Scale large notification icons according to device settings.

chrome/android/java/src/org/chromium/chrome/browser/notifications/NotificationUIManager.java

 // Copyright 2014 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.notifications;
 
 import android.app.Notification;
 import android.app.NotificationManager;
 import android.app.PendingIntent;
 import android.content.Context;
@@ skipping 52 matching lines @@
     private static final int PENDING_INTENT_REQUEST_CODE = 0;
 
     private static NotificationUIManager sInstance;
     private static NotificationManagerProxy sNotificationManagerOverride;
 
     private final long mNativeNotificationManager;
 
     private final Context mAppContext;
     private final NotificationManagerProxy mNotificationManager;
 
-    private RoundedIconGenerator mIconGenerator;
+    @VisibleForTesting public RoundedIconGenerator mIconGenerator;
+    private final int mLargeIconWidthPx;
+    private final int mLargeIconHeightPx;
+    private final float mDensity;
 
     private long mLastNotificationClickMs = 0L;
 
     /**
      * Creates a new instance of the NotificationUIManager.
      *
      * @param nativeNotificationManager Instance of the NotificationUIManagerAndroid class.
      * @param context Application context for this instance of Chrome.
      */
     @CalledByNative
     private static NotificationUIManager create(long nativeNotificationManager, Context context) {
         if (sInstance != null) {
             throw new IllegalStateException("There must only be a single NotificationUIManager.");
         }
 
         sInstance = new NotificationUIManager(nativeNotificationManager, context);
         return sInstance;
     }
 
     /**
+     * Returns the current instance of the NotificationUIManager. Should only be used by tests.

[Miguel Garcia, 2015/09/28 17:47:12]

Doesn't the @VisibleForTesting annotation already imply that this is only is
supposed to be private + test visibility?

Also consider making it package private since the test will presumably live in
the same package.

[Peter Beverloo, 2015/09/28 18:03:03]

Done.

+     *
+     * @return The instance of the NotificationUIManager, if any.
+     */
+    @Nullable
+    @VisibleForTesting
+    public static NotificationUIManager getInstanceForTests() {
+        return sInstance;
+    }
+
+    /**
      * Overrides the notification manager which is to be used for displaying Notifications on the
      * Android framework. Should only be used for testing. Tests are expected to clean up after
      * themselves by setting this to NULL again.
      *
      * @param proxy The notification manager instance to use instead of the system's.
      */
     @VisibleForTesting
     public static void overrideNotificationManagerForTesting(
             NotificationManagerProxy notificationManager) {
         sNotificationManagerOverride = notificationManager;
     }
 
     private NotificationUIManager(long nativeNotificationManager, Context context) {
         mNativeNotificationManager = nativeNotificationManager;
         mAppContext = context.getApplicationContext();
 
         if (sNotificationManagerOverride != null) {
             mNotificationManager = sNotificationManagerOverride;
         } else {
             mNotificationManager = new NotificationManagerProxyImpl(
                     (NotificationManager) context.getSystemService(Context.NOTIFICATION_SERVICE));
         }
+
+        Resources resources = mAppContext.getResources();
+

[Miguel Garcia, 2015/09/28 17:47:13]

nit can you initialize density after line 137 so it matches the order in which
they are declared above?

[Peter Beverloo, 2015/09/28 18:03:03]

Done.

+        mDensity = resources.getDisplayMetrics().density;
+        mLargeIconWidthPx =

[Miguel Garcia, 2015/09/28 17:47:13]

I assume neither of this can ever return 0? Otherwise createScaledBitmap in #506
will explode.

[Peter Beverloo, 2015/09/28 18:03:03]

Stack Overflow would have exploded already if that were the case :).

+            resources.getDimensionPixelSize(android.R.dimen.notification_large_icon_width);
+        mLargeIconHeightPx =
+            resources.getDimensionPixelSize(android.R.dimen.notification_large_icon_height);
     }
 
     /**
      * Marks the current instance as being freed, allowing for a new NotificationUIManager
      * object to be initialized.
      */
     @CalledByNative
     private void destroy() {
         assert sInstance == this;
         sInstance = null;
@@ skipping 239 matching lines @@
      *
      * @param persistentNotificationId The persistent id of the notification.
      * @param origin Full text of the origin, including the protocol, owning this notification.
      * @param tag A string identifier for this notification. If the tag is not empty, the new
      *            notification will replace the previous notification with the same tag and origin,
      *            if present. If no matching previous notification is present, the new one will just
      *            be added.
      * @param title Title to be displayed in the notification.
      * @param body Message to be displayed in the notification. Will be trimmed to one line of
      *             text by the Android notification system.
-     * @param icon Icon to be displayed in the notification. When this isn't a valid Bitmap, a
-     *             default icon will be generated instead.
+     * @param icon Icon to be displayed in the notification. Valid Bitmap icons will be scaled to
+     *             the platforms, whereas a default icon will be generated for invalid Bitmaps.
      * @param vibrationPattern Vibration pattern following the Web Vibration syntax.
      * @param silent Whether the default sound, vibration and lights should be suppressed.
      * @param actionTitles Titles of actions to display alongside the notification.
      * @see https://developer.android.com/reference/android/app/Notification.html
      */
     @CalledByNative
     private void displayNotification(long persistentNotificationId, String origin, String tag,
             String title, String body, Bitmap icon, int[] vibrationPattern, boolean silent,
             String[] actionTitles) {
-        if (icon == null || icon.getWidth() == 0) {
-            icon = getIconGenerator().generateIconForUrl(origin, true);
-        }
-
         Resources res = mAppContext.getResources();
 
         // Set up a pending intent for going to the settings screen for |origin|.
         Intent settingsIntent = PreferencesLauncher.createIntentForSettingsPage(
                 mAppContext, SingleWebsitePreferences.class.getName());
         settingsIntent.setData(makeIntentData(persistentNotificationId, origin,
                                               -1 /* actionIndex */));
         settingsIntent.putExtra(Preferences.EXTRA_SHOW_FRAGMENT_ARGUMENTS,
                 SingleWebsitePreferences.createFragmentArgsForSite(origin));
 
         PendingIntent pendingSettingsIntent = PendingIntent.getActivity(mAppContext,
                 PENDING_INTENT_REQUEST_CODE, settingsIntent, PendingIntent.FLAG_UPDATE_CURRENT);
 
         NotificationCompat.Builder notificationBuilder = new NotificationCompat.Builder(mAppContext)
                 .setContentTitle(title)
                 .setContentText(body)
                 .setStyle(new NotificationCompat.BigTextStyle().bigText(body))
-                .setLargeIcon(icon)
+                .setLargeIcon(ensureNormalizedIcon(icon, origin))
                 .setSmallIcon(R.drawable.ic_chrome)
                 .setContentIntent(makePendingIntent(
                         NotificationConstants.ACTION_CLICK_NOTIFICATION,
                         persistentNotificationId, origin, tag, -1 /* actionIndex */))
                 .setDeleteIntent(makePendingIntent(
                         NotificationConstants.ACTION_CLOSE_NOTIFICATION,
                         persistentNotificationId, origin, tag, -1 /* actionIndex */))
                 .setTicker(createTickerText(title, body))
                 .setSubText(origin);
 
@@ skipping 34 matching lines @@
         spannableStringBuilder.append(body);
 
         // Mark the title of the notification as being bold.
         spannableStringBuilder.setSpan(new StyleSpan(android.graphics.Typeface.BOLD),
                 0, title.length(), Spannable.SPAN_INCLUSIVE_INCLUSIVE);
 
         return spannableStringBuilder;
     }
 
     /**
-     * Ensures the existance of an icon generator, which is created lazily.
+     * Ensures the availability of an icon for the notification.
      *
-     * @return The icon generator which can be used.
+     * If |icon| is a valid, non-empty Bitmap, the bitmap will be scaled to be of an appropriate
+     * size for the current Android device. Otherwise, a default icon will be created based on the
+     * origin the notification is being displayed for.
+     *
+     * @param icon The developer-provided icon they intend to use for the notification.
+     * @param origin The origin the notification is being displayed for.
+     * @return An appropriately sized icon to use for the notification.
      */
-    private RoundedIconGenerator getIconGenerator() {
-        if (mIconGenerator == null) {
-            mIconGenerator = createRoundedIconGenerator(mAppContext);
+    @VisibleForTesting
+    public Bitmap ensureNormalizedIcon(Bitmap icon, String origin) {
+        if (icon == null || icon.getWidth() == 0) {
+            if (mIconGenerator == null) {
+                int cornerRadiusPx = Math.min(mLargeIconWidthPx, mLargeIconHeightPx) / 2;
+                mIconGenerator =
+                        new RoundedIconGenerator(mLargeIconWidthPx, mLargeIconHeightPx,
+                                                 cornerRadiusPx,
+                                                 NOTIFICATION_ICON_BG_COLOR,
+                                                 NOTIFICATION_TEXT_SIZE_DP * mDensity);
+            }
+
+            return mIconGenerator.generateIconForUrl(origin, true);
         }
 
-        return mIconGenerator;
+        if (icon.getWidth() > mLargeIconWidthPx || icon.getHeight() > mLargeIconHeightPx) {
+            return icon.createScaledBitmap(icon, mLargeIconWidthPx, mLargeIconHeightPx, false);

[Miguel Garcia, 2015/09/28 17:47:12]

can you add /* not filtered */ right after the last parameter?

[Peter Beverloo, 2015/09/28 18:03:03]

Done.

+        }
+
+        return icon;
     }
 
     /**
-     * Creates the rounded icon generator to use for notifications based on the dimensions
-     * and resolution of the device we're running on.
-     *
-     * @param appContext The application context to retrieve resources from.
-     * @return The newly created rounded icon generator.
-     */
-    @VisibleForTesting
-    public static RoundedIconGenerator createRoundedIconGenerator(Context appContext) {
-        Resources res = appContext.getResources();
-        float density = res.getDisplayMetrics().density;
-
-        int widthPx = res.getDimensionPixelSize(android.R.dimen.notification_large_icon_width);
-        int heightPx =
-                res.getDimensionPixelSize(android.R.dimen.notification_large_icon_height);
-
-        return new RoundedIconGenerator(
-                widthPx,
-                heightPx,
-                Math.min(widthPx, heightPx) / 2,
-                NOTIFICATION_ICON_BG_COLOR,
-                NOTIFICATION_TEXT_SIZE_DP * density);
-    }
-
-    /**
      * Returns whether a notification has been clicked in the last 5 seconds.
      * Used for Startup.BringToForegroundReason UMA histogram.
      */
     public static boolean wasNotificationRecentlyClicked() {
         if (sInstance == null) return false;
         long now = System.currentTimeMillis();
         return now - sInstance.mLastNotificationClickMs < 5 * 1000;
     }
 
     /**
@@ skipping 41 matching lines @@
                                           origin, tag);
     }
 
     private static native void nativeInitializeNotificationUIManager();
 
     private native boolean nativeOnNotificationClicked(long nativeNotificationUIManagerAndroid,
             long persistentNotificationId, String origin, String tag, int actionIndex);
     private native boolean nativeOnNotificationClosed(long nativeNotificationUIManagerAndroid,
             long persistentNotificationId, String origin, String tag);
 }