filetree_markup.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 open CamomileLibrary
  22 open Default.Camomile
  23 open Unix
  24
  25 open Utils
  26 open Filetree_type
  27
  28 open Printf
  29
  30 (* Base colours. XXX Should be configurable somewhere. *)
  31 let file_color = 0x20, 0x20, 0xff  (* regular file *)
  32 let dir_color = 0x80, 0x80, 0x20   (* directory *)
  33 let symlink_color = file_color     (* symlink *)
  34 let suid_color = 0x20, 0x20, 0x80  (* setuid bit set on regular file *)
  35 let suid_bgcolor = 0xff, 0xc0, 0xc0
  36 let sgid_color = suid_color        (* setgid bit set on regular file *)
  37 let sgid_bgcolor = suid_bgcolor
  38 let block_color = 0x00, 0x60, 0x60 (* block device *)
  39 let char_color = block_color       (* char device *)
  40 let fifo_color = 0x60, 0x00, 0x60  (* fifo *)
  41 let socket_color = fifo_color      (* socket *)
  42 let other_color = file_color       (* anything not one of the above *)
  43
  44 (* Mark up a filename for the name_col column.
  45  *
  46  * See also
  47  * http://library.gnome.org/devel/pango/stable/PangoMarkupFormat.html
  48  *)
  49 let rec markup_of_name ?(visited = false) direntry =
  50   let name = direntry.Slave.dent_name in
  51   let mode = direntry.Slave.dent_stat.Guestfs.mode in
  52   if is_directory mode then (           (* directory *)
  53     let fg = if not visited then normal dir_color else darken dir_color in
  54     sprintf "<span weight=\"bold\" fgcolor=\"%s\">%s</span>"
  55       fg (markup_escape name)
  56   )
  57   else if is_symlink mode then (        (* symlink *)
  58     let link = direntry.Slave.dent_link in
  59     let fg =
  60       if not visited then normal symlink_color else darken symlink_color in
  61     sprintf "<span style=\"italic\" fgcolor=\"%s\">%s</span> %s <span style=\"italic\" fgcolor=\"%s\">%s</span>"
  62       fg (markup_escape name) utf8_rarrow fg (markup_escape link)
  63   )
  64   else (                                (* not directory, not symlink *)
  65     let fg, bg =
  66       if is_regular_file mode then (
  67         if is_suid mode then suid_color, Some suid_bgcolor
  68         else if is_sgid mode then sgid_color, Some sgid_bgcolor
  69         else file_color, None
  70       )
  71       else if is_block mode then block_color, None
  72       else if is_char mode then char_color, None
  73       else if is_fifo mode then fifo_color, None
  74       else if is_socket mode then socket_color, None
  75       else other_color, None in
  76     let fg = if not visited then normal fg else darken fg in
  77     let bg =
  78       match bg with
  79       | Some bg -> sprintf " bgcolor=\"%s\"" (normal bg)
  80       | None -> "" in
  81     sprintf "<span fgcolor=\"%s\"%s>%s</span>"
  82       fg bg (markup_escape name)
  83   )
  84
  85 (* Mark up a registry key. *)
  86 and markup_of_regkey ?(visited = false) h node =
  87   let name = Hivex.node_name h node in
  88   let fg = if not visited then normal dir_color else darken dir_color in
  89   sprintf "<span fgcolor=\"%s\">%s</span>" fg (markup_escape name)
  90
  91 (* Mark up a registry value. *)
  92 and markup_of_regvalue ?(visited = false) h value =
  93   debug "markup_of_regvalue";
  94   let k = Hivex.value_key h value in
  95   let k = if k = "" then "@" else k in
  96   let t, v = Hivex.value_value h value in
  97
  98   (* Ignore long values. *)
  99   let len = String.length v in
 100   let v =
 101     if len >= 256 then
 102       sprintf "&lt;%d bytes not printed&gt;" len
 103     else (
 104       (* Deal as best we can with printing the value. *)
 105       match t with
 106       | Hivex.REG_NONE -> if v = "" then "" else markup_hex_data v
 107       | Hivex.REG_SZ -> markup_windows_string v
 108       | Hivex.REG_EXPAND_SZ -> markup_windows_string v
 109       | Hivex.REG_BINARY -> markup_hex_data v
 110       | Hivex.REG_DWORD ->
 111           (bitmatch Bitstring.bitstring_of_string v with
 112            | { i : 32 : littleendian } -> sprintf "%08lx" i
 113            | { _ } -> markup_hex_data v)
 114       | Hivex.REG_DWORD_BIG_ENDIAN ->
 115           (bitmatch Bitstring.bitstring_of_string v with
 116            | { i : 32 : bigendian } -> sprintf "%08lx" i
 117            | { _ } -> markup_hex_data v)
 118       | Hivex.REG_LINK -> markup_hex_data v
 119       | Hivex.REG_MULTI_SZ -> (* XXX could do better with this *)
 120           markup_hex_data v
 121       | Hivex.REG_RESOURCE_LIST -> markup_hex_data v
 122       | Hivex.REG_FULL_RESOURCE_DESCRIPTOR -> markup_hex_data v
 123       | Hivex.REG_RESOURCE_REQUIREMENTS_LIST -> markup_hex_data v
 124       | Hivex.REG_QWORD ->
 125           (bitmatch Bitstring.bitstring_of_string v with
 126            | { i : 64 : littleendian } -> sprintf "%016Lx" i
 127            | { _ } -> markup_hex_data v)
 128       | Hivex.REG_UNKNOWN i32 -> markup_hex_data v
 129     ) in
 130
 131   let fg = if not visited then normal file_color else darken file_color in
 132   sprintf "<span fgcolor=\"%s\">%s</span>=<span fgcolor=\"%s\">%s</span>"
 133     fg (markup_escape k) fg v
 134
 135 (* Mark up registry value as hex data. *)
 136 and markup_hex_data v =
 137   let vs = String.explode v in
 138   let vs = List.mapi (
 139     fun i c ->
 140       sprintf "%s%02x" (if i mod 16 = 0 then "\n" else "") (int_of_char c)
 141   ) vs in
 142   String.concat "," vs
 143
 144 (* Best guess the format of the string and convert to UTF-8. *)
 145 and markup_windows_string v =
 146   try markup_escape (windows_string_to_utf8 v)
 147   with CharEncoding.Malformed_code | CharEncoding.Out_of_range ->
 148     (* Fallback to displaying the string as hex. *)
 149     markup_hex_data v
 150
 151 and normal (r, g, b) =
 152   let r = if r < 0 then 0 else if r > 255 then 255 else r in
 153   let g = if g < 0 then 0 else if g > 255 then 255 else g in
 154   let b = if b < 0 then 0 else if b > 255 then 255 else b in
 155   sprintf "#%02x%02x%02x" r g b
 156
 157 and darken (r, g, b) =
 158   normal (r * 4 / 10, g * 4 / 10, b * 4 / 10)
 159
 160 (* Mark up mode. *)
 161 let markup_of_mode mode =
 162   let c =
 163     if is_socket mode then 's'
 164     else if is_symlink mode then 'l'
 165     else if is_regular_file mode then '-'
 166     else if is_block mode then 'b'
 167     else if is_directory mode then 'd'
 168     else if is_char mode then 'c'
 169     else if is_fifo mode then 'p' else '?' in
 170   let ru = if is_ru mode then 'r' else '-' in
 171   let wu = if is_wu mode then 'w' else '-' in
 172   let xu = if is_xu mode then 'x' else '-' in
 173   let rg = if is_rg mode then 'r' else '-' in
 174   let wg = if is_wg mode then 'w' else '-' in
 175   let xg = if is_xg mode then 'x' else '-' in
 176   let ro = if is_ro mode then 'r' else '-' in
 177   let wo = if is_wo mode then 'w' else '-' in
 178   let xo = if is_xo mode then 'x' else '-' in
 179   let str = sprintf "%c%c%c%c%c%c%c%c%c%c" c ru wu xu rg wg xg ro wo xo in
 180
 181   let suid = is_suid mode in
 182   let sgid = is_sgid mode in
 183   let svtx = is_svtx mode in
 184   if suid then str.[3] <- 's';
 185   if sgid then str.[6] <- 's';
 186   if svtx then str.[9] <- 't';
 187
 188   "<span color=\"#222222\" size=\"small\">" ^ str ^ "</span>"
 189
 190 (* Mark up dates. *)
 191 let markup_of_date t =
 192   (* Guestfs gives us int64's, we want float which is OCaml's
 193    * equivalent of time_t.
 194    *)
 195   let t = Int64.to_float t in
 196
 197   let show_full_date () =
 198     let tm = localtime t in
 199     sprintf "<span color=\"#222222\" size=\"small\">%04d-%02d-%02d %02d:%02d:%02d</span>"
 200       (tm.tm_year + 1900) (tm.tm_mon + 1) tm.tm_mday
 201       tm.tm_hour tm.tm_min tm.tm_sec
 202   in
 203
 204   (* How long ago? *)
 205   let now = time () in
 206   let ago = now -. t in
 207   if ago < 0. then (* future *)
 208     show_full_date ()
 209   else if ago < 60. then
 210     "<small>now</small>"
 211   else if ago < 60. *. 60. then
 212     sprintf "<small>%.0f minutes ago</small>" (ago /. 60.)
 213   else if ago < 60. *. 60. *. 24. then
 214     sprintf "<small>%.0f hours ago</small>" (ago /. 60. /. 60.)
 215   else if ago < 60. *. 60. *. 24. *. 28. then
 216     sprintf "<small>%.0f days ago</small>" (ago /. 60. /. 60. /. 24.)
 217   else
 218     show_full_date ()
 219
 220 (* Mark up file sizes. *)
 221 let markup_of_size bytes =
 222   sprintf "<small>%s</small>" (human_size bytes)
 223
 224 (* Mark up registry value types. *)
 225 let markup_of_regvaluetype h value =
 226   let t, _ = Hivex.value_value h value in
 227
 228   match t with
 229   | Hivex.REG_NONE -> "none(0)"
 230   | Hivex.REG_SZ -> "str(1)"
 231   | Hivex.REG_EXPAND_SZ -> "str(2)"
 232   | Hivex.REG_BINARY -> "hex(3)"
 233   | Hivex.REG_DWORD -> "dword(4)"
 234   | Hivex.REG_DWORD_BIG_ENDIAN -> "dword(5)"
 235   | Hivex.REG_LINK -> "link(6)"
 236   | Hivex.REG_MULTI_SZ -> "multi string (7)"
 237   | Hivex.REG_RESOURCE_LIST -> "resource list (8)"
 238   | Hivex.REG_FULL_RESOURCE_DESCRIPTOR -> "full resource descriptor (9)"
 239   | Hivex.REG_RESOURCE_REQUIREMENTS_LIST -> "resource requirements list (10)"
 240   | Hivex.REG_QWORD -> "qword (11)"
 241   | Hivex.REG_UNKNOWN i32 -> sprintf "type 0x%08lx" i32
 242
 243 (* Mark up registry value sizes. *)
 244 let markup_of_regvaluesize h value =
 245   let _, len = Hivex.value_type h value in
 246   sprintf "%d" len
 247
 248 (* This is a bit of a hack.  Ideally just setting 'visited' would
 249  * darken the colour when the cell was re-rendered.  However that would
 250  * mean we couldn't store other stuff in the name column.  Therefore,
 251  * repopulate the name column.
 252  *)
 253 let set_visited ({ model = model; name_col = name_col } as t) row =
 254   let hdata = get_hdata t row in
 255   if hdata.visited = false then (
 256     hdata.visited <- true;
 257     match hdata.content with
 258     | Directory direntry | File direntry ->
 259         debug "set_visited %s" direntry.Slave.dent_name;
 260         model#set ~row ~column:name_col
 261           (markup_of_name ~visited:true direntry)
 262     | RegKey node ->
 263         debug "set_visited RegKey";
 264         let h = Option.get hdata.hiveh in
 265         model#set ~row ~column:name_col
 266           (markup_of_regkey ~visited:true h node)
 267     | RegValue value ->
 268         debug "set_visited RegValue";
 269         let h = Option.get hdata.hiveh in
 270         model#set ~row ~column:name_col
 271           (markup_of_regvalue ~visited:true h value)
 272     | Loading | ErrorMessage _ | Info _ | Top _ | TopWinReg _ -> ()
 273   )