- OCCore: replace directly defined completionHandler blocks with typedef variants, also accept omission for -updateDrive:…

felix-schwarz · felix-schwarz · commit e5e30d42e7f7 · 2025-03-14T12:32:55.000+01:00
- OCVault+TemporaryTools: new OCVault methods to simplify temporary saving of files
diff --git a/ownCloudSDK.xcodeproj/project.pbxproj b/ownCloudSDK.xcodeproj/project.pbxproj
@@ -181,6 +181,8 @@
 		DC2D646821C3D71000EB26FD /* OCCore+Thumbnails.h in Headers */ = {isa = PBXBuildFile; fileRef = DC2D646721C3D70F00EB26FD /* OCCore+Thumbnails.h */; };
 		DC2D649C21C7B3DF00EB26FD /* OCAuthenticationMethodOAuth2+OCMocking.h in Headers */ = {isa = PBXBuildFile; fileRef = DC2D649A21C7B3DF00EB26FD /* OCAuthenticationMethodOAuth2+OCMocking.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		DC2D649D21C7B3DF00EB26FD /* OCAuthenticationMethodOAuth2+OCMocking.m in Sources */ = {isa = PBXBuildFile; fileRef = DC2D649B21C7B3DF00EB26FD /* OCAuthenticationMethodOAuth2+OCMocking.m */; };
+		DC2EB43F2D6FBB4400100A67 /* OCVault+TemporaryTools.m in Sources */ = {isa = PBXBuildFile; fileRef = DC2EB43E2D6FBB4400100A67 /* OCVault+TemporaryTools.m */; };
+		DC2EB4402D6FBB4400100A67 /* OCVault+TemporaryTools.h in Headers */ = {isa = PBXBuildFile; fileRef = DC2EB43D2D6FBB4400100A67 /* OCVault+TemporaryTools.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		DC2F63632239455E0063C2DA /* OCRecipientSearchController.h in Headers */ = {isa = PBXBuildFile; fileRef = DC2F63612239455E0063C2DA /* OCRecipientSearchController.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		DC2F63642239455E0063C2DA /* OCRecipientSearchController.m in Sources */ = {isa = PBXBuildFile; fileRef = DC2F63622239455E0063C2DA /* OCRecipientSearchController.m */; };
 		DC2F63682239509E0063C2DA /* OCCore+Sharing.m in Sources */ = {isa = PBXBuildFile; fileRef = DC2F63662239509E0063C2DA /* OCCore+Sharing.m */; };
@@ -1276,6 +1278,8 @@
 		DC2D646721C3D70F00EB26FD /* OCCore+Thumbnails.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = "OCCore+Thumbnails.h"; sourceTree = "<group>"; };
 		DC2D649A21C7B3DF00EB26FD /* OCAuthenticationMethodOAuth2+OCMocking.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "OCAuthenticationMethodOAuth2+OCMocking.h"; sourceTree = "<group>"; };
 		DC2D649B21C7B3DF00EB26FD /* OCAuthenticationMethodOAuth2+OCMocking.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = "OCAuthenticationMethodOAuth2+OCMocking.m"; sourceTree = "<group>"; };
+		DC2EB43D2D6FBB4400100A67 /* OCVault+TemporaryTools.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "OCVault+TemporaryTools.h"; sourceTree = "<group>"; };
+		DC2EB43E2D6FBB4400100A67 /* OCVault+TemporaryTools.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = "OCVault+TemporaryTools.m"; sourceTree = "<group>"; };
 		DC2F63612239455E0063C2DA /* OCRecipientSearchController.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = OCRecipientSearchController.h; sourceTree = "<group>"; };
 		DC2F63622239455E0063C2DA /* OCRecipientSearchController.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = OCRecipientSearchController.m; sourceTree = "<group>"; };
 		DC2F63662239509E0063C2DA /* OCCore+Sharing.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = "OCCore+Sharing.m"; sourceTree = "<group>"; };
@@ -3664,6 +3668,8 @@
 				DC82665D2818972200F91F7D /* OCVaultLocation.h */,
 				DCB4F6E628324A3A005AD181 /* OCVaultDriveList.m */,
 				DCB4F6E528324A3A005AD181 /* OCVaultDriveList.h */,
+				DC2EB43E2D6FBB4400100A67 /* OCVault+TemporaryTools.m */,
+				DC2EB43D2D6FBB4400100A67 /* OCVault+TemporaryTools.h */,
 				DC22669922817DC600FB29EE /* OCVault+Internal.m */,
 				DC22669822817DC600FB29EE /* OCVault+Internal.h */,
 				DCCE49312684B0EF005961D8 /* Prepopulation */,
@@ -4869,6 +4875,7 @@
 				DCCC85912CF87C8200251683 /* GAGraphStruct+Encoder.h in Headers */,
 				DC70147F220B0650009D4FD9 /* OCHTTPResponse.h in Headers */,
 				DCC8F9F6202855A200EB6701 /* OCShare.h in Headers */,
+				DC2EB4402D6FBB4400100A67 /* OCVault+TemporaryTools.h in Headers */,
 				DC47E4E827A5820D0020E8EF /* GAFolderView.h in Headers */,
 				DC27BBC32304A7CE002CC2F8 /* NSHTTPCookie+OCCookies.h in Headers */,
 				DCA35D6124CF704100DBE2B0 /* OCSyncAction+Diagnostic.h in Headers */,
@@ -5615,6 +5622,7 @@
 				DC62FD63211B11FD0034B628 /* OCItem+OCThumbnail.m in Sources */,
 				DCEEB2DD20430B1400189B9A /* NSURL+OCURLQueryParameterExtensions.m in Sources */,
 				DC47E4CC27A5820D0020E8EF /* GAFileSystemInfo.m in Sources */,
+				DC2EB43F2D6FBB4400100A67 /* OCVault+TemporaryTools.m in Sources */,
 				DC2F6376223A61990063C2DA /* OCCoreQuery.m in Sources */,
 				DCC8F9F7202855A200EB6701 /* OCShare.m in Sources */,
 				DC0CE19728C8907D009ABDFB /* OCResourceRequestURLItem.m in Sources */,
diff --git a/ownCloudSDK/Core/DriveManagement/OCCore+DriveManagement.m b/ownCloudSDK/Core/DriveManagement/OCCore+DriveManagement.m
@@ -75,13 +75,14 @@ - (nullable NSProgress *)updateDrive:(OCDrive *)drive properties:(NSDictionary<O
 		if (error == nil) {
 			[self fetchUpdatesWithCompletionHandler:nil];
 		}
-		completionHandler(error, newDrive);
+		if (completionHandler != nil) {
+			completionHandler(error, newDrive);
+		}
 	}]);
 }
 
-- (void)retrieveDrive:(OCDrive *)drive itemForResource:(OCDriveResource)resource completionHandler:(void(^)(NSError * _Nullable error, OCItem * _Nullable item))completionHandler
+- (void)retrieveDrive:(OCDrive *)drive itemForResource:(OCDriveResource)resource completionHandler:(nonnull OCCoreItemCompletionHandler)completionHandler
 {
-	NSError *error = nil;
 	GADriveItem *driveItem = nil;
 
 	if ([resource isEqual:OCDriveResourceCoverImage]) {
@@ -178,13 +179,15 @@ - (void)retrieveDrive:(OCDrive *)drive itemForResource:(OCDriveResource)resource
 	}
 }
 
-- (nullable NSProgress *)updateDrive:(OCDrive *)drive resourceFor:(OCDriveResource)resource withItem:(nullable OCItem *)item completionHandler:(void(^)(NSError * _Nullable error, OCDrive * _Nullable drive))completionHandler
+- (nullable NSProgress *)updateDrive:(OCDrive *)drive resourceFor:(OCDriveResource)resource withItem:(nullable OCItem *)item completionHandler:(nullable OCCoreDriveCompletionHandler)completionHandler
 {
 	return ([self.connection updateDrive:drive resourceFor:resource withItem:item completionHandler:^(NSError * _Nullable error, OCDrive * _Nullable drive) {
 		if (error == nil) {
 			[self fetchUpdatesWithCompletionHandler:nil];
 		}
-		completionHandler(error, drive);
+		if (completionHandler != nil) {
+			completionHandler(error, drive);
+		}
 	}]);
 }
 
diff --git a/ownCloudSDK/Core/OCCore.h b/ownCloudSDK/Core/OCCore.h
@@ -118,7 +118,9 @@ typedef void(^OCCoreClaimCompletionHandler)(NSError * _Nullable error, OCItem *
 typedef void(^OCCoreCompletionHandler)(NSError * _Nullable error);
 typedef void(^OCCoreStateChangedHandler)(OCCore *core);
 typedef void(^OCCoreSyncReasonCountChangeObserver)(OCCore *core, BOOL initial, NSDictionary<OCSyncReason, NSNumber *> * _Nullable countBySyncReason);
-typedef void(^OCCoreDriveCompletionHandler)(NSError * _Nullable error, OCDrive * _Nullable newDrive);
+typedef void(^OCCoreDriveCompletionHandler)(NSError * _Nullable error, OCDrive * _Nullable drive);
+typedef void(^OCCoreItemCompletionHandler)(NSError * _Nullable error, OCItem * _Nullable item);
+
 
 typedef void(^OCCoreBusyStatusHandler)(NSProgress * _Nullable progress);
 
@@ -524,10 +526,10 @@ typedef void(^OCCoreShareRoleRetrievalHandler)(NSError * _Nullable error, NSArra
 - (nullable NSProgress *)deleteDrive:(OCDrive *)drive completionHandler:(OCCoreCompletionHandler)completionHandler;
 
 // Change attributes
-- (nullable NSProgress *)updateDrive:(OCDrive *)drive properties:(NSDictionary<OCDriveProperty, id> *)updateProperties completionHandler:(OCCoreDriveCompletionHandler)completionHandler;
+- (nullable NSProgress *)updateDrive:(OCDrive *)drive properties:(NSDictionary<OCDriveProperty, id> *)updateProperties completionHandler:(nullable OCCoreDriveCompletionHandler)completionHandler;
 
-- (void)retrieveDrive:(OCDrive *)drive itemForResource:(OCDriveResource)resource completionHandler:(void(^)(NSError * _Nullable error, OCItem * _Nullable item))completionHandler;
-- (nullable NSProgress *)updateDrive:(OCDrive *)drive resourceFor:(OCDriveResource)resource withItem:(nullable OCItem *)item completionHandler:(void(^)(NSError * _Nullable error, OCDrive * _Nullable drive))completionHandler;
+- (void)retrieveDrive:(OCDrive *)drive itemForResource:(OCDriveResource)resource completionHandler:(OCCoreItemCompletionHandler)completionHandler;
+- (nullable NSProgress *)updateDrive:(OCDrive *)drive resourceFor:(OCDriveResource)resource withItem:(nullable OCItem *)item completionHandler:(nullable OCCoreDriveCompletionHandler)completionHandler;
 
 @end
 
diff --git a/ownCloudSDK/Vaults/OCVault+TemporaryTools.h b/ownCloudSDK/Vaults/OCVault+TemporaryTools.h
@@ -0,0 +1,32 @@
+//
+//  OCVault+TemporaryTools.h
+//  ownCloudSDK
+//
+//  Created by Felix Schwarz on 26.02.25.
+//  Copyright © 2025 ownCloud GmbH. All rights reserved.
+//
+
+/*
+ * Copyright (C) 2025, ownCloud GmbH.
+ *
+ * This code is covered by the GNU Public License Version 3.
+ *
+ * For distribution utilizing Apple mechanisms please see https://owncloud.org/contribute/iOS-license-exception/
+ * You should have received a copy of this license along with this program. If not, see <http://www.gnu.org/licenses/gpl-3.0.en.html>.
+ *
+ */
+
+#import "OCVault.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+typedef void(^OCVaultTemporaryStorageEraser)(void); //!< Block that, if called, deletes the temporarily allocated filesystem object(s).
+
+@interface OCVault (TemporaryTools)
+
+- (nullable OCVaultTemporaryStorageEraser)createTemporaryUploadContainer:(out NSURL * _Nullable * _Nullable)outURL error:(out NSError * _Nullable * _Nullable)outError; //!< Create a temporary folder in the .temporaryUploadURL of the vault, returning a block to delete it.
+- (nullable OCVaultTemporaryStorageEraser)createTemporaryUploadFileFromData:(NSData *)data name:(NSString *)name url:(out NSURL * _Nullable * _Nullable)outURL error:(out NSError * _Nullable * _Nullable)outError; //!< Creates a temporary folder with a temporary file inside, containing the passed data. Returns a block to delete the temporary folder + file.
+
+@end
+
+NS_ASSUME_NONNULL_END
diff --git a/ownCloudSDK/Vaults/OCVault+TemporaryTools.m b/ownCloudSDK/Vaults/OCVault+TemporaryTools.m
@@ -0,0 +1,78 @@
+//
+//  OCVault+TemporaryTools.m
+//  ownCloudSDK
+//
+//  Created by Felix Schwarz on 26.02.25.
+//  Copyright © 2025 ownCloud GmbH. All rights reserved.
+//
+
+/*
+ * Copyright (C) 2025, ownCloud GmbH.
+ *
+ * This code is covered by the GNU Public License Version 3.
+ *
+ * For distribution utilizing Apple mechanisms please see https://owncloud.org/contribute/iOS-license-exception/
+ * You should have received a copy of this license along with this program. If not, see <http://www.gnu.org/licenses/gpl-3.0.en.html>.
+ *
+ */
+
+#import "OCVault+TemporaryTools.h"
+
+@implementation OCVault (TemporaryTools)
+
+- (nullable OCVaultTemporaryStorageEraser)createTemporaryUploadContainer:(NSURL ** _Nullable)outURL error:(NSError * _Nullable * _Nullable)outError
+{
+	NSURL *parentURL = self.temporaryUploadURL;
+	NSURL *temporaryDirectoryURL = [parentURL URLByAppendingPathComponent:NSUUID.UUID.UUIDString];
+	NSError *error = nil;
+	OCVaultTemporaryStorageEraser eraser = nil;
+
+	if ([NSFileManager.defaultManager createDirectoryAtURL:temporaryDirectoryURL withIntermediateDirectories:YES attributes:@{ NSFileProtectionKey : NSFileProtectionCompleteUntilFirstUserAuthentication } error:&error])
+	{
+		eraser = ^{
+			[NSFileManager.defaultManager removeItemAtURL:temporaryDirectoryURL error:NULL];
+		};
+	}
+
+	if (outURL != NULL) {
+		*outURL = (error == nil) ? temporaryDirectoryURL : nil;
+	}
+
+	if (outError != NULL) {
+		*outError = error;
+	}
+
+	return ([eraser copy]);
+}
+
+- (nullable OCVaultTemporaryStorageEraser)createTemporaryUploadFileFromData:(NSData *)data name:(NSString *)name url:(NSURL * _Nonnull * _Nullable)outURL error:(NSError * _Nullable * _Nullable)outError
+{
+	NSURL *containerURL = nil;
+	NSError *error = nil;
+	OCVaultTemporaryStorageEraser tempFolderEraser;
+	OCVaultTemporaryStorageEraser eraser = nil;
+
+	if ((tempFolderEraser = [self createTemporaryUploadContainer:&containerURL error:&error]) != nil)
+	{
+		NSURL *tempFileURL = [containerURL URLByAppendingPathComponent:name];
+		if ([data writeToURL:tempFileURL options:NSDataWritingFileProtectionCompleteUntilFirstUserAuthentication error:&error])
+		{
+			if (outURL != NULL) {
+				*outURL = tempFileURL;
+			}
+			eraser = tempFolderEraser;
+		}
+		else
+		{
+			tempFolderEraser();
+		}
+	}
+
+	if (outError != NULL) {
+		*outError = error;
+	}
+
+	return (eraser);
+}
+
+@end
diff --git a/ownCloudSDK/Vaults/OCVault.h b/ownCloudSDK/Vaults/OCVault.h
@@ -54,6 +54,8 @@
 		"TemporaryDownloads"/					- OCVault.temporaryDownloadURL
 			[Random UUID] (temporary files for downloads)
 
+		"TemporaryUploads"/					- OCVault.temporaryUploadURL
+			[Random UUID] (temporary files for uploads)
 
 		"messageQueue.dat"					- OCMessageQueue.globalQueue KVS
 
@@ -104,6 +106,7 @@ typedef BOOL(^OCVaultCompactSelector)(OCSyncAnchor _Nullable syncAnchor, OCItem
 	NSURL *_filesRootURL;
 	NSURL *_httpPipelineRootURL;
 	NSURL *_temporaryDownloadURL;
+	NSURL *_temporaryUploadURL;
 	NSURL *_bookmarkMetadataURL;
 	NSURL *_wipeContainerRootURL;
 	NSURL *_wipeContainerFilesRootURL;
@@ -144,6 +147,7 @@ typedef BOOL(^OCVaultCompactSelector)(OCSyncAnchor _Nullable syncAnchor, OCItem
 @property(nullable,readonly,nonatomic) NSURL *drivesRootURL; //!< The vault's root URL for drive folders
 @property(nullable,readonly,nonatomic) NSURL *httpPipelineRootURL; //!< The vault's root URL for HTTP pipeline data
 @property(nullable,readonly,nonatomic) NSURL *temporaryDownloadURL; //!< The vault's root URL for temporarily downloaded files.
+@property(nullable,readonly,nonatomic) NSURL *temporaryUploadURL; //!< The vault's root URL for temporary files for uploading.
 @property(nullable,readonly,nonatomic) NSURL *bookmarkMetadataURL; //!< The vault's root URL for bookmark metadata files.
 
 @property(nullable,readonly,nonatomic) NSURL *wipeContainerRootURL; //!< The vault's rootURL subfolder for items to erase.
diff --git a/ownCloudSDK/Vaults/OCVault.m b/ownCloudSDK/Vaults/OCVault.m
@@ -280,6 +280,16 @@ - (NSURL *)temporaryDownloadURL
 	return (_temporaryDownloadURL);
 }
 
+- (NSURL *)temporaryUploadURL
+{
+	if (_temporaryUploadURL == nil)
+	{
+		_temporaryUploadURL = [self.rootURL URLByAppendingPathComponent:@"TemporaryUploads"];
+	}
+
+	return (_temporaryUploadURL);
+}
+
 - (NSURL *)bookmarkMetadataURL
 {
 	if (_bookmarkMetadataURL == nil)
diff --git a/ownCloudSDK/ownCloudSDK.h b/ownCloudSDK/ownCloudSDK.h
@@ -161,6 +161,7 @@ FOUNDATION_EXPORT const unsigned char ownCloudSDKVersionString[];
 #import <ownCloudSDK/OCEventTarget.h>
 
 #import <ownCloudSDK/OCVault.h>
+#import <ownCloudSDK/OCVault+TemporaryTools.h>
 #import <ownCloudSDK/OCVaultLocation.h>
 #import <ownCloudSDK/OCDatabase.h>
 #import <ownCloudSDK/OCDatabase+Versions.h>

Original file line number	Diff line number	Diff line change
`@@ -75,13 +75,14 @@ - (nullable NSProgress )updateDrive:(OCDrive )drive properties:(NSDictionary<O`
`75`	`75`	`if (error == nil) {`
`76`	`76`	`[self fetchUpdatesWithCompletionHandler:nil];`
`77`	`77`	`}`
`78`		`- completionHandler(error, newDrive);`
	`78`	`+ if (completionHandler != nil) {`
	`79`	`+ completionHandler(error, newDrive);`
	`80`	`+ }`
`79`	`81`	`}]);`
`80`	`82`	`}`
`81`	`83`
`82`		`-- (void)retrieveDrive:(OCDrive )drive itemForResource:(OCDriveResource)resource completionHandler:(void(^)(NSError _Nullable error, OCItem * _Nullable item))completionHandler`
	`84`	`+- (void)retrieveDrive:(OCDrive *)drive itemForResource:(OCDriveResource)resource completionHandler:(nonnull OCCoreItemCompletionHandler)completionHandler`
`83`	`85`	`{`
`84`		`- NSError *error = nil;`
`85`	`86`	`GADriveItem *driveItem = nil;`
`86`	`87`
`87`	`88`	`if ([resource isEqual:OCDriveResourceCoverImage]) {`
`@@ -178,13 +179,15 @@ - (void)retrieveDrive:(OCDrive *)drive itemForResource:(OCDriveResource)resource`
`178`	`179`	`}`
`179`	`180`	`}`
`180`	`181`
`181`		`-- (nullable NSProgress )updateDrive:(OCDrive )drive resourceFor:(OCDriveResource)resource withItem:(nullable OCItem )item completionHandler:(void(^)(NSError _Nullable error, OCDrive * _Nullable drive))completionHandler`
	`182`	`+- (nullable NSProgress )updateDrive:(OCDrive )drive resourceFor:(OCDriveResource)resource withItem:(nullable OCItem *)item completionHandler:(nullable OCCoreDriveCompletionHandler)completionHandler`
`182`	`183`	`{`
`183`	`184`	`return ([self.connection updateDrive:drive resourceFor:resource withItem:item completionHandler:^(NSError * _Nullable error, OCDrive * _Nullable drive) {`
`184`	`185`	`if (error == nil) {`
`185`	`186`	`[self fetchUpdatesWithCompletionHandler:nil];`
`186`	`187`	`}`
`187`		`- completionHandler(error, drive);`
	`188`	`+ if (completionHandler != nil) {`
	`189`	`+ completionHandler(error, drive);`
	`190`	`+ }`
`188`	`191`	`}]);`
`189`	`192`	`}`
`190`	`193`