/* * Copyright (C) 2017 The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package org.mozilla.thirdparty.com.google.android.exoplayer2.offline; import static org.mozilla.thirdparty.com.google.android.exoplayer2.offline.Download.STOP_REASON_NONE; import android.app.Notification; import android.app.Service; import android.content.Context; import android.content.Intent; import android.os.Handler; import android.os.IBinder; import android.os.Looper; import androidx.annotation.Nullable; import androidx.annotation.StringRes; import org.mozilla.thirdparty.com.google.android.exoplayer2.scheduler.Requirements; import org.mozilla.thirdparty.com.google.android.exoplayer2.scheduler.Scheduler; import org.mozilla.thirdparty.com.google.android.exoplayer2.util.Assertions; import org.mozilla.thirdparty.com.google.android.exoplayer2.util.Log; import org.mozilla.thirdparty.com.google.android.exoplayer2.util.NotificationUtil; import org.mozilla.thirdparty.com.google.android.exoplayer2.util.Util; import java.util.HashMap; import java.util.List; import org.checkerframework.checker.nullness.qual.MonotonicNonNull; /** A {@link Service} for downloading media. */ public abstract class DownloadService extends Service { /** * Starts a download service to resume any ongoing downloads. Extras: * *
If {@code foregroundNotificationId} is {@link #FOREGROUND_NOTIFICATION_ID_NONE} then the * service will only ever run in the background. No foreground notification will be displayed and * {@link #getScheduler()} will not be called. * *
If {@code foregroundNotificationId} is not {@link #FOREGROUND_NOTIFICATION_ID_NONE} then the * service will run in the foreground. The foreground notification will be updated at least as * often as the interval specified by {@link #DEFAULT_FOREGROUND_NOTIFICATION_UPDATE_INTERVAL}. * * @param foregroundNotificationId The notification id for the foreground notification, or {@link * #FOREGROUND_NOTIFICATION_ID_NONE} if the service should only ever run in the background. */ protected DownloadService(int foregroundNotificationId) { this(foregroundNotificationId, DEFAULT_FOREGROUND_NOTIFICATION_UPDATE_INTERVAL); } /** * Creates a DownloadService. * * @param foregroundNotificationId The notification id for the foreground notification, or {@link * #FOREGROUND_NOTIFICATION_ID_NONE} if the service should only ever run in the background. * @param foregroundNotificationUpdateInterval The maximum interval between updates to the * foreground notification, in milliseconds. Ignored if {@code foregroundNotificationId} is * {@link #FOREGROUND_NOTIFICATION_ID_NONE}. */ protected DownloadService( int foregroundNotificationId, long foregroundNotificationUpdateInterval) { this( foregroundNotificationId, foregroundNotificationUpdateInterval, /* channelId= */ null, /* channelNameResourceId= */ 0, /* channelDescriptionResourceId= */ 0); } /** @deprecated Use {@link #DownloadService(int, long, String, int, int)}. */ @Deprecated protected DownloadService( int foregroundNotificationId, long foregroundNotificationUpdateInterval, @Nullable String channelId, @StringRes int channelNameResourceId) { this( foregroundNotificationId, foregroundNotificationUpdateInterval, channelId, channelNameResourceId, /* channelDescriptionResourceId= */ 0); } /** * Creates a DownloadService. * * @param foregroundNotificationId The notification id for the foreground notification, or {@link * #FOREGROUND_NOTIFICATION_ID_NONE} if the service should only ever run in the background. * @param foregroundNotificationUpdateInterval The maximum interval between updates to the * foreground notification, in milliseconds. Ignored if {@code foregroundNotificationId} is * {@link #FOREGROUND_NOTIFICATION_ID_NONE}. * @param channelId An id for a low priority notification channel to create, or {@code null} if * the app will take care of creating a notification channel if needed. If specified, must be * unique per package. The value may be truncated if it's too long. Ignored if {@code * foregroundNotificationId} is {@link #FOREGROUND_NOTIFICATION_ID_NONE}. * @param channelNameResourceId A string resource identifier for the user visible name of the * notification channel. The recommended maximum length is 40 characters. The value may be * truncated if it's too long. Ignored if {@code channelId} is null or if {@code * foregroundNotificationId} is {@link #FOREGROUND_NOTIFICATION_ID_NONE}. * @param channelDescriptionResourceId A string resource identifier for the user visible * description of the notification channel, or 0 if no description is provided. The * recommended maximum length is 300 characters. The value may be truncated if it is too long. * Ignored if {@code channelId} is null or if {@code foregroundNotificationId} is {@link * #FOREGROUND_NOTIFICATION_ID_NONE}. */ protected DownloadService( int foregroundNotificationId, long foregroundNotificationUpdateInterval, @Nullable String channelId, @StringRes int channelNameResourceId, @StringRes int channelDescriptionResourceId) { if (foregroundNotificationId == FOREGROUND_NOTIFICATION_ID_NONE) { this.foregroundNotificationUpdater = null; this.channelId = null; this.channelNameResourceId = 0; this.channelDescriptionResourceId = 0; } else { this.foregroundNotificationUpdater = new ForegroundNotificationUpdater( foregroundNotificationId, foregroundNotificationUpdateInterval); this.channelId = channelId; this.channelNameResourceId = channelNameResourceId; this.channelDescriptionResourceId = channelDescriptionResourceId; } } /** * Builds an {@link Intent} for adding a new download. * * @param context A {@link Context}. * @param clazz The concrete download service being targeted by the intent. * @param downloadRequest The request to be executed. * @param foreground Whether this intent will be used to start the service in the foreground. * @return The created intent. */ public static Intent buildAddDownloadIntent( Context context, Class extends DownloadService> clazz, DownloadRequest downloadRequest, boolean foreground) { return buildAddDownloadIntent(context, clazz, downloadRequest, STOP_REASON_NONE, foreground); } /** * Builds an {@link Intent} for adding a new download. * * @param context A {@link Context}. * @param clazz The concrete download service being targeted by the intent. * @param downloadRequest The request to be executed. * @param stopReason An initial stop reason for the download, or {@link Download#STOP_REASON_NONE} * if the download should be started. * @param foreground Whether this intent will be used to start the service in the foreground. * @return The created intent. */ public static Intent buildAddDownloadIntent( Context context, Class extends DownloadService> clazz, DownloadRequest downloadRequest, int stopReason, boolean foreground) { return getIntent(context, clazz, ACTION_ADD_DOWNLOAD, foreground) .putExtra(KEY_DOWNLOAD_REQUEST, downloadRequest) .putExtra(KEY_STOP_REASON, stopReason); } /** * Builds an {@link Intent} for removing the download with the {@code id}. * * @param context A {@link Context}. * @param clazz The concrete download service being targeted by the intent. * @param id The content id. * @param foreground Whether this intent will be used to start the service in the foreground. * @return The created intent. */ public static Intent buildRemoveDownloadIntent( Context context, Class extends DownloadService> clazz, String id, boolean foreground) { return getIntent(context, clazz, ACTION_REMOVE_DOWNLOAD, foreground) .putExtra(KEY_CONTENT_ID, id); } /** * Builds an {@link Intent} for removing all downloads. * * @param context A {@link Context}. * @param clazz The concrete download service being targeted by the intent. * @param foreground Whether this intent will be used to start the service in the foreground. * @return The created intent. */ public static Intent buildRemoveAllDownloadsIntent( Context context, Class extends DownloadService> clazz, boolean foreground) { return getIntent(context, clazz, ACTION_REMOVE_ALL_DOWNLOADS, foreground); } /** * Builds an {@link Intent} for resuming all downloads. * * @param context A {@link Context}. * @param clazz The concrete download service being targeted by the intent. * @param foreground Whether this intent will be used to start the service in the foreground. * @return The created intent. */ public static Intent buildResumeDownloadsIntent( Context context, Class extends DownloadService> clazz, boolean foreground) { return getIntent(context, clazz, ACTION_RESUME_DOWNLOADS, foreground); } /** * Builds an {@link Intent} to pause all downloads. * * @param context A {@link Context}. * @param clazz The concrete download service being targeted by the intent. * @param foreground Whether this intent will be used to start the service in the foreground. * @return The created intent. */ public static Intent buildPauseDownloadsIntent( Context context, Class extends DownloadService> clazz, boolean foreground) { return getIntent(context, clazz, ACTION_PAUSE_DOWNLOADS, foreground); } /** * Builds an {@link Intent} for setting the stop reason for one or all downloads. To clear the * stop reason, pass {@link Download#STOP_REASON_NONE}. * * @param context A {@link Context}. * @param clazz The concrete download service being targeted by the intent. * @param id The content id, or {@code null} to set the stop reason for all downloads. * @param stopReason An application defined stop reason. * @param foreground Whether this intent will be used to start the service in the foreground. * @return The created intent. */ public static Intent buildSetStopReasonIntent( Context context, Class extends DownloadService> clazz, @Nullable String id, int stopReason, boolean foreground) { return getIntent(context, clazz, ACTION_SET_STOP_REASON, foreground) .putExtra(KEY_CONTENT_ID, id) .putExtra(KEY_STOP_REASON, stopReason); } /** * Builds an {@link Intent} for setting the requirements that need to be met for downloads to * progress. * * @param context A {@link Context}. * @param clazz The concrete download service being targeted by the intent. * @param requirements A {@link Requirements}. * @param foreground Whether this intent will be used to start the service in the foreground. * @return The created intent. */ public static Intent buildSetRequirementsIntent( Context context, Class extends DownloadService> clazz, Requirements requirements, boolean foreground) { return getIntent(context, clazz, ACTION_SET_REQUIREMENTS, foreground) .putExtra(KEY_REQUIREMENTS, requirements); } /** * Starts the service if not started already and adds a new download. * * @param context A {@link Context}. * @param clazz The concrete download service to be started. * @param downloadRequest The request to be executed. * @param foreground Whether the service is started in the foreground. */ public static void sendAddDownload( Context context, Class extends DownloadService> clazz, DownloadRequest downloadRequest, boolean foreground) { Intent intent = buildAddDownloadIntent(context, clazz, downloadRequest, foreground); startService(context, intent, foreground); } /** * Starts the service if not started already and adds a new download. * * @param context A {@link Context}. * @param clazz The concrete download service to be started. * @param downloadRequest The request to be executed. * @param stopReason An initial stop reason for the download, or {@link Download#STOP_REASON_NONE} * if the download should be started. * @param foreground Whether the service is started in the foreground. */ public static void sendAddDownload( Context context, Class extends DownloadService> clazz, DownloadRequest downloadRequest, int stopReason, boolean foreground) { Intent intent = buildAddDownloadIntent(context, clazz, downloadRequest, stopReason, foreground); startService(context, intent, foreground); } /** * Starts the service if not started already and removes a download. * * @param context A {@link Context}. * @param clazz The concrete download service to be started. * @param id The content id. * @param foreground Whether the service is started in the foreground. */ public static void sendRemoveDownload( Context context, Class extends DownloadService> clazz, String id, boolean foreground) { Intent intent = buildRemoveDownloadIntent(context, clazz, id, foreground); startService(context, intent, foreground); } /** * Starts the service if not started already and removes all downloads. * * @param context A {@link Context}. * @param clazz The concrete download service to be started. * @param foreground Whether the service is started in the foreground. */ public static void sendRemoveAllDownloads( Context context, Class extends DownloadService> clazz, boolean foreground) { Intent intent = buildRemoveAllDownloadsIntent(context, clazz, foreground); startService(context, intent, foreground); } /** * Starts the service if not started already and resumes all downloads. * * @param context A {@link Context}. * @param clazz The concrete download service to be started. * @param foreground Whether the service is started in the foreground. */ public static void sendResumeDownloads( Context context, Class extends DownloadService> clazz, boolean foreground) { Intent intent = buildResumeDownloadsIntent(context, clazz, foreground); startService(context, intent, foreground); } /** * Starts the service if not started already and pauses all downloads. * * @param context A {@link Context}. * @param clazz The concrete download service to be started. * @param foreground Whether the service is started in the foreground. */ public static void sendPauseDownloads( Context context, Class extends DownloadService> clazz, boolean foreground) { Intent intent = buildPauseDownloadsIntent(context, clazz, foreground); startService(context, intent, foreground); } /** * Starts the service if not started already and sets the stop reason for one or all downloads. To * clear stop reason, pass {@link Download#STOP_REASON_NONE}. * * @param context A {@link Context}. * @param clazz The concrete download service to be started. * @param id The content id, or {@code null} to set the stop reason for all downloads. * @param stopReason An application defined stop reason. * @param foreground Whether the service is started in the foreground. */ public static void sendSetStopReason( Context context, Class extends DownloadService> clazz, @Nullable String id, int stopReason, boolean foreground) { Intent intent = buildSetStopReasonIntent(context, clazz, id, stopReason, foreground); startService(context, intent, foreground); } /** * Starts the service if not started already and sets the requirements that need to be met for * downloads to progress. * * @param context A {@link Context}. * @param clazz The concrete download service to be started. * @param requirements A {@link Requirements}. * @param foreground Whether the service is started in the foreground. */ public static void sendSetRequirements( Context context, Class extends DownloadService> clazz, Requirements requirements, boolean foreground) { Intent intent = buildSetRequirementsIntent(context, clazz, requirements, foreground); startService(context, intent, foreground); } /** * Starts a download service to resume any ongoing downloads. * * @param context A {@link Context}. * @param clazz The concrete download service to be started. * @see #startForeground(Context, Class) */ public static void start(Context context, Class extends DownloadService> clazz) { context.startService(getIntent(context, clazz, ACTION_INIT)); } /** * Starts the service in the foreground without adding a new download request. If there are any * not finished downloads and the requirements are met, the service resumes downloading. Otherwise * it stops immediately. * * @param context A {@link Context}. * @param clazz The concrete download service to be started. * @see #start(Context, Class) */ public static void startForeground(Context context, Class extends DownloadService> clazz) { Intent intent = getIntent(context, clazz, ACTION_INIT, true); Util.startForegroundService(context, intent); } @Override public void onCreate() { if (channelId != null) { NotificationUtil.createNotificationChannel( this, channelId, channelNameResourceId, channelDescriptionResourceId, NotificationUtil.IMPORTANCE_LOW); } Class extends DownloadService> clazz = getClass(); @Nullable DownloadManagerHelper downloadManagerHelper = downloadManagerHelpers.get(clazz); if (downloadManagerHelper == null) { boolean foregroundAllowed = foregroundNotificationUpdater != null; @Nullable Scheduler scheduler = foregroundAllowed ? getScheduler() : null; downloadManager = getDownloadManager(); downloadManager.resumeDownloads(); downloadManagerHelper = new DownloadManagerHelper( getApplicationContext(), downloadManager, foregroundAllowed, scheduler, clazz); downloadManagerHelpers.put(clazz, downloadManagerHelper); } else { downloadManager = downloadManagerHelper.downloadManager; } downloadManagerHelper.attachService(this); } @Override public int onStartCommand(@Nullable Intent intent, int flags, int startId) { lastStartId = startId; taskRemoved = false; @Nullable String intentAction = null; @Nullable String contentId = null; if (intent != null) { intentAction = intent.getAction(); contentId = intent.getStringExtra(KEY_CONTENT_ID); startedInForeground |= intent.getBooleanExtra(KEY_FOREGROUND, false) || ACTION_RESTART.equals(intentAction); } // intentAction is null if the service is restarted or no action is specified. if (intentAction == null) { intentAction = ACTION_INIT; } DownloadManager downloadManager = Assertions.checkNotNull(this.downloadManager); switch (intentAction) { case ACTION_INIT: case ACTION_RESTART: // Do nothing. break; case ACTION_ADD_DOWNLOAD: @Nullable DownloadRequest downloadRequest = Assertions.checkNotNull(intent).getParcelableExtra(KEY_DOWNLOAD_REQUEST); if (downloadRequest == null) { Log.e(TAG, "Ignored ADD_DOWNLOAD: Missing " + KEY_DOWNLOAD_REQUEST + " extra"); } else { int stopReason = intent.getIntExtra(KEY_STOP_REASON, Download.STOP_REASON_NONE); downloadManager.addDownload(downloadRequest, stopReason); } break; case ACTION_REMOVE_DOWNLOAD: if (contentId == null) { Log.e(TAG, "Ignored REMOVE_DOWNLOAD: Missing " + KEY_CONTENT_ID + " extra"); } else { downloadManager.removeDownload(contentId); } break; case ACTION_REMOVE_ALL_DOWNLOADS: downloadManager.removeAllDownloads(); break; case ACTION_RESUME_DOWNLOADS: downloadManager.resumeDownloads(); break; case ACTION_PAUSE_DOWNLOADS: downloadManager.pauseDownloads(); break; case ACTION_SET_STOP_REASON: if (!Assertions.checkNotNull(intent).hasExtra(KEY_STOP_REASON)) { Log.e(TAG, "Ignored SET_STOP_REASON: Missing " + KEY_STOP_REASON + " extra"); } else { int stopReason = intent.getIntExtra(KEY_STOP_REASON, /* defaultValue= */ 0); downloadManager.setStopReason(contentId, stopReason); } break; case ACTION_SET_REQUIREMENTS: @Nullable Requirements requirements = Assertions.checkNotNull(intent).getParcelableExtra(KEY_REQUIREMENTS); if (requirements == null) { Log.e(TAG, "Ignored SET_REQUIREMENTS: Missing " + KEY_REQUIREMENTS + " extra"); } else { downloadManager.setRequirements(requirements); } break; default: Log.e(TAG, "Ignored unrecognized action: " + intentAction); break; } if (Util.SDK_INT >= 26 && startedInForeground && foregroundNotificationUpdater != null) { // From API level 26, services started in the foreground are required to show a notification. foregroundNotificationUpdater.showNotificationIfNotAlready(); } isStopped = false; if (downloadManager.isIdle()) { stop(); } return START_STICKY; } @Override public void onTaskRemoved(Intent rootIntent) { taskRemoved = true; } @Override public void onDestroy() { isDestroyed = true; DownloadManagerHelper downloadManagerHelper = Assertions.checkNotNull(downloadManagerHelpers.get(getClass())); downloadManagerHelper.detachService(this); if (foregroundNotificationUpdater != null) { foregroundNotificationUpdater.stopPeriodicUpdates(); } } /** * Throws {@link UnsupportedOperationException} because this service is not designed to be bound. */ @Nullable @Override public final IBinder onBind(Intent intent) { throw new UnsupportedOperationException(); } /** * Returns a {@link DownloadManager} to be used to downloaded content. Called only once in the * life cycle of the process. */ protected abstract DownloadManager getDownloadManager(); /** * Returns a {@link Scheduler} to restart the service when requirements allowing downloads to take * place are met. If {@code null}, the service will only be restarted if the process is still in * memory when the requirements are met. * *
This method is not called for services whose {@code foregroundNotificationId} is set to * {@link #FOREGROUND_NOTIFICATION_ID_NONE}. Such services will only be restarted if the process * is still in memory and considered non-idle, meaning that it's either in the foreground or was * backgrounded within the last few minutes. */ @Nullable protected abstract Scheduler getScheduler(); /** * Returns a notification to be displayed when this service running in the foreground. * *
Download services that do not wish to run in the foreground should be created by setting the
* {@code foregroundNotificationId} constructor argument to {@link
* #FOREGROUND_NOTIFICATION_ID_NONE}. This method is not called for such services, meaning it can
* be implemented to throw {@link UnsupportedOperationException}.
*
* @param downloads The current downloads.
* @return The foreground notification to display.
*/
protected abstract Notification getForegroundNotification(List