Merge lp:~larryprice/ubuntu-app-launch/no-display-options into lp:ubuntu-app-launch/16.04

[Larry Price]

Add additional cases for not presenting desktop launchers based on keyfile entries.

Add additional cases for not presenting desktop launchers based on keyfile entries.

This includes looking for NoDisplay and Hidden, verifying the Type is Application, and checking to see if Unity is included in the "OnlyShowIn" or "NotShowIn" lists. This logic is similar to what we've been using in libertine-container-manager to determine which app launchers to show. The intent is to update the UAL API for use in libertine-scope to reduce duplication of logic in fetching application launchers.

[Ted Gould (ted)]

Overall, cool, thanks for the fix! Some little things that need to be fixed inline.

review: Needs Fixing

[lp:~larryprice/ubuntu-app-launch/no-display-options]

272. By Larry Price on 2016-04-26

Fix memory management in stringlist method and use XDG_CURRENT_DESKTOP to determine environment (review recycle)

[Ted Gould (ted)]

Great, thanks!

review: Approve

[lp:~larryprice/ubuntu-app-launch/no-display-options]

273. By Larry Price on 2016-04-26

Merge with trunk 16.04

=== modified file 'libubuntu-app-launch/application-info-desktop.cpp'
--- libubuntu-app-launch/application-info-desktop.cpp	2016-03-03 20:48:24 +0000
+++ libubuntu-app-launch/application-info-desktop.cpp	2016-04-26 13:49:48 +0000
@@ -18,6 +18,7 @@
  */
 
 #include "application-info-desktop.h"
+#include <cstdlib>
 
 namespace ubuntu
 {
@@ -25,9 +26,20 @@
 {
 namespace app_info
 {
-
+namespace
+{
 constexpr const char* DESKTOP_GROUP = "Desktop Entry";
 
+struct TypeTag;
+typedef TypeTagger<TypeTag, std::string> Type;
+
+struct HiddenTag;
+typedef TypeTagger<HiddenTag, bool> Hidden;
+
+struct NoDisplayTag;
+typedef TypeTagger<NoDisplayTag, bool> NoDisplay;
+} // anonymous namespace
+
 template <typename T>
 auto stringFromKeyfile(std::shared_ptr<GKeyFile> keyfile, const std::string& key, const std::string& exceptionText = {})
     -> T
@@ -113,12 +125,58 @@
     return retval;
 }
 
+bool stringlistFromKeyfileContains(std::shared_ptr<GKeyFile> keyfile,
+                                   const gchar* key,
+                                   const std::string& match,
+                                   bool defaultValue)
+{
+    GError* error = nullptr;
+    auto results = g_key_file_get_string_list(keyfile.get(), DESKTOP_GROUP, key, nullptr, &error);
+    if (error != nullptr)
+    {
+      g_error_free(error);
+      return defaultValue;
+    }
+
+    bool result = false;
+    for (auto i = 0; results[i] != nullptr; ++i)
+    {
+        if (results[i] == match)
+        {
+            result = true;
+            break;
+        }
+    }
+    g_strfreev(results);
+
+    return result;
+}
+
 Desktop::Desktop(std::shared_ptr<GKeyFile> keyfile, const std::string& basePath)
     : _keyfile([keyfile]() {
         if (!keyfile)
         {
             throw std::runtime_error("Can not build a desktop application info object with a null keyfile");
         }
+        if (stringFromKeyfile<Type>(keyfile, "Type").value() != "Application")
+        {
+            throw std::runtime_error("Keyfile does not represent application type");
+        }
+        if (boolFromKeyfile<NoDisplay>(keyfile, "NoDisplay", false).value())
+        {
+            throw std::runtime_error("Application is not meant to be displayed");
+        }
+        if (boolFromKeyfile<Hidden>(keyfile, "Hidden", false).value())
+        {
+            throw std::runtime_error("Application keyfile is hidden");
+        }
+        auto xdg_current_desktop = getenv("XDG_CURRENT_DESKTOP");
+        if (stringlistFromKeyfileContains(keyfile, "NotShowIn", xdg_current_desktop, false)
+                 || !stringlistFromKeyfileContains(keyfile, "OnlyShowIn", xdg_current_desktop, true))
+        {
+            throw std::runtime_error("Application is not shown in Unity");
+        }
+
         return keyfile;
     }())
     , _basePath(basePath)
 
=== modified file 'tests/application-info-desktop.cpp'
--- tests/application-info-desktop.cpp	2016-02-10 22:04:00 +0000
+++ tests/application-info-desktop.cpp	2016-04-26 13:49:48 +0000
@@ -20,28 +20,46 @@
 #include "application-info-desktop.h"
 
 #include <gtest/gtest.h>
+#include <cstdlib>
+
+namespace
+{
+#define DESKTOP "Desktop Entry"
 
 class ApplicationInfoDesktop : public ::testing::Test
 {
+protected:
+    ApplicationInfoDesktop()
+      : test_dekstop_env("SomeFreeDesktop")
+    {
+    }
+
     virtual void SetUp()
     {
+        setenv("XDG_CURRENT_DESKTOP", test_dekstop_env.c_str(), true);
     }
 
     virtual void TearDown()
     {
     }
+
+    std::shared_ptr<GKeyFile> defaultKeyfile()
+    {
+        auto keyfile = std::shared_ptr<GKeyFile>(g_key_file_new(), g_key_file_free);
+        g_key_file_set_string(keyfile.get(), DESKTOP, "Type", "Application");
+        g_key_file_set_string(keyfile.get(), DESKTOP, "Name", "Foo App");
+        g_key_file_set_string(keyfile.get(), DESKTOP, "Exec", "foo");
+        g_key_file_set_string(keyfile.get(), DESKTOP, "Icon", "foo.png");
+        return keyfile;
+    }
+
+    const std::string test_dekstop_env;
 };
 
-#define DESKTOP "Desktop Entry"
 
 TEST_F(ApplicationInfoDesktop, DefaultState)
 {
-    auto keyfile = std::shared_ptr<GKeyFile>(g_key_file_new(), g_key_file_free);
-    g_key_file_set_string(keyfile.get(), DESKTOP, "Name", "Foo App");
-    g_key_file_set_string(keyfile.get(), DESKTOP, "Exec", "foo");
-    g_key_file_set_string(keyfile.get(), DESKTOP, "Icon", "foo.png");
-
-    auto appinfo = ubuntu::app_launch::app_info::Desktop(keyfile, "/");
+    auto appinfo = ubuntu::app_launch::app_info::Desktop(defaultKeyfile(), "/");
 
     EXPECT_EQ("Foo App", appinfo.name().value());
     EXPECT_EQ("", appinfo.description().value());
@@ -66,21 +84,61 @@
 
 TEST_F(ApplicationInfoDesktop, KeyfileErrors)
 {
+    // empty
     EXPECT_THROW(ubuntu::app_launch::app_info::Desktop({}, "/"), std::runtime_error);
 
-    auto noname = std::shared_ptr<GKeyFile>(g_key_file_new(), g_key_file_free);
-    g_key_file_set_string(noname.get(), DESKTOP, "Comment", "This is a comment");
-    g_key_file_set_string(noname.get(), DESKTOP, "Exec", "foo");
-    g_key_file_set_string(noname.get(), DESKTOP, "Icon", "foo.png");
-
+    // empty name
+    auto noname = defaultKeyfile();
+    g_key_file_remove_key(noname.get(), DESKTOP, "Name", nullptr);
     EXPECT_THROW(ubuntu::app_launch::app_info::Desktop(noname, "/"), std::runtime_error);
 
-    auto noicon = std::shared_ptr<GKeyFile>(g_key_file_new(), g_key_file_free);
-    g_key_file_set_string(noicon.get(), DESKTOP, "Name", "Foo App");
-    g_key_file_set_string(noicon.get(), DESKTOP, "Comment", "This is a comment");
-    g_key_file_set_string(noicon.get(), DESKTOP, "Exec", "foo");
-
+    // empty icon
+    auto noicon = defaultKeyfile();
+    g_key_file_remove_key(noicon.get(), DESKTOP, "Icon", nullptr);
     EXPECT_THROW(ubuntu::app_launch::app_info::Desktop(noicon, "/"), std::runtime_error);
+
+    // wrong type
+    auto wrongtype = defaultKeyfile();
+    g_key_file_set_string(wrongtype.get(), DESKTOP, "Type", "MimeType");
+    EXPECT_THROW(ubuntu::app_launch::app_info::Desktop(wrongtype, "/"), std::runtime_error);
+
+    // not displayable
+    auto nodisplay = defaultKeyfile();
+    g_key_file_set_string(nodisplay.get(), DESKTOP, "NoDisplay", "true");
+    EXPECT_THROW(ubuntu::app_launch::app_info::Desktop(nodisplay, "/"), std::runtime_error);
+
+    // hidden
+    auto hidden = defaultKeyfile();
+    g_key_file_set_string(hidden.get(), DESKTOP, "Hidden", "true");
+    EXPECT_THROW(ubuntu::app_launch::app_info::Desktop(hidden, "/"), std::runtime_error);
+
+    // not shown in Unity
+    auto notshowin = defaultKeyfile();
+    g_key_file_set_string(notshowin.get(), DESKTOP, "NotShowIn", ("Gnome;" + test_dekstop_env + ";").c_str());
+    EXPECT_THROW(ubuntu::app_launch::app_info::Desktop(notshowin, "/"), std::runtime_error);
+
+    // only show in not Unity
+    auto onlyshowin = defaultKeyfile();
+    g_key_file_set_string(onlyshowin.get(), DESKTOP, "OnlyShowIn", "KDE;Gnome;");
+    EXPECT_THROW(ubuntu::app_launch::app_info::Desktop(onlyshowin, "/"), std::runtime_error);
+}
+
+TEST_F(ApplicationInfoDesktop, KeyfileShowListEdgeCases)
+{
+  // Not appearing in not show list
+  auto notshowin = defaultKeyfile();
+  g_key_file_set_string(notshowin.get(), DESKTOP, "NotShowIn", "Gnome;KDE;");
+  EXPECT_NO_THROW(ubuntu::app_launch::app_info::Desktop(notshowin, "/"));
+
+  // Appearing explicitly in only show list
+  auto onlyshowin = defaultKeyfile();
+  g_key_file_set_string(onlyshowin.get(), DESKTOP, "OnlyShowIn", (test_dekstop_env + ";Gnome;").c_str());
+  EXPECT_NO_THROW(ubuntu::app_launch::app_info::Desktop(onlyshowin, "/"));
+
+  // Appearing explicitly in only show list not first
+  auto onlyshowinmiddle = defaultKeyfile();
+  g_key_file_set_string(onlyshowinmiddle.get(), DESKTOP, "OnlyShowIn", ("Gnome;" + test_dekstop_env + ";KDE;").c_str());
+  EXPECT_NO_THROW(ubuntu::app_launch::app_info::Desktop(onlyshowinmiddle, "/"));
 }
 
 TEST_F(ApplicationInfoDesktop, Orientations)
@@ -97,10 +155,7 @@
         true
     };
 
-    auto keyfile = std::shared_ptr<GKeyFile>(g_key_file_new(), g_key_file_free);
-    g_key_file_set_string(keyfile.get(), DESKTOP, "Name", "Foo App");
-    g_key_file_set_string(keyfile.get(), DESKTOP, "Exec", "foo");
-    g_key_file_set_string(keyfile.get(), DESKTOP, "Icon", "foo.png");
+    auto keyfile = defaultKeyfile();
 
     EXPECT_EQ(defaultOrientations, ubuntu::app_launch::app_info::Desktop(keyfile, "/").supportedOrientations());
 
@@ -146,3 +201,4 @@
     EXPECT_EQ(defaultOrientations,
               ubuntu::app_launch::app_info::Desktop(keyfile, "/").supportedOrientations());
 }
+} //anonymous namespace