support loading pepper flash debugger dlls

chrome/browser/component_updater/pepper_flash_component_installer.cc

 // Copyright (c) 2013 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/component_updater/flash_component_installer.h"
 
 #include <string.h>
 
 #include <vector>
 
 #include "base/base_paths.h"
+#include "base/base_paths_win.h"
 #include "base/bind.h"
 #include "base/command_line.h"
 #include "base/compiler_specific.h"
 #include "base/file_util.h"
 #include "base/files/file_enumerator.h"
 #include "base/files/file_path.h"
 #include "base/logging.h"
 #include "base/path_service.h"
 #include "base/strings/string_split.h"
 #include "base/strings/string_util.h"
@@ skipping 61 matching lines @@
 #endif
 
 // The base directory on Windows looks like:
 // <profile>\AppData\Local\Google\Chrome\User Data\PepperFlash\.
 base::FilePath GetPepperFlashBaseDirectory() {
   base::FilePath result;
   PathService::Get(chrome::DIR_COMPONENT_UPDATED_PEPPER_FLASH_PLUGIN, &result);
   return result;
 }
 
+// Install directory for pepper flash debugger dlls will be like
+// c:\windows\system32\macromed\flash\, or basically the Macromed\Flash
+// subdirectory of the Windows system directory.
+base::FilePath GetPepperFlashDebuggerDirectory() {
+  base::FilePath result;
+  PathService::Get(base::DIR_SYSTEM, &result);
+  base::FilePath subdir;
+  PathService::Get(chrome::DIR_PEPPER_FLASH_DEBUGGER_PLUGIN, &subdir);

[cpu_(ooo_6.6-7.5), 2014/04/24 20:42:04]

any reason not to return the full path when
chrome::DIR_PEPPER_FLASH_DEBUGGER_PLUGIN is called?

[luken, 2014/04/24 22:04:15]

Done.

+  return result.Append(subdir);
+}
+
 #if defined(GOOGLE_CHROME_BUILD) && !defined(OS_LINUX)
 // Pepper Flash plugins have the version encoded in the path itself
 // so we need to enumerate the directories to find the full path.
 // On success, |latest_dir| returns something like:
 // <profile>\AppData\Local\Google\Chrome\User Data\PepperFlash\10.3.44.555\.
 // |latest_version| returns the corresponding version number. |older_dirs|
 // returns directories of all older versions.
 bool GetPepperFlashDirectory(base::FilePath* latest_dir,
                              Version* latest_version,
                              std::vector<base::FilePath>* older_dirs) {
@@ skipping 17 matching lines @@
     } else {
       *latest_dir = path;
       *latest_version = version;
       found = true;
     }
   }
   return found;
 }
 #endif
 
+const wchar_t kPepperFlashDebuggerDLLSearchString[] =
+#if defined(ARCH_CPU_X86)
+    L"pepflashplayer32*.dll";
+#elif defined(ARCH_CPU_X86_64)
+    L"pepflashplayer64*.dll";
+#else  // TODO(luken): ARM flash debugger?
+    L"???";

[cpu_(ooo_6.6-7.5), 2014/04/24 20:42:04]

elif defined(ARCH_CPU_ARM_FAMILY) ?

[luken, 2014/04/24 22:04:15]

Done.

+#endif
+
+bool GetPepperFlashDebuggerPath(base::FilePath* dll_path,
+                                Version* dll_version) {

[cpu_(ooo_6.6-7.5), 2014/04/24 20:42:04]

DCHECK(BrowserThread::CurrentlyOn(BrowserThread::FILE));  ? I mean you cannot do
file IO in the UI Thread.

[luken, 2014/04/24 22:04:15]

We are on the file IO thread, and the other function to find the regular flash
dll doesn't have the DCHECK, but I like the DCHECK so I added it to both. :)

+  base::FilePath debugger_dir = GetPepperFlashDebuggerDirectory();
+  // If path doesn't exist they simply don't have the flash debugger installed.
+  if (!base::PathExists(debugger_dir)) {

[cpu_(ooo_6.6-7.5), 2014/04/24 20:42:04]

if the style of this file has single statement ifs applied consistently then
lets change this one. If on the other hand we are inconsistent then do as you
wish.

[luken, 2014/04/24 22:04:15]

Done.

+    return false;
+  }
+  bool found = false;
+  // Enumerate any DLLs that match the appropriate pattern for this DLL, and
+  // pick the highest version number we find.
+  base::FileEnumerator file_enumerator(debugger_dir,
+                                       false,
+                                       base::FileEnumerator::FILES,
+                                       kPepperFlashDebuggerDLLSearchString);
+  for (base::FilePath path = file_enumerator.Next(); !path.value().empty();
+       path = file_enumerator.Next()) {
+    // Version number is embedded in file name like basename_x_y_z.dll. Extract.
+    std::string file_name(path.BaseName().MaybeAsASCII());

[cpu_(ooo_6.6-7.5), 2014/04/24 20:42:04]

I have the feeling that using base/strings/string_split.h will make this
prettier, splitting on '_'.  wdyt?

[luken, 2014/04/24 22:04:15]

I didn't know about this, yes!

+    std::size_t ver_start = file_name.find_first_of("_");
+    if (ver_start == std::string::npos)
+      continue;
+    // Add one to the ver_start to skip over the starting underscore.
+    ++ver_start;
+    std::size_t ver_end = file_name.find_first_of(".", ver_start);
+    if (ver_end == std::string::npos)
+      continue;
+    std::string version_string =
+        file_name.substr(ver_start, ver_end - ver_start);
+    // Now swap all the underscores for dots, so our version object can parse.
+    for (std::size_t i = 0; i < version_string.length(); ++i) {
+      if (version_string[i] == '_')
+        version_string[i] = '.';
+    }
+    Version version(version_string);
+    if (!version.IsValid())
+      continue;
+    if (found) {
+      if (version.CompareTo(*dll_version) > 0) {
+        *dll_path = path;
+        *dll_version = version;
+      }
+    } else {
+      *dll_path = path;
+      *dll_version = version;
+      found = true;
+    }
+  }
+  return found;
+}
+
 // Returns true if the Pepper |interface_name| is implemented  by this browser.
 // It does not check if the interface is proxied.
 bool SupportsPepperInterface(const char* interface_name) {
   if (IsSupportedPepperInterface(interface_name))
     return true;
   // The PDF interface is invisible to SupportsInterface() on the browser
   // process because it is provided using PpapiInterfaceFactoryManager. We need
   // to check for that as well.
   // TODO(cpu): make this more sane.
   return (strcmp(interface_name, PPB_PDF_INTERFACE) == 0);
 }
 
 bool MakePepperFlashPluginInfo(const base::FilePath& flash_path,
                                const Version& flash_version,
                                bool out_of_process,
+                               bool is_debugger,
                                content::PepperPluginInfo* plugin_info) {
   if (!flash_version.IsValid())
     return false;
   const std::vector<uint16> ver_nums = flash_version.components();
   if (ver_nums.size() < 3)
     return false;
 
   plugin_info->is_internal = false;
   plugin_info->is_out_of_process = out_of_process;
   plugin_info->path = flash_path;
   plugin_info->name = content::kFlashPluginName;
   plugin_info->permissions = kPepperFlashPermissions;
 
   // The description is like "Shockwave Flash 10.2 r154".
   plugin_info->description = base::StringPrintf("%s %d.%d r%d",
       content::kFlashPluginName, ver_nums[0], ver_nums[1], ver_nums[2]);
+  if (is_debugger) {
+    plugin_info->description += " Debug";
+  }
 
   plugin_info->version = flash_version.GetString();
 
   content::WebPluginMimeType swf_mime_type(content::kFlashPluginSwfMimeType,
                                            content::kFlashPluginSwfExtension,
                                            content::kFlashPluginName);
   plugin_info->mime_types.push_back(swf_mime_type);
   content::WebPluginMimeType spl_mime_type(content::kFlashPluginSplMimeType,
                                            content::kFlashPluginSplExtension,
                                            content::kFlashPluginName);
   plugin_info->mime_types.push_back(spl_mime_type);
   return true;
 }
 
 bool IsPepperFlash(const content::WebPluginInfo& plugin) {
   // We try to recognize Pepper Flash by the following criteria:
   // * It is a Pepper plug-in.
   // * It has the special Flash permissions.
   return plugin.is_pepper_plugin() &&
          (plugin.pepper_permissions & ppapi::PERMISSION_FLASH);
 }
 
 void RegisterPepperFlashWithChrome(const base::FilePath& path,
-                                   const Version& version) {
+                                   const Version& version,
+                                   bool is_debugger) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
   content::PepperPluginInfo plugin_info;
-  if (!MakePepperFlashPluginInfo(path, version, true, &plugin_info))
+  if (!MakePepperFlashPluginInfo(
+          path, version, true, is_debugger, &plugin_info))
     return;
 
-  std::vector<content::WebPluginInfo> plugins;
-  PluginService::GetInstance()->GetInternalPlugins(&plugins);
-  for (std::vector<content::WebPluginInfo>::const_iterator it = plugins.begin();
-       it != plugins.end(); ++it) {
-    if (!IsPepperFlash(*it))
-      continue;
+  // If this is the non-debugger version, we enumerate any installed versions of
+  // pepper flash to make sure we only replace the installed version with a
+  // newer version.
+  if (!is_debugger) {
+    std::vector<content::WebPluginInfo> plugins;
+    PluginService::GetInstance()->GetInternalPlugins(&plugins);
+    for (std::vector<content::WebPluginInfo>::const_iterator it =
+             plugins.begin();
+         it != plugins.end();
+         ++it) {
+      if (!IsPepperFlash(*it))
+        continue;
 
-    // Do it only if the version we're trying to register is newer.
-    Version registered_version(base::UTF16ToUTF8(it->version));
-    if (registered_version.IsValid() &&
-        version.CompareTo(registered_version) <= 0) {
-      return;
+      // Do it only if the version we're trying to register is newer.
+      Version registered_version(base::UTF16ToUTF8(it->version));
+      if (registered_version.IsValid() &&
+          version.CompareTo(registered_version) <= 0) {
+        return;
+      }
+
+      // If the version is newer, remove the old one first.
+      PluginService::GetInstance()->UnregisterInternalPlugin(it->path);
+      break;
     }
-
-    // If the version is newer, remove the old one first.
-    PluginService::GetInstance()->UnregisterInternalPlugin(it->path);
-    break;
   }
 
+  // We only ask for registration at the beginning for the non-debugger plugin,
+  // that way the debugger plugin doesn't automatically clobber the built-in or
+  // updated non-debugger version.
   PluginService::GetInstance()->RegisterInternalPlugin(
-      plugin_info.ToWebPluginInfo(), true);
+      plugin_info.ToWebPluginInfo(), !is_debugger);
   PluginService::GetInstance()->RefreshPlugins();
 }
 
 // Returns true if this browser implements one of the interfaces given in
 // |interface_string|, which is a '|'-separated string of interface names.
 bool CheckPepperFlashInterfaceString(const std::string& interface_string) {
   std::vector<std::string> interface_names;
   base::SplitString(interface_string, '|', &interface_names);
   for (size_t i = 0; i < interface_names.size(); i++) {
     if (SupportsPepperInterface(interface_names[i].c_str()))
@@ skipping 68 matching lines @@
   if (base::PathExists(path))
     return false;
   if (!base::Move(unpack_path, path))
     return false;
   // Installation is done. Now tell the rest of chrome. Both the path service
   // and to the plugin service.
   current_version_ = version;
   PathService::Override(chrome::DIR_PEPPER_FLASH_PLUGIN, path);
   path = path.Append(chrome::kPepperFlashPluginFilename);
   BrowserThread::PostTask(
-      BrowserThread::UI, FROM_HERE,
-      base::Bind(&RegisterPepperFlashWithChrome, path, version));
+      BrowserThread::UI,
+      FROM_HERE,
+      base::Bind(&RegisterPepperFlashWithChrome, path, version, false));
   return true;
 }
 
 bool PepperFlashComponentInstaller::GetInstalledFile(
     const std::string& file, base::FilePath* installed_file) {
   return false;
 }
 
 bool CheckPepperFlashManifest(const base::DictionaryValue& manifest,
                               Version* version_out) {
@@ skipping 59 matching lines @@
       return;
     }
   }
 
   Version version(kNullVersion);
   std::vector<base::FilePath> older_dirs;
   if (GetPepperFlashDirectory(&path, &version, &older_dirs)) {
     path = path.Append(chrome::kPepperFlashPluginFilename);
     if (base::PathExists(path)) {
       BrowserThread::PostTask(
-          BrowserThread::UI, FROM_HERE,
-          base::Bind(&RegisterPepperFlashWithChrome, path, version));
+          BrowserThread::UI,
+          FROM_HERE,
+          base::Bind(&RegisterPepperFlashWithChrome, path, version, false));
     } else {
       version = Version(kNullVersion);
     }
   }
 
   BrowserThread::PostTask(
       BrowserThread::UI, FROM_HERE,
       base::Bind(&FinishPepperFlashUpdateRegistration, cus, version));
 
   // Remove older versions of Pepper Flash.
   for (std::vector<base::FilePath>::iterator iter = older_dirs.begin();
        iter != older_dirs.end(); ++iter) {
     base::DeleteFile(*iter, true);
   }
+
+  // Check for Debugging version of Flash and register if present.
+  base::FilePath debugger_path;
+  Version debugger_version(kNullVersion);
+  if (GetPepperFlashDebuggerPath(&debugger_path, &debugger_version)) {
+    BrowserThread::PostTask(BrowserThread::UI,
+                            FROM_HERE,
+                            base::Bind(&RegisterPepperFlashWithChrome,
+                                       debugger_path,
+                                       debugger_version,
+                                       true));
+  }
 }
 #endif  // defined(GOOGLE_CHROME_BUILD) && !defined(OS_LINUX)
 
 }  // namespace
 
 void RegisterPepperFlashComponent(ComponentUpdateService* cus) {
 #if defined(GOOGLE_CHROME_BUILD) && !defined(OS_LINUX)
   // Component updated flash supersedes bundled flash therefore if that one
   // is disabled then this one should never install.
   CommandLine* cmd_line = CommandLine::ForCurrentProcess();
   if (cmd_line->HasSwitch(switches::kDisableBundledPpapiFlash))
     return;
   BrowserThread::PostTask(BrowserThread::FILE, FROM_HERE,
                           base::Bind(&StartPepperFlashUpdateRegistration, cus));
 #endif
 }
 
 }  // namespace component_updater