Content settings extension API

chrome/browser/extensions/extension_content_settings_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_content_settings_api.h"
+
+#include "base/values.h"
+#include "chrome/browser/content_settings/host_content_settings_map.h"
+#include "chrome/browser/extensions/extension_service.h"
+#include "chrome/browser/extensions/extension_content_settings_api_constants.h"
+#include "chrome/browser/extensions/extension_content_settings_helpers.h"
+#include "chrome/browser/extensions/extension_content_settings_store.h"
+#include "chrome/browser/extensions/extension_preference_api_constants.h"
+#include "chrome/browser/extensions/extension_preference_helpers.h"
+#include "chrome/browser/profiles/profile.h"
+#include "chrome/common/extensions/extension_error_utils.h"
+
+namespace helpers = extension_content_settings_helpers;
+namespace keys = extension_content_settings_api_constants;
+namespace pref_helpers = extension_preference_helpers;
+namespace pref_keys = extension_preference_api_constants;
+
+bool ClearContentSettingsFunction::RunImpl() {
+  std::string content_type_str;
+  EXTENSION_FUNCTION_VALIDATE(
+      args_->GetString(0, &content_type_str));

[battre, 2011/06/06 23:45:13]

nit: single line?

[Bernhard Bauer, 2011/06/07 13:48:13]

Done.

+  ContentSettingsType content_type =
+      helpers::StringToContentSettingsType(content_type_str);
+  EXTENSION_FUNCTION_VALIDATE(content_type != CONTENT_SETTINGS_TYPE_DEFAULT);
+
+  DictionaryValue* details;

[battre, 2011/06/06 23:45:13]

nit: initialize with NULL

[Bernhard Bauer, 2011/06/07 13:48:13]

Done.

+  EXTENSION_FUNCTION_VALIDATE(args_->GetDictionary(1, &details));
+
+  extension_prefs_scope::Scope scope = extension_prefs_scope::kRegular;
+  if (details->HasKey(pref_keys::kScopeKey)) {
+    std::string scope_str;
+    EXTENSION_FUNCTION_VALIDATE(details->GetString(pref_keys::kScopeKey,
+                                                   &scope_str));
+
+    EXTENSION_FUNCTION_VALIDATE(pref_helpers::StringToScope(scope_str, &scope));
+    EXTENSION_FUNCTION_VALIDATE(
+        scope != extension_prefs_scope::kIncognitoPersistent);
+  }
+
+  bool incognito = (scope == extension_prefs_scope::kIncognitoPersistent ||
+                    scope == extension_prefs_scope::kIncognitoSessionOnly);
+  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.";

[battre, 2011/06/06 23:45:13]

nit: export this like keys::kInvalidUrlError?

[Bernhard Bauer, 2011/06/07 13:48:13]

Done.

+      return false;
+    }
+  }
+
+  ExtensionContentSettingsStore* store =
+      profile_->GetExtensionService()->GetExtensionContentSettingsStore();
+  store->ClearContentSettingsForExtension(extension_id(), scope);
+
+  return true;
+}
+
+bool GetContentSettingFunction::RunImpl() {
+  std::string content_type_str;
+  EXTENSION_FUNCTION_VALIDATE(
+      args_->GetString(0, &content_type_str));

[battre, 2011/06/06 23:45:13]

nit: single line?

[Bernhard Bauer, 2011/06/07 13:48:13]

Done.

+  ContentSettingsType content_type =
+      helpers::StringToContentSettingsType(content_type_str);
+  EXTENSION_FUNCTION_VALIDATE(content_type != CONTENT_SETTINGS_TYPE_DEFAULT);
+
+  DictionaryValue* details = NULL;
+  EXTENSION_FUNCTION_VALIDATE(args_->GetDictionary(1, &details));
+
+  std::string embedded_url_spec;
+  EXTENSION_FUNCTION_VALIDATE(
+      details->GetString(keys::kEmbeddedUrlKey, &embedded_url_spec));
+  GURL embedded_url(embedded_url_spec);
+  if (!embedded_url.is_valid()) {
+    error_ = ExtensionErrorUtils::FormatErrorMessage(keys::kInvalidUrlError,
+                                                     embedded_url_spec);
+    return false;
+  }
+
+  std::string top_level_url_spec;
+  EXTENSION_FUNCTION_VALIDATE(
+      details->GetString(keys::kTopLevelUrlKey, &top_level_url_spec));
+  GURL top_level_url(top_level_url_spec);
+  if (!top_level_url.is_valid()) {
+    error_ = ExtensionErrorUtils::FormatErrorMessage(keys::kInvalidUrlError,
+                                                     top_level_url_spec);
+    return false;
+  }
+
+  std::string resource_identifier;
+  if (details->HasKey(keys::kResourceIdentifierKey)) {
+    DictionaryValue* resource_identifier_dict = NULL;
+    EXTENSION_FUNCTION_VALIDATE(
+        details->GetDictionary(keys::kResourceIdentifierKey,
+                               &resource_identifier_dict));
+    EXTENSION_FUNCTION_VALIDATE(
+        resource_identifier_dict->GetString(keys::kIdKey,
+                                            &resource_identifier));
+  }
+
+  bool incognito = false;
+  if (details->HasKey(pref_keys::kIncognitoKey)) {
+    EXTENSION_FUNCTION_VALIDATE(
+        details->GetBoolean(pref_keys::kIncognitoKey, &incognito));
+  }
+  if (incognito && !include_incognito()) {
+    error_ = pref_keys::kIncognitoErrorMessage;
+    return false;
+  }
+
+  HostContentSettingsMap* map;
+  if (incognito) {
+    if (!profile()->HasOffTheRecordProfile()) {
+      // TODO(bauerb): Allow reading incognito content settings
+      // outside of an incognito session.
+      error_ = "You cannot read incognito content settings "
+               "when no incognito window is open.";

[battre, 2011/06/06 23:45:13]

nit: export error message?

[Bernhard Bauer, 2011/06/07 13:48:13]

Done.

+      return false;
+    }
+    map = profile()->GetOffTheRecordProfile()->GetHostContentSettingsMap();
+  } else {
+    map = profile()->GetHostContentSettingsMap();
+  }
+
+  ContentSetting setting;
+  if (content_type == CONTENT_SETTINGS_TYPE_COOKIES) {
+    // TODO(jochen): Do we return the value for setting or for reading cookies?

[battre, 2011/06/06 23:45:13]

add an optional parameter?

[Bernhard Bauer, 2011/06/07 13:48:13]

Hm. I'm not sure adding an additional parameter for cookies would be easy to
implement in a generic ContentSetting object. Maybe we could use the resource
identifier.

+    bool setting_cookie = false;
+    setting = map->GetCookieContentSetting(embedded_url, top_level_url,
+                                           setting_cookie);
+  } else {
+    setting = map->GetContentSetting(top_level_url, content_type,
+                                     resource_identifier);
+  }
+
+  DictionaryValue* result = new DictionaryValue();
+  result->SetString(keys::kContentSettingKey,
+                    helpers::ContentSettingToString(setting));
+
+  result_.reset(result);
+
+  return true;
+}
+
+bool SetContentSettingFunction::RunImpl() {
+  std::string content_type_str;
+  EXTENSION_FUNCTION_VALIDATE(
+      args_->GetString(0, &content_type_str));

[battre, 2011/06/06 23:45:13]

nit: single line?

[Bernhard Bauer, 2011/06/07 13:48:13]

Done.

+  ContentSettingsType content_type =
+      helpers::StringToContentSettingsType(content_type_str);
+  EXTENSION_FUNCTION_VALIDATE(content_type != CONTENT_SETTINGS_TYPE_DEFAULT);
+
+  DictionaryValue* details = NULL;
+  EXTENSION_FUNCTION_VALIDATE(args_->GetDictionary(1, &details));
+
+  DictionaryValue* top_level_pattern_dict = NULL;
+  EXTENSION_FUNCTION_VALIDATE(
+      details->GetDictionary(keys::kTopLevelPatternKey,
+                             &top_level_pattern_dict));
+  std::string top_level_pattern_str;
+  EXTENSION_FUNCTION_VALIDATE(
+      top_level_pattern_dict->GetString(keys::kPatternKey,
+                                        &top_level_pattern_str));
+  ContentSettingsPattern top_level_pattern =
+      ContentSettingsPattern::FromString(top_level_pattern_str);
+  EXTENSION_FUNCTION_VALIDATE(top_level_pattern.IsValid());
+
+  DictionaryValue* embedded_pattern_dict;

[battre, 2011/06/06 23:45:13]

nit: initialize with NULL

[Bernhard Bauer, 2011/06/07 13:48:13]

Done.

+  EXTENSION_FUNCTION_VALIDATE(
+      details->GetDictionary(keys::kEmbeddedPatternKey,
+                             &embedded_pattern_dict));
+  std::string embedded_pattern_str;
+  EXTENSION_FUNCTION_VALIDATE(
+      embedded_pattern_dict->GetString(keys::kPatternKey,
+                                       &embedded_pattern_str));
+  ContentSettingsPattern embedded_pattern =
+      ContentSettingsPattern::FromString(embedded_pattern_str);
+  EXTENSION_FUNCTION_VALIDATE(embedded_pattern.IsValid());
+
+  std::string resource_identifier;
+  if (details->HasKey(keys::kResourceIdentifierKey)) {
+    DictionaryValue* resource_identifier_dict = NULL;
+    EXTENSION_FUNCTION_VALIDATE(
+        details->GetDictionary(keys::kResourceIdentifierKey,
+                               &resource_identifier_dict));
+    EXTENSION_FUNCTION_VALIDATE(
+        resource_identifier_dict->GetString(keys::kIdKey,
+                                            &resource_identifier));
+  }
+  std::string setting_str;
+  EXTENSION_FUNCTION_VALIDATE(
+      details->GetString(keys::kContentSettingKey, &setting_str));
+  ContentSetting setting = CONTENT_SETTING_DEFAULT;
+  EXTENSION_FUNCTION_VALIDATE(
+      helpers::StringToContentSetting(setting_str, &setting));
+  EXTENSION_FUNCTION_VALIDATE(
+      HostContentSettingsMap::IsSettingAllowedForType(content_type, setting));
+
+  extension_prefs_scope::Scope scope = extension_prefs_scope::kRegular;
+  if (details->HasKey(pref_keys::kScopeKey)) {
+    std::string scope_str;
+    EXTENSION_FUNCTION_VALIDATE(details->GetString(pref_keys::kScopeKey,
+                                                   &scope_str));
+
+    EXTENSION_FUNCTION_VALIDATE(pref_helpers::StringToScope(scope_str, &scope));
+    EXTENSION_FUNCTION_VALIDATE(
+        scope != extension_prefs_scope::kIncognitoPersistent);

[battre, 2011/06/06 23:45:13]

So we do not want to allow setting default ContentSettings for incognito windows
(e.g. no Flash/Java in my incognito sessions)?

[Bernhard Bauer, 2011/06/07 13:48:13]

Not yet. Supporting this requires the incognito HostContentSettingsMap to exist
independent of the OffTheRecordProfile, which depends on some (already planned)
refactoring.

+  }
+
+  bool incognito = (scope == extension_prefs_scope::kIncognitoPersistent ||
+                    scope == extension_prefs_scope::kIncognitoSessionOnly);
+  if (incognito) {
+    // Regular profiles can't access incognito unless include_incognito is true.
+    if (!profile()->IsOffTheRecord() && !include_incognito()) {
+      error_ = pref_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.";

[battre, 2011/06/06 23:45:13]

nit: externalize error message?

[Bernhard Bauer, 2011/06/07 13:48:13]

Done.

+      return false;
+    }
+  }
+
+  if (scope == extension_prefs_scope::kIncognitoSessionOnly &&
+      !profile_->HasOffTheRecordProfile()) {
+    error_ = pref_keys::kIncognitoSessionOnlyErrorMessage;
+    return false;
+  }
+
+  ExtensionContentSettingsStore* store =
+      profile_->GetExtensionService()->GetExtensionContentSettingsStore();
+  store->SetExtensionContentSetting(extension_id(), top_level_pattern,

[battre, 2011/06/06 23:45:13]

no distinction between setting and reading cookies here?

[Bernhard Bauer, 2011/06/07 13:48:13]

For getting the content setting, HostContentSettingsMap requires the flag,
because the behavior w/r/t third-party cookie blocking depends on it (we block
setting third-party cookies, not reading them), but setting a content setting
only changes the entry in the HostContentSettingsMap. We'll probably need to
think about how to properly integrate third-party cookie blocking with content
settings based on two URLs.

+                                    embedded_pattern, content_type,
+                                    resource_identifier, setting, scope);
+  return true;
+}