On Linux, automatically create app shortcuts on install or update.

chrome/browser/shell_integration_unittest.cc

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "chrome/browser/shell_integration.h"
 
 #include <cstdlib>
 #include <map>
 
 #include "base/file_util.h"
@@ skipping 88 matching lines @@
  private:
   // Map from name to original value, or the empty string if there was no
   // previous value.
   std::map<std::string, std::string> old_variables_;
 
   DISALLOW_COPY_AND_ASSIGN(ScopedEnvironment);
 };
 
 }  // namespace
 
-TEST(ShellIntegrationTest, GetDesktopShortcutTemplate) {
-#if defined(GOOGLE_CHROME_BUILD)
-  const char kTemplateFilename[] = "google-chrome.desktop";
-#else  // CHROMIUM_BUILD
-  const char kTemplateFilename[] = "chromium-browser.desktop";
-#endif
-
+TEST(ShellIntegrationTest, GetExistingDesktopShortcutContents) {
+  const char kTemplateFilename[] = "shortcut-test.desktop";
+  base::FilePath kTemplateFilepath(kTemplateFilename);
   const char kTestData1[] = "a magical testing string";
   const char kTestData2[] = "a different testing string";
 
   MessageLoop message_loop;
   content::TestBrowserThread file_thread(BrowserThread::FILE, &message_loop);
 
+  // Test that it searches $XDG_DATA_HOME/applications.
   {
     base::ScopedTempDir temp_dir;
     ASSERT_TRUE(temp_dir.CreateUniqueTempDir());
 
     MockEnvironment env;
     env.Set("XDG_DATA_HOME", temp_dir.path().value());
+    // Create a file in a non-applications directory. This should be ignored.
     ASSERT_TRUE(file_util::WriteFile(
         temp_dir.path().AppendASCII(kTemplateFilename),
+        kTestData2, strlen(kTestData2)));
+    ASSERT_TRUE(file_util::CreateDirectory(
+        temp_dir.path().AppendASCII("applications")));
+    ASSERT_TRUE(file_util::WriteFile(
+        temp_dir.path().AppendASCII("applications")
+            .AppendASCII(kTemplateFilename),
         kTestData1, strlen(kTestData1)));
     std::string contents;
-    ASSERT_TRUE(ShellIntegrationLinux::GetDesktopShortcutTemplate(&env,
-                                                                  &contents));
+    ASSERT_TRUE(
+        ShellIntegrationLinux::GetExistingDesktopShortcutContents(
+            &env, kTemplateFilepath, &contents));
     EXPECT_EQ(kTestData1, contents);
   }
 
+  // Test that it falls back to $HOME/.local/share/applications.
   {
     base::ScopedTempDir temp_dir;
     ASSERT_TRUE(temp_dir.CreateUniqueTempDir());
+
+    MockEnvironment env;
+    env.Set("HOME", temp_dir.path().value());
+    ASSERT_TRUE(file_util::CreateDirectory(
+        temp_dir.path().AppendASCII(".local/share/applications")));
+    ASSERT_TRUE(file_util::WriteFile(
+        temp_dir.path().AppendASCII(".local/share/applications")
+            .AppendASCII(kTemplateFilename),
+        kTestData1, strlen(kTestData1)));
+    std::string contents;
+    ASSERT_TRUE(
+        ShellIntegrationLinux::GetExistingDesktopShortcutContents(
+            &env, kTemplateFilepath, &contents));
+    EXPECT_EQ(kTestData1, contents);
+  }
+
+  // Test that it searches $XDG_DATA_DIRS/applications.
+  {
+    base::ScopedTempDir temp_dir;
+    ASSERT_TRUE(temp_dir.CreateUniqueTempDir());
 
     MockEnvironment env;
     env.Set("XDG_DATA_DIRS", temp_dir.path().value());
     ASSERT_TRUE(file_util::CreateDirectory(
         temp_dir.path().AppendASCII("applications")));
     ASSERT_TRUE(file_util::WriteFile(
         temp_dir.path().AppendASCII("applications")
             .AppendASCII(kTemplateFilename),
         kTestData2, strlen(kTestData2)));
     std::string contents;
-    ASSERT_TRUE(ShellIntegrationLinux::GetDesktopShortcutTemplate(&env,
-                                                                  &contents));
+    ASSERT_TRUE(
+        ShellIntegrationLinux::GetExistingDesktopShortcutContents(
+            &env, kTemplateFilepath, &contents));
     EXPECT_EQ(kTestData2, contents);
   }
 
+  // Test that it searches $X/applications for each X in $XDG_DATA_DIRS.
+  {
+    base::ScopedTempDir temp_dir1;
+    ASSERT_TRUE(temp_dir1.CreateUniqueTempDir());
+    base::ScopedTempDir temp_dir2;
+    ASSERT_TRUE(temp_dir2.CreateUniqueTempDir());
+
+    MockEnvironment env;
+    env.Set("XDG_DATA_DIRS", temp_dir1.path().value() + ":" +
+                             temp_dir2.path().value());
+    // Create a file in a non-applications directory. This should be ignored.
+    ASSERT_TRUE(file_util::WriteFile(
+        temp_dir1.path().AppendASCII(kTemplateFilename),
+        kTestData1, strlen(kTestData1)));
+    // Only create a findable desktop file in the second path.
+    ASSERT_TRUE(file_util::CreateDirectory(
+        temp_dir2.path().AppendASCII("applications")));
+    ASSERT_TRUE(file_util::WriteFile(
+        temp_dir2.path().AppendASCII("applications")
+            .AppendASCII(kTemplateFilename),
+        kTestData2, strlen(kTestData2)));
+    std::string contents;
+    ASSERT_TRUE(
+        ShellIntegrationLinux::GetExistingDesktopShortcutContents(
+            &env, kTemplateFilepath, &contents));
+    EXPECT_EQ(kTestData2, contents);
+  }
+}
+
+TEST(ShellIntegrationTest, GetDesktopShortcutTemplate) {
+#if defined(GOOGLE_CHROME_BUILD)
+  const char kTemplateFilename[] = "google-chrome.desktop";
+#else  // CHROMIUM_BUILD
+  const char kTemplateFilename[] = "chromium-browser.desktop";
+#endif
+
+  const char kTestData[] = "a magical testing string";
+
+  MessageLoop message_loop;
+  content::TestBrowserThread file_thread(BrowserThread::FILE, &message_loop);
+
+  // Just do a simple test. The details are covered by
+  // GetExistingDesktopShortcutContents test.
   {
     base::ScopedTempDir temp_dir;
     ASSERT_TRUE(temp_dir.CreateUniqueTempDir());
 
     MockEnvironment env;
-    env.Set("XDG_DATA_DIRS", temp_dir.path().value() + ":" +
-                   temp_dir.path().AppendASCII("applications").value());
+    env.Set("XDG_DATA_HOME", temp_dir.path().value());
     ASSERT_TRUE(file_util::CreateDirectory(
         temp_dir.path().AppendASCII("applications")));
     ASSERT_TRUE(file_util::WriteFile(
-        temp_dir.path().AppendASCII(kTemplateFilename),
-        kTestData1, strlen(kTestData1)));
-    ASSERT_TRUE(file_util::WriteFile(
         temp_dir.path().AppendASCII("applications")
             .AppendASCII(kTemplateFilename),
-        kTestData2, strlen(kTestData2)));
+        kTestData, strlen(kTestData)));
     std::string contents;
     ASSERT_TRUE(ShellIntegrationLinux::GetDesktopShortcutTemplate(&env,
                                                                   &contents));
-    EXPECT_EQ(kTestData1, contents);
+    EXPECT_EQ(kTestData, contents);
   }
 }
 
 TEST(ShellIntegrationTest, GetWebShortcutFilename) {
   const struct {
     const base::FilePath::CharType* path;
     const char* url;
   } test_cases[] = {
     { FPL("http___foo_.desktop"), "http://foo" },
     { FPL("http___foo_bar_.desktop"), "http://foo/bar/" },
@@ skipping 11 matching lines @@
                   GURL(test_cases[i].url)).value()) <<
         " while testing " << test_cases[i].url;
   }
 }
 
 TEST(ShellIntegrationTest, GetDesktopFileContents) {
   const struct {
     const char* url;
     const char* title;
     const char* icon_name;
+    bool nodisplay;
     const char* template_contents;
     const char* expected_output;
   } test_cases[] = {
     // Dumb case.
-    { "ignored", "ignored", "ignored", "", "#!/usr/bin/env xdg-open\n" },
+    { "ignored", "ignored", "ignored", false, "", "#!/usr/bin/env xdg-open\n" },
 
     // Real-world case.
     { "http://gmail.com",
       "GMail",
       "chrome-http__gmail.com",
+      false,
 
       "[Desktop Entry]\n"
       "Version=1.0\n"
       "Encoding=UTF-8\n"
       "Name=Google Chrome\n"
       "GenericName=Web Browser\n"
       "Comment=The web browser from Google\n"
       "Exec=/opt/google/chrome/google-chrome %U\n"
       "Terminal=false\n"
       "Icon=/opt/google/chrome/product_logo_48.png\n"
@@ skipping 21 matching lines @@
       // Aura Chrome does not (yet) set WMClass, so we only expect
       // StartupWMClass on non-Aura builds.
       "StartupWMClass=gmail.com\n"
 #endif
     },
 
     // Make sure we don't insert duplicate shebangs.
     { "http://gmail.com",
       "GMail",
       "chrome-http__gmail.com",
+      false,
 
       "#!/some/shebang\n"
       "[Desktop Entry]\n"
       "Name=Google Chrome\n"
       "Exec=/opt/google/chrome/google-chrome %U\n",
 
       "#!/usr/bin/env xdg-open\n"
       "[Desktop Entry]\n"
       "Name=GMail\n"
       "Exec=/opt/google/chrome/google-chrome --app=http://gmail.com/\n"
       "Icon=chrome-http__gmail.com\n"
 #if !defined(USE_AURA)
       // Aura Chrome does not (yet) set WMClass, so we only expect
       // StartupWMClass on non-Aura builds.
       "StartupWMClass=gmail.com\n"
 #endif
     },
 
     // Make sure i18n-ed names and other fields are removed.
     { "http://gmail.com",
       "GMail",
       "chrome-http__gmail.com",
+      false,
 
       "[Desktop Entry]\n"
       "Name=Google Chrome\n"
       "Name[en_AU]=Google Chrome\n"
       "Name[pl]=Google Chrome\n"
       "GenericName=Web Browser\n"
       "GenericName[en_AU]=Web Browser\n"
       "GenericName[pl]=Navegador Web\n"
       "Exec=/opt/google/chrome/google-chrome %U\n"
       "Comment[en_AU]=Some comment.\n"
       "Comment[pl]=Jakis komentarz.\n",
 
       "#!/usr/bin/env xdg-open\n"
       "[Desktop Entry]\n"
       "Name=GMail\n"
       "Exec=/opt/google/chrome/google-chrome --app=http://gmail.com/\n"
       "Icon=chrome-http__gmail.com\n"
 #if !defined(USE_AURA)
       // Aura Chrome does not (yet) set WMClass, so we only expect
       // StartupWMClass on non-Aura builds.
       "StartupWMClass=gmail.com\n"
 #endif
     },
 
     // Make sure that empty icons are replaced by the chrome icon.
     { "http://gmail.com",
       "GMail",
       "",
+      false,
 
       "[Desktop Entry]\n"
       "Name=Google Chrome\n"
       "Exec=/opt/google/chrome/google-chrome %U\n"
       "Comment[pl]=Jakis komentarz.\n"
       "Icon=/opt/google/chrome/product_logo_48.png\n",
 
       "#!/usr/bin/env xdg-open\n"
       "[Desktop Entry]\n"
       "Name=GMail\n"
       "Exec=/opt/google/chrome/google-chrome --app=http://gmail.com/\n"
       "Icon=/opt/google/chrome/product_logo_48.png\n"
 #if !defined(USE_AURA)
       // Aura Chrome does not (yet) set WMClass, so we only expect
       // StartupWMClass on non-Aura builds.
       "StartupWMClass=gmail.com\n"
 #endif
     },
 
+    // Test adding NoDisplay=true.
+    { "http://gmail.com",
+      "GMail",
+      "chrome-http__gmail.com",
+      true,
+
+      "[Desktop Entry]\n"
+      "Name=Google Chrome\n"
+      "Exec=/opt/google/chrome/google-chrome %U\n",
+
+      "#!/usr/bin/env xdg-open\n"
+      "[Desktop Entry]\n"
+      "Name=GMail\n"
+      "Exec=/opt/google/chrome/google-chrome --app=http://gmail.com/\n"
+      "Icon=chrome-http__gmail.com\n"
+      "NoDisplay=true\n"
+#if !defined(USE_AURA)
+      // Aura Chrome does not (yet) set WMClass, so we only expect
+      // StartupWMClass on non-Aura builds.
+      "StartupWMClass=gmail.com\n"
+#endif
+    },
+
     // Now we're starting to be more evil...
     { "http://evil.com/evil --join-the-b0tnet",
       "Ownz0red\nExec=rm -rf /",
       "chrome-http__evil.com_evil",
+      false,
 
       "[Desktop Entry]\n"
       "Name=Google Chrome\n"
       "Exec=/opt/google/chrome/google-chrome %U\n",
 
       "#!/usr/bin/env xdg-open\n"
       "[Desktop Entry]\n"
       "Name=http://evil.com/evil%20--join-the-b0tnet\n"
       "Exec=/opt/google/chrome/google-chrome "
       "--app=http://evil.com/evil%20--join-the-b0tnet\n"
       "Icon=chrome-http__evil.com_evil\n"
 #if !defined(USE_AURA)
       // Aura Chrome does not (yet) set WMClass, so we only expect
       // StartupWMClass on non-Aura builds.
       "StartupWMClass=evil.com__evil%20--join-the-b0tnet\n"
 #endif
     },
     { "http://evil.com/evil; rm -rf /; \"; rm -rf $HOME >ownz0red",
       "Innocent Title",
       "chrome-http__evil.com_evil",
+      false,
 
       "[Desktop Entry]\n"
       "Name=Google Chrome\n"
       "Exec=/opt/google/chrome/google-chrome %U\n",
 
       "#!/usr/bin/env xdg-open\n"
       "[Desktop Entry]\n"
       "Name=Innocent Title\n"
       "Exec=/opt/google/chrome/google-chrome "
       "\"--app=http://evil.com/evil;%20rm%20-rf%20/;%20%22;%20rm%20"
       // Note: $ is escaped as \$ within an arg to Exec, and then
       // the \ is escaped as \\ as all strings in a Desktop file should
       // be; finally, \\ becomes \\\\ when represented in a C++ string!
       "-rf%20\\\\$HOME%20%3Eownz0red\"\n"
       "Icon=chrome-http__evil.com_evil\n"
 #if !defined(USE_AURA)
       // Aura Chrome does not (yet) set WMClass, so we only expect
       // StartupWMClass on non-Aura builds.
       "StartupWMClass=evil.com__evil;%20rm%20-rf%20_;%20%22;%20"
       "rm%20-rf%20$HOME%20%3Eownz0red\n"
 #endif
     },
     { "http://evil.com/evil | cat `echo ownz0red` >/dev/null",
       "Innocent Title",
       "chrome-http__evil.com_evil",
+      false,
 
       "[Desktop Entry]\n"
       "Name=Google Chrome\n"
       "Exec=/opt/google/chrome/google-chrome %U\n",
 
       "#!/usr/bin/env xdg-open\n"
       "[Desktop Entry]\n"
       "Name=Innocent Title\n"
       "Exec=/opt/google/chrome/google-chrome "
       "--app=http://evil.com/evil%20%7C%20cat%20%60echo%20ownz0red"
@@ skipping 19 matching lines @@
     EXPECT_EQ(
         test_cases[i].expected_output,
         ShellIntegrationLinux::GetDesktopFileContents(
             test_cases[i].template_contents,
             web_app::GenerateApplicationNameFromURL(GURL(test_cases[i].url)),
             GURL(test_cases[i].url),
             "",
             base::FilePath(),
             ASCIIToUTF16(test_cases[i].title),
             test_cases[i].icon_name,
-            base::FilePath()));
+            base::FilePath(),
+            test_cases[i].nodisplay));
   }
 }
+
+TEST(ShellIntegrationTest, DesktopShortcutLocations) {
+  base::FilePath kProfilePath("Default");
+  const char kExtensionId[] = "test_extension";
+  const char kTemplateFilename[] = "chrome-test_extension-Default.desktop";
+  base::FilePath kTemplateFilepath(kTemplateFilename);
+  const char kNoDisplayDesktopFile[] = "[Desktop Entry]\nNoDisplay=true";
+
+  MessageLoop message_loop;
+  content::TestBrowserThread file_thread(BrowserThread::FILE, &message_loop);
+
+  // No existing shortcuts.
+  {
+    MockEnvironment env;
+    ShellIntegration::ShortcutLocations result =
+        ShellIntegrationLinux::DesktopShortcutLocations(
+            &env, kProfilePath, kExtensionId);
+    EXPECT_FALSE(result.on_desktop);
+    EXPECT_FALSE(result.in_applications_menu);
+    EXPECT_FALSE(result.in_quick_launch_bar);
+    EXPECT_TRUE(result.hidden);
+  }
+
+  // Shortcut on desktop.
+  {
+    base::ScopedTempDir temp_dir;
+    ASSERT_TRUE(temp_dir.CreateUniqueTempDir());
+    base::FilePath desktop_path = temp_dir.path();
+
+    MockEnvironment env;
+    ASSERT_TRUE(file_util::CreateDirectory(desktop_path));
+    ASSERT_FALSE(file_util::WriteFile(
+        desktop_path.AppendASCII(kTemplateFilename),
+        "", 0));
+    ShellIntegration::ShortcutLocations result =
+        ShellIntegrationLinux::DesktopShortcutLocations(
+            &env, kProfilePath, kExtensionId, desktop_path);
+    EXPECT_TRUE(result.on_desktop);
+    EXPECT_FALSE(result.in_applications_menu);
+    EXPECT_FALSE(result.in_quick_launch_bar);
+    EXPECT_TRUE(result.hidden);
+  }
+
+  // Shortcut in applications directory.
+  {
+    base::ScopedTempDir temp_dir;
+    ASSERT_TRUE(temp_dir.CreateUniqueTempDir());
+    base::FilePath apps_path = temp_dir.path().AppendASCII("applications");
+
+    MockEnvironment env;
+    env.Set("XDG_DATA_HOME", temp_dir.path().value());
+    ASSERT_TRUE(file_util::CreateDirectory(apps_path));
+    ASSERT_FALSE(file_util::WriteFile(
+        apps_path.AppendASCII(kTemplateFilename),
+        "", 0));
+    ShellIntegration::ShortcutLocations result =
+        ShellIntegrationLinux::DesktopShortcutLocations(
+            &env, kProfilePath, kExtensionId);
+    EXPECT_FALSE(result.on_desktop);
+    EXPECT_TRUE(result.in_applications_menu);
+    EXPECT_FALSE(result.in_quick_launch_bar);
+    EXPECT_TRUE(result.hidden);   // This will be ignored.
+  }
+
+  // Shortcut in applications directory with NoDisplay=true.
+  {
+    base::ScopedTempDir temp_dir;
+    ASSERT_TRUE(temp_dir.CreateUniqueTempDir());
+    base::FilePath apps_path = temp_dir.path().AppendASCII("applications");
+
+    MockEnvironment env;
+    env.Set("XDG_DATA_HOME", temp_dir.path().value());
+    ASSERT_TRUE(file_util::CreateDirectory(apps_path));
+    ASSERT_TRUE(file_util::WriteFile(
+        apps_path.AppendASCII(kTemplateFilename),
+        kNoDisplayDesktopFile, strlen(kNoDisplayDesktopFile)));
+    ShellIntegration::ShortcutLocations result =
+        ShellIntegrationLinux::DesktopShortcutLocations(
+            &env, kProfilePath, kExtensionId);
+    // Doesn't count as being in applications menu.
+    EXPECT_FALSE(result.on_desktop);
+    EXPECT_FALSE(result.in_applications_menu);
+    EXPECT_FALSE(result.in_quick_launch_bar);
+    EXPECT_TRUE(result.hidden);
+  }
+
+  // Shortcut on desktop and in applications directory.
+  {
+    base::ScopedTempDir temp_dir1;
+    ASSERT_TRUE(temp_dir1.CreateUniqueTempDir());
+    base::FilePath desktop_path = temp_dir1.path();
+
+    base::ScopedTempDir temp_dir2;
+    ASSERT_TRUE(temp_dir2.CreateUniqueTempDir());
+    base::FilePath apps_path = temp_dir2.path().AppendASCII("applications");
+
+    MockEnvironment env;
+    ASSERT_TRUE(file_util::CreateDirectory(desktop_path));
+    ASSERT_FALSE(file_util::WriteFile(
+        desktop_path.AppendASCII(kTemplateFilename),
+        "", 0));
+    env.Set("XDG_DATA_HOME", temp_dir2.path().value());
+    ASSERT_TRUE(file_util::CreateDirectory(apps_path));
+    ASSERT_FALSE(file_util::WriteFile(
+        apps_path.AppendASCII(kTemplateFilename),
+        "", 0));
+    ShellIntegration::ShortcutLocations result =
+        ShellIntegrationLinux::DesktopShortcutLocations(
+            &env, kProfilePath, kExtensionId, desktop_path);
+    EXPECT_TRUE(result.on_desktop);
+    EXPECT_TRUE(result.in_applications_menu);
+    EXPECT_FALSE(result.in_quick_launch_bar);
+    EXPECT_TRUE(result.hidden);   // This will be ignored.
+  }
+}
+
 #endif