extensions/renderer/user_script_set_manager.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_USER_SCRIPT_SET_MANAGER_H_
   6 #define EXTENSIONS_RENDERER_USER_SCRIPT_SET_MANAGER_H_
   7
   8 #include <map>
   9 #include <set>
  10 #include <string>
  11
  12 #include "base/memory/linked_ptr.h"
  13 #include "base/memory/shared_memory.h"
  14 #include "base/observer_list.h"
  15 #include "content/public/renderer/render_process_observer.h"
  16 #include "extensions/common/extension.h"
  17 #include "extensions/common/user_script.h"
  18 #include "extensions/renderer/user_script_set.h"
  19
  20 namespace content {
  21 class RenderFrame;
  22 }
  23
  24 namespace IPC {
  25 class Message;
  26 }
  27
  28 namespace extensions {
  29
  30 class ExtensionSet;
  31 class ScriptInjection;
  32
  33 // Manager for separate UserScriptSets, one for each shared memory region.
  34 // Regions are organized as follows:
  35 // static_scripts -- contains all extensions' scripts that are statically
  36 //                   declared in the extension manifest.
  37 // programmatic_scripts -- one region per host (extension or WebUI) containing
  38 //                         only programmatically-declared scripts, instantiated
  39 //                         when an extension first creates a declarative rule
  40 //                         that would, if triggered, request a script injection.
  41 class UserScriptSetManager : public content::RenderProcessObserver {
  42  public:
  43   // Like a UserScriptSet::Observer, but automatically subscribes to all sets
  44   // associated with the manager.
  45   class Observer {
  46    public:
  47     virtual void OnUserScriptsUpdated(
  48         const std::set<HostID>& changed_hosts,
  49         const std::vector<UserScript*>& scripts) = 0;
  50   };
  51
  52   UserScriptSetManager(const ExtensionSet* extensions);
  53
  54   ~UserScriptSetManager() override;
  55
  56   void AddObserver(Observer* observer);
  57   void RemoveObserver(Observer* observer);
  58
  59   // Looks up the script injection associated with |script_id| and
  60   // |extension_id| in the context of the given |web_frame|, |tab_id|,
  61   // and |url|.
  62   scoped_ptr<ScriptInjection> GetInjectionForDeclarativeScript(
  63       int script_id,
  64       content::RenderFrame* render_frame,
  65       int tab_id,
  66       const GURL& url,
  67       const std::string& extension_id);
  68
  69   // Append all injections from |static_scripts| and each of
  70   // |programmatic_scripts_| to |injections|.
  71   void GetAllInjections(ScopedVector<ScriptInjection>* injections,
  72                         content::RenderFrame* render_frame,
  73                         int tab_id,
  74                         UserScript::RunLocation run_location);
  75
  76   // Get active extension IDs from |static_scripts| and each of
  77   // |programmatic_scripts_|.
  78   void GetAllActiveExtensionIds(std::set<std::string>* ids) const;
  79
  80   const UserScriptSet* static_scripts() const { return &static_scripts_; }
  81
  82  private:
  83   // Map for per-extension sets that may be defined programmatically.
  84   typedef std::map<HostID, linked_ptr<UserScriptSet> > UserScriptSetMap;
  85
  86   // content::RenderProcessObserver implementation.
  87   bool OnControlMessageReceived(const IPC::Message& message) override;
  88
  89   UserScriptSet* GetProgrammaticScriptsByHostID(const HostID& host_id);
  90
  91   // Handle the UpdateUserScripts extension message.
  92   void OnUpdateUserScripts(base::SharedMemoryHandle shared_memory,
  93                            const HostID& host_id,
  94                            const std::set<HostID>& changed_hosts,
  95                            bool whitelisted_only);
  96
  97   // Scripts statically defined in extension manifests.
  98   UserScriptSet static_scripts_;
  99
 100   // Scripts programmatically-defined through API calls (initialized and stored
 101   // per-extension).
 102   UserScriptSetMap programmatic_scripts_;
 103
 104   // The set of all known extensions. Owned by the Dispatcher.
 105   const ExtensionSet* extensions_;
 106
 107   // The associated observers.
 108   base::ObserverList<Observer> observers_;
 109
 110   DISALLOW_COPY_AND_ASSIGN(UserScriptSetManager);
 111 };
 112
 113 }  // namespace extensions
 114
 115 #endif  // EXTENSIONS_RENDERER_USER_SCRIPT_SET_MANAGER_H_