offline_items_collection : Added helper class to determine progress

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

 // Copyright 2016 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.Activity;
 import android.app.PendingIntent;
 import android.content.ActivityNotFoundException;
 import android.content.Context;
@@ skipping 33 matching lines @@
 import org.chromium.chrome.browser.offlinepages.OfflinePageBridge;
 import org.chromium.chrome.browser.offlinepages.OfflinePageUtils;
 import org.chromium.chrome.browser.offlinepages.downloads.OfflinePageDownloadBridge;
 import org.chromium.chrome.browser.profiles.Profile;
 import org.chromium.chrome.browser.tab.Tab;
 import org.chromium.chrome.browser.tabmodel.TabModel.TabLaunchType;
 import org.chromium.chrome.browser.tabmodel.document.TabDelegate;
 import org.chromium.chrome.browser.util.IntentUtils;
 import org.chromium.components.feature_engagement_tracker.EventConstants;
 import org.chromium.components.feature_engagement_tracker.FeatureEngagementTracker;
+import org.chromium.components.offline_items_collection.OfflineItem.Progress;
+import org.chromium.components.offline_items_collection.OfflineItemProgressUnit;
 import org.chromium.content_public.browser.DownloadState;
 import org.chromium.content_public.browser.LoadUrlParams;
 import org.chromium.ui.base.DeviceFormFactor;
 import org.chromium.ui.widget.Toast;
 
 import java.io.File;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.text.NumberFormat;
 import java.util.ArrayList;
 import java.util.Calendar;
 import java.util.Date;
 import java.util.List;
 import java.util.Locale;
+import java.util.concurrent.TimeUnit;
 
 /**
  * A class containing some utility static methods.
  */
 public class DownloadUtils {
 
     /** Strings indicating how many bytes have been downloaded for different units. */
     @VisibleForTesting
     static final int[] BYTES_DOWNLOADED_STRINGS = {
         R.string.file_size_downloaded_kb,
         R.string.file_size_downloaded_mb,
         R.string.file_size_downloaded_gb
     };
 
     private static final String TAG = "download";
 
     private static final String DEFAULT_MIME_TYPE = "*/*";
     private static final String MIME_TYPE_DELIMITER = "/";
     private static final String MIME_TYPE_VIDEO = "video";
 
     private static final String EXTRA_IS_OFF_THE_RECORD =
             "org.chromium.chrome.browser.download.IS_OFF_THE_RECORD";
 
     private static final long BYTES_PER_KILOBYTE = 1024;
     private static final long BYTES_PER_MEGABYTE = 1024 * 1024;
     private static final long BYTES_PER_GIGABYTE = 1024 * 1024 * 1024;
 
     @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);
+
+    @VisibleForTesting
     static final String ELLIPSIS = "\u2026";
 
     /**
      * Possible sizes of type-based icons.
      */
     @IntDef({ICON_SIZE_24_DP, ICON_SIZE_36_DP})
     @Retention(RetentionPolicy.SOURCE)
     public @interface IconSize {}
 
     public static final int ICON_SIZE_24_DP = 24;
@@ skipping 462 matching lines @@
      * Create a string that represents the percentage of the file that has downloaded.
      * @param percentage Current percentage of the file.
      * @return String representing the percentage of the file that has been downloaded.
      */
     public static String getPercentageString(int percentage) {
         NumberFormat formatter = NumberFormat.getPercentInstance(Locale.getDefault());
         return formatter.format(percentage / 100.0);
     }
 
     /**
+     * Creates a string that shows the time left or number of files left.
+     * @param context The application context.
+     * @param progress The download progress.
+     * @param timeRemainingInMillis The remaining time in milli seconds.
+     * @return Formatted string representing the time left or the number of files left.
+     */
+    public static String getTimeOrFilesLeftString(

[David Trainor- moved to gerrit, 2017/05/09 05:36:01]

Should this just create the string completely and not just for files or time? 
If it's different for notifications and downloads home, should we just have two
different methods?

Just a nit, I'm fine either way.

[shaktisahu, 2017/05/09 19:04:31]

Yes, the strings are different for notifications and downloads home. Not sure if
making two separate methods in DownloadUtils would look better though.

+            Context context, Progress progress, long timeRemainingInMillis) {
+        if (progress.unit == OfflineItemProgressUnit.FILES) {
+            return formatRemainingFiles(context, progress);
+        } else {
+            return formatRemainingTime(context, timeRemainingInMillis);
+        }
+    }
+
+    /**
+     * Creates a string that represents the number of files left to be downloaded.
+     * @param progress Current download progress.
+     * @return String representing the number of files left.
+     */
+    public static String formatRemainingFiles(Context context, Progress progress) {
+        int filesLeft = (int) (progress.max - progress.value);
+        if (filesLeft == 1) {
+            return context.getResources().getString(R.string.one_file_left);
+        } else {
+            return context.getResources().getString(R.string.files_left, filesLeft);
+        }
+    }
+
+    /**
+     * 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.
+     */
+    @VisibleForTesting
+    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);
+        }
+    }
+
+    /**
      * Determine what String to show for a given download.
      * @param item Download to check the status of.
-     * @return ID of a String resource to use, or 0 if the status couldn't be determined.
+     * @return String representing the current download status.
      */
     public static String getStatusString(DownloadItem item) {
         Context context = ContextUtils.getApplicationContext();
         DownloadInfo info = item.getDownloadInfo();
+        Progress progress = info.getProgress();
 
         int state = info.state();
         if (state == DownloadState.COMPLETE) {
             return context.getString(R.string.download_notification_completed);
         }
 
         DownloadSharedPreferenceHelper helper = DownloadSharedPreferenceHelper.getInstance();
         DownloadSharedPreferenceEntry entry =
                 helper.getDownloadSharedPreferenceEntry(item.getContentId());
         boolean isDownloadPending =
                 entry != null && state == DownloadState.INTERRUPTED && entry.isAutoResumable;
 
         if (isDownloadPending) {
             return context.getString(R.string.download_notification_pending);
         } else if (isDownloadPaused(item)) {
             return context.getString(R.string.download_notification_paused);
         }
 
         if (info.getBytesReceived() == 0
                 || (!item.isIndeterminate() && info.getTimeRemainingInMillis() < 0)) {
             // We lack enough information about the download to display a useful string.
             return context.getString(R.string.download_started);
         } else if (item.isIndeterminate()) {
             // Count up the bytes.
             long bytes = info.getBytesReceived();
             return DownloadUtils.getStringForDownloadedBytes(context, bytes);
         } else {
-            // Count down the time.
-            long msRemaining = info.getTimeRemainingInMillis();
-            return DownloadNotificationService.formatRemainingTime(context, msRemaining);
+            // Count down the time or number of files.
+            return getTimeOrFilesLeftString(context, progress, info.getTimeRemainingInMillis());
         }
     }
 
     /**
      * Query the Download backends about whether a download is paused.
      *
      * The Java-side contains more information about the status of a download than is persisted
      * by the native backend, so it is queried first.
      *
      * @param item Download to check the status of.
@@ skipping 151 matching lines @@
     public static Date getDateAtMidnight(long timestamp) {
         Calendar cal = Calendar.getInstance();
         cal.setTimeInMillis(timestamp);
         cal.set(Calendar.HOUR_OF_DAY, 0);
         cal.set(Calendar.MINUTE, 0);
         cal.set(Calendar.SECOND, 0);
         cal.set(Calendar.MILLISECOND, 0);
         return cal.getTime();
     }
 }