Add the Guide.
[PrivacyBrowser.git] / app / src / main / java / com / stoutner / privacybrowser / SettingsFragment.java
1 /**
2  * Copyright 2016 Soren Stoutner <soren@stoutner.com>.
3  *
4  * This file is part of Privacy Browser <https://www.stoutner.com/privacy-browser>.
5  *
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.
10  *
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.
15  *
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/>.
18  */
19
20 package com.stoutner.privacybrowser;
21
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;
29
30 public class SettingsFragment extends PreferenceFragment {
31     private SharedPreferences.OnSharedPreferenceChangeListener preferencesListener;
32     private SharedPreferences savedPreferences;
33
34     @Override
35     public void onCreate(Bundle savedInstanceState) {
36         super.onCreate(savedInstanceState);
37         addPreferencesFromResource(R.xml.preferences);
38
39         // Initialize savedPreferences.
40         savedPreferences = getPreferenceScreen().getSharedPreferences();
41
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));
45
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));
49
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());
57                 break;
58
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);
62                 break;
63
64             default:
65                 // Display the user agent from the preference as the summary text.
66                 userAgentPreference.setSummary(savedPreferences.getString("user_agent", "Default user agent"));
67                 break;
68         }
69
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"));
74
75
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);
83         } else {
84             // Set the array value as the summary text.
85             javaScriptDisabledSearchPreference.setSummary(javaScriptDisabledSearchString);
86         }
87
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"));
92
93
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);
101         } else {
102             // Set the array value as the summary text.
103             javaScriptEnabledSearchPreference.setSummary(javaScriptEnabledSearchString);
104         }
105
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"));
110
111
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"));
115
116
117         // Listen for preference changes.
118         preferencesListener = new SharedPreferences.OnSharedPreferenceChangeListener() {
119             @Override
120             // Remove Android Studio's warning about the dangers of using SetJavaScriptEnabled.  We know.
121             @SuppressLint("SetJavaScriptEnabled")
122             public void onSharedPreferenceChanged(SharedPreferences sharedPreferences, String key) {
123
124                 switch (key) {
125                     case "javascript_enabled":
126                         // Set javaScriptEnabled to the new state.  The default is false.
127                         MainWebViewActivity.javaScriptEnabled = sharedPreferences.getBoolean("javascript_enabled", false);
128
129                         // Toggle the state of the "dom_storage_enabled" preference.  The default is false.
130                         final Preference domStorageEnabled = findPreference("dom_storage_enabled");
131                         domStorageEnabled.setEnabled(sharedPreferences.getBoolean("javascript_enabled", false));
132
133                         // Update mainWebView and reload the website.
134                         MainWebViewActivity.mainWebView.getSettings().setJavaScriptEnabled(MainWebViewActivity.javaScriptEnabled);
135                         MainWebViewActivity.mainWebView.reload();
136
137                         // Update the privacy icon.
138                         updatePrivacyIcon();
139                         break;
140
141                     case "first_party_cookies_enabled":
142                         // Set firstPartyCookiesEnabled to the new state.  The default is false.
143                         MainWebViewActivity.firstPartyCookiesEnabled = sharedPreferences.getBoolean("first_party_cookies_enabled", false);
144
145                         // Toggle the state of the "third_party_cookies_enabled" preference.  The default is false.
146                         final Preference thirdPartyCookiesEnabled = findPreference("third_party_cookies_enabled");
147                         thirdPartyCookiesEnabled.setEnabled(sharedPreferences.getBoolean("first_party_cookies_enabled", false));
148
149                         // Update mainWebView and reload the website.
150                         MainWebViewActivity.cookieManager.setAcceptCookie(MainWebViewActivity.firstPartyCookiesEnabled);
151                         MainWebViewActivity.mainWebView.reload();
152
153                         // Update the checkbox in the options menu.
154                         MenuItem firstPartyCookiesMenuItem = MainWebViewActivity.mainMenu.findItem(R.id.toggleFirstPartyCookies);
155                         firstPartyCookiesMenuItem.setChecked(MainWebViewActivity.firstPartyCookiesEnabled);
156
157                         // Update the privacy icon.
158                         updatePrivacyIcon();
159                         break;
160
161                     case "third_party_cookies_enabled":
162                         // Set thirdPartyCookiesEnabled to the new state.  The default is false.
163                         MainWebViewActivity.thirdPartyCookiesEnabled = sharedPreferences.getBoolean("third_party_cookies_enabled", false);
164
165                         // Update the checkbox in the options menu.
166                         MenuItem thirdPartyCookiesMenuItem = MainWebViewActivity.mainMenu.findItem(R.id.toggleThirdPartyCookies);
167                         thirdPartyCookiesMenuItem.setChecked(MainWebViewActivity.thirdPartyCookiesEnabled);
168
169                         // Update mainWebView and reload the website if API >= 21.
170                         if (Build.VERSION.SDK_INT >= 21) {
171                             MainWebViewActivity.cookieManager.setAcceptThirdPartyCookies(MainWebViewActivity.mainWebView, MainWebViewActivity.thirdPartyCookiesEnabled);
172                             MainWebViewActivity.mainWebView.reload();
173                         }
174                         break;
175
176                     case "dom_storage_enabled":
177                         // Set domStorageEnabled to the new state.  The default is false.
178                         MainWebViewActivity.domStorageEnabled = sharedPreferences.getBoolean("dom_storage_enabled", false);
179
180                         // Update the checkbox in the options menu.
181                         MenuItem domStorageMenuItem = MainWebViewActivity.mainMenu.findItem(R.id.toggleDomStorage);
182                         domStorageMenuItem.setChecked(MainWebViewActivity.domStorageEnabled);
183
184                         // Update mainWebView and reload the website.
185                         MainWebViewActivity.mainWebView.getSettings().setDomStorageEnabled(MainWebViewActivity.domStorageEnabled);
186                         MainWebViewActivity.mainWebView.reload();
187
188                         // Update the privacy icon.
189                         updatePrivacyIcon();
190                         break;
191
192                     case "user_agent":
193                         String userAgentString = sharedPreferences.getString("user_agent", "Default user agent");
194
195                         switch (userAgentString) {
196                             case "Default user agent":
197                                 // Set the default user agent on mainWebView, display the user agent as the summary text for userAgentPreference, and disable customUserAgent.
198                                 // Once API >= 17 we can use getDefaultUserAgent().  For now, setUserAgentString("") sets the WebView's default user agent.
199                                 MainWebViewActivity.mainWebView.getSettings().setUserAgentString("");
200                                 userAgentPreference.setSummary(MainWebViewActivity.mainWebView.getSettings().getUserAgentString());
201                                 customUserAgent.setEnabled(false);
202                                 break;
203
204                             case "Custom user agent":
205                                 // Set the custom user agent on mainWebView, display "Custom user agent" as the summary text for userAgentPreference, and enable customUserAgent.
206                                 MainWebViewActivity.mainWebView.getSettings().setUserAgentString(sharedPreferences.getString("custom_user_agent", "PrivacyBrowser/1.0"));
207                                 userAgentPreference.setSummary(R.string.custom_user_agent);
208                                 customUserAgent.setEnabled(true);
209                                 break;
210
211                             default:
212                                 // Set the user agent on mainWebView, display the user agent as the summary text for userAgentPreference, and disable customUserAgent.
213                                 MainWebViewActivity.mainWebView.getSettings().setUserAgentString(sharedPreferences.getString("user_agent", "Default user agent"));
214                                 userAgentPreference.setSummary(MainWebViewActivity.mainWebView.getSettings().getUserAgentString());
215                                 customUserAgent.setEnabled(false);
216                                 break;
217                         }
218                         break;
219
220                     case "custom_user_agent":
221                         // Set the new custom user agent as the summary text for "custom_user_agent".  The default is "PrivacyBrowser/1.0".
222                         customUserAgent.setSummary(sharedPreferences.getString("custom_user_agent", "PrivacyBrowser/1.0"));
223
224                         // Update mainWebView's user agent.  The default is "PrivacyBrowser/1.0".
225                         MainWebViewActivity.mainWebView.getSettings().setUserAgentString(sharedPreferences.getString("user_agent", "PrivacyBrowser/1.0"));
226                         break;
227
228                     case "javascript_disabled_search":
229                         String newJavaScriptDisabledSearchString = sharedPreferences.getString("javascript_disabled_search", "https://duckduckgo.com/html/?q=");
230                         if (newJavaScriptDisabledSearchString.equals("Custom URL")) {
231                             // Set the summary text to R.string.custom_url, which will be translated.
232                             javaScriptDisabledSearchPreference.setSummary(R.string.custom_url);
233
234                             // Update the javaScriptDisabledSearchURL variable.  The default is "".
235                             MainWebViewActivity.javaScriptDisabledSearchURL = sharedPreferences.getString("javascript_disabled_search_custom_url", "");
236                         } else {  // javascript_disabled_search is not set to Custom.
237                             // Set the new search URL as the summary text for the JavaScript-disabled search preference.  The default is "https://duckduckgo.com/html/?q=".
238                             javaScriptDisabledSearchPreference.setSummary(newJavaScriptDisabledSearchString);
239
240                             // Update the javaScriptDisabledSearchURL variable.  The default is "https://duckduckgo.com/html/?q=".
241                             MainWebViewActivity.javaScriptDisabledSearchURL = newJavaScriptDisabledSearchString;
242                         }
243
244                         // Enable or disable javaScriptDisabledSearchCustomURLPreference.
245                         javaScriptDisabledSearchCustomURLPreference.setEnabled(newJavaScriptDisabledSearchString.equals("Custom URL"));
246                         break;
247
248                     case "javascript_disabled_search_custom_url":
249                         // Set the new custom search URL as the summary text for "javascript_disabled_search_custom_url".  The default is "".
250                         javaScriptDisabledSearchCustomURLPreference.setSummary(sharedPreferences.getString("javascript_disabled_search_custom_url", ""));
251
252                         // Update javaScriptDisabledSearchCustomURL.  The default is "".
253                         MainWebViewActivity.javaScriptDisabledSearchURL = sharedPreferences.getString("javascript_disabled_search_custom_url", "");
254                         break;
255
256                     case "javascript_enabled_search":
257                         String newJavaScriptEnabledSearchString = sharedPreferences.getString("javascript_enabled_search", "https://duckduckgo.com/?q=");
258                         if (newJavaScriptEnabledSearchString.equals("Custom URL")) {
259                             // Set the summary text to R.string.custom_url, which will be translated.
260                             javaScriptEnabledSearchPreference.setSummary(R.string.custom_url);
261
262                             // Update the javaScriptEnabledSearchURL variable.  The default is "".
263                             MainWebViewActivity.javaScriptEnabledSearchURL = sharedPreferences.getString("javascript_enabled_search_custom_url", "");
264                         } else { // javascript_enabled_search is not set to Custom.
265                             // Set the new search URL as the summary text for the JavaScript-enabled search preference.  The default is "https://duckduckgo.com/?q=".
266                             javaScriptEnabledSearchPreference.setSummary(newJavaScriptEnabledSearchString);
267
268                             // Update the javaScriptEnabledSearchURL variable.  The default is "https://duckduckgo.com/?q=".
269                             MainWebViewActivity.javaScriptEnabledSearchURL = newJavaScriptEnabledSearchString;
270                         }
271
272                         // Enable or disable javaScriptEnabledSearchCustomURLPreference.
273                         javaScriptEnabledSearchCustomURLPreference.setEnabled(newJavaScriptEnabledSearchString.equals("Custom URL"));
274                         break;
275
276                     case "javascript_enabled_search_custom_url":
277                         // Set the new custom search URL as the summary text for "javascript_enabled_search_custom_url".  The default is "".
278                         javaScriptEnabledSearchCustomURLPreference.setSummary(sharedPreferences.getString("javascript_enabled_search_custom_url", ""));
279
280                         // Update javaScriptEnabledSearchCustomURL.  The default is "".
281                         MainWebViewActivity.javaScriptEnabledSearchURL = sharedPreferences.getString("javascript_enabled_search_custom_url", "");
282                         break;
283
284                     case "homepage":
285                         // Set the new homepage URL as the summary text for the Homepage preference.  The default is "https://www.duckduckgo.com".
286                         homepagePreference.setSummary(sharedPreferences.getString("homepage", "https://www.duckduckgo.com"));
287
288                         // Update the homepage variable.  The default is "https://www.duckduckgo.com".
289                         MainWebViewActivity.homepage = sharedPreferences.getString("homepage", "https://www.duckduckgo.com");
290                         break;
291
292                     case "swipe_to_refresh_enabled":
293                         // Set swipeToRefreshEnabled to the new state.  The default is true.
294                         MainWebViewActivity.swipeToRefreshEnabled = sharedPreferences.getBoolean("swipe_to_refresh_enabled", true);
295
296                         // Update swipeRefreshLayout to match the new state.
297                         MainWebViewActivity.swipeToRefresh.setEnabled(MainWebViewActivity.swipeToRefreshEnabled);
298                         break;
299
300                     default:
301                         // If no match, do nothing.
302                         break;
303                 }
304             }
305         };
306
307         // Register the listener.
308         savedPreferences.registerOnSharedPreferenceChangeListener(preferencesListener);
309     }
310
311     // 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
312     // even while running in the foreground.
313     @Override
314     public void onPause() {
315         super.onPause();
316         savedPreferences.unregisterOnSharedPreferenceChangeListener(preferencesListener);
317     }
318
319     @Override
320     public void onResume() {
321         super.onResume();
322         savedPreferences.registerOnSharedPreferenceChangeListener(preferencesListener);
323     }
324
325     private void updatePrivacyIcon() {
326         // Define a reference to the toggleJavaScript icon.
327         MenuItem toggleJavaScript = MainWebViewActivity.mainMenu.findItem(R.id.toggleJavaScript);
328
329         if (MainWebViewActivity.javaScriptEnabled) {
330             toggleJavaScript.setIcon(R.drawable.javascript_enabled);
331         } else {
332             if (MainWebViewActivity.firstPartyCookiesEnabled) {
333                 toggleJavaScript.setIcon(R.drawable.warning);
334             } else {
335                 toggleJavaScript.setIcon(R.drawable.privacy_mode);
336             }
337         }
338     }
339 }