This commit is contained in:
agra
2026-05-10 16:37:23 +03:00
parent 65c7a3195a
commit 3eba30358c
16 changed files with 1883 additions and 6 deletions

280
lib/src/gallery.dart Normal file
View File

@@ -0,0 +1,280 @@
import 'dart:io' as io;
import 'package:flutter/services.dart';
/// Authorisation state of the system photo library.
///
/// Mirrors the union of `PHAuthorizationStatus` (iOS / macOS) and
/// Android's manifest-permission outcomes:
/// - [notDetermined] — never asked. Prompt the user with
/// [UxGallery.requestPermission].
/// - [denied] — user said no. [UxGallery.openSettings] is the only
/// way back.
/// - [restricted] — parental controls / MDM. Same UI as [denied].
/// - [limited] — iOS 14+. User picked a subset; the grid still
/// populates from that subset. Call
/// [UxGallery.presentLimitedLibraryPicker] to let them adjust.
/// - [granted] — full access.
enum UxGalleryPermission { notDetermined, denied, restricted, limited, granted }
enum UxAssetKind { image, video }
/// A user-visible album / collection in the system photo library
/// (`PHAssetCollection` on Apple, `MediaStore.Bucket` on Android).
class UxAlbum {
const UxAlbum({
required this.id,
required this.name,
required this.count,
this.coverKind,
});
final String id;
final String name;
final int count;
final UxAssetKind? coverKind;
}
/// A single asset (photo or video) in the system library
/// (`PHAsset` / `ContentResolver` row).
class UxAsset {
const UxAsset({
required this.id,
required this.kind,
this.duration,
required this.width,
required this.height,
required this.createdAt,
});
/// Stable identifier (e.g. iOS `localIdentifier`, Android `content://` URI).
final String id;
final UxAssetKind kind;
/// Duration for videos; null for photos.
final Duration? duration;
final int width;
final int height;
final DateTime createdAt;
}
/// Cell-sized thumbnail bytes ready for `Image.memory`. Backed by
/// `PHCachingImageManager` on Apple and `MediaStore.Thumbnails` on
/// Android.
class UxAssetThumbnail {
const UxAssetThumbnail({
required this.bytes,
required this.width,
required this.height,
});
final Uint8List bytes;
final int width;
final int height;
}
/// Backend contract that [UxGallery] dispatches into. The default
/// implementation calls into native code via the `ux/gallery` method
/// channel; tests substitute their own (see
/// `ux/lib/testing.dart`'s `FakeUxGalleryBackend`).
abstract class UxGalleryBackend {
Future<UxGalleryPermission> permission();
Future<UxGalleryPermission> requestPermission();
Future<void> openSettings();
Future<void> presentLimitedLibraryPicker();
Future<List<UxAlbum>> albums({UxAssetKind? filter});
Future<List<UxAsset>> assets({
String? albumId,
UxAssetKind? filter,
required int start,
required int end,
});
Future<UxAssetThumbnail> thumbnail(String assetId, {required int sizePx});
Future<io.File> resolveFile(String assetId);
}
/// Static facade for the system photo library. All state lives in the
/// platform; this class is a thin Dart-side wrapper that dispatches
/// into [backend].
class UxGallery {
UxGallery._();
/// Swap to inject a fake (e.g.
/// `FakeUxGalleryBackend` from `package:ux/testing.dart`) before
/// any UI code mounts.
static UxGalleryBackend backend = MethodChannelGalleryBackend();
static Future<UxGalleryPermission> permission() => backend.permission();
static Future<UxGalleryPermission> requestPermission() =>
backend.requestPermission();
static Future<void> openSettings() => backend.openSettings();
/// iOS 14+ only — opens the system "manage limited access" sheet.
/// No-op on Android / older iOS.
static Future<void> presentLimitedLibraryPicker() =>
backend.presentLimitedLibraryPicker();
/// Albums in the user's library, ordered Recents → smart → user.
/// Pass [filter] to restrict to image-only / video-only albums.
static Future<List<UxAlbum>> albums({UxAssetKind? filter}) =>
backend.albums(filter: filter);
/// Paginate assets within [albumId] (or all assets if null), sorted
/// by `createdAt DESC`. [start] inclusive, [end] exclusive.
static Future<List<UxAsset>> assets({
String? albumId,
UxAssetKind? filter,
required int start,
required int end,
}) =>
backend.assets(
albumId: albumId,
filter: filter,
start: start,
end: end,
);
/// Cell-sized thumbnail at `~max(width,height) <= sizePx`. Native
/// caches keep repeated calls cheap; the caller still maintains a
/// small Dart-side LRU keyed by `(assetId, sizePx)`.
static Future<UxAssetThumbnail> thumbnail(
String assetId, {
required int sizePx,
}) =>
backend.thumbnail(assetId, sizePx: sizePx);
/// Resolve a real `io.File` for the asset. Photo / video alike.
/// On Android, this stream-copies a `content://` source into the
/// app cache (since `dart:io` can't read content URIs directly).
static Future<io.File> resolveFile(String assetId) =>
backend.resolveFile(assetId);
}
/// Default [UxGalleryBackend] — dispatches to native code via the
/// `ux/gallery` method channel. Public so test code can reinstall it
/// after swapping to a fake.
class MethodChannelGalleryBackend implements UxGalleryBackend {
static const _channel = MethodChannel('ux/gallery');
static String _kindArg(UxAssetKind? k) => switch (k) {
null => 'any',
UxAssetKind.image => 'image',
UxAssetKind.video => 'video',
};
static UxGalleryPermission _parsePermission(String? name) =>
switch (name) {
'notDetermined' => UxGalleryPermission.notDetermined,
'denied' => UxGalleryPermission.denied,
'restricted' => UxGalleryPermission.restricted,
'limited' => UxGalleryPermission.limited,
'granted' => UxGalleryPermission.granted,
_ => UxGalleryPermission.denied,
};
static UxAssetKind _parseKind(Object? v) =>
v == 'video' ? UxAssetKind.video : UxAssetKind.image;
static UxAsset _parseAsset(Map<Object?, Object?> m) => UxAsset(
id: m['id']! as String,
kind: _parseKind(m['kind']),
duration: m['duration_ms'] != null
? Duration(milliseconds: (m['duration_ms']! as num).toInt())
: null,
width: (m['width']! as num).toInt(),
height: (m['height']! as num).toInt(),
createdAt: DateTime.fromMillisecondsSinceEpoch(
(m['created_ms']! as num).toInt(),
),
);
static UxAlbum _parseAlbum(Map<Object?, Object?> m) => UxAlbum(
id: m['id']! as String,
name: m['name']! as String,
count: (m['count']! as num).toInt(),
coverKind: m['cover_kind'] == null ? null : _parseKind(m['cover_kind']),
);
@override
Future<UxGalleryPermission> permission() async {
final s = await _channel.invokeMethod<String>('permission');
return _parsePermission(s);
}
@override
Future<UxGalleryPermission> requestPermission() async {
final s = await _channel.invokeMethod<String>('requestPermission');
return _parsePermission(s);
}
@override
Future<void> openSettings() async {
await _channel.invokeMethod<void>('openSettings');
}
@override
Future<void> presentLimitedLibraryPicker() async {
await _channel.invokeMethod<void>('presentLimitedLibraryPicker');
}
@override
Future<List<UxAlbum>> albums({UxAssetKind? filter}) async {
final list = await _channel.invokeMethod<List<Object?>>(
'albums',
{'filter': _kindArg(filter)},
);
if (list == null) return const [];
return [
for (final raw in list) _parseAlbum((raw! as Map).cast()),
];
}
@override
Future<List<UxAsset>> assets({
String? albumId,
UxAssetKind? filter,
required int start,
required int end,
}) async {
final list = await _channel.invokeMethod<List<Object?>>(
'assets',
{
'albumId': albumId,
'filter': _kindArg(filter),
'start': start,
'end': end,
},
);
if (list == null) return const [];
return [
for (final raw in list) _parseAsset((raw! as Map).cast()),
];
}
@override
Future<UxAssetThumbnail> thumbnail(
String assetId, {
required int sizePx,
}) async {
final m = await _channel.invokeMethod<Map<Object?, Object?>>(
'thumbnail',
{'assetId': assetId, 'sizePx': sizePx},
);
return UxAssetThumbnail(
bytes: m!['bytes']! as Uint8List,
width: (m['width']! as num).toInt(),
height: (m['height']! as num).toInt(),
);
}
@override
Future<io.File> resolveFile(String assetId) async {
final path = await _channel.invokeMethod<String>(
'resolveFile',
{'assetId': assetId},
);
return io.File(path!);
}
}

View File

@@ -0,0 +1,119 @@
import 'dart:convert';
import 'dart:io' as io;
import 'dart:typed_data';
import 'package:ux/src/gallery.dart';
/// 1×1 transparent PNG. Decodable by `Image.memory`, so tests that
/// mount the picker UI against [FakeUxGalleryBackend] don't need to
/// provide their own thumbnail bytes.
final Uint8List _placeholderPng = base64Decode(
'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==',
);
/// In-memory backend for [UxGallery] tests. Swap in via
/// `UxGallery.backend = FakeUxGalleryBackend(...)` before any UI
/// mounts; restore with `UxGallery.backend = ...` (or by replacing
/// with another fake) in `tearDown`.
class FakeUxGalleryBackend implements UxGalleryBackend {
FakeUxGalleryBackend({
this.permissionState = UxGalleryPermission.granted,
List<UxAlbum> albums = const [],
Map<String, List<UxAsset>> assetsByAlbum = const {},
List<UxAsset> recents = const [],
this.onRequestPermission,
this.onOpenSettings,
this.onPresentLimitedLibraryPicker,
UxAssetThumbnail Function(String assetId, int sizePx)? thumbnailFor,
io.File Function(String assetId)? fileFor,
}) : _albums = List.unmodifiable(albums),
_assetsByAlbum = Map.unmodifiable(
assetsByAlbum.map(
(k, v) => MapEntry(k, List<UxAsset>.unmodifiable(v)),
),
),
_recents = List.unmodifiable(recents),
_thumbnailFor = thumbnailFor ?? _defaultThumbnail,
_fileFor = fileFor ?? _defaultFile;
/// Mutable so tests can simulate user grant after `requestPermission`.
UxGalleryPermission permissionState;
final List<UxAlbum> _albums;
final Map<String, List<UxAsset>> _assetsByAlbum;
final List<UxAsset> _recents;
final UxAssetThumbnail Function(String assetId, int sizePx) _thumbnailFor;
final io.File Function(String assetId) _fileFor;
/// Optional hook fired on `requestPermission`. Default updates
/// `permissionState` to [UxGalleryPermission.granted].
final UxGalleryPermission Function()? onRequestPermission;
final void Function()? onOpenSettings;
final void Function()? onPresentLimitedLibraryPicker;
static UxAssetThumbnail _defaultThumbnail(String _, int sizePx) =>
UxAssetThumbnail(
bytes: _placeholderPng,
width: sizePx,
height: sizePx,
);
static io.File _defaultFile(String assetId) =>
io.File('/dev/null/$assetId');
@override
Future<UxGalleryPermission> permission() async => permissionState;
@override
Future<UxGalleryPermission> requestPermission() async {
permissionState =
onRequestPermission?.call() ?? UxGalleryPermission.granted;
return permissionState;
}
@override
Future<void> openSettings() async {
onOpenSettings?.call();
}
@override
Future<void> presentLimitedLibraryPicker() async {
onPresentLimitedLibraryPicker?.call();
}
@override
Future<List<UxAlbum>> albums({UxAssetKind? filter}) async {
if (filter == null) return _albums;
return [
for (final a in _albums)
if (a.coverKind == null || a.coverKind == filter) a,
];
}
@override
Future<List<UxAsset>> assets({
String? albumId,
UxAssetKind? filter,
required int start,
required int end,
}) async {
final source = albumId == null
? _recents
: _assetsByAlbum[albumId] ?? const <UxAsset>[];
final filtered = filter == null
? source
: [for (final a in source) if (a.kind == filter) a];
if (start >= filtered.length) return const [];
return filtered.sublist(start, end.clamp(start, filtered.length));
}
@override
Future<UxAssetThumbnail> thumbnail(
String assetId, {
required int sizePx,
}) async =>
_thumbnailFor(assetId, sizePx);
@override
Future<io.File> resolveFile(String assetId) async => _fileFor(assetId);
}

View File

@@ -5,4 +5,5 @@
/// ```
library;
export 'src/testing/fake_gallery.dart';
export 'src/testing/text_golden.dart';

View File

@@ -10,6 +10,7 @@ export 'src/json_extension.dart';
export 'src/bezier.dart';
export 'src/clipboard.dart';
export 'src/file.dart';
export 'src/gallery.dart';
export 'src/keyboard.dart';
export 'src/auto_map.dart';
export 'src/scanner.dart';