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 pretty_string_of_exn =
  68   function
  69   | Guestfs.Error str ->
  70       "Libguestfs error",
  71       sprintf "libguestfs reported an error:
  72
  73 %s
  74
  75 To get more information about libguestfs errors, run guestfs-browser
  76 with the -x flag on the command line."
  77         str
  78
  79   (* Add more exception types here as we come across them.  Last
  80    * case below is the catch-all.
  81    *)
  82   | exn ->
  83       "Error", Printexc.to_string exn
  84
  85 let human_size i =
  86   if i < 1024L then
  87     sprintf "%Ld" i
  88   else if i < 1024L *^ 1024L then
  89     sprintf "%.1f KB" (Int64.to_float i /. 1024.)
  90   else if i < 1024L *^ 1024L *^ 1024L then
  91     sprintf "%.1f MB" (Int64.to_float i /. 1024. /. 1024.)
  92   else if i < 1024L *^ 1024L *^ 1024L *^ 1024L then
  93     sprintf "%.1f GB" (Int64.to_float i /. 1024. /. 1024. /. 1024.)
  94   else
  95     sprintf "%.1f TB" (Int64.to_float i /. 1024. /. 1024. /. 1024. /. 1024.)
  96
  97 let human_size_1k i =
  98   if i < 1024L then
  99     sprintf "%Ld KB" i
 100   else if i < 1024L *^ 1024L then
 101     sprintf "%.1f MB" (Int64.to_float i /. 1024.)
 102   else
 103     sprintf "%.1f GB" (Int64.to_float i /. 1024. /. 1024.)
 104
 105 let unique = let i = ref 0 in fun () -> incr i; !i
 106
 107 let mklabel text =
 108   (GMisc.label ~text () :> GObj.widget)
 109
 110 (* g_markup_escape is not bound by lablgtk2, but we want to provide
 111  * extra protection for \0 characters appearing in the string
 112  * anyway.
 113  *)
 114 let markup_escape name =
 115   let f = function
 116     | '&' -> "&amp;" | '<' -> "&lt;" | '>' -> "&gt;"
 117     | '\000' -> "\\0"
 118     | c -> String.make 1 c
 119   in
 120   String.replace_chars f name
 121
 122 let libguestfs_version_string () =
 123   let g = new Guestfs.guestfs () in
 124   let v = g#version () in
 125   let s =
 126     sprintf "%Ld.%Ld.%Ld%s"
 127       v.Guestfs.major v.Guestfs.minor v.Guestfs.release v.Guestfs.extra in
 128   g#close ();
 129   s
 130
 131 let libvirt_version_string () =
 132   let v = fst (Libvirt.get_version ()) in
 133   sprintf "%d.%d.%d" (v / 1_000_000) ((v / 1_000) mod 1_000) (v mod 1_000)
 134
 135 (* File type tests.
 136  *
 137  * Note these have to be on Linux ABI modes.  We cannot use the
 138  * OCaml (ie. host) equivalents here.
 139  *)
 140 let rec file_type mask mode = Int64.logand mode 0o170000L = mask
 141
 142 and is_socket mode =       file_type 0o140000L mode
 143 and is_symlink mode =      file_type 0o120000L mode
 144 and is_regular_file mode = file_type 0o100000L mode
 145 and is_block mode =        file_type 0o060000L mode
 146 and is_directory mode =    file_type 0o040000L mode
 147 and is_char mode =         file_type 0o020000L mode
 148 and is_fifo mode =         file_type 0o010000L mode
 149
 150 and is_suid mode =         test_bit 0o4000L mode
 151 and is_sgid mode =         test_bit 0o2000L mode
 152 and is_svtx mode =         test_bit 0o1000L mode
 153
 154 and is_ru mode =           test_bit 0o400L mode
 155 and is_wu mode =           test_bit 0o200L mode
 156 and is_xu mode =           test_bit 0o100L mode
 157 and is_rg mode =           test_bit 0o040L mode
 158 and is_wg mode =           test_bit 0o020L mode
 159 and is_xg mode =           test_bit 0o010L mode
 160 and is_ro mode =           test_bit 0o004L mode
 161 and is_wo mode =           test_bit 0o002L mode
 162 and is_xo mode =           test_bit 0o001L mode
 163
 164 and test_bit mask mode = Int64.logand mode mask = mask
 165
 166 let tmpdir () =
 167   let chan = open_in "/dev/urandom" in
 168   let data = String.create 16 in
 169   really_input chan data 0 (String.length data);
 170   close_in chan;
 171   let data = Digest.to_hex (Digest.string data) in
 172   (* Note this is secure, because if the name already exists, even as a
 173    * symlink, mkdir(2) will fail.
 174    *)
 175   let tmpdir = Filename.temp_dir_name // sprintf "guestfsbrowser%s.tmp" data in
 176   Unix.mkdir tmpdir 0o700;
 177   at_exit
 178     (fun () ->
 179        let cmd = sprintf "rm -rf %s" (Filename.quote tmpdir) in
 180        ignore (Sys.command cmd));
 181   tmpdir
 182
 183 module CE = CamomileLibraryDefault.Camomile.CharEncoding
 184 module UTF8 = CamomileLibraryDefault.Camomile.UTF8
 185 module UChar = CamomileLibraryDefault.Camomile.UChar
 186 let utf16le = CE.utf16le
 187 let utf8 = CE.utf8
 188 let recode = CE.recode_string ~in_enc:utf16le ~out_enc:utf8
 189
 190 let windows_string_to_utf8 str =
 191   let str = recode str in
 192
 193   (* Windows strings include the final \0 so remove this if present. *)
 194   let len = UTF8.length str in
 195   if len > 0 && UChar.code (UTF8.get str (len-1)) = 0 then
 196     String.sub str 0 (UTF8.last str)
 197   else
 198     str
 199
 200 (* Best effort convert hive value to printable string. *)
 201 let rec printable_hivex_value ?split_long_lines t v =
 202   let hex = reg_hex_of_string ?split_long_lines in
 203   match t with
 204   | Hivex.REG_NONE -> if v = "" then "" else hex v
 205   | Hivex.REG_SZ ->
 206       (try windows_string_to_utf8 v with _ -> hex v)
 207   | Hivex.REG_EXPAND_SZ ->
 208       (try windows_string_to_utf8 v with _ -> hex v)
 209   | Hivex.REG_BINARY -> hex v
 210   | Hivex.REG_DWORD ->
 211       (bitmatch Bitstring.bitstring_of_string v with
 212        | { i : 32 : littleendian } -> sprintf "%08lx" i
 213        | { _ } -> hex v)
 214   | Hivex.REG_DWORD_BIG_ENDIAN ->
 215       (bitmatch Bitstring.bitstring_of_string v with
 216        | { i : 32 : bigendian } -> sprintf "%08lx" i
 217        | { _ } -> hex v)
 218   | Hivex.REG_LINK -> hex v
 219   | Hivex.REG_MULTI_SZ -> (* XXX should be better for this one *)
 220       hex v
 221   | Hivex.REG_RESOURCE_LIST -> hex v
 222   | Hivex.REG_FULL_RESOURCE_DESCRIPTOR -> hex v
 223   | Hivex.REG_RESOURCE_REQUIREMENTS_LIST -> hex v
 224   | Hivex.REG_QWORD ->
 225       (bitmatch Bitstring.bitstring_of_string v with
 226        | { i : 64 : littleendian } -> sprintf "%016Lx" i
 227        | { _ } -> hex v)
 228   | Hivex.REG_UNKNOWN i32 -> hex v
 229
 230 (* Convert binary data to a hex string.  This includes line breaks. *)
 231 and reg_hex_of_string ?(split_long_lines=false) v =
 232   let vs = String.explode v in
 233   let vs = List.mapi (
 234     fun i c ->
 235       sprintf "%s%02x"
 236         (if split_long_lines && i mod 16 = 0 then "\n" else "")
 237         (int_of_char c)
 238   ) vs in
 239   String.concat "," vs
 240
 241 let local_file_exists filename =
 242   try Unix.access filename [Unix.F_OK]; true
 243   with Unix.Unix_error _ -> false