2 * Copyright 2016 Soren Stoutner <soren@stoutner.com>.
4 * This file is part of Privacy Browser <https://www.stoutner.com/privacy-browser>.
6 * Privacy Browser is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * Privacy Browser is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with Privacy Browser. If not, see <http://www.gnu.org/licenses/>.
20 package com.stoutner.privacybrowser;
22 import android.annotation.SuppressLint;
23 import android.content.SharedPreferences;
24 import android.os.Build;
25 import android.os.Bundle;
26 import android.preference.Preference;
27 import android.preference.PreferenceFragment;
28 import android.view.MenuItem;
30 public class SettingsFragment extends PreferenceFragment {
31 private SharedPreferences.OnSharedPreferenceChangeListener preferencesListener;
32 private SharedPreferences savedPreferences;
35 public void onCreate(Bundle savedInstanceState) {
36 super.onCreate(savedInstanceState);
37 addPreferencesFromResource(R.xml.preferences);
39 // Initialize savedPreferences.
40 savedPreferences = getPreferenceScreen().getSharedPreferences();
42 // Allow the user to access "dom_storage_enabled" if "javascript_enabled" is enabled. The default is false.
43 final Preference domStorageEnabled = findPreference("dom_storage_enabled");
44 domStorageEnabled.setEnabled(savedPreferences.getBoolean("javascript_enabled", false));
46 // Allow the user to access "third_party_cookies_enabled" if "first_party_cookies_enabled" is enabled. The default is false.
47 final Preference thirdPartyCookiesEnabled = findPreference("third_party_cookies_enabled");
48 thirdPartyCookiesEnabled.setEnabled(savedPreferences.getBoolean("first_party_cookies_enabled", false));
50 // Set the current user-agent as the summary text for the "user_agent" preference when the preference screen is loaded.
51 final Preference userAgentPreference = findPreference("user_agent");
52 switch (savedPreferences.getString("user_agent", "Default user agent")) {
53 case "Default user agent":
54 // Get the user agent text from the webview (which changes based on the version of Android and WebView installed).
55 // Once API >= 17 we can use getDefaultUserAgent() instead of getUserAgentString().
56 userAgentPreference.setSummary(MainWebViewActivity.mainWebView.getSettings().getUserAgentString());
59 case "Custom user agent":
60 // We can't use the string from the array because it is referenced in code and can't be translated.
61 userAgentPreference.setSummary(R.string.custom_user_agent);
65 // Display the user agent from the preference as the summary text.
66 userAgentPreference.setSummary(savedPreferences.getString("user_agent", "Default user agent"));
70 // Set the summary text for "custom_user_agent" (the default is "PrivacyBrowser/1.0") and enable it if "user_agent" it set to "Custom user agent".
71 final Preference customUserAgent = findPreference("custom_user_agent");
72 customUserAgent.setSummary(savedPreferences.getString("custom_user_agent", "PrivacyBrowser/1.0"));
73 customUserAgent.setEnabled(userAgentPreference.getSummary().equals("Custom user agent"));
76 // Set the JavaScript-disabled search URL as the summary text for the JavaScript-disabled search preference when the preference screen is loaded.
77 // The default is "https://duckduckgo.com/html/?q=".
78 final Preference javaScriptDisabledSearchPreference = findPreference("javascript_disabled_search");
79 String javaScriptDisabledSearchString = savedPreferences.getString("javascript_disabled_search", "https://duckduckgo.com/html/?q=");
80 if (javaScriptDisabledSearchString.equals("Custom URL")) {
81 // If set to "Custom URL", use R.string.custom_url, which will be translated, instead of the array value, which will not.
82 javaScriptDisabledSearchPreference.setSummary(R.string.custom_url);
84 // Set the array value as the summary text.
85 javaScriptDisabledSearchPreference.setSummary(javaScriptDisabledSearchString);
88 // Set the summary text for "javascript_disabled_search_custom_url" (the default is "") and enable it if "javascript_disabled_search" is set to "Custom URL".
89 final Preference javaScriptDisabledSearchCustomURLPreference = findPreference("javascript_disabled_search_custom_url");
90 javaScriptDisabledSearchCustomURLPreference.setSummary(savedPreferences.getString("javascript_disabled_search_custom_url", ""));
91 javaScriptDisabledSearchCustomURLPreference.setEnabled(javaScriptDisabledSearchString.equals("Custom URL"));
94 // Set the JavaScript-enabled searchURL as the summary text for the JavaScript-enabled search preference when the preference screen is loaded.
95 // The default is "https://duckduckgo.com/?q=".
96 final Preference javaScriptEnabledSearchPreference = findPreference("javascript_enabled_search");
97 String javaScriptEnabledSearchString = savedPreferences.getString("javascript_enabled_search", "https://duckduckgo.com/?q=");
98 if (javaScriptEnabledSearchString.equals("Custom URL")) {
99 // If set to "Custom URL", use R.string.custom_url, which will be translated, instead of the array value, which will not.
100 javaScriptEnabledSearchPreference.setSummary(R.string.custom_url);
102 // Set the array value as the summary text.
103 javaScriptEnabledSearchPreference.setSummary(javaScriptEnabledSearchString);
106 // Set the summary text for "javascript_enabled_search_custom_url" (the default is "") and enable it if "javascript_enabled_search" is set to "Custom URL".
107 final Preference javaScriptEnabledSearchCustomURLPreference = findPreference("javascript_enabled_search_custom_url");
108 javaScriptEnabledSearchCustomURLPreference.setSummary(savedPreferences.getString("javascript_enabled_search_custom_url", ""));
109 javaScriptEnabledSearchCustomURLPreference.setEnabled(javaScriptEnabledSearchString.equals("Custom URL"));
112 // Set the homepage URL as the summary text for the `Homepage` preference when the preference screen is loaded. The default is `https://www.duckduckgo.com`.
113 final Preference homepagePreference = findPreference("homepage");
114 homepagePreference.setSummary(savedPreferences.getString("homepage", "https://www.duckduckgo.com"));
116 // Set the default font size as the summary text for the `Default Font Size` preference when the preference screen is loaded. The default is `100`.
117 final Preference defaultFontSizePreference = findPreference("default_font_size");
118 String defaultFontSizeString = savedPreferences.getString("default_font_size", "100");
119 defaultFontSizePreference.setSummary(defaultFontSizeString + "%%");
122 // Listen for preference changes.
123 preferencesListener = new SharedPreferences.OnSharedPreferenceChangeListener() {
125 // Remove Android Studio's warning about the dangers of using SetJavaScriptEnabled. We know.
126 @SuppressLint("SetJavaScriptEnabled")
127 public void onSharedPreferenceChanged(SharedPreferences sharedPreferences, String key) {
130 case "javascript_enabled":
131 // Set `javaScriptEnabled` to the new state. The default is `false`.
132 MainWebViewActivity.javaScriptEnabled = sharedPreferences.getBoolean("javascript_enabled", false);
134 // Toggle the state of the `dom_storage_enabled` preference. The default is `false`.
135 final Preference domStorageEnabled = findPreference("dom_storage_enabled");
136 domStorageEnabled.setEnabled(sharedPreferences.getBoolean("javascript_enabled", false));
138 // Update `mainWebView`.
139 MainWebViewActivity.mainWebView.getSettings().setJavaScriptEnabled(MainWebViewActivity.javaScriptEnabled);
141 // Update the privacy icons.
142 MainWebViewActivity.updatePrivacyIcons(MainWebViewActivity.privacyBrowserActivity);
145 case "first_party_cookies_enabled":
146 // Set `firstPartyCookiesEnabled` to the new state. The default is `false`.
147 MainWebViewActivity.firstPartyCookiesEnabled = sharedPreferences.getBoolean("first_party_cookies_enabled", false);
149 // Toggle the state of the `third_party_cookies_enabled` preference. The default is `false`.
150 final Preference thirdPartyCookiesEnabled = findPreference("third_party_cookies_enabled");
151 thirdPartyCookiesEnabled.setEnabled(sharedPreferences.getBoolean("first_party_cookies_enabled", false));
153 // Update `mainWebView`.
154 MainWebViewActivity.cookieManager.setAcceptCookie(MainWebViewActivity.firstPartyCookiesEnabled);
156 // Update the checkbox in the options menu.
157 MenuItem firstPartyCookiesMenuItem = MainWebViewActivity.mainMenu.findItem(R.id.toggleFirstPartyCookies);
158 firstPartyCookiesMenuItem.setChecked(MainWebViewActivity.firstPartyCookiesEnabled);
160 // Update the privacy icons.
161 MainWebViewActivity.updatePrivacyIcons(MainWebViewActivity.privacyBrowserActivity);
164 case "third_party_cookies_enabled":
165 // Set `thirdPartyCookiesEnabled` to the new state. The default is `false`.
166 MainWebViewActivity.thirdPartyCookiesEnabled = sharedPreferences.getBoolean("third_party_cookies_enabled", false);
168 // Update the checkbox in the options menu.
169 MenuItem thirdPartyCookiesMenuItem = MainWebViewActivity.mainMenu.findItem(R.id.toggleThirdPartyCookies);
170 thirdPartyCookiesMenuItem.setChecked(MainWebViewActivity.thirdPartyCookiesEnabled);
172 // Update `mainWebView` if API >= 21.
173 if (Build.VERSION.SDK_INT >= 21) {
174 MainWebViewActivity.cookieManager.setAcceptThirdPartyCookies(MainWebViewActivity.mainWebView, MainWebViewActivity.thirdPartyCookiesEnabled);
178 case "dom_storage_enabled":
179 // Set `domStorageEnabled` to the new state. The default is `false`.
180 MainWebViewActivity.domStorageEnabled = sharedPreferences.getBoolean("dom_storage_enabled", false);
182 // Update the checkbox in the options menu.
183 MenuItem domStorageMenuItem = MainWebViewActivity.mainMenu.findItem(R.id.toggleDomStorage);
184 domStorageMenuItem.setChecked(MainWebViewActivity.domStorageEnabled);
186 // Update `mainWebView`.
187 MainWebViewActivity.mainWebView.getSettings().setDomStorageEnabled(MainWebViewActivity.domStorageEnabled);
189 // Update the privacy icons.
190 MainWebViewActivity.updatePrivacyIcons(MainWebViewActivity.privacyBrowserActivity);
193 case "save_form_data_enabled":
194 // Set `saveFormDataEnabled` to the new state. The default is `false`.
195 MainWebViewActivity.saveFormDataEnabled = sharedPreferences.getBoolean("save_form_data_enabled", false);
197 // Update the checkbox in the options menu.
198 MenuItem saveFormDataMenuItem = MainWebViewActivity.mainMenu.findItem(R.id.toggleSaveFormData);
199 saveFormDataMenuItem.setChecked(MainWebViewActivity.saveFormDataEnabled);
201 // Update `mainWebView`.
202 MainWebViewActivity.mainWebView.getSettings().setSaveFormData(MainWebViewActivity.saveFormDataEnabled);
204 // Update the privacy icons.
205 MainWebViewActivity.updatePrivacyIcons(MainWebViewActivity.privacyBrowserActivity);
209 String userAgentString = sharedPreferences.getString("user_agent", "Default user agent");
211 switch (userAgentString) {
212 case "Default user agent":
213 // Set the default user agent on `mainWebView`, display the user agent as the summary text for `userAgentPreference`, and disable `customUserAgent`.
214 // Once API >= 17 we can use getDefaultUserAgent(). For now, setUserAgentString("") sets the WebView's default user agent.
215 MainWebViewActivity.mainWebView.getSettings().setUserAgentString("");
216 userAgentPreference.setSummary(MainWebViewActivity.mainWebView.getSettings().getUserAgentString());
217 customUserAgent.setEnabled(false);
220 case "Custom user agent":
221 // Set the custom user agent on mainWebView, display "Custom user agent" as the summary text for userAgentPreference, and enable customUserAgent.
222 MainWebViewActivity.mainWebView.getSettings().setUserAgentString(sharedPreferences.getString("custom_user_agent", "PrivacyBrowser/1.0"));
223 userAgentPreference.setSummary(R.string.custom_user_agent);
224 customUserAgent.setEnabled(true);
228 // Set the user agent on mainWebView, display the user agent as the summary text for userAgentPreference, and disable customUserAgent.
229 MainWebViewActivity.mainWebView.getSettings().setUserAgentString(sharedPreferences.getString("user_agent", "Default user agent"));
230 userAgentPreference.setSummary(MainWebViewActivity.mainWebView.getSettings().getUserAgentString());
231 customUserAgent.setEnabled(false);
236 case "custom_user_agent":
237 // Set the new custom user agent as the summary text for "custom_user_agent". The default is "PrivacyBrowser/1.0".
238 customUserAgent.setSummary(sharedPreferences.getString("custom_user_agent", "PrivacyBrowser/1.0"));
240 // Update mainWebView's user agent. The default is "PrivacyBrowser/1.0".
241 MainWebViewActivity.mainWebView.getSettings().setUserAgentString(sharedPreferences.getString("custom_user_agent", "PrivacyBrowser/1.0"));
244 case "javascript_disabled_search":
245 String newJavaScriptDisabledSearchString = sharedPreferences.getString("javascript_disabled_search", "https://duckduckgo.com/html/?q=");
246 if (newJavaScriptDisabledSearchString.equals("Custom URL")) {
247 // Set the summary text to R.string.custom_url, which will be translated.
248 javaScriptDisabledSearchPreference.setSummary(R.string.custom_url);
250 // Update the javaScriptDisabledSearchURL variable. The default is "".
251 MainWebViewActivity.javaScriptDisabledSearchURL = sharedPreferences.getString("javascript_disabled_search_custom_url", "");
252 } else { // javascript_disabled_search is not set to Custom.
253 // Set the new search URL as the summary text for the JavaScript-disabled search preference. The default is "https://duckduckgo.com/html/?q=".
254 javaScriptDisabledSearchPreference.setSummary(newJavaScriptDisabledSearchString);
256 // Update the javaScriptDisabledSearchURL variable. The default is "https://duckduckgo.com/html/?q=".
257 MainWebViewActivity.javaScriptDisabledSearchURL = newJavaScriptDisabledSearchString;
260 // Enable or disable javaScriptDisabledSearchCustomURLPreference.
261 javaScriptDisabledSearchCustomURLPreference.setEnabled(newJavaScriptDisabledSearchString.equals("Custom URL"));
264 case "javascript_disabled_search_custom_url":
265 // Set the new custom search URL as the summary text for "javascript_disabled_search_custom_url". The default is "".
266 javaScriptDisabledSearchCustomURLPreference.setSummary(sharedPreferences.getString("javascript_disabled_search_custom_url", ""));
268 // Update javaScriptDisabledSearchCustomURL. The default is "".
269 MainWebViewActivity.javaScriptDisabledSearchURL = sharedPreferences.getString("javascript_disabled_search_custom_url", "");
272 case "javascript_enabled_search":
273 String newJavaScriptEnabledSearchString = sharedPreferences.getString("javascript_enabled_search", "https://duckduckgo.com/?q=");
274 if (newJavaScriptEnabledSearchString.equals("Custom URL")) {
275 // Set the summary text to R.string.custom_url, which will be translated.
276 javaScriptEnabledSearchPreference.setSummary(R.string.custom_url);
278 // Update the javaScriptEnabledSearchURL variable. The default is "".
279 MainWebViewActivity.javaScriptEnabledSearchURL = sharedPreferences.getString("javascript_enabled_search_custom_url", "");
280 } else { // javascript_enabled_search is not set to Custom.
281 // Set the new search URL as the summary text for the JavaScript-enabled search preference. The default is "https://duckduckgo.com/?q=".
282 javaScriptEnabledSearchPreference.setSummary(newJavaScriptEnabledSearchString);
284 // Update the javaScriptEnabledSearchURL variable. The default is "https://duckduckgo.com/?q=".
285 MainWebViewActivity.javaScriptEnabledSearchURL = newJavaScriptEnabledSearchString;
288 // Enable or disable javaScriptEnabledSearchCustomURLPreference.
289 javaScriptEnabledSearchCustomURLPreference.setEnabled(newJavaScriptEnabledSearchString.equals("Custom URL"));
292 case "javascript_enabled_search_custom_url":
293 // Set the new custom search URL as the summary text for `javascript_enabled_search_custom_url`. The default is ``.
294 javaScriptEnabledSearchCustomURLPreference.setSummary(sharedPreferences.getString("javascript_enabled_search_custom_url", ""));
296 // Update javaScriptEnabledSearchCustomURL. The default is ``.
297 MainWebViewActivity.javaScriptEnabledSearchURL = sharedPreferences.getString("javascript_enabled_search_custom_url", "");
301 // Update `customHeaders`. The default is `true`.
302 if (sharedPreferences.getBoolean("do_not_track", true)) {
303 MainWebViewActivity.customHeaders.put("DNT", "1");
304 } else { // Remove the Do Not Track header.
305 MainWebViewActivity.customHeaders.remove("DNT");
309 // Set the new homepage URL as the summary text for the Homepage preference. The default is `https://www.duckduckgo.com`.
310 homepagePreference.setSummary(sharedPreferences.getString("homepage", "https://www.duckduckgo.com"));
312 // Update the homepage variable. The default is `https://www.duckduckgo.com`.
313 MainWebViewActivity.homepage = sharedPreferences.getString("homepage", "https://www.duckduckgo.com");
316 case "default_font_size":
317 // Get the default font size as a string. The default is `100`.
318 String newDefaultFontSizeString = sharedPreferences.getString("default_font_size", "100");
320 // Update the font size on `mainWebView`. The default is `100`.
321 MainWebViewActivity.mainWebView.getSettings().setTextZoom(Integer.valueOf(newDefaultFontSizeString));
323 // Update the summary text of `default_font_size`.
324 defaultFontSizePreference.setSummary(newDefaultFontSizeString + "%%");
326 case "swipe_to_refresh_enabled":
327 // Set `swipeToRefreshEnabled` to the new state. The default is `true`.
328 MainWebViewActivity.swipeToRefreshEnabled = sharedPreferences.getBoolean("swipe_to_refresh_enabled", true);
330 // Update `swipeRefreshLayout` to match the new state.
331 MainWebViewActivity.swipeToRefresh.setEnabled(MainWebViewActivity.swipeToRefreshEnabled);
335 // If no match, do nothing.
341 // Register the listener.
342 savedPreferences.registerOnSharedPreferenceChangeListener(preferencesListener);
345 // It is necessary to re-register the listener on every resume or it will randomly stop working because apps can be paused and resumed at any time
346 // even while running in the foreground.
348 public void onPause() {
350 savedPreferences.unregisterOnSharedPreferenceChangeListener(preferencesListener);
354 public void onResume() {
356 savedPreferences.registerOnSharedPreferenceChangeListener(preferencesListener);