Merge ChromeShortcutManager into ShortcutHelper.

chrome/android/java/src/org/chromium/chrome/browser/ShortcutHelper.java

 // Copyright 2013 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 package org.chromium.chrome.browser;
 
+import android.annotation.SuppressLint;
+import android.annotation.TargetApi;
 import android.app.ActivityManager;
 import android.content.Context;
 import android.content.Intent;
+import android.content.IntentSender;
 import android.content.pm.ApplicationInfo;
 import android.content.pm.PackageInfo;
 import android.content.pm.PackageManager;
 import android.content.pm.PackageManager.NameNotFoundException;
+import android.content.pm.ResolveInfo;
 import android.graphics.Bitmap;
 import android.graphics.BitmapFactory;
 import android.graphics.Canvas;
 import android.graphics.Color;
 import android.graphics.Paint;
 import android.graphics.Rect;
 import android.graphics.drawable.BitmapDrawable;
 import android.graphics.drawable.Drawable;
+import android.graphics.drawable.Icon;
 import android.net.Uri;
 import android.os.AsyncTask;
 import android.support.annotation.NonNull;
 import android.text.TextUtils;
 import android.util.Base64;
 
 import org.chromium.base.ApiCompatibilityUtils;
+import org.chromium.base.BuildInfo;
 import org.chromium.base.ContextUtils;
 import org.chromium.base.Log;
 import org.chromium.base.ThreadUtils;
 import org.chromium.base.VisibleForTesting;
 import org.chromium.base.annotations.CalledByNative;
 import org.chromium.blink_public.platform.WebDisplayMode;
 import org.chromium.chrome.R;
-import org.chromium.chrome.browser.webapps.ChromeShortcutManager;
 import org.chromium.chrome.browser.webapps.ChromeWebApkHost;
 import org.chromium.chrome.browser.webapps.WebApkInfo;
 import org.chromium.chrome.browser.webapps.WebappActivity;
 import org.chromium.chrome.browser.webapps.WebappAuthenticator;
 import org.chromium.chrome.browser.webapps.WebappDataStorage;
 import org.chromium.chrome.browser.webapps.WebappLauncherActivity;
 import org.chromium.chrome.browser.webapps.WebappRegistry;
 import org.chromium.chrome.browser.widget.RoundedIconGenerator;
 import org.chromium.content_public.common.ScreenOrientationConstants;
 import org.chromium.ui.widget.Toast;
 import org.chromium.webapk.lib.client.WebApkValidator;
 
 import java.io.ByteArrayOutputStream;
+import java.lang.reflect.Constructor;
+import java.lang.reflect.InvocationTargetException;
+import java.lang.reflect.Method;
 import java.util.ArrayList;
 import java.util.List;
 
 /**
  * This class contains functions related to adding shortcuts to the Android Home
  * screen.  These shortcuts are used to either open a page in the main browser
  * or open a web app.
  */
 public class ShortcutHelper {
     public static final String EXTRA_ICON = "org.chromium.chrome.browser.webapp_icon";
@@ skipping 21 matching lines @@
 
     // When a new field is added to the intent, this version should be incremented so that it will
     // be correctly populated into the WebappRegistry/WebappDataStorage.
     public static final int WEBAPP_SHORTCUT_VERSION = 2;
 
     // This value is equal to kInvalidOrMissingColor in the C++ content::Manifest struct.
     public static final long MANIFEST_COLOR_INVALID_OR_MISSING = ((long) Integer.MAX_VALUE) + 1;
 
     private static final String TAG = "ShortcutHelper";
 
+    // There is no public string defining this intent so if Home changes the value, we
+    // have to update this string.

[dominickn, 2017/05/08 04:51:22]

Nit: I think we can remove this comment now since I don't think the name of this
broadcast will ever change (it's been killed!)

[Marti Wong, 2017/05/09 04:36:42]

Done.

+    private static final String INSTALL_SHORTCUT = "com.android.launcher.action.INSTALL_SHORTCUT";
+
     // The activity class used for launching a WebApk.
     private static final String WEBAPK_MAIN_ACTIVITY = "org.chromium.webapk.shell_apk.MainActivity";
 
     // These sizes are from the Material spec for icons:
     // https://www.google.com/design/spec/style/icons.html#icons-product-icons
     private static final float MAX_INNER_SIZE_RATIO = 1.25f;
     private static final float ICON_PADDING_RATIO = 2.0f / 44.0f;
     private static final float ICON_CORNER_RADIUS_RATIO = 1.0f / 16.0f;
     private static final float GENERATED_ICON_PADDING_RATIO = 1.0f / 12.0f;
     private static final float GENERATED_ICON_FONT_SIZE_RATIO = 1.0f / 3.0f;
 
+    // True when Android O's ShortcutManager.requestPinShortcut() is supported.
+    private static boolean sIsRequestPinShortcutSupported;
+
+    // True when it is already checked if ShortcutManager.requestPinShortcut() is supported.
+    private static boolean sCheckedIfRequestPinShortcutSupported;
+
+    // TODO(martiw): Use 'ShortcutInfo' instead of 'Object' below when compileSdk is bumped to O.
+    private static Object sShortcutManager;
+
     /** Helper for generating home screen shortcuts. */
     public static class Delegate {
         /**
          * Request Android to add a shortcut to the home screen.
          * @param title  Title of the shortcut.
          * @param icon   Image that represents the shortcut.
          * @param intent Intent to fire when the shortcut is activated.
          */
         public void addShortcutToHomescreen(String title, Bitmap icon, Intent shortcutIntent) {
-            ChromeShortcutManager.getInstance().addShortcutToHomeScreen(
-                    title, icon, shortcutIntent);
+            if (isRequestPinShortcutSupported()) {
+                addShortcutWithShortcutManager(title, icon, shortcutIntent);
+                return;
+            }
+            Intent intent = createAddToHomeIntent(title, icon, shortcutIntent);
+            ContextUtils.getApplicationContext().sendBroadcast(intent);
         }
 
         /**
          * Returns the name of the fullscreen Activity to use when launching shortcuts.
          */
         public String getFullscreenAction() {
             return WebappLauncherActivity.ACTION_START_WEBAPP;
         }
     }
 
@@ skipping 43 matching lines @@
                 // process is complete, call back to native code to start the splash image
                 // download.
                 WebappRegistry.getInstance().register(
                         id, new WebappRegistry.FetchWebappDataStorageCallback() {
                             @Override
                             public void onWebappDataStorageRetrieved(WebappDataStorage storage) {
                                 storage.updateFromShortcutIntent(resultIntent);
                                 nativeOnWebappDataStored(callbackPointer);
                             }
                         });
-                if (ChromeShortcutManager.getInstance().shouldShowToastWhenAddingShortcut()) {
+                if (shouldShowToastWhenAddingShortcut()) {
                     showAddedToHomescreenToast(userTitle);
                 }
             }
         }.executeOnExecutor(AsyncTask.THREAD_POOL_EXECUTOR);
     }
 
     public static void addWebApkShortcut(Context context, String packageName) {
         PackageManager pm = context.getPackageManager();
         try {
             ApplicationInfo appInfo = pm.getApplicationInfo(
                     packageName, PackageManager.GET_META_DATA);
             String shortcutTitle = pm.getApplicationLabel(appInfo).toString();
             Bitmap shortcutIcon = ((BitmapDrawable) pm.getApplicationIcon(packageName)).getBitmap();
 
             Bitmap bitmap = createHomeScreenIconFromWebIcon(shortcutIcon);
             Intent i = new Intent();
             i.setClassName(packageName, WEBAPK_MAIN_ACTIVITY);
             i.addCategory(Intent.CATEGORY_LAUNCHER);
-            context.sendBroadcast(
-                    ChromeShortcutManager.createAddToHomeIntent(shortcutTitle, bitmap, i));
+            context.sendBroadcast(createAddToHomeIntent(shortcutTitle, bitmap, i));
         } catch (NameNotFoundException e) {
             e.printStackTrace();
         }
     }
 
     /**
      * Adds home screen shortcut which opens in the browser Activity.
      */
     @SuppressWarnings("unused")
     @CalledByNative
     private static void addShortcut(
             String id, String url, String userTitle, Bitmap icon, int source) {
         Context context = ContextUtils.getApplicationContext();
         final Intent shortcutIntent = createShortcutIntent(url);
         shortcutIntent.putExtra(EXTRA_ID, id);
         shortcutIntent.putExtra(EXTRA_SOURCE, source);
         shortcutIntent.setPackage(context.getPackageName());
         sDelegate.addShortcutToHomescreen(userTitle, icon, shortcutIntent);
-        if (ChromeShortcutManager.getInstance().shouldShowToastWhenAddingShortcut()) {
+        if (shouldShowToastWhenAddingShortcut()) {
             showAddedToHomescreenToast(userTitle);
         }
     }
 
+    // TODO(martiw): Use Build.VERSION_CODES.O instead of hardcoded number when it is available.
+    @TargetApi(26)
+    private static void addShortcutWithShortcutManager(
+            String title, Bitmap icon, Intent shortcutIntent) {
+        String id = shortcutIntent.getStringExtra(ShortcutHelper.EXTRA_ID);
+        Context context = ContextUtils.getApplicationContext();
+
+        // The code in the try-block uses reflection in order to compile as it calls APIs newer than
+        // our compileSdkVersion of Android. The equivalent code without reflection looks like this:
+        //  ShortcutInfo shortcutInfo = new ShortcutInfo.Builder(context, id)
+        //                                  .setShortLabel(title)
+        //                                  .setLongLabel(title)
+        //                                  .setIcon(Icon.createWithBitmap(icon))
+        //                                  .setIntent(shortcutIntent)
+        //                                  .build();
+        //  sShortcutManager.requestPinShortcut(shortcutInfo, null);
+        // TODO(martiw): Remove the following reflection once compileSdk is bumped to O.
+        try {
+            Class<?> builderClass = Class.forName("android.content.pm.ShortcutInfo$Builder");
+            Constructor<?> builderConstructor =
+                    builderClass.getDeclaredConstructor(Context.class, String.class);
+            Object shortcutBuilder = builderConstructor.newInstance(context, id);
+
+            Method setShortLabel = builderClass.getMethod("setShortLabel", CharSequence.class);
+            setShortLabel.invoke(shortcutBuilder, title);
+
+            Method setLongLabel = builderClass.getMethod("setLongLabel", CharSequence.class);
+            setLongLabel.invoke(shortcutBuilder, title);
+
+            Method setIcon = builderClass.getMethod("setIcon", Icon.class);
+            setIcon.invoke(shortcutBuilder, Icon.createWithBitmap(icon));
+
+            Method setIntent = builderClass.getMethod("setIntent", Intent.class);
+            setIntent.invoke(shortcutBuilder, shortcutIntent);
+
+            Method build = builderClass.getMethod("build");
+            Object shortcutInfo = build.invoke(shortcutBuilder);
+
+            Class<?> ShortcutInfoClass = Class.forName("android.content.pm.ShortcutInfo");
+            Method requestPinShortcut = sShortcutManager.getClass().getMethod(
+                    "requestPinShortcut", ShortcutInfoClass, IntentSender.class);
+            requestPinShortcut.invoke(sShortcutManager, shortcutInfo, null);
+        } catch (ClassNotFoundException | NoSuchMethodException | InstantiationException
+                | InvocationTargetException | IllegalAccessException e) {
+            Log.e(TAG, "Error adding shortcut with ShortcutManager:", e);
+        }
+    }
+
     /**
      * Show toast to alert user that the shortcut was added to the home screen.
      */
     private static void showAddedToHomescreenToast(final String title) {
         Context applicationContext = ContextUtils.getApplicationContext();
         String toastText = applicationContext.getString(R.string.added_to_homescreen, title);
         showToast(toastText);
     }
 
     /**
@@ skipping 34 matching lines @@
 
                 @Override
                 protected void onPostExecute(String encodedImage) {
                     storage.updateSplashScreenImage(encodedImage);
                 }
             }.executeOnExecutor(AsyncTask.THREAD_POOL_EXECUTOR);
         }
     }
 
     /**
+     * Creates an intent that will add a shortcut to the home screen.
+     * @param title          Title of the shortcut.
+     * @param icon           Image that represents the shortcut.
+     * @param shortcutIntent Intent to fire when the shortcut is activated.
+     * @return Intent for the shortcut.
+     */
+    public static Intent createAddToHomeIntent(String title, Bitmap icon, Intent shortcutIntent) {
+        Intent i = new Intent(INSTALL_SHORTCUT);
+        i.putExtra(Intent.EXTRA_SHORTCUT_INTENT, shortcutIntent);
+        i.putExtra(Intent.EXTRA_SHORTCUT_NAME, title);
+        i.putExtra(Intent.EXTRA_SHORTCUT_ICON, icon);
+        return i;
+    }
+
+    /**
      * Creates a shortcut to launch a web app on the home screen.
      * @param id              Id of the web app.
      * @param action          Intent action to open a full screen activity.
      * @param url             Url of the web app.
      * @param scope           Url scope of the web app.
      * @param name            Name of the web app.
      * @param shortName       Short name of the web app.
      * @param icon            Icon of the web app.
      * @param version         Version number of the shortcut.
      * @param displayMode     Display mode of the web app.
@@ skipping 51 matching lines @@
     public static Intent createShortcutIntent(String url) {
         Intent shortcutIntent = new Intent(Intent.ACTION_VIEW, Uri.parse(url));
         shortcutIntent.putExtra(REUSE_URL_MATCHING_TAB_ELSE_NEW_TAB, true);
         return shortcutIntent;
     }
 
     /**
      * Utility method to check if a shortcut can be added to the home screen.
      * @return if a shortcut can be added to the home screen under the current profile.
      */
+    // TODO(crbug.com/635567): Fix this properly.
+    @SuppressLint("WrongConstant")
     public static boolean isAddToHomeIntentSupported() {
-        return ChromeShortcutManager.getInstance().canAddShortcutToHomescreen();
+        if (isRequestPinShortcutSupported()) return true;
+        PackageManager pm = ContextUtils.getApplicationContext().getPackageManager();
+        Intent i = new Intent(INSTALL_SHORTCUT);
+        List<ResolveInfo> receivers =
+                pm.queryBroadcastReceivers(i, PackageManager.GET_INTENT_FILTERS);
+        return !receivers.isEmpty();
     }
 
     /**
      * Returns whether the given icon matches the size requirements to be used on the home screen.
      * @param width  Icon width, in pixels.
      * @param height Icon height, in pixels.
      * @return whether the given icon matches the size requirements to be used on the home screen.
      */
     @CalledByNative
     public static boolean isIconLargeEnoughForLauncher(int width, int height) {
@@ skipping 259 matching lines @@
         int maxY = icon.getHeight() - 1;
 
         if ((Color.alpha(icon.getPixel(0, 0)) != 0) && (Color.alpha(icon.getPixel(maxX, maxY)) != 0)
                 && (Color.alpha(icon.getPixel(0, maxY)) != 0)
                 && (Color.alpha(icon.getPixel(maxX, 0)) != 0)) {
             return true;
         }
         return false;
     }
 
+    private static boolean shouldShowToastWhenAddingShortcut() {
+        return !isRequestPinShortcutSupported();
+    }
+
+    private static boolean isRequestPinShortcutSupported() {
+        if (!sCheckedIfRequestPinShortcutSupported) {
+            if (BuildInfo.isAtLeastO()) {
+                checkIfRequestPinShortcutSupported();
+            }
+            sCheckedIfRequestPinShortcutSupported = true;
+        }
+        return sIsRequestPinShortcutSupported;
+    }
+
+    // TODO(martiw): Use Build.VERSION_CODES.O instead of hardcoded number when it is available.
+    @TargetApi(26)
+    private static void checkIfRequestPinShortcutSupported() {
+        // The code in the try-block uses reflection in order to compile as it calls APIs newer than
+        // our target version of Android. The equivalent code without reflection is as follows:
+        //  sShortcutManager =
+        //          ContextUtils.getApplicationContext().getSystemService(ShortcutManager.class);
+        //  sIsRequestPinShortcutSupported = sShortcutManager.isRequestPinShortcutSupported();
+        // TODO(martiw): Remove the following reflection once compileSdk is bumped to O.
+        try {
+            Class<?> ShortcutManagerClass = Class.forName("android.content.pm.ShortcutManager");
+            sShortcutManager =
+                    ContextUtils.getApplicationContext().getSystemService(ShortcutManagerClass);
+
+            Method isRequestPinShortcutSupported =
+                    ShortcutManagerClass.getMethod("isRequestPinShortcutSupported");
+            sIsRequestPinShortcutSupported =
+                    (boolean) isRequestPinShortcutSupported.invoke(sShortcutManager);
+        } catch (ClassNotFoundException | NoSuchMethodException | InvocationTargetException
+                | IllegalAccessException e) {
+            Log.e(TAG, "Error checking if RequestPinShortcut is supported:", e);
+        }
+    }
+
     private static int getSizeFromResourceInPx(Context context, int resource) {
         return Math.round(context.getResources().getDimension(resource));
     }
 
     private static Bitmap getBitmapFromResourceId(Context context, int id, int density) {
         Drawable drawable = ApiCompatibilityUtils.getDrawableForDensity(
                 context.getResources(), id, density);
 
         if (drawable instanceof BitmapDrawable) {
             BitmapDrawable bd = (BitmapDrawable) drawable;
@@ skipping 73 matching lines @@
         }
         return array;
     }
 
     private static native void nativeOnWebappDataStored(long callbackPointer);
     private static native void nativeOnWebApksRetrieved(long callbackPointer, String[] names,
             String[] shortNames, String[] packageName, int[] shellApkVersions, int[] versionCodes,
             String[] uris, String[] scopes, String[] manifestUrls, String[] manifestStartUrls,
             int[] displayModes, int[] orientations, long[] themeColors, long[] backgroundColors);
 }