feat(cat-voices): io downloader (#3361)

* chore: adding dependencies

* feat: adding permission for android

* feat: permission handler factory

* feat: exporting models

* feat: adding dependencies

* fix: android manifest format

* feat: adding catalyst operating system

* feat: adding catalyst operating system

* feat: refactor to used rationale and explanation exception

* feat: adding queue

* chore: remove android manifest permission

* fix: remove white space and sort intl

* feat: io downloader implementation

* chore: remove comments

* fix: spelling

* feat: extracting common logic

* chore: update logic for downloader class

* chore: remove unused mixin

* fix: format

* chore: review update

* chore: set default strategy

* chore: remove files

* chore: added permission

* chore: remove old files

Author: LynxLynxx

.config/dictionaries/project.dic

@@ -99,6 +99,7 @@ dockerenv
 dockerhub
 domcontentloaded
 Dominik
+downloadsfolder
 donts
 dotenv
 dotenvy

catalyst_voices/apps/voices/ios/Runner/Info.plist

@@ -51,5 +51,7 @@
 	</array>
 	<key>UIViewControllerBasedStatusBarAppearance</key>
 	<false/>
+	<key>UISupportsDocumentBrowser</key>  
+	<true/>
 </dict>
 </plist>

catalyst_voices/apps/voices/macos/Flutter/GeneratedPluginRegistrant.swift

@@ -6,6 +6,7 @@ import FlutterMacOS
 import Foundation
 
 import device_info_plus
+import downloadsfolder
 import file_picker
 import file_selector_macos
 import flutter_inappwebview_macos
@@ -22,6 +23,7 @@ import webview_flutter_wkwebview
 
 func RegisterGeneratedPlugins(registry: FlutterPluginRegistry) {
   DeviceInfoPlusMacosPlugin.register(with: registry.registrar(forPlugin: "DeviceInfoPlusMacosPlugin"))
+  DownloadsfolderPlugin.register(with: registry.registrar(forPlugin: "DownloadsfolderPlugin"))
   FilePickerPlugin.register(with: registry.registrar(forPlugin: "FilePickerPlugin"))
   FileSelectorPlugin.register(with: registry.registrar(forPlugin: "FileSelectorPlugin"))
   InAppWebViewFlutterPlugin.register(with: registry.registrar(forPlugin: "InAppWebViewFlutterPlugin"))

catalyst_voices/apps/voices/pubspec.yaml

@@ -35,7 +35,7 @@ dependencies:
   device_info_plus: ^11.5.0
   dotted_border: ^3.1.0
   equatable: ^2.0.7
-  file_picker: ^10.2.1
+  file_picker: ^10.3.2
   flutter:
     sdk: flutter
   flutter_bloc: ^9.1.1

catalyst_voices/melos.yaml

@@ -99,14 +99,15 @@ command:
       collection: ^1.19.1
       cryptography: ^2.7.0
       device_info_plus: ^11.5.0
+      downloadsfolder: ^1.1.0
       dotted_border: ^3.1.0
       ed25519_hd_key: ^2.3.0
       email_validator: ^3.0.0
       equatable: ^2.0.7
       fake_async: ^1.3.3
       ffi: ^2.1.4
       ffigen: ^19.1.0
-      file_picker: ^10.2.1
+      file_picker: ^10.3.2
       flutter_bloc: ^9.1.1
       flutter_dropzone: ^4.2.1
       flutter_inappwebview: ^6.1.5

catalyst_voices/packages/internal/catalyst_voices_models/lib/src/config/app_environment.dart

@@ -46,8 +46,7 @@ final class AppEnvironment extends Equatable {
   factory AppEnvironment.fromEnv() {
     String? envName;
 
-    // TODO(LynxLynxx): Change to CatalystPlatform when its refactored
-    if (kIsWeb) {
+    if (CatalystPlatform.isWeb) {
       final envVars = getDartEnvVars();
       envName = envVars.envName;
     }

catalyst_voices/packages/internal/catalyst_voices_services/lib/src/downloader/downloader_service.dart

@@ -1,36 +1,82 @@
 import 'dart:async';
 import 'dart:typed_data';
 
-import 'package:catalyst_voices_services/src/downloader/utils/downloader.dart';
+import 'package:catalyst_voices_models/catalyst_voices_models.dart';
+import 'package:catalyst_voices_services/src/downloader/utils/file_save_strategy.dart';
+import 'package:catalyst_voices_shared/catalyst_voices_shared.dart';
+import 'package:downloadsfolder/downloadsfolder.dart';
+import 'package:path/path.dart' as p;
 
 // ignore: one_member_abstracts
 abstract interface class DownloaderService {
-  static const bytesMimeType = 'application/octet-stream';
-
   const factory DownloaderService() = DownloaderServiceImpl;
 
-  Future<void> download({
+  Future<String?> download({
     required Uint8List data,
     required String filename,
-    String mimeType = DownloaderService.bytesMimeType,
   });
 }
 
 final class DownloaderServiceImpl implements DownloaderService {
   const DownloaderServiceImpl();
 
-  Downloader get _downloader => Downloader();
-
   @override
-  Future<void> download({
+  Future<String?> download({
     required Uint8List data,
     required String filename,
-    String mimeType = DownloaderService.bytesMimeType,
   }) async {
-    await _downloader.download(
-      data,
-      path: Uri(path: filename),
-      mimeType: mimeType,
+    final envType = AppEnvironment.fromEnv().type;
+    final strategyType = FileSaveStrategyFactory.getDefaultStrategyType();
+    final strategy = FileSaveStrategyFactory.getStrategy(type: strategyType);
+
+    final fileUri = await _buildSaveUri(filename, strategyType, envType);
+
+    return strategy.saveFile(
+      data: data,
+      fileUri: fileUri,
     );
   }
+
+  Future<Uri> _buildSaveUri(
+    String filename,
+    FileSaveStrategyType strategyType,
+    AppEnvironmentType envType,
+  ) async {
+    final flavorName = _getFlavorName(strategyType, envType);
+    final fileWithoutExtension = p.withoutExtension(filename);
+    final extensionName = p.extension(filename);
+
+    final downloadPath = await _getDownloadPathIfNeeded(strategyType);
+    final uniqueFilename = '$fileWithoutExtension$flavorName$extensionName';
+
+    return Uri.file(
+      downloadPath != null ? '$downloadPath/$uniqueFilename' : uniqueFilename,
+      windows: false,
+    );
+  }
+
+  Future<String?> _getDownloadPathIfNeeded(FileSaveStrategyType strategyType) async {
+    if (strategyType == FileSaveStrategyType.downloadsDirectory) {
+      final downloadDir = await getDownloadDirectory();
+      return downloadDir.path;
+    }
+    return null;
+  }
+
+  String _getFlavorName(FileSaveStrategyType strategyType, AppEnvironmentType envType) {
+    if (strategyType == FileSaveStrategyType.filePicker) {
+      return envType.fileFlavorName;
+    } else {
+      // For downloads directory, skip flavor on iOS
+      return CatalystOperatingSystem.current.isIOS ? '' : envType.fileFlavorName;
+    }
+  }
+}
+
+extension on AppEnvironmentType {
+  String get fileFlavorName => switch (this) {
+    AppEnvironmentType.dev => '_dev',
+    AppEnvironmentType.preprod => '_preprod',
+    _ => '',
+  };
 }

catalyst_voices/packages/internal/catalyst_voices_services/lib/src/downloader/utils/downloader.dart

@@ -0,0 +1,103 @@
+import 'dart:io';
+import 'dart:typed_data';
+
+import 'package:catalyst_voices_shared/catalyst_voices_shared.dart';
+import 'package:file_picker/file_picker.dart';
+import 'package:flutter/services.dart';
+import 'package:path/path.dart' as p;
+
+final _loggerDownloadsDirectory = Logger('DownloadsDirectorySaveStrategy');
+final _loggerFilePicker = Logger('FilePickerSaveStrategy');
+
+final class DownloadsDirectorySaveStrategy implements FileSaveStrategy {
+  const DownloadsDirectorySaveStrategy();
+
+  @override
+  Future<String?> saveFile({
+    required Uint8List data,
+    required Uri fileUri,
+  }) async {
+    try {
+      var file = File.fromUri(fileUri);
+
+      // If file exists, add numbers like web browsers do
+      var counter = 1;
+      while (file.existsSync()) {
+        final pathWithoutExt = p.withoutExtension(fileUri.path);
+        final extension = p.extension(fileUri.path);
+        final newPath = '$pathWithoutExt ($counter)$extension';
+        final newUri = Uri.file(newPath, windows: false);
+        file = File.fromUri(newUri);
+        counter++;
+      }
+
+      await file.writeAsBytes(data);
+      return file.path;
+    } catch (e) {
+      _loggerDownloadsDirectory.severe('Error saving file to downloads directory', e);
+      rethrow;
+    }
+  }
+}
+
+final class FilePickerSaveStrategy implements FileSaveStrategy {
+  const FilePickerSaveStrategy();
+
+  @override
+  Future<String?> saveFile({
+    required Uint8List data,
+    required Uri fileUri,
+  }) async {
+    try {
+      final fileName = fileUri.path;
+
+      await FilePicker.platform.saveFile(
+        fileName: fileName,
+        bytes: data,
+      );
+      return null;
+    } catch (e) {
+      _loggerFilePicker.severe('Error saving file with FilePicker', e);
+      rethrow;
+    }
+  }
+}
+
+/// Abstract interface for file saving strategies
+// ignore: one_member_abstracts
+abstract interface class FileSaveStrategy {
+  const FileSaveStrategy();
+
+  /// Saves the file represented by the [data] bytes with the given [fileUri].
+  /// Returns the path where the file was saved.
+  Future<String?> saveFile({
+    required Uint8List data,
+    required Uri fileUri,
+  });
+}
+
+/// Factory to get the appropriate file save strategy based on platform or preference
+class FileSaveStrategyFactory {
+  const FileSaveStrategyFactory();
+
+  /// Returns the default strategy for the current platform
+  static FileSaveStrategyType getDefaultStrategyType() {
+    return switch (CatalystOperatingSystem.current) {
+      _ when CatalystPlatform.isWeb || CatalystOperatingSystem.current.isIOS =>
+        FileSaveStrategyType.filePicker,
+      _ => FileSaveStrategyType.downloadsDirectory,
+    };
+  }
+
+  static FileSaveStrategy getStrategy({required FileSaveStrategyType type}) {
+    return switch (type) {
+      FileSaveStrategyType.filePicker => const FilePickerSaveStrategy(),
+      FileSaveStrategyType.downloadsDirectory => const DownloadsDirectorySaveStrategy(),
+    };
+  }
+}
+
+enum FileSaveStrategyType {
+  filePicker,
+  downloadsDirectory,
+}