295 lines
12 KiB
Swift
295 lines
12 KiB
Swift
//
|
|
// Copyright 2023 Signal Messenger, LLC
|
|
// SPDX-License-Identifier: AGPL-3.0-only
|
|
//
|
|
|
|
import Foundation
|
|
import LibSignalClient
|
|
|
|
/**
|
|
* Archives a contact (``SignalRecipient``) as a ``BackupProto.Contact``, which is a type of
|
|
* ``BackupProto.Recipient``.
|
|
*/
|
|
public class MessageBackupContactRecipientArchiver: MessageBackupRecipientDestinationArchiver {
|
|
|
|
private let blockingManager: MessageBackup.Shims.BlockingManager
|
|
private let profileManager: MessageBackup.Shims.ProfileManager
|
|
private let recipientDatabaseTable: any RecipientDatabaseTable
|
|
private let recipientHidingManager: RecipientHidingManager
|
|
private let recipientManager: any SignalRecipientManager
|
|
private let signalServiceAddressCache: SignalServiceAddressCache
|
|
private let storyStore: StoryStore
|
|
private let tsAccountManager: TSAccountManager
|
|
private let usernameLookupManager: UsernameLookupManager
|
|
|
|
public init(
|
|
blockingManager: MessageBackup.Shims.BlockingManager,
|
|
profileManager: MessageBackup.Shims.ProfileManager,
|
|
recipientDatabaseTable: any RecipientDatabaseTable,
|
|
recipientHidingManager: RecipientHidingManager,
|
|
recipientManager: any SignalRecipientManager,
|
|
signalServiceAddressCache: SignalServiceAddressCache,
|
|
storyStore: StoryStore,
|
|
tsAccountManager: TSAccountManager,
|
|
usernameLookupManager: UsernameLookupManager
|
|
) {
|
|
self.blockingManager = blockingManager
|
|
self.profileManager = profileManager
|
|
self.recipientDatabaseTable = recipientDatabaseTable
|
|
self.recipientHidingManager = recipientHidingManager
|
|
self.recipientManager = recipientManager
|
|
self.signalServiceAddressCache = signalServiceAddressCache
|
|
self.storyStore = storyStore
|
|
self.tsAccountManager = tsAccountManager
|
|
self.usernameLookupManager = usernameLookupManager
|
|
}
|
|
|
|
private typealias ArchivingAddress = MessageBackup.RecipientArchivingContext.Address
|
|
|
|
public func archiveRecipients(
|
|
stream: MessageBackupProtoOutputStream,
|
|
context: MessageBackup.RecipientArchivingContext,
|
|
tx: DBReadTransaction
|
|
) -> ArchiveMultiFrameResult {
|
|
let whitelistedAddresses = Set(profileManager.allWhitelistedAddresses(tx: tx))
|
|
let blockedAddresses = blockingManager.blockedAddresses(tx: tx)
|
|
|
|
var errors = [ArchiveMultiFrameResult.ArchiveFrameError]()
|
|
|
|
recipientDatabaseTable.enumerateAll(tx: tx) { recipient in
|
|
guard
|
|
let contactAddress = MessageBackup.ContactAddress(
|
|
aci: recipient.aci,
|
|
pni: recipient.pni,
|
|
e164: E164(recipient.phoneNumber?.stringValue)
|
|
)
|
|
else {
|
|
// Skip but don't add to the list of errors.
|
|
Logger.warn("Skipping empty recipient")
|
|
return
|
|
}
|
|
|
|
guard !context.localIdentifiers.containsAnyOf(
|
|
aci: recipient.aci,
|
|
phoneNumber: E164(recipient.phoneNumber?.stringValue),
|
|
pni: recipient.pni
|
|
) else {
|
|
// Skip local user
|
|
return
|
|
}
|
|
|
|
let recipientAddress = contactAddress.asArchivingAddress()
|
|
|
|
let recipientId = context.assignRecipientId(to: recipientAddress)
|
|
|
|
var unregisteredAtTimestamp: UInt64 = 0
|
|
if !recipient.isRegistered {
|
|
unregisteredAtTimestamp = (
|
|
recipient.unregisteredAtTimestamp ?? SignalRecipient.Constants.distantPastUnregisteredTimestamp
|
|
)
|
|
}
|
|
|
|
let storyContext = recipient.aci.map { self.storyStore.getOrCreateStoryContextAssociatedData(for: $0, tx: tx) }
|
|
|
|
var contact = BackupProto.Contact(
|
|
blocked: blockedAddresses.contains(recipient.address),
|
|
hidden: self.recipientHidingManager.isHiddenRecipient(recipient, tx: tx),
|
|
unregisteredTimestamp: unregisteredAtTimestamp,
|
|
profileSharing: whitelistedAddresses.contains(recipient.address),
|
|
hideStory: storyContext?.isHidden ?? false
|
|
)
|
|
|
|
contact.registered = recipient.isRegistered ? .REGISTERED : .NOT_REGISTERED
|
|
contact.aci = recipient.aci.map(\.rawUUID.data)
|
|
contact.pni = recipient.pni.map(\.rawUUID.data)
|
|
contact.e164 = { () -> UInt64? in
|
|
guard let phoneNumberString = recipient.phoneNumber?.stringValue else { return nil }
|
|
return E164(phoneNumberString)?.uint64Value
|
|
}()
|
|
|
|
if let aci = recipient.aci {
|
|
contact.username = usernameLookupManager.fetchUsername(
|
|
forAci: aci, transaction: tx
|
|
)
|
|
}
|
|
|
|
let userProfile = self.profileManager.getUserProfile(for: recipient.address, tx: tx)
|
|
contact.profileKey = userProfile?.profileKey.map(\.keyData)
|
|
contact.profileGivenName = userProfile?.givenName
|
|
contact.profileFamilyName = userProfile?.familyName
|
|
// TODO: joined name?
|
|
|
|
Self.writeFrameToStream(
|
|
stream,
|
|
objectId: .contact(contactAddress),
|
|
frameBuilder: {
|
|
var recipient = BackupProto.Recipient(id: recipientId.value)
|
|
recipient.destination = .contact(contact)
|
|
|
|
var frame = BackupProto.Frame()
|
|
frame.item = .recipient(recipient)
|
|
return frame
|
|
}
|
|
).map { errors.append($0) }
|
|
}
|
|
|
|
if errors.isEmpty {
|
|
return .success
|
|
} else {
|
|
return .partialSuccess(errors)
|
|
}
|
|
}
|
|
|
|
static func canRestore(_ recipient: BackupProto.Recipient) -> Bool {
|
|
switch recipient.destination {
|
|
case .contact:
|
|
return true
|
|
case nil, .group, .distributionList, .selfRecipient, .releaseNotes:
|
|
return false
|
|
}
|
|
}
|
|
|
|
public func restore(
|
|
_ recipientProto: BackupProto.Recipient,
|
|
context: MessageBackup.RecipientRestoringContext,
|
|
tx: DBWriteTransaction
|
|
) -> RestoreFrameResult {
|
|
let contactProto: BackupProto.Contact
|
|
switch recipientProto.destination {
|
|
case .contact(let backupProtoContact):
|
|
contactProto = backupProtoContact
|
|
case nil, .group, .distributionList, .selfRecipient, .releaseNotes:
|
|
return .failure([.restoreFrameError(
|
|
.developerError(OWSAssertionError("Invalid proto for class")),
|
|
recipientProto.recipientId
|
|
)])
|
|
}
|
|
|
|
let isRegistered: Bool?
|
|
let unregisteredTimestamp: UInt64?
|
|
switch contactProto.registered {
|
|
case nil, .UNKNOWN:
|
|
isRegistered = nil
|
|
unregisteredTimestamp = nil
|
|
case .REGISTERED:
|
|
isRegistered = true
|
|
unregisteredTimestamp = nil
|
|
case .NOT_REGISTERED:
|
|
isRegistered = false
|
|
unregisteredTimestamp = contactProto.unregisteredTimestamp
|
|
}
|
|
|
|
let aci: Aci?
|
|
let pni: Pni?
|
|
let e164: E164?
|
|
let profileKey: OWSAES256Key?
|
|
if let aciRaw = contactProto.aci {
|
|
guard let aciUuid = UUID(data: aciRaw) else {
|
|
return .failure([.restoreFrameError(.invalidProtoData(.invalidAci(protoClass: BackupProto.Contact.self)), recipientProto.recipientId)])
|
|
}
|
|
aci = Aci.init(fromUUID: aciUuid)
|
|
} else {
|
|
aci = nil
|
|
}
|
|
if let pniRaw = contactProto.pni {
|
|
guard let pniUuid = UUID(data: pniRaw) else {
|
|
return .failure([.restoreFrameError(.invalidProtoData(.invalidPni(protoClass: BackupProto.Contact.self)), recipientProto.recipientId)])
|
|
}
|
|
pni = Pni.init(fromUUID: pniUuid)
|
|
} else {
|
|
pni = nil
|
|
}
|
|
if let contactProtoE164 = contactProto.e164 {
|
|
guard let protoE164 = E164(contactProtoE164) else {
|
|
return .failure([.restoreFrameError(.invalidProtoData(.invalidE164(protoClass: BackupProto.Contact.self)), recipientProto.recipientId)])
|
|
}
|
|
e164 = protoE164
|
|
} else {
|
|
e164 = nil
|
|
}
|
|
if let contactProtoProfileKeyData = contactProto.profileKey {
|
|
guard let protoProfileKey = OWSAES256Key(data: contactProtoProfileKeyData) else {
|
|
return .failure([.restoreFrameError(.invalidProtoData(.invalidProfileKey(protoClass: BackupProto.Contact.self)), recipientProto.recipientId)])
|
|
}
|
|
profileKey = protoProfileKey
|
|
} else {
|
|
profileKey = nil
|
|
}
|
|
|
|
guard
|
|
let address = MessageBackup.ContactAddress(aci: aci, pni: pni, e164: e164)
|
|
else {
|
|
// Need at least one identifier!
|
|
return .failure([.restoreFrameError(.invalidProtoData(.contactWithoutIdentifiers), recipientProto.recipientId)])
|
|
}
|
|
context[recipientProto.recipientId] = .contact(address)
|
|
|
|
let recipient = SignalRecipient.fromBackup(
|
|
address,
|
|
isRegistered: isRegistered,
|
|
unregisteredAtTimestamp: unregisteredTimestamp
|
|
)
|
|
|
|
// Stop early if this is the local user. That shouldn't happen.
|
|
let profileAddress = OWSUserProfile.internalAddress(
|
|
for: recipient.address,
|
|
localIdentifiers: context.localIdentifiers
|
|
)
|
|
switch profileAddress {
|
|
case .localUser:
|
|
return .failure([.restoreFrameError(.invalidProtoData(.otherContactWithLocalIdentifiers), recipientProto.recipientId)])
|
|
case .otherUser:
|
|
break
|
|
}
|
|
|
|
recipientDatabaseTable.insertRecipient(recipient, transaction: tx)
|
|
/// No Backup code should be relying on the SSA cache, but once we've
|
|
/// finished restoring and launched we want the cache to have accurate
|
|
/// mappings based on the recipients we just restored.
|
|
signalServiceAddressCache.updateRecipient(recipient, tx: tx)
|
|
|
|
if
|
|
let aci = recipient.aci,
|
|
let username = contactProto.username
|
|
{
|
|
usernameLookupManager.saveUsername(username, forAci: aci, transaction: tx)
|
|
}
|
|
|
|
if contactProto.profileSharing {
|
|
// Add to the whitelist.
|
|
profileManager.addToWhitelist(recipient.address, tx: tx)
|
|
}
|
|
|
|
if contactProto.blocked {
|
|
blockingManager.addBlockedAddress(recipient.address, tx: tx)
|
|
}
|
|
|
|
if contactProto.hidden {
|
|
do {
|
|
try recipientHidingManager.addHiddenRecipient(recipient, wasLocallyInitiated: false, tx: tx)
|
|
} catch let error {
|
|
return .failure([.restoreFrameError(.databaseInsertionFailed(error), recipientProto.recipientId)])
|
|
}
|
|
}
|
|
|
|
// We only need to active hide, since unhidden is the default.
|
|
if contactProto.hideStory, let aci = address.aci {
|
|
let storyContext = storyStore.getOrCreateStoryContextAssociatedData(for: aci, tx: tx)
|
|
storyStore.updateStoryContext(storyContext, updateStorageService: false, isHidden: true, tx: tx)
|
|
}
|
|
|
|
profileManager.insertOtherUserProfile(
|
|
givenName: contactProto.profileGivenName,
|
|
familyName: contactProto.profileFamilyName,
|
|
profileKey: profileKey,
|
|
address: profileAddress,
|
|
tx: tx
|
|
)
|
|
|
|
// TODO: Refetch every profile (including our own) after registration.
|
|
// Certain fields (eg badges & Sealed Sender state) can be fetched without the profile key.
|
|
|
|
return .success
|
|
}
|
|
}
|