| OLD | NEW |
| 1 // Copyright 2014 The Chromium Authors. All rights reserved. | 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 | 2 // Use of this source code is governed by a BSD-style license that can be |
| 3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
| 4 | 4 |
| 5 #ifndef EXTENSIONS_BROWSER_USER_SCRIPT_LOADER_H_ | 5 #ifndef EXTENSIONS_BROWSER_USER_SCRIPT_LOADER_H_ |
| 6 #define EXTENSIONS_BROWSER_USER_SCRIPT_LOADER_H_ | 6 #define EXTENSIONS_BROWSER_USER_SCRIPT_LOADER_H_ |
| 7 | 7 |
| 8 #include <map> | 8 #include <map> |
| 9 #include <set> | 9 #include <set> |
| 10 | 10 |
| (...skipping 11 matching lines...) Expand all Loading... |
| 22 class SharedMemory; | 22 class SharedMemory; |
| 23 } | 23 } |
| 24 | 24 |
| 25 namespace content { | 25 namespace content { |
| 26 class BrowserContext; | 26 class BrowserContext; |
| 27 class RenderProcessHost; | 27 class RenderProcessHost; |
| 28 } | 28 } |
| 29 | 29 |
| 30 namespace extensions { | 30 namespace extensions { |
| 31 | 31 |
| 32 class ContentVerifier; | |
| 33 | |
| 34 // Manages one "logical unit" of user scripts in shared memory by constructing a | 32 // Manages one "logical unit" of user scripts in shared memory by constructing a |
| 35 // new shared memory region when the set of scripts changes. Also notifies | 33 // new shared memory region when the set of scripts changes. Also notifies |
| 36 // renderers of new shared memory region when new renderers appear, or when | 34 // renderers of new shared memory region when new renderers appear, or when |
| 37 // script reloading completes. Script loading lives on the UI thread. Instances | 35 // script reloading completes. Script loading lives on the UI thread. Instances |
| 38 // of this class are embedded within classes with names ending in | 36 // of this class are embedded within classes with names ending in |
| 39 // UserScriptMaster. These "master" classes implement the strategy for which | 37 // UserScriptMaster. These "master" classes implement the strategy for which |
| 40 // scripts to load/unload on this logical unit of scripts. | 38 // scripts to load/unload on this logical unit of scripts. |
| 41 class UserScriptLoader : public content::NotificationObserver { | 39 class UserScriptLoader : public content::NotificationObserver { |
| 42 public: | 40 public: |
| 43 using PathAndDefaultLocale = std::pair<base::FilePath, std::string>; | 41 using LoadScriptsCallback = |
| 44 using HostsInfo = std::map<HostID, PathAndDefaultLocale>; | 42 base::Callback<void(scoped_ptr<UserScriptList>, |
| 45 | 43 scoped_ptr<base::SharedMemory>)>; |
| 46 using SubstitutionMap = std::map<std::string, std::string>; | |
| 47 using LoadUserScriptsContentFunction = | |
| 48 base::Callback<bool(const HostID&, | |
| 49 UserScript::File*, | |
| 50 const SubstitutionMap*, | |
| 51 const scoped_refptr<ContentVerifier>&)>; | |
| 52 | 44 |
| 53 // Parses the includes out of |script| and returns them in |includes|. | 45 // Parses the includes out of |script| and returns them in |includes|. |
| 54 static bool ParseMetadataHeader(const base::StringPiece& script_text, | 46 static bool ParseMetadataHeader(const base::StringPiece& script_text, |
| 55 UserScript* script); | 47 UserScript* script); |
| 56 | 48 |
| 57 UserScriptLoader(content::BrowserContext* browser_context, | 49 UserScriptLoader(content::BrowserContext* browser_context, |
| 58 const HostID& host_id, | 50 const HostID& host_id); |
| 59 const scoped_refptr<ContentVerifier>& content_verifier); | |
| 60 ~UserScriptLoader() override; | 51 ~UserScriptLoader() override; |
| 61 | 52 |
| 62 // A wrapper around the method to load user scripts, which is normally run on | |
| 63 // the file thread. Exposed only for tests. | |
| 64 void LoadScriptsForTest(UserScriptList* user_scripts); | |
| 65 | |
| 66 // Add |scripts| to the set of scripts managed by this loader. | 53 // Add |scripts| to the set of scripts managed by this loader. |
| 67 void AddScripts(const std::set<UserScript>& scripts); | 54 void AddScripts(const std::set<UserScript>& scripts); |
| 68 | 55 |
| 56 // Add |scripts| to the set of scripts managed by this loader. |
| 57 // The fetch of the content of the script starts URL request |
| 58 // to the associated render specified by |
| 59 // |render_process_id, render_view_id|. |
| 60 // TODO(hanxi): The renderer information doesn't really belong in this base |
| 61 // class, but it's not an easy fix. |
| 62 virtual void AddScripts(const std::set<UserScript>& scripts, |
| 63 int render_process_id, |
| 64 int render_view_id); |
| 65 |
| 69 // Remove |scripts| from the set of scripts managed by this loader. | 66 // Remove |scripts| from the set of scripts managed by this loader. |
| 70 void RemoveScripts(const std::set<UserScript>& scripts); | 67 void RemoveScripts(const std::set<UserScript>& scripts); |
| 71 | 68 |
| 72 // Clears the set of scripts managed by this loader. | 69 // Clears the set of scripts managed by this loader. |
| 73 void ClearScripts(); | 70 void ClearScripts(); |
| 74 | 71 |
| 75 // Initiates procedure to start loading scripts on the file thread. | 72 // Initiates procedure to start loading scripts on the file thread. |
| 76 void StartLoad(); | 73 void StartLoad(); |
| 77 | 74 |
| 78 // Returns true if we have any scripts ready. | 75 // Returns true if we have any scripts ready. |
| 79 bool scripts_ready() const { return shared_memory_.get() != NULL; } | 76 bool scripts_ready() const { return shared_memory_.get() != NULL; } |
| 80 | 77 |
| 78 // Pickle user scripts and return pointer to the shared memory. |
| 79 static scoped_ptr<base::SharedMemory> Serialize( |
| 80 const extensions::UserScriptList& scripts); |
| 81 |
| 81 protected: | 82 protected: |
| 82 // Updates |hosts_info_| to contain info for each element of | 83 // Allows the derived classes have different ways to load user scripts. |
| 83 // |changed_hosts_|. | 84 virtual void LoadScripts(scoped_ptr<UserScriptList> user_scripts, |
| 84 virtual void UpdateHostsInfo(const std::set<HostID>& changed_hosts) = 0; | 85 const std::set<HostID>& changed_hosts, |
| 85 | 86 const std::set<int>& added_script_ids, |
| 86 // Returns a function pointer of a static funcion to load user scripts. | 87 LoadScriptsCallback callback) = 0; |
| 87 // Derived classes can specify their ways to load scripts in the static | |
| 88 // function they return. | |
| 89 // Note: It has to be safe to call multiple times. | |
| 90 virtual LoadUserScriptsContentFunction GetLoadUserScriptsFunction() = 0; | |
| 91 | |
| 92 // Adds the |host_id, location| to the |hosts_info_| map. | |
| 93 // Only inserts the entry to the map when the given host_id doesn't | |
| 94 // exists. | |
| 95 void AddHostInfo(const HostID& host_id, const PathAndDefaultLocale& location); | |
| 96 | |
| 97 // Removes the entries with the given host_id from the |hosts_info_| map. | |
| 98 void RemoveHostInfo(const HostID& host_id); | |
| 99 | 88 |
| 100 // Sets the flag if the initial set of hosts has finished loading; if it's | 89 // Sets the flag if the initial set of hosts has finished loading; if it's |
| 101 // set to be true, calls AttempLoad() to bootstrap. | 90 // set to be true, calls AttempLoad() to bootstrap. |
| 102 void SetReady(bool ready); | 91 void SetReady(bool ready); |
| 103 | 92 |
| 104 content::BrowserContext* browser_context() const { return browser_context_; } | 93 content::BrowserContext* browser_context() const { return browser_context_; } |
| 105 const HostID& host_id() const { return host_id_; } | 94 const HostID& host_id() const { return host_id_; } |
| 106 | 95 |
| 107 private: | 96 private: |
| 108 // content::NotificationObserver implementation. | 97 // content::NotificationObserver implementation. |
| (...skipping 28 matching lines...) Expand all Loading... |
| 137 | 126 |
| 138 // Manages our notification registrations. | 127 // Manages our notification registrations. |
| 139 content::NotificationRegistrar registrar_; | 128 content::NotificationRegistrar registrar_; |
| 140 | 129 |
| 141 // Contains the scripts that were found the last time scripts were updated. | 130 // Contains the scripts that were found the last time scripts were updated. |
| 142 scoped_ptr<base::SharedMemory> shared_memory_; | 131 scoped_ptr<base::SharedMemory> shared_memory_; |
| 143 | 132 |
| 144 // List of scripts from currently-installed extensions we should load. | 133 // List of scripts from currently-installed extensions we should load. |
| 145 scoped_ptr<UserScriptList> user_scripts_; | 134 scoped_ptr<UserScriptList> user_scripts_; |
| 146 | 135 |
| 147 // Maps host info needed for localization to a host ID. | |
| 148 HostsInfo hosts_info_; | |
| 149 | |
| 150 // The mutually-exclusive sets of scripts that were added or removed since the | 136 // The mutually-exclusive sets of scripts that were added or removed since the |
| 151 // last script load. | 137 // last script load. |
| 152 std::set<UserScript> added_scripts_; | 138 std::set<UserScript> added_scripts_; |
| 153 std::set<UserScript> removed_scripts_; | 139 std::set<UserScript> removed_scripts_; |
| 154 | 140 |
| 155 // Indicates whether the the collection of scripts should be cleared before | 141 // Indicates whether the the collection of scripts should be cleared before |
| 156 // additions and removals on the next script load. | 142 // additions and removals on the next script load. |
| 157 bool clear_scripts_; | 143 bool clear_scripts_; |
| 158 | 144 |
| 159 // The IDs of the extensions which changed in the last update sent to the | 145 // The IDs of the extensions which changed in the last update sent to the |
| (...skipping 11 matching lines...) Expand all Loading... |
| 171 // Whether or not we are currently loading. | 157 // Whether or not we are currently loading. |
| 172 bool is_loading_; | 158 bool is_loading_; |
| 173 | 159 |
| 174 // The browser_context for which the scripts managed here are installed. | 160 // The browser_context for which the scripts managed here are installed. |
| 175 content::BrowserContext* browser_context_; | 161 content::BrowserContext* browser_context_; |
| 176 | 162 |
| 177 // ID of the host that owns these scripts, if any. This is only set to a | 163 // ID of the host that owns these scripts, if any. This is only set to a |
| 178 // non-empty value for declarative user script shared memory regions. | 164 // non-empty value for declarative user script shared memory regions. |
| 179 HostID host_id_; | 165 HostID host_id_; |
| 180 | 166 |
| 181 // Manages content verification of the loaded user scripts. | |
| 182 scoped_refptr<ContentVerifier> content_verifier_; | |
| 183 | |
| 184 base::WeakPtrFactory<UserScriptLoader> weak_factory_; | 167 base::WeakPtrFactory<UserScriptLoader> weak_factory_; |
| 185 | 168 |
| 186 DISALLOW_COPY_AND_ASSIGN(UserScriptLoader); | 169 DISALLOW_COPY_AND_ASSIGN(UserScriptLoader); |
| 187 }; | 170 }; |
| 188 | 171 |
| 189 } // namespace extensions | 172 } // namespace extensions |
| 190 | 173 |
| 191 #endif // EXTENSIONS_BROWSER_USER_SCRIPT_LOADER_H_ | 174 #endif // EXTENSIONS_BROWSER_USER_SCRIPT_LOADER_H_ |
| OLD | NEW |