GTK: Use glib's desktop file parser instead of our hand rolled one.

chrome/browser/shell_integration_linux.cc

 // Copyright (c) 2011 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 <fcntl.h>
+#include <glib.h>
 #include <stdlib.h>
 #include <sys/stat.h>
 #include <sys/types.h>
 #include <unistd.h>
 
 #include <string>
 #include <vector>
 
 #include "base/command_line.h"
 #include "base/eintr_wrapper.h"
@@ skipping 179 matching lines @@
         quoted += '\\';
         break;
     }
     quoted += arg[i];
   }
   quoted += '"';
 
   return quoted;
 }
 
-// Escape a string if needed for the right side of a Key=Value
-// construct in a desktop file.  (Note that for Exec= lines this
-// should be used in conjunction with QuoteArgForDesktopFileExec,
-// possibly escaping a backslash twice.)
-std::string EscapeStringForDesktopFile(const std::string& arg) {
-  // http://standards.freedesktop.org/desktop-entry-spec/latest/ar01s03.html
-  if (arg.find('\\') == std::string::npos)
-    return arg;
+// Remove keys that we certainly don't want.

[Evan Martin, 2011/05/11 21:29:06]

Can you make this comment describe what this is?  The comment you have here
seems more like a description of what some code later likely does

+const char* kDesktopKeysToDelete[] = {
+  "GenericName",
+  "Comment",
+  "MimeType",
+  "X-Ayatana-Desktop-Shortcuts",
+  "StartupWMClass",  // read only on TOOLKIT_GTK

[Evan Martin, 2011/05/11 21:29:06]

what does this comment mean?

+  NULL
+};
 
-  std::string escaped;
-  for (size_t i = 0; i < arg.size(); ++i) {
-    if (arg[i] == '\\')
-      escaped += '\\';
-    escaped += arg[i];
-  }
-  return escaped;
-}
+const char* kDesktopEntry = "Desktop Entry";
+
+const char* kXdgOpenShebang = "#!/usr/bin/env xdg-open\n";
 
 }  // namespace
 
 // static
 std::string ShellIntegration::GetDesktopName(base::Environment* env) {
 #if defined(GOOGLE_CHROME_BUILD)
   return "google-chrome.desktop";
 #else  // CHROMIUM_BUILD
   // Allow $CHROME_DESKTOP to override the built-in value, so that development
   // versions can set themselves as the default without interfering with
@@ skipping 127 matching lines @@
 }
 
 // static
 std::string ShellIntegration::GetDesktopFileContents(
     const std::string& template_contents,
     const std::string& app_name,
     const GURL& url,
     const std::string& extension_id,
     const string16& title,
     const std::string& icon_name) {
+  if (template_contents.empty())
+    return kXdgOpenShebang;
+
   // See http://standards.freedesktop.org/desktop-entry-spec/latest/
-  // 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("#!/usr/bin/env xdg-open\n");
-  StringTokenizer tokenizer(template_contents, "\n");
-  while (tokenizer.GetNext()) {
-    if (tokenizer.token().substr(0, 5) == "Exec=") {
-      std::string exec_path = tokenizer.token().substr(5);
-      StringTokenizer exec_tokenizer(exec_path, " ");
-      std::string final_path;
-      while (exec_tokenizer.GetNext() && exec_tokenizer.token() != "%U") {
-        if (!final_path.empty())
-          final_path += " ";
-        final_path += exec_tokenizer.token();
-      }
-      CommandLine cmd_line =
-          ShellIntegration::CommandLineArgsForLauncher(url, extension_id);
-      const CommandLine::SwitchMap& switch_map = cmd_line.GetSwitches();
-      for (CommandLine::SwitchMap::const_iterator i = switch_map.begin();
-           i != switch_map.end(); ++i) {
-        if (i->second.empty()) {
-          final_path += " --" + i->first;
-        } else {
-          final_path += " " + QuoteArgForDesktopFileExec("--" + i->first +
-                                                         "=" + i->second);
-        }
-      }
-      output_buffer += std::string("Exec=") +
-                       EscapeStringForDesktopFile(final_path) + "\n";
-    } else if (tokenizer.token().substr(0, 5) == "Name=") {
-      std::string final_title = UTF16ToUTF8(title);
-      // Make sure no endline characters can slip in and possibly introduce
-      // additional lines (like Exec, which makes it a security risk). Also
-      // use the URL as a default when the title is empty.
-      if (final_title.empty() ||
-          final_title.find("\n") != std::string::npos ||
-          final_title.find("\r") != std::string::npos) {
-        final_title = url.spec();
-      }
-      output_buffer += StringPrintf("Name=%s\n", final_title.c_str());
-    } else if (tokenizer.token().substr(0, 11) == "GenericName" ||
-               tokenizer.token().substr(0, 7) == "Comment" ||
-               tokenizer.token().substr(0, 1) == "#") {
-      // Skip comment lines.
-    } else if (tokenizer.token().substr(0, 9) == "MimeType=") {
-      // Skip MimeType lines, they are only relevant for a web browser
-      // shortcut, not a web application shortcut.
-    } else if (tokenizer.token().substr(0, 15) == "StartupWMClass=") {
-      // Skip StartupWMClass; it will certainly be wrong since we emit a
-      // different one based on the app name below.
-    } else if (tokenizer.token().substr(0, 5) == "Icon=" &&
-               !icon_name.empty()) {
-      output_buffer += StringPrintf("Icon=%s\n", icon_name.c_str());
-    } else {
-      output_buffer += tokenizer.token() + "\n";
+  // http://developer.gnome.org/glib/unstable/glib-Key-value-file-parser.html

[Evan Martin, 2011/05/11 21:29:06]

Oh wow, I had no idea this existed!

+  GKeyFile* key_file = g_key_file_new();
+  GError* err = NULL;
+  // Loading the data will strip translations and comments from the desktop
+  // file (which we want to do!)
+  if (!g_key_file_load_from_data(
+          key_file,
+          template_contents.c_str(),
+          template_contents.size(),
+          G_KEY_FILE_NONE,
+          &err)) {
+    NOTREACHED() << "Unable to read desktop file template:" << err->message;
+    g_error_free(err);
+    return kXdgOpenShebang;
+  }
+
+  // Remove all sections except for the Desktop Entry
+  gsize length = 0;
+  gchar** groups = g_key_file_get_groups(key_file, &length);
+  for (gsize i = 0; i < length; ++i) {
+    if (strcmp(groups[i], kDesktopEntry) != 0) {
+      g_key_file_remove_group(key_file, groups[i], NULL);
     }
   }
+  g_strfreev(groups);
+
+  // Remove keys that we won't need.
+  for (const char** current_key = kDesktopKeysToDelete; *current_key;
+       ++current_key) {
+    g_key_file_remove_key(key_file, kDesktopEntry, *current_key, NULL);
+  }
+
+  // Set the "Name" key.
+  std::string final_title = UTF16ToUTF8(title);
+  // Make sure no endline characters can slip in and possibly introduce
+  // additional lines (like Exec, which makes it a security risk). Also
+  // use the URL as a default when the title is empty.
+  if (final_title.empty() ||
+      final_title.find("\n") != std::string::npos ||
+      final_title.find("\r") != std::string::npos) {
+    final_title = url.spec();

[Evan Martin, 2011/05/11 21:29:06]

Is it possible that url.spec() has these bad characters?

[Elliot Glaysher, 2011/05/11 21:52:29]

No, but it would if we called invalid_spec(). On debug builds it will dcheck and
return an empty gurl.

+  }
+  g_key_file_set_string(key_file, kDesktopEntry, "Name", final_title.c_str());
+
+  // Set the "Exec" key.
+  char* exec_c_string = g_key_file_get_string(key_file, kDesktopEntry, "Exec",
+                                              NULL);
+  if (exec_c_string) {
+    std::string exec_string(exec_c_string);
+    g_free(exec_c_string);
+    StringTokenizer exec_tokenizer(exec_string, " ");
+
+    std::string final_path;
+    while (exec_tokenizer.GetNext() && exec_tokenizer.token() != "%U") {
+      if (!final_path.empty())
+        final_path += " ";
+      final_path += exec_tokenizer.token();
+    }
+    CommandLine cmd_line =
+        ShellIntegration::CommandLineArgsForLauncher(url, extension_id);
+    const CommandLine::SwitchMap& switch_map = cmd_line.GetSwitches();
+    for (CommandLine::SwitchMap::const_iterator i = switch_map.begin();
+         i != switch_map.end(); ++i) {
+      if (i->second.empty()) {
+        final_path += " --" + i->first;
+      } else {
+        final_path += " " + QuoteArgForDesktopFileExec("--" + i->first +
+                                                       "=" + i->second);
+      }
+    }
+
+    g_key_file_set_string(key_file, kDesktopEntry, "Exec", final_path.c_str());

[Elliot Glaysher, 2011/05/11 01:07:27]

This level of quoting is done by the library. (We need to still do
QuoteArgForDesktopFileExec above though or the unit tests complain about
non-equivalent output).

[Evan Martin, 2011/05/11 21:29:06]

Are the unit tests correct?  Better to be correct and fix the tests...

[Elliot Glaysher, 2011/05/11 21:52:29]

Yes. It's just a weird artifact of where gkeyparser escapes stuff. (The unit
tests also call out this escaping behaviour specifically.)

+  }
+
+  // Set the "Icon" key.
+  if (!icon_name.empty())
+    g_key_file_set_string(key_file, kDesktopEntry, "Icon", icon_name.c_str());
 
 #if defined(TOOLKIT_USES_GTK)
   std::string wmclass = web_app::GetWMClassFromAppName(app_name);
-  if (!wmclass.empty()) {
-    output_buffer += StringPrintf("StartupWMClass=%s\n", wmclass.c_str());
-  }
+  g_key_file_set_string(key_file, kDesktopEntry, "StartupWMClass",
+                        wmclass.c_str());
 #endif
 
+  // 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("#!/usr/bin/env xdg-open");

[Evan Martin, 2011/05/11 21:29:06]

did you intend to use your kShebang constant?

[Elliot Glaysher, 2011/05/11 21:52:29]

No, because that constant has a newline. Updated though.

+  length = 0;
+  gchar* data_dump = g_key_file_to_data(key_file, &length, NULL);
+  if (data_dump) {
+    output_buffer += data_dump;
+    g_free(data_dump);
+  }
+
+  g_key_file_free(key_file);
   return output_buffer;
 }
 
 // static
 void ShellIntegration::CreateDesktopShortcut(
     const ShortcutInfo& shortcut_info, const std::string& shortcut_template) {
   // TODO(phajdan.jr): Report errors from this function, possibly as infobars.
 
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::FILE));
 
@@ skipping 12 matching lines @@
       shortcut_info.extension_id,
       shortcut_info.title,
       icon_name);
 
   if (shortcut_info.create_on_desktop)
     CreateShortcutOnDesktop(shortcut_filename, contents);
 
   if (shortcut_info.create_in_applications_menu)
     CreateShortcutInApplicationsMenu(shortcut_filename, contents);
 }