Import policy data into default search dictionary pref.

chrome/browser/search_engines/default_search_policy_handler.cc

 // Copyright 2013 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/search_engines/default_search_policy_handler.h"
 
 #include "base/prefs/pref_value_map.h"
 #include "base/stl_util.h"
+#include "base/strings/string_number_conversions.h"
 #include "base/strings/string_util.h"
 #include "chrome/browser/chrome_notification_types.h"
+#include "chrome/browser/search_engines/default_search_manager.h"
 #include "chrome/browser/search_engines/search_terms_data.h"
 #include "chrome/browser/search_engines/template_url.h"
 #include "chrome/common/pref_names.h"
 #include "components/policy/core/browser/policy_error_map.h"
 #include "components/policy/core/common/policy_map.h"
 #include "content/public/browser/notification_service.h"
 #include "grit/component_strings.h"
 #include "policy/policy_constants.h"
 
 namespace policy {
 
+namespace {
+// Extract a list from a policy value and add it to a pref dictionary.

[Peter Kasting, 2014/04/29 01:47:32]

Nit: Extract -> Extracts (and similar with "add") (2 places)

Frankly, these are short enough that I'd probably inline them into the lone
caller, but up to you.

[Cait (Slow), 2014/04/29 17:14:51]

Done.

+void SetListInPref(const PolicyMap& policies,
+                   const char* policy_name,
+                   const char* key,
+                   base::DictionaryValue* dict) {
+  DCHECK(dict);
+  const base::Value* policy_value = policies.GetValue(policy_name);
+  const base::ListValue* policy_list = NULL;
+  if (policy_value) {
+    bool is_list = policy_value->GetAsList(&policy_list);
+    DCHECK(is_list);
+  }
+  dict->Set(key, policy_list ? policy_list->DeepCopy() : new base::ListValue());
+}
+
+// Extract a string from a policy value and add it to a pref dictionary.
+void SetStringInPref(const PolicyMap& policies,
+                     const char* policy_name,
+                     const char* key,
+                     base::DictionaryValue* dict) {
+  DCHECK(dict);
+  const base::Value* policy_value = policies.GetValue(policy_name);
+  std::string str;
+  if (policy_value) {
+    bool is_string = policy_value->GetAsString(&str);
+    DCHECK(is_string);
+  }
+  dict->SetString(key, str);
+}
+
+}  // namespace
+
 // List of policy types to preference names, for policies affecting the default
 // search provider.
 const PolicyToPreferenceMapEntry kDefaultSearchPolicyMap[] = {
   { key::kDefaultSearchProviderEnabled,
     prefs::kDefaultSearchProviderEnabled,
     base::Value::TYPE_BOOLEAN },
   { key::kDefaultSearchProviderName,
     prefs::kDefaultSearchProviderName,
     base::Value::TYPE_STRING },
   { key::kDefaultSearchProviderKeyword,
@@ skipping 33 matching lines @@
     prefs::kDefaultSearchProviderSuggestURLPostParams,
     base::Value::TYPE_STRING },
   { key::kDefaultSearchProviderInstantURLPostParams,
     prefs::kDefaultSearchProviderInstantURLPostParams,
     base::Value::TYPE_STRING },
   { key::kDefaultSearchProviderImageURLPostParams,
     prefs::kDefaultSearchProviderImageURLPostParams,
     base::Value::TYPE_STRING },
 };
 
+// List of policy types to preference names, for policies affecting the default
+// search provider.
+const PolicyToPreferenceMapEntry kDefaultSearchPolicyDataMap[] = {
+    {key::kDefaultSearchProviderName, DefaultSearchManager::kShortName,
+     base::Value::TYPE_STRING},
+    {key::kDefaultSearchProviderKeyword, DefaultSearchManager::kKeyword,
+     base::Value::TYPE_STRING},
+    {key::kDefaultSearchProviderSearchURL, DefaultSearchManager::kURL,
+     base::Value::TYPE_STRING},
+    {key::kDefaultSearchProviderSuggestURL,
+     DefaultSearchManager::kSuggestionsURL, base::Value::TYPE_STRING},
+    {key::kDefaultSearchProviderInstantURL, DefaultSearchManager::kInstantURL,
+     base::Value::TYPE_STRING},
+    {key::kDefaultSearchProviderIconURL, DefaultSearchManager::kFaviconURL,
+     base::Value::TYPE_STRING},
+    {key::kDefaultSearchProviderEncodings,
+     DefaultSearchManager::kInputEncodings, base::Value::TYPE_LIST},
+    {key::kDefaultSearchProviderAlternateURLs,
+     DefaultSearchManager::kAlternateURLs, base::Value::TYPE_LIST},
+    {key::kDefaultSearchProviderSearchTermsReplacementKey,
+     DefaultSearchManager::kSearchTermsReplacementKey,
+     base::Value::TYPE_STRING},
+    {key::kDefaultSearchProviderImageURL, DefaultSearchManager::kImageURL,
+     base::Value::TYPE_STRING},
+    {key::kDefaultSearchProviderNewTabURL, DefaultSearchManager::kNewTabURL,
+     base::Value::TYPE_STRING},
+    {key::kDefaultSearchProviderSearchURLPostParams,
+     DefaultSearchManager::kSearchURLPostParams, base::Value::TYPE_STRING},
+    {key::kDefaultSearchProviderSuggestURLPostParams,
+     DefaultSearchManager::kSuggestionsURLPostParams, base::Value::TYPE_STRING},
+    {key::kDefaultSearchProviderInstantURLPostParams,
+     DefaultSearchManager::kInstantURLPostParams, base::Value::TYPE_STRING},
+    {key::kDefaultSearchProviderImageURLPostParams,
+     DefaultSearchManager::kImageURLPostParams, base::Value::TYPE_STRING},
+};
+
 // DefaultSearchEncodingsPolicyHandler implementation --------------------------
 
 DefaultSearchEncodingsPolicyHandler::DefaultSearchEncodingsPolicyHandler()
     : TypeCheckingPolicyHandler(key::kDefaultSearchProviderEncodings,
                                 base::Value::TYPE_LIST) {}
 
 DefaultSearchEncodingsPolicyHandler::~DefaultSearchEncodingsPolicyHandler() {
 }
 
 void DefaultSearchEncodingsPolicyHandler::ApplyPolicySettings(
@@ skipping 65 matching lines @@
   const base::Value* url;
   std::string dummy;
   if (DefaultSearchURLIsValid(policies, &url, &dummy) ||
       !AnyDefaultSearchPoliciesSpecified(policies))
     return true;
   errors->AddError(key::kDefaultSearchProviderSearchURL, url ?
       IDS_POLICY_INVALID_SEARCH_URL_ERROR : IDS_POLICY_NOT_SPECIFIED_ERROR);
   return false;
 }
 
+void DefaultSearchPolicyHandler::HandleDictionaryPref(const PolicyMap& policies,
+                                                      PrefValueMap* prefs) {
+  if (DefaultSearchProviderIsDisabled(policies)) {
+    scoped_ptr<base::DictionaryValue> dict(new base::DictionaryValue);
+    dict->SetBoolean(DefaultSearchManager::kDisabledByPolicy, true);
+    DefaultSearchManager::AddPrefValueToMap(prefs, dict.release());

[Peter Kasting, 2014/04/29 01:47:32]

Nit: Early return and remove "else" below, to avoid indenting almost the whole
function

[Cait (Slow), 2014/04/29 17:14:51]

Done.

+  } else {
+    // The search URL is required.  The other entries are optional.  Just make
+    // sure that they are all specified via policy, so that the regular prefs
+    // aren't used.
+    const base::Value* dummy;
+    std::string url;
+    if (!DefaultSearchURLIsValid(policies, &dummy, &url))
+      return;
+
+    scoped_ptr<base::DictionaryValue> dict(new base::DictionaryValue);
+    for (size_t i = 0; i < arraysize(kDefaultSearchPolicyDataMap); ++i) {
+      const char* policy_name = kDefaultSearchPolicyDataMap[i].policy_name;
+      switch (kDefaultSearchPolicyDataMap[i].value_type) {
+        case base::Value::TYPE_STRING:
+          SetStringInPref(policies,
+                          policy_name,
+                          kDefaultSearchPolicyDataMap[i].preference_path,
+                          dict);
+          break;
+        case base::Value::TYPE_LIST:
+          SetListInPref(policies,
+                        policy_name,
+                        kDefaultSearchPolicyDataMap[i].preference_path,
+                        dict);
+          break;
+        default:
+          NOTREACHED();
+          break;
+      }
+    }
+
+    // Set the fields which are not specified by the policy to default values.
+    dict->SetString(DefaultSearchManager::kID,
+                    base::Int64ToString(kInvalidTemplateURLID));
+    dict->SetInteger(DefaultSearchManager::kPrepopulateID, 0);
+    dict->SetString(DefaultSearchManager::kSyncGUID, std::string());
+    dict->SetString(DefaultSearchManager::kOriginatingURL, std::string());
+    dict->SetBoolean(DefaultSearchManager::kSafeForAutoReplace, true);
+    dict->SetDouble(DefaultSearchManager::kDateCreated,
+                    base::Time::Now().ToInternalValue());
+    dict->SetDouble(DefaultSearchManager::kLastModified,
+                    base::Time::Now().ToInternalValue());
+    dict->SetInteger(DefaultSearchManager::kUsageCount, 0);
+    dict->SetBoolean(DefaultSearchManager::kCreatedByPolicy, true);
+
+    // For the name and keyword, default to the host if not specified.  If
+    // there is no host (file: URLs?  Not sure), use "_" to guarantee that the

[Peter Kasting, 2014/04/29 01:47:32]

Right, I believe file: URLs won't have a host.  You should check this (and you
should have a unittest covering it!) and then firm up the comment.

[Cait (Slow), 2014/04/29 17:14:51]

Done.

+    // keyword is non-empty.
+    std::string name, keyword;
+    dict->GetString(DefaultSearchManager::kKeyword, &keyword);
+    dict->GetString(DefaultSearchManager::kShortName, &name);
+    dict->GetString(DefaultSearchManager::kURL, &url);
+
+    std::string host(GURL(url).host());
+    if (host.empty())
+      host = "_";
+    if (name.empty())
+      dict->SetString(DefaultSearchManager::kShortName, host);
+    if (keyword.empty())
+      dict->SetString(DefaultSearchManager::kKeyword, host);
+
+    DefaultSearchManager::AddPrefValueToMap(prefs, dict.release());
+  }
+}
+
 void DefaultSearchPolicyHandler::ApplyPolicySettings(const PolicyMap& policies,
                                                      PrefValueMap* prefs) {
+  HandleDictionaryPref(policies, prefs);
+
   if (DefaultSearchProviderIsDisabled(policies)) {
     prefs->SetBoolean(prefs::kDefaultSearchProviderEnabled, false);
 
     // If default search is disabled, the other fields are ignored.
     prefs->SetString(prefs::kDefaultSearchProviderName, std::string());
     prefs->SetString(prefs::kDefaultSearchProviderSearchURL, std::string());
     prefs->SetString(prefs::kDefaultSearchProviderSuggestURL, std::string());
     prefs->SetString(prefs::kDefaultSearchProviderIconURL, std::string());
     prefs->SetString(prefs::kDefaultSearchProviderEncodings, std::string());
     prefs->SetString(prefs::kDefaultSearchProviderKeyword, std::string());
@@ skipping 142 matching lines @@
 void DefaultSearchPolicyHandler::EnsureListPrefExists(
     PrefValueMap* prefs,
     const std::string& path) {
   base::Value* value;
   base::ListValue* list_value;
   if (!prefs->GetValue(path, &value) || !value->GetAsList(&list_value))
     prefs->SetValue(path, new base::ListValue());
 }
 
 }  // namespace policy