Implement a useful context menu for the blocked plug-in frame:...

chrome/renderer/blocked_plugin.cc

 // Copyright (c) 2010 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/blocked_plugin.h"
 
 #include "app/l10n_util.h"
 #include "app/resource_bundle.h"
 #include "base/string_piece.h"
 #include "base/values.h"
 #include "chrome/common/jstemplate_builder.h"
 #include "chrome/common/notification_service.h"
 #include "chrome/common/render_messages.h"
 #include "chrome/renderer/render_view.h"
 #include "grit/generated_resources.h"
 #include "grit/renderer_resources.h"
+#include "third_party/WebKit/WebKit/chromium/public/WebContextMenuData.h"
 #include "third_party/WebKit/WebKit/chromium/public/WebData.h"
 #include "third_party/WebKit/WebKit/chromium/public/WebFrame.h"
+#include "third_party/WebKit/WebKit/chromium/public/WebMenuItemInfo.h"
 #include "third_party/WebKit/WebKit/chromium/public/WebPluginContainer.h"
+#include "third_party/WebKit/WebKit/chromium/public/WebPoint.h"
+#include "third_party/WebKit/WebKit/chromium/public/WebVector.h"
 #include "third_party/WebKit/WebKit/chromium/public/WebView.h"
 #include "webkit/glue/plugins/plugin_group.h"
 #include "webkit/glue/plugins/webview_plugin.h"
 #include "webkit/glue/webpreferences.h"
 
+using WebKit::WebContextMenuData;
 using WebKit::WebFrame;
+using WebKit::WebMenuItemInfo;
 using WebKit::WebPlugin;
 using WebKit::WebPluginContainer;
 using WebKit::WebPluginParams;
+using WebKit::WebPoint;
+using WebKit::WebString;
+using WebKit::WebVector;
 
 static const char* const kBlockedPluginDataURL = "chrome://blockedplugindata/";
+static const unsigned kMenuActionLoad = 1;
+static const unsigned kMenuActionRemove = 2;
 
 BlockedPlugin::BlockedPlugin(RenderView* render_view,
                              WebFrame* frame,
                              const PluginGroup& info,
                              const WebPluginParams& params,
                              const WebPreferences& preferences,
                              int template_id,
                              const string16& message)
     : render_view_(render_view),
       frame_(frame),
       plugin_params_(params) {
   const base::StringPiece template_html(
       ResourceBundle::GetSharedInstance().GetRawDataResource(template_id));
 
   DCHECK(!template_html.empty()) << "unable to load template. ID: "
                                  << template_id;
 
   DictionaryValue values;
   values.SetString("message", message);
-  values.SetString("name", info.GetGroupName());
+  name_ = info.GetGroupName();
+  values.SetString("name", name_);
 
   // "t" is the id of the templates root node.
   std::string html_data = jstemplate_builder::GetTemplatesHtml(
       template_html, &values, "t");
 
   plugin_ = WebViewPlugin::Create(this,
                                   preferences,
                                   html_data,
                                   GURL(kBlockedPluginDataURL));
 
   registrar_.Add(this,
                  NotificationType::SHOULD_LOAD_PLUGINS,
                  NotificationService::AllSources());
 }
 
-BlockedPlugin::~BlockedPlugin() {}
+BlockedPlugin::~BlockedPlugin() {
+  render_view_->PluginMenuEventListenerDestroyed(this);
+}
 
 void BlockedPlugin::BindWebFrame(WebFrame* frame) {
   BindToJavascript(frame, L"plugin");
   BindMethod("load", &BlockedPlugin::Load);
 }
 
 void BlockedPlugin::WillDestroyPlugin() {
   delete this;
 }
 
+void BlockedPlugin::ShowContextMenu(const WebKit::WebMouseEvent& event) {
+  WebContextMenuData menuData;

[brettw, 2010/12/07 06:23:56]

Local variables should be lower_case_with_underscores.

[Chris Evans, 2010/12/07 15:36:14]

Done.

+  WebVector<WebMenuItemInfo> customItems(static_cast<size_t>(4));

[brettw, 2010/12/07 06:23:56]

I think you can just use custom_items(4) here? If not, try 4u.

[Chris Evans, 2010/12/07 15:36:14]

4u doesn't work either (on 64-bit); the constructor in question is marked
explicit. 4UL works, but I think there are 64-bit platforms where
sizeof(long)==4 so I think the explicit cast to size_t is safest long term.

[brettw, 2010/12/07 16:53:51]

4u should be OK. size_t is equal to or larger than an unsigned so the compiler
can convert if necessary without you making it explicit. Explicit doesn't affect
type conversion, that just prevents a size_t from being implicitly converted to
a WebVector when e.g. calling a function. Since you're calling the constructor
explicitly here, the "explicit" condition is met.

+  {

[brettw, 2010/12/07 06:23:56]

Normally we wouldn't use {} here. Just separate the blocks with newlines.

[Chris Evans, 2010/12/07 15:36:14]

Done.

+    WebMenuItemInfo nameItem;
+    nameItem.label = name_;
+    customItems[0] = nameItem;
+  }
+  {
+    WebMenuItemInfo separatorItem;
+    separatorItem.type = WebMenuItemInfo::Separator;
+    customItems[1] = separatorItem;
+  }
+  {
+    WebMenuItemInfo runItem;
+    runItem.action = kMenuActionLoad;
+    runItem.enabled = true;
+    runItem.label = WebString::fromUTF8(
+        l10n_util::GetStringUTF8(IDS_CONTENT_CONTEXT_PLUGIN_RUN).c_str());
+    customItems[2] = runItem;
+  }
+  {
+    WebMenuItemInfo hideItem;
+    hideItem.action = kMenuActionRemove;
+    hideItem.enabled = true;
+    hideItem.label = WebString::fromUTF8(
+        l10n_util::GetStringUTF8(IDS_CONTENT_CONTEXT_PLUGIN_HIDE).c_str());
+    customItems[3] = hideItem;
+  }
+  menuData.customItems.swap(customItems);
+  menuData.mousePosition = WebPoint(event.windowX, event.windowY);
+  render_view_->showContextMenu(NULL, menuData);
+  render_view_->PluginMenuEventListenerInstall(this);
+}
+
+void BlockedPlugin::menuOptionSelected(unsigned id) {
+  if (id == kMenuActionLoad) {
+    LoadPlugin();
+  } else if (id == kMenuActionRemove) {
+    HidePlugin();
+  } else {
+    NOTREACHED();
+  }
+}
+
 void BlockedPlugin::Observe(NotificationType type,
                             const NotificationSource& source,
                             const NotificationDetails& details) {
   if (type == NotificationType::SHOULD_LOAD_PLUGINS) {
     LoadPlugin();
   } else {
     NOTREACHED();
   }
 }
 
 void BlockedPlugin::Load(const CppArgumentList& args, CppVariant* result) {
   LoadPlugin();
 }
 
 void BlockedPlugin::LoadPlugin() {
   CHECK(plugin_);
   WebPluginContainer* container = plugin_->container();
   WebPlugin* new_plugin =
       render_view_->CreatePluginNoCheck(frame_,
                                         plugin_params_);
   if (new_plugin && new_plugin->initialize(container)) {
     container->setPlugin(new_plugin);
     container->invalidate();
     container->reportGeometry();
     plugin_->ReplayReceivedData(new_plugin);
     plugin_->destroy();
   }
 }
+
+void BlockedPlugin::HidePlugin() {
+  CHECK(plugin_);
+  WebPluginContainer* container = plugin_->container();
+  container->element().setAttribute("style", "display: none;");
+}