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