diff --git a/CHANGELOG.md b/CHANGELOG.md index 20f3dfd..0df339e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,7 @@ **New features** * You can now pick multiple files by using the `getMultiFilePath()` method which will return a `Map` with all paths from selected files, where the key matches the file name and the value its path. Optionally, it also supports filtering by file extension, otherwise all files will be selectable. Nevertheless, you should keep using `getFilePath()` for single path picking. * You can now use `FileType.AUDIO` to pick audio files. In iOS this will let you select from your music library. Paths from DRM protected files won't be loaded (see README for more details). + * Adds `getFile()` utility method that does the same of `getFilePath()` but returns a `File` object instead, for the returned path. **Bug fixes and updates** * This package is no longer attached to the [image_picker](https://pub.dartlang.org/packages/image_picker), and because of that, camera permission is also no longer required. diff --git a/README.md b/README.md index 418bbb6..c356a89 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ # file_picker -File picker plugin alows you to use a native file explorer to load absolute file path from different file types. +A package that allows you to use a native file explorer to pick single or multiple absolute file paths, with extensions filtering support. ## Installation @@ -12,17 +12,39 @@ First, add *file_picker* as a dependency in [your pubspec.yaml file](https://f ``` file_picker: ^1.3.0 ``` -## Android +### Android Add `` to your app `AndroidManifest.xml` file. This is required due to file caching when a path is required from a remote file (eg. Google Drive). -## iOS +### iOS Based on the location of the files that you are willing to pick paths, you may need to add some keys to your iOS app's _Info.plist_ file, located in `/ios/Runner/Info.plist`: +* **_UIBackgroundModes_** with the **_fetch_** and **_remote-notifications_** keys - Required if you'll be using the `FileType.ANY` or `FileType.CUSTOM`. Describe why your app needs to access background taks, such downloading files (from cloud services). This is called _Required background modes_, with the keys _App download content from network_ and _App downloads content in response to push notifications_ respectively in the visual editor (since both methods aren't actually overriden, not adding this property/keys may only display a warning, but shouldn't prevent its correct usage). + + ``` + UIBackgroundModes + + fetch + remote-notification + + ``` + * **_NSAppleMusicUsageDescription_** - Required if you'll be using the `FileType.AUDIO`. Describe why your app needs permission to access music library. This is called _Privacy - Media Library Usage Description_ in the visual editor. + ``` + NSAppleMusicUsageDescription + Explain why your app uses music + ``` + + * **_NSPhotoLibraryUsageDescription_** - Required if you'll be using the `FileType.IMAGE` or `FileType.VIDEO`. Describe why your app needs permission for the photo library. This is called _Privacy - Photo Library Usage Description_ in the visual editor. -* **_UIBackgroundModes_** with the **_fetch_** and **_remote-notifications_** keys - Required if you'll be using the `FileType.ANY` or `FileType.CUSTOM`. Describe why your app needs to access background taks, such downloading files (from cloud services) when not cached to locate path. This is called _Required background modes_, with the keys _App download content from network_ and _App downloads content in response to push notifications_ respectively in the visual editor (since both methods aren't actually overriden, not adding this property/keys may only display a warning, but shouldn't prevent its correct usage). + ``` + NSPhotoLibraryUsageDescription + Explain why your app uses photo library + ``` + +**Note:** Any iOS version below 11.0, will require an Apple Developer Program account to enable _CloudKit_ and make it possible to use the document picker (which happens when you select `FileType.ALL`, `FileType.CUSTOM` or any other option with `getMultiFilePath()`). You can read more about it [here]( https://developer.apple.com/library/archive/documentation/DataManagement/Conceptual/CloudKitQuickStart/EnablingiCloudandConfiguringCloudKit/EnablingiCloudandConfiguringCloudKit.html). + ## Usage There are only two methods that should be used with this package: @@ -48,31 +70,37 @@ So, a few example usages can be as follow: ``` // Single file path String filePath; -filePath = await FilePicker.getFilePath(type: FileType.ANY); // will let you pick one file, from all extensions -filePath = await FilePicker.getFilePath(type: FileType.CUSTOM, fileExtension: 'svg'); // will filter and only let you pick files with svg extension. +filePath = await FilePicker.getFilePath(type: FileType.ANY); // will let you pick one file path, from all extensions +filePath = await FilePicker.getFilePath(type: FileType.CUSTOM, fileExtension: 'svg'); // will filter and only let you pick files with svg extension + +// Pick a single file directly +File file = await FilePicker.getFile(type: FileType.ANY); // will return a File object directly from the selected file // Multi file path Map filesPaths; filePaths = await FilePicker.getMultiFilePath(); // will let you pick multiple files of any format at once filePaths = await FilePicker.getMultiFilePath(fileExtension: 'pdf'); // will let you pick multiple pdf files at once +filePaths = await FilePicker.getMultiFilePath(type: FileType.IMAGE); // will let you pick multiple image files at once List allNames = filePaths.keys; // List of all file names List allPaths = filePaths.values; // List of all paths String someFilePath = filePaths['fileName']; // Access a file path directly by its name (matching a key) ``` -##### A few notes +##### A few side notes +* Using `getMultiFilePath()` on iOS will always use the document picker (aka Files app). This means that multi picks are not currently supported for photo library images/videos or music library files. * When using `FileType.CUSTOM`, unsupported extensions will throw a `MissingPluginException` that is handled by the plugin. -* On Android, when available, you should avoid using custom file explorers as those may prevent file extension filtering (behaving as `FileType.ANY`). In this scenario, you will need to validate it on return. +* On Android, when available, you should avoid using third-party file explorers as those may prevent file extension filtering (behaving as `FileType.ANY`). In this scenario, you will need to validate it on return. ## Currently supported features * [X] Load paths from **cloud files** (GDrive, Dropbox, iCloud) * [X] Load path from a **custom format** by providing a file extension (pdf, svg, zip, etc.) -* [X] Load path from **multiple files** with an optional file extension +* [X] Load path from **multiple files** optionally, supplying a file extension * [X] Load path from **gallery** * [X] Load path from **audio** * [X] Load path from **video** -* [X] Load path from **any** file type (without filtering, just pick what you want) +* [X] Load path from **any** +* [X] Create a `File` object from **any** selected file ## Demo App @@ -88,3 +116,5 @@ For help getting started with Flutter, view our online For help on editing plugin code, view the [documentation](https://flutter.io/platform-plugins/#edit-code). + + diff --git a/android/src/main/java/com/mr/flutter/plugin/filepicker/FilePickerPlugin.java b/android/src/main/java/com/mr/flutter/plugin/filepicker/FilePickerPlugin.java index d8ebdc2..2aa1c0c 100644 --- a/android/src/main/java/com/mr/flutter/plugin/filepicker/FilePickerPlugin.java +++ b/android/src/main/java/com/mr/flutter/plugin/filepicker/FilePickerPlugin.java @@ -65,8 +65,6 @@ public class FilePickerPlugin implements MethodCallHandler { Uri uri = data.getData(); Log.i(TAG, "[SingleFilePick] File URI:" +data.getData().toString()); String fullPath = FileUtils.getPath(uri, instance.context()); - String cloudFile = null; - if(fullPath == null) { fullPath = FileUtils.getUriFromRemote(instance.activeContext(), uri, result); @@ -84,7 +82,7 @@ public class FilePickerPlugin implements MethodCallHandler { result.success(null); return true; } - result.error(TAG, "Unknown activity error, please report issue." ,null); + result.error(TAG, "Unknown activity error, please fill an issue." ,null); return false; } }); @@ -110,6 +108,8 @@ public class FilePickerPlugin implements MethodCallHandler { if(fileType == null) { result.notImplemented(); + } else if(fileType.equals("unsupported")) { + result.error(TAG, "Unsupported filter. Make sure that you are only using the extension without the dot, (ie., jpg instead of .jpg). This could also have happened because you are using an unsupported file extension. If the problem persists, you may want to consider using FileType.ALL instead." ,null); } else { startFileExplorer(fileType); } @@ -136,6 +136,7 @@ public class FilePickerPlugin implements MethodCallHandler { if(isCustom) { final String extension = type.split("__CUSTOM_")[1].toLowerCase(); String mime = MimeTypeMap.getSingleton().getMimeTypeFromExtension(extension); + mime = mime == null ? "unsupported" : mime; Log.i(TAG, "Custom file type: " + mime); return mime; } diff --git a/example/example.gif b/example/example.gif index c450cf8..a80843d 100644 Binary files a/example/example.gif and b/example/example.gif differ diff --git a/example/ios/Runner.xcodeproj/project.pbxproj b/example/ios/Runner.xcodeproj/project.pbxproj index 4190d80..7c79d1d 100644 --- a/example/ios/Runner.xcodeproj/project.pbxproj +++ b/example/ios/Runner.xcodeproj/project.pbxproj @@ -8,15 +8,12 @@ /* Begin PBXBuildFile section */ 1498D2341E8E89220040F4C2 /* GeneratedPluginRegistrant.m in Sources */ = {isa = PBXBuildFile; fileRef = 1498D2331E8E89220040F4C2 /* GeneratedPluginRegistrant.m */; }; - 2D5378261FAA1A9400D5DBA9 /* flutter_assets in Resources */ = {isa = PBXBuildFile; fileRef = 2D5378251FAA1A9400D5DBA9 /* flutter_assets */; }; 3B3967161E833CAA004F5970 /* AppFrameworkInfo.plist in Resources */ = {isa = PBXBuildFile; fileRef = 3B3967151E833CAA004F5970 /* AppFrameworkInfo.plist */; }; 3B80C3941E831B6300D905FE /* App.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 3B80C3931E831B6300D905FE /* App.framework */; }; 3B80C3951E831B6300D905FE /* App.framework in Embed Frameworks */ = {isa = PBXBuildFile; fileRef = 3B80C3931E831B6300D905FE /* App.framework */; settings = {ATTRIBUTES = (CodeSignOnCopy, RemoveHeadersOnCopy, ); }; }; 94EE95F5D222CC3C902F7AA8 /* libPods-Runner.a in Frameworks */ = {isa = PBXBuildFile; fileRef = 9E29C2B321AA1B6738D05DCC /* libPods-Runner.a */; }; 9705A1C61CF904A100538489 /* Flutter.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 9740EEBA1CF902C7004384FC /* Flutter.framework */; }; 9705A1C71CF904A300538489 /* Flutter.framework in Embed Frameworks */ = {isa = PBXBuildFile; fileRef = 9740EEBA1CF902C7004384FC /* Flutter.framework */; settings = {ATTRIBUTES = (CodeSignOnCopy, RemoveHeadersOnCopy, ); }; }; - 9740EEB41CF90195004384FC /* Debug.xcconfig in Resources */ = {isa = PBXBuildFile; fileRef = 9740EEB21CF90195004384FC /* Debug.xcconfig */; }; - 9740EEB51CF90195004384FC /* Generated.xcconfig in Resources */ = {isa = PBXBuildFile; fileRef = 9740EEB31CF90195004384FC /* Generated.xcconfig */; }; 978B8F6F1D3862AE00F588F7 /* AppDelegate.m in Sources */ = {isa = PBXBuildFile; fileRef = 7AFFD8EE1D35381100E5BB4D /* AppDelegate.m */; }; 97C146F31CF9000F007C117D /* main.m in Sources */ = {isa = PBXBuildFile; fileRef = 97C146F21CF9000F007C117D /* main.m */; }; 97C146FC1CF9000F007C117D /* Main.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = 97C146FA1CF9000F007C117D /* Main.storyboard */; }; @@ -42,7 +39,6 @@ /* Begin PBXFileReference section */ 1498D2321E8E86230040F4C2 /* GeneratedPluginRegistrant.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = GeneratedPluginRegistrant.h; sourceTree = ""; }; 1498D2331E8E89220040F4C2 /* GeneratedPluginRegistrant.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = GeneratedPluginRegistrant.m; sourceTree = ""; }; - 2D5378251FAA1A9400D5DBA9 /* flutter_assets */ = {isa = PBXFileReference; lastKnownFileType = folder; name = flutter_assets; path = Flutter/flutter_assets; sourceTree = SOURCE_ROOT; }; 3B3967151E833CAA004F5970 /* AppFrameworkInfo.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; name = AppFrameworkInfo.plist; path = Flutter/AppFrameworkInfo.plist; sourceTree = ""; }; 3B80C3931E831B6300D905FE /* App.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = App.framework; path = Flutter/App.framework; sourceTree = ""; }; 7AFA3C8E1D35360C0083082E /* Release.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; name = Release.xcconfig; path = Flutter/Release.xcconfig; sourceTree = ""; }; @@ -77,7 +73,6 @@ 9740EEB11CF90186004384FC /* Flutter */ = { isa = PBXGroup; children = ( - 2D5378251FAA1A9400D5DBA9 /* flutter_assets */, 3B80C3931E831B6300D905FE /* App.framework */, 3B3967151E833CAA004F5970 /* AppFrameworkInfo.plist */, 9740EEBA1CF902C7004384FC /* Flutter.framework */, @@ -177,7 +172,7 @@ 97C146E61CF9000F007C117D /* Project object */ = { isa = PBXProject; attributes = { - LastUpgradeCheck = 0910; + LastUpgradeCheck = 1010; ORGANIZATIONNAME = "The Chromium Authors"; TargetAttributes = { 97C146ED1CF9000F007C117D = { @@ -210,11 +205,8 @@ buildActionMask = 2147483647; files = ( 97C147011CF9000F007C117D /* LaunchScreen.storyboard in Resources */, - 9740EEB51CF90195004384FC /* Generated.xcconfig in Resources */, 3B3967161E833CAA004F5970 /* AppFrameworkInfo.plist in Resources */, - 9740EEB41CF90195004384FC /* Debug.xcconfig in Resources */, 97C146FE1CF9000F007C117D /* Assets.xcassets in Resources */, - 2D5378261FAA1A9400D5DBA9 /* flutter_assets in Resources */, 97C146FC1CF9000F007C117D /* Main.storyboard in Resources */, ); runOnlyForDeploymentPostprocessing = 0; @@ -335,12 +327,14 @@ CLANG_WARN_BOOL_CONVERSION = YES; CLANG_WARN_COMMA = YES; CLANG_WARN_CONSTANT_CONVERSION = YES; + CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; CLANG_WARN_EMPTY_BODY = YES; CLANG_WARN_ENUM_CONVERSION = YES; CLANG_WARN_INFINITE_RECURSION = YES; CLANG_WARN_INT_CONVERSION = YES; CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES; + CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES; CLANG_WARN_OBJC_LITERAL_CONVERSION = YES; CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; @@ -389,12 +383,14 @@ CLANG_WARN_BOOL_CONVERSION = YES; CLANG_WARN_COMMA = YES; CLANG_WARN_CONSTANT_CONVERSION = YES; + CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; CLANG_WARN_EMPTY_BODY = YES; CLANG_WARN_ENUM_CONVERSION = YES; CLANG_WARN_INFINITE_RECURSION = YES; CLANG_WARN_INT_CONVERSION = YES; CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES; + CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES; CLANG_WARN_OBJC_LITERAL_CONVERSION = YES; CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; diff --git a/example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme b/example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme index f5a8db1..e4f93ed 100644 --- a/example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme +++ b/example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme @@ -1,6 +1,6 @@ $(FLUTTER_BUILD_NAME) CFBundleSignature ???? + NSAppleMusicUsageDescription + Used to demonstrate file picker plugin CFBundleVersion $(FLUTTER_BUILD_NUMBER) LSRequiresIPhoneOS NSPhotoLibraryUsageDescription - Used to demonstrate image picker plugin + Used to demonstrate file picker plugin UILaunchStoryboardName LaunchScreen UIMainStoryboardFile diff --git a/example/lib/main.dart b/example/lib/main.dart index 3e6a0c5..65197d2 100644 --- a/example/lib/main.dart +++ b/example/lib/main.dart @@ -31,7 +31,7 @@ class _FilePickerDemoState extends State { try { if (_multiPick) { _path = null; - _paths = await FilePicker.getMultiFilePath(fileExtension: _extension); + _paths = await FilePicker.getMultiFilePath(type: _pickingType, fileExtension: _extension); } else { _paths = null; _path = await FilePicker.getFilePath(type: _pickingType, fileExtension: _extension); @@ -54,58 +54,55 @@ class _FilePickerDemoState extends State { appBar: new AppBar( title: const Text('File Picker example app'), ), - body: SingleChildScrollView( - child: new Center( - child: new Padding( - padding: const EdgeInsets.only(top: 50.0, left: 10.0, right: 10.0), - child: new ConstrainedBox( - constraints: new BoxConstraints(maxWidth: 200.0), - child: new Column( - mainAxisAlignment: MainAxisAlignment.center, - children: [ - new Padding( - padding: const EdgeInsets.only(top: 20.0), - child: new DropdownButton( - hint: new Text('LOAD PATH FROM'), - value: _pickingType, - items: [ - new DropdownMenuItem( - child: new Text('FROM AUDIO'), - value: FileType.AUDIO, - ), - new DropdownMenuItem( - child: new Text('FROM GALLERY'), - value: FileType.IMAGE, - ), - new DropdownMenuItem( - child: new Text('FROM VIDEO'), - value: FileType.VIDEO, - ), - new DropdownMenuItem( - child: new Text('FROM ANY'), - value: FileType.ANY, - ), - new DropdownMenuItem( - child: new Text('CUSTOM FORMAT'), - value: FileType.CUSTOM, - ), - ], - onChanged: (value) => setState(() { - _pickingType = value; - if (_pickingType != FileType.CUSTOM && _pickingType != FileType.ANY) { - _multiPick = false; - } - if (_pickingType != FileType.CUSTOM) { - _controller.text = _extension = ''; - } - })), - ), - _pickingType == FileType.CUSTOM + body: new Center( + child: new Padding( + padding: const EdgeInsets.only(top: 50.0, left: 10.0, right: 10.0), + child: new SingleChildScrollView( + child: new Column( + mainAxisAlignment: MainAxisAlignment.center, + children: [ + new Padding( + padding: const EdgeInsets.only(top: 20.0), + child: new DropdownButton( + hint: new Text('LOAD PATH FROM'), + value: _pickingType, + items: [ + new DropdownMenuItem( + child: new Text('FROM AUDIO'), + value: FileType.AUDIO, + ), + new DropdownMenuItem( + child: new Text('FROM IMAGE'), + value: FileType.IMAGE, + ), + new DropdownMenuItem( + child: new Text('FROM VIDEO'), + value: FileType.VIDEO, + ), + new DropdownMenuItem( + child: new Text('FROM ANY'), + value: FileType.ANY, + ), + new DropdownMenuItem( + child: new Text('CUSTOM FORMAT'), + value: FileType.CUSTOM, + ), + ], + onChanged: (value) => setState(() { + _pickingType = value; + if (_pickingType != FileType.CUSTOM) { + _controller.text = _extension = ''; + } + })), + ), + ConstrainedBox( + constraints: BoxConstraints.tightFor(width: 100.0), + child: _pickingType == FileType.CUSTOM ? new TextFormField( - maxLength: 20, + maxLength: 15, autovalidate: true, controller: _controller, - decoration: InputDecoration(labelText: 'File type'), + decoration: InputDecoration(labelText: 'File extension'), keyboardType: TextInputType.text, textCapitalization: TextCapitalization.none, validator: (value) { @@ -118,49 +115,52 @@ class _FilePickerDemoState extends State { }, ) : new Container(), - new Visibility( - visible: _pickingType == FileType.ANY || _pickingType == FileType.CUSTOM, - child: new SwitchListTile.adaptive( - title: new Text('Pick multiple files', textAlign: TextAlign.right), - onChanged: (bool value) => setState(() => _multiPick = value), - value: _multiPick, - ), + ), + new ConstrainedBox( + constraints: BoxConstraints.tightFor(width: 200.0), + child: new SwitchListTile.adaptive( + title: new Text('Pick multiple files', textAlign: TextAlign.right), + onChanged: (bool value) => setState(() => _multiPick = value), + value: _multiPick, ), - new Padding( - padding: const EdgeInsets.only(top: 50.0, bottom: 20.0), - child: new RaisedButton( - onPressed: () => _openFileExplorer(), - child: new Text("Open file picker"), - ), + ), + new Padding( + padding: const EdgeInsets.only(top: 50.0, bottom: 20.0), + child: new RaisedButton( + onPressed: () => _openFileExplorer(), + child: new Text("Open file picker"), ), - new Text( - 'URI PATH ', - textAlign: TextAlign.center, - style: new TextStyle(fontWeight: FontWeight.bold), - ), - new Text( - _path ?? ((_paths != null && _paths.isNotEmpty) ? _paths.values.map((path) => path + '\n\n').toString() : '...'), - textAlign: TextAlign.center, - softWrap: true, - textScaleFactor: 0.85, - ), - new Padding( - padding: const EdgeInsets.only(top: 10.0), - child: new Text( - 'FILE NAME ', - textAlign: TextAlign.center, - style: new TextStyle(fontWeight: FontWeight.bold), - ), - ), - new Text( - _fileName ?? '...', - textAlign: TextAlign.center, - ), - ], - ), + ), + new Builder( + builder: (BuildContext context) => new Container( + padding: const EdgeInsets.only(bottom: 30.0), + height: MediaQuery.of(context).size.height * 0.50, + child: new Scrollbar( + child: _path != null || _paths != null + ? new ListView.separated( + itemCount: _paths != null && _paths.isNotEmpty ? _paths.length : 1, + itemBuilder: (BuildContext context, int index) { + final bool isMultiPath = _paths != null && _paths.isNotEmpty; + final String name = 'File $index: ' + (isMultiPath ? _paths.keys.toList()[index] : _fileName ?? '...'); + final path = isMultiPath ? _paths.values.toList()[index].toString() : _path; + + return new ListTile( + title: new Text( + name, + ), + subtitle: new Text(path), + ); + }, + separatorBuilder: (BuildContext context, int index) => new Divider(), + ) + : new Container(), + ), + ), + ), + ], ), - )), - ), + ), + )), ), ); } diff --git a/ios/Classes/FilePickerPlugin.m b/ios/Classes/FilePickerPlugin.m index cf0cf3b..d230260 100644 --- a/ios/Classes/FilePickerPlugin.m +++ b/ios/Classes/FilePickerPlugin.m @@ -6,7 +6,7 @@ @property (nonatomic) FlutterResult result; @property (nonatomic) UIViewController *viewController; @property (nonatomic) UIImagePickerController *galleryPickerController; -@property (nonatomic) UIDocumentPickerViewController *pickerController; +@property (nonatomic) UIDocumentPickerViewController *documentPickerController; @property (nonatomic) UIDocumentInteractionController *interactionController; @property (nonatomic) MPMediaPickerController *audioPickerController; @property (nonatomic) NSString * fileType; @@ -37,31 +37,34 @@ - (void)handleMethodCall:(FlutterMethodCall*)call result:(FlutterResult)result { if (_result) { - _result([FlutterError errorWithCode:@"multiple_request" + result([FlutterError errorWithCode:@"multiple_request" message:@"Cancelled by a second request" details:nil]); _result = nil; + return; } _result = result; - - - if([call.method isEqualToString:@"VIDEO"]) { + BOOL isMultiplePick = [call.arguments boolValue]; + if(isMultiplePick || [call.method isEqualToString:@"ANY"] || [call.method containsString:@"__CUSTOM"]) { + self.fileType = [FileUtils resolveType:call.method]; + if(self.fileType == nil) { + _result([FlutterError errorWithCode:@"Unsupported file extension" + message:@"Make sure that you are only using the extension without the dot, (ie., jpg instead of .jpg). This could also have happened because you are using an unsupported file extension. If the problem persists, you may want to consider using FileType.ALL instead." + details:nil]); + _result = nil; + } else if(self.fileType != nil) { + [self resolvePickDocumentWithMultipleSelection:isMultiplePick]; + } + } else if([call.method isEqualToString:@"VIDEO"]) { [self resolvePickVideo]; - } - else if([call.method isEqualToString:@"AUDIO"]) { + } else if([call.method isEqualToString:@"AUDIO"]) { [self resolvePickAudio]; - } - else if([call.method isEqualToString:@"IMAGE"]) { + } else if([call.method isEqualToString:@"IMAGE"]) { [self resolvePickImage]; } else { - self.fileType = [FileUtils resolveType:call.method]; - - if(self.fileType == nil){ - result(FlutterMethodNotImplemented); - } else { - [self resolvePickDocumentWithMultipleSelection:call.arguments]; - } + result(FlutterMethodNotImplemented); + _result = nil; } } @@ -70,20 +73,27 @@ - (void)resolvePickDocumentWithMultipleSelection:(BOOL)allowsMultipleSelection { - self.pickerController = [[UIDocumentPickerViewController alloc] + @try{ + self.documentPickerController = [[UIDocumentPickerViewController alloc] initWithDocumentTypes:@[self.fileType] inMode:UIDocumentPickerModeImport]; + } @catch (NSException * e) { + Log(@"Couldn't launch documents file picker. Probably due to iOS version being below 11.0 and not having the iCloud entitlement. If so, just make sure to enable it for your app in Xcode. Exception was: %@", e); + _result = nil; + return; + } if (@available(iOS 11.0, *)) { - self.pickerController.allowsMultipleSelection = allowsMultipleSelection; + self.documentPickerController.allowsMultipleSelection = allowsMultipleSelection; } else if(allowsMultipleSelection) { Log(@"Multiple file selection is only supported on iOS 11 and above. Single selection will be used."); } - self.pickerController.delegate = self; - self.pickerController.modalPresentationStyle = UIModalPresentationCurrentContext; + self.documentPickerController.delegate = self; + self.documentPickerController.modalPresentationStyle = UIModalPresentationCurrentContext; self.galleryPickerController.allowsEditing = NO; - [_viewController presentViewController:self.pickerController animated:YES completion:nil]; + + [_viewController presentViewController:self.documentPickerController animated:YES completion:nil]; } - (void) resolvePickImage { @@ -104,6 +114,7 @@ self.audioPickerController.showsCloudItems = NO; self.audioPickerController.allowsPickingMultipleItems = NO; self.audioPickerController.modalPresentationStyle = UIModalPresentationCurrentContext; + [self.viewController presentViewController:self.audioPickerController animated:YES completion:nil]; } @@ -124,7 +135,7 @@ - (void)documentPicker:(UIDocumentPickerViewController *)controller didPickDocumentsAtURLs:(NSArray *)urls{ - [self.pickerController dismissViewControllerAnimated:YES completion:nil]; + [self.documentPickerController dismissViewControllerAnimated:YES completion:nil]; NSArray * result = [FileUtils resolvePath:urls]; if([result count] > 1) { @@ -132,6 +143,7 @@ didPickDocumentsAtURLs:(NSArray *)urls{ } else { _result([result objectAtIndex:0]); } + _result = nil; } @@ -159,9 +171,12 @@ didPickDocumentsAtURLs:(NSArray *)urls{ _result([FlutterError errorWithCode:@"file_picker_error" message:@"Temporary file could not be created" details:nil]); + _result = nil; + return; } _result([pickedVideoUrl != nil ? pickedVideoUrl : pickedImageUrl path]); + _result = nil; } @@ -171,9 +186,10 @@ didPickDocumentsAtURLs:(NSArray *)urls{ [mediaPicker dismissViewControllerAnimated:YES completion:NULL]; NSURL *url = [[[mediaItemCollection items] objectAtIndex:0] valueForKey:MPMediaItemPropertyAssetURL]; if(url == nil) { - Log(@"Couldn't retrieve the audio file path, either is not locally downloaded or the file DRM protected."); + Log(@"Couldn't retrieve the audio file path, either is not locally downloaded or the file is DRM protected."); } _result([url absoluteString]); + _result = nil; } #pragma mark - Actions canceled diff --git a/ios/Classes/FileUtils.m b/ios/Classes/FileUtils.m index e31999d..5f941ba 100644 --- a/ios/Classes/FileUtils.m +++ b/ios/Classes/FileUtils.m @@ -25,6 +25,12 @@ if ([type isEqualToString:@"ANY"]) { return @"public.item"; + } else if ([type isEqualToString:@"IMAGE"]) { + return @"public.image"; + } else if ([type isEqualToString:@"VIDEO"]) { + return @"public.movie"; + } else if ([type isEqualToString:@"AUDIO"]) { + return @"public.audio"; } else { return nil; } diff --git a/lib/file_picker.dart b/lib/file_picker.dart index a3e8d47..a81fa5b 100644 --- a/lib/file_picker.dart +++ b/lib/file_picker.dart @@ -1,9 +1,8 @@ import 'dart:async'; +import 'dart:io'; import 'package:flutter/services.dart'; -String _kCustomType = '__CUSTOM_'; - enum FileType { ANY, IMAGE, @@ -18,7 +17,33 @@ class FilePicker { FilePicker._(); - static Future _getPath(String type, [bool multipleSelection = false]) async { + /// Returns an iterable `Map` where the `key` is the name of the file + /// and the `value` the path. + /// + /// A [fileExtension] can be provided to filter the picking results. + /// If provided, it will be use the `FileType.CUSTOM` for that [fileExtension]. + /// If not, `FileType.ANY` will be used and any combination of files can be multi picked at once. + static Future> getMultiFilePath({FileType type = FileType.ANY, String fileExtension}) async => + await _getPath(_handleType(type, fileExtension), true); + + /// Returns an absolute file path from the calling platform. + /// + /// A [type] must be provided to filter the picking results. + /// Can be used a custom file type with `FileType.CUSTOM`. A [fileExtension] must be provided (e.g. PDF, SVG, etc.) + /// Defaults to `FileType.ANY` which will display all file types. + static Future getFilePath({FileType type = FileType.ANY, String fileExtension}) async => + await _getPath(_handleType(type, fileExtension), false); + + /// Returns a `File` object from the selected file path. + /// + /// This is an utility method that does the same of `getFilePath()` but saving some boilerplate if + /// you are planing to create a `File` for the returned path. + static Future getFile({FileType type = FileType.ANY, String fileExtension}) async { + final String filePath = await _getPath(_handleType(type, fileExtension), false); + return File(filePath); + } + + static Future _getPath(String type, bool multipleSelection) async { try { dynamic result = await _channel.invokeMethod(type, multipleSelection); if (result != null && multipleSelection) { @@ -29,50 +54,27 @@ class FilePicker { } return result; } on PlatformException catch (e) { - print("[$_tag] Platform exception: " + e.toString()); + print('[$_tag] Platform exception: ' + e.toString()); } catch (e) { - print(e.toString()); - print( - "[$_tag] Unsupported operation. This probably have happened because [${type.split('_').last}] is an unsupported file type. You may want to try FileType.ALL instead."); + print('[$_tag] Unsupported operation. Method not found. The exception thrown was: ' + e.toString()); } return null; } - /// Returns an iterable `Map` where the `key` is the name of the file - /// and the `value` the path. - /// - /// A [fileExtension] can be provided to filter the picking results. - /// If provided, it will be use the `FileType.CUSTOM` for that [fileExtension]. - /// If not, `FileType.ANY` will be used and any combination of files can be multi picked at once. - static Future> getMultiFilePath({String fileExtension}) async => - await _getPath(fileExtension != null && fileExtension != '' ? (_kCustomType + fileExtension) : 'ANY', true); - - /// Returns an absolute file path from the calling platform - /// - /// A [type] must be provided to filter the picking results. - /// Can be used a custom file type with `FileType.CUSTOM`. A [fileExtension] must be provided (e.g. PDF, SVG, etc.) - /// Defaults to `FileType.ANY` which will display all file types. - static Future getFilePath({FileType type = FileType.ANY, String fileExtension}) async { - var path; + static String _handleType(FileType type, String fileExtension) { switch (type) { case FileType.IMAGE: - path = _getPath('IMAGE'); - break; + return 'IMAGE'; case FileType.AUDIO: - path = _getPath('AUDIO'); - break; + return 'AUDIO'; case FileType.VIDEO: - path = _getPath('VIDEO'); - break; + return 'VIDEO'; case FileType.ANY: - path = _getPath('ANY'); - break; + return 'ANY'; case FileType.CUSTOM: - path = _getPath(_kCustomType + (fileExtension ?? '')); - break; + return '__CUSTOM_' + (fileExtension ?? ''); default: - break; + return 'ANY'; } - return await path; } } diff --git a/pubspec.yaml b/pubspec.yaml index 2bb3e5e..b544841 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,8 +1,8 @@ name: file_picker -description: A plugin that allows you to filter and pick absolute paths for diferent file extensions. -version: 1.3.0 +description: A package that allows you to use a native file explorer to pick single or multiple absolute file paths, with extensions filtering support. author: Miguel Ruivo homepage: https://github.com/miguelpruivo/plugins_flutter_file_picker +version: 1.3.0 dependencies: