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