passepartout-apple/Library/Sources/AppUIMain/Views/Providers/ProviderContentModifier.swift
Davide fae0200995
Exclude OpenVPN endpoints (#987)
Exclude endpoints from OpenVPN modules and providers with the generic
Blacklist<T> observable. Eventually, rebuild the Profile in
PacketTunnelProvider (via DefaultTunnelProcessor) with the applied
exclusions from preferences.

Revisit approach to preferences:

- Module preferences
  - Tied to the module and therefore to the parent profile
- Load/save in ProfileEditor on request (rather than on
ProfileEditor.load)
- Provider preferences
  - Shared globally across profiles
  - Load/save in module view if needed

For more consistency with Core Data:

- Revert to observables for both module and provider preferences
- Treat excluded endpoints as relationships rather than a serialized
Array
- Add/remove single relationships over bulk delete + re-add
- Do not map the relationships, Blacklist only needs exists/add/remove:
  - isExcludedEndpoint
  - addExcludedEndpoint
  - removeExcludedEndpoint

Some clean-up:

- Move the importer logic to OpenVPNView.ImportModifier
- Move the preview data to OpenVPN.Configuration.Builder.forPreviews
- Drop objectWillChange.send() on .repository didSet to avoid potential
recursion during SwiftUI updates

Closes #971
2024-12-09 02:00:55 +01:00

231 lines
6.5 KiB
Swift

//
// ProviderContentModifier.swift
// Passepartout
//
// Created by Davide De Rosa on 10/14/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 <http://www.gnu.org/licenses/>.
//
import CommonAPI
import CommonLibrary
import PassepartoutKit
import SwiftUI
import UILibrary
struct ProviderContentModifier<Entity, ProviderRows>: ViewModifier where Entity: ProviderEntity, ProviderRows: View {
@EnvironmentObject
private var providerManager: ProviderManager
@EnvironmentObject
private var preferencesManager: PreferencesManager
let apis: [APIMapper]
@Binding
var providerId: ProviderID?
let providerPreferences: ProviderPreferences?
let entityType: Entity.Type
@Binding
var paywallReason: PaywallReason?
@ViewBuilder
let providerRows: ProviderRows
let onSelectProvider: (ProviderManager, ProviderID?, _ isInitial: Bool) -> Void
func body(content: Content) -> some View {
providerView
.onLoad(perform: loadCurrentProvider)
.onChange(of: providerId) { newId in
Task {
if let newId {
await refreshInfrastructure(for: newId)
}
loadPreferences(for: newId)
onSelectProvider(providerManager, newId, false)
}
}
.onDisappear(perform: savePreferences)
.disabled(providerManager.isLoading)
content
}
static func == (lhs: Self, rhs: Self) -> Bool {
lhs.providerId == rhs.providerId
}
}
private extension ProviderContentModifier {
#if os(iOS)
@ViewBuilder
var providerView: some View {
providerPicker
.themeSection()
if let providerId {
Group {
providerRows
RefreshInfrastructureButton(apis: apis, providerId: providerId)
}
.themeSection(footer: lastUpdatedString)
}
}
#else
@ViewBuilder
var providerView: some View {
Section {
providerPicker
}
if let providerId {
Section {
providerRows
HStack {
lastUpdatedString.map {
Text($0)
.themeSubtitle()
}
Spacer()
RefreshInfrastructureButton(apis: apis, providerId: providerId)
}
}
}
}
#endif
var providerPicker: some View {
ProviderPicker(
providers: supportedProviders,
providerId: $providerId,
isRequired: true,
isLoading: providerManager.isLoading,
paywallReason: $paywallReason
)
}
}
private extension ProviderContentModifier {
var supportedProviders: [Provider] {
providerManager
.providers
.filter {
$0.supports(Entity.Template.self)
}
}
var lastUpdate: Date? {
guard let providerId else {
return nil
}
return providerManager.lastUpdate(for: providerId)
}
var lastUpdatedString: String? {
guard let lastUpdate else {
return providerManager.isLoading ? Strings.Views.Providers.LastUpdated.loading : nil
}
return Strings.Views.Providers.lastUpdated(lastUpdate.localizedDescription(style: .timestamp))
}
func loadCurrentProvider() {
Task {
await refreshIndex()
if let providerId {
onSelectProvider(providerManager, providerId, true)
loadPreferences(for: providerId)
}
}
}
@discardableResult
func refreshIndex() async -> Bool {
do {
try await providerManager.fetchIndex(from: apis)
return true
} catch {
pp_log(.app, .error, "Unable to fetch index: \(error)")
return false
}
}
@discardableResult
func refreshInfrastructure(for providerId: ProviderID) async -> Bool {
do {
try await providerManager.fetchVPNInfrastructure(from: apis, for: providerId)
return true
} catch {
pp_log(.app, .error, "Unable to refresh infrastructure: \(error)")
return false
}
}
func loadPreferences(for providerId: ProviderID?) {
guard let providerPreferences else {
return
}
if let providerId {
do {
pp_log(.app, .debug, "Load preferences for provider \(providerId)")
providerPreferences.repository = try preferencesManager.preferencesRepository(forProviderWithId: providerId)
} catch {
pp_log(.app, .error, "Unable to load preferences for provider \(providerId): \(error)")
providerPreferences.repository = nil
}
} else {
providerPreferences.repository = nil
}
}
func savePreferences() {
guard let providerPreferences else {
return
}
do {
pp_log(.app, .debug, "Save preferences for provider \(providerId.debugDescription)")
try providerPreferences.save()
} catch {
pp_log(.app, .error, "Unable to save preferences for provider \(providerId.debugDescription): \(error)")
}
}
}
// MARK: - Preview
#Preview {
List {
EmptyView()
.modifier(ProviderContentModifier(
apis: [API.bundled],
providerId: .constant(.hideme),
providerPreferences: nil,
entityType: VPNEntity<OpenVPN.Configuration>.self,
paywallReason: .constant(nil),
providerRows: {},
onSelectProvider: { _, _, _ in }
))
}
.withMockEnvironment()
}