bug 838290 - make nsIPluginHost.getPermissionStringForType more robust r=bsmedberg

dom/plugins/base/nsPluginHost.cpp

@@ -1191,7 +1191,13 @@ nsPluginHost::GetPermissionStringForType(const nsACString &aMimeType, nsACString
     aPermissionString.AssignLiteral("plugin:");
   }
 
-  aPermissionString.Append(tag->mFileName);
+  if (tag->mIsJavaPlugin) {
+    aPermissionString.Append("java");
+  } else if (tag->mIsFlashPlugin) {
+    aPermissionString.Append("flash");
+  } else {
+    aPermissionString.Append(tag->GetNiceFileName());
+  }
 
   return NS_OK;
 }

dom/plugins/base/nsPluginTags.cpp

@@ -19,6 +19,7 @@
 #include "nsNPAPIPlugin.h"
 #include "mozilla/TimeStamp.h"
 #include "mozilla/Preferences.h"
+#include <cctype>
 
 using namespace mozilla;
 using mozilla::TimeStamp;
@@ -52,7 +53,8 @@ mFileName(aPluginTag->mFileName),
 mFullPath(aPluginTag->mFullPath),
 mVersion(aPluginTag->mVersion),
 mLastModifiedTime(0),
-mFlags(NS_PLUGIN_FLAG_ENABLED)
+mFlags(NS_PLUGIN_FLAG_ENABLED),
+mNiceFileName()
 {
 }
 
@@ -67,7 +69,8 @@ mFileName(aPluginInfo->fFileName),
 mFullPath(aPluginInfo->fFullPath),
 mVersion(aPluginInfo->fVersion),
 mLastModifiedTime(0),
-mFlags(NS_PLUGIN_FLAG_ENABLED)
+mFlags(NS_PLUGIN_FLAG_ENABLED),
+mNiceFileName()
 {
   InitMime(aPluginInfo->fMimeTypeArray,
            aPluginInfo->fMimeDescriptionArray,
@@ -97,7 +100,8 @@ mFileName(aFileName),
 mFullPath(aFullPath),
 mVersion(aVersion),
 mLastModifiedTime(aLastModifiedTime),
-mFlags(0) // Caller will read in our flags from cache
+mFlags(0), // Caller will read in our flags from cache
+mNiceFileName()
 {
   InitMime(aMimeTypes, aMimeDescriptions, aExtensions, static_cast<uint32_t>(aVariants));
   if (!aArgsAreUTF8)
@@ -433,3 +437,28 @@ void nsPluginTag::TryUnloadPlugin(bool inShutdown)
     mPlugin = nullptr;
   }
 }
+
+nsCString nsPluginTag::GetNiceFileName() {
+  if (!mNiceFileName.IsEmpty()) {
+    return mNiceFileName;
+  }
+
+  mNiceFileName.Assign(mFileName);
+  int32_t niceNameLength = mFileName.RFind(".");
+  NS_ASSERTION(niceNameLength != kNotFound, "mFileName doesn't have a '.'?");
+  while (niceNameLength > 0) {
+    char chr = mFileName[niceNameLength - 1];
+    if (!std::isalpha(chr))
+      niceNameLength--;
+    else
+      break;
+  }
+
+  // If it turns out that niceNameLength <= 0, we'll fall back and use the
+  // entire mFileName (which we've already taken care of, a few lines back)
+  if (niceNameLength > 0) {
+    mNiceFileName.Truncate(niceNameLength);
+  }
+
+  return mNiceFileName;
+}

dom/plugins/base/nsPluginTags.h

@@ -59,6 +59,7 @@ public:
   uint32_t Flags();
   bool HasSameNameAndMimes(const nsPluginTag *aPluginTag) const;
   bool IsEnabled();
+  nsCString GetNiceFileName();
   
   nsRefPtr<nsPluginTag> mNext;
   nsPluginHost *mPluginHost;
@@ -78,6 +79,7 @@ public:
   nsCOMPtr<nsITimer> mUnloadTimer;
 private:
   uint32_t      mFlags;
+  nsCString     mNiceFileName; // UTF-8
 
   void InitMime(const char* const* aMimeTypes,
                 const char* const* aMimeDescriptions,

dom/plugins/test/unit/test_nice_plugin_name.js

@@ -0,0 +1,147 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+
+const Cc = Components.classes;
+const Ci = Components.interfaces;
+const XULAPPINFO_CONTRACTID = "@mozilla.org/xre/app-info;1";
+const XULAPPINFO_CID = Components.ID("{c763b610-9d49-455a-bbd2-ede71682a1ac}");
+
+Components.utils.import("resource://gre/modules/XPCOMUtils.jsm");
+
+let gAppInfo = null;
+
+function createAppInfo(id, name, version, platformVersion) {
+  gAppInfo = {
+    // nsIXULAppInfo
+    vendor: "Mozilla",
+    name: name,
+    ID: id,
+    version: version,
+    appBuildID: "2007010101",
+    platformVersion: platformVersion ? platformVersion : "1.0",
+    platformBuildID: "2007010101",
+
+    // nsIXULRuntime
+    inSafeMode: false,
+    logConsoleErrors: true,
+    OS: "XPCShell",
+    XPCOMABI: "noarch-spidermonkey",
+    invalidateCachesOnRestart: function invalidateCachesOnRestart() {
+      // Do nothing
+    },
+
+    // nsICrashReporter
+    annotations: {},
+
+    annotateCrashReport: function(key, data) {
+      this.annotations[key] = data;
+    },
+
+    QueryInterface: XPCOMUtils.generateQI([Ci.nsIXULAppInfo,
+                                           Ci.nsIXULRuntime,
+                                           Ci.nsICrashReporter,
+                                           Ci.nsISupports])
+  };
+
+  let XULAppInfoFactory = {
+    createInstance: function (outer, iid) {
+      if (outer != null)
+        throw Components.results.NS_ERROR_NO_AGGREGATION;
+      return gAppInfo.QueryInterface(iid);
+    }
+  };
+  let registrar = Components.manager.QueryInterface(Ci.nsIComponentRegistrar);
+  registrar.registerFactory(XULAPPINFO_CID, "XULAppInfo",
+                            XULAPPINFO_CONTRACTID, XULAppInfoFactory);
+}
+
+let gDirSvc = Cc["@mozilla.org/file/directory_service;1"]
+                .getService(Ci.nsIProperties);
+
+function get_test_plugin_no_symlink() {
+  let pluginEnum = gDirSvc.get("APluginsDL", Ci.nsISimpleEnumerator);
+  while (pluginEnum.hasMoreElements()) {
+    let dir = pluginEnum.getNext().QueryInterface(Ci.nsILocalFile);
+    let plugin = dir.clone();
+    plugin.append(get_platform_specific_plugin_name());
+    if (plugin.exists()) {
+      return plugin;
+    }
+  }
+  return null;
+}
+
+let gPluginHost = null;
+let gIsWindows = null;
+let gIsOSX = null;
+let gIsLinux = null;
+
+function get_platform_specific_plugin_name() {
+  if (gIsWindows) return "nptest.dll";
+  else if (gIsOSX) return "Test.plugin";
+  else if (gIsLinux) return "libnptest.so";
+  else return null;
+}
+
+function get_platform_specific_plugin_suffix() {
+  if (gIsWindows) return ".dll";
+  else if (gIsOSX) return ".plugin";
+  else if (gIsLinux) return ".so";
+  else return null;
+}
+
+function test_expected_permission_string(aPermString) {
+  gPluginHost.reloadPlugins(false);
+  let plugin = get_test_plugintag();
+  do_check_false(plugin == null);
+  do_check_eq(gPluginHost.getPermissionStringForType("application/x-test"),
+              aPermString);
+}
+
+function run_test() {
+  gIsWindows = ("@mozilla.org/windows-registry-key;1" in Cc);
+  gIsOSX = ("nsILocalFileMac" in Ci);
+  gIsLinux = ("@mozilla.org/gnome-gconf-service;1" in Cc);
+  do_check_true(gIsWindows || gIsOSX || gIsLinux);
+  do_check_true(!(gIsWindows && gIsOSX) && !(gIsWindows && gIsLinux) &&
+                !(gIsOSX && gIsLinux));
+
+  createAppInfo("xpcshell@tests.mozilla.org", "XPCShell", "1", "1.9");
+  gPluginHost = Cc["@mozilla.org/plugin/host;1"].getService(Ci.nsIPluginHost);
+
+  let expectedDefaultPermissionString = null;
+  if (gIsWindows) expectedDefaultPermissionString = "plugin:nptest";
+  if (gIsOSX) expectedDefaultPermissionString = "plugin:Test";
+  if (gIsLinux) expectedDefaultPermissionString = "plugin:libnptest";
+  test_expected_permission_string(expectedDefaultPermissionString);
+
+  let suffix = get_platform_specific_plugin_suffix();
+  let pluginFile = get_test_plugin_no_symlink();
+  let pluginDir = pluginFile.parent;
+  pluginFile.copyTo(null, "npblah235" + suffix);
+  let pluginCopy = pluginDir.clone();
+  pluginCopy.append("npblah235" + suffix);
+  pluginFile.moveTo(pluginDir.parent, null);
+  test_expected_permission_string("plugin:npblah");
+
+  pluginCopy.moveTo(null, "npasdf-3.2.2" + suffix);
+  test_expected_permission_string("plugin:npasdf");
+
+  pluginCopy.moveTo(null, "npasdf_##29387!{}{[][" + suffix);
+  test_expected_permission_string("plugin:npasdf");
+
+  pluginCopy.moveTo(null, "npqtplugin7" + suffix);
+  test_expected_permission_string("plugin:npqtplugin");
+
+  pluginCopy.moveTo(null, "npfoo3d" + suffix);
+  test_expected_permission_string("plugin:npfoo3d");
+
+  pluginCopy.moveTo(null, "NPSWF32_11_5_502_146" + suffix);
+  test_expected_permission_string("plugin:NPSWF");
+
+  pluginCopy.remove(true);
+  pluginFile.moveTo(pluginDir, null);
+  test_expected_permission_string(expectedDefaultPermissionString);
+}

dom/plugins/test/unit/xpcshell.ini

@@ -11,3 +11,4 @@ fail-if = os == "android"
 [test_bug813245.js]
 # Bug 676953: test fails consistently on Android
 fail-if = os == "android"
+[test_nice_plugin_name.js]