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 26 matching lines...) Expand all Loading... | |
37 // script reloading completes. Script loading lives on the UI thread. Instances | 37 // script reloading completes. Script loading lives on the UI thread. Instances |
38 // of this class are embedded within classes with names ending in | 38 // of this class are embedded within classes with names ending in |
39 // UserScriptMaster. These "master" classes implement the strategy for which | 39 // UserScriptMaster. These "master" classes implement the strategy for which |
40 // scripts to load/unload on this logical unit of scripts. | 40 // scripts to load/unload on this logical unit of scripts. |
41 class UserScriptLoader : public content::NotificationObserver { | 41 class UserScriptLoader : public content::NotificationObserver { |
42 public: | 42 public: |
43 using PathAndDefaultLocale = std::pair<base::FilePath, std::string>; | 43 using PathAndDefaultLocale = std::pair<base::FilePath, std::string>; |
44 using HostsInfo = std::map<HostID, PathAndDefaultLocale>; | 44 using HostsInfo = std::map<HostID, PathAndDefaultLocale>; |
45 | 45 |
46 using SubstitutionMap = std::map<std::string, std::string>; | 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 | 47 |
53 // Parses the includes out of |script| and returns them in |includes|. | 48 // Parses the includes out of |script| and returns them in |includes|. |
54 static bool ParseMetadataHeader(const base::StringPiece& script_text, | 49 static bool ParseMetadataHeader(const base::StringPiece& script_text, |
55 UserScript* script); | 50 UserScript* script); |
56 | 51 |
57 UserScriptLoader(content::BrowserContext* browser_context, | 52 UserScriptLoader(content::BrowserContext* browser_context, |
58 const HostID& host_id, | 53 const HostID& host_id); |
59 const scoped_refptr<ContentVerifier>& content_verifier); | |
60 ~UserScriptLoader() override; | 54 ~UserScriptLoader() override; |
61 | 55 |
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. | 56 // Add |scripts| to the set of scripts managed by this loader. |
67 void AddScripts(const std::set<UserScript>& scripts); | 57 void AddScripts(const std::set<UserScript>& scripts); |
68 | 58 |
59 // Add |scripts| to the set of scripts managed by this loader. | |
60 // The fetch of the content of the script starts URL request | |
61 // to the associated render specified by | |
62 // |render_process_id, render_view_id|. | |
63 virtual void AddScripts(const std::set<UserScript>& scripts, | |
64 int render_process_id, | |
65 int render_view_id); | |
66 | |
69 // Remove |scripts| from the set of scripts managed by this loader. | 67 // Remove |scripts| from the set of scripts managed by this loader. |
70 void RemoveScripts(const std::set<UserScript>& scripts); | 68 void RemoveScripts(const std::set<UserScript>& scripts); |
71 | 69 |
72 // Clears the set of scripts managed by this loader. | 70 // Clears the set of scripts managed by this loader. |
73 void ClearScripts(); | 71 // If |is_clear| is true, will attempt to load scripts. |
72 void ClearScripts(bool is_clear); | |
Devlin
2015/04/20 23:48:25
Do we still need this bool?
Xi Han
2015/04/21 21:18:58
Yes, it is also called by DeclarativeUserScriptMas
| |
74 | 73 |
75 // Initiates procedure to start loading scripts on the file thread. | 74 // Initiates procedure to start loading scripts on the file thread. |
76 void StartLoad(); | 75 void StartLoad(); |
77 | 76 |
78 // Returns true if we have any scripts ready. | 77 // Returns true if we have any scripts ready. |
79 bool scripts_ready() const { return shared_memory_.get() != NULL; } | 78 bool scripts_ready() const { return shared_memory_.get() != NULL; } |
80 | 79 |
80 // Pickle user scripts and return pointer to the shared memory. | |
81 static scoped_ptr<base::SharedMemory> Serialize( | |
82 const extensions::UserScriptList& scripts); | |
83 | |
81 protected: | 84 protected: |
82 // Updates |hosts_info_| to contain info for each element of | 85 // Allows the derived classes have different ways to load user scripts. |
83 // |changed_hosts_|. | 86 virtual void LoadScripts(const std::set<HostID>& changed_hosts, |
84 virtual void UpdateHostsInfo(const std::set<HostID>& changed_hosts) = 0; | 87 const std::set<int>& added_script_ids) = 0; |
85 | |
86 // Returns a function pointer of a static funcion to load user scripts. | |
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 |
93 // Called once we have finished loading the scripts on the file thread. | |
94 void OnScriptsLoaded(scoped_ptr<UserScriptList> user_scripts, | |
95 scoped_ptr<base::SharedMemory> shared_memory); | |
96 | |
104 content::BrowserContext* browser_context() const { return browser_context_; } | 97 content::BrowserContext* browser_context() const { return browser_context_; } |
105 const HostID& host_id() const { return host_id_; } | 98 const HostID& host_id() const { return host_id_; } |
106 | 99 |
100 // List of scripts from currently-installed extensions we should load. | |
101 scoped_ptr<UserScriptList> user_scripts_; | |
102 | |
107 private: | 103 private: |
108 // content::NotificationObserver implementation. | 104 // content::NotificationObserver implementation. |
109 void Observe(int type, | 105 void Observe(int type, |
110 const content::NotificationSource& source, | 106 const content::NotificationSource& source, |
111 const content::NotificationDetails& details) override; | 107 const content::NotificationDetails& details) override; |
112 | 108 |
113 // Returns whether or not it is possible that calls to AddScripts(), | 109 // Returns whether or not it is possible that calls to AddScripts(), |
114 // RemoveScripts(), and/or ClearScripts() have caused any real change in the | 110 // RemoveScripts(), and/or ClearScripts() have caused any real change in the |
115 // set of scripts to be loaded. | 111 // set of scripts to be loaded. |
116 bool ScriptsMayHaveChanged() const; | 112 bool ScriptsMayHaveChanged() const; |
117 | 113 |
118 // Attempts to initiate a load. | 114 // Attempts to initiate a load. |
119 void AttemptLoad(); | 115 void AttemptLoad(); |
120 | 116 |
121 // Called once we have finished loading the scripts on the file thread. | |
122 void OnScriptsLoaded(scoped_ptr<UserScriptList> user_scripts, | |
123 scoped_ptr<base::SharedMemory> shared_memory); | |
124 | |
125 // Sends the renderer process a new set of user scripts. If | 117 // Sends the renderer process a new set of user scripts. If |
126 // |changed_hosts| is not empty, this signals that only the scripts from | 118 // |changed_hosts| is not empty, this signals that only the scripts from |
127 // those hosts should be updated. Otherwise, all hosts will be | 119 // those hosts should be updated. Otherwise, all hosts will be |
128 // updated. | 120 // updated. |
129 void SendUpdate(content::RenderProcessHost* process, | 121 void SendUpdate(content::RenderProcessHost* process, |
130 base::SharedMemory* shared_memory, | 122 base::SharedMemory* shared_memory, |
131 const std::set<HostID>& changed_hosts); | 123 const std::set<HostID>& changed_hosts); |
132 | 124 |
133 bool is_loading() const { | 125 bool is_loading() const { |
134 // Ownership of |user_scripts_| is passed to the file thread when loading. | 126 // Ownership of |user_scripts_| is passed to the file thread when loading. |
135 return user_scripts_.get() == NULL; | 127 return user_scripts_.get() == NULL; |
136 } | 128 } |
137 | 129 |
138 // Manages our notification registrations. | 130 // Manages our notification registrations. |
139 content::NotificationRegistrar registrar_; | 131 content::NotificationRegistrar registrar_; |
140 | 132 |
141 // Contains the scripts that were found the last time scripts were updated. | 133 // Contains the scripts that were found the last time scripts were updated. |
142 scoped_ptr<base::SharedMemory> shared_memory_; | 134 scoped_ptr<base::SharedMemory> shared_memory_; |
143 | 135 |
144 // List of scripts from currently-installed extensions we should load. | |
145 scoped_ptr<UserScriptList> user_scripts_; | |
146 | |
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_; | |
185 | |
186 DISALLOW_COPY_AND_ASSIGN(UserScriptLoader); | 167 DISALLOW_COPY_AND_ASSIGN(UserScriptLoader); |
187 }; | 168 }; |
188 | 169 |
189 } // namespace extensions | 170 } // namespace extensions |
190 | 171 |
191 #endif // EXTENSIONS_BROWSER_USER_SCRIPT_LOADER_H_ | 172 #endif // EXTENSIONS_BROWSER_USER_SCRIPT_LOADER_H_ |
OLD | NEW |