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
3 // found in the LICENSE file.
5 #ifndef NET_PROXY_PROXY_SERVICE_H_
6 #define NET_PROXY_PROXY_SERVICE_H_
11 #include "base/gtest_prod_util.h"
12 #include "base/memory/ref_counted.h"
13 #include "base/memory/scoped_ptr.h"
14 #include "base/synchronization/waitable_event.h"
15 #include "base/threading/non_thread_safe.h"
16 #include "net/base/completion_callback.h"
17 #include "net/base/load_states.h"
18 #include "net/base/net_export.h"
19 #include "net/base/net_log.h"
20 #include "net/base/network_change_notifier.h"
21 #include "net/proxy/proxy_config_service.h"
22 #include "net/proxy/proxy_info.h"
23 #include "net/proxy/proxy_server.h"
29 class SingleThreadTaskRunner;
35 class DhcpProxyScriptFetcher;
37 class NetworkDelegate;
39 class ProxyResolverScriptData;
40 class ProxyScriptDecider;
41 class ProxyScriptFetcher;
43 // This class can be used to resolve the proxy server to use when loading a
44 // HTTP(S) URL. It uses the given ProxyResolver to handle the actual proxy
45 // resolution. See ProxyResolverV8 for example.
46 class NET_EXPORT ProxyService : public NetworkChangeNotifier::IPAddressObserver,
47 public NetworkChangeNotifier::DNSObserver,
48 public ProxyConfigService::Observer,
49 NON_EXPORTED_BASE(public base::NonThreadSafe) {
51 static const size_t kDefaultNumPacThreads = 4;
53 // This interface defines the set of policies for when to poll the PAC
54 // script for changes.
56 // The polling policy decides what the next poll delay should be in
57 // milliseconds. It also decides how to wait for this delay -- either
58 // by starting a timer to do the poll at exactly |next_delay_ms|
59 // (MODE_USE_TIMER) or by waiting for the first network request issued after
60 // |next_delay_ms| (MODE_START_AFTER_ACTIVITY).
62 // The timer method is more precise and guarantees that polling happens when
63 // it was requested. However it has the disadvantage of causing spurious CPU
64 // and network activity. It is a reasonable choice to use for short poll
65 // intervals which only happen a couple times.
67 // However for repeated timers this will prevent the browser from going
68 // idle. MODE_START_AFTER_ACTIVITY solves this problem by only polling in
69 // direct response to network activity. The drawback to
70 // MODE_START_AFTER_ACTIVITY is since the poll is initiated only after the
71 // request is received, the first couple requests initiated after a long
72 // period of inactivity will likely see a stale version of the PAC script
73 // until the background polling gets a chance to update things.
74 class NET_EXPORT_PRIVATE PacPollPolicy {
78 MODE_START_AFTER_ACTIVITY,
81 virtual ~PacPollPolicy() {}
83 // Decides the next poll delay. |current_delay| is the delay used
84 // by the preceding poll, or a negative TimeDelta value if determining
85 // the delay for the initial poll. |initial_error| is the network error
86 // code that the last PAC fetch (or WPAD initialization) failed with,
87 // or OK if it completed successfully. Implementations must set
88 // |next_delay| to a non-negative value.
89 virtual Mode GetNextDelay(int initial_error,
90 base::TimeDelta current_delay,
91 base::TimeDelta* next_delay) const = 0;
94 // The instance takes ownership of |config_service| and |resolver|.
95 // |net_log| is a possibly NULL destination to send log events to. It must
96 // remain alive for the lifetime of this ProxyService.
97 ProxyService(ProxyConfigService* config_service,
98 ProxyResolver* resolver,
101 virtual ~ProxyService();
103 // Used internally to handle PAC queries.
104 // TODO(eroman): consider naming this simply "Request".
107 // Returns ERR_IO_PENDING if the proxy information could not be provided
108 // synchronously, to indicate that the result will be available when the
109 // callback is run. The callback is run on the thread that calls
112 // The caller is responsible for ensuring that |results| and |callback|
113 // remain valid until the callback is run or until |pac_request| is cancelled
114 // via CancelPacRequest. |pac_request| is only valid while the completion
115 // callback is still pending. NULL can be passed for |pac_request| if
116 // the caller will not need to cancel the request.
118 // We use the three possible proxy access types in the following order,
119 // doing fallback if one doesn't work. See "pac_script_decider.h"
120 // for the specifics.
121 // 1. WPAD auto-detection
125 // Profiling information for the request is saved to |net_log| if non-NULL.
126 int ResolveProxy(const GURL& url,
129 const net::CompletionCallback& callback,
130 PacRequest** pac_request,
131 NetworkDelegate* network_delegate,
132 const BoundNetLog& net_log);
134 // This method is called after a failure to connect or resolve a host name.
135 // It gives the proxy service an opportunity to reconsider the proxy to use.
136 // The |results| parameter contains the results returned by an earlier call
137 // to ResolveProxy. The |net_error| parameter contains the network error
138 // code associated with the failure. See "net/base/net_error_list.h" for a
139 // list of possible values. The semantics of this call are otherwise
140 // similar to ResolveProxy.
142 // NULL can be passed for |pac_request| if the caller will not need to
143 // cancel the request.
145 // Returns ERR_FAILED if there is not another proxy config to try.
147 // Profiling information for the request is saved to |net_log| if non-NULL.
148 int ReconsiderProxyAfterError(const GURL& url,
152 const CompletionCallback& callback,
153 PacRequest** pac_request,
154 NetworkDelegate* network_delegate,
155 const BoundNetLog& net_log);
157 // Explicitly trigger proxy fallback for the given |results| by updating our
158 // list of bad proxies to include the first entry of |results|, and,
159 // optionally, another bad proxy. Will retry after |retry_delay| if positive,
160 // and will use the default proxy retry duration otherwise. Proxies marked as
161 // bad will not be retried until |retry_delay| has passed. Returns true if
162 // there will be at least one proxy remaining in the list after fallback and
164 bool MarkProxiesAsBadUntil(const ProxyInfo& results,
165 base::TimeDelta retry_delay,
166 const ProxyServer& another_bad_proxy,
167 const BoundNetLog& net_log);
169 // Called to report that the last proxy connection succeeded. If |proxy_info|
170 // has a non empty proxy_retry_info map, the proxies that have been tried (and
171 // failed) for this request will be marked as bad.
172 void ReportSuccess(const ProxyInfo& proxy_info);
174 // Call this method with a non-null |pac_request| to cancel the PAC request.
175 void CancelPacRequest(PacRequest* pac_request);
177 // Returns the LoadState for this |pac_request| which must be non-NULL.
178 LoadState GetLoadState(const PacRequest* pac_request) const;
180 // Sets the ProxyScriptFetcher and DhcpProxyScriptFetcher dependencies. This
181 // is needed if the ProxyResolver is of type ProxyResolverWithoutFetch.
182 // ProxyService takes ownership of both objects.
183 void SetProxyScriptFetchers(
184 ProxyScriptFetcher* proxy_script_fetcher,
185 DhcpProxyScriptFetcher* dhcp_proxy_script_fetcher);
186 ProxyScriptFetcher* GetProxyScriptFetcher() const;
188 // Tells this ProxyService to start using a new ProxyConfigService to
189 // retrieve its ProxyConfig from. The new ProxyConfigService will immediately
190 // be queried for new config info which will be used for all subsequent
191 // ResolveProxy calls. ProxyService takes ownership of
192 // |new_proxy_config_service|.
193 void ResetConfigService(ProxyConfigService* new_proxy_config_service);
195 // Returns the last configuration fetched from ProxyConfigService.
196 const ProxyConfig& fetched_config() {
197 return fetched_config_;
200 // Returns the current configuration being used by ProxyConfigService.
201 const ProxyConfig& config() {
205 // Returns the map of proxies which have been marked as "bad".
206 const ProxyRetryInfoMap& proxy_retry_info() const {
207 return proxy_retry_info_;
210 // Clears the list of bad proxy servers that has been cached.
211 void ClearBadProxiesCache() {
212 proxy_retry_info_.clear();
215 // Forces refetching the proxy configuration, and applying it.
216 // This re-does everything from fetching the system configuration,
217 // to downloading and testing the PAC files.
218 void ForceReloadProxyConfig();
220 // Same as CreateProxyServiceUsingV8ProxyResolver, except it uses system
221 // libraries for evaluating the PAC script if available, otherwise skips
223 static ProxyService* CreateUsingSystemProxyResolver(
224 ProxyConfigService* proxy_config_service,
225 size_t num_pac_threads,
228 // Creates a ProxyService without support for proxy autoconfig.
229 static ProxyService* CreateWithoutProxyResolver(
230 ProxyConfigService* proxy_config_service,
233 // Convenience methods that creates a proxy service using the
234 // specified fixed settings.
235 static ProxyService* CreateFixed(const ProxyConfig& pc);
236 static ProxyService* CreateFixed(const std::string& proxy);
238 // Creates a proxy service that uses a DIRECT connection for all requests.
239 static ProxyService* CreateDirect();
240 // |net_log|'s lifetime must exceed ProxyService.
241 static ProxyService* CreateDirectWithNetLog(NetLog* net_log);
243 // This method is used by tests to create a ProxyService that returns a
244 // hardcoded proxy fallback list (|pac_string|) for every URL.
246 // |pac_string| is a list of proxy servers, in the format that a PAC script
247 // would return it. For example, "PROXY foobar:99; SOCKS fml:2; DIRECT"
248 static ProxyService* CreateFixedFromPacResult(const std::string& pac_string);
250 // Creates a config service appropriate for this platform that fetches the
251 // system proxy settings.
252 static ProxyConfigService* CreateSystemProxyConfigService(
253 base::SingleThreadTaskRunner* io_thread_task_runner,
254 base::MessageLoop* file_loop);
256 // This method should only be used by unit tests.
257 void set_stall_proxy_auto_config_delay(base::TimeDelta delay) {
258 stall_proxy_auto_config_delay_ = delay;
261 // This method should only be used by unit tests. Returns the previously
263 static const PacPollPolicy* set_pac_script_poll_policy(
264 const PacPollPolicy* policy);
266 // This method should only be used by unit tests. Creates an instance
267 // of the default internal PacPollPolicy used by ProxyService.
268 static scoped_ptr<PacPollPolicy> CreateDefaultPacPollPolicy();
270 void set_quick_check_enabled(bool value) {
271 quick_check_enabled_ = value;
274 bool quick_check_enabled() const { return quick_check_enabled_; }
277 FRIEND_TEST_ALL_PREFIXES(ProxyServiceTest, UpdateConfigAfterFailedAutodetect);
278 FRIEND_TEST_ALL_PREFIXES(ProxyServiceTest, UpdateConfigFromPACToDirect);
279 friend class PacRequest;
280 class InitProxyResolver;
281 class ProxyScriptDeciderPoller;
283 // TODO(eroman): change this to a std::set. Note that this requires updating
284 // some tests in proxy_service_unittest.cc such as:
285 // ProxyServiceTest.InitialPACScriptDownload
286 // which expects requests to finish in the order they were added.
287 typedef std::vector<scoped_refptr<PacRequest> > PendingRequests;
291 STATE_WAITING_FOR_PROXY_CONFIG,
292 STATE_WAITING_FOR_INIT_PROXY_RESOLVER,
296 // Resets all the variables associated with the current proxy configuration,
297 // and rewinds the current state to |STATE_NONE|. Returns the previous value
298 // of |current_state_|. If |reset_fetched_config| is true then
299 // |fetched_config_| will also be reset, otherwise it will be left as-is.
300 // Resetting it means that we will have to re-fetch the configuration from
301 // the ProxyConfigService later.
302 State ResetProxyConfig(bool reset_fetched_config);
304 // Retrieves the current proxy configuration from the ProxyConfigService, and
305 // starts initializing for it.
306 void ApplyProxyConfigIfAvailable();
308 // Callback for when the proxy resolver has been initialized with a
310 void OnInitProxyResolverComplete(int result);
312 // Returns ERR_IO_PENDING if the request cannot be completed synchronously.
313 // Otherwise it fills |result| with the proxy information for |url|.
314 // Completing synchronously means we don't need to query ProxyResolver.
315 int TryToCompleteSynchronously(const GURL& url,
317 NetworkDelegate* network_delegate,
320 // Cancels all of the requests sent to the ProxyResolver. These will be
321 // restarted when calling SetReady().
322 void SuspendAllPendingRequests();
324 // Advances the current state to |STATE_READY|, and resumes any pending
325 // requests which had been stalled waiting for initialization to complete.
328 // Returns true if |pending_requests_| contains |req|.
329 bool ContainsPendingRequest(PacRequest* req);
331 // Removes |req| from the list of pending requests.
332 void RemovePendingRequest(PacRequest* req);
334 // Called when proxy resolution has completed (either synchronously or
335 // asynchronously). Handles logging the result, and cleaning out
336 // bad entries from the results list.
337 int DidFinishResolvingProxy(const GURL& url,
339 NetworkDelegate* network_delegate,
342 const BoundNetLog& net_log);
344 // Start initialization using |fetched_config_|.
345 void InitializeUsingLastFetchedConfig();
347 // Start the initialization skipping past the "decision" phase.
348 void InitializeUsingDecidedConfig(
350 ProxyResolverScriptData* script_data,
351 const ProxyConfig& effective_config);
353 // NetworkChangeNotifier::IPAddressObserver
354 // When this is called, we re-fetch PAC scripts and re-run WPAD.
355 virtual void OnIPAddressChanged() OVERRIDE;
357 // NetworkChangeNotifier::DNSObserver
358 // We respond as above.
359 virtual void OnDNSChanged() OVERRIDE;
361 // ProxyConfigService::Observer
362 virtual void OnProxyConfigChanged(
363 const ProxyConfig& config,
364 ProxyConfigService::ConfigAvailability availability) OVERRIDE;
366 scoped_ptr<ProxyConfigService> config_service_;
367 scoped_ptr<ProxyResolver> resolver_;
369 // We store the proxy configuration that was last fetched from the
370 // ProxyConfigService, as well as the resulting "effective" configuration.
371 // The effective configuration is what we condense the original fetched
372 // settings to after testing the various automatic settings (auto-detect
373 // and custom PAC url).
374 ProxyConfig fetched_config_;
377 // Increasing ID to give to the next ProxyConfig that we set.
380 // The time when the proxy configuration was last read from the system.
381 base::TimeTicks config_last_update_time_;
383 // Map of the known bad proxies and the information about the retry time.
384 ProxyRetryInfoMap proxy_retry_info_;
386 // Set of pending/inprogress requests.
387 PendingRequests pending_requests_;
389 // The fetcher to use when downloading PAC scripts for the ProxyResolver.
390 // This dependency can be NULL if our ProxyResolver has no need for
391 // external PAC script fetching.
392 scoped_ptr<ProxyScriptFetcher> proxy_script_fetcher_;
394 // The fetcher to use when attempting to download the most appropriate PAC
395 // script configured in DHCP, if any. Can be NULL if the ProxyResolver has
396 // no need for DHCP PAC script fetching.
397 scoped_ptr<DhcpProxyScriptFetcher> dhcp_proxy_script_fetcher_;
399 // Helper to download the PAC script (wpad + custom) and apply fallback rules.
401 // Note that the declaration is important here: |proxy_script_fetcher_| and
402 // |proxy_resolver_| must outlive |init_proxy_resolver_|.
403 scoped_ptr<InitProxyResolver> init_proxy_resolver_;
405 // Helper to poll the PAC script for changes.
406 scoped_ptr<ProxyScriptDeciderPoller> script_poller_;
408 State current_state_;
410 // Either OK or an ERR_* value indicating that a permanent error (e.g.
411 // failed to fetch the PAC script) prevents proxy resolution.
412 int permanent_error_;
414 // This is the log where any events generated by |init_proxy_resolver_| are
418 // The earliest time at which we should run any proxy auto-config. (Used to
419 // stall re-configuration following an IP address change).
420 base::TimeTicks stall_proxy_autoconfig_until_;
422 // The amount of time to stall requests following IP address changes.
423 base::TimeDelta stall_proxy_auto_config_delay_;
425 // Whether child ProxyScriptDeciders should use QuickCheck
426 bool quick_check_enabled_;
428 DISALLOW_COPY_AND_ASSIGN(ProxyService);
433 #endif // NET_PROXY_PROXY_SERVICE_H_