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

chrome/browser/shell_integration_linux.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_linux.h"
 
 #include <fcntl.h>
 #include <glib.h>
 #include <stdlib.h>
 #include <sys/stat.h>
@@ skipping 376 matching lines @@
     // xdg-settings failed: we can't determine or set the default browser.
     return ShellIntegration::UNKNOWN_DEFAULT;
   }
 
   // Allow any reply that starts with "yes".
   return (reply.find("yes") == 0) ? ShellIntegration::IS_DEFAULT :
                                     ShellIntegration::NOT_DEFAULT;
 #endif
 }
 
+// Get the value of NoDisplay from the [Desktop Entry] section of a .desktop
+// file, given in |shortcut_contents|. If the key is not found, returns false.
+bool GetNoDisplayFromDesktopFile(const std::string& shortcut_contents) {
+  GKeyFile* key_file = g_key_file_new();
+  GError* err = NULL;
+  if (!g_key_file_load_from_data(key_file, shortcut_contents.c_str(),
+                                 shortcut_contents.size(), G_KEY_FILE_NONE,
+                                 &err)) {
+    LOG(WARNING) << "Unable to read desktop file template: " << err->message;
+    g_error_free(err);
+    return false;
+  }
+
+  bool nodisplay = false;
+  char* nodisplay_c_string = g_key_file_get_string(key_file, kDesktopEntry,
+                                                   "NoDisplay", &err);
+  if (nodisplay_c_string) {
+    if (!g_strcmp0(nodisplay_c_string, "true"))
+      nodisplay = true;
+    g_free(nodisplay_c_string);
+  }
+
+  g_key_file_free(key_file);
+  return nodisplay;
+}
+
 } // namespace
 
 // static
 ShellIntegration::DefaultWebClientSetPermission
     ShellIntegration::CanSetAsDefaultBrowser() {
   return SET_DEFAULT_UNATTENDED;
 }
 
 // static
 bool ShellIntegration::SetAsDefaultBrowser() {
@@ skipping 43 matching lines @@
   // Allow $CHROME_DESKTOP to override the built-in value, so that development
   // versions can set themselves as the default without interfering with
   // non-official, packaged versions using the built-in value.
   std::string name;
   if (env->GetVar("CHROME_DESKTOP", &name) && !name.empty())
     return name;
   return "chromium-browser.desktop";
 #endif
 }
 
-bool GetDesktopShortcutTemplate(base::Environment* env,
-                                std::string* output) {
+ShellIntegration::ShortcutLocations GetExistingShortcutLocations(
+    base::Environment* env,
+    const base::FilePath& profile_path,
+    const std::string& extension_id) {
+  base::FilePath desktop_path;
+  // If Get returns false, just leave desktop_path empty.
+  PathService::Get(base::DIR_USER_DESKTOP, &desktop_path);
+  return GetExistingShortcutLocations(env, profile_path, extension_id,
+                                             desktop_path);
+}
+
+ShellIntegration::ShortcutLocations GetExistingShortcutLocations(
+    base::Environment* env,
+    const base::FilePath& profile_path,
+    const std::string& extension_id,
+    const base::FilePath& desktop_path) {
+  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::FILE));
+
+  base::FilePath shortcut_filename = GetExtensionShortcutFilename(
+      profile_path, extension_id);
+  DCHECK(!shortcut_filename.empty());
+  ShellIntegration::ShortcutLocations locations;
+
+  // Determine whether there is a shortcut on desktop.
+  if (!desktop_path.empty()) {
+    locations.on_desktop =
+        file_util::PathExists(desktop_path.Append(shortcut_filename));
+  }
+
+  // Determine whether there is a shortcut in applications menu that *does not*
+  // have NoDisplay=true.

[benwells, 2013/03/06 07:44:25]

If there is a shortcut that does have NoDisplay=true, should location.hidden be
set true?

This probably doesn't matter for this patch but will for subsequent changes.

[Matt Giuca, 2013/03/06 08:11:54]

Right again. Done.

+  std::string shortcut_contents;
+  if (GetExistingShortcutContents(env, shortcut_filename,
+                                         &shortcut_contents)) {
+    locations.in_applications_menu =
+        !GetNoDisplayFromDesktopFile(shortcut_contents);
+  }
+
+  return locations;
+}
+
+bool GetExistingShortcutContents(base::Environment* env,
+                                        const base::FilePath& desktop_filename,
+                                        std::string* output) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::FILE));
 
   std::vector<base::FilePath> search_paths;
 
   // Search paths as specified in the XDG Base Directory Specification.
   // http://standards.freedesktop.org/basedir-spec/latest/
   std::string xdg_data_home;
   std::string home;
   if (env->GetVar("XDG_DATA_HOME", &xdg_data_home) &&
       !xdg_data_home.empty()) {
     search_paths.push_back(base::FilePath(xdg_data_home));
   } else if (env->GetVar("HOME", &home) && !home.empty()) {
     search_paths.push_back(base::FilePath(home).Append(".local").Append(
         "share"));
   }
 
   std::string xdg_data_dirs;
   if (env->GetVar("XDG_DATA_DIRS", &xdg_data_dirs) &&
       !xdg_data_dirs.empty()) {
     base::StringTokenizer tokenizer(xdg_data_dirs, ":");
     while (tokenizer.GetNext()) {
       base::FilePath data_dir(tokenizer.token());
       search_paths.push_back(data_dir);
     }
   } else {
     search_paths.push_back(base::FilePath("/usr/local/share"));
     search_paths.push_back(base::FilePath("/usr/share"));
   }
 
-  std::string template_filename(GetDesktopName(env));
   for (std::vector<base::FilePath>::const_iterator i = search_paths.begin();
        i != search_paths.end(); ++i) {
-    base::FilePath path = i->Append("applications").Append(template_filename);
-    VLOG(1) << "Looking for desktop file template in " << path.value();
+    base::FilePath path = i->Append("applications").Append(desktop_filename);
+    VLOG(1) << "Looking for desktop file in " << path.value();
     if (file_util::PathExists(path)) {
-      VLOG(1) << "Found desktop file template at " << path.value();
+      VLOG(1) << "Found desktop file at " << path.value();
       return file_util::ReadFileToString(path, output);
     }
   }
 
-  LOG(ERROR) << "Could not find desktop file template.";
   return false;
 }
 
+bool GetDesktopShortcutTemplate(base::Environment* env,
+                                std::string* output) {
+  base::FilePath template_filename(GetDesktopName(env));
+  if (GetExistingShortcutContents(env, template_filename, output)) {
+    return true;
+  } else {
+    LOG(ERROR) << "Could not find desktop file " << template_filename.value()
+               << ".";
+    return false;
+  }
+}
+
 base::FilePath GetWebShortcutFilename(const GURL& url) {
   // Use a prefix, because xdg-desktop-menu requires it.
   std::string filename =
       std::string(chrome::kBrowserProcessExecutableName) + "-" + url.spec();
   file_util::ReplaceIllegalCharactersInPath(&filename, '_');
 
   base::FilePath desktop_path;
   if (!PathService::Get(base::DIR_USER_DESKTOP, &desktop_path))
     return base::FilePath();
 
@@ skipping 26 matching lines @@
 }
 
 std::string GetDesktopFileContents(
     const std::string& template_contents,
     const std::string& app_name,
     const GURL& url,
     const std::string& extension_id,
     const base::FilePath& extension_path,
     const string16& title,
     const std::string& icon_name,
-    const base::FilePath& profile_path) {
+    const base::FilePath& profile_path,
+    bool no_display) {
   // Although not required by the spec, Nautilus on Ubuntu Karmic creates its
   // launchers with an xdg-open shebang. Follow that convention.
   std::string output_buffer = std::string(kXdgOpenShebang) + "\n";
   if (template_contents.empty())
     return output_buffer;
 
   // See http://standards.freedesktop.org/desktop-entry-spec/latest/
   // http://developer.gnome.org/glib/unstable/glib-Key-value-file-parser.html
   GKeyFile* key_file = g_key_file_new();
   GError* err = NULL;
@@ skipping 80 matching lines @@
       }
     }
 
     g_key_file_set_string(key_file, kDesktopEntry, "Exec", final_path.c_str());
   }
 
   // Set the "Icon" key.
   if (!icon_name.empty())
     g_key_file_set_string(key_file, kDesktopEntry, "Icon", icon_name.c_str());
 
+  // Set the "NoDisplay" key.
+  if (no_display)
+    g_key_file_set_string(key_file, kDesktopEntry, "NoDisplay", "true");
+
 #if defined(TOOLKIT_GTK)
   std::string wmclass = web_app::GetWMClassFromAppName(app_name);
   g_key_file_set_string(key_file, kDesktopEntry, "StartupWMClass",
                         wmclass.c_str());
 #endif
 
   length = 0;
   gchar* data_dump = g_key_file_to_data(key_file, &length, NULL);
   if (data_dump) {
     // If strlen(data_dump[0]) == 0, this check will fail.
@@ skipping 18 matching lines @@
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::FILE));
 
   base::FilePath shortcut_filename;
   if (!shortcut_info.extension_id.empty()) {
     shortcut_filename = GetExtensionShortcutFilename(
         shortcut_info.profile_path, shortcut_info.extension_id);
     // For extensions we do not want duplicate shortcuts. So, delete any that
     // already exist and replace them.
     if (creation_locations.on_desktop)
       DeleteShortcutOnDesktop(shortcut_filename);
-    if (creation_locations.in_applications_menu)
+    if (creation_locations.in_applications_menu || creation_locations.hidden)
       DeleteShortcutInApplicationsMenu(shortcut_filename);
   } else {
     shortcut_filename = GetWebShortcutFilename(shortcut_info.url);
   }
   if (shortcut_filename.empty())
     return false;
 
   std::string icon_name = CreateShortcutIcon(shortcut_info, shortcut_filename);
 
   std::string app_name =
       web_app::GenerateApplicationNameFromInfo(shortcut_info);
-  std::string contents = ShellIntegrationLinux::GetDesktopFileContents(
-      shortcut_template,
-      app_name,
-      shortcut_info.url,
-      shortcut_info.extension_id,
-      shortcut_info.extension_path,
-      shortcut_info.title,
-      icon_name,
-      shortcut_info.profile_path);
 
   bool success = true;
 
-  if (creation_locations.on_desktop)
+  if (creation_locations.on_desktop) {
+    std::string contents = ShellIntegrationLinux::GetDesktopFileContents(
+        shortcut_template,
+        app_name,
+        shortcut_info.url,
+        shortcut_info.extension_id,
+        shortcut_info.extension_path,
+        shortcut_info.title,
+        icon_name,
+        shortcut_info.profile_path,
+        false);
     success = CreateShortcutOnDesktop(shortcut_filename, contents);
+  }
 
-  if (creation_locations.in_applications_menu)
+  // The 'in_applications_menu' and 'hidden' locations are actually the same
+  // place ('applications').
+  if (creation_locations.in_applications_menu || creation_locations.hidden) {
+    // Set NoDisplay=true if hidden but not in_applications_menu. This will hide
+    // the application from user-facing menus.
+    std::string contents = ShellIntegrationLinux::GetDesktopFileContents(
+        shortcut_template,
+        app_name,
+        shortcut_info.url,
+        shortcut_info.extension_id,
+        shortcut_info.extension_path,
+        shortcut_info.title,
+        icon_name,
+        shortcut_info.profile_path,
+        !creation_locations.in_applications_menu);
     success = CreateShortcutInApplicationsMenu(shortcut_filename, contents) &&
               success;
+  }
 
   return success;
 }
 
 void DeleteDesktopShortcuts(const base::FilePath& profile_path,
                             const std::string& extension_id) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::FILE));
 
   base::FilePath shortcut_filename = GetExtensionShortcutFilename(
       profile_path, extension_id);
   DCHECK(!shortcut_filename.empty());
 
   DeleteShortcutOnDesktop(shortcut_filename);
   DeleteShortcutInApplicationsMenu(shortcut_filename);
 }
 
 }  // namespace ShellIntegrationLinux