Merge lp:~jeremy-munsch/synapse-project/virtualbox-plugin into lp:synapse-project

[Jeremy Munsch]

Search for virtual machines and provides actions for it
using libxmlbird since librest xml is buggy/harassing to work with.

[lp:~jeremy-munsch/synapse-project/virtualbox-plugin]

634. By Rico Tzschichholz on 2015-11-30

ui/controller: Some optimization accessing model.query[] in search*()

635. By Rico Tzschichholz on 2015-11-30

core/query: Cache and reuse Regex.escape_string (query)

636. By Rico Tzschichholz on 2015-11-30

debian: Bump build-deps accordingly

637. By Rico Tzschichholz on 2016-02-26

plugins: Add suport for MATE Screensaver

638. By Rico Tzschichholz on 2016-02-26

po: Update translations

639. By Rico Tzschichholz on 2016-02-27

desktop-file-plugin: correct ApplicationsMatch to DesktopFileMatch

640. By Rico Tzschichholz on 2016-02-27

src: Drop "using Gee;"

641. By Rico Tzschichholz on 2016-02-27

src: Drop "using Json;"

642. By Rico Tzschichholz on 2016-02-27

src: Drop "using Zeitgeist;"

643. By Rico Tzschichholz on 2016-02-27

src: Drop "using Gtk;"

644. By Rico Tzschichholz on 2016-02-27

src: Drop "using Cairo;"

645. By Rico Tzschichholz on 2016-02-27

src: Drop last usages of "using *;"

646. By Rico Tzschichholz on 2016-02-27

ui: Show release-name in about-dialog only

647. By Rico Tzschichholz on 2016-02-27

ui: Bump to 2016

648. By Rico Tzschichholz on 2016-02-28

Release 0.2.99.2

649. By Rico Tzschichholz on 2016-03-02

ui: Set and update client-window of Gtk.IMMulticontext

650. By Rico Tzschichholz on 2016-03-08

main: Properly construct OptionEntry

Stop using an empty string where is getting treated as translateable.

651. By Michael Aquilina on 2016-04-01

Add pass plugin

652. By Rico Tzschichholz on 2016-09-29

Fix non-matching generic types

653. By Rico Tzschichholz on 2016-10-06

Fix non-matching generic types of interface implementations

654. By Jeremy Munsch on 2016-12-16

add virtualbox plugin
add libxmlbird dependency

Unmerged revisions

654. By Jeremy Munsch on 2016-12-16

add virtualbox plugin
add libxmlbird dependency

=== modified file 'configure.ac'
--- configure.ac	2016-02-28 12:40:08 +0000
+++ configure.ac	2016-12-16 21:07:04 +0000
@@ -62,7 +62,8 @@
   gee-0.8 >= $MIN_GEE_VERSION \
   json-glib-1.0 >= $MIN_JSON_VERSION \
   keybinder-3.0 \
-  libnotify
+  libnotify \
+  xmlbird
   )
 SYNAPSE_MODULES_VALAFLAGS=" --pkg gdk-x11-3.0 \
   --pkg gtk+-3.0 \
@@ -71,6 +72,7 @@
   --pkg gee-0.8 \
   --pkg json-glib-1.0 \
   --pkg keybinder-3.0 \
+  --pkg xmlbird \
   --pkg libnotify"
 AC_SUBST(SYNAPSE_MODULES_VALAFLAGS)
 
 
=== modified file 'debian/control'
--- debian/control	2015-11-30 14:47:10 +0000
+++ debian/control	2016-12-16 21:07:04 +0000
@@ -15,6 +15,7 @@
  libkeybinder-3.0-dev,
  libnotify-dev,
  librest-dev,
+ libxmlbird-dev,
  libappindicator3-dev (>= 0.0.7)
 Vcs-Bzr: http://bazaar.launchpad.net/~synapse-core/synapse-project/trunk/
 Vcs-Browser: http://bazaar.launchpad.net/~synapse-core/synapse-project/trunk/files
 
=== modified file 'src/plugins/Makefile.am'
--- src/plugins/Makefile.am	2016-04-01 05:58:51 +0000
+++ src/plugins/Makefile.am	2016-12-16 21:07:04 +0000
@@ -53,6 +53,7 @@
 	test-slow-plugin.vala \
 	xnoise-media-player-plugin.vala \
 	system-management.vala \
+	virtualbox-plugin.vala \
 	zeal-plugin.vala \
 	$(NULL)
 
 
=== added file 'src/plugins/virtualbox-plugin.vala'
--- src/plugins/virtualbox-plugin.vala	1970-01-01 00:00:00 +0000
+++ src/plugins/virtualbox-plugin.vala	2016-12-16 21:07:04 +0000
@@ -0,0 +1,437 @@
+/*
+ * Copyright (C) 2015 Jérémy Munsch <[e-mail]>
+ *
+ * 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 St, Fifth Floor, Boston, MA 02110-1301  USA.
+ *
+ * Note :
+ *   Using libxmlbird since librest is buggy/pain to use
+ *
+ * What is does :
+ *   Search hosts virtual machines and provides
+ *   some actions took from virtualbox --help
+ */
+
+using B;
+
+namespace Synapse
+{
+  private errordomain VMParseError { ERROR }
+
+  public class VirtualBoxPlugin : Object, Activatable, ItemProvider, ActionProvider
+  {
+    public bool enabled { get; set; default = true; }
+
+    public static string virtualbox_config_dir { get; private set; default = "VirtualBox"; }
+    public static string virtualbox_vm_dir { get; private set; }
+
+    private Gee.List<VirtualBoxMachineMatch> machines;
+    private Gee.List<VirtualBoxAction> actions;
+
+    public void activate ()
+    {
+      parse_vm_config.begin ();
+    }
+
+    public void deactivate ()
+    {
+    }
+
+    static void register_plugin ()
+    {
+      PluginRegistry.get_default ().register_plugin (
+        typeof (VirtualBoxPlugin),
+        _("VirtualBox"),
+        _("Control you virtual machines"),
+        "virtualbox",
+        register_plugin,
+        Environment.find_program_in_path ("virtualbox") != null,
+        _("Unable to find \"virtualbox\" program")
+      );
+    }
+
+    static construct
+    {
+      register_plugin ();
+      virtualbox_config_dir = Path.build_filename (Environment.get_user_config_dir (), virtualbox_config_dir);
+    }
+
+    construct
+    {
+      machines = new Gee.ArrayList<VirtualBoxMachineMatch> ();
+      actions = new Gee.ArrayList<VirtualBoxAction> ();
+      actions.add (new StartVirtualMachine ());
+      actions.add (new StartFullscreenVirtualMachine ());
+      actions.add (new StartSeemlessVirtualMachine ());
+      actions.add (new StartScaleVirtualMachine ());
+      actions.add (new RestoreVirtualMachine ());
+      actions.add (new StartPausedVirtualMachine ());
+      actions.add (new StartSeparateVirtualMachine ());
+    }
+
+    public bool handles_query (Query query)
+    {
+      return (QueryFlags.APPLICATIONS in query.query_type);
+    }
+
+    public async ResultSet? search (Query q) throws SearchError
+    {
+      var results = new ResultSet ();
+
+      var matchers = Query.get_matchers_for_query (q.query_string, MatcherFlags.NO_FUZZY,  RegexCompileFlags.OPTIMIZE | RegexCompileFlags.CASELESS);
+      foreach (var matcher in matchers)
+      {
+        foreach (var machine in machines)
+        {
+          q.check_cancellable ();
+          if (matcher.key.match (machine.title))
+          {
+            results.add (machine, matcher.value);
+          }
+        }
+      }
+      return results;
+    }
+
+    public ResultSet? find_for_match (ref Query q, Match match)
+    {
+      if (!actions[0].valid_for_match (match)) return null;
+
+      var matchers = Query.get_matchers_for_query (q.query_string, 0,  RegexCompileFlags.OPTIMIZE | RegexCompileFlags.CASELESS);
+
+      var results = new ResultSet ();
+      foreach (var matcher in matchers)
+      {
+        foreach (var action in actions)
+        {
+          if (matcher.key.match (action.title))
+          {
+            int relevancy = (match is StartVirtualMachine) ?
+            action.default_relevancy :
+            action.default_relevancy - MatchScore.INCREMENT_MINOR;
+            results.add (action, relevancy);
+          }
+        }
+      }
+      return results;
+    }
+
+
+    /**
+     * Actions
+     */
+
+    private abstract class VirtualBoxAction : Action
+    {
+      public abstract string command { get; set; }
+      public new virtual int default_relevancy { get; set; default = MatchScore.AVERAGE; }
+
+      public override bool valid_for_match (Match match)
+      {
+        return (match is VirtualBoxMachineMatch);
+      }
+
+      public override void do_execute (Match match, Match? target = null)
+      {
+        string cmd = command.printf (((VirtualBoxMachineMatch)match).uuid);
+        try
+        {
+          AppInfo ai = AppInfo.create_from_commandline (cmd, "virtualbox", 0);
+          if (!ai.launch (null, null))
+            warning ("Could not launch VirtualBox %s".printf (cmd));
+        }
+        catch (Error err)
+        {
+          warning ("Could not launch %s %s", cmd, err.message);
+        }
+      }
+    }
+
+    private class StartVirtualMachine : VirtualBoxAction
+    {
+      public override string command { get; set; default = "virtualbox --startvm %s"; }
+      public StartVirtualMachine ()
+      {
+        Object (title: _("Turn on"),
+                description: _("Start the virtual machine"),
+                icon_name: "virtualbox",
+                has_thumbnail: false);
+        default_relevancy = MatchScore.HIGHEST;
+      }
+    }
+
+    private class StartFullscreenVirtualMachine : VirtualBoxAction
+    {
+      public override string command { get; set; default = "virtualbox --startvm %s --fullscreen"; }
+      public StartFullscreenVirtualMachine ()
+      {
+        Object (title: _("Fullscreen"),
+                description: _("Start the virtual machine in fullscreen mode"),
+                icon_name: "virtualbox",
+                has_thumbnail: true);
+      }
+    }
+
+    private class StartSeemlessVirtualMachine : VirtualBoxAction
+    {
+      public override string command { get; set; default = "virtualbox --startvm %s --seamless"; }
+      public StartSeemlessVirtualMachine ()
+      {
+        Object (title: _("Seamless"),
+                description: _("Start the virtual machine in seamless mode"),
+                icon_name: "virtualbox",
+                has_thumbnail: false);
+      }
+    }
+
+    private class StartScaleVirtualMachine : VirtualBoxAction
+    {
+      public override string command { get; set; default = "virtualbox --startvm %s --scale"; }
+      public StartScaleVirtualMachine ()
+      {
+        Object (title: _("Scale"),
+                description: _("Start the virtual machine in scale mode"),
+                icon_name: "virtualbox",
+                has_thumbnail: false);
+      }
+    }
+
+    private class RestoreVirtualMachine : VirtualBoxAction
+    {
+      public override string command { get; set; default = "virtualbox --startvm %s --restore"; }
+      public RestoreVirtualMachine ()
+      {
+        Object (title: _("Restore"),
+                description: _("Restore the last vitual machine state"),
+                icon_name: "virtualbox",
+                has_thumbnail: false);
+      }
+    }
+
+    private class StartPausedVirtualMachine : VirtualBoxAction
+    {
+      public override string command { get; set; default = "virtualbox --startvm %s --start-paused"; }
+      public StartPausedVirtualMachine ()
+      {
+        Object (title: _("Start Paused"),
+                description: _("Start the virtual machine in paused state"),
+                icon_name: "virtualbox",
+                has_thumbnail: false);
+      }
+    }
+
+    private class StartSeparateVirtualMachine : VirtualBoxAction
+    {
+      public override string command { get; set; default = "virtualbox --startvm %s --separate"; }
+      public StartSeparateVirtualMachine ()
+      {
+        Object (title: _("Start Separated"),
+                description: _("Start the virtual machine in a separate process"),
+                icon_name: "virtualbox",
+                has_thumbnail: false);
+      }
+    }
+
+
+    /**
+     * Match
+     */
+
+    private class VirtualBoxMachineMatch : Match
+    {
+      public string name { get; set; }
+      public string uuid { get; set; }
+      public string src { get; set; }
+      public string os_type { get; set; }
+
+      public VirtualBoxMachineMatch (string name, string uuid, string src, string os_type)
+      {
+        Object (title: "VM %s  %s".printf (name, os_type),
+                description : "",
+                icon_name: "virtualbox",
+                has_thumbnail: false);
+        this.uuid = uuid;
+        this.src = src;
+        this.os_type = os_type;
+      }
+    }
+
+
+    /**
+     * private methods
+     */
+
+    private async void parse_vm_config ()
+    {
+      try
+      {
+        Gee.List<Tag> results = new Gee.ArrayList<Tag> ();
+        string vm_config_file = Path.build_filename (virtualbox_config_dir, "VirtualBox.xml");
+
+        Tag root = parse_xml_file (vm_config_file);
+
+        if (null == root)
+          throw new VMParseError.ERROR ("Failed to parse VirtualBox config file %s".printf (vm_config_file));
+
+        find_all_tags ("MachineEntry", root, ref results);
+
+        foreach (var machine_entry in results)
+        {
+          string uuid = get_attribute ("uuid", machine_entry) ?? null;
+          string src = get_attribute ("src", machine_entry) ?? null;
+
+          if (null == uuid || null == src)
+            throw new VMParseError.ERROR ("Could not get uuid %s or src %s from MachineEntry %s".printf (uuid, src, vm_config_file));
+
+          Idle.add_full (Priority.DEFAULT_IDLE, parse_vm_config.callback);
+          yield;
+
+          Tag machine_tag = parse_xml_file (src);
+
+          if (null == machine_tag)
+          {
+            message ("Failed to parse VirtualBox config file %s".printf (src));
+            continue;
+          }
+
+          machine_tag = find_first_tag ("Machine", machine_tag);
+
+          if (null == machine_tag)
+          {
+            message ("Could not get Machine from %s".printf (src));
+            continue;
+          }
+
+          string name = get_attribute ("name", machine_tag) ?? null;
+          string os_type = get_attribute ("OSType", machine_tag) ?? null;
+
+          if (null == name || null == os_type)
+          {
+            message ("Could not get name %s or ostype %s from MachineEntry %s".printf (name, os_type, src));
+            continue;
+          }
+
+          machines.add (new VirtualBoxMachineMatch (name, uuid, src, parse_os (os_type)));
+        }
+      }
+      catch (Error e)
+      {
+        warning ("%s".printf (e.message));
+      }
+    }
+
+    private string parse_os (string os_info)
+    {
+      int _pos = os_info.index_of_char ('_');
+      // 0: arch, 1: os, 2: version
+      string os[3] = {  -1 != _pos ? os_info.slice (_pos, os_info.length).replace ("_", "x") : "",
+                        -1 != _pos ? os_info.slice (0, _pos).replace ("_", "x") : os_info,
+                        "" };
+      try
+      {
+        os[2] = (new Regex ("[a-zA-Z]")).replace (os[1], os[1].length, 0, "");
+        os[1] = os[1].replace (os[2], "");
+        switch (os[1])
+        {
+          case "Linux":
+            if (os[2].length > 1) // eg: 22 -> 2.2
+              os[2] = os[2].substring (0, 1) + "." + os[2].substring (1);
+            break;
+          case "MacOS":
+            if (os[2].length > 2) // eg: 106 -> 10.6
+              os[2] = os[2].substring (0, 2) + "." + os[2].substring (2);
+            break;
+          case "Windows":
+            if ("81" == os[2])
+              os[2] = "8.1";
+            break;
+          case "L":
+              os[1] = "L4";
+              os[2] = "";
+            break;
+          case "OSx": // IBM
+              os[1] = "OS/x";
+              os[2] = "21";
+            break;
+          case "OS2Warp45": // IBM
+              os[1] = "OS/2 Warp";
+              os[2] = "45";
+            break;
+          case "OS2Warp4": // IBM
+              os[1] = "OS/2 Warp";
+              os[2] = "4";
+            break;
+          case "OSeCS": // IBM
+              os[1] = "OS/2 eCS";
+              os[2] = "";
+            break;
+        }
+      }
+      catch (Error e)
+      {
+        warning ("%s".printf (e.message));
+      }
+      return "%s %s  %s%s".printf (os[1], os[2], string.nfill (3-os[0].length, ' '), os[0]);
+    }
+
+    /**
+     * Xml methods
+     */
+
+    private void find_all_tags (string tag_name, Tag root, ref Gee.List<Tag> results)
+    {
+      foreach (Tag tag in root) {
+        if (tag_name == tag.get_name ())
+          results.add (tag);
+        else
+          find_all_tags (tag_name, tag, ref results);
+      }
+    }
+
+    private Tag? find_first_tag (string tag_name, Tag root)
+    {
+      foreach (Tag tag in root) {
+        if (tag_name == tag.get_name ())
+          return tag;
+        else
+          find_first_tag (tag_name, tag);
+      }
+      return null;
+    }
+
+    private string? get_attribute (string attribute_name, Tag tag) {
+      foreach (Attribute attribute in tag.get_attributes ()) {
+        if (attribute_name == attribute.get_name ())
+          return attribute.get_content ();
+      }
+      return null;
+    }
+
+    private Tag parse_xml_file (string file) throws FileError, VMParseError
+    {
+      size_t length;
+      string read;
+      FileUtils.get_contents (file, out read, out length);
+
+      XmlParser parser = new XmlParser (read);
+
+      if (!parser.validate ())
+      {
+          throw new VMParseError.ERROR ("Invalid XML %s".printf (file));
+      }
+
+      return parser.get_root_tag ();
+    }
+  }
+}
 
=== modified file 'src/ui/synapse-main.vala'
--- src/ui/synapse-main.vala	2016-04-01 05:58:51 +0000
+++ src/ui/synapse-main.vala	2016-12-16 21:07:04 +0000
@@ -183,6 +183,7 @@
 #endif
 #if HAVE_LIBREST
         typeof (ImgUrPlugin),
+        typeof (VirtualBoxPlugin),
 #endif
         // action-only plugins
         typeof (DevhelpPlugin),