Merge lp:~3v1n0/bamf/more-java-friendly-desktops into lp:bamf

[Marco Trevisan (Treviño)]

BamfMatcher: ignore known invalid window class values when matching windows

And generate better .desktop files for local apps.
This will make us life easier with Java.

Make .desktop generation more robust, avoiding matching errors on some
applications that shares the same WM_CLASS (such as JavaWS)
Disable StartupNotification by default on these .desktop files.

Tests updated

[Christopher Townsend (townsend)]

Merges and compiles cleanly and all tests pass. Code looks good. +1

review: Approve

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:651
http://jenkins.qa.ubuntu.com/job/bamf-ci/83/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/bamf-saucy-amd64-ci/64
    SUCCESS: http://jenkins.qa.ubuntu.com/job/bamf-saucy-armhf-ci/65

Click here to trigger a rebuild:
http://s-jenkins:8080/job/bamf-ci/83/rebuild

review: Approve (continuous-integration)

[lp:~3v1n0/bamf/more-java-friendly-desktops]

575. By Marco Trevisan (Treviño) on 2013-08-07

BamfMatcher: ignore known invalid window class values when matching windows

And generate better .desktop files for local apps.
This will make us life easier with Java.

Approved by PS Jenkins bot, Christopher Townsend.

=== modified file 'src/bamf-application.c'
--- src/bamf-application.c	2013-08-06 15:49:30 +0000
+++ src/bamf-application.c	2013-08-07 16:08:26 +0000
@@ -496,6 +496,7 @@
 {
   BamfApplicationPrivate *priv;
   BamfLegacyWindow *window;
+  BamfMatcher *matcher;
   GKeyFile *key_file;
   const gchar *name, *icon, *iclass, *nclass, *class, *exec;
   GFile *data_dir, *apps_dir, *icons_dir, *desktop_file, *icon_file, *mini_icon;
@@ -517,13 +518,20 @@
       return FALSE;
     }
 
+  matcher = bamf_matcher_get_default ();
   data_dir = g_file_new_for_path (g_get_user_data_dir ());
   name = bamf_view_get_name (BAMF_VIEW (self));
   icon = bamf_view_get_icon (BAMF_VIEW (self));
+  nclass = bamf_legacy_window_get_class_name (window);
   iclass = bamf_legacy_window_get_class_instance_name (window);
-  nclass = bamf_legacy_window_get_class_name (window);
   mini_icon = bamf_legacy_window_get_saved_mini_icon (window);
 
+  if (!bamf_matcher_is_valid_class_name (matcher, iclass))
+    iclass = NULL;
+
+  if (!bamf_matcher_is_valid_class_name (matcher, nclass))
+    nclass = NULL;
+
   apps_dir = try_create_subdir (data_dir, "applications", priv->cancellable);
   icons_dir = NULL;
 
@@ -540,7 +548,7 @@
 
   desktop_file = NULL;
   icon_file = NULL;
-  class = (iclass) ? iclass : nclass;
+  class = (nclass) ? nclass : iclass;
 
   if (class)
     {
@@ -550,7 +558,6 @@
 
   if (!G_IS_FILE (desktop_file))
     {
-      BamfMatcher *matcher = bamf_matcher_get_default ();
       gchar *trimmed_exec = bamf_matcher_get_trimmed_exec (matcher, exec);
       try_create_local_desktop_data (apps_dir, icons_dir, trimmed_exec,
                                      &desktop_file, &icon_file, priv->cancellable);
@@ -622,8 +629,9 @@
   g_key_file_set_string (key_file, G_KEY_FILE_DESKTOP_GROUP,
                          G_KEY_FILE_DESKTOP_KEY_EXEC, exec);
 
+  // It would be nice to be able to find if enabling this from some win property
   g_key_file_set_boolean (key_file, G_KEY_FILE_DESKTOP_GROUP,
-                          G_KEY_FILE_DESKTOP_KEY_STARTUP_NOTIFY, TRUE);
+                          G_KEY_FILE_DESKTOP_KEY_STARTUP_NOTIFY, FALSE);
 
   if (class)
     {

=== modified file 'src/bamf-matcher-private.h'
--- src/bamf-matcher-private.h	2013-07-24 00:11:46 +0000
+++ src/bamf-matcher-private.h	2013-08-07 16:08:26 +0000
@@ -51,7 +51,6 @@
 
 BamfApplication * bamf_matcher_get_application_by_desktop_file (BamfMatcher *self, const char *desktop_file);
 BamfApplication * bamf_matcher_get_application_by_xid (BamfMatcher *self, guint xid);
-gboolean bamf_matcher_is_valid_process_prefix (BamfMatcher *self, const char *exec);
 char * get_exec_overridden_desktop_file (const char *exec);
 
 gboolean is_autostart_desktop_file (const gchar *desktop_file);

=== modified file 'src/bamf-matcher.c'
--- src/bamf-matcher.c	2013-08-05 16:18:46 +0000
+++ src/bamf-matcher.c	2013-08-07 16:08:26 +0000
@@ -75,6 +75,13 @@
   "^sol$"
 };
 
+// These class names are ignored as matching values
+const gchar * CLASS_BAD_VALUES[] =
+{
+  "sun-awt-X11-XFramePeer", "net-sourceforge-jnlp-runtime-Boot",
+  "com-sun-javaws-Main", "VCLSalFrame"
+};
+
 const gchar * EXEC_DESKTOP_FILE_OVERRIDE = "--desktop_file_hint";
 
 static void
@@ -1586,6 +1593,25 @@
   return FALSE;
 }
 
+gboolean
+bamf_matcher_is_valid_class_name (BamfMatcher *self, const char *class_name)
+{
+  int i;
+
+  g_return_val_if_fail (BAMF_IS_MATCHER (self), FALSE);
+
+  if (!class_name)
+    return TRUE;
+
+  for (i = 0; i < G_N_ELEMENTS (CLASS_BAD_VALUES); ++i)
+    {
+      if (g_strcmp0 (class_name, CLASS_BAD_VALUES[i]) == 0)
+        return FALSE;
+    }
+
+  return TRUE;
+}
+
 static GList *
 bamf_matcher_possible_applications_for_window (BamfMatcher *self,
                                                BamfWindow *bamf_window,
@@ -1610,6 +1636,12 @@
   class_name = bamf_legacy_window_get_class_name (window);
   instance_name = bamf_legacy_window_get_class_instance_name (window);
 
+  if (!bamf_matcher_is_valid_class_name (self, class_name))
+    class_name = NULL;
+
+  if (!bamf_matcher_is_valid_class_name (self, instance_name))
+    instance_name = NULL;
+
   target_class = instance_name;
   filter_by_wmclass = bamf_matcher_has_instance_class_desktop_file (self, target_class);
 

=== modified file 'src/bamf-matcher.h'
--- src/bamf-matcher.h	2013-07-25 16:54:16 +0000
+++ src/bamf-matcher.h	2013-08-07 16:08:26 +0000
@@ -111,6 +111,9 @@
 gboolean      bamf_matcher_is_valid_process_prefix       (BamfMatcher *matcher,
                                                           const char *process_name);
 
+gboolean      bamf_matcher_is_valid_class_name           (BamfMatcher *matcher,
+                                                          const char *class_name);
+
 char        * bamf_matcher_get_trimmed_exec              (BamfMatcher *matcher,
                                                           const char *exec_string);
 

=== modified file 'tests/bamfdaemon/test-application.c'
--- tests/bamfdaemon/test-application.c	2013-08-06 15:49:21 +0000
+++ tests/bamfdaemon/test-application.c	2013-08-07 16:08:26 +0000
@@ -1141,7 +1141,7 @@
 verify_application_desktop_file_content (BamfApplication *application)
 {
   GKeyFile *key_file;
-  const gchar *desktop_file, *exec, *class;
+  const gchar *desktop_file, *exec;
   gchar *str_value;
   GError *error = NULL;
   BamfView *main_child;
@@ -1186,11 +1186,11 @@
   g_assert_cmpstr (str_value, ==, exec);
   g_clear_pointer (&str_value, g_free);
 
-  g_assert (g_key_file_get_boolean (key_file, G_KEY_FILE_DESKTOP_GROUP,
-                                    G_KEY_FILE_DESKTOP_KEY_STARTUP_NOTIFY, &error));
+  g_assert (!g_key_file_get_boolean (key_file, G_KEY_FILE_DESKTOP_GROUP,
+                                     G_KEY_FILE_DESKTOP_KEY_STARTUP_NOTIFY, &error));
   g_assert (!error);
 
-  class = bamf_legacy_window_get_class_instance_name (main_window);
+  const gchar *class = bamf_legacy_window_get_class_instance_name (main_window);
   class = class ? class : bamf_legacy_window_get_class_name (main_window);
 
   if (class)
@@ -1215,7 +1215,7 @@
 
   application = bamf_application_new ();
   lwin = bamf_legacy_window_test_new (20, "window", NULL, "awesome --exec");
-  bamf_legacy_window_test_set_wmclass (lwin, "application-class", "instance-class");
+  bamf_legacy_window_test_set_wmclass (lwin, NULL, "instance-class");
   win = bamf_window_new (BAMF_LEGACY_WINDOW (lwin));
   bamf_view_add_child (BAMF_VIEW (application), BAMF_VIEW (win));
 

=== modified file 'tests/bamfdaemon/test-matcher.c'
--- tests/bamfdaemon/test-matcher.c	2013-07-25 16:55:10 +0000
+++ tests/bamfdaemon/test-matcher.c	2013-08-07 16:08:26 +0000
@@ -1212,6 +1212,21 @@
   g_object_unref (screen);
 }
 
+static void
+test_class_valid_name (void)
+{
+  BamfMatcher *matcher;
+
+  matcher = bamf_matcher_get_default ();
+  g_assert (bamf_matcher_is_valid_class_name (matcher, "any-good-class"));
+  g_assert (!bamf_matcher_is_valid_class_name (matcher, "sun-awt-X11-XFramePeer"));
+  g_assert (!bamf_matcher_is_valid_class_name (matcher, "net-sourceforge-jnlp-runtime-Boot"));
+  g_assert (!bamf_matcher_is_valid_class_name (matcher, "com-sun-javaws-Main"));
+  g_assert (!bamf_matcher_is_valid_class_name (matcher, "VCLSalFrame"));
+
+  g_object_unref (matcher);
+}
+
 /* Initialize test suite */
 
 void
@@ -1222,6 +1237,7 @@
   g_test_add_func (DOMAIN"/Allocation", test_allocation);
   g_test_add_func (DOMAIN"/AutostartDesktopFile/User", test_autostart_desktop_file_user);
   g_test_add_func (DOMAIN"/AutostartDesktopFile/System", test_autostart_desktop_file_system);
+  g_test_add_func (DOMAIN"/ClassValidName", test_class_valid_name);
   g_test_add_func (DOMAIN"/ExecStringTrimming", test_trim_exec_string);
   g_test_add_func (DOMAIN"/GetViewByPath", test_get_view_by_path);
   g_test_add_func (DOMAIN"/LoadDesktopFile", test_load_desktop_file);