From 3813743e3dec3e0fe08a44d0dce8eb929b851886 Mon Sep 17 00:00:00 2001 From: arkon Date: Wed, 29 Jul 2020 21:57:43 -0400 Subject: [PATCH] Split download notifications into progress and complete channels --- .../data/download/DownloadNotifier.kt | 76 +++++++++---------- .../data/download/DownloadService.kt | 2 +- .../data/notification/Notifications.kt | 40 ++++++---- app/src/main/res/values/strings.xml | 8 +- 4 files changed, 67 insertions(+), 59 deletions(-) diff --git a/app/src/main/java/eu/kanade/tachiyomi/data/download/DownloadNotifier.kt b/app/src/main/java/eu/kanade/tachiyomi/data/download/DownloadNotifier.kt index f93b343b1c..c3d14c25bc 100644 --- a/app/src/main/java/eu/kanade/tachiyomi/data/download/DownloadNotifier.kt +++ b/app/src/main/java/eu/kanade/tachiyomi/data/download/DownloadNotifier.kt @@ -13,8 +13,8 @@ import eu.kanade.tachiyomi.util.lang.chop import eu.kanade.tachiyomi.util.system.notificationBuilder import eu.kanade.tachiyomi.util.system.notificationManager import java.util.regex.Pattern -import uy.kohesive.injekt.Injekt import uy.kohesive.injekt.api.get +import uy.kohesive.injekt.injectLazy /** * DownloadNotifier is used to show notifications when downloading one or multiple chapters. @@ -23,16 +23,19 @@ import uy.kohesive.injekt.api.get */ internal class DownloadNotifier(private val context: Context) { - private val notificationBuilder = context.notificationBuilder(Notifications.CHANNEL_DOWNLOADER) { + private val preferences: PreferencesHelper by injectLazy() + + private val progressNotificationBuilder = context.notificationBuilder(Notifications.CHANNEL_DOWNLOADER_PROGRESS) { setLargeIcon(BitmapFactory.decodeResource(context.resources, R.mipmap.ic_launcher)) } - private val preferences by lazy { Injekt.get() } + private val completeNotificationBuilder = context.notificationBuilder(Notifications.CHANNEL_DOWNLOADER_COMPLETE) { + setAutoCancel(false) + } /** * Status of download. Used for correct notification icon. */ - @Volatile private var isDownloading = false /** @@ -57,7 +60,7 @@ internal class DownloadNotifier(private val context: Context) { /** * Clear old actions if they exist. */ - private fun clearActions() = with(notificationBuilder) { + private fun NotificationCompat.Builder.clearActions() { if (mActions.isNotEmpty()) { mActions.clear() } @@ -71,35 +74,13 @@ internal class DownloadNotifier(private val context: Context) { context.notificationManager.cancel(Notifications.ID_DOWNLOAD_CHAPTER) } - /** - * This function shows a notification to inform download tasks are done. - */ - fun downloadFinished() { - // Create notification - with(notificationBuilder) { - setContentTitle(context.getString(R.string.download_notifier_downloader_title)) - setContentText(context.getString(R.string.download_notifier_download_finish)) - setSmallIcon(android.R.drawable.stat_sys_download_done) - clearActions() - setAutoCancel(true) - setContentIntent(NotificationHandler.openDownloadManagerPendingActivity(context)) - setProgress(0, 0, false) - } - notificationBuilder.show(Notifications.ID_DOWNLOAD_CHAPTER_COMPLETE) - - // Reset states to default - errorThrown = false - isDownloading = false - } - /** * Called when download progress changes. * * @param download download object containing download information. */ fun onProgressChange(download: Download) { - // Create notification - with(notificationBuilder) { + with(progressNotificationBuilder) { // Check if first call. if (!isDownloading) { setSmallIcon(android.R.drawable.stat_sys_download) @@ -132,16 +113,14 @@ internal class DownloadNotifier(private val context: Context) { setProgress(download.pages!!.size, download.downloadedImages, false) } - - // Displays the progress bar on notification - notificationBuilder.show() + progressNotificationBuilder.show() } /** * Show notification when download is paused. */ fun onDownloadPaused() { - with(notificationBuilder) { + with(progressNotificationBuilder) { setContentTitle(context.getString(R.string.chapter_paused)) setContentText(context.getString(R.string.download_notifier_download_paused)) setSmallIcon(R.drawable.ic_pause_24dp) @@ -163,21 +142,40 @@ internal class DownloadNotifier(private val context: Context) { NotificationReceiver.clearDownloadsPendingBroadcast(context) ) } - - // Show notification. - notificationBuilder.show() + progressNotificationBuilder.show() // Reset initial values isDownloading = false } + /** + * This function shows a notification to inform download tasks are done. + */ + fun downloadFinished() { + // Create notification + with(completeNotificationBuilder) { + setContentTitle(context.getString(R.string.download_notifier_downloader_title)) + setContentText(context.getString(R.string.download_notifier_download_finish)) + setSmallIcon(android.R.drawable.stat_sys_download_done) + clearActions() + setAutoCancel(true) + setContentIntent(NotificationHandler.openDownloadManagerPendingActivity(context)) + setProgress(0, 0, false) + } + completeNotificationBuilder.show(Notifications.ID_DOWNLOAD_CHAPTER_COMPLETE) + + // Reset states to default + errorThrown = false + isDownloading = false + } + /** * Called when the downloader receives a warning. * * @param reason the text to show. */ fun onWarning(reason: String) { - with(notificationBuilder) { + with(completeNotificationBuilder) { setContentTitle(context.getString(R.string.download_notifier_downloader_title)) setContentText(reason) setSmallIcon(android.R.drawable.stat_sys_warning) @@ -186,7 +184,7 @@ internal class DownloadNotifier(private val context: Context) { setContentIntent(NotificationHandler.openDownloadManagerPendingActivity(context)) setProgress(0, 0, false) } - notificationBuilder.show() + completeNotificationBuilder.show() // Reset download information isDownloading = false @@ -201,7 +199,7 @@ internal class DownloadNotifier(private val context: Context) { */ fun onError(error: String? = null, chapter: String? = null) { // Create notification - with(notificationBuilder) { + with(completeNotificationBuilder) { setContentTitle( chapter ?: context.getString(R.string.download_notifier_downloader_title) @@ -213,7 +211,7 @@ internal class DownloadNotifier(private val context: Context) { setContentIntent(NotificationHandler.openDownloadManagerPendingActivity(context)) setProgress(0, 0, false) } - notificationBuilder.show(Notifications.ID_DOWNLOAD_CHAPTER_ERROR) + completeNotificationBuilder.show(Notifications.ID_DOWNLOAD_CHAPTER_ERROR) // Reset download information errorThrown = true diff --git a/app/src/main/java/eu/kanade/tachiyomi/data/download/DownloadService.kt b/app/src/main/java/eu/kanade/tachiyomi/data/download/DownloadService.kt index d0e6278635..0bcb6e613b 100644 --- a/app/src/main/java/eu/kanade/tachiyomi/data/download/DownloadService.kt +++ b/app/src/main/java/eu/kanade/tachiyomi/data/download/DownloadService.kt @@ -188,7 +188,7 @@ class DownloadService : Service() { } private fun getPlaceholderNotification(): Notification { - return notification(Notifications.CHANNEL_DOWNLOADER) { + return notification(Notifications.CHANNEL_DOWNLOADER_PROGRESS) { setContentTitle(getString(R.string.download_notifier_downloader_title)) } } diff --git a/app/src/main/java/eu/kanade/tachiyomi/data/notification/Notifications.kt b/app/src/main/java/eu/kanade/tachiyomi/data/notification/Notifications.kt index 81165edfd9..4edf0a9d14 100644 --- a/app/src/main/java/eu/kanade/tachiyomi/data/notification/Notifications.kt +++ b/app/src/main/java/eu/kanade/tachiyomi/data/notification/Notifications.kt @@ -30,8 +30,10 @@ object Notifications { /** * Notification channel and ids used by the downloader. */ - const val CHANNEL_DOWNLOADER = "downloader_channel" + private const val GROUP_DOWNLOADER = "group_downloader" + const val CHANNEL_DOWNLOADER_PROGRESS = "downloader_progress_channel" const val ID_DOWNLOAD_CHAPTER = -201 + const val CHANNEL_DOWNLOADER_COMPLETE = "downloader_complete_channel" const val ID_DOWNLOAD_CHAPTER_ERROR = -202 const val ID_DOWNLOAD_CHAPTER_COMPLETE = -203 @@ -51,7 +53,7 @@ object Notifications { /** * Notification channel and ids used by the backup/restore system. */ - private const val GROUP_BACK_RESTORE = "group_backup_restore" + private const val GROUP_BACKUP_RESTORE = "group_backup_restore" const val CHANNEL_BACKUP_RESTORE_PROGRESS = "backup_restore_progress_channel" const val ID_BACKUP_PROGRESS = -501 const val ID_RESTORE_PROGRESS = -503 @@ -60,6 +62,7 @@ object Notifications { const val ID_RESTORE_COMPLETE = -504 private val deprecatedChannels = listOf( + "downloader_channel", "backup_restore_complete_channel" ) @@ -71,10 +74,12 @@ object Notifications { fun createChannels(context: Context) { if (Build.VERSION.SDK_INT < Build.VERSION_CODES.O) return - val backupRestoreGroup = NotificationChannelGroup(GROUP_BACK_RESTORE, context.getString(R.string.channel_backup_restore)) - context.notificationManager.createNotificationChannelGroup(backupRestoreGroup) + listOf( + NotificationChannelGroup(GROUP_BACKUP_RESTORE, context.getString(R.string.group_backup_restore)), + NotificationChannelGroup(GROUP_DOWNLOADER, context.getString(R.string.group_downloader)) + ).forEach(context.notificationManager::createNotificationChannelGroup) - val channels = listOf( + listOf( NotificationChannel( CHANNEL_COMMON, context.getString(R.string.channel_common), NotificationManager.IMPORTANCE_LOW @@ -86,9 +91,17 @@ object Notifications { setShowBadge(false) }, NotificationChannel( - CHANNEL_DOWNLOADER, context.getString(R.string.channel_downloader), + CHANNEL_DOWNLOADER_PROGRESS, context.getString(R.string.channel_progress), NotificationManager.IMPORTANCE_LOW ).apply { + group = GROUP_DOWNLOADER + setShowBadge(false) + }, + NotificationChannel( + CHANNEL_DOWNLOADER_COMPLETE, context.getString(R.string.channel_complete), + NotificationManager.IMPORTANCE_LOW + ).apply { + group = GROUP_DOWNLOADER setShowBadge(false) }, NotificationChannel( @@ -100,26 +113,23 @@ object Notifications { NotificationManager.IMPORTANCE_DEFAULT ), NotificationChannel( - CHANNEL_BACKUP_RESTORE_PROGRESS, context.getString(R.string.channel_backup_restore_progress), + CHANNEL_BACKUP_RESTORE_PROGRESS, context.getString(R.string.channel_progress), NotificationManager.IMPORTANCE_LOW ).apply { - group = GROUP_BACK_RESTORE + group = GROUP_BACKUP_RESTORE setShowBadge(false) }, NotificationChannel( - CHANNEL_BACKUP_RESTORE_COMPLETE, context.getString(R.string.channel_backup_restore_complete), + CHANNEL_BACKUP_RESTORE_COMPLETE, context.getString(R.string.channel_complete), NotificationManager.IMPORTANCE_HIGH ).apply { - group = GROUP_BACK_RESTORE + group = GROUP_BACKUP_RESTORE setShowBadge(false) setSound(null, null) } - ) - context.notificationManager.createNotificationChannels(channels) + ).forEach(context.notificationManager::createNotificationChannel) // Delete old notification channels - deprecatedChannels.forEach { - context.notificationManager.deleteNotificationChannel(it) - } + deprecatedChannels.forEach(context.notificationManager::deleteNotificationChannel) } } diff --git a/app/src/main/res/values/strings.xml b/app/src/main/res/values/strings.xml index ef36c29a10..e07c3a8a43 100644 --- a/app/src/main/res/values/strings.xml +++ b/app/src/main/res/values/strings.xml @@ -676,13 +676,13 @@ Common + Progress + Complete Library - Downloader + Downloads + Backup and restore Chapter updates Extension updates - Backup and restore - Progress - Complete Invert tapping None Horizontal