Introduce ActiveScriptController; track active extension scripts

chrome/browser/extensions/active_script_controller.cc

Index: chrome/browser/extensions/active_script_controller.cc
diff --git a/chrome/browser/extensions/active_script_controller.cc b/chrome/browser/extensions/active_script_controller.cc
new file mode 100644
index 0000000000000000000000000000000000000000..55fa3d24bdf9475a0a11bd125de603fb436757ae
--- /dev/null
+++ b/chrome/browser/extensions/active_script_controller.cc
@@ -0,0 +1,134 @@
+// Copyright 2014 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/extensions/active_script_controller.h"
+
+#include "base/metrics/histogram.h"
+#include "chrome/browser/extensions/extension_action.h"
+#include "chrome/common/extensions/api/extension_action/action_info.h"
+#include "content/public/browser/navigation_controller.h"
+#include "content/public/browser/navigation_entry.h"
+#include "content/public/browser/web_contents.h"
+#include "extensions/browser/extension_registry.h"
+#include "extensions/common/extension.h"
+#include "extensions/common/extension_messages.h"
+#include "extensions/common/extension_set.h"
+#include "extensions/common/feature_switch.h"
+#include "extensions/common/permissions/permissions_data.h"
+#include "ipc/ipc_message_macros.h"
+
+namespace extensions {
+
+ActiveScriptController::ActiveScriptController(
+    content::WebContents* web_contents)
+    : content::WebContentsObserver(web_contents),
+      enabled_(FeatureSwitch::scripts_require_action()->IsEnabled()) {
+}
+
+ActiveScriptController::~ActiveScriptController() {
+  LogUMA();
+}
+
+void ActiveScriptController::NotifyScriptExecuting(
+    const std::string& extension_id, int page_id) {
+  if (extensions_executing_scripts_.count(extension_id) ||
+      web_contents()->GetController().GetVisibleEntry()->GetPageID()
+          != page_id) {
+    return;
+  }
+
+  const Extension* extension =
+      ExtensionRegistry::Get(web_contents()->GetBrowserContext())
+          ->enabled_extensions().GetByID(extension_id);
+  if (extension &&
+      PermissionsData::RequiresActionForScriptExecution(extension)) {
+    extensions_executing_scripts_.insert(extension_id);
+    LocationBarController::NotifyChange(web_contents());
+  }
+}
+
+void ActiveScriptController::OnAdInjectionDetected(
+    const std::string& extension_id) {
+  ad_injectors_.insert(extension_id);
+}
+
+ExtensionAction* ActiveScriptController::GetActionForExtension(
+    const Extension* extension) {
+  if (!enabled_ || extensions_executing_scripts_.count(extension->id()) == 0)
+    return NULL;  // No action for this extension.
+
+  ActiveScriptMap::iterator existing =
+      active_script_actions_.find(extension->id());
+  if (existing != active_script_actions_.end())
+    return existing->second.get();
+
+  linked_ptr<ExtensionAction> action(
+      new ExtensionAction(extension->id(),
+                          ActionInfo::TYPE_PAGE,
+                          ActionInfo()));
+  action->SetTitle(ExtensionAction::kDefaultTabId, extension->name());
+  action->SetIsVisible(ExtensionAction::kDefaultTabId, true);
+
+  const ActionInfo* action_info = ActionInfo::GetPageActionInfo(extension);
+  if (!action_info)
+    action_info = ActionInfo::GetBrowserActionInfo(extension);
+
+  if (action_info && !action_info->default_icon.empty()) {
+    action->set_default_icon(
+        make_scoped_ptr(new ExtensionIconSet(action_info->default_icon)));
+  }
+
+  active_script_actions_[extension->id()] = action;
+  return action.get();
+}
+
+LocationBarController::Action ActiveScriptController::OnClicked(
+    const Extension* extension) {
+  DCHECK(extensions_executing_scripts_.count(extension->id()) > 0);
+  return LocationBarController::ACTION_NONE;
+}
+
+void ActiveScriptController::OnNavigated() {
+  LogUMA();
+  extensions_executing_scripts_.clear();
+}
+
+bool ActiveScriptController::OnMessageReceived(const IPC::Message& message) {
+  bool handled = true;
+  IPC_BEGIN_MESSAGE_MAP(ActiveScriptController, message)
+    IPC_MESSAGE_HANDLER(ExtensionHostMsg_NotifyExtensionScriptExecution,
+                        OnNotifyExtensionScriptExecution)
+    IPC_MESSAGE_UNHANDLED(handled = false)
+  IPC_END_MESSAGE_MAP()
+  return handled;
+}
+
+void ActiveScriptController::OnNotifyExtensionScriptExecution(
+    const std::string& extension_id,
+    int page_id) {
+  if (!Extension::IdIsValid(extension_id)) {
+    NOTREACHED() << "'" << extension_id << "' is not a valid id.";
+    return;
+  }
+  NotifyScriptExecuting(extension_id, page_id);
+}
+
+void ActiveScriptController::LogUMA() const {
+  UMA_HISTOGRAM_COUNTS_100(
+      "Extensions.ActiveScriptController.ShownActiveScriptsOnPage",
+      extensions_executing_scripts_.size());
+
+  size_t num_preventable_ad_injectors = 0u;
+  for (std::set<std::string>::const_iterator iter = ad_injectors_.begin();
+       iter != ad_injectors_.end();
+       ++iter) {
+    num_preventable_ad_injectors += extensions_executing_scripts_.count(*iter);
+  }

[not at google - send to devlin, 2014/05/09 00:22:59]

easier:

size_t num_preventable_ad_injectors = STLSetIntersection(
    ad_injectors_, extensions_executing_scripts_).size();

[Devlin, 2014/05/09 22:23:29]

Done.

+
+  UMA_HISTOGRAM_COUNTS_100(
+      "Extensions.ActiveScriptController.PreventableAdInjectors",
+      num_preventable_ad_injectors);

[not at google - send to devlin, 2014/05/09 00:22:59]

maybe it WOULD be nice to also log how many wouldn't have been prevented, even
if you can figure it out by looking at the ActivityLog UMA... hm. Ilya WDYT?

[Ilya Sherman, 2014/05/09 22:08:43]

Sorry, missed this question before.  Either way is fine by me -- whichever you
guys prefer.

[Devlin, 2014/05/09 22:23:29]

Added it, to save us from having to add up all different ad injection types.

+}
+
+}  // namespace extensions