deprecate notificationId for downloads

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.app.Notification;
 import android.app.NotificationManager;
 import android.app.PendingIntent;
 import android.app.Service;
@@ skipping 35 matching lines @@
     static final String EXTRA_DOWNLOAD_FILE_NAME = "DownloadFileName";
     static final String ACTION_DOWNLOAD_CANCEL =
             "org.chromium.chrome.browser.download.DOWNLOAD_CANCEL";
     static final String ACTION_DOWNLOAD_PAUSE =
             "org.chromium.chrome.browser.download.DOWNLOAD_PAUSE";
     static final String ACTION_DOWNLOAD_RESUME =
             "org.chromium.chrome.browser.download.DOWNLOAD_RESUME";
     static final int INVALID_DOWNLOAD_PERCENTAGE = -1;
     @VisibleForTesting
     static final String PENDING_DOWNLOAD_NOTIFICATIONS = "PendingDownloadNotifications";
-    private static final String NOTIFICATION_NAMESPACE = "DownloadNotificationService";
+    static final String NOTIFICATION_NAMESPACE = "DownloadNotificationService";

[Ted C, 2016/05/20 00:02:13]

rename DEPRECATED?

[qinmin, 2016/05/23 23:03:14]

There is no need to deprecate it. See reasons below

     private static final String TAG = "DownloadNotification";
+    private static final String NEXT_DOWNLOAD_NOTIFICATION_ID = "NextDownloadNotificationId";

[Ted C, 2016/05/20 00:02:13]

Instead of Next, I would use V2

[qinmin, 2016/05/23 23:03:13]

Since I am keeping the namespace, V2 is probably not very suitable.

[Ted C, 2016/05/23 23:15:23]

got it...I was thinking it was a namespace...do'h

+    // Notification Id starting value, to avoid conflicts from IDs used in prior versions.
+    private static final int STARTING_NOTIFICATION_ID = 1000000;

[Ted C, 2016/05/20 00:02:13]

any reason we don't use a different notification namespace?  couldn't we just
clear all notifications in the previous namespace and then add new ones w/o
having to worry about the id collision possibilities?

[qinmin, 2016/05/23 23:03:14]

If we clear all existing notifications, we have to recreate these notifications
with new namespace so that user won't lose paused downloads.
However,recreate notification requires us to read the intent from the existing
notification. That requires API 18, and BIND_NOTIFICATION_LISTENER_SERVICE
permission, which is not desirable.

     private final IBinder mBinder = new LocalBinder();
     private final List<DownloadSharedPreferenceEntry> mDownloadSharedPreferenceEntries =
             new ArrayList<DownloadSharedPreferenceEntry>();
     private NotificationManager mNotificationManager;
     private SharedPreferences mSharedPrefs;
     private Context mContext;
+    private int mNextNotificationId;
 
     /**
      * Class for clients to access.
      */
     public class LocalBinder extends Binder {
         DownloadNotificationService getService() {
             return DownloadNotificationService.this;
         }
     }
 
@@ skipping 17 matching lines @@
         // onStartCommand(), it will be restarted as soon as resources are available
         // after it is killed. As a result, onCreate() may be called after Chrome
         // gets killed and before user restarts chrome. In that case,
         // DownloadManagerService.hasDownloadManagerService() will return false as
         // there are no calls to initialize DownloadManagerService. Pause all the
         // download notifications as download will not progress without chrome.
         if (!DownloadManagerService.hasDownloadManagerService()) {
             pauseAllDownloads();
             stopSelf();
         }
+        mNextNotificationId = mSharedPrefs.getInt(
+            NEXT_DOWNLOAD_NOTIFICATION_ID, STARTING_NOTIFICATION_ID);

[Ted C, 2016/05/20 00:02:13]

+4 indent

[qinmin, 2016/05/23 23:03:14]

Done.

+
     }
 
     @Override
     public int onStartCommand(final Intent intent, int flags, int startId) {
         if (isDownloadOperationIntent(intent)) {
             handleDownloadOperation(intent);
         }
 
         // This should restart the service after Chrome gets killed. However, this
         // doesn't work on Android 4.4.2.
         return START_STICKY;
     }
 
     @Override
     public IBinder onBind(Intent intent) {
         return mBinder;
     }
 
     /**
      * Add a in-progress download notification.
-     * @param notificationId Notification ID of the download.
      * @param downloadGuid GUID 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 timeRemainingInMillis Remaining download time in milliseconds.
      * @param startTime Time when download started.
      * @param isResumable Whether the download can be resumed.
      * @param canDownloadWhileMetered Whether the download can happen in metered network.
      */
-    public void notifyDownloadProgress(int notificationId, String downloadGuid, String fileName,
-            int percentage, long timeRemainingInMillis, long startTime, boolean isResumable,
+    public void notifyDownloadProgress(String downloadGuid, String fileName, int percentage,
+            long timeRemainingInMillis, long startTime, boolean isResumable,
             boolean canDownloadWhileMetered) {
         boolean indeterminate = percentage == INVALID_DOWNLOAD_PERCENTAGE;
         NotificationCompat.Builder builder = buildNotification(
                 android.R.drawable.stat_sys_download, fileName, null);
         builder.setOngoing(true).setProgress(100, percentage, indeterminate);
         builder.setPriority(Notification.PRIORITY_HIGH);
         if (!indeterminate) {
             NumberFormat formatter = NumberFormat.getPercentInstance(Locale.getDefault());
             String percentText = formatter.format(percentage / 100.0);
             String duration = getDurationString(timeRemainingInMillis);
             builder.setContentText(duration).setContentInfo(percentText);
         }
+        int notificationId = getNotificationId(downloadGuid);
         addOrReplaceSharedPreferenceEntry(new DownloadSharedPreferenceEntry(
                 notificationId, isResumable, canDownloadWhileMetered, downloadGuid, fileName));
         if (startTime > 0) builder.setWhen(startTime);
         builder.addAction(R.drawable.bookmark_cancel_active,
                 mContext.getResources().getString(R.string.download_notification_cancel_button),
                 buildPendingIntent(ACTION_DOWNLOAD_CANCEL, notificationId, downloadGuid, fileName));
         if (isResumable) {
             builder.addAction(R.drawable.ic_vidcontrol_pause,
                     mContext.getResources().getString(R.string.download_notification_pause_button),
                     buildPendingIntent(ACTION_DOWNLOAD_PAUSE, notificationId, downloadGuid,
                             fileName));
         }
         updateNotification(notificationId, builder.build());
     }
 
     /**
      * Converts milliseconds to time remaining format.
      * @param timeRemainingInMillis Remaining download time in milliseconds.
      * @return formatted remaining time string for display.
      */
     @VisibleForTesting
     String getDurationString(long timeRemainingInMillis) {
         return LocalizationUtils.getDurationString(timeRemainingInMillis);
     }
 
     /**
      * Cancel a download notification.
-     * @param notificationId Notification ID of the download.
+     * @notificationId Notification ID of the download
      * @param downloadGuid GUID of the download.
      */
-    public void cancelNotification(int notificationId, String downloadGuid) {
-        mNotificationManager.cancel(NOTIFICATION_NAMESPACE, notificationId);
+    @VisibleForTesting
+    void cancelNotification(int notificaitonId, String downloadGuid) {
+        mNotificationManager.cancel(NOTIFICATION_NAMESPACE, notificaitonId);
         removeSharedPreferenceEntry(downloadGuid);
     }
 
     /**
+     * Called when a download is canceled.
+     * @param downloadGuid GUID of the download.
+     */
+    public void notifyDownloadCanceled(String downloadGuid) {
+        DownloadSharedPreferenceEntry entry = getDownloadSharedPreferenceEntry(downloadGuid);
+        if (entry == null) return;
+        cancelNotification(entry.notificationId, downloadGuid);
+    }
+
+    /**
      * Change a download notification to paused state.
      * @param downloadGuid GUID of the download.
      * @param isAutoResumable whether download is can be resumed automatically.
      */
     public void notifyDownloadPaused(String downloadGuid, boolean isAutoResumable) {
         DownloadSharedPreferenceEntry entry = getDownloadSharedPreferenceEntry(downloadGuid);
         if (entry == null) return;
         NotificationCompat.Builder builder = buildNotification(
                 android.R.drawable.ic_media_pause, entry.fileName,
                 mContext.getResources().getString(R.string.download_notification_paused));
@@ skipping 12 matching lines @@
         }
         updateNotification(entry.notificationId, builder.build());
         // If download is not auto resumable, there is no need to keep it in SharedPreferences.
         if (!entry.isResumable || !isAutoResumable) {
             removeSharedPreferenceEntry(downloadGuid);
         }
     }
 
     /**
      * Add a download successful notification.
-     * @param notificationId Notification ID of the download.
      * @param downloadGuid GUID of the download.
      * @param fileName GUID of the download.
      * @param intent Intent to launch when clicking the notification.
+     * @return ID of the successful download notification. Used for removing the notification when
+     *         user click on the snackbar.
      */
-    public void notifyDownloadSuccessful(int notificationId, String downloadGuid, String fileName,
-            Intent intent) {
+    public int notifyDownloadSuccessful(String downloadGuid, String fileName, Intent intent) {
+        int notificationId = getNotificationId(downloadGuid);
         NotificationCompat.Builder builder = buildNotification(
                 android.R.drawable.stat_sys_download_done, fileName,
                 mContext.getResources().getString(R.string.download_notification_completed));
         if (intent != null) {
             builder.setContentIntent(PendingIntent.getActivity(
                     mContext, 0, intent, PendingIntent.FLAG_UPDATE_CURRENT));
         }
         updateNotification(notificationId, builder.build());
         removeSharedPreferenceEntry(downloadGuid);
+        return notificationId;
     }
 
     /**
      * Add a download failed notification.
-     * @param notificationId Notification ID of the download.
      * @param downloadGuid GUID of the download.
      * @param fileName GUID of the download.
      */
-    public void notifyDownloadFailed(int notificationId, String downloadGuid, String fileName) {
+    public void notifyDownloadFailed(String downloadGuid, String fileName) {
+        int notificationId = getNotificationId(downloadGuid);
         NotificationCompat.Builder builder = buildNotification(
                 android.R.drawable.stat_sys_download_done, fileName,
                 mContext.getResources().getString(R.string.download_notification_failed));
         updateNotification(notificationId, builder.build());
         removeSharedPreferenceEntry(downloadGuid);
     }
 
     /**
      * Called to pause all the download notifications.
      */
@@ skipping 87 matching lines @@
                         // 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(notificationId, guid);
                         service.cancelDownload(guid);
                         break;
                     case ACTION_DOWNLOAD_PAUSE:
                         service.pauseDownload(guid);
                         break;
                     case ACTION_DOWNLOAD_RESUME:
                         assert item != null;
-                        notifyDownloadProgress(notificationId, guid, fileName,
-                                INVALID_DOWNLOAD_PERCENTAGE, 0, 0, true,
-                                canDownloadWhileMetered);
+                        notifyDownloadProgress(guid, fileName, INVALID_DOWNLOAD_PERCENTAGE, 0, 0,
+                                true, canDownloadWhileMetered);
                         service.resumeDownload(item, true);
                         break;
                     default:
                         Log.e(TAG, "Unrecognized intent action.", intent);
                         break;
                 }
             }
         };
         try {
             ChromeBrowserInitializer.getInstance(mContext).handlePreNativeStartup(parts);
@@ skipping 86 matching lines @@
      * Resumes all pending downloads from |mDownloadSharedPreferenceEntries|.
      */
     public void resumeAllPendingDownloads() {
         boolean isNetworkMetered = DownloadManagerService.isActiveNetworkMetered(mContext);
         if (!DownloadManagerService.hasDownloadManagerService()) return;
         DownloadManagerService service =
                 DownloadManagerService.getDownloadManagerService(getApplicationContext());
         for (int i = 0; i < mDownloadSharedPreferenceEntries.size(); ++i) {
             DownloadSharedPreferenceEntry entry = mDownloadSharedPreferenceEntries.get(i);
             if (!entry.canDownloadWhileMetered && isNetworkMetered) continue;
-            notifyDownloadProgress(entry.notificationId, entry.downloadGuid, entry.fileName,
-                    INVALID_DOWNLOAD_PERCENTAGE, 0, 0, true, entry.canDownloadWhileMetered);
+            notifyDownloadProgress(entry.downloadGuid, entry.fileName, INVALID_DOWNLOAD_PERCENTAGE,
+                    0, 0, true, entry.canDownloadWhileMetered);
             service.resumeDownload(entry.buildDownloadItem(), false);
         }
     }
 
     /**
      * Parse the DownloadSharedPreferenceEntry from the shared preference and return a list of them.
      * @return a list of parsed DownloadSharedPreferenceEntry.
      */
     void parseDownloadSharedPrefs() {
         if (!mSharedPrefs.contains(PENDING_DOWNLOAD_NOTIFICATIONS)) return;
@@ skipping 27 matching lines @@
      * Helper method to store all the SharedPreferences entries.
      */
     private void storeDownloadSharedPreferenceEntries() {
         Set<String> entries = new HashSet<String>();
         for (int i = 0; i < mDownloadSharedPreferenceEntries.size(); ++i) {
             entries.add(mDownloadSharedPreferenceEntries.get(i).getSharedPreferenceString());
         }
         DownloadManagerService.storeDownloadInfo(
                 mSharedPrefs, PENDING_DOWNLOAD_NOTIFICATIONS, entries);
     }
+
+    /**
+     * Return the notification ID for the given download GUID.
+     * @return notification ID to be used.
+     */
+    private int getNotificationId(String downloadGuid) {
+        DownloadSharedPreferenceEntry entry = getDownloadSharedPreferenceEntry(downloadGuid);
+        if (entry != null) return entry.notificationId;
+        int notificationId = mNextNotificationId;
+        mNextNotificationId = mNextNotificationId == Integer.MAX_VALUE
+                ? STARTING_NOTIFICATION_ID : mNextNotificationId + 1;
+        SharedPreferences.Editor editor = mSharedPrefs.edit();
+        editor.putInt(NEXT_DOWNLOAD_NOTIFICATION_ID, mNextNotificationId);
+        editor.apply();
+        return notificationId;
+    }
 }