Skip to content
This repository was archived by the owner on Feb 22, 2023. It is now read-only.

[image_picker] add requestFullMetadata for iOS (optional permissions) #5915

Merged
merged 63 commits into from
Oct 5, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
63 commits
Select commit Hold shift + click to select a range
5d3a9aa
Added new image picking method with flag for controlling metadata
PiotrMitkowski Jan 3, 2022
4195dca
Updated tests with cases for the new method
PiotrMitkowski Jan 3, 2022
7d255de
Updated changelog in platform interface and app-facing package to mat…
PiotrMitkowski Jan 3, 2022
3fd7383
Updated app-facing package to call new method from platform interface
PiotrMitkowski Jan 3, 2022
686bc22
Merge branch 'master' of github.com:flutter/plugins into ios-optional…
PiotrMitkowski Jan 12, 2022
1f73191
Fixed version in changelog file
PiotrMitkowski Jan 12, 2022
24d0679
Merge branch 'main' into ios-optional-permissions
PiotrMitkowski Jan 18, 2022
1ba0c73
Merge branch 'main' into ios-optional-permissions
PiotrMitkowski Jan 18, 2022
1084763
PR remarks
PiotrMitkowski Jan 24, 2022
a89ad0a
Renamed flag to better specify its purpose
PiotrMitkowski Jan 24, 2022
8ff7492
Renamed flag in remaining occurences
PiotrMitkowski Jan 24, 2022
193bbe9
Merge branch 'main' into ios-optional-permissions
PiotrMitkowski Jan 24, 2022
95eef20
Fixed formatting and originalAsset assignment
PiotrMitkowski Jan 24, 2022
e10b24e
Merge remote-tracking branch 'origin/ios-optional-permissions' into i…
PiotrMitkowski Jan 24, 2022
f2c2e68
Resolved merge conflicts
PiotrMitkowski Feb 1, 2022
f5f94b2
PR remarks
PiotrMitkowski Feb 14, 2022
97efdca
Merge branch 'main' of github.com:flutter/plugins into ios-optional-p…
PiotrMitkowski Feb 14, 2022
bd3dfeb
Fixed issues after merge
PiotrMitkowski Feb 14, 2022
b99ba07
Added a test for picking image without full metadata
PiotrMitkowski Feb 14, 2022
3d6c45c
Fixed code formatting
PiotrMitkowski Feb 14, 2022
b3e9166
Merge branch 'main' of github.com:flutter/plugins into ios-optional-p…
PiotrMitkowski Apr 7, 2022
bf3f55c
PR remarks
PiotrMitkowski Apr 7, 2022
742b259
Fixed linter warnings
PiotrMitkowski Apr 7, 2022
d41b390
Added dependency overrides for missing modules
PiotrMitkowski Apr 7, 2022
ead2f62
Fixed formatting
PiotrMitkowski Apr 7, 2022
7b6ace9
Added options class for handling image picking settings
PiotrMitkowski Apr 8, 2022
0f43653
Added missing license comment
PiotrMitkowski Apr 8, 2022
c6dcc49
Merge branch 'main' of github.com:flutter/plugins into ios-optional-p…
PiotrMitkowski Apr 13, 2022
9ba71b9
Merge branch 'main' of github.com:flutter/plugins into ios-optional-p…
PiotrMitkowski Apr 14, 2022
c1fc9da
PR remarks
PiotrMitkowski Apr 15, 2022
7f958a6
pbxproj version revert
PiotrMitkowski Apr 15, 2022
c825d09
PR remarks
PiotrMitkowski Apr 27, 2022
a2ca361
Merge branch 'main' of github.com:flutter/plugins into ios-optional-p…
PiotrMitkowski Apr 27, 2022
0120c47
Resolved merge conflicts
PiotrMitkowski Apr 27, 2022
0827c80
Generated Pigeon files for new API and metadata flag
PiotrMitkowski Apr 27, 2022
994e45f
Switched to use options object in private picking method
PiotrMitkowski Apr 28, 2022
9b39e31
Merge branch 'main' of github.com:flutter/plugins into ios-optional-p…
PiotrMitkowski Apr 28, 2022
933254e
Fixed failing unit tests
PiotrMitkowski Apr 28, 2022
66f14b2
Added missing tests for a new method and request full metadata parameter
PiotrMitkowski Apr 28, 2022
47098ec
Fixed failing native tests
PiotrMitkowski Apr 28, 2022
0a811d8
PR remarks
PiotrMitkowski Apr 29, 2022
0789a7b
Fixed linting
PiotrMitkowski Apr 29, 2022
c5966d4
Removed dependency overrides
PiotrMitkowski May 12, 2022
6f32405
Merge branch 'main' of github.com:flutter/plugins into ios-optional-p…
PiotrMitkowski May 12, 2022
217237b
PR remarks
PiotrMitkowski May 12, 2022
7a4d250
Fixed linter warnings and failing tests
PiotrMitkowski May 12, 2022
4ee04cb
Removed remaining dependency override
PiotrMitkowski May 12, 2022
b3fb220
Enforcing proper platform interface version having required API changes
PiotrMitkowski May 13, 2022
4d884de
Merge branch 'main' of github.com:flutter/plugins into ios-optional-p…
PiotrMitkowski May 13, 2022
c2240fa
Fixed failing test in app-facing plugin
PiotrMitkowski May 13, 2022
2fea4be
Merge branch 'main' of github.com:flutter/plugins into ios-optional-p…
PiotrMitkowski Sep 1, 2022
839b574
Added missing tests
PiotrMitkowski Sep 1, 2022
b0b1d1b
Fixed formatting and linter issues
PiotrMitkowski Sep 1, 2022
0c3fe02
Restored original interface version in Android example
PiotrMitkowski Sep 1, 2022
f9c8ea3
Fixed formatting in mocks
PiotrMitkowski Sep 1, 2022
24a504b
Fixed docs lines length
PiotrMitkowski Sep 1, 2022
f842d76
PR remarks
PiotrMitkowski Sep 5, 2022
b45b4e6
PR remarks
PiotrMitkowski Sep 5, 2022
e357c56
Merge branch 'main' of github.com:flutter/plugins into ios-optional-p…
PiotrMitkowski Sep 7, 2022
5567f8c
PR remarks
PiotrMitkowski Sep 7, 2022
58d6b10
Merge branch 'main' of github.com:flutter/plugins into ios-optional-p…
PiotrMitkowski Sep 20, 2022
f80f09d
Merge branch 'main' of github.com:flutter/plugins into ios-optional-p…
PiotrMitkowski Sep 21, 2022
39e8d37
Updated package with iOS implementation to fix a bug
PiotrMitkowski Sep 21, 2022
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion packages/image_picker/image_picker/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
## NEXT
## 0.8.6

* Updates minimum Flutter version to 2.10.
* Fixes avoid_redundant_argument_values lint warnings and minor typos.
* Adds `requestFullMetadata` option to `pickImage`, so images on iOS can be picked without `Photo Library Usage` permission.

## 0.8.5+3

Expand Down
1 change: 1 addition & 0 deletions packages/image_picker/image_picker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ As a result of implementing PHPicker it becomes impossible to pick HEIC images o
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.
* This permission is not required for image picking on iOS 11+ if you pass `false` for `requestFullMetadata`.
* `NSCameraUsageDescription` - describe why your app needs access to the camera. This is called _Privacy - Camera Usage Description_ in the visual editor.
* `NSMicrophoneUsageDescription` - describe why your app needs access to the microphone, if you intend to record videos. This is called _Privacy - Microphone Usage Description_ in the visual editor.

Expand Down
2 changes: 1 addition & 1 deletion packages/image_picker/image_picker/example/lib/main.dart
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ class _MyHomePageState extends State<MyHomePage> {
await _displayPickImageDialog(context!,
(double? maxWidth, double? maxHeight, int? quality) async {
try {
final List<XFile>? pickedFileList = await _picker.pickMultiImage(
final List<XFile> pickedFileList = await _picker.pickMultiImage(
maxWidth: maxWidth,
maxHeight: maxHeight,
imageQuality: quality,
Expand Down
70 changes: 48 additions & 22 deletions packages/image_picker/image_picker/lib/image_picker.dart
Original file line number Diff line number Diff line change
Expand Up @@ -173,23 +173,32 @@ class ImagePicker {
/// 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.
/// 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 and on Android PNG and WebP, too. 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.
/// image types such as JPEG and on Android PNG and WebP, too. 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.
///
/// 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.
Expand All @@ -206,6 +215,7 @@ class ImagePicker {
double? maxHeight,
int? imageQuality,
CameraDevice preferredCameraDevice = CameraDevice.rear,
bool requestFullMetadata = true,
}) {
if (imageQuality != null && (imageQuality < 0 || imageQuality > 100)) {
throw ArgumentError.value(
Expand All @@ -218,12 +228,15 @@ class ImagePicker {
throw ArgumentError.value(maxHeight, 'maxHeight', 'cannot be negative');
}

return platform.getImage(
return platform.getImageFromSource(
source: source,
maxWidth: maxWidth,
maxHeight: maxHeight,
imageQuality: imageQuality,
preferredCameraDevice: preferredCameraDevice,
options: ImagePickerOptions(
maxWidth: maxWidth,
maxHeight: maxHeight,
imageQuality: imageQuality,
preferredCameraDevice: preferredCameraDevice,
requestFullMetadata: requestFullMetadata,
),
);
}

Expand All @@ -239,22 +252,30 @@ class ImagePicker {
/// If specified, the images will be at most `maxWidth` wide and
/// `maxHeight` tall. Otherwise the images will be returned at it's
/// original width and height.
///
/// The `imageQuality` argument modifies the quality of the images, ranging from 0-100
/// where 100 is the original/max quality. If `imageQuality` is null, the images with
/// the original quality will be returned. Compression is only supported for certain
/// image types such as JPEG and on Android PNG and WebP, too. If compression is not supported for the image that is picked,
/// a warning message will be logged.
/// image types such as JPEG and on Android PNG and WebP, too. If compression is not
/// supported for the image that is picked, a warning message will be logged.
///
/// 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.
///
/// The method could throw [PlatformException] if the app does not have permission to access
/// the camera or photos gallery, no camera is available, plugin is already in use,
/// temporary file could not be created (iOS only), plugin activity could not
/// be allocated (Android only) or due to an unknown error.
///
/// See also [pickImage] to allow users to only pick a single image.
Future<List<XFile>?> pickMultiImage({
Future<List<XFile>> pickMultiImage({
double? maxWidth,
double? maxHeight,
int? imageQuality,
bool requestFullMetadata = true,
}) {
if (imageQuality != null && (imageQuality < 0 || imageQuality > 100)) {
throw ArgumentError.value(
Expand All @@ -267,10 +288,15 @@ class ImagePicker {
throw ArgumentError.value(maxHeight, 'maxHeight', 'cannot be negative');
}

return platform.getMultiImage(
maxWidth: maxWidth,
maxHeight: maxHeight,
imageQuality: imageQuality,
return platform.getMultiImageWithOptions(
options: MultiImagePickerOptions(
imageOptions: ImageOptions(
maxWidth: maxWidth,
maxHeight: maxHeight,
imageQuality: imageQuality,
requestFullMetadata: requestFullMetadata,
),
),
);
}

Expand Down
6 changes: 3 additions & 3 deletions packages/image_picker/image_picker/pubspec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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/main/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.5+3
version: 0.8.6

environment:
sdk: ">=2.14.0 <3.0.0"
Expand All @@ -24,8 +24,8 @@ dependencies:
sdk: flutter
image_picker_android: ^0.8.4+11
image_picker_for_web: ^2.1.0
image_picker_ios: ^0.8.4+11
image_picker_platform_interface: ^2.3.0
image_picker_ios: ^0.8.6+1
image_picker_platform_interface: ^2.6.1

dev_dependencies:
build_runner: ^2.1.10
Expand Down
Loading