offline_items_collection : Added helper class to determine progress

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 38 matching lines @@
 import org.chromium.chrome.browser.notifications.ChromeNotificationBuilder;
 import org.chromium.chrome.browser.notifications.NotificationBuilderFactory;
 import org.chromium.chrome.browser.notifications.NotificationConstants;
 import org.chromium.chrome.browser.notifications.NotificationUmaTracker;
 import org.chromium.chrome.browser.notifications.channels.ChannelDefinitions;
 import org.chromium.chrome.browser.offlinepages.downloads.OfflinePageDownloadBridge;
 import org.chromium.chrome.browser.profiles.Profile;
 import org.chromium.chrome.browser.util.IntentUtils;
 import org.chromium.components.offline_items_collection.ContentId;
 import org.chromium.components.offline_items_collection.LegacyHelpers;
+import org.chromium.components.offline_items_collection.OfflineItem.Progress;
 import org.chromium.content.browser.BrowserStartupController;
 
 import java.util.ArrayList;
 import java.util.List;
-import java.util.concurrent.TimeUnit;
 
 /**
  * Service responsible for creating and updating download notifications even after
  * Chrome gets killed.
  *
  * On O and above, this service will receive {@link Service#startForeground(int, Notification)}
  * calls when containing active downloads.  The foreground notification will be the summary
  * notification generated by {@link DownloadNotificationService#buildSummaryNotification(Context)}.
  * The service will receive a {@link Service#stopForeground(boolean)} call when all active downloads
  * are paused.  The summary notification will be hidden when there are no other notifications in the
@@ skipping 30 matching lines @@
     private static final String TAG = "DownloadNotification";
     // Limit file name to 25 characters. TODO(qinmin): use different limit for different devices?
     private static final int MAX_FILE_NAME_LENGTH = 25;
 
     /** Notification Id starting value, to avoid conflicts from IDs used in prior versions. */
 
     private static final String EXTRA_NOTIFICATION_BUNDLE_ICON_ID =
             "Chrome.NotificationBundleIconIdExtra";
     private static final int STARTING_NOTIFICATION_ID = 1000000;
     private static final int MAX_RESUMPTION_ATTEMPT_LEFT = 5;
-    @VisibleForTesting static final long SECONDS_PER_MINUTE = TimeUnit.MINUTES.toSeconds(1);
-    @VisibleForTesting static final long SECONDS_PER_HOUR = TimeUnit.HOURS.toSeconds(1);
-    @VisibleForTesting static final long SECONDS_PER_DAY = TimeUnit.DAYS.toSeconds(1);
 
     private static final String KEY_AUTO_RESUMPTION_ATTEMPT_LEFT = "ResumptionAttemptLeft";
     private static final String KEY_NEXT_DOWNLOAD_NOTIFICATION_ID = "NextDownloadNotificationId";
 
     /**
      * An Observer interface that allows other classes to know when this class is canceling
      * downloads.
      */
     public interface Observer {
         /**
@@ skipping 604 matching lines @@
         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 progress                The current download progress.
      * @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 icon                    A {@link Bitmap} to be used as the large icon for display.
      */
     @VisibleForTesting
-    public void notifyDownloadProgress(ContentId id, String fileName, int percentage,
+    public void notifyDownloadProgress(ContentId id, String fileName, Progress progress,
             long bytesReceived, long timeRemainingInMillis, long startTime, boolean isOffTheRecord,
             boolean canDownloadWhileMetered, boolean isTransient, Bitmap icon) {
-        updateActiveDownloadNotification(id, fileName, percentage, bytesReceived,
+        updateActiveDownloadNotification(id, fileName, progress, bytesReceived,
                 timeRemainingInMillis, startTime, isOffTheRecord, canDownloadWhileMetered, false,
                 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 canDownloadWhileMetered Whether the download can happen in metered network.
      * @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, Bitmap icon) {
-        updateActiveDownloadNotification(id, fileName,
-                DownloadItem.INDETERMINATE_DOWNLOAD_PERCENTAGE, 0, 0, 0, isOffTheRecord,
-                canDownloadWhileMetered, true, isTransient, icon);
+        updateActiveDownloadNotification(id, fileName, Progress.createIndeterminateProgress(), 0, 0,
+                0, isOffTheRecord, 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 progress                The current download progress.
      * @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 icon                    A {@link Bitmap} to be used as the large icon for display.
      */
-    private void updateActiveDownloadNotification(ContentId id, String fileName, int percentage,
+    private void updateActiveDownloadNotification(ContentId id, String fileName, Progress progress,
             long bytesReceived, long timeRemainingInMillis, long startTime, boolean isOffTheRecord,
             boolean canDownloadWhileMetered, boolean isDownloadPending, boolean isTransient,
             Bitmap icon) {
-        boolean indeterminate =
-                (percentage == DownloadItem.INDETERMINATE_DOWNLOAD_PERCENTAGE) || isDownloadPending;
+        boolean indeterminate = (progress.isIndeterminate() || isDownloadPending);
         String contentText = null;
         if (isDownloadPending) {
             contentText = mContext.getResources().getString(R.string.download_notification_pending);
-        } else if (indeterminate) {
+        } else if (indeterminate || timeRemainingInMillis < 0) {
             // 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 {
-            contentText = timeRemainingInMillis < 0
-                    ? mContext.getResources().getString(R.string.download_started)
-                    : formatRemainingTime(mContext, timeRemainingInMillis);
+            contentText = DownloadUtils.getTimeOrFilesLeftString(
+                    mContext, progress, timeRemainingInMillis);
         }
         int resId = isDownloadPending ? R.drawable.ic_download_pending
                 : android.R.drawable.stat_sys_download;
         ChromeNotificationBuilder builder = buildNotification(resId, fileName, contentText);
         builder.setOngoing(true);
         builder.setPriority(Notification.PRIORITY_HIGH);
 
         // Avoid animations while the download isn't progressing.
         if (!isDownloadPending) {
-            builder.setProgress(100, percentage, indeterminate);
+            builder.setProgress(100, indeterminate ? -1 : progress.getPercentage(), indeterminate);
         }
 
         if (!indeterminate && !LegacyHelpers.isLegacyOfflinePage(id)) {
-            String percentText = DownloadUtils.getPercentageString(percentage);
+            String percentText = DownloadUtils.getPercentageString(progress.getPercentage());
             if (Build.VERSION.CODENAME.equals("N")
                     || Build.VERSION.SDK_INT > Build.VERSION_CODES.M) {
                 builder.setSubText(percentText);
             } else {
                 builder.setContentInfo(percentText);
             }
         }
         int notificationId = getNotificationId(id);
         if (startTime > 0) builder.setWhen(startTime);
 
@@ skipping 579 matching lines @@
                 mDownloadSharedPreferenceHelper.getDownloadSharedPreferenceEntry(id);
         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(KEY_NEXT_DOWNLOAD_NOTIFICATION_ID, mNextNotificationId);
         editor.apply();
         return notificationId;
     }
-
-    /**
-     * Format remaining time for the given millis, in the following format:
-     * 5 hours; will include 1 unit, can go down to seconds precision.
-     * This is similar to what android.java.text.Formatter.formatShortElapsedTime() does. Don't use
-     * ui::TimeFormat::Simple() as it is very expensive.
-     *
-     * @param context the application context.
-     * @param millis the remaining time in milli seconds.
-     * @return the formatted remaining time.
-     */
-    public static String formatRemainingTime(Context context, long millis) {
-        long secondsLong = millis / 1000;
-
-        int days = 0;
-        int hours = 0;
-        int minutes = 0;
-        if (secondsLong >= SECONDS_PER_DAY) {
-            days = (int) (secondsLong / SECONDS_PER_DAY);
-            secondsLong -= days * SECONDS_PER_DAY;
-        }
-        if (secondsLong >= SECONDS_PER_HOUR) {
-            hours = (int) (secondsLong / SECONDS_PER_HOUR);
-            secondsLong -= hours * SECONDS_PER_HOUR;
-        }
-        if (secondsLong >= SECONDS_PER_MINUTE) {
-            minutes = (int) (secondsLong / SECONDS_PER_MINUTE);
-            secondsLong -= minutes * SECONDS_PER_MINUTE;
-        }
-        int seconds = (int) secondsLong;
-
-        if (days >= 2) {
-            days += (hours + 12) / 24;
-            return context.getString(R.string.remaining_duration_days, days);
-        } else if (days > 0) {
-            return context.getString(R.string.remaining_duration_one_day);
-        } else if (hours >= 2) {
-            hours += (minutes + 30) / 60;
-            return context.getString(R.string.remaining_duration_hours, hours);
-        } else if (hours > 0) {
-            return context.getString(R.string.remaining_duration_one_hour);
-        } else if (minutes >= 2) {
-            minutes += (seconds + 30) / 60;
-            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);
-        }
-    }
 }