SPB Git

Repository Public License

ActionsController.swift 12.3 KB 253 lines swift

1// ORIX Secure2// File: App/Sources/Features/Actions/ActionsController.swift3// Description: Connects the workflow engine to the app's real operations. Each step kind runs the same code as its screen.4//              A destructive step (photo deletion) always waits for the user's confirmation, then for iOS's own confirmation.5//6// Author: Simon-Pierre Boucher7// Contact: contact@spboucher.ai8import ORIXMediaCleanup9import ORIXNetworkLab10import ORIXSecureEngines11import ORIXSecureModel12import ORIXURLRisk13import ORIXWorkflow14import SwiftUI1516@Observable final class ActionsController {17    struct StepState: Identifiable {18        let id: UUID19        let step: WorkflowStep20        var status: Status = .pending21        var progress: Double?22        var message: String?23        enum Status: Equatable { case pending, running, awaitingConfirmation, succeeded, failed, skipped }24    }2526    private let runner = WorkflowRunner()27    private weak var model: AppModel?28    private var runTask: Task<Void, Never>?29    private var confirmation: CheckedContinuation<ConfirmationDecision, Never>?30    private var review: CheckedContinuation<Bool, Never>?3132    private(set) var definition: WorkflowDefinition?33    private(set) var steps: [StepState] = []34    private(set) var run: WorkflowRun?35    private(set) var isRunning = false36    /// The step waiting for the user's confirmation.37    private(set) var pendingConfirmation: WorkflowStep?38    /// True while the photo review step waits for the user to finish choosing.39    var isReviewingPhotos = false40    private(set) var custom: [WorkflowDefinition] = []4142    init(model: AppModel) {43        self.model = model44        loadCustom()45    }4647    // MARK: Library4849    var library: [WorkflowDefinition] { WorkflowLibrary.builtIn + custom }5051    static let stepCatalog: [(kind: WorkflowStepKind, title: String, destructive: Bool)] = [52        (.securityAssessment, L("Security assessment"), false),53        (.checklistReview, L("Checklist review"), false),54        (.networkDiagnostics, L("Network diagnostics"), false),55        (.urlInspect, L("Link inspection"), false),56        (.storageOverview, L("Storage assessment"), false),57        (.photosScan, L("Duplicate and similar photo detection"), false),58        (.photosReview, L("Review photo candidates"), false),59        (.photosDelete, L("Delete the photos you selected"), true),60        (.reportGenerate, L("Generate report"), false),61    ]6263    private func loadCustom() {64        guard let model else { return }65        custom = model.store.workflowPayloads().compactMap { try? JSONDecoder().decode(WorkflowDefinition.self, from: $0) }66    }6768    /// Builds and saves a user workflow. Throws the engine's validation error (for example a deletion without a review before it).69    func saveCustom(name: String, kinds: [WorkflowStepKind]) throws {70        let steps = kinds.map { kind in71            let entry = Self.stepCatalog.first { $0.kind == kind }72            return WorkflowStep(kind: kind, title: entry?.title ?? kind.rawValue, requiresConfirmation: entry?.destructive ?? false, isDestructive: entry?.destructive ?? false)73        }74        let definition = try WorkflowDefinition(name: name, summary: L("Your workflow · \(steps.count) step(s)"), systemImage: "person.crop.circle.badge.plus", steps: steps)75        let data = try JSONEncoder().encode(definition)76        model?.store.saveWorkflow(id: definition.id.uuidString, name: definition.name, payload: data)77        loadCustom()78    }7980    func deleteCustom(_ definition: WorkflowDefinition) {81        model?.store.deleteWorkflow(id: definition.id.uuidString)82        loadCustom()83    }8485    // MARK: Running8687    func start(_ definition: WorkflowDefinition, link: String?) {88        guard !isRunning, let model else { return }89        self.definition = definition90        steps = definition.steps.map { StepState(id: $0.id, step: $0) }91        run = nil92        isRunning = true93        let registry = makeRegistry(model: model)94        let initial = link.map { ["url": $0] } ?? [:]95        runTask = Task { [weak self] in96            guard let self else { return }97            let events = await self.runner.run(definition, handlers: registry, initialValues: initial) { step in98                await withCheckedContinuation { continuation in99                    Task { @MainActor in100                        self.confirmation = continuation101                        self.pendingConfirmation = step102                    }103                }104            }105            for await event in events { self.handle(event) }106            self.isRunning = false107        }108    }109110    func answerConfirmation(_ decision: ConfirmationDecision) {111        pendingConfirmation = nil112        confirmation?.resume(returning: decision)113        confirmation = nil114    }115116    func finishReview(proceed: Bool) {117        isReviewingPhotos = false118        review?.resume(returning: proceed)119        review = nil120    }121122    func cancel() {123        Task { await runner.cancel() }124        answerConfirmation(.declined)125        finishReview(proceed: false)126    }127128    private func update(_ index: Int, _ change: (inout StepState) -> Void) {129        guard steps.indices.contains(index) else { return }130        change(&steps[index])131    }132133    private func handle(_ event: WorkflowEvent) {134        switch event {135        case .started: break136        case .stepStarted(let index, _): update(index) { $0.status = .running }137        case .stepProgress(let index, let fraction, let message): update(index) { $0.progress = fraction; if let message { $0.message = message } }138        case .awaitingConfirmation(let index, _): update(index) { $0.status = .awaitingConfirmation }139        case .stepFinished(let index, _, let output): update(index) { $0.status = .succeeded; $0.message = output.summary; $0.progress = nil }140        case .stepSkipped(let index, _, let reason): update(index) { $0.status = .skipped; $0.message = reason; $0.progress = nil }141        case .stepFailed(let index, _, let error): update(index) { $0.status = .failed; $0.message = error; $0.progress = nil }142        case .finished(let run):143            self.run = run144            var report = run.report()145            report.generator = ReportBuilder.generator146            model?.store.save(report)147        }148    }149150    private func waitForPhotoReview() async -> Bool {151        await withCheckedContinuation { continuation in152            review = continuation153            isReviewingPhotos = true154        }155    }156157    // MARK: Handlers158159    private func makeRegistry(model: AppModel) -> WorkflowHandlerRegistry {160        var registry = WorkflowHandlerRegistry()161        registry.register(.securityAssessment) { _, _, _ in162            await MainActor.run {163                model.refresh()164                let assessment = model.assessment165                let summary = assessment.summary166                return StepOutput(summary: L("\(summary.attention) to act on, \(summary.verified) verified, \(summary.awaitingConfirmation) awaiting your confirmation"),167                                  findings: assessment.automatic + assessment.contributed,168                                  section: .init(title: L("Security assessment"), facts: ReportBuilder.summaryFacts(summary), findings: assessment.actions))169            }170        }171        registry.register(.checklistReview) { _, _, _ in172            await MainActor.run {173                let pending = model.assessment.pendingConfirmations174                let reported = model.assessment.checklist.filter { $0.state == .attention }175                return StepOutput(summary: L("\(pending.count) setting(s) still to confirm, \(reported.count) reported as needing action"),176                                  findings: reported,177                                  section: .init(title: L("Checklist"), findings: reported, bullets: pending.map { $0.title }))178            }179        }180        registry.register(.storageOverview) { _, _, _ in181            await MainActor.run {182                model.refresh()183                let overview = model.storage184                let free = overview.volume.bestAvailable.value.map { ORIXFormat.bytes($0) } ?? L("not available")185                return StepOutput(summary: L("\(free) available"), findings: overview.findings,186                                  section: ReportBuilder.storage(overview).sections.first)187            }188        }189        registry.register(.networkDiagnostics) { _, _, _ in190            await model.network.assess()191            return await MainActor.run {192                let findings = model.network.findings193                return StepOutput(summary: L("\(findings.count(.attention)) network finding(s) need attention"), findings: findings,194                                  section: .init(title: L("Network"), findings: findings))195            }196        }197        registry.register(.urlInspect) { step, context, _ in198            let link = await context.value(for: "url") ?? step.parameters["url"]199            guard let link, !link.trimmingCharacters(in: .whitespaces).isEmpty else {200                return StepOutput(summary: L("No link was provided, so nothing was inspected."))201            }202            let analysis = URLRiskAnalyzer().analyze(link)203            return StepOutput(summary: L("\(analysis.level.title) · \(analysis.findings.count) signal(s)"), findings: analysis.findings,204                              section: analysis.reportDocument().sections.first)205        }206        registry.register(.photosScan) { _, _, progress in207            let output: CleanupPipelineOutput? = await withCheckedContinuation { continuation in208                Task { @MainActor in209                    let photos = model.photos210                    photos.refreshAccess()211                    if photos.access == .notDetermined { await photos.requestAccess() }212                    guard photos.access.canRead else { continuation.resume(returning: nil); return }213                    photos.scan { continuation.resume(returning: $0) }214                    // The scan reports its own failure through its phase; poll it so a failure does not hang the workflow.215                    while photos.isScanning { try? await Task.sleep(for: .milliseconds(200)); if case .scanning(let message, let fraction) = photos.phase { progress(fraction ?? 0, message) } }216                    if photos.output == nil || photos.phase != .results { continuation.resume(returning: nil) }217                }218            }219            guard let output else { throw PhotoStepError.noAccessOrFailed }220            let totals = output.analysis.totals221            return StepOutput(summary: L("\(totals.candidateCount) candidate(s), \(ORIXFormat.bytes(totals.measuredBytes)) measured"),222                              section: .init(title: L("Photo scan"), facts: [223                                  .init(L("Items scanned"), "\(output.analysis.statistics.itemsScanned)"), .init(L("Cleanup candidates"), "\(totals.candidateCount)"),224                                  .init(L("Measured size of candidates"), ORIXFormat.bytes(totals.measuredBytes)), .init(L("Candidates of unknown size"), "\(totals.notMeasuredCount)"),225                              ]))226        }227        registry.register(.photosReview) { [weak self] _, _, _ in228            guard let self else { throw CancellationError() }229            let proceed = await self.waitForPhotoReview()230            guard proceed else { throw CancellationError() }231            let count = await MainActor.run { model.photos.selection.count }232            return StepOutput(summary: L("\(count) item(s) selected by you"), values: ["photos.selected": "\(count)"])233        }234        registry.register(.photosDelete) { _, _, _ in235            let plan = await MainActor.run { model.photos.plan() }236            guard let plan, !plan.isEmpty else { return StepOutput(summary: L("Nothing was selected, so nothing was deleted.")) }237            let result = await model.photos.delete(plan)238            await MainActor.run { model.refresh() }239            return StepOutput(summary: result.summary, section: result.report(generator: ReportBuilder.generator).sections.first)240        }241        registry.register(.reportGenerate) { _, context, _ in242            let sections = await context.sections243            return StepOutput(summary: L("Report with \(sections.count) section(s) saved to Reports"))244        }245        return registry246    }247}248249enum PhotoStepError: LocalizedError {250    case noAccessOrFailed251    var errorDescription: String? { L("The photo library could not be scanned (no access, or the scan was interrupted).") }252}253
Files main
Menu

Theme