extensions/renderer/extension_frame_helper.cc

   1 // Copyright 2013 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "extensions/renderer/extension_frame_helper.h"
   6
   7 #include "content/public/renderer/render_frame.h"
   8 #include "extensions/common/api/messaging/message.h"
   9 #include "extensions/common/constants.h"
  10 #include "extensions/common/extension_messages.h"
  11 #include "extensions/common/manifest_handlers/background_info.h"
  12 #include "extensions/renderer/console.h"
  13 #include "extensions/renderer/content_watcher.h"
  14 #include "extensions/renderer/dispatcher.h"
  15 #include "extensions/renderer/messaging_bindings.h"
  16 #include "extensions/renderer/script_context.h"
  17 #include "third_party/WebKit/public/web/WebConsoleMessage.h"
  18 #include "third_party/WebKit/public/web/WebDocument.h"
  19 #include "third_party/WebKit/public/web/WebLocalFrame.h"
  20
  21 namespace extensions {
  22
  23 namespace {
  24
  25 base::LazyInstance<std::set<const ExtensionFrameHelper*>> g_frame_helpers =
  26     LAZY_INSTANCE_INITIALIZER;
  27
  28 // Returns true if the render frame corresponding with |frame_helper| matches
  29 // the given criteria.
  30 bool RenderFrameMatches(const ExtensionFrameHelper* frame_helper,
  31                         ViewType match_view_type,
  32                         int match_window_id,
  33                         const std::string& match_extension_id) {
  34   if (match_view_type != VIEW_TYPE_INVALID &&
  35       frame_helper->view_type() != match_view_type)
  36     return false;
  37   GURL url = frame_helper->render_frame()->GetWebFrame()->document().url();
  38   if (!url.SchemeIs(kExtensionScheme))
  39     return false;
  40   if (url.host() != match_extension_id)
  41     return false;
  42   if (match_window_id != extension_misc::kUnknownWindowId &&
  43       frame_helper->browser_window_id() != match_window_id)
  44     return false;
  45   return true;
  46 }
  47
  48 }  // namespace
  49
  50 ExtensionFrameHelper::ExtensionFrameHelper(content::RenderFrame* render_frame,
  51                                            Dispatcher* extension_dispatcher)
  52     : content::RenderFrameObserver(render_frame),
  53       content::RenderFrameObserverTracker<ExtensionFrameHelper>(render_frame),
  54       view_type_(VIEW_TYPE_INVALID),
  55       tab_id_(-1),
  56       browser_window_id_(-1),
  57       extension_dispatcher_(extension_dispatcher) {
  58   g_frame_helpers.Get().insert(this);
  59 }
  60
  61 ExtensionFrameHelper::~ExtensionFrameHelper() {
  62   g_frame_helpers.Get().erase(this);
  63 }
  64
  65 // static
  66 std::vector<content::RenderFrame*> ExtensionFrameHelper::GetExtensionFrames(
  67     const std::string& extension_id,
  68     int browser_window_id,
  69     ViewType view_type) {
  70   std::vector<content::RenderFrame*> render_frames;
  71   for (const ExtensionFrameHelper* helper : g_frame_helpers.Get()) {
  72     if (RenderFrameMatches(helper, view_type, browser_window_id, extension_id))
  73       render_frames.push_back(helper->render_frame());
  74   }
  75   return render_frames;
  76 }
  77
  78 // static
  79 content::RenderFrame* ExtensionFrameHelper::GetBackgroundPageFrame(
  80     const std::string& extension_id) {
  81   for (const ExtensionFrameHelper* helper : g_frame_helpers.Get()) {
  82     if (RenderFrameMatches(helper, VIEW_TYPE_EXTENSION_BACKGROUND_PAGE,
  83                            extension_misc::kUnknownWindowId, extension_id)) {
  84       blink::WebLocalFrame* web_frame = helper->render_frame()->GetWebFrame();
  85       // Check if this is the top frame.
  86       if (web_frame->top() == web_frame)
  87         return helper->render_frame();
  88     }
  89   }
  90   return nullptr;
  91 }
  92
  93 // static
  94 bool ExtensionFrameHelper::IsContextForEventPage(const ScriptContext* context) {
  95   content::RenderFrame* render_frame = context->GetRenderFrame();
  96   return context->extension() && render_frame &&
  97          BackgroundInfo::HasLazyBackgroundPage(context->extension()) &&
  98          ExtensionFrameHelper::Get(render_frame)->view_type() ==
  99               VIEW_TYPE_EXTENSION_BACKGROUND_PAGE;
 100 }
 101
 102 void ExtensionFrameHelper::DidCreateDocumentElement() {
 103   extension_dispatcher_->DidCreateDocumentElement(
 104       render_frame()->GetWebFrame());
 105 }
 106
 107 void ExtensionFrameHelper::DidMatchCSS(
 108     const blink::WebVector<blink::WebString>& newly_matching_selectors,
 109     const blink::WebVector<blink::WebString>& stopped_matching_selectors) {
 110   extension_dispatcher_->content_watcher()->DidMatchCSS(
 111       render_frame()->GetWebFrame(), newly_matching_selectors,
 112       stopped_matching_selectors);
 113 }
 114
 115 void ExtensionFrameHelper::DidCreateScriptContext(
 116     v8::Local<v8::Context> context,
 117     int extension_group,
 118     int world_id) {
 119   extension_dispatcher_->DidCreateScriptContext(
 120       render_frame()->GetWebFrame(), context, extension_group, world_id);
 121 }
 122
 123 void ExtensionFrameHelper::WillReleaseScriptContext(
 124     v8::Local<v8::Context> context,
 125     int world_id) {
 126   extension_dispatcher_->WillReleaseScriptContext(
 127       render_frame()->GetWebFrame(), context, world_id);
 128 }
 129
 130 bool ExtensionFrameHelper::OnMessageReceived(const IPC::Message& message) {
 131   bool handled = true;
 132   IPC_BEGIN_MESSAGE_MAP(ExtensionFrameHelper, message)
 133     IPC_MESSAGE_HANDLER(ExtensionMsg_DispatchOnConnect,
 134                         OnExtensionDispatchOnConnect)
 135     IPC_MESSAGE_HANDLER(ExtensionMsg_DeliverMessage, OnExtensionDeliverMessage)
 136     IPC_MESSAGE_HANDLER(ExtensionMsg_DispatchOnDisconnect,
 137                         OnExtensionDispatchOnDisconnect)
 138     IPC_MESSAGE_HANDLER(ExtensionMsg_SetTabId, OnExtensionSetTabId)
 139     IPC_MESSAGE_HANDLER(ExtensionMsg_UpdateBrowserWindowId,
 140                         OnUpdateBrowserWindowId)
 141     IPC_MESSAGE_HANDLER(ExtensionMsg_NotifyRenderViewType,
 142                         OnNotifyRendererViewType)
 143     IPC_MESSAGE_HANDLER(ExtensionMsg_Response, OnExtensionResponse)
 144     IPC_MESSAGE_HANDLER(ExtensionMsg_MessageInvoke, OnExtensionMessageInvoke)
 145     IPC_MESSAGE_UNHANDLED(handled = false)
 146   IPC_END_MESSAGE_MAP()
 147   return handled;
 148 }
 149
 150 void ExtensionFrameHelper::OnExtensionDispatchOnConnect(
 151     int target_port_id,
 152     const std::string& channel_name,
 153     const ExtensionMsg_TabConnectionInfo& source,
 154     const ExtensionMsg_ExternalConnectionInfo& info,
 155     const std::string& tls_channel_id) {
 156   MessagingBindings::DispatchOnConnect(
 157       extension_dispatcher_->script_context_set(),
 158       target_port_id,
 159       channel_name,
 160       source,
 161       info,
 162       tls_channel_id,
 163       render_frame());
 164 }
 165
 166 void ExtensionFrameHelper::OnExtensionDeliverMessage(int target_id,
 167                                                      const Message& message) {
 168   MessagingBindings::DeliverMessage(
 169       extension_dispatcher_->script_context_set(), target_id, message,
 170       render_frame());
 171 }
 172
 173 void ExtensionFrameHelper::OnExtensionDispatchOnDisconnect(
 174     int port_id,
 175     const std::string& error_message) {
 176   MessagingBindings::DispatchOnDisconnect(
 177       extension_dispatcher_->script_context_set(), port_id, error_message,
 178       render_frame());
 179 }
 180
 181 void ExtensionFrameHelper::OnExtensionSetTabId(int tab_id) {
 182   CHECK_EQ(tab_id_, -1);
 183   CHECK_GE(tab_id, 0);
 184   tab_id_ = tab_id;
 185 }
 186
 187 void ExtensionFrameHelper::OnUpdateBrowserWindowId(int browser_window_id) {
 188   browser_window_id_ = browser_window_id;
 189 }
 190
 191 void ExtensionFrameHelper::OnNotifyRendererViewType(ViewType type) {
 192   // TODO(devlin): It'd be really nice to be able to
 193   // DCHECK_EQ(VIEW_TYPE_INVALID, view_type_) here.
 194   view_type_ = type;
 195 }
 196
 197 void ExtensionFrameHelper::OnExtensionResponse(int request_id,
 198                                                bool success,
 199                                                const base::ListValue& response,
 200                                                const std::string& error) {
 201   extension_dispatcher_->OnExtensionResponse(request_id,
 202                                              success,
 203                                              response,
 204                                              error);
 205 }
 206
 207 void ExtensionFrameHelper::OnExtensionMessageInvoke(
 208     const std::string& extension_id,
 209     const std::string& module_name,
 210     const std::string& function_name,
 211     const base::ListValue& args,
 212     bool user_gesture) {
 213   extension_dispatcher_->InvokeModuleSystemMethod(render_frame(), extension_id,
 214                                                   module_name, function_name,
 215                                                   args, user_gesture);
 216 }
 217
 218 }  // namespace extensions