From b72fd06c1e378ca01c1cccd83ed0c7ae5297b8f4 Mon Sep 17 00:00:00 2001
From: Soren Stoutner <soren@stoutner.com>
Date: Wed, 16 Dec 2015 22:36:17 -0700
Subject: [PATCH] Create an "Add to Home Screen" AlertDialog.

---
 .idea/dictionaries/soren.xml                  |   1 +
 app/src/main/AndroidManifest.xml              |   6 +-
 .../CreateHomeScreenShortcut.java             | 104 ++++++++++++++++++
 .../com/stoutner/privacybrowser/Webview.java  |  60 ++++++++--
 app/src/main/res/layout/app_bar.xml           |   7 +-
 .../create_home_screen_shortcut_dialog.xml    |  22 ++++
 app/src/main/res/menu/menu_webview.xml        |  14 ++-
 app/src/main/res/values/strings.xml           |  12 +-
 8 files changed, 203 insertions(+), 23 deletions(-)
 create mode 100644 app/src/main/java/com/stoutner/privacybrowser/CreateHomeScreenShortcut.java
 create mode 100644 app/src/main/res/layout/create_home_screen_shortcut_dialog.xml

diff --git a/.idea/dictionaries/soren.xml b/.idea/dictionaries/soren.xml
index a29dfbc4..1f8fe134 100644
--- a/.idea/dictionaries/soren.xml
+++ b/.idea/dictionaries/soren.xml
@@ -4,6 +4,7 @@
       <w>duckduckgo</w>
       <w>rehide</w>
       <w>rehides</w>
+      <w>schortcut</w>
       <w>webview</w>
     </words>
   </dictionary>
diff --git a/app/src/main/AndroidManifest.xml b/app/src/main/AndroidManifest.xml
index 1f1aed55..85d0b273 100644
--- a/app/src/main/AndroidManifest.xml
+++ b/app/src/main/AndroidManifest.xml
@@ -4,6 +4,9 @@
 
     <uses-permission android:name="android.permission.INTERNET" />
 
+    <!-- Required to create homescreen shortcuts. -->
+    <uses-permission android:name="com.android.launcher.permission.INSTALL_SHORTCUT" />
+
     <application
         android:allowBackup="false"
         android:fullBackupContent="false"
@@ -16,8 +19,7 @@
         <activity
             android:name=".Webview"
             android:configChanges="orientation|screenSize"
-            android:label="@string/privacy_browser"
-            android:windowSoftInputMode="stateAlwaysHidden">
+            android:label="@string/privacy_browser" >
             <intent-filter>
                 <action android:name="android.intent.action.MAIN" />
                 <category android:name="android.intent.category.LAUNCHER" />
diff --git a/app/src/main/java/com/stoutner/privacybrowser/CreateHomeScreenShortcut.java b/app/src/main/java/com/stoutner/privacybrowser/CreateHomeScreenShortcut.java
new file mode 100644
index 00000000..2349fcdd
--- /dev/null
+++ b/app/src/main/java/com/stoutner/privacybrowser/CreateHomeScreenShortcut.java
@@ -0,0 +1,104 @@
+/**
+ * Copyright Soren Stoutner 2015.
+ */
+
+package com.stoutner.privacybrowser;
+
+import android.app.Activity;
+import android.app.Dialog;
+import android.content.DialogInterface;
+import android.graphics.drawable.BitmapDrawable;
+import android.graphics.drawable.Drawable;
+import android.os.Bundle;
+import android.support.annotation.NonNull;
+import android.support.v4.app.DialogFragment;
+import android.support.v7.app.AlertDialog;
+import android.support.v7.app.AppCompatDialogFragment;
+import android.view.KeyEvent;
+import android.view.LayoutInflater;
+import android.view.View;
+import android.view.WindowManager;
+import android.widget.EditText;
+
+public class CreateHomeScreenShortcut extends AppCompatDialogFragment {
+    // The public interface is used to send information back to the activity that called CreateHomeScreenShortcut.
+    public interface CreateHomeScreenSchortcutListener {
+        void onCreateHomeScreenShortcutCancel(DialogFragment dialog);
+
+        void onCreateHomeScreenShortcutCreate(DialogFragment dialog);
+    }
+
+    CreateHomeScreenSchortcutListener buttonListener;
+
+    // Check to make sure that the activity that called CreateHomeScreenShortcut implements both listeners.
+    public void onAttach(Activity activity) {
+        super.onAttach(activity);
+        try {
+            buttonListener = (CreateHomeScreenSchortcutListener) activity;
+        } catch (ClassCastException e) {
+            throw new ClassCastException(activity.toString() + " must implement CreateHomeScreenShortcutListener.");
+        }
+    }
+
+    // onCreateDialog requires @NonNull.
+    @Override
+    @NonNull
+    public Dialog onCreateDialog(Bundle savedInstanceState) {
+        AlertDialog.Builder alertDialogBuilder = new AlertDialog.Builder(getActivity());
+        LayoutInflater customDialogInflater = getActivity().getLayoutInflater();
+
+        // Create a drawable version of the favorite icon.
+        Drawable favoriteIconDrawable = new BitmapDrawable(getResources(), Webview.favoriteIcon);
+
+        // Setup dialogBuilder.
+        alertDialogBuilder.setTitle(R.string.shortcut_name);
+        alertDialogBuilder.setIcon(favoriteIconDrawable);
+        alertDialogBuilder.setView(customDialogInflater.inflate(R.layout.create_home_screen_shortcut_dialog, null));
+        alertDialogBuilder.setNegativeButton(R.string.cancel, new DialogInterface.OnClickListener() {
+            @Override
+            public void onClick(DialogInterface dialog, int which) {
+                buttonListener.onCreateHomeScreenShortcutCancel(CreateHomeScreenShortcut.this);
+            }
+        });
+        alertDialogBuilder.setPositiveButton(R.string.create, new DialogInterface.OnClickListener() {
+            @Override
+            public void onClick(DialogInterface dialog, int which) {
+                buttonListener.onCreateHomeScreenShortcutCreate(CreateHomeScreenShortcut.this);
+            }
+        });
+
+        // Assign the resulting built dialog to an AlertDialog.
+        final AlertDialog alertDialog = alertDialogBuilder.create();
+
+        // Show the keyboard when the dialog is displayed on the screen.
+        alertDialog.getWindow().setSoftInputMode(WindowManager.LayoutParams.SOFT_INPUT_STATE_ALWAYS_VISIBLE);
+
+        // We need to show alertDialog before we can setOnKeyListener below.
+        alertDialog.show();
+
+        EditText shortcutNameEditText = (EditText) alertDialog.findViewById(R.id.shortcutNameEditText);
+
+        // Allow the "enter" key on the keyboard to create the shortcut.
+        shortcutNameEditText.setOnKeyListener(new View.OnKeyListener() {
+            public boolean onKey(View v, int keyCode, KeyEvent event) {
+                // If the event is a key-down event on the "enter" button, select the PositiveButton "Create".
+                if ((event.getAction() == KeyEvent.ACTION_DOWN) && (keyCode == KeyEvent.KEYCODE_ENTER)) {
+                    // Trigger the create listener.
+                    buttonListener.onCreateHomeScreenShortcutCreate(CreateHomeScreenShortcut.this);
+
+                    // Manually dismiss alertDialog.
+                    alertDialog.dismiss();
+
+                    // Consume the event.
+                    return true;
+                } else {
+                    // If any other key was pressed, do not consume the event.
+                    return false;
+                }
+            }
+        });
+
+        // onCreateDialog requires the return of an AlertDialog.
+        return alertDialog;
+    }
+}
\ No newline at end of file
diff --git a/app/src/main/java/com/stoutner/privacybrowser/Webview.java b/app/src/main/java/com/stoutner/privacybrowser/Webview.java
index 5f1e8723..9c51b446 100644
--- a/app/src/main/java/com/stoutner/privacybrowser/Webview.java
+++ b/app/src/main/java/com/stoutner/privacybrowser/Webview.java
@@ -12,8 +12,10 @@ import android.graphics.Bitmap;
 import android.net.Uri;
 import android.os.Build;
 import android.os.Bundle;
+import android.support.v4.app.DialogFragment;
 import android.support.v7.app.ActionBar;
 import android.support.v7.app.AppCompatActivity;
+import android.support.v7.app.AppCompatDialogFragment;
 import android.util.Patterns;
 import android.view.KeyEvent;
 import android.view.Menu;
@@ -30,14 +32,15 @@ import android.widget.EditText;
 import android.widget.FrameLayout;
 import android.widget.ImageView;
 import android.widget.ProgressBar;
-import android.widget.RelativeLayout;
 import android.widget.Toast;
 import java.io.UnsupportedEncodingException;
 import java.net.MalformedURLException;
 import java.net.URL;
 import java.net.URLEncoder;
 
-public class Webview extends AppCompatActivity {
+public class Webview extends AppCompatActivity implements CreateHomeScreenShortcut.CreateHomeScreenSchortcutListener {
+    // favoriteIcon is public static so it can be accessed from CreateHomeScreenShortcut.
+    public static Bitmap favoriteIcon;
 
     private String formattedUrlString;
     private String homepage = "https://www.duckduckgo.com/";
@@ -52,7 +55,6 @@ public class Webview extends AppCompatActivity {
 
         final WebView mainWebView = (WebView) findViewById(R.id.mainWebView);
         final FrameLayout fullScreenVideoFrameLayout = (FrameLayout) findViewById(R.id.fullScreenVideoFrameLayout);
-        final RelativeLayout rootRelativeLayout = (RelativeLayout) findViewById(R.id.rootRelativeLayout);
         final Activity mainWebViewActivity = this;
 
         final ActionBar actionBar = getSupportActionBar();
@@ -69,8 +71,7 @@ public class Webview extends AppCompatActivity {
             urlTextBox.setOnKeyListener(new View.OnKeyListener() {
                 public boolean onKey(View v, int keyCode, KeyEvent event) {
                     // If the event is a key-down event on the "enter" button, load the URL.
-                    if ((event.getAction() == KeyEvent.ACTION_DOWN) &&
-                            (keyCode == KeyEvent.KEYCODE_ENTER)) {
+                    if ((event.getAction() == KeyEvent.ACTION_DOWN) && (keyCode == KeyEvent.KEYCODE_ENTER)) {
                         // Load the URL into the mainWebView and consume the event.
                         try {
                             loadUrlFromTextBox();
@@ -79,9 +80,10 @@ public class Webview extends AppCompatActivity {
                         }
                         // If the enter key was pressed, consume the event.
                         return true;
+                    } else {
+                        // If any other key was pressed, do not consume the event.
+                        return false;
                     }
-                    // If any other key was pressed, do not consume the event.
-                    return false;
                 }
             });
         }
@@ -138,10 +140,13 @@ public class Webview extends AppCompatActivity {
             // Set the favorite icon when it changes.
             @Override
             public void onReceivedIcon(WebView view, Bitmap icon) {
-                // Make sure that actionBar is not null.
+                // Save a copy of the favorite icon for use if a shortcut is added to the home screen.
+                favoriteIcon = icon;
+
+                // Place the favorite icon in the actionBar if it is not null.
                 if (actionBar != null) {
-                    ImageView favoriteIcon = (ImageView) actionBar.getCustomView().findViewById(R.id.favoriteIcon);
-                    favoriteIcon.setImageBitmap(Bitmap.createScaledBitmap(icon, 64, 64, true));
+                    ImageView imageViewFavoriteIcon = (ImageView) actionBar.getCustomView().findViewById(R.id.favoriteIcon);
+                    imageViewFavoriteIcon.setImageBitmap(Bitmap.createScaledBitmap(icon, 64, 64, true));
                 }
             }
 
@@ -307,6 +312,14 @@ public class Webview extends AppCompatActivity {
                 }
                 break;
 
+            case R.id.addToHomescreen:
+                // Show the CreateHomeScreenShortcut AlertDialog and name this instance createShortcut.
+                AppCompatDialogFragment shortcutDialog = new CreateHomeScreenShortcut();
+                shortcutDialog.show(getSupportFragmentManager(), "createShortcut");
+
+                //Everything else will be handled by CreateHomeScreenShortcut and the associated listeners below.
+                break;
+
             case R.id.downloads:
                 // Launch the system Download Manager.
                 Intent downloadManangerIntent = new Intent(DownloadManager.ACTION_VIEW_DOWNLOADS);
@@ -315,11 +328,36 @@ public class Webview extends AppCompatActivity {
                 downloadManangerIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
 
                 startActivity(downloadManangerIntent);
+                break;
         }
 
         return super.onOptionsItemSelected(menuItem);
     }
 
+    @Override
+    public void onCreateHomeScreenShortcutCancel(DialogFragment dialog) {
+        // Do nothing because the user selected "Cancel".
+    }
+
+    @Override
+    public void onCreateHomeScreenShortcutCreate(DialogFragment dialog) {
+        // Get shortcutNameEditText from the alert dialog.
+        EditText shortcutNameEditText = (EditText) dialog.getDialog().findViewById(R.id.shortcutNameEditText);
+
+        // Create the bookmark shortcut based on formattedUrlString.
+        Intent bookmarkShortcut = new Intent();
+        bookmarkShortcut.setAction(Intent.ACTION_VIEW);
+        bookmarkShortcut.setData(Uri.parse(formattedUrlString));
+
+        // Place the bookmark shortcut on the home screen.
+        Intent placeBookmarkShortcut = new Intent();
+        placeBookmarkShortcut.putExtra("android.intent.extra.shortcut.INTENT", bookmarkShortcut);
+        placeBookmarkShortcut.putExtra("android.intent.extra.shortcut.NAME", shortcutNameEditText.getText().toString());
+        placeBookmarkShortcut.putExtra("android.intent.extra.shortcut.ICON", favoriteIcon);
+        placeBookmarkShortcut.setAction("com.android.launcher.action.INSTALL_SHORTCUT");
+        sendBroadcast(placeBookmarkShortcut);
+    }
+
     // Override onBackPressed so that if mainWebView can go back it does when the system back button is pressed.
     @Override
     public void onBackPressed() {
@@ -382,4 +420,4 @@ public class Webview extends AppCompatActivity {
             inputMethodManager.hideSoftInputFromWindow(mainWebView.getWindowToken(), 0);
         }
     }
-}
+}
\ No newline at end of file
diff --git a/app/src/main/res/layout/app_bar.xml b/app/src/main/res/layout/app_bar.xml
index a66e99f4..0efa7a90 100644
--- a/app/src/main/res/layout/app_bar.xml
+++ b/app/src/main/res/layout/app_bar.xml
@@ -22,15 +22,16 @@
             android:layout_gravity="center"
             android:contentDescription="@string/favorite_icon"/>
 
-        <!-- android:inputType="textUri" sets the keyboard to have a go arrow. -->
+        <!-- android:imeOptions="actionGo" sets the keyboard to have a "go" key instead of a "new line" key. -->
+        <!-- android:inputType="textUri" disables spell check in the EditText and changes the "go" key from a check mark to an arrow. -->
         <!-- android:layout_weight="1" makes urlTextBox take up all the remaining space. -->
         <EditText
             android:id="@+id/urlTextBox"
             android:layout_width="0dp"
             android:layout_weight="1"
             android:layout_height="wrap_content"
-            android:inputType="textUri"
-            android:imeOptions="actionGo" />
+            android:imeOptions="actionGo"
+            android:inputType="textUri" />
     </LinearLayout>
 
     <!-- android:max changes the maximum ProgressBar value from 10000 to 100 to match progress percentage. -->
diff --git a/app/src/main/res/layout/create_home_screen_shortcut_dialog.xml b/app/src/main/res/layout/create_home_screen_shortcut_dialog.xml
new file mode 100644
index 00000000..e16936cf
--- /dev/null
+++ b/app/src/main/res/layout/create_home_screen_shortcut_dialog.xml
@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="utf-8"?>
+<RelativeLayout
+    android:id="@+id/createHomeScreenShortcutDialogRelativeLayout"
+    xmlns:android="http://schemas.android.com/apk/res/android"
+    android:layout_width="match_parent"
+    android:layout_height="wrap_content" >
+
+    <!-- android:imeOptions="actionGo" sets the keyboard to have a "go" key instead of a "new line" key. -->
+    <!-- android:inputType="textUri" disables spell check in the EditText and changes the "go" key from a check mark to an arrow. -->
+    <!-- android:imeOptions="actionGo" sets the keyboard to have a "go" key instead of a "new line" key. -->
+    <EditText
+        android:id="@+id/shortcutNameEditText"
+        android:layout_width="match_parent"
+        android:layout_height="wrap_content"
+        android:layout_marginTop="16dp"
+        android:layout_marginLeft="4dp"
+        android:layout_marginRight="4dp"
+        android:layout_marginBottom="16dp"
+        android:imeOptions="actionGo"
+        android:inputType="textUri" />
+
+</RelativeLayout>
\ No newline at end of file
diff --git a/app/src/main/res/menu/menu_webview.xml b/app/src/main/res/menu/menu_webview.xml
index a1cf47d9..bc21d686 100644
--- a/app/src/main/res/menu/menu_webview.xml
+++ b/app/src/main/res/menu/menu_webview.xml
@@ -34,7 +34,7 @@
     <!-- tools:targetApi="11" is required because copy and paste was not available on earlier version of Android. -->
     <item
         android:id="@+id/copyURL"
-        android:title="@string/copyURL"
+        android:title="@string/copy_URL"
         android:orderInCategory="50"
         tools:targetApi="11"
         app:showAsAction="never" />
@@ -42,20 +42,26 @@
     <!-- tools:targetApi="11" is required because copy and paste was not available on earlier version of Android. -->
     <item
         android:id="@+id/pasteURL"
-        android:title="@string/pasteURL"
+        android:title="@string/paste_URL"
         android:orderInCategory="60"
         tools:targetApi="11"
         app:showAsAction="never" />
 
     <item
         android:id="@+id/shareURL"
-        android:title="@string/shareURL"
+        android:title="@string/share_URL"
         android:orderInCategory="70"
         app:showAsAction="never" />
 
+    <item
+        android:id="@+id/addToHomescreen"
+        android:title="@string/add_to_home_screen"
+        android:orderInCategory="80"
+        app:showAsAction="never" />
+
     <item
         android:id="@+id/downloads"
         android:title="@string/downloads"
-        android:orderInCategory="80"
+        android:orderInCategory="90"
         app:showAsAction="never" />
 </menu>
diff --git a/app/src/main/res/values/strings.xml b/app/src/main/res/values/strings.xml
index 1afee767..6b4b6ced 100644
--- a/app/src/main/res/values/strings.xml
+++ b/app/src/main/res/values/strings.xml
@@ -10,8 +10,14 @@
     <string name="refresh">Refresh</string>
     <string name="back">Back</string>
     <string name="forward">Forward</string>
-    <string name="copyURL">Copy URL</string>
-    <string name="pasteURL">Paste URL</string>
-    <string name="shareURL">Share URL</string>
+    <string name="copy_URL">Copy URL</string>
+    <string name="paste_URL">Paste URL</string>
+    <string name="share_URL">Share URL</string>
+    <string name="add_to_home_screen">Add to Home Screen</string>
     <string name="downloads">Downloads</string>
+
+    <!-- Create Home Screen Shorcut Alert Dialog. -->
+    <string name="shortcut_name">Shortcut name</string>
+    <string name="cancel">Cancel</string>
+    <string name="create">Create</string>
 </resources>
-- 
2.45.2