Skip to content

Avoid attaching removefile callbacks when delegate does not implement functions #1070

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 5, 2024
Merged

Avoid attaching removefile callbacks when delegate does not implement functions #1070

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 72 additions & 32 deletions Sources/FoundationEssentials/FileManager/FileOperations.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,24 @@ extension FileManager {
return delegateResponse ?? true
}

fileprivate func _delegateImplementsRemoveItemConfirmation() -> Bool {
guard let delegate = self.safeDelegate else { return false }
#if FOUNDATION_FRAMEWORK
return delegate.responds(to: #selector(FileManagerDelegate.fileManager(_:shouldRemoveItemAt:))) || delegate.responds(to: #selector(FileManagerDelegate.fileManager(_:shouldRemoveItemAtPath:)))
#else
return true
#endif
}

fileprivate func _delegateImplementsRemoveItemError() -> Bool {
guard let delegate = self.safeDelegate else { return false }
#if FOUNDATION_FRAMEWORK
return delegate.responds(to: #selector(FileManagerDelegate.fileManager(_:shouldProceedAfterError:removingItemAt:))) || delegate.responds(to: #selector(FileManagerDelegate.fileManager(_:shouldProceedAfterError:removingItemAtPath:)))
#else
return true
#endif
}

fileprivate func _shouldProceedAfter(error: Error, copyingItemAtPath path: String, to dst: String) -> Bool {
var delegateResponse: Bool?

Expand Down Expand Up @@ -292,11 +310,15 @@ extension removefile_state_t {
return num
}

fileprivate func attachCallbacks(context: UnsafeRawPointer?, confirm: RemoveFileCallback, error: RemoveFileCallback) {
removefile_state_set(self, UInt32(REMOVEFILE_STATE_CONFIRM_CONTEXT), context)
removefile_state_set(self, UInt32(REMOVEFILE_STATE_CONFIRM_CALLBACK), unsafeBitCast(confirm, to: UnsafeRawPointer.self))
removefile_state_set(self, UInt32(REMOVEFILE_STATE_ERROR_CONTEXT), context)
removefile_state_set(self, UInt32(REMOVEFILE_STATE_ERROR_CALLBACK), unsafeBitCast(error, to: UnsafeRawPointer.self))
fileprivate func attachCallbacks(context: UnsafeRawPointer?, confirm: RemoveFileCallback?, error: RemoveFileCallback?) {
if let confirm {
removefile_state_set(self, UInt32(REMOVEFILE_STATE_CONFIRM_CONTEXT), context)
removefile_state_set(self, UInt32(REMOVEFILE_STATE_CONFIRM_CALLBACK), unsafeBitCast(confirm, to: UnsafeRawPointer.self))
}
if let error {
removefile_state_set(self, UInt32(REMOVEFILE_STATE_ERROR_CONTEXT), context)
removefile_state_set(self, UInt32(REMOVEFILE_STATE_ERROR_CALLBACK), unsafeBitCast(error, to: UnsafeRawPointer.self))
}
}
}
#endif
Expand Down Expand Up @@ -411,49 +433,67 @@ enum _FileOperations {
#if canImport(Darwin)
fileprivate class _FileRemoveContext {
var error: CocoaError?
var manager: FileManager?
var manager: FileManager

init(_ manager: FileManager?) {
init(_ manager: FileManager) {
self.manager = manager
}
}

private static func _removeFile(_ pathPtr: UnsafePointer<CChar>, _ pathStr: String, state: removefile_state_t) throws {
let err = removefile(pathPtr, state, removefile_flags_t(REMOVEFILE_RECURSIVE))
if err < 0 {
if errno != 0 {
throw CocoaError.removeFileError(Int32(errno), pathStr)
}
throw CocoaError.removeFileError(state.errnum, pathStr)
}
}

private static func _removeFile(_ pathPtr: UnsafePointer<CChar>, _ pathStr: String, with fileManager: FileManager?) throws {
let state = removefile_state_alloc()!
defer { removefile_state_free(state) }

guard let fileManager else {
// We have no file manager with a delegate, simply call removefile and return
try Self._removeFile(pathPtr, pathStr, state: state)
return
}

let ctx = _FileRemoveContext(fileManager)
try withExtendedLifetime(ctx) {
let ctxPtr = Unmanaged.passUnretained(ctx).toOpaque()
state.attachCallbacks(context: ctxPtr, confirm: { _, pathPtr, contextPtr in
let context = Unmanaged<_FileOperations._FileRemoveContext>.fromOpaque(contextPtr).takeUnretainedValue()
let path = String(cString: pathPtr)

// Proceed unless the delegate says to skip
return (context.manager?._shouldRemoveItemAtPath(path) ?? true) ? REMOVEFILE_PROCEED : REMOVEFILE_SKIP
}, error: { state, pathPtr, contextPtr in
let context = Unmanaged<_FileOperations._FileRemoveContext>.fromOpaque(contextPtr).takeUnretainedValue()
let path = String(cString: pathPtr)

let err = CocoaError.removeFileError(state.errnum, path)

// Proceed only if the delegate says so
if context.manager?._shouldProceedAfter(error: err, removingItemAtPath: path) ?? false {
return REMOVEFILE_PROCEED
} else {
context.error = err
return REMOVEFILE_STOP
}
})
var confirmCallback: RemoveFileCallback?
var errorCallback: RemoveFileCallback?

let err = removefile(pathPtr, state, removefile_flags_t(REMOVEFILE_RECURSIVE))
if err < 0 {
if errno != 0 {
throw CocoaError.removeFileError(Int32(errno), pathStr)
if fileManager._delegateImplementsRemoveItemConfirmation() {
confirmCallback = { _, pathPtr, contextPtr in
let context = Unmanaged<_FileOperations._FileRemoveContext>.fromOpaque(contextPtr).takeUnretainedValue()
let path = String(cString: pathPtr)

// Proceed unless the delegate says to skip
return (context.manager._shouldRemoveItemAtPath(path)) ? REMOVEFILE_PROCEED : REMOVEFILE_SKIP
}
}
if fileManager._delegateImplementsRemoveItemError() {
errorCallback = { state, pathPtr, contextPtr in
let context = Unmanaged<_FileOperations._FileRemoveContext>.fromOpaque(contextPtr).takeUnretainedValue()
let path = String(cString: pathPtr)

let err = CocoaError.removeFileError(state.errnum, path)

// Proceed only if the delegate says so
if context.manager._shouldProceedAfter(error: err, removingItemAtPath: path) {
return REMOVEFILE_PROCEED
} else {
context.error = err
return REMOVEFILE_STOP
}
}
throw CocoaError.removeFileError(state.errnum, pathStr)
}

state.attachCallbacks(context: ctxPtr, confirm: confirmCallback, error: errorCallback)
try Self._removeFile(pathPtr, pathStr, state: state)
if let error = ctx.error {
throw error
}
Expand Down