2 * Copyright 2015-2016 Soren Stoutner <soren@stoutner.com>.
4 * This file is part of 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.annotation.TargetApi;
24 import android.app.Activity;
25 import android.app.DownloadManager;
26 import android.content.ClipData;
27 import android.content.ClipboardManager;
28 import android.content.Context;
29 import android.content.Intent;
30 import android.graphics.Bitmap;
31 import android.net.Uri;
32 import android.os.Build;
33 import android.os.Bundle;
34 import android.support.v4.app.DialogFragment;
35 import android.support.v7.app.ActionBar;
36 import android.support.v7.app.AppCompatActivity;
37 import android.support.v7.app.AppCompatDialogFragment;
38 import android.util.Patterns;
39 import android.view.KeyEvent;
40 import android.view.Menu;
41 import android.view.MenuItem;
42 import android.view.View;
43 import android.view.inputmethod.InputMethodManager;
44 import android.webkit.CookieManager;
45 import android.webkit.DownloadListener;
46 import android.webkit.WebChromeClient;
47 import android.webkit.WebStorage;
48 import android.webkit.WebView;
49 import android.webkit.WebViewClient;
50 import android.widget.EditText;
51 import android.widget.FrameLayout;
52 import android.widget.ImageView;
53 import android.widget.ProgressBar;
54 import android.widget.Toast;
55 import java.io.UnsupportedEncodingException;
56 import java.net.MalformedURLException;
58 import java.net.URLEncoder;
60 public class MainWebView extends AppCompatActivity implements CreateHomeScreenShortcut.CreateHomeScreenSchortcutListener {
61 // favoriteIcon is public static so it can be accessed from CreateHomeScreenShortcut.
62 public static Bitmap favoriteIcon;
63 // mainWebView is public static so it can be accessed from AboutDialog. It is also used in onCreate and onOptionsItemSelected.
64 public static WebView mainWebView;
66 // formattedUrlString is used in onCreate, onOptionsItemSelected, onCreateHomeScreenShortcutCreate, and loadUrlFromTextBox.
67 private String formattedUrlString;
68 // homepage is used in onCreate and onOptionsItemSelected.
69 private String homepage = "https://www.duckduckgo.com/";
70 // enableJavaScript is used in onCreate, onCreateOptionsMenu, and onOptionsItemSelected.
71 private boolean enableJavaScript;
72 // enableDomStorage is used in onCreate, onCreateOptionsMenu, and onOptionsItemSelected.
73 private boolean enableDomStorage;
75 /* enableSaveFormData does nothing until database storage is implemented.
76 // enableSaveFormData is used in onCreate, onCreateOptionsMenu, and onOptionsItemSelected.
77 private boolean enableSaveFormData;
80 // cookieManager is used in onCreate and onOptionsItemSelected.
81 private CookieManager cookieManager;
82 // enableCookies is used in onCreate, onCreateOptionsMenu, and onOptionsItemSelected.
83 private boolean enableCookies;
85 // actionBar is used in onCreate and onOptionsItemSelected.
86 private ActionBar actionBar;
89 // Remove Android Studio's warning about the dangers of using SetJavaScriptEnabled.
90 @SuppressLint("SetJavaScriptEnabled")
91 protected void onCreate(Bundle savedInstanceState) {
92 super.onCreate(savedInstanceState);
93 setContentView(R.layout.activity_webview);
95 final FrameLayout fullScreenVideoFrameLayout = (FrameLayout) findViewById(R.id.fullScreenVideoFrameLayout);
96 final Activity mainWebViewActivity = this;
98 mainWebView = (WebView) findViewById(R.id.mainWebView);
99 actionBar = getSupportActionBar();
101 if (actionBar != null) {
102 // Remove the title from the action bar.
103 actionBar.setDisplayShowTitleEnabled(false);
105 // Add the custom app_bar layout, which shows the favoriteIcon, urlTextBar, and progressBar.
106 actionBar.setCustomView(R.layout.app_bar);
107 actionBar.setDisplayOptions(ActionBar.DISPLAY_SHOW_CUSTOM);
109 // Set the "go" button on the keyboard to load the URL in urlTextBox.
110 EditText urlTextBox = (EditText) actionBar.getCustomView().findViewById(R.id.urlTextBox);
111 urlTextBox.setOnKeyListener(new View.OnKeyListener() {
112 public boolean onKey(View v, int keyCode, KeyEvent event) {
113 // If the event is a key-down event on the "enter" button, load the URL.
114 if ((event.getAction() == KeyEvent.ACTION_DOWN) && (keyCode == KeyEvent.KEYCODE_ENTER)) {
115 // Load the URL into the mainWebView and consume the event.
117 loadUrlFromTextBox();
118 } catch (UnsupportedEncodingException e) {
121 // If the enter key was pressed, consume the event.
124 // If any other key was pressed, do not consume the event.
131 mainWebView.setWebViewClient(new WebViewClient() {
132 // shouldOverrideUrlLoading makes this WebView the default handler for URLs inside the app, so that links are not kicked out to other apps.
134 public boolean shouldOverrideUrlLoading(WebView view, String url) {
135 mainWebView.loadUrl(url);
139 /* These errors do not provide any useful information and clutter the screen.
140 public void onReceivedError(WebView view, WebResourceRequest request, WebResourceError error) {
141 Toast.makeText(mainWebViewActivity, "Error loading " + request + " Error: " + error, Toast.LENGTH_SHORT).show();
145 // Update the URL in urlTextBox when the page starts to load.
147 public void onPageStarted(WebView view, String url, Bitmap favicon) {
148 if (actionBar != null) {
149 EditText urlTextBox = (EditText) actionBar.getCustomView().findViewById(R.id.urlTextBox);
150 urlTextBox.setText(url);
154 // Update formattedUrlString and urlTextBox. It is necessary to do this after the page finishes loading because the final URL can change during load.
156 public void onPageFinished(WebView view, String url) {
157 formattedUrlString = url;
159 if (actionBar != null) {
160 EditText urlTextBox = (EditText) actionBar.getCustomView().findViewById(R.id.urlTextBox);
161 urlTextBox.setText(formattedUrlString);
166 mainWebView.setWebChromeClient(new WebChromeClient() {
167 // Update the progress bar when a page is loading.
169 public void onProgressChanged(WebView view, int progress) {
170 // Make sure that actionBar is not null.
171 if (actionBar != null) {
172 ProgressBar progressBar = (ProgressBar) actionBar.getCustomView().findViewById(R.id.progressBar);
173 progressBar.setProgress(progress);
174 if (progress < 100) {
175 progressBar.setVisibility(View.VISIBLE);
177 progressBar.setVisibility(View.GONE);
182 // Set the favorite icon when it changes.
184 public void onReceivedIcon(WebView view, Bitmap icon) {
185 // Save a copy of the favorite icon for use if a shortcut is added to the home screen.
188 // Place the favorite icon in the actionBar if it is not null.
189 if (actionBar != null) {
190 ImageView imageViewFavoriteIcon = (ImageView) actionBar.getCustomView().findViewById(R.id.favoriteIcon);
191 imageViewFavoriteIcon.setImageBitmap(Bitmap.createScaledBitmap(icon, 64, 64, true));
195 // Enter full screen video
197 public void onShowCustomView(View view, CustomViewCallback callback) {
198 if (getSupportActionBar() != null) {
199 getSupportActionBar().hide();
202 fullScreenVideoFrameLayout.addView(view);
203 fullScreenVideoFrameLayout.setVisibility(View.VISIBLE);
205 mainWebView.setVisibility(View.GONE);
207 /* SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bars on the bottom or right of the screen.
208 ** SYSTEM_UI_FLAG_FULLSCREEN hides the status bar across the top of the screen.
209 ** SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the navigation and status bars ghosted overlays and automatically rehides them.
212 // Set the one flag supported by API >= 14.
213 if (Build.VERSION.SDK_INT >= 14) {
214 view.setSystemUiVisibility(View.SYSTEM_UI_FLAG_HIDE_NAVIGATION);
217 // Set the two flags that are supported by API >= 16.
218 if (Build.VERSION.SDK_INT >= 16) {
219 view.setSystemUiVisibility(View.SYSTEM_UI_FLAG_HIDE_NAVIGATION | View.SYSTEM_UI_FLAG_FULLSCREEN);
222 // Set all three flags that are supported by API >= 19.
223 if (Build.VERSION.SDK_INT >= 19) {
224 view.setSystemUiVisibility(View.SYSTEM_UI_FLAG_HIDE_NAVIGATION | View.SYSTEM_UI_FLAG_FULLSCREEN | View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY);
228 // Exit full screen video
229 public void onHideCustomView() {
230 if (getSupportActionBar() != null) {
231 getSupportActionBar().show();
234 mainWebView.setVisibility(View.VISIBLE);
236 fullScreenVideoFrameLayout.removeAllViews();
237 fullScreenVideoFrameLayout.setVisibility(View.GONE);
241 // Allow the downloading of files.
242 mainWebView.setDownloadListener(new DownloadListener() {
243 // Launch the Android download manager when a link leads to a download.
245 public void onDownloadStart(String url, String userAgent, String contentDisposition, String mimetype, long contentLength) {
246 DownloadManager downloadManager = (DownloadManager) getSystemService(DOWNLOAD_SERVICE);
247 DownloadManager.Request requestUri = new DownloadManager.Request(Uri.parse(url));
249 // Add the URL as the description for the download.
250 requestUri.setDescription(url);
252 // Show the download notification after the download is completed if the API is 11 or greater.
253 if (Build.VERSION.SDK_INT >= 11) {
254 requestUri.setNotificationVisibility(DownloadManager.Request.VISIBILITY_VISIBLE_NOTIFY_COMPLETED);
257 downloadManager.enqueue(requestUri);
258 Toast.makeText(mainWebViewActivity, "Download started", Toast.LENGTH_SHORT).show();
262 // Allow pinch to zoom.
263 mainWebView.getSettings().setBuiltInZoomControls(true);
265 // Hide zoom controls if the API is 11 or greater.
266 if (Build.VERSION.SDK_INT >= 11) {
267 mainWebView.getSettings().setDisplayZoomControls(false);
270 // Set JavaScript initial status.
271 enableJavaScript = false;
272 mainWebView.getSettings().setJavaScriptEnabled(enableJavaScript);
274 // Set DOM Storage initial status.
275 enableDomStorage = false;
276 mainWebView.getSettings().setDomStorageEnabled(enableDomStorage);
278 /* Save Form Data does nothing until database storage is implemented.
279 // Set Save Form Data initial status.
280 enableSaveFormData = true;
281 mainWebView.getSettings().setSaveFormData(enableSaveFormData);
284 // Set Cookies initial status.
285 enableCookies = false;
286 cookieManager = CookieManager.getInstance();
287 cookieManager.setAcceptCookie(enableCookies);
289 // Get the intent information that started the app.
290 final Intent intent = getIntent();
292 if (intent.getData() != null) {
293 // Get the intent data and convert it to a string.
294 final Uri intentUriData = intent.getData();
295 formattedUrlString = intentUriData.toString();
298 // If formattedUrlString is null assign the homepage to it.
299 if (formattedUrlString == null) {
300 formattedUrlString = homepage;
303 // Load the initial website.
304 mainWebView.loadUrl(formattedUrlString);
308 protected void onNewIntent(Intent intent) {
309 // Sets the new intent as the activity intent, so that any future getIntent() picks up this one.
312 if (intent.getData() != null) {
313 // Get the intent data and convert it to a string.
314 final Uri intentUriData = intent.getData();
315 formattedUrlString = intentUriData.toString();
319 mainWebView.loadUrl(formattedUrlString);
323 public boolean onCreateOptionsMenu(Menu menu) {
324 // Inflate the menu; this adds items to the action bar if it is present.
325 getMenuInflater().inflate(R.menu.menu_webview, menu);
327 // Get MenuItems for checkable menu items.
328 MenuItem toggleJavaScript = menu.findItem(R.id.toggleJavaScript);
329 MenuItem toggleDomStorage = menu.findItem(R.id.toggleDomStorage);
330 /* toggleSaveFormData does nothing until database storage is implemented.
331 MenuItem toggleSaveFormData = menu.findItem(R.id.toggleSaveFormData);
333 MenuItem toggleCookies = menu.findItem(R.id.toggleCookies);
335 // Set the initial icon for toggleJavaScript
336 if (enableJavaScript) {
337 toggleJavaScript.setIcon(R.drawable.javascript_on);
339 toggleJavaScript.setIcon(R.drawable.javascript_off);
342 // Set the initial status of the menu item checkboxes.
343 toggleDomStorage.setChecked(enableDomStorage);
344 /* toggleSaveFormData does nothing until database storage is implemented.
345 toggleSaveFormData.setChecked(enableSaveFormData);
347 toggleCookies.setChecked(enableCookies);
353 public boolean onPrepareOptionsMenu(Menu menu) {
354 // Enable Clear Cookies if there are any.
355 MenuItem clearCookies = menu.findItem(R.id.clearCookies);
356 clearCookies.setEnabled(cookieManager.hasCookies());
358 // Enable Back if canGoBack().
359 MenuItem back = menu.findItem(R.id.back);
360 back.setEnabled(mainWebView.canGoBack());
362 // Enable forward if canGoForward().
363 MenuItem forward = menu.findItem(R.id.forward);
364 forward.setEnabled(mainWebView.canGoForward());
366 // Run all the other default commands.
367 super.onPrepareOptionsMenu(menu);
369 // return true displays the menu.
374 // @TargetApi(11) turns off the errors regarding copy and paste, which are removed from view in menu_webview.xml for lower version of Android.
376 // Remove Android Studio's warning about the dangers of using SetJavaScriptEnabled.
377 @SuppressLint("SetJavaScriptEnabled")
378 // removeAllCookies is deprecated, but it is required for API < 21.
379 @SuppressWarnings("deprecation")
380 public boolean onOptionsItemSelected(MenuItem menuItem) {
381 int menuItemId = menuItem.getItemId();
382 ClipboardManager clipboard = (ClipboardManager) getSystemService(Context.CLIPBOARD_SERVICE);
384 // Sets the commands that relate to the menu entries.
385 switch (menuItemId) {
386 case R.id.toggleJavaScript:
387 if (enableJavaScript) {
388 enableJavaScript = false;
389 menuItem.setIcon(R.drawable.javascript_off);
390 mainWebView.getSettings().setJavaScriptEnabled(false);
391 mainWebView.reload();
392 Toast.makeText(getApplicationContext(), "JavaScript Disabled", Toast.LENGTH_SHORT).show();
394 enableJavaScript = true;
395 menuItem.setIcon(R.drawable.javascript_on);
396 mainWebView.getSettings().setJavaScriptEnabled(true);
397 mainWebView.reload();
398 Toast.makeText(getApplicationContext(), "JavaScript Enabled", Toast.LENGTH_SHORT).show();
402 case R.id.toggleDomStorage:
403 if (enableDomStorage) {
404 enableDomStorage = false;
405 menuItem.setChecked(false);
406 mainWebView.getSettings().setDomStorageEnabled(false);
407 mainWebView.reload();
409 enableDomStorage = true;
410 menuItem.setChecked(true);
411 mainWebView.getSettings().setDomStorageEnabled(true);
412 mainWebView.reload();
416 /* toggleSaveFormData does nothing until database storage is implemented.
417 case R.id.toggleSaveFormData:
418 if (enableSaveFormData) {
419 enableSaveFormData = false;
420 menuItem.setChecked(false);
421 mainWebView.getSettings().setSaveFormData(false);
422 mainWebView.reload();
424 enableSaveFormData = true;
425 menuItem.setChecked(true);
426 mainWebView.getSettings().setSaveFormData(true);
427 mainWebView.reload();
432 case R.id.toggleCookies:
434 enableCookies = false;
435 menuItem.setChecked(false);
436 cookieManager.setAcceptCookie(false);
437 mainWebView.reload();
439 enableCookies = true;
440 menuItem.setChecked(true);
441 cookieManager.setAcceptCookie(true);
442 mainWebView.reload();
446 case R.id.clearDomStorage:
447 WebStorage webStorage = WebStorage.getInstance();
448 webStorage.deleteAllData();
449 Toast.makeText(getApplicationContext(), "DOM storage deleted", Toast.LENGTH_SHORT).show();
452 case R.id.clearCookies:
453 if (Build.VERSION.SDK_INT < 21) {
454 cookieManager.removeAllCookie();
456 cookieManager.removeAllCookies(null);
458 Toast.makeText(getApplicationContext(), "Cookies deleted", Toast.LENGTH_SHORT).show();
462 mainWebView.loadUrl(homepage);
466 mainWebView.reload();
470 mainWebView.goBack();
474 mainWebView.goForward();
478 // Make sure that actionBar is not null.
479 if (actionBar != null) {
480 EditText urlTextBox = (EditText) actionBar.getCustomView().findViewById(R.id.urlTextBox);
481 clipboard.setPrimaryClip(ClipData.newPlainText("URL", urlTextBox.getText()));
486 // Make sure that actionBar is not null.
487 if (actionBar != null) {
488 ClipData.Item clipboardData = clipboard.getPrimaryClip().getItemAt(0);
489 EditText urlTextBox = (EditText) actionBar.getCustomView().findViewById(R.id.urlTextBox);
490 urlTextBox.setText(clipboardData.coerceToText(this));
492 loadUrlFromTextBox();
493 } catch (UnsupportedEncodingException e) {
500 // Make sure that actionBar is not null.
501 if (actionBar != null) {
502 EditText urlTextBox = (EditText) actionBar.getCustomView().findViewById(R.id.urlTextBox);
503 Intent shareIntent = new Intent();
504 shareIntent.setAction(Intent.ACTION_SEND);
505 shareIntent.putExtra(Intent.EXTRA_TEXT, urlTextBox.getText().toString());
506 shareIntent.setType("text/plain");
507 startActivity(Intent.createChooser(shareIntent, "Share URL"));
511 case R.id.addToHomescreen:
512 // Show the CreateHomeScreenShortcut AlertDialog and name this instance createShortcut.
513 AppCompatDialogFragment shortcutDialog = new CreateHomeScreenShortcut();
514 shortcutDialog.show(getSupportFragmentManager(), "createShortcut");
516 //Everything else will be handled by CreateHomeScreenShortcut and the associated listeners below.
520 // Launch the system Download Manager.
521 Intent downloadManangerIntent = new Intent(DownloadManager.ACTION_VIEW_DOWNLOADS);
523 // Launch as a new task so that Download Manager and Privacy Browser show as separate windows in the recent tasks list.
524 downloadManangerIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
526 startActivity(downloadManangerIntent);
530 // Show the AboutDialog AlertDialog and name this instance aboutDialog.
531 AppCompatDialogFragment aboutDialog = new AboutDialog();
532 aboutDialog.show(getSupportFragmentManager(), "aboutDialog");
535 case R.id.clearAndExit:
536 // Clear DOM storage.
537 WebStorage domStorage = WebStorage.getInstance();
538 domStorage.deleteAllData();
541 if (Build.VERSION.SDK_INT < 21) {
542 cookieManager.removeAllCookie();
544 cookieManager.removeAllCookies(null);
547 // Destroy the internal state of the webview.
548 mainWebView.destroy();
550 // Close Privacy Browser.
555 return super.onOptionsItemSelected(menuItem);
560 public void onCreateHomeScreenShortcutCancel(DialogFragment dialog) {
561 // Do nothing because the user selected "Cancel".
565 public void onCreateHomeScreenShortcutCreate(DialogFragment dialog) {
566 // Get shortcutNameEditText from the alert dialog.
567 EditText shortcutNameEditText = (EditText) dialog.getDialog().findViewById(R.id.shortcutNameEditText);
569 // Create the bookmark shortcut based on formattedUrlString.
570 Intent bookmarkShortcut = new Intent();
571 bookmarkShortcut.setAction(Intent.ACTION_VIEW);
572 bookmarkShortcut.setData(Uri.parse(formattedUrlString));
574 // Place the bookmark shortcut on the home screen.
575 Intent placeBookmarkShortcut = new Intent();
576 placeBookmarkShortcut.putExtra("android.intent.extra.shortcut.INTENT", bookmarkShortcut);
577 placeBookmarkShortcut.putExtra("android.intent.extra.shortcut.NAME", shortcutNameEditText.getText().toString());
578 placeBookmarkShortcut.putExtra("android.intent.extra.shortcut.ICON", favoriteIcon);
579 placeBookmarkShortcut.setAction("com.android.launcher.action.INSTALL_SHORTCUT");
580 sendBroadcast(placeBookmarkShortcut);
583 // Override onBackPressed so that if mainWebView can go back it does when the system back button is pressed.
585 public void onBackPressed() {
586 final WebView mainWebView = (WebView) findViewById(R.id.mainWebView);
588 if (mainWebView.canGoBack()) {
589 mainWebView.goBack();
591 super.onBackPressed();
595 public void loadUrlFromTextBox() throws UnsupportedEncodingException {
596 // Make sure that actionBar is not null.
597 ActionBar actionBar = getSupportActionBar();
598 if (actionBar != null) {
599 final WebView mainWebView = (WebView) findViewById(R.id.mainWebView);
600 EditText urlTextBox = (EditText) actionBar.getCustomView().findViewById(R.id.urlTextBox);
602 // Get the text from urlTextInput and convert it to a string.
603 String unformattedUrlString = urlTextBox.getText().toString();
604 URL unformattedUrl = null;
605 Uri.Builder formattedUri = new Uri.Builder();
607 // Check to see if unformattedUrlString is a valid URL. Otherwise, convert it into a Duck Duck Go search.
608 if (Patterns.WEB_URL.matcher(unformattedUrlString).matches()) {
610 // Add http:// at the beginning if it is missing. Otherwise the app will segfault.
611 if (!unformattedUrlString.startsWith("http")) {
612 unformattedUrlString = "http://" + unformattedUrlString;
615 // Convert unformattedUrlString to a URL, then to a URI, and then back to a string, which sanitizes the input and adds in any missing components.
617 unformattedUrl = new URL(unformattedUrlString);
618 } catch (MalformedURLException e) {
622 // The ternary operator (? :) makes sure that a null pointer exception is not thrown, which would happen if .get was called on a null value.
623 final String scheme = unformattedUrl != null ? unformattedUrl.getProtocol() : null;
624 final String authority = unformattedUrl != null ? unformattedUrl.getAuthority() : null;
625 final String path = unformattedUrl != null ? unformattedUrl.getPath() : null;
626 final String query = unformattedUrl != null ? unformattedUrl.getQuery() : null;
627 final String fragment = unformattedUrl != null ? unformattedUrl.getRef() : null;
629 formattedUri.scheme(scheme).authority(authority).path(path).query(query).fragment(fragment);
630 formattedUrlString = formattedUri.build().toString();
633 // Sanitize the search input and convert it to a DuckDuckGo search.
634 final String encodedUrlString = URLEncoder.encode(unformattedUrlString, "UTF-8");
635 formattedUrlString = "https://duckduckgo.com/?q=" + encodedUrlString;
638 mainWebView.loadUrl(formattedUrlString);
640 // Hides the keyboard so we can see the webpage.
641 InputMethodManager inputMethodManager = (InputMethodManager) getSystemService(Activity.INPUT_METHOD_SERVICE);
642 inputMethodManager.hideSoftInputFromWindow(mainWebView.getWindowToken(), 0);