[image_picker] Multiple image support (flutter#3783)

Author: danielroek

packages/image_picker/image_picker/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 0.8.1
+
+* Add a new method `getMultiImage` to allow picking multiple images on iOS 14 or higher
+and Android 4.3 or higher. Returns only 1 image for lower versions of iOS and Android.
+* Known issue: On Android, `getLostData` will only get the last picked image when picking multiple images,
+see: [#84634](https://github.com/flutter/flutter/issues/84634).
+
 ## 0.8.0+4
 
 * Cleaned up the README example
@@ -49,15 +56,15 @@ is not included selected photos and image is scaled.
 
 ## 0.7.3
 
-* Endorse image_picker_for_web
+* Endorse image_picker_for_web.
 
 ## 0.7.2+1
 
 * Android: fixes an issue where videos could be wrongly picked with `.jpg` extension.
 
 ## 0.7.2
 
-* Run CocoaPods iOS tests in RunnerUITests target
+* Run CocoaPods iOS tests in RunnerUITests target.
 
 ## 0.7.1
 

packages/image_picker/image_picker/README.md

@@ -11,6 +11,9 @@ First, add `image_picker` as a [dependency in your pubspec.yaml file](https://fl
 
 ### iOS
 
+Starting with version **0.8.1** the iOS implementation uses PHPicker to pick (multiple) images on iOS 14 or higher.
+As a result of implementing PHPicker it becomes impossible to pick HEIC images on the iOS simulator in iOS 14+. This is a known issue. Please test this on a real device, or test with non-HEIC images until Apple solves this issue.[63426347 - Apple known issue](https://www.google.com/search?q=63426347+apple&sxsrf=ALeKk01YnTMid5S0PYvhL8GbgXJ40ZS[…]t=gws-wiz&ved=0ahUKEwjKh8XH_5HwAhWL_rsIHUmHDN8Q4dUDCA8&uact=5) 
+
 Add the following keys to your _Info.plist_ file, located in `<project root>/ios/Runner/Info.plist`:
 
 * `NSPhotoLibraryUsageDescription` - describe why your app needs permission for the photo library. This is called _Privacy - Photo Library Usage Description_ in the visual editor.
@@ -19,6 +22,8 @@ Add the following keys to your _Info.plist_ file, located in `<project root>/ios
 
 ### Android
 
+Starting with version **0.8.1** the Android implementation support to pick (multiple) images on Android 4.3 or higher.
+
 No configuration required - the plugin should work out of the box.
 
 It is no longer required to add `android:requestLegacyExternalStorage="true"` as an attribute to the `<application>` tag in AndroidManifest.xml, as `image_picker` has been updated to make use of scoped storage.
@@ -63,6 +68,8 @@ Future<void> retrieveLostData() async {
 
 There's no way to detect when this happens, so calling this method at the right place is essential. We recommend to wire this into some kind of start up check. Please refer to the example app to see how we used it.
 
+On Android, `getLostData` will only get the last picked image when picking multiple images, see: [#84634](https://github.com/flutter/flutter/issues/84634).
+
 ## Deprecation warnings in `pickImage`, `pickVideo` and `LostDataResponse`
 
 Starting with version **0.6.7** of the image_picker plugin, the API of the plugin changed slightly to allow for web implementations to exist.

packages/image_picker/image_picker/android/src/main/java/io/flutter/plugins/imagepicker/ImagePickerDelegate.java

@@ -22,6 +22,7 @@
 import io.flutter.plugin.common.PluginRegistry;
 import java.io.File;
 import java.io.IOException;
+import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
 import java.util.UUID;
@@ -75,6 +76,7 @@ public class ImagePickerDelegate
   @VisibleForTesting static final int REQUEST_CODE_CHOOSE_IMAGE_FROM_GALLERY = 2342;
   @VisibleForTesting static final int REQUEST_CODE_TAKE_IMAGE_WITH_CAMERA = 2343;
   @VisibleForTesting static final int REQUEST_CAMERA_IMAGE_PERMISSION = 2345;
+  @VisibleForTesting static final int REQUEST_CODE_CHOOSE_MULTI_IMAGE_FROM_GALLERY = 2346;
   @VisibleForTesting static final int REQUEST_CODE_CHOOSE_VIDEO_FROM_GALLERY = 2352;
   @VisibleForTesting static final int REQUEST_CODE_TAKE_VIDEO_WITH_CAMERA = 2353;
   @VisibleForTesting static final int REQUEST_CAMERA_VIDEO_PERMISSION = 2355;
@@ -315,13 +317,32 @@ public void chooseImageFromGallery(MethodCall methodCall, MethodChannel.Result r
     launchPickImageFromGalleryIntent();
   }
 
+  public void chooseMultiImageFromGallery(MethodCall methodCall, MethodChannel.Result result) {
+    if (!setPendingMethodCallAndResult(methodCall, result)) {
+      finishWithAlreadyActiveError(result);
+      return;
+    }
+
+    launchMultiPickImageFromGalleryIntent();
+  }
+
   private void launchPickImageFromGalleryIntent() {
     Intent pickImageIntent = new Intent(Intent.ACTION_GET_CONTENT);
     pickImageIntent.setType("image/*");
 
     activity.startActivityForResult(pickImageIntent, REQUEST_CODE_CHOOSE_IMAGE_FROM_GALLERY);
   }
 
+  private void launchMultiPickImageFromGalleryIntent() {
+    Intent pickImageIntent = new Intent(Intent.ACTION_GET_CONTENT);
+    if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.JELLY_BEAN_MR2) {
+      pickImageIntent.putExtra(Intent.EXTRA_ALLOW_MULTIPLE, true);
+    }
+    pickImageIntent.setType("image/*");
+
+    activity.startActivityForResult(pickImageIntent, REQUEST_CODE_CHOOSE_MULTI_IMAGE_FROM_GALLERY);
+  }
+
   public void takeImageWithCamera(MethodCall methodCall, MethodChannel.Result result) {
     if (!setPendingMethodCallAndResult(methodCall, result)) {
       finishWithAlreadyActiveError(result);
@@ -440,6 +461,9 @@ public boolean onActivityResult(int requestCode, int resultCode, Intent data) {
       case REQUEST_CODE_CHOOSE_IMAGE_FROM_GALLERY:
         handleChooseImageResult(resultCode, data);
         break;
+      case REQUEST_CODE_CHOOSE_MULTI_IMAGE_FROM_GALLERY:
+        handleChooseMultiImageResult(resultCode, data);
+        break;
       case REQUEST_CODE_TAKE_IMAGE_WITH_CAMERA:
         handleCaptureImageResult(resultCode);
         break;
@@ -467,6 +491,24 @@ private void handleChooseImageResult(int resultCode, Intent data) {
     finishWithSuccess(null);
   }
 
+  private void handleChooseMultiImageResult(int resultCode, Intent intent) {
+    if (resultCode == Activity.RESULT_OK && intent != null) {
+      ArrayList<String> paths = new ArrayList<>();
+      if (intent.getClipData() != null) {
+        for (int i = 0; i < intent.getClipData().getItemCount(); i++) {
+          paths.add(fileUtils.getPathFromUri(activity, intent.getClipData().getItemAt(i).getUri()));
+        }
+      } else {
+        paths.add(fileUtils.getPathFromUri(activity, intent.getData()));
+      }
+      handleMultiImageResult(paths, false);
+      return;
+    }
+
+    // User cancelled choosing a picture.
+    finishWithSuccess(null);
+  }
+
   private void handleChooseVideoResult(int resultCode, Intent data) {
     if (resultCode == Activity.RESULT_OK && data != null) {
       String path = fileUtils.getPathFromUri(activity, data.getData());
@@ -516,26 +558,45 @@ public void onPathReady(String path) {
     finishWithSuccess(null);
   }
 
-  private void handleImageResult(String path, boolean shouldDeleteOriginalIfScaled) {
+  private void handleMultiImageResult(
+      ArrayList<String> paths, boolean shouldDeleteOriginalIfScaled) {
     if (methodCall != null) {
-      Double maxWidth = methodCall.argument("maxWidth");
-      Double maxHeight = methodCall.argument("maxHeight");
-      Integer imageQuality = methodCall.argument("imageQuality");
-
-      String finalImagePath =
-          imageResizer.resizeImageIfNeeded(path, maxWidth, maxHeight, imageQuality);
-
-      finishWithSuccess(finalImagePath);
+      for (int i = 0; i < paths.size(); i++) {
+        String finalImagePath = getResizedImagePath(paths.get(i));
+
+        //delete original file if scaled
+        if (finalImagePath != null
+            && !finalImagePath.equals(paths.get(i))
+            && shouldDeleteOriginalIfScaled) {
+          new File(paths.get(i)).delete();
+        }
+        paths.set(i, finalImagePath);
+      }
+      finishWithListSuccess(paths);
+    }
+  }
 
+  private void handleImageResult(String path, boolean shouldDeleteOriginalIfScaled) {
+    if (methodCall != null) {
+      String finalImagePath = getResizedImagePath(path);
       //delete original file if scaled
       if (finalImagePath != null && !finalImagePath.equals(path) && shouldDeleteOriginalIfScaled) {
         new File(path).delete();
       }
+      finishWithSuccess(finalImagePath);
     } else {
       finishWithSuccess(path);
     }
   }
 
+  private String getResizedImagePath(String path) {
+    Double maxWidth = methodCall.argument("maxWidth");
+    Double maxHeight = methodCall.argument("maxHeight");
+    Integer imageQuality = methodCall.argument("imageQuality");
+
+    return imageResizer.resizeImageIfNeeded(path, maxWidth, maxHeight, imageQuality);
+  }
+
   private void handleVideoResult(String path) {
     finishWithSuccess(path);
   }
@@ -564,6 +625,17 @@ private void finishWithSuccess(String imagePath) {
     clearMethodCallAndResult();
   }
 
+  private void finishWithListSuccess(ArrayList<String> imagePaths) {
+    if (pendingResult == null) {
+      for (String imagePath : imagePaths) {
+        cache.saveResult(imagePath, null, null);
+      }
+      return;
+    }
+    pendingResult.success(imagePaths);
+    clearMethodCallAndResult();
+  }
+
   private void finishWithAlreadyActiveError(MethodChannel.Result result) {
     result.error("already_active", "Image picker is already active", null);
   }

packages/image_picker/image_picker/android/src/main/java/io/flutter/plugins/imagepicker/ImagePickerPlugin.java

@@ -91,6 +91,7 @@ public void onActivityStopped(Activity activity) {
   }
 
   static final String METHOD_CALL_IMAGE = "pickImage";
+  static final String METHOD_CALL_MULTI_IMAGE = "pickMultiImage";
   static final String METHOD_CALL_VIDEO = "pickVideo";
   private static final String METHOD_CALL_RETRIEVE = "retrieve";
   private static final int CAMERA_DEVICE_FRONT = 1;
@@ -302,6 +303,9 @@ public void onMethodCall(MethodCall call, MethodChannel.Result rawResult) {
             throw new IllegalArgumentException("Invalid image source: " + imageSource);
         }
         break;
+      case METHOD_CALL_MULTI_IMAGE:
+        delegate.chooseMultiImageFromGallery(call, result);
+        break;
       case METHOD_CALL_VIDEO:
         imageSource = call.argument("source");
         switch (imageSource) {

packages/image_picker/image_picker/example/android/app/src/test/java/io/flutter/plugins/imagepicker/ImagePickerDelegateTest.java

@@ -104,6 +104,15 @@ public void chooseImageFromGallery_WhenPendingResultExists_FinishesWithAlreadyAc
   }
 
   @Test
+  public void chooseMultiImageFromGallery_WhenPendingResultExists_FinishesWithAlreadyActiveError() {
+    ImagePickerDelegate delegate = createDelegateWithPendingResultAndMethodCall();
+
+    delegate.chooseMultiImageFromGallery(mockMethodCall, mockResult);
+
+    verifyFinishedWithAlreadyActiveError();
+    verifyNoMoreInteractions(mockResult);
+  }
+
   public void
       chooseImageFromGallery_WhenHasExternalStoragePermission_LaunchesChooseFromGalleryIntent() {
     when(mockPermissionManager.isPermissionGranted(Manifest.permission.READ_EXTERNAL_STORAGE))

packages/image_picker/image_picker/example/android/app/src/test/java/io/flutter/plugins/imagepicker/ImagePickerPluginTest.java

@@ -32,6 +32,7 @@ public class ImagePickerPluginTest {
   private static final int SOURCE_CAMERA = 0;
   private static final int SOURCE_GALLERY = 1;
   private static final String PICK_IMAGE = "pickImage";
+  private static final String PICK_MULTI_IMAGE = "pickMultiImage";
   private static final String PICK_VIDEO = "pickVideo";
 
   @Rule public ExpectedException exception = ExpectedException.none();
@@ -92,6 +93,14 @@ public void onMethodCall_WhenSourceIsGallery_InvokesChooseImageFromGallery() {
     verifyZeroInteractions(mockResult);
   }
 
+  @Test
+  public void onMethodCall_InvokesChooseMultiImageFromGallery() {
+    MethodCall call = buildMethodCall(PICK_MULTI_IMAGE);
+    plugin.onMethodCall(call, mockResult);
+    verify(mockImagePickerDelegate).chooseMultiImageFromGallery(eq(call), any());
+    verifyZeroInteractions(mockResult);
+  }
+
   @Test
   public void onMethodCall_WhenSourceIsCamera_InvokesTakeImageWithCamera() {
     MethodCall call = buildMethodCall(PICK_IMAGE, SOURCE_CAMERA);
@@ -173,4 +182,8 @@ private MethodCall buildMethodCall(String method, final int source) {
 
     return new MethodCall(method, arguments);
   }
+
+  private MethodCall buildMethodCall(String method) {
+    return new MethodCall(method, null);
+  }
 }

packages/image_picker/image_picker/example/ios/RunnerTests/ImagePickerPluginTests.m

@@ -22,7 +22,7 @@ - (UIViewController *)presentedViewController {
 
 @interface FLTImagePickerPlugin (Test)
 @property(copy, nonatomic) FlutterResult result;
-- (void)handleSavedPath:(NSString *)path;
+- (void)handleSavedPathList:(NSMutableArray *)pathList;
 - (void)imagePickerControllerDidCancel:(UIImagePickerController *)picker;
 @end
 
@@ -122,21 +122,6 @@ - (void)testPickingVideoWithDuration {
   XCTAssertEqual([plugin getImagePickerController].videoMaximumDuration, 95);
 }
 
-- (void)testPluginPickImageSelectMultipleTimes {
-  FLTImagePickerPlugin *plugin = [FLTImagePickerPlugin new];
-  FlutterMethodCall *call =
-      [FlutterMethodCall methodCallWithMethodName:@"pickImage"
-                                        arguments:@{@"source" : @(0), @"cameraDevice" : @(0)}];
-  [plugin handleMethodCall:call
-                    result:^(id _Nullable r){
-                    }];
-  plugin.result = ^(id result) {
-
-  };
-  [plugin handleSavedPath:@"test"];
-  [plugin handleSavedPath:@"test"];
-}
-
 - (void)testViewController {
   UIWindow *window = [UIWindow new];
   MockViewController *vc1 = [MockViewController new];
@@ -149,4 +134,62 @@ - (void)testViewController {
   XCTAssertEqual([plugin viewControllerWithWindow:window], vc2);
 }
 
+- (void)testPluginMultiImagePathIsNil {
+  FLTImagePickerPlugin *plugin = [FLTImagePickerPlugin new];
+
+  dispatch_semaphore_t resultSemaphore = dispatch_semaphore_create(0);
+  __block FlutterError *pickImageResult = nil;
+
+  plugin.result = ^(id _Nullable r) {
+    pickImageResult = r;
+    dispatch_semaphore_signal(resultSemaphore);
+  };
+  [plugin handleSavedPathList:nil];
+
+  dispatch_semaphore_wait(resultSemaphore, DISPATCH_TIME_FOREVER);
+
+  XCTAssertEqualObjects(pickImageResult.code, @"create_error");
+}
+
+- (void)testPluginMultiImagePathHasNullItem {
+  FLTImagePickerPlugin *plugin = [FLTImagePickerPlugin new];
+  NSMutableArray *pathList = [NSMutableArray new];
+
+  [pathList addObject:[NSNull null]];
+
+  dispatch_semaphore_t resultSemaphore = dispatch_semaphore_create(0);
+  __block FlutterError *pickImageResult = nil;
+
+  plugin.result = ^(id _Nullable r) {
+    pickImageResult = r;
+    dispatch_semaphore_signal(resultSemaphore);
+  };
+  [plugin handleSavedPathList:pathList];
+
+  dispatch_semaphore_wait(resultSemaphore, DISPATCH_TIME_FOREVER);
+
+  XCTAssertEqualObjects(pickImageResult.code, @"create_error");
+}
+
+- (void)testPluginMultiImagePathHasItem {
+  FLTImagePickerPlugin *plugin = [FLTImagePickerPlugin new];
+  NSString *savedPath = @"test";
+  NSMutableArray *pathList = [NSMutableArray new];
+
+  [pathList addObject:savedPath];
+
+  dispatch_semaphore_t resultSemaphore = dispatch_semaphore_create(0);
+  __block id pickImageResult = nil;
+
+  plugin.result = ^(id _Nullable r) {
+    pickImageResult = r;
+    dispatch_semaphore_signal(resultSemaphore);
+  };
+  [plugin handleSavedPathList:pathList];
+
+  dispatch_semaphore_wait(resultSemaphore, DISPATCH_TIME_FOREVER);
+
+  XCTAssertEqual(pickImageResult, pathList);
+}
+
 @end