[fenix] For https://github.com/mozilla-mobile/fenix/issues/1084 - Add Setting to enable/disable TP

2024-11-17 15:26:23 +00:00 · 2019-04-12 14:36:46 -07:00 · 2019-04-12 14:36:46 -07:00 · 35d3e5c949
commit 35d3e5c949
parent 1be065e488
10 changed files with 129 additions and 10 deletions
--- a/app/src/main/java/org/mozilla/fenix/components/Core.kt
+++ b/app/src/main/java/org/mozilla/fenix/components/Core.kt
@ -5,10 +5,8 @@
 package org.mozilla.fenix.components

 import android.content.Context
-import android.content.SharedPreferences
 import android.content.res.Configuration
 import android.os.Bundle
-import android.preference.PreferenceManager
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.GlobalScope
 import kotlinx.coroutines.async
@ -60,13 +58,11 @@ class Core(private val context: Context) {
     * configuration (see build variants).
     */
    val engine: Engine by lazy {
-        val prefs = PreferenceManager.getDefaultSharedPreferences(context)
-
        val defaultSettings = DefaultSettings(
            requestInterceptor = AppRequestInterceptor(context),
            remoteDebuggingEnabled = Settings.getInstance(context).isRemoteDebuggingEnabled,
            testingModeEnabled = false,
-            trackingProtectionPolicy = createTrackingProtectionPolicy(prefs),
+            trackingProtectionPolicy = createTrackingProtectionPolicy(),
            historyTrackingDelegate = HistoryDelegate(historyStorage)
        )

@ -133,17 +129,14 @@ class Core(private val context: Context) {
    /**
     * Constructs a [TrackingProtectionPolicy] based on current preferences.
     *
-     * @param prefs the shared preferences to use when reading tracking
-     * protection settings.
     * @param normalMode whether or not tracking protection should be enabled
     * in normal browsing mode, defaults to the current preference value.
     * @param privateMode whether or not tracking protection should be enabled
     * in private browsing mode, default to the current preference value.
     * @return the constructed tracking protection policy based on preferences.
     */
-    fun createTrackingProtectionPolicy(
-        prefs: SharedPreferences = PreferenceManager.getDefaultSharedPreferences(context),
-        normalMode: Boolean = true,
+    private fun createTrackingProtectionPolicy(
+        normalMode: Boolean = Settings.getInstance(context).shouldUseTrackingProtection,
        privateMode: Boolean = true
    ): TrackingProtectionPolicy {
        val trackingProtectionPolicy = TrackingProtectionPolicy.select(
@ -160,6 +153,11 @@ class Core(private val context: Context) {
        }
    }

+    fun updateTrackingProtection(newValue: Boolean) {
+        engine.settings.trackingProtectionPolicy =
+            createTrackingProtectionPolicy(normalMode = newValue)
+    }
+
    /**
     * Sets Preferred Color scheme based on Dark/Light Theme Settings or Current Configuration
     */
--- a/app/src/main/java/org/mozilla/fenix/settings/SettingsFragment.kt
+++ b/app/src/main/java/org/mozilla/fenix/settings/SettingsFragment.kt
@ -47,6 +47,7 @@ import org.mozilla.fenix.R.string.pref_key_theme
 import org.mozilla.fenix.R.string.pref_key_account
 import org.mozilla.fenix.R.string.pref_key_account_category
 import org.mozilla.fenix.R.string.pref_key_search_engine_settings
+import org.mozilla.fenix.R.string.pref_key_tracking_protection_settings
 import org.mozilla.fenix.utils.ItsNotBrokenSnack

@SuppressWarnings("TooManyFunctions")
@ -99,6 +100,9 @@ class SettingsFragment : PreferenceFragmentCompat(), CoroutineScope, AccountObse
            resources.getString(pref_key_search_engine_settings) -> {
                navigateToSearchEngineSettings()
            }
+            resources.getString(pref_key_tracking_protection_settings) -> {
+                navigateToTrackingProtectionSettings()
+            }
            resources.getString(pref_key_site_permissions) -> {
                navigateToSitePermissions()
            }
@ -221,6 +225,11 @@ class SettingsFragment : PreferenceFragmentCompat(), CoroutineScope, AccountObse
        Navigation.findNavController(view!!).navigate(directions)
    }

+    private fun navigateToTrackingProtectionSettings() {
+        val directions = SettingsFragmentDirections.actionSettingsFragmentToTrackingProtectionFragment()
+        Navigation.findNavController(view!!).navigate(directions)
+    }
+
    private fun navigateToThemeSettings() {
        val directions = SettingsFragmentDirections.actionSettingsFragmentToThemeFragment()
        Navigation.findNavController(view!!).navigate(directions)
--- a/app/src/main/java/org/mozilla/fenix/settings/TrackingProtectionFragment.kt
+++ b/app/src/main/java/org/mozilla/fenix/settings/TrackingProtectionFragment.kt
@ -0,0 +1,51 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+package org.mozilla.fenix.settings
+
+import android.os.Bundle
+import androidx.appcompat.app.AppCompatActivity
+import androidx.preference.Preference
+import androidx.preference.PreferenceFragmentCompat
+import org.mozilla.fenix.R
+import org.mozilla.fenix.ext.getPreferenceKey
+import org.mozilla.fenix.ext.requireComponents
+
+class TrackingProtectionFragment : PreferenceFragmentCompat() {
+    override fun onCreate(savedInstanceState: Bundle?) {
+        super.onCreate(savedInstanceState)
+        (activity as AppCompatActivity).title = getString(R.string.preferences_tracking_protection)
+        (activity as AppCompatActivity).supportActionBar?.show()
+    }
+
+    override fun onCreatePreferences(savedInstanceState: Bundle?, rootKey: String?) {
+        setPreferencesFromResource(R.xml.tracking_protection_preferences, rootKey)
+    }
+
+    override fun onResume() {
+        super.onResume()
+        // Tracking Protection Switch
+        val trackingProtectionKey =
+            context!!.getPreferenceKey(R.string.pref_key_tracking_protection)
+        val preferenceTP = findPreference<Preference>(trackingProtectionKey)
+        preferenceTP?.onPreferenceChangeListener =
+            Preference.OnPreferenceChangeListener { _, newValue ->
+                requireComponents.core.updateTrackingProtection(newValue as Boolean)
+                true
+            }
+
+        // Exceptions
+        val exceptions =
+            context!!.getPreferenceKey(R.string.pref_key_tracking_protection_exceptions)
+        val preferenceExceptions = findPreference<Preference>(exceptions)
+        preferenceExceptions?.onPreferenceClickListener = getClickListenerForSignOut()
+    }
+
+    private fun getClickListenerForSignOut(): Preference.OnPreferenceClickListener {
+        return Preference.OnPreferenceClickListener {
+            // TODO go to Exceptions Fragment
+            true
+        }
+    }
+}
--- a/app/src/main/java/org/mozilla/fenix/utils/Settings.kt
+++ b/app/src/main/java/org/mozilla/fenix/utils/Settings.kt
@ -79,6 +79,12 @@ class Settings private constructor(context: Context) {
            false
        )

+    val shouldUseTrackingProtection: Boolean
+        get() = preferences.getBoolean(
+            appContext.getPreferenceKey(R.string.pref_key_tracking_protection),
+            true
+        )
+
    val shouldUseAutoBatteryTheme: Boolean
        get() = preferences.getBoolean(
            appContext.getPreferenceKey(R.string.pref_key_auto_battery_theme),
--- a/app/src/main/res/drawable/ic_tracking_protection.xml
+++ b/app/src/main/res/drawable/ic_tracking_protection.xml
@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- This Source Code Form is subject to the terms of the Mozilla Public
+   - License, v. 2.0. If a copy of the MPL was not distributed with this
+   - file, You can obtain one at http://mozilla.org/MPL/2.0/. -->
+<vector xmlns:android="http://schemas.android.com/apk/res/android"
+    android:width="24dp"
+    android:height="24dp"
+    android:viewportWidth="24"
+    android:viewportHeight="24">
+    <path
+        android:fillColor="?attr/primaryTextColor"
+        android:fillType="evenOdd"
+        android:pathData="M20,6.047C19.9965,4.9927 19.2276,4.0971 18.186,3.934L12,2.912L5.816,3.933C4.7741,4.0968 4.0049,4.9923 4,6.047C4,7.729 4.012,9.954 4.111,11.005C4.411,14.205 5.033,15.96 6.56,17.954C7.8759,19.6329 9.7831,20.746 11.892,21.066L12,21.078L12.107,21.066C14.2159,20.746 16.1231,19.6329 17.439,17.954C18.967,15.96 19.584,14.206 19.888,11.005L19.888,11.005C19.993,9.891 20,7.421 20,6.047ZM17.9,10.815C17.63,13.659 17.152,15.043 15.855,16.739C14.8897,17.9499 13.5217,18.7739 12,19.061C10.4792,18.7737 9.1122,17.9496 8.148,16.739C6.848,15.039 6.372,13.659 6.103,10.816C6.031,10.059 6,8.367 6,6.054C6.0036,5.9768 6.0631,5.9138 6.14,5.906L12,4.939L17.861,5.907C17.9376,5.9135 17.9972,5.9762 18,6.053C18.005,8.328 17.968,10.064 17.9,10.815ZM8,7.626C8.015,9.593 8.066,10.365 8.091,10.626C8.347,13.326 8.785,14.282 9.733,15.526C10.3122,16.2484 11.1061,16.7677 12,17.009L12,6.967L8,7.626Z" />
+</vector>
--- a/app/src/main/res/navigation/nav_graph.xml
+++ b/app/src/main/res/navigation/nav_graph.xml
@ -198,6 +198,9 @@
        <action
            android:id="@+id/action_settingsFragment_to_themeFragment"
            app:destination="@id/themeFragment" />
+        <action
+            android:id="@+id/action_settingsFragment_to_trackingProtectionFragment"
+            app:destination="@id/trackingProtectionFragment" />
    </fragment>
    <fragment android:id="@+id/dataChoicesFragment" android:name="org.mozilla.fenix.settings.DataChoicesFragment"
              android:label="DataChoicesFragment"/>
@ -240,4 +243,8 @@
        android:id="@+id/themeFragment"
        android:name="org.mozilla.fenix.settings.ThemeFragment"
        android:label="ThemeFragment" />
+    <fragment
+        android:id="@+id/trackingProtectionFragment"
+        android:name="org.mozilla.fenix.settings.TrackingProtectionFragment"
+        android:label="TrackingProtectionFragment" />
 </navigation>
--- a/app/src/main/res/values/preference_keys.xml
+++ b/app/src/main/res/values/preference_keys.xml
@ -55,4 +55,9 @@
    <string name="pref_key_dark_theme" translatable="false">pref_key_dark_theme</string>
    <string name="pref_key_auto_battery_theme" translatable="false">pref_key_auto_battery_theme</string>
    <string name="pref_key_follow_device_theme" translatable="false">pref_key_follow_device_theme</string>
+
+    <!-- Tracking Protection Settings -->
+    <string name="pref_key_tracking_protection_settings" translatable="false">pref_key_tracking_protection_settings</string>
+    <string name="pref_key_tracking_protection" translatable="false">pref_key_tracking_protection</string>
+    <string name="pref_key_tracking_protection_exceptions" translatable="false">pref_key_tracking_protection_exceptions</string>
 </resources>
--- a/app/src/main/res/values/strings.xml
+++ b/app/src/main/res/values/strings.xml
@ -156,6 +156,15 @@
    <string name="sync_never_synced_summary">Last synced: never</string>

    <!-- Advanced Preferences -->
+    <!-- Preference for tracking protection settings -->
+    <string name="preferences_tracking_protection_settings">Tracking Protection</string>
+    <!-- Preference switch for tracking protection -->
+    <string name="preferences_tracking_protection">Tracking Protection</string>
+    <!-- Preference switch description for tracking protection -->
+    <string name="preferences_tracking_protection_description">Block content and scripts that track you online</string>
+    <!-- Preference for tracking protection exceptions -->
+    <string name="preferences_tracking_protection_exceptions">Exceptions</string>
+
    <!-- Preference switch for Telemetry -->
    <string name="preferences_telemetry">Telemetry</string>
    <!-- Preference switch for crash reporter -->
--- a/app/src/main/res/xml/preferences.xml
+++ b/app/src/main/res/xml/preferences.xml
@ -55,6 +55,10 @@
    <androidx.preference.PreferenceCategory
        android:title="@string/preferences_category_advanced"
        app:iconSpaceReserved="false">
+        <androidx.preference.Preference
+            android:icon="@drawable/ic_tracking_protection"
+            android:key="@string/pref_key_tracking_protection_settings"
+            android:title="@string/preferences_tracking_protection" />
        <androidx.preference.Preference
            android:icon="@drawable/ic_permission"
            android:key="@string/pref_key_site_permissions"
--- a/app/src/main/res/xml/tracking_protection_preferences.xml
+++ b/app/src/main/res/xml/tracking_protection_preferences.xml
@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- This Source Code Form is subject to the terms of the Mozilla Public
+   - License, v. 2.0. If a copy of the MPL was not distributed with this
+   - file, You can obtain one at http://mozilla.org/MPL/2.0/. -->
+<androidx.preference.PreferenceScreen xmlns:android="http://schemas.android.com/apk/res/android">
+    <SwitchPreference
+        android:defaultValue="true"
+        android:icon="@drawable/ic_tracking_protection"
+        android:key="@string/pref_key_tracking_protection"
+        android:summary="@string/preferences_tracking_protection_description"
+        android:title="@string/preferences_tracking_protection" />
+    <Preference
+        android:icon="@drawable/ic_internet"
+        android:key="@string/pref_key_tracking_protection_exceptions"
+        android:title="@string/preferences_tracking_protection_exceptions" />
+</androidx.preference.PreferenceScreen>