Merge lp:~mhr3/dockmanager/metadata-update into lp:dockmanager

[Michal Hruby]

[Robert Dyer (psybers)]

First of all, your diff includes way more than what you wanted. You should fix that up.

Second, what is the point to the metadata changes? What is the format used? Is it just a true INI file format? Must we verify the section is named 'DEFAULT'? What if it isnt, do we still use it? Will we allow other sections, if so what are those?

review: Needs Fixing

[Michal Hruby (mhr3)]

It includes changes to the daemon which read this format, so it's related.

It's standard key-file format used everywhere (and parser for it available in glib), section name is required in keyfiles, therefore if it's not there, it's invalid. As for supporting more sections and/or keys it's easily possible when needed.

[Robert Dyer (psybers)]

Ok but the name of the section, is that a standard? Or are we going to just grab the first section in the file? What if there are more sections?

[Michal Hruby (mhr3)]

The APIs reading keyfiles usually need both group name and key name, so you shouldn't just grab the first one, anyway maybe we should use something more specific than "DEFAULT" (for example .desktop files use "DesktopEntry"), perhaps "DockmanagerHelper"?

[Rico Tzschichholz (ricotz)]

The new metadata-file format is fine. "DockmanagerHelper" sounds good.

[lp:~mhr3/dockmanager/metadata-update]

32. By Michal Hruby on 2010-06-05

Use DockmanagerHelper

[Michal Hruby (mhr3)]

Branch updated, please merge when Docky is ready to handle it.

=== modified file 'configure.ac'
--- configure.ac	2010-06-02 11:27:12 +0000
+++ configure.ac	2010-06-05 13:05:33 +0000
@@ -13,18 +13,17 @@
 
 dnl Bzr Revno, if release set BZR_REVNO to the release version number
 if test -d $top_srcdir/.bzr ; then
-	BZR_REVNO=`bzr version-info --custom \
-	--template="{revno}"`
+	BZR_REVNO=`bzr revno`
 else
 	BZR_REVNO=0.1
 fi
 AC_SUBST(BZR_REVNO)
 
-if test -d $top_srcdir/.bzr ; then
+if test -e $top_srcdir/.version_info ; then
+   VERSION_INFO=`cat .version_info`
+elif test -d $top_srcdir/.bzr ; then
    VERSION_INFO=`bzr version-info --custom \
    --template="bzr {branch_nick} r{revno}"`
-elif test -e $top_srcdir/.version_info ; then
-   VERSION_INFO=`cat .version_info`
 else
    VERSION_INFO="Release"
 fi
 
=== modified file 'daemon/dockmanager-daemon.vala'
--- daemon/dockmanager-daemon.vala	2010-06-02 09:39:27 +0000
+++ daemon/dockmanager-daemon.vala	2010-06-05 13:05:33 +0000
@@ -24,12 +24,35 @@
 
 namespace DockManager
 {
+  const string GROUP_NAME = "DockmanagerHelper";
+
+  public struct HelperInfo
+  {
+    string path;
+    string? name;
+    string? description;
+    string? icon_name;
+    string? app_name;
+    bool app_available;
+  }
+
+  private struct HelperProcessInfo
+  {
+    int pid;
+    uint timer_id;
+  }
+
   [DBus (name = "org.dockmanager.Daemon")]
   public interface DaemonInterface: GLib.Object
   {
+    public abstract HelperInfo[] get_all_helpers () throws DBus.Error;
+    public abstract void run_helper (string path) throws DBus.Error;
+    public abstract void stop_helper (string path) throws DBus.Error;
+    public abstract void restart_all () throws DBus.Error;
     public abstract void show_preferences () throws DBus.Error;
     public abstract void embed_preferences (int64 xid) throws DBus.Error;
-    public abstract void restart_all () throws DBus.Error;
+
+    public signal void helper_stopped (string path);
   }
 
   const string DBUS_UNIQUE_NAME = "org.dockmanager.Daemon";
@@ -50,11 +73,14 @@
       }
     }
 
-    private HashTable<string, int> helpers;
+    private HashTable<string, HelperProcessInfo?> helper_process_info;
+    private List<HelperInfo?> all_scripts;
 
     public HelperDaemon ()
     {
-      helpers = new HashTable<string, int> (str_hash, str_equal);
+      helper_process_info = 
+        new HashTable<string, HelperProcessInfo?> (str_hash, str_equal);
+      all_scripts = new List<HelperInfo?> ();
     }
 
     public override void constructed ()
@@ -92,6 +118,7 @@
         {
           connection.register_object ("/org/dockmanager/Daemon", this);
 
+          this.init ();
           this.run_helpers ();
 
           Gtk.main ();
@@ -107,47 +134,172 @@
       }
     }
 
+    private void init ()
+    {
+      string[] prefixes = 
+      {
+        Build.PKGDATADIR,
+        Environment.get_user_data_dir () + "/dockmanager"
+      };
+
+      foreach (unowned string prefix in prefixes)
+      {
+        string path = prefix + "/scripts";
+        string metadata_dir = prefix + "/metadata/";
+        var scripts_dir = DesktopAgnostic.VFS.file_new_for_path (path);
+        if (!scripts_dir.exists ()) continue;
+
+        foreach (var f in scripts_dir.enumerate_children ())
+        {
+          var hi = HelperInfo ();
+          hi.path = f.path;
+          hi.app_available = true; // probably... we'll set it later
+          all_scripts.append (hi);
+        }
+
+        foreach (unowned HelperInfo? hi in all_scripts)
+        {
+          string metadata = metadata_dir + Path.get_basename (hi.path) + ".info";
+          var metadata_file = DesktopAgnostic.VFS.file_new_for_path (metadata);
+          if (!metadata_file.exists ()) continue;
+
+          string contents;
+          size_t length;
+          metadata_file.load_contents (out contents, out length);
+
+          var keyfile = new KeyFile ();
+          try
+          {
+            keyfile.load_from_data (contents, length, KeyFileFlags.NONE);
+          }
+          catch (KeyFileError err)
+          {
+            warning ("Cannot load %s: %s", metadata, err.message);
+            continue;
+          }
+
+          try
+          {
+            hi.name = keyfile.get_string (GROUP_NAME, "Name");
+            hi.description = keyfile.get_string (GROUP_NAME, "Description");
+          }
+          catch (KeyFileError err)
+          {
+            warning ("Required key missing in %s", metadata);
+            continue;
+          }
+          try
+          {
+            hi.icon_name = keyfile.get_string (GROUP_NAME, "Icon");
+          }
+          catch (KeyFileError err) { }
+          try
+          {
+            int status;
+            hi.app_name = keyfile.get_string (GROUP_NAME, "AppName");
+            Process.spawn_command_line_sync ("which " + hi.app_name, null, null,
+                                             out status);
+            hi.app_available = status == 0;
+          }
+          catch (GLib.Error err)
+          {
+            warning ("%s", err.message);
+          }
+        }
+      }
+    }
+
     public void run_helpers ()
     {
       foreach (Value v in _helper_list)
       {
         unowned string helper = v.get_string ();
-        int pid = run_helper (helper);
-        helpers.insert (helper, pid);
+        run_helper (helper);
       }
 
-      helpers.@foreach ((k, v) =>
+      helper_process_info.@foreach ((k, v) =>
       {
         unowned string key = (string) k;
-        int val = (int)(long) v;
-        debug ("%s: %d", key, val);
+        unowned HelperProcessInfo? val = (HelperProcessInfo?) v;
+        debug ("%s: %d", key, val.pid);
       });
     }
 
-    public int run_helper (string uri)
+    private int get_helper_pid (string path)
+    {
+      unowned HelperProcessInfo? hpi = helper_process_info.lookup (path);
+      return hpi != null ? hpi.pid : 0;
+    }
+
+    public void run_helper (string path) throws DBus.Error
     {
       Pid child_pid = 0;
       string[] argv;
 
+      if (get_helper_pid (path) != 0)
+      {
+        debug ("%s is already running", path);
+        return;
+      }
+
       try
       {
-        Shell.parse_argv (uri, out argv);
+        Shell.parse_argv (path, out argv);
         var flags = SpawnFlags.DO_NOT_REAP_CHILD | SpawnFlags.SEARCH_PATH;
         Process.spawn_async (null, argv, null, flags, null, out child_pid);
-        ChildWatch.add (child_pid, this.child_died);
+        ChildWatch.add_full (Priority.DEFAULT, child_pid, (pid, status) =>
+        {
+          debug ("[%d] \"%s\" exitted", pid, Path.get_basename (path));
+          unowned HelperProcessInfo? hpi = helper_process_info.lookup (path);
+          if (hpi != null)
+          {
+            if (hpi.timer_id != 0)
+            {
+              Source.remove (hpi.timer_id);
+            }
+            hpi.pid = 0;
+            hpi.timer_id = 0;
+          }
+          Process.close_pid (pid);
+          helper_stopped (path);
+        });
       }
       catch (GLib.Error err)
       {
         warning ("%s", err.message);
-        return 0;
+        throw new DBus.Error.SPAWN_FAILED (err.message);
       }
 
-      return (int)child_pid;
+      unowned HelperProcessInfo? hpi = helper_process_info.lookup (path);
+      if (hpi != null)
+      {
+        hpi.pid = (int) child_pid;
+      }
+      else
+      {
+        var pi = HelperProcessInfo ();
+        pi.pid = (int) child_pid;
+        helper_process_info.insert (path, pi);
+      }
     }
 
-    private void child_died (Pid pid, int status)
+    public void stop_helper (string path) throws DBus.Error
     {
-      debug ("[%d] died, status: %d", pid, status);
+      int pid = get_helper_pid (path);
+      if (pid == 0) return;
+
+      unowned HelperProcessInfo? hpi = helper_process_info.lookup (path);
+      Posix.kill ((Posix.pid_t)pid, Posix.SIGTERM);
+
+      hpi.timer_id = Timeout.add (2000, () =>
+      {
+        if (hpi.pid != 0)
+        {
+          Posix.kill ((Posix.pid_t)hpi.pid, Posix.SIGKILL);
+        }
+        hpi.timer_id = 0;
+        return false;
+      });
     }
 
     public void show_preferences ()
@@ -158,6 +310,27 @@
     {
     }
 
+    public HelperInfo[] get_all_helpers ()
+    {
+      int i = 0;
+
+      HelperInfo[] helpers = new HelperInfo [all_scripts.length ()];
+      foreach (unowned HelperInfo hi in all_scripts)
+      {
+        // our custom copy, dbus doesn't like NULLs
+        helpers[i].path = hi.path;
+        helpers[i].name = hi.name != null ? hi.name : "";
+        helpers[i].description = hi.description != null ? hi.description : "";
+        helpers[i].icon_name = hi.icon_name != null ? hi.icon_name : "";
+        helpers[i].app_name = hi.app_name != null ? hi.app_name : "";
+        helpers[i].app_available = hi.app_available;
+
+        i++;
+      }
+
+      return helpers;
+    }
+
     public void restart_all ()
     {
     }
 
=== modified file 'metadata/banshee_control.py.info'
--- metadata/banshee_control.py.info	2010-06-02 02:54:39 +0000
+++ metadata/banshee_control.py.info	2010-06-05 13:05:33 +0000
@@ -1,4 +1,5 @@
-NAME="Banshee Controls"
-DESCRIPTION="Control Banshee media playback"
-ICON="banshee"
-APPURI="/usr/bin/banshee"
+[DockmanagerHelper]
+Name=Banshee Controls
+Description=Control Banshee media playback
+Icon=banshee
+AppName=banshee
 
=== modified file 'metadata/deluge_badge.py.info'
--- metadata/deluge_badge.py.info	2010-06-02 02:54:39 +0000
+++ metadata/deluge_badge.py.info	2010-06-05 13:05:33 +0000
@@ -1,4 +1,5 @@
-NAME="Deluge"
-DESCRIPTION="Show transfer rates"
-ICON="deluge"
-APPURI="/usr/bin/deluge"
+[DockmanagerHelper]
+Name=Deluge
+Description=Show transfer rates
+Icon=deluge
+AppName=deluge
 
=== modified file 'metadata/emesene_control.py.info'
--- metadata/emesene_control.py.info	2010-06-02 02:54:39 +0000
+++ metadata/emesene_control.py.info	2010-06-05 13:05:33 +0000
@@ -1,4 +1,5 @@
-NAME="Emesene Controls"
-DESCRIPTION="See your message count status on Emesene"
-ICON="emesene"
-APPURI="/usr/bin/emesene"
+[DockmanagerHelper]
+Name=Emesene Controls
+Description=See your message count status on Emesene
+Icon=emesene
+AppName=emesene
 
=== modified file 'metadata/gajim_badge.py.info'
--- metadata/gajim_badge.py.info	2010-06-02 02:54:39 +0000
+++ metadata/gajim_badge.py.info	2010-06-05 13:05:33 +0000
@@ -1,4 +1,5 @@
-NAME="Gajim"
-DESCRIPTION="Shows new messages count"
-ICON="gajim"
-APPURI="/usr/bin/gajim"
+[DockmanagerHelper]
+Name=Gajim
+Description=Shows new messages count
+Icon=gajim
+AppName=gajim
 
=== modified file 'metadata/gtg_menus.py.info'
--- metadata/gtg_menus.py.info	2010-06-02 02:54:39 +0000
+++ metadata/gtg_menus.py.info	2010-06-05 13:05:33 +0000
@@ -1,4 +1,5 @@
-NAME="Getting Things GNOME!"
-DESCRIPTION="Access your tasks"
-ICON="gtg"
-APPURI="/usr/bin/gtg"
+[DockmanagerHelper]
+Name=Getting Things GNOME!
+Description=Access your tasks
+Icon=gtg
+AppName=gtg
 
=== modified file 'metadata/liferea_badge.py.info'
--- metadata/liferea_badge.py.info	2010-06-02 02:54:39 +0000
+++ metadata/liferea_badge.py.info	2010-06-05 13:05:33 +0000
@@ -1,4 +1,5 @@
-NAME="Liferea"
-DESCRIPTION="Shows unread messages count"
-ICON="liferea"
-APPURI="/usr/bin/liferea"
+[DockmanagerHelper]
+Name=Liferea
+Description=Shows unread messages count
+Icon=liferea
+AppName=liferea
 
=== modified file 'metadata/open_terminal_here.py.info'
--- metadata/open_terminal_here.py.info	2010-06-02 02:54:39 +0000
+++ metadata/open_terminal_here.py.info	2010-06-05 13:05:33 +0000
@@ -1,4 +1,5 @@
-NAME="Open Terminal Here"
-DESCRIPTION="Opens a terminal at the selected location"
-ICON="gnome-terminal"
-APPURI="/usr/bin/gnome-terminal"
+[DockmanagerHelper]
+Name=Open Terminal Here
+Description=Opens a terminal at the selected location
+Icon=gnome-terminal
+AppName=gnome-terminal
 
=== modified file 'metadata/pidgin_control.py.info'
--- metadata/pidgin_control.py.info	2010-06-02 02:54:39 +0000
+++ metadata/pidgin_control.py.info	2010-06-05 13:05:33 +0000
@@ -1,4 +1,5 @@
-NAME="Pidgin Controls"
-DESCRIPTION="Control your availability and connectivity status on Pidgin"
-ICON="pidgin"
-APPURI="/usr/bin/pidgin"
+[DockmanagerHelper]
+Name=Pidgin Controls
+Description=Control your availability and connectivity status on Pidgin
+Icon=pidgin
+AppName=pidgin
 
=== modified file 'metadata/rhythmbox_control.py.info'
--- metadata/rhythmbox_control.py.info	2010-06-02 02:54:39 +0000
+++ metadata/rhythmbox_control.py.info	2010-06-05 13:05:33 +0000
@@ -1,4 +1,5 @@
-NAME="Rhythmbox Controls"
-DESCRIPTION="Control Rhythmbox media playback"
-ICON="rhythmbox"
-APPURI="/usr/bin/rhythmbox"
+[DockmanagerHelper]
+Name=Rhythmbox Controls
+Description=Control Rhythmbox media playback
+Icon=rhythmbox
+AppName=rhythmbox
 
=== modified file 'metadata/tomboy_menus.py.info'
--- metadata/tomboy_menus.py.info	2010-06-02 02:54:39 +0000
+++ metadata/tomboy_menus.py.info	2010-06-05 13:05:33 +0000
@@ -1,4 +1,5 @@
-NAME="Tomboy Notes"
-DESCRIPTION="Access your Tomboy notes"
-ICON="tomboy"
-APPURI="/usr/bin/tomboy"
+[DockmanagerHelper]
+Name=Tomboy Notes
+Description=Access your Tomboy notes
+Icon=tomboy
+AppName=tomboy
 
=== modified file 'metadata/transmission_badge.py.info'
--- metadata/transmission_badge.py.info	2010-06-02 02:54:39 +0000
+++ metadata/transmission_badge.py.info	2010-06-05 13:05:33 +0000
@@ -1,4 +1,5 @@
-NAME="Transmission"
-DESCRIPTION="Show transfer rates"
-ICON="transmission"
-APPURI="/usr/bin/transmission"
+[DockmanagerHelper]
+Name=Transmission
+Description=Show transfer rates
+Icon=transmission
+AppName=transmission
 
=== modified file 'metadata/tsclient_menus.py.info'
--- metadata/tsclient_menus.py.info	2010-06-02 02:54:39 +0000
+++ metadata/tsclient_menus.py.info	2010-06-05 13:05:33 +0000
@@ -1,4 +1,5 @@
-NAME="Terminal Server Client"
-DESCRIPTION="Jump directly to Terminal Server Client bookmarks"
-ICON="tsclient"
-APPURI="/usr/bin/tsclient"
+[DockmanagerHelper]
+Name=Terminal Server Client
+Description=Jump directly to Terminal Server Client bookmarks
+Icon=tsclient
+AppName=tsclient
 
=== modified file 'metadata/zeitgeist_journal.py.info'
--- metadata/zeitgeist_journal.py.info	2010-06-02 10:08:48 +0000
+++ metadata/zeitgeist_journal.py.info	2010-06-05 13:05:33 +0000
@@ -1,3 +1,4 @@
-NAME="Zeitgeist Journal"
-DESCRIPTION="Provides a journal of all activity for the selected application supplied by Zeitgeist"
-APPURI="/usr/bin/zeitgeist-daemon"
+[DockmanagerHelper]
+Name=Zeitgeist Journal
+Description=Provides a journal of all activity for the selected application supplied by Zeitgeist
+AppName=zeitgeist-daemon
 
=== modified file 'metadata/zeitgeist_menus.py.info'
--- metadata/zeitgeist_menus.py.info	2010-06-02 10:08:48 +0000
+++ metadata/zeitgeist_menus.py.info	2010-06-05 13:05:33 +0000
@@ -1,3 +1,4 @@
-NAME="Zeitgeist Integration"
-DESCRIPTION="Interfaces with Zeitgeist to supply a list of most used items for an application"
-APPURI="/usr/bin/zeitgeist-daemon"
+[DockmanagerHelper]
+Name=Zeitgeist Integration
+Description=Interfaces with Zeitgeist to supply a list of most used items for an application
+AppName=zeitgeist-daemon