OLD | NEW |
---|---|
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2012 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 CHROME_BROWSER_NET_HTTP_SERVER_PROPERTIES_MANAGER_H_ | 5 #ifndef CHROME_BROWSER_NET_HTTP_SERVER_PROPERTIES_MANAGER_H_ |
6 #define CHROME_BROWSER_NET_HTTP_SERVER_PROPERTIES_MANAGER_H_ | 6 #define CHROME_BROWSER_NET_HTTP_SERVER_PROPERTIES_MANAGER_H_ |
7 | 7 |
8 #include <string> | 8 #include <string> |
9 #include <vector> | 9 #include <vector> |
10 #include "base/basictypes.h" | 10 #include "base/basictypes.h" |
11 #include "base/compiler_specific.h" | 11 #include "base/compiler_specific.h" |
12 #include "base/memory/scoped_ptr.h" | 12 #include "base/memory/scoped_ptr.h" |
13 #include "base/memory/weak_ptr.h" | 13 #include "base/memory/weak_ptr.h" |
14 #include "base/prefs/pref_change_registrar.h" | 14 #include "base/prefs/pref_change_registrar.h" |
15 #include "base/timer/timer.h" | 15 #include "base/timer/timer.h" |
16 #include "base/values.h" | 16 #include "base/values.h" |
17 #include "net/base/host_port_pair.h" | 17 #include "net/base/host_port_pair.h" |
18 #include "net/http/http_server_properties.h" | 18 #include "net/http/http_server_properties.h" |
19 #include "net/http/http_server_properties_impl.h" | 19 #include "net/http/http_server_properties_impl.h" |
20 | 20 |
21 class PrefService; | 21 class PrefService; |
22 | 22 |
23 namespace user_prefs { | 23 namespace base { |
24 class PrefRegistrySyncable; | 24 class SingleThreadTaskRunner; |
25 } | 25 } |
26 | 26 |
27 namespace chrome_browser_net { | 27 namespace net { |
28 | 28 |
29 //////////////////////////////////////////////////////////////////////////////// | 29 //////////////////////////////////////////////////////////////////////////////// |
30 // HttpServerPropertiesManager | 30 // HttpServerPropertiesManager |
31 | 31 |
32 // The manager for creating and updating an HttpServerProperties (for example it | 32 // The manager for creating and updating an HttpServerProperties (for example it |
33 // tracks if a server supports SPDY or not). | 33 // tracks if a server supports SPDY or not). |
34 // | 34 // |
35 // This class interacts with both the UI thread, where notifications of pref | 35 // This class interacts with both the UI thread, where notifications of pref |
36 // changes are received from, and the IO thread, which owns it (in the | 36 // changes are received from, and the IO thread, which owns it (in the |
37 // ProfileIOData) and it persists the changes from network stack that if a | 37 // ProfileIOData) and it persists the changes from network stack that if a |
38 // server supports SPDY or not. | 38 // server supports SPDY or not. |
39 // | 39 // |
40 // It must be constructed on the UI thread, to set up |ui_method_factory_| and | 40 // It must be constructed on the UI thread, to set up |ui_method_factory_| and |
mmenke
2014/07/08 15:05:48
ui_method_factory_?
mef
2014/07/08 18:04:32
Done.
| |
41 // the prefs listeners. | 41 // the prefs listeners. |
42 // | 42 // |
43 // ShutdownOnUIThread must be called from UI before destruction, to release | 43 // ShutdownOnUIThread must be called from UI before destruction, to release |
44 // the prefs listeners on the UI thread. This is done from ProfileIOData. | 44 // the prefs listeners on the UI thread. This is done from ProfileIOData. |
45 // | 45 // |
46 // Update tasks from the UI thread can post safely to the IO thread, since the | 46 // Update tasks from the UI thread can post safely to the IO thread, since the |
47 // destruction order of Profile and ProfileIOData guarantees that if this | 47 // destruction order of Profile and ProfileIOData guarantees that if this |
mmenke
2014/07/08 15:05:48
net/ shouldn't know about Profile, ProfileIOData,
mef
2014/07/08 18:04:32
Done.
| |
48 // exists in UI, then a potential destruction on IO will come after any task | 48 // exists in UI, then a potential destruction on IO will come after any task |
49 // posted to IO from that method on UI. This is used to go through IO before | 49 // posted to IO from that method on UI. This is used to go through IO before |
50 // the actual update starts, and grab a WeakPtr. | 50 // the actual update starts, and grab a WeakPtr. |
51 class HttpServerPropertiesManager | 51 class NET_EXPORT HttpServerPropertiesManager |
52 : public net::HttpServerProperties { | 52 : public HttpServerProperties { |
53 public: | 53 public: |
54 // Create an instance of the HttpServerPropertiesManager. The lifetime of the | 54 // Create an instance of the HttpServerPropertiesManager. The lifetime of the |
55 // PrefService objects must be longer than that of the | 55 // PrefService objects must be longer than that of the |
56 // HttpServerPropertiesManager object. Must be constructed on the UI thread. | 56 // HttpServerPropertiesManager object. Must be constructed on the UI thread. |
57 explicit HttpServerPropertiesManager(PrefService* pref_service); | 57 HttpServerPropertiesManager( |
58 PrefService* pref_service, | |
59 const char* path, | |
mmenke
2014/07/08 15:05:48
I don't think it's clear that path is the preferen
mef
2014/07/08 18:04:32
Done.
| |
60 scoped_refptr<base::SingleThreadTaskRunner> ui_task_runner, | |
61 scoped_refptr<base::SingleThreadTaskRunner> io_task_runner); | |
mmenke
2014/07/08 15:05:48
net/ shouldn't know (or care) what a UI thread is.
mef
2014/07/08 18:04:32
Done. As we don't want this class to know about pr
| |
58 virtual ~HttpServerPropertiesManager(); | 62 virtual ~HttpServerPropertiesManager(); |
59 | 63 |
60 // Initialize |http_server_properties_impl_| and |io_method_factory_| on IO | 64 // Initialize |http_server_properties_impl_| and |io_method_factory_| on IO |
61 // thread. It also posts a task to UI thread to get SPDY Server preferences | 65 // thread. It also posts a task to UI thread to get SPDY Server preferences |
62 // from |pref_service_|. | 66 // from |pref_service_|. |
63 void InitializeOnIOThread(); | 67 void InitializeOnIOThread(); |
64 | 68 |
65 // Prepare for shutdown. Must be called on the UI thread, before destruction. | 69 // Prepare for shutdown. Must be called on the UI thread, before destruction. |
66 void ShutdownOnUIThread(); | 70 void ShutdownOnUIThread(); |
67 | 71 |
68 // Register |prefs| for properties managed here. | |
69 static void RegisterProfilePrefs(user_prefs::PrefRegistrySyncable* registry); | |
70 | |
71 // Helper function for unit tests to set the version in the dictionary. | 72 // Helper function for unit tests to set the version in the dictionary. |
72 static void SetVersion(base::DictionaryValue* http_server_properties_dict, | 73 static void SetVersion(base::DictionaryValue* http_server_properties_dict, |
73 int version_number); | 74 int version_number); |
74 | 75 |
75 // Deletes all data. Works asynchronously, but if a |completion| callback is | 76 // Deletes all data. Works asynchronously, but if a |completion| callback is |
76 // provided, it will be fired on the UI thread when everything is done. | 77 // provided, it will be fired on the UI thread when everything is done. |
77 void Clear(const base::Closure& completion); | 78 void Clear(const base::Closure& completion); |
78 | 79 |
79 // ---------------------------------- | 80 // ---------------------------------- |
80 // net::HttpServerProperties methods: | 81 // HttpServerProperties methods: |
81 // ---------------------------------- | 82 // ---------------------------------- |
82 | 83 |
83 // Gets a weak pointer for this object. | 84 // Gets a weak pointer for this object. |
84 virtual base::WeakPtr<net::HttpServerProperties> GetWeakPtr() OVERRIDE; | 85 virtual base::WeakPtr<HttpServerProperties> GetWeakPtr() OVERRIDE; |
85 | 86 |
86 // Deletes all data. Works asynchronously. | 87 // Deletes all data. Works asynchronously. |
87 virtual void Clear() OVERRIDE; | 88 virtual void Clear() OVERRIDE; |
88 | 89 |
89 // Returns true if |server| supports SPDY. Should only be called from IO | 90 // Returns true if |server| supports SPDY. Should only be called from IO |
90 // thread. | 91 // thread. |
91 virtual bool SupportsSpdy(const net::HostPortPair& server) OVERRIDE; | 92 virtual bool SupportsSpdy(const HostPortPair& server) OVERRIDE; |
92 | 93 |
93 // Add |server| as the SPDY server which supports SPDY protocol into the | 94 // Add |server| as the SPDY server which supports SPDY protocol into the |
94 // persisitent store. Should only be called from IO thread. | 95 // persisitent store. Should only be called from IO thread. |
95 virtual void SetSupportsSpdy(const net::HostPortPair& server, | 96 virtual void SetSupportsSpdy(const HostPortPair& server, |
96 bool support_spdy) OVERRIDE; | 97 bool support_spdy) OVERRIDE; |
97 | 98 |
98 // Returns true if |server| has an Alternate-Protocol header. | 99 // Returns true if |server| has an Alternate-Protocol header. |
99 virtual bool HasAlternateProtocol(const net::HostPortPair& server) OVERRIDE; | 100 virtual bool HasAlternateProtocol(const HostPortPair& server) OVERRIDE; |
100 | 101 |
101 // Returns the Alternate-Protocol and port for |server|. | 102 // Returns the Alternate-Protocol and port for |server|. |
102 // HasAlternateProtocol(server) must be true. | 103 // HasAlternateProtocol(server) must be true. |
103 virtual net::PortAlternateProtocolPair GetAlternateProtocol( | 104 virtual PortAlternateProtocolPair GetAlternateProtocol( |
104 const net::HostPortPair& server) OVERRIDE; | 105 const HostPortPair& server) OVERRIDE; |
105 | 106 |
106 // Sets the Alternate-Protocol for |server|. | 107 // Sets the Alternate-Protocol for |server|. |
107 virtual void SetAlternateProtocol( | 108 virtual void SetAlternateProtocol( |
108 const net::HostPortPair& server, | 109 const HostPortPair& server, |
109 uint16 alternate_port, | 110 uint16 alternate_port, |
110 net::AlternateProtocol alternate_protocol) OVERRIDE; | 111 AlternateProtocol alternate_protocol) OVERRIDE; |
111 | 112 |
112 // Sets the Alternate-Protocol for |server| to be BROKEN. | 113 // Sets the Alternate-Protocol for |server| to be BROKEN. |
113 virtual void SetBrokenAlternateProtocol( | 114 virtual void SetBrokenAlternateProtocol( |
114 const net::HostPortPair& server) OVERRIDE; | 115 const HostPortPair& server) OVERRIDE; |
115 | 116 |
116 // Returns true if Alternate-Protocol for |server| was recently BROKEN. | 117 // Returns true if Alternate-Protocol for |server| was recently BROKEN. |
117 virtual bool WasAlternateProtocolRecentlyBroken( | 118 virtual bool WasAlternateProtocolRecentlyBroken( |
118 const net::HostPortPair& server) OVERRIDE; | 119 const HostPortPair& server) OVERRIDE; |
119 | 120 |
120 // Confirms that Alternate-Protocol for |server| is working. | 121 // Confirms that Alternate-Protocol for |server| is working. |
121 virtual void ConfirmAlternateProtocol( | 122 virtual void ConfirmAlternateProtocol( |
122 const net::HostPortPair& server) OVERRIDE; | 123 const HostPortPair& server) OVERRIDE; |
123 | 124 |
124 // Clears the Alternate-Protocol for |server|. | 125 // Clears the Alternate-Protocol for |server|. |
125 virtual void ClearAlternateProtocol(const net::HostPortPair& server) OVERRIDE; | 126 virtual void ClearAlternateProtocol(const HostPortPair& server) OVERRIDE; |
126 | 127 |
127 // Returns all Alternate-Protocol mappings. | 128 // Returns all Alternate-Protocol mappings. |
128 virtual const net::AlternateProtocolMap& | 129 virtual const AlternateProtocolMap& |
129 alternate_protocol_map() const OVERRIDE; | 130 alternate_protocol_map() const OVERRIDE; |
130 | 131 |
131 virtual void SetAlternateProtocolExperiment( | 132 virtual void SetAlternateProtocolExperiment( |
132 net::AlternateProtocolExperiment experiment) OVERRIDE; | 133 AlternateProtocolExperiment experiment) OVERRIDE; |
133 | 134 |
134 virtual net::AlternateProtocolExperiment GetAlternateProtocolExperiment() | 135 virtual AlternateProtocolExperiment GetAlternateProtocolExperiment() |
135 const OVERRIDE; | 136 const OVERRIDE; |
136 | 137 |
137 // Gets a reference to the SettingsMap stored for a host. | 138 // Gets a reference to the SettingsMap stored for a host. |
138 // If no settings are stored, returns an empty SettingsMap. | 139 // If no settings are stored, returns an empty SettingsMap. |
139 virtual const net::SettingsMap& GetSpdySettings( | 140 virtual const SettingsMap& GetSpdySettings( |
140 const net::HostPortPair& host_port_pair) OVERRIDE; | 141 const HostPortPair& host_port_pair) OVERRIDE; |
141 | 142 |
142 // Saves an individual SPDY setting for a host. Returns true if SPDY setting | 143 // Saves an individual SPDY setting for a host. Returns true if SPDY setting |
143 // is to be persisted. | 144 // is to be persisted. |
144 virtual bool SetSpdySetting(const net::HostPortPair& host_port_pair, | 145 virtual bool SetSpdySetting(const HostPortPair& host_port_pair, |
145 net::SpdySettingsIds id, | 146 SpdySettingsIds id, |
146 net::SpdySettingsFlags flags, | 147 SpdySettingsFlags flags, |
147 uint32 value) OVERRIDE; | 148 uint32 value) OVERRIDE; |
148 | 149 |
149 // Clears all SPDY settings for a host. | 150 // Clears all SPDY settings for a host. |
150 virtual void ClearSpdySettings( | 151 virtual void ClearSpdySettings( |
151 const net::HostPortPair& host_port_pair) OVERRIDE; | 152 const HostPortPair& host_port_pair) OVERRIDE; |
152 | 153 |
153 // Clears all SPDY settings for all hosts. | 154 // Clears all SPDY settings for all hosts. |
154 virtual void ClearAllSpdySettings() OVERRIDE; | 155 virtual void ClearAllSpdySettings() OVERRIDE; |
155 | 156 |
156 // Returns all SPDY persistent settings. | 157 // Returns all SPDY persistent settings. |
157 virtual const net::SpdySettingsMap& spdy_settings_map() const OVERRIDE; | 158 virtual const SpdySettingsMap& spdy_settings_map() const OVERRIDE; |
158 | 159 |
159 virtual void SetServerNetworkStats(const net::HostPortPair& host_port_pair, | 160 virtual void SetServerNetworkStats(const HostPortPair& host_port_pair, |
160 NetworkStats stats) OVERRIDE; | 161 NetworkStats stats) OVERRIDE; |
161 | 162 |
162 virtual const NetworkStats* GetServerNetworkStats( | 163 virtual const NetworkStats* GetServerNetworkStats( |
163 const net::HostPortPair& host_port_pair) const OVERRIDE; | 164 const HostPortPair& host_port_pair) const OVERRIDE; |
164 | 165 |
165 protected: | 166 protected: |
166 // -------------------- | 167 // -------------------- |
167 // SPDY related methods | 168 // SPDY related methods |
168 | 169 |
169 // These are used to delay updating of the cached data in | 170 // These are used to delay updating of the cached data in |
170 // |http_server_properties_impl_| while the preferences are changing, and | 171 // |http_server_properties_impl_| while the preferences are changing, and |
171 // execute only one update per simultaneous prefs changes. | 172 // execute only one update per simultaneous prefs changes. |
172 void ScheduleUpdateCacheOnUI(); | 173 void ScheduleUpdateCacheOnUI(); |
173 | 174 |
174 // Starts the timers to update the cached prefs. This are overridden in tests | 175 // Starts the timers to update the cached prefs. This are overridden in tests |
175 // to prevent the delay. | 176 // to prevent the delay. |
176 virtual void StartCacheUpdateTimerOnUI(base::TimeDelta delay); | 177 virtual void StartCacheUpdateTimerOnUI(base::TimeDelta delay); |
177 | 178 |
178 // Update cached prefs in |http_server_properties_impl_| with data from | 179 // Update cached prefs in |http_server_properties_impl_| with data from |
179 // preferences. It gets the data on UI thread and calls | 180 // preferences. It gets the data on UI thread and calls |
180 // UpdateSpdyServersFromPrefsOnIO() to perform the update on IO thread. | 181 // UpdateSpdyServersFromPrefsOnIO() to perform the update on IO thread. |
181 virtual void UpdateCacheFromPrefsOnUI(); | 182 virtual void UpdateCacheFromPrefsOnUI(); |
182 | 183 |
183 // Starts the update of cached prefs in |http_server_properties_impl_| on the | 184 // Starts the update of cached prefs in |http_server_properties_impl_| on the |
184 // IO thread. Protected for testing. | 185 // IO thread. Protected for testing. |
185 void UpdateCacheFromPrefsOnIO( | 186 void UpdateCacheFromPrefsOnIO( |
186 std::vector<std::string>* spdy_servers, | 187 std::vector<std::string>* spdy_servers, |
187 net::SpdySettingsMap* spdy_settings_map, | 188 SpdySettingsMap* spdy_settings_map, |
188 net::AlternateProtocolMap* alternate_protocol_map, | 189 AlternateProtocolMap* alternate_protocol_map, |
189 net::AlternateProtocolExperiment alternate_protocol_experiment, | 190 AlternateProtocolExperiment alternate_protocol_experiment, |
190 bool detected_corrupted_prefs); | 191 bool detected_corrupted_prefs); |
191 | 192 |
192 // These are used to delay updating the preferences when cached data in | 193 // These are used to delay updating the preferences when cached data in |
193 // |http_server_properties_impl_| is changing, and execute only one update per | 194 // |http_server_properties_impl_| is changing, and execute only one update per |
194 // simultaneous spdy_servers or spdy_settings or alternate_protocol changes. | 195 // simultaneous spdy_servers or spdy_settings or alternate_protocol changes. |
195 void ScheduleUpdatePrefsOnIO(); | 196 void ScheduleUpdatePrefsOnIO(); |
196 | 197 |
197 // Starts the timers to update the prefs from cache. This are overridden in | 198 // Starts the timers to update the prefs from cache. This are overridden in |
198 // tests to prevent the delay. | 199 // tests to prevent the delay. |
199 virtual void StartPrefsUpdateTimerOnIO(base::TimeDelta delay); | 200 virtual void StartPrefsUpdateTimerOnIO(base::TimeDelta delay); |
200 | 201 |
201 // Update prefs::kHttpServerProperties in preferences with the cached data | 202 // Update prefs::kHttpServerProperties in preferences with the cached data |
202 // from |http_server_properties_impl_|. This gets the data on IO thread and | 203 // from |http_server_properties_impl_|. This gets the data on IO thread and |
203 // posts a task (UpdatePrefsOnUI) to update the preferences UI thread. | 204 // posts a task (UpdatePrefsOnUI) to update the preferences UI thread. |
204 void UpdatePrefsFromCacheOnIO(); | 205 void UpdatePrefsFromCacheOnIO(); |
205 | 206 |
206 // Same as above, but fires an optional |completion| callback on the UI thread | 207 // Same as above, but fires an optional |completion| callback on the UI thread |
207 // when finished. Virtual for testing. | 208 // when finished. Virtual for testing. |
208 virtual void UpdatePrefsFromCacheOnIO(const base::Closure& completion); | 209 virtual void UpdatePrefsFromCacheOnIO(const base::Closure& completion); |
209 | 210 |
210 // Update prefs::kHttpServerProperties preferences on UI thread. Executes an | 211 // Update prefs::kHttpServerProperties preferences on UI thread. Executes an |
211 // optional |completion| callback when finished. Protected for testing. | 212 // optional |completion| callback when finished. Protected for testing. |
212 void UpdatePrefsOnUI( | 213 void UpdatePrefsOnUI( |
213 base::ListValue* spdy_server_list, | 214 base::ListValue* spdy_server_list, |
214 net::SpdySettingsMap* spdy_settings_map, | 215 SpdySettingsMap* spdy_settings_map, |
215 net::AlternateProtocolMap* alternate_protocol_map, | 216 AlternateProtocolMap* alternate_protocol_map, |
216 const base::Closure& completion); | 217 const base::Closure& completion); |
217 | 218 |
218 private: | 219 private: |
219 void OnHttpServerPropertiesChanged(); | 220 void OnHttpServerPropertiesChanged(); |
220 | 221 |
221 // --------- | 222 // --------- |
222 // UI thread | 223 // UI thread |
223 // --------- | 224 // --------- |
224 | 225 |
226 const scoped_refptr<base::SingleThreadTaskRunner> ui_task_runner_; | |
227 | |
225 // Used to get |weak_ptr_| to self on the UI thread. | 228 // Used to get |weak_ptr_| to self on the UI thread. |
226 scoped_ptr<base::WeakPtrFactory<HttpServerPropertiesManager> > | 229 scoped_ptr<base::WeakPtrFactory<HttpServerPropertiesManager> > |
227 ui_weak_ptr_factory_; | 230 ui_weak_ptr_factory_; |
228 | 231 |
229 base::WeakPtr<HttpServerPropertiesManager> ui_weak_ptr_; | 232 base::WeakPtr<HttpServerPropertiesManager> ui_weak_ptr_; |
230 | 233 |
231 // Used to post cache update tasks. | 234 // Used to post cache update tasks. |
232 scoped_ptr<base::OneShotTimer<HttpServerPropertiesManager> > | 235 scoped_ptr<base::OneShotTimer<HttpServerPropertiesManager> > |
233 ui_cache_update_timer_; | 236 ui_cache_update_timer_; |
234 | 237 |
235 // Used to track the spdy servers changes. | 238 // Used to track the spdy servers changes. |
236 PrefChangeRegistrar pref_change_registrar_; | 239 PrefChangeRegistrar pref_change_registrar_; |
237 PrefService* pref_service_; // Weak. | 240 PrefService* pref_service_; // Weak. |
238 bool setting_prefs_; | 241 bool setting_prefs_; |
242 const char* path_; | |
239 | 243 |
240 // --------- | 244 // --------- |
241 // IO thread | 245 // IO thread |
242 // --------- | 246 // --------- |
243 | 247 |
248 const scoped_refptr<base::SingleThreadTaskRunner> io_task_runner_; | |
249 | |
244 // Used to get |weak_ptr_| to self on the IO thread. | 250 // Used to get |weak_ptr_| to self on the IO thread. |
245 scoped_ptr<base::WeakPtrFactory<HttpServerPropertiesManager> > | 251 scoped_ptr<base::WeakPtrFactory<HttpServerPropertiesManager> > |
246 io_weak_ptr_factory_; | 252 io_weak_ptr_factory_; |
247 | 253 |
248 // Used to post |prefs::kHttpServerProperties| pref update tasks. | 254 // Used to post |prefs::kHttpServerProperties| pref update tasks. |
249 scoped_ptr<base::OneShotTimer<HttpServerPropertiesManager> > | 255 scoped_ptr<base::OneShotTimer<HttpServerPropertiesManager> > |
250 io_prefs_update_timer_; | 256 io_prefs_update_timer_; |
251 | 257 |
252 scoped_ptr<net::HttpServerPropertiesImpl> http_server_properties_impl_; | 258 scoped_ptr<HttpServerPropertiesImpl> http_server_properties_impl_; |
253 | 259 |
254 DISALLOW_COPY_AND_ASSIGN(HttpServerPropertiesManager); | 260 DISALLOW_COPY_AND_ASSIGN(HttpServerPropertiesManager); |
255 }; | 261 }; |
256 | 262 |
257 } // namespace chrome_browser_net | 263 } // namespace chrome_browser_net |
258 | 264 |
259 #endif // CHROME_BROWSER_NET_HTTP_SERVER_PROPERTIES_MANAGER_H_ | 265 #endif // CHROME_BROWSER_NET_HTTP_SERVER_PROPERTIES_MANAGER_H_ |
OLD | NEW |