Merge lp:~3v1n0/bamf/no-display-desktop-files-lower-priority into lp:bamf/0.4

[Marco Trevisan (Treviño)]

BamfMatcher: make sure that all the no-display desktop files have lower priority

When a .desktop file with NoDisplay=true is passed to BAMF, we make sure that we add it always at the end of our lists so that it won't be used for matching unless it's the only one we have or it has a StartupWMClass value that forces it.

Tests updated.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:534
http://jenkins.qa.ubuntu.com/job/bamf-ci/2/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/bamf-raring-amd64-ci/2/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/bamf-raring-armhf-ci/2/console

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

review: Needs Fixing (continuous-integration)

[Brandon Schaefer (brandontschaefer)]

Im still getting this crash:

http://paste.ubuntu.com/5655931/

review: Needs Fixing

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:535
http://jenkins.qa.ubuntu.com/job/bamf-ci/8/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/bamf-raring-amd64-ci/8/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/bamf-raring-armhf-ci/8/console

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

review: Needs Fixing (continuous-integration)

[Brandon Schaefer (brandontschaefer)]

Sweeet! Looks good to me :)

review: Approve

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:536
http://jenkins.qa.ubuntu.com/job/bamf-ci/11/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/bamf-raring-amd64-ci/11/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/bamf-raring-armhf-ci/11/console

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

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

review: Approve (continuous-integration)

=== modified file 'src/bamf-matcher-private.h'
--- src/bamf-matcher-private.h	2013-01-29 16:06:42 +0000
+++ src/bamf-matcher-private.h	2013-03-28 22:20:27 +0000
@@ -43,6 +43,7 @@
   GList           * views;
   GList           * monitors;
   GList           * favorites;
+  GList           * no_display_desktop;
   BamfView        * active_app;
   BamfView        * active_win;
   guint             dispatch_changes_id;

=== modified file 'src/bamf-matcher.c'
--- src/bamf-matcher.c	2013-03-28 19:59:24 +0000
+++ src/bamf-matcher.c	2013-03-28 22:20:27 +0000
@@ -714,15 +714,52 @@
   return FALSE;
 }
 
+static gboolean
+is_no_display_desktop (BamfMatcher *self, const gchar *desktop_path)
+{
+  g_return_val_if_fail (BAMF_IS_MATCHER (self), FALSE);
+
+  if (!desktop_path || desktop_path[0] == '\0')
+    return FALSE;
+
+  GList *list = self->priv->no_display_desktop;
+
+  return g_list_find_custom (list, desktop_path, (GCompareFunc) g_strcmp0) != NULL;
+}
+
+static GList *
+get_last_no_display_desktop_in_list (BamfMatcher *self, GList *desktop_list)
+{
+  GList *last, *l;
+
+  g_return_val_if_fail (BAMF_IS_MATCHER (self), NULL);
+
+  last = NULL;
+
+  for (l = desktop_list; l; l = l->next)
+    {
+      char *desktop_path = l->data;
+
+      if (is_no_display_desktop (self, desktop_path))
+        {
+          last = l;
+          break;
+        }
+    }
+
+  return last;
+}
+
 static void
 insert_data_into_tables (BamfMatcher *self,
                          const char *data,
                          const char *exec,
                          const char *desktop_id,
+                         gboolean no_display,
                          GHashTable *desktop_file_table,
                          GHashTable *desktop_id_table)
 {
-  GList *file_list, *id_list;
+  GList *file_list, *id_list, *last, *l;
   char *datadup;
 
   g_return_if_fail (exec);
@@ -739,11 +776,15 @@
 
   datadup = g_strdup (data);
 
+  if (no_display)
+    {
+      self->priv->no_display_desktop = g_list_prepend (self->priv->no_display_desktop, datadup);
+    }
+
   /* order so that items whose desktop_id == exec string are first in the list */
 
   if (g_strcmp0 (exec, desktop_id) == 0 || is_desktop_folder_item (datadup, -1))
     {
-      GList *l, *last;
       last = NULL;
 
       for (l = file_list; l; l = l->next)
@@ -768,7 +809,7 @@
               continue;
             }
 
-          if (strncmp (desktop_id, dname_start, len) != 0 &&
+          if ((strncmp (desktop_id, dname_start, len) != 0 || is_no_display_desktop (self, dpath)) &&
               !is_desktop_folder_item (dpath, (dname_start - dpath - 1)))
             {
               last = l;
@@ -780,10 +821,20 @@
     }
   else
     {
-      file_list = g_list_append (file_list, datadup);
+      last = NULL;
+
+      if (!no_display)
+        last = get_last_no_display_desktop_in_list (self, file_list);
+
+      file_list = g_list_insert_before (file_list, last, datadup);
     }
 
-  id_list = g_list_append (id_list, datadup);
+  last = NULL;
+
+  if (!no_display)
+    last = get_last_no_display_desktop_in_list (self, id_list);
+
+  id_list = g_list_insert_before (id_list, last, 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);
@@ -823,6 +874,7 @@
                             GHashTable *desktop_class_table)
 {
   GDesktopAppInfo *desktop_file;
+  gboolean no_display;
   const char *current_desktop;
   char *exec;
   char *path;
@@ -874,8 +926,9 @@
   g_free (path);
 
   desktop_id = g_string_truncate (desktop_id, desktop_id->len - 8); /* remove last 8 characters for .desktop */
+  no_display = g_desktop_app_info_get_nodisplay (desktop_file);
 
-  insert_data_into_tables (self, file, exec, desktop_id->str, desktop_file_table, desktop_id_table);
+  insert_data_into_tables (self, file, exec, desktop_id->str, no_display, desktop_file_table, desktop_id_table);
   insert_desktop_file_class_into_table (self, file, desktop_class_table);
 
   g_free (exec);
@@ -970,6 +1023,7 @@
       const char *class;
       const char *show_in;
       GString *desktop_id;
+      gboolean no_display;
 
       /* Order is: 0 Desktop-Id, 1 Exec, 2 class, 3 ShowIn, 4 NoDisplay */
       gchar **parts = g_strsplit (line, "\t", 5);
@@ -1011,7 +1065,13 @@
       desktop_id = g_string_new (parts[0]);
       g_string_truncate (desktop_id, desktop_id->len - 8);
 
-      insert_data_into_tables (self, filename, exec, desktop_id->str, desktop_file_table, desktop_id_table);
+      no_display = FALSE;
+      if (parts[4] && g_ascii_strcasecmp (parts[4], "true") == 0)
+        {
+          no_display = TRUE;
+        }
+
+      insert_data_into_tables (self, filename, exec, desktop_id->str, no_display, desktop_file_table, desktop_id_table);
 
       class = parts[2];
       if (class && class[0] != '\0')
@@ -3027,6 +3087,7 @@
   g_hash_table_destroy (priv->desktop_file_table);
   g_hash_table_destroy (priv->desktop_class_table);
   g_hash_table_destroy (priv->registered_pids);
+  g_list_free (priv->no_display_desktop);
 
   if (priv->opened_closed_paths_table)
     {

=== added directory 'tests/bamfdaemon/data/no-display'
=== added file 'tests/bamfdaemon/data/no-display/test-bamf-app.desktop'
--- tests/bamfdaemon/data/no-display/test-bamf-app.desktop	1970-01-01 00:00:00 +0000
+++ tests/bamfdaemon/data/no-display/test-bamf-app.desktop	2013-03-28 22:20:27 +0000
@@ -0,0 +1,8 @@
+[Desktop Entry]
+Version=1.0
+Name=TestBamfApp
+Type=Application
+Exec=test-bamf-app
+Icon=bamf
+NoDisplay=true
+StartupWMClass=test_bamf_app

=== added file 'tests/bamfdaemon/data/test-bamf-app-display.desktop'
--- tests/bamfdaemon/data/test-bamf-app-display.desktop	1970-01-01 00:00:00 +0000
+++ tests/bamfdaemon/data/test-bamf-app-display.desktop	2013-03-28 22:20:27 +0000
@@ -0,0 +1,7 @@
+[Desktop Entry]
+Version=1.0
+Name=TestBamfApp
+Type=Application
+Exec=test-bamf-app
+Icon=bamf
+StartupWMClass=test_bamf_app

=== added file 'tests/bamfdaemon/data/test-bamf-app-no-display.desktop'
--- tests/bamfdaemon/data/test-bamf-app-no-display.desktop	1970-01-01 00:00:00 +0000
+++ tests/bamfdaemon/data/test-bamf-app-no-display.desktop	2013-03-28 22:20:27 +0000
@@ -0,0 +1,8 @@
+[Desktop Entry]
+Version=1.0
+Name=TestBamfApp
+Type=Application
+Exec=test-bamf-app
+Icon=bamf
+NoDisplay=true
+StartupWMClass=test_bamf_app

=== modified file 'tests/bamfdaemon/test-bamf.c'
--- tests/bamfdaemon/test-bamf.c	2013-03-28 21:16:29 +0000
+++ tests/bamfdaemon/test-bamf.c	2013-03-28 22:20:27 +0000
@@ -65,6 +65,7 @@
   gtk_init (&argc, &argv);
   g_test_init (&argc, &argv, NULL);
   glibtop_init ();
+
   g_setenv("BAMF_TEST_MODE", "TRUE", TRUE);
 
   loop = g_main_loop_new (NULL, FALSE);

=== modified file 'tests/bamfdaemon/test-matcher.c'
--- tests/bamfdaemon/test-matcher.c	2013-03-28 18:58:28 +0000
+++ tests/bamfdaemon/test-matcher.c	2013-03-28 22:20:27 +0000
@@ -28,6 +28,8 @@
 
 static void test_allocation (void);
 static void test_load_desktop_file (void);
+static void test_load_desktop_file_no_display_has_lower_prio_same_id (void);
+static void test_load_desktop_file_no_display_has_lower_prio_different_id (void);
 static void test_open_windows (void);
 static void test_match_desktopless_application (void);
 static void test_match_desktop_application (void);
@@ -53,6 +55,8 @@
 
   g_test_add_func (DOMAIN"/Allocation", test_allocation);
   g_test_add_func (DOMAIN"/LoadDesktopFile", test_load_desktop_file);
+  g_test_add_func (DOMAIN"/LoadDesktopFile/NoDisplay/SameID", test_load_desktop_file_no_display_has_lower_prio_same_id);
+  g_test_add_func (DOMAIN"/LoadDesktopFile/NoDisplay/DifferentID", test_load_desktop_file_no_display_has_lower_prio_different_id);
   g_test_add_func (DOMAIN"/OpenWindows", test_open_windows);
   g_test_add_func (DOMAIN"/Matching/Application/DesktopLess", test_match_desktopless_application);
   g_test_add_func (DOMAIN"/Matching/Application/Desktop", test_match_desktop_application);
@@ -88,6 +92,7 @@
   g_hash_table_destroy (matcher->priv->desktop_file_table);
   g_hash_table_destroy (matcher->priv->desktop_id_table);
   g_hash_table_destroy (matcher->priv->desktop_class_table);
+  g_list_free (matcher->priv->no_display_desktop);
 
   matcher->priv->desktop_file_table =
     g_hash_table_new_full ((GHashFunc) g_str_hash,
@@ -106,6 +111,8 @@
                            (GEqualFunc) g_str_equal,
                            (GDestroyNotify) g_free,
                            (GDestroyNotify) g_free);
+
+  matcher->priv->no_display_desktop = NULL;
 }
 
 static BamfWindow *
@@ -173,9 +180,11 @@
   bamf_matcher_load_desktop_file (matcher, TEST_BAMF_APP_DESKTOP);
 
   GList *l = g_hash_table_lookup (priv->desktop_file_table, "test-bamf-app");
+  g_assert (l);
   g_assert_cmpstr (l->data, ==, TEST_BAMF_APP_DESKTOP);
 
   l = g_hash_table_lookup (priv->desktop_id_table, "test-bamf-app");
+  g_assert (l);
   g_assert_cmpstr (l->data, ==, TEST_BAMF_APP_DESKTOP);
 
   const char *desktop = g_hash_table_lookup (priv->desktop_class_table, TEST_BAMF_APP_DESKTOP);
@@ -183,6 +192,49 @@
 }
 
 static void
+test_load_desktop_file_no_display_has_lower_prio_same_id (void)
+{
+  BamfMatcher *matcher = bamf_matcher_get_default ();
+  BamfMatcherPrivate *priv = matcher->priv;
+
+  cleanup_matcher_tables (matcher);
+  bamf_matcher_load_desktop_file (matcher, DATA_DIR"/no-display/test-bamf-app.desktop");
+  bamf_matcher_load_desktop_file (matcher, TEST_BAMF_APP_DESKTOP);
+
+  GList *l = g_hash_table_lookup (priv->desktop_file_table, "test-bamf-app");
+  g_assert (l);
+  g_assert_cmpstr (l->data, ==, TEST_BAMF_APP_DESKTOP);
+
+  g_assert (l->next);
+  g_assert_cmpstr (l->next->data, ==, DATA_DIR"/no-display/test-bamf-app.desktop");
+
+  l = g_hash_table_lookup (priv->desktop_id_table, "test-bamf-app");
+  g_assert (l);
+  g_assert_cmpstr (l->data, ==, TEST_BAMF_APP_DESKTOP);
+
+  g_assert (l->next);
+  g_assert_cmpstr (l->next->data, ==, DATA_DIR"/no-display/test-bamf-app.desktop");
+}
+
+static void
+test_load_desktop_file_no_display_has_lower_prio_different_id (void)
+{
+  BamfMatcher *matcher = bamf_matcher_get_default ();
+  BamfMatcherPrivate *priv = matcher->priv;
+
+  cleanup_matcher_tables (matcher);
+  bamf_matcher_load_desktop_file (matcher, DATA_DIR"/test-bamf-app-no-display.desktop");
+  bamf_matcher_load_desktop_file (matcher, DATA_DIR"/test-bamf-app-display.desktop");
+
+  GList *l = g_hash_table_lookup (priv->desktop_file_table, "test-bamf-app");
+  g_assert (l);
+  g_assert_cmpstr (l->data, ==, DATA_DIR"/test-bamf-app-display.desktop");
+
+  g_assert (l->next);
+  g_assert_cmpstr (l->next->data, ==, DATA_DIR"/test-bamf-app-no-display.desktop");
+}
+
+static void
 test_open_windows (void)
 {
   BamfMatcher *matcher;