feat(nextcloud)!: webdav deserialize duration fields

Signed-off-by: Nikolas Rimikis <leptopoda@users.noreply.github.com>
nextcloud · Apr 3, 2024 · d10b22a · d10b22a
1 parent d49c27c
commit d10b22a
Show file tree

Hide file tree

Showing 5 changed files with 85 additions and 16 deletions.
diff --git a/packages/nextcloud/generate_props.dart b/packages/nextcloud/generate_props.dart
@@ -37,7 +37,7 @@ void main() {
       'lock-owner-editor': 'String',
       'lock-owner-type': 'int',
       'lock-time': 'unixEpoch',
-      'lock-timeout': 'int',
+      'lock-timeout': 'seconds',
       'lock-token': 'String',
       'metadata_etag': 'String',
       'mount-type': 'String',
@@ -102,6 +102,9 @@ void main() {
         case 'unixEpoch':
           value.writeln('  @UnixEpochXMLConverter()');
           type = 'tz.TZDateTime';
+        case 'seconds':
+          value.writeln('  @DurationXMLConverter()');
+          type = 'Duration';
       }
 
       value.write('  final $type? $variable;');
@@ -124,6 +127,7 @@ void main() {
       '// coverage:ignore-file',
       "import 'package:meta/meta.dart';",
       "import 'package:nextcloud/src/utils/date_time.dart';",
+      "import 'package:nextcloud/src/webdav/utils.dart';",
       "import 'package:nextcloud/src/webdav/webdav.dart';",
       "import 'package:timezone/timezone.dart' as tz;",
       "import 'package:xml/xml.dart';",

diff --git a/packages/nextcloud/lib/src/webdav/props.dart b/packages/nextcloud/lib/src/webdav/props.dart
@@ -2,6 +2,7 @@
 // coverage:ignore-file
 import 'package:meta/meta.dart';
 import 'package:nextcloud/src/utils/date_time.dart';
+import 'package:nextcloud/src/webdav/utils.dart';
 import 'package:nextcloud/src/webdav/webdav.dart';
 import 'package:timezone/timezone.dart' as tz;
 import 'package:xml/xml.dart';
@@ -938,7 +939,8 @@ class WebDavProp with _$WebDavPropXmlSerializableMixin {
     namespace: namespaceNextcloud,
     includeIfNull: false,
   )
-  final int? ncLockTimeout;
+  @DurationXMLConverter()
+  final Duration? ncLockTimeout;
 
   @annotation.XmlElement(
     name: 'lock-token',
@@ -1418,7 +1420,8 @@ class WebDavOcFilterRules with _$WebDavOcFilterRulesXmlSerializableMixin {
     namespace: namespaceNextcloud,
     includeIfNull: false,
   )
-  final int? ncLockTimeout;
+  @DurationXMLConverter()
+  final Duration? ncLockTimeout;
 
   @annotation.XmlElement(
     name: 'lock-token',

diff --git a/packages/nextcloud/lib/src/webdav/props.g.dart b/packages/nextcloud/lib/src/webdav/props.g.dart
diff --git a/packages/nextcloud/lib/src/webdav/utils.dart b/packages/nextcloud/lib/src/webdav/utils.dart
@@ -7,6 +7,8 @@ import 'package:meta/meta.dart';
 import 'package:nextcloud/src/webdav/models.dart';
 import 'package:nextcloud/src/webdav/path_uri.dart';
 import 'package:nextcloud/src/webdav/webdav.dart';
+import 'package:xml/xml.dart' as xml;
+import 'package:xml_annotation/xml_annotation.dart' as xml_annotation;
 
 /// Base path used on the server
 final webdavBase = PathUri.parse('/remote.php/webdav');
@@ -47,3 +49,59 @@ final class WebDavResponseConverter with Converter<http.StreamedResponse, Future
     return WebDavMultistatus.fromXmlElement(xml!);
   }
 }
+
+@internal
+final class DurationXMLConverter implements xml_annotation.XmlConverter<Duration?> {
+  const DurationXMLConverter();
+
+  @override
+  void buildXmlChildren(
+    Duration? instance,
+    xml.XmlBuilder builder, {
+    Map<String, String> namespaces = const {},
+  }) {
+    if (instance == null) {
+      return;
+    }
+
+    final serialized = instance.inSeconds.toString();
+    builder.text(serialized);
+  }
+
+  @override
+  Duration? fromXmlElement(
+    xml.XmlElement element,
+  ) {
+    final value = element.getText();
+
+    if (value != null) {
+      final seconds = int.parse(value);
+      return Duration(seconds: seconds);
+    }
+
+    return null;
+  }
+
+  @override
+  List<xml.XmlAttribute> toXmlAttributes(
+    Duration? instance, {
+    Map<String, String?> namespaces = const {},
+  }) {
+    return const <xml.XmlAttribute>[];
+  }
+
+  @override
+  List<xml.XmlNode> toXmlChildren(
+    Duration? instance, {
+    Map<String, String?> namespaces = const {},
+  }) {
+    if (instance == null) {
+      return const <xml.XmlNode>[];
+    }
+
+    final serialized = instance.inSeconds.toString();
+    return <xml.XmlNode>[
+      xml.XmlText(serialized),
+    ];
+  }
+}
diff --git a/packages/nextcloud/lib/webdav.dart b/packages/nextcloud/lib/webdav.dart
@@ -7,7 +7,7 @@ export 'src/webdav/file.dart';
 export 'src/webdav/models.dart';
 export 'src/webdav/path_uri.dart';
 export 'src/webdav/props.dart';
-export 'src/webdav/utils.dart' hide constructUri;
+export 'src/webdav/utils.dart' hide DurationXMLConverter, constructUri;
 export 'src/webdav/webdav.dart';
 
 // ignore: public_member_api_docs