Move renderer plugin code into a new component.

components/plugins/renderer/plugin_placeholder.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/renderer/plugins/plugin_placeholder.h"
+#include "components/plugins/renderer/plugin_placeholder.h"
 
 #include "base/bind.h"
 #include "base/bind_helpers.h"
 #include "base/json/string_escape.h"
 #include "base/strings/string_piece.h"
 #include "base/strings/string_util.h"
 #include "base/strings/utf_string_conversions.h"
 #include "base/values.h"
-#include "chrome/common/prerender_messages.h"
-#include "chrome/common/render_messages.h"
-#include "chrome/renderer/chrome_content_renderer_client.h"
-#include "chrome/renderer/custom_menu_commands.h"
-#include "chrome/renderer/plugins/plugin_uma.h"
+#include "components/plugins/renderer/plugin_uma.h"
 #include "content/public/common/content_constants.h"
 #include "content/public/common/context_menu_params.h"
 #include "content/public/renderer/render_thread.h"
 #include "content/public/renderer/render_view.h"
-#include "grit/generated_resources.h"
-#include "grit/renderer_resources.h"
-#include "grit/webkit_strings.h"
-#include "third_party/WebKit/public/platform/WebData.h"
-#include "third_party/WebKit/public/platform/WebPoint.h"
-#include "third_party/WebKit/public/platform/WebURLRequest.h"
-#include "third_party/WebKit/public/platform/WebVector.h"
-#include "third_party/WebKit/public/web/WebContextMenuData.h"
 #include "third_party/WebKit/public/web/WebDocument.h"
 #include "third_party/WebKit/public/web/WebElement.h"
 #include "third_party/WebKit/public/web/WebFrame.h"
 #include "third_party/WebKit/public/web/WebInputEvent.h"
 #include "third_party/WebKit/public/web/WebPluginContainer.h"
 #include "third_party/WebKit/public/web/WebScriptSource.h"
 #include "third_party/WebKit/public/web/WebView.h"
 #include "third_party/re2/re2/re2.h"
-#include "ui/base/l10n/l10n_util.h"
-#include "ui/base/resource/resource_bundle.h"
-#include "ui/webui/jstemplate_builder.h"
 
 using content::RenderThread;
-using content::RenderView;
-using WebKit::WebContextMenuData;
-using WebKit::WebDocument;
 using WebKit::WebElement;
 using WebKit::WebFrame;
 using WebKit::WebMouseEvent;
 using WebKit::WebNode;
 using WebKit::WebPlugin;
 using WebKit::WebPluginContainer;
 using WebKit::WebPluginParams;
-using WebKit::WebPoint;
 using WebKit::WebScriptSource;
-using WebKit::WebString;
 using WebKit::WebURLRequest;
-using WebKit::WebVector;
 using webkit_glue::CppArgumentList;
 using webkit_glue::CppVariant;
 
-const char* const kPluginPlaceholderDataURL =
-    "chrome://pluginplaceholderdata/";
-
-#if defined(ENABLE_MOBILE_YOUTUBE_PLUGIN)
-// Strings we used to parse the youtube plugin url.
-const char* const kSlashVSlash = "/v/";
-const char* const kSlashESlash = "/e/";
-#endif
-
-namespace {
-const PluginPlaceholder* g_last_active_menu = NULL;
-
-#if defined(ENABLE_MOBILE_YOUTUBE_PLUGIN)
-// Helper function to get the youtube id from plugin params for old style
-// embedded youtube video.
-std::string GetYoutubeVideoId(const WebPluginParams& params) {
-  GURL url(params.url);
-  std::string video_id = url.path().substr(strlen(kSlashVSlash));
-
-  // Extract just the video id
-  size_t video_id_end = video_id.find('&');
-  if (video_id_end != std::string::npos)
-    video_id = video_id.substr(0, video_id_end);
-  return video_id;
-}
-#endif
-}  // namespace
-
-// static
-PluginPlaceholder* PluginPlaceholder::CreateMissingPlugin(
-    RenderView* render_view,
-    WebFrame* frame,
-    const WebPluginParams& params) {
-  const base::StringPiece template_html(
-      ResourceBundle::GetSharedInstance().GetRawDataResource(
-          IDR_BLOCKED_PLUGIN_HTML));
-
-  base::DictionaryValue values;
-#if defined(ENABLE_PLUGIN_INSTALLATION)
-  values.SetString("message", l10n_util::GetStringUTF8(IDS_PLUGIN_SEARCHING));
-#else
-  values.SetString("message",
-      l10n_util::GetStringUTF8(IDS_PLUGIN_NOT_SUPPORTED));
-#endif
-
-  std::string html_data = webui::GetI18nTemplateHtml(template_html, &values);
-
-  // |missing_plugin| will destroy itself when its WebViewPlugin is going away.
-  PluginPlaceholder* missing_plugin = new PluginPlaceholder(
-      render_view, frame, params, html_data, params.mimeType);
-  missing_plugin->set_allow_loading(true);
-#if defined(ENABLE_PLUGIN_INSTALLATION)
-  RenderThread::Get()->Send(new ChromeViewHostMsg_FindMissingPlugin(
-      missing_plugin->routing_id(), missing_plugin->CreateRoutingId(),
-      params.mimeType.utf8()));
-#endif
-  return missing_plugin;
-}
-
-PluginPlaceholder* PluginPlaceholder::CreateErrorPlugin(
-    RenderView* render_view,
-    const base::FilePath& file_path) {
-  base::DictionaryValue values;
-  values.SetString("message",
-                   l10n_util::GetStringUTF8(IDS_PLUGIN_INITIALIZATION_ERROR));
-
-  const base::StringPiece template_html(
-      ResourceBundle::GetSharedInstance().GetRawDataResource(
-          IDR_BLOCKED_PLUGIN_HTML));
-  std::string html_data = webui::GetI18nTemplateHtml(template_html, &values);
-
-  WebPluginParams params;
-  // |missing_plugin| will destroy itself when its WebViewPlugin is going away.
-  PluginPlaceholder* plugin = new PluginPlaceholder(
-      render_view, NULL, params, html_data, params.mimeType);
-
-  RenderThread::Get()->Send(
-      new ChromeViewHostMsg_CouldNotLoadPlugin(plugin->routing_id(),
-                                               file_path));
-  return plugin;
-}
-
-// static
-PluginPlaceholder* PluginPlaceholder::CreateBlockedPlugin(
-    RenderView* render_view,
-    WebFrame* frame,
-    const WebPluginParams& params,
-    const content::WebPluginInfo& plugin,
-    const std::string& identifier,
-    const string16& name,
-    int template_id,
-    const string16& message) {
-  base::DictionaryValue values;
-  values.SetString("message", message);
-  values.SetString("name", name);
-  values.SetString("hide", l10n_util::GetStringUTF8(IDS_PLUGIN_HIDE));
-
-  const base::StringPiece template_html(
-      ResourceBundle::GetSharedInstance().GetRawDataResource(
-          template_id));
-
-  DCHECK(!template_html.empty()) << "unable to load template. ID: "
-                                 << template_id;
-  std::string html_data = webui::GetI18nTemplateHtml(template_html, &values);
-
-  // |blocked_plugin| will destroy itself when its WebViewPlugin is going away.
-  PluginPlaceholder* blocked_plugin = new PluginPlaceholder(
-      render_view, frame, params, html_data, name);
-  blocked_plugin->plugin_info_ = plugin;
-  blocked_plugin->identifier_ = identifier;
-  return blocked_plugin;
-}
-
-#if defined(ENABLE_MOBILE_YOUTUBE_PLUGIN)
-// static
-PluginPlaceholder* PluginPlaceholder::CreateMobileYoutubePlugin(
-    content::RenderView* render_view,
-    WebFrame* frame,
-    const WebPluginParams& params) {
-  const base::StringPiece template_html(
-      ResourceBundle::GetSharedInstance().GetRawDataResource(
-          IDR_MOBILE_YOUTUBE_PLUGIN_HTML));
-
-  base::DictionaryValue values;
-  values.SetString("video_id", GetYoutubeVideoId(params));
-  std::string html_data = webui::GetI18nTemplateHtml(template_html, &values);
-
-  // |youtube_plugin| will destroy itself when its WebViewPlugin is going away.
-  PluginPlaceholder* youtube_plugin = new PluginPlaceholder(
-      render_view, frame, params, html_data, params.mimeType);
-  return youtube_plugin;
-}
-#endif
+const char* const kPluginPlaceholderDataURL = "chrome://pluginplaceholderdata/";

[Bernhard Bauer, 2013/09/13 20:04:10]

Why are you moving this?

[aberent, 2013/09/13 20:11:30]

Because it is not an appropriate URL for Webview. Webview doesn't know anything
about chrome: URLs.

[Bernhard Bauer, 2013/09/13 20:37:41]

But content does, and WebView uses content. WebView doesn't know about
*specific* chrome: URLs (e.g. chrome://plugins or chrome://settings), but I
think the concept of chrome: URLs is in content.

 
 PluginPlaceholder::PluginPlaceholder(content::RenderView* render_view,
                                      WebFrame* frame,
                                      const WebPluginParams& params,
-                                     const std::string& html_data,
-                                     const string16& title)
+                                     const std::string& html_data)
     : content::RenderViewObserver(render_view),
       frame_(frame),
       plugin_params_(params),
-      plugin_(WebViewPlugin::Create(
-          this, render_view->GetWebkitPreferences(), html_data,
-          GURL(kPluginPlaceholderDataURL))),
-      title_(title),
-      status_(new ChromeViewHostMsg_GetPluginInfo_Status),
+      plugin_(WebViewPlugin::Create(this,
+                                    render_view->GetWebkitPreferences(),
+                                    html_data,
+                                    GURL(kPluginPlaceholderDataURL))),
       is_blocked_for_prerendering_(false),
       allow_loading_(false),
-#if defined(ENABLE_PLUGIN_INSTALLATION)
-      placeholder_routing_id_(MSG_ROUTING_NONE),
-#endif
       hidden_(false),
-      has_host_(false),
-      finished_loading_(false),
-      context_menu_request_id_(0) {
-  RenderThread::Get()->AddObserver(this);
-}
+      finished_loading_(false) {}
 
-PluginPlaceholder::~PluginPlaceholder() {
-  RenderThread::Get()->RemoveObserver(this);
-  if (context_menu_request_id_)
-    render_view()->CancelContextMenu(context_menu_request_id_);
-
-#if defined(ENABLE_PLUGIN_INSTALLATION)
-  if (placeholder_routing_id_ == MSG_ROUTING_NONE)
-    return;
-  RenderThread::Get()->RemoveRoute(placeholder_routing_id_);
-  if (has_host_) {
-    RenderThread::Get()->Send(
-        new ChromeViewHostMsg_RemovePluginPlaceholderHost(
-            routing_id(), placeholder_routing_id_));
-  }
-#endif
-}
-
-#if defined(ENABLE_PLUGIN_INSTALLATION)
-int32 PluginPlaceholder::CreateRoutingId() {
-  placeholder_routing_id_ = RenderThread::Get()->GenerateRoutingID();
-  RenderThread::Get()->AddRoute(placeholder_routing_id_, this);
-  return placeholder_routing_id_;
-}
-#endif
-
-void PluginPlaceholder::SetStatus(
-    const ChromeViewHostMsg_GetPluginInfo_Status& status) {
-  status_->value = status.value;
-}
+PluginPlaceholder::~PluginPlaceholder() {}
 
 void PluginPlaceholder::BindWebFrame(WebFrame* frame) {
   BindToJavascript(frame, "plugin");
-  BindCallback("load", base::Bind(&PluginPlaceholder::LoadCallback,
-                                  base::Unretained(this)));
-  BindCallback("hide", base::Bind(&PluginPlaceholder::HideCallback,
-                                  base::Unretained(this)));
-  BindCallback("openAboutPlugins",
-               base::Bind(&PluginPlaceholder::OpenAboutPluginsCallback,
-                          base::Unretained(this)));
+  BindCallback(
+      "load",
+      base::Bind(&PluginPlaceholder::LoadCallback, base::Unretained(this)));
+  BindCallback(
+      "hide",
+      base::Bind(&PluginPlaceholder::HideCallback, base::Unretained(this)));
   BindCallback("didFinishLoading",
                base::Bind(&PluginPlaceholder::DidFinishLoadingCallback,
-               base::Unretained(this)));
-#if defined(ENABLE_MOBILE_YOUTUBE_PLUGIN)
-  BindCallback("openYoutubeURL",
-               base::Bind(&PluginPlaceholder::OpenYoutubeUrlCallback,
-               base::Unretained(this)));
-#endif
-}
-
-bool PluginPlaceholder::OnMessageReceived(const IPC::Message& message) {
-#if defined(ENABLE_PLUGIN_INSTALLATION)
-  bool handled = true;
-  IPC_BEGIN_MESSAGE_MAP(PluginPlaceholder, message)
-    IPC_MESSAGE_HANDLER(ChromeViewMsg_FoundMissingPlugin,
-                        OnFoundMissingPlugin)
-    IPC_MESSAGE_HANDLER(ChromeViewMsg_DidNotFindMissingPlugin,
-                        OnDidNotFindMissingPlugin)
-    IPC_MESSAGE_HANDLER(ChromeViewMsg_StartedDownloadingPlugin,
-                        OnStartedDownloadingPlugin)
-    IPC_MESSAGE_HANDLER(ChromeViewMsg_FinishedDownloadingPlugin,
-                        OnFinishedDownloadingPlugin)
-    IPC_MESSAGE_HANDLER(ChromeViewMsg_ErrorDownloadingPlugin,
-                        OnErrorDownloadingPlugin)
-    IPC_MESSAGE_HANDLER(ChromeViewMsg_CancelledDownloadingPlugin,
-                        OnCancelledDownloadingPlugin)
-    IPC_MESSAGE_UNHANDLED(handled = false)
-  IPC_END_MESSAGE_MAP()
-
-  if (handled)
-    return true;
-#endif
-
-  // We don't swallow these messages because multiple blocked plugins have an
-  // interest in them.
-  IPC_BEGIN_MESSAGE_MAP(PluginPlaceholder, message)
-    IPC_MESSAGE_HANDLER(ChromeViewMsg_LoadBlockedPlugins, OnLoadBlockedPlugins)
-    IPC_MESSAGE_HANDLER(PrerenderMsg_SetIsPrerendering, OnSetIsPrerendering)
-  IPC_END_MESSAGE_MAP()
-
-  return false;
+                          base::Unretained(this)));
 }
 
 void PluginPlaceholder::ReplacePlugin(WebPlugin* new_plugin) {
   CHECK(plugin_);
   if (!new_plugin) {
     PluginUMAReporter::GetInstance()->ReportPluginMissing(
-        plugin_params_.mimeType.utf8(),
-        plugin_params_.url);
+        plugin_params_.mimeType.utf8(), plugin_params_.url);
     return;
   }
 
   WebPluginContainer* container = plugin_->container();
   // Set the new plug-in on the container before initializing it.
   container->setPlugin(new_plugin);
   // Save the element in case the plug-in is removed from the page during
   // initialization.
   WebElement element = container->element();
   if (!new_plugin->initialize(container)) {
@@ skipping 60 matching lines @@
       if (element.hasAttribute("style")) {
         std::string style_str = element.getAttribute("style").utf8();
         if (RE2::PartialMatch(style_str, width_str) &&
             RE2::PartialMatch(style_str, height_str))
           element.setAttribute("style", "display: none;");
       }
     }
   }
 }
 
-void PluginPlaceholder::WillDestroyPlugin() {
-  delete this;
-}
-
-#if defined(ENABLE_PLUGIN_INSTALLATION)
-void PluginPlaceholder::OnDidNotFindMissingPlugin() {
-  SetMessage(l10n_util::GetStringUTF16(IDS_PLUGIN_NOT_FOUND));
-}
-
-void PluginPlaceholder::OnFoundMissingPlugin(const string16& plugin_name) {
-  if (status_->value == ChromeViewHostMsg_GetPluginInfo_Status::kNotFound)
-    SetMessage(l10n_util::GetStringFUTF16(IDS_PLUGIN_FOUND, plugin_name));
-  has_host_ = true;
-  plugin_name_ = plugin_name;
-}
-
-void PluginPlaceholder::OnStartedDownloadingPlugin() {
-  SetMessage(l10n_util::GetStringFUTF16(IDS_PLUGIN_DOWNLOADING, plugin_name_));
-}
-
-void PluginPlaceholder::OnFinishedDownloadingPlugin() {
-  bool is_installing =
-      status_->value == ChromeViewHostMsg_GetPluginInfo_Status::kNotFound;
-  SetMessage(l10n_util::GetStringFUTF16(
-      is_installing ? IDS_PLUGIN_INSTALLING : IDS_PLUGIN_UPDATING,
-      plugin_name_));
-}
-
-void PluginPlaceholder::OnErrorDownloadingPlugin(const std::string& error) {
-  SetMessage(l10n_util::GetStringFUTF16(IDS_PLUGIN_DOWNLOAD_ERROR,
-                                        UTF8ToUTF16(error)));
-}
-
-void PluginPlaceholder::OnCancelledDownloadingPlugin() {
-  SetMessage(l10n_util::GetStringFUTF16(IDS_PLUGIN_DOWNLOAD_CANCELLED,
-                                        plugin_name_));
-}
-#endif  // defined(ENABLE_PLUGIN_INSTALLATION)
-
-void PluginPlaceholder::PluginListChanged() {
-  if (!frame_)
-    return;
-  WebDocument document = frame_->top()->document();
-  if (document.isNull())
-    return;
-
-  ChromeViewHostMsg_GetPluginInfo_Output output;
-  std::string mime_type(plugin_params_.mimeType.utf8());
-  render_view()->Send(new ChromeViewHostMsg_GetPluginInfo(
-      routing_id(), GURL(plugin_params_.url), document.url(),
-      mime_type, &output));
-  if (output.status.value == status_->value)
-    return;
-  WebPlugin* new_plugin = chrome::ChromeContentRendererClient::CreatePlugin(
-      render_view(), frame_, plugin_params_, output);
-  ReplacePlugin(new_plugin);
-}
-
-void PluginPlaceholder::OnMenuAction(int request_id, unsigned action) {
-  DCHECK_EQ(context_menu_request_id_, request_id);
-  if (g_last_active_menu != this)
-    return;
-  switch (action) {
-    case chrome::MENU_COMMAND_PLUGIN_RUN: {
-      RenderThread::Get()->RecordUserMetrics("Plugin_Load_Menu");
-      LoadPlugin();
-      break;
-    }
-    case chrome::MENU_COMMAND_PLUGIN_HIDE: {
-      RenderThread::Get()->RecordUserMetrics("Plugin_Hide_Menu");
-      HidePlugin();
-      break;
-    }
-    default:
-      NOTREACHED();
-  }
-}
-
-void PluginPlaceholder::OnMenuClosed(int request_id) {
-  DCHECK_EQ(context_menu_request_id_, request_id);
-  context_menu_request_id_ = 0;
-}
+void PluginPlaceholder::WillDestroyPlugin() { delete this; }
 
 void PluginPlaceholder::SetMessage(const string16& message) {
   message_ = message;
   if (finished_loading_)
     UpdateMessage();
 }
 
 void PluginPlaceholder::UpdateMessage() {
-  std::string script = "window.setMessage(" +
-                       base::GetDoubleQuotedJson(message_) + ")";
+  std::string script =
+      "window.setMessage(" + base::GetDoubleQuotedJson(message_) + ")";
   plugin_->web_view()->mainFrame()->executeScript(
       WebScriptSource(ASCIIToUTF16(script)));
 }
 
 void PluginPlaceholder::ShowContextMenu(const WebMouseEvent& event) {
-  if (context_menu_request_id_)
-    return;  // Don't allow nested context menu requests.
-
-  content::ContextMenuParams params;
-
-  content::MenuItem name_item;
-  name_item.label = title_;
-  params.custom_items.push_back(name_item);
-
-  content::MenuItem separator_item;
-  separator_item.type = content::MenuItem::SEPARATOR;
-  params.custom_items.push_back(separator_item);
-
-  if (!plugin_info_.path.value().empty()) {
-    content::MenuItem run_item;
-    run_item.action = chrome::MENU_COMMAND_PLUGIN_RUN;
-    // Disable this menu item if the plugin is blocked by policy.
-    run_item.enabled = allow_loading_;
-    run_item.label = l10n_util::GetStringUTF16(IDS_CONTENT_CONTEXT_PLUGIN_RUN);
-    params.custom_items.push_back(run_item);
-  }
-
-  content::MenuItem hide_item;
-  hide_item.action = chrome::MENU_COMMAND_PLUGIN_HIDE;
-  hide_item.enabled = true;
-  hide_item.label = l10n_util::GetStringUTF16(IDS_CONTENT_CONTEXT_PLUGIN_HIDE);
-  params.custom_items.push_back(hide_item);
-
-  params.x = event.windowX;
-  params.y = event.windowY;
-
-  context_menu_request_id_ = render_view()->ShowContextMenu(this, params);
-  g_last_active_menu = this;
+  // Does nothing by default. Will be overridden if a specific browser wants
+  // a context menu.
+  return;
 }
 
 void PluginPlaceholder::OnLoadBlockedPlugins(const std::string& identifier) {
   if (!identifier.empty() && identifier != identifier_)
     return;
 
   RenderThread::Get()->RecordUserMetrics("Plugin_Load_UI");
   LoadPlugin();
 }
 
@@ skipping 28 matching lines @@
   RenderThread::Get()->RecordUserMetrics("Plugin_Load_Click");
   LoadPlugin();
 }
 
 void PluginPlaceholder::HideCallback(const CppArgumentList& args,
                                      CppVariant* result) {
   RenderThread::Get()->RecordUserMetrics("Plugin_Hide_Click");
   HidePlugin();
 }
 
-void PluginPlaceholder::OpenAboutPluginsCallback(const CppArgumentList& args,
-                                                 CppVariant* result) {
-  RenderThread::Get()->Send(
-      new ChromeViewHostMsg_OpenAboutPlugins(routing_id()));
-}
-
 void PluginPlaceholder::DidFinishLoadingCallback(const CppArgumentList& args,
                                                  CppVariant* result) {
   finished_loading_ = true;
   if (message_.length() > 0)
     UpdateMessage();
 }
 
-#if defined(ENABLE_MOBILE_YOUTUBE_PLUGIN)
-void PluginPlaceholder::OpenYoutubeUrlCallback(const CppArgumentList& args,
-                                               CppVariant* result) {
-  std::string youtube("vnd.youtube:");
-  GURL url(youtube.append(GetYoutubeVideoId(plugin_params_)));
-  WebURLRequest request;
-  request.initialize();
-  request.setURL(url);
-  render_view()->LoadURLExternally(
-      frame_, request, WebKit::WebNavigationPolicyNewForegroundTab);
+void PluginPlaceholder::SetPluginInfo(
+    const content::WebPluginInfo& plugin_info) {
+  plugin_info_ = plugin_info;
 }
 
-bool PluginPlaceholder::IsValidYouTubeVideo(const std::string& path) {
-  unsigned len = strlen(kSlashVSlash);
-
-  // check for more than just /v/ or /e/.
-  if (path.length() <= len)
-    return false;
-
-  std::string str = StringToLowerASCII(path);
-  // Youtube flash url can start with /v/ or /e/.
-  if (strncmp(str.data(), kSlashVSlash, len) != 0 &&
-      strncmp(str.data(), kSlashESlash, len) != 0)
-    return false;
-
-  // Start after /v/
-  for (unsigned i = len; i < path.length(); i++) {
-    char c = str[i];
-    if (isalpha(c) || isdigit(c) || c == '_' || c == '-')
-      continue;
-    // The url can have more parameters such as &hl=en after the video id.
-    // Once we start seeing extra parameters we can return true.
-    return c == '&' && i > len;
-  }
-  return true;
+const content::WebPluginInfo& PluginPlaceholder::GetPluginInfo() const {
+  return plugin_info_;
 }
 
-bool PluginPlaceholder::IsYouTubeURL(const GURL& url,
-                                       const std::string& mime_type) {
-  std::string host = url.host();
-  bool is_youtube = EndsWith(host, "youtube.com", true) ||
-      EndsWith(host, "youtube-nocookie.com", true);
+void PluginPlaceholder::SetIdentifier(const std::string& identifier) {
+  identifier_ = identifier;
+}
 
-  return is_youtube && IsValidYouTubeVideo(url.path()) &&
-      LowerCaseEqualsASCII(mime_type, content::kFlashPluginSwfMimeType);
+WebKit::WebFrame* PluginPlaceholder::GetFrame() { return frame_; }
+
+const WebKit::WebPluginParams& PluginPlaceholder::GetPluginParams() const {
+  return plugin_params_;
 }
-#endif