(* Guestfs Browser.
* Copyright (C) 2010 Red Hat Inc.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*)
open ExtString
open ExtList
open Printf
open Utils
open DeviceSet
open Filetree_type
open Filetree_ops
module G = Guestfs
type t = Filetree_type.t
let rec create ?status ~packing () =
let view = GTree.view ~packing () in
(*view#set_rules_hint true;*)
(*view#selection#set_mode `MULTIPLE; -- add this later *)
(* Hash of index numbers -> hdata. We do this because it's more
* efficient for the GC compared to storing OCaml objects directly in
* the rows.
*)
let hash = Hashtbl.create 1023 in
(* The columns stored in each row. The hidden [index_col] column is
* an index into the hash table that records everything else about
* this row (see hdata above). The other display columns, eg.
* [name_col] contain Pango markup and thus have to be escaped.
*)
let cols = new GTree.column_list in
(* Hidden: *)
let index_col = cols#add Gobject.Data.int in
(* Displayed: *)
let mode_col = cols#add Gobject.Data.string in
let name_col = cols#add Gobject.Data.string in
let size_col = cols#add Gobject.Data.int64 in
let date_col = cols#add Gobject.Data.string in
let link_col = cols#add Gobject.Data.string in
(* Create the model. *)
let model = GTree.tree_store cols in
view#set_model (Some (model :> GTree.model));
let renderer = GTree.cell_renderer_text [], ["markup", mode_col] in
let mode_view = GTree.view_column ~title:"Permissions" ~renderer () in
ignore (view#append_column mode_view);
let renderer = GTree.cell_renderer_text [], ["markup", name_col] in
let name_view = GTree.view_column ~title:"Filename" ~renderer () in
name_view#set_max_width 300 (*pixels?!?*);
ignore (view#append_column name_view);
let renderer = GTree.cell_renderer_text [], ["text", size_col] in
let size_view = GTree.view_column ~title:"Size" ~renderer () in
ignore (view#append_column size_view);
let renderer = GTree.cell_renderer_text [], ["markup", date_col] in
let date_view = GTree.view_column ~title:"Date" ~renderer () in
ignore (view#append_column date_view);
let renderer = GTree.cell_renderer_text [], ["markup", link_col] in
let link_view = GTree.view_column ~title:"Link" ~renderer () in
ignore (view#append_column link_view);
let t = {
view = view; model = model; hash = hash;
index_col = index_col;
mode_col = mode_col; name_col = name_col; size_col = size_col;
date_col = date_col; link_col = link_col;
status = status
} in
(* Open a context menu when a button is pressed. *)
ignore (view#event#connect#button_press ~callback:(button_press t));
t
(* Handle mouse button press on the selected row. This opens the
* pop-up context menu.
* http://scentric.net/tutorial/sec-selections-context-menus.html
*)
and button_press ({ model = model; view = view } as t) ev =
let button = GdkEvent.Button.button ev in
let x = int_of_float (GdkEvent.Button.x ev) in
let y = int_of_float (GdkEvent.Button.y ev) in
let time = GdkEvent.Button.time ev in
(* Right button for opening the context menu. *)
if button = 3 then (
(*
(* If no row is selected, select the row under the mouse. *)
let paths =
let sel = view#selection in
if sel#count_selected_rows < 1 then (
match view#get_path_at_pos ~x ~y with
| None -> []
| Some (path, _, _, _) ->
sel#unselect_all ();
sel#select_path path;
[path]
) else
sel#get_selected_rows (* actually returns paths *) in
*)
(* Select the row under the mouse. *)
let paths =
let sel = view#selection in
match view#get_path_at_pos ~x ~y with
| None -> []
| Some (path, _, _, _) ->
sel#unselect_all ();
sel#select_path path;
[path] in
(* Get the hdata for all the paths. Filter out rows that it doesn't
* make sense to select.
*)
let paths =
List.filter_map (
fun path ->
let row = model#get_iter path in
let hdata = get_hdata t row in
match hdata with
| _, (Loading | ErrorMessage _) -> None
| _, (Top _ | Directory _ | File _) -> 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
);
(* Return true so no other handler will run. *)
true
)
(* We didn't handle this, defer to other handlers. *)
else false
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 "File information" in
item#misc#set_sensitive false;
let item = factory#add_item "Checksum" in
item#misc#set_sensitive false;
ignore (factory#add_separator ());
let item = factory#add_item "Download ..." in
ignore (item#connect#activate ~callback:(download_file t path));
and add_directory_items path =
let item = factory#add_item "Directory information" in
item#misc#set_sensitive false;
let item = factory#add_item "Space used by directory" in
item#misc#set_sensitive false;
ignore (factory#add_separator ());
let item = factory#add_item "Download ..." in
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));
let item = factory#add_item "Download as .tar.gz ..." in
ignore (item#connect#activate
~callback:(download_dir_tarball t Slave.TGZ path));
let item = factory#add_item "Download as .tar.xz ..." in
ignore (item#connect#activate
~callback:(download_dir_tarball t Slave.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 =
let item = factory#add_item "Operating system information" in
item#misc#set_sensitive false;
let item = factory#add_item "Block device information" in
item#misc#set_sensitive false;
let item = factory#add_item "Filesystem used & free" in
item#misc#set_sensitive false;
ignore (factory#add_separator ());
add_directory_items path
and add_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
in
(match paths with
(* single selection *)
| [path, (_, Top (Slave.OS os))] -> (* top level operating system *)
add_os_items path
| [path, (_, Top (Slave.Volume dev))] -> (* top level volume *)
add_volume_items path
| [path, (_, Directory direntry)] -> (* directory *)
add_directory_items path
| [path, (_, File direntry)] -> (* file *)
add_file_items path
| [_, (_, Loading)]
| [_, (_, ErrorMessage _)] -> ()
| _ ->
(* At the moment multiple selection is disabled. When/if we
* enable it we should do something intelligent here. XXX
*)
()
);
menu
(* XXX No binding for g_markup_escape in lablgtk2. *)
let markup_escape name =
let f = function
| '&' -> "&" | '<' -> "<" | '>' -> ">"
| c -> String.make 1 c
in
String.replace_chars f name
(* Mark up a filename for the name_col column. *)
let rec markup_of_name name =
markup_escape name
(* Mark up symbolic links. *)
and markup_of_link link =
let link = markup_escape link in
if link <> "" then utf8_rarrow ^ " " ^ link else ""
(* Mark up mode. *)
and 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 test_bit 0o400L mode then 'r' else '-' in
let wu = if test_bit 0o200L mode then 'w' else '-' in
let xu = if test_bit 0o100L mode then 'x' else '-' in
let rg = if test_bit 0o40L mode then 'r' else '-' in
let wg = if test_bit 0o20L mode then 'w' else '-' in
let xg = if test_bit 0o10L mode then 'x' else '-' in
let ro = if test_bit 0o4L mode then 'r' else '-' in
let wo = if test_bit 0o2L mode then 'w' else '-' in
let xo = if test_bit 0o1L 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 = test_bit 0o4000L mode in
let sgid = test_bit 0o2000L mode in
let svtx = test_bit 0o1000L mode in
if suid then str.[3] <- 's';
if sgid then str.[6] <- 's';
if svtx then str.[9] <- 't';
"" ^ str ^ ""
(* File type tests. *)
and file_type mask mode = Int64.logand mode 0o170000L = mask
and is_socket mode = file_type 0o140000L mode
and is_symlink mode = file_type 0o120000L mode
and is_regular_file mode = file_type 0o100000L mode
and is_block mode = file_type 0o060000L mode
and is_directory mode = file_type 0o040000L mode
and is_char mode = file_type 0o020000L mode
and is_fifo mode = file_type 0o010000L mode
and test_bit mask mode = Int64.logand mode mask = mask
(* Mark up dates. *)
and markup_of_date time =
let time = Int64.to_float time in
let tm = Unix.localtime time in
sprintf "%04d-%02d-%02d %02d:%02d:%02d"
(tm.Unix.tm_year + 1900) (tm.Unix.tm_mon + 1) tm.Unix.tm_mday
tm.Unix.tm_hour tm.Unix.tm_min tm.Unix.tm_sec
let clear { model = model; hash = hash } =
model#clear ();
Hashtbl.clear hash
let rec add ({ model = model; hash = hash } as t) name data =
clear t;
(* Populate the top level of the filetree. If there are operating
* systems from inspection, these have their own top level entries
* followed by only unreferenced filesystems. If we didn't get
* anything from inspection, then at the top level we just show
* filesystems.
*)
let other_filesystems =
DeviceSet.of_list (List.map fst data.Slave.insp_all_filesystems) in
let other_filesystems =
List.fold_left (fun set { Slave.insp_filesystems = fses } ->
DeviceSet.subtract set (DeviceSet.of_array fses))
other_filesystems data.Slave.insp_oses in
(* Add top level operating systems. *)
List.iter (add_top_level_os t name) data.Slave.insp_oses;
(* Add top level left-over filesystems. *)
DeviceSet.iter (add_top_level_vol t name) other_filesystems;
(* 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 =
let markup =
sprintf "%s\n%s\n%s"
(markup_escape name) (markup_escape os.Slave.insp_hostname)
(markup_escape os.Slave.insp_product_name) in
let row = model#append () in
make_node t row (Top (Slave.OS os));
model#set ~row ~column:t.name_col markup
and add_top_level_vol ({ model = model; hash = hash } as t) name dev =
let markup =
sprintf "%s\nfrom %s"
(markup_escape dev) (markup_escape name) in
let row = model#append () in
make_node t row (Top (Slave.Volume dev));
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 = NodeNotStarted, content 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 = IsLeaf, Loading in
store_hdata t placeholder hdata;
model#set ~row:placeholder ~column:t.name_col "Loading ...";
ignore (t.view#connect#row_expanded ~callback:(expand_row t))
and make_leaf ({ model = model; hash = hash } as t) row content =
let hdata = IsLeaf, content 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 _ =
match get_hdata t row with
| NodeNotStarted, Top src ->
(* User has opened a top level node that was not previously opened. *)
(* Mark this row as loading, so we don't try to open it again. *)
let hdata = NodeLoading, Top src in
store_hdata t row hdata;
(* Get a stable path for this row. *)
let path = model#get_path row in
Slave.read_directory ~fail:(when_read_directory_fail t path)
src "/" (when_read_directory t path)
| NodeNotStarted, Directory direntry ->
(* User has opened a filesystem directory not previously opened. *)
(* Mark this row as loading. *)
let hdata = NodeLoading, Directory direntry in
store_hdata t row hdata;
(* Get a stable path for this row. *)
let path = model#get_path row in
let src, pathname = get_pathname t row in
Slave.read_directory ~fail:(when_read_directory_fail t path)
src pathname (when_read_directory t path)
| NodeLoading, _ | IsNode, _ -> ()
(* These are not nodes so it should never be possible to open them. *)
| _, File _ | IsLeaf, _ -> assert false
(* Node should not exist in the tree. *)
| NodeNotStarted, (Loading | ErrorMessage _) -> assert false
(* This is the callback when the slave has read the directory for us. *)
and when_read_directory ({ model = model } as t) path entries =
debug "when_read_directory";
let row = model#get_iter path in
(* Add the entries. *)
List.iter (
fun direntry ->
let { Slave.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)
else
make_leaf t row (File direntry);
model#set ~row ~column:t.name_col (markup_of_name name);
model#set ~row ~column:t.mode_col (markup_of_mode stat.G.mode);
model#set ~row ~column:t.size_col stat.G.size;
model#set ~row ~column:t.date_col (markup_of_date stat.G.mtime);
model#set ~row ~column:t.link_col (markup_of_link link)
) entries;
(* Remove the placeholder entry. NB. Must be done AFTER adding
* the other entries, or else Gtk will unexpand the row.
*)
(try
let placeholder = model#iter_children ~nth:0 (Some row) in
ignore (model#remove placeholder)
with Invalid_argument _ -> ()
);
(* The original directory entry has now been loaded, so
* update its state.
*)
let state, content = get_hdata t row in
let hdata = IsNode, content in
store_hdata t row hdata
(* This is called instead of when_read_directory when the read directory
* (or mount etc) failed. Convert the "Loading" entry into the
* error message.
*)
and when_read_directory_fail ({ model = model } as t) path exn =
debug "when_read_directory_fail: %s" (Printexc.to_string exn);
match exn with
| G.Error msg ->
let row = model#get_iter path in
let row = model#iter_children ~nth:0 (Some row) in
let hdata = IsLeaf, ErrorMessage msg in
store_hdata t row hdata;
model#set ~row ~column:t.name_col (markup_escape msg)
| exn ->
(* unexpected exception: re-raise it *)
raise exn
let set_status_fn t status =
t.status <- Some status