Add trashbin properties to File

lib/api/api.dart

@@ -175,6 +175,9 @@ class _Files {
     hasPreview,
     size,
     richWorkspace,
+    trashbinFilename,
+    trashbinOriginalLocation,
+    trashbinDeletionTime,
     Map<String, String>? customNamespaces,
     List<String>? customProperties,
   }) async {
@@ -195,7 +198,11 @@ class _Files {
           shareTypes != null ||
           checksums != null ||
           size != null);
-      final bool hasNcNs = (hasPreview != null || richWorkspace != null);
+      final bool hasNcNs = (hasPreview != null ||
+          richWorkspace != null ||
+          trashbinFilename != null ||
+          trashbinOriginalLocation != null ||
+          trashbinDeletionTime != null);
       if (!hasDavNs && !hasOcNs && !hasNcNs) {
         // no body
         return await _api.request("PROPFIND", path);
@@ -265,6 +272,15 @@ class _Files {
             if (richWorkspace != null) {
               builder.element("nc:rich-workspace");
             }
+            if (trashbinFilename != null) {
+              builder.element("nc:trashbin-filename");
+            }
+            if (trashbinOriginalLocation != null) {
+              builder.element("nc:trashbin-original-location");
+            }
+            if (trashbinDeletionTime != null) {
+              builder.element("nc:trashbin-deletion-time");
+            }
             for (final p in customProperties ?? []) {
               builder.element(p);
             }

lib/entity/file.dart

@@ -210,6 +210,9 @@ class File with EquatableMixin {
     this.metadata,
     this.isArchived,
     this.overrideDateTime,
+    this.trashbinFilename,
+    this.trashbinOriginalLocation,
+    this.trashbinDeletionTime,
   }) : this.path = path.trimAny("/");
 
   @override
@@ -240,6 +243,11 @@ class File with EquatableMixin {
       hasPreview: json["hasPreview"],
       fileId: json["fileId"],
       ownerId: json["ownerId"],
+      trashbinFilename: json["trashbinFilename"],
+      trashbinOriginalLocation: json["trashbinOriginalLocation"],
+      trashbinDeletionTime: json["trashbinDeletionTime"] == null
+          ? null
+          : DateTime.parse(json["trashbinDeletionTime"]),
       metadata: json["metadata"] == null
           ? null
           : Metadata.fromJson(
@@ -291,6 +299,15 @@ class File with EquatableMixin {
     if (ownerId != null) {
       product += "ownerId: '$ownerId', ";
     }
+    if (trashbinFilename != null) {
+      product += "trashbinFilename: '$trashbinFilename', ";
+    }
+    if (trashbinOriginalLocation != null) {
+      product += "trashbinOriginalLocation: '$trashbinOriginalLocation', ";
+    }
+    if (trashbinDeletionTime != null) {
+      product += "trashbinDeletionTime: $trashbinDeletionTime, ";
+    }
     if (metadata != null) {
       product += "metadata: $metadata, ";
     }
@@ -316,6 +333,11 @@ class File with EquatableMixin {
       if (hasPreview != null) "hasPreview": hasPreview,
       if (fileId != null) "fileId": fileId,
       if (ownerId != null) "ownerId": ownerId,
+      if (trashbinFilename != null) "trashbinFilename": trashbinFilename,
+      if (trashbinOriginalLocation != null)
+        "trashbinOriginalLocation": trashbinOriginalLocation,
+      if (trashbinDeletionTime != null)
+        "trashbinDeletionTime": trashbinDeletionTime!.toUtc().toIso8601String(),
       if (metadata != null) "metadata": metadata!.toJson(),
       if (isArchived != null) "isArchived": isArchived,
       if (overrideDateTime != null)
@@ -334,6 +356,9 @@ class File with EquatableMixin {
     bool? hasPreview,
     int? fileId,
     String? ownerId,
+    String? trashbinFilename,
+    String? trashbinOriginalLocation,
+    DateTime? trashbinDeletionTime,
     OrNull<Metadata>? metadata,
     OrNull<bool>? isArchived,
     OrNull<DateTime>? overrideDateTime,
@@ -349,6 +374,10 @@ class File with EquatableMixin {
       hasPreview: hasPreview ?? this.hasPreview,
       fileId: fileId ?? this.fileId,
       ownerId: ownerId ?? this.ownerId,
+      trashbinFilename: trashbinFilename ?? this.trashbinFilename,
+      trashbinOriginalLocation:
+          trashbinOriginalLocation ?? this.trashbinOriginalLocation,
+      trashbinDeletionTime: trashbinDeletionTime ?? this.trashbinDeletionTime,
       metadata: metadata == null ? this.metadata : metadata.obj,
       isArchived: isArchived == null ? this.isArchived : isArchived.obj,
       overrideDateTime: overrideDateTime == null
@@ -386,6 +415,9 @@ class File with EquatableMixin {
         hasPreview,
         fileId,
         ownerId,
+        trashbinFilename,
+        trashbinOriginalLocation,
+        trashbinDeletionTime,
         // metadata is handled separately, see [equals]
         isArchived,
         overrideDateTime,
@@ -402,6 +434,9 @@ class File with EquatableMixin {
   // maybe null when loaded from old cache
   final int? fileId;
   final String? ownerId;
+  final String? trashbinFilename;
+  final String? trashbinOriginalLocation;
+  final DateTime? trashbinDeletionTime;
   // metadata
   final Metadata? metadata;
   final bool? isArchived;

lib/entity/file/data_source.dart

@@ -40,6 +40,9 @@ class FileWebdavDataSource implements FileDataSource {
       hasPreview: 1,
       fileid: 1,
       ownerId: 1,
+      trashbinFilename: 1,
+      trashbinOriginalLocation: 1,
+      trashbinDeletionTime: 1,
       customNamespaces: {
         "com.nkming.nc_photos": "app",
       },

lib/entity/webdav_response_parser.dart

@@ -68,6 +68,9 @@ class WebdavFileParser {
     Metadata? metadata;
     bool? isArchived;
     DateTime? overrideDateTime;
+    String? trashbinFilename;
+    String? trashbinOriginalLocation;
+    DateTime? trashbinDeletionTime;
 
     for (final child in element.children.whereType<XmlElement>()) {
       if (child.matchQualifiedName("href",
@@ -101,6 +104,9 @@ class WebdavFileParser {
         metadata = propParser.metadata;
         isArchived = propParser.isArchived;
         overrideDateTime = propParser.overrideDateTime;
+        trashbinFilename = propParser.trashbinFilename;
+        trashbinOriginalLocation = propParser.trashbinOriginalLocation;
+        trashbinDeletionTime = propParser.trashbinDeletionTime;
       }
     }
 
@@ -118,6 +124,9 @@ class WebdavFileParser {
       metadata: metadata,
       isArchived: isArchived,
       overrideDateTime: overrideDateTime,
+      trashbinFilename: trashbinFilename,
+      trashbinOriginalLocation: trashbinOriginalLocation,
+      trashbinDeletionTime: trashbinDeletionTime,
     );
   }
 
@@ -177,6 +186,16 @@ class _PropParser {
       } else if (child.matchQualifiedName("owner-id",
           prefix: "http://owncloud.org/ns", namespaces: namespaces)) {
         _ownerId = child.innerText;
+      } else if (child.matchQualifiedName("trashbin-filename",
+          prefix: "http://nextcloud.org/ns", namespaces: namespaces)) {
+        _trashbinFilename = child.innerText;
+      } else if (child.matchQualifiedName("trashbin-original-location",
+          prefix: "http://nextcloud.org/ns", namespaces: namespaces)) {
+        _trashbinOriginalLocation = child.innerText;
+      } else if (child.matchQualifiedName("trashbin-deletion-time",
+          prefix: "http://nextcloud.org/ns", namespaces: namespaces)) {
+        _trashbinDeletionTime = DateTime.fromMillisecondsSinceEpoch(
+            int.parse(child.innerText) * 1000);
       } else if (child.matchQualifiedName("is-archived",
           prefix: "com.nkming.nc_photos", namespaces: namespaces)) {
         _isArchived = child.innerText == "true";
@@ -216,6 +235,9 @@ class _PropParser {
   Metadata? get metadata => _metadata;
   bool? get isArchived => _isArchived;
   DateTime? get overrideDateTime => _overrideDateTime;
+  String? get trashbinFilename => _trashbinFilename;
+  String? get trashbinOriginalLocation => _trashbinOriginalLocation;
+  DateTime? get trashbinDeletionTime => _trashbinDeletionTime;
 
   final Map<String, String> namespaces;
 
@@ -234,6 +256,9 @@ class _PropParser {
   Metadata? _metadata;
   bool? _isArchived;
   DateTime? _overrideDateTime;
+  String? _trashbinFilename;
+  String? _trashbinOriginalLocation;
+  DateTime? _trashbinDeletionTime;
 }
 
 extension on XmlElement {

test/entity/file_test.dart

@@ -434,6 +434,38 @@ void main() {
         expect(file, File(path: "", ownerId: "admin"));
       });
 
+      test("trashbinFilename", () {
+        final json = <String, dynamic>{
+          "path": "",
+          "trashbinFilename": "test.jpg",
+        };
+        final file = File.fromJson(json);
+        expect(file, File(path: "", trashbinFilename: "test.jpg"));
+      });
+
+      test("trashbinOriginalLocation", () {
+        final json = <String, dynamic>{
+          "path": "",
+          "trashbinOriginalLocation": "Photos/test.jpg",
+        };
+        final file = File.fromJson(json);
+        expect(
+            file, File(path: "", trashbinOriginalLocation: "Photos/test.jpg"));
+      });
+
+      test("trashbinDeletionTime", () {
+        final json = <String, dynamic>{
+          "path": "",
+          "trashbinDeletionTime": "2022-01-02T03:04:05.000Z",
+        };
+        final file = File.fromJson(json);
+        expect(
+            file,
+            File(
+                path: "",
+                trashbinDeletionTime: DateTime.utc(2022, 1, 2, 3, 4, 5)));
+      });
+
       test("metadata", () {
         final json = <String, dynamic>{
           "path": "",
@@ -567,6 +599,32 @@ void main() {
         });
       });
 
+      test("trashbinFilename", () {
+        final file = File(path: "", trashbinFilename: "test.jpg");
+        expect(file.toJson(), <String, dynamic>{
+          "path": "",
+          "trashbinFilename": "test.jpg",
+        });
+      });
+
+      test("trashbinOriginalLocation", () {
+        final file =
+            File(path: "", trashbinOriginalLocation: "Photos/test.jpg");
+        expect(file.toJson(), <String, dynamic>{
+          "path": "",
+          "trashbinOriginalLocation": "Photos/test.jpg",
+        });
+      });
+
+      test("trashbinDeletionTime", () {
+        final file = File(
+            path: "", trashbinDeletionTime: DateTime.utc(2022, 1, 2, 3, 4, 5));
+        expect(file.toJson(), <String, dynamic>{
+          "path": "",
+          "trashbinDeletionTime": "2022-01-02T03:04:05.000Z",
+        });
+      });
+
       test("metadata", () {
         final file = File(
             path: "remote.php/dav/files/admin/test.jpg",
@@ -614,6 +672,9 @@ void main() {
         hasPreview: true,
         fileId: 123,
         ownerId: "admin",
+        trashbinFilename: "test.jpg",
+        trashbinOriginalLocation: "Photos/test.jpg",
+        trashbinDeletionTime: DateTime.utc(2022, 1, 2, 3, 4, 5),
         metadata: null,
         isArchived: true,
         overrideDateTime: DateTime.utc(2021, 1, 2, 3, 4, 5),
@@ -634,6 +695,9 @@ void main() {
               hasPreview: true,
               fileId: 123,
               ownerId: "admin",
+              trashbinFilename: "test.jpg",
+              trashbinOriginalLocation: "Photos/test.jpg",
+              trashbinDeletionTime: DateTime.utc(2022, 1, 2, 3, 4, 5),
               isArchived: true,
               overrideDateTime: DateTime.utc(2021, 1, 2, 3, 4, 5),
             ));
@@ -654,6 +718,9 @@ void main() {
               hasPreview: true,
               fileId: 123,
               ownerId: "admin",
+              trashbinFilename: "test.jpg",
+              trashbinOriginalLocation: "Photos/test.jpg",
+              trashbinDeletionTime: DateTime.utc(2022, 1, 2, 3, 4, 5),
               isArchived: true,
               overrideDateTime: DateTime.utc(2021, 1, 2, 3, 4, 5),
             ));
@@ -674,6 +741,9 @@ void main() {
               hasPreview: true,
               fileId: 123,
               ownerId: "admin",
+              trashbinFilename: "test.jpg",
+              trashbinOriginalLocation: "Photos/test.jpg",
+              trashbinDeletionTime: DateTime.utc(2022, 1, 2, 3, 4, 5),
               isArchived: true,
               overrideDateTime: DateTime.utc(2021, 1, 2, 3, 4, 5),
             ));
@@ -694,6 +764,9 @@ void main() {
               hasPreview: true,
               fileId: 123,
               ownerId: "admin",
+              trashbinFilename: "test.jpg",
+              trashbinOriginalLocation: "Photos/test.jpg",
+              trashbinDeletionTime: DateTime.utc(2022, 1, 2, 3, 4, 5),
               isArchived: true,
               overrideDateTime: DateTime.utc(2021, 1, 2, 3, 4, 5),
             ));
@@ -715,6 +788,9 @@ void main() {
               hasPreview: true,
               fileId: 123,
               ownerId: "admin",
+              trashbinFilename: "test.jpg",
+              trashbinOriginalLocation: "Photos/test.jpg",
+              trashbinDeletionTime: DateTime.utc(2022, 1, 2, 3, 4, 5),
               isArchived: true,
               overrideDateTime: DateTime.utc(2021, 1, 2, 3, 4, 5),
             ));
@@ -735,6 +811,9 @@ void main() {
               hasPreview: true,
               fileId: 123,
               ownerId: "admin",
+              trashbinFilename: "test.jpg",
+              trashbinOriginalLocation: "Photos/test.jpg",
+              trashbinDeletionTime: DateTime.utc(2022, 1, 2, 3, 4, 5),
               isArchived: true,
               overrideDateTime: DateTime.utc(2021, 1, 2, 3, 4, 5),
             ));
@@ -755,6 +834,9 @@ void main() {
               hasPreview: true,
               fileId: 123,
               ownerId: "admin",
+              trashbinFilename: "test.jpg",
+              trashbinOriginalLocation: "Photos/test.jpg",
+              trashbinDeletionTime: DateTime.utc(2022, 1, 2, 3, 4, 5),
               isArchived: true,
               overrideDateTime: DateTime.utc(2021, 1, 2, 3, 4, 5),
             ));
@@ -775,6 +857,9 @@ void main() {
               hasPreview: false,
               fileId: 123,
               ownerId: "admin",
+              trashbinFilename: "test.jpg",
+              trashbinOriginalLocation: "Photos/test.jpg",
+              trashbinDeletionTime: DateTime.utc(2022, 1, 2, 3, 4, 5),
               isArchived: true,
               overrideDateTime: DateTime.utc(2021, 1, 2, 3, 4, 5),
             ));
@@ -795,6 +880,9 @@ void main() {
               hasPreview: true,
               fileId: 321,
               ownerId: "admin",
+              trashbinFilename: "test.jpg",
+              trashbinOriginalLocation: "Photos/test.jpg",
+              trashbinDeletionTime: DateTime.utc(2022, 1, 2, 3, 4, 5),
               isArchived: true,
               overrideDateTime: DateTime.utc(2021, 1, 2, 3, 4, 5),
             ));
@@ -815,6 +903,79 @@ void main() {
               hasPreview: true,
               fileId: 123,
               ownerId: "user",
+              trashbinFilename: "test.jpg",
+              trashbinOriginalLocation: "Photos/test.jpg",
+              trashbinDeletionTime: DateTime.utc(2022, 1, 2, 3, 4, 5),
+              isArchived: true,
+              overrideDateTime: DateTime.utc(2021, 1, 2, 3, 4, 5),
+            ));
+      });
+
+      test("trashbinFilename", () {
+        final file = src.copyWith(trashbinFilename: "test2.jpg");
+        expect(
+            file,
+            File(
+              path: "remote.php/dav/files/admin/test.jpg",
+              contentLength: 123,
+              contentType: "image/jpeg",
+              etag: "8a3e0799b6f0711c23cc2d93950eceb5",
+              lastModified: DateTime.utc(2020, 1, 2, 3, 4, 5, 678, 901),
+              isCollection: true,
+              usedBytes: 123456,
+              hasPreview: true,
+              fileId: 123,
+              ownerId: "admin",
+              trashbinFilename: "test2.jpg",
+              trashbinOriginalLocation: "Photos/test.jpg",
+              trashbinDeletionTime: DateTime.utc(2022, 1, 2, 3, 4, 5),
+              isArchived: true,
+              overrideDateTime: DateTime.utc(2021, 1, 2, 3, 4, 5),
+            ));
+      });
+
+      test("trashbinOriginalLocation", () {
+        final file = src.copyWith(trashbinOriginalLocation: "Photos2/test.jpg");
+        expect(
+            file,
+            File(
+              path: "remote.php/dav/files/admin/test.jpg",
+              contentLength: 123,
+              contentType: "image/jpeg",
+              etag: "8a3e0799b6f0711c23cc2d93950eceb5",
+              lastModified: DateTime.utc(2020, 1, 2, 3, 4, 5, 678, 901),
+              isCollection: true,
+              usedBytes: 123456,
+              hasPreview: true,
+              fileId: 123,
+              ownerId: "admin",
+              trashbinFilename: "test.jpg",
+              trashbinOriginalLocation: "Photos2/test.jpg",
+              trashbinDeletionTime: DateTime.utc(2022, 1, 2, 3, 4, 5),
+              isArchived: true,
+              overrideDateTime: DateTime.utc(2021, 1, 2, 3, 4, 5),
+            ));
+      });
+
+      test("trashbinDeletionTime", () {
+        final now = DateTime.now();
+        final file = src.copyWith(trashbinDeletionTime: now);
+        expect(
+            file,
+            File(
+              path: "remote.php/dav/files/admin/test.jpg",
+              contentLength: 123,
+              contentType: "image/jpeg",
+              etag: "8a3e0799b6f0711c23cc2d93950eceb5",
+              lastModified: DateTime.utc(2020, 1, 2, 3, 4, 5, 678, 901),
+              isCollection: true,
+              usedBytes: 123456,
+              hasPreview: true,
+              fileId: 123,
+              ownerId: "admin",
+              trashbinFilename: "test.jpg",
+              trashbinOriginalLocation: "Photos/test.jpg",
+              trashbinDeletionTime: now,
               isArchived: true,
               overrideDateTime: DateTime.utc(2021, 1, 2, 3, 4, 5),
             ));
@@ -836,6 +997,9 @@ void main() {
               hasPreview: true,
               fileId: 123,
               ownerId: "admin",
+              trashbinFilename: "test.jpg",
+              trashbinOriginalLocation: "Photos/test.jpg",
+              trashbinDeletionTime: DateTime.utc(2022, 1, 2, 3, 4, 5),
               metadata: metadata,
               isArchived: true,
               overrideDateTime: DateTime.utc(2021, 1, 2, 3, 4, 5),
@@ -854,6 +1018,9 @@ void main() {
           hasPreview: true,
           fileId: 123,
           ownerId: "admin",
+          trashbinFilename: "test.jpg",
+          trashbinOriginalLocation: "Photos/test.jpg",
+          trashbinDeletionTime: DateTime.utc(2022, 1, 2, 3, 4, 5),
           metadata: Metadata(),
           isArchived: true,
           overrideDateTime: DateTime.utc(2021, 1, 2, 3, 4, 5),
@@ -872,6 +1039,9 @@ void main() {
               hasPreview: true,
               fileId: 123,
               ownerId: "admin",
+              trashbinFilename: "test.jpg",
+              trashbinOriginalLocation: "Photos/test.jpg",
+              trashbinDeletionTime: DateTime.utc(2022, 1, 2, 3, 4, 5),
               isArchived: true,
               overrideDateTime: DateTime.utc(2021, 1, 2, 3, 4, 5),
             ));
@@ -892,6 +1062,9 @@ void main() {
               hasPreview: true,
               fileId: 123,
               ownerId: "admin",
+              trashbinFilename: "test.jpg",
+              trashbinOriginalLocation: "Photos/test.jpg",
+              trashbinDeletionTime: DateTime.utc(2022, 1, 2, 3, 4, 5),
               isArchived: false,
               overrideDateTime: DateTime.utc(2021, 1, 2, 3, 4, 5),
             ));
@@ -912,6 +1085,9 @@ void main() {
               hasPreview: true,
               fileId: 123,
               ownerId: "admin",
+              trashbinFilename: "test.jpg",
+              trashbinOriginalLocation: "Photos/test.jpg",
+              trashbinDeletionTime: DateTime.utc(2022, 1, 2, 3, 4, 5),
               overrideDateTime: DateTime.utc(2021, 1, 2, 3, 4, 5),
             ));
       });
@@ -932,6 +1108,9 @@ void main() {
               hasPreview: true,
               fileId: 123,
               ownerId: "admin",
+              trashbinFilename: "test.jpg",
+              trashbinOriginalLocation: "Photos/test.jpg",
+              trashbinDeletionTime: DateTime.utc(2022, 1, 2, 3, 4, 5),
               isArchived: true,
               overrideDateTime: DateTime.utc(2022, 3, 4, 5, 6, 7),
             ));
@@ -952,6 +1131,9 @@ void main() {
               hasPreview: true,
               fileId: 123,
               ownerId: "admin",
+              trashbinFilename: "test.jpg",
+              trashbinOriginalLocation: "Photos/test.jpg",
+              trashbinDeletionTime: DateTime.utc(2022, 1, 2, 3, 4, 5),
               isArchived: true,
             ));
       });