ShellAppSystem: Add favorites API and shell_app_system_lookup_basename

Add a GConf key for favorites, and API for retrieving them.

Also add shell_app_system_lookup_basename, which we use from
the app monitor to look up WM_CLASS ids.

data/gnome-shell.schemas

@@ -15,6 +15,21 @@
 	</locale>
       </schema>
 
+      <schema>
+        <key>/schemas/desktop/gnome/shell/favorite_apps</key>
+	<applyto>/desktop/gnome/shell/favorite_apps</applyto>
+	<owner>gnome-shell</owner>
+	<type>list</type>
+	<listtype>string</listtype>
+	<default>[mozilla-firefox.desktop,evolution.desktop,openoffice.org-writer.desktop]</default>
+	<locale name="C">
+	  <short>List of desktop file IDs for favorite applications</short>
+	  <long>
+        The applications corresponding to these identifiers will be displayed in the favorites area.
+	  </long>
+	</locale>
+      </schema>
+
   </schemalist>
 
 </gconfschemafile>

src/shell-app-monitor.c

@@ -279,7 +279,7 @@ get_appid_for_window (MetaWindow     *window)
 {
   char *wmclass;
   char *with_desktop;
-  char *fullpath;
+  char *result;
   ShellAppSystem *appsys;
 
   wmclass = get_cleaned_wmclass_for_window (window);
@@ -291,10 +291,10 @@ get_appid_for_window (MetaWindow     *window)
   g_free (wmclass);
 
   appsys = shell_app_system_get_default ();
+  result = shell_app_system_lookup_basename (appsys, with_desktop);
+  g_free (with_desktop);
 
-  fullpath = shell_app_system_lookup_basename (appsys, with_desktop);
+  return result;
-
-  return fullpath;
 }
 
 static void

src/shell-app-system.c

@@ -1,19 +1,25 @@
 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
 
 #include "shell-app-system.h"
+#include <string.h>
 
 #include <gio/gio.h>
+#include <gconf/gconf.h>
+#include <gconf/gconf-client.h>
 
 #define GMENU_I_KNOW_THIS_IS_UNSTABLE
 #include <gmenu-tree.h>
 
+#define SHELL_APP_FAVORITES_KEY "/desktop/gnome/shell/favorite_apps"
+
 enum {
    PROP_0,
 
 };
 
 enum {
-  CHANGED,
+  INSTALLED_CHANGED,
+  FAVORITES_CHANGED,
   LAST_SIGNAL
 };
 
@@ -26,11 +32,17 @@ struct _ShellAppSystemPrivate {
   GSList *cached_app_menus; /* ShellAppMenuEntry */
 
   GSList *cached_setting_ids; /* utf8 */
+
+  GHashTable *cached_favorites; /* <utf8,integer> */
+
+  gint app_monitor_id;
 };
 
 static void shell_app_system_finalize (GObject *object);
 static void on_tree_changed (GMenuTree *tree, gpointer user_data);
 static void reread_menus (ShellAppSystem *self);
+static void on_favorite_apps_changed (GConfClient *client, guint id, GConfEntry *entry, gpointer user_data);
+static void reread_favorite_apps (ShellAppSystem *system);
 
 G_DEFINE_TYPE(ShellAppSystem, shell_app_system, G_TYPE_OBJECT);
 
@@ -63,11 +75,19 @@ static void shell_app_system_class_init(ShellAppSystemClass *klass)
 
   gobject_class->finalize = shell_app_system_finalize;
 
-  signals[CHANGED] =
+  signals[INSTALLED_CHANGED] =
-    g_signal_new ("changed",
+    g_signal_new ("installed-changed",
 		  SHELL_TYPE_APP_SYSTEM,
 		  G_SIGNAL_RUN_LAST,
-		  G_STRUCT_OFFSET (ShellAppSystemClass, changed),
+		  G_STRUCT_OFFSET (ShellAppSystemClass, installed_changed),
+		  NULL, NULL,
+		  g_cclosure_marshal_VOID__VOID,
+		  G_TYPE_NONE, 0);
+  signals[FAVORITES_CHANGED] =
+    g_signal_new ("favorites-changed",
+                  SHELL_TYPE_APP_SYSTEM,
+                  G_SIGNAL_RUN_LAST,
+                  G_STRUCT_OFFSET (ShellAppSystemClass, favorites_changed),
                   NULL, NULL,
                   g_cclosure_marshal_VOID__VOID,
                   G_TYPE_NONE, 0);
@@ -79,10 +99,16 @@ static void
 shell_app_system_init (ShellAppSystem *self)
 {
   ShellAppSystemPrivate *priv;
+  GConfClient *client;
+
   self->priv = priv = G_TYPE_INSTANCE_GET_PRIVATE (self,
                                                    SHELL_TYPE_APP_SYSTEM,
                                                    ShellAppSystemPrivate);
 
+  priv->cached_favorites = g_hash_table_new_full (g_str_hash, g_str_equal,
+                                                  (GDestroyNotify)g_free,
+                                                  NULL);
+
   priv->apps_tree = gmenu_tree_lookup ("applications.menu", GMENU_TREE_FLAGS_NONE);
   priv->settings_tree = gmenu_tree_lookup ("settings.menu", GMENU_TREE_FLAGS_NONE);
 
@@ -90,6 +116,12 @@ shell_app_system_init (ShellAppSystem *self)
   gmenu_tree_add_monitor (priv->settings_tree, on_tree_changed, self);
 
   reread_menus (self);
+
+  client = gconf_client_get_default ();
+
+  self->priv->app_monitor_id = gconf_client_notify_add (client, SHELL_APP_FAVORITES_KEY,
+                                                        on_favorite_apps_changed, self, NULL, NULL);
+  reread_favorite_apps (self);
 }
 
 static void
@@ -112,13 +144,16 @@ shell_app_system_finalize (GObject *object)
   g_slist_free (priv->cached_setting_ids);
   priv->cached_setting_ids = NULL;
 
+  g_hash_table_destroy (priv->cached_favorites);
+
+  gconf_client_notify_remove (gconf_client_get_default (), priv->app_monitor_id);
+
   G_OBJECT_CLASS (shell_app_system_parent_class)->finalize(object);
 }
 
 static void
 reread_directories (ShellAppSystem *self, GSList **cache, GMenuTree *tree)
 {
-  ShellAppSystemPrivate *priv = self->priv;
   GMenuTreeDirectory *trunk;
   GSList *entries;
   GSList *iter;
@@ -228,11 +263,58 @@ on_tree_changed (GMenuTree *monitor, gpointer user_data)
 {
   ShellAppSystem *self = SHELL_APP_SYSTEM (user_data);
 
-  g_signal_emit (self, signals[CHANGED], 0);
+  g_signal_emit (self, signals[INSTALLED_CHANGED], 0);
 
   reread_menus (self);
 }
 
+static void
+copy_gconf_value_string_list_to_hashset (GConfValue *value,
+                                         GHashTable *dest)
+{
+  GSList *list;
+  GSList *tmp;
+
+  list = gconf_value_get_list (value);
+
+  for (tmp = list ; tmp; tmp = tmp->next)
+    {
+      GConfValue *value = tmp->data;
+      char *str = g_strdup (gconf_value_get_string (value));
+      if (!str)
+        continue;
+      g_hash_table_insert (dest, str, GUINT_TO_POINTER(1));
+    }
+}
+
+static void
+reread_favorite_apps (ShellAppSystem *system)
+{
+  GConfClient *client = gconf_client_get_default ();
+  GConfValue *val;
+
+  val = gconf_client_get (client, SHELL_APP_FAVORITES_KEY, NULL);
+
+  if (!(val && val->type == GCONF_VALUE_LIST && gconf_value_get_list_type (val) == GCONF_VALUE_STRING))
+    return;
+
+  g_hash_table_remove_all (system->priv->cached_favorites);
+  copy_gconf_value_string_list_to_hashset (val, system->priv->cached_favorites);
+
+  gconf_value_free (val);
+}
+
+void
+on_favorite_apps_changed (GConfClient *client,
+                          guint        id,
+                          GConfEntry  *entry,
+                          gpointer     user_data)
+{
+  ShellAppSystem *system = SHELL_APP_SYSTEM (user_data);
+  reread_favorite_apps (system);
+  g_signal_emit (G_OBJECT (system), signals[FAVORITES_CHANGED], 0);
+}
+
 GType
 shell_app_menu_entry_get_type (void)
 {
@@ -315,3 +397,160 @@ shell_app_system_get_default ()
 
   return instance;
 }
+
+/**
+ * shell_app_system_get_favorites:
+ *
+ * Return the list of applications which have been explicitly added to the
+ * favorites.
+ *
+ * Return value: (transfer container) (element-type utf8): List of favorite application ids
+ */
+GList *
+shell_app_system_get_favorites (ShellAppSystem *system)
+{
+  return g_hash_table_get_keys (system->priv->cached_favorites);
+}
+
+static void
+set_gconf_value_string_list (GConfValue *val, GList *items)
+{
+  GList *iter;
+  GSList *tmp = NULL;
+
+  for (iter = items; iter; iter = iter->next)
+    {
+      const char *str = iter->data;
+      GConfValue *strval = gconf_value_new (GCONF_VALUE_STRING);
+      gconf_value_set_string (strval, str);
+      tmp = g_slist_prepend (tmp, strval);
+    }
+  tmp = g_slist_reverse (tmp);
+
+  gconf_value_set_list (val, tmp);
+  g_slist_free (tmp);
+}
+
+void
+shell_app_system_add_favorite (ShellAppSystem *system, const char *id)
+{
+  GConfClient *client = gconf_client_get_default ();
+  GConfValue *val;
+  GList *favorites;
+
+  val = gconf_value_new (GCONF_VALUE_LIST);
+  gconf_value_set_list_type (val, GCONF_VALUE_STRING);
+
+  g_hash_table_insert (system->priv->cached_favorites, g_strdup (id), GUINT_TO_POINTER (1));
+
+  favorites = g_hash_table_get_keys (system->priv->cached_favorites);
+  set_gconf_value_string_list (val, favorites);
+  g_list_free (favorites);
+
+  gconf_client_set (client, SHELL_APP_FAVORITES_KEY, val, NULL);
+}
+
+void
+shell_app_system_remove_favorite (ShellAppSystem *system, const char *id)
+{
+  GConfClient *client = gconf_client_get_default ();
+  GConfValue *val;
+  GList *favorites;
+
+  if (!g_hash_table_remove (system->priv->cached_favorites, id))
+    return;
+
+  val = gconf_value_new (GCONF_VALUE_LIST);
+  gconf_value_set_list_type (val, GCONF_VALUE_STRING);
+
+  favorites = g_hash_table_get_keys (system->priv->cached_favorites);
+  set_gconf_value_string_list (val, favorites);
+  g_list_free (favorites);
+
+  gconf_client_set (client, SHELL_APP_FAVORITES_KEY, val, NULL);
+}
+
+static gboolean
+desktop_id_exists (ShellAppSystem      *system,
+                   const char          *target_id,
+                   GMenuTreeDirectory  *root)
+{
+  gboolean found = FALSE;
+  GSList *contents, *iter;
+
+  contents = gmenu_tree_directory_get_contents (root);
+
+  for (iter = contents; iter; iter = iter->next)
+    {
+      GMenuTreeItem *item = iter->data;
+
+      if (found)
+        break;
+
+      switch (gmenu_tree_item_get_type (item))
+        {
+          case GMENU_TREE_ITEM_ENTRY:
+            {
+              GMenuTreeEntry *entry = (GMenuTreeEntry *)item;
+              const char *id = gmenu_tree_entry_get_desktop_file_id (entry);
+              if (strcmp (id, target_id) == 0)
+                found = TRUE;
+            }
+            break;
+          case GMENU_TREE_ITEM_DIRECTORY:
+            {
+              GMenuTreeDirectory *dir = (GMenuTreeDirectory*)item;
+              found = desktop_id_exists (system, target_id, dir);
+            }
+            break;
+          default:
+            break;
+        }
+      gmenu_tree_item_unref (item);
+    }
+
+  g_slist_free (contents);
+
+  return found;
+}
+
+/**
+ * shell_app_system_lookup_basename:
+ * @name: Probable application identifier
+ *
+ * Determine whether a valid .desktop file ID corresponding to a given
+ * heuristically determined application identifier
+ * string.
+ */
+char *
+shell_app_system_lookup_basename (ShellAppSystem *system,
+                                  const char *name)
+{
+  GMenuTreeDirectory *root;
+  char *result;
+
+  root = gmenu_tree_get_directory_from_path (system->priv->apps_tree, "/");
+  g_assert (root != NULL);
+
+  if (desktop_id_exists (system, name, root))
+    {
+      result = g_strdup (name);
+      goto out;
+    }
+
+  /* These are common "vendor prefixes".  But using
+   * WM_CLASS as a source, we don't get the vendor
+   * prefix.  So try stripping them.
+   */
+  result = g_strjoin ("", "gnome-", name, NULL);
+  if (desktop_id_exists (system, result, root))
+    goto out;
+
+  result = g_strjoin ("", "fedora-", name, NULL);
+  if (desktop_id_exists (system, result, root))
+    goto out;
+
+out:
+  gmenu_tree_item_unref (root);
+  return result;
+}

src/shell-app-system.h

@@ -25,7 +25,8 @@ struct _ShellAppSystemClass
 {
   GObjectClass parent_class;
 
-  void (*changed)(ShellAppSystem *appsys, gpointer data);
+  void (*installed_changed)(ShellAppSystem *appsys, gpointer user_data);
+  void (*favorites_changed)(ShellAppSystem *appsys, gpointer user_data);
 };
 
 GType shell_app_system_get_type (void) G_GNUC_CONST;
@@ -43,8 +44,16 @@ struct _ShellAppMenuEntry {
 
 GType shell_app_menu_entry_get_type (void);
 
+char * shell_app_system_lookup_basename (ShellAppSystem *system, const char *id);
+
 GSList *shell_app_system_get_menus (ShellAppSystem *system);
 
 GSList *shell_app_system_get_all_settings (ShellAppSystem *system);
 
+GList *shell_app_system_get_favorites (ShellAppSystem *system);
+
+void shell_app_system_add_favorite (ShellAppSystem *system, const char *id);
+
+void shell_app_system_remove_favorite (ShellAppSystem *system, const char *id);
+
 #endif /* __SHELL_APP_SYSTEM_H__ */