PawletOS/cromite
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
create-pull-request/patch-cdf415c
cromite/build/patches/Bromite-subresource-adblocker.patch
T

2028 lines
84 KiB
Diff
Raw Permalink Blame History

From: csagan5 <32685696+csagan5@users.noreply.github.com>
Date: Sat, 14 Sep 2019 10:20:08 +0200
Subject: Bromite subresource adblocker
Add option to configure the ad blocker filters URL
Disable look-alike, metrics, ablation and navigation throttles
Do not use experiments to enable/disable presets
Always enable ad filtering
Download filters by checking Last-Modified header first
Fix RestoreForeignSessionTab by recreating the tab (issue #681)
Enable AutomaticLazyFrameLoadingToAds and AutomaticLazyFrameLoadingToEmbeds features
License: GPL-3.0-only - https://spdx.org/licenses/GPL-3.0-only.html
---
chrome/android/BUILD.gn | 1 +
chrome/android/chrome_java_resources.gni | 2 +
chrome/android/chrome_java_sources.gni | 2 +
.../java/res/layout/adblock_editor.xml | 67 +++++
chrome/android/java/res/values/styles.xml | 18 ++
chrome/android/java/res/values/values.xml | 4 +
.../java/res/xml/adblock_preferences.xml | 25 ++
.../android/java/res/xml/main_preferences.xml | 5 +
.../browser/settings/AdBlockEditor.java | 91 ++++++
.../browser/settings/AdBlockPreferences.java | 76 +++++
.../browser/settings/SettingsActivity.java | 3 +
chrome/app/generated_resources.grd | 10 +
chrome/browser/after_startup_task_utils.cc | 5 +
chrome/browser/browser_process.h | 5 +
chrome/browser/browser_process_impl.cc | 30 ++
chrome/browser/browser_process_impl.h | 2 +
chrome/browser/chrome_browser_main.cc | 3 +
chrome/browser/flags/BUILD.gn | 3 +
.../flags/android/adblock_native_gateway.cc | 33 ++
.../browser/flags/AdBlockNativeGateway.java | 30 ++
.../net/system_network_context_manager.cc | 4 +
.../strings/android_chrome_strings.grd | 14 +
chrome/common/pref_names.h | 5 +
.../strings/android/site_settings.grdp | 3 +
components/component_updater/BUILD.gn | 8 +
.../adblock_updater_service.cc | 281 ++++++++++++++++++
.../adblock_updater_service.h | 103 +++++++
.../download_filters_task.cc | 250 ++++++++++++++++
.../component_updater/download_filters_task.h | 129 ++++++++
...ent_subresource_filter_throttle_manager.cc | 15 +
...tent_subresource_filter_throttle_manager.h | 2 +
.../content/browser/ruleset_service.cc | 44 ++-
.../content/browser/ruleset_service.h | 8 +-
.../unindexed_ruleset_stream_generator.cc | 3 +
.../core/browser/ruleset_version.h | 4 +
.../browser/subresource_filter_features.cc | 118 +-------
.../core/browser/verified_ruleset_dealer.cc | 4 +
.../core/common/indexed_ruleset.cc | 5 +-
38 files changed, 1288 insertions(+), 127 deletions(-)
create mode 100644 chrome/android/java/res/layout/adblock_editor.xml
create mode 100644 chrome/android/java/res/xml/adblock_preferences.xml
create mode 100644 chrome/android/java/src/org/chromium/chrome/browser/settings/AdBlockEditor.java
create mode 100644 chrome/android/java/src/org/chromium/chrome/browser/settings/AdBlockPreferences.java
create mode 100755 chrome/browser/flags/android/adblock_native_gateway.cc
create mode 100755 chrome/browser/flags/android/java/src/org/chromium/chrome/browser/flags/AdBlockNativeGateway.java
create mode 100644 components/component_updater/adblock_updater_service.cc
create mode 100644 components/component_updater/adblock_updater_service.h
create mode 100644 components/component_updater/download_filters_task.cc
create mode 100644 components/component_updater/download_filters_task.h
diff --git a/chrome/android/BUILD.gn b/chrome/android/BUILD.gn
--- a/chrome/android/BUILD.gn
+++ b/chrome/android/BUILD.gn
@@ -317,6 +317,7 @@ if (_is_default_toolchain) {
"//chrome/android/features/tab_ui/public:ui_java_resources",
"//chrome/android/modules/stack_unwinder/provider:java",
"//chrome/android/webapk/libs/client:client_java",
+ "//chrome/browser/endpoint_fetcher:java",
"//chrome/android/webapk/libs/common:common_java",
"//chrome/android/webapk/libs/common:splash_java",
"//chrome/android/webapk/libs/runtime_library:webapk_service_aidl_java",
diff --git a/chrome/android/chrome_java_resources.gni b/chrome/android/chrome_java_resources.gni
--- a/chrome/android/chrome_java_resources.gni
+++ b/chrome/android/chrome_java_resources.gni
@@ -438,6 +438,7 @@ chrome_java_resources = [
"java/res/layout/account_management_account_row.xml",
"java/res/layout/app_history_filter.xml",
"java/res/layout/auto_pip_permission_dialog.xml",
+ "java/res/layout/adblock_editor.xml",
"java/res/layout/auto_sign_in_first_run_dialog.xml",
"java/res/layout/autofill_billing_address_dropdown.xml",
"java/res/layout/autofill_card_name_and_number.xml",
@@ -650,6 +651,7 @@ chrome_java_resources = [
"java/res/xml/account_management_preferences.xml",
"java/res/xml/ad_services_config.xml",
"java/res/xml/appearance_preferences.xml",
+ "java/res/xml/adblock_preferences.xml",
"java/res/xml/bookmark_widget_info.xml",
"java/res/xml/clear_browsing_data_preferences.xml",
"java/res/xml/contextual_search_preferences.xml",
diff --git a/chrome/android/chrome_java_sources.gni b/chrome/android/chrome_java_sources.gni
--- a/chrome/android/chrome_java_sources.gni
+++ b/chrome/android/chrome_java_sources.gni
@@ -992,6 +992,8 @@ chrome_java_sources = [
"java/src/org/chromium/chrome/browser/permissions/PermissionBlockedDialog.java",
"java/src/org/chromium/chrome/browser/permissions/PermissionUpdateRequester.java",
"java/src/org/chromium/chrome/browser/photo_picker/DecoderServiceImpl.java",
+ "java/src/org/chromium/chrome/browser/settings/AdBlockEditor.java",
+ "java/src/org/chromium/chrome/browser/settings/AdBlockPreferences.java",
"java/src/org/chromium/chrome/browser/policy/PolicyAuditor.java",
"java/src/org/chromium/chrome/browser/policy/PolicyAuditorBridge.java",
"java/src/org/chromium/chrome/browser/privacy/settings/DoNotTrackSettings.java",
diff --git a/chrome/android/java/res/layout/adblock_editor.xml b/chrome/android/java/res/layout/adblock_editor.xml
new file mode 100644
--- /dev/null
+++ b/chrome/android/java/res/layout/adblock_editor.xml
@@ -0,0 +1,67 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Copyright 2015 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. -->
+
+<FrameLayout
+ xmlns:android="http://schemas.android.com/apk/res/android"
+ xmlns:app="http://schemas.android.com/apk/res-auto"
+ xmlns:tools="http://schemas.android.com/tools"
+ android:layout_width="match_parent"
+ android:layout_height="match_parent" >
+
+ <ScrollView
+ android:layout_width="match_parent"
+ android:layout_height="match_parent"
+ android:id="@+id/scroll_view"
+ android:fillViewport="true" >
+
+ <LinearLayout
+ android:layout_width="match_parent"
+ android:layout_height="wrap_content"
+ android:orientation="vertical"
+ android:focusableInTouchMode="true" >
+
+ <com.google.android.material.textfield.TextInputLayout
+ android:id="@+id/adblock_url"
+ android:paddingTop="16dp"
+ android:paddingStart="@dimen/pref_autofill_content_spacing"
+ android:paddingEnd="@dimen/pref_autofill_content_spacing"
+ android:layout_width="match_parent"
+ android:layout_height="wrap_content" >
+ <!-- TODO(crbug.com/900912): Fix and remove lint ignore -->
+ <EditText
+ tools:ignore="Autofill"
+ android:id="@+id/adblock_url_edit"
+ android:layout_width="match_parent"
+ android:layout_height="wrap_content"
+ android:inputType="textUri"
+ android:singleLine="true"
+ android:hint="@string/options_adblock_edit_label" />
+ </com.google.android.material.textfield.TextInputLayout>
+
+ <Space style="@style/ButtonBarTopSpacer" />
+ <View style="@style/ButtonBarTopDivider" />
+
+ <LinearLayout style="@style/ButtonBar" >
+ <org.chromium.ui.widget.ButtonCompat
+ android:id="@+id/adblock_reset"
+ style="@style/ButtonBarButton"
+ android:text="@string/reset" />
+
+ <org.chromium.ui.widget.ButtonCompat
+ android:id="@+id/adblock_cancel"
+ style="@style/ButtonBarButton"
+ android:text="@string/cancel" />
+
+ <org.chromium.ui.widget.ButtonCompat
+ android:id="@+id/adblock_save"
+ style="@style/ButtonBarButton"
+ android:text="@string/save" />
+ </LinearLayout>
+ </LinearLayout>
+ </ScrollView>
+
+ <include layout="@layout/settings_action_bar_shadow"/>
+
+</FrameLayout>
diff --git a/chrome/android/java/res/values/styles.xml b/chrome/android/java/res/values/styles.xml
--- a/chrome/android/java/res/values/styles.xml
+++ b/chrome/android/java/res/values/styles.xml
@@ -339,6 +339,24 @@ found in the LICENSE file.
</item>
</style>
+ <style name="ButtonBarTopSpacer" parent="ButtonBarTopSpacerLight">
+ <item name="android:minHeight">5dp</item>
+ </style>
+ <style name="ButtonBar" parent="@android:style/Holo.Light.ButtonBar.AlertDialog">
+ <item name="android:layout_width">match_parent</item>
+ <item name="android:layout_height">wrap_content</item>
+ <item name="android:divider">?android:attr/dividerVertical</item>
+ <item name="android:dividerPadding">0dp</item>
+ <item name="android:showDividers">middle</item>
+ </style>
+ <style name="ButtonBarButton" parent="@style/TextButton">
+ <item name="android:layout_width">0dp</item>
+ <item name="android:layout_height">match_parent</item>
+ <item name="android:layout_weight">1</item>
+ <item name="android:paddingStart">4dp</item>
+ <item name="android:paddingEnd">4dp</item>
+ </style>
+
<!-- Button bar styles -->
<style name="ButtonBarTopSpacerLight">
<item name="android:layout_width">0dp</item>
diff --git a/chrome/android/java/res/values/values.xml b/chrome/android/java/res/values/values.xml
--- a/chrome/android/java/res/values/values.xml
+++ b/chrome/android/java/res/values/values.xml
@@ -22,6 +22,10 @@ found in the LICENSE file.
<!-- Compositor Tab Title Text -->
<bool name="compositor_tab_title_fake_bold_text">true</bool>
+ <string name="adblock_on">Autoupdate enabled</string>
+ <string name="adblock_off">Autoupdate disabled</string>
+ <string name="adblock_help_url">https://github.com/uazo/cromite/blob/master/docs/BROMITE_LEGACY_ADBLOCK.md</string>
+
<string name="proxy_title">Proxy configuration</string>
<string name="proxy_url">chrome://proxy</string>
diff --git a/chrome/android/java/res/xml/adblock_preferences.xml b/chrome/android/java/res/xml/adblock_preferences.xml
new file mode 100644
--- /dev/null
+++ b/chrome/android/java/res/xml/adblock_preferences.xml
@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Copyright 2015 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. -->
+
+<PreferenceScreen
+ xmlns:android="http://schemas.android.com/apk/res/android"
+ xmlns:app="http://schemas.android.com/apk/res-auto">
+
+ <org.chromium.components.browser_ui.settings.ChromeSwitchPreference
+ android:key="adblock_switch"
+ android:summaryOn="@string/adblock_on"
+ android:summaryOff="@string/adblock_off" />
+
+ <Preference
+ android:key="adblock_edit"
+ android:title="@string/options_adblock_edit_label"
+ android:fragment="org.chromium.chrome.browser.settings.AdBlockEditor" />
+
+ <org.chromium.chrome.browser.about_settings.HyperlinkPreference
+ android:key="adblock_help"
+ android:title="@string/adblock_help"
+ app:url="@string/adblock_help_url" />
+
+</PreferenceScreen>
diff --git a/chrome/android/java/res/xml/main_preferences.xml b/chrome/android/java/res/xml/main_preferences.xml
--- a/chrome/android/java/res/xml/main_preferences.xml
+++ b/chrome/android/java/res/xml/main_preferences.xml
@@ -119,6 +119,11 @@ found in the LICENSE file.
android:key="toolbar_shortcut"
android:order="22"
android:title="@string/toolbar_shortcut"/>
+ <Preference
+ android:fragment="org.chromium.chrome.browser.settings.AdBlockPreferences"
+ android:key="adblock"
+ android:order="13"
+ android:title="@string/prefs_adblock"/>
<Preference
android:key="notifications"
android:order="23"
diff --git a/chrome/android/java/src/org/chromium/chrome/browser/settings/AdBlockEditor.java b/chrome/android/java/src/org/chromium/chrome/browser/settings/AdBlockEditor.java
new file mode 100644
--- /dev/null
+++ b/chrome/android/java/src/org/chromium/chrome/browser/settings/AdBlockEditor.java
@@ -0,0 +1,91 @@
+// Copyright 2015 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.
+
+package org.chromium.chrome.browser.settings;
+
+import android.os.Bundle;
+import androidx.fragment.app.Fragment;
+import android.text.Editable;
+import android.text.TextWatcher;
+import android.view.LayoutInflater;
+import android.view.View;
+import android.view.ViewGroup;
+import android.widget.Button;
+import android.widget.EditText;
+
+import org.chromium.components.browser_ui.settings.SettingsUtils;
+import org.chromium.chrome.browser.flags.AdBlockNativeGateway;
+import org.chromium.chrome.R;
+import org.chromium.components.url_formatter.UrlFormatter;
+
+/**
+ * Provides the Java-UI for editing AdBlock preferences.
+ */
+public class AdBlockEditor extends Fragment implements TextWatcher {
+ private EditText mAdBlockFiltersUrlEdit;
+ private Button mSaveButton;
+ private Button mResetButton;
+
+ @Override
+ public View onCreateView(LayoutInflater inflater, ViewGroup container,
+ Bundle savedInstanceState) {
+ super.onCreate(savedInstanceState);
+ getActivity().setTitle(R.string.options_adblock_edit_title);
+
+ View v = inflater.inflate(R.layout.adblock_editor, container, false);
+ View scrollView = v.findViewById(R.id.scroll_view);
+ scrollView.getViewTreeObserver().addOnScrollChangedListener(
+ SettingsUtils.getShowShadowOnScrollListener(v, v.findViewById(R.id.shadow)));
+ mAdBlockFiltersUrlEdit = (EditText) v.findViewById(R.id.adblock_url_edit);
+ mAdBlockFiltersUrlEdit.setText(AdBlockNativeGateway.getAdBlockFiltersURL());
+ mAdBlockFiltersUrlEdit.addTextChangedListener(this);
+ mAdBlockFiltersUrlEdit.requestFocus();
+
+ initializeSaveCancelResetButtons(v);
+ return v;
+ }
+
+ @Override
+ public void beforeTextChanged(CharSequence s, int start, int count, int after) {
+ }
+
+ @Override
+ public void onTextChanged(CharSequence s, int start, int before, int count) {
+ mSaveButton.setEnabled(true); // was (s.length() != 0);
+ mResetButton.setEnabled(true);
+ }
+
+ @Override
+ public void afterTextChanged(Editable s) {
+ }
+
+ private void initializeSaveCancelResetButtons(View v) {
+ mResetButton = (Button) v.findViewById(R.id.adblock_reset);
+ mResetButton.setOnClickListener(new View.OnClickListener() {
+ @Override
+ public void onClick(View v) {
+ mAdBlockFiltersUrlEdit.setText(AdBlockNativeGateway.getAdBlockFiltersURL());
+ }
+ });
+
+ mSaveButton = (Button) v.findViewById(R.id.adblock_save);
+ mSaveButton.setEnabled(false);
+ mSaveButton.setOnClickListener(new View.OnClickListener() {
+ @Override
+ public void onClick(View v) {
+ AdBlockNativeGateway.setAdBlockFiltersURL(
+ UrlFormatter.fixupUrl(mAdBlockFiltersUrlEdit.getText().toString()).getSpec());
+ getActivity().finish();
+ }
+ });
+
+ Button button = (Button) v.findViewById(R.id.adblock_cancel);
+ button.setOnClickListener(new View.OnClickListener() {
+ @Override
+ public void onClick(View v) {
+ getActivity().finish();
+ }
+ });
+ }
+}
diff --git a/chrome/android/java/src/org/chromium/chrome/browser/settings/AdBlockPreferences.java b/chrome/android/java/src/org/chromium/chrome/browser/settings/AdBlockPreferences.java
new file mode 100644
--- /dev/null
+++ b/chrome/android/java/src/org/chromium/chrome/browser/settings/AdBlockPreferences.java
@@ -0,0 +1,76 @@
+// Copyright 2015 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.
+
+package org.chromium.chrome.browser.settings;
+
+import android.os.Bundle;
+import androidx.preference.Preference;
+import androidx.preference.PreferenceFragmentCompat;
+
+import org.chromium.base.supplier.MonotonicObservableSupplier;
+import org.chromium.base.supplier.ObservableSuppliers;
+import org.chromium.base.supplier.SettableMonotonicObservableSupplier;
+import java.util.function.Supplier;
+
+import org.chromium.content_public.browser.BrowserContextHandle;
+import org.chromium.components.browser_ui.settings.ChromeSwitchPreference;
+import org.chromium.components.browser_ui.site_settings.BaseSiteSettingsFragment;
+import org.chromium.components.browser_ui.site_settings.WebsitePreferenceBridge;
+import org.chromium.components.content_settings.ContentSettingsType;
+import org.chromium.components.browser_ui.settings.SettingsUtils;
+import org.chromium.components.browser_ui.settings.SettingsFragment;
+
+import org.chromium.chrome.R;
+import org.chromium.chrome.browser.flags.AdBlockNativeGateway;
+import org.chromium.chrome.browser.settings.ChromeBaseSettingsFragment;
+
+/**
+ * Fragment that allows the user to configure AdBlock related preferences.
+ */
+public class AdBlockPreferences extends ChromeBaseSettingsFragment {
+ public static final String PREF_ADBLOCK_SWITCH = "adblock_switch";
+ private static final String PREF_ADBLOCK_EDIT = "adblock_edit";
+
+ private Preference mAdBlockEdit;
+ private final SettableMonotonicObservableSupplier<String> mPageTitle =
+ ObservableSuppliers.createMonotonic();
+
+ @Override
+ public MonotonicObservableSupplier<String> getPageTitle() {
+ return mPageTitle;
+ }
+
+ @Override
+ public @SettingsFragment.AnimationType int getAnimationType() {
+ return SettingsFragment.AnimationType.PROPERTY;
+ }
+
+ @Override
+ public void onCreatePreferences(Bundle savedInstanceState, String rootKey) {
+ mPageTitle.set(getString(R.string.options_adblock_title));
+ SettingsUtils.addPreferencesFromResource(this, R.xml.adblock_preferences);
+
+ ChromeSwitchPreference mAdBlockSwitch =
+ (ChromeSwitchPreference) findPreference(PREF_ADBLOCK_SWITCH);
+ boolean isAdBlockEnabled = AdBlockNativeGateway.getAdBlockEnabled();
+ mAdBlockSwitch.setChecked(isAdBlockEnabled);
+ mAdBlockSwitch.setOnPreferenceChangeListener((preference, newValue) -> {
+ AdBlockNativeGateway.setAdBlockEnabled((boolean) newValue);
+ return true;
+ });
+
+ mAdBlockEdit = findPreference(PREF_ADBLOCK_EDIT);
+ updateCurrentAdBlockUrl();
+ }
+
+ private void updateCurrentAdBlockUrl() {
+ mAdBlockEdit.setSummary(AdBlockNativeGateway.getAdBlockFiltersURL());
+ }
+
+ @Override
+ public void onResume() {
+ super.onResume();
+ updateCurrentAdBlockUrl();
+ }
+}
diff --git a/chrome/android/java/src/org/chromium/chrome/browser/settings/SettingsActivity.java b/chrome/android/java/src/org/chromium/chrome/browser/settings/SettingsActivity.java
--- a/chrome/android/java/src/org/chromium/chrome/browser/settings/SettingsActivity.java
+++ b/chrome/android/java/src/org/chromium/chrome/browser/settings/SettingsActivity.java
@@ -109,6 +109,8 @@ import java.util.List;
import java.util.Locale;
import java.util.Map;
+import org.chromium.chrome.browser.settings.AdBlockEditor;
+
/**
* The Chrome settings activity.
*
@@ -1376,6 +1378,7 @@ public class SettingsActivity extends ChromeBaseAppCompatActivity
&& !MAIN_FRAGMENT_TAG.equals(fragment.getTag())) {
return;
}
+ if (fragment instanceof AdBlockEditor) return;
String className = fragment.getClass().getSimpleName();
RecordHistogram.recordSparseHistogram(
diff --git a/chrome/app/generated_resources.grd b/chrome/app/generated_resources.grd
--- a/chrome/app/generated_resources.grd
+++ b/chrome/app/generated_resources.grd
@@ -17455,6 +17455,16 @@ Please help our engineers fix this problem. Tell us what happened right before y
Never show this again.
</message>
+ <!-- Ad Blocking preferences -->
+ <if expr="is_android">
+ <message name="IDS_OPTIONS_ADBLOCK_TITLE" desc="The title of the Ad Blocking option on Android" formatter_data="android_java">
+ Ad Blocking
+ </message>
+ <message name="IDS_OPTIONS_ADBLOCK_SUMMARY" desc="The title of the Ad Blocking summary on Android" formatter_data="android_java">
+ Configure Ad Blocking and filters URL
+ </message>
+ </if>
+
<!-- Ad Blocking UI strings. -->
<message name="IDS_BLOCKED_ADS_PROMPT_TOOLTIP" desc="Explanation that Chrome blocked ads on this site. To be shown as a tooltip on the Ads blocked desktop bubble">
Ads blocked on this site
diff --git a/chrome/browser/after_startup_task_utils.cc b/chrome/browser/after_startup_task_utils.cc
--- a/chrome/browser/after_startup_task_utils.cc
+++ b/chrome/browser/after_startup_task_utils.cc
@@ -24,6 +24,9 @@
#include "chrome/browser/ui/ash/login/login_display_host.h"
#endif
+#include "chrome/browser/browser_process.h"
+#include "components/component_updater/adblock_updater_service.h"
+
using content::BrowserThread;
namespace {
@@ -129,6 +132,8 @@ void SetBrowserStartupIsComplete() {
}
GetAfterStartupTasks().clear();
GetAfterStartupTasks().shrink_to_fit();
+ // initialize AdBlock engine scheduled updates
+ g_browser_process->adblock_updater()->Start();
}
// Observes the first visible page load and sets the startup complete
diff --git a/chrome/browser/browser_process.h b/chrome/browser/browser_process.h
--- a/chrome/browser/browser_process.h
+++ b/chrome/browser/browser_process.h
@@ -96,6 +96,10 @@ namespace component_updater {
class ComponentUpdateService;
}
+namespace adblock_updater {
+class AdBlockUpdaterService;
+}
+
namespace gcm {
class GCMDriver;
}
@@ -294,6 +298,7 @@ class BrowserProcess {
virtual activity_reporter::ActivityReporter* activity_reporter() = 0;
virtual component_updater::ComponentUpdateService* component_updater() = 0;
+ virtual adblock_updater::AdBlockUpdaterService* adblock_updater() = 0;
#if BUILDFLAG(IS_CHROMEOS)
virtual MediaFileSystemRegistry* media_file_system_registry() = 0;
diff --git a/chrome/browser/browser_process_impl.cc b/chrome/browser/browser_process_impl.cc
--- a/chrome/browser/browser_process_impl.cc
+++ b/chrome/browser/browser_process_impl.cc
@@ -187,6 +187,8 @@
#include "ui/message_center/message_center.h"
#endif
+#include "components/component_updater/adblock_updater_service.h"
+
#if BUILDFLAG(IS_ANDROID)
#include "chrome/browser/accessibility/accessibility_prefs/android/accessibility_prefs_controller.h"
#include "chrome/browser/flags/android/chrome_feature_list.h"
@@ -1414,6 +1416,34 @@ BrowserProcessImpl::component_updater() {
return component_updater_.get();
}
+adblock_updater::AdBlockUpdaterService*
+BrowserProcessImpl::adblock_updater() {
+ if (adblock_updater_)
+ return adblock_updater_.get();
+
+ if (!BrowserThread::CurrentlyOn(BrowserThread::UI))
+ return nullptr;
+
+ std::unique_ptr<component_updater::UpdateScheduler> scheduler =
+ std::make_unique<component_updater::TimerUpdateScheduler>();
+
+ auto adblock_updater_url =
+ local_state()->GetString(prefs::kAdBlockFiltersURL);
+ if (base::StartsWith(adblock_updater_url,
+ "https://www.bromite.org", base::CompareCase::INSENSITIVE_ASCII)) {
+ local_state()->SetString(prefs::kAdBlockFiltersURL, "about:blank");
+ }
+
+ adblock_updater_ = std::make_unique<adblock_updater::AdBlockUpdaterService>(
+ g_browser_process->system_network_context_manager()->GetSharedURLLoaderFactory(),
+ std::move(scheduler),
+ g_browser_process->subresource_filter_ruleset_service(),
+ local_state()->GetBoolean(prefs::kAdBlockEnabled),
+ local_state()->GetString(prefs::kAdBlockFiltersURL));
+
+ return adblock_updater_.get();
+}
+
void BrowserProcessImpl::OnKeepAliveStateChanged(bool is_keeping_alive) {
if (is_keeping_alive) {
Pin();
diff --git a/chrome/browser/browser_process_impl.h b/chrome/browser/browser_process_impl.h
--- a/chrome/browser/browser_process_impl.h
+++ b/chrome/browser/browser_process_impl.h
@@ -224,6 +224,7 @@ class BrowserProcessImpl : public BrowserProcess,
activity_reporter::ActivityReporter* activity_reporter() override;
component_updater::ComponentUpdateService* component_updater() override;
+ adblock_updater::AdBlockUpdaterService* adblock_updater() override;
#if BUILDFLAG(IS_CHROMEOS)
MediaFileSystemRegistry* media_file_system_registry() override;
#endif
@@ -449,6 +450,7 @@ class BrowserProcessImpl : public BrowserProcess,
// to concerns over integrity of data shared between profiles,
// but some users of component updater only install per-user.
std::unique_ptr<component_updater::ComponentUpdateService> component_updater_;
+ std::unique_ptr<adblock_updater::AdBlockUpdaterService> adblock_updater_;
#if !BUILDFLAG(IS_ANDROID)
// Used to create a singleton instance of SodaInstallerImpl, which can be
diff --git a/chrome/browser/chrome_browser_main.cc b/chrome/browser/chrome_browser_main.cc
--- a/chrome/browser/chrome_browser_main.cc
+++ b/chrome/browser/chrome_browser_main.cc
@@ -449,6 +449,9 @@ StartupProfileInfo CreateInitialProfile(
// missing code in the above test.
CHECK(profile_info.profile) << "Cannot get default profile.";
+ // force AdBlock updater initialisation
+ g_browser_process->adblock_updater();
+
#else
profile_info =
GetStartupProfile(/*cur_dir=*/base::FilePath(), parsed_command_line);
diff --git a/chrome/browser/flags/BUILD.gn b/chrome/browser/flags/BUILD.gn
--- a/chrome/browser/flags/BUILD.gn
+++ b/chrome/browser/flags/BUILD.gn
@@ -9,6 +9,7 @@ import("//third_party/jni_zero/jni_zero.gni")
android_library("java") {
sources = [ "android/java/src/org/chromium/chrome/browser/flags/CromiteNativeUtils.java" ]
sources += [
+ "android/java/src/org/chromium/chrome/browser/flags/AdBlockNativeGateway.java",
"android/java/src/org/chromium/chrome/browser/flags/ChromeFeatureList.java",
"android/java/src/org/chromium/chrome/browser/flags/ChromeFeatureMap.java",
"android/java/src/org/chromium/chrome/browser/flags/ChromeSessionState.java",
@@ -49,6 +50,7 @@ java_bromite_impl("java_cromite_cached_flags") {
generate_jni("jni_headers") {
sources = [ "android/java/src/org/chromium/chrome/browser/flags/CromiteNativeUtils.java" ]
sources += [
+ "android/java/src/org/chromium/chrome/browser/flags/AdBlockNativeGateway.java",
"android/java/src/org/chromium/chrome/browser/flags/ChromeFeatureMap.java",
"android/java/src/org/chromium/chrome/browser/flags/ChromeSessionState.java",
]
@@ -62,6 +64,7 @@ static_library("flags_android") {
"android/chrome_session_state.cc",
"android/chrome_session_state.h",
]
+ sources += [ "android/adblock_native_gateway.cc" ]
deps = [
":jni_headers",
"//base",
diff --git a/chrome/browser/flags/android/adblock_native_gateway.cc b/chrome/browser/flags/android/adblock_native_gateway.cc
new file mode 100755
--- /dev/null
+++ b/chrome/browser/flags/android/adblock_native_gateway.cc
@@ -0,0 +1,33 @@
+#include "chrome/browser/flags/jni_headers/AdBlockNativeGateway_jni.h"
+
+#include "base/android/jni_string.h"
+#include "chrome/browser/browser_process.h"
+#include "chrome/common/pref_names.h"
+#include "components/prefs/pref_service.h"
+
+using base::android::ScopedJavaLocalRef;
+using base::android::JavaRef;
+
+static ScopedJavaLocalRef<jstring> JNI_AdBlockNativeGateway_GetAdBlockFiltersURL(
+ JNIEnv* env) {
+ return base::android::ConvertUTF8ToJavaString(env,
+ g_browser_process->local_state()->GetString(prefs::kAdBlockFiltersURL));
+}
+
+static void JNI_AdBlockNativeGateway_SetAdBlockFiltersURL(
+ JNIEnv* env, const JavaRef<jstring>& url) {
+ g_browser_process->local_state()->SetString(prefs::kAdBlockFiltersURL,
+ base::android::ConvertJavaStringToUTF8(env, url));
+}
+
+static bool JNI_AdBlockNativeGateway_GetAdBlockEnabled(
+ JNIEnv* env) {
+ return g_browser_process->local_state()->GetBoolean(prefs::kAdBlockEnabled);
+}
+
+static void JNI_AdBlockNativeGateway_SetAdBlockEnabled(
+ JNIEnv* env, bool enabled) {
+ g_browser_process->local_state()->SetBoolean(prefs::kAdBlockEnabled, enabled);
+}
+
+DEFINE_JNI(AdBlockNativeGateway)
diff --git a/chrome/browser/flags/android/java/src/org/chromium/chrome/browser/flags/AdBlockNativeGateway.java b/chrome/browser/flags/android/java/src/org/chromium/chrome/browser/flags/AdBlockNativeGateway.java
new file mode 100755
--- /dev/null
+++ b/chrome/browser/flags/android/java/src/org/chromium/chrome/browser/flags/AdBlockNativeGateway.java
@@ -0,0 +1,30 @@
+package org.chromium.chrome.browser.flags;
+
+import org.jni_zero.CalledByNative;
+import org.jni_zero.NativeMethods;
+
+public class AdBlockNativeGateway {
+ public static void setAdBlockFiltersURL(String url) {
+ AdBlockNativeGatewayJni.get().setAdBlockFiltersURL(url);
+ }
+
+ public static String getAdBlockFiltersURL() {
+ return AdBlockNativeGatewayJni.get().getAdBlockFiltersURL();
+ }
+
+ public static void setAdBlockEnabled(boolean enabled) {
+ AdBlockNativeGatewayJni.get().setAdBlockEnabled(enabled);
+ }
+
+ public static boolean getAdBlockEnabled() {
+ return AdBlockNativeGatewayJni.get().getAdBlockEnabled();
+ }
+
+ @NativeMethods
+ public interface Natives {
+ void setAdBlockFiltersURL(String url);
+ String getAdBlockFiltersURL();
+ void setAdBlockEnabled(boolean enabled);
+ boolean getAdBlockEnabled();
+ }
+}
diff --git a/chrome/browser/net/system_network_context_manager.cc b/chrome/browser/net/system_network_context_manager.cc
--- a/chrome/browser/net/system_network_context_manager.cc
+++ b/chrome/browser/net/system_network_context_manager.cc
@@ -718,6 +718,10 @@ void SystemNetworkContextManager::RegisterPrefs(PrefRegistrySimple* registry) {
DefaultDnsOverHttpsConfigSource::RegisterPrefs(registry);
NetworkProcessLaunchWatcher::RegisterPrefs(registry);
+ registry->RegisterBooleanPref(prefs::kAdBlockEnabled, false);
+ registry->RegisterStringPref(prefs::kAdBlockFiltersURL,
+ "about:blank");
+
// Static auth params
registry->RegisterStringPref(prefs::kAuthSchemes,
"basic,digest,ntlm,negotiate");
diff --git a/chrome/browser/ui/android/strings/android_chrome_strings.grd b/chrome/browser/ui/android/strings/android_chrome_strings.grd
--- a/chrome/browser/ui/android/strings/android_chrome_strings.grd
+++ b/chrome/browser/ui/android/strings/android_chrome_strings.grd
@@ -245,6 +245,20 @@ CHAR_LIMIT guidelines:
Delete
</message>
+ <!-- AdBlock settings -->
+ <message name="IDS_PREFS_ADBLOCK" desc="Title of the AdBlock Settings screen. [CHAR-LIMIT=32]">
+ Legacy Adblock settings
+ </message>
+ <message name="IDS_OPTIONS_ADBLOCK_EDIT_TITLE" desc="The title of the screen that allows users to change the URL that is used to fetch the ad blocker filters.">
+ Edit filters URL
+ </message>
+ <message name="IDS_OPTIONS_ADBLOCK_EDIT_LABEL" desc="The label for the edit text field that allows the user to change the URL that is used to fetch the ad blocker filters.">
+ Filters URL
+ </message>
+ <message name="IDS_ADBLOCK_HELP" desc="The title of the hyperlink that allows users to visit the web page with instructions for custom ad blocker filters.">
+ Visit help page
+ </message>
+
<!-- Notification channels -->
<message name="IDS_NOTIFICATION_CATEGORY_GROUP_GENERAL" desc='Subheading for "General" section of a list of notification categories. [CHAR_LIMIT=32]'>
General
diff --git a/chrome/common/pref_names.h b/chrome/common/pref_names.h
--- a/chrome/common/pref_names.h
+++ b/chrome/common/pref_names.h
@@ -2416,6 +2416,11 @@ inline constexpr char kAudioCaptureAllowed[] = "hardware.audio_capture_enabled";
inline constexpr char kAudioCaptureAllowedUrls[] =
"hardware.audio_capture_allowed_urls";
+// Holds the URL to an indexed subresource filters file.
+inline constexpr char kAdBlockFiltersURL[] = "adblock.filters_url";
+
+inline constexpr char kAdBlockEnabled[] = "adblock.enabled";
+
// A pref holding the value of the policy used to explicitly allow or deny
// access to video capture devices. When enabled or not set, the user is
// prompted for device access. When disabled, access to video capture devices
diff --git a/components/browser_ui/strings/android/site_settings.grdp b/components/browser_ui/strings/android/site_settings.grdp
--- a/components/browser_ui/strings/android/site_settings.grdp
+++ b/components/browser_ui/strings/android/site_settings.grdp
@@ -421,6 +421,9 @@
<message name="IDS_INTRUSIVE_ADS_INFORMATION" desc="The extra information at the top of the Site Details page when the site tends to show intrusive ads">
This site shows intrusive or misleading ads
</message>
+ <message name="IDS_WEBSITE_SETTINGS_CATEGORY_ADS_BLOCKED" desc="A setting that, if turned on, will block ads.">
+ Block ads based on the current filters
+ </message>
<message name="IDS_WEBSITE_SETTINGS_CATEGORY_ADS_BLOCKED_LIST" desc="Summary text explaining that the Ads permission is set to block ads on some sites. To be shown in the list of permission categories.">
Blocked on some sites
</message>
diff --git a/components/component_updater/BUILD.gn b/components/component_updater/BUILD.gn
--- a/components/component_updater/BUILD.gn
+++ b/components/component_updater/BUILD.gn
@@ -19,6 +19,12 @@ static_library("component_updater") {
"component_installer.h",
"component_updater_command_line_config_policy.cc",
"component_updater_command_line_config_policy.h",
+
+ "adblock_updater_service.cc",
+ "adblock_updater_service.h",
+ "download_filters_task.cc",
+ "download_filters_task.h",
+
"component_updater_service.cc",
"component_updater_service.h",
"component_updater_service_internal.h",
@@ -49,9 +55,11 @@ static_library("component_updater") {
"//components/update_client",
"//components/version_info",
"//net",
+ "//services/network/public/mojom",
"//third_party/boringssl",
"//ui/base",
"//url",
+ "//content/common:buildflags"
]
}
diff --git a/components/component_updater/adblock_updater_service.cc b/components/component_updater/adblock_updater_service.cc
new file mode 100644
--- /dev/null
+++ b/components/component_updater/adblock_updater_service.cc
@@ -0,0 +1,281 @@
+/*
+ This file is part of Bromite.
+
+ Bromite is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ Bromite is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with Bromite. If not, see <https://www.gnu.org/licenses/>.
+*/
+
+#include "components/component_updater/adblock_updater_service.h"
+
+#include <algorithm>
+#include <map>
+#include <string>
+#include <utility>
+#include <vector>
+
+#include "base/files/file_path.h"
+#include "base/files/file_util.h"
+#include "base/logging.h"
+#include "base/threading/thread_checker.h"
+#include "base/time/time.h"
+#include "base/timer/timer.h"
+#include "url/gurl.h"
+#include "base/strings/safe_sprintf.h"
+#include "base/strings/string_number_conversions.h"
+#include "base/strings/string_split.h"
+namespace adblock_updater {
+
+// all constants express seconds
+// these could be made configurable
+const int initial_check_delay = 5,
+ next_check_delay = 60*60*24*7, // 1 week
+ on_demand_check_delay = 60; // minimum 1 minute between each on-demand check
+
+AdBlockUpdaterService::AdBlockUpdaterService(
+ scoped_refptr<network::SharedURLLoaderFactory> shared_url_network_factory,
+ std::unique_ptr<component_updater::UpdateScheduler> scheduler,
+ subresource_filter::RulesetService* ruleset_service,
+ bool enabled,
+ std::string filters_url)
+ : ruleset_service_(ruleset_service),
+ shared_url_network_factory_(shared_url_network_factory),
+ scheduler_(std::move(scheduler)),
+ enabled_(enabled) {
+ DCHECK(ruleset_service);
+
+ filters_url_ = filters_url;
+}
+
+AdBlockUpdaterService::~AdBlockUpdaterService() {
+ DCHECK(thread_checker_.CalledOnValidThread());
+}
+
+void AdBlockUpdaterService::AddObserver(Observer* observer) {
+ DCHECK(thread_checker_.CalledOnValidThread());
+ observer_list_.AddObserver(observer);
+}
+
+void AdBlockUpdaterService::RemoveObserver(Observer* observer) {
+ DCHECK(thread_checker_.CalledOnValidThread());
+ observer_list_.RemoveObserver(observer);
+}
+
+void AdBlockUpdaterService::NotifyObservers(Event event) {
+ DCHECK(thread_checker_.CalledOnValidThread());
+ for (auto& observer : observer_list_)
+ observer.OnEvent(event);
+}
+
+void AdBlockUpdaterService::Start() {
+ DCHECK(thread_checker_.CalledOnValidThread());
+
+ // avoid multiple scheduling
+ if (scheduled_)
+ return;
+ scheduled_ = true;
+
+ LOG(INFO) << "AdBlockUpdaterService: starting up. "
+ << "First update attempt will take place in "
+ << initial_check_delay << " seconds. "
+ << "Next update attempt will take place in "
+ << next_check_delay << " seconds. ";
+
+ scheduler_->Schedule(
+ base::Seconds(initial_check_delay),
+ base::Seconds(next_check_delay),
+ base::BindRepeating(&AdBlockUpdaterService::OnDemandScheduledUpdate,
+ base::Unretained(this)), base::DoNothing());
+}
+
+void AdBlockUpdaterService::OnDemandScheduledUpdate(component_updater::UpdateScheduler::OnFinishedCallback on_finished) {
+ //TODO: call on_finished
+ OnDemandUpdateAsNeeded(false, Callback());
+}
+
+bool AdBlockUpdaterService::OnDemandUpdate(Callback on_finished) {
+ return OnDemandUpdateAsNeeded(true, std::move(on_finished));
+}
+
+bool AdBlockUpdaterService::OnDemandUpdateAsNeeded(bool is_foreground, Callback on_finished) {
+ DCHECK(thread_checker_.CalledOnValidThread());
+
+ if (!enabled_) {
+ LOG(INFO) << "AdBlockUpdaterService: update is disabled.";
+ return false;
+ }
+
+ // Check if the request is too early
+ if (!last_update_.is_null()) {
+ base::TimeDelta delta =
+ base::TimeTicks::Now() - last_update_;
+ if (delta < base::Seconds(on_demand_check_delay)) {
+ LOG(INFO) << "AdBlockUpdaterService: update not necessary.";
+ return false;
+ }
+ }
+
+ if (is_updating_) {
+ base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
+ FROM_HERE, base::BindOnce(std::move(on_finished),
+ Error::UPDATE_IN_PROGRESS));
+ return false;
+ }
+ is_updating_ = true;
+
+ base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
+ FROM_HERE, base::BindOnce(&AdBlockUpdaterService::NotifyObservers, base::Unretained(this), Event::ADBLOCK_CHECKING_FOR_UPDATES));
+
+ base::Time::Exploded e = {0};
+ base::Time min_last_modified = base::Time();
+ auto version = ruleset_service_->GetMostRecentlyIndexedVersion();
+ LOG(INFO) << "AdBlockUpdaterService: MostRecentIndexedVersion = " << version.content_version;
+ std::vector<std::string> tokens =
+ base::SplitString(version.content_version, ".", base::KEEP_WHITESPACE, base::SPLIT_WANT_ALL);
+ int i = 0;
+ bool failed = false;
+ for (const std::string& token : tokens) {
+ // parse as number
+ int n = 0;
+ if (!base::StringToInt(token, &n)) {
+ failed = true;
+ break;
+ }
+
+ switch (i++) {
+ case 0:
+ e.year = 2019 + n;
+ break;
+ case 1:
+ e.month = n + 1;
+ break;
+ case 2:
+ e.day_of_month = n + 1;
+ break;
+ case 3:
+ e.second = n % 60;
+ n -= e.second;
+ n /= 60;
+ e.minute = n % 60;
+ e.hour = n / 60;
+ break;
+ default:
+ failed = true;
+ break;
+ }
+ }
+
+ if (failed) {
+ LOG(WARNING) << "AdBlockUpdaterService: failed to parse most recent version as x.y.z.w dot-separated integers";
+ } else {
+ if (!base::Time::FromUTCExploded(e, &min_last_modified))
+ LOG(WARNING) << "AdBlockUpdaterService: failed to convert version to time.";
+ }
+
+ // avoid making a new request if version-based time is recent enough
+ if (!failed) {
+ base::TimeDelta delta =
+ base::Time::Now() - min_last_modified;
+ if (delta < base::Seconds(on_demand_check_delay)) {
+ LOG(INFO) << "AdBlockUpdaterService: update check not yet needed.";
+ is_updating_ = false;
+ return false;
+ }
+ }
+
+ last_update_ = base::TimeTicks::Now();
+ if (!filters_url_.empty()) {
+ auto task = base::MakeRefCounted<DownloadFiltersTask>(
+ shared_url_network_factory_,
+ is_foreground, filters_url_,
+ min_last_modified,
+ base::BindOnce(&AdBlockUpdaterService::OnUpdateComplete, base::Unretained(this),
+ std::move(on_finished)));
+
+ // run task now; task is responsible for downloading the filters (if Last-Modified header is more recent)
+ // and then clearing the 'is_updating' status
+ base::SequencedTaskRunner::GetCurrentDefault()->PostTask(FROM_HERE,
+ base::BindOnce(&DownloadFiltersTask::Run, base::Unretained(task.get())));
+ tasks_.insert(task);
+
+ base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
+ FROM_HERE, base::BindOnce(&AdBlockUpdaterService::NotifyObservers, base::Unretained(this), Event::ADBLOCK_UPDATE_DOWNLOADING));
+ }
+ return true;
+}
+
+void AdBlockUpdaterService::OnUpdateComplete(Callback on_finished,
+ scoped_refptr<DownloadFiltersTask> task,
+ Error error) {
+ DCHECK(thread_checker_.CalledOnValidThread());
+
+ auto file_path = task->file_path();
+ if (error == Error::NONE) {
+ base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
+ FROM_HERE, base::BindOnce(&AdBlockUpdaterService::NotifyObservers, base::Unretained(this), Event::ADBLOCK_UPDATE_READY));
+
+ subresource_filter::UnindexedRulesetInfo ruleset_info;
+ ruleset_info.ruleset_path = file_path;
+ ruleset_info.delete_ruleset_path = true;
+ ruleset_info.content_version = "0.0.0.0";
+ DCHECK(!ruleset_info.ruleset_path.empty());
+
+ // convert Last-Modified timestamp fetched by the DownloadFiltersTask to a semver version
+ auto t = task->last_modified();
+ bool ignore_version = t.is_null();
+ if (!ignore_version) {
+ base::Time::Exploded e;
+ t.UTCExplode(&e);
+
+ // convert time to version
+ const int major = e.year - 2019,
+ minor = e.month - 1,
+ patch = e.day_of_month - 1,
+ revision = (e.hour*60+e.minute)*60 + e.second;
+ if (major < 0)
+ LOG(WARNING) << "AdBlockUpdaterService: too old Last-Modified header, ignoring version check.";
+ else {
+ char version_buffer[32];
+ base::strings::SafeSNPrintf(version_buffer, sizeof(version_buffer), "%d.%d.%d.%d",
+ major, minor, patch, revision);
+
+ ruleset_info.content_version = version_buffer;
+
+ LOG(INFO) << "AdBlockUpdaterService: indexing filters with version " << ruleset_info.content_version;
+ }
+ } else
+ LOG(WARNING) << "AdBlockUpdaterService: invalid Last-Modified header, ignoring version check.";
+ ruleset_service_->IndexAndStoreAndPublishRulesetIfNeeded(ruleset_info, ignore_version);
+
+ base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
+ FROM_HERE, base::BindOnce(&AdBlockUpdaterService::NotifyObservers, base::Unretained(this), Event::ADBLOCK_UPDATED));
+ } else if (error == Error::UPDATE_NOT_NEEDED) {
+ base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
+ FROM_HERE, base::BindOnce(&AdBlockUpdaterService::NotifyObservers, base::Unretained(this), Event::ADBLOCK_NOT_UPDATED));
+ } else {
+ base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
+ FROM_HERE, base::BindOnce(&AdBlockUpdaterService::NotifyObservers, base::Unretained(this), Event::ADBLOCK_UPDATE_ERROR));
+ }
+
+ //TODO: run these only when index-and-store is actually finished?
+ // would require exposing the callback in IndexAndStoreAndPublishRulesetIfNeeded
+ if (!on_finished.is_null()) {
+ base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
+ FROM_HERE, base::BindOnce(std::move(on_finished), error));
+ }
+
+ // mark as not updating
+ is_updating_ = false;
+ tasks_.erase(task);
+}
+
+} // namespace adblock_updater
diff --git a/components/component_updater/adblock_updater_service.h b/components/component_updater/adblock_updater_service.h
new file mode 100644
--- /dev/null
+++ b/components/component_updater/adblock_updater_service.h
@@ -0,0 +1,103 @@
+/*
+ This file is part of Bromite.
+
+ Bromite is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ Bromite is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with Bromite. If not, see <https://www.gnu.org/licenses/>.
+*/
+
+#ifndef COMPONENTS_ADBLOCK_UPDATER_SERVICE_H
+#define COMPONENTS_ADBLOCK_UPDATER_SERVICE_H
+
+#include <stdint.h>
+
+#include <memory>
+#include <string>
+#include <vector>
+
+#include "base/memory/ref_counted.h"
+#include "base/observer_list.h"
+#include "base/version.h"
+#include "build/build_config.h"
+#include "components/component_updater/update_scheduler.h"
+#include "url/gurl.h"
+#include "components/component_updater/download_filters_task.h"
+#include "components/subresource_filter/content/browser/ruleset_service.h"
+#include "services/network/public/cpp/shared_url_loader_factory.h"
+
+namespace adblock_updater {
+
+// Called when a non-blocking call in this module completes.
+using Callback = base::OnceCallback<void(Error error)>;
+
+class Observer {
+ public:
+ virtual ~Observer() {}
+
+ // Called by the update service when a state change happens.
+ virtual void OnEvent(Event event) = 0;
+};
+
+// The AdBlock update service is in charge of downloading and saving the
+// AdBlock filters.
+//
+// All methods are safe to call ONLY from the browser's main thread.
+class AdBlockUpdaterService {
+ public:
+ AdBlockUpdaterService(
+ scoped_refptr<network::SharedURLLoaderFactory> shared_url_network_factory,
+ std::unique_ptr<component_updater::UpdateScheduler> scheduler,
+ subresource_filter::RulesetService* ruleset_service,
+ bool enabled,
+ std::string filters_url);
+ ~AdBlockUpdaterService();
+
+ // Adds an observer for this class. An observer should not be added more
+ // than once. The caller retains the ownership of the observer object.
+ void AddObserver(Observer* observer);
+
+ // Removes an observer. It is safe for an observer to be removed while
+ // the observers are being notified.
+ void RemoveObserver(Observer* observer);
+
+ // Will schedule automatic updates, run in background.
+ void Start();
+
+ // To be called for an user-triggered update.
+ // Will not result in an actual update if the last update was too recently triggered.
+ bool OnDemandUpdate(Callback on_finished);
+
+ private:
+ void NotifyObservers(Event event);
+ void OnDemandScheduledUpdate(component_updater::UpdateScheduler::OnFinishedCallback on_finished);
+ bool OnDemandUpdateAsNeeded(bool is_foreground, Callback on_finished);
+ void OnUpdateComplete(Callback callback, scoped_refptr<DownloadFiltersTask> task, Error error);
+
+ base::ObserverList<Observer>::Unchecked observer_list_;
+ base::ThreadChecker thread_checker_;
+ base::TimeTicks last_update_;
+
+ raw_ptr<subresource_filter::RulesetService> ruleset_service_;
+ std::string filters_url_;
+
+ scoped_refptr<network::SharedURLLoaderFactory> shared_url_network_factory_;
+ std::unique_ptr<component_updater::UpdateScheduler> scheduler_;
+
+ bool enabled_;
+ bool is_updating_ = false;
+ bool scheduled_ = false;
+ std::set<scoped_refptr<DownloadFiltersTask>> tasks_;
+};
+
+} // namespace adblock_updater
+
+#endif // COMPONENTS_ADBLOCK_UPDATER_SERVICE_H
diff --git a/components/component_updater/download_filters_task.cc b/components/component_updater/download_filters_task.cc
new file mode 100644
--- /dev/null
+++ b/components/component_updater/download_filters_task.cc
@@ -0,0 +1,250 @@
+/*
+ This file is part of Bromite.
+
+ Bromite is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ Bromite is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with Bromite. If not, see <https://www.gnu.org/licenses/>.
+*/
+#include "components/component_updater/download_filters_task.h"
+
+#include <utility>
+
+#include "base/files/file_util.h"
+#include "base/location.h"
+#include "base/logging.h"
+#include "net/base/load_flags.h"
+#include "url/gurl.h"
+#include "services/network/public/cpp/resource_request.h"
+#include "services/network/public/mojom/url_response_head.mojom.h"
+
+namespace adblock_updater {
+
+// maximum 10MB for the filters file
+const int kMaxBodySize = 1024 * 1024 * 50;
+
+const int kMaxRetriesOnNetworkChange = 3;
+
+const net::NetworkTrafficAnnotationTag traffic_annotation =
+ net::DefineNetworkTrafficAnnotation("filters_update", R"(
+ semantics {
+ sender: "Bromite AdBlock filters updater"
+ description:
+ "The AdBlock filters updater is responsible for updating the subresource filters."
+ trigger: "Manual or automatic AdBlock filters updates."
+ data:
+ "Subresource filters rulesets, binary format"
+ destination: WEBSITE
+ internal {
+ contacts {
+ email: "uazo@users.noreply.github.com"
+ }
+ contacts {
+ email: "uazo@users.noreply.github.com"
+ }
+ }
+ user_data {
+ type: NONE
+ }
+ last_reviewed: "2023-01-01"
+ }
+ policy {
+ cookies_allowed: NO
+ setting:
+ "You enable or disable this feature via 'Adblock Enable' pref."
+ policy_exception_justification: "Not implemented."
+ })");
+
+DownloadFiltersTask::DownloadFiltersTask(scoped_refptr<network::SharedURLLoaderFactory> shared_url_network_factory,
+ bool is_foreground, const std::string& filters_url, base::Time min_last_modified,
+ Callback callback)
+ : shared_url_network_factory_(shared_url_network_factory),
+ is_foreground_(is_foreground),
+ complete_callback_(std::move(callback)) {
+ DCHECK(!filters_url.empty());
+ filters_url_ = GURL(filters_url);
+ min_last_modified_ = min_last_modified;
+
+ if (filters_url.empty()) {
+ return;
+ }
+
+ createSimpleURLLoader(!min_last_modified_.is_null());
+}
+
+void DownloadFiltersTask::createSimpleURLLoader(bool headers_only) {
+ // always reset response-related fields
+ response_code_ = -1;
+ final_url_ = GURL();
+ download_start_time_ = base::TimeTicks();
+
+ auto resource_request = std::make_unique<network::ResourceRequest>();
+ resource_request->url = filters_url_;
+ resource_request->credentials_mode = network::mojom::CredentialsMode::kOmit;
+ resource_request->load_flags = net::LOAD_BYPASS_CACHE | net::LOAD_DISABLE_CACHE | net::LOAD_DO_NOT_SAVE_COOKIES;
+ resource_request->credentials_mode = network::mojom::CredentialsMode::kOmit;
+ if (headers_only)
+ // will chain two requests - first one is to check last modified header alone
+ resource_request->method = "HEAD";
+ else
+ resource_request->method = "GET";
+
+ simple_url_loader_ = network::SimpleURLLoader::Create(
+ std::move(resource_request), traffic_annotation);
+ simple_url_loader_->SetRetryOptions(
+ kMaxRetriesOnNetworkChange,
+ network::SimpleURLLoader::RetryMode::RETRY_ON_NETWORK_CHANGE);
+ simple_url_loader_->SetAllowPartialResults(false);
+ simple_url_loader_->SetOnResponseStartedCallback(base::BindOnce(
+ &DownloadFiltersTask::OnResponseStarted, base::Unretained(this)));
+}
+
+DownloadFiltersTask::~DownloadFiltersTask() {
+ DCHECK(thread_checker_.CalledOnValidThread());
+}
+
+void DownloadFiltersTask::Run() {
+ DCHECK(thread_checker_.CalledOnValidThread());
+
+ // will not be initialized if the URL was empty
+ if (!simple_url_loader_) {
+ TaskComplete(Error::INVALID_ARGUMENT);
+ return;
+ }
+
+ download_start_time_ = base::TimeTicks::Now();
+ if (min_last_modified_.is_null()) {
+ internalDownload();
+ } else {
+ simple_url_loader_->DownloadHeadersOnly(
+ shared_url_network_factory_.get(),
+ base::BindOnce(&DownloadFiltersTask::OnHeadersDownloadComplete, base::Unretained(this))
+ );
+ }
+}
+
+void DownloadFiltersTask::internalDownload() {
+ simple_url_loader_->DownloadToTempFile(
+ shared_url_network_factory_.get(),
+ base::BindOnce(&DownloadFiltersTask::OnDownloadComplete, base::Unretained(this)),
+ kMaxBodySize);
+}
+
+void DownloadFiltersTask::OnHeadersDownloadComplete(scoped_refptr<net::HttpResponseHeaders> headers) {
+ // something went wrong
+ if (headers == nullptr) {
+ OnDownloadComplete(base::FilePath());
+ return;
+ }
+
+ // ignoring 'headers' as 'Last-Modified' has already been picked up by OnResponseStarted
+ const base::TimeDelta dt =
+ last_modified_ - min_last_modified_;
+
+ if (dt.InSeconds() > 0) {
+ // prepare for next simple URL loader and trigger download
+ createSimpleURLLoader(false);
+ internalDownload();
+ return;
+ }
+
+ // the remote filters are not more recent than known ones
+ TaskComplete(Error::UPDATE_NOT_NEEDED);
+}
+
+void DownloadFiltersTask::OnResponseStarted(
+ const GURL& final_url,
+ const network::mojom::URLResponseHead& response_head) {
+
+ final_url_ = final_url;
+ response_code_ = response_head.headers ? response_head.headers->response_code() : -1;
+
+ std::optional<base::Time> last_modified_value =
+ response_head.headers->GetLastModifiedValue();
+ if (last_modified_value) {
+ last_modified_ = last_modified_value.value();
+ LOG(INFO) << "DownloadFiltersTask: fetching URL '"
+ << final_url.spec()
+ << "' with method "
+ << (min_last_modified_.is_null() ? "GET" : "HEAD");
+ } else {
+ LOG(WARNING) << "DownloadFiltersTask: fetching URL '"
+ << final_url.spec()
+ << "' with method "
+ << (min_last_modified_.is_null() ? "GET" : "HEAD")
+ << " (no Last-Modified header)";
+ }
+}
+
+void DownloadFiltersTask::OnDownloadComplete(base::FilePath file_path) {
+ DCHECK_CALLED_ON_VALID_THREAD(thread_checker_);
+ int net_error = simple_url_loader_->NetError();
+ int64_t content_size = simple_url_loader_->GetContentSize();
+
+ const base::TimeTicks download_end_time(base::TimeTicks::Now());
+ const base::TimeDelta download_time =
+ download_end_time >= download_start_time_
+ ? download_end_time - download_start_time_
+ : base::TimeDelta();
+
+ // Consider a 5xx response from the server as an indication to terminate
+ // the request and avoid overloading the server in this case.
+ // is not accepting requests for the moment.
+ int error = -1;
+ if (!file_path.empty() && response_code_ == 200) {
+ DCHECK_EQ(0, net_error);
+ error = 0;
+ } else if (response_code_ != -1) {
+ error = response_code_;
+ } else {
+ error = net_error;
+ }
+
+ LOG(INFO) << "DownloadFiltersTask: downloaded " << content_size << " bytes in "
+ << download_time.InMilliseconds() << "ms from '" << final_url_.spec()
+ << "' to '" << file_path << "' with net_error " << net_error << " and error " << error;
+
+ if (error) {
+ TaskComplete(Error::DOWNLOAD_ERROR);
+ return;
+ }
+
+ file_path_ = file_path;
+ TaskComplete(Error::NONE);
+}
+
+void DownloadFiltersTask::Cancel() {
+ DCHECK(thread_checker_.CalledOnValidThread());
+
+ LOG(INFO) << "DownloadFiltersTask: update cancelled";
+
+ // deletion of the simple_url_loader_ will cause cancellation of its active request, if any
+
+ TaskComplete(Error::UPDATE_CANCELED);
+}
+
+void DownloadFiltersTask::TaskComplete(Error error) {
+ DCHECK(thread_checker_.CalledOnValidThread());
+
+ base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
+ FROM_HERE, base::BindOnce(std::move(complete_callback_),
+ scoped_refptr<DownloadFiltersTask>(this), error));
+}
+
+base::Time DownloadFiltersTask::last_modified() {
+ return last_modified_;
+}
+
+base::FilePath DownloadFiltersTask::file_path() {
+ return file_path_;
+}
+
+} // namespace adblock_updater
diff --git a/components/component_updater/download_filters_task.h b/components/component_updater/download_filters_task.h
new file mode 100644
--- /dev/null
+++ b/components/component_updater/download_filters_task.h
@@ -0,0 +1,129 @@
+/*
+ This file is part of Bromite.
+
+ Bromite is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ Bromite is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with Bromite. If not, see <https://www.gnu.org/licenses/>.
+*/
+
+#ifndef COMPONENTS_DOWNLOAD_FILTERS_TASK_H_
+#define COMPONENTS_DOWNLOAD_FILTERS_TASK_H_
+
+#include <string>
+#include <vector>
+
+#include "base/memory/ref_counted.h"
+#include "base/threading/thread_checker.h"
+#include "components/update_client/network.h"
+#include "url/gurl.h"
+#include "base/files/file_path.h"
+#include "services/network/public/cpp/shared_url_loader_factory.h"
+#include "services/network/public/cpp/simple_url_loader.h"
+
+namespace adblock_updater {
+
+// Errors generated as a result of calling Run() or by the service itself (UPDATE_IN_PROGRESS or UPDATE_CANCELED)
+enum class Error {
+ NONE = 0,
+ UPDATE_IN_PROGRESS = 1,
+ UPDATE_CANCELED = 2,
+ UPDATE_NOT_NEEDED = 3,
+ DOWNLOAD_ERROR = 4,
+ INVALID_ARGUMENT = 5,
+ MAX_VALUE,
+};
+
+enum class Event {
+ // Sent before the update client does an update check.
+ ADBLOCK_CHECKING_FOR_UPDATES = 1,
+
+ // Sent after the new filters have been downloaded but before the install
+ // or the upgrade is attempted.
+ ADBLOCK_UPDATE_READY,
+
+ // Sent when filters are being downloaded.
+ ADBLOCK_UPDATE_DOWNLOADING,
+
+ // Sent when filters have been successfully updated.
+ ADBLOCK_UPDATED,
+
+ // Sent when filters have not been updated because there
+ // was no new version available
+ //TODO: implement this with the headers check
+ ADBLOCK_NOT_UPDATED,
+
+ // Sent when an error ocurred during an update for any reason, including
+ // the update check itself failed, or the download of the update payload
+ // failed, or applying the update failed.
+ ADBLOCK_UPDATE_ERROR,
+};
+
+// Defines a specialized task for updating AdBlock filters.
+class DownloadFiltersTask : public base::RefCounted<DownloadFiltersTask> {
+ public:
+ DownloadFiltersTask(const DownloadFiltersTask&) = delete;
+ DownloadFiltersTask& operator=(const DownloadFiltersTask&) = delete;
+
+ using Callback =
+ base::OnceCallback<void(scoped_refptr<DownloadFiltersTask> task, Error error)>;
+
+ // |shared_url_network_factory| is injected here for the URL loader factory.
+ // |is_foreground| is true when the update task is initiated by the user.
+ // |filters_url| is the URL to load filters from.
+ // |complete_callback| is called to return the execution flow back to creator of
+ // this task when the task is done.
+ DownloadFiltersTask(scoped_refptr<network::SharedURLLoaderFactory> shared_url_network_factory,
+ bool is_foreground, const std::string& filters_url, base::Time min_last_modified,
+ Callback complete_callback);
+
+ void Run();
+
+ void Cancel();
+
+ base::FilePath file_path();
+
+ base::Time last_modified();
+
+ private:
+ ~DownloadFiltersTask();
+
+ void OnDownloadProgress(uint64_t current);
+ void OnResponseStarted(const GURL& final_url,
+ const network::mojom::URLResponseHead& response_head);
+ void OnDownloadComplete(base::FilePath file_path);
+ void OnHeadersDownloadComplete(scoped_refptr<net::HttpResponseHeaders> headers);
+ void createSimpleURLLoader(bool);
+ void internalDownload();
+
+ // Called when the task has completed either because the task has run or
+ // it has been canceled.
+ void TaskComplete(Error error);
+
+ base::ThreadChecker thread_checker_;
+ scoped_refptr<network::SharedURLLoaderFactory> shared_url_network_factory_;
+ const bool is_foreground_;
+ Callback complete_callback_;
+ std::unique_ptr<network::SimpleURLLoader> simple_url_loader_;
+
+ // fields populated while downloading
+ base::TimeTicks download_start_time_;
+ GURL final_url_, filters_url_;
+ int response_code_;
+ base::Time last_modified_, min_last_modified_;
+ base::FilePath file_path_;
+
+ friend class base::RefCounted<DownloadFiltersTask>;
+};
+
+} // namespace update_client
+
+#endif // COMPONENTS_DOWNLOAD_FILTERS_TASK_H_
diff --git a/components/subresource_filter/content/browser/content_subresource_filter_throttle_manager.cc b/components/subresource_filter/content/browser/content_subresource_filter_throttle_manager.cc
--- a/components/subresource_filter/content/browser/content_subresource_filter_throttle_manager.cc
+++ b/components/subresource_filter/content/browser/content_subresource_filter_throttle_manager.cc
@@ -17,7 +17,10 @@
#include "base/trace_event/trace_event.h"
#include "base/trace_event/traced_value.h"
#include "base/tracing/protos/chrome_track_event.pbzero.h"
+#include "components/content_settings/core/common/content_settings_types.h"
#include "components/subresource_filter/content/browser/activation_state_computing_navigation_throttle.h"
+#include "components/subresource_filter/content/browser/subresource_filter_content_settings_manager.h"
+#include "components/subresource_filter/content/browser/subresource_filter_profile_context.h"
#include "components/subresource_filter/content/browser/ad_tagging_utils.h"
#include "components/subresource_filter/content/browser/content_subresource_filter_web_contents_helper.h"
#include "components/subresource_filter/content/browser/page_load_statistics.h"
@@ -113,6 +116,7 @@ ContentSubresourceFilterThrottleManager::
profile_interaction_manager_(
std::make_unique<subresource_filter::ProfileInteractionManager>(
profile_context)),
+ profile_context_(profile_context),
web_contents_helper_(web_contents_helper) {}
ContentSubresourceFilterThrottleManager::
@@ -658,6 +662,17 @@ ContentSubresourceFilterThrottleManager::
throttle->NotifyPageActivationWithRuleset(EnsureRulesetHandle(),
ad_tagging_state);
}
+
+ const GURL& url(navigation_handle.GetURL());
+ if (profile_context_->settings_manager()->GetSitePermission(url) != CONTENT_SETTING_ALLOW) {
+ subresource_filter::ActivationDecision ignored_decision;
+ mojom::ActivationState ad_filtering_state;
+ ad_filtering_state.activation_level = profile_interaction_manager_->OnPageActivationComputed(
+ &navigation_handle, mojom::ActivationLevel::kEnabled, &ignored_decision);
+ throttle->NotifyPageActivationWithRuleset(EnsureRulesetHandle(),
+ ad_filtering_state);
+ }
+
return throttle;
}
diff --git a/components/subresource_filter/content/browser/content_subresource_filter_throttle_manager.h b/components/subresource_filter/content/browser/content_subresource_filter_throttle_manager.h
--- a/components/subresource_filter/content/browser/content_subresource_filter_throttle_manager.h
+++ b/components/subresource_filter/content/browser/content_subresource_filter_throttle_manager.h
@@ -410,6 +410,8 @@ class ContentSubresourceFilterThrottleManager
std::unique_ptr<ProfileInteractionManager> profile_interaction_manager_;
+ raw_ptr<SubresourceFilterProfileContext> profile_context_;
+
// Unowned since the throttle manager cannot outlive the Page that owns it.
// The throttle manager is held as user data first on NavigationHandle, then
// transferred to Page once it is created. Once the Page is created and this
diff --git a/components/subresource_filter/content/browser/ruleset_service.cc b/components/subresource_filter/content/browser/ruleset_service.cc
--- a/components/subresource_filter/content/browser/ruleset_service.cc
+++ b/components/subresource_filter/content/browser/ruleset_service.cc
@@ -49,12 +49,7 @@ namespace {
void RecordIndexAndWriteRulesetResult(
std::string_view uma_tag,
RulesetService::IndexAndWriteRulesetResult result) {
- base::UmaHistogramEnumeration(
- base::StrCat({uma_tag, ".WriteRuleset.Result"}), result,
- static_cast<RulesetService::IndexAndWriteRulesetResult>(
- static_cast<int>(
- RulesetService::IndexAndWriteRulesetResult::kMaxValue) +
- 1));
+ VLOG(1) << "SubresourceFilter.WriteRuleset.Result: " << static_cast<int>(result);
}
// Implements operations on a `sentinel file`, which is used as a safeguard to
@@ -236,11 +231,13 @@ RulesetService::RulesetService(
RulesetService::~RulesetService() = default;
void RulesetService::IndexAndStoreAndPublishRulesetIfNeeded(
- const UnindexedRulesetInfo& unindexed_ruleset_info) {
+ const UnindexedRulesetInfo& unindexed_ruleset_info, bool ignore_recent_version) {
if (unindexed_ruleset_info.content_version.empty()) {
+ LOG(INFO) << "RulesetService: ignoring update with empty version.";
return;
}
+ if (!ignore_recent_version) {
// Trying to store a ruleset with the same version for a second time would
// not only be futile, but would fail on Windows due to "File System
// Tunneling" as long as the previously stored copy of the rules is still
@@ -250,13 +247,16 @@ void RulesetService::IndexAndStoreAndPublishRulesetIfNeeded(
if (most_recently_indexed_version.IsCurrentFormatVersion() &&
most_recently_indexed_version.content_version ==
unindexed_ruleset_info.content_version) {
+ LOG(INFO) << "RulesetService: ignoring update with equal or older version.";
return;
}
+ }
// Before initialization, retain information about the most recently supplied
// unindexed ruleset, to be processed during initialization.
if (!is_initialized_) {
queued_unindexed_ruleset_info_ = unindexed_ruleset_info;
+ LOG(INFO) << "RulesetService: ignoring update while not initialized.";
return;
}
@@ -276,6 +276,23 @@ IndexedRulesetVersion RulesetService::IndexAndWriteRuleset(
const RulesetConfig& config,
const base::FilePath& indexed_ruleset_base_dir,
const UnindexedRulesetInfo& unindexed_ruleset_info) {
+ IndexedRulesetVersion version =
+ IndexAndWriteRulesetInternal(
+ config,
+ indexed_ruleset_base_dir,
+ unindexed_ruleset_info);
+ // cleanup temporary file when done
+ if (unindexed_ruleset_info.delete_ruleset_path) {
+ base::DeleteFile(unindexed_ruleset_info.ruleset_path);
+ }
+ return version;
+}
+
+// static
+IndexedRulesetVersion RulesetService::IndexAndWriteRulesetInternal(
+ const RulesetConfig& config,
+ const base::FilePath& indexed_ruleset_base_dir,
+ const UnindexedRulesetInfo& unindexed_ruleset_info) {
base::ScopedBlockingCall scoped_blocking_call(FROM_HERE,
base::BlockingType::MAY_BLOCK);
@@ -283,6 +300,7 @@ IndexedRulesetVersion RulesetService::IndexAndWriteRuleset(
unindexed_ruleset_info);
if (!unindexed_ruleset_stream_generator.ruleset_stream()) {
+ LOG(WARNING) << "RulesetService: failed to open: " << unindexed_ruleset_info.ruleset_path;
RecordIndexAndWriteRulesetResult(
config.uma_tag,
IndexAndWriteRulesetResult::kFailedOpeningUnindexedRuleset);
@@ -297,6 +315,7 @@ IndexedRulesetVersion RulesetService::IndexAndWriteRuleset(
indexed_ruleset_base_dir, indexed_version);
if (!base::CreateDirectory(indexed_ruleset_version_dir)) {
+ LOG(WARNING) << "RulesetService: failed to create version dir: " << indexed_ruleset_version_dir;
RecordIndexAndWriteRulesetResult(
config.uma_tag, IndexAndWriteRulesetResult::kFailedCreatingVersionDir);
return IndexedRulesetVersion(config.filter_tag);
@@ -304,13 +323,11 @@ IndexedRulesetVersion RulesetService::IndexAndWriteRuleset(
SentinelFile sentinel_file(indexed_ruleset_version_dir);
if (sentinel_file.IsPresent()) {
- RecordIndexAndWriteRulesetResult(
- config.uma_tag,
- IndexAndWriteRulesetResult::kAbortedBecauseSentinelFilePresent);
- return IndexedRulesetVersion(config.filter_tag);
+ LOG(WARNING) << "RulesetService: sentinel file is present in " << indexed_ruleset_version_dir;
}
if (!sentinel_file.Create()) {
+ LOG(WARNING) << "RulesetService: cannot create sentinel file in " << indexed_ruleset_version_dir;
RecordIndexAndWriteRulesetResult(
config.uma_tag,
IndexAndWriteRulesetResult::kFailedCreatingSentinelFile);
@@ -325,6 +342,7 @@ IndexedRulesetVersion RulesetService::IndexAndWriteRuleset(
RulesetIndexer indexer;
if (!(*g_index_ruleset_func)(config, &unindexed_ruleset_stream_generator,
&indexer)) {
+ LOG(WARNING) << "RulesetService: failed parsing.";
RecordIndexAndWriteRulesetResult(
config.uma_tag,
IndexAndWriteRulesetResult::kFailedParsingUnindexedRuleset);
@@ -345,9 +363,12 @@ IndexedRulesetVersion RulesetService::IndexAndWriteRuleset(
unindexed_ruleset_info.license_path, indexer.data());
RecordIndexAndWriteRulesetResult(config.uma_tag, result);
if (result != IndexAndWriteRulesetResult::kSuccess) {
+ LOG(INFO) << "RulesetService: failed to index.";
return IndexedRulesetVersion(config.filter_tag);
}
+ LOG(INFO) << "RulesetService: successful parsing.";
+
CHECK(indexed_version.IsValid());
return indexed_version;
}
@@ -471,6 +492,7 @@ void RulesetService::IndexAndStoreRuleset(
void RulesetService::OnWrittenRuleset(WriteRulesetCallback result_callback,
const IndexedRulesetVersion& version) {
CHECK(!result_callback.is_null());
+ LOG(INFO) << "RulesetService: valid version: " << version.IsValid();
if (!version.IsValid()) {
return;
}
diff --git a/components/subresource_filter/content/browser/ruleset_service.h b/components/subresource_filter/content/browser/ruleset_service.h
--- a/components/subresource_filter/content/browser/ruleset_service.h
+++ b/components/subresource_filter/content/browser/ruleset_service.h
@@ -183,7 +183,7 @@ class RulesetService {
//
// Virtual so that it can be mocked out in tests.
virtual void IndexAndStoreAndPublishRulesetIfNeeded(
- const UnindexedRulesetInfo& unindexed_ruleset_info);
+ const UnindexedRulesetInfo& unindexed_ruleset_info, bool ignore_recent_version = false);
// Get the ruleset version associated with the current local_state_.
IndexedRulesetVersion GetMostRecentlyIndexedVersion() const;
@@ -219,6 +219,12 @@ class RulesetService {
const base::FilePath& indexed_ruleset_base_dir,
const UnindexedRulesetInfo& unindexed_ruleset_info);
+ // internal function used to wrap the temporary file deletion for unindexed rulesets
+ static IndexedRulesetVersion IndexAndWriteRulesetInternal(
+ const RulesetConfig& config,
+ const base::FilePath& indexed_ruleset_base_dir,
+ const UnindexedRulesetInfo& unindexed_ruleset_info);
+
// Reads the rules via the |unindexed_ruleset_stream_generator|, and indexes
// them using |indexer|. Returns whether the entire ruleset could be parsed.
static bool IndexRuleset(
diff --git a/components/subresource_filter/content/browser/unindexed_ruleset_stream_generator.cc b/components/subresource_filter/content/browser/unindexed_ruleset_stream_generator.cc
--- a/components/subresource_filter/content/browser/unindexed_ruleset_stream_generator.cc
+++ b/components/subresource_filter/content/browser/unindexed_ruleset_stream_generator.cc
@@ -12,6 +12,7 @@
#include "third_party/protobuf/src/google/protobuf/io/zero_copy_stream_impl.h"
#include "third_party/protobuf/src/google/protobuf/io/zero_copy_stream_impl_lite.h"
#include "ui/base/resource/resource_bundle.h"
+#include "base/logging.h"
namespace subresource_filter {
@@ -46,6 +47,8 @@ void UnindexedRulesetStreamGenerator::GenerateStreamFromFile(
ruleset_size_ = unindexed_ruleset_file.GetLength();
+ LOG(INFO) << "Opened " << ruleset_path << " size " << ruleset_size_;
+
copying_stream_ = std::make_unique<CopyingFileInputStream>(
std::move(unindexed_ruleset_file));
ruleset_stream_ =
diff --git a/components/subresource_filter/core/browser/ruleset_version.h b/components/subresource_filter/core/browser/ruleset_version.h
--- a/components/subresource_filter/core/browser/ruleset_version.h
+++ b/components/subresource_filter/core/browser/ruleset_version.h
@@ -53,6 +53,10 @@ struct UnindexedRulesetInfo {
// can be indicated not only by setting |license_path| to empty, but also by
// setting it to any non existent path.
base::FilePath license_path;
+
+ // Whether to delete or not the ruleset path once done indexing; useful for disposal
+ // of temporary files.
+ bool delete_ruleset_path;
};
// Encapsulates the combination of the binary format version of the indexed
diff --git a/components/subresource_filter/core/browser/subresource_filter_features.cc b/components/subresource_filter/core/browser/subresource_filter_features.cc
--- a/components/subresource_filter/core/browser/subresource_filter_features.cc
+++ b/components/subresource_filter/core/browser/subresource_filter_features.cc
@@ -54,75 +54,8 @@ class CommaSeparatedStrings {
const std::vector<std::string_view> pieces_;
};
-std::string TakeVariationParamOrReturnEmpty(
- std::map<std::string, std::string>* params,
- const std::string& key) {
- auto it = params->find(key);
- if (it == params->end()) {
- return std::string();
- }
- std::string value = std::move(it->second);
- params->erase(it);
- return value;
-}
-
-mojom::ActivationLevel ParseActivationLevel(std::string_view activation_level) {
- if (base::EqualsCaseInsensitiveASCII(activation_level,
- kActivationLevelEnabled)) {
- return mojom::ActivationLevel::kEnabled;
- } else if (base::EqualsCaseInsensitiveASCII(activation_level,
- kActivationLevelDryRun)) {
- return mojom::ActivationLevel::kDryRun;
- }
- return mojom::ActivationLevel::kDisabled;
-}
-
-ActivationScope ParseActivationScope(std::string_view activation_scope) {
- if (base::EqualsCaseInsensitiveASCII(activation_scope,
- kActivationScopeAllSites)) {
- return ActivationScope::ALL_SITES;
- } else if (base::EqualsCaseInsensitiveASCII(activation_scope,
- kActivationScopeActivationList)) {
- return ActivationScope::ACTIVATION_LIST;
- }
- return ActivationScope::NO_SITES;
-}
-
-ActivationList ParseActivationList(std::string activation_lists_string) {
- CommaSeparatedStrings activation_lists(std::move(activation_lists_string));
- if (activation_lists.CaseInsensitiveContains(
- kActivationListPhishingInterstitial)) {
- return ActivationList::PHISHING_INTERSTITIAL;
- } else if (activation_lists.CaseInsensitiveContains(
- kActivationListSocialEngineeringAdsInterstitial)) {
- return ActivationList::SOCIAL_ENG_ADS_INTERSTITIAL;
- } else if (activation_lists.CaseInsensitiveContains(
- kActivationListSubresourceFilter)) {
- return ActivationList::SUBRESOURCE_FILTER;
- } else if (activation_lists.CaseInsensitiveContains(
- kActivationListBetterAds)) {
- return ActivationList::BETTER_ADS;
- }
- return ActivationList::NONE;
-}
-
-// Will return a value between 0 and 1 inclusive.
-double ParsePerformanceMeasurementRate(const std::string& rate) {
- double value = 0.0;
- if (!base::StringToDouble(rate, &value) || value < 0) {
- return 0.0;
- }
- return value < 1 ? value : 1;
-}
-
-int ParseInt(std::string_view value) {
- int result = 0;
- base::StringToInt(value, &result);
- return result;
-}
-
std::vector<Configuration> FillEnabledPresetConfigurations(
- std::map<std::string, std::string>* params) {
+ /*std::map<std::string, std::string>* params*/) {
// If ad tagging is enabled, turn on the dryrun automatically.
bool ad_tagging_enabled = base::FeatureList::IsEnabled(kAdTagging);
const struct {
@@ -130,23 +63,16 @@ std::vector<Configuration> FillEnabledPresetConfigurations(
bool enabled_by_default;
Configuration (*factory_method)();
} kAvailablePresetConfigurations[] = {
- {kPresetLiveRunOnPhishingSites, true,
+ {kPresetLiveRunOnPhishingSites, false,
&Configuration::MakePresetForLiveRunOnPhishingSites},
{kPresetPerformanceTestingDryRunOnAllSites, ad_tagging_enabled,
&Configuration::MakePresetForPerformanceTestingDryRunOnAllSites},
{kPresetLiveRunForBetterAds, true,
&Configuration::MakePresetForLiveRunForBetterAds}};
- CommaSeparatedStrings enabled_presets(
- TakeVariationParamOrReturnEmpty(params, kEnablePresetsParameterName));
- CommaSeparatedStrings disabled_presets(
- TakeVariationParamOrReturnEmpty(params, kDisablePresetsParameterName));
-
std::vector<Configuration> enabled_configurations;
for (const auto& available_preset : kAvailablePresetConfigurations) {
- if ((enabled_presets.CaseInsensitiveContains(available_preset.name) ||
- available_preset.enabled_by_default) &&
- !disabled_presets.CaseInsensitiveContains(available_preset.name)) {
+ if (available_preset.enabled_by_default) {
enabled_configurations.push_back(available_preset.factory_method());
}
}
@@ -154,48 +80,12 @@ std::vector<Configuration> FillEnabledPresetConfigurations(
return enabled_configurations;
}
-Configuration ParseExperimentalConfiguration(
- std::map<std::string, std::string>* params) {
- Configuration configuration;
-
- // ActivationConditions:
- configuration.activation_conditions.activation_scope = ParseActivationScope(
- TakeVariationParamOrReturnEmpty(params, kActivationScopeParameterName));
-
- configuration.activation_conditions.activation_list = ParseActivationList(
- TakeVariationParamOrReturnEmpty(params, kActivationListsParameterName));
-
- configuration.activation_conditions.priority =
- ParseInt(TakeVariationParamOrReturnEmpty(
- params, kActivationPriorityParameterName));
-
- // ActivationOptions:
- configuration.activation_options.activation_level = ParseActivationLevel(
- TakeVariationParamOrReturnEmpty(params, kActivationLevelParameterName));
-
- configuration.activation_options.performance_measurement_rate =
- ParsePerformanceMeasurementRate(TakeVariationParamOrReturnEmpty(
- params, kPerformanceMeasurementRateParameterName));
-
- // GeneralSettings:
- configuration.general_settings.ruleset_flavor =
- TakeVariationParamOrReturnEmpty(params, kRulesetFlavorParameterName);
-
- return configuration;
-}
-
std::vector<Configuration> ParseEnabledConfigurations() {
- std::map<std::string, std::string> params;
- base::GetFieldTrialParamsByFeature(kSafeBrowsingSubresourceFilter, &params);
-
std::vector<Configuration> configs;
if (base::FeatureList::IsEnabled(kSafeBrowsingSubresourceFilter)) {
- configs = FillEnabledPresetConfigurations(&params);
+ configs = FillEnabledPresetConfigurations();
}
- Configuration experimental_config = ParseExperimentalConfiguration(&params);
- configs.push_back(std::move(experimental_config));
-
return configs;
}
diff --git a/components/subresource_filter/core/browser/verified_ruleset_dealer.cc b/components/subresource_filter/core/browser/verified_ruleset_dealer.cc
--- a/components/subresource_filter/core/browser/verified_ruleset_dealer.cc
+++ b/components/subresource_filter/core/browser/verified_ruleset_dealer.cc
@@ -11,6 +11,7 @@
#include "base/functional/bind.h"
#include "base/functional/callback_helpers.h"
#include "base/location.h"
+#include "base/logging.h"
#include "base/notreached.h"
#include "base/task/sequenced_task_runner.h"
#include "base/trace_event/trace_event.h"
@@ -39,6 +40,9 @@ RulesetFilePtr VerifiedRulesetDealer::OpenAndSetRulesetFile(
TRACE_EVENT1(TRACE_DISABLED_BY_DEFAULT("loading"),
"VerifiedRulesetDealer::OpenAndSetRulesetFile", "file_valid",
file->IsValid());
+
+ LOG(INFO) << "OpenAndSetRulesetFile: " << file_path << " is valid: " << file->IsValid();
+
if (file->IsValid()) {
SetRulesetFile(file->Duplicate());
expected_checksum_ = expected_checksum;
diff --git a/components/subresource_filter/core/common/indexed_ruleset.cc b/components/subresource_filter/core/common/indexed_ruleset.cc
--- a/components/subresource_filter/core/common/indexed_ruleset.cc
+++ b/components/subresource_filter/core/common/indexed_ruleset.cc
@@ -7,6 +7,7 @@
#include "base/check.h"
#include "base/functional/callback.h"
#include "base/hash/hash.h"
+#include "base/logging.h"
#include "base/metrics/histogram_functions.h"
#include "base/strings/strcat.h"
#include "base/trace_event/trace_event.h"
@@ -38,7 +39,9 @@ VerifyStatus GetVerifyStatus(base::span<const uint8_t> buffer,
// least once. The verifier detects a subset of the errors detected by the
// checksum, and is unneeded once expected_checksum is consistently nonzero.
flatbuffers::Verifier verifier(buffer.data(), buffer.size());
- if (expected_checksum != 0 && expected_checksum != LocalGetChecksum(buffer)) {
+ int local_checksum = LocalGetChecksum(buffer);
+ LOG(INFO) << "GetVerifyStatus: expected checksum = 0x" << std::hex << expected_checksum << ", local checksum = 0x" << std::hex << local_checksum;
+ if (expected_checksum != 0 && expected_checksum != local_checksum) {
return flat::VerifyIndexedRulesetBuffer(verifier)
? VerifyStatus::kChecksumFailVerifierPass
: VerifyStatus::kChecksumFailVerifierFail;
--
Reference in New Issue View Git Blame Copy Permalink