[image_picker] add requestFullMetadata for iOS (optional permissions)

packages/image_picker/image_picker/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.8.6
+
+* Adds `requestFullMetadata` option to `pickImage`, so images on iOS can be picked without `Photo Library Usage` permission.
+
 ## 0.8.5
 
 * Moves Android and iOS implementations to federated packages.

packages/image_picker/image_picker/example/pubspec.yaml

@@ -28,3 +28,9 @@ dev_dependencies:
 
 flutter:
   uses-material-design: true
+
+# FOR TESTING ONLY. DO NOT MERGE.
+dependency_overrides:
+  image_picker_platform_interface:
+    path:
+      ../../image_picker_platform_interface

packages/image_picker/image_picker/lib/image_picker.dart

@@ -191,6 +191,10 @@ class ImagePicker {
   /// the front or rear camera should be opened, this function is not guaranteed
   /// to work on an Android device.
   ///
+  /// Use `requestFullMetadata` (defaults to `true`) to control how much additional information the plugin tries to get.
+  /// If `requestFullMetadata` is set to `true`, the plugin tries to get the full image metadata which may require
+  /// extra permission requests on some platforms, such as `Photo Library Usage` permission on iOS .
+  ///
   /// In Android, the MainActivity can be destroyed for various reasons. If that happens, the result will be lost
   /// in this call. You can then call [retrieveLostData] when your app relaunches to retrieve the lost data.
   ///
@@ -206,13 +210,15 @@ class ImagePicker {
     double? maxHeight,
     int? imageQuality,
     CameraDevice preferredCameraDevice = CameraDevice.rear,
+    bool requestFullMetadata = true,
   }) {
-    return platform.getImage(
+    return platform.getImageFromSource(
       source: source,
       maxWidth: maxWidth,
       maxHeight: maxHeight,
       imageQuality: imageQuality,
       preferredCameraDevice: preferredCameraDevice,
+      requestFullMetadata: requestFullMetadata,
     );
   }
 

packages/image_picker/image_picker/pubspec.yaml

@@ -32,3 +32,9 @@ dev_dependencies:
     sdk: flutter
   mockito: ^5.0.0
   plugin_platform_interface: ^2.0.0
+
+# FOR TESTING ONLY. DO NOT MERGE.
+dependency_overrides:
+  image_picker_platform_interface:
+    path:
+      ../image_picker_platform_interface

packages/image_picker/image_picker/test/image_picker_deprecated_test.dart

@@ -57,14 +57,16 @@ void main() {
                 'maxWidth': null,
                 'maxHeight': null,
                 'imageQuality': null,
-                'cameraDevice': 0
+                'cameraDevice': 0,
+                'requestFullMetadata': true,
               }),
               isMethodCall('pickImage', arguments: <String, dynamic>{
                 'source': 1,
                 'maxWidth': null,
                 'maxHeight': null,
                 'imageQuality': null,
-                'cameraDevice': 0
+                'cameraDevice': 0,
+                'requestFullMetadata': true,
               }),
             ],
           );
@@ -103,49 +105,56 @@ void main() {
                 'maxWidth': null,
                 'maxHeight': null,
                 'imageQuality': null,
-                'cameraDevice': 0
+                'cameraDevice': 0,
+                'requestFullMetadata': true,
               }),
               isMethodCall('pickImage', arguments: <String, dynamic>{
                 'source': 0,
                 'maxWidth': 10.0,
                 'maxHeight': null,
                 'imageQuality': null,
-                'cameraDevice': 0
+                'cameraDevice': 0,
+                'requestFullMetadata': true,
               }),
               isMethodCall('pickImage', arguments: <String, dynamic>{
                 'source': 0,
                 'maxWidth': null,
                 'maxHeight': 10.0,
                 'imageQuality': null,
-                'cameraDevice': 0
+                'cameraDevice': 0,
+                'requestFullMetadata': true,
               }),
               isMethodCall('pickImage', arguments: <String, dynamic>{
                 'source': 0,
                 'maxWidth': 10.0,
                 'maxHeight': 20.0,
                 'imageQuality': null,
-                'cameraDevice': 0
+                'cameraDevice': 0,
+                'requestFullMetadata': true,
               }),
               isMethodCall('pickImage', arguments: <String, dynamic>{
                 'source': 0,
                 'maxWidth': 10.0,
                 'maxHeight': null,
                 'imageQuality': 70,
-                'cameraDevice': 0
+                'cameraDevice': 0,
+                'requestFullMetadata': true,
               }),
               isMethodCall('pickImage', arguments: <String, dynamic>{
                 'source': 0,
                 'maxWidth': null,
                 'maxHeight': 10.0,
                 'imageQuality': 70,
-                'cameraDevice': 0
+                'cameraDevice': 0,
+                'requestFullMetadata': true,
               }),
               isMethodCall('pickImage', arguments: <String, dynamic>{
                 'source': 0,
                 'maxWidth': 10.0,
                 'maxHeight': 20.0,
                 'imageQuality': 70,
-                'cameraDevice': 0
+                'cameraDevice': 0,
+                'requestFullMetadata': true,
               }),
             ],
           );
@@ -182,6 +191,7 @@ void main() {
                 'maxHeight': null,
                 'imageQuality': null,
                 'cameraDevice': 0,
+                'requestFullMetadata': true,
               }),
             ],
           );
@@ -201,6 +211,7 @@ void main() {
                 'maxHeight': null,
                 'imageQuality': null,
                 'cameraDevice': 1,
+                'requestFullMetadata': true,
               }),
             ],
           );

packages/image_picker/image_picker/test/image_picker_test.dart

@@ -52,14 +52,16 @@ void main() {
                 'maxWidth': null,
                 'maxHeight': null,
                 'imageQuality': null,
-                'cameraDevice': 0
+                'cameraDevice': 0,
+                'requestFullMetadata': true,
               }),
               isMethodCall('pickImage', arguments: <String, dynamic>{
                 'source': 1,
                 'maxWidth': null,
                 'maxHeight': null,
                 'imageQuality': null,
-                'cameraDevice': 0
+                'cameraDevice': 0,
+                'requestFullMetadata': true,
               }),
             ],
           );
@@ -98,49 +100,56 @@ void main() {
                 'maxWidth': null,
                 'maxHeight': null,
                 'imageQuality': null,
-                'cameraDevice': 0
+                'cameraDevice': 0,
+                'requestFullMetadata': true,
               }),
               isMethodCall('pickImage', arguments: <String, dynamic>{
                 'source': 0,
                 'maxWidth': 10.0,
                 'maxHeight': null,
                 'imageQuality': null,
-                'cameraDevice': 0
+                'cameraDevice': 0,
+                'requestFullMetadata': true,
               }),
               isMethodCall('pickImage', arguments: <String, dynamic>{
                 'source': 0,
                 'maxWidth': null,
                 'maxHeight': 10.0,
                 'imageQuality': null,
-                'cameraDevice': 0
+                'cameraDevice': 0,
+                'requestFullMetadata': true,
               }),
               isMethodCall('pickImage', arguments: <String, dynamic>{
                 'source': 0,
                 'maxWidth': 10.0,
                 'maxHeight': 20.0,
                 'imageQuality': null,
-                'cameraDevice': 0
+                'cameraDevice': 0,
+                'requestFullMetadata': true,
               }),
               isMethodCall('pickImage', arguments: <String, dynamic>{
                 'source': 0,
                 'maxWidth': 10.0,
                 'maxHeight': null,
                 'imageQuality': 70,
-                'cameraDevice': 0
+                'cameraDevice': 0,
+                'requestFullMetadata': true,
               }),
               isMethodCall('pickImage', arguments: <String, dynamic>{
                 'source': 0,
                 'maxWidth': null,
                 'maxHeight': 10.0,
                 'imageQuality': 70,
-                'cameraDevice': 0
+                'cameraDevice': 0,
+                'requestFullMetadata': true,
               }),
               isMethodCall('pickImage', arguments: <String, dynamic>{
                 'source': 0,
                 'maxWidth': 10.0,
                 'maxHeight': 20.0,
                 'imageQuality': 70,
-                'cameraDevice': 0
+                'cameraDevice': 0,
+                'requestFullMetadata': true,
               }),
             ],
           );
@@ -177,6 +186,7 @@ void main() {
                 'maxHeight': null,
                 'imageQuality': null,
                 'cameraDevice': 0,
+                'requestFullMetadata': true,
               }),
             ],
           );
@@ -196,6 +206,26 @@ void main() {
                 'maxHeight': null,
                 'imageQuality': null,
                 'cameraDevice': 1,
+                'requestFullMetadata': true,
+              }),
+            ],
+          );
+        });
+
+        test('passes the full metadata argument correctly', () async {
+          await picker.pickImage(
+              source: ImageSource.camera, requestFullMetadata: false);
+
+          expect(
+            log,
+            <Matcher>[
+              isMethodCall('pickImage', arguments: <String, dynamic>{
+                'source': 0,
+                'maxWidth': null,
+                'maxHeight': null,
+                'imageQuality': null,
+                'cameraDevice': 0,
+                'requestFullMetadata': false,
               }),
             ],
           );

packages/image_picker/image_picker_android/pubspec.yaml

@@ -26,3 +26,9 @@ dev_dependencies:
   flutter_test:
     sdk: flutter
   mockito: ^5.0.0
+
+# FOR TESTING ONLY. DO NOT MERGE.
+dependency_overrides:
+  image_picker_platform_interface:
+    path:
+      ../image_picker_platform_interface

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

@@ -180,6 +180,27 @@ - (void)testPickMultiImageShouldUseUIImagePickerControllerOnPreiOS14 {
             [mockUIImagePicker setSourceType:UIImagePickerControllerSourceTypePhotoLibrary]);
 }
 
+- (void)testPickImageWithoutFullMetadataPreiOS14 {
+  if (@available(iOS 14, *)) {
+    return;
+  }
+  id mockUIImagePicker = OCMClassMock([UIImagePickerController class]);
+  FLTImagePickerPlugin *plugin = [FLTImagePickerPlugin new];
+  [plugin setImagePickerControllerOverrides:@[ mockUIImagePicker ]];
+  FlutterMethodCall *call = [FlutterMethodCall methodCallWithMethodName:@"pickImage"
+                                                              arguments:@{
+                                                                @"source" : @(1),
+                                                                @"requestFullMetadata" : @(false),
+                                                              }];
+
+  [plugin handleMethodCall:call
+                    result:^(id _Nullable r){
+                    }];
+
+  OCMVerify(times(1),
+            [mockUIImagePicker setSourceType:UIImagePickerControllerSourceTypePhotoLibrary]);
+}
+
 #pragma mark - Test camera devices, no op on simulators
 
 - (void)testPluginPickImageDeviceCancelClickMultipleTimes {

packages/image_picker/image_picker_ios/ios/Classes/FLTImagePickerPlugin.m

@@ -133,7 +133,12 @@ - (void)pickImageWithPHPicker:(int)maxImagesAllowed API_AVAILABLE(ios(14)) {
 
   self.maxImagesAllowed = maxImagesAllowed;
 
-  [self checkPhotoAuthorizationForAccessLevel];
+  BOOL usePHAsset = [[_arguments objectForKey:@"requestFullMetadata"] boolValue];
+  if (usePHAsset) {
+    [self checkPhotoAuthorizationForAccessLevel];
+  } else {
+    [self showPhotoLibraryWithPHPicker:_pickerViewController];
+  }
 }
 
 - (void)launchUIImagePickerWithSource:(int)imageSource {
@@ -142,14 +147,24 @@ - (void)launchUIImagePickerWithSource:(int)imageSource {
   imagePickerController.delegate = self;
   imagePickerController.mediaTypes = @[ (NSString *)kUTTypeImage ];
 
+  BOOL usePHAsset = [[_arguments objectForKey:@"requestFullMetadata"] boolValue];
   self.maxImagesAllowed = 1;
 
   switch (imageSource) {
     case SOURCE_CAMERA:
       [self checkCameraAuthorizationWithImagePicker:imagePickerController];
       break;
     case SOURCE_GALLERY:
-      [self checkPhotoAuthorizationWithImagePicker:imagePickerController];
+      if (@available(iOS 11, *)) {
+        if (usePHAsset) {
+          [self checkPhotoAuthorizationWithImagePicker:imagePickerController];
+        } else {
+          [self showPhotoLibraryWithImagePicker:imagePickerController];
+        }
+      } else {
+        // Prior to iOS 11, accessing gallery requires authorization
+        [self checkPhotoAuthorizationWithImagePicker:imagePickerController];
+      }
       break;
     default:
       self.result([FlutterError errorWithCode:@"invalid_source"
@@ -172,7 +187,6 @@ - (void)handleMethodCall:(FlutterMethodCall *)call result:(FlutterResult)result
 
   if ([@"pickImage" isEqualToString:call.method]) {
     int imageSource = [call.arguments[@"source"] intValue];
-
     if (imageSource == SOURCE_GALLERY) {  // Capture is not possible with PHPicker
       if (@available(iOS 14, *)) {
         // PHPicker is used
@@ -206,12 +220,17 @@ - (void)handleMethodCall:(FlutterMethodCall *)call result:(FlutterResult)result
       imagePickerController.videoMaximumDuration = max;
     }
 
+    BOOL usePHAsset = [[_arguments objectForKey:@"requestFullMetadata"] boolValue];
     switch (imageSource) {
       case SOURCE_CAMERA:
         [self checkCameraAuthorizationWithImagePicker:imagePickerController];
         break;
       case SOURCE_GALLERY:
-        [self checkPhotoAuthorizationWithImagePicker:imagePickerController];
+        if (usePHAsset) {
+          [self checkPhotoAuthorizationWithImagePicker:imagePickerController];
+        } else {
+          [self showPhotoLibraryWithImagePicker:imagePickerController];
+        }
         break;
       default:
         result([FlutterError errorWithCode:@"invalid_source"
@@ -515,8 +534,12 @@ - (void)imagePickerController:(UIImagePickerController *)picker
     NSNumber *maxHeight = GetNullableValueForKey(_arguments, @"maxHeight");
     NSNumber *imageQuality = GetNullableValueForKey(_arguments, @"imageQuality");
     NSNumber *desiredImageQuality = [self getDesiredImageQuality:imageQuality];
+    BOOL usePHAsset = [[_arguments objectForKey:@"requestFullMetadata"] boolValue];
 
-    PHAsset *originalAsset = [FLTImagePickerPhotoAssetUtil getAssetFromImagePickerInfo:info];
+    PHAsset *originalAsset;
+    if (usePHAsset) {
+      originalAsset = [FLTImagePickerPhotoAssetUtil getAssetFromImagePickerInfo:info];
+    }
 
     if (maxWidth != nil || maxHeight != nil) {
       image = [FLTImagePickerImageUtil scaledImage:image