v1.4.0

.fvm/fvm_config.json

@@ -1,4 +1,4 @@
 {
-  "flutterSdkVersion": "3.10.0",
+  "flutterSdkVersion": "3.10.2",
   "flavors": {}
 }

lib/ardrive_io.dart

@@ -8,6 +8,7 @@ export 'src/io_entity.dart';
 export 'src/io_exception.dart';
 export 'src/io_file.dart';
 export 'src/io_folder.dart';
+export 'src/mobile/mobile_io.dart';
 export 'src/utils/mime_type_utils.dart';
 export 'src/utils/path_utils.dart';
 export 'src/utils/permissions.dart';

lib/src/ardrive_downloader.dart

@@ -15,20 +15,24 @@ import 'package:flutter_downloader/flutter_downloader.dart';
 /// running at the time, it will only cancel the current one.
 ///
 // TODO: Add an interface for this class and implement a Web and mobile specific downloader
-class ArDriveDownloader {
+class ArDriveMobileDownloader {
   late String _currentTaskId;
 
   String get currentTaskId => _currentTaskId;
 
-  Stream<int> downloadFile(String downloadUrl, String fileName) async* {
+  Stream<int> downloadFile(
+      String downloadUrl, String fileName, String? contentType) async* {
     await requestPermissions();
     await verifyPermissions();
+
     final downloadDir = await getDefaultMobileDownloadDir();
+    final saveFileName =
+        await nonexistentFileName(downloadDir, fileName, contentType);
 
     final taskId = await FlutterDownloader.enqueue(
       url: downloadUrl,
       savedDir: downloadDir,
-      fileName: fileName,
+      fileName: saveFileName,
       saveInPublicStorage: true,
       showNotification: true,
       openFileFromNotification: false,
@@ -46,24 +50,24 @@ class ArDriveDownloader {
   }
 
   Stream<int> _handleProgress(String taskId) {
-    ReceivePort _port = ReceivePort();
+    ReceivePort port = ReceivePort();
     StreamController<int> controller = StreamController<int>();
 
     /// Remove previous port and track only one download
     IsolateNameServer.removePortNameMapping('downloader_send_port');
 
     IsolateNameServer.registerPortWithName(
-        _port.sendPort, 'downloader_send_port');
+        port.sendPort, 'downloader_send_port');
 
-    _port.listen((dynamic data) {
-      DownloadTaskStatus status = DownloadTaskStatus(data[1]);
+    port.listen((dynamic data) {
+      DownloadTaskStatus status = DownloadTaskStatus.values[data[1]];
       int progress = data[2];
 
       /// only track the progress of current task id
       if (status == DownloadTaskStatus.enqueued) {
         controller.sink.add(0);
       } else if (status == DownloadTaskStatus.running) {
-        debugPrint('Download progress: ' + progress.toString());
+        debugPrint('Download progress: $progress');
         controller.sink.add(progress);
       } else if (status == DownloadTaskStatus.complete) {
         controller.sink.add(100);

lib/src/ardrive_io.dart

@@ -9,6 +9,18 @@ import 'mobile/mobile_io.dart';
 import 'web/stub_web_io.dart' // Stub implementation
     if (dart.library.html) 'web/web_io.dart';
 
+class SaveStatus {
+  final int bytesSaved;
+  final int totalBytes;
+  final bool? saveResult;
+
+  SaveStatus({
+    required this.bytesSaved,
+    required this.totalBytes,
+    this.saveResult,
+  });
+}
+
 /// API for I/O operations
 ///
 /// Opens the platform specific file picker to pick files and folders, and save files using
@@ -36,4 +48,6 @@ abstract class ArDriveIO {
   Future<IOFolder> pickFolder();
 
   Future<void> saveFile(IOFile file);
+
+  Stream<SaveStatus> saveFileStream(IOFile file, Completer<bool> finalize);
 }

lib/src/cache_storage.dart

@@ -10,19 +10,19 @@ class IOCacheStorage {
 
     debugPrint('saving file on local storage');
 
-    final _file = File('${cacheDir.path}/${entity.name}');
+    final file = File('${cacheDir.path}/${entity.name}');
 
     final readStream = File(entity.path).openRead();
 
-    final writeStream = await _file.open(mode: FileMode.write);
+    final writeStream = await file.open(mode: FileMode.write);
 
     await for (List<int> chunk in readStream) {
       await writeStream.writeFrom(chunk);
     }
 
     await writeStream.close();
 
-    return _file.path;
+    return file.path;
   }
 
   Future<IOFile> getFileFromStorage(String fileName) async {
@@ -32,9 +32,9 @@ class IOCacheStorage {
 
     final cacheDir = await _getCacheDir();
 
-    final _file = File('${cacheDir.path}/$fileName');
+    final file = File('${cacheDir.path}/$fileName');
 
-    return adapter.fromFile(_file);
+    return adapter.fromFile(file);
   }
 
   Future<void> freeLocalStorage() async {

lib/src/file_provider.dart

@@ -28,7 +28,8 @@ abstract class FolderProvider {
 }
 
 /// Provides multiple `IOFiles` or an `IOFolder`
-abstract class MultiFileProvider extends FileProvider with FolderProvider {
+abstract class MultiFileProvider extends FileProvider
+    implements FolderProvider {
   Future<List<IOFile>> pickMultipleFiles({
     List<String>? allowedExtensions,
     required FileSource fileSource,

lib/src/io_exception.dart

@@ -9,6 +9,8 @@ class FileSystemPermissionDeniedException extends IOException {
   List<Permission> permissionsDenied;
 }
 
+class FileReadWritePermissionDeniedException extends IOException {}
+
 class EntityPathException extends IOException {}
 
 class UnsupportedPlatformException extends IOException {

lib/src/io_folder.dart

@@ -70,13 +70,13 @@ class _FileSystemFolder extends IOFolder {
   /// `_mountFolderChildren` mounts recursiverly the folder hierarchy. It gets only
   /// the current level entities loading only `IOFile` and `IOFolder`
   Future<List<IOEntity>> _mountFolderStructure() async {
-    List<IOEntity> _children = [];
+    List<IOEntity> children = [];
 
     for (var fs in _folderContent) {
-      _children.add(await _addFolderNode(fs));
+      children.add(await _addFolderNode(fs));
     }
 
-    return _children;
+    return children;
   }
 
   Future<IOEntity> _addFolderNode(FileSystemEntity fsEntity) async {

lib/src/mobile/mobile_io.dart

@@ -1,7 +1,10 @@
+import 'dart:async';
 import 'dart:io';
 
 import 'package:ardrive_io/ardrive_io.dart';
+import 'package:ardrive_io/src/utils/completer.dart';
 import 'package:file_saver/file_saver.dart' as file_saver;
+import 'package:flutter/foundation.dart';
 import 'package:mime/mime.dart' as mime;
 import 'package:path/path.dart' as p;
 
@@ -64,9 +67,19 @@ class MobileIO implements ArDriveIO {
   }
 
   @override
-  Future<void> saveFile(IOFile file) async {
+  Future<void> saveFile(IOFile file, [bool saveOnAppDirectory = false]) async {
     try {
-      await _fileSaver.save(file);
+      await _fileSaver.save(file, saveOnAppDirectory: saveOnAppDirectory);
+    } catch (e) {
+      rethrow;
+    }
+  }
+
+  @override
+  Stream<SaveStatus> saveFileStream(
+      IOFile file, Completer<bool> finalize) async* {
+    try {
+      yield* _fileSaver.saveStream(file, finalize);
     } catch (e) {
       rethrow;
     }
@@ -78,12 +91,24 @@ class MobileIO implements ArDriveIO {
 /// This implementation uses the `file_saver` package.
 ///
 /// Throws an `FileSystemPermissionDeniedException` when user deny access to storage
+///
+/// `saveOnAppDirectory` is not supported on this implementation
 class MobileSelectableFolderFileSaver implements FileSaver {
+  final DartIOFileSaver _dartIOFileSaver;
+
+  MobileSelectableFolderFileSaver({DartIOFileSaver? dartIOFileSaver})
+      : _dartIOFileSaver = dartIOFileSaver ?? DartIOFileSaver();
+
   @override
-  Future<void> save(IOFile file) async {
+  Future<void> save(IOFile file, {bool saveOnAppDirectory = false}) async {
     await requestPermissions();
     await verifyPermissions();
 
+    if (saveOnAppDirectory) {
+      await _dartIOFileSaver.save(file, saveOnAppDirectory: saveOnAppDirectory);
+      return;
+    }
+
     await file_saver.FileSaver.instance.saveAs(
       name: file.name,
       bytes: await file.readAsBytes(),
@@ -92,13 +117,19 @@ class MobileSelectableFolderFileSaver implements FileSaver {
 
     return;
   }
+
+  @override
+  Stream<SaveStatus> saveStream(IOFile file, Completer<bool> finalize) {
+    // file_saver doesn't seem to support support saving streams
+    throw UnimplementedError();
+  }
 }
 
 /// Saves a file using the `dart:io` library.
 /// It will save on `getDefaultMobileDownloadDir()`
 class DartIOFileSaver implements FileSaver {
   @override
-  Future<void> save(IOFile file) async {
+  Future<void> save(IOFile file, {bool saveOnAppDirectory = false}) async {
     await requestPermissions();
     await verifyPermissions();
 
@@ -111,24 +142,105 @@ class DartIOFileSaver implements FileSaver {
       fileName += '.$fileExtension';
     }
 
+    if (saveOnAppDirectory) {
+      await _saveOnAppDir(file, fileName);
+      return;
+    }
+
+    await _saveOnDownloadsDir(file, fileName);
+  }
+
+  Future<void> _saveOnDownloadsDir(IOFile file, String fileName) async {
     /// platform_specific_path/Downloads/
     final defaultDownloadDir = await getDefaultMobileDownloadDir();
 
-    final newFile = File(defaultDownloadDir + fileName);
+    final newFile = await nonexistentFile(defaultDownloadDir, file);
 
     await newFile.writeAsBytes(await file.readAsBytes());
   }
+
+  Future<void> _saveOnAppDir(IOFile file, String fileName) async {
+    final appDir = await getDefaultAppDir();
+
+    final newFile = File(appDir + fileName);
+
+    await newFile.writeAsBytes(await file.readAsBytes());
+  }
+
+  @override
+  Stream<SaveStatus> saveStream(IOFile file, Completer<bool> finalize) async* {
+    var bytesSaved = 0;
+    final totalBytes = await file.length;
+    yield SaveStatus(
+      bytesSaved: bytesSaved,
+      totalBytes: totalBytes,
+    );
+
+    try {
+      await requestPermissions();
+      await verifyPermissions();
+
+      /// platform_specific_path/Downloads/
+      final defaultDownloadDir = await getDefaultMobileDownloadDir();
+
+      final newFile = await nonexistentFile(defaultDownloadDir, file);
+
+      final sink = newFile.openWrite();
+
+      // NOTE: This is an alternative to `addStream` with lower level control
+      const flushThresholdBytes = 50 * 1024 * 1024; // 50 MiB
+      var unflushedDataBytes = 0;
+      await for (final chunk in file.openReadStream()) {
+        if (await completerMaybe(finalize) == false) break;
+
+        sink.add(chunk);
+        unflushedDataBytes += chunk.length;
+        if (unflushedDataBytes > flushThresholdBytes) {
+          await sink.flush();
+          unflushedDataBytes = 0;
+        }
+
+        bytesSaved += chunk.length;
+        yield SaveStatus(
+          bytesSaved: bytesSaved,
+          totalBytes: totalBytes,
+        );
+      }
+      await sink.flush();
+      await sink.close();
+
+      final finalizeResult = await finalize.future;
+      if (!finalizeResult) {
+        debugPrint('Cancelling saveStream...');
+        await newFile.delete();
+      }
+
+      yield SaveStatus(
+        bytesSaved: bytesSaved,
+        totalBytes: totalBytes,
+        saveResult: finalizeResult,
+      );
+    } catch (e) {
+      yield SaveStatus(
+        bytesSaved: bytesSaved,
+        totalBytes: totalBytes,
+        saveResult: false,
+      );
+    }
+  }
 }
 
 /// Defines the API for saving `IOFile` on Storage
 abstract class FileSaver {
   factory FileSaver() {
     if (Platform.isAndroid || Platform.isIOS) {
-      return MobileSelectableFolderFileSaver();
+      return DartIOFileSaver();
     }
     throw UnsupportedPlatformException(
         'The ${Platform.operatingSystem} platform is not supported');
   }
 
-  Future<void> save(IOFile file);
+  Future<void> save(IOFile file, {bool saveOnAppDirectory = false});
+
+  Stream<SaveStatus> saveStream(IOFile file, Completer<bool> finalize);
 }

lib/src/utils/completer.dart

@@ -0,0 +1,6 @@
+import 'dart:async';
+
+Future<T?> completerMaybe<T>(Completer<T> completer) => 
+  completer.isCompleted
+    ? completer.future
+    : Future.value(null);