src/extensions/renderer/extension_helper.h

   1 // Copyright 2014 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 #ifndef EXTENSIONS_RENDERER_EXTENSION_HELPER_H_
   6 #define EXTENSIONS_RENDERER_EXTENSION_HELPER_H_
   7
   8 #include <vector>
   9
  10 #include "base/memory/scoped_ptr.h"
  11 #include "content/public/common/console_message_level.h"
  12 #include "content/public/renderer/render_view_observer.h"
  13 #include "content/public/renderer/render_view_observer_tracker.h"
  14 #include "extensions/common/view_type.h"
  15
  16 class GURL;
  17 class SkBitmap;
  18 struct ExtensionMsg_ExternalConnectionInfo;
  19
  20 namespace base {
  21 class DictionaryValue;
  22 class ListValue;
  23 }
  24
  25 namespace extensions {
  26 class AutomationApiHelper;
  27 class Dispatcher;
  28
  29 struct Message;
  30
  31 // RenderView-level plumbing for extension features.
  32 class ExtensionHelper
  33     : public content::RenderViewObserver,
  34       public content::RenderViewObserverTracker<ExtensionHelper> {
  35  public:
  36   // Returns a list of extension RenderViews that match the given filter
  37   // criteria. If |browser_window_id| is not extension_misc::kUnknownWindowId,
  38   // the list is restricted to views in that browser window.
  39   static std::vector<content::RenderView*> GetExtensionViews(
  40       const std::string& extension_id,
  41       int browser_window_id,
  42       ViewType view_type);
  43
  44   // Returns the given extension's background page, or NULL if none.
  45   static content::RenderView* GetBackgroundPage(
  46       const std::string& extension_id);
  47
  48   ExtensionHelper(content::RenderView* render_view, Dispatcher* dispatcher);
  49   ~ExtensionHelper() override;
  50
  51   int tab_id() const { return tab_id_; }
  52   int browser_window_id() const { return browser_window_id_; }
  53   ViewType view_type() const { return view_type_; }
  54   Dispatcher* dispatcher() const { return dispatcher_; }
  55
  56  private:
  57   // RenderViewObserver implementation.
  58   bool OnMessageReceived(const IPC::Message& message) override;
  59   void DidCreateDocumentElement(blink::WebLocalFrame* frame) override;
  60   void DidMatchCSS(
  61       blink::WebLocalFrame* frame,
  62       const blink::WebVector<blink::WebString>& newly_matching_selectors,
  63       const blink::WebVector<blink::WebString>& stopped_matching_selectors)
  64       override;
  65   void DraggableRegionsChanged(blink::WebFrame* frame) override;
  66
  67   void OnExtensionResponse(int request_id, bool success,
  68                            const base::ListValue& response,
  69                            const std::string& error);
  70   void OnExtensionMessageInvoke(const std::string& extension_id,
  71                                 const std::string& module_name,
  72                                 const std::string& function_name,
  73                                 const base::ListValue& args,
  74                                 bool user_gesture);
  75   void OnExtensionDispatchOnConnect(
  76       int target_port_id,
  77       const std::string& channel_name,
  78       const base::DictionaryValue& source_tab,
  79       const ExtensionMsg_ExternalConnectionInfo& info,
  80       const std::string& tls_channel_id);
  81   void OnExtensionDeliverMessage(int target_port_id,
  82                                  const Message& message);
  83   void OnExtensionDispatchOnDisconnect(int port_id,
  84                                        const std::string& error_message);
  85   void OnNotifyRendererViewType(ViewType view_type);
  86   void OnSetTabId(int tab_id);
  87   void OnUpdateBrowserWindowId(int window_id);
  88   void OnAddMessageToConsole(content::ConsoleMessageLevel level,
  89                              const std::string& message);
  90   void OnAppWindowClosed();
  91   void OnSetFrameName(const std::string& name);
  92
  93   Dispatcher* dispatcher_;
  94
  95   // Type of view attached with RenderView.
  96   ViewType view_type_;
  97
  98   // Id of the tab which the RenderView is attached to.
  99   int tab_id_;
 100
 101   // Id number of browser window which RenderView is attached to.
 102   int browser_window_id_;
 103
 104   DISALLOW_COPY_AND_ASSIGN(ExtensionHelper);
 105 };
 106
 107 }  // namespace extensions
 108
 109 #endif  // EXTENSIONS_RENDERER_EXTENSION_HELPER_H_