SPB Git

Repository Public

FileProviderExtension.swift 20.4 KB 307 lines swift

1// Author: Simon-Pierre Boucher — contact@spboucher.ai2// File: FileProviderExtension/FileProviderExtension.swift3// Description: SP Drive in the Finder: a replicated File Provider. The system keeps the local replica and calls this class to describe items, fetch contents, and push what was created, edited, renamed, moved, trashed or deleted on this Mac. Content pushed here is always derived from a named server version: a different current version becomes a conflict copy, never an overwrite.4import AppKit5import FileProvider6import Foundation7import OSLog8import SPDriveCore9import SPDriveSync10import UniformTypeIdentifiers1112final class FileProviderExtension: NSObject, NSFileProviderReplicatedExtension, NSFileProviderThumbnailing, NSFileProviderCustomAction, @unchecked Sendable {13    let domain: NSFileProviderDomain14    let manager: NSFileProviderManager?15    private let lock = NSLock()16    private var cached: DriveServices?17    private let log = DriveServices.log1819    required init(domain: NSFileProviderDomain) {20        self.domain = domain21        manager = NSFileProviderManager(for: domain)22        super.init()23    }24    func invalidate() {}2526    /// Built on demand at each call until someone is signed in: the extension is started and stopped by the system at will and keeps no state of its own.27    private func services() throws -> DriveServices {28        try lock.withLock {29            if let c = cached { if (try? AppEnvironment.tokens.readToken()) != nil { return c }; cached = nil }30            let s = try DriveServices(); cached = s; return s31        }32    }33    /// Runs `body` as a task tied to the Progress returned to the system (cancelling one cancels the other).34    private func run(units: Int64 = 1, _ body: @escaping @Sendable (DriveServices, Progress) async throws -> Void, failure: @escaping @Sendable (NSError) -> Void) -> Progress {35        let progress = Progress(totalUnitCount: max(units, 1))36        let task = Task {37            do {38                let s = try self.services()39                do { try await body(s, progress) } catch { self.log.error("operation failed: \(DriveError.wrap(error).code, privacy: .public)"); failure(s.fpError(error)) }40            } catch { failure(error as NSError) }41        }42        progress.cancellationHandler = { task.cancel() }43        return progress44    }45    private func done(_ s: DriveServices) { AppEnvironment.postChanged() }4647    // MARK: Items48    func item(for identifier: NSFileProviderItemIdentifier, request: NSFileProviderRequest, completionHandler: @escaping (NSFileProviderItem?, Error?) -> Void) -> Progress {49        let cb = SendableBox(completionHandler)50        return run({ s, _ in51            let root = try await s.requireRoot()52            if identifier == .trashContainer || identifier == .workingSet { throw NSFileProviderError(.noSuchItem) }53            let id = FileProviderItem.serverID(identifier, rootID: root)54            // the mirror answers at once; an unknown identifier is asked to the server55            let item: DriveItem56            if let known = try s.store.item(id) { item = known } else { item = try await s.fresh(id) }57            cb.value(s.fpItem(item), nil)58        }, failure: { cb.value(nil, $0) })59    }6061    // MARK: Contents62    func fetchContents(for itemIdentifier: NSFileProviderItemIdentifier, version requestedVersion: NSFileProviderItemVersion?, request: NSFileProviderRequest,63                       completionHandler: @escaping (URL?, NSFileProviderItem?, Error?) -> Void) -> Progress {64        let cb = SendableBox(completionHandler)65        let size = (try? services().store.item(itemIdentifier.rawValue))??.size ?? 166        return run(units: size, { s, progress in67            let item = try await s.fresh(itemIdentifier.rawValue, kind: .file)68            guard let tmp = try self.manager?.temporaryDirectoryURL() else { throw DriveError.local("dossier temporaire indisponible") }69            // a stable partial name per content version: an interrupted download resumes, even after the extension was restarted70            let partial = tmp.appendingPathComponent("\(item.id)-\(item.versionID ?? item.sha256).part")71            let dest = tmp.appendingPathComponent("\(UUID().uuidString)-\(item.id)")72            progress.totalUnitCount = max(item.size, 1)73            try await s.downloader.download(fileID: item.id, versionID: item.versionID, sha256: item.sha256, size: item.size, to: dest, partial: partial) { done, _ in progress.completedUnitCount = done }74            cb.value(dest, s.fpItem(item), nil)75        }, failure: { cb.value(nil, nil, $0) })76    }7778    // MARK: Creation79    func createItem(basedOn template: NSFileProviderItem, fields: NSFileProviderItemFields, contents url: URL?, options: NSFileProviderCreateItemOptions = [], request: NSFileProviderRequest,80                    completionHandler: @escaping (NSFileProviderItem?, NSFileProviderItemFields, Bool, Error?) -> Void) -> Progress {81        let cb = SendableBox(completionHandler)82        let name = template.filename, parentIdentifier = template.parentItemIdentifier, type = template.contentType ?? .data83        let reimport = options.contains(.mayAlreadyExist)84        if DriveServices.isExcluded(name) || type.conforms(to: .symbolicLink) || type.conforms(to: .aliasFile) {85            // stays on this Mac only: hidden and temporary files, links (which mean nothing on another device)86            completionHandler(nil, [], false, NSFileProviderError(.excludedFromSync)); return Progress()87        }88        let size = (url.flatMap { try? FileManager.default.attributesOfItem(atPath: $0.path)[.size] as? NSNumber })?.int64Value ?? 189        return run(units: size, { s, progress in90            let root = try await s.requireRoot()91            if parentIdentifier == .trashContainer { throw NSFileProviderError(.cannotSynchronize) } // nothing is created directly in the trash92            let parent = FileProviderItem.serverID(parentIdentifier, rootID: root)93            let created: DriveItem94            if type.conforms(to: .folder) || type.conforms(to: .directory) {95                // after a re-import the folder is already there under the same name: adopt it instead of making "name (2)"96                if reimport, let l = try? await s.api.listFolder(parent), let same = l.folders.first(where: { NameRules.key($0.name) == NameRules.key(NameRules.sanitize(name)) }) { created = same }97                else { created = try await s.api.createFolder(parent: parent, name: name, onConflict: .rename) }98            } else {99                let source: URL100                if let url { source = url } else {101                    // a file created without content: an empty one102                    guard let tmp = try self.manager?.temporaryDirectoryURL() else { throw DriveError.local("dossier temporaire indisponible") }103                    source = tmp.appendingPathComponent("empty-\(UUID().uuidString)"); FileManager.default.createFile(atPath: source.path, contents: nil)104                }105                if reimport, let l = try? await s.api.listFolder(parent), let same = l.files.first(where: { NameRules.key($0.name) == NameRules.key(NameRules.sanitize(name)) }),106                   same.sha256 == (try Hashing.sha256Hex(of: source)).sha256 { created = same } // identical file already on the server107                else {108                    progress.totalUnitCount = max(size, 1)109                    created = try await s.uploader.upload(file: source, to: .newFile(folderID: parent, name: name, onConflict: .rename)) { done, _ in progress.completedUnitCount = done }.item110                }111            }112            try s.store.upsert([created])113            self.done(s)114            cb.value(s.fpItem(created), [], false, nil)115        }, failure: { cb.value(nil, [], false, $0) })116    }117118    // MARK: Modification119    func modifyItem(_ item: NSFileProviderItem, baseVersion version: NSFileProviderItemVersion, changedFields: NSFileProviderItemFields, contents newContents: URL?,120                    options: NSFileProviderModifyItemOptions = [], request: NSFileProviderRequest,121                    completionHandler: @escaping (NSFileProviderItem?, NSFileProviderItemFields, Bool, Error?) -> Void) -> Progress {122        let cb = SendableBox(completionHandler)123        let identifier = item.itemIdentifier, newName = item.filename, newParent = item.parentItemIdentifier, isFolder = item.contentType == .folder || (item.contentType?.conforms(to: .directory) ?? false)124        let base = serverVersionID(version)125        let size = (newContents.flatMap { try? FileManager.default.attributesOfItem(atPath: $0.path)[.size] as? NSNumber })?.int64Value ?? 1126        return run(units: size, { s, progress in127            let root = try await s.requireRoot()128            guard identifier != .rootContainer else { throw NSFileProviderError(.cannotSynchronize) }129            let id = identifier.rawValue, kind: ItemKind = isFolder ? .folder : .file130            let sel = isFolder ? Selection(folderIds: [id]) : Selection(fileIds: [id])131            var current = try await s.fresh(id, kind: kind)132            var refetch = false133134            if changedFields.contains(.parentItemIdentifier) {135                if newParent == .trashContainer {136                    if !current.isTrashed { try await s.api.trash(sel) }137                } else {138                    let dest = FileProviderItem.serverID(newParent, rootID: root)139                    if current.isTrashed { try await s.api.restore(sel); current = try await s.fresh(id, kind: kind) } // out of the trash140                    if current.parentID != dest { try await s.api.move(sel, to: dest, onConflict: .rename) }141                }142                refetch = true143            }144            if changedFields.contains(.filename), NameRules.sanitize(newName) != current.name, !current.isTrashed || newParent != .trashContainer {145                do { _ = try await s.api.update(current, name: newName) }146                catch let e as DriveError where e.code == "name_conflict" {147                    // the name is taken on the server: tell the system which item holds it, it resolves the collision locally148                    let parent = (try await s.fresh(id, kind: kind)).parentID ?? root149                    if let l = try? await s.api.listFolder(parent), let other = l.children.first(where: { NameRules.key($0.name) == NameRules.key(NameRules.sanitize(newName)) }), let fp = s.fpItem(other) {150                        throw NSError.fileProviderErrorForCollision(with: fp)151                    }152                    throw e153                }154                refetch = true155            }156            var fetchContent = false157            if changedFields.contains(.contents), let newContents, !isFolder {158                progress.totalUnitCount = max(size, 1)159                // the edit was made from `base`; the server refuses to replace anything else160                let outcome = try await s.uploader.upload(file: newContents, to: .newVersion(fileID: id, folderID: current.parentID ?? root, name: current.name, baseVersionID: base ?? current.versionID)) { done, _ in progress.completedUnitCount = done }161                if case .conflictCopy(let copy, _) = outcome {162                    // both versions exist on the server now: this Mac's content under a conflict name, the other device's under the original name163                    try s.store.upsert([copy])164                    _ = try? s.conflicts.record(itemID: id, itemName: current.name, copy: copy, detail: "modifié dans le Finder pendant qu’un autre appareil modifiait le fichier")165                    self.log.notice("conflict: local edit kept as a copy")166                    fetchContent = true // the original on this Mac must take the server's content167                    self.manager?.signalEnumerator(for: .workingSet) { _ in }168                }169                refetch = true170            }171            let result = refetch ? try await s.fresh(id, kind: kind) : current172            self.done(s)173            cb.value(s.fpItem(result), [], fetchContent, nil)174        }, failure: { cb.value(nil, [], false, $0) })175    }176177    // MARK: Deletion178    func deleteItem(identifier: NSFileProviderItemIdentifier, baseVersion version: NSFileProviderItemVersion, options: NSFileProviderDeleteItemOptions = [], request: NSFileProviderRequest,179                    completionHandler: @escaping (Error?) -> Void) -> Progress {180        let cb = SendableBox(completionHandler)181        return run({ s, _ in182            let id = identifier.rawValue183            guard let item = try await s.api.items(Selection(fileIds: [id], folderIds: [id])).all.first else { try? s.store.remove([id]); cb.value(nil); return } // already gone184            let sel = Selection([item])185            if item.isTrashed {186                // deleted from the trash, by an explicit action of the person: gone for good187                if item.trashRoot { try await s.api.purge(sel); try s.store.remove(try s.store.subtreeIDs(of: id, includeTrashed: true)) }188            } else {189                // a deletion coming from this Mac is never a destruction: the item goes to the trash of SP Drive, where it can be restored190                try await s.api.trash(sel)191                _ = try? await s.fresh(id, kind: item.kind)192            }193            self.done(s)194            cb.value(nil)195        }, failure: { cb.value($0) })196    }197198    // MARK: Enumeration199    func enumerator(for containerItemIdentifier: NSFileProviderItemIdentifier, request: NSFileProviderRequest) throws -> NSFileProviderEnumerator {200        let s = try services()201        switch containerItemIdentifier {202        case .workingSet: return FileProviderEnumerator(scope: .workingSet, services: s)203        case .trashContainer: return FileProviderEnumerator(scope: .trash, services: s)204        case .rootContainer:205            guard let root = s.rootID else { return FileProviderEnumerator(scope: .folder("root"), services: s) }206            return FileProviderEnumerator(scope: .folder(root), services: s)207        default: return FileProviderEnumerator(scope: .folder(containerItemIdentifier.rawValue), services: s)208        }209    }210211    // MARK: What is on this Mac212    func materializedItemsDidChange(completionHandler: @escaping () -> Void) {213        guard let s = try? services(), let e = manager?.enumeratorForMaterializedItems() else { completionHandler(); return }214        let done = SendableBox(completionHandler)215        Collector(e) { ids in216            try? s.store.replaceMaterialized(Set(ids.map(\.rawValue)))217            AppEnvironment.postChanged(); done.value()218        }.start()219    }220    func pendingItemsDidChange(completionHandler: @escaping () -> Void) {221        guard let s = try? services(), let e = manager?.enumeratorForPendingItems() else { completionHandler(); return }222        let done = SendableBox(completionHandler)223        Collector(e) { ids in224            try? s.store.setMeta("fp_pending", String(ids.count))225            AppEnvironment.postChanged(); done.value()226        }.start()227    }228229    // MARK: Context-menu actions (declared in Info.plist, `NSExtensionFileProviderActions`)230    enum Action: String {231        case copyLink, keepOffline, releaseOffline, showVersions232        static let prefix = "\(AppEnvironment.appBundleID).fileprovider.action."233        init?(_ id: NSFileProviderExtensionActionIdentifier) { guard id.rawValue.hasPrefix(Action.prefix) else { return nil }; self.init(rawValue: String(id.rawValue.dropFirst(Action.prefix.count))) }234    }235    func performAction(identifier actionIdentifier: NSFileProviderExtensionActionIdentifier, onItemsWithIdentifiers itemIdentifiers: [NSFileProviderItemIdentifier], completionHandler: @escaping (Error?) -> Void) -> Progress {236        let cb = SendableBox(completionHandler)237        guard let action = Action(actionIdentifier) else { completionHandler(NSError(domain: NSCocoaErrorDomain, code: NSFeatureUnsupportedError)); return Progress() }238        return run(units: Int64(max(itemIdentifiers.count, 1)), { s, progress in239            let root = try await s.requireRoot()240            let ids = itemIdentifiers.map { FileProviderItem.serverID($0, rootID: root) }241            switch action {242            case .copyLink:243                // a new link to this one item (read and download), its address put on the clipboard; managed afterwards in the app244                guard let id = ids.first else { break }245                let item = try await s.fresh(id)246                let made = try await s.api.createShare(for: item, settings: ShareSettings(label: "Créé depuis le Finder"))247                NSPasteboard.general.clearContents(); NSPasteboard.general.setString(made.url.absoluteString, forType: .string)248                let known = s.sharedIDs().union([id])249                try? s.store.setMeta("shared_ids", known.sorted().joined(separator: ",")); s.forgetSharedCache()250                try? s.store.touch([id])251                progress.completedUnitCount = 1252            case .keepOffline:253                for id in ids { try s.store.setPinned(id, true); try? s.store.touch([id]); progress.completedUnitCount += 1 } // the content policy then makes the system download and keep them254            case .releaseOffline:255                for id in ids {256                    try s.store.setPinned(id, false); try? s.store.touch([id])257                    try? await self.manager?.evictItem(identifier: NSFileProviderItemIdentifier(id)) // refused by the system for unsent edits: they stay258                    progress.completedUnitCount += 1259                }260            case .showVersions:261                guard let id = ids.first else { break }262                // the app shows it: a note in the shared database, a signal, and the app is opened if it was not running263                try s.store.setMeta("ui_request", "versions|\(id)|\(Date().timeIntervalSince1970)")264                let app = Bundle.main.bundleURL.deletingLastPathComponent().deletingLastPathComponent().deletingLastPathComponent()265                if app.pathExtension == "app" { let c = NSWorkspace.OpenConfiguration(); c.activates = true; _ = try? await NSWorkspace.shared.openApplication(at: app, configuration: c) }266            }267            self.manager?.signalEnumerator(for: .workingSet) { _ in }268            self.done(s)269            self.log.notice("custom action \(action.rawValue, privacy: .public) on \(ids.count) item(s)")270            cb.value(nil)271        }, failure: { cb.value($0) })272    }273274    // MARK: Thumbnails275    func fetchThumbnails(for itemIdentifiers: [NSFileProviderItemIdentifier], requestedSize size: CGSize, perThumbnailCompletionHandler: @escaping (NSFileProviderItemIdentifier, Data?, Error?) -> Void,276                         completionHandler: @escaping (Error?) -> Void) -> Progress {277        let per = SendableBox(perThumbnailCompletionHandler), all = SendableBox(completionHandler)278        let progress = Progress(totalUnitCount: Int64(itemIdentifiers.count))279        let task = Task {280            guard let s = try? self.services() else { all.value(NSFileProviderError(.notAuthenticated)); return }281            for id in itemIdentifiers {282                if Task.isCancelled { break }283                guard (try? s.store.item(id.rawValue))??.hasThumbnail == true, let request = try? s.api.thumbnailRequest(fileID: id.rawValue), let (data, _) = try? await s.api.data(for: request) else { per.value(id, nil, nil); continue }284                per.value(id, data, nil); progress.completedUnitCount += 1285            }286            all.value(nil)287        }288        progress.cancellationHandler = { task.cancel() }289        return progress290    }291}292293/// Reads every page of a system enumerator (materialised or pending items) and hands the identifiers over once.294final class Collector: NSObject, NSFileProviderEnumerationObserver, @unchecked Sendable {295    private let enumerator: NSFileProviderEnumerator296    private var ids: [NSFileProviderItemIdentifier] = []297    private let finish: ([NSFileProviderItemIdentifier]) -> Void298    private var keep: Collector?299    init(_ e: NSFileProviderEnumerator, finish: @escaping ([NSFileProviderItemIdentifier]) -> Void) { enumerator = e; self.finish = finish }300    func start() { keep = self; enumerator.enumerateItems(for: self, startingAt: NSFileProviderPage(NSFileProviderPage.initialPageSortedByName as Data)) }301    func didEnumerate(_ updatedItems: [NSFileProviderItemProtocol]) { ids.append(contentsOf: updatedItems.map(\.itemIdentifier)) }302    func finishEnumerating(upTo nextPage: NSFileProviderPage?) {303        if let nextPage { enumerator.enumerateItems(for: self, startingAt: nextPage) } else { finish(ids); enumerator.invalidate(); keep = nil }304    }305    func finishEnumeratingWithError(_ error: Error) { finish(ids); enumerator.invalidate(); keep = nil }306}307
Files main
Menu

Theme