Merge pull request #24 from alnitak/invalidFileName

fix: invalid file names checks in `startRecording`

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.0.1
+- detailed exception when passing an invalind file name to `startRecording` #23
+- removed deprecated `dart:js_util`
+
 ## 1.0.0
 - fixed choppy PCM playback on macOS #18.
 - fix `startRecording` empty path on the web

example/lib/loopback.dart

@@ -113,7 +113,7 @@ class _LoopBackState extends State<LoopBack> {
     if (audioSource != null) disposeAudioSource();
 
     audioSource = soloud.setBufferStream(
-      maxBufferSize: 1024 * 1024 * 50,
+      maxBufferSizeBytes: 1024 * 1024 * 50,
       channels: audioStreamChannels,
       format: audioStreamFormat,
       sampleRate: sampleRate,

example/pubspec.lock

@@ -5,42 +5,42 @@ packages:
     dependency: transitive
     description:
       name: async
-      sha256: "947bfcf187f74dbc5e146c9eb9c0f10c9f8b30743e341481c1e2ed3ecc18c20c"
+      sha256: d2872f9c19731c2e5f10444b14686eb7cc85c76274bd6c16e1816bff9a3bab63
       url: "https://pub.dev"
     source: hosted
-    version: "2.11.0"
+    version: "2.12.0"
   boolean_selector:
     dependency: transitive
     description:
       name: boolean_selector
-      sha256: "6cfb5af12253eaf2b368f07bacc5a80d1301a071c73360d746b7f2e32d762c66"
+      sha256: "8aab1771e1243a5063b8b0ff68042d67334e3feab9e95b9490f9a6ebf73b42ea"
       url: "https://pub.dev"
     source: hosted
-    version: "2.1.1"
+    version: "2.1.2"
   characters:
     dependency: transitive
     description:
       name: characters
-      sha256: "04a925763edad70e8443c99234dc3328f442e811f1d8fd1a72f1c8ad0f69a605"
+      sha256: f71061c654a3380576a52b451dd5532377954cf9dbd272a78fc8479606670803
       url: "https://pub.dev"
     source: hosted
-    version: "1.3.0"
+    version: "1.4.0"
   clock:
     dependency: transitive
     description:
       name: clock
-      sha256: cb6d7f03e1de671e34607e909a7213e31d7752be4fb66a86d29fe1eb14bfb5cf
+      sha256: fddb70d9b5277016c77a80201021d40a2247104d9f4aa7bab7157b7e3f05b84b
       url: "https://pub.dev"
     source: hosted
-    version: "1.1.1"
+    version: "1.1.2"
   collection:
     dependency: transitive
     description:
       name: collection
-      sha256: a1ace0a119f20aabc852d165077c036cd864315bd99b7eaa10a60100341941bf
+      sha256: "2f5709ae4d3d59dd8f7cd309b4e023046b57d8a6c82130785d2b0e5868084e76"
       url: "https://pub.dev"
     source: hosted
-    version: "1.19.0"
+    version: "1.19.1"
   cupertino_icons:
     dependency: "direct main"
     description:
@@ -53,10 +53,10 @@ packages:
     dependency: transitive
     description:
       name: fake_async
-      sha256: "511392330127add0b769b75a987850d136345d9227c6b94c96a04cf4a391bf78"
+      sha256: "6a95e56b2449df2273fd8c45a662d6947ce1ebb7aafe80e550a3f68297f3cacc"
       url: "https://pub.dev"
     source: hosted
-    version: "1.3.1"
+    version: "1.3.2"
   ffi:
     dependency: transitive
     description:
@@ -84,15 +84,15 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "0.9.6"
+    version: "1.0.0"
   flutter_soloud:
     dependency: "direct main"
     description:
       name: flutter_soloud
-      sha256: "83954f0ca99141872243bf497e5d20bcfd6eee559dbc93cd709a2445c5824562"
+      sha256: "711143c165e16717aa5ec7a2ac998d1803818ab101df6b506befa814923d9ce8"
       url: "https://pub.dev"
     source: hosted
-    version: "3.0.0-pre.0"
+    version: "3.0.0"
   flutter_test:
     dependency: "direct dev"
     description: flutter
@@ -123,18 +123,18 @@ packages:
     dependency: transitive
     description:
       name: leak_tracker
-      sha256: "7bb2830ebd849694d1ec25bf1f44582d6ac531a57a365a803a6034ff751d2d06"
+      sha256: c35baad643ba394b40aac41080300150a4f08fd0fd6a10378f8f7c6bc161acec
       url: "https://pub.dev"
     source: hosted
-    version: "10.0.7"
+    version: "10.0.8"
   leak_tracker_flutter_testing:
     dependency: transitive
     description:
       name: leak_tracker_flutter_testing
-      sha256: "9491a714cca3667b60b5c420da8217e6de0d1ba7a5ec322fab01758f6998f379"
+      sha256: f8b613e7e6a13ec79cfdc0e97638fddb3ab848452eff057653abd3edba760573
       url: "https://pub.dev"
     source: hosted
-    version: "3.0.8"
+    version: "3.0.9"
   leak_tracker_testing:
     dependency: transitive
     description:
@@ -163,10 +163,10 @@ packages:
     dependency: transitive
     description:
       name: matcher
-      sha256: d2323aa2060500f906aa31a895b4030b6da3ebdcc5619d14ce1aada65cd161cb
+      sha256: dc58c723c3c24bf8d3e2d3ad3f2f9d7bd9cf43ec6feaa64181775e60190153f2
       url: "https://pub.dev"
     source: hosted
-    version: "0.12.16+1"
+    version: "0.12.17"
   material_color_utilities:
     dependency: transitive
     description:
@@ -179,10 +179,10 @@ packages:
     dependency: transitive
     description:
       name: meta
-      sha256: bdb68674043280c3428e9ec998512fb681678676b3c54e773629ffe74419f8c7
+      sha256: e3641ec5d63ebf0d9b41bd43201a66e3fc79a65db5f61fc181f04cd27aab950c
       url: "https://pub.dev"
     source: hosted
-    version: "1.15.0"
+    version: "1.16.0"
   open_filex:
     dependency: "direct main"
     description:
@@ -195,10 +195,10 @@ packages:
     dependency: transitive
     description:
       name: path
-      sha256: "087ce49c3f0dc39180befefc60fdb4acd8f8620e5682fe2476afd0b3688bb4af"
+      sha256: "75cca69d1490965be98c73ceaea117e8a04dd21217b37b292c9ddbec0d955bc5"
       url: "https://pub.dev"
     source: hosted
-    version: "1.9.0"
+    version: "1.9.1"
   path_provider:
     dependency: "direct main"
     description:
@@ -320,50 +320,50 @@ packages:
     dependency: transitive
     description:
       name: source_span
-      sha256: "53e943d4206a5e30df338fd4c6e7a077e02254531b138a15aec3bd143c1a8b3c"
+      sha256: "254ee5351d6cb365c859e20ee823c3bb479bf4a293c22d17a9f1bf144ce86f7c"
       url: "https://pub.dev"
     source: hosted
-    version: "1.10.0"
+    version: "1.10.1"
   stack_trace:
     dependency: transitive
     description:
       name: stack_trace
-      sha256: "9f47fd3630d76be3ab26f0ee06d213679aa425996925ff3feffdec504931c377"
+      sha256: "8b27215b45d22309b5cddda1aa2b19bdfec9df0e765f2de506401c071d38d1b1"
       url: "https://pub.dev"
     source: hosted
-    version: "1.12.0"
+    version: "1.12.1"
   stream_channel:
     dependency: transitive
     description:
       name: stream_channel
-      sha256: ba2aa5d8cc609d96bbb2899c28934f9e1af5cddbd60a827822ea467161eb54e7
+      sha256: "969e04c80b8bcdf826f8f16579c7b14d780458bd97f56d107d3950fdbeef059d"
       url: "https://pub.dev"
     source: hosted
-    version: "2.1.2"
+    version: "2.1.4"
   string_scanner:
     dependency: transitive
     description:
       name: string_scanner
-      sha256: "688af5ed3402a4bde5b3a6c15fd768dbf2621a614950b17f04626c431ab3c4c3"
+      sha256: "921cd31725b72fe181906c6a94d987c78e3b98c2e205b397ea399d4054872b43"
       url: "https://pub.dev"
     source: hosted
-    version: "1.3.0"
+    version: "1.4.1"
   term_glyph:
     dependency: transitive
     description:
       name: term_glyph
-      sha256: a29248a84fbb7c79282b40b8c72a1209db169a2e0542bce341da992fe1bc7e84
+      sha256: "7f554798625ea768a7518313e58f83891c7f5024f88e46e7182a4558850a4b8e"
       url: "https://pub.dev"
     source: hosted
-    version: "1.2.1"
+    version: "1.2.2"
   test_api:
     dependency: transitive
     description:
       name: test_api
-      sha256: "664d3a9a64782fcdeb83ce9c6b39e78fd2971d4e37827b9b06c3aa1edc5e760c"
+      sha256: fb31f383e2ee25fbbfe06b40fe21e1e458d14080e3c67e7ba0acfde4df4e0bbd
       url: "https://pub.dev"
     source: hosted
-    version: "0.7.3"
+    version: "0.7.4"
   typed_data:
     dependency: transitive
     description:
@@ -392,10 +392,10 @@ packages:
     dependency: transitive
     description:
       name: vm_service
-      sha256: f6be3ed8bd01289b34d679c2b62226f63c0e69f9fd2e50a6b3c1c729a961041b
+      sha256: "0968250880a6c5fe7edc067ed0a13d4bae1577fe2771dcf3010d52c4a9d3ca14"
       url: "https://pub.dev"
     source: hosted
-    version: "14.3.0"
+    version: "14.3.1"
   web:
     dependency: transitive
     description:
@@ -413,5 +413,5 @@ packages:
     source: hosted
     version: "1.1.0"
 sdks:
-  dart: ">=3.6.0 <4.0.0"
+  dart: ">=3.7.0-0 <4.0.0"
   flutter: ">=3.24.0"

example/pubspec.yaml

@@ -13,11 +13,7 @@ dependencies:
   flutter_recorder:
     path: ../
 
-  flutter_soloud: ^3.0.0-pre.0
-    # path: ../../flutter_soloud # for development
-    # git:
-    #   url: /~https://github.com/alnitak/flutter_soloud.git
-    #   ref: main
+  flutter_soloud: ^3.0.0
 
   cupertino_icons: ^1.0.8
   logging: ^1.3.0

lib/src/bindings/recorder_io.dart

@@ -3,7 +3,6 @@
 
 import 'dart:ffi' as ffi;
 import 'dart:io';
-import 'dart:typed_data';
 
 import 'package:ffi/ffi.dart';
 import 'package:flutter/foundation.dart';
@@ -253,6 +252,81 @@ class RecorderFfi extends RecorderImpl {
 
   @override
   void startRecording(String path) {
+    var errorDescription = '';
+    // Check the file name is valid for the different platforms.
+    bool isValidPathName() {
+      // Reserved Windows filenames - these apply to any part of the path
+      const reservedNames = {
+        'CON', 'PRN', 'AUX', 'NUL',
+        'COM1', 'COM2', 'COM3', 'COM4', 'COM5', 'COM6', 'COM7', 'COM8', 'COM9',
+        'LPT1', 'LPT2', 'LPT3', 'LPT4', 'LPT5', 'LPT6', 'LPT7', 'LPT8', 'LPT9'
+        // ignore: require_trailing_commas
+      };
+
+      switch (defaultTargetPlatform) {
+        case TargetPlatform.windows:
+          // Split path into components
+          final pathParts = path.split(RegExp(r'[/\\]'));
+
+          // Check each component
+          for (final part in pathParts) {
+            // Skip empty parts
+            if (part.isEmpty) continue;
+
+            // Check for invalid characters in each part
+            if (part.contains(RegExp('[:*?"<>|]')) ||
+                reservedNames.contains(part.toUpperCase().split('.').first) ||
+                part.endsWith(' ') ||
+                part.endsWith('.')) {
+              errorDescription = 'Invalid path component "$part". Path '
+                  'components must not '
+                  'contain any of these characters: :*?"<>| '
+                  'or be a reserved name, or end with space/period.';
+              return false;
+            }
+          }
+
+          // Check total path length (Windows MAX_PATH is 260)
+          if (path.length > 259) {
+            errorDescription = 'Path is too long. Windows paths must be '
+                'less than 260 characters.';
+            return false;
+          }
+
+        case TargetPlatform.linux:
+        case TargetPlatform.android:
+          // Check for null bytes and control characters
+          if (path.contains(RegExp(r'[\x00-\x1F]'))) {
+            errorDescription = 'Path contains invalid control characters.';
+            return false;
+          }
+
+        case TargetPlatform.macOS:
+        case TargetPlatform.iOS:
+          // Check for invalid characters on macOS/iOS
+          if (path.contains(RegExp('[:<>]'))) {
+            errorDescription = 'Path contains invalid characters. '
+                'The following characters are not allowed: :<>';
+            return false;
+          }
+          // Check for ._ at start (reserved for resource forks)
+          if (path.split('/').any((part) => part.startsWith('._'))) {
+            errorDescription =
+                'File names cannot start with "._" on macOS/iOS.';
+            return false;
+          }
+
+        case TargetPlatform.fuchsia:
+          throw UnimplementedError();
+      }
+
+      return true;
+    }
+
+    if (!isValidPathName()) {
+      throw RecorderInvalidFileNameException(errorDescription);
+    }
+
     final error = _bindings.startRecording(path.toNativeUtf8().cast());
     if (error != CaptureErrors.captureNoError) {
       throw RecorderCppException.fromRecorderError(error);

lib/src/exceptions/exceptions.dart

@@ -36,9 +36,6 @@ sealed class RecorderException implements Exception {
 
 /// A base class for all flutter_recorder exceptions that are thrown from
 /// the C++ side.
-///
-/// These exceptions correspond to the errors define in the
-/// [CaptureErrors] enum.
 abstract class RecorderCppException extends RecorderException {
   /// Creates a new Recorder exception that is thrown from the C++ side.
   const RecorderCppException([super.message]);
@@ -77,3 +74,12 @@ abstract class RecorderCppException extends RecorderException {
     }
   }
 }
+
+/// An exception that is thrown when passing an invalid file name.
+class RecorderInvalidFileNameException extends RecorderException {
+  /// Creates a new [RecorderInvalidFileNameException].
+  const RecorderInvalidFileNameException([super.message]);
+
+  @override
+  String get description => 'The file name is invalid.';
+}

lib/src/flutter_recorder.dart

@@ -305,12 +305,13 @@ interface class Recorder {
   ///
   /// [completeFilePath] complete file path to save the recording.
   /// This is mandatory on all platforms but on the Web.
-  /// NOTE: when running on the  Web, [completeFilePath] is ignored and
-  /// just stopping the recording the browser will ask to save the file.
+  /// NOTE: when running on the  Web, [completeFilePath] is ignored:
+  /// when stopping the recording the browser will ask to save the file.
   ///
   /// Throws [RecorderNotInitializedException].
   /// Throws [RecorderCaptureNotStartededException].
-  /// Throws [RecorderFailedToInitializeRecordingException].
+  /// Throws [RecorderInvalidFileNameException] if the given file name is
+  /// invalid.
   void startRecording({String completeFilePath = ''}) {
     assert(
       () {

pubspec.yaml

@@ -3,7 +3,7 @@ description: >-
   A low-level audio recorder plugin which uses miniaudio as
   backend. Detect silence and save to WAV audio file. Audio
   wave, FFT and volume level can be get in real-time.
-version: 1.0.0
+version: 1.0.1
 issue_tracker: /~https://github.com/alnitak/flutter_recorder/issues
 homepage: /~https://github.com/alnitak/flutter_recorder
 maintainer: Marco Bavagnoli (@lildeimos)