Add support for pulling icons for OfflineItems

chrome/android/java/src/org/chromium/chrome/browser/download/DownloadNotificationService.java

 // Copyright 2015 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.download;
 
 import android.annotation.TargetApi;
 import android.app.DownloadManager;
 import android.app.Notification;
 import android.app.NotificationManager;
@@ skipping 563 matching lines @@
 
     @VisibleForTesting
     void updateNotificationsForShutdown() {
         cancelOffTheRecordDownloads();
         List<DownloadSharedPreferenceEntry> entries = mDownloadSharedPreferenceHelper.getEntries();
         for (DownloadSharedPreferenceEntry entry : entries) {
             if (entry.isOffTheRecord) continue;
             // Move all regular downloads to pending.  Don't propagate the pause because
             // if native is still working and it triggers an update, then the service will be
             // restarted.
-            notifyDownloadPaused(entry.id, !entry.isOffTheRecord, true, entry.isTransient);
+            notifyDownloadPaused(entry.id, !entry.isOffTheRecord, true, entry.isTransient, null);
         }
     }
 
     @VisibleForTesting
     void cancelOffTheRecordDownloads() {
         boolean cancelActualDownload = LibraryLoader.isInitialized()
                 && Profile.getLastUsedProfile().hasOffTheRecordProfile();
 
         List<DownloadSharedPreferenceEntry> entries = mDownloadSharedPreferenceHelper.getEntries();
         List<DownloadSharedPreferenceEntry> copies =
@@ skipping 136 matching lines @@
      */
     static void clearResumptionAttemptLeft() {
         SharedPreferences SharedPrefs = ContextUtils.getAppSharedPreferences();
         SharedPreferences.Editor editor = SharedPrefs.edit();
         editor.remove(KEY_AUTO_RESUMPTION_ATTEMPT_LEFT);
         editor.apply();
     }
 
     /**
      * Adds or updates an in-progress download notification.
-     * @param id The {@link ContentId} of the download.
-     * @param fileName File name of the download.
-     * @param percentage Percentage completed. Value should be between 0 to 100 if
-     *        the percentage can be determined, or -1 if it is unknown.
-     * @param bytesReceived Total number of bytes received.
-     * @param timeRemainingInMillis Remaining download time in milliseconds.
-     * @param startTime Time when download started.
-     * @param isOffTheRecord Whether the download is off the record.
+     * @param id                      The {@link ContentId} of the download.
+     * @param fileName                File name of the download.
+     * @param percentage              Percentage completed. Value should be between 0 to 100 if the
+     *                                percentage can be determined, or -1 if it is unknown.
+     * @param bytesReceived           Total number of bytes received.
+     * @param timeRemainingInMillis   Remaining download time in milliseconds.
+     * @param startTime               Time when download started.
+     * @param isOffTheRecord          Whether the download is off the record.
      * @param canDownloadWhileMetered Whether the download can happen in metered network.
-     * @param isTransient Whether or not clicking on the download should launch downloads home.
+     * @param isTransient             Whether or not clicking on the download should launch
+     *                                downloads home.
+     * @param icon                    A {@link Bitmap} to be used as the large icon for display.
      */
     @VisibleForTesting
     public void notifyDownloadProgress(ContentId id, String fileName, int percentage,
             long bytesReceived, long timeRemainingInMillis, long startTime, boolean isOffTheRecord,
-            boolean canDownloadWhileMetered, boolean isTransient) {
+            boolean canDownloadWhileMetered, boolean isTransient, Bitmap icon) {
         updateActiveDownloadNotification(id, fileName, percentage, bytesReceived,
                 timeRemainingInMillis, startTime, isOffTheRecord, canDownloadWhileMetered, false,
-                isTransient);
+                isTransient, icon);
     }
 
     /**
      * Adds or updates a pending download notification.
-     * @param id The {@link ContentId} of the download.
-     * @param fileName File name of the download.
-     * @param isOffTheRecord Whether the download is off the record.
+     * @param id                      The {@link ContentId} of the download.
+     * @param fileName                File name of the download.
+     * @param isOffTheRecord          Whether the download is off the record.
      * @param canDownloadWhileMetered Whether the download can happen in metered network.
-     * @param isTransient Whether or not clicking on the download should launch downloads home.
+     * @param isTransient             Whether or not clicking on the download should launch
+     *                                downloads home.
+     * @param icon                    A {@link Bitmap} to be used as the large icon for display.
      */
     private void notifyDownloadPending(ContentId id, String fileName, boolean isOffTheRecord,
-            boolean canDownloadWhileMetered, boolean isTransient) {
+            boolean canDownloadWhileMetered, boolean isTransient, Bitmap icon) {
         updateActiveDownloadNotification(id, fileName,
                 DownloadItem.INDETERMINATE_DOWNLOAD_PERCENTAGE, 0, 0, 0, isOffTheRecord,
-                canDownloadWhileMetered, true, isTransient);
+                canDownloadWhileMetered, true, isTransient, icon);
     }
 
     /**
      * Helper method to update the notification for an active download, the download is either in
      * progress or pending.
-     * @param id The {@link ContentId} of the download.
-     * @param fileName File name of the download.
-     * @param percentage Percentage completed. Value should be between 0 to 100 if
-     *        the percentage can be determined, or -1 if it is unknown.
-     * @param bytesReceived Total number of bytes received.
-     * @param timeRemainingInMillis Remaining download time in milliseconds or -1 if it is unknown.
-     * @param startTime Time when download started.
-     * @param isOffTheRecord Whether the download is off the record.
+     * @param id                      The {@link ContentId} of the download.
+     * @param fileName                File name of the download.
+     * @param percentage              Percentage completed. Value should be between 0 to 100 if the
+     *                                percentage can be determined, or -1 if it is unknown.
+     * @param bytesReceived           Total number of bytes received.
+     * @param timeRemainingInMillis   Remaining download time in milliseconds or -1 if it is
+     *                                unknown.
+     * @param startTime               Time when download started.
+     * @param isOffTheRecord          Whether the download is off the record.
      * @param canDownloadWhileMetered Whether the download can happen in metered network.
-     * @param isDownloadPending Whether the download is pending.
-     * @param isTransient Whether or not clicking on the download should launch downloads home.
+     * @param isDownloadPending       Whether the download is pending.
+     * @param isTransient             Whether or not clicking on the download should launch
+     *                                downloads home.
+     * @param icon                    A {@link Bitmap} to be used as the large icon for display.
      */
     private void updateActiveDownloadNotification(ContentId id, String fileName, int percentage,
             long bytesReceived, long timeRemainingInMillis, long startTime, boolean isOffTheRecord,
-            boolean canDownloadWhileMetered, boolean isDownloadPending, boolean isTransient) {
+            boolean canDownloadWhileMetered, boolean isDownloadPending, boolean isTransient,
+            Bitmap icon) {
         boolean indeterminate =
                 (percentage == DownloadItem.INDETERMINATE_DOWNLOAD_PERCENTAGE) || isDownloadPending;
         String contentText = null;
         if (isDownloadPending) {
             contentText = mContext.getResources().getString(R.string.download_notification_pending);
         } else if (indeterminate) {
             // TODO(dimich): Enable the byte count back in M59. See bug 704049 for more info and
             // details of what was temporarily reverted (for M58).
             contentText = mContext.getResources().getString(R.string.download_started);
         } else {
@@ skipping 25 matching lines @@
         if (startTime > 0) builder.setWhen(startTime);
 
         if (!isTransient) {
             // Clicking on an in-progress download sends the user to see all their downloads.
             Intent downloadHomeIntent = buildActionIntent(
                     mContext, DownloadManager.ACTION_NOTIFICATION_CLICKED, null, isOffTheRecord);
             builder.setContentIntent(PendingIntent.getBroadcast(mContext, notificationId,
                     downloadHomeIntent, PendingIntent.FLAG_UPDATE_CURRENT));
         }
         builder.setAutoCancel(false);
+        if (icon != null) builder.setLargeIcon(icon);
 
         Intent pauseIntent = buildActionIntent(mContext, ACTION_DOWNLOAD_PAUSE, id, isOffTheRecord);
         builder.addAction(R.drawable.ic_pause_white_24dp,
                 mContext.getResources().getString(R.string.download_notification_pause_button),
                 buildPendingIntent(pauseIntent, notificationId));
 
         Intent cancelIntent =
                 buildActionIntent(mContext, ACTION_DOWNLOAD_CANCEL, id, isOffTheRecord);
         builder.addAction(R.drawable.btn_close_white,
                 mContext.getResources().getString(R.string.download_notification_cancel_button),
@@ skipping 34 matching lines @@
     @VisibleForTesting
     public void notifyDownloadCanceled(ContentId id) {
         DownloadSharedPreferenceEntry entry =
                 mDownloadSharedPreferenceHelper.getDownloadSharedPreferenceEntry(id);
         if (entry == null) return;
         cancelNotification(entry.notificationId, id);
     }
 
     /**
      * Change a download notification to paused state.
-     * @param id The {@link ContentId} of the download.
-     * @param isResumable Whether download can be resumed.
+     * @param id              The {@link ContentId} of the download.
+     * @param isResumable     Whether download can be resumed.
      * @param isAutoResumable whether download is can be resumed automatically.
-     * @param isTransient Whether or not clicking on the download should launch downloads home.
+     * @param isTransient     Whether or not clicking on the download should launch downloads home.
+     * @param icon            A {@link Bitmap} to be used as the large icon for display.
      */
-    public void notifyDownloadPaused(
-            ContentId id, boolean isResumable, boolean isAutoResumable, boolean isTransient) {
+    public void notifyDownloadPaused(ContentId id, boolean isResumable, boolean isAutoResumable,
+            boolean isTransient, Bitmap icon) {
         DownloadSharedPreferenceEntry entry =
                 mDownloadSharedPreferenceHelper.getDownloadSharedPreferenceEntry(id);
         if (entry == null) return;
         if (!isResumable) {
-            notifyDownloadFailed(id, entry.fileName);
+            notifyDownloadFailed(id, entry.fileName, icon);
             return;
         }
         // If download is already paused, do nothing.
         if (!entry.isAutoResumable) return;
         // If download is interrupted due to network disconnection, show download pending state.
         if (isAutoResumable) {
             notifyDownloadPending(id, entry.fileName, entry.isOffTheRecord,
-                    entry.canDownloadWhileMetered, isTransient);
+                    entry.canDownloadWhileMetered, isTransient, icon);
             stopTrackingInProgressDownload(id, true);
             return;
         }
 
         String contentText = mContext.getResources().getString(
                 R.string.download_notification_paused);
         ChromeNotificationBuilder builder =
                 buildNotification(R.drawable.ic_download_pause, entry.fileName, contentText);
 
         if (!isTransient) {
             // Clicking on an in-progress download sends the user to see all their downloads.
             Intent downloadHomeIntent = buildActionIntent(
                     mContext, DownloadManager.ACTION_NOTIFICATION_CLICKED, null, false);
             builder.setContentIntent(PendingIntent.getBroadcast(mContext, entry.notificationId,
                     downloadHomeIntent, PendingIntent.FLAG_UPDATE_CURRENT));
         }
         builder.setAutoCancel(false);
+        if (icon != null) builder.setLargeIcon(icon);
 
         Intent resumeIntent =
                 buildActionIntent(mContext, ACTION_DOWNLOAD_RESUME, id, entry.isOffTheRecord);
         builder.addAction(R.drawable.ic_file_download_white_24dp,
                 mContext.getResources().getString(R.string.download_notification_resume_button),
                 buildPendingIntent(resumeIntent, entry.notificationId));
 
         Intent cancelIntent =
                 buildActionIntent(mContext, ACTION_DOWNLOAD_CANCEL, id, entry.isOffTheRecord);
         builder.addAction(R.drawable.btn_close_white,
                 mContext.getResources().getString(R.string.download_notification_cancel_button),
                 buildPendingIntent(cancelIntent, entry.notificationId));
         PendingIntent deleteIntent = isTransient
                 ? buildPendingIntent(cancelIntent, entry.notificationId)
                 : buildSummaryIconIntent(entry.notificationId);
         builder.setDeleteIntent(deleteIntent);
 
         updateNotification(entry.notificationId, builder.build(), id,
                 new DownloadSharedPreferenceEntry(id, entry.notificationId, entry.isOffTheRecord,
                         entry.canDownloadWhileMetered, entry.fileName, isAutoResumable,
                         isTransient));
         stopTrackingInProgressDownload(id, true);
     }
 
     /**
      * Add a download successful notification.
-     * @param id The {@link ContentId} of the download.
-     * @param filePath Full path to the download.
-     * @param fileName Filename of the download.
-     * @param systemDownloadId Download ID assigned by system DownloadManager.
+     * @param id                  The {@link ContentId} of the download.
+     * @param filePath            Full path to the download.
+     * @param fileName            Filename of the download.
+     * @param systemDownloadId    Download ID assigned by system DownloadManager.
      * @param isSupportedMimeType Whether the MIME type can be viewed inside browser.
-     * @param isOpenable Whether or not this download can be opened.
-     * @return ID of the successful download notification. Used for removing the notification when
-     *         user click on the snackbar.
+     * @param isOpenable          Whether or not this download can be opened.
+     * @param icon                A {@link Bitmap} to be used as the large icon for display.
+     * @return                    ID of the successful download notification. Used for removing the
+     *                            notification when user click on the snackbar.
      */
     @VisibleForTesting
     public int notifyDownloadSuccessful(ContentId id, String filePath, String fileName,
             long systemDownloadId, boolean isOffTheRecord, boolean isSupportedMimeType,
-            boolean isOpenable) {
+            boolean isOpenable, Bitmap icon) {
         int notificationId = getNotificationId(id);
         ChromeNotificationBuilder builder = buildNotification(R.drawable.offline_pin, fileName,
                 mContext.getResources().getString(R.string.download_notification_completed));
         ComponentName component = new ComponentName(
                 mContext.getPackageName(), DownloadBroadcastReceiver.class.getName());
 
         if (isOpenable) {
             Intent intent = null;
             if (LegacyHelpers.isLegacyDownload(id)) {
                 intent = new Intent(DownloadManager.ACTION_NOTIFICATION_CLICKED);
                 long[] idArray = {systemDownloadId};
                 intent.putExtra(DownloadManager.EXTRA_NOTIFICATION_CLICK_DOWNLOAD_IDS, idArray);
                 intent.putExtra(EXTRA_DOWNLOAD_FILE_PATH, filePath);
                 intent.putExtra(EXTRA_IS_SUPPORTED_MIME_TYPE, isSupportedMimeType);
                 intent.putExtra(EXTRA_IS_OFF_THE_RECORD, isOffTheRecord);
                 intent.putExtra(EXTRA_DOWNLOAD_CONTENTID_ID, id.id);
                 intent.putExtra(EXTRA_DOWNLOAD_CONTENTID_NAMESPACE, id.namespace);
                 intent.putExtra(NotificationConstants.EXTRA_NOTIFICATION_ID, notificationId);
             } else {
                 intent = buildActionIntent(mContext, ACTION_DOWNLOAD_OPEN, id, false);
             }
 
             intent.setComponent(component);
             builder.setContentIntent(PendingIntent.getBroadcast(
                     mContext, notificationId, intent, PendingIntent.FLAG_UPDATE_CURRENT));
         }
-        if (mDownloadSuccessLargeIcon == null) {
+        if (icon == null && mDownloadSuccessLargeIcon == null) {
             Bitmap bitmap = BitmapFactory.decodeResource(
                     mContext.getResources(), R.drawable.offline_pin);
             mDownloadSuccessLargeIcon = getLargeNotificationIcon(bitmap);
         }
         builder.setDeleteIntent(buildSummaryIconIntent(notificationId));
-        builder.setLargeIcon(mDownloadSuccessLargeIcon);
+        builder.setLargeIcon(icon != null ? icon : mDownloadSuccessLargeIcon);
         updateNotification(notificationId, builder.build(), id, null);
         stopTrackingInProgressDownload(id, true);
         return notificationId;
     }
 
     /**
      * Add a download failed notification.
-     * @param id The {@link ContentId} of the download.
+     * @param id       The {@link ContentId} of the download.
      * @param fileName GUID of the download.
+     * @param icon     A {@link Bitmap} to be used as the large icon for display.
      */
     @VisibleForTesting
-    public void notifyDownloadFailed(ContentId id, String fileName) {
+    public void notifyDownloadFailed(ContentId id, String fileName, Bitmap icon) {
         // If the download is not in history db, fileName could be empty. Get it from
         // SharedPreferences.
         if (TextUtils.isEmpty(fileName)) {
             DownloadSharedPreferenceEntry entry =
                     mDownloadSharedPreferenceHelper.getDownloadSharedPreferenceEntry(id);
             if (entry == null) return;
             fileName = entry.fileName;
         }
 
         int notificationId = getNotificationId(id);
         ChromeNotificationBuilder builder =
                 buildNotification(android.R.drawable.stat_sys_download_done, fileName,
                         mContext.getResources().getString(R.string.download_notification_failed));
+        if (icon != null) builder.setLargeIcon(icon);
         builder.setDeleteIntent(buildSummaryIconIntent(notificationId));
         updateNotification(notificationId, builder.build(), id, null);
         stopTrackingInProgressDownload(id, true);
     }
 
     /**
      * Helper method to build a PendingIntent from the provided intent.
      * @param intent Intent to broadcast.
      * @param notificationId ID of the notification.
      */
@@ skipping 112 matching lines @@
                            && TextUtils.equals(intent.getAction(), ACTION_DOWNLOAD_OPEN))) {
             handleDownloadOperationForMissingNotification(intent);
             hideSummaryNotificationIfNecessary(-1);
             return;
         }
 
         if (ACTION_DOWNLOAD_PAUSE.equals(intent.getAction())) {
             // If browser process already goes away, the download should have already paused. Do
             // nothing in that case.
             if (!DownloadManagerService.hasDownloadManagerService()) {
-                notifyDownloadPaused(entry.id, !entry.isOffTheRecord, false, entry.isTransient);
+                // TODO(dtrainor): Should we spin up native to make sure we have the icon?  Or maybe
+                // build a Java cache for easy access.
+                notifyDownloadPaused(
+                        entry.id, !entry.isOffTheRecord, false, entry.isTransient, null);
                 hideSummaryNotificationIfNecessary(-1);
                 return;
             }
         } else if (ACTION_DOWNLOAD_RESUME.equals(intent.getAction())) {
             // If user manually resumes a download, update the network type if it
             // is not metered previously.
             boolean canDownloadWhileMetered = entry.canDownloadWhileMetered
                     || DownloadManagerService.isActiveNetworkMetered(mContext);
             // Update the SharedPreference entry.
             mDownloadSharedPreferenceHelper.addOrReplaceSharedPreferenceEntry(
@@ skipping 26 matching lines @@
                 if (ACTION_DOWNLOAD_CANCEL.equals(intent.getAction())) {
                         // TODO(qinmin): Alternatively, we can delete the downloaded content on
                         // SD card, and remove the download ID from the SharedPreferences so we
                         // don't need to restart the browser process. http://crbug.com/579643.
                         cancelNotification(entry.notificationId, entry.id);
                         downloadServiceDelegate.cancelDownload(entry.id, entry.isOffTheRecord);
                         for (Observer observer : mObservers) {
                             observer.onDownloadCanceled(entry.id);
                         }
                 } else if (ACTION_DOWNLOAD_PAUSE.equals(intent.getAction())) {
-                    notifyDownloadPaused(entry.id, true, false, entry.isTransient);
+                    // TODO(dtrainor): Shouldwe just hit the delegate and rely on that to update the

[nyquist, 2017/04/13 05:08:24]

Nit: "Should we" here and below.
Or rewrite and do something like: "Consider hitting the delegate and rely on
that to update the state."

[David Trainor- moved to gerrit, 2017/04/13 07:20:23]

Done.

+                    // state?
+                    notifyDownloadPaused(entry.id, true, false, entry.isTransient, null);
                     downloadServiceDelegate.pauseDownload(entry.id, entry.isOffTheRecord);
                 } else if (ACTION_DOWNLOAD_RESUME.equals(intent.getAction())) {
+                    // TODO(dtrainor): Shouldwe just hit the delegate and rely on that to update the
+                    // state?
                     notifyDownloadPending(entry.id, entry.fileName, entry.isOffTheRecord,
-                            entry.canDownloadWhileMetered, entry.isTransient);
+                            entry.canDownloadWhileMetered, entry.isTransient, null);
                     downloadServiceDelegate.resumeDownload(
                             entry.id, entry.buildDownloadItem(), true);
                 } else if (ACTION_DOWNLOAD_RESUME_ALL.equals(intent.getAction())) {
                         assert entry == null;
                         resumeAllPendingDownloads();
                 } else if (ACTION_DOWNLOAD_OPEN.equals(intent.getAction())) {
                     ContentId id = getContentIdFromIntent(intent);
                     if (LegacyHelpers.isLegacyOfflinePage(id)) {
                         OfflinePageDownloadBridge.openDownloadedPage(id);
                     }
@@ skipping 146 matching lines @@
      */
     public void resumeAllPendingDownloads() {
         if (!DownloadManagerService.hasDownloadManagerService()) return;
         List<DownloadSharedPreferenceEntry> entries = mDownloadSharedPreferenceHelper.getEntries();
         for (int i = 0; i < entries.size(); ++i) {
             DownloadSharedPreferenceEntry entry = entries.get(i);
             if (!canResumeDownload(mContext, entry)) continue;
             if (mDownloadsInProgress.contains(entry.id)) continue;
 
             notifyDownloadPending(entry.id, entry.fileName, false, entry.canDownloadWhileMetered,
-                    entry.isTransient);
+                    entry.isTransient, null);
             DownloadServiceDelegate downloadServiceDelegate = getServiceDelegate(entry.id);
             downloadServiceDelegate.resumeDownload(entry.id, entry.buildDownloadItem(), false);
             downloadServiceDelegate.destroyServiceDelegate();
         }
     }
 
     /**
      * Return the notification ID for the given download {@link ContentId}.
      * @param id the {@link ContentId} of the download.
      * @return notification ID to be used.
@@ skipping 56 matching lines @@
             return context.getString(R.string.remaining_duration_minutes, minutes);
         } else if (minutes > 0) {
             return context.getString(R.string.remaining_duration_one_minute);
         } else if (seconds == 1) {
             return context.getString(R.string.remaining_duration_one_second);
         } else {
             return context.getString(R.string.remaining_duration_seconds, seconds);
         }
     }
 }