passepartout-apple/PassepartoutCore/Sources/PassepartoutProviders/Managers/ProviderManager.swift

//
//  ProviderManager.swift
//  Passepartout
//
//  Created by Davide De Rosa on 3/13/22.
//  Copyright (c) 2022 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 <http://www.gnu.org/licenses/>.
//

import Foundation
import Combine
import PassepartoutServices
import PassepartoutUtils

enum ProviderManagerError: LocalizedError {
    case outdatedBuild(Int, Int)
    
    var errorDescription: String? {
        switch self {
        case .outdatedBuild(let current, let min):
            return "Build is outdated (found \(current), required \(min))"
        }
    }
}

@MainActor
public class ProviderManager: ObservableObject, RateLimited {
    public enum FetchPriority {
        case bundle
        
        case remote
        
        case remoteThenBundle
    }
    
    private let appBuild: Int
    
    private let bundleServices: WebServices
    
    private let webServices: WebServices
    
    private let persistence: Persistence
    
    private let providerRepository: ProviderRepository

    private let infrastructureRepository: InfrastructureRepository

    private let serverRepository: ServerRepository

    public init(appBuild: Int, bundleServices: WebServices, webServices: WebServices, persistence: Persistence) {
        self.appBuild = appBuild
        self.bundleServices = bundleServices
        self.webServices = webServices
        self.persistence = persistence
        providerRepository = ProviderRepository(persistence.context)
        infrastructureRepository = InfrastructureRepository(persistence.context)
        serverRepository = ServerRepository(persistence.context)

        _ = allProviders()
    }
    
    // MARK: Queries

    public func allProviders() -> [ProviderMetadata] {
        providerRepository.allProviders()
    }
    
    public func provider(withName name: ProviderName) -> ProviderMetadata? {
        providerRepository.provider(withName: name)
    }
    
    public func isAvailable(_ name: ProviderName, vpnProtocol: VPNProtocolType) -> Bool {
        infrastructureRepository.lastInfrastructureUpdate(withName: name, vpnProtocol: vpnProtocol) != nil
    }
    
    public func defaultUsername(_ name: ProviderName, vpnProtocol: VPNProtocolType) -> String? {
        infrastructureRepository.defaultUsername(forProviderWithName: name, vpnProtocol: vpnProtocol)
    }
    
    public func lastUpdate(_ name: ProviderName, vpnProtocol: VPNProtocolType) -> Date? {
        infrastructureRepository.lastInfrastructureUpdate(withName: name, vpnProtocol: vpnProtocol)
    }
    
    public func categories(_ name: ProviderName, vpnProtocol: VPNProtocolType) -> [ProviderCategory] {
        serverRepository.categories(forProviderWithName: name, vpnProtocol: vpnProtocol)
    }

    public func servers(forLocation location: ProviderLocation) -> [ProviderServer] {
        serverRepository.servers(forLocation: location)
    }

//    @available(*, deprecated, message: "only use for migration, server is not cached")
    public func server(_ name: ProviderName, vpnProtocol: VPNProtocolType, serverId: String) -> ProviderServer? {
        serverRepository.server(forProviderWithName: name, vpnProtocol: vpnProtocol, serverId: serverId)
    }

//    public func anyServer(forProviderWithName providerName: ProviderName, vpnProtocol: VPNProtocolType, countryCode: String) -> ProviderServer? {
//        serverRepository.anyServer(forProviderWithName: providerName, vpnProtocol: vpnProtocol, countryCode: countryCode)
//    }
    
    public func anyDefaultServer(_ name: ProviderName, vpnProtocol: VPNProtocolType) -> ProviderServer? {
        serverRepository.anyDefaultServer(forProviderWithName: name, vpnProtocol: vpnProtocol)
    }
    
    public func server(withId id: String) -> ProviderServer? {
        serverRepository.server(withId: id)
    }

    // MARK: Modification

    public func fetchProvidersIndexPublisher(priority: FetchPriority) -> AnyPublisher<Void, Error> {
        guard !isRateLimited(indexActionName) else {
            return Just(())
                .setFailureType(to: Error.self)
                .eraseToAnyPublisher()
        }
        
        let publisher = priority.publisher(remote: {
            self.webServices.providersIndex()
        }, bundle: {
            self.bundleServices.providersIndex()
        })

        return publisher
            .receive(on: DispatchQueue.main)
            .tryMap { index in
                self.saveLastAction(self.indexActionName)
                try self.providerRepository.mergeIndex(index)
            }.eraseToAnyPublisher()
    }
    
    public func fetchProviderPublisher(withName providerName: ProviderName, vpnProtocol: VPNProtocolType, priority: FetchPriority) -> AnyPublisher<Void, Error> {
        guard !isRateLimited(providerName) else {
            return Just(())
                .setFailureType(to: Error.self)
                .eraseToAnyPublisher()
        }

        let publisher = priority.publisher(remote: {
            let ifModifiedSince = self.infrastructureRepository.lastInfrastructureUpdate(withName: providerName, vpnProtocol: vpnProtocol)
            return self.webServices.providerNetwork(with: providerName, vpnProtocol: vpnProtocol, ifModifiedSince: ifModifiedSince)
        }, bundle: {
            self.bundleServices.providerNetwork(with: providerName, vpnProtocol: vpnProtocol, ifModifiedSince: nil)
        })

        return publisher
            .receive(on: DispatchQueue.main)
            .flatMap { pub -> AnyPublisher<Void, Error> in
                self.saveLastAction(providerName)

                // ignores empty responses (e.g. HTTP 304)
                guard let infrastructure = pub.value else {
                    return Just(())
                        .setFailureType(to: Error.self)
                        .eraseToAnyPublisher()
                }
                
                guard self.appBuild >= infrastructure.buildNumber else {
                    pp_log.error("Infrastructure requires app build >= \(infrastructure.buildNumber) (app is \(self.appBuild))")
                    return Fail(error: ProviderManagerError.outdatedBuild(self.appBuild, infrastructure.buildNumber))
                        .eraseToAnyPublisher()
                }

                do {
                    try self.infrastructureRepository.saveInfrastructure(
                        infrastructure,
                        vpnProtocol: vpnProtocol,
                        lastUpdate: pub.lastModified ?? Date()
                    )
                } catch {
                    pp_log.error("Unable to persist \(providerName) infrastructure (\(vpnProtocol)): \(error)")
                }
                return Just(())
                    .setFailureType(to: Error.self)
                    .eraseToAnyPublisher()
            }.eraseToAnyPublisher()
    }
    
    public func reset() {
        persistence.truncate()
    }

    // MARK: RateLimited
    
    private let indexActionName = ""
    
    public var lastActionDate: [String: Date] = [:]
    
    public var rateLimitMilliseconds: Int?
}

private struct InfrastructureKey: Hashable {
    let providerName: ProviderName
    
    let vpnProtocol: VPNProtocolType
    
    init(_ providerName: ProviderName, _ vpnProtocol: VPNProtocolType) {
        self.providerName = providerName
        self.vpnProtocol = vpnProtocol
    }
}

private struct LocationKey: Hashable {
    let providerName: ProviderName
    
    let vpnProtocol: VPNProtocolType
    
    let categoryName: String
    
    let countryCode: String
    
    init(
        _ providerName: ProviderName,
        _ vpnProtocol: VPNProtocolType,
        _ categoryName: String,
        _ countryCode: String
    ) {
        self.providerName = providerName
        self.vpnProtocol = vpnProtocol
        self.categoryName = categoryName
        self.countryCode = countryCode
    }
}

private extension ProviderLocation {
    var key: LocationKey {
        return .init(providerMetadata.name, vpnProtocol, categoryName, countryCode)
    }
}

private extension ProviderManager.FetchPriority {
    func publisher<T>(
        remote: @escaping () -> AnyPublisher<T, Error>,
        bundle: @escaping () -> AnyPublisher<T, Error>
    ) -> AnyPublisher<T, Error> {
        switch self {
        case .bundle:
            return bundle()
            
        case .remote:
            return remote()
            
        case .remoteThenBundle:
            return remote()
                .catch { error -> AnyPublisher<T, Error> in
                    pp_log.warning("Unable to fetch remotely: \(error)")
                    pp_log.warning("Falling back to bundle")
                    return bundle()
                }.eraseToAnyPublisher()
        }
    }
}