Poll PAC scripts for content changes.

net/proxy/proxy_service.h

 // Copyright (c) 2011 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef NET_PROXY_PROXY_SERVICE_H_
 #define NET_PROXY_PROXY_SERVICE_H_
 #pragma once
 
 #include <string>
 #include <vector>
@@ skipping 14 matching lines @@
 
 class GURL;
 class MessageLoop;
 
 namespace net {
 
 class DhcpProxyScriptFetcher;
 class HostResolver;
 class NetworkDelegate;
 class ProxyResolver;
+class ProxyResolverScriptData;
 class ProxyScriptDecider;
 class ProxyScriptFetcher;
 
 // This class can be used to resolve the proxy server to use when loading a
 // HTTP(S) URL.  It uses the given ProxyResolver to handle the actual proxy
 // resolution.  See ProxyResolverV8 for example.
 class NET_EXPORT ProxyService : public NetworkChangeNotifier::IPAddressObserver,
                                 public ProxyConfigService::Observer,
                                 NON_EXPORTED_BASE(public base::NonThreadSafe) {
  public:
+  // Only used by unit-tests.
+  enum PollPolicy {
+    POLL_POLICY_REGULAR,  // Normal PAC poll policy (retry periodically).
+    POLL_POLICY_NEVER,  // Don't re-fetch PAC scripts for changes.
+    POLL_POLICY_IMMEDIATE,  // Check every 1 ms.
+  };
+
   // The instance takes ownership of |config_service| and |resolver|.
   // |net_log| is a possibly NULL destination to send log events to. It must
   // remain alive for the lifetime of this ProxyService.
   ProxyService(ProxyConfigService* config_service,
                ProxyResolver* resolver,
                NetLog* net_log);
 
   virtual ~ProxyService();
 
   // Used internally to handle PAC queries.
@@ skipping 174 matching lines @@
   // Creates a config service appropriate for this platform that fetches the
   // system proxy settings.
   static ProxyConfigService* CreateSystemProxyConfigService(
       MessageLoop* io_loop, MessageLoop* file_loop);
 
   // This method should only be used by unit tests.
   void set_stall_proxy_auto_config_delay(base::TimeDelta delay) {
     stall_proxy_auto_config_delay_ = delay;
   }
 
+  // This method should only be used by unit tests. Returns the currently
+  // active policy.

[wtc, 2012/01/03 23:54:45]

Nit: currently active => previously active ?

[eroman, 2012/01/04 03:41:47]

Done.

+  static PollPolicy set_pac_script_poll_policy(PollPolicy policy);
+
  private:
   FRIEND_TEST_ALL_PREFIXES(ProxyServiceTest, UpdateConfigAfterFailedAutodetect);
   FRIEND_TEST_ALL_PREFIXES(ProxyServiceTest, UpdateConfigFromPACToDirect);
   friend class PacRequest;
   class InitProxyResolver;
+  class ProxyScriptDeciderPoller;
 
   // TODO(eroman): change this to a std::set. Note that this requires updating
   // some tests in proxy_service_unittest.cc such as:
   //   ProxyServiceTest.InitialPACScriptDownload
   // which expects requests to finish in the order they were added.
   typedef std::vector<scoped_refptr<PacRequest> > PendingRequests;
 
   enum State {
     STATE_NONE,
     STATE_WAITING_FOR_PROXY_CONFIG,
@@ skipping 39 matching lines @@
   // Called when proxy resolution has completed (either synchronously or
   // asynchronously). Handles logging the result, and cleaning out
   // bad entries from the results list.
   int DidFinishResolvingProxy(ProxyInfo* result,
                               int result_code,
                               const BoundNetLog& net_log);
 
   // Start initialization using |fetched_config_|.
   void InitializeUsingLastFetchedConfig();
 
+  // Start the initialization skipping past the "decision" phase.
+  void InitializeUsingDecidedConfig(
+      int decider_result,
+      ProxyResolverScriptData* script_data,
+      const ProxyConfig& effective_config);
+
   // NetworkChangeNotifier::IPAddressObserver
   // When this is called, we re-fetch PAC scripts and re-run WPAD.
   virtual void OnIPAddressChanged() OVERRIDE;
 
   // ProxyConfigService::Observer
   virtual void OnProxyConfigChanged(
       const ProxyConfig& config,
       ProxyConfigService::ConfigAvailability availability) OVERRIDE;
 
   scoped_ptr<ProxyConfigService> config_service_;
@@ skipping 27 matching lines @@
   // The fetcher to use when attempting to download the most appropriate PAC
   // script configured in DHCP, if any. Can be NULL if the ProxyResolver has
   // no need for DHCP PAC script fetching.
   scoped_ptr<DhcpProxyScriptFetcher> dhcp_proxy_script_fetcher_;
 
   // Helper to download the PAC script (wpad + custom) and apply fallback rules.
   //
   // Note that the declaration is important here: |proxy_script_fetcher_| and
   // |proxy_resolver_| must outlive |init_proxy_resolver_|.
   scoped_ptr<InitProxyResolver> init_proxy_resolver_;
+  scoped_ptr<ProxyScriptDeciderPoller> script_poller_;

[wtc, 2012/01/03 23:54:45]

Nit: should we document this member?

[eroman, 2012/01/04 03:41:47]

Done.

 
   State current_state_;
 
   // Either OK or an ERR_* value indicating that a permanent error (e.g.
   // failed to fetch the PAC script) prevents proxy resolution.
   int permanent_error_;
 
   // This is the log where any events generated by |init_proxy_resolver_| are
   // sent to.
   NetLog* net_log_;
@@ skipping 37 matching lines @@
 
   base::WaitableEvent event_;
   CompletionCallback callback_;
   ProxyInfo proxy_info_;
   int result_;
 };
 
 }  // namespace net
 
 #endif  // NET_PROXY_PROXY_SERVICE_H_