Merge pull request #439 from brave/brave_shields_content_settings

Allow users to be able to change content settings set by shield extension.

browser/extensions/BUILD.gn

@@ -4,8 +4,6 @@ source_set("extensions") {
   sources = [
     "api/brave_shields_api.cc",
     "api/brave_shields_api.h",
-    "api/content_settings/brave_content_settings_store.cc",
-    "api/content_settings/brave_content_settings_store.h",
     "api/settings_private/brave_prefs_util.cc",
     "api/settings_private/brave_prefs_util.h",
     "brave_component_extension.cc",

browser/extensions/api/brave_shields_api.cc

@@ -5,14 +5,47 @@
 #include "brave/browser/extensions/api/brave_shields_api.h"
 
 #include "brave/common/extensions/api/brave_shields.h"
+#include "brave/common/extensions/extension_constants.h"
 #include "brave/components/brave_shields/browser/brave_shields_web_contents_observer.h"
+#include "chrome/browser/content_settings/host_content_settings_map_factory.h"
+#include "chrome/browser/extensions/api/content_settings/content_settings_api_constants.h"
+#include "chrome/browser/extensions/api/content_settings/content_settings_helpers.h"
+#include "chrome/browser/extensions/api/content_settings/content_settings_service.h"
+#include "chrome/browser/extensions/api/content_settings/content_settings_store.h"
+#include "chrome/browser/extensions/api/preference/preference_api_constants.h"
 #include "chrome/browser/extensions/api/tabs/tabs_constants.h"
 #include "chrome/browser/extensions/extension_tab_util.h"
 #include "chrome/browser/profiles/profile.h"
+#include "components/content_settings/core/browser/content_settings_registry.h"
+#include "components/content_settings/core/browser/content_settings_utils.h"
+#include "components/content_settings/core/browser/host_content_settings_map.h"
 #include "content/public/browser/web_contents.h"
+#include "extensions/browser/extension_util.h"
 
 using brave_shields::BraveShieldsWebContentsObserver;
 
+namespace Get = extensions::api::brave_shields::ContentSetting::Get;
+namespace Set = extensions::api::brave_shields::ContentSetting::Set;
+namespace pref_keys = extensions::preference_api_constants;
+
+namespace {
+
+bool RemoveContentType(base::ListValue* args,
+                       ContentSettingsType* content_type) {
+  std::string content_type_str;
+  if (!args->GetString(0, &content_type_str))
+    return false;
+  // We remove the ContentSettingsType parameter since this is added by the
+  // renderer, and is not part of the JSON schema.
+  args->Remove(0, nullptr);
+  *content_type =
+      extensions::content_settings_helpers::StringToContentSettingsType(
+          content_type_str);
+  return *content_type != CONTENT_SETTINGS_TYPE_DEFAULT;
+}
+
+}  // namespace
+
 namespace extensions {
 namespace api {
 
@@ -43,5 +76,180 @@ ExtensionFunction::ResponseAction BraveShieldsAllowScriptsOnceFunction::Run() {
   return RespondNow(NoArguments());
 }
 
+ExtensionFunction::ResponseAction
+BraveShieldsContentSettingGetFunction::Run() {
+  ContentSettingsType content_type;
+  EXTENSION_FUNCTION_VALIDATE(RemoveContentType(args_.get(), &content_type));
+
+  std::unique_ptr<Get::Params> params(Get::Params::Create(*args_));
+  EXTENSION_FUNCTION_VALIDATE(params.get());
+
+  GURL primary_url(params->details.primary_url);
+  if (!primary_url.is_valid()) {
+    return RespondNow(Error(content_settings_api_constants::kInvalidUrlError,
+                            params->details.primary_url));
+  }
+
+  GURL secondary_url(primary_url);
+  if (params->details.secondary_url.get()) {
+    secondary_url = GURL(*params->details.secondary_url);
+    if (!secondary_url.is_valid()) {
+      return RespondNow(Error(content_settings_api_constants::kInvalidUrlError,
+                              *params->details.secondary_url));
+    }
+  }
+
+  std::string resource_identifier;
+  if (params->details.resource_identifier.get())
+    resource_identifier = params->details.resource_identifier->id;
+
+  bool incognito = false;
+  if (params->details.incognito.get())
+    incognito = *params->details.incognito;
+  if (incognito && !include_incognito_information())
+    return RespondNow(Error(pref_keys::kIncognitoErrorMessage));
+
+  HostContentSettingsMap* map;
+  Profile* profile = Profile::FromBrowserContext(browser_context());
+  if (incognito) {
+    if (!profile->HasOffTheRecordProfile()) {
+      // TODO(bauerb): Allow reading incognito content settings
+      // outside of an incognito session.
+      return RespondNow(
+          Error(content_settings_api_constants::kIncognitoSessionOnlyError));
+    }
+    map = HostContentSettingsMapFactory::GetForProfile(
+        profile->GetOffTheRecordProfile());
+  } else {
+    map = HostContentSettingsMapFactory::GetForProfile(profile);
+  }
+
+  ContentSetting setting = map->GetContentSetting(
+      primary_url, secondary_url, content_type, resource_identifier);
+
+  std::unique_ptr<base::DictionaryValue> result(new base::DictionaryValue());
+  std::string setting_string =
+      content_settings::ContentSettingToString(setting);
+  DCHECK(!setting_string.empty());
+  result->SetString(content_settings_api_constants::kContentSettingKey,
+                    setting_string);
+
+  return RespondNow(OneArgument(std::move(result)));
+}
+
+ExtensionFunction::ResponseAction
+BraveShieldsContentSettingSetFunction::Run() {
+  ContentSettingsType content_type;
+  EXTENSION_FUNCTION_VALIDATE(RemoveContentType(args_.get(), &content_type));
+
+  std::unique_ptr<Set::Params> params(Set::Params::Create(*args_));
+  EXTENSION_FUNCTION_VALIDATE(params.get());
+
+  std::string resource_identifier;
+  if (params->details.resource_identifier.get())
+    resource_identifier = params->details.resource_identifier->id;
+
+  std::string setting_str;
+  EXTENSION_FUNCTION_VALIDATE(
+      params->details.setting->GetAsString(&setting_str));
+  ContentSetting setting;
+  EXTENSION_FUNCTION_VALIDATE(
+      content_settings::ContentSettingFromString(setting_str, &setting));
+  EXTENSION_FUNCTION_VALIDATE(CONTENT_SETTING_DEFAULT != setting);
+  EXTENSION_FUNCTION_VALIDATE(
+      content_settings::ContentSettingsRegistry::GetInstance()
+          ->Get(content_type)
+          ->IsSettingValid(setting));
+
+  std::string primary_error;
+  ContentSettingsPattern primary_pattern =
+      content_settings_helpers::ParseExtensionPattern(
+          params->details.primary_pattern, &primary_error);
+  if (!primary_pattern.IsValid())
+    return RespondNow(Error(primary_error));
+  ContentSettingsPattern secondary_pattern =
+      ContentSettingsPattern::Wildcard();
+  if (params->details.secondary_pattern.get()) {
+    std::string secondary_error;
+    secondary_pattern = content_settings_helpers::ParseExtensionPattern(
+        *params->details.secondary_pattern, &secondary_error);
+    if (!secondary_pattern.IsValid())
+      return RespondNow(Error(secondary_error));
+  }
+
+  ExtensionPrefsScope scope = kExtensionPrefsScopeRegular;
+  bool incognito = false;
+  if (params->details.scope ==
+      brave_shields::SCOPE_INCOGNITO_SESSION_ONLY) {
+    scope = kExtensionPrefsScopeIncognitoSessionOnly;
+    incognito = true;
+  }
+
+  if (incognito) {
+    // Regular profiles can't access incognito unless the extension is allowed
+    // to run in incognito contexts.
+    if (!browser_context()->IsOffTheRecord() &&
+        !extensions::util::IsIncognitoEnabled(brave_extension_id,
+                                              browser_context())) {
+      return RespondNow(Error(pref_keys::kIncognitoErrorMessage));
+    }
+  } else {
+    // Incognito profiles can't access regular mode ever, they only exist in
+    // split mode.
+    if (browser_context()->IsOffTheRecord())
+      return RespondNow(
+          Error(content_settings_api_constants::kIncognitoContextError));
+  }
+
+  if (scope == kExtensionPrefsScopeIncognitoSessionOnly &&
+      !Profile::FromBrowserContext(browser_context())
+           ->HasOffTheRecordProfile()) {
+    return RespondNow(Error(pref_keys::kIncognitoSessionOnlyErrorMessage));
+  }
+
+  HostContentSettingsMap* map;
+  Profile* profile = Profile::FromBrowserContext(browser_context());
+  if (incognito) {
+    if (!profile->HasOffTheRecordProfile()) {
+      // TODO(bauerb): Allow reading incognito content settings
+      // outside of an incognito session.
+      return RespondNow(
+          Error(content_settings_api_constants::kIncognitoSessionOnlyError));
+    }
+    map = HostContentSettingsMapFactory::GetForProfile(
+        profile->GetOffTheRecordProfile());
+  } else {
+    map = HostContentSettingsMapFactory::GetForProfile(profile);
+  }
+
+  if (content_type == CONTENT_SETTINGS_TYPE_JAVASCRIPT) {
+    // TODO(simonhong): Need to check why generating pattern with
+    // content_settings_helpers::ParseExtensionPattern() causes javascript
+    // set fail.
+    const GURL primary_url(params->details.primary_pattern);
+    if (!primary_url.is_valid())
+      return RespondNow(Error("Invalid url"));
+
+    map->SetContentSettingDefaultScope(
+        primary_url, primary_url, content_type, resource_identifier, setting);
+  } else {
+    map->SetContentSettingCustomScope(
+        primary_pattern, secondary_pattern,
+        content_type, resource_identifier, setting);
+  }
+
+  // Delete previous settings set by brave extension in extension's
+  // ContentSettingsStore. Setting default means delete.
+  scoped_refptr<ContentSettingsStore> store =
+      ContentSettingsService::Get(browser_context())->content_settings_store();
+  store->SetExtensionContentSetting(brave_extension_id,
+                                    primary_pattern, secondary_pattern,
+                                    content_type,
+                                    resource_identifier,
+                                    CONTENT_SETTING_DEFAULT,
+                                    scope);
+  return RespondNow(NoArguments());
+}
+
 }  // namespace api
 }  // namespace extensions

browser/extensions/api/brave_shields_api.h

@@ -20,6 +20,30 @@ class BraveShieldsAllowScriptsOnceFunction : public UIThreadExtensionFunction {
   ResponseAction Run() override;
 };
 
+class BraveShieldsContentSettingGetFunction
+    : public UIThreadExtensionFunction {
+ public:
+  DECLARE_EXTENSION_FUNCTION("braveShields.get", UNKNOWN)
+
+ protected:
+  ~BraveShieldsContentSettingGetFunction() override {}
+
+  // ExtensionFunction:
+  ResponseAction Run() override;
+};
+
+class BraveShieldsContentSettingSetFunction
+    : public UIThreadExtensionFunction {
+ public:
+  DECLARE_EXTENSION_FUNCTION("braveShields.set", UNKNOWN)
+
+ protected:
+  ~BraveShieldsContentSettingSetFunction() override {}
+
+  // ExtensionFunction:
+  ResponseAction Run() override;
+};
+
 }  // namespace api
 }  // namespace extensions