Merge lp:~3v1n0/bamf/wmclass-matching into lp:bamf/0.4

[Marco Trevisan (Treviño)]

Now bamf uses also the window WMCLASS parameter and the .desktop file StartupWMClass to associate a window to its application.
This causes that each bamf application should now have its own class; a window is considered as part of that application only if its wmclass matches the application one.

A desktop file is now associated to an application also considering the StartupWMClass key value.

[Mikkel Kamstrup Erlandsen (kamstrup)]

I am not sure I'm the right person to review this branch, but I got one nitpick nontheless :-)

The get_class() and set_class() methods on BamfApplication are not very binding friendly. If I called app.get_class() from Vala or PyGI it would normally give me the GObjectClass struct for the object, but this patch would override that method.

Maybe get/set_wmclass() instead?

[Marco Trevisan (Treviño) (3v1n0)]

Yes, you're right about that. I'll fix it.

[lp:~3v1n0/bamf/wmclass-matching]

392. By Marco Trevisan (Treviño) on 2011-03-29

application_class renamed as application_wmclass

To avoid gobjet get_class function overriding

393. By Marco Trevisan (Treviño) on 2011-03-29

Some code spaces cleanup.

[Jason Smith (jassmith)]

Works for me, looks good

review: Approve

=== modified file 'src/bamf-application.c'
--- src/bamf-application.c	2011-01-14 15:53:35 +0000
+++ src/bamf-application.c	2011-03-29 11:26:03 +0000
@@ -48,6 +48,7 @@
   GList * desktop_file_list;
   char * app_type;
   char * icon;
+  char * wmclass;
   gboolean is_tab_container;
   gboolean show_stubs;
 };
@@ -83,6 +84,19 @@
   return result;
 }
 
+char *
+bamf_application_get_wmclass (BamfApplication *application)
+{
+  BamfApplicationPrivate *priv;
+  char *result = NULL;
+
+  g_return_val_if_fail (BAMF_IS_APPLICATION (application), NULL);
+  priv = application->priv;
+
+  result = g_strdup (priv->wmclass);
+  return result;
+}
+
 static gboolean
 icon_name_is_valid (char *name)
 {
@@ -212,6 +226,18 @@
   bamf_application_setup_icon_and_name (application);
 }
 
+void
+bamf_application_set_wmclass (BamfApplication *application,
+                            char *wmclass)
+{
+  g_return_if_fail (BAMF_IS_APPLICATION (application));
+
+  if (wmclass && wmclass[0] != '\0')
+    application->priv->wmclass = g_strdup (wmclass);
+  else
+    application->priv->wmclass = NULL;
+}
+
 GArray *
 bamf_application_get_xids (BamfApplication *application)
 {
@@ -312,12 +338,15 @@
   GList *children, *l;
   BamfView *child;
 
-  g_return_val_if_fail (BAMF_IS_APPLICATION (view), NULL);  
+  g_return_val_if_fail (BAMF_IS_APPLICATION (view), NULL);
   self = BAMF_APPLICATION (view);
-  
+
+  if (self->priv->wmclass)
+    return g_strdup_printf ("application%i", abs (g_str_hash (self->priv->wmclass)));
+
   if (self->priv->desktop_file)
     return g_strdup_printf ("application%i", abs (g_str_hash (self->priv->desktop_file)));
-  
+
   children = bamf_view_get_children (BAMF_VIEW (self));
   for (l = children; l; l = l->next)
     {
@@ -562,6 +591,12 @@
       g_free (priv->app_type);
       priv->app_type = NULL;
     }
+
+  if (priv->wmclass)
+    {
+      g_free (priv->wmclass);
+      priv->wmclass = NULL;
+    }
   
   g_signal_handlers_disconnect_by_func (G_OBJECT (bamf_matcher_get_default ()), matcher_favorites_changed, object);
 
@@ -577,6 +612,7 @@
   priv->is_tab_container = FALSE;
   priv->app_type = g_strdup ("system");
   priv->show_stubs = TRUE;
+  priv->wmclass = NULL;
   
   g_signal_connect (G_OBJECT (bamf_matcher_get_default ()), "favorites-changed", 
                     (GCallback) matcher_favorites_changed, self);
@@ -651,6 +687,17 @@
   return application;  
 }
 
+BamfApplication *
+bamf_application_new_with_wmclass (char *wmclass)
+{
+  BamfApplication *application;
+  application = (BamfApplication *) g_object_new (BAMF_TYPE_APPLICATION, NULL);
+
+  bamf_application_set_wmclass (application, wmclass);
+
+  return application;
+}
+
 /**
     bamf_application_get_show_stubs:
     @application: Application to check for menu stubs
 
=== modified file 'src/bamf-application.h'
--- src/bamf-application.h	2010-09-11 02:52:33 +0000
+++ src/bamf-application.h	2011-03-29 11:26:03 +0000
@@ -66,6 +66,10 @@
 gboolean          bamf_application_contains_similar_to_window (BamfApplication *app, 
                                                                BamfWindow *window);
 
+char            * bamf_application_get_wmclass             (BamfApplication *application);
+void              bamf_application_set_wmclass             (BamfApplication *application,
+                                                            char *wmclass);
+
 BamfApplication * bamf_application_new                   (void);
 
 BamfApplication * bamf_application_new_from_desktop_file (char * desktop_file);
@@ -73,4 +77,6 @@
 
 BamfApplication * bamf_application_new_from_desktop_files (GList * desktop_files);
 
+BamfApplication * bamf_application_new_with_wmclass (char *wmclass);
+
 #endif
 
=== modified file 'src/bamf-matcher.c'
--- src/bamf-matcher.c	2011-03-15 12:09:16 +0000
+++ src/bamf-matcher.c	2011-03-29 11:26:03 +0000
@@ -61,6 +61,7 @@
   GArray          * known_pids;
   GHashTable      * desktop_id_table;
   GHashTable      * desktop_file_table;
+  GHashTable      * desktop_class_table;
   GHashTable      * exec_list;
   GHashTable      * registered_pids;
   GList           * views;
@@ -416,17 +417,43 @@
       file_list = g_list_append (file_list, datadup);
       id_list   = g_list_append (id_list,   datadup);
     }
-      
+
   g_hash_table_insert (desktop_file_table, g_strdup (exec),       file_list);
   g_hash_table_insert (desktop_id_table,   g_strdup (desktop_id), id_list);
-
+}
+
+static void
+insert_desktop_file_class_into_table (BamfMatcher *self,
+                                      const char *desktop_file,
+                                      GHashTable *desktop_class_table)
+{
+  GKeyFile *desktop_keyfile;
+  char *class;
+
+  g_return_if_fail (desktop_file);
+
+  desktop_keyfile = g_key_file_new ();
+
+  if (g_key_file_load_from_file (desktop_keyfile, desktop_file, G_KEY_FILE_NONE,
+                                 NULL))
+    {
+      class = g_key_file_get_string (desktop_keyfile,
+                                     G_KEY_FILE_DESKTOP_GROUP,
+                                     G_KEY_FILE_DESKTOP_KEY_STARTUP_WM_CLASS,
+                                     NULL);
+      if (class)
+        g_hash_table_insert (desktop_class_table, g_strdup (desktop_file), class);
+
+      g_key_file_free (desktop_keyfile);
+    }
 }
 
 static void
 load_desktop_file_to_table (BamfMatcher * self,
                             const char *file,
                             GHashTable *desktop_file_table,
-                            GHashTable *desktop_id_table)
+                            GHashTable *desktop_id_table,
+                            GHashTable *desktop_class_table)
 {
   GAppInfo *desktop_file;
   char *exec;
@@ -467,6 +494,7 @@
   desktop_id = g_string_truncate (desktop_id, desktop_id->len - 8); /* remove last 8 characters for .desktop */
   
   insert_data_into_tables (self, file, exec, desktop_id->str, desktop_file_table, desktop_id_table);
+  insert_desktop_file_class_into_table (self, file, desktop_class_table);
 
   g_free (exec);
   g_string_free (desktop_id, TRUE);
@@ -476,7 +504,8 @@
 load_directory_to_table (BamfMatcher * self,
                          const char *directory,
                          GHashTable *desktop_file_table,
-                         GHashTable *desktop_id_table)
+                         GHashTable *desktop_id_table,
+                         GHashTable *desktop_class_table)
 {
   GFile *dir;
   GFileEnumerator *enumerator;
@@ -506,7 +535,8 @@
         load_desktop_file_to_table (self,
                                     path,
                                     desktop_file_table,
-                                    desktop_id_table);
+                                    desktop_id_table,
+                                    desktop_class_table);
 
       g_free ((gpointer) path);
       g_object_unref (info);
@@ -520,7 +550,8 @@
 load_index_file_to_table (BamfMatcher * self,
                           const char *index_file,
                           GHashTable *desktop_file_table,
-                          GHashTable *desktop_id_table)
+                          GHashTable *desktop_id_table,
+                          GHashTable *desktop_class_table)
 {
   GFile *file;
   GFileInputStream *stream;
@@ -569,6 +600,7 @@
       g_string_truncate (desktop_id, desktop_id->len - 8);
       
       insert_data_into_tables (self, filename->str, exec, desktop_id->str, desktop_file_table, desktop_id_table);
+      insert_desktop_file_class_into_table (self, filename->str, desktop_class_table);
 
       g_string_free (desktop_id, TRUE);
       length = 0;
@@ -612,7 +644,7 @@
   if (!g_list_find_custom (dirs, "/usr/local/share/applications", (GCompareFunc) g_strcmp0))
     dirs = g_list_prepend (dirs, g_strdup ("/usr/local/share/applications"));
   
-  dirs = g_list_prepend (dirs, g_strdup (g_build_filename (g_get_home_dir (), ".share/applications", NULL)));
+  dirs = g_list_prepend (dirs, g_strdup (g_build_filename (g_get_home_dir (), ".local/share/applications", NULL)));
   
   if (data_dirs)
     g_strfreev (data_dirs);
@@ -690,6 +722,7 @@
     {
       g_hash_table_foreach_remove (self->priv->desktop_id_table, (GHRFunc) hash_table_remove_values, path);
       g_hash_table_foreach_remove (self->priv->desktop_file_table, (GHRFunc) hash_table_remove_values, path);
+      g_hash_table_remove (self->priv->desktop_class_table, path);
     }
 
 out:
@@ -697,7 +730,10 @@
 }
 
 static void
-create_desktop_file_table (BamfMatcher * self, GHashTable **desktop_file_table, GHashTable **desktop_id_table)
+create_desktop_file_table (BamfMatcher * self,
+                           GHashTable **desktop_file_table,
+                           GHashTable **desktop_id_table,
+                           GHashTable **desktop_class_table)
 {
   GList *directories;
   GList *l;
@@ -718,6 +754,12 @@
                            (GDestroyNotify) g_free,
                            NULL);
 
+  *desktop_class_table =
+    g_hash_table_new_full ((GHashFunc) g_str_hash,
+                           (GEqualFunc) g_str_equal,
+                           (GDestroyNotify) g_free,
+                           (GDestroyNotify) g_free);
+
   g_return_if_fail (BAMF_IS_MATCHER (self));
 
   directories = get_desktop_file_directories (self);
@@ -740,11 +782,13 @@
 
       if (g_file_test (bamf_file, G_FILE_TEST_EXISTS))
         {
-          load_index_file_to_table (self, bamf_file, *desktop_file_table, *desktop_id_table);
+          load_index_file_to_table (self, bamf_file, *desktop_file_table,
+                                    *desktop_id_table, *desktop_class_table);
         }
       else
         {
-          load_directory_to_table (self, directory, *desktop_file_table, *desktop_id_table);
+          load_directory_to_table (self, directory, *desktop_file_table,
+                                   *desktop_id_table, *desktop_class_table);
         }
 
       g_free (directory);
@@ -993,38 +1037,81 @@
     }
   else
     {
-      char *class_name = window_class_name (window);
-
-      if (class_name)
+      char *window_class = window_class_name (window);
+      
+      char *desktop_file;
+      char *desktop_class;
+      
+      if (window_class)
         {
-          class_name = g_ascii_strdown (class_name, -1);
-          l = g_hash_table_lookup (priv->desktop_id_table, class_name);
+          char *window_class_down = g_ascii_strdown (g_strdup(window_class), -1);
+          l = g_hash_table_lookup (priv->desktop_id_table, window_class_down);
+          g_free (window_class_down);
 
           for (; l; l = l->next)
             {
-              if (l->data && !g_list_find_custom (desktop_files, l->data, (GCompareFunc) g_strcmp0))
-                desktop_files = g_list_prepend (desktop_files, g_strdup (l->data));
-            }
-
-         desktop_files = g_list_reverse (desktop_files);
-         g_free (class_name);
-       }
+              desktop_file = l->data;
+              if (desktop_file)
+                {
+                  desktop_class = g_hash_table_lookup (priv->desktop_class_table, desktop_file);
+                  if ((desktop_class == NULL || g_strcmp0 (desktop_class, window_class) == 0) &&
+                      !g_list_find_custom (desktop_files, desktop_file,
+                                           (GCompareFunc) g_strcmp0))
+                    {
+                      desktop_files = g_list_prepend (desktop_files, g_strdup (desktop_file));
+                    }
+                }
+            }
+
+          desktop_files = g_list_reverse (desktop_files);
+        }
+
+      /* Iterate over the desktop class table, and add matching desktop files */
+      gpointer key;
+      gpointer value;
+      GHashTableIter iter;
+      g_hash_table_iter_init (&iter, priv->desktop_class_table);
+
+      while (g_hash_table_iter_next (&iter, &key, &value))
+        {
+          desktop_file = g_strdup (key);
+          desktop_class = value;
+          if (g_strcmp0 (desktop_class, window_class) == 0 &&
+              !g_list_find_custom (desktop_files, desktop_file, (GCompareFunc) g_strcmp0))
+            {
+              desktop_files = g_list_prepend (desktop_files, desktop_file);
+            }
+        }
 
       pid = bamf_legacy_window_get_pid (window);
-      
       pid_list = bamf_matcher_possible_applications_for_pid (self, pid);
       
-      /* Append these files to the end to give preference to class_name style picking.
+      /* Append these files to the end to give preference to window_class style picking.
          This style of matching is prefered and used by GNOME Shell however does not work
          very well in practice, thus requiring the fallback here */
       for (l = pid_list; l; l = l->next)
         {
+          desktop_file = l->data;
           if (g_list_find_custom (desktop_files, l->data, (GCompareFunc) g_strcmp0))
-            g_free (l->data);
+            g_free (desktop_file);
           else
-            desktop_files = g_list_append (desktop_files, l->data);
+            {
+              if (window_class)
+                {
+                  desktop_class = g_hash_table_lookup (priv->desktop_class_table, desktop_file);
+                  if ((desktop_class == NULL || g_strcmp0 (desktop_class, window_class) == 0) &&
+                      !g_list_find_custom (desktop_files, desktop_file,
+                                           (GCompareFunc) g_strcmp0))
+                    {
+                      desktop_files = g_list_append (desktop_files, desktop_file);
+                    }
+                }
+              else
+                desktop_files = g_list_append (desktop_files, desktop_file);
+            }
         }
-      
+
+      g_free (window_class);
       g_list_free (pid_list);
     }
   
@@ -1039,6 +1126,8 @@
   BamfLegacyWindow *window;
   GList *views, *a;
   char *desktop_file;
+  char *win_class;
+  char *app_class;
   BamfApplication *app = NULL, *best = NULL;
   BamfView *view;
 
@@ -1049,6 +1138,7 @@
   views = self->priv->views;
 
   possible_apps = bamf_matcher_possible_applications_for_window (self, bamf_window);
+  win_class = window_class_name(window);
 
   /* Loop over every application, inside that application see if its .desktop file
    * matches with any of our possible hits. If so we match it. If we have no possible hits
@@ -1062,8 +1152,16 @@
         continue;
 
       app = BAMF_APPLICATION (view);
+      app_class = bamf_application_get_wmclass (app);
+
+      if (app_class != NULL && g_strcmp0 (win_class, app_class) != 0)
+        {
+          g_free (app_class);
+          continue;
+        }
+
       desktop_file = bamf_application_get_desktop_file (app);
-      
+
       if (possible_apps)
         {
           /* primary matching */
@@ -1084,7 +1182,8 @@
           if (bamf_application_contains_similar_to_window (app, bamf_window))
             best = app;
         }
-        
+
+      g_free (app_class);
       g_free (desktop_file);
     }
 
@@ -1095,16 +1194,19 @@
       else
         best = bamf_application_new ();
 
+      bamf_application_set_wmclass (best, win_class);
+
       bamf_matcher_register_view (self, BAMF_VIEW (best));
       g_object_unref (best);
     }
 
- for (l = possible_apps; l; l = l->next)
-  {
-    char *str = l->data;
-    g_free (str);
-  }
+  g_free (win_class);
 
+  for (l = possible_apps; l; l = l->next)
+    {
+      char *str = l->data;
+      g_free (str);
+    }
 
   g_list_free (possible_apps);
 
@@ -1340,7 +1442,8 @@
   load_desktop_file_to_table (self,
                               desktop_file,
                               self->priv->desktop_file_table,
-                              self->priv->desktop_id_table);
+                              self->priv->desktop_id_table,
+                              self->priv->desktop_class_table);
 }
 
 void
@@ -1731,11 +1834,13 @@
 
   g_array_free (prefixstrings, TRUE);
 
-  create_desktop_file_table (self, &(priv->desktop_file_table), &(priv->desktop_id_table));
+  create_desktop_file_table (self, &(priv->desktop_file_table),
+                             &(priv->desktop_id_table),
+                             &(priv->desktop_class_table));
 
   screen = bamf_legacy_screen_get_default ();
   g_signal_connect (G_OBJECT (screen), "window-opened",
-		    (GCallback) handle_window_opened, self);
+                    (GCallback) handle_window_opened, self);
 
   approver = bamf_indicator_source_get_default ();
   g_signal_connect (G_OBJECT (approver), "indicator-opened",