summaryrefslogtreecommitdiffstats
path: root/net/http/http_proxy_service.h
diff options
context:
space:
mode:
Diffstat (limited to 'net/http/http_proxy_service.h')
-rw-r--r--net/http/http_proxy_service.h303
1 files changed, 0 insertions, 303 deletions
diff --git a/net/http/http_proxy_service.h b/net/http/http_proxy_service.h
deleted file mode 100644
index 6e87505..0000000
--- a/net/http/http_proxy_service.h
+++ /dev/null
@@ -1,303 +0,0 @@
-// Copyright 2008, Google Inc.
-// All rights reserved.
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are
-// met:
-//
-// * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-// * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-#ifndef NET_HTTP_HTTP_PROXY_SERVICE_H__
-#define NET_HTTP_HTTP_PROXY_SERVICE_H__
-
-#include <map>
-#include <vector>
-
-#include "base/ref_counted.h"
-#include "base/scoped_ptr.h"
-#include "base/string_util.h"
-#include "base/thread.h"
-#include "base/time.h"
-#include "net/base/completion_callback.h"
-
-typedef LPVOID HINTERNET; // From winhttp.h
-
-class GURL;
-
-namespace net {
-
-class HttpProxyInfo;
-class HttpProxyResolver;
-
-// Proxy configuration used to by the HttpProxyService.
-class HttpProxyConfig {
- public:
- typedef int ID;
-
- // Indicates an invalid proxy config.
- enum { INVALID_ID = 0 };
-
- HttpProxyConfig();
- // Default copy-constructor an assignment operator are OK!
-
- // Used to numerically identify this configuration.
- ID id() const { return id_; }
-
- // True if the proxy configuration should be auto-detected.
- bool auto_detect;
-
- // If non-empty, indicates the URL of the proxy auto-config file to use.
- std::wstring pac_url;
-
- // If non-empty, indicates the proxy server to use (of the form host:port).
- std::wstring proxy_server;
-
- // If non-empty, indicates a comma-delimited list of hosts that should bypass
- // any proxy configuration. For these hosts, a direct connection should
- // always be used.
- std::wstring proxy_bypass;
-
- // Returns true if the given config is equivalent to this config.
- bool Equals(const HttpProxyConfig& other) const;
-
- private:
- static int last_id_;
- int id_;
-};
-
-// Contains the information about when to retry a proxy server.
-struct HttpProxyRetryInfo {
- // We should not retry until this time.
- TimeTicks bad_until;
-
- // This is the current delay. If the proxy is still bad, we need to increase
- // this delay.
- TimeDelta current_delay;
-};
-
-// Map of proxy servers with the associated RetryInfo structures.
-typedef std::map<std::wstring, HttpProxyRetryInfo> HttpProxyRetryInfoMap;
-
-// This class can be used to resolve the proxy server to use when loading a
-// HTTP(S) URL. It uses to the given HttpProxyResolver to handle the actual
-// proxy resolution. See HttpProxyResolverWinHttp for example. The consumer
-// of this class is responsible for ensuring that the HttpProxyResolver
-// instance remains valid for the lifetime of the HttpProxyService.
-class HttpProxyService {
- public:
- explicit HttpProxyService(HttpProxyResolver* resolver);
-
- // Used internally to handle PAC queries.
- class PacRequest;
-
- // Returns OK if proxy information could be provided synchronously. Else,
- // ERR_IO_PENDING is returned to indicate that the result will be available
- // when the callback is run. The callback is run on the thread that calls
- // ResolveProxy.
- //
- // The caller is responsible for ensuring that |results| and |callback|
- // remain valid until the callback is run or until |pac_request| is cancelled
- // via CancelPacRequest. |pac_request| is only valid while the completion
- // callback is still pending.
- //
- // We use the three possible proxy access types in the following order, and
- // we only use one of them (no falling back to other access types if the
- // chosen one doesn't work).
- // 1. named proxy
- // 2. PAC URL
- // 3. WPAD auto-detection
- //
- int ResolveProxy(const GURL& url,
- HttpProxyInfo* results,
- CompletionCallback* callback,
- PacRequest** pac_request);
-
- // This method is called after a failure to connect or resolve a host name.
- // It gives the proxy service an opportunity to reconsider the proxy to use.
- // The |results| parameter contains the results returned by an earlier call
- // to ResolveProxy. The semantics of this call are otherwise similar to
- // ResolveProxy.
- //
- // Returns ERR_FAILED if there is not another proxy config to try.
- //
- int ReconsiderProxyAfterError(const GURL& url,
- HttpProxyInfo* results,
- CompletionCallback* callback,
- PacRequest** pac_request);
-
- // Call this method with a non-null |pac_request| to cancel the PAC request.
- void CancelPacRequest(PacRequest* pac_request);
-
- private:
- friend class PacRequest;
-
- HttpProxyResolver* resolver() { return resolver_; }
- Thread* pac_thread() { return pac_thread_.get(); }
-
- // Identifies the proxy configuration.
- HttpProxyConfig::ID config_id() const { return config_.id(); }
-
- // Checks to see if the proxy configuration changed, and then updates config_
- // to reference the new configuration.
- void UpdateConfig();
-
- // Called to indicate that a PacRequest completed. The |config_id| parameter
- // indicates the proxy configuration that was queried. |result_code| is OK
- // if the PAC file could be downloaded and executed. Otherwise, it is an
- // error code, indicating a bad proxy configuration.
- void DidCompletePacRequest(int config_id, int result_code);
-
- // Returns true if the URL passed in should not go through the proxy server.
- // 1. If the bypass proxy list contains the string <local> and the URL
- // passed in is a local URL, i.e. a URL without a DOT (.)
- // 2. The URL matches one of the entities in the proxy bypass list.
- bool ShouldBypassProxyForURL(const GURL& url);
-
- HttpProxyResolver* resolver_;
- scoped_ptr<Thread> pac_thread_;
-
- // We store the IE proxy config and a counter that is incremented each time
- // the config changes.
- HttpProxyConfig config_;
-
- // Indicates that the configuration is bad and should be ignored.
- bool config_is_bad_;
-
- // The time when the proxy configuration was last read from the system.
- TimeTicks config_last_update_time_;
-
- // Map of the known bad proxies and the information about the retry time.
- HttpProxyRetryInfoMap http_proxy_retry_info_;
-
- DISALLOW_EVIL_CONSTRUCTORS(HttpProxyService);
-};
-
-// This class is used to hold a list of proxies returned by GetProxyForUrl or
-// manually configured. It handles proxy fallback if multiple servers are
-// specified.
-class HttpProxyList {
- public:
- // Initializes the proxy list to a string containing one or more proxy servers
- // delimited by a semicolon.
- void Set(const std::wstring& proxy_list);
-
- // Initializes the proxy list to a vector containing one or more proxy
- // servers.
- void SetVector(const std::vector<std::wstring>& proxy_list);
-
- // Remove all proxies known to be bad from the proxy list.
- void RemoveBadProxies(const HttpProxyRetryInfoMap& http_proxy_retry_info);
-
- // Returns the first valid proxy server in the list.
- std::wstring Get() const;
-
- // Returns all the valid proxies, delimited by a semicolon.
- std::wstring GetList() const;
-
- // Marks the current proxy server as bad and deletes it from the list.
- // The list of known bad proxies is given by http_proxy_retry_info.
- // Returns true if there is another server available in the list.
- bool Fallback(HttpProxyRetryInfoMap* http_proxy_retry_info);
-
- private:
- // List of proxies.
- std::vector<std::wstring> proxies_;
-};
-
-// This object holds proxy information returned by ResolveProxy.
-class HttpProxyInfo {
- public:
- HttpProxyInfo();
-
- // Use the same proxy server as the given |proxy_info|.
- void Use(const HttpProxyInfo& proxy_info);
-
- // Use a direct connection.
- void UseDirect();
-
- // Use a specific proxy server, of the form: <hostname> [":" <port>]
- // This may optionally be a semi-colon delimited list of proxy servers.
- void UseNamedProxy(const std::wstring& proxy_server);
-
- // Apply this proxy information to the given WinHTTP request handle.
- void Apply(HINTERNET request_handle);
-
- // Returns true if this proxy info specifies a direct connection.
- bool is_direct() const { return proxy_list_.Get().empty(); }
-
- // Returns the first valid proxy server.
- std::wstring proxy_server() const { return proxy_list_.Get(); }
-
- std::string GetProxyServer() const { return WideToASCII(proxy_server()); }
-
- // Marks the current proxy as bad. Returns true if there is another proxy
- // available to try in proxy list_.
- bool Fallback(HttpProxyRetryInfoMap* http_proxy_retry_info) {
- return proxy_list_.Fallback(http_proxy_retry_info);
- }
-
- // Remove all proxies known to be bad from the proxy list.
- void RemoveBadProxies(const HttpProxyRetryInfoMap& http_proxy_retry_info) {
- proxy_list_.RemoveBadProxies(http_proxy_retry_info);
- }
-
- private:
- friend class HttpProxyService;
-
- // If proxy_list_ is set to empty, then a "direct" connection is indicated.
- HttpProxyList proxy_list_;
-
- // This value identifies the proxy config used to initialize this object.
- HttpProxyConfig::ID config_id_;
-
- // This flag is false when the proxy configuration was known to be bad when
- // this proxy info was initialized. In such cases, we know that if this
- // proxy info does not yield a connection that we might want to reconsider
- // the proxy config given by config_id_.
- bool config_was_tried_;
-
- DISALLOW_EVIL_CONSTRUCTORS(HttpProxyInfo);
-};
-
-// This interface provides the low-level functions to access the proxy
-// configuration and resolve proxies for given URLs synchronously.
-class HttpProxyResolver {
- public:
- virtual ~HttpProxyResolver() {}
-
- // Get the proxy configuration. Returns OK if successful or an error code if
- // otherwise. |config| should be in its initial state when this method is
- // called.
- virtual int GetProxyConfig(HttpProxyConfig* config) = 0;
-
- // Query the proxy auto-config file (specified by |pac_url|) for the proxy to
- // use to load the given |query_url|. Returns OK if successful or an error
- // code if otherwise.
- virtual int GetProxyForURL(const std::wstring& query_url,
- const std::wstring& pac_url,
- HttpProxyInfo* results) = 0;
-};
-
-} // namespace net
-
-#endif // NET_HTTP_HTTP_PROXY_SERVICE_H__
generated by cgit v1.1 at 2025-10-14 20:13:00 +0000