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