extensions/renderer/dispatcher.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_DISPATCHER_H_
   6 #define EXTENSIONS_RENDERER_DISPATCHER_H_
   7
   8 #include <map>
   9 #include <set>
  10 #include <string>
  11 #include <utility>
  12 #include <vector>
  13
  14 #include "base/scoped_observer.h"
  15 #include "base/timer/timer.h"
  16 #include "content/public/renderer/render_process_observer.h"
  17 #include "extensions/common/event_filter.h"
  18 #include "extensions/common/extension_set.h"
  19 #include "extensions/common/extensions_client.h"
  20 #include "extensions/common/features/feature.h"
  21 #include "extensions/renderer/resource_bundle_source_map.h"
  22 #include "extensions/renderer/script_context.h"
  23 #include "extensions/renderer/script_context_set.h"
  24 #include "extensions/renderer/user_script_set_manager.h"
  25 #include "extensions/renderer/v8_schema_registry.h"
  26 #include "third_party/WebKit/public/platform/WebString.h"
  27 #include "third_party/WebKit/public/platform/WebVector.h"
  28 #include "v8/include/v8.h"
  29
  30 class ChromeRenderViewTest;
  31 class GURL;
  32 class ModuleSystem;
  33 class URLPattern;
  34 struct ExtensionMsg_ExternalConnectionInfo;
  35 struct ExtensionMsg_Loaded_Params;
  36 struct ExtensionMsg_TabConnectionInfo;
  37 struct ExtensionMsg_UpdatePermissions_Params;
  38
  39 namespace blink {
  40 class WebFrame;
  41 class WebLocalFrame;
  42 class WebSecurityOrigin;
  43 }
  44
  45 namespace base {
  46 class ListValue;
  47 }
  48
  49 namespace content {
  50 class RenderThread;
  51 }
  52
  53 namespace extensions {
  54 class ContentWatcher;
  55 class DispatcherDelegate;
  56 class Extension;
  57 class FilteredEventRouter;
  58 class ManifestPermissionSet;
  59 class RequestSender;
  60 class ScriptContext;
  61 class ScriptInjectionManager;
  62 struct Message;
  63
  64 // Dispatches extension control messages sent to the renderer and stores
  65 // renderer extension related state.
  66 class Dispatcher : public content::RenderProcessObserver,
  67                    public UserScriptSetManager::Observer {
  68  public:
  69   explicit Dispatcher(DispatcherDelegate* delegate);
  70   ~Dispatcher() override;
  71
  72   const std::set<std::string>& function_names() const {
  73     return function_names_;
  74   }
  75
  76   const ExtensionSet* extensions() const { return &extensions_; }
  77
  78   const ScriptContextSet& script_context_set() const {
  79     return script_context_set_;
  80   }
  81
  82   V8SchemaRegistry* v8_schema_registry() { return v8_schema_registry_.get(); }
  83
  84   ContentWatcher* content_watcher() { return content_watcher_.get(); }
  85
  86   RequestSender* request_sender() { return request_sender_.get(); }
  87
  88   void OnRenderViewCreated(content::RenderView* render_view);
  89
  90   bool IsExtensionActive(const std::string& extension_id) const;
  91
  92   // Finds the extension for the JavaScript context associated with the
  93   // specified |frame| and isolated world. If |world_id| is zero, finds the
  94   // extension ID associated with the main world's JavaScript context. If the
  95   // JavaScript context isn't from an extension, returns empty string.
  96   const Extension* GetExtensionFromFrameAndWorld(const blink::WebFrame* frame,
  97                                                  int world_id,
  98                                                  bool use_effective_url);
  99
 100   // Forwarded from the RenderFrameObserver events by ExtensionFrameHelper.
 101   void DidCreateScriptContext(blink::WebLocalFrame* frame,
 102                               const v8::Handle<v8::Context>& context,
 103                               int extension_group,
 104                               int world_id);
 105   void WillReleaseScriptContext(blink::WebLocalFrame* frame,
 106                                 const v8::Handle<v8::Context>& context,
 107                                 int world_id);
 108
 109   void DidCreateDocumentElement(blink::WebFrame* frame);
 110
 111   void DidMatchCSS(
 112       blink::WebFrame* frame,
 113       const blink::WebVector<blink::WebString>& newly_matching_selectors,
 114       const blink::WebVector<blink::WebString>& stopped_matching_selectors);
 115
 116   void OnExtensionResponse(int request_id,
 117                            bool success,
 118                            const base::ListValue& response,
 119                            const std::string& error);
 120
 121   // Checks that the current context contains an extension that has permission
 122   // to execute the specified function. If it does not, a v8 exception is thrown
 123   // and the method returns false. Otherwise returns true.
 124   bool CheckContextAccessToExtensionAPI(const std::string& function_name,
 125                                         ScriptContext* context) const;
 126
 127   // Dispatches the event named |event_name| to all render views.
 128   void DispatchEvent(const std::string& extension_id,
 129                      const std::string& event_name) const;
 130
 131   // Shared implementation of the various MessageInvoke IPCs.
 132   void InvokeModuleSystemMethod(content::RenderView* render_view,
 133                                 const std::string& extension_id,
 134                                 const std::string& module_name,
 135                                 const std::string& function_name,
 136                                 const base::ListValue& args,
 137                                 bool user_gesture);
 138
 139   void ClearPortData(int port_id);
 140
 141   // Returns a list of (module name, resource id) pairs for the JS modules to
 142   // add to the source map.
 143   static std::vector<std::pair<std::string, int> > GetJsResources();
 144   static void RegisterNativeHandlers(ModuleSystem* module_system,
 145                                      ScriptContext* context,
 146                                      Dispatcher* dispatcher,
 147                                      RequestSender* request_sender,
 148                                      V8SchemaRegistry* v8_schema_registry);
 149
 150   bool WasWebRequestUsedBySomeExtensions() const { return webrequest_used_; }
 151
 152  private:
 153   friend class ::ChromeRenderViewTest;
 154   FRIEND_TEST_ALL_PREFIXES(RendererPermissionsPolicyDelegateTest,
 155                            CannotScriptWebstore);
 156
 157   // RenderProcessObserver implementation:
 158   bool OnControlMessageReceived(const IPC::Message& message) override;
 159   void WebKitInitialized() override;
 160   void IdleNotification() override;
 161   void OnRenderProcessShutdown() override;
 162
 163   void OnActivateExtension(const std::string& extension_id);
 164   void OnCancelSuspend(const std::string& extension_id);
 165   void OnDeliverMessage(int target_port_id, const Message& message);
 166   void OnDispatchOnConnect(int target_port_id,
 167                            const std::string& channel_name,
 168                            const ExtensionMsg_TabConnectionInfo& source,
 169                            const ExtensionMsg_ExternalConnectionInfo& info,
 170                            const std::string& tls_channel_id);
 171   void OnDispatchOnDisconnect(int port_id, const std::string& error_message);
 172   void OnLoaded(
 173       const std::vector<ExtensionMsg_Loaded_Params>& loaded_extensions);
 174   void OnLoadedInternal(scoped_refptr<const Extension> extension);
 175   void OnMessageInvoke(const std::string& extension_id,
 176                        const std::string& module_name,
 177                        const std::string& function_name,
 178                        const base::ListValue& args,
 179                        bool user_gesture);
 180   void OnSetChannel(int channel);
 181   void OnSetFunctionNames(const std::vector<std::string>& names);
 182   void OnSetScriptingWhitelist(
 183       const ExtensionsClient::ScriptingWhitelist& extension_ids);
 184   void OnSetSystemFont(const std::string& font_family,
 185                        const std::string& font_size);
 186   void OnShouldSuspend(const std::string& extension_id, uint64 sequence_id);
 187   void OnSuspend(const std::string& extension_id);
 188   void OnTransferBlobs(const std::vector<std::string>& blob_uuids);
 189   void OnUnloaded(const std::string& id);
 190   void OnUpdatePermissions(const ExtensionMsg_UpdatePermissions_Params& params);
 191   void OnUpdateTabSpecificPermissions(const GURL& visible_url,
 192                                       const std::string& extension_id,
 193                                       const URLPatternSet& new_hosts,
 194                                       bool update_origin_whitelist,
 195                                       int tab_id);
 196   void OnClearTabSpecificPermissions(
 197       const std::vector<std::string>& extension_ids,
 198       bool update_origin_whitelist,
 199       int tab_id);
 200   void OnUsingWebRequestAPI(bool webrequest_used);
 201
 202   // UserScriptSetManager::Observer implementation.
 203   void OnUserScriptsUpdated(const std::set<HostID>& changed_hosts,
 204                             const std::vector<UserScript*>& scripts) override;
 205
 206   void UpdateActiveExtensions();
 207
 208   // Sets up the host permissions for |extension|.
 209   void InitOriginPermissions(const Extension* extension);
 210
 211   // Updates the host permissions for the extension url to include only those in
 212   // |new_patterns|, and remove from |old_patterns| that are no longer allowed.
 213   void UpdateOriginPermissions(const GURL& extension_url,
 214                                const URLPatternSet& old_patterns,
 215                                const URLPatternSet& new_patterns);
 216
 217   // Enable custom element whitelist in Apps.
 218   void EnableCustomElementWhiteList();
 219
 220   // Adds or removes bindings for every context belonging to |extension_id|, or
 221   // or all contexts if |extension_id| is empty.
 222   void UpdateBindings(const std::string& extension_id);
 223
 224   void UpdateBindingsForContext(ScriptContext* context);
 225
 226   void RegisterBinding(const std::string& api_name, ScriptContext* context);
 227
 228   void RegisterNativeHandlers(ModuleSystem* module_system,
 229                               ScriptContext* context);
 230
 231   // Determines if a ScriptContext can connect to any externally_connectable-
 232   // enabled extension.
 233   bool IsRuntimeAvailableToContext(ScriptContext* context);
 234
 235   // Updates a web page context with any content capabilities granted by active
 236   // extensions.
 237   void UpdateContentCapabilities(ScriptContext* context);
 238
 239   // Inserts static source code into |source_map_|.
 240   void PopulateSourceMap();
 241
 242   // Returns whether the current renderer hosts a platform app.
 243   bool IsWithinPlatformApp();
 244
 245   bool IsSandboxedPage(const GURL& url) const;
 246
 247   // Returns the Feature::Context type of context for a JavaScript context.
 248   Feature::Context ClassifyJavaScriptContext(
 249       const Extension* extension,
 250       int extension_group,
 251       const GURL& url,
 252       const blink::WebSecurityOrigin& origin);
 253
 254   // Gets |field| from |object| or creates it as an empty object if it doesn't
 255   // exist.
 256   v8::Handle<v8::Object> GetOrCreateObject(const v8::Handle<v8::Object>& object,
 257                                            const std::string& field,
 258                                            v8::Isolate* isolate);
 259
 260   v8::Handle<v8::Object> GetOrCreateBindObjectIfAvailable(
 261       const std::string& api_name,
 262       std::string* bind_name,
 263       ScriptContext* context);
 264
 265   // Requires the GuestView modules in the module system of the ScriptContext
 266   // |context|.
 267   void RequireGuestViewModules(ScriptContext* context);
 268
 269   // The delegate for this dispatcher. Not owned, but must extend beyond the
 270   // Dispatcher's own lifetime.
 271   DispatcherDelegate* delegate_;
 272
 273   // True if the IdleNotification timer should be set.
 274   bool set_idle_notifications_;
 275
 276   // Contains all loaded extensions.  This is essentially the renderer
 277   // counterpart to ExtensionService in the browser. It contains information
 278   // about all extensions currently loaded by the browser.
 279   ExtensionSet extensions_;
 280
 281   // The IDs of extensions that failed to load, mapped to the error message
 282   // generated on failure.
 283   std::map<std::string, std::string> extension_load_errors_;
 284
 285   // All the bindings contexts that are currently loaded for this renderer.
 286   // There is zero or one for each v8 context.
 287   ScriptContextSet script_context_set_;
 288
 289   scoped_ptr<ContentWatcher> content_watcher_;
 290
 291   scoped_ptr<UserScriptSetManager> user_script_set_manager_;
 292
 293   scoped_ptr<ScriptInjectionManager> script_injection_manager_;
 294
 295   // Same as above, but on a longer timer and will run even if the process is
 296   // not idle, to ensure that IdleHandle gets called eventually.
 297   scoped_ptr<base::RepeatingTimer<content::RenderThread> > forced_idle_timer_;
 298
 299   // All declared function names.
 300   std::set<std::string> function_names_;
 301
 302   // The extensions and apps that are active in this process.
 303   std::set<std::string> active_extension_ids_;
 304
 305   ResourceBundleSourceMap source_map_;
 306
 307   // Cache for the v8 representation of extension API schemas.
 308   scoped_ptr<V8SchemaRegistry> v8_schema_registry_;
 309
 310   // Sends API requests to the extension host.
 311   scoped_ptr<RequestSender> request_sender_;
 312
 313   // The platforms system font family and size;
 314   std::string system_font_family_;
 315   std::string system_font_size_;
 316
 317   // Mapping of port IDs to tabs. If there is no tab, the value would be -1.
 318   std::map<int, int> port_to_tab_id_map_;
 319
 320   // True once WebKit has been initialized (and it is therefore safe to poke).
 321   bool is_webkit_initialized_;
 322
 323   // It is important for this to come after the ScriptInjectionManager, so that
 324   // the observer is destroyed before the UserScriptSet.
 325   ScopedObserver<UserScriptSetManager, UserScriptSetManager::Observer>
 326       user_script_set_manager_observer_;
 327
 328   // Status of webrequest usage.
 329   bool webrequest_used_;
 330
 331   DISALLOW_COPY_AND_ASSIGN(Dispatcher);
 332 };
 333
 334 }  // namespace extensions
 335
 336 #endif  // EXTENSIONS_RENDERER_DISPATCHER_H_