window.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 Printf
  20
  21 open Utils
  22 open Slave_types
  23
  24 module G = Guestfs
  25
  26 (* Main window state. *)
  27 type window_state = {
  28   window : GWindow.window;
  29   view : Filetree.t;
  30   vmcombo : GEdit.combo_box GEdit.text_combo;
  31   refresh_button : GButton.button;
  32   throbber : GMisc.image;
  33   throbber_static : GdkPixbuf.pixbuf;
  34   statusbar : GMisc.statusbar;
  35   statusbar_context : GMisc.statusbar_context;
  36   progress_bar : GRange.progress_bar;
  37 }
  38
  39 (* Set the statusbar text. *)
  40 let set_statusbar ws msg =
  41   ws.statusbar_context#pop ();
  42   ignore (ws.statusbar_context#push msg)
  43
  44 (* Clear the filetree. *)
  45 let clear_view ws =
  46   Filetree.clear ws.view
  47
  48 (* Callback from Connect -> ... menu items. *)
  49 let rec connect_to ws uri =
  50   clear_view ws;
  51   Slave.discard_command_queue ();
  52   Slave.connect uri (when_connected ws uri)
  53
  54 (* Called back when connected to a new hypervisor. *)
  55 and when_connected ws uri doms =
  56   populate_vmcombo ws doms
  57
  58 and populate_vmcombo ws doms =
  59   (* Populate the VM combo box. *)
  60   let combo, (model, column) = ws.vmcombo in
  61   model#clear ();
  62   List.iter (
  63     fun { dom_name = name } ->
  64       let row = model#append () in
  65       model#set ~row ~column name
  66   ) doms
  67
  68 (* When a new domain is selected by the user, eg through vmcombo. *)
  69 let rec open_domain ws name =
  70   clear_view ws;
  71   Slave.discard_command_queue ();
  72   Slave.open_domain name (when_opened_domain ws name)
  73
  74 (* Called back when domain was opened successfully. *)
  75 and when_opened_domain ws name data =
  76   debug "when_opened_domain callback";
  77   when_opened_common ws name data
  78
  79 (* When a set of disk images is selected by the user. *)
  80 and open_disk_images ws images =
  81   match images with
  82   | [] -> ()
  83   | images ->
  84       clear_view ws;
  85       Slave.discard_command_queue ();
  86       Slave.open_images images (when_opened_disk_images ws images)
  87
  88 (* Called back when disk image(s) were opened successfully. *)
  89 and when_opened_disk_images ws images data =
  90   match images with
  91   | [] -> ()
  92   | (image, _) :: _ ->
  93       debug "when_opened_disk_images callback";
  94       when_opened_common ws image data
  95
  96 (* Common code for when_opened_domain/when_opened_disk_images. *)
  97 and when_opened_common ws name data =
  98   (* Dump some of the inspection data in debug messages. *)
  99   List.iter (fun (dev, t) -> debug "filesystem: %s: %s" dev t)
 100     data.insp_all_filesystems;
 101   List.iter (
 102     fun { insp_root = root; insp_type = typ; insp_distro = distro;
 103           insp_major_version = major; insp_minor_version = minor } ->
 104       debug "root device %s contains %s %s %d.%d" root typ distro major minor;
 105   ) data.insp_oses;
 106
 107   Filetree.add ws.view name data
 108
 109 let throbber_busy ws () =
 110   (*throbber#set_pixbuf animation*)
 111   (* XXX Workaround because no binding for GdkPixbufAnimation: *)
 112   let file = Filename.dirname Sys.argv.(0) // "Throbber.gif" in
 113   ws.throbber#set_file file
 114
 115 let throbber_idle ws () =
 116   ws.throbber#set_pixbuf ws.throbber_static
 117
 118 let progress ws (position, total) =
 119   if position = 0L && total = 1L then
 120     ws.progress_bar#pulse ()
 121   else (
 122     let frac = Int64.to_float position /. Int64.to_float total in
 123     if frac < 0. || frac > 1. then
 124       eprintf "warning: progress bar out of range: %Ld / %Ld (%g)\n"
 125         position total frac;
 126     let frac = if frac < 0. then 0. else if frac > 1. then 1. else frac in
 127     ws.progress_bar#set_fraction frac
 128   )
 129
 130 (* This is called in the main thread whenever a command fails in the
 131  * slave thread.  The command queue has been cleared before this is
 132  * called, so our job here is to reset the main window, and if
 133  * necessary to turn the exception into an error message.
 134  *)
 135 let failure ws exn =
 136   let title = "Error" in
 137   let msg = Printexc.to_string exn in
 138   debug "failure hook: %s" msg;
 139   let icon = GMisc.image () in
 140   icon#set_stock `DIALOG_ERROR;
 141   icon#set_icon_size `DIALOG;
 142   GToolbox.message_box ~title ~icon msg
 143
 144 let rec open_main_window () =
 145   (* I prototyped the basic window layout using Glade, but have
 146    * implemented it by hand to give us more flexibility.
 147    *)
 148   let title = "Guest Filesystem Browser" in
 149   let window = GWindow.window ~width:700 ~height:700 ~title () in
 150   let vbox = GPack.vbox ~packing:window#add () in
 151
 152   (* Menus. *)
 153   let connect_kvm_item, connect_xen_item, connect_none_item, _, _ =
 154     make_menubar window vbox ~packing:vbox#pack () in
 155
 156   (* Top toolbar. *)
 157   let vmcombo, refresh_button, throbber, throbber_static =
 158     make_toolbar ~packing:vbox#pack () in
 159
 160   (* Main part of display is the file tree. *)
 161   let view = make_filetree ~packing:(vbox#pack ~expand:true ~fill:true) () in
 162
 163   (* Status bar and progress bar. *)
 164   let hbox = GPack.hbox ~spacing:4 ~packing:vbox#pack () in
 165   let progress_bar = GRange.progress_bar ~packing:hbox#pack () in
 166   let statusbar = GMisc.statusbar ~packing:(hbox#pack ~expand:true) () in
 167   let statusbar_context = statusbar#new_context ~name:"Standard" in
 168   ignore (statusbar_context#push title);
 169
 170   window#show ();
 171
 172   (* Construct the window_state struct. *)
 173   let ws = {
 174     window = window;
 175     view = view;
 176     vmcombo = vmcombo;
 177     refresh_button = refresh_button;
 178     throbber = throbber; throbber_static = throbber_static;
 179     statusbar = statusbar; statusbar_context = statusbar_context;
 180     progress_bar = progress_bar
 181   } in
 182
 183   (* Connect up the callback for menu entries etc.  These require the
 184    * window_state struct in callbacks.
 185    *)
 186
 187   (* Connect to different hypervisors. *)
 188   ignore (connect_kvm_item#connect#activate
 189             ~callback:(fun () -> connect_to ws (Some "qemu:///system")));
 190   ignore (connect_xen_item#connect#activate
 191             ~callback:(fun () -> connect_to ws (Some "xen:///")));
 192   ignore (connect_none_item#connect#activate
 193             ~callback:(fun () -> connect_to ws None));
 194
 195   (* VM combo box when changed by the user.
 196    * The refresh button acts like changing the VM combo too.
 197    *)
 198   let combo, (model, column) = ws.vmcombo in
 199   ignore (
 200     combo#connect#changed
 201       ~callback:(
 202         fun () ->
 203           match combo#active_iter with
 204           | None -> () (* nothing selected *)
 205           | Some row -> open_domain ws (model#get ~row ~column)
 206       )
 207   );
 208   ignore (
 209     refresh_button#connect#clicked
 210       ~callback:(
 211         fun () ->
 212           match combo#active_iter with
 213           | None -> () (* nothing selected *)
 214           | Some row -> open_domain ws (model#get ~row ~column)
 215       )
 216   );
 217
 218   (* Return the window_state struct. *)
 219   ws
 220
 221 and make_menubar window vbox ~packing () =
 222   let menubar = GMenu.menu_bar ~packing:vbox#pack () in
 223   let factory = new GMenu.factory menubar in
 224   let accel_group = factory#accel_group in
 225   let connect_menu = factory#add_submenu "_Connect" in
 226
 227   let factory = new GMenu.factory connect_menu ~accel_group in
 228   let connect_kvm_item = factory#add_item "Connect to local _KVM hypervisor" in
 229   let connect_xen_item = factory#add_item "Connect to local _Xen hypervisor" in
 230   let connect_none_item = factory#add_item "_Connect to default hypervisor" in
 231   let connect_uri_item = factory#add_item "Connect to a _libvirt URI ..." in
 232   ignore (factory#add_separator ());
 233   let open_image_item =
 234     factory#add_item "_Open disk image ..." ~key:GdkKeysyms._O in
 235   ignore (factory#add_separator ());
 236   let quit_item = factory#add_item "E_xit" ~key:GdkKeysyms._Q in
 237
 238   (* Quit. *)
 239   let quit _ = GMain.quit (); false in
 240   ignore (window#connect#destroy ~callback:GMain.quit);
 241   ignore (window#event#connect#delete ~callback:quit);
 242   ignore (quit_item#connect#activate
 243             ~callback:(fun () -> ignore (quit ()); ()));
 244
 245   window#add_accel_group accel_group;
 246
 247   connect_kvm_item, connect_xen_item, connect_none_item,
 248   connect_uri_item, open_image_item
 249
 250 (* Top toolbar.  In fact, not a toolbar because you don't seem to be
 251  * able to put a combo box into a toolbar, so it's just an hbox for now.
 252  *)
 253 and make_toolbar ~packing () =
 254   let hbox = GPack.hbox ~border_width:4 ~packing () in
 255
 256   (* Combo box for displaying virtual machine names. *)
 257   hbox#pack (mklabel "Guest: ");
 258   let vmcombo = GEdit.combo_box_text ~packing:hbox#pack () in
 259
 260   (* Refresh button.
 261    * http://stackoverflow.com/questions/2188659/stock-icons-not-shown-on-buttons
 262    *)
 263   let refresh_button =
 264     let image = GMisc.image ~stock:`REFRESH () in
 265     let b = GButton.button ~packing:hbox#pack () in
 266     b#set_image (image :> GObj.widget);
 267     b in
 268
 269   (* Throbber. *)
 270   let static = Throbber.static () in
 271   (*let animation = Throbber.animation () in*)
 272   let throbber =
 273     (* Workaround for http://caml.inria.fr/mantis/view.php?id=4732 *)
 274     let from = Obj.magic 3448763 (* `END *) in
 275     GMisc.image ~pixbuf:static ~packing:(hbox#pack ~from) () in
 276
 277   vmcombo, refresh_button, throbber, static
 278
 279 and make_filetree ~packing () =
 280   let sw =
 281     GBin.scrolled_window ~packing ~hpolicy:`AUTOMATIC ~vpolicy:`ALWAYS () in
 282   Filetree.create ~packing:sw#add ()
 283
 284 (* Do what the user asked on the command line. *)
 285 let rec run_cli_request ws = function
 286   | Cmdline.Empty_window -> ()
 287   | Cmdline.Open_images images ->
 288       open_disk_images ws images
 289   | Cmdline.Open_guest guest ->
 290       (* Open libvirt connection, and in the callback open the guest. *)
 291       let uri = connect_uri () in
 292       Slave.connect uri (when_connected_cli_request ws guest)
 293 and when_connected_cli_request ws guest doms =
 294   populate_vmcombo ws doms;
 295
 296   (* "guest" should match a domain in "doms".  Check this and
 297    * get the index of it.
 298    *)
 299   let rec loop i = function
 300     | [] ->
 301         failwith "guest %s not found (do you need to use --connect?)" guest
 302     | d::ds when d = guest -> i
 303     | _::ds -> loop (i+1) ds
 304   in
 305   let i = loop 0 (List.map (fun { dom_name = name } -> name) doms) in
 306
 307   let combo, _ = ws.vmcombo in
 308   combo#set_active i