Content settings extension API

chrome/browser/extensions/extension_preference_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_preference_api.h"
 
 #include <map>
 
 #include "base/json/json_writer.h"
 #include "base/memory/singleton.h"
 #include "base/stl_util-inl.h"
 #include "base/stringprintf.h"
 #include "base/values.h"
 #include "chrome/browser/extensions/extension_event_router.h"
+#include "chrome/browser/extensions/extension_preference_api_constants.h"
+#include "chrome/browser/extensions/extension_preference_helpers.h"
 #include "chrome/browser/extensions/extension_prefs.h"
 #include "chrome/browser/extensions/extension_prefs_scope.h"
 #include "chrome/browser/extensions/extension_proxy_api.h"
 #include "chrome/browser/extensions/extension_service.h"
 #include "chrome/browser/profiles/profile.h"
+#include "chrome/common/extensions/extension_error_utils.h"
 #include "chrome/common/pref_names.h"
 #include "content/common/notification_type.h"
 #include "content/common/notification_service.h"
 
 namespace {
 
 struct PrefMappingEntry {
   const char* extension_pref;
   const char* browser_pref;
   const char* permission;
 };
 
 const char kNotControllable[] = "not_controllable";
 const char kControlledByOtherExtensions[] = "controlled_by_other_extensions";
 const char kControllableByThisExtension[] = "controllable_by_this_extension";
 const char kControlledByThisExtension[] = "controlled_by_this_extension";
 
-const char kIncognito[] = "incognito";
 const char kIncognitoSpecific[] = "incognitoSpecific";
-const char kScope[] = "scope";
 const char kLevelOfControl[] = "levelOfControl";
-const char kRegular[] = "regular";
-const char kIncognitoPersistent[] = "incognito_persistent";
-const char kIncognitoSessionOnly[] = "incognito_session_only";
 const char kValue[] = "value";
 
 const char kOnPrefChangeFormat[] = "types.ChromeSetting.%s.onChange";
 
-const char kIncognitoErrorMessage[] =
-    "You do not have permission to access incognito preferences.";
-
-const char kIncognitoSessionOnlyErrorMessage[] =
-    "You cannot set a preference with scope 'incognito_session_only' when no "
-    "incognito window is open.";
-
-const char kPermissionErrorMessage[] =
-    "You do not have permission to access the preference '%s'. "
-    "Be sure to declare in your manifest what permissions you need.";
-
 PrefMappingEntry kPrefMapping[] = {
   { "thirdPartyCookiesAllowed",
     prefs::kBlockThirdPartyCookies,
     Extension::kContentSettingsPermission
   },
   { "referrersEnabled",
     prefs::kEnableReferrers,
     Extension::kContentSettingsPermission
   },
   { "hyperlinkAuditingEnabled",
@@ skipping 59 matching lines @@
 
   if (ep->DoesExtensionControlPref(extension_id, browser_pref, incognito))
     return kControlledByThisExtension;
 
   if (ep->CanExtensionControlPref(extension_id, browser_pref, incognito))
     return kControllableByThisExtension;
 
   return kControlledByOtherExtensions;
 }
 
-bool StringToScope(const std::string& s, ExtensionPrefsScope* scope) {
-  if (s == kRegular)
-    *scope = kExtensionPrefsScopeRegular;
-  else if (s == kIncognitoPersistent)
-    *scope = kExtensionPrefsScopeIncognitoPersistent;
-  else if (s == kIncognitoSessionOnly)
-    *scope = kExtensionPrefsScopeIncognitoSessionOnly;
-  else
-    return false;
-  return true;
-}
-
 class PrefMapping {
  public:
   static PrefMapping* GetInstance() {
     return Singleton<PrefMapping>::get();
   }
 
   bool FindBrowserPrefForExtensionPref(const std::string& extension_pref,
                                        std::string* browser_pref,
                                        std::string* permission) {
     std::map<std::string, std::pair<std::string, std::string> >::iterator it =
@@ skipping 72 matching lines @@
   // Mapping from browser pref keys to transformers.
   std::map<std::string, PrefTransformerInterface*> transformers_;
 
   scoped_ptr<PrefTransformerInterface> identity_transformer_;
 
   DISALLOW_COPY_AND_ASSIGN(PrefMapping);
 };
 
 }  // namespace
 
+namespace keys = extension_preference_api_constants;
+namespace helpers = extension_preference_helpers;
+
 ExtensionPreferenceEventRouter::ExtensionPreferenceEventRouter(
     Profile* profile) : profile_(profile) {
   registrar_.Init(profile_->GetPrefs());
   incognito_registrar_.Init(profile_->GetOffTheRecordPrefs());
   for (size_t i = 0; i < arraysize(kPrefMapping); ++i) {
     registrar_.Add(kPrefMapping[i].browser_pref, this);
     incognito_registrar_.Add(kPrefMapping[i].browser_pref, this);
   }
 }
 
@@ skipping 28 matching lines @@
   args.Append(dict);
   const PrefService::Preference* pref =
       pref_service->FindPreference(browser_pref.c_str());
   CHECK(pref);
   ExtensionService* extension_service = profile_->GetExtensionService();
   PrefTransformerInterface* transformer =
       PrefMapping::GetInstance()->FindTransformerForBrowserPref(browser_pref);
   dict->Set(kValue, transformer->BrowserToExtensionPref(pref->GetValue()));
   if (incognito) {
     ExtensionPrefs* ep = extension_service->extension_prefs();
-    dict->Set(
-        kIncognitoSpecific,
-        Value::CreateBooleanValue(ep->HasIncognitoPrefValue(browser_pref)));
+    dict->SetBoolean(kIncognitoSpecific,
+                     ep->HasIncognitoPrefValue(browser_pref));
   }
 
   ExtensionEventRouter* router = profile_->GetExtensionEventRouter();
   if (!router || !router->HasEventListener(event_name))
     return;
   const ExtensionList* extensions = extension_service->extensions();
   for (ExtensionList::const_iterator it = extensions->begin();
        it != extensions->end(); ++it) {
     std::string extension_id = (*it)->id();
     // TODO(bauerb): Only iterate over registered event listeners.
     if (router->ExtensionHasEventListener(extension_id, event_name) &&
         (*it)->HasApiPermission(permission) &&
         (!incognito || extension_service->CanCrossIncognito(*it))) {
       std::string level_of_control =
           GetLevelOfControl(profile_, extension_id, browser_pref, incognito);
-      dict->Set(kLevelOfControl, Value::CreateStringValue(level_of_control));
+      dict->SetString(kLevelOfControl, level_of_control);
 
       std::string json_args;
       base::JSONWriter::Write(&args, false, &json_args);
 
       DispatchEvent(extension_id, event_name, json_args);
     }
   }
 }
 
 void ExtensionPreferenceEventRouter::DispatchEvent(
     const std::string& extension_id,
     const std::string& event_name,
     const std::string& json_args) {
   profile_->GetExtensionEventRouter()->DispatchEventToExtension(
       extension_id, event_name, json_args, NULL, GURL());
 }
 
 // TODO(battre): Factor out common parts once this is stable.
 
 GetPreferenceFunction::~GetPreferenceFunction() { }
 
 bool GetPreferenceFunction::RunImpl() {
   std::string pref_key;
   EXTENSION_FUNCTION_VALIDATE(args_->GetString(0, &pref_key));
   DictionaryValue* details = NULL;
   EXTENSION_FUNCTION_VALIDATE(args_->GetDictionary(1, &details));
 
   bool incognito = false;
-  if (details->HasKey(kIncognito))
-    EXTENSION_FUNCTION_VALIDATE(details->GetBoolean(kIncognito, &incognito));
+  if (details->HasKey(keys::kIncognitoKey))
+    EXTENSION_FUNCTION_VALIDATE(details->GetBoolean(keys::kIncognitoKey,
+                                                    &incognito));
 
   if (incognito && !include_incognito()) {
-    error_ = kIncognitoErrorMessage;
+    error_ = keys::kIncognitoErrorMessage;
     return false;
   }
 
   PrefService* prefs = incognito ? profile_->GetOffTheRecordPrefs()
                                  : profile_->GetPrefs();
   std::string browser_pref;
   std::string permission;
   EXTENSION_FUNCTION_VALIDATE(
       PrefMapping::GetInstance()->FindBrowserPrefForExtensionPref(
           pref_key, &browser_pref, &permission));
   if (!GetExtension()->HasApiPermission(permission)) {
-    error_ = base::StringPrintf(kPermissionErrorMessage, pref_key.c_str());
+    error_ = ExtensionErrorUtils::FormatErrorMessage(
+        keys::kPermissionErrorMessage, pref_key);
     return false;
   }
 
   const PrefService::Preference* pref =
       prefs->FindPreference(browser_pref.c_str());
   CHECK(pref);
   std::string level_of_control =
       GetLevelOfControl(profile_, extension_id(), browser_pref, incognito);
 
   scoped_ptr<DictionaryValue> result(new DictionaryValue);
   PrefTransformerInterface* transformer =
       PrefMapping::GetInstance()->FindTransformerForBrowserPref(browser_pref);
   result->Set(kValue, transformer->BrowserToExtensionPref(pref->GetValue()));
-  result->Set(kLevelOfControl, Value::CreateStringValue(level_of_control));
+  result->SetString(kLevelOfControl, level_of_control);
   if (incognito) {
     ExtensionPrefs* ep = profile_->GetExtensionService()->extension_prefs();
-    result->Set(
-        kIncognitoSpecific,
-        Value::CreateBooleanValue(ep->HasIncognitoPrefValue(browser_pref)));
+    result->SetBoolean(kIncognitoSpecific,
+                       ep->HasIncognitoPrefValue(browser_pref));
   }
   result_.reset(result.release());
   return true;
 }
 
 SetPreferenceFunction::~SetPreferenceFunction() { }
 
 bool SetPreferenceFunction::RunImpl() {
   std::string pref_key;
   EXTENSION_FUNCTION_VALIDATE(args_->GetString(0, &pref_key));
   DictionaryValue* details = NULL;
   EXTENSION_FUNCTION_VALIDATE(args_->GetDictionary(1, &details));
 
   Value* value = NULL;
   EXTENSION_FUNCTION_VALIDATE(details->Get(kValue, &value));
 
-  std::string scope_str = kRegular;
-  if (details->HasKey(kScope))
-    EXTENSION_FUNCTION_VALIDATE(details->GetString(kScope, &scope_str));
+  ExtensionPrefsScope scope = kExtensionPrefsScopeRegular;
+  if (details->HasKey(keys::kScopeKey)) {
+    std::string scope_str;
+    EXTENSION_FUNCTION_VALIDATE(
+        details->GetString(keys::kScopeKey, &scope_str));
 
-  ExtensionPrefsScope scope;
-  EXTENSION_FUNCTION_VALIDATE(StringToScope(scope_str, &scope));
+    EXTENSION_FUNCTION_VALIDATE(helpers::StringToScope(scope_str, &scope));
+  }
 
   bool incognito = (scope == kExtensionPrefsScopeIncognitoPersistent ||
                     scope == kExtensionPrefsScopeIncognitoSessionOnly);
   if (incognito) {
     // Regular profiles can't access incognito unless include_incognito is true.
     if (!profile()->IsOffTheRecord() && !include_incognito()) {
-      error_ = kIncognitoErrorMessage;
+      error_ = keys::kIncognitoErrorMessage;
       return false;
     }
   } else {
     // Incognito profiles can't access regular mode ever, they only exist in
     // split mode.
     if (profile()->IsOffTheRecord()) {
       error_ = "Can't modify regular settings from an incognito context.";
       return false;
     }
   }
 
   if (scope == kExtensionPrefsScopeIncognitoSessionOnly &&
       !profile_->HasOffTheRecordProfile()) {
-    error_ = kIncognitoSessionOnlyErrorMessage;
+    error_ = keys::kIncognitoSessionOnlyErrorMessage;
     return false;
   }
 
-  if (scope == kExtensionPrefsScopeIncognitoSessionOnly &&
-      !profile_->HasOffTheRecordProfile()) {
-    error_ = kIncognitoSessionOnlyErrorMessage;
-    return false;
-  }
-
   std::string browser_pref;
   std::string permission;
   EXTENSION_FUNCTION_VALIDATE(
       PrefMapping::GetInstance()->FindBrowserPrefForExtensionPref(
           pref_key, &browser_pref, &permission));
   if (!GetExtension()->HasApiPermission(permission)) {
-    error_ = base::StringPrintf(kPermissionErrorMessage, pref_key.c_str());
+    error_ = ExtensionErrorUtils::FormatErrorMessage(
+        keys::kPermissionErrorMessage, pref_key);
     return false;
   }
   ExtensionPrefs* prefs = profile_->GetExtensionService()->extension_prefs();
   const PrefService::Preference* pref =
       prefs->pref_service()->FindPreference(browser_pref.c_str());
   CHECK(pref);
   EXTENSION_FUNCTION_VALIDATE(value->GetType() == pref->GetType());
   PrefTransformerInterface* transformer =
       PrefMapping::GetInstance()->FindTransformerForBrowserPref(browser_pref);
   std::string error;
@@ skipping 13 matching lines @@
 }
 
 ClearPreferenceFunction::~ClearPreferenceFunction() { }
 
 bool ClearPreferenceFunction::RunImpl() {
   std::string pref_key;
   EXTENSION_FUNCTION_VALIDATE(args_->GetString(0, &pref_key));
   DictionaryValue* details = NULL;
   EXTENSION_FUNCTION_VALIDATE(args_->GetDictionary(1, &details));
 
-  std::string scope_str = kRegular;
-  if (details->HasKey(kScope))
-    EXTENSION_FUNCTION_VALIDATE(details->GetString(kScope, &scope_str));
+  ExtensionPrefsScope scope = kExtensionPrefsScopeRegular;
+  if (details->HasKey(keys::kScopeKey)) {
+    std::string scope_str;
+    EXTENSION_FUNCTION_VALIDATE(
+        details->GetString(keys::kScopeKey, &scope_str));
 
-  ExtensionPrefsScope scope;
-  EXTENSION_FUNCTION_VALIDATE(StringToScope(scope_str, &scope));
+    EXTENSION_FUNCTION_VALIDATE(helpers::StringToScope(scope_str, &scope));
+  }
 
   bool incognito = (scope == kExtensionPrefsScopeIncognitoPersistent ||
                     scope == kExtensionPrefsScopeIncognitoSessionOnly);
   if (incognito) {
     // We don't check incognito permissions here, as an extension should be
     // always allowed to clear its own settings.
   } else {
     // Incognito profiles can't access regular mode ever, they only exist in
     // split mode.
     if (profile()->IsOffTheRecord()) {
       error_ = "Can't modify regular settings from an incognito context.";
       return false;
     }
   }
 
   std::string browser_pref;
   std::string permission;
   EXTENSION_FUNCTION_VALIDATE(
       PrefMapping::GetInstance()->FindBrowserPrefForExtensionPref(
           pref_key, &browser_pref, &permission));
   if (!GetExtension()->HasApiPermission(permission)) {
-    error_ = base::StringPrintf(kPermissionErrorMessage, pref_key.c_str());
+    error_ = ExtensionErrorUtils::FormatErrorMessage(
+        keys::kPermissionErrorMessage, pref_key);
     return false;
   }
   ExtensionPrefs* prefs = profile_->GetExtensionService()->extension_prefs();
   prefs->RemoveExtensionControlledPref(extension_id(), browser_pref, scope);
   return true;
 }