Repository Public
1// SP Drive iOS2// File: FileProviderExtension/FileProviderExtension.swift3// Description: SP Drive as a location of the Files app (replicated File Provider). The system owns the files on disk and the queue of4// pending changes; this extension answers its requests against MacLustr: list, download on demand, create, rename, move,5// trash, delete, upload edits. It keeps no state in memory between requests beyond what it can rebuild: iOS stops it at will.6//7// Author: Simon-Pierre Boucher8// Contact: contact@spboucher.ai9import FileProvider10import Foundation11import UIKit12import UniformTypeIdentifiers1314final class FileProviderExtension: NSObject, NSFileProviderReplicatedExtension, NSFileProviderThumbnailing, @unchecked Sendable {15 private let domain: NSFileProviderDomain16 private let context: ProviderContext?1718 required init(domain: NSFileProviderDomain) {19 self.domain = domain20 context = try? ProviderContext(domain: domain)21 super.init()22 }2324 func invalidate() {}2526 /// Runs one request. The returned progress is cancellable: the system cancels work it no longer needs.27 private func run(units: Int64 = 100, _ body: @escaping @Sendable (ProviderContext, Progress) async throws -> Void, failure: @escaping @Sendable (Error) -> Void) -> Progress {28 let progress = Progress(totalUnitCount: units)29 guard let context else { failure(NSFileProviderError(.cannotSynchronize)); return progress }30 let task = Task {31 do {32 guard context.api.isSignedIn else { throw RemoteError.unauthenticated }33 try await body(context, progress)34 } catch {35 Log.provider.notice("request failed: \(String(describing: error), privacy: .public)")36 failure(context.providerError(error))37 }38 }39 progress.cancellationHandler = { task.cancel() }40 return progress41 }4243 private var scratchDirectory: URL {44 let base = (try? context?.manager?.temporaryDirectoryURL()) ?? FileManager.default.temporaryDirectory45 return base46 }4748 // MARK: Items4950 func item(for identifier: NSFileProviderItemIdentifier, request: NSFileProviderRequest, completionHandler: @escaping (NSFileProviderItem?, Error?) -> Void) -> Progress {51 nonisolated(unsafe) let done = completionHandler52 return run({ context, _ in53 if identifier == .trashContainer || identifier == .workingSet { throw NSFileProviderError(.noSuchItem) }54 if context.item(identifier) == nil { try await context.refresh() }55 guard let item = context.item(identifier) else { throw NSFileProviderError(.noSuchItem) }56 done(context.providerItem(item), nil)57 }, failure: { done(nil, $0) })58 }5960 func enumerator(for containerItemIdentifier: NSFileProviderItemIdentifier, request: NSFileProviderRequest) throws -> NSFileProviderEnumerator {61 guard let context else { throw NSFileProviderError(.cannotSynchronize) }62 guard context.api.isSignedIn else { throw NSFileProviderError(.notAuthenticated) }63 switch containerItemIdentifier {64 case .workingSet: return FileProviderEnumerator(scope: .workingSet, context: context)65 case .trashContainer: return FileProviderEnumerator(scope: .trash, context: context)66 case .rootContainer:67 // the root's identifier is learnt from the server on the first listing68 return RootEnumerator(context: context)69 default: return FileProviderEnumerator(scope: .folder(containerItemIdentifier.rawValue), context: context)70 }71 }7273 // MARK: Download on demand7475 func fetchContents(for itemIdentifier: NSFileProviderItemIdentifier, version requestedVersion: NSFileProviderItemVersion?, request: NSFileProviderRequest,76 completionHandler: @escaping (URL?, NSFileProviderItem?, Error?) -> Void) -> Progress {77 nonisolated(unsafe) let done = completionHandler78 let scratch = scratchDirectory79 return run({ context, progress in80 // always serve the server's current content: ask it for the item's present state first81 guard let id = context.id(itemIdentifier) else { throw NSFileProviderError(.noSuchItem) }82 let item = try await context.api.item(id: id, isFolder: false)83 try? context.store.upsert(item)84 if item.isInfected { throw NSFileProviderError(.cannotSynchronize) }85 progress.totalUnitCount = max(1, item.size)86 // named after the content, so an interrupted download of the same content is completed rather than restarted87 let dest = scratch.appendingPathComponent("dl-\(LocalFiles.safeID(item.id))-\(item.sha256.prefix(16))")88 try await DirectTransfer.download(item: item, api: context.api, to: dest) { progress.completedUnitCount = $0 }89 done(dest, context.providerItem(item), nil)90 }, failure: { done(nil, nil, $0) })91 }9293 // MARK: Changes made in Files9495 func createItem(basedOn itemTemplate: NSFileProviderItem, fields: NSFileProviderItemFields, contents url: URL?, options: NSFileProviderCreateItemOptions = [], request: NSFileProviderRequest,96 completionHandler: @escaping (NSFileProviderItem?, NSFileProviderItemFields, Bool, Error?) -> Void) -> Progress {97 nonisolated(unsafe) let done = completionHandler98 let name = itemTemplate.filename99 let parentIdentifier = itemTemplate.parentItemIdentifier100 let type = itemTemplate.contentType ?? .data101 let templateID = itemTemplate.itemIdentifier.rawValue102 let starred = itemTemplate.favoriteRank ?? nil != nil103 let scratch = scratchDirectory.appendingPathComponent("chunk-\(UUID().uuidString)")104 return run({ context, progress in105 if context.store.rootID == nil { try await context.refresh() }106 guard let parentID = context.id(parentIdentifier), parentIdentifier != .trashContainer else { throw NSFileProviderError(.noSuchItem) }107 var created: DriveItem108 if type.conforms(to: .folder) || type == .directory {109 created = try await context.api.createFolder(parentID: parentID, name: name, onConflict: .rename)110 } else if type.conforms(to: .symbolicLink) || type.conforms(to: .package) || type.conforms(to: .aliasFile) {111 // not representable on the Drive: tell the system to keep it local only112 throw NSError(domain: NSCocoaErrorDomain, code: NSFeatureUnsupportedError)113 } else {114 let source: URL115 if let url { source = url } else {116 source = scratch.appendingPathExtension("empty")117 FileManager.default.createFile(atPath: source.path, contents: nil)118 }119 created = try await DirectTransfer.upload(file: source, remote: context.api, store: context.store, resumeKey: "create:\(templateID):\(parentID):\(name)", scratch: scratch,120 progress: { d, t in progress.totalUnitCount = max(1, t); progress.completedUnitCount = d }) { size in121 try await context.api.createUpload(parentID: parentID, name: name, size: size, onConflict: .rename, fileID: nil, baseVersionID: nil)122 }123 }124 if starred, let s = try? await context.api.setStarred(id: created.id, isFolder: created.isFolder, starred: true) { created = s }125 context.record(created)126 done(context.providerItem(created), [], false, nil)127 }, failure: { done(nil, [], false, $0) })128 }129130 func modifyItem(_ item: NSFileProviderItem, baseVersion version: NSFileProviderItemVersion, changedFields: NSFileProviderItemFields, contents newContents: URL?,131 options: NSFileProviderModifyItemOptions = [], request: NSFileProviderRequest, completionHandler: @escaping (NSFileProviderItem?, NSFileProviderItemFields, Bool, Error?) -> Void) -> Progress {132 nonisolated(unsafe) let done = completionHandler133 let identifier = item.itemIdentifier134 let newName = item.filename135 let newParent = item.parentItemIdentifier136 let favorite = (item.favoriteRank ?? nil) != nil137 let baseVersionID = FileProviderItem.baseVersionID(from: version)138 let folderHint = item.contentType?.conforms(to: .folder) == true139 let scratch = scratchDirectory.appendingPathComponent("chunk-\(UUID().uuidString)")140 return run({ context, progress in141 guard let id = context.id(identifier), identifier != .rootContainer else { throw NSFileProviderError(.noSuchItem) }142 var current = try await context.api.item(id: id, isFolder: context.store.item(id)?.isFolder ?? folderHint)143 let files = current.isFolder ? [] : [id], folders = current.isFolder ? [id] : []144145 if changedFields.contains(.parentItemIdentifier) {146 if newParent == .trashContainer {147 if !current.isTrashed { try await context.api.trash(fileIDs: files, folderIDs: folders) }148 } else {149 if current.isTrashed { try await context.api.restore(fileIDs: files, folderIDs: folders) }150 guard let dest = context.id(newParent) else { throw NSFileProviderError(.noSuchItem) }151 let now = try await context.api.item(id: id, isFolder: current.isFolder)152 if now.parentID != dest { try await context.api.move(fileIDs: files, folderIDs: folders, to: dest, onConflict: .rename) }153 }154 current = try await context.api.item(id: id, isFolder: current.isFolder)155 }156 if changedFields.contains(.filename), newName != current.name, !current.isTrashed {157 do { current = try await context.api.rename(id: id, isFolder: current.isFolder, name: newName) }158 catch RemoteError.nameConflict {159 // another item already has that name on the Drive: the system resolves it by renaming locally160 if let other = context.store.children(of: current.parentID ?? "").first(where: { $0.name.lowercased() == newName.lowercased() && $0.id != id }) {161 throw NSError.fileProviderErrorForCollision(with: context.providerItem(other))162 }163 throw NSFileProviderError(.cannotSynchronize)164 }165 }166 if changedFields.contains(.favoriteRank), favorite != current.starred {167 current = try await context.api.setStarred(id: id, isFolder: current.isFolder, starred: favorite)168 }169 if changedFields.contains(.contents), let newContents, !current.isFolder {170 let parentID = current.parentID ?? context.store.rootID ?? "root"171 let name = current.name172 do {173 current = try await DirectTransfer.upload(file: newContents, remote: context.api, store: context.store, resumeKey: "modify:\(id)", scratch: scratch,174 progress: { d, t in progress.totalUnitCount = max(1, t); progress.completedUnitCount = d }) { size in175 try await context.api.createUpload(parentID: parentID, name: name, size: size, onConflict: .version, fileID: id, baseVersionID: baseVersionID)176 }177 } catch let refused as DirectTransfer.UploadRefused where refused.error == .versionConflict {178 // The file changed on the server since the version edited here. Nothing is overwritten: the edit is stored as a separate179 // file next to the original (the bytes already sent are reused), and the original takes the server's content.180 let copyName = SyncEngine.conflictName(name, device: await MainActor.run { UIDevice.current.name })181 try await context.api.convertUploadToNewFile(id: refused.uploadID, name: copyName)182 let copy = try await context.api.completeUpload(id: refused.uploadID, sha256: refused.sha256)183 if let key = refused.resumeKey { context.store.setMeta(key, nil) }184 try? context.store.upsert(copy)185 current = try await context.api.item(id: id, isFolder: false)186 } catch RemoteError.versionConflict {187 // refused before any byte travelled: send the edit as a separate file188 let copyName = SyncEngine.conflictName(name, device: await MainActor.run { UIDevice.current.name })189 let copy = try await DirectTransfer.upload(file: newContents, remote: context.api, store: context.store, resumeKey: "conflict:\(id)", scratch: scratch) { size in190 try await context.api.createUpload(parentID: parentID, name: copyName, size: size, onConflict: .rename, fileID: nil, baseVersionID: nil)191 }192 try? context.store.upsert(copy)193 current = try await context.api.item(id: id, isFolder: false)194 }195 }196 context.record(current)197 done(context.providerItem(current), [], false, nil)198 }, failure: { done(nil, [], false, $0) })199 }200201 func deleteItem(identifier: NSFileProviderItemIdentifier, baseVersion version: NSFileProviderItemVersion, options: NSFileProviderDeleteItemOptions = [], request: NSFileProviderRequest,202 completionHandler: @escaping (Error?) -> Void) -> Progress {203 nonisolated(unsafe) let done = completionHandler204 return run({ context, _ in205 guard let id = context.id(identifier), identifier != .rootContainer else { throw NSFileProviderError(.noSuchItem) }206 let known = context.store.item(id)207 let current: DriveItem208 do { current = try await context.api.item(id: id, isFolder: known?.isFolder ?? false) } catch RemoteError.notFound {209 // may be a folder the mirror does not know yet, or already gone210 guard let other = try? await context.api.item(id: id, isFolder: !(known?.isFolder ?? false)) else { try? context.store.deleteItem(id); done(nil); return }211 current = other212 }213 let files = current.isFolder ? [] : [id], folders = current.isFolder ? [id] : []214 if current.isTrashed {215 // deleting from « Recently Deleted »: the only definitive deletion, and only with the server's confirmation216 if current.trashRoot { try await context.api.purge(fileIDs: files, folderIDs: folders) }217 try? context.store.deleteItem(id)218 } else {219 // a deletion of a live item goes to the Drive's trash, where it can still be restored220 try await context.api.trash(fileIDs: files, folderIDs: folders)221 if let now = try? await context.api.item(id: id, isFolder: current.isFolder) { try? context.store.upsert(now) }222 }223 context.signal()224 done(nil)225 }, failure: { done($0) })226 }227228 // MARK: Thumbnails229230 func fetchThumbnails(for itemIdentifiers: [NSFileProviderItemIdentifier], requestedSize size: CGSize, perThumbnailCompletionHandler: @escaping (NSFileProviderItemIdentifier, Data?, Error?) -> Void,231 completionHandler: @escaping (Error?) -> Void) -> Progress {232 nonisolated(unsafe) let each = perThumbnailCompletionHandler233 nonisolated(unsafe) let done = completionHandler234 return run(units: Int64(max(1, itemIdentifiers.count)), { context, progress in235 for identifier in itemIdentifiers {236 try Task.checkCancellation()237 var data: Data?238 if let item = context.item(identifier), !item.isFolder, item.hasThumbnail, let request = try? await context.api.thumbnailRequest(fileID: item.id) {239 data = try? await context.api.fetchSmall(request)240 }241 each(identifier, data, nil)242 progress.completedUnitCount += 1243 }244 done(nil)245 }, failure: { done($0) })246 }247}248249/// Lists the root folder: resolves the root's server identifier first, then behaves like any folder.250final class RootEnumerator: NSObject, NSFileProviderEnumerator, @unchecked Sendable {251 private let context: ProviderContext252 init(context: ProviderContext) { self.context = context }253 func invalidate() {}254255 private func inner() async throws -> FileProviderEnumerator {256 if context.store.rootID == nil { try await context.refresh() }257 guard let root = context.store.rootID else { throw NSFileProviderError(.serverUnreachable) }258 return FileProviderEnumerator(scope: .folder(root), context: context)259 }260261 func enumerateItems(for observer: NSFileProviderEnumerationObserver, startingAt page: NSFileProviderPage) {262 nonisolated(unsafe) let observer = observer263 nonisolated(unsafe) let page = page264 Task {265 do { try await inner().enumerateItems(for: observer, startingAt: page) } catch { observer.finishEnumeratingWithError(context.providerError(error)) }266 }267 }268 func enumerateChanges(for observer: NSFileProviderChangeObserver, from anchor: NSFileProviderSyncAnchor) {269 nonisolated(unsafe) let observer = observer270 nonisolated(unsafe) let anchor = anchor271 Task {272 do { try await inner().enumerateChanges(for: observer, from: anchor) } catch { observer.finishEnumeratingWithError(context.providerError(error)) }273 }274 }275 func currentSyncAnchor(completionHandler: @escaping (NSFileProviderSyncAnchor?) -> Void) {276 completionHandler(NSFileProviderSyncAnchor(Data(String(context.store.cursor).utf8)))277 }278}279