support merging regional and custom cosmetic selectors

brave · Feb 26, 2020 · b4de1ce · b4de1ce
1 parent 611881d
commit b4de1ce
Show file tree

Hide file tree

Showing 8 changed files with 86 additions and 11 deletions.
diff --git a/browser/extensions/api/brave_shields_api.cc b/browser/extensions/api/brave_shields_api.cc
@@ -93,11 +93,49 @@ BraveShieldsHiddenClassIdSelectorsFunction::Run() {
  brave_shields::HiddenClassIdSelectors::Params::Create(*args_));
  EXTENSION_FUNCTION_VALIDATE(params.get());
 
- std::string stylesheet = g_brave_browser_process->
+ base::Optional<base::Value> selectors = g_brave_browser_process->
  ad_block_service()->HiddenClassIdSelectors(params->classes,
  params->ids,
  params->exceptions);
- return RespondNow(OneArgument(std::make_unique<base::Value>(stylesheet)));
+
+ base::Optional<base::Value> regional_selectors = g_brave_browser_process->
+ ad_block_regional_service_manager()->
+ HiddenClassIdSelectors(params->classes,
+ params->ids,
+ params->exceptions);
+
+ if (selectors && selectors->is_list()) {
+ if (regional_selectors && regional_selectors->is_list()) {
+ for (auto i = regional_selectors->GetList().begin();
+ i < regional_selectors->GetList().end();
+ i++) {
+ selectors->Append(std::move(*i));
+ }
+ }
+ } else {
+ selectors = std::move(regional_selectors);
+ }
+
+ base::Optional<base::Value> custom_selectors = g_brave_browser_process->
+ ad_block_custom_filters_service()->
+ HiddenClassIdSelectors(params->classes,
+ params->ids,
+ params->exceptions);
+
+ if (selectors && custom_selectors->is_list()) {
+ if (custom_selectors && custom_selectors->is_list()) {
+ for (auto i = custom_selectors->GetList().begin();
+ i < custom_selectors->GetList().end();
+ i++) {
+ selectors->Append(std::move(*i));
+ }
+ }
+ } else {
+ selectors = std::move(custom_selectors);
+ }
+
+ return RespondNow(OneArgument(std::make_unique<base::Value>(
+ std::move(*selectors))));
 }
 
 

diff --git a/common/extensions/api/brave_shields.json b/common/extensions/api/brave_shields.json
@@ -126,7 +126,8 @@
  "parameters": [
  {
  "name": "selectorsJson",
- "type": "string"
+ "type": "array",
+ "items": {"type": "string"}
  }
  ]
  }

diff --git a/components/brave_extension/extension/brave_extension/background/api/cosmeticFilterAPI.ts b/components/brave_extension/extension/brave_extension/background/api/cosmeticFilterAPI.ts
@@ -19,8 +19,7 @@ const informTabOfCosmeticRulesToConsider = (tabId: number, selectors: string[])
 
 // Fires when content-script calls hiddenClassIdSelectors
 export const injectClassIdStylesheet = (tabId: number, classes: string[], ids: string[], exceptions: string[]) => {
- chrome.braveShields.hiddenClassIdSelectors(classes, ids, exceptions, (jsonSelectors) => {
- const selectors = JSON.parse(jsonSelectors)
+ chrome.braveShields.hiddenClassIdSelectors(classes, ids, exceptions, (selectors) => {
  informTabOfCosmeticRulesToConsider(tabId, selectors)
  })
 }

diff --git a/components/brave_shields/browser/ad_block_base_service.cc b/components/brave_shields/browser/ad_block_base_service.cc
@@ -202,13 +202,14 @@ base::Optional<base::Value> AdBlockBaseService::HostnameCosmeticResources(
  this->ad_block_client_->hostnameCosmeticResources(hostname));
 }
 
-std::string AdBlockBaseService::HiddenClassIdSelectors(
+base::Optional<base::Value> AdBlockBaseService::HiddenClassIdSelectors(
  const std::vector<std::string>& classes,
  const std::vector<std::string>& ids,
  const std::vector<std::string>& exceptions) {
- return this->ad_block_client_->hiddenClassIdSelectors(classes,
- ids,
- exceptions);
+ return base::JSONReader::Read(
+ this->ad_block_client_->hiddenClassIdSelectors(classes,
+ ids,
+ exceptions));
 }
 
 void AdBlockBaseService::GetDATFileData(const base::FilePath& dat_file_path) {

diff --git a/components/brave_shields/browser/ad_block_base_service.h b/components/brave_shields/browser/ad_block_base_service.h
@@ -49,7 +49,7 @@ class AdBlockBaseService : public BaseBraveShieldsService {
 
  base::Optional<base::Value> HostnameCosmeticResources(
  const std::string& hostname);
- std::string HiddenClassIdSelectors(
+ base::Optional<base::Value> HiddenClassIdSelectors(
  const std::vector<std::string>& classes,
  const std::vector<std::string>& ids,
  const std::vector<std::string>& exceptions);

diff --git a/components/brave_shields/browser/ad_block_regional_service_manager.cc b/components/brave_shields/browser/ad_block_regional_service_manager.cc
@@ -216,6 +216,37 @@ AdBlockRegionalServiceManager::HostnameCosmeticResources(
  return first_value;
 }
 
+base::Optional<base::Value>
+AdBlockRegionalServiceManager::HiddenClassIdSelectors(
+ const std::vector<std::string>& classes,
+ const std::vector<std::string>& ids,
+ const std::vector<std::string>& exceptions) {
+ auto it = this->regional_services_.begin();
+ if (it == this->regional_services_.end()) {
+ return base::Optional<base::Value>();
+ }
+ base::Optional<base::Value> first_value =
+ it->second->HiddenClassIdSelectors(classes, ids, exceptions);
+
+ for ( ; it != this->regional_services_.end(); it++) {
+ base::Optional<base::Value> next_value =
+ it->second->HiddenClassIdSelectors(classes, ids, exceptions);
+ if (first_value && first_value->is_list()) {
+ if (next_value && next_value->is_list()) {
+ for (auto i = next_value->GetList().begin();
+ i < next_value->GetList().end();
+ i++) {
+ first_value->Append(std::move(*i));
+ }
+ }
+ } else {
+ first_value = std::move(next_value);
+ }
+ }
+
+ return first_value;
+}
+
 // static
 bool AdBlockRegionalServiceManager::IsSupportedLocale(
  const std::string& locale) {

diff --git a/components/brave_shields/browser/ad_block_regional_service_manager.h b/components/brave_shields/browser/ad_block_regional_service_manager.h
@@ -9,6 +9,7 @@
 #include <map>
 #include <memory>
 #include <string>
+#include <vector>
 
 #include "base/macros.h"
 #include "base/memory/scoped_refptr.h"
@@ -56,6 +57,10 @@ class AdBlockRegionalServiceManager {
 
  base::Optional<base::Value> HostnameCosmeticResources(
  const std::string& hostname);
+ base::Optional<base::Value> HiddenClassIdSelectors(
+ const std::vector<std::string>& classes,
+ const std::vector<std::string>& ids,
+ const std::vector<std::string>& exceptions);
 
  private:
  friend class ::AdBlockServiceTest;

diff --git a/components/definitions/chromel.d.ts b/components/definitions/chromel.d.ts
@@ -220,7 +220,7 @@ declare namespace chrome.braveShields {
  injected_script: string
  }
  const hostnameCosmeticResources: (hostname: string, callback: (resources: HostnameSpecificResources) => void) => void
- const hiddenClassIdSelectors: (classes: string[], ids: string[], exceptions: string[], callback: (selectorsJson: string) => void) => void
+ const hiddenClassIdSelectors: (classes: string[], ids: string[], exceptions: string[], callback: (selectors: string[]) => void) => void
 
  type BraveShieldsViewPreferences = {
  showAdvancedView: boolean