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-enabed 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 tgranslated, 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 and reload the website.
139 MainWebViewActivity.mainWebView.getSettings().setJavaScriptEnabled(MainWebViewActivity.javaScriptEnabled);
140 MainWebViewActivity.mainWebView.reload();
142 // Update the privacy icons.
143 MainWebViewActivity.updatePrivacyIcons(MainWebViewActivity.privacyBrowserActivity);
146 case "first_party_cookies_enabled":
147 // Set firstPartyCookiesEnabled to the new state. The default is false.
148 MainWebViewActivity.firstPartyCookiesEnabled = sharedPreferences.getBoolean("first_party_cookies_enabled", false);
150 // Toggle the state of the "third_party_cookies_enabled" preference. The default is false.
151 final Preference thirdPartyCookiesEnabled = findPreference("third_party_cookies_enabled");
152 thirdPartyCookiesEnabled.setEnabled(sharedPreferences.getBoolean("first_party_cookies_enabled", false));
154 // Update mainWebView and reload the website.
155 MainWebViewActivity.cookieManager.setAcceptCookie(MainWebViewActivity.firstPartyCookiesEnabled);
156 MainWebViewActivity.mainWebView.reload();
158 // Update the checkbox in the options menu.
159 MenuItem firstPartyCookiesMenuItem = MainWebViewActivity.mainMenu.findItem(R.id.toggleFirstPartyCookies);
160 firstPartyCookiesMenuItem.setChecked(MainWebViewActivity.firstPartyCookiesEnabled);
162 // Update the privacy icons.
163 MainWebViewActivity.updatePrivacyIcons(MainWebViewActivity.privacyBrowserActivity);
166 case "third_party_cookies_enabled":
167 // Set thirdPartyCookiesEnabled to the new state. The default is false.
168 MainWebViewActivity.thirdPartyCookiesEnabled = sharedPreferences.getBoolean("third_party_cookies_enabled", false);
170 // Update the checkbox in the options menu.
171 MenuItem thirdPartyCookiesMenuItem = MainWebViewActivity.mainMenu.findItem(R.id.toggleThirdPartyCookies);
172 thirdPartyCookiesMenuItem.setChecked(MainWebViewActivity.thirdPartyCookiesEnabled);
174 // Update mainWebView and reload the website if API >= 21.
175 if (Build.VERSION.SDK_INT >= 21) {
176 MainWebViewActivity.cookieManager.setAcceptThirdPartyCookies(MainWebViewActivity.mainWebView, MainWebViewActivity.thirdPartyCookiesEnabled);
177 MainWebViewActivity.mainWebView.reload();
180 // Update the privacy icons.
181 MainWebViewActivity.updatePrivacyIcons(MainWebViewActivity.privacyBrowserActivity);
184 case "dom_storage_enabled":
185 // Set domStorageEnabled to the new state. The default is false.
186 MainWebViewActivity.domStorageEnabled = sharedPreferences.getBoolean("dom_storage_enabled", false);
188 // Update the checkbox in the options menu.
189 MenuItem domStorageMenuItem = MainWebViewActivity.mainMenu.findItem(R.id.toggleDomStorage);
190 domStorageMenuItem.setChecked(MainWebViewActivity.domStorageEnabled);
192 // Update mainWebView and reload the website.
193 MainWebViewActivity.mainWebView.getSettings().setDomStorageEnabled(MainWebViewActivity.domStorageEnabled);
194 MainWebViewActivity.mainWebView.reload();
196 // Update the privacy icons.
197 MainWebViewActivity.updatePrivacyIcons(MainWebViewActivity.privacyBrowserActivity);
200 case "save_form_data_enabled":
201 // Set saveFormDataEnabled to the new state. The default is false.
202 MainWebViewActivity.saveFormDataEnabled = sharedPreferences.getBoolean("save_form_data_enabled", false);
204 // Update the checkbox in the options menu.
205 MenuItem saveFormDataMenuItem = MainWebViewActivity.mainMenu.findItem(R.id.toggleSaveFormData);
206 saveFormDataMenuItem.setChecked(MainWebViewActivity.saveFormDataEnabled);
208 // Update mainWebView and reload the website.
209 MainWebViewActivity.mainWebView.getSettings().setSaveFormData(MainWebViewActivity.saveFormDataEnabled);
210 MainWebViewActivity.mainWebView.reload();
212 // Update the privacy icons.
213 MainWebViewActivity.updatePrivacyIcons(MainWebViewActivity.privacyBrowserActivity);
217 String userAgentString = sharedPreferences.getString("user_agent", "Default user agent");
219 switch (userAgentString) {
220 case "Default user agent":
221 // Set the default user agent on mainWebView, display the user agent as the summary text for userAgentPreference, and disable customUserAgent.
222 // Once API >= 17 we can use getDefaultUserAgent(). For now, setUserAgentString("") sets the WebView's default user agent.
223 MainWebViewActivity.mainWebView.getSettings().setUserAgentString("");
224 userAgentPreference.setSummary(MainWebViewActivity.mainWebView.getSettings().getUserAgentString());
225 customUserAgent.setEnabled(false);
228 case "Custom user agent":
229 // Set the custom user agent on mainWebView, display "Custom user agent" as the summary text for userAgentPreference, and enable customUserAgent.
230 MainWebViewActivity.mainWebView.getSettings().setUserAgentString(sharedPreferences.getString("custom_user_agent", "PrivacyBrowser/1.0"));
231 userAgentPreference.setSummary(R.string.custom_user_agent);
232 customUserAgent.setEnabled(true);
236 // Set the user agent on mainWebView, display the user agent as the summary text for userAgentPreference, and disable customUserAgent.
237 MainWebViewActivity.mainWebView.getSettings().setUserAgentString(sharedPreferences.getString("user_agent", "Default user agent"));
238 userAgentPreference.setSummary(MainWebViewActivity.mainWebView.getSettings().getUserAgentString());
239 customUserAgent.setEnabled(false);
244 case "custom_user_agent":
245 // Set the new custom user agent as the summary text for "custom_user_agent". The default is "PrivacyBrowser/1.0".
246 customUserAgent.setSummary(sharedPreferences.getString("custom_user_agent", "PrivacyBrowser/1.0"));
248 // Update mainWebView's user agent. The default is "PrivacyBrowser/1.0".
249 MainWebViewActivity.mainWebView.getSettings().setUserAgentString(sharedPreferences.getString("custom_user_agent", "PrivacyBrowser/1.0"));
252 case "javascript_disabled_search":
253 String newJavaScriptDisabledSearchString = sharedPreferences.getString("javascript_disabled_search", "https://duckduckgo.com/html/?q=");
254 if (newJavaScriptDisabledSearchString.equals("Custom URL")) {
255 // Set the summary text to R.string.custom_url, which will be translated.
256 javaScriptDisabledSearchPreference.setSummary(R.string.custom_url);
258 // Update the javaScriptDisabledSearchURL variable. The default is "".
259 MainWebViewActivity.javaScriptDisabledSearchURL = sharedPreferences.getString("javascript_disabled_search_custom_url", "");
260 } else { // javascript_disabled_search is not set to Custom.
261 // Set the new search URL as the summary text for the JavaScript-disabled search preference. The default is "https://duckduckgo.com/html/?q=".
262 javaScriptDisabledSearchPreference.setSummary(newJavaScriptDisabledSearchString);
264 // Update the javaScriptDisabledSearchURL variable. The default is "https://duckduckgo.com/html/?q=".
265 MainWebViewActivity.javaScriptDisabledSearchURL = newJavaScriptDisabledSearchString;
268 // Enable or disable javaScriptDisabledSearchCustomURLPreference.
269 javaScriptDisabledSearchCustomURLPreference.setEnabled(newJavaScriptDisabledSearchString.equals("Custom URL"));
272 case "javascript_disabled_search_custom_url":
273 // Set the new custom search URL as the summary text for "javascript_disabled_search_custom_url". The default is "".
274 javaScriptDisabledSearchCustomURLPreference.setSummary(sharedPreferences.getString("javascript_disabled_search_custom_url", ""));
276 // Update javaScriptDisabledSearchCustomURL. The default is "".
277 MainWebViewActivity.javaScriptDisabledSearchURL = sharedPreferences.getString("javascript_disabled_search_custom_url", "");
280 case "javascript_enabled_search":
281 String newJavaScriptEnabledSearchString = sharedPreferences.getString("javascript_enabled_search", "https://duckduckgo.com/?q=");
282 if (newJavaScriptEnabledSearchString.equals("Custom URL")) {
283 // Set the summary text to R.string.custom_url, which will be translated.
284 javaScriptEnabledSearchPreference.setSummary(R.string.custom_url);
286 // Update the javaScriptEnabledSearchURL variable. The default is "".
287 MainWebViewActivity.javaScriptEnabledSearchURL = sharedPreferences.getString("javascript_enabled_search_custom_url", "");
288 } else { // javascript_enabled_search is not set to Custom.
289 // Set the new search URL as the summary text for the JavaScript-enabled search preference. The default is "https://duckduckgo.com/?q=".
290 javaScriptEnabledSearchPreference.setSummary(newJavaScriptEnabledSearchString);
292 // Update the javaScriptEnabledSearchURL variable. The default is "https://duckduckgo.com/?q=".
293 MainWebViewActivity.javaScriptEnabledSearchURL = newJavaScriptEnabledSearchString;
296 // Enable or disable javaScriptEnabledSearchCustomURLPreference.
297 javaScriptEnabledSearchCustomURLPreference.setEnabled(newJavaScriptEnabledSearchString.equals("Custom URL"));
300 case "javascript_enabled_search_custom_url":
301 // Set the new custom search URL as the summary text for "javascript_enabled_search_custom_url". The default is "".
302 javaScriptEnabledSearchCustomURLPreference.setSummary(sharedPreferences.getString("javascript_enabled_search_custom_url", ""));
304 // Update javaScriptEnabledSearchCustomURL. The default is "".
305 MainWebViewActivity.javaScriptEnabledSearchURL = sharedPreferences.getString("javascript_enabled_search_custom_url", "");
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);