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. 4 5 #ifndef NET_PROXY_PROXY_LIST_H_ 6 #define NET_PROXY_PROXY_LIST_H_ 7 8 #include <string> 9 #include <vector> 10 11 #include "net/base/net_export.h" 12 #include "net/base/net_log.h" 13 #include "net/proxy/proxy_retry_info.h" 14 15 namespace base { 16 class ListValue; 17 class TimeDelta; 18 } 19 20 namespace net { 21 22 class ProxyServer; 23 24 // This class is used to hold a list of proxies returned by GetProxyForUrl or 25 // manually configured. It handles proxy fallback if multiple servers are 26 // specified. 27 class NET_EXPORT_PRIVATE ProxyList { 28 public: 29 ProxyList(); 30 ~ProxyList(); 31 32 // Initializes the proxy list to a string containing one or more proxy servers 33 // delimited by a semicolon. 34 void Set(const std::string& proxy_uri_list); 35 36 // Set the proxy list to a single entry, |proxy_server|. 37 void SetSingleProxyServer(const ProxyServer& proxy_server); 38 39 // Append a single proxy server to the end of the proxy list. 40 void AddProxyServer(const ProxyServer& proxy_server); 41 42 // De-prioritizes the proxies that are cached as not working but are allowed 43 // to be reconsidered, by moving them to the end of the fallback list. 44 void DeprioritizeBadProxies(const ProxyRetryInfoMap& proxy_retry_info); 45 46 // Delete any entry which doesn't have one of the specified proxy schemes. 47 // |scheme_bit_field| is a bunch of ProxyServer::Scheme bitwise ORed together. 48 void RemoveProxiesWithoutScheme(int scheme_bit_field); 49 50 // Clear the proxy list. 51 void Clear(); 52 53 // Returns true if there is nothing left in the ProxyList. 54 bool IsEmpty() const; 55 56 // Returns the number of proxy servers in this list. 57 size_t size() const; 58 59 // Returns true if |*this| lists the same proxies as |other|. 60 bool Equals(const ProxyList& other) const; 61 62 // Returns the first proxy server in the list. It is only valid to call 63 // this if !IsEmpty(). 64 const ProxyServer& Get() const; 65 66 // Sets the list by parsing the pac result |pac_string|. 67 // Some examples for |pac_string|: 68 // "DIRECT" 69 // "PROXY foopy1" 70 // "PROXY foopy1; SOCKS4 foopy2:1188" 71 // Does a best-effort parse, and silently discards any errors. 72 void SetFromPacString(const std::string& pac_string); 73 74 // Returns a PAC-style semicolon-separated list of valid proxy servers. 75 // For example: "PROXY xxx.xxx.xxx.xxx:xx; SOCKS yyy.yyy.yyy:yy". 76 std::string ToPacString() const; 77 78 // Returns a serialized value for the list. The caller takes ownership of it. 79 base::ListValue* ToValue() const; 80 81 // Marks the current proxy server as bad and deletes it from the list. The 82 // list of known bad proxies is given by |proxy_retry_info|. |net_error| 83 // should contain the network error encountered when this proxy was tried, if 84 // any. If this fallback is not because of a network error, then |OK| should 85 // be passed in (eg. for reasons such as local policy). Returns true if there 86 // is another server available in the list. 87 bool Fallback(ProxyRetryInfoMap* proxy_retry_info, 88 int net_error, 89 const BoundNetLog& net_log); 90 91 // Updates |proxy_retry_info| to indicate that the first proxy in the list 92 // is bad. This is distinct from Fallback(), above, to allow updating proxy 93 // retry information without modifying a given transction's proxy list. Will 94 // retry after |retry_delay| if positive, and will use the default proxy retry 95 // duration otherwise. It may reconsider the proxy beforehand if |reconsider| 96 // is true. Additionally updates |proxy_retry_info| with 97 // |another_proxy_to_bypass| if non-empty. |net_error| should contain the 98 // network error countered when this proxy was tried, or OK if the proxy retry 99 // info is being updated for a non-network related reason (e.g. local policy). 100 void UpdateRetryInfoOnFallback( 101 ProxyRetryInfoMap* proxy_retry_info, 102 base::TimeDelta retry_delay, 103 bool reconsider, 104 const ProxyServer& another_proxy_to_bypass, 105 int net_error, 106 const BoundNetLog& net_log) const; 107 108 private: 109 // Updates |proxy_retry_info| to indicate that the |proxy_to_retry| in 110 // |proxies_| is bad for |retry_delay|, but may be reconsidered earlier if 111 // |try_while_bad| is true. |net_error| should contain the network error 112 // countered when this proxy was tried, or OK if the proxy retry info is 113 // being updated for a non-network related reason (e.g. local policy). 114 void AddProxyToRetryList(ProxyRetryInfoMap* proxy_retry_info, 115 base::TimeDelta retry_delay, 116 bool try_while_bad, 117 const ProxyServer& proxy_to_retry, 118 int net_error, 119 const BoundNetLog& net_log) const; 120 121 // List of proxies. 122 std::vector<ProxyServer> proxies_; 123 }; 124 125 } // namespace net 126 127 #endif // NET_PROXY_PROXY_LIST_H_ 128