Merge pull request #49 from ParsePlatform/richardross.filestaging.clear

Added PFFileStagingController to manage staging.

Author: richardjrossiii

Parse.xcodeproj/project.pbxproj

@@ -800,6 +800,8 @@
 		F50C66331B33A708001941A6 /* PFPushUtilities.h in Headers */ = {isa = PBXBuildFile; fileRef = F50C66311B33A708001941A6 /* PFPushUtilities.h */; };
 		F50C66341B33A708001941A6 /* PFPushUtilities.m in Sources */ = {isa = PBXBuildFile; fileRef = F50C66321B33A708001941A6 /* PFPushUtilities.m */; };
 		F50C667C1B34B231001941A6 /* PFPushUtilities.m in Sources */ = {isa = PBXBuildFile; fileRef = F50C66321B33A708001941A6 /* PFPushUtilities.m */; };
+		F50E486E1B83ED270055094D /* PFFileStagingController.h in Headers */ = {isa = PBXBuildFile; fileRef = F50E486C1B83ED270055094D /* PFFileStagingController.h */; };
+		F50E486F1B83ED270055094D /* PFFileStagingController.m in Sources */ = {isa = PBXBuildFile; fileRef = F50E486D1B83ED270055094D /* PFFileStagingController.m */; };
 		F510509F1B6AA4CE00749060 /* ExtensionDataSharingTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 814915E61B66D44500EFD14F /* ExtensionDataSharingTests.m */; };
 		F51050A01B6AA4D100749060 /* ExtensionDataSharingTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 814915E61B66D44500EFD14F /* ExtensionDataSharingTests.m */; };
 		F51050A11B6AA4D600749060 /* ExtensionDataSharingMobileTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 814915E51B66D44500EFD14F /* ExtensionDataSharingMobileTests.m */; };
@@ -900,6 +902,7 @@
 		F5C42CDB1B38761B00C720D8 /* PFObjectSubclassInfo.h in Headers */ = {isa = PBXBuildFile; fileRef = F5C42CD81B38761B00C720D8 /* PFObjectSubclassInfo.h */; };
 		F5C42CDC1B38761B00C720D8 /* PFObjectSubclassInfo.m in Sources */ = {isa = PBXBuildFile; fileRef = F5C42CD91B38761B00C720D8 /* PFObjectSubclassInfo.m */; };
 		F5C42CDD1B38761B00C720D8 /* PFObjectSubclassInfo.m in Sources */ = {isa = PBXBuildFile; fileRef = F5C42CD91B38761B00C720D8 /* PFObjectSubclassInfo.m */; };
+		F5C6B38B1B83F7A100690F3A /* PFFileStagingController.m in Sources */ = {isa = PBXBuildFile; fileRef = F50E486D1B83ED270055094D /* PFFileStagingController.m */; };
 		F5C8F2C01B1F7E7800CD98E7 /* PFAsyncTaskQueue.m in Sources */ = {isa = PBXBuildFile; fileRef = F5C8F2BF1B1F7E6B00CD98E7 /* PFAsyncTaskQueue.m */; };
 		F5C8F2C11B1F7E7900CD98E7 /* PFAsyncTaskQueue.m in Sources */ = {isa = PBXBuildFile; fileRef = F5C8F2BF1B1F7E6B00CD98E7 /* PFAsyncTaskQueue.m */; };
 		F5E381311B68832000A3B9F2 /* URLSessionTests.m in Sources */ = {isa = PBXBuildFile; fileRef = F5556A141B66F36000410837 /* URLSessionTests.m */; };
@@ -1486,6 +1489,8 @@
 		E9E81E8316EEF93E001D034F /* PFSubclassing.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = PFSubclassing.h; sourceTree = "<group>"; };
 		F50C66311B33A708001941A6 /* PFPushUtilities.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = PFPushUtilities.h; sourceTree = "<group>"; };
 		F50C66321B33A708001941A6 /* PFPushUtilities.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = PFPushUtilities.m; sourceTree = "<group>"; };
+		F50E486C1B83ED270055094D /* PFFileStagingController.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = PFFileStagingController.h; sourceTree = "<group>"; };
+		F50E486D1B83ED270055094D /* PFFileStagingController.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = PFFileStagingController.m; sourceTree = "<group>"; };
 		F51534F61B571E9100C49F56 /* PFACLPrivate.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = PFACLPrivate.h; sourceTree = "<group>"; };
 		F51534F81B571E9100C49F56 /* PFACLState.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = PFACLState.h; sourceTree = "<group>"; };
 		F51534F91B571E9100C49F56 /* PFACLState.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = PFACLState.m; sourceTree = "<group>"; };
@@ -2890,6 +2895,8 @@
 			children = (
 				81EB595C1AF46434001EA1FC /* PFFileController.h */,
 				81EB595D1AF46434001EA1FC /* PFFileController.m */,
+				F50E486C1B83ED270055094D /* PFFileStagingController.h */,
+				F50E486D1B83ED270055094D /* PFFileStagingController.m */,
 			);
 			path = Controller;
 			sourceTree = "<group>";
@@ -3152,6 +3159,7 @@
 				F5B0B2DF1B449EEF00F3EBC4 /* PFCommandCache_Private.h in Headers */,
 				F5B0B2E01B449EEF00F3EBC4 /* PFCommandResult.h in Headers */,
 				812B02961B5DE3EE003846EE /* PFURLSession.h in Headers */,
+				F50E486E1B83ED270055094D /* PFFileStagingController.h in Headers */,
 				8166FC731B50376D003841A2 /* PFObjectController.h in Headers */,
 				F5B0B2EB1B449EEF00F3EBC4 /* PFAlertView.h in Headers */,
 				8119C9971A76E28F0085B516 /* PFNetworkCommand.h in Headers */,
@@ -4028,6 +4036,7 @@
 				814881471B795C63008763BF /* PFKeyValueCache.m in Sources */,
 				81C3825119CCAD2C0066284A /* PFNetworkActivityIndicatorManager.m in Sources */,
 				81C3824819CCAD2C0066284A /* PFObject.m in Sources */,
+				F50E486F1B83ED270055094D /* PFFileStagingController.m in Sources */,
 				F51D06351B792CF10044539E /* PFSQLiteDatabaseController.m in Sources */,
 				815960A31ABCA3B30069EBCC /* PFFileManager.m in Sources */,
 				81CD66561B4DA5A70042FC0B /* PFCurrentInstallationController.m in Sources */,
@@ -4195,6 +4204,7 @@
 				81EBF3461B33E7DE00991947 /* PFPushChannelsController.m in Sources */,
 				9701108A1630B45800AB761E /* PFRole.m in Sources */,
 				9701108C1630B45800AB761E /* PFUser.m in Sources */,
+				F5C6B38B1B83F7A100690F3A /* PFFileStagingController.m in Sources */,
 				81E7A2281B6042BD006CB680 /* PFObjectFileCodingLogic.m in Sources */,
 				8166FCEB1B504083003841A2 /* PFPushManager.m in Sources */,
 				819A4B0B1A67330200D01241 /* PFHash.m in Sources */,

Parse/Internal/File/Controller/PFFileController.h

@@ -16,13 +16,15 @@
 @class BFCancellationToken;
 @class BFTask;
 @class PFFileState;
+@class PFFileStagingController;
 
 @interface PFFileController : NSObject
 
 @property (nonatomic, weak, readonly) id<PFCommandRunnerProvider, PFFileManagerProvider> dataSource;
 
+@property (nonatomic, strong, readonly) PFFileStagingController *fileStagingController;
+
 @property (nonatomic, copy, readonly) NSString *cacheFilesDirectoryPath;
-@property (nonatomic, copy, readonly) NSString *stagedFilesDirectoryPath;
 
 ///--------------------------------------
 /// @name Init

Parse/Internal/File/Controller/PFFileController.m

@@ -17,24 +17,27 @@
 #import "PFCommandResult.h"
 #import "PFCommandRunning.h"
 #import "PFFileManager.h"
+#import "PFFileStagingController.h"
 #import "PFFileState.h"
 #import "PFHash.h"
 #import "PFMacros.h"
 #import "PFRESTFileCommand.h"
 
 static NSString *const PFFileControllerCacheDirectoryName_ = @"PFFileCache";
-static NSString *const PFFileControllerStagingDirectoryName_ = @"PFFileStaging";
 
 @interface PFFileController () {
     NSMutableDictionary *_downloadTasks; // { "urlString" : BFTask }
     NSMutableDictionary *_downloadProgressBlocks; // { "urlString" : [ block1, block2 ] }
     dispatch_queue_t _downloadDataAccessQueue;
+    dispatch_queue_t _fileStagingControllerAccessQueue;
 }
 
 @end
 
 @implementation PFFileController
 
+@synthesize fileStagingController = _fileStagingController;
+
 ///--------------------------------------
 #pragma mark - Init
 ///--------------------------------------
@@ -52,6 +55,7 @@ - (instancetype)initWithDataSource:(id<PFCommandRunnerProvider, PFFileManagerPro
     _downloadTasks = [NSMutableDictionary dictionary];
     _downloadProgressBlocks = [NSMutableDictionary dictionary];
     _downloadDataAccessQueue = dispatch_queue_create("com.parse.fileController.download", DISPATCH_QUEUE_SERIAL);
+    _fileStagingControllerAccessQueue = dispatch_queue_create("com.parse.filestaging.controller.access", DISPATCH_QUEUE_SERIAL);
 
     return self;
 }
@@ -60,6 +64,21 @@ + (instancetype)controllerWithDataSource:(id<PFCommandRunnerProvider, PFFileMana
     return [[self alloc] initWithDataSource:dataSource];
 }
 
+///--------------------------------------
+#pragma mark - Properties
+///--------------------------------------
+
+- (PFFileStagingController *)fileStagingController {
+    __block PFFileStagingController *result = nil;
+    dispatch_sync(_fileStagingControllerAccessQueue, ^{
+        if (!_fileStagingController) {
+            _fileStagingController = [PFFileStagingController controllerWithDataSource:self.dataSource];
+        }
+        result = _fileStagingController;
+    });
+    return result;
+}
+
 ///--------------------------------------
 #pragma mark - Download
 ///--------------------------------------
@@ -244,15 +263,4 @@ - (BFTask *)clearFileCacheAsync {
     return [PFFileManager removeDirectoryContentsAsyncAtPath:path];
 }
 
-///--------------------------------------
-#pragma mark - Staging
-///--------------------------------------
-
-- (NSString *)stagedFilesDirectoryPath {
-    NSString *folderPath = [self.dataSource.fileManager parseLocalSandboxDataDirectoryPath];
-    NSString *path = [folderPath stringByAppendingPathComponent:PFFileControllerStagingDirectoryName_];
-    [[PFFileManager createDirectoryIfNeededAsyncAtPath:path] waitForResult:nil withMainThreadWarning:NO];
-    return path;
-}
-
 @end

Parse/Internal/File/Controller/PFFileStagingController.h

@@ -0,0 +1,72 @@
+/**
+ * Copyright (c) 2015-present, Parse, LLC.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
+
+#import <Foundation/Foundation.h>
+
+#import <Bolts/BFTask.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@protocol PFFileManagerProvider;
+
+@interface PFFileStagingController : NSObject
+
+@property (nonatomic, weak, readonly) id<PFFileManagerProvider> dataSource;
+
+@property (nonatomic, copy, readonly) NSString *stagedFilesDirectoryPath;
+
+///--------------------------------------
+/// @name Init
+///--------------------------------------
+
+- (instancetype)init NS_UNAVAILABLE;
+- (instancetype)initWithDataSource:(id<PFFileManagerProvider>)dataSource NS_DESIGNATED_INITIALIZER;
+
++ (instancetype)controllerWithDataSource:(id<PFFileManagerProvider>)dataSource;
+
+///--------------------------------------
+/// @name Staging
+///--------------------------------------
+
+/*!
+ Moves a file from the specified path to the staging directory based off of the name and unique ID passed in.
+
+ @param filePath The source path to stage
+ @param name     The name of the file to stage
+ @param uniqueId A unique ID for this file to be used when differentiating between files with the same name.
+
+ @return A task, which yields the path of the staged file on disk.
+ */
+- (BFTask *)stageFileAsyncAtPath:(NSString *)filePath name:(NSString *)name uniqueId:(uint64_t)uniqueId;
+
+/*!
+ Creates a file from the specified data and places it into the staging directory based off of the name and unique 
+ ID passed in.
+
+ @param fileData The data to stage
+ @param name     The name of the file to stage
+ @param uniqueId The unique ID for this file to be used when differentiating between files with the same name.
+
+ @return A task, which yields the path of the staged file on disk.
+ */
+- (BFTask *)stageFileAsyncWithData:(NSData *)fileData name:(NSString *)name uniqueId:(uint64_t)uniqueId;
+
+/*!
+ Get the staged directory path for a file with the specified name and unique ID.
+
+ @param name     The name of the staged file
+ @param uniqueId The unique ID of the staged file
+
+ @return The path in the staged directory folder which contains the contents of the requested file.
+ */
+- (NSString *)stagedFilePathForFileWithName:(NSString *)name uniqueId:(uint64_t)uniqueId;
+
+@end
+
+NS_ASSUME_NONNULL_END

Parse/Internal/File/Controller/PFFileStagingController.m

@@ -0,0 +1,96 @@
+/**
+ * Copyright (c) 2015-present, Parse, LLC.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
+
+#import "PFFileStagingController.h"
+
+#import "BFTask+Private.h"
+#import "PFAssert.h"
+#import "PFAsyncTaskQueue.h"
+#import "PFDataProvider.h"
+#import "PFFileManager.h"
+#import "PFLogging.h"
+
+static NSString *const PFFileStagingControllerDirectoryName_ = @"PFFileStaging";
+
+@implementation PFFileStagingController {
+    PFAsyncTaskQueue *_taskQueue;
+}
+
+///--------------------------------------
+#pragma mark - Init
+///--------------------------------------
+
+- (instancetype)init {
+    PFNotDesignatedInitializer();
+}
+
+- (instancetype)initWithDataSource:(id<PFFileManagerProvider>)dataSource {
+    self = [super init];
+    if (!self) return nil;
+
+    _dataSource = dataSource;
+    _taskQueue = [PFAsyncTaskQueue taskQueue];
+
+    [self _clearStagedFilesAsync];
+
+    return self;
+}
+
++ (instancetype)controllerWithDataSource:(id<PFFileManagerProvider>)dataSource {
+    return [[self alloc] initWithDataSource:dataSource];
+}
+
+///--------------------------------------
+#pragma mark - Properties
+///--------------------------------------
+
+- (NSString *)stagedFilesDirectoryPath {
+    NSString *folderPath = [self.dataSource.fileManager parseLocalSandboxDataDirectoryPath];
+    return [folderPath stringByAppendingPathComponent:PFFileStagingControllerDirectoryName_];
+}
+
+///--------------------------------------
+#pragma mark - Staging
+///--------------------------------------
+
+- (BFTask *)stageFileAsyncAtPath:(NSString *)filePath name:(NSString *)name uniqueId:(uint64_t)uniqueId {
+    return [_taskQueue enqueue:^id(BFTask *task) {
+        return [[PFFileManager createDirectoryIfNeededAsyncAtPath:[self stagedFilesDirectoryPath]] continueWithBlock:^id(BFTask *task) {
+            NSString *destinationPath = [self stagedFilePathForFileWithName:name uniqueId:uniqueId];
+            return [[PFFileManager copyItemAsyncAtPath:filePath toPath:destinationPath] continueWithSuccessResult:destinationPath];
+        }];
+    }];
+}
+
+- (BFTask *)stageFileAsyncWithData:(NSData *)fileData name:(NSString *)name uniqueId:(uint64_t)uniqueId {
+    return [_taskQueue enqueue:^id(BFTask *task) {
+        return [[PFFileManager createDirectoryIfNeededAsyncAtPath:[self stagedFilesDirectoryPath]] continueWithBlock:^id(BFTask *task) {
+            NSString *destinationPath = [self stagedFilePathForFileWithName:name uniqueId:uniqueId];
+            return [[PFFileManager writeDataAsync:fileData toFile:destinationPath] continueWithSuccessResult:destinationPath];
+        }];
+    }];
+}
+
+- (NSString *)stagedFilePathForFileWithName:(NSString *)name uniqueId:(uint64_t)uniqueId {
+    NSString *fileName = [NSString stringWithFormat:@"%llX_%@", uniqueId, name];
+    return [[self stagedFilesDirectoryPath] stringByAppendingPathComponent:fileName];
+}
+
+///--------------------------------------
+#pragma mark - Clearing
+///--------------------------------------
+
+- (BFTask *)_clearStagedFilesAsync {
+    return [_taskQueue enqueue:^id(BFTask *task) {
+        NSString *stagedFilesDirectoryPath = [self stagedFilesDirectoryPath];
+        return [PFFileManager removeItemAtPathAsync:stagedFilesDirectoryPath];
+    }];
+}
+
+@end