Skip to content

Commit

Permalink
Split download notifications into progress and complete channels
Browse files Browse the repository at this point in the history 
(cherry picked from commit 3813743)
  • Loading branch information
@arkon @jobobby04
arkon authored and jobobby04 committed Jul 30, 2020
1 parent ae48c1d commit e338bb0
Show file tree
Hide file tree
Showing 4 changed files with 67 additions and 59 deletions.
76 changes: 37 additions & 39 deletions app/src/main/java/eu/kanade/tachiyomi/data/download/DownloadNotifier.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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<PreferencesHelper>() }
private val completeNotificationBuilder = context.notificationBuilder(Notifications.CHANNEL_DOWNLOADER_COMPLETE) {
setAutoCancel(false)
}

/**
* Status of download. Used for correct notification icon.
*/
@Volatile
private var isDownloading = false

/**
Expand All @@ -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()
}
Expand All @@ -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)
Expand Down Expand Up @@ -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)
Expand All @@ -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)
Expand All @@ -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
Expand All @@ -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)
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion app/src/main/java/eu/kanade/tachiyomi/data/download/DownloadService.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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))
}
}
Expand Down
40 changes: 25 additions & 15 deletions app/src/main/java/eu/kanade/tachiyomi/data/notification/Notifications.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand All @@ -60,6 +62,7 @@ object Notifications {
const val ID_RESTORE_COMPLETE = -504

private val deprecatedChannels = listOf(
"downloader_channel",
"backup_restore_complete_channel"
)

Expand All @@ -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
Expand All @@ -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(
Expand All @@ -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)
}
}
8 changes: 4 additions & 4 deletions app/src/main/res/values/strings.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -676,13 +676,13 @@

<!-- Notification channels -->
<string name="channel_common">Common</string>
<string name="channel_progress">Progress</string>
<string name="channel_complete">Complete</string>
<string name="channel_library">Library</string>
<string name="channel_downloader">Downloader</string>
<string name="group_downloader">Downloads</string>
<string name="group_backup_restore">Backup and restore</string>
<string name="channel_new_chapters">Chapter updates</string>
<string name="channel_ext_updates">Extension updates</string>
<string name="channel_backup_restore">Backup and restore</string>
<string name="channel_backup_restore_progress">Progress</string>
<string name="channel_backup_restore_complete">Complete</string>
<string name="pref_read_with_tapping_inverted">Invert tapping</string>
<string name="tapping_inverted_none">None</string>
<string name="tapping_inverted_horizontal">Horizontal</string>
Expand Down

0 comments on commit e338bb0

Please sign in to comment.