Extract synchronization logic from SyncWorker into a separate class

This commit is contained in:
Shinokuni 2024-10-09 18:57:00 +02:00
parent 5824797aed
commit b94933d61b
3 changed files with 265 additions and 215 deletions

View File

@ -24,6 +24,7 @@ import com.readrops.app.repositories.FreshRSSRepository
import com.readrops.app.repositories.GetFoldersWithFeeds import com.readrops.app.repositories.GetFoldersWithFeeds
import com.readrops.app.repositories.LocalRSSRepository import com.readrops.app.repositories.LocalRSSRepository
import com.readrops.app.repositories.NextcloudNewsRepository import com.readrops.app.repositories.NextcloudNewsRepository
import com.readrops.app.sync.Synchronizer
import com.readrops.app.timelime.TimelineScreenModel import com.readrops.app.timelime.TimelineScreenModel
import com.readrops.app.util.DataStorePreferences import com.readrops.app.util.DataStorePreferences
import com.readrops.app.util.Preferences import com.readrops.app.util.Preferences
@ -113,4 +114,6 @@ val appModule = module {
single { Preferences(get()) } single { Preferences(get()) }
single { NotificationManagerCompat.from(get()) } single { NotificationManagerCompat.from(get()) }
single { Synchronizer(get(), get(), get(), get()) }
} }

View File

@ -3,8 +3,6 @@ package com.readrops.app.sync
import android.app.PendingIntent import android.app.PendingIntent
import android.content.Context import android.content.Context
import android.content.Intent import android.content.Intent
import android.content.SharedPreferences
import android.graphics.BitmapFactory
import android.util.Log import android.util.Log
import androidx.core.app.NotificationCompat import androidx.core.app.NotificationCompat
import androidx.core.app.NotificationCompat.Action import androidx.core.app.NotificationCompat.Action
@ -23,27 +21,17 @@ import androidx.work.WorkInfo
import androidx.work.WorkManager import androidx.work.WorkManager
import androidx.work.WorkerParameters import androidx.work.WorkerParameters
import androidx.work.workDataOf import androidx.work.workDataOf
import coil.annotation.ExperimentalCoilApi
import coil.imageLoader
import com.readrops.api.services.Credentials
import com.readrops.api.services.fever.adapters.Favicon
import com.readrops.api.utils.AuthInterceptor
import com.readrops.app.MainActivity import com.readrops.app.MainActivity
import com.readrops.app.R import com.readrops.app.R
import com.readrops.app.ReadropsApp import com.readrops.app.ReadropsApp
import com.readrops.app.repositories.BaseRepository
import com.readrops.app.repositories.ErrorResult
import com.readrops.app.repositories.SyncResult import com.readrops.app.repositories.SyncResult
import com.readrops.app.util.FeedColors
import com.readrops.app.util.putSerializable import com.readrops.app.util.putSerializable
import com.readrops.db.Database import com.readrops.db.Database
import com.readrops.db.entities.Feed
import com.readrops.db.entities.account.Account import com.readrops.db.entities.account.Account
import kotlinx.coroutines.flow.first import kotlinx.coroutines.flow.first
import org.koin.core.component.KoinComponent import org.koin.core.component.KoinComponent
import org.koin.core.component.get import org.koin.core.component.get
import org.koin.core.component.inject import org.koin.core.component.inject
import org.koin.core.parameter.parametersOf
import java.util.concurrent.TimeUnit import java.util.concurrent.TimeUnit
@ -64,9 +52,7 @@ class SyncWorker(
if (infos.any { it.state == WorkInfo.State.RUNNING && it.id != id }) { if (infos.any { it.state == WorkInfo.State.RUNNING && it.id != id }) {
return if (isManual) { return if (isManual) {
Result.failure( Result.failure(
workDataOf( workDataOf(SYNC_FAILURE_KEY to true)
SYNC_FAILURE_KEY to true,
)
.putSerializable( .putSerializable(
SYNC_FAILURE_EXCEPTION_KEY, SYNC_FAILURE_EXCEPTION_KEY,
Exception(applicationContext.getString(R.string.background_sync_already_running)) Exception(applicationContext.getString(R.string.background_sync_already_running))
@ -85,14 +71,37 @@ class SyncWorker(
.setOnlyAlertOnce(true) .setOnlyAlertOnce(true)
return try { return try {
val (workResult, syncResults) = refreshAccounts(notificationBuilder) val synchronizer = get<Synchronizer>()
val (syncResults, errorResult) = synchronizer.synchronizeAccounts(
notificationBuilder = notificationBuilder,
inputData = SyncInputData(
accountId = inputData.getInt(ACCOUNT_ID_KEY, -1),
feedId = inputData.getInt(FEED_ID_KEY, -1),
folderId = inputData.getInt(FOLDER_ID_KEY, -1)
),
onUpdate = { feed, feedMax, feedCount ->
setProgress(
workDataOf(
FEED_NAME_KEY to feed.name,
FEED_MAX_KEY to feedMax,
FEED_COUNT_KEY to feedCount
)
)
}
)
notificationManager.cancel(SYNC_NOTIFICATION_ID) notificationManager.cancel(SYNC_NOTIFICATION_ID)
if (!isManual) { if (!isManual) {
displaySyncResults(syncResults) displaySyncResults(syncResults)
} }
workResult return Result.success(workDataOf(END_SYNC_KEY to true).apply {
if (errorResult.isNotEmpty() && isManual) {
putSerializable(LOCAL_SYNC_ERRORS_KEY, errorResult)
}
})
} catch (e: Exception) { } catch (e: Exception) {
Log.e(TAG, "${e.printStackTrace()}") Log.e(TAG, "${e.printStackTrace()}")
@ -108,188 +117,6 @@ class SyncWorker(
} }
} }
private suspend fun refreshAccounts(notificationBuilder: Builder): Pair<Result, Map<Account, SyncResult>> {
val sharedPreferences = get<SharedPreferences>()
var workResult = Result.success(workDataOf(END_SYNC_KEY to true))
val syncResults = mutableMapOf<Account, SyncResult>()
val accountId = inputData.getInt(ACCOUNT_ID_KEY, -1)
val accounts = if (accountId == -1) {
database.accountDao().selectAllAccounts().first()
} else {
listOf(database.accountDao().select(accountId))
}
for (account in accounts) {
if (!account.isLocal) {
account.login = sharedPreferences.getString(account.loginKey, null)
account.password = sharedPreferences.getString(account.passwordKey, null)
}
val repository = get<BaseRepository> { parametersOf(account) }
notificationBuilder.setContentTitle(
applicationContext.resources.getString(
R.string.updating_account,
account.name
)
)
if (notificationManager.areNotificationsEnabled()) {
notificationManager.notify(SYNC_NOTIFICATION_ID, notificationBuilder.build())
}
if (account.isLocal) {
val result = refreshLocalAccount(repository, account, notificationBuilder)
if (result.second.isNotEmpty() && tags.contains(WORK_MANUAL)) {
workResult = Result.success(
workDataOf(END_SYNC_KEY to true)
.putSerializable(LOCAL_SYNC_ERRORS_KEY, result.second)
)
}
syncResults[account] = result.first
} else {
get<AuthInterceptor>().credentials = Credentials.toCredentials(account)
val syncResult = repository.synchronize()
if (syncResult.favicons.isNotEmpty()) {
loadFeverFavicons(syncResult.favicons, account, notificationBuilder)
} else {
fetchFeedColors(syncResult, notificationBuilder)
}
syncResults[account] = syncResult
}
}
return workResult to syncResults
}
private suspend fun refreshLocalAccount(
repository: BaseRepository,
account: Account,
notificationBuilder: Builder
): Pair<SyncResult, ErrorResult> {
val feedId = inputData.getInt(FEED_ID_KEY, 0)
val folderId = inputData.getInt(FOLDER_ID_KEY, 0)
val feeds = when {
feedId > 0 -> listOf(database.feedDao().selectFeed(feedId))
folderId > 0 -> database.feedDao().selectFeedsByFolder(folderId)
else -> listOf()
}
var feedCount = 0
val feedMax = if (feeds.isNotEmpty()) {
feeds.size
} else {
database.feedDao().selectFeedCount(account.id)
}
val result = repository.synchronize(
selectedFeeds = feeds,
onUpdate = { feed ->
if (notificationManager.areNotificationsEnabled()) {
notificationBuilder.setContentText(feed.name)
.setStyle(NotificationCompat.BigTextStyle().bigText(feed.name))
.setProgress(feedMax, ++feedCount, false)
notificationManager.notify(SYNC_NOTIFICATION_ID, notificationBuilder.build())
}
setProgress(
workDataOf(
FEED_NAME_KEY to feed.name,
FEED_MAX_KEY to feedMax,
FEED_COUNT_KEY to feedCount
)
)
}
)
if (result.second.isNotEmpty()) {
Log.e(
TAG,
"refreshing local account ${account.name}: ${result.second.size} errors"
)
}
return result
}
private suspend fun fetchFeedColors(
syncResult: SyncResult,
notificationBuilder: Builder
) = with(syncResult) {
notificationBuilder.setContentTitle(applicationContext.getString(R.string.get_feeds_colors))
for ((index, feed) in feeds.withIndex()) {
notificationBuilder.setContentText(feed.name)
.setStyle(NotificationCompat.BigTextStyle().bigText(feed.name))
.setProgress(feeds.size, index + 1, false)
if (notificationManager.areNotificationsEnabled()) {
notificationManager.notify(SYNC_NOTIFICATION_ID, notificationBuilder.build())
}
try {
if (feed.iconUrl != null) {
val color = FeedColors.getFeedColor(feed.iconUrl!!)
database.feedDao().updateFeedColor(feed.id, color)
}
} catch (e: Exception) {
Log.e(TAG, "${feed.name}: ${e.message}")
}
}
}
@OptIn(ExperimentalCoilApi::class)
private suspend fun loadFeverFavicons(
favicons: Map<Feed, Favicon>,
account: Account,
notificationBuilder: Builder
) {
if (notificationManager.areNotificationsEnabled()) {
// can't make detailed progress as the favicon might already exist in cache
notificationBuilder.setContentTitle("Loading icons and colors")
.setProgress(0, 0, true)
notificationManager.notify(SYNC_NOTIFICATION_ID, notificationBuilder.build())
}
val diskCache = applicationContext.imageLoader.diskCache!!
for ((feed, favicon) in favicons) {
val key = "account_${account.id}_feed_${feed.name!!.replace(" ", "_")}"
val snapshot = diskCache.openSnapshot(key)
if (snapshot == null) {
try {
diskCache.openEditor(key)!!.apply {
diskCache.fileSystem.write(data) {
write(favicon.data)
}
commit()
}
database.feedDao().updateFeedIconUrl(feed.id, key)
val bitmap =
BitmapFactory.decodeByteArray(favicon.data, 0, favicon.data.size)
if (bitmap != null) {
val color = FeedColors.getFeedColor(bitmap)
database.feedDao().updateFeedColor(feed.id, color)
}
} catch (e: Exception) {
Log.e(TAG, "${feed.name}: ${e.message}")
}
}
snapshot?.close()
}
}
private suspend fun displaySyncResults(syncResults: Map<Account, SyncResult>) { private suspend fun displaySyncResults(syncResults: Map<Account, SyncResult>) {
val notificationContent = SyncAnalyzer(applicationContext, database) val notificationContent = SyncAnalyzer(applicationContext, database)
.getNotificationContent(syncResults) .getNotificationContent(syncResults)
@ -343,14 +170,12 @@ class SyncWorker(
putExtra(ITEM_ID_KEY, itemId) putExtra(ITEM_ID_KEY, itemId)
} }
val pendingIntent = val pendingIntent = PendingIntent.getBroadcast(
PendingIntent.getBroadcast( applicationContext,
applicationContext, 0,
0, intent,
intent, PendingIntent.FLAG_UPDATE_CURRENT or PendingIntent.FLAG_IMMUTABLE
PendingIntent.FLAG_UPDATE_CURRENT or PendingIntent.FLAG_IMMUTABLE )
)
return Action.Builder( return Action.Builder(
R.drawable.ic_done_all, R.drawable.ic_done_all,
@ -367,13 +192,12 @@ class SyncWorker(
putExtra(ITEM_ID_KEY, itemId) putExtra(ITEM_ID_KEY, itemId)
} }
val pendingIntent = val pendingIntent = PendingIntent.getBroadcast(
PendingIntent.getBroadcast( applicationContext,
applicationContext, 0,
0, intent,
intent, PendingIntent.FLAG_UPDATE_CURRENT or PendingIntent.FLAG_IMMUTABLE
PendingIntent.FLAG_UPDATE_CURRENT or PendingIntent.FLAG_IMMUTABLE )
)
return Action.Builder( return Action.Builder(
R.drawable.ic_favorite_border, R.drawable.ic_favorite_border,
@ -390,7 +214,7 @@ class SyncWorker(
private val WORK_AUTO = "$TAG-auto" private val WORK_AUTO = "$TAG-auto"
private val WORK_MANUAL = "$TAG-manual" private val WORK_MANUAL = "$TAG-manual"
private const val SYNC_NOTIFICATION_ID = 2 const val SYNC_NOTIFICATION_ID = 2
const val SYNC_RESULT_NOTIFICATION_ID = 3 const val SYNC_RESULT_NOTIFICATION_ID = 3
const val END_SYNC_KEY = "END_SYNC" const val END_SYNC_KEY = "END_SYNC"

View File

@ -0,0 +1,223 @@
package com.readrops.app.sync
import android.content.Context
import android.content.SharedPreferences
import android.graphics.BitmapFactory
import android.util.Log
import androidx.core.app.NotificationCompat
import androidx.core.app.NotificationCompat.Builder
import androidx.core.app.NotificationManagerCompat
import coil.annotation.ExperimentalCoilApi
import coil.imageLoader
import com.readrops.api.services.Credentials
import com.readrops.api.services.fever.adapters.Favicon
import com.readrops.api.utils.AuthInterceptor
import com.readrops.app.R
import com.readrops.app.repositories.BaseRepository
import com.readrops.app.repositories.ErrorResult
import com.readrops.app.repositories.SyncResult
import com.readrops.app.sync.SyncWorker.Companion.SYNC_NOTIFICATION_ID
import com.readrops.app.util.FeedColors
import com.readrops.db.Database
import com.readrops.db.entities.Feed
import com.readrops.db.entities.account.Account
import kotlinx.coroutines.flow.first
import org.koin.core.component.KoinComponent
import org.koin.core.component.get
import org.koin.core.parameter.parametersOf
data class SyncInputData(
val accountId: Int,
val feedId: Int,
val folderId: Int
)
class Synchronizer(
private val notificationManager: NotificationManagerCompat,
private val database: Database,
private val context: Context,
private val encryptedPreferences: SharedPreferences,
) : KoinComponent {
suspend fun synchronizeAccounts(
notificationBuilder: Builder,
inputData: SyncInputData,
onUpdate: suspend (feed: Feed, feedMax: Int, feedCount: Int) -> Unit
): Pair<Map<Account, SyncResult>, ErrorResult> {
val syncResults = mutableMapOf<Account, SyncResult>()
val errorResult = hashMapOf<Feed, Exception>()
val accounts = if (inputData.accountId == -1) {
database.accountDao().selectAllAccounts().first()
} else {
listOf(database.accountDao().select(inputData.accountId))
}
for (account in accounts) {
if (!account.isLocal) {
account.login = encryptedPreferences.getString(account.loginKey, null)
account.password = encryptedPreferences.getString(account.passwordKey, null)
}
val repository = get<BaseRepository> { parametersOf(account) }
notificationBuilder.setContentTitle(
context.resources.getString(
R.string.updating_account,
account.name
)
)
if (notificationManager.areNotificationsEnabled()) {
notificationManager.notify(SYNC_NOTIFICATION_ID, notificationBuilder.build())
}
if (account.isLocal) {
val result = refreshLocalAccount(
repository = repository,
account = account,
notificationBuilder = notificationBuilder,
inputData = inputData,
onUpdate = onUpdate
)
syncResults[account] = result.first
errorResult.putAll(result.second)
} else {
get<AuthInterceptor>().credentials = Credentials.toCredentials(account)
val syncResult = repository.synchronize()
if (syncResult.favicons.isNotEmpty()) {
loadFeverFavicons(syncResult.favicons, account, notificationBuilder)
} else {
fetchFeedColors(syncResult, notificationBuilder)
}
syncResults[account] = syncResult
}
}
return syncResults to errorResult
}
private suspend fun refreshLocalAccount(
repository: BaseRepository,
account: Account,
notificationBuilder: Builder,
inputData: SyncInputData,
onUpdate: suspend (feed: Feed, feedMax: Int, feedCount: Int) -> Unit
): Pair<SyncResult, ErrorResult> {
val feedId = inputData.feedId
val folderId = inputData.folderId
val feeds = when {
feedId > 0 -> listOf(database.feedDao().selectFeed(feedId))
folderId > 0 -> database.feedDao().selectFeedsByFolder(folderId)
else -> listOf()
}
var feedCount = 0
val feedMax = if (feeds.isNotEmpty()) {
feeds.size
} else {
database.feedDao().selectFeedCount(account.id)
}
val result = repository.synchronize(
selectedFeeds = feeds,
onUpdate = { feed ->
if (notificationManager.areNotificationsEnabled()) {
notificationBuilder.setContentText(feed.name)
.setStyle(NotificationCompat.BigTextStyle().bigText(feed.name))
.setProgress(feedMax, ++feedCount, false)
notificationManager.notify(SYNC_NOTIFICATION_ID, notificationBuilder.build())
}
onUpdate(feed, feedMax, feedCount)
}
)
if (result.second.isNotEmpty()) {
Log.e(TAG, "refreshing local account ${account.name}: ${result.second.size} errors")
}
return result
}
private suspend fun fetchFeedColors(
syncResult: SyncResult,
notificationBuilder: Builder
) = with(syncResult) {
notificationBuilder.setContentTitle(context.getString(R.string.get_feeds_colors))
for ((index, feed) in feeds.withIndex()) {
notificationBuilder.setContentText(feed.name)
.setStyle(NotificationCompat.BigTextStyle().bigText(feed.name))
.setProgress(feeds.size, index + 1, false)
if (notificationManager.areNotificationsEnabled()) {
notificationManager.notify(SYNC_NOTIFICATION_ID, notificationBuilder.build())
}
try {
if (feed.iconUrl != null) {
val color = FeedColors.getFeedColor(feed.iconUrl!!)
database.feedDao().updateFeedColor(feed.id, color)
}
} catch (e: Exception) {
Log.e(TAG, "${feed.name}: ${e.message}")
}
}
}
@OptIn(ExperimentalCoilApi::class)
private suspend fun loadFeverFavicons(
favicons: Map<Feed, Favicon>,
account: Account,
notificationBuilder: Builder
) {
if (notificationManager.areNotificationsEnabled()) {
// can't make detailed progress as the favicon might already exist in cache
notificationBuilder.setContentTitle("Loading icons and colors")
.setProgress(0, 0, true)
notificationManager.notify(SYNC_NOTIFICATION_ID, notificationBuilder.build())
}
val diskCache = context.imageLoader.diskCache!!
for ((feed, favicon) in favicons) {
val key = "account_${account.id}_feed_${feed.name!!.replace(" ", "_")}"
val snapshot = diskCache.openSnapshot(key)
if (snapshot == null) {
try {
diskCache.openEditor(key)!!.apply {
diskCache.fileSystem.write(data) {
write(favicon.data)
}
commit()
}
database.feedDao().updateFeedIconUrl(feed.id, key)
val bitmap =
BitmapFactory.decodeByteArray(favicon.data, 0, favicon.data.size)
if (bitmap != null) {
val color = FeedColors.getFeedColor(bitmap)
database.feedDao().updateFeedColor(feed.id, color)
}
} catch (e: Exception) {
Log.e(TAG, "${feed.name}: ${e.message}")
}
}
snapshot?.close()
}
}
companion object {
private val TAG = Synchronizer::class.java.simpleName
}
}