// // ProfileManager.swift // Passepartout // // Created by Davide De Rosa on 2/19/24. // Copyright (c) 2024 Davide De Rosa. All rights reserved. // // https://github.com/passepartoutvpn // // This file is part of Passepartout. // // Passepartout is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // Passepartout is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // // You should have received a copy of the GNU General Public License // along with Passepartout. If not, see . // import Combine import Foundation import PassepartoutKit @MainActor public final class ProfileManager: ObservableObject { private enum Observer: CaseIterable { case local case remote } public enum Event { case save(Profile) case remove([Profile.ID]) case startRemoteImport case stopRemoteImport } // MARK: Dependencies private let repository: ProfileRepository private let backupRepository: ProfileRepository? private let remoteRepositoryBlock: ((Bool) -> ProfileRepository)? private var remoteRepository: ProfileRepository? private let mirrorsRemoteRepository: Bool private let processor: ProfileProcessor? // MARK: State private var allProfiles: [Profile.ID: Profile] { didSet { reloadFilteredProfiles(with: searchSubject.value) reloadRequiredFeatures() } } private var allRemoteProfiles: [Profile.ID: Profile] private var filteredProfiles: [Profile] @Published private var requiredFeatures: [Profile.ID: Set] @Published public private(set) var isRemoteImportingEnabled: Bool private var waitingObservers: Set // MARK: Publishers public let didChange: PassthroughSubject private let searchSubject: CurrentValueSubject private var localSubscription: AnyCancellable? private var remoteSubscription: AnyCancellable? private var searchSubscription: AnyCancellable? private var remoteImportTask: Task? // for testing/previews public convenience init(profiles: [Profile]) { self.init( repository: InMemoryProfileRepository(profiles: profiles), remoteRepositoryBlock: { _ in InMemoryProfileRepository() } ) } public init( repository: ProfileRepository, backupRepository: ProfileRepository? = nil, remoteRepositoryBlock: ((Bool) -> ProfileRepository)?, mirrorsRemoteRepository: Bool = false, processor: ProfileProcessor? = nil ) { precondition(!mirrorsRemoteRepository || remoteRepositoryBlock != nil, "mirrorsRemoteRepository requires a non-nil remoteRepositoryBlock") self.repository = repository self.backupRepository = backupRepository self.remoteRepositoryBlock = remoteRepositoryBlock self.mirrorsRemoteRepository = mirrorsRemoteRepository self.processor = processor allProfiles = [:] allRemoteProfiles = [:] filteredProfiles = [] requiredFeatures = [:] isRemoteImportingEnabled = false if remoteRepositoryBlock != nil { waitingObservers = [.local, .remote] } else { waitingObservers = [.local] } didChange = PassthroughSubject() searchSubject = CurrentValueSubject("") observeSearch() } } // MARK: - View extension ProfileManager { public var isReady: Bool { waitingObservers.isEmpty } public var hasProfiles: Bool { !filteredProfiles.isEmpty } public var headers: [ProfileHeader] { filteredProfiles.map { $0.header() } } public func profile(withId profileId: Profile.ID) -> Profile? { allProfiles[profileId] } public var isSearching: Bool { !searchSubject.value.isEmpty } public func search(byName name: String) { searchSubject.send(name) } public func requiredFeatures(forProfileWithId profileId: Profile.ID) -> Set? { requiredFeatures[profileId] } public func reloadRequiredFeatures() { guard let processor else { return } requiredFeatures = allProfiles.reduce(into: [:]) { guard let ineligible = processor.verify($1.value), !ineligible.isEmpty else { return } $0[$1.key] = ineligible } pp_log(.App.profiles, .info, "Required features: \(requiredFeatures)") } } // MARK: - Edit extension ProfileManager { public func save(_ originalProfile: Profile, isLocal: Bool = false, remotelyShared: Bool? = nil) async throws { let profile: Profile if isLocal { var builder = originalProfile.builder() if let processor { builder = try processor.willRebuild(builder) } builder.attributes.lastUpdate = Date() builder.attributes.fingerprint = UUID() profile = try builder.tryBuild() } else { profile = originalProfile } pp_log(.App.profiles, .notice, "Save profile \(profile.id)...") do { let existingProfile = allProfiles[profile.id] if existingProfile == nil || profile != existingProfile { try await repository.saveProfile(profile) if let backupRepository { Task.detached { try await backupRepository.saveProfile(profile) } } didChange.send(.save(profile)) } else { pp_log(.App.profiles, .notice, "\tProfile \(profile.id) not modified, not saving") } } catch { pp_log(.App.profiles, .fault, "\tUnable to save profile \(profile.id): \(error)") throw error } if let remoteRepository { let enableSharing = remotelyShared == true || (remotelyShared == nil && isLocal && isRemotelyShared(profileWithId: profile.id)) let disableSharing = remotelyShared == false do { if enableSharing { pp_log(.App.profiles, .notice, "\tEnable remote sharing of profile \(profile.id)...") try await remoteRepository.saveProfile(profile) } else if disableSharing { pp_log(.App.profiles, .notice, "\tDisable remote sharing of profile \(profile.id)...") try await remoteRepository.removeProfiles(withIds: [profile.id]) } } catch { pp_log(.App.profiles, .fault, "\tUnable to save/remove remote profile \(profile.id): \(error)") throw error } } pp_log(.App.profiles, .notice, "Finished saving profile \(profile.id)") } public func remove(withId profileId: Profile.ID) async { await remove(withIds: [profileId]) } public func remove(withIds profileIds: [Profile.ID]) async { pp_log(.App.profiles, .notice, "Remove profiles \(profileIds)...") do { try await repository.removeProfiles(withIds: profileIds) try? await remoteRepository?.removeProfiles(withIds: profileIds) didChange.send(.remove(profileIds)) } catch { pp_log(.App.profiles, .fault, "Unable to remove profiles \(profileIds): \(error)") } } } // MARK: - Remote/Attributes extension ProfileManager { public func isRemotelyShared(profileWithId profileId: Profile.ID) -> Bool { allRemoteProfiles.keys.contains(profileId) } public func isAvailableForTV(profileWithId profileId: Profile.ID) -> Bool { profile(withId: profileId)?.attributes.isAvailableForTV == true } public func eraseRemotelySharedProfiles() async throws { pp_log(.App.profiles, .notice, "Erase remotely shared profiles...") try await remoteRepository?.removeAllProfiles() } } // MARK: - Shortcuts extension ProfileManager { public func new(withName name: String) -> Profile { var builder = Profile.Builder() builder.name = firstUniqueName(from: name) do { return try builder.tryBuild() } catch { fatalError("Unable to build new empty profile: \(error)") } } public func duplicate(profileWithId profileId: Profile.ID) async throws { guard let profile = profile(withId: profileId) else { return } var builder = profile.builder(withNewId: true) builder.name = firstUniqueName(from: profile.name) pp_log(.App.profiles, .notice, "Duplicate profile [\(profileId), \(profile.name)] -> [\(builder.id), \(builder.name)]...") let copy = try builder.tryBuild() try await save(copy) } } private extension ProfileManager { func firstUniqueName(from name: String) -> String { let allNames = Set(allProfiles.values.map(\.name)) var newName = name var index = 1 while true { if !allNames.contains(newName) { return newName } newName = [name, index.description].joined(separator: ".") index += 1 } } } // MARK: - Observation extension ProfileManager { public func observeLocal() async throws { localSubscription = nil let initialProfiles = try await repository.fetchProfiles() reloadLocalProfiles(initialProfiles) localSubscription = repository .profilesPublisher .dropFirst() .receive(on: DispatchQueue.main) .sink { [weak self] in self?.reloadLocalProfiles($0) } } public func observeRemote(_ isRemoteImportingEnabled: Bool) async throws { guard let remoteRepositoryBlock else { // preconditionFailure("Missing remoteRepositoryBlock") return } guard remoteRepository == nil || isRemoteImportingEnabled != self.isRemoteImportingEnabled else { return } self.isRemoteImportingEnabled = isRemoteImportingEnabled remoteSubscription = nil let newRepository = remoteRepositoryBlock(isRemoteImportingEnabled) let initialProfiles = try await newRepository.fetchProfiles() reloadRemoteProfiles(initialProfiles) remoteRepository = newRepository remoteSubscription = remoteRepository? .profilesPublisher .dropFirst() .receive(on: DispatchQueue.main) .sink { [weak self] in self?.reloadRemoteProfiles($0) } } } private extension ProfileManager { func observeSearch(debounce: Int = 200) { searchSubscription = searchSubject .debounce(for: .milliseconds(debounce), scheduler: DispatchQueue.main) .sink { [weak self] in self?.reloadFilteredProfiles(with: $0) } } } private extension ProfileManager { func reloadLocalProfiles(_ result: [Profile]) { pp_log(.App.profiles, .info, "Reload local profiles: \(result.map(\.id))") let excludedIds = Set(result .filter { !(processor?.isIncluded($0) ?? true) } .map(\.id)) allProfiles = result .filter { !excludedIds.contains($0.id) } .reduce(into: [:]) { $0[$1.id] = $1 } pp_log(.App.profiles, .info, "Local profiles after exclusions: \(allProfiles.keys)") if waitingObservers.contains(.local) { waitingObservers.remove(.local) } objectWillChange.send() if !excludedIds.isEmpty { pp_log(.App.profiles, .info, "Delete excluded profiles from repository: \(excludedIds)") Task { // TODO: ###, ignore this published value try await repository.removeProfiles(withIds: Array(excludedIds)) } } } func reloadRemoteProfiles(_ result: [Profile]) { pp_log(.App.profiles, .info, "Reload remote profiles: \(result.map(\.id))") allRemoteProfiles = result.reduce(into: [:]) { $0[$1.id] = $1 } if waitingObservers.contains(.remote) { waitingObservers.remove(.remote) } Task { [weak self] in self?.didChange.send(.startRemoteImport) await self?.importRemoteProfiles(result) self?.didChange.send(.stopRemoteImport) } objectWillChange.send() } func importRemoteProfiles(_ profiles: [Profile]) async { if let previousTask = remoteImportTask { pp_log(.App.profiles, .info, "Cancel ongoing remote import...") previousTask.cancel() await previousTask.value remoteImportTask = nil } pp_log(.App.profiles, .info, "Start importing remote profiles: \(profiles.map(\.id)))") assert(profiles.count == Set(profiles.map(\.id)).count, "Remote repository must not have duplicates") pp_log(.App.profiles, .debug, "Local attributes:") let localAttributes: [Profile.ID: ProfileAttributes] = allProfiles.values.reduce(into: [:]) { $0[$1.id] = $1.attributes pp_log(.App.profiles, .debug, "\t\($1.id) = \($1.attributes)") } pp_log(.App.profiles, .debug, "Remote attributes:") let remoteAttributes: [Profile.ID: ProfileAttributes] = profiles.reduce(into: [:]) { $0[$1.id] = $1.attributes pp_log(.App.profiles, .debug, "\t\($1.id) = \($1.attributes)") } let remotelyDeletedIds = Set(allProfiles.keys).subtracting(Set(allRemoteProfiles.keys)) let mirrorsRemoteRepository = mirrorsRemoteRepository remoteImportTask = Task.detached { [weak self] in guard let self else { return } var idsToRemove: [Profile.ID] = [] if !remotelyDeletedIds.isEmpty { pp_log(.App.profiles, .info, "Will \(mirrorsRemoteRepository ? "delete" : "retain") local profiles not present in remote repository: \(remotelyDeletedIds)") if mirrorsRemoteRepository { idsToRemove.append(contentsOf: remotelyDeletedIds) } } for remoteProfile in profiles { do { guard await processor?.isIncluded(remoteProfile) ?? true else { pp_log(.App.profiles, .info, "Will delete non-included remote profile \(remoteProfile.id)") idsToRemove.append(remoteProfile.id) continue } if let localFingerprint = localAttributes[remoteProfile.id]?.fingerprint { guard let remoteFingerprint = remoteAttributes[remoteProfile.id]?.fingerprint, remoteFingerprint != localFingerprint else { pp_log(.App.profiles, .info, "Skip re-importing local profile \(remoteProfile.id)") continue } } pp_log(.App.profiles, .notice, "Import remote profile \(remoteProfile.id)...") try await save(remoteProfile) } catch { pp_log(.App.profiles, .error, "Unable to import remote profile: \(error)") } guard !Task.isCancelled else { pp_log(.App.profiles, .info, "Cancelled import of remote profiles: \(profiles.map(\.id))") return } } pp_log(.App.profiles, .notice, "Finished importing remote profiles, delete stale profiles: \(idsToRemove)") if !idsToRemove.isEmpty { do { try await repository.removeProfiles(withIds: idsToRemove) } catch { pp_log(.App.profiles, .error, "Unable to delete stale profiles: \(error)") } } // yield a little bit try? await Task.sleep(for: .milliseconds(100)) } await remoteImportTask?.value remoteImportTask = nil } func reloadFilteredProfiles(with search: String) { filteredProfiles = allProfiles .values .filter { if !search.isEmpty { return $0.name.lowercased().contains(search.lowercased()) } return true } .sorted { $0.name.lowercased() < $1.name.lowercased() } pp_log(.App.profiles, .notice, "Filter profiles with '\(search)' (\(filteredProfiles.count) results)") objectWillChange.send() } }