Quelle  BlobManager.swift   Sprache: JAVA

import CocoaLumberjackSwift
import Foundation
import ThreemaEssentials

// MARK: - BlobManagerDelegate

protocol BlobManagerDelegate: AnyObject {
    func updateProgress(for objectID: NSManagedObjectID, didUpdate progress: Progress) async
}

/// Central manager creating, coordinating and observing blob up- & downloads of BlobData asynchronously
public actor BlobManager: BlobManagerProtocol {
    
    /// Shared `BlobManager`, always use this, except for testing.
    /// To see its default values, look at the `init()` below.
    public static let shared = BlobManager()
    
    // MARK: - Private properties

    private static let state = BlobManagerState()
    private static let activeState = BlobManagerActiveState()
    
    private let sessionManager: URLSessionManager
    private let serverConnector: ServerConnectorProtocol
    private let serverInfoProvider: ServerInfoProvider
    private let userSettings: UserSettingsProtocol

    private let blobURL: BlobURL
    private let blobDownloader: BlobDownloader
    private let blobUploader: BlobUploader

    private let injectedEntityManager: EntityManager?
    private let injectedGroupManager: GroupManagerProtocol?

    /// The entityManager is implemented like this, because we needed a
    /// possibility to override it for testing.
    /// Further, to solve CoreData context syncing issues, we create a new
    /// one every time we save or fetch something.
    private var entityManager: EntityManager {
        if let entityManager = injectedEntityManager {
            return entityManager
        }
        return PersistenceManager(
            appGroupID: AppGroup.groupID(),
            userDefaults: AppGroup.userDefaults(),
            remoteSecretManager: RemoteSecretProvider.remoteSecretManager
        ).backgroundEntityManager
    }
    
    private var groupManager: GroupManagerProtocol {
        if let groupManager = injectedGroupManager {
            return groupManager
        }
        return GroupManager(entityManager: entityManager)
    }
    
    // MARK: - Lifecycle
    
    /// Initializes a BlobManager, **only** use for testing, otherwise use `BlobManager.shared`
    /// - Parameters:
    ///   - entityManager: EntityManager to be used to fetch and save, default is
    ///                    `EntityManager(withChildContextForBackgroundProcess: true)`
    ///   - sessionManager: URLSessionManager, default is `URLSessionManager.shared`
    ///   - serverConnector: ServerConnector, default is `ServerConnector.shared`
    ///   - serverInfoProvider: ServerInfoProviderFactory, default is
    ///                         `ServerInfoProviderFactory.makeServerInfoProvider()`
    ///   - userSettings: UserSettingsProtocol, default is `UserSettings.shared()`
    init(
        entityManager: EntityManager? = nil,
        groupManager: GroupManagerProtocol? = nil,
        sessionManager: URLSessionManager = URLSessionManager.shared,
        serverConnector: ServerConnectorProtocol = ServerConnector.shared(),
        serverInfoProvider: ServerInfoProvider = ServerInfoProviderFactory.makeServerInfoProvider(),
        userSettings: UserSettingsProtocol = UserSettings.shared()
    ) {
        self.injectedEntityManager = entityManager
        self.injectedGroupManager = groupManager
        self.sessionManager = sessionManager
        self.serverConnector = serverConnector
        self.serverInfoProvider = serverInfoProvider
        self.userSettings = userSettings

        self.blobURL = BlobURL(
            serverConnector: serverConnector,
            userSettings: userSettings,
            serverInfoProvider: serverInfoProvider
        )
        self.blobDownloader = BlobDownloader(blobURL: blobURL, sessionManager: sessionManager)
        self.blobUploader = BlobUploader(blobURL: blobURL, sessionManager: sessionManager)
    }
    
    // MARK: - Public interface
        
    /// Start automatic download of blobs in passed object
    /// - Parameter objectID: Object to sync blobs for
    public func autoSyncBlobs(for objectID: NSManagedObjectID) async {
        var shouldSync = false
        
        // We check if the message is of the right type, and if it is incoming since we do not want to automatically
        // send failed messages again
        let em = entityManager
        var blobID: String?
        var blobThumbnailID: String?

        await em.performSave {
            guard let message = em.entityFetcher.existingObject(with: objectID) as? FileMessageProvider,
                  !message.blobIsOutgoing else {
                return
            }
            
            blobID = message.blobIdentifier?.hexString
            blobThumbnailID = message.blobThumbnailIdentifier?.hexString

            switch message.fileMessageType {
            case .image, .sticker, .animatedImage, .animatedSticker, .voice:
                shouldSync = true
            case .video, .file:
                shouldSync = false
            }
        }
        
        guard shouldSync else {
            return
        }
        
        // Then we start the sync
        do {
            let result = try await syncBlobsThrows(for: objectID)
            assert(result != .uploaded, "This should never upload media")
        }
        catch {
            let messageID = await messageIDString(for: objectID)
            
            DDLogError(
                "[BlobManager] Auto sync for message with id: \(messageID), blobID: \(blobID ?? "nil"), and thumbnailID: \(blobThumbnailID ?? "nil") failed, reason: \(error)"
            )
        }
    }
    
    /// Start up- or download of blobs in passed object
    /// - Parameter objectID: Object to sync blobs for
    public func syncBlobs(for objectID: NSManagedObjectID) async -> BlobManagerResult {
        // This should not need any additional functionality. Add it below to `syncBlobsThrows(for:)` if needed.
        do {
            return try await syncBlobsThrows(for: objectID)
        }
        catch {
            let em = entityManager
            var messageID: String?
            var blobID: String?
            var blobThumbnailID: String?
            
            em.performAndWaitSave {
                guard let message = em.entityFetcher.existingObject(with: objectID) as? FileMessage else {
                    return
                }
                messageID = message.id.hexString
                blobID = message.blobIdentifier?.hexString
                blobThumbnailID = message.blobThumbnailIdentifier?.hexString
            }
            
            DDLogError(
                "[BlobManager] Sync for message with messageID: \(messageID ?? "nil"), blobID: \(blobID ?? "nil"), and thumbnailID: \(blobThumbnailID ?? "nil") failed, reason: \(error)"
            )
            
            return .failed
        }
    }
    
    /// Same as `syncBlobs(for:)` but throws an error if there was any
    ///
    /// Used in `syncBlobs(for:)` but exposed for testing
    ///
    /// - Parameter objectID: Object to sync blobs for
    public func syncBlobsThrows(for objectID: NSManagedObjectID) async throws -> BlobManagerResult {
        
        // We do not even attempt to sync if blob is for note group or we are not connected
        guard !isForNoteGroup(objectID: objectID) else {
            DDLogNotice("[BlobManager] Tried to sync for note group.")
            throw BlobManagerError.noteGroupNeedsNoSync
        }
        
        guard serverConnector.connectionState == .loggedIn else {
            DDLogNotice("[BlobManager] Tried to sync while not connected.")
            throw BlobManagerError.notConnected
        }
        
        try await BlobManager.state.addActiveObjectID(objectID)
        BlobManager.activeState.hasActiveSyncs = true
        
        do {
            let result = try await startSync(for: objectID)
            resetStatesForBlob(with: objectID)
            await BlobManager.state.removeActiveObjectIDAndProgress(for: objectID)
           
            // Update non isolated state tracker
            if await !(BlobManager.state.hasActiveObjectIDs()) {
                BlobManager.activeState.hasActiveSyncs = false
            }
            
            return result
        }
        catch {
            setErrorStateForBlob(with: objectID)
            await BlobManager.state.removeActiveObjectIDAndProgress(for: objectID)
            
            // Update non isolated state tracker
            if await !(BlobManager.state.hasActiveObjectIDs()) {
                BlobManager.activeState.hasActiveSyncs = false
            }
            
            throw error
        }
    }
    
    /// Cancel any active blob up- or downloads for passed object
    /// Note: This does not cancel thumbnail syncs
    /// - Parameter objectID: Managed object ID of object to cancel blob sync for
    public func cancelBlobsSync(for objectID: NSManagedObjectID) async {
        if await BlobManager.state.removeActiveObjectIDAndProgress(for: objectID) {
            
            let messageID = await messageIDString(for: objectID)
            DDLogNotice("[BlobManager] Cancelling download for messageID: \(messageID)")
        
            blobDownloader.cancelDownload(for: objectID)
            blobUploader.cancelUpload(for: objectID)
            resetStatesForBlob(with: objectID)
        }
        
        // Update non isolated state tracker
        if await !(BlobManager.state.hasActiveObjectIDs()) {
            BlobManager.activeState.hasActiveSyncs = false
        }
    }
    
    /// Checks the non isolated state tracker if there are any active blob syncs. Might not return the correct value
    /// since it is not handled in actor isolation.
    /// - Returns: `True` if there are probably some active syncs.
    public nonisolated func hasActiveSyncs() -> Bool {
        BlobManager.activeState.hasActiveSyncs
    }
    
    // MARK: - State handling and processing logic
    
    private func startSync(for objectID: NSManagedObjectID) async throws -> BlobManagerResult {

        // Safely load data and states concurrently
        var em = entityManager
        let (blobDataState, thumbnailState) = try await em.perform {
            guard let blobData = em.entityFetcher.existingObject(with: objectID) as? BlobData else {
                DDLogError("[BlobManager] Unable to load message as BlobData for object ID: \(objectID)")
                throw BlobManagerError.unableToLoadMessageAsBlobData
            }
            
            return (blobData.dataState, blobData.thumbnailState)
        }
        
        // Differentiate between incoming and outgoing
        if case let .incoming(incomingThumbnailState) = thumbnailState,
           case let .incoming(incomingDataState) = blobDataState {
            // Check is legacy image message
            if await isLegacyImageMessage(objectID: objectID) {
                return try await downloadLegacyImageMessage(objectID: objectID, with: incomingDataState)
            }

            // We don't do this in parallel for now to make everything testable
            try await syncIncomingThumbnail(of: objectID, with: incomingThumbnailState)
            return try await syncIncomingData(of: objectID, with: incomingDataState)
        }
        else if case let .outgoing(outgoingThumbnailState) = thumbnailState,
                case let .outgoing(outgoingDataState) = blobDataState {
            
            // We directly return if blob is for note group
            guard !isForNoteGroup(objectID: objectID) else {
                DDLogNotice("[BlobManager] Tried to sync for note group.")
                throw BlobManagerError.noteGroupNeedsNoSync
            }
            
            // We don't do this in parallel for now to make everything testable
            try await syncOutgoingThumbnail(of: objectID, with: outgoingThumbnailState)
            let result = try await syncOutgoingData(of: objectID, with: outgoingDataState)

            // Upload succeeded, we reset the progress
            em = entityManager
            em.performAndWaitSave {
                guard let blobData = em.entityFetcher
                    .existingObject(with: objectID) as? BlobData
                else {
                    DDLogError("[BlobManager] Unable to load message as BlobData for object ID: \(objectID)")
                    return
                }
                
                blobData.blobProgress = nil
            }
            
            return result
        }
        else {
            DDLogError("[BlobManager] Thumbnail and Data have different directions.")
            throw BlobManagerError.stateMismatch
        }
    }
    
    // MARK: Incoming Thumbnail
    
    private func syncIncomingThumbnail(
        of objectID: NSManagedObjectID,
        with state: IncomingBlobState
    ) async throws {
        
        // We return directly if the thumbnail is downloaded and fully processed
        guard state != .processed else {
            return
        }
        
        var blobData: BlobData?
        var encryptionKey: Data?
        var thumbnailID: Data?
        var origin: BlobOrigin?
        
        let em = entityManager
        em.performAndWait {
            guard let bd = em.entityFetcher
                .existingObject(with: objectID) as? BlobData
            else {
                DDLogError("[BlobManager] Unable to load message as BlobData for object ID: \(objectID)")
                return
            }
            blobData = bd
            encryptionKey = bd.blobEncryptionKey
            thumbnailID = bd.blobThumbnailIdentifier
            origin = bd.blobOrigin
        }
        
        guard let blobData else {
            DDLogError("[BlobManager] Unable to load message as BlobData for object ID: \(objectID)")
            return
        }
        
        guard let thumbnailID else {
            DDLogNotice("[BlobManager] There is no thumbnailID available for given blob.")
            return
        }
        
        guard let origin else {
            DDLogNotice("[BlobManager] There is no origin available for given blob.")
            return
        }
                
        switch state {
        case .remote:
            em.performAndWaitSave {
                // Note: This will also reset the error of the belonging incomingDataState
                blobData.blobError = false
                if blobData.blobProgress == nil {
                    // If not already done, we set the progress to 0.0 to indicate work has started
                    blobData.blobProgress = 0.0
                }
            }
            
            let thumbnail = try await downloadBlob(
                for: thumbnailID,
                origin: origin,
                objectID: objectID,
                encryptionKey: encryptionKey,
                nonce: ThreemaProtocol.nonce02,
                trackProgress: false
            )
            
            // This is save. Delegate calls will not result in another update of the progress as the
            // objectID is no-more in `activeObjectIDs`.
            em.performAndWaitSave {
                blobData.blobThumbnail = thumbnail
            }
            
            try await markDownloadDone(for: thumbnailID, objectID: objectID, origin: origin)
            
        default:
            DDLogNotice(
                "[BlobManager] Blob does not need any action, current state is \(state.description)."
            )
        }
    }

    // MARK: Incoming Data
    
    private func syncIncomingData(
        of objectID: NSManagedObjectID,
        with state: IncomingBlobState
    ) async throws -> BlobManagerResult {
        
        // We return directly if the data is already downloaded and fully processed
        guard state != .processed else {
            return .downloaded
        }
        
        var blobData: BlobData?
        var encryptionKey: Data?
        var dataID: Data?
        var origin: BlobOrigin?
        
        let em = entityManager
        em.performAndWait {
            guard let bd = em.entityFetcher
                .existingObject(with: objectID) as? BlobData
            else {
                DDLogError("[BlobManager] Unable to load message as BlobData for object ID: \(objectID)")
                return
            }
            
            blobData = bd
            encryptionKey = bd.blobEncryptionKey
            dataID = bd.blobIdentifier
            origin = bd.blobOrigin
        }
        
        guard let blobData else {
            DDLogError("[BlobManager] Unable to load message as BlobData for object ID: \(objectID)")
            throw BlobManagerError.unableToLoadMessageAsBlobData
        }
        
        guard let dataID else {
            DDLogNotice("[BlobManager] There is no dataID available for given blob.")
            throw BlobManagerError.noID
        }
        
        guard let origin else {
            DDLogNotice("[BlobManager] There is no origin available for given blob.")
            throw BlobManagerError.noOrigin
        }
        
        switch state {
        case .remote:
            em.performAndWaitSave {
                blobData.blobError = false
                if blobData.blobProgress == nil {
                    // If not already done, we set the progress to 0.0 to indicate work has started
                    blobData.blobProgress = 0.0
                }
            }
            
            let data = try await downloadBlob(
                for: dataID,
                origin: origin,
                objectID: objectID,
                encryptionKey: encryptionKey,
                nonce: ThreemaProtocol.nonce01,
                trackProgress: true
            )
            
            // This is save. Delegate calls will not result in another update of the progress as the
            // objectID is no-more in `activeObjectIDs`.
            em.performAndWaitSave {
                blobData.blobData = data
            }
            
            try await markDownloadDone(for: dataID, objectID: objectID, origin: origin)
            
            // Download succeeded, we reset the progress
            em.performAndWaitSave {
                blobData.blobProgress = nil
            }
            
            autoSaveMedia(objectID: objectID)
            
            return .downloaded
            
        default:
            DDLogNotice("[BlobManager] Data of blob does not need any action, current state is \(state.description).")
            return .inProgress
        }
    }
    
    private func downloadBlob(
        for blobID: Data,
        origin: BlobOrigin,
        objectID: NSManagedObjectID,
        encryptionKey: Data?,
        nonce: Data,
        trackProgress: Bool
    ) async throws -> Data {
               
        // Tracking
        if trackProgress {
            await BlobManager.state.setProgress(for: objectID, to: 0.0)
        }
        
        let messageID = await messageIDString(for: objectID)
        DDLogNotice(
            "[BlobManager] Starting download for messageID: \(messageID), blobID: \(blobID.hexString), origin:\(origin)"
        )

        // Download, Decrypt & Save
        let encryptedData = try await blobDownloader.download(
            blobID: blobID,
            origin: origin,
            objectID: objectID,
            delegate: self
        )
        
        guard let decryptedData = NaClCrypto.shared().symmetricDecryptData(
            encryptedData,
            withKey: encryptionKey,
            nonce: nonce
        ) else {
            DDLogNotice("[BlobManager] Data of blob could not be decrypted.")
            throw BlobManagerError.cryptographyFailed
        }
        
        return decryptedData
    }
    
    private func markDownloadDone(for blobID: Data, objectID: NSManagedObjectID, origin: BlobOrigin) async throws {
        
        var isGroupMessage: Bool?
        var messageID: String?
        let em = entityManager
        em.performAndWaitSave {
            guard let fetchedMessage = em.entityFetcher.existingObject(with: objectID) as? BaseMessageEntity
            else {
                return
            }
            isGroupMessage = fetchedMessage.isGroupMessage
            messageID = fetchedMessage.id.hexString
        }
        
        guard let isGroupMessage, !isGroupMessage else {
            DDLogInfo("[BlobManager] Do not mark downloads done for group messages. id: \(messageID ?? "nil")")
            return
        }
        
        guard let url = try await blobURL.done(blobID: blobID, origin: origin) else {
            throw BlobManagerError.markDoneFailed
        }
        
        let client = HTTPClient(sessionManager: sessionManager)
        try await client.sendDone(url: url)
        DDLogNotice(
            "[BlobManager] Marked blob as done for messageID: \(messageID ?? "nil"), blobID: \(blobID.hexString), origin:\(origin)"
        )
    }
    
    private func autoSaveMedia(objectID: NSManagedObjectID) {
        guard UserSettings.shared().autoSaveMedia else {
            return
        }
    
        Task {
            let em = entityManager
            
            em.performAndWait {
                guard let fetchedMessage = em.entityFetcher.existingObject(with: objectID) as? ThumbnailDisplayMessage
                else {
                    DDLogInfo("[BlobManager] ThumbnailDisplayMessage of media to be autosaved not found.")
                    
                    NotificationPresenterWrapper.shared.present(type: .autosaveMediaError)
                    return
                }
                
                // If message should not be autosaved at all we simply return.
                guard fetchedMessage.assetResourceTypeForAutosave != nil else {
                    return
                }
                
                // If message belongs to private chat we simply return too.
                guard fetchedMessage.conversation.conversationCategory != .private else {
                    return
                }
                
                guard let saveMediaItem = fetchedMessage.createSaveMediaItem(forAutosave: true) else {
                    DDLogInfo("[BlobManager] Getting SaveMediaItem to auto-save failed.")
                    
                    NotificationPresenterWrapper.shared.present(type: .autosaveMediaError)
                    return
                }
                
                AlbumManager.shared.save(saveMediaItem, showNotifications: false, autosave: true)
            }
        }
    }
    
    // MARK: Outgoing Thumbnail
    
    private func syncOutgoingThumbnail(
        of objectID: NSManagedObjectID,
        with state: OutgoingBlobState
    ) async throws {
        
        // We return directly if the thumbnail is already uploaded or there is no thumbnail to upload
        // TODO: (IOS-2861) Check if we failed to generate thumbnail and retry if so
        guard state != .remote, state != .noData(.noThumbnail) else {
            return
        }

        var blobData: BlobData?
        var thumbnailID: Data?
        var thumbnailData: Data?
        var encryptionKey: Data?
        var origin: BlobOrigin?
        var setPersistParam: Bool?
        
        let em = entityManager
        em.performAndWait {
            guard let bd = em.entityFetcher
                .existingObject(with: objectID) as? BlobData
            else {
                DDLogError("[BlobManager] Unable to load message as BlobData for object ID: \(objectID)")
                return
            }
            
            blobData = bd
            thumbnailID = bd.blobThumbnailIdentifier
            thumbnailData = bd.blobThumbnail
            encryptionKey = bd.blobEncryptionKey
            origin = bd.blobOrigin
            setPersistParam = bd.isPersistingBlob
        }
        
        guard let blobData else {
            DDLogError("[BlobManager] Unable to load message as BlobData for object ID: \(objectID)")
            return
        }
        
        guard let encryptionKey else {
            DDLogNotice("[BlobManager] Encryption Key not found.")
            throw BlobManagerError.noEncryptionKey
        }
        
        guard let origin else {
            DDLogNotice("[BlobManager] There is no origin available for given blob.")
            throw BlobManagerError.noOrigin
        }
        
        guard let setPersistParam else {
            DDLogNotice("[BlobManager] There is no persist indicator set for given blob thumbnail.")
            throw BlobManagerError.noPersistParam
        }
                       
        switch state {
        case .pendingDownload:
            guard let thumbnailID else {
                throw BlobManagerError.noID
            }

            em.performAndWaitSave {
                // Note: This will also reset the error of the belonging incomingDataState
                blobData.blobError = false
                if blobData.blobProgress == nil {
                    // If not already done, we set the progress to 0.0 to indicate work has started
                    blobData.blobProgress = 0.0
                }
            }

            let thumbnail = try await downloadBlob(
                for: thumbnailID,
                origin: origin,
                objectID: objectID,
                encryptionKey: encryptionKey,
                nonce: ThreemaProtocol.nonce02,
                trackProgress: false
            )

            // This is save. Delegate calls will not result in another update of the progress as the
            // objectID is no-more in `activeObjectIDs`.
            em.performAndWaitSave {
                blobData.blobThumbnail = thumbnail
            }

            try await markDownloadDone(for: thumbnailID, objectID: objectID, origin: origin)

        case .pendingUpload:
            guard let thumbnailData else {
                DDLogNotice("[BlobManager] Thumbnail has no data.")
                // We return here to still upload data
                return
            }

            em.performAndWaitSave {
                // Note: This will also reset the error of the belonging outgoingDataState
                blobData.blobError = false
                if blobData.blobProgress == nil {
                    // If not already done, we set the progress to 0.0 to indicate work has started
                    blobData.blobProgress = 0.0
                }
            }
            
            // Upload data to get ID
            let thumbnailID = try await uploadBlob(
                for: thumbnailData,
                origin: origin,
                objectID: objectID,
                encryptionKey: encryptionKey,
                nonce: ThreemaProtocol.nonce02,
                trackProgress: false,
                setPersistParam: setPersistParam
            )
            
            guard let thumbnailID else {
                throw BlobManagerError.noID
            }

            // Assign ID to message & save
            em.performAndWaitSave {
                blobData.blobThumbnailIdentifier = thumbnailID
            }
            
        case .noData:
            // The local thumbnail data is missing and we can't upload anything
            // TODO: (IOS-2861) Generate thumbnail if it is missing
            return
            
        default:
            DDLogNotice("[BlobManager] Blob does not need any action, state is \(state.description).")
        }
    }
    
    // MARK: Outgoing Data

    private func syncOutgoingData(
        of objectID: NSManagedObjectID,
        with state: OutgoingBlobState
    ) async throws -> BlobManagerResult {
        
        // If the data was uploaded successfully and we still reach this point, the message sending failed and we try to
        // resend it, and return
        guard state != .remote else {
            return .uploaded
        }
        
        var blobID: Data?
        var blobData: BlobData?
        var data: Data?
        var encryptionKey: Data?
        var origin: BlobOrigin?
        var setPersistParam: Bool?
        
        let em = entityManager
        em.performAndWait {
            guard let bd = em.entityFetcher
                .existingObject(with: objectID) as? BlobData
            else {
                DDLogError("[BlobManager] Unable to load message as BlobData for object ID: \(objectID)")
                return
            }

            blobID = bd.blobIdentifier
            blobData = bd
            data = bd.blobData
            encryptionKey = bd.blobEncryptionKey
            origin = bd.blobOrigin
            setPersistParam = bd.isPersistingBlob
        }
        
        guard let blobData else {
            DDLogError("[BlobManager] Unable to load message as BlobData for object ID: \(objectID)")
            throw BlobManagerError.unableToLoadMessageAsBlobData
        }
        
        guard let encryptionKey else {
            DDLogNotice("[BlobManager] Encryption Key not found.")
            throw BlobManagerError.noEncryptionKey
        }

        guard let origin else {
            DDLogNotice("[BlobManager] There is no origin available for given blob.")
            throw BlobManagerError.noOrigin
        }
        
        guard let setPersistParam else {
            DDLogNotice("[BlobManager] There is no persist indicator set for given blob.")
            throw BlobManagerError.noPersistParam
        }
               
        switch state {
        case .pendingDownload:
            guard let blobID else {
                throw BlobManagerError.noID
            }

            em.performAndWaitSave {
                blobData.blobError = false
                if blobData.blobProgress == nil {
                    // If not already done, we set the progress to 0.0 to indicate work has started
                    blobData.blobProgress = 0.0
                }
            }

            let data = try await downloadBlob(
                for: blobID,
                origin: origin,
                objectID: objectID,
                encryptionKey: encryptionKey,
                nonce: ThreemaProtocol.nonce01,
                trackProgress: true
            )

            // This is save. Delegate calls will not result in another update of the progress as the
            // objectID is no-more in `activeObjectIDs`.
            em.performAndWaitSave {
                blobData.blobData = data
            }

            try await markDownloadDone(for: blobID, objectID: objectID, origin: origin)

            // Download succeeded, we reset the progress
            em.performAndWaitSave {
                blobData.blobProgress = nil
            }
            
            return .downloaded
            
        case .pendingUpload:
            guard let data else {
                DDLogNotice("[BlobManager] Data has no data.")
                throw BlobManagerError.noData
            }

            // There might have been an issue where the app was terminated while uploading and we need to clean up
            await BlobManager.state.removeProgress(for: objectID)
            
            em.performAndWaitSave {
                blobData.blobError = false
                if blobData.blobProgress == nil {
                    // If not already done, we set the progress to 0.0 to indicate work has started
                    blobData.blobProgress = 0.0
                }
            }
        
            // Upload data to get ID
            let dataID = try await uploadBlob(
                for: data,
                origin: origin,
                objectID: objectID,
                encryptionKey: encryptionKey,
                nonce: ThreemaProtocol.nonce01,
                trackProgress: true,
                setPersistParam: setPersistParam
            )
            
            guard let dataID else {
                throw BlobManagerError.noID
            }
            
            // Assign ID to message & save
            em.performAndWaitSave {
                blobData.blobIdentifier = dataID
            }
            
            return .uploaded
            
        case .noData:
            throw BlobManagerError.noData

        default:
            DDLogNotice("[BlobManager] Blob does not need any action, state is \(state.description).")
            return .inProgress
        }
    }
    
    private func uploadBlob(
        for data: Data,
        origin: BlobOrigin,
        objectID: NSManagedObjectID,
        encryptionKey: Data?,
        nonce: Data,
        trackProgress: Bool,
        setPersistParam: Bool
    ) async throws -> Data? {
        
        // Encrypt
        guard let encryptedData = NaClCrypto.shared().symmetricEncryptData(
            data,
            withKey: encryptionKey,
            nonce: nonce
        ) else {
            throw BlobManagerError.cryptographyFailed
        }
        
        // Tracking
        if trackProgress {
            await BlobManager.state.setProgress(for: objectID, to: 0.0)
        }
        
        // Upload & get returned ID
        let data = try await blobUploader.upload(
            blobData: encryptedData,
            origin: origin,
            setPersistParam: setPersistParam,
            objectID: objectID,
            delegate: self
        )
        
        return data
    }
    
    // MARK: - Helpers
    
    // Reset BlobData values, to reflect state
    private func resetStatesForBlob(with objectID: NSManagedObjectID) {
        
        let em = entityManager
        em.performAndWaitSave {
            guard let blob = em.entityFetcher
                .existingObject(with: objectID) as? BlobData
            else {
                DDLogWarn("[BlobManager] Could not reset blob progress and error because it was not found.")
                return
            }
            
            if blob.blobProgress != nil {
                blob.blobProgress = nil
            }
            
            if blob.blobError {
                blob.blobError = false
            }
        }
    }
    
    private func setErrorStateForBlob(with objectID: NSManagedObjectID) {
        // Reset BlobData values, to reflect state
        let em = entityManager
        em.performAndWaitSave {
            guard let blob = em.entityFetcher.existingObject(with: objectID) as? BlobData else {
                DDLogWarn("[BlobManager] Could not set blob error because it was not found.")
                return
            }
            
            blob.blobProgress = nil
            blob.blobError = true
        }
    }
    
    private func isForNoteGroup(objectID: NSManagedObjectID) -> Bool {
        
        // We upload anyways if MD is activated
        if userSettings.enableMultiDevice {
            return false
        }
        
        let em = entityManager
        
        var isNoteGroup = false
        
        em.performAndWaitSave {
            guard let message = em.entityFetcher.existingObject(with: objectID) as? FileMessageEntity,
                  message.conversation.isGroup,
                  let group = self.groupManager.getGroup(conversation: message.conversation),
                  group.isNoteGroup else {
                return
            }
            message.sent = true
            message.blobError = false
            message.progress = nil
            message.blobIdentifier = ThreemaProtocol.nonUploadedBlobID
            
            if message.blobThumbnail != nil {
                message.blobThumbnailIdentifier = ThreemaProtocol.nonUploadedBlobID
            }
            
            isNoteGroup = true
        }
        return isNoteGroup
    }
    
    private func messageIDString(for objectID: NSManagedObjectID) async -> String {
        let em = entityManager
        
        return await em.perform {
            guard let message = em.entityFetcher.existingObject(with: objectID) as? BaseMessageEntity else {
                return "nil"
            }
            
            return message.id.hexString
        }
    }
}

// MARK: - BlobManagerDelegate

extension BlobManager: BlobManagerDelegate {
    
    func updateProgress(for objectID: NSManagedObjectID, didUpdate progress: Progress) async {
        guard await BlobManager.state.isActive(objectID),
              let lastProgress = await BlobManager.state.progress(for: objectID)
        else {
            return
        }
        
        // We artificially limit the saving of the progress to at least every 1% to reduce the amount of snapshots
        // applied in the chat view
        let newProgress = Double((100 * progress.fractionCompleted).rounded(.up) / 100)
        guard abs(lastProgress - newProgress) >= 0.01 else {
            return
        }
        
        await BlobManager.state.setProgress(for: objectID, to: newProgress)
        let em = entityManager
        em.performAndWaitSave {
            guard let blobData = em.entityFetcher.existingObject(with: objectID) as? BlobData else {
                return
            }

            blobData.blobProgress = NSNumber(value: progress.fractionCompleted)
        }
    }
}

extension BlobManager {

    private func isLegacyImageMessage(objectID: NSManagedObjectID) async -> Bool {
        let em = entityManager
        return await em.perform {
            em.entityFetcher.existingObject(with: objectID) is ImageMessageEntity
        }
    }

    private func downloadLegacyImageMessage(
        objectID: NSManagedObjectID,
        with state: IncomingBlobState
    ) async throws -> BlobManagerResult {
        // We return directly if the data is already downloaded and fully processed
        guard state != .processed else {
            return .downloaded
        }

        let em = entityManager

        let (
            messageID,
            conversationObjectID,
            blobID,
            blobOrigin,
            encryptionKey,
            imageNonce,
            publicKey,
            isAlreadyDownloaded
        ) = try await em.performSave {
            guard let message = em.entityFetcher.existingObject(with: objectID) as? ImageMessageEntity,
                  let blobID = message.blobIdentifier,
                  let imageNonce = message.imageNonce,
                  let publicKey = message.conversation.contact?.publicKey else {

                throw BlobManagerError.cryptographyFailed
            }

            message.blobError = false
            message.blobProgress = 0

            return (
                message.id,
                message.conversation.objectID,
                blobID,
                message.blobOrigin,
                message.encryptionKey,
                imageNonce,
                publicKey,
                message.blobEncryptionKey != nil
            )
        }

        guard !isAlreadyDownloaded else {
            return .downloaded
        }
        
        DDLogNotice(
            "[BlobManager] Starting download for legacy messageID: \(messageID.hexString), blobID: \(blobID.hexString)"
        )

        try await withCheckedThrowingContinuation { continuation in
            let processor = ImageMessageProcessor(
                blobDownloader: self.blobDownloader,
                myIdentityStore: MyIdentityStore.shared(),
                userSettings: self.userSettings,
                entityManager: em
            )
            processor.downloadImage(
                imageMessageID: messageID,
                in: conversationObjectID,
                imageBlobID: blobID,
                origin: blobOrigin,
                imageBlobEncryptionKey: encryptionKey,
                imageBlobNonce: imageNonce,
                senderPublicKey: publicKey,
                maxBytesToDecrypt: Int.max
            )
            .done(on: .global(), flags: .inheritQoS) {
                continuation.resume()
            }
            .catch(on: .global(), flags: .inheritQoS) { error in
                continuation.resume(throwing: error)
            }
        }
        
        return .downloaded
    }
}