OLD | NEW |
| (Empty) |
1 // Copyright (c) 2011 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_INIT_PROXY_RESOLVER_H_ | |
6 #define NET_PROXY_INIT_PROXY_RESOLVER_H_ | |
7 #pragma once | |
8 | |
9 #include <vector> | |
10 | |
11 #include "base/memory/scoped_ptr.h" | |
12 #include "base/string16.h" | |
13 #include "base/time.h" | |
14 #include "base/timer.h" | |
15 #include "googleurl/src/gurl.h" | |
16 #include "net/base/completion_callback.h" | |
17 #include "net/base/net_export.h" | |
18 #include "net/base/net_log.h" | |
19 | |
20 namespace net { | |
21 | |
22 class DhcpProxyScriptFetcher; | |
23 class NetLogParameter; | |
24 class ProxyConfig; | |
25 class ProxyResolver; | |
26 class ProxyScriptFetcher; | |
27 | |
28 // InitProxyResolver is a helper class used by ProxyService to | |
29 // initialize a ProxyResolver with the PAC script data specified | |
30 // by a particular ProxyConfig. | |
31 // | |
32 // This involves trying to use PAC scripts in this order: | |
33 // | |
34 // (1) WPAD (DNS) if auto-detect is on. | |
35 // (2) Custom PAC script if a URL was given. | |
36 // | |
37 // If no PAC script was successfully downloaded + parsed, then it fails with | |
38 // a network error. Otherwise the proxy resolver is left initialized with | |
39 // the PAC script. | |
40 // | |
41 // Deleting InitProxyResolver while Init() is in progress, will | |
42 // cancel the request. | |
43 // | |
44 class NET_EXPORT_PRIVATE InitProxyResolver { | |
45 public: | |
46 // |resolver|, |proxy_script_fetcher|, |dhcp_proxy_script_fetcher| and | |
47 // |net_log| must remain valid for the lifespan of InitProxyResolver. | |
48 InitProxyResolver(ProxyResolver* resolver, | |
49 ProxyScriptFetcher* proxy_script_fetcher, | |
50 DhcpProxyScriptFetcher* dhcp_proxy_script_fetcher, | |
51 NetLog* net_log); | |
52 | |
53 // Aborts any in-progress request. | |
54 ~InitProxyResolver(); | |
55 | |
56 // Applies the PAC settings of |config| to |resolver_|. | |
57 // If |wait_delay| is positive, the initialization will pause for this | |
58 // amount of time before getting started. | |
59 // If |effective_config| is non-NULL, then on successful initialization of | |
60 // |resolver_| the "effective" proxy settings we ended up using will be | |
61 // written out to |*effective_config|. Note that this may differ from | |
62 // |config| since we will have stripped any manual settings, and decided | |
63 // whether to use auto-detect or the custom PAC URL. Finally, if auto-detect | |
64 // was used we may now have resolved that to a specific script URL. | |
65 int Init(const ProxyConfig& config, | |
66 const base::TimeDelta wait_delay, | |
67 ProxyConfig* effective_config, | |
68 OldCompletionCallback* callback); | |
69 | |
70 private: | |
71 // Represents the sources from which we can get PAC files; two types of | |
72 // auto-detect or a custom URL. | |
73 struct PacSource { | |
74 enum Type { | |
75 WPAD_DHCP, | |
76 WPAD_DNS, | |
77 CUSTOM | |
78 }; | |
79 | |
80 PacSource(Type type, const GURL& url) | |
81 : type(type), url(url) {} | |
82 | |
83 Type type; | |
84 GURL url; // Empty unless |type == PAC_SOURCE_CUSTOM|. | |
85 }; | |
86 | |
87 typedef std::vector<PacSource> PacSourceList; | |
88 | |
89 enum State { | |
90 STATE_NONE, | |
91 STATE_WAIT, | |
92 STATE_WAIT_COMPLETE, | |
93 STATE_FETCH_PAC_SCRIPT, | |
94 STATE_FETCH_PAC_SCRIPT_COMPLETE, | |
95 STATE_SET_PAC_SCRIPT, | |
96 STATE_SET_PAC_SCRIPT_COMPLETE, | |
97 }; | |
98 | |
99 // Returns ordered list of PAC urls to try for |config|. | |
100 PacSourceList BuildPacSourcesFallbackList(const ProxyConfig& config) const; | |
101 | |
102 void OnIOCompletion(int result); | |
103 int DoLoop(int result); | |
104 void DoCallback(int result); | |
105 | |
106 int DoWait(); | |
107 int DoWaitComplete(int result); | |
108 | |
109 int DoFetchPacScript(); | |
110 int DoFetchPacScriptComplete(int result); | |
111 | |
112 int DoSetPacScript(); | |
113 int DoSetPacScriptComplete(int result); | |
114 | |
115 // Tries restarting using the next fallback PAC URL: | |
116 // |pac_sources_[++current_pac_source_index]|. | |
117 // Returns OK and rewinds the state machine when there | |
118 // is something to try, otherwise returns |error|. | |
119 int TryToFallbackPacSource(int error); | |
120 | |
121 // Gets the initial state (we skip fetching when the | |
122 // ProxyResolver doesn't |expect_pac_bytes()|. | |
123 State GetStartState() const; | |
124 | |
125 NetLogStringParameter* CreateNetLogParameterAndDetermineURL( | |
126 const PacSource& pac_source, GURL* effective_pac_url); | |
127 | |
128 // Returns the current PAC URL we are fetching/testing. | |
129 const PacSource& current_pac_source() const; | |
130 | |
131 void OnWaitTimerFired(); | |
132 void DidCompleteInit(); | |
133 void Cancel(); | |
134 | |
135 ProxyResolver* resolver_; | |
136 ProxyScriptFetcher* proxy_script_fetcher_; | |
137 DhcpProxyScriptFetcher* dhcp_proxy_script_fetcher_; | |
138 | |
139 OldCompletionCallbackImpl<InitProxyResolver> io_callback_; | |
140 OldCompletionCallback* user_callback_; | |
141 | |
142 size_t current_pac_source_index_; | |
143 | |
144 // Filled when the PAC script fetch completes. | |
145 string16 pac_script_; | |
146 | |
147 // Flag indicating whether the caller requested a mandatory pac script | |
148 // (i.e. fallback to direct connections are prohibited). | |
149 bool pac_mandatory_; | |
150 | |
151 PacSourceList pac_sources_; | |
152 State next_state_; | |
153 | |
154 BoundNetLog net_log_; | |
155 | |
156 base::TimeDelta wait_delay_; | |
157 base::OneShotTimer<InitProxyResolver> wait_timer_; | |
158 | |
159 ProxyConfig* effective_config_; | |
160 | |
161 DISALLOW_COPY_AND_ASSIGN(InitProxyResolver); | |
162 }; | |
163 | |
164 } // namespace net | |
165 | |
166 #endif // NET_PROXY_INIT_PROXY_RESOLVER_H_ | |
OLD | NEW |