PhoneNumberVisibilityFetcher.swift

//
// Copyright 2024 Signal Messenger, LLC
// SPDX-License-Identifier: AGPL-3.0-only
//

import Foundation
import LibSignalClient

public protocol PhoneNumberVisibilityFetcher {
    /// Fetches whether or not a phone number is visible.
    func isPhoneNumberVisible(for recipient: SignalRecipient, tx: DBReadTransaction) -> Bool

    /// Pre-fetches state about visible phone numbers.
    ///
    /// This is useful during `SignalServiceAddressCache`'s `warmCaches` method
    /// because we're checking every ACI we know and expect there to be far more
    /// known ACIs than ACIs that are sharing their phone number.
    func fetchAll(tx: DBReadTransaction) throws -> BulkPhoneNumberVisibilityFetcher
}

private func _isPhoneNumberVisible(
    for recipient: SignalRecipient,
    localAci: () -> Aci?,
    isPhoneNumberShared: (Aci) -> Bool,
    isSystemContact: (_ phoneNumber: String) -> Bool,
) -> Bool {
    // If there's no ACI, the phone number can't be hidden. (You hide a number
    // via your encrypted profile, and that only exists for ACIs.)
    guard let aci = recipient.aci, let phoneNumber = recipient.phoneNumber else {
        return true
    }
    return (aci == localAci()) || isPhoneNumberShared(aci) || isSystemContact(phoneNumber.stringValue)
}

public final class PhoneNumberVisibilityFetcherImpl: PhoneNumberVisibilityFetcher {
    private let contactsManager: any ContactManager
    private let tsAccountManager: any TSAccountManager
    private let userProfileStore: any UserProfileStore

    init(
        contactsManager: any ContactManager,
        tsAccountManager: any TSAccountManager,
        userProfileStore: any UserProfileStore,
    ) {
        self.contactsManager = contactsManager
        self.tsAccountManager = tsAccountManager
        self.userProfileStore = userProfileStore
    }

    public func isPhoneNumberVisible(for recipient: SignalRecipient, tx: DBReadTransaction) -> Bool {
        return _isPhoneNumberVisible(
            for: recipient,
            localAci: {
                tsAccountManager.localIdentifiers(tx: tx)?.aci
            },
            isPhoneNumberShared: {
                let userProfile = userProfileStore.fetchUserProfiles(for: $0, tx: tx).first
                return userProfile?.isPhoneNumberShared ?? (userProfile?.givenName == nil)
            },
            isSystemContact: {
                contactsManager.fetchSignalAccount(forPhoneNumber: $0, transaction: tx) != nil
            },
        )
    }

    public func fetchAll(tx: DBReadTransaction) throws -> BulkPhoneNumberVisibilityFetcher {
        return BulkPhoneNumberVisibilityFetcher(
            localAci: tsAccountManager.localIdentifiers(tx: tx)?.aci,
            acisWithHiddenPhoneNumbers: Set(
                try UserProfileFinder().fetchAcisWithHiddenPhoneNumbers(tx: tx),
            ),
            phoneNumbersWithSystemContacts: Set(
                try SignalAccountFinder().fetchPhoneNumbers(tx: tx),
            ),
        )
    }
}

public final class BulkPhoneNumberVisibilityFetcher {
    private let localAci: Aci?
    private let acisWithHiddenPhoneNumbers: Set<Aci>
    private let phoneNumbersWithSystemContacts: Set<String>

    init(
        localAci: Aci?,
        acisWithHiddenPhoneNumbers: Set<Aci>,
        phoneNumbersWithSystemContacts: Set<String>,
    ) {
        self.localAci = localAci
        self.acisWithHiddenPhoneNumbers = acisWithHiddenPhoneNumbers
        self.phoneNumbersWithSystemContacts = phoneNumbersWithSystemContacts
    }

    func isPhoneNumberVisible(for recipient: SignalRecipient) -> Bool {
        return _isPhoneNumberVisible(
            for: recipient,
            localAci: { localAci },
            isPhoneNumberShared: { !acisWithHiddenPhoneNumbers.contains($0) },
            isSystemContact: { phoneNumbersWithSystemContacts.contains($0) },
        )
    }
}

#if TESTABLE_BUILD

final class MockPhoneNumberVisibilityFetcher: PhoneNumberVisibilityFetcher {
    var localAci: Aci?
    var acisWithHiddenPhoneNumbers = Set<Aci>()
    var phoneNumbersWithSystemContacts = Set<String>()

    func isPhoneNumberVisible(for recipient: SignalRecipient, tx: DBReadTransaction) -> Bool {
        return try! fetchAll(tx: tx).isPhoneNumberVisible(for: recipient)
    }

    func fetchAll(tx: DBReadTransaction) throws -> BulkPhoneNumberVisibilityFetcher {
        return BulkPhoneNumberVisibilityFetcher(
            localAci: localAci,
            acisWithHiddenPhoneNumbers: acisWithHiddenPhoneNumbers,
            phoneNumbersWithSystemContacts: phoneNumbersWithSystemContacts,
        )
    }
}

#endif