Implementation of getCurrentProxySettings for proxy settings API.

chrome/browser/extensions/extension_proxy_api.cc

 // 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.
 
 #include "chrome/browser/extensions/extension_proxy_api.h"
 
 #include "base/string_util.h"
 #include "base/values.h"
 #include "chrome/browser/prefs/proxy_config_dictionary.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/browser/extensions/extension_service.h"
 #include "chrome/common/pref_names.h"
-#include "net/base/host_port_pair.h"
-#include "net/proxy/proxy_server.h"
+#include "net/proxy/proxy_config.h"
 
 namespace {
 
 // The scheme for which to use a manually specified proxy, not of the proxy URI
 // itself.
 enum {
   SCHEME_ALL = 0,
   SCHEME_HTTP,
   SCHEME_HTTPS,
   SCHEME_FTP,
@@ skipping 11 matching lines @@
 
 // The names of the schemes to be used to build the preference value string
 // for manual proxy settings.  These must be kept in sync with the SCHEME_*
 // constants.
 const char* scheme_name[] = { "*error*",
                               "http",
                               "https",
                               "ftp",
                               "socks" };
 
+// String literals in dictionaries used to communicate with extension.
+const char kProxyCfgMode[] = "mode";
+const char kProxyCfgPacScript[] = "pacScript";
+const char kProxyCfgPacScriptUrl[] = "url";
+const char kProxyCfgRules[] = "rules";
+const char kProxyCfgRuleHost[] = "host";
+const char kProxyCfgRulePort[] = "port";
+const char kProxyCfgScheme[] = "scheme";
+
 COMPILE_ASSERT(SCHEME_MAX == SCHEME_SOCKS, SCHEME_MAX_must_equal_SCHEME_SOCKS);
 COMPILE_ASSERT(arraysize(field_name) == SCHEME_MAX + 1,
                field_name_array_is_wrong_size);
 COMPILE_ASSERT(arraysize(scheme_name) == SCHEME_MAX + 1,
                scheme_name_array_is_wrong_size);
 COMPILE_ASSERT(SCHEME_ALL == 0, singleProxy_must_be_first_option);
 
 // Converts a proxy server description |dict| as passed by the API caller
 // (e.g. for the http proxy in the rules element) and converts it to a
 // ProxyServer. Returns true if successful.
 bool GetProxyServer(const DictionaryValue* dict,
                     net::ProxyServer::Scheme default_scheme,
                     net::ProxyServer* proxy_server) {
   std::string scheme_string;  // optional.
-  dict->GetString("scheme", &scheme_string);
+  dict->GetString(kProxyCfgScheme, &scheme_string);
 
   net::ProxyServer::Scheme scheme =
       net::ProxyServer::GetSchemeFromURI(scheme_string);
   if (scheme == net::ProxyServer::SCHEME_INVALID)
     scheme = default_scheme;
 
   std::string host;
-  if (!dict->GetString("host", &host))
+  if (!dict->GetString(kProxyCfgRuleHost, &host))
     return false;
 
   int port;  // optional.
-  if (!dict->GetInteger("port", &port))
+  if (!dict->GetInteger(kProxyCfgRulePort, &port))
     port = net::ProxyServer::GetDefaultPortForScheme(scheme);
 
   *proxy_server = net::ProxyServer(scheme, net::HostPortPair(host, port));
 
   return true;
 }
 
 // Converts a proxy "rules" element passed by the API caller into a proxy
 // configuration string that can be used by the proxy subsystem (see
 // proxy_config.h). Returns true if successful.
@@ skipping 74 matching lines @@
 bool UseCustomProxySettingsFunction::RunImpl() {
   DictionaryValue* proxy_config;
   EXTENSION_FUNCTION_VALIDATE(args_->GetDictionary(0, &proxy_config));
 
   bool incognito = false;  // Optional argument, defaults to false.
   if (HasOptionalArgument(1)) {
     EXTENSION_FUNCTION_VALIDATE(args_->GetBoolean(1, &incognito));
   }
 
   std::string proxy_mode;
-  proxy_config->GetString("mode", &proxy_mode);
+  proxy_config->GetString(kProxyCfgMode, &proxy_mode);
   ProxyPrefs::ProxyMode mode_enum;
   if (!ProxyPrefs::StringToProxyMode(proxy_mode, &mode_enum)) {
     LOG(ERROR) << "Invalid mode for proxy settings: " << proxy_mode << ". "
                << "Setting custom proxy settings failed.";
     return false;
   }
 
   DictionaryValue* pac_dict = NULL;
-  proxy_config->GetDictionary("pacScript", &pac_dict);
+  proxy_config->GetDictionary(kProxyCfgPacScript, &pac_dict);
   std::string pac_url;
-  if (pac_dict && !pac_dict->GetString("url", &pac_url)) {
+  if (pac_dict && !pac_dict->GetString(kProxyCfgPacScriptUrl, &pac_url)) {
     LOG(ERROR) << "'pacScript' requires a 'url' field. "
                << "Setting custom proxy settings failed.";
     return false;
   }
 
   DictionaryValue* proxy_rules = NULL;
-  proxy_config->GetDictionary("rules", &proxy_rules);
+  proxy_config->GetDictionary(kProxyCfgRules, &proxy_rules);
   std::string proxy_rules_string;
   if (proxy_rules && !GetProxyRules(proxy_rules, &proxy_rules_string)) {
     LOG(ERROR) << "Invalid 'rules' specified. "
                << "Setting custom proxy settings failed.";
     return false;
   }
 
   // not supported, yet.
   std::string bypass_list;
 
@@ skipping 39 matching lines @@
 
 bool RemoveCustomProxySettingsFunction::RunImpl() {
   bool incognito = false;
   if (HasOptionalArgument(0)) {
     EXTENSION_FUNCTION_VALIDATE(args_->GetBoolean(0, &incognito));
   }
 
   RemovePreference(prefs::kProxy, incognito);
   return true;
 }
+
+bool GetCurrentProxySettingsFunction::RunImpl() {
+  bool incognito = false;
+  EXTENSION_FUNCTION_VALIDATE(args_->GetBoolean(0, &incognito));
+
+  // This is how it is stored in the PrefStores:
+  const DictionaryValue* proxy_prefs;
+
+  if (profile_->IsOffTheRecord() && !incognito) {

[Bernhard Bauer, 2011/02/10 12:38:01]

Does this really happen? I thought |profile_| is always the regular one.

[battre, 2011/02/10 13:42:36]

I have added all access to profile_ as follows

  Profile* profile = profile();
  if (profile->IsOffTheRecord())
    profile = profile->GetOriginalProfile();

and added a TODO to ask mpcomplete to review this code w.r.t. the
include_incognito flag.

+    LOG(ERROR) << "Incognito profile cannot access the regular profile";
+  }
+  PrefService* prefs = incognito ? profile_->GetOffTheRecordPrefs()
+                                 : profile_->GetPrefs();
+  proxy_prefs = prefs->GetDictionary(prefs::kProxy);
+
+  // This is how it is presented to the API caller:
+  scoped_ptr<DictionaryValue> out(new DictionaryValue);
+
+  if (!ConvertToApiFormat(proxy_prefs, out.get()))
+    return false;
+
+  result_.reset(out.release());
+  return true;
+}
+
+bool GetCurrentProxySettingsFunction::ConvertToApiFormat(
+    const DictionaryValue* proxy_prefs,
+    DictionaryValue* api_proxy_config) const {
+  ProxyConfigDictionary dict(proxy_prefs);
+
+  ProxyPrefs::ProxyMode mode;
+  if (!dict.GetMode(&mode)) {
+    LOG(ERROR) << "Cannot determine proxy mode.";
+    return false;
+  }
+  api_proxy_config->SetString(kProxyCfgMode,
+                              ProxyPrefs::ProxyModeToString(mode));
+
+  switch (mode) {
+    case ProxyPrefs::MODE_DIRECT:
+    case ProxyPrefs::MODE_AUTO_DETECT:
+    case ProxyPrefs::MODE_SYSTEM:
+      // These modes have no further parameters.
+      break;
+    case ProxyPrefs::MODE_PAC_SCRIPT: {
+      std::string pac_url;
+      if (!dict.GetPacUrl(&pac_url)) {
+        LOG(ERROR) << "Missing pac url";
+        return false;
+      }
+      DictionaryValue* pac_dict = new DictionaryValue;
+      pac_dict->SetString(kProxyCfgPacScriptUrl, pac_url);
+      api_proxy_config->Set(kProxyCfgPacScript, pac_dict);
+      break;
+    }
+    case ProxyPrefs::MODE_FIXED_SERVERS: {
+      // TODO(battre): Handle bypass list.
+      std::string proxy_servers;
+      if (!dict.GetProxyServer(&proxy_servers)) {
+        LOG(ERROR) << "Missing proxy servers";
+        return false;
+      }
+      DictionaryValue* rules_dict = new DictionaryValue;
+      if (!ParseRules(proxy_servers, &rules_dict)) {
+        LOG(ERROR) << "Could not parse proxy rules";
+        return false;
+      }
+      api_proxy_config->Set(kProxyCfgRules, rules_dict);
+      break;
+    }
+    case ProxyPrefs::kModeCount:
+      NOTREACHED();
+  }
+  return true;
+}
+
+bool GetCurrentProxySettingsFunction::ParseRules(const std::string& rules,
+                                                 DictionaryValue** out) const {
+  net::ProxyConfig::ProxyRules config;
+  config.ParseFromString(rules);
+  switch (config.type) {
+    case net::ProxyConfig::ProxyRules::TYPE_NO_RULES:
+      return false;
+    case net::ProxyConfig::ProxyRules::TYPE_SINGLE_PROXY:
+      if (config.single_proxy.is_valid()) {
+        (*out)->Set(field_name[SCHEME_ALL],
+                    ConvertToDictionary(config.single_proxy));
+      }
+      break;
+    case net::ProxyConfig::ProxyRules::TYPE_PROXY_PER_SCHEME:
+      if (config.proxy_for_http.is_valid()) {
+        (*out)->Set(field_name[SCHEME_HTTP],
+                    ConvertToDictionary(config.proxy_for_http));
+      }
+      if (config.proxy_for_https.is_valid()) {
+        (*out)->Set(field_name[SCHEME_HTTPS],
+                    ConvertToDictionary(config.proxy_for_https));
+      }
+      if (config.proxy_for_ftp.is_valid()) {
+        (*out)->Set(field_name[SCHEME_FTP],
+                    ConvertToDictionary(config.proxy_for_ftp));
+      }
+      if (config.fallback_proxy.is_valid()) {
+        (*out)->Set(field_name[SCHEME_SOCKS],
+                    ConvertToDictionary(config.fallback_proxy));
+      }
+      COMPILE_ASSERT(SCHEME_MAX == 4, SCHEME_FORGOTTEN);
+      break;
+  }
+  return true;
+}
+
+DictionaryValue* GetCurrentProxySettingsFunction::ConvertToDictionary(
+    const net::ProxyServer& proxy) const {
+  // Creates a
+  // {
+  //   scheme ( optional enumerated string
+  //            ["http", "https", "socks", "socks4", "socks5"] ),
+  //   host ( string ),
+  //   port ( optional integer )
+  // }
+  // dictionary.

[Bernhard Bauer, 2011/02/10 12:38:01]

You could just refer to the ProxyServer type in |experimental.proxy|, which has
autogenerated documentation. That way, it's always current.

[battre, 2011/02/10 13:42:36]

Deleted the comment and added the reference in the header file.

Done.

+
+  DictionaryValue* out = new DictionaryValue;
+
+  switch (proxy.scheme()) {
+    case net::ProxyServer::SCHEME_HTTP:
+      out->SetString(kProxyCfgScheme, "http");
+      break;
+    case net::ProxyServer::SCHEME_HTTPS:
+      out->SetString(kProxyCfgScheme, "https");
+      break;
+    case net::ProxyServer::SCHEME_SOCKS4:
+      out->SetString(kProxyCfgScheme, "socks4");
+      break;
+    case net::ProxyServer::SCHEME_SOCKS5:
+      out->SetString(kProxyCfgScheme, "socks5");
+      break;
+    case net::ProxyServer::SCHEME_DIRECT:
+    case net::ProxyServer::SCHEME_INVALID:
+      NOTREACHED();
+      return out;
+  }
+  out->SetString(kProxyCfgRuleHost, proxy.host_port_pair().host());
+  out->SetInteger(kProxyCfgRulePort, proxy.host_port_pair().port());
+  return out;
+}