#6006 add path and thumbnails to yust file

lib/src/models/yust_file.dart

@@ -1,13 +1,32 @@
+import 'dart:convert';
 import 'dart:io';
 import 'dart:typed_data';
 
+import 'package:collection/collection.dart';
 import 'package:json_annotation/json_annotation.dart';
 
+import '../../yust.dart';
+
 part 'yust_file.g.dart';
 
 typedef YustFileJson = Map<String, dynamic>;
 typedef YustFilesJson = List<YustFileJson>;
 
+/// The size of the thumbnail.
+enum YustFileThumbnailSize {
+  small;
+
+  /// Converts a JSON string to a [YustFileThumbnailSize].
+  ///
+  /// If the size is not found, [YustFileThumbnailSize.small] is returned.
+  static YustFileThumbnailSize fromJson(String size) =>
+      YustFileThumbnailSize.values.firstWhereOrNull((e) => e.name == size) ??
+      YustFileThumbnailSize.small;
+
+  /// Converts a [YustFileThumbnailSize] to a JSON string.
+  String toJson() => name;
+}
+
 /// A binary file handled by database and file storage.
 /// A file is stored in Firebase Storage and linked to a document in the database.
 /// For offline caching a file can also be stored on the device.
@@ -31,6 +50,14 @@ class YustFile {
   /// On mobile devices, this can also be the time the file was uploaded into device cache.
   DateTime? createdAt;
 
+  /// The path to the file in the storage.
+  String? path;
+
+  /// The thumbnails of the file.
+  ///
+  /// Map of thumbnail size to path in the storage.
+  Map<YustFileThumbnailSize, String>? thumbnails;
+
   /// The binary file. This attribute is used for iOS and Android. For web [bytes] is used instead.
   @JsonKey(includeFromJson: false, includeToJson: false)
   File? file;
@@ -59,6 +86,10 @@ class YustFile {
   @JsonKey(includeFromJson: false, includeToJson: false)
   String? lastError;
 
+  /// True if a thumbnail should be created.
+  @JsonKey(includeFromJson: false, includeToJson: false)
+  bool? createThumbnail;
+
   /// True if the files should be stored as a Map of hash and file
   /// inside the linked document.
   ///
@@ -98,8 +129,11 @@ class YustFile {
     this.linkedDocAttribute,
     this.processing = false,
     this.lastError,
+    this.createThumbnail,
     this.linkedDocStoresFilesAsMap,
     this.createdAt,
+    this.path,
+    this.thumbnails,
     bool setCreatedAtToNow = true,
   }) {
     if (setCreatedAtToNow) {
@@ -124,6 +158,11 @@ class YustFile {
           : json['createdAt'] is DateTime
           ? json['createdAt'] as DateTime
           : DateTime.parse(json['createdAt'] as String),
+      path: json['path'] as String?,
+      thumbnails: (json['thumbnails'] as Map?)?.map(
+        (key, value) =>
+            MapEntry(YustFileThumbnailSize.fromJson(key), value as String),
+      ),
       setCreatedAtToNow: false,
     );
   }
@@ -141,6 +180,8 @@ class YustFile {
     name = file.name;
     hash = file.hash;
     createdAt = file.createdAt;
+    path = file.path;
+    thumbnails = file.thumbnails;
   }
 
   /// Converts the file to JSON for local device. Only relevant attributes are converted.
@@ -154,13 +195,24 @@ class YustFile {
       linkedDocPath: json['linkedDocPath'] as String,
       linkedDocAttribute: json['linkedDocAttribute'] as String,
       lastError: json['lastError'] as String?,
+      createThumbnail: json['createThumbnail'] == 'true',
       linkedDocStoresFilesAsMap: json['linkedDocStoresFilesAsMap'] == 'true',
       modifiedAt: json['modifiedAt'] != null
           ? DateTime.parse(json['modifiedAt'] as String)
           : null,
       createdAt: json['createdAt'] != null
           ? DateTime.parse(json['createdAt'] as String)
           : null,
+      path: json['path'] as String?,
+      thumbnails: json['thumbnails'] != null
+          ? (jsonDecode(json['thumbnails'] as String) as Map).map(
+              (key, value) => MapEntry(
+                YustFileThumbnailSize.fromJson(key),
+                value as String,
+              ),
+            )
+          : null,
+
       setCreatedAtToNow: false,
     );
   }
@@ -170,16 +222,22 @@ class YustFile {
   /// This is used for offline file handling only (Caching on mobile devices)
   Map<String, String?> toLocalJson() {
     if (name == null) {
-      throw ('Error: Each cached file needs a name. Should be unique for each path!');
+      throw YustException(
+        'Error: Each cached file needs a name. Should be unique for each path!',
+      );
     }
     if (devicePath == null) {
-      throw ('Error: Device Path has to be a String.');
+      throw YustException('Error: Device Path has to be a String.');
     }
     if (storageFolderPath == null) {
-      throw ('Error: StorageFolderPath has to be set for a successful upload.');
+      throw YustException(
+        'Error: StorageFolderPath has to be set for a successful upload.',
+      );
     }
     if (linkedDocPath == null || linkedDocAttribute == null) {
-      throw ('Error: linkedDocPath and linkedDocAttribute have to be set for a successful upload.');
+      throw YustException(
+        'Error: linkedDocPath and linkedDocAttribute have to be set for a successful upload.',
+      );
     }
     return {
       'name': name,
@@ -188,14 +246,39 @@ class YustFile {
       'linkedDocAttribute': linkedDocAttribute,
       'devicePath': devicePath,
       'lastError': lastError,
+      'createThumbnail': (createThumbnail ?? false).toString(),
       'linkedDocStoresFilesAsMap': (linkedDocStoresFilesAsMap ?? false)
           .toString(),
       'modifiedAt': modifiedAt?.toIso8601String(),
       'createdAt': createdAt?.toIso8601String(),
       'type': type,
+      'path': path,
+      'thumbnails': thumbnails != null ? jsonEncode(thumbnails) : null,
     };
   }
 
+  /// Creates a new file with the same properties but with a new URL.
+  YustFile copyWithUrl(String? url) => YustFile(
+    key: key,
+    name: name,
+    modifiedAt: modifiedAt,
+    url: url,
+    hash: hash,
+    file: file,
+    bytes: bytes,
+    devicePath: devicePath,
+    storageFolderPath: storageFolderPath,
+    linkedDocPath: linkedDocPath,
+    linkedDocAttribute: linkedDocAttribute,
+    processing: processing,
+    lastError: lastError,
+    createThumbnail: createThumbnail,
+    createdAt: createdAt,
+    path: path,
+    thumbnails: thumbnails,
+    setCreatedAtToNow: false,
+  );
+
   dynamic operator [](String key) {
     switch (key) {
       case 'name':
@@ -206,6 +289,9 @@ class YustFile {
         return url;
       case 'createdAt':
         return createdAt;
+      case 'path':
+        return path;
+      case 'thumbnails': // Thumbnails should not be accessible
       default:
         throw ArgumentError();
     }
@@ -234,4 +320,28 @@ class YustFile {
 
     return name!.contains('.') ? name!.split('.').last : '';
   }
+
+  bool hasThumbnail() => thumbnails?.isNotEmpty ?? false;
+
+  String? getOriginalUrl() {
+    final baseUrl = Yust.fileAccessService.originalCdnBaseUrl;
+    final grant = Yust.fileAccessService.getGrantForFile(this);
+
+    if (baseUrl == null || grant == null || path == null) return url;
+
+    return '${_tryAppendSlash(baseUrl)}$path?${grant.originalSignedUrlPart}';
+  }
+
+  String? getThumbnailUrl() {
+    final baseUrl = Yust.fileAccessService.thumbnailCdnBaseUrl;
+    final grant = Yust.fileAccessService.getGrantForFile(this);
+
+    if (baseUrl == null || grant == null || !hasThumbnail()) return null;
+    final thumbnailPath = thumbnails![YustFileThumbnailSize.small];
+
+    return '${_tryAppendSlash(baseUrl)}$thumbnailPath?${grant.thumbnailSignedUrlPart}';
+  }
+
+  String? _tryAppendSlash(String baseUrl) =>
+      baseUrl.endsWith('/') ? baseUrl : '$baseUrl/';
 }

lib/src/models/yust_image.dart

@@ -22,13 +22,17 @@ class YustImage extends YustFile {
     super.linkedDocAttribute,
     super.processing = false,
     super.lastError,
+    super.createThumbnail,
     super.linkedDocStoresFilesAsMap,
     super.createdAt,
+    super.path,
+    super.thumbnails,
     this.location,
   });
 
   YustGeoLocation? location;
 
+  /// Creates a new image from a file.
   factory YustImage.fromYustFile(YustFile file) => file is YustImage
       ? file
       : YustImage(
@@ -45,8 +49,11 @@ class YustImage extends YustFile {
           linkedDocAttribute: file.linkedDocAttribute,
           processing: file.processing,
           lastError: file.lastError,
+          createThumbnail: file.createThumbnail,
           linkedDocStoresFilesAsMap: file.linkedDocStoresFilesAsMap,
           createdAt: file.createdAt,
+          path: file.path,
+          thumbnails: file.thumbnails,
         );
 
   /// Create a list of images from a list of files

lib/src/services/yust_file_access_service.dart

@@ -0,0 +1,3 @@
+export './yust_file_access_service_dart.dart'
+    if (dart.library.ui) './yust_file_access_service_flutter.dart';
+export './yust_file_access_service_interface.dart';

lib/src/services/yust_file_access_service_dart.dart

@@ -0,0 +1,72 @@
+import 'package:collection/collection.dart';
+
+import '../models/yust_file.dart';
+import '../util/file_access/yust_cdn_configuration.dart';
+import '../util/file_access/yust_file_access_grant.dart';
+import '../util/google_cloud_cdn_helper.dart';
+import 'yust_file_access_service_interface.dart';
+
+class YustFileAccessService implements IYustFileAccessService {
+  @override
+  final String? originalCdnBaseUrl;
+
+  @override
+  final String? thumbnailCdnBaseUrl;
+
+  @override
+  List<YustFileAccessGrant> grants = [];
+
+  @override
+  Future<String?> Function(YustFile)? generateDownloadUrl;
+
+  YustFileAccessService({
+    required this.originalCdnBaseUrl,
+    required this.thumbnailCdnBaseUrl,
+  });
+
+  @override
+  String createSignedUrlForFile({
+    required String path,
+    required String name,
+    required Duration validFor,
+    required YustCdnConfiguration cdnConfiguration,
+    Map<String, String>? additionalQueryParams,
+  }) {
+    final helper = GoogleCloudCdnHelper(
+      baseUrl: cdnConfiguration.baseUrl,
+      keyName: cdnConfiguration.keyName,
+      keyBase64: cdnConfiguration.keyBase64,
+    );
+    return helper.signFilePath(
+      objectPath: '$path/$name',
+      validFor: validFor,
+      additionalQueryParams: additionalQueryParams,
+    );
+  }
+
+  @override
+  String createSignedUrlPartForFolder({
+    required String path,
+    required Duration validFor,
+    required YustCdnConfiguration cdnConfiguration,
+  }) {
+    final helper = GoogleCloudCdnHelper(
+      baseUrl: cdnConfiguration.baseUrl,
+      keyName: cdnConfiguration.keyName,
+      keyBase64: cdnConfiguration.keyBase64,
+    );
+    return helper.signPrefix(prefixPath: path, validFor: validFor);
+  }
+
+  @override
+  void setGrants(List<YustFileAccessGrant> grants) {
+    this.grants = grants;
+  }
+
+  @override
+  YustFileAccessGrant? getGrantForFile(YustFile file) {
+    return grants.firstWhereOrNull(
+      (grant) => file.path?.startsWith(grant.pathPrefix) ?? false,
+    );
+  }
+}