[image_picker] add requestFullMetadata for iOS (optional permissions)

packages/image_picker/image_picker/CHANGELOG.md

@@ -1,7 +1,7 @@
-## NEXT
-
+## 0.8.5
 * Updates Android compileSdkVersion to 31.
 * Fix iOS RunnerUITests search paths.
+* Adds `forceFullMetadata` option to `pickImage`, so images on iOS can be picked without `Photo Library Usage` permission.
 
 ## 0.8.4+4
 

packages/image_picker/image_picker/lib/image_picker.dart

@@ -191,6 +191,13 @@ class ImagePicker {
   /// the front or rear camera should be opened, this function is not guaranteed
   /// to work on an Android device.
   ///
+  /// Use `forceFullMetadata` (defaults to `true`) to control, how much additional information the plugin tries to get on iOS.
+  /// If `forceFullMetadata` is set to `true`, the plugin tries to get the full image metadata which may require
+  /// extra permission requests.
+  /// If `forceFullMetadata` is set to `false`, the plugin fetches the image in a way that reduces permission requests
+  /// from the iOS platform (it won’t ask for the `Photo Library Usage` permission).
+  ///
+  ///
   /// 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 +213,15 @@ class ImagePicker {
     double? maxHeight,
     int? imageQuality,
     CameraDevice preferredCameraDevice = CameraDevice.rear,
+    bool forceFullMetadata = true,
   }) {
-    return platform.getImage(
+    return platform.getImageFromSource(
       source: source,
       maxWidth: maxWidth,
       maxHeight: maxHeight,
       imageQuality: imageQuality,
       preferredCameraDevice: preferredCameraDevice,
+      forceFullMetadata: forceFullMetadata,
     );
   }
 

packages/image_picker/image_picker/pubspec.yaml

@@ -3,7 +3,7 @@ description: Flutter plugin for selecting images from the Android and iOS image
   library, and taking new pictures with the camera.
 repository: https://github.com/flutter/plugins/tree/master/packages/image_picker/image_picker
 issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+image_picker%22
-version: 0.8.4+4
+version: 0.8.5
 
 environment:
   sdk: ">=2.14.0 <3.0.0"
@@ -33,3 +33,9 @@ dev_dependencies:
   mockito: ^5.0.0
   pedantic: ^1.10.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,
+                'forceFullMetadata': true,
               }),
               isMethodCall('pickImage', arguments: <String, dynamic>{
                 'source': 1,
                 'maxWidth': null,
                 'maxHeight': null,
                 'imageQuality': null,
-                'cameraDevice': 0
+                'cameraDevice': 0,
+                'forceFullMetadata': true,
               }),
             ],
           );
@@ -103,49 +105,56 @@ void main() {
                 'maxWidth': null,
                 'maxHeight': null,
                 'imageQuality': null,
-                'cameraDevice': 0
+                'cameraDevice': 0,
+                'forceFullMetadata': true,
               }),
               isMethodCall('pickImage', arguments: <String, dynamic>{
                 'source': 0,
                 'maxWidth': 10.0,
                 'maxHeight': null,
                 'imageQuality': null,
-                'cameraDevice': 0
+                'cameraDevice': 0,
+                'forceFullMetadata': true,
               }),
               isMethodCall('pickImage', arguments: <String, dynamic>{
                 'source': 0,
                 'maxWidth': null,
                 'maxHeight': 10.0,
                 'imageQuality': null,
-                'cameraDevice': 0
+                'cameraDevice': 0,
+                'forceFullMetadata': true,
               }),
               isMethodCall('pickImage', arguments: <String, dynamic>{
                 'source': 0,
                 'maxWidth': 10.0,
                 'maxHeight': 20.0,
                 'imageQuality': null,
-                'cameraDevice': 0
+                'cameraDevice': 0,
+                'forceFullMetadata': true,
               }),
               isMethodCall('pickImage', arguments: <String, dynamic>{
                 'source': 0,
                 'maxWidth': 10.0,
                 'maxHeight': null,
                 'imageQuality': 70,
-                'cameraDevice': 0
+                'cameraDevice': 0,
+                'forceFullMetadata': true,
               }),
               isMethodCall('pickImage', arguments: <String, dynamic>{
                 'source': 0,
                 'maxWidth': null,
                 'maxHeight': 10.0,
                 'imageQuality': 70,
-                'cameraDevice': 0
+                'cameraDevice': 0,
+                'forceFullMetadata': true,
               }),
               isMethodCall('pickImage', arguments: <String, dynamic>{
                 'source': 0,
                 'maxWidth': 10.0,
                 'maxHeight': 20.0,
                 'imageQuality': 70,
-                'cameraDevice': 0
+                'cameraDevice': 0,
+                'forceFullMetadata': true,
               }),
             ],
           );
@@ -182,6 +191,7 @@ void main() {
                 'maxHeight': null,
                 'imageQuality': null,
                 'cameraDevice': 0,
+                'forceFullMetadata': true,
               }),
             ],
           );
@@ -201,6 +211,7 @@ void main() {
                 'maxHeight': null,
                 'imageQuality': null,
                 'cameraDevice': 1,
+                'forceFullMetadata': 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,
+                'forceFullMetadata': true,
               }),
               isMethodCall('pickImage', arguments: <String, dynamic>{
                 'source': 1,
                 'maxWidth': null,
                 'maxHeight': null,
                 'imageQuality': null,
-                'cameraDevice': 0
+                'cameraDevice': 0,
+                'forceFullMetadata': true,
               }),
             ],
           );
@@ -98,49 +100,56 @@ void main() {
                 'maxWidth': null,
                 'maxHeight': null,
                 'imageQuality': null,
-                'cameraDevice': 0
+                'cameraDevice': 0,
+                'forceFullMetadata': true,
               }),
               isMethodCall('pickImage', arguments: <String, dynamic>{
                 'source': 0,
                 'maxWidth': 10.0,
                 'maxHeight': null,
                 'imageQuality': null,
-                'cameraDevice': 0
+                'cameraDevice': 0,
+                'forceFullMetadata': true,
               }),
               isMethodCall('pickImage', arguments: <String, dynamic>{
                 'source': 0,
                 'maxWidth': null,
                 'maxHeight': 10.0,
                 'imageQuality': null,
-                'cameraDevice': 0
+                'cameraDevice': 0,
+                'forceFullMetadata': true,
               }),
               isMethodCall('pickImage', arguments: <String, dynamic>{
                 'source': 0,
                 'maxWidth': 10.0,
                 'maxHeight': 20.0,
                 'imageQuality': null,
-                'cameraDevice': 0
+                'cameraDevice': 0,
+                'forceFullMetadata': true,
               }),
               isMethodCall('pickImage', arguments: <String, dynamic>{
                 'source': 0,
                 'maxWidth': 10.0,
                 'maxHeight': null,
                 'imageQuality': 70,
-                'cameraDevice': 0
+                'cameraDevice': 0,
+                'forceFullMetadata': true,
               }),
               isMethodCall('pickImage', arguments: <String, dynamic>{
                 'source': 0,
                 'maxWidth': null,
                 'maxHeight': 10.0,
                 'imageQuality': 70,
-                'cameraDevice': 0
+                'cameraDevice': 0,
+                'forceFullMetadata': true,
               }),
               isMethodCall('pickImage', arguments: <String, dynamic>{
                 'source': 0,
                 'maxWidth': 10.0,
                 'maxHeight': 20.0,
                 'imageQuality': 70,
-                'cameraDevice': 0
+                'cameraDevice': 0,
+                'forceFullMetadata': true,
               }),
             ],
           );
@@ -177,6 +186,7 @@ void main() {
                 'maxHeight': null,
                 'imageQuality': null,
                 'cameraDevice': 0,
+                'forceFullMetadata': true,
               }),
             ],
           );
@@ -196,6 +206,26 @@ void main() {
                 'maxHeight': null,
                 'imageQuality': null,
                 'cameraDevice': 1,
+                'forceFullMetadata': true,
+              }),
+            ],
+          );
+        });
+
+        test('passes the full metadata argument correctly', () async {
+          await picker.pickImage(
+              source: ImageSource.camera, forceFullMetadata: false);
+
+          expect(
+            log,
+            <Matcher>[
+              isMethodCall('pickImage', arguments: <String, dynamic>{
+                'source': 0,
+                'maxWidth': null,
+                'maxHeight': null,
+                'imageQuality': null,
+                'cameraDevice': 0,
+                'forceFullMetadata': false,
               }),
             ],
           );

packages/image_picker/image_picker_platform_interface/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 2.5.0
+
+* Re-adding `forceFullMetadata` option, but as a parameter of a new `pickImageFromSource` 
+  method (non-breaking change approach).
+
 ## 2.4.3
 
 * Removes dependency on `meta`.

packages/image_picker/image_picker_platform_interface/lib/src/method_channel/method_channel_image_picker.dart

@@ -85,6 +85,7 @@ class MethodChannelImagePicker extends ImagePickerPlatform {
     double? maxHeight,
     int? imageQuality,
     CameraDevice preferredCameraDevice = CameraDevice.rear,
+    bool forceFullMetadata = true,
   }) {
     if (imageQuality != null && (imageQuality < 0 || imageQuality > 100)) {
       throw ArgumentError.value(
@@ -106,7 +107,8 @@ class MethodChannelImagePicker extends ImagePickerPlatform {
         'maxWidth': maxWidth,
         'maxHeight': maxHeight,
         'imageQuality': imageQuality,
-        'cameraDevice': preferredCameraDevice.index
+        'cameraDevice': preferredCameraDevice.index,
+        'forceFullMetadata': forceFullMetadata,
       },
     );
   }
@@ -270,4 +272,24 @@ class MethodChannelImagePicker extends ImagePickerPlatform {
       files: pickedFileList,
     );
   }
+
+  @override
+  Future<XFile?> getImageFromSource({
+    required ImageSource source,
+    double? maxWidth,
+    double? maxHeight,
+    int? imageQuality,
+    CameraDevice preferredCameraDevice = CameraDevice.rear,
+    bool forceFullMetadata = true,
+  }) async {
+    String? path = await _getImagePath(
+      source: source,
+      maxWidth: maxWidth,
+      maxHeight: maxHeight,
+      imageQuality: imageQuality,
+      preferredCameraDevice: preferredCameraDevice,
+      forceFullMetadata: forceFullMetadata,
+    );
+    return path != null ? XFile(path) : null;
+  }
 }

packages/image_picker/image_picker_platform_interface/lib/src/platform_interface/image_picker_platform.dart

@@ -146,6 +146,8 @@ abstract class ImagePickerPlatform extends PlatformInterface {
     throw UnimplementedError('retrieveLostData() has not been implemented.');
   }
 
+  /// This method is deprecated in favor of [getImageFromSource] and will be removed in a future update
+  ///
   /// Returns an [XFile] with the image that was picked.
   ///
   /// The `source` argument controls where the image comes from. This can
@@ -251,4 +253,54 @@ abstract class ImagePickerPlatform extends PlatformInterface {
   Future<LostDataResponse> getLostData() {
     throw UnimplementedError('getLostData() has not been implemented.');
   }
+
+  /// Returns an [XFile] with the image that was picked.
+  ///
+  /// The `source` argument controls where the image comes from. This can
+  /// be either [ImageSource.camera] or [ImageSource.gallery].
+  ///
+  /// Where iOS supports HEIC images, Android 8 and below doesn't. Android 9 and above only support HEIC images if used
+  /// in addition to a size modification, of which the usage is explained below.
+  ///
+  /// If specified, the image will be at most `maxWidth` wide and
+  /// `maxHeight` tall. Otherwise the image will be returned at it's
+  /// original width and height.
+  ///
+  /// The `imageQuality` argument modifies the quality of the image, ranging from 0-100
+  /// where 100 is the original/max quality. If `imageQuality` is null, the image with
+  /// the original quality will be returned. Compression is only supported for certain
+  /// image types such as JPEG. If compression is not supported for the image that is picked,
+  /// a warning message will be logged.
+  ///
+  /// Use `preferredCameraDevice` to specify the camera to use when the `source` is [ImageSource.camera].
+  /// The `preferredCameraDevice` is ignored when `source` is [ImageSource.gallery]. It is also ignored if the chosen camera is not supported on the device.
+  /// Defaults to [CameraDevice.rear]. Note that Android has no documented parameter for an intent to specify if
+  /// the front or rear camera should be opened, this function is not guaranteed
+  /// to work on an Android device.
+  ///
+  /// `forceFullMetadata` defaults to `true`, so the plugin tries to get the full image metadata which may require
+  /// extra permission requests on certain platforms.
+  /// If `forceFullMetadata` is set to `false`, the plugin fetches the image in a way that reduces permission requests
+  /// from the platform (e.g. on iOS the plugin won’t ask for the `NSPhotoLibraryUsageDescription` permission).
+  ///
+  /// 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 [getLostData] when your app relaunches to retrieve the lost data.
+  ///
+  /// If no images were picked, the return value is null.
+  Future<XFile?> getImageFromSource({
+    required ImageSource source,
+    double? maxWidth,
+    double? maxHeight,
+    int? imageQuality,
+    CameraDevice preferredCameraDevice = CameraDevice.rear,
+    bool forceFullMetadata = true,
+  }) {
+    return getImage(
+      source: source,
+      maxHeight: maxHeight,
+      maxWidth: maxWidth,
+      imageQuality: imageQuality,
+      preferredCameraDevice: preferredCameraDevice,
+    );
+  }
 }