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,
128 const net::CompletionCallback& callback,
129 PacRequest** pac_request,
130 const BoundNetLog& net_log);
132 // This method is called after a failure to connect or resolve a host name.
133 // It gives the proxy service an opportunity to reconsider the proxy to use.
134 // The |results| parameter contains the results returned by an earlier call
135 // to ResolveProxy. The semantics of this call are otherwise similar to
138 // NULL can be passed for |pac_request| if the caller will not need to
139 // cancel the request.
141 // Returns ERR_FAILED if there is not another proxy config to try.
143 // Profiling information for the request is saved to |net_log| if non-NULL.
144 int ReconsiderProxyAfterError(const GURL& url,
146 const CompletionCallback& callback,
147 PacRequest** pac_request,
148 const BoundNetLog& net_log);
150 // Explicitly trigger proxy fallback for the given |results| by updating our
151 // list of bad proxies to include the first entry of |results|, and,
152 // optionally, another bad proxy. Will retry after |retry_delay| if positive,
153 // and will use the default proxy retry duration otherwise. Proxies marked as
154 // bad will not be retried until |retry_delay| has passed. Returns true if
155 // there will be at least one proxy remaining in the list after fallback and
157 bool MarkProxiesAsBadUntil(const ProxyInfo& results,
158 base::TimeDelta retry_delay,
159 const ProxyServer& another_bad_proxy,
160 const BoundNetLog& net_log);
162 // Called to report that the last proxy connection succeeded. If |proxy_info|
163 // has a non empty proxy_retry_info map, the proxies that have been tried (and
164 // failed) for this request will be marked as bad.
165 void ReportSuccess(const ProxyInfo& proxy_info);
167 // Call this method with a non-null |pac_request| to cancel the PAC request.
168 void CancelPacRequest(PacRequest* pac_request);
170 // Returns the LoadState for this |pac_request| which must be non-NULL.
171 LoadState GetLoadState(const PacRequest* pac_request) const;
173 // Sets the ProxyScriptFetcher and DhcpProxyScriptFetcher dependencies. This
174 // is needed if the ProxyResolver is of type ProxyResolverWithoutFetch.
175 // ProxyService takes ownership of both objects.
176 void SetProxyScriptFetchers(
177 ProxyScriptFetcher* proxy_script_fetcher,
178 DhcpProxyScriptFetcher* dhcp_proxy_script_fetcher);
179 ProxyScriptFetcher* GetProxyScriptFetcher() const;
181 // Tells this ProxyService to start using a new ProxyConfigService to
182 // retrieve its ProxyConfig from. The new ProxyConfigService will immediately
183 // be queried for new config info which will be used for all subsequent
184 // ResolveProxy calls. ProxyService takes ownership of
185 // |new_proxy_config_service|.
186 void ResetConfigService(ProxyConfigService* new_proxy_config_service);
188 // Tells the resolver to purge any memory it does not need.
192 // Returns the last configuration fetched from ProxyConfigService.
193 const ProxyConfig& fetched_config() {
194 return fetched_config_;
197 // Returns the current configuration being used by ProxyConfigService.
198 const ProxyConfig& config() {
202 // Returns the map of proxies which have been marked as "bad".
203 const ProxyRetryInfoMap& proxy_retry_info() const {
204 return proxy_retry_info_;
207 // Clears the list of bad proxy servers that has been cached.
208 void ClearBadProxiesCache() {
209 proxy_retry_info_.clear();
212 // Forces refetching the proxy configuration, and applying it.
213 // This re-does everything from fetching the system configuration,
214 // to downloading and testing the PAC files.
215 void ForceReloadProxyConfig();
217 // Same as CreateProxyServiceUsingV8ProxyResolver, except it uses system
218 // libraries for evaluating the PAC script if available, otherwise skips
220 static ProxyService* CreateUsingSystemProxyResolver(
221 ProxyConfigService* proxy_config_service,
222 size_t num_pac_threads,
225 // Creates a ProxyService without support for proxy autoconfig.
226 static ProxyService* CreateWithoutProxyResolver(
227 ProxyConfigService* proxy_config_service,
230 // Convenience methods that creates a proxy service using the
231 // specified fixed settings.
232 static ProxyService* CreateFixed(const ProxyConfig& pc);
233 static ProxyService* CreateFixed(const std::string& proxy);
235 // Creates a proxy service that uses a DIRECT connection for all requests.
236 static ProxyService* CreateDirect();
237 // |net_log|'s lifetime must exceed ProxyService.
238 static ProxyService* CreateDirectWithNetLog(NetLog* net_log);
240 // This method is used by tests to create a ProxyService that returns a
241 // hardcoded proxy fallback list (|pac_string|) for every URL.
243 // |pac_string| is a list of proxy servers, in the format that a PAC script
244 // would return it. For example, "PROXY foobar:99; SOCKS fml:2; DIRECT"
245 static ProxyService* CreateFixedFromPacResult(const std::string& pac_string);
247 // Creates a config service appropriate for this platform that fetches the
248 // system proxy settings.
249 static ProxyConfigService* CreateSystemProxyConfigService(
250 base::SingleThreadTaskRunner* io_thread_task_runner,
251 base::MessageLoop* file_loop);
253 // This method should only be used by unit tests.
254 void set_stall_proxy_auto_config_delay(base::TimeDelta delay) {
255 stall_proxy_auto_config_delay_ = delay;
258 // This method should only be used by unit tests. Returns the previously
260 static const PacPollPolicy* set_pac_script_poll_policy(
261 const PacPollPolicy* policy);
263 // This method should only be used by unit tests. Creates an instance
264 // of the default internal PacPollPolicy used by ProxyService.
265 static scoped_ptr<PacPollPolicy> CreateDefaultPacPollPolicy();
267 void set_quick_check_enabled(bool value) {
268 quick_check_enabled_ = value;
271 bool quick_check_enabled() const { return quick_check_enabled_; }
273 #if defined(SPDY_PROXY_AUTH_ORIGIN)
274 // Values of the UMA DataReductionProxy.BypassInfo{Primary|Fallback}
275 // histograms. This enum must remain synchronized with the enum of the same
276 // name in metrics/histograms/histograms.xml.
277 enum DataReductionProxyBypassEventType {
278 // Bypass the proxy for less than 30 minutes.
281 // Bypass the proxy for 30 minutes or more.
284 // Bypass the proxy because of an internal server error.
285 INTERNAL_SERVER_ERROR_BYPASS,
287 // Bypass the proxy because of any other error.
290 // Bypass the proxy because responses appear not to be coming via it.
293 // This must always be last.
294 BYPASS_EVENT_TYPE_MAX
297 // Records a |DataReductionProxyBypassEventType| for either the data reduction
298 // proxy (|is_primary| is true) or the data reduction proxy fallback.
299 void RecordDataReductionProxyBypassInfo(
301 const ProxyServer& proxy_server,
302 DataReductionProxyBypassEventType bypass_type) const;
306 FRIEND_TEST_ALL_PREFIXES(ProxyServiceTest, UpdateConfigAfterFailedAutodetect);
307 FRIEND_TEST_ALL_PREFIXES(ProxyServiceTest, UpdateConfigFromPACToDirect);
308 friend class PacRequest;
309 class InitProxyResolver;
310 class ProxyScriptDeciderPoller;
312 // TODO(eroman): change this to a std::set. Note that this requires updating
313 // some tests in proxy_service_unittest.cc such as:
314 // ProxyServiceTest.InitialPACScriptDownload
315 // which expects requests to finish in the order they were added.
316 typedef std::vector<scoped_refptr<PacRequest> > PendingRequests;
320 STATE_WAITING_FOR_PROXY_CONFIG,
321 STATE_WAITING_FOR_INIT_PROXY_RESOLVER,
325 // Resets all the variables associated with the current proxy configuration,
326 // and rewinds the current state to |STATE_NONE|. Returns the previous value
327 // of |current_state_|. If |reset_fetched_config| is true then
328 // |fetched_config_| will also be reset, otherwise it will be left as-is.
329 // Resetting it means that we will have to re-fetch the configuration from
330 // the ProxyConfigService later.
331 State ResetProxyConfig(bool reset_fetched_config);
333 // Retrieves the current proxy configuration from the ProxyConfigService, and
334 // starts initializing for it.
335 void ApplyProxyConfigIfAvailable();
337 // Callback for when the proxy resolver has been initialized with a
339 void OnInitProxyResolverComplete(int result);
341 // Returns ERR_IO_PENDING if the request cannot be completed synchronously.
342 // Otherwise it fills |result| with the proxy information for |url|.
343 // Completing synchronously means we don't need to query ProxyResolver.
344 int TryToCompleteSynchronously(const GURL& url, ProxyInfo* result);
346 // Cancels all of the requests sent to the ProxyResolver. These will be
347 // restarted when calling SetReady().
348 void SuspendAllPendingRequests();
350 // Advances the current state to |STATE_READY|, and resumes any pending
351 // requests which had been stalled waiting for initialization to complete.
354 // Returns true if |pending_requests_| contains |req|.
355 bool ContainsPendingRequest(PacRequest* req);
357 // Removes |req| from the list of pending requests.
358 void RemovePendingRequest(PacRequest* req);
360 // Called when proxy resolution has completed (either synchronously or
361 // asynchronously). Handles logging the result, and cleaning out
362 // bad entries from the results list.
363 int DidFinishResolvingProxy(ProxyInfo* result,
365 const BoundNetLog& net_log);
367 // Start initialization using |fetched_config_|.
368 void InitializeUsingLastFetchedConfig();
370 // Start the initialization skipping past the "decision" phase.
371 void InitializeUsingDecidedConfig(
373 ProxyResolverScriptData* script_data,
374 const ProxyConfig& effective_config);
376 // NetworkChangeNotifier::IPAddressObserver
377 // When this is called, we re-fetch PAC scripts and re-run WPAD.
378 virtual void OnIPAddressChanged() OVERRIDE;
380 // NetworkChangeNotifier::DNSObserver
381 // We respond as above.
382 virtual void OnDNSChanged() OVERRIDE;
384 // ProxyConfigService::Observer
385 virtual void OnProxyConfigChanged(
386 const ProxyConfig& config,
387 ProxyConfigService::ConfigAvailability availability) OVERRIDE;
389 scoped_ptr<ProxyConfigService> config_service_;
390 scoped_ptr<ProxyResolver> resolver_;
392 // We store the proxy configuration that was last fetched from the
393 // ProxyConfigService, as well as the resulting "effective" configuration.
394 // The effective configuration is what we condense the original fetched
395 // settings to after testing the various automatic settings (auto-detect
396 // and custom PAC url).
397 ProxyConfig fetched_config_;
400 // Increasing ID to give to the next ProxyConfig that we set.
403 // The time when the proxy configuration was last read from the system.
404 base::TimeTicks config_last_update_time_;
406 // Map of the known bad proxies and the information about the retry time.
407 ProxyRetryInfoMap proxy_retry_info_;
409 // Set of pending/inprogress requests.
410 PendingRequests pending_requests_;
412 // The fetcher to use when downloading PAC scripts for the ProxyResolver.
413 // This dependency can be NULL if our ProxyResolver has no need for
414 // external PAC script fetching.
415 scoped_ptr<ProxyScriptFetcher> proxy_script_fetcher_;
417 // The fetcher to use when attempting to download the most appropriate PAC
418 // script configured in DHCP, if any. Can be NULL if the ProxyResolver has
419 // no need for DHCP PAC script fetching.
420 scoped_ptr<DhcpProxyScriptFetcher> dhcp_proxy_script_fetcher_;
422 // Helper to download the PAC script (wpad + custom) and apply fallback rules.
424 // Note that the declaration is important here: |proxy_script_fetcher_| and
425 // |proxy_resolver_| must outlive |init_proxy_resolver_|.
426 scoped_ptr<InitProxyResolver> init_proxy_resolver_;
428 // Helper to poll the PAC script for changes.
429 scoped_ptr<ProxyScriptDeciderPoller> script_poller_;
431 State current_state_;
433 // Either OK or an ERR_* value indicating that a permanent error (e.g.
434 // failed to fetch the PAC script) prevents proxy resolution.
435 int permanent_error_;
437 // This is the log where any events generated by |init_proxy_resolver_| are
441 // The earliest time at which we should run any proxy auto-config. (Used to
442 // stall re-configuration following an IP address change).
443 base::TimeTicks stall_proxy_autoconfig_until_;
445 // The amount of time to stall requests following IP address changes.
446 base::TimeDelta stall_proxy_auto_config_delay_;
448 // Whether child ProxyScriptDeciders should use QuickCheck
449 bool quick_check_enabled_;
451 DISALLOW_COPY_AND_ASSIGN(ProxyService);
454 // Wrapper for invoking methods on a ProxyService synchronously.
455 class NET_EXPORT SyncProxyServiceHelper
456 : public base::RefCountedThreadSafe<SyncProxyServiceHelper> {
458 SyncProxyServiceHelper(base::MessageLoop* io_message_loop,
459 ProxyService* proxy_service);
461 int ResolveProxy(const GURL& url,
462 ProxyInfo* proxy_info,
463 const BoundNetLog& net_log);
464 int ReconsiderProxyAfterError(const GURL& url,
465 ProxyInfo* proxy_info,
466 const BoundNetLog& net_log);
469 friend class base::RefCountedThreadSafe<SyncProxyServiceHelper>;
471 virtual ~SyncProxyServiceHelper();
473 void StartAsyncResolve(const GURL& url, const BoundNetLog& net_log);
474 void StartAsyncReconsider(const GURL& url, const BoundNetLog& net_log);
476 void OnCompletion(int result);
478 base::MessageLoop* io_message_loop_;
479 ProxyService* proxy_service_;
481 base::WaitableEvent event_;
482 CompletionCallback callback_;
483 ProxyInfo proxy_info_;
489 #endif // NET_PROXY_PROXY_SERVICE_H_