utils.ml

   1 (* Guestfs Browser.
   2  * Copyright (C) 2010 Red Hat Inc.
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  17  *)
  18
  19 open ExtString
  20 open ExtList
  21
  22 open Printf
  23
  24 let (+^) = Int64.add
  25 let (-^) = Int64.sub
  26 let ( *^ ) = Int64.mul
  27 let (/^) = Int64.div
  28
  29 type ('a, 'b) either = Left of 'a | Right of 'b
  30
  31 let (//) = Filename.concat
  32
  33 let verbose = ref false
  34 let set_verbose_flag () = verbose := true
  35 let verbose () = !verbose
  36
  37 let debug fs =
  38   let f str =
  39     if verbose () then (
  40       prerr_string Config.package;
  41       prerr_string ": tid ";
  42       prerr_string (string_of_int (Thread.id (Thread.self ())));
  43       prerr_string ": ";
  44       prerr_string str;
  45       prerr_newline ()
  46     )
  47   in
  48   ksprintf f fs
  49
  50 let failwith fs =
  51   let f str =
  52     if verbose () then (prerr_string str; prerr_newline ());
  53     raise (Failure str)
  54   in
  55   ksprintf f fs
  56
  57 let trace = ref false
  58 let set_trace_flag () = trace := true
  59 let trace () = !trace
  60
  61 let connect_uri = ref None
  62 let set_connect_uri conn = connect_uri := conn
  63 let connect_uri () = !connect_uri
  64
  65 let utf8_rarrow = "\xe2\x86\x92"
  66
  67 let human_size i =
  68   if i < 1024L then
  69     sprintf "%Ld" i
  70   else if i < 1024L *^ 1024L then
  71     sprintf "%.1f KB" (Int64.to_float i /. 1024.)
  72   else if i < 1024L *^ 1024L *^ 1024L then
  73     sprintf "%.1f MB" (Int64.to_float i /. 1024. /. 1024.)
  74   else if i < 1024L *^ 1024L *^ 1024L *^ 1024L then
  75     sprintf "%.1f GB" (Int64.to_float i /. 1024. /. 1024. /. 1024.)
  76   else
  77     sprintf "%.1f TB" (Int64.to_float i /. 1024. /. 1024. /. 1024. /. 1024.)
  78
  79 let human_size_1k i =
  80   if i < 1024L then
  81     sprintf "%Ld KB" i
  82   else if i < 1024L *^ 1024L then
  83     sprintf "%.1f MB" (Int64.to_float i /. 1024.)
  84   else
  85     sprintf "%.1f GB" (Int64.to_float i /. 1024. /. 1024.)
  86
  87 let unique = let i = ref 0 in fun () -> incr i; !i
  88
  89 let mklabel text =
  90   (GMisc.label ~text () :> GObj.widget)
  91
  92 (* g_markup_escape is not bound by lablgtk2, but we want to provide
  93  * extra protection for \0 characters appearing in the string
  94  * anyway.
  95  *)
  96 let markup_escape name =
  97   let f = function
  98     | '&' -> "&amp;" | '<' -> "&lt;" | '>' -> "&gt;"
  99     | '\000' -> "\\0"
 100     | c -> String.make 1 c
 101   in
 102   String.replace_chars f name
 103
 104 let libguestfs_version_string () =
 105   let g = new Guestfs.guestfs () in
 106   let v = g#version () in
 107   let s =
 108     sprintf "%Ld.%Ld.%Ld%s"
 109       v.Guestfs.major v.Guestfs.minor v.Guestfs.release v.Guestfs.extra in
 110   g#close ();
 111   s
 112
 113 let libvirt_version_string () =
 114   let v = fst (Libvirt.get_version ()) in
 115   sprintf "%d.%d.%d" (v / 1_000_000) ((v / 1_000) mod 1_000) (v mod 1_000)
 116
 117 (* File type tests.
 118  *
 119  * Note these have to be on Linux ABI modes.  We cannot use the
 120  * OCaml (ie. host) equivalents here.
 121  *)
 122 let rec file_type mask mode = Int64.logand mode 0o170000L = mask
 123
 124 and is_socket mode =       file_type 0o140000L mode
 125 and is_symlink mode =      file_type 0o120000L mode
 126 and is_regular_file mode = file_type 0o100000L mode
 127 and is_block mode =        file_type 0o060000L mode
 128 and is_directory mode =    file_type 0o040000L mode
 129 and is_char mode =         file_type 0o020000L mode
 130 and is_fifo mode =         file_type 0o010000L mode
 131
 132 and is_suid mode =         test_bit 0o4000L mode
 133 and is_sgid mode =         test_bit 0o2000L mode
 134 and is_svtx mode =         test_bit 0o1000L mode
 135
 136 and is_ru mode =           test_bit 0o400L mode
 137 and is_wu mode =           test_bit 0o200L mode
 138 and is_xu mode =           test_bit 0o100L mode
 139 and is_rg mode =           test_bit 0o040L mode
 140 and is_wg mode =           test_bit 0o020L mode
 141 and is_xg mode =           test_bit 0o010L mode
 142 and is_ro mode =           test_bit 0o004L mode
 143 and is_wo mode =           test_bit 0o002L mode
 144 and is_xo mode =           test_bit 0o001L mode
 145
 146 and test_bit mask mode = Int64.logand mode mask = mask
 147
 148 let tmpdir () =
 149   let chan = open_in "/dev/urandom" in
 150   let data = String.create 16 in
 151   really_input chan data 0 (String.length data);
 152   close_in chan;
 153   let data = Digest.to_hex (Digest.string data) in
 154   (* Note this is secure, because if the name already exists, even as a
 155    * symlink, mkdir(2) will fail.
 156    *)
 157   let tmpdir = Filename.temp_dir_name // sprintf "guestfsbrowser%s.tmp" data in
 158   Unix.mkdir tmpdir 0o700;
 159   at_exit
 160     (fun () ->
 161        let cmd = sprintf "rm -rf %s" (Filename.quote tmpdir) in
 162        ignore (Sys.command cmd));
 163   tmpdir
 164
 165 module CE = CamomileLibraryDefault.Camomile.CharEncoding
 166 module UTF8 = CamomileLibraryDefault.Camomile.UTF8
 167 module UChar = CamomileLibraryDefault.Camomile.UChar
 168 let utf16le = CE.utf16le
 169 let utf8 = CE.utf8
 170 let recode = CE.recode_string ~in_enc:utf16le ~out_enc:utf8
 171
 172 let windows_string_to_utf8 str =
 173   let str = recode str in
 174
 175   (* Windows strings include the final \0 so remove this if present. *)
 176   let len = UTF8.length str in
 177   if len > 0 && UChar.code (UTF8.get str (len-1)) = 0 then
 178     String.sub str 0 (UTF8.last str)
 179   else
 180     str
 181
 182 (* Best effort convert hive value to printable string. *)
 183 let rec printable_hivex_value ?split_long_lines t v =
 184   let hex = reg_hex_of_string ?split_long_lines in
 185   match t with
 186   | Hivex.REG_NONE -> if v = "" then "" else hex v
 187   | Hivex.REG_SZ ->
 188       (try windows_string_to_utf8 v with _ -> hex v)
 189   | Hivex.REG_EXPAND_SZ ->
 190       (try windows_string_to_utf8 v with _ -> hex v)
 191   | Hivex.REG_BINARY -> hex v
 192   | Hivex.REG_DWORD ->
 193       (bitmatch Bitstring.bitstring_of_string v with
 194        | { i : 32 : littleendian } -> sprintf "%08lx" i
 195        | { _ } -> hex v)
 196   | Hivex.REG_DWORD_BIG_ENDIAN ->
 197       (bitmatch Bitstring.bitstring_of_string v with
 198        | { i : 32 : bigendian } -> sprintf "%08lx" i
 199        | { _ } -> hex v)
 200   | Hivex.REG_LINK -> hex v
 201   | Hivex.REG_MULTI_SZ -> (* XXX should be better for this one *)
 202       hex v
 203   | Hivex.REG_RESOURCE_LIST -> hex v
 204   | Hivex.REG_FULL_RESOURCE_DESCRIPTOR -> hex v
 205   | Hivex.REG_RESOURCE_REQUIREMENTS_LIST -> hex v
 206   | Hivex.REG_QWORD ->
 207       (bitmatch Bitstring.bitstring_of_string v with
 208        | { i : 64 : littleendian } -> sprintf "%016Lx" i
 209        | { _ } -> hex v)
 210   | Hivex.REG_UNKNOWN i32 -> hex v
 211
 212 (* Convert binary data to a hex string.  This includes line breaks. *)
 213 and reg_hex_of_string ?(split_long_lines=false) v =
 214   let vs = String.explode v in
 215   let vs = List.mapi (
 216     fun i c ->
 217       sprintf "%s%02x"
 218         (if split_long_lines && i mod 16 = 0 then "\n" else "")
 219         (int_of_char c)
 220   ) vs in
 221   String.concat "," vs
 222
 223 let local_file_exists filename =
 224   try Unix.access filename [Unix.F_OK]; true
 225   with Unix.Unix_error _ -> false