Cutlery/immich
1
0
Fork 1
mirror of https://github.com/immich-app/immich.git synced 2025-07-09 03:04:16 -04:00
Code Issues Packages Projects Releases Wiki Activity

reduce number of native calls

Browse Source
This commit is contained in:
shenlong-tanwen 2025-05-07 19:34:08 +05:30
parent c0acd863cf
commit 09e5503fb1
10 changed files with 344 additions and 440 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

145
mobile/android/app/src/main/kotlin/app/alextran/immich/platform/MediaManager.kt
View File

@ -5,10 +5,8 @@ import SyncDelta
import android.content.Context import android.content.Context
import android.os.Build import android.os.Build
import android.provider.MediaStore import android.provider.MediaStore
import android.provider.MediaStore.VOLUME_EXTERNAL
import androidx.annotation.RequiresApi import androidx.annotation.RequiresApi
import androidx.annotation.RequiresExtension import androidx.annotation.RequiresExtension
import androidx.core.content.edit
import kotlinx.serialization.json.Json import kotlinx.serialization.json.Json
import java.io.File import java.io.File
import java.time.Instant import java.time.Instant
@ -33,80 +31,48 @@ class MediaManager(context: Context) {
@RequiresApi(Build.VERSION_CODES.Q) @RequiresApi(Build.VERSION_CODES.Q)
fun shouldFullSync(callback: (Result<Boolean>) -> Unit) { fun shouldFullSync(callback: (Result<Boolean>) -> Unit) {
val prefs = ctx.getSharedPreferences(SHARED_PREF_NAME, Context.MODE_PRIVATE)
val currVersion = MediaStore.getVersion(ctx) val currVersion = MediaStore.getVersion(ctx)
val lastVersion = ctx.getSharedPreferences(SHARED_PREF_NAME, Context.MODE_PRIVATE) val lastVersion = prefs.getString(SHARED_PREF_MEDIA_STORE_VERSION_KEY, null)
.getString(SHARED_PREF_MEDIA_STORE_VERSION_KEY, null)
callback(Result.success(currVersion != lastVersion)) callback(Result.success(currVersion != lastVersion))
} }
@RequiresApi(Build.VERSION_CODES.Q)
@RequiresExtension(extension = Build.VERSION_CODES.R, version = 1)
fun hasMediaChanges(callback: (Result<Boolean>) -> Unit) {
val genMap = getSavedGenerationMap(ctx)
val currentVolumes = MediaStore.getExternalVolumeNames(ctx)
if (currentVolumes != genMap.keys) {
callback(Result.success(true))
return
}
val hasChanged = currentVolumes.any { volume ->
val currentGen = MediaStore.getGeneration(ctx, volume)
currentGen != genMap[volume]
}
callback(Result.success(hasChanged))
}
@RequiresApi(Build.VERSION_CODES.Q) @RequiresApi(Build.VERSION_CODES.Q)
@RequiresExtension(extension = Build.VERSION_CODES.R, version = 1) @RequiresExtension(extension = Build.VERSION_CODES.R, version = 1)
fun checkpointSync(callback: (Result<Unit>) -> Unit) { fun checkpointSync(callback: (Result<Unit>) -> Unit) {
val genMap = MediaStore.getExternalVolumeNames(ctx).associateWith { val genMap =
MediaStore.getGeneration(ctx, it) MediaStore.getExternalVolumeNames(ctx).associateWith { MediaStore.getGeneration(ctx, it) }
}.let { Json.encodeToString(it) } val prefs = ctx.getSharedPreferences(SHARED_PREF_NAME, Context.MODE_PRIVATE)
prefs.edit().apply {
ctx.getSharedPreferences(SHARED_PREF_NAME, Context.MODE_PRIVATE).edit {
putString(SHARED_PREF_MEDIA_STORE_VERSION_KEY, MediaStore.getVersion(ctx)) putString(SHARED_PREF_MEDIA_STORE_VERSION_KEY, MediaStore.getVersion(ctx))
putString(SHARED_PREF_MEDIA_STORE_GEN_KEY, genMap) putString(SHARED_PREF_MEDIA_STORE_GEN_KEY, Json.encodeToString(genMap))
apply()
} }
callback(Result.success(Unit)) callback(Result.success(Unit))
} }
@RequiresApi(Build.VERSION_CODES.Q) @RequiresApi(Build.VERSION_CODES.Q)
fun getAssetIdsForAlbum( fun getAssetIdsForAlbum(albumId: String, callback: (Result<List<String>>) -> Unit) {
albumId: String,
callback: (Result<List<String>>) -> Unit
) {
try { try {
val currentIds = mutableListOf<String>() val uri = MediaStore.Files.getContentUri(MediaStore.VOLUME_EXTERNAL)
val uri = MediaStore.Files.getContentUri(VOLUME_EXTERNAL)
val projection = arrayOf(MediaStore.Files.FileColumns._ID) val projection = arrayOf(MediaStore.Files.FileColumns._ID)
val selection = """ val selection =
${MediaStore.Files.FileColumns.BUCKET_ID} = ? "${MediaStore.Files.FileColumns.BUCKET_ID} = ? AND (${MediaStore.Files.FileColumns.MEDIA_TYPE} = ? OR ${MediaStore.Files.FileColumns.MEDIA_TYPE} = ?)"
AND (
${MediaStore.Files.FileColumns.MEDIA_TYPE} = ?
OR ${MediaStore.Files.FileColumns.MEDIA_TYPE} = ?
)
""".trimIndent()
val selectionArgs = arrayOf( val selectionArgs = arrayOf(
albumId, albumId,
MediaStore.Files.FileColumns.MEDIA_TYPE_IMAGE.toString(), MediaStore.Files.FileColumns.MEDIA_TYPE_IMAGE.toString(),
MediaStore.Files.FileColumns.MEDIA_TYPE_VIDEO.toString() MediaStore.Files.FileColumns.MEDIA_TYPE_VIDEO.toString()
) )
val sortOrder = null
ctx.contentResolver.query( val ids =
uri, ctx.contentResolver.query(uri, projection, selection, selectionArgs, null)?.use { cursor ->
projection,
selection,
selectionArgs,
sortOrder
)?.use { cursor ->
val idColumn = cursor.getColumnIndexOrThrow(MediaStore.Files.FileColumns._ID) val idColumn = cursor.getColumnIndexOrThrow(MediaStore.Files.FileColumns._ID)
while (cursor.moveToNext()) { generateSequence {
currentIds.add(cursor.getLong(idColumn).toString()) if (cursor.moveToNext()) cursor.getLong(idColumn).toString() else null
} }.toList()
} } ?: emptyList()
callback(Result.success(currentIds)) callback(Result.success(ids))
} catch (e: Exception) { } catch (e: Exception) {
callback(Result.failure(e)) callback(Result.failure(e))
} }
@ -120,70 +86,57 @@ class MediaManager(context: Context) {
val currentVolumes = MediaStore.getExternalVolumeNames(ctx) val currentVolumes = MediaStore.getExternalVolumeNames(ctx)
val changed = mutableListOf<Asset>() val changed = mutableListOf<Asset>()
val deleted = mutableListOf<String>() val deleted = mutableListOf<String>()
val formatter = DateTimeFormatter.ISO_DATE_TIME.withZone(ZoneOffset.UTC)
var hasChanges = genMap.keys != currentVolumes
for (volume in currentVolumes) { for (volume in currentVolumes) {
val currentGen = MediaStore.getGeneration(ctx, volume) val currentGen = MediaStore.getGeneration(ctx, volume)
val storedGen = genMap[volume] val storedGen = genMap[volume]
if (storedGen != null && currentGen <= storedGen) {
if (storedGen != null && currentGen < storedGen) {
continue continue
} }
hasChanges = true
val queryUri = MediaStore.Files.getContentUri(volume) val uri = MediaStore.Files.getContentUri(volume)
val projection = arrayOf( val projection = arrayOf(
MediaStore.MediaColumns._ID, MediaStore.MediaColumns._ID,
MediaStore.MediaColumns.DATA, MediaStore.MediaColumns.DATA,
MediaStore.MediaColumns.DISPLAY_NAME, MediaStore.MediaColumns.DISPLAY_NAME,
MediaStore.MediaColumns.TITLE,
MediaStore.Files.FileColumns.MEDIA_TYPE,
MediaStore.MediaColumns.BUCKET_ID,
MediaStore.MediaColumns.DURATION,
MediaStore.MediaColumns.DATE_TAKEN, MediaStore.MediaColumns.DATE_TAKEN,
MediaStore.MediaColumns.DATE_ADDED, MediaStore.MediaColumns.DATE_ADDED,
MediaStore.MediaColumns.DATE_MODIFIED, MediaStore.MediaColumns.DATE_MODIFIED,
MediaStore.Files.FileColumns.MEDIA_TYPE,
MediaStore.MediaColumns.BUCKET_ID,
MediaStore.MediaColumns.DURATION
) )
val selectionParts = mutableListOf<String>() val selection =
val selectionArgsList = mutableListOf<String>() "(${MediaStore.Files.FileColumns.MEDIA_TYPE} = ? OR ${MediaStore.Files.FileColumns.MEDIA_TYPE} = ?) AND (${MediaStore.MediaColumns.GENERATION_MODIFIED} > ? OR ${MediaStore.MediaColumns.GENERATION_ADDED} > ?)"
val selectionArgs = arrayOf(
selectionParts.add( MediaStore.Files.FileColumns.MEDIA_TYPE_IMAGE.toString(),
"(${MediaStore.Files.FileColumns.MEDIA_TYPE} = ? OR ${MediaStore.Files.FileColumns.MEDIA_TYPE} = ?)" MediaStore.Files.FileColumns.MEDIA_TYPE_VIDEO.toString(),
storedGen?.toString() ?: "0",
storedGen?.toString() ?: "0"
) )
selectionArgsList.add(MediaStore.Files.FileColumns.MEDIA_TYPE_IMAGE.toString())
selectionArgsList.add(MediaStore.Files.FileColumns.MEDIA_TYPE_VIDEO.toString())
if (storedGen != null) {
selectionParts.add(
"(${MediaStore.MediaColumns.GENERATION_MODIFIED} > ? OR ${MediaStore.MediaColumns.GENERATION_ADDED} > ?)"
)
selectionArgsList.add(storedGen.toString())
selectionArgsList.add(storedGen.toString())
}
val selection = selectionParts.joinToString(" AND ")
val selectionArgs = selectionArgsList.toTypedArray()
val sortOrder = null
ctx.contentResolver.query( ctx.contentResolver.query(
queryUri, uri,
projection, projection,
selection, selection,
selectionArgs, selectionArgs,
sortOrder null
)?.use { cursor -> )?.use { cursor ->
val idColumn = cursor.getColumnIndexOrThrow(MediaStore.MediaColumns._ID) val idColumn = cursor.getColumnIndexOrThrow(MediaStore.MediaColumns._ID)
val mediaTypeColumn =
cursor.getColumnIndexOrThrow(MediaStore.Files.FileColumns.MEDIA_TYPE)
val nameColumn =
cursor.getColumnIndexOrThrow(MediaStore.MediaColumns.DISPLAY_NAME)
val dataColumn = cursor.getColumnIndexOrThrow(MediaStore.MediaColumns.DATA) val dataColumn = cursor.getColumnIndexOrThrow(MediaStore.MediaColumns.DATA)
val dateTakeColumn = cursor.getColumnIndexOrThrow(MediaStore.MediaColumns.DATE_TAKEN) val nameColumn = cursor.getColumnIndexOrThrow(MediaStore.MediaColumns.DISPLAY_NAME)
val dateTakenColumn = cursor.getColumnIndexOrThrow(MediaStore.MediaColumns.DATE_TAKEN)
val dateAddedColumn = cursor.getColumnIndexOrThrow(MediaStore.MediaColumns.DATE_ADDED) val dateAddedColumn = cursor.getColumnIndexOrThrow(MediaStore.MediaColumns.DATE_ADDED)
val dateModifiedColumn = val dateModifiedColumn =
cursor.getColumnIndexOrThrow(MediaStore.MediaColumns.DATE_MODIFIED) cursor.getColumnIndexOrThrow(MediaStore.MediaColumns.DATE_MODIFIED)
val durationColumn = cursor.getColumnIndexOrThrow(MediaStore.MediaColumns.DURATION) val mediaTypeColumn =
cursor.getColumnIndexOrThrow(MediaStore.Files.FileColumns.MEDIA_TYPE)
val bucketIdColumn = cursor.getColumnIndexOrThrow(MediaStore.MediaColumns.BUCKET_ID) val bucketIdColumn = cursor.getColumnIndexOrThrow(MediaStore.MediaColumns.BUCKET_ID)
val formatter = DateTimeFormatter.ISO_DATE_TIME.withZone(ZoneOffset.UTC) val durationColumn = cursor.getColumnIndexOrThrow(MediaStore.MediaColumns.DURATION)
while (cursor.moveToNext()) { while (cursor.moveToNext()) {
val id = cursor.getLong(idColumn).toString() val id = cursor.getLong(idColumn).toString()
@ -195,14 +148,11 @@ class MediaManager(context: Context) {
val mediaType = cursor.getInt(mediaTypeColumn) val mediaType = cursor.getInt(mediaTypeColumn)
val name = cursor.getString(nameColumn) val name = cursor.getString(nameColumn)
// Date taken is milliseconds since epoch // Date taken is milliseconds since epoch, Date added is seconds since epoch
var takenAt = cursor.getLong(dateTakeColumn) val takenAt = cursor.getLong(dateTakenColumn).takeIf { it > 0 } ?: (cursor.getLong(
if (takenAt == 0L) { dateAddedColumn
// Date added is seconds since epoch ) * 1000)
takenAt = cursor.getLong(dateAddedColumn) * 1000 val createdAt = formatter.format(Instant.ofEpochMilli(takenAt))
}
val takenInstant = Instant.ofEpochMilli(takenAt)
val createdAt = formatter.format(takenInstant)
// Date modified is seconds since epoch // Date modified is seconds since epoch
val modifiedAt = val modifiedAt =
formatter.format(Instant.ofEpochMilli(cursor.getLong(dateModifiedColumn) * 1000)) formatter.format(Instant.ofEpochMilli(cursor.getLong(dateModifiedColumn) * 1000))
@ -228,9 +178,8 @@ class MediaManager(context: Context) {
} }
} }
// Unmounted volumes are handled in dart when the album is removed // Unmounted volumes are handled in dart when the album is removed
val syncDelta = SyncDelta(updates = changed, deletes = deleted)
callback(Result.success(syncDelta))
callback(Result.success(SyncDelta(hasChanges, changed, deleted)))
} catch (e: Exception) { } catch (e: Exception) {
callback(Result.failure(e)) callback(Result.failure(e))
} }

28
mobile/android/app/src/main/kotlin/app/alextran/immich/platform/Messages.g.kt
View File

@ -125,19 +125,22 @@ data class Asset (
/** Generated class from Pigeon that represents data sent in messages. */ /** Generated class from Pigeon that represents data sent in messages. */
data class SyncDelta ( data class SyncDelta (
val hasChanges: Boolean,
val updates: List<Asset>, val updates: List<Asset>,
val deletes: List<String> val deletes: List<String>
) )
{ {
companion object { companion object {
fun fromList(pigeonVar_list: List<Any?>): SyncDelta { fun fromList(pigeonVar_list: List<Any?>): SyncDelta {
val updates = pigeonVar_list[0] as List<Asset> val hasChanges = pigeonVar_list[0] as Boolean
val deletes = pigeonVar_list[1] as List<String> val updates = pigeonVar_list[1] as List<Asset>
return SyncDelta(updates, deletes) val deletes = pigeonVar_list[2] as List<String>
return SyncDelta(hasChanges, updates, deletes)
} }
} }
fun toList(): List<Any?> { fun toList(): List<Any?> {
return listOf( return listOf(
hasChanges,
updates, updates,
deletes, deletes,
) )
@ -188,7 +191,6 @@ private open class MessagesPigeonCodec : StandardMessageCodec() {
/** Generated interface from Pigeon that represents a handler of messages from Flutter. */ /** Generated interface from Pigeon that represents a handler of messages from Flutter. */
interface ImHostService { interface ImHostService {
fun shouldFullSync(callback: (Result<Boolean>) -> Unit) fun shouldFullSync(callback: (Result<Boolean>) -> Unit)
fun hasMediaChanges(callback: (Result<Boolean>) -> Unit)
fun getMediaChanges(callback: (Result<SyncDelta>) -> Unit) fun getMediaChanges(callback: (Result<SyncDelta>) -> Unit)
fun checkpointSync(callback: (Result<Unit>) -> Unit) fun checkpointSync(callback: (Result<Unit>) -> Unit)
fun getAssetIdsForAlbum(albumId: String, callback: (Result<List<String>>) -> Unit) fun getAssetIdsForAlbum(albumId: String, callback: (Result<List<String>>) -> Unit)
@ -221,24 +223,6 @@ interface ImHostService {
channel.setMessageHandler(null) channel.setMessageHandler(null)
} }
} }
run {
val channel = BasicMessageChannel<Any?>(binaryMessenger, "dev.flutter.pigeon.immich_mobile.ImHostService.hasMediaChanges$separatedMessageChannelSuffix", codec)
if (api != null) {
channel.setMessageHandler { _, reply ->
api.hasMediaChanges{ result: Result<Boolean> ->
val error = result.exceptionOrNull()
if (error != null) {
reply.reply(MessagesPigeonUtils.wrapError(error))
} else {
val data = result.getOrNull()
reply.reply(MessagesPigeonUtils.wrapResult(data))
}
}
}
} else {
channel.setMessageHandler(null)
}
}
run { run {
val channel = BasicMessageChannel<Any?>(binaryMessenger, "dev.flutter.pigeon.immich_mobile.ImHostService.getMediaChanges$separatedMessageChannelSuffix", codec, taskQueue) val channel = BasicMessageChannel<Any?>(binaryMessenger, "dev.flutter.pigeon.immich_mobile.ImHostService.getMediaChanges$separatedMessageChannelSuffix", codec, taskQueue)
if (api != null) { if (api != null) {

28
mobile/android/app/src/main/kotlin/app/alextran/immich/platform/MessagesImpl.kt
View File

@ -10,6 +10,16 @@ class MessagesImpl(context: Context) : ImHostService {
private val ctx: Context = context.applicationContext private val ctx: Context = context.applicationContext
private val mediaManager: MediaManager = MediaManager(ctx) private val mediaManager: MediaManager = MediaManager(ctx)
companion object {
private fun isMediaChangesSupported(): Boolean {
return Build.VERSION.SDK_INT >= Build.VERSION_CODES.R &&
SdkExtensions.getExtensionVersion(Build.VERSION_CODES.R) >= 1
}
private fun unsupportedFeatureException() =
IllegalStateException("Method not supported on this Android version.")
}
override fun shouldFullSync(callback: (Result<Boolean>) -> Unit) { override fun shouldFullSync(callback: (Result<Boolean>) -> Unit) {
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q) { if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q) {
mediaManager.shouldFullSync(callback) mediaManager.shouldFullSync(callback)
@ -18,24 +28,16 @@ class MessagesImpl(context: Context) : ImHostService {
} }
} }
override fun hasMediaChanges(callback: (Result<Boolean>) -> Unit) {
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.R && SdkExtensions.getExtensionVersion(Build.VERSION_CODES.R) >= 1) {
mediaManager.hasMediaChanges(callback)
} else {
callback(Result.failure(IllegalStateException("hasMediaChanges changes not supported on this Android version.")))
}
}
override fun getMediaChanges(callback: (Result<SyncDelta>) -> Unit) { override fun getMediaChanges(callback: (Result<SyncDelta>) -> Unit) {
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.R && SdkExtensions.getExtensionVersion(Build.VERSION_CODES.R) >= 1) { if (isMediaChangesSupported()) {
mediaManager.getMediaChanges(callback) mediaManager.getMediaChanges(callback)
} else { } else {
callback(Result.failure(IllegalStateException("getMediaChanges not supported on this Android version."))) callback(Result.failure(unsupportedFeatureException()))
} }
} }
override fun checkpointSync(callback: (Result<Unit>) -> Unit) { override fun checkpointSync(callback: (Result<Unit>) -> Unit) {
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.R && SdkExtensions.getExtensionVersion(Build.VERSION_CODES.R) >= 1) { if (isMediaChangesSupported()) {
mediaManager.checkpointSync(callback) mediaManager.checkpointSync(callback)
} else { } else {
callback(Result.success(Unit)) callback(Result.success(Unit))
@ -46,10 +48,10 @@ class MessagesImpl(context: Context) : ImHostService {
albumId: String, albumId: String,
callback: (Result<List<String>>) -> Unit callback: (Result<List<String>>) -> Unit
) { ) {
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.R && SdkExtensions.getExtensionVersion(Build.VERSION_CODES.R) >= 1) { if (isMediaChangesSupported()) {
mediaManager.getAssetIdsForAlbum(albumId, callback) mediaManager.getAssetIdsForAlbum(albumId, callback)
} else { } else {
callback(Result.failure(IllegalStateException("getAssetIdsForAlbum not supported on this Android version."))) callback(Result.failure(unsupportedFeatureException()))
} }
} }
} }

83
mobile/ios/Runner/Platform/MediaManager.swift
View File

@ -1,26 +1,24 @@
import Photos import Photos
class MediaManager { class MediaManager {
let _defaults: UserDefaults private let _defaults: UserDefaults
private let _changeTokenKey = "immich:changeToken"
let _changeTokenKey = "immich:changeToken";
init(with defaults: UserDefaults = .standard) { init(with defaults: UserDefaults = .standard) {
_defaults = defaults self._defaults = defaults
} }
@available(iOS 16, *) @available(iOS 16, *)
func _getChangeToken() -> PHPersistentChangeToken? { func _getChangeToken() -> PHPersistentChangeToken? {
guard let encodedToken = _defaults.data(forKey: _changeTokenKey) else { guard let encodedToken = _defaults.data(forKey: _changeTokenKey) else {
print("_getChangeToken: Change token not available in UserDefaults") print("MediaManager::_getChangeToken: Change token not available in UserDefaults")
return nil return nil
} }
do { do {
let changeToken = try NSKeyedUnarchiver.unarchivedObject(ofClass: PHPersistentChangeToken.self, from: encodedToken) return try NSKeyedUnarchiver.unarchivedObject(ofClass: PHPersistentChangeToken.self, from: encodedToken)
return changeToken
} catch { } catch {
print("_getChangeToken: Cannot decode the token from UserDefaults") print("MediaManager::_getChangeToken: Cannot decode the token from UserDefaults")
return nil return nil
} }
} }
@ -30,9 +28,9 @@ class MediaManager {
do { do {
let encodedToken = try NSKeyedArchiver.archivedData(withRootObject: token, requiringSecureCoding: true) let encodedToken = try NSKeyedArchiver.archivedData(withRootObject: token, requiringSecureCoding: true)
_defaults.set(encodedToken, forKey: _changeTokenKey) _defaults.set(encodedToken, forKey: _changeTokenKey)
print("_setChangeToken: Change token saved to UserDefaults") print("MediaManager::_setChangeToken: Change token saved to UserDefaults")
} catch { } catch {
print("_setChangeToken: Failed to persist the token to UserDefaults: \(error)") print("MediaManager::_setChangeToken: Failed to persist the token to UserDefaults: \(error)")
} }
} }
@ -52,7 +50,7 @@ class MediaManager {
guard let storedToken = _getChangeToken() else { guard let storedToken = _getChangeToken() else {
// No token exists, perform the initial full sync // No token exists, perform the initial full sync
print("shouldUseOldSync: No token found") print("MediaManager::shouldUseOldSync: No token found. Full sync required")
completion(.success(true)) completion(.success(true))
return return
} }
@ -62,44 +60,40 @@ class MediaManager {
completion(.success(false)) completion(.success(false))
} catch { } catch {
// fallback to using old sync when we cannot detect changes using the available token // fallback to using old sync when we cannot detect changes using the available token
print("shouldUseOldSync: fetchPersistentChanges failed with error (\(error))") print("MediaManager::shouldUseOldSync: fetchPersistentChanges failed with error (\(error))")
completion(.success(true)) completion(.success(true))
} }
} }
@available(iOS 16, *)
func hasMediaChanges(completion: @escaping (Result<Bool, Error>) -> Void) {
guard PHPhotoLibrary.authorizationStatus(for: .readWrite) == .authorized else {
completion(.failure(PigeonError(code: "1", message: "No photo library access", details: nil)))
return
}
let storedToken = _getChangeToken()
let currentToken = PHPhotoLibrary.shared().currentChangeToken
completion(.success(storedToken != currentToken))
}
@available(iOS 16, *) @available(iOS 16, *)
func getMediaChanges(completion: @escaping (Result<SyncDelta, Error>) -> Void) { func getMediaChanges(completion: @escaping (Result<SyncDelta, Error>) -> Void) {
guard PHPhotoLibrary.authorizationStatus(for: .readWrite) == .authorized else { guard PHPhotoLibrary.authorizationStatus(for: .readWrite) == .authorized else {
completion(.failure(PigeonError(code: "1", message: "No photo library access", details: nil))) completion(.failure(PigeonError(code: "NO_AUTH", message: "No photo library access", details: nil)))
return return
} }
guard let storedToken = _getChangeToken() else { guard let storedToken = _getChangeToken() else {
// No token exists, definitely need a full sync // No token exists, definitely need a full sync
print("getMediaChanges: No token found") print("MediaManager::getMediaChanges: No token found")
completion(.failure(PigeonError(code: "2", message: "No stored change token", details: nil))) completion(.failure(PigeonError(code: "NO_TOKEN", message: "No stored change token", details: nil)))
return
}
let currentToken = PHPhotoLibrary.shared().currentChangeToken
if storedToken == currentToken {
completion(.success(SyncDelta(hasChanges: false, updates: [], deletes: [])))
return return
} }
do { do {
let result = try PHPhotoLibrary.shared().fetchPersistentChanges(since: storedToken) let result = try PHPhotoLibrary.shared().fetchPersistentChanges(since: storedToken)
let dateFormatter = ISO8601DateFormatter() let dateFormatter = ISO8601DateFormatter()
dateFormatter.formatOptions = [.withInternetDateTime, .withFractionalSeconds] dateFormatter.formatOptions = [.withInternetDateTime, .withFractionalSeconds]
var delta = SyncDelta(updates: [], deletes: [])
var updatedArr: [Asset] = []
var deletedArr: [String] = []
for changes in result { for changes in result {
let details = try changes.changeDetails(for: PHObjectType.asset) let details = try changes.changeDetails(for: PHObjectType.asset)
let updated = details.updatedLocalIdentifiers.union(details.insertedLocalIdentifiers) let updated = details.updatedLocalIdentifiers.union(details.insertedLocalIdentifiers)
@ -109,7 +103,6 @@ class MediaManager {
options.includeHiddenAssets = true options.includeHiddenAssets = true
let updatedAssets = PHAsset.fetchAssets(withLocalIdentifiers: Array(updated), options: options) let updatedAssets = PHAsset.fetchAssets(withLocalIdentifiers: Array(updated), options: options)
var updates: [Asset] = []
updatedAssets.enumerateObjects { (asset, _, _) in updatedAssets.enumerateObjects { (asset, _, _) in
let id = asset.localIdentifier let id = asset.localIdentifier
let name = PHAssetResource.assetResources(for: asset).first?.originalFilename ?? asset.title() let name = PHAssetResource.assetResources(for: asset).first?.originalFilename ?? asset.title()
@ -118,33 +111,41 @@ class MediaManager {
let updatedAt = asset.modificationDate.map { dateFormatter.string(from: $0) } let updatedAt = asset.modificationDate.map { dateFormatter.string(from: $0) }
let durationInSeconds: Int64 = Int64(asset.duration) let durationInSeconds: Int64 = Int64(asset.duration)
let dAsset = Asset(id: id, name: name, type: type, createdAt: createdAt, updatedAt: updatedAt, durationInSeconds: durationInSeconds, albumIds: self._getAlbumIdsForAsset(asset: asset)) let domainAsset = Asset(
updates.append(dAsset) id: id,
name: name,
type: type,
createdAt: createdAt,
updatedAt: updatedAt,
durationInSeconds: durationInSeconds,
albumIds: self._getAlbumIds(forAsset: asset)
)
updatedArr.append(domainAsset)
} }
delta.updates.append(contentsOf: updates) deletedArr.append(contentsOf: details.deletedLocalIdentifiers)
delta.deletes.append(contentsOf: deleted)
} }
let delta = SyncDelta(hasChanges: true, updates: updatedArr, deletes: deletedArr)
completion(.success(delta)) completion(.success(delta))
return return
} catch { } catch {
print("getMediaChanges: Error fetching persistent changes: \(error)") print("MediaManager::getMediaChanges: Error fetching persistent changes: \(error)")
completion(.failure(PigeonError(code: "3", message: error.localizedDescription, details: nil))) completion(.failure(PigeonError(code: "3", message: error.localizedDescription, details: nil)))
return return
} }
} }
@available(iOS 16, *) @available(iOS 16, *)
func _getAlbumIdsForAsset(asset: PHAsset) -> [String] { func _getAlbumIds(forAsset: PHAsset) -> [String] {
var albumIds: [String] = [] var albumIds: [String] = []
var albums = PHAssetCollection.fetchAssetCollectionsContaining(asset, with: .album, options: nil) let albumTypes: [PHAssetCollectionType] = [.album, .smartAlbum]
albums.enumerateObjects { (album, _, _) in
albumTypes.forEach { type in
let collections = PHAssetCollection.fetchAssetCollectionsContaining(forAsset, with: type, options: nil)
collections.enumerateObjects { (album, _, _) in
albumIds.append(album.localIdentifier) albumIds.append(album.localIdentifier)
} }
albums = PHAssetCollection.fetchAssetCollectionsContaining(asset, with: .smartAlbum, options: nil)
albums.enumerateObjects { (album, _, _) in
albumIds.append(album.localIdentifier)
} }
return albumIds return albumIds
} }

24
mobile/ios/Runner/Platform/Messages.g.swift
View File

@ -179,22 +179,26 @@ struct Asset: Hashable {
/// Generated class from Pigeon that represents data sent in messages. /// Generated class from Pigeon that represents data sent in messages.
struct SyncDelta: Hashable { struct SyncDelta: Hashable {
var hasChanges: Bool
var updates: [Asset] var updates: [Asset]
var deletes: [String] var deletes: [String]
// swift-format-ignore: AlwaysUseLowerCamelCase // swift-format-ignore: AlwaysUseLowerCamelCase
static func fromList(_ pigeonVar_list: [Any?]) -> SyncDelta? { static func fromList(_ pigeonVar_list: [Any?]) -> SyncDelta? {
let updates = pigeonVar_list[0] as! [Asset] let hasChanges = pigeonVar_list[0] as! Bool
let deletes = pigeonVar_list[1] as! [String] let updates = pigeonVar_list[1] as! [Asset]
let deletes = pigeonVar_list[2] as! [String]
return SyncDelta( return SyncDelta(
hasChanges: hasChanges,
updates: updates, updates: updates,
deletes: deletes deletes: deletes
) )
} }
func toList() -> [Any?] { func toList() -> [Any?] {
return [ return [
hasChanges,
updates, updates,
deletes, deletes,
] ]
@ -251,7 +255,6 @@ class MessagesPigeonCodec: FlutterStandardMessageCodec, @unchecked Sendable {
/// Generated protocol from Pigeon that represents a handler of messages from Flutter. /// Generated protocol from Pigeon that represents a handler of messages from Flutter.
protocol ImHostService { protocol ImHostService {
func shouldFullSync(completion: @escaping (Result<Bool, Error>) -> Void) func shouldFullSync(completion: @escaping (Result<Bool, Error>) -> Void)
func hasMediaChanges(completion: @escaping (Result<Bool, Error>) -> Void)
func getMediaChanges(completion: @escaping (Result<SyncDelta, Error>) -> Void) func getMediaChanges(completion: @escaping (Result<SyncDelta, Error>) -> Void)
func checkpointSync(completion: @escaping (Result<Void, Error>) -> Void) func checkpointSync(completion: @escaping (Result<Void, Error>) -> Void)
func getAssetIdsForAlbum(albumId: String, completion: @escaping (Result<[String], Error>) -> Void) func getAssetIdsForAlbum(albumId: String, completion: @escaping (Result<[String], Error>) -> Void)
@ -283,21 +286,6 @@ class ImHostServiceSetup {
} else { } else {
shouldFullSyncChannel.setMessageHandler(nil) shouldFullSyncChannel.setMessageHandler(nil)
} }
let hasMediaChangesChannel = FlutterBasicMessageChannel(name: "dev.flutter.pigeon.immich_mobile.ImHostService.hasMediaChanges\(channelSuffix)", binaryMessenger: binaryMessenger, codec: codec)
if let api = api {
hasMediaChangesChannel.setMessageHandler { _, reply in
api.hasMediaChanges { result in
switch result {
case .success(let res):
reply(wrapResult(res))
case .failure(let error):
reply(wrapError(error))
}
}
}
} else {
hasMediaChangesChannel.setMessageHandler(nil)
}
let getMediaChangesChannel = taskQueue == nil let getMediaChangesChannel = taskQueue == nil
? FlutterBasicMessageChannel(name: "dev.flutter.pigeon.immich_mobile.ImHostService.getMediaChanges\(channelSuffix)", binaryMessenger: binaryMessenger, codec: codec) ? FlutterBasicMessageChannel(name: "dev.flutter.pigeon.immich_mobile.ImHostService.getMediaChanges\(channelSuffix)", binaryMessenger: binaryMessenger, codec: codec)
: FlutterBasicMessageChannel(name: "dev.flutter.pigeon.immich_mobile.ImHostService.getMediaChanges\(channelSuffix)", binaryMessenger: binaryMessenger, codec: codec, taskQueue: taskQueue) : FlutterBasicMessageChannel(name: "dev.flutter.pigeon.immich_mobile.ImHostService.getMediaChanges\(channelSuffix)", binaryMessenger: binaryMessenger, codec: codec, taskQueue: taskQueue)

21
mobile/ios/Runner/Platform/MessagesImpl.swift
View File

@ -4,33 +4,24 @@ class ImHostServiceImpl: ImHostService {
let _mediaManager: MediaManager let _mediaManager: MediaManager
init() { init() {
_mediaManager = MediaManager() self._mediaManager = MediaManager()
} }
func shouldFullSync(completion: @escaping (Result<Bool, Error>) -> Void) { func shouldFullSync(completion: @escaping (Result<Bool, Error>) -> Void) {
if #available(iOS 16, *) { if #available(iOS 16, *) {
_mediaManager.shouldFullSync(completion: completion) _mediaManager.shouldFullSync(completion: completion)
return;
} else { } else {
// Always fall back to full sync on older iOS versions // Always fall back to full sync on older iOS versions
completion(.success(true)) completion(.success(true))
} }
} }
func hasMediaChanges(completion: @escaping (Result<Bool, Error>) -> Void) {
if #available(iOS 16, *) {
_mediaManager.hasMediaChanges(completion: completion)
} else {
completion(.failure(PigeonError(code: "-1", message: "Not supported", details: nil)))
}
}
func getMediaChanges(completion: @escaping (Result<SyncDelta, Error>) -> Void) { func getMediaChanges(completion: @escaping (Result<SyncDelta, Error>) -> Void) {
if #available(iOS 16, *) { guard #available(iOS 16, *) else {
_mediaManager.getMediaChanges(completion: completion) completion(.failure(PigeonError(code: "UNSUPPORTED_OS", message: "This feature requires iOS 16 or later.", details: nil)))
} else { return
completion(.failure(PigeonError(code: "-1", message: "Not supported", details: nil)))
} }
_mediaManager.getMediaChanges(completion: completion)
} }
func checkpointSync(completion: @escaping (Result<Void, any Error>) -> Void) { func checkpointSync(completion: @escaping (Result<Void, any Error>) -> Void) {
@ -42,7 +33,7 @@ class ImHostServiceImpl: ImHostService {
} }
func getAssetIdsForAlbum(albumId: String, completion: @escaping (Result<[String], any Error>) -> Void) { func getAssetIdsForAlbum(albumId: String, completion: @escaping (Result<[String], any Error>) -> Void) {
// Android specific, ignore the call with an empty list // Android specific, empty list is safe no-op
completion(.success([])) completion(.success([]))
} }
} }

5
mobile/lib/domain/services/device_sync.service.dart
View File

@ -35,15 +35,14 @@ class DeviceSyncService {
return await fullSync(); return await fullSync();
} }
if (!await _hostService.hasMediaChanges()) { final delta = await _hostService.getMediaChanges();
if (!delta.hasChanges) {
_log.fine("No media changes detected. Skipping sync"); _log.fine("No media changes detected. Skipping sync");
return; return;
} }
final deviceAlbums = await _albumMediaRepository.getAll(); final deviceAlbums = await _albumMediaRepository.getAll();
await _localAlbumRepository.updateAll(deviceAlbums); await _localAlbumRepository.updateAll(deviceAlbums);
final delta = await _hostService.getMediaChanges();
await _localAlbumRepository.handleSyncDelta(delta); await _localAlbumRepository.handleSyncDelta(delta);
if (_platform.isAndroid) { if (_platform.isAndroid) {

10
mobile/lib/platform/messages.dart
View File

@ -33,7 +33,12 @@ class Asset {
} }
class SyncDelta { class SyncDelta {
SyncDelta({this.updates = const [], this.deletes = const []}); SyncDelta({
this.hasChanges = false,
this.updates = const [],
this.deletes = const [],
});
bool hasChanges;
List<Asset> updates; List<Asset> updates;
List<String> deletes; List<String> deletes;
} }
@ -43,9 +48,6 @@ abstract class ImHostService {
@async @async
bool shouldFullSync(); bool shouldFullSync();
@async
bool hasMediaChanges();
@async @async
@TaskQueue(type: TaskQueueType.serialBackgroundThread) @TaskQueue(type: TaskQueueType.serialBackgroundThread)
SyncDelta getMediaChanges(); SyncDelta getMediaChanges();

88
mobile/lib/platform/messages.g.dart generated
View File

@ -14,6 +14,7 @@ PlatformException _createConnectionError(String channelName) {
message: 'Unable to establish connection on channel: "$channelName".', message: 'Unable to establish connection on channel: "$channelName".',
); );
} }
bool _deepEquals(Object? a, Object? b) { bool _deepEquals(Object? a, Object? b) {
if (a is List && b is List) { if (a is List && b is List) {
return a.length == b.length && return a.length == b.length &&
@ -21,14 +22,14 @@ bool _deepEquals(Object? a, Object? b) {
.every(((int, dynamic) item) => _deepEquals(item.$2, b[item.$1])); .every(((int, dynamic) item) => _deepEquals(item.$2, b[item.$1]));
} }
if (a is Map && b is Map) { if (a is Map && b is Map) {
return a.length == b.length && a.entries.every((MapEntry<Object?, Object?> entry) => return a.length == b.length &&
a.entries.every((MapEntry<Object?, Object?> entry) =>
(b as Map<Object?, Object?>).containsKey(entry.key) && (b as Map<Object?, Object?>).containsKey(entry.key) &&
_deepEquals(entry.value, b[entry.key])); _deepEquals(entry.value, b[entry.key]));
} }
return a == b; return a == b;
} }
class Asset { class Asset {
Asset({ Asset({
required this.id, required this.id,
@ -67,7 +68,8 @@ class Asset {
} }
Object encode() { Object encode() {
return _toList(); } return _toList();
}
static Asset decode(Object result) { static Asset decode(Object result) {
result as List<Object?>; result as List<Object?>;
@ -96,35 +98,40 @@ class Asset {
@override @override
// ignore: avoid_equals_and_hash_code_on_mutable_classes // ignore: avoid_equals_and_hash_code_on_mutable_classes
int get hashCode => Object.hashAll(_toList()) int get hashCode => Object.hashAll(_toList());
;
} }
class SyncDelta { class SyncDelta {
SyncDelta({ SyncDelta({
this.hasChanges = false,
this.updates = const [], this.updates = const [],
this.deletes = const [], this.deletes = const [],
}); });
bool hasChanges;
List<Asset> updates; List<Asset> updates;
List<String> deletes; List<String> deletes;
List<Object?> _toList() { List<Object?> _toList() {
return <Object?>[ return <Object?>[
hasChanges,
updates, updates,
deletes, deletes,
]; ];
} }
Object encode() { Object encode() {
return _toList(); } return _toList();
}
static SyncDelta decode(Object result) { static SyncDelta decode(Object result) {
result as List<Object?>; result as List<Object?>;
return SyncDelta( return SyncDelta(
updates: (result[0] as List<Object?>?)!.cast<Asset>(), hasChanges: result[0]! as bool,
deletes: (result[1] as List<Object?>?)!.cast<String>(), updates: (result[1] as List<Object?>?)!.cast<Asset>(),
deletes: (result[2] as List<Object?>?)!.cast<String>(),
); );
} }
@ -142,11 +149,9 @@ class SyncDelta {
@override @override
// ignore: avoid_equals_and_hash_code_on_mutable_classes // ignore: avoid_equals_and_hash_code_on_mutable_classes
int get hashCode => Object.hashAll(_toList()) int get hashCode => Object.hashAll(_toList());
;
} }
class _PigeonCodec extends StandardMessageCodec { class _PigeonCodec extends StandardMessageCodec {
const _PigeonCodec(); const _PigeonCodec();
@override @override
@ -182,9 +187,11 @@ class ImHostService {
/// Constructor for [ImHostService]. The [binaryMessenger] named argument is /// Constructor for [ImHostService]. The [binaryMessenger] named argument is
/// available for dependency injection. If it is left null, the default /// available for dependency injection. If it is left null, the default
/// BinaryMessenger will be used which routes to the host platform. /// BinaryMessenger will be used which routes to the host platform.
ImHostService({BinaryMessenger? binaryMessenger, String messageChannelSuffix = ''}) ImHostService(
{BinaryMessenger? binaryMessenger, String messageChannelSuffix = ''})
: pigeonVar_binaryMessenger = binaryMessenger, : pigeonVar_binaryMessenger = binaryMessenger,
pigeonVar_messageChannelSuffix = messageChannelSuffix.isNotEmpty ? '.$messageChannelSuffix' : ''; pigeonVar_messageChannelSuffix =
messageChannelSuffix.isNotEmpty ? '.$messageChannelSuffix' : '';
final BinaryMessenger? pigeonVar_binaryMessenger; final BinaryMessenger? pigeonVar_binaryMessenger;
static const MessageCodec<Object?> pigeonChannelCodec = _PigeonCodec(); static const MessageCodec<Object?> pigeonChannelCodec = _PigeonCodec();
@ -192,36 +199,10 @@ class ImHostService {
final String pigeonVar_messageChannelSuffix; final String pigeonVar_messageChannelSuffix;
Future<bool> shouldFullSync() async { Future<bool> shouldFullSync() async {
final String pigeonVar_channelName = 'dev.flutter.pigeon.immich_mobile.ImHostService.shouldFullSync$pigeonVar_messageChannelSuffix'; final String pigeonVar_channelName =
final BasicMessageChannel<Object?> pigeonVar_channel = BasicMessageChannel<Object?>( 'dev.flutter.pigeon.immich_mobile.ImHostService.shouldFullSync$pigeonVar_messageChannelSuffix';
pigeonVar_channelName, final BasicMessageChannel<Object?> pigeonVar_channel =
pigeonChannelCodec, BasicMessageChannel<Object?>(
binaryMessenger: pigeonVar_binaryMessenger,
);
final Future<Object?> pigeonVar_sendFuture = pigeonVar_channel.send(null);
final List<Object?>? pigeonVar_replyList =
await pigeonVar_sendFuture as List<Object?>?;
if (pigeonVar_replyList == null) {
throw _createConnectionError(pigeonVar_channelName);
} else if (pigeonVar_replyList.length > 1) {
throw PlatformException(
code: pigeonVar_replyList[0]! as String,
message: pigeonVar_replyList[1] as String?,
details: pigeonVar_replyList[2],
);
} else if (pigeonVar_replyList[0] == null) {
throw PlatformException(
code: 'null-error',
message: 'Host platform returned null value for non-null return value.',
);
} else {
return (pigeonVar_replyList[0] as bool?)!;
}
}
Future<bool> hasMediaChanges() async {
final String pigeonVar_channelName = 'dev.flutter.pigeon.immich_mobile.ImHostService.hasMediaChanges$pigeonVar_messageChannelSuffix';
final BasicMessageChannel<Object?> pigeonVar_channel = BasicMessageChannel<Object?>(
pigeonVar_channelName, pigeonVar_channelName,
pigeonChannelCodec, pigeonChannelCodec,
binaryMessenger: pigeonVar_binaryMessenger, binaryMessenger: pigeonVar_binaryMessenger,
@ -248,8 +229,10 @@ class ImHostService {
} }
Future<SyncDelta> getMediaChanges() async { Future<SyncDelta> getMediaChanges() async {
final String pigeonVar_channelName = 'dev.flutter.pigeon.immich_mobile.ImHostService.getMediaChanges$pigeonVar_messageChannelSuffix'; final String pigeonVar_channelName =
final BasicMessageChannel<Object?> pigeonVar_channel = BasicMessageChannel<Object?>( 'dev.flutter.pigeon.immich_mobile.ImHostService.getMediaChanges$pigeonVar_messageChannelSuffix';
final BasicMessageChannel<Object?> pigeonVar_channel =
BasicMessageChannel<Object?>(
pigeonVar_channelName, pigeonVar_channelName,
pigeonChannelCodec, pigeonChannelCodec,
binaryMessenger: pigeonVar_binaryMessenger, binaryMessenger: pigeonVar_binaryMessenger,
@ -276,8 +259,10 @@ class ImHostService {
} }
Future<void> checkpointSync() async { Future<void> checkpointSync() async {
final String pigeonVar_channelName = 'dev.flutter.pigeon.immich_mobile.ImHostService.checkpointSync$pigeonVar_messageChannelSuffix'; final String pigeonVar_channelName =
final BasicMessageChannel<Object?> pigeonVar_channel = BasicMessageChannel<Object?>( 'dev.flutter.pigeon.immich_mobile.ImHostService.checkpointSync$pigeonVar_messageChannelSuffix';
final BasicMessageChannel<Object?> pigeonVar_channel =
BasicMessageChannel<Object?>(
pigeonVar_channelName, pigeonVar_channelName,
pigeonChannelCodec, pigeonChannelCodec,
binaryMessenger: pigeonVar_binaryMessenger, binaryMessenger: pigeonVar_binaryMessenger,
@ -299,13 +284,16 @@ class ImHostService {
} }
Future<List<String>> getAssetIdsForAlbum(String albumId) async { Future<List<String>> getAssetIdsForAlbum(String albumId) async {
final String pigeonVar_channelName = 'dev.flutter.pigeon.immich_mobile.ImHostService.getAssetIdsForAlbum$pigeonVar_messageChannelSuffix'; final String pigeonVar_channelName =
final BasicMessageChannel<Object?> pigeonVar_channel = BasicMessageChannel<Object?>( 'dev.flutter.pigeon.immich_mobile.ImHostService.getAssetIdsForAlbum$pigeonVar_messageChannelSuffix';
final BasicMessageChannel<Object?> pigeonVar_channel =
BasicMessageChannel<Object?>(
pigeonVar_channelName, pigeonVar_channelName,
pigeonChannelCodec, pigeonChannelCodec,
binaryMessenger: pigeonVar_binaryMessenger, binaryMessenger: pigeonVar_binaryMessenger,
); );
final Future<Object?> pigeonVar_sendFuture = pigeonVar_channel.send(<Object?>[albumId]); final Future<Object?> pigeonVar_sendFuture =
pigeonVar_channel.send(<Object?>[albumId]);
final List<Object?>? pigeonVar_replyList = final List<Object?>? pigeonVar_replyList =
await pigeonVar_sendFuture as List<Object?>?; await pigeonVar_sendFuture as List<Object?>?;
if (pigeonVar_replyList == null) { if (pigeonVar_replyList == null) {