Add note about OCaml bindings bug, and which versions of libguestfs are req'd.
[guestfs-browser.git] / filetree.ml
index f252f2a..a68dd8b 100644 (file)
@@ -23,14 +23,22 @@ open Printf
 
 open Utils
 open DeviceSet
+open Slave_types
 
 open Filetree_type
+open Filetree_markup
 open Filetree_ops
 
 module G = Guestfs
+module UTF8 = CamomileLibraryDefault.Camomile.UTF8
 
 type t = Filetree_type.t
 
+(* Temporary directory for shared use by any function in this file.
+ * It is cleaned up when the program exits.
+ *)
+let tmpdir = tmpdir ()
+
 let rec create ~packing () =
   let view = GTree.view ~packing () in
   (*view#set_rules_hint true;*)
@@ -70,6 +78,7 @@ let rec create ~packing () =
   let renderer = GTree.cell_renderer_text [], ["markup", name_col] in
   let name_view = GTree.view_column ~title:"Filename" ~renderer () in
   name_view#set_resizable true;
+  name_view#set_sizing `AUTOSIZE;
   ignore (view#append_column name_view);
 
   let renderer = GTree.cell_renderer_text [`XALIGN 1.], ["markup", size_col] in
@@ -140,15 +149,17 @@ and button_press ({ model = model; view = view } as t) ev =
           let hdata = get_hdata t row in
           match hdata with
           | { content=(Loading | ErrorMessage _ | Info _) } -> None
-          | { content=(Top _ | Directory _ | File _) } -> Some (path, hdata)
+          | { content=(Top _ | Directory _ | File _ |
+                           TopWinReg _ | RegKey _ | RegValue _ ) } ->
+              Some (path, hdata)
       ) paths in
 
     (* Based on number of selected rows and what is selected, construct
      * the context menu.
      *)
-    if paths <> [] then (
-      let menu = make_context_menu t paths in
-      menu#popup ~button ~time
+    (match make_context_menu t paths with
+     | Some menu -> menu#popup ~button ~time
+     | None -> ()
     );
 
     (* Return true so no other handler will run. *)
@@ -161,14 +172,20 @@ and make_context_menu t paths =
   let menu = GMenu.menu () in
   let factory = new GMenu.factory menu in
 
-  let item = factory#add_item "Open" in
-  item#misc#set_sensitive false;
-
   let rec add_file_items path =
+    let item = factory#add_item "View ..." in
+    (match Config.opener with
+     | Some opener ->
+         ignore (item#connect#activate ~callback:(view_file t path opener));
+     | None ->
+         item#misc#set_sensitive false
+    );
     let item = factory#add_item "File information" in
-    item#misc#set_sensitive false;
-    let item = factory#add_item "Checksum" in
-    item#misc#set_sensitive false;
+    ignore (item#connect#activate ~callback:(file_information t path));
+    let item = factory#add_item "MD5 checksum" in
+    ignore (item#connect#activate ~callback:(checksum_file t path "md5"));
+    let item = factory#add_item "SHA1 checksum" in
+    ignore (item#connect#activate ~callback:(checksum_file t path "sha1"));
     ignore (factory#add_separator ());
     let item = factory#add_item "Download ..." in
     ignore (item#connect#activate ~callback:(download_file t path));
@@ -183,126 +200,92 @@ and make_context_menu t paths =
     item#misc#set_sensitive false;
     let item = factory#add_item "Download as .tar ..." in
     ignore (item#connect#activate
-              ~callback:(download_dir_tarball t Slave.Tar path));
+              ~callback:(download_dir_tarball t Tar path));
     let item = factory#add_item "Download as .tar.gz ..." in
     ignore (item#connect#activate
-              ~callback:(download_dir_tarball t Slave.TGZ path));
+              ~callback:(download_dir_tarball t TGZ path));
     let item = factory#add_item "Download as .tar.xz ..." in
     ignore (item#connect#activate
-              ~callback:(download_dir_tarball t Slave.TXZ path));
+              ~callback:(download_dir_tarball t TXZ path));
     let item = factory#add_item "Download list of filenames ..." in
     ignore (item#connect#activate ~callback:(download_dir_find0 t path));
 
-  and add_os_items path =
+  and add_top_os_items path =
     let item = factory#add_item "Operating system information" in
     ignore (item#connect#activate ~callback:(display_inspection_data t path));
     ignore (factory#add_separator ());
-    add_volume_items path
+    add_top_volume_items path
 
-  and add_volume_items path =
+  and add_top_volume_items path =
     let item = factory#add_item "Filesystem used & free" in
     item#misc#set_sensitive false;
     let item = factory#add_item "Block device information" in
     item#misc#set_sensitive false;
     ignore (factory#add_separator ());
     add_directory_items path
+
+  and add_topwinreg_items path =
+    let item = factory#add_item "Download hive file ..." in
+    item#misc#set_sensitive false;
+    ignore (factory#add_separator ());
+    add_regkey_items path
+
+  and add_regkey_items path =
+    let item = factory#add_item "Download as .reg file ..." in
+    (match Config.hivexregedit with
+     | Some hivexregedit ->
+         ignore (item#connect#activate
+                   ~callback:(download_as_reg t path hivexregedit));
+     | None ->
+         item#misc#set_sensitive false
+    )
+
+  and add_regvalue_items path =
+    let item = factory#add_item "Copy value to clipboard" in
+    ignore (item#connect#activate ~callback:(copy_regvalue t path));
+
   in
 
-  (match paths with
-   (* single selection *)
-   | [path, { content=Top (Slave.OS os)} ] ->  (* top level operating system *)
-       add_os_items path
+  let has_menu =
+    match paths with
+    | [] -> false
 
-   | [path, { content=Top (Slave.Volume dev) }] -> (* top level volume *)
-       add_volume_items path
+    (* single selection *)
+    | [path, { content=Top (OS os)} ] ->  (* top level operating system *)
+        add_top_os_items path; true
 
-   | [path, { content=Directory direntry }] ->     (* directory *)
-       add_directory_items path
+    | [path, { content=Top (Volume dev) }] -> (* top level volume *)
+        add_top_volume_items path; true
 
-   | [path, { content=File direntry }] ->          (* file *)
-       add_file_items path
+    | [path, { content=Directory _ }] -> (* directory *)
+        add_directory_items path; true
 
-   | [_, { content=Loading }]
-   | [_, { content=ErrorMessage _ }] -> ()
+    | [path, { content=File _ }] ->      (* file *)
+        add_file_items path; true
 
-   | _ ->
-       (* At the moment multiple selection is disabled.  When/if we
-        * enable it we should do something intelligent here. XXX
-        *)
-       ()
-  );
+    | [path, { content=TopWinReg _ }] -> (* top level registry node *)
+        add_topwinreg_items path; true
 
-  menu
-
-(* Mark up mode. *)
-let markup_of_mode mode =
-  let c =
-    if is_socket mode then 's'
-    else if is_symlink mode then 'l'
-    else if is_regular_file mode then '-'
-    else if is_block mode then 'b'
-    else if is_directory mode then 'd'
-    else if is_char mode then 'c'
-    else if is_fifo mode then 'p' else '?' in
-  let ru = if is_ru mode then 'r' else '-' in
-  let wu = if is_wu mode then 'w' else '-' in
-  let xu = if is_xu mode then 'x' else '-' in
-  let rg = if is_rg mode then 'r' else '-' in
-  let wg = if is_wg mode then 'w' else '-' in
-  let xg = if is_xg mode then 'x' else '-' in
-  let ro = if is_ro mode then 'r' else '-' in
-  let wo = if is_wo mode then 'w' else '-' in
-  let xo = if is_xo mode then 'x' else '-' in
-  let str = sprintf "%c%c%c%c%c%c%c%c%c%c" c ru wu xu rg wg xg ro wo xo in
-
-  let suid = is_suid mode in
-  let sgid = is_sgid mode in
-  let svtx = is_svtx mode in
-  if suid then str.[3] <- 's';
-  if sgid then str.[6] <- 's';
-  if svtx then str.[9] <- 't';
-
-  "<span color=\"#222222\" size=\"small\">" ^ str ^ "</span>"
-
-(* Mark up dates. *)
-let markup_of_date t =
-  (* Guestfs gives us int64's, we want float which is OCaml's
-   * equivalent of time_t.
-   *)
-  let t = Int64.to_float t in
+    | [path, { content=RegKey _ }] ->    (* registry node *)
+        add_regkey_items path; true
 
-  let show_full_date () =
-    let tm = localtime t in
-    sprintf "<span color=\"#222222\" size=\"small\">%04d-%02d-%02d %02d:%02d:%02d</span>"
-      (tm.tm_year + 1900) (tm.tm_mon + 1) tm.tm_mday
-      tm.tm_hour tm.tm_min tm.tm_sec
-  in
+    | [path, { content=RegValue _ }] ->  (* registry key/value pair *)
+        add_regvalue_items path; true
 
-  (* How long ago? *)
-  let now = time () in
-  let ago = now -. t in
-  if ago < 0. then (* future *)
-    show_full_date ()
-  else if ago < 60. then
-    "<small>now</small>"
-  else if ago < 60. *. 60. then
-    sprintf "<small>%.0f minutes ago</small>" (ago /. 60.)
-  else if ago < 60. *. 60. *. 24. then
-    sprintf "<small>%.0f hours ago</small>" (ago /. 60. /. 60.)
-  else if ago < 60. *. 60. *. 24. *. 28. then
-    sprintf "<small>%.0f days ago</small>" (ago /. 60. /. 60. /. 24.)
-  else
-    show_full_date ()
-
-(* Mark up file sizes. *)
-let markup_of_size bytes =
-  sprintf "<small>%s</small>" (human_size bytes)
+    | [_, { content=(Loading|ErrorMessage _|Info _) }] -> false
+
+    | _::_::_ ->
+        (* At the moment multiple selection is disabled.  When/if we
+         * enable it we should do something intelligent here. XXX
+         *)
+        false in
+  if has_menu then Some menu else None
 
 let clear { model = model; hash = hash } =
   model#clear ();
   Hashtbl.clear hash
 
-let rec add ({ model = model; hash = hash } as t) name data =
+let rec add ({ model = model } as t) name data =
   clear t;
 
   (* Populate the top level of the filetree.  If there are operating
@@ -312,63 +295,115 @@ let rec add ({ model = model; hash = hash } as t) name data =
    * filesystems.
    *)
   let other_filesystems =
-    DeviceSet.of_list (List.map fst data.Slave.insp_all_filesystems) in
+    DeviceSet.of_list (List.map fst data.insp_all_filesystems) in
   let other_filesystems =
-    List.fold_left (fun set { Slave.insp_filesystems = fses } ->
+    List.fold_left (fun set { insp_filesystems = fses } ->
                       DeviceSet.subtract set (DeviceSet.of_array fses))
-      other_filesystems data.Slave.insp_oses in
+      other_filesystems data.insp_oses in
 
   (* Add top level operating systems. *)
-  List.iter (add_top_level_os t name) data.Slave.insp_oses;
+  List.iter (add_top_level_os t name) data.insp_oses;
 
   (* Add top level left-over filesystems. *)
   DeviceSet.iter (add_top_level_vol t name) other_filesystems;
 
+  (* If it's Windows and registry files exist, create a node for
+   * each file.
+   *)
+  List.iter (
+    fun os ->
+      (match os.insp_winreg_SAM with
+       | Some filename ->
+           add_top_level_winreg t name os "HKEY_LOCAL_MACHINE\\SAM" filename
+       | None -> ()
+      );
+      (match os.insp_winreg_SECURITY with
+       | Some filename ->
+           add_top_level_winreg t name os "HKEY_LOCAL_MACHINE\\SECURITY"
+             filename
+       | None -> ()
+      );
+      (match os.insp_winreg_SOFTWARE with
+       | Some filename ->
+           add_top_level_winreg t name os "HKEY_LOCAL_MACHINE\\SOFTWARE"
+             filename
+       | None -> ()
+      );
+      (match os.insp_winreg_SYSTEM with
+       | Some filename ->
+           add_top_level_winreg t name os "HKEY_LOCAL_MACHINE\\SYSTEM"
+             filename
+       | None -> ()
+      );
+      (match os.insp_winreg_DEFAULT with
+       | Some filename ->
+           add_top_level_winreg t name os "HKEY_USERS\\.DEFAULT" filename
+       | None -> ()
+      );
+  ) data.insp_oses;
+
   (* Expand the first top level node. *)
   match model#get_iter_first with
   | None -> ()
   | Some row ->
       t.view#expand_row (model#get_path row)
 
-and add_top_level_os ({ model = model; hash = hash } as t) name os =
+(* Add a top level operating system node. *)
+and add_top_level_os ({ model = model } as t) name os =
   let markup =
     sprintf "<b>%s</b>\n<small>%s</small>\n<small>%s</small>"
-      (markup_escape name) (markup_escape os.Slave.insp_hostname)
-      (markup_escape os.Slave.insp_product_name) in
+      (markup_escape name) (markup_escape os.insp_hostname)
+      (markup_escape os.insp_product_name) in
 
   let row = model#append () in
-  make_node t row (Top (Slave.OS os));
+  make_node t row (Top (OS os)) None;
   model#set ~row ~column:t.name_col markup
 
-and add_top_level_vol ({ model = model; hash = hash } as t) name dev =
+(* Add a top level volume (left over filesystem) node. *)
+and add_top_level_vol ({ model = model } as t) name dev =
   let markup =
     sprintf "<b>%s</b>\n<small>from %s</small>"
       (markup_escape dev) (markup_escape name) in
 
   let row = model#append () in
-  make_node t row (Top (Slave.Volume dev));
+  make_node t row (Top (Volume dev)) None;
+  model#set ~row ~column:t.name_col markup
+
+(* Add a top level Windows Registry node. *)
+and add_top_level_winreg ({ model = model } as t) name os rootkey
+    remotefile =
+  let cachefile = tmpdir // string_of_int (unique ()) ^ ".hive" in
+
+  let markup =
+    sprintf "<b>%s</b>\n<small>from %s</small>"
+      (markup_escape rootkey) (markup_escape name) in
+
+  let row = model#append () in
+  make_node t row
+    (TopWinReg (OS os, rootkey, remotefile, cachefile)) None;
   model#set ~row ~column:t.name_col markup
 
 (* Generic function to make an openable node to the tree. *)
-and make_node ({ model = model; hash = hash } as t) row content =
-  let hdata = { state=NodeNotStarted; content=content; visited=false } in
+and make_node ({ model = model } as t) row content hiveh =
+  let hdata =
+    { state=NodeNotStarted; content=content; visited=false; hiveh=hiveh } in
   store_hdata t row hdata;
 
   (* Create a placeholder "loading ..." row underneath this node so
    * the user has something to expand.
    *)
   let placeholder = model#append ~parent:row () in
-  let hdata = { state=IsLeaf; content=Loading; visited=false } in
+  let hdata = { state=IsLeaf; content=Loading; visited=false; hiveh=None } in
   store_hdata t placeholder hdata;
   model#set ~row:placeholder ~column:t.name_col "<i>Loading ...</i>";
   ignore (t.view#connect#row_expanded ~callback:(expand_row t))
 
-and make_leaf ({ model = model; hash = hash } as t) row content =
-  let hdata = { state=IsLeaf; content=content; visited=false } in
+and make_leaf ({ model = model } as t) row content hiveh =
+  let hdata = { state=IsLeaf; content=content; visited=false; hiveh=hiveh } in
   store_hdata t row hdata
 
 (* This is called when the user expands a row. *)
-and expand_row ({ model = model; hash = hash } as t) row _ =
+and expand_row ({ model = model } as t) row _ =
   match get_hdata t row with
   | { state=NodeNotStarted; content=Top src } as hdata ->
       (* User has opened a top level node that was not previously opened. *)
@@ -396,10 +431,39 @@ and expand_row ({ model = model; hash = hash } as t) row _ =
       Slave.read_directory ~fail:(when_read_directory_fail t path)
         src pathname (when_read_directory t path)
 
+  | { state=NodeNotStarted;
+      content=TopWinReg (src, rootkey, remotefile, cachefile) } as hdata ->
+      (* User has opened a Windows Registry top level node
+       * not previously opened.
+       *)
+
+      (* Mark this row as loading. *)
+      hdata.state <- NodeLoading;
+
+      (* Get a stable path for this row. *)
+      let path = model#get_path row in
+
+      (* Since the user has opened this top level registry node for the
+       * first time, we now need to download the hive.
+       *)
+      cache_registry_file ~fail:(when_downloaded_registry_fail t path)
+        t path src remotefile cachefile (when_downloaded_registry t path)
+
+  | { state=NodeNotStarted; content=RegKey node } as hdata ->
+      (* User has opened a Windows Registry key node not previously opened. *)
+
+      (* Mark this row as loading. *)
+      hdata.state <- NodeLoading;
+
+      expand_hive_node t row node
+
+  (* Ignore when a user opens a node which is loading or has been loaded. *)
   | { state=(NodeLoading|IsNode) } -> ()
 
-  (* These are not nodes so it should never be possible to open them. *)
-  | { content=File _ } | { state=IsLeaf } -> assert false
+  (* In some circumstances these can be nodes, eg. if we have added Info
+   * nodes below them.  Just ignore them if opened.
+   *)
+  | { content=(File _ | RegValue _) } | { state=IsLeaf } -> ()
 
   (* Node should not exist in the tree. *)
   | { state=NodeNotStarted; content=(Loading | ErrorMessage _ | Info _) } ->
@@ -411,16 +475,22 @@ and when_read_directory ({ model = model } as t) path entries =
 
   let row = model#get_iter path in
 
+  (* Sort the entries by lexicographic ordering. *)
+  let cmp { dent_name = n1 } { dent_name = n2 } =
+    UTF8.compare n1 n2
+  in
+  let entries = List.sort ~cmp entries in
+
   (* Add the entries. *)
   List.iter (
     fun direntry ->
-      let { Slave.dent_name = name; dent_stat = stat; dent_link = link } =
+      let { dent_name = name; dent_stat = stat; dent_link = link } =
         direntry in
       let row = model#append ~parent:row () in
       if is_directory stat.G.mode then
-        make_node t row (Directory direntry)
+        make_node t row (Directory direntry) None
       else
-        make_leaf t row (File direntry);
+        make_leaf t row (File direntry) None;
       model#set ~row ~column:t.name_col (markup_of_name direntry);
       model#set ~row ~column:t.mode_col (markup_of_mode stat.G.mode);
       model#set ~row ~column:t.size_col (markup_of_size stat.G.size);
@@ -455,7 +525,41 @@ and when_read_directory_fail ({ model = model } as t) path exn =
       let row = model#get_iter path in
       let row = model#iter_children ~nth:0 (Some row) in
 
-      let hdata = { state=IsLeaf; content=ErrorMessage msg; visited=false } in
+      let hdata =
+        { state=IsLeaf; content=ErrorMessage msg; visited=false; hiveh=None } in
+      store_hdata t row hdata;
+
+      model#set ~row ~column:t.name_col (markup_escape msg)
+
+  | exn ->
+      (* unexpected exception: re-raise it *)
+      raise exn
+
+(* Called when the top level registry node has been opened and the
+ * hive file was downloaded to the cache file successfully.
+ *)
+and when_downloaded_registry ({ model = model } as t) path () =
+  debug "when_downloaded_registry";
+  let row = model#get_iter path in
+  let hdata = get_hdata t row in
+  let h = Option.get hdata.hiveh in
+
+  (* Continue as if expanding any other hive node. *)
+  let root = Hivex.root h in
+  expand_hive_node t row root
+
+(* Called instead of {!when_downloaded_registry} if the download failed. *)
+and when_downloaded_registry_fail ({ model = model } as t) path exn =
+  debug "when_downloaded_registry_fail: %s" (Printexc.to_string exn);
+
+  match exn with
+  | G.Error msg
+  | Hivex.Error (_, _, msg) ->
+      let row = model#get_iter path in
+      let row = model#iter_children ~nth:0 (Some row) in
+
+      let hdata =
+        { state=IsLeaf; content=ErrorMessage msg; visited=false; hiveh=None } in
       store_hdata t row hdata;
 
       model#set ~row ~column:t.name_col (markup_escape msg)
@@ -463,3 +567,47 @@ and when_read_directory_fail ({ model = model } as t) path exn =
   | exn ->
       (* unexpected exception: re-raise it *)
       raise exn
+
+(* Expand a hive node. *)
+and expand_hive_node ({ model = model } as t) row node =
+  debug "expand_hive_node";
+  let hdata = get_hdata t row in
+  let h = Option.get hdata.hiveh in
+
+  (* Read the hive entries (values, subkeys) at this node and add them
+   * to the tree.
+   *)
+  let values = Hivex.node_values h node in
+  let cmp v1 v2 = UTF8.compare (Hivex.value_key h v1) (Hivex.value_key h v2) in
+  Array.sort cmp values;
+  Array.iter (
+    fun value ->
+      let row = model#append ~parent:row () in
+      make_leaf t row (RegValue value) (Some h);
+      model#set ~row ~column:t.name_col (markup_of_regvalue h value);
+      model#set ~row ~column:t.size_col (markup_of_regvaluesize h value);
+      model#set ~row ~column:t.date_col (markup_of_regvaluetype h value);
+  ) values;
+
+  let children = Hivex.node_children h node in
+  let cmp n1 n2 = UTF8.compare (Hivex.node_name h n1) (Hivex.node_name h n2) in
+  Array.sort cmp children;
+  Array.iter (
+    fun node ->
+      let row = model#append ~parent:row () in
+      make_node t row (RegKey node) (Some h);
+      model#set ~row ~column:t.name_col (markup_of_regkey h node);
+  ) children;
+
+  (* Remove the placeholder "Loading" entry.  NB. Must be done AFTER
+   * adding the other entries, or else Gtk will unexpand the row.
+   *)
+  (try
+     let row = find_child_node_by_content t row Loading in
+     ignore (model#remove row)
+   with Invalid_argument _ | Not_found -> ()
+  );
+
+  (* The original entry has now been loaded, so update its state. *)
+  hdata.state <- IsNode;
+  set_visited t row