From 26ce53c5262abc009c31441130d4a330ba0c267a Mon Sep 17 00:00:00 2001 From: Soren Stoutner Date: Wed, 15 Mar 2017 18:33:38 -0700 Subject: [PATCH] Implement automatic loading of privacy settings. --- .idea/misc.xml | 2 +- app/build.gradle | 2 +- .../activities/MainWebViewActivity.java | 265 ++++++++++++++---- .../helpers/DomainsDatabaseHelper.java | 20 +- app/src/main/res/layout/url_app_bar.xml | 1 + app/src/main/res/values/colors.xml | 8 +- 6 files changed, 232 insertions(+), 66 deletions(-) diff --git a/.idea/misc.xml b/.idea/misc.xml index 1caa1363..95f0f031 100644 --- a/.idea/misc.xml +++ b/.idea/misc.xml @@ -37,7 +37,7 @@ - + diff --git a/app/build.gradle b/app/build.gradle index c1a932f9..795348df 100644 --- a/app/build.gradle +++ b/app/build.gradle @@ -55,7 +55,7 @@ android { dependencies { compile fileTree(include: ['*.jar'], dir: 'libs') - compile 'com.android.support:design:25.2.0' + compile 'com.android.support:design:25.3.0' // Only compile `com.google.firebase:firebase-ads:9.8.0` for the free flavor. freeCompile 'com.google.firebase:firebase-ads:9.8.0' diff --git a/app/src/main/java/com/stoutner/privacybrowser/activities/MainWebViewActivity.java b/app/src/main/java/com/stoutner/privacybrowser/activities/MainWebViewActivity.java index d6462c61..23e000a6 100644 --- a/app/src/main/java/com/stoutner/privacybrowser/activities/MainWebViewActivity.java +++ b/app/src/main/java/com/stoutner/privacybrowser/activities/MainWebViewActivity.java @@ -32,6 +32,7 @@ import android.content.Intent; import android.content.IntentFilter; import android.content.SharedPreferences; import android.content.res.Configuration; +import android.database.Cursor; import android.graphics.Bitmap; import android.graphics.drawable.BitmapDrawable; import android.graphics.drawable.Drawable; @@ -94,6 +95,7 @@ import com.stoutner.privacybrowser.dialogs.CreateHomeScreenShortcutDialog; import com.stoutner.privacybrowser.dialogs.DownloadImageDialog; import com.stoutner.privacybrowser.dialogs.UrlHistoryDialog; import com.stoutner.privacybrowser.dialogs.ViewSslCertificateDialog; +import com.stoutner.privacybrowser.helpers.DomainsDatabaseHelper; import com.stoutner.privacybrowser.helpers.OrbotProxyHelper; import com.stoutner.privacybrowser.dialogs.DownloadFileDialog; import com.stoutner.privacybrowser.dialogs.SslCertificateErrorDialog; @@ -124,7 +126,7 @@ public class MainWebViewActivity extends AppCompatActivity implements Navigation public static Bitmap favoriteIcon; // `formattedUrlString` is public static so it can be accessed from `BookmarksActivity`, `CreateBookmarkDialog`, and `AddDomainDialog`. - // It is also used in `onCreate()`, `onOptionsItemSelected()`, `onCreateHomeScreenShortcutCreate()`, and `loadUrlFromTextBox()`. + // It is also used in `onCreate()`, `onOptionsItemSelected()`, `onNavigationItemSelected()`, `onCreateHomeScreenShortcutCreate()`, and `loadUrlFromTextBox()`. public static String formattedUrlString; // `sslCertificate` is public static so it can be accessed from `ViewSslCertificateDialog`. It is also used in `onCreate()`. @@ -134,6 +136,9 @@ public class MainWebViewActivity extends AppCompatActivity implements Navigation public static String orbotStatus; + // `navigatingHistory` is used in `onCreate()` and `onNavigationItemSelected()`. + private boolean navigatingHistory; + // `drawerLayout` is used in `onCreate()`, `onNewIntent()`, and `onBackPressed()`. private DrawerLayout drawerLayout; @@ -149,10 +154,10 @@ public class MainWebViewActivity extends AppCompatActivity implements Navigation // `swipeRefreshLayout` is used in `onCreate()`, `onPrepareOptionsMenu`, and `onRestart()`. private SwipeRefreshLayout swipeRefreshLayout; - // `cookieManager` is used in `onCreate()`, `onOptionsItemSelected()`, and `onNavigationItemSelected()`, `onDownloadImage()`, `onDownloadFile()`, and `onRestart()`. + // `cookieManager` is used in `onCreate()`, `onOptionsItemSelected()`, and `onNavigationItemSelected()`, `loadUrlFromTextBox()`, `onDownloadImage()`, `onDownloadFile()`, and `onRestart()`. private CookieManager cookieManager; - // `customHeader` is used in `onCreate()`, `onOptionsItemSelected()`, `onCreateContextMenu()`, and `loadUrlFromTextBox()`. + // `customHeader` is used in `onCreate()`, `onOptionsItemSelected()`, `onCreateContextMenu()`, and `loadUrl()`. private final Map customHeaders = new HashMap<>(); // `javaScriptEnabled` is also used in `onCreate()`, `onCreateOptionsMenu()`, `onOptionsItemSelected()`, `loadUrlFromTextBox()`, and `applySettings()`. @@ -222,7 +227,7 @@ public class MainWebViewActivity extends AppCompatActivity implements Navigation // `supportAppBar` is used in `onCreate()`, `onOptionsItemSelected()`, and `closeFindOnPage()`. private Toolbar supportAppBar; - // `urlTextBox` is used in `onCreate()`, `onOptionsItemSelected()`, and `loadUrlFromTextBox()`. + // `urlTextBox` is used in `onCreate()`, `onOptionsItemSelected()`, `loadUrlFromTextBox()`, and `loadUrl()`. private EditText urlTextBox; // `adView` is used in `onCreate()` and `onConfigurationChanged()`. @@ -312,7 +317,7 @@ public class MainWebViewActivity extends AppCompatActivity implements Navigation pendingUrl = ""; // Load `formattedUrlString - mainWebView.loadUrl(formattedUrlString, customHeaders); + loadUrl(formattedUrlString); } } }; @@ -566,7 +571,7 @@ public class MainWebViewActivity extends AppCompatActivity implements Navigation startActivity(emailIntent); return true; } else { // Load the URL in Privacy Browser. - mainWebView.loadUrl(url, customHeaders); + loadUrl(url); return true; } } @@ -580,12 +585,12 @@ public class MainWebViewActivity extends AppCompatActivity implements Navigation Uri requestUri = Uri.parse(url); String requestHost = requestUri.getHost(); - // Create a variable to track if this is an ad server. + // Initialize a variable to track if this is an ad server. boolean requestHostIsAdServer = false; - // Check all the subdomains of `requestHost` if it is not `null`. + // Check all the subdomains of `requestHost` if it is not `null` against the ad server database. if (requestHost != null) { - while (requestHost.contains(".")) { + while (requestHost.contains(".") && !requestHostIsAdServer) { // Stop checking if we run out of `.` or if we already know that `requestHostIsAdServer` is `true`. if (adServersSet.contains(requestHost)) { requestHostIsAdServer = true; } @@ -618,6 +623,11 @@ public class MainWebViewActivity extends AppCompatActivity implements Navigation // Display the loading URL is the URL text box. urlTextBox.setText(url); + + // Apply any custom domain settings if the URL was loaded by navigating history. + if (navigatingHistory) { + applyDomainSettings(url); + } } } @@ -773,12 +783,19 @@ public class MainWebViewActivity extends AppCompatActivity implements Navigation // Initialize AdView for the free flavor. adView = findViewById(R.id.adView); + // Initialize the privacy settings variables. + javaScriptEnabled = false; + firstPartyCookiesEnabled = false; + thirdPartyCookiesEnabled = false; + domStorageEnabled = false; + saveFormDataEnabled = false; + // Apply the settings from the shared preferences. applySettings(); // Load `formattedUrlString` if we are not proxying through Orbot and waiting for Orbot to connect. if (!(proxyThroughOrbot && !orbotStatus.equals("ON"))) { - mainWebView.loadUrl(formattedUrlString, customHeaders); + loadUrl(formattedUrlString); } // If the favorite icon is null, load the default. @@ -808,7 +825,7 @@ public class MainWebViewActivity extends AppCompatActivity implements Navigation } // Load the website. - mainWebView.loadUrl(formattedUrlString, customHeaders); + loadUrl(formattedUrlString); // Clear the keyboard if displayed and remove the focus on the urlTextBar if it has it. mainWebView.requestFocus(); @@ -1191,17 +1208,25 @@ public class MainWebViewActivity extends AppCompatActivity implements Navigation switch (menuItemId) { case R.id.home: - mainWebView.loadUrl(homepage, customHeaders); + loadUrl(homepage); break; case R.id.back: if (mainWebView.canGoBack()) { + // Set `navigatingHistory` so that the domain settings are applied when the new URL is loaded. + navigatingHistory = true; + + // Load the previous website in the history. mainWebView.goBack(); } break; case R.id.forward: if (mainWebView.canGoForward()) { + // Set `navigatingHistory` so that the domain settings are applied when the new URL is loaded. + navigatingHistory = true; + + // Load the next website in the history. mainWebView.goForward(); } break; @@ -1371,7 +1396,7 @@ public class MainWebViewActivity extends AppCompatActivity implements Navigation menu.add(R.string.load_url).setOnMenuItemClickListener(new MenuItem.OnMenuItemClickListener() { @Override public boolean onMenuItemClick(MenuItem item) { - mainWebView.loadUrl(linkUrl, customHeaders); + loadUrl(linkUrl); return false; } }); @@ -1448,7 +1473,7 @@ public class MainWebViewActivity extends AppCompatActivity implements Navigation menu.add(R.string.view_image).setOnMenuItemClickListener(new MenuItem.OnMenuItemClickListener() { @Override public boolean onMenuItemClick(MenuItem item) { - mainWebView.loadUrl(imageUrl, customHeaders); + loadUrl(imageUrl); return false; } }); @@ -1494,7 +1519,7 @@ public class MainWebViewActivity extends AppCompatActivity implements Navigation menu.add(R.string.view_image).setOnMenuItemClickListener(new MenuItem.OnMenuItemClickListener() { @Override public boolean onMenuItemClick(MenuItem item) { - mainWebView.loadUrl(imageUrl, customHeaders); + loadUrl(imageUrl); return false; } }); @@ -1659,6 +1684,9 @@ public class MainWebViewActivity extends AppCompatActivity implements Navigation @Override public void onUrlHistoryEntrySelected(int moveBackOrForwardSteps) { + // Set `navigatingHistory` so that the domain settings are applied when the new URL is loaded. + navigatingHistory = true; + // Load the history entry. mainWebView.goBackOrForward(moveBackOrForwardSteps); } @@ -1772,12 +1800,174 @@ public class MainWebViewActivity extends AppCompatActivity implements Navigation } } - mainWebView.loadUrl(formattedUrlString, customHeaders); + loadUrl(formattedUrlString); // Hide the keyboard so we can see the webpage. `0` indicates no additional flags. inputMethodManager.hideSoftInputFromWindow(mainWebView.getWindowToken(), 0); } + + private void loadUrl(String url) { + // Apply any custom domain settings. + applyDomainSettings(url); + + // Load the URL. + mainWebView.loadUrl(url, customHeaders); + } + + // We have to use the deprecated `.getColor()` until the minimum API >= 23. + @SuppressWarnings("deprecation") + private void applyDomainSettings(String url) { + // Parse the URL into a URI. + Uri uri = Uri.parse(url); + + // Extract the domain from `uri`. + String hostname = uri.getHost(); + + // Initialize the database handler. `this` specifies the context. The two `nulls` do not specify the database name or a `CursorFactory`. + // The `0` specifies the database version, but that is ignored and set instead using a constant in `DomainsDatabaseHelper`. + DomainsDatabaseHelper domainsDatabaseHelper = new DomainsDatabaseHelper(this, null, null, 0); + + // Get a full cursor from `domainsDatabaseHelper`. + Cursor domainNameCursor = domainsDatabaseHelper.getDomainNameCursorOrderedByDomain(); + + // Initialize `domainSettingsSet`. + Set domainSettingsSet = new HashSet<>(); + + // Get the domain name column index. + int domainNameColumnIndex = domainNameCursor.getColumnIndex(DomainsDatabaseHelper.DOMAIN_NAME); + + // Populate `domainSettingsSet`. + for (int i=0; i= 21. + if (Build.VERSION.SDK_INT >= 21) { + cookieManager.setAcceptThirdPartyCookies(mainWebView, thirdPartyCookiesEnabled); + } + + // Set the user agent. + if (userAgentString.equals("WebView default user agent")) { + // Set the user agent to `""`, which uses the default value. + mainWebView.getSettings().setUserAgentString(""); + } else { + // Use the selected user agent. + mainWebView.getSettings().setUserAgentString(userAgentString); + } + + // Set a green background on `urlTextBox` to indicate that custom domain settings are being used. We have to use the deprecated `.getColor()` until the minimum API >= 23. + urlAppBarFrameLayout.setBackgroundColor(getResources().getColor(R.color.green_100)); + } else { // The URL we are loading does not have custom domain settings. Load the defaults. + // Get the shared preference values. `this` references the current context. + SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this); + + // Store the values from `sharedPreferences` in variables. + javaScriptEnabled = sharedPreferences.getBoolean("javascript_enabled", false); + firstPartyCookiesEnabled = sharedPreferences.getBoolean("first_party_cookies_enabled", false); + thirdPartyCookiesEnabled = sharedPreferences.getBoolean("third_party_cookies_enabled", false); + domStorageEnabled = sharedPreferences.getBoolean("dom_storage_enabled", false); + saveFormDataEnabled = sharedPreferences.getBoolean("save_form_data_enabled", false); + String userAgentString = sharedPreferences.getString("user_agent", "PrivacyBrowser/1.0"); + String customUserAgentString = sharedPreferences.getString("custom_user_agent", "PrivacyBrowser/1.0"); + String defaultFontSizeString = sharedPreferences.getString("default_font_size", "100"); + + // Apply the default settings. + mainWebView.getSettings().setJavaScriptEnabled(javaScriptEnabled); + cookieManager.setAcceptCookie(firstPartyCookiesEnabled); + mainWebView.getSettings().setDomStorageEnabled(domStorageEnabled); + mainWebView.getSettings().setSaveFormData(saveFormDataEnabled); + mainWebView.getSettings().setTextZoom(Integer.valueOf(defaultFontSizeString)); + + // Set third-party cookies status if API >= 21. + if (Build.VERSION.SDK_INT >= 21) { + cookieManager.setAcceptThirdPartyCookies(mainWebView, thirdPartyCookiesEnabled); + } + + // Set the default user agent. + switch (userAgentString) { + case "WebView default user agent": + // Set the user agent to `""`, which uses the default value. + mainWebView.getSettings().setUserAgentString(""); + break; + + case "Custom user agent": + // Set the custom user agent. + mainWebView.getSettings().setUserAgentString(customUserAgentString); + break; + + default: + // Use the selected user agent. + mainWebView.getSettings().setUserAgentString(userAgentString); + break; + } + + // Set a transparent background on `urlTextBox`. We have to use the deprecated `.getColor()` until the minimum API >= 23. + urlAppBarFrameLayout.setBackgroundColor(getResources().getColor(R.color.transparent)); + } + + // Close `domainsDatabaseHelper`. + domainsDatabaseHelper.close(); + + // Update the privacy icons, but only if `mainMenu` has already been populated. + if (mainMenu != null) { + updatePrivacyIcons(true); + } + } + public void findPreviousOnPage(View view) { // Go to the previous highlighted phrase on the page. `false` goes backwards instead of forwards. mainWebView.findNext(false); @@ -1810,8 +2000,6 @@ public class MainWebViewActivity extends AppCompatActivity implements Navigation SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this); // Store the values from `sharedPreferences` in variables. - String userAgentString = sharedPreferences.getString("user_agent", "PrivacyBrowser/1.0"); - String customUserAgentString = sharedPreferences.getString("custom_user_agent", "PrivacyBrowser/1.0"); String javaScriptDisabledSearchString = sharedPreferences.getString("javascript_disabled_search", "https://duckduckgo.com/html/?q="); String javaScriptDisabledSearchCustomURLString = sharedPreferences.getString("javascript_disabled_search_custom_url", ""); String javaScriptEnabledSearchString = sharedPreferences.getString("javascript_enabled_search", "https://duckduckgo.com/?q="); @@ -1822,7 +2010,6 @@ public class MainWebViewActivity extends AppCompatActivity implements Navigation String torJavaScriptDisabledSearchCustomURLString = sharedPreferences.getString("tor_javascript_disabled_search_custom_url", ""); String torJavaScriptEnabledSearchString = sharedPreferences.getString("tor_javascript_enabled_search", "https://3g2upl4pq6kufc4m.onion/?q="); String torJavaScriptEnabledSearchCustomURLString = sharedPreferences.getString("tor_javascript_enabled_search_custom_url", ""); - String defaultFontSizeString = sharedPreferences.getString("default_font_size", "100"); swipeToRefreshEnabled = sharedPreferences.getBoolean("swipe_to_refresh_enabled", false); adBlockerEnabled = sharedPreferences.getBoolean("block_ads", true); boolean doNotTrackEnabled = sharedPreferences.getBoolean("do_not_track", false); @@ -1831,28 +2018,6 @@ public class MainWebViewActivity extends AppCompatActivity implements Navigation hideSystemBarsOnFullscreen = sharedPreferences.getBoolean("hide_system_bars", false); translucentNavigationBarOnFullscreen = sharedPreferences.getBoolean("translucent_navigation_bar", true); - // Because they can be modified on-the-fly by the user, these default settings are only applied when the program first runs. - if (javaScriptEnabled == null) { // If `javaScriptEnabled` is null the program is just starting. - // Get the values from `sharedPreferences`. - javaScriptEnabled = sharedPreferences.getBoolean("javascript_enabled", false); - firstPartyCookiesEnabled = sharedPreferences.getBoolean("first_party_cookies_enabled", false); - thirdPartyCookiesEnabled = sharedPreferences.getBoolean("third_party_cookies_enabled", false); - domStorageEnabled = sharedPreferences.getBoolean("dom_storage_enabled", false); - saveFormDataEnabled = sharedPreferences.getBoolean("save_form_data_enabled", false); - - // Apply the default settings. - mainWebView.getSettings().setJavaScriptEnabled(javaScriptEnabled); - cookieManager.setAcceptCookie(firstPartyCookiesEnabled); - mainWebView.getSettings().setDomStorageEnabled(domStorageEnabled); - mainWebView.getSettings().setSaveFormData(saveFormDataEnabled); - mainWebView.getSettings().setTextZoom(Integer.valueOf(defaultFontSizeString)); - - // Set third-party cookies status if API >= 21. - if (Build.VERSION.SDK_INT >= 21) { - cookieManager.setAcceptThirdPartyCookies(mainWebView, thirdPartyCookiesEnabled); - } - } - // Set the homepage, search, and proxy options. if (proxyThroughOrbot) { // Set the Tor options. // Set `torHomepageString` as `homepage`. @@ -1924,24 +2089,6 @@ public class MainWebViewActivity extends AppCompatActivity implements Navigation // Set swipe to refresh. swipeRefreshLayout.setEnabled(swipeToRefreshEnabled); - // Set the user agent initial status. - switch (userAgentString) { - case "WebView default user agent": - // Set the user agent to `""`, which uses the default value. - mainWebView.getSettings().setUserAgentString(""); - break; - - case "Custom user agent": - // Set the custom user agent. - mainWebView.getSettings().setUserAgentString(customUserAgentString); - break; - - default: - // Use the selected user agent. - mainWebView.getSettings().setUserAgentString(userAgentString); - break; - } - // Set Do Not Track status. if (doNotTrackEnabled) { customHeaders.put("DNT", "1"); diff --git a/app/src/main/java/com/stoutner/privacybrowser/helpers/DomainsDatabaseHelper.java b/app/src/main/java/com/stoutner/privacybrowser/helpers/DomainsDatabaseHelper.java index 130b0f6c..24ceaba5 100644 --- a/app/src/main/java/com/stoutner/privacybrowser/helpers/DomainsDatabaseHelper.java +++ b/app/src/main/java/com/stoutner/privacybrowser/helpers/DomainsDatabaseHelper.java @@ -91,7 +91,7 @@ public class DomainsDatabaseHelper extends SQLiteOpenHelper { " WHERE " + _ID + " IS NOT " + databaseId + " ORDER BY " + DOMAIN_NAME + " ASC"; - // Return the results as a `Cursor`. The second argument is `null` because there are no `selectionArgs`. We can't close the `Cursor` because we need to use it in the parent activity. + // Return the results as a `Cursor`. The second argument is `null` because there are no `selectionArgs`. We can't close the `Cursor` because we need to use it in the calling activity. return domainsDatabase.rawQuery(GET_CURSOR_ORDERED_BY_DOMAIN_EXCEPT, null); } @@ -99,14 +99,26 @@ public class DomainsDatabaseHelper extends SQLiteOpenHelper { // Get a readable database handle. SQLiteDatabase domainsDatabase = this.getReadableDatabase(); - // Prepare the SQL statement to ge the `Cursor` for `databaseId`. - final String GET_CURSOR_FOR_ID = "Select * FROM " + DOMAINS_TABLE + + // Prepare the SQL statement to get the `Cursor` for `databaseId`. + final String GET_CURSOR_FOR_ID = "SELECT * FROM " + DOMAINS_TABLE + " WHERE " + _ID + " = " + databaseId; - // Return the results as a `Cursor`. The second argument is `null` because there are no `selectionArgs`. We can't close the `Cursor` because we need to use it in the parent activity. + // Return the results as a `Cursor`. The second argument is `null` because there are no `selectionArgs`. We can't close the `Cursor` because we need to use it in the calling activity. return domainsDatabase.rawQuery(GET_CURSOR_FOR_ID, null); } + public Cursor getCursorForDomainName(String domainName) { + // Get a readable database handle. + SQLiteDatabase domainsDatabase = this.getReadableDatabase(); + + // Prepare the SQL statement to get the `Cursor` for `domainName`. + final String GET_CURSOR_FOR_DOMAIN_NAME = "SELECT * FROM " + DOMAINS_TABLE + + " WHERE " + DOMAIN_NAME + " = " + "\"" + domainName + "\""; + + // Return the results as a `Cursor`. The second argument is `null` because there are no `selectionArgs`. We can't close the `Cursor` because we need to us it in the calling activity. + return domainsDatabase.rawQuery(GET_CURSOR_FOR_DOMAIN_NAME, null); + } + public void addDomain(String domainName) { // Store the domain data in a `ContentValues`. ContentValues domainContentValues = new ContentValues(); diff --git a/app/src/main/res/layout/url_app_bar.xml b/app/src/main/res/layout/url_app_bar.xml index 506e9c12..34d6339f 100644 --- a/app/src/main/res/layout/url_app_bar.xml +++ b/app/src/main/res/layout/url_app_bar.xml @@ -20,6 +20,7 @@ = 22 we can remove the hardcoded colors and reference these entries. --> - #66000000 + #66000000 #FF000000 @@ -41,10 +41,16 @@ #FFF5F5F5 #FF9E9E9E + #FFE8F5E9 + #FFC8E6C9 + + #FFDCEDC8 #FF64DD17 #FFD50000 + #00000000 + #FFFFFFFF #FFF57F17 -- 2.43.0