@amazon-devices/expo-file-system 2.0.1758683737

package/ios/EXSessionTasks/EXSessionTaskDispatcher.m

@@ -0,0 +1,96 @@
+// Copyright 2015-present 650 Industries. All rights reserved.
+
+#import <ExpoFileSystem/EXSessionTaskDispatcher.h>
+#import <ExpoFileSystem/EXSessionResumableDownloadTaskDelegate.h>
+
+@interface EXSessionTaskDispatcher ()
+
+@property (nonatomic, strong) NSMutableDictionary<NSURLSessionTask *, EXSessionTaskDelegate *> *tasks;
+@property (nonatomic) BOOL isActive;
+@property (nonatomic, weak, nullable) id<EXSessionHandler> sessionHandler;
+
+@end
+
+@implementation EXSessionTaskDispatcher
+
+- (instancetype)initWithSessionHandler:(nullable id<EXSessionHandler>)sessionHandler;
+{
+  if (self = [super init]) {
+    _tasks = [NSMutableDictionary dictionary];
+    _isActive = true;
+    _sessionHandler = sessionHandler;
+  }
+  return self;
+}
+
+#pragma mark - public methods
+
+- (void)registerTaskDelegate:(EXSessionTaskDelegate *)delegate forTask:(NSURLSessionTask *)task
+{
+  _tasks[task] = delegate;
+}
+
+- (void)deactivate
+{
+  _isActive = false;
+}
+
+#pragma mark - dispatcher
+
+- (void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask didFinishDownloadingToURL:(NSURL *)location
+{
+  if (_isActive) {
+    EXSessionTaskDelegate *exTask = _tasks[downloadTask];
+    if (exTask) {
+      [exTask URLSession:session downloadTask:downloadTask didFinishDownloadingToURL:location];
+      [_tasks removeObjectForKey:downloadTask];
+    }
+  }
+}
+
+- (void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task didCompleteWithError:(NSError *)error
+{
+  if (_isActive) {
+    EXSessionTaskDelegate *exTask = _tasks[task];
+    if (exTask) {
+      [exTask URLSession:session task:task didCompleteWithError:error];
+      [_tasks removeObjectForKey:task];
+    }
+  }
+}
+
+- (void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask
+                                           didWriteData:(int64_t)bytesWritten
+                                      totalBytesWritten:(int64_t)totalBytesWritten
+                              totalBytesExpectedToWrite:(int64_t)totalBytesExpectedToWrite
+{
+  if (_isActive) {
+    EXSessionTaskDelegate *exTask = _tasks[downloadTask];
+    [exTask URLSession:session downloadTask:downloadTask didWriteData:bytesWritten totalBytesWritten:totalBytesWritten totalBytesExpectedToWrite:totalBytesExpectedToWrite];
+  }
+}
+
+- (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didReceiveData:(NSData *)data
+{
+  if (_isActive) {
+    EXSessionTaskDelegate *exTask = _tasks[dataTask];
+    [exTask URLSession:session dataTask:dataTask didReceiveData:data];
+  }
+}
+
+- (void)URLSessionDidFinishEventsForBackgroundURLSession:(NSURLSession *)session {
+  [_sessionHandler invokeCompletionHandlerForSessionIdentifier:session.configuration.identifier];
+}
+
+- (void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task
+                                didSendBodyData:(int64_t)bytesSent
+                                 totalBytesSent:(int64_t)totalBytesSent
+                       totalBytesExpectedToSend:(int64_t)totalBytesExpectedToSend
+{
+  if (_isActive) {
+    EXSessionTaskDelegate *exTask = _tasks[task];
+    [exTask URLSession:session task:task didSendBodyData:bytesSent totalBytesSent:totalBytesSent totalBytesExpectedToSend:totalBytesExpectedToSend];
+  }
+}
+
+@end

package/ios/EXSessionTasks/EXSessionUploadTaskDelegate.h

@@ -0,0 +1,8 @@
+// Copyright 2015-present 650 Industries. All rights reserved.
+
+#import <ExpoFileSystem/EXSessionTaskDelegate.h>
+
+@interface EXSessionUploadTaskDelegate : EXSessionTaskDelegate
+
+@end
+

package/ios/EXSessionTasks/EXSessionUploadTaskDelegate.m

@@ -0,0 +1,52 @@
+// Copyright 2015-present 650 Industries. All rights reserved.
+
+#import <ExpoFileSystem/EXSessionUploadTaskDelegate.h>
+
+@interface EXSessionUploadTaskDelegate ()
+
+@property (strong, nonatomic) NSMutableData *responseData;
+
+@end
+
+@implementation EXSessionUploadTaskDelegate
+
+- (instancetype)initWithResolve:(EXPromiseResolveBlock)resolve reject:(EXPromiseRejectBlock)reject
+{
+  if (self = [super initWithResolve:resolve reject:reject]) {
+    _responseData = [NSMutableData new];
+  }
+  return self;
+}
+
+- (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didReceiveData:(NSData *)data
+{
+  if (!data.length) {
+    return;
+  }
+  [_responseData appendData:data];
+}
+
+- (void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task didCompleteWithError:(NSError *)error
+{
+  if (error) {
+    self.reject(@"ERR_FILESYSTEM_CANNOT_UPLOAD",
+                [NSString stringWithFormat:@"Unable to upload the file: '%@'", error.description],
+                error);
+    return;
+  }
+  
+  // We only set EXSessionUploadTaskDelegates as delegates of upload tasks
+  // so it should be safe to assume that this is what we will receive here.
+  NSURLSessionUploadTask *uploadTask = (NSURLSessionUploadTask *)task;
+  self.resolve([self parseServerResponse:uploadTask.response]);
+}
+
+- (NSDictionary *)parseServerResponse:(NSURLResponse *)response
+{
+  NSMutableDictionary *result = [[super parseServerResponse:response] mutableCopy];
+  // TODO: add support for others response types (different encodings, files)
+  result[@"body"] = EXNullIfNil([[NSString alloc] initWithData:_responseData encoding:NSUTF8StringEncoding]);
+  return result;
+}
+
+@end

package/ios/EXSessionTasks/EXTaskHandlersManager.h

@@ -0,0 +1,21 @@
+// Copyright 2015-present 650 Industries. All rights reserved.
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface EXTaskHandlersManager : NSObject
+
+- (NSURLSessionTask * _Nullable)taskForId:(NSString *)uuid;
+
+- (NSURLSessionDownloadTask * _Nullable)downloadTaskForId:(NSString *)uuid;
+
+- (NSURLSessionUploadTask * _Nullable)uploadTaskForId:(NSString *)uuid;
+
+- (void)registerTask:(NSURLSessionTask *)task uuid:(NSString *)uuid;
+
+- (void)unregisterTask:(NSString *)uuid;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/ios/EXSessionTasks/EXTaskHandlersManager.m

@@ -0,0 +1,56 @@
+// Copyright 2015-present 650 Industries. All rights reserved.
+
+#import <ExpoFileSystem/EXTaskHandlersManager.h>
+
+@interface EXTaskHandlersManager ()
+
+@property (nonatomic, strong) NSMutableDictionary<NSString *, NSURLSessionTask *> *resumableDownloads;
+
+@end
+
+@implementation EXTaskHandlersManager
+
+- (instancetype)init
+{
+  if (self = [super init]) {
+    _resumableDownloads = [NSMutableDictionary dictionary];
+  }
+  return self;
+}
+
+- (void)registerTask:(NSURLSessionTask *)task uuid:(NSString *)uuid
+{
+  _resumableDownloads[uuid] = task;
+}
+
+- (NSURLSessionTask * _Nullable)taskForId:(NSString *)uuid
+{
+  return _resumableDownloads[uuid];
+}
+
+- (NSURLSessionDownloadTask * _Nullable)downloadTaskForId:(NSString *)uuid
+{
+  NSURLSessionTask *task = [self taskForId:uuid];
+  if ([task isKindOfClass:[NSURLSessionDownloadTask class]]) {
+    return (NSURLSessionDownloadTask *)task;
+  }
+  
+  return nil;
+}
+
+- (NSURLSessionUploadTask * _Nullable)uploadTaskForId:(NSString *)uuid
+{
+  NSURLSessionTask *task = [self taskForId:uuid];
+  if ([task isKindOfClass:[NSURLSessionUploadTask class]]) {
+    return (NSURLSessionDownloadTask *)task;
+  }
+  
+  return nil;
+}
+
+- (void)unregisterTask:(NSString *)uuid
+{
+  [_resumableDownloads removeObjectForKey:uuid];
+}
+
+@end

package/ios/Encoding.swift

@@ -0,0 +1,88 @@
+// Copyright 2023-present 650 Industries. All rights reserved.
+
+import ExpoModulesCore
+
+enum Encoding: String, Enumerable {
+  // Equivalents of String.Encoding
+  case ascii
+  case nextstep
+  case japaneseeuc
+  case utf8
+  case isolatin1
+  case symbol
+  case nonlossyascii
+  case shiftjis
+  case isolatin2
+  case unicode
+  case windowscp1251
+  case windowscp1252
+  case windowscp1253
+  case windowscp1254
+  case windowscp1250
+  case iso2022jp
+  case macosroman
+  case utf16
+  case utf16bigendian
+  case utf16littleendian
+  case utf32
+  case utf32bigendian
+  case utf32littleendian
+
+  // Without equivalents in String.Encoding
+  case base64
+
+  func toStringEncoding() -> String.Encoding? {
+    switch self {
+    case .ascii:
+      return .ascii
+    case .nextstep:
+      return .nextstep
+    case .japaneseeuc:
+      return .japaneseEUC
+    case .utf8:
+      return .utf8
+    case .isolatin1:
+      return .isoLatin1
+    case .symbol:
+      return .symbol
+    case .nonlossyascii:
+      return .nonLossyASCII
+    case .shiftjis:
+      return .shiftJIS
+    case .isolatin2:
+      return .isoLatin2
+    case .unicode:
+      return .unicode
+    case .windowscp1251:
+      return .windowsCP1251
+    case .windowscp1252:
+      return .windowsCP1252
+    case .windowscp1253:
+      return .windowsCP1253
+    case .windowscp1254:
+      return .windowsCP1254
+    case .windowscp1250:
+      return .windowsCP1250
+    case .iso2022jp:
+      return .iso2022JP
+    case .macosroman:
+      return .macOSRoman
+    case .utf16:
+      return .utf16
+    case .utf16bigendian:
+      return .utf16BigEndian
+    case .utf16littleendian:
+      return .utf16LittleEndian
+    case .utf32:
+      return .utf32
+    case .utf32bigendian:
+      return .utf32BigEndian
+    case .utf32littleendian:
+      return .utf32LittleEndian
+
+      // Cases that don't have their own equivalent in String.Encoding
+    case .base64:
+      return nil
+    }
+  }
+}

package/ios/ExpoFileSystem.h

@@ -0,0 +1 @@
+// Copyright 2023-present 650 Industries. All rights reserved.

package/ios/ExpoFileSystem.podspec

@@ -0,0 +1,32 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, '..', 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name           = 'ExpoFileSystem'
+  s.version        = package['version']
+  s.summary        = package['description']
+  s.description    = package['description']
+  s.license        = package['license']
+  s.author         = package['author']
+  s.homepage       = package['homepage']
+  s.platforms       = { :ios => '13.0', :tvos => '13.0'}
+  s.swift_version  = '5.4'
+  s.source         = { :git => 'https://github.com/expo/expo.git' }
+  s.static_framework = true
+
+  s.dependency 'ExpoModulesCore'
+
+  # Swift/Objective-C compatibility
+  s.pod_target_xcconfig = {
+    'DEFINES_MODULE' => 'YES'
+  }
+
+  s.source_files = "**/*.{h,m,swift}"
+
+  s.exclude_files = 'Tests/'
+  s.test_spec 'Tests' do |test_spec|
+    test_spec.dependency 'ExpoModulesTestCore'
+    test_spec.source_files = 'Tests/**/*.{m,swift}'
+  end
+end

package/ios/FileSystemBackgroundSessionHandler.swift

@@ -0,0 +1,25 @@
+// Copyright 2023-present 650 Industries. All rights reserved.
+
+import ExpoModulesCore
+
+public final class FileSystemBackgroundSessionHandler: ExpoAppDelegateSubscriber, EXSessionHandlerProtocol {
+  public typealias BackgroundSessionCompletionHandler = () -> Void
+
+  private var completionHandlers: [String: BackgroundSessionCompletionHandler] = [:]
+
+  public func invokeCompletionHandler(forSessionIdentifier identifier: String) {
+    guard let completionHandler = completionHandlers[identifier] else {
+      return
+    }
+    DispatchQueue.main.async {
+      completionHandler()
+    }
+    completionHandlers.removeValue(forKey: identifier)
+  }
+
+  // MARK: - ExpoAppDelegateSubscriber
+
+  public func application(_ application: UIApplication, handleEventsForBackgroundURLSession identifier: String, completionHandler: @escaping () -> Void) {
+    completionHandlers[identifier] = completionHandler
+  }
+}

package/ios/FileSystemExceptions.swift

@@ -0,0 +1,69 @@
+// Copyright 2023-present 650 Industries. All rights reserved.
+
+import ExpoModulesCore
+
+final class FileNotExistsException: GenericException<String> {
+  override var reason: String {
+    "File '\(param)' does not exist"
+  }
+}
+
+final class DirectoryNotExistsException: GenericException<String> {
+  override var reason: String {
+    "Directory '\(param)' does not exist"
+  }
+}
+
+final class FileNotReadableException: GenericException<String> {
+  override var reason: String {
+    "File '\(param)' is not readable"
+  }
+}
+
+final class FileNotWritableException: GenericException<String> {
+  override var reason: String {
+    "File '\(param)' is not writable"
+  }
+}
+
+final class FileWriteFailedException: GenericException<String> {
+  override var reason: String {
+    "Writing to '\(param)' file has failed"
+  }
+}
+
+final class FileCannotDeleteException: GenericException<String> {
+  override var reason: String {
+    "File '\(param)' could not be deleted"
+  }
+}
+
+final class InvalidFileUrlException: GenericException<URL> {
+  override var reason: String {
+    "'\(param.absoluteString)' is not a file URL"
+  }
+}
+
+final class UnsupportedSchemeException: GenericException<String?> {
+  override var reason: String {
+    "Unsupported URI scheme: '\(String(describing: param))'"
+  }
+}
+
+final class HeaderEncodingFailedException: GenericException<String> {
+  override var reason: String {
+    "Unable to encode headers for request '\(param)' to UTF8"
+  }
+}
+
+final class DownloadTaskNotFoundException: GenericException<String> {
+  override var reason: String {
+    "Cannot find a download task with id: '\(param)'"
+  }
+}
+
+final class CannotDetermineDiskCapacity: Exception {
+  override var reason: String {
+    "Unable to determine free disk storage capacity"
+  }
+}

package/ios/FileSystemHelpers.swift

@@ -0,0 +1,66 @@
+// Copyright 2023-present 650 Industries. All rights reserved.
+
+import ExpoModulesCore
+
+internal func ensureFileDirectoryExists(_ fileUrl: URL) throws {
+  let directoryPath = fileUrl.deletingLastPathComponent()
+
+  if !FileManager.default.fileExists(atPath: directoryPath.path) {
+    throw DirectoryNotExistsException(directoryPath.path)
+  }
+}
+
+internal func readFileAsBase64(path: String, options: ReadingOptions) throws -> String {
+  let file = FileHandle(forReadingAtPath: path)
+
+  guard let file else {
+    throw FileNotExistsException(path)
+  }
+  if let position = options.position, position != 0 {
+    // TODO: Handle these errors?
+    try? file.seek(toOffset: UInt64(position))
+  }
+  if let length = options.length {
+    return file.readData(ofLength: length).base64EncodedString(options: .endLineWithLineFeed)
+  }
+  return file.readDataToEndOfFile().base64EncodedString(options: .endLineWithLineFeed)
+}
+
+internal func writeFileAsBase64(path: String, string: String) throws {
+  let data = Data(base64Encoded: string, options: .ignoreUnknownCharacters)
+
+  if !FileManager.default.createFile(atPath: path, contents: data) {
+    throw FileWriteFailedException(path)
+  }
+}
+
+internal func removeFile(path: String, idempotent: Bool = false) throws {
+  if FileManager.default.fileExists(atPath: path) {
+    do {
+      try FileManager.default.removeItem(atPath: path)
+    } catch {
+      throw FileCannotDeleteException(path)
+        .causedBy(error)
+    }
+  } else if !idempotent {
+    throw FileCannotDeleteException(path)
+      .causedBy(FileNotExistsException(path))
+  }
+}
+
+internal func getResourceValues(from directory: URL?, forKeys: Set<URLResourceKey>) throws -> URLResourceValues? {
+  do {
+    return try directory?.resourceValues(forKeys: forKeys)
+  } catch {
+    throw CannotDetermineDiskCapacity().causedBy(error)
+  }
+}
+
+internal func ensurePathPermission(_ appContext: AppContext?, path: String, flag: EXFileSystemPermissionFlags) throws {
+  guard let permissionsManager: EXFilePermissionModuleInterface = appContext?.legacyModule(implementing: EXFilePermissionModuleInterface.self) else {
+    throw Exceptions.PermissionsModuleNotFound()
+  }
+  guard permissionsManager.getPathPermissions(path).contains(flag) else {
+    throw flag == .read ? FileNotReadableException(path) : FileNotWritableException(path)
+  }
+}