pref_proxy_config_tracker_impl.cc revision 868fa2fe829687343ffae624259930155e16dbd8 
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#include "chrome/browser/net/pref_proxy_config_tracker_impl.h"
6
7#include "base/bind.h"
8#include "base/prefs/pref_registry_simple.h"
9#include "base/prefs/pref_service.h"
10#include "base/values.h"
11#include "chrome/browser/prefs/proxy_config_dictionary.h"
12#include "chrome/common/chrome_notification_types.h"
13#include "chrome/common/pref_names.h"
14#include "components/user_prefs/pref_registry_syncable.h"
15#include "content/public/browser/browser_thread.h"
16#include "content/public/browser/notification_details.h"
17#include "content/public/browser/notification_source.h"
18
19using content::BrowserThread;
20
21//============================= ChromeProxyConfigService =======================
22
23ChromeProxyConfigService::ChromeProxyConfigService(
24    net::ProxyConfigService* base_service)
25    : base_service_(base_service),
26      pref_config_state_(ProxyPrefs::CONFIG_UNSET),
27      pref_config_read_pending_(true),
28      registered_observer_(false) {
29}
30
31ChromeProxyConfigService::~ChromeProxyConfigService() {
32  if (registered_observer_ && base_service_.get())
33    base_service_->RemoveObserver(this);
34}
35
36void ChromeProxyConfigService::AddObserver(
37    net::ProxyConfigService::Observer* observer) {
38  RegisterObserver();
39  observers_.AddObserver(observer);
40}
41
42void ChromeProxyConfigService::RemoveObserver(
43    net::ProxyConfigService::Observer* observer) {
44  observers_.RemoveObserver(observer);
45}
46
47net::ProxyConfigService::ConfigAvailability
48    ChromeProxyConfigService::GetLatestProxyConfig(net::ProxyConfig* config) {
49  RegisterObserver();
50
51  if (pref_config_read_pending_)
52    return net::ProxyConfigService::CONFIG_PENDING;
53
54  // Ask the base service if available.
55  net::ProxyConfig system_config;
56  ConfigAvailability system_availability =
57      net::ProxyConfigService::CONFIG_UNSET;
58  if (base_service_.get())
59    system_availability = base_service_->GetLatestProxyConfig(&system_config);
60
61  ProxyPrefs::ConfigState config_state;
62  return PrefProxyConfigTrackerImpl::GetEffectiveProxyConfig(
63      pref_config_state_, pref_config_,
64      system_availability, system_config, false,
65      &config_state, config);
66}
67
68void ChromeProxyConfigService::OnLazyPoll() {
69  if (base_service_.get())
70    base_service_->OnLazyPoll();
71}
72
73void ChromeProxyConfigService::UpdateProxyConfig(
74    ProxyPrefs::ConfigState config_state,
75    const net::ProxyConfig& config) {
76  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO));
77
78  pref_config_read_pending_ = false;
79  pref_config_state_ = config_state;
80  pref_config_ = config;
81
82  if (!observers_.size())
83    return;
84
85  // Evaluate the proxy configuration. If GetLatestProxyConfig returns
86  // CONFIG_PENDING, we are using the system proxy service, but it doesn't have
87  // a valid configuration yet. Once it is ready, OnProxyConfigChanged() will be
88  // called and broadcast the proxy configuration.
89  // Note: If a switch between a preference proxy configuration and the system
90  // proxy configuration occurs an unnecessary notification might get send if
91  // the two configurations agree. This case should be rare however, so we don't
92  // handle that case specially.
93  net::ProxyConfig new_config;
94  ConfigAvailability availability = GetLatestProxyConfig(&new_config);
95  if (availability != CONFIG_PENDING) {
96    FOR_EACH_OBSERVER(net::ProxyConfigService::Observer, observers_,
97                      OnProxyConfigChanged(new_config, availability));
98  }
99}
100
101void ChromeProxyConfigService::OnProxyConfigChanged(
102    const net::ProxyConfig& config,
103    ConfigAvailability availability) {
104  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO));
105
106  // Check whether there is a proxy configuration defined by preferences. In
107  // this case that proxy configuration takes precedence and the change event
108  // from the delegate proxy service can be disregarded.
109  if (!PrefProxyConfigTrackerImpl::PrefPrecedes(pref_config_state_)) {
110    net::ProxyConfig actual_config;
111    availability = GetLatestProxyConfig(&actual_config);
112    FOR_EACH_OBSERVER(net::ProxyConfigService::Observer, observers_,
113                      OnProxyConfigChanged(actual_config, availability));
114  }
115}
116
117void ChromeProxyConfigService::RegisterObserver() {
118  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO));
119  if (!registered_observer_ && base_service_.get()) {
120    base_service_->AddObserver(this);
121    registered_observer_ = true;
122  }
123}
124
125//========================= PrefProxyConfigTrackerImpl =========================
126
127PrefProxyConfigTrackerImpl::PrefProxyConfigTrackerImpl(
128    PrefService* pref_service)
129    : pref_service_(pref_service),
130      chrome_proxy_config_service_(NULL),
131      update_pending_(true) {
132  config_state_ = ReadPrefConfig(pref_service_, &pref_config_);
133  proxy_prefs_.Init(pref_service);
134  proxy_prefs_.Add(prefs::kProxy,
135                   base::Bind(&PrefProxyConfigTrackerImpl::OnProxyPrefChanged,
136                              base::Unretained(this)));
137}
138
139PrefProxyConfigTrackerImpl::~PrefProxyConfigTrackerImpl() {
140  DCHECK(pref_service_ == NULL);
141}
142
143void PrefProxyConfigTrackerImpl::SetChromeProxyConfigService(
144    ChromeProxyConfigService* chrome_proxy_config_service) {
145  VLOG(1) << this << ": set chrome proxy config service to "
146          << chrome_proxy_config_service;
147  chrome_proxy_config_service_ = chrome_proxy_config_service;
148  if (chrome_proxy_config_service_ && update_pending_)
149    OnProxyConfigChanged(config_state_, pref_config_);
150}
151
152void PrefProxyConfigTrackerImpl::DetachFromPrefService() {
153  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
154  // Stop notifications.
155  proxy_prefs_.RemoveAll();
156  pref_service_ = NULL;
157  SetChromeProxyConfigService(NULL);
158}
159
160// static
161bool PrefProxyConfigTrackerImpl::PrefPrecedes(
162    ProxyPrefs::ConfigState config_state) {
163  return config_state == ProxyPrefs::CONFIG_POLICY ||
164         config_state == ProxyPrefs::CONFIG_EXTENSION ||
165         config_state == ProxyPrefs::CONFIG_OTHER_PRECEDE;
166}
167
168// static
169net::ProxyConfigService::ConfigAvailability
170    PrefProxyConfigTrackerImpl::GetEffectiveProxyConfig(
171        ProxyPrefs::ConfigState pref_state,
172        const net::ProxyConfig& pref_config,
173        net::ProxyConfigService::ConfigAvailability system_availability,
174        const net::ProxyConfig& system_config,
175        bool ignore_fallback_config,
176        ProxyPrefs::ConfigState* effective_config_state,
177        net::ProxyConfig* effective_config) {
178  *effective_config_state = pref_state;
179
180  if (PrefPrecedes(pref_state)) {
181    *effective_config = pref_config;
182    return net::ProxyConfigService::CONFIG_VALID;
183  }
184
185  // If there's no system proxy config, fall back to prefs or default.
186  if (system_availability == net::ProxyConfigService::CONFIG_UNSET) {
187    if (pref_state == ProxyPrefs::CONFIG_FALLBACK && !ignore_fallback_config)
188      *effective_config = pref_config;
189    else
190      *effective_config = net::ProxyConfig::CreateDirect();
191    return net::ProxyConfigService::CONFIG_VALID;
192  }
193
194  *effective_config_state = ProxyPrefs::CONFIG_SYSTEM;
195  *effective_config = system_config;
196  return system_availability;
197}
198
199// static
200void PrefProxyConfigTrackerImpl::RegisterPrefs(PrefRegistrySimple* registry) {
201  DictionaryValue* default_settings = ProxyConfigDictionary::CreateSystem();
202  registry->RegisterDictionaryPref(prefs::kProxy, default_settings);
203}
204
205// static
206void PrefProxyConfigTrackerImpl::RegisterUserPrefs(
207    user_prefs::PrefRegistrySyncable* pref_service) {
208  DictionaryValue* default_settings = ProxyConfigDictionary::CreateSystem();
209  pref_service->RegisterDictionaryPref(
210      prefs::kProxy,
211      default_settings,
212      user_prefs::PrefRegistrySyncable::UNSYNCABLE_PREF);
213}
214
215// static
216ProxyPrefs::ConfigState PrefProxyConfigTrackerImpl::ReadPrefConfig(
217    const PrefService* pref_service,
218    net::ProxyConfig* config) {
219  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
220
221  // Clear the configuration and source.
222  *config = net::ProxyConfig();
223  ProxyPrefs::ConfigState config_state = ProxyPrefs::CONFIG_UNSET;
224
225  const PrefService::Preference* pref =
226      pref_service->FindPreference(prefs::kProxy);
227  DCHECK(pref);
228
229  const DictionaryValue* dict = pref_service->GetDictionary(prefs::kProxy);
230  DCHECK(dict);
231  ProxyConfigDictionary proxy_dict(dict);
232
233  if (PrefConfigToNetConfig(proxy_dict, config)) {
234    if (!pref->IsUserModifiable() || pref->HasUserSetting()) {
235      if (pref->IsManaged())
236        config_state = ProxyPrefs::CONFIG_POLICY;
237      else if (pref->IsExtensionControlled())
238        config_state = ProxyPrefs::CONFIG_EXTENSION;
239      else
240        config_state = ProxyPrefs::CONFIG_OTHER_PRECEDE;
241    } else  {
242      config_state = ProxyPrefs::CONFIG_FALLBACK;
243    }
244  }
245
246  return config_state;
247}
248
249ProxyPrefs::ConfigState PrefProxyConfigTrackerImpl::GetProxyConfig(
250    net::ProxyConfig* config) {
251  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
252  if (config_state_ != ProxyPrefs::CONFIG_UNSET)
253    *config = pref_config_;
254  return config_state_;
255}
256
257void PrefProxyConfigTrackerImpl::OnProxyConfigChanged(
258    ProxyPrefs::ConfigState config_state,
259    const net::ProxyConfig& config) {
260  if (!chrome_proxy_config_service_) {
261    VLOG(1) << "No chrome proxy config service to push to UpdateProxyConfig";
262    update_pending_ = true;
263    return;
264  }
265  update_pending_ = !BrowserThread::PostTask(
266      BrowserThread::IO, FROM_HERE,
267      base::Bind(&ChromeProxyConfigService::UpdateProxyConfig,
268                 base::Unretained(chrome_proxy_config_service_),
269                 config_state, config));
270  VLOG(1) << this << (update_pending_ ? ": Error" : ": Done")
271          << " pushing proxy to UpdateProxyConfig";
272}
273
274bool PrefProxyConfigTrackerImpl::PrefConfigToNetConfig(
275    const ProxyConfigDictionary& proxy_dict,
276    net::ProxyConfig* config) {
277  ProxyPrefs::ProxyMode mode;
278  if (!proxy_dict.GetMode(&mode)) {
279    // Fall back to system settings if the mode preference is invalid.
280    return false;
281  }
282
283  switch (mode) {
284    case ProxyPrefs::MODE_SYSTEM:
285      // Use system settings.
286      return false;
287    case ProxyPrefs::MODE_DIRECT:
288      // Ignore all the other proxy config preferences if the use of a proxy
289      // has been explicitly disabled.
290      return true;
291    case ProxyPrefs::MODE_AUTO_DETECT:
292      config->set_auto_detect(true);
293      return true;
294    case ProxyPrefs::MODE_PAC_SCRIPT: {
295      std::string proxy_pac;
296      if (!proxy_dict.GetPacUrl(&proxy_pac)) {
297        LOG(ERROR) << "Proxy settings request PAC script but do not specify "
298                   << "its URL. Falling back to direct connection.";
299        return true;
300      }
301      GURL proxy_pac_url(proxy_pac);
302      if (!proxy_pac_url.is_valid()) {
303        LOG(ERROR) << "Invalid proxy PAC url: " << proxy_pac;
304        return true;
305      }
306      config->set_pac_url(proxy_pac_url);
307      bool pac_mandatory = false;
308      proxy_dict.GetPacMandatory(&pac_mandatory);
309      config->set_pac_mandatory(pac_mandatory);
310      return true;
311    }
312    case ProxyPrefs::MODE_FIXED_SERVERS: {
313      std::string proxy_server;
314      if (!proxy_dict.GetProxyServer(&proxy_server)) {
315        LOG(ERROR) << "Proxy settings request fixed proxy servers but do not "
316                   << "specify their URLs. Falling back to direct connection.";
317        return true;
318      }
319      config->proxy_rules().ParseFromString(proxy_server);
320
321      std::string proxy_bypass;
322      if (proxy_dict.GetBypassList(&proxy_bypass)) {
323        config->proxy_rules().bypass_rules.ParseFromString(proxy_bypass);
324      }
325      return true;
326    }
327    case ProxyPrefs::kModeCount: {
328      // Fall through to NOTREACHED().
329    }
330  }
331  NOTREACHED() << "Unknown proxy mode, falling back to system settings.";
332  return false;
333}
334
335void PrefProxyConfigTrackerImpl::OnProxyPrefChanged() {
336  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
337  net::ProxyConfig new_config;
338  ProxyPrefs::ConfigState config_state = ReadPrefConfig(pref_service_,
339                                                        &new_config);
340  if (config_state_ != config_state ||
341      (config_state_ != ProxyPrefs::CONFIG_UNSET &&
342       !pref_config_.Equals(new_config))) {
343    config_state_ = config_state;
344    if (config_state_ != ProxyPrefs::CONFIG_UNSET)
345      pref_config_ = new_config;
346    update_pending_ = true;
347  }
348  if (update_pending_)
349    OnProxyConfigChanged(config_state, new_config);
350}
351