81 lines
2.8 KiB
Swift
81 lines
2.8 KiB
Swift
//
|
|
// Copyright 2024 Signal Messenger, LLC
|
|
// SPDX-License-Identifier: AGPL-3.0-only
|
|
//
|
|
|
|
import Foundation
|
|
import LibSignalClient
|
|
|
|
extension MessageBackup {
|
|
|
|
/// Base context class used for archiving (creating a backup).
|
|
///
|
|
/// Requires a write tx on init; we want to hold the write lock while
|
|
/// creating a backup to avoid races with e.g. message processing.
|
|
///
|
|
/// But only exposes a read tx, because we explicitly do not want
|
|
/// archiving to be updating the database, just reading from it.
|
|
/// (The exception to this is enqueuing attachment uploads.)
|
|
open class ArchivingContext {
|
|
struct IncludedContentFilter {
|
|
/// The minimum amount of time remaining on a message's expiration
|
|
/// timer, such that it is eligible for inclusion.
|
|
///
|
|
/// For example, this allows callers to require messages to have at
|
|
/// least 24h before their expiration in order to be included.
|
|
let minRemainingTimeUntilExpirationMs: UInt64
|
|
|
|
/// Whether or not the plaintext SVR PIN should be included.
|
|
let shouldIncludePin: Bool
|
|
}
|
|
|
|
/// For benchmarking archive steps.
|
|
let bencher: MessageBackup.ArchiveBencher
|
|
|
|
/// Parameters configuring what content is included in this archive.
|
|
let includedContentFilter: IncludedContentFilter
|
|
|
|
private let _tx: DBWriteTransaction
|
|
var tx: DBReadTransaction { _tx }
|
|
|
|
/// Nil if not a paid backups account.
|
|
private let currentBackupAttachmentUploadEra: String?
|
|
private let backupAttachmentUploadManager: BackupAttachmentUploadManager
|
|
|
|
init(
|
|
backupAttachmentUploadManager: BackupAttachmentUploadManager,
|
|
bencher: MessageBackup.ArchiveBencher,
|
|
currentBackupAttachmentUploadEra: String?,
|
|
includedContentFilter: IncludedContentFilter,
|
|
tx: DBWriteTransaction
|
|
) {
|
|
self.bencher = bencher
|
|
self.backupAttachmentUploadManager = backupAttachmentUploadManager
|
|
self.currentBackupAttachmentUploadEra = currentBackupAttachmentUploadEra
|
|
self.includedContentFilter = includedContentFilter
|
|
self._tx = tx
|
|
}
|
|
|
|
func enqueueAttachmentForUploadIfNeeded(_ referencedAttachment: ReferencedAttachment) throws {
|
|
guard let currentBackupAttachmentUploadEra else {
|
|
return
|
|
}
|
|
try backupAttachmentUploadManager.enqueueIfNeeded(
|
|
referencedAttachment,
|
|
currentUploadEra: currentBackupAttachmentUploadEra,
|
|
tx: _tx
|
|
)
|
|
}
|
|
}
|
|
|
|
/// Base context class used for restoring from a backup.
|
|
open class RestoringContext {
|
|
|
|
public let tx: DBWriteTransaction
|
|
|
|
init(tx: DBWriteTransaction) {
|
|
self.tx = tx
|
|
}
|
|
}
|
|
}
|