extensions/renderer/user_script_set.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_H_
   6 #define EXTENSIONS_RENDERER_USER_SCRIPT_SET_H_
   7
   8 #include <set>
   9 #include <string>
  10
  11 #include "base/basictypes.h"
  12 #include "base/macros.h"
  13 #include "base/memory/scoped_ptr.h"
  14 #include "base/memory/scoped_vector.h"
  15 #include "base/memory/shared_memory.h"
  16 #include "base/observer_list.h"
  17 #include "content/public/renderer/render_process_observer.h"
  18 #include "extensions/common/user_script.h"
  19
  20 class GURL;
  21
  22 namespace blink {
  23 class WebFrame;
  24 }
  25
  26 namespace extensions {
  27 class Extension;
  28 class ExtensionSet;
  29 class ScriptInjection;
  30
  31 // The UserScriptSet is a collection of UserScripts which knows how to update
  32 // itself from SharedMemory and create ScriptInjections for UserScripts to
  33 // inject on a page.
  34 class UserScriptSet {
  35  public:
  36   class Observer {
  37    public:
  38     virtual void OnUserScriptsUpdated(
  39         const std::set<std::string>& changed_extensions,
  40         const std::vector<UserScript*>& scripts) = 0;
  41   };
  42
  43   explicit UserScriptSet(const ExtensionSet* extensions);
  44   ~UserScriptSet();
  45
  46   // Adds or removes observers.
  47   void AddObserver(Observer* observer);
  48   void RemoveObserver(Observer* observer);
  49
  50   // Appends the ids of the extensions that have user scripts to |ids|.
  51   void GetActiveExtensionIds(std::set<std::string>* ids) const;
  52
  53   // Populate |injections| with any ScriptInjections that should run on the
  54   // given |web_frame| and |tab_id|, at the given |run_location|.
  55   // |extensions| is passed in to verify the corresponding extension is still
  56   // valid.
  57   void GetInjections(ScopedVector<ScriptInjection>* injections,
  58                      blink::WebFrame* web_frame,
  59                      int tab_id,
  60                      UserScript::RunLocation run_location);
  61
  62   scoped_ptr<ScriptInjection> GetDeclarativeScriptInjection(
  63       int script_id,
  64       blink::WebFrame* web_frame,
  65       int tab_id,
  66       UserScript::RunLocation run_location,
  67       const GURL& document_url,
  68       const Extension* extension);
  69
  70   // Updates scripts given the shared memory region containing user scripts.
  71   // Returns true if the scripts were successfully updated.
  72   bool UpdateUserScripts(base::SharedMemoryHandle shared_memory,
  73                          const std::set<std::string>& changed_extensions);
  74
  75   const std::vector<UserScript*>& scripts() const { return scripts_.get(); }
  76
  77  private:
  78   // Returns a new ScriptInjection for the given |script| to execute in the
  79   // |web_frame|, or NULL if the script should not execute.
  80   scoped_ptr<ScriptInjection> GetInjectionForScript(
  81       UserScript* script,
  82       blink::WebFrame* web_frame,
  83       int tab_id,
  84       UserScript::RunLocation run_location,
  85       const GURL& document_url,
  86       const Extension* extension,
  87       bool is_declarative);
  88
  89   // Shared memory containing raw script data.
  90   scoped_ptr<base::SharedMemory> shared_memory_;
  91
  92   // The set of all known extensions. Owned by the Dispatcher.
  93   const ExtensionSet* extensions_;
  94
  95   // The UserScripts this injector manages.
  96   ScopedVector<UserScript> scripts_;
  97
  98   // The associated observers.
  99   ObserverList<Observer> observers_;
 100
 101   DISALLOW_COPY_AND_ASSIGN(UserScriptSet);
 102 };
 103
 104 }  // namespace extensions
 105
 106 #endif  // EXTENSIONS_RENDERER_USER_SCRIPT_SET_H_