Merge pull request #2455 from nextcloud/feat/nextcloud/webdav-extended-mkcol

feat(nextcloud): Implement WebDAV extended MKCOL

Author: Leptopoda

packages/nextcloud/lib/src/api/webdav/models/webdav.dart

@@ -88,6 +88,18 @@ class WebDavPropertyupdate with _$WebDavPropertyupdateXmlSerializableMixin {
   final WebDavRemove? remove;
 }
 
+@immutable
+@annotation.XmlSerializable(createMixin: true)
+@annotation.XmlRootElement(name: 'mkcol', namespace: namespaceDav)
+class WebDavMkcol with _$WebDavMkcolXmlSerializableMixin {
+  const WebDavMkcol({
+    this.set,
+  });
+
+  @annotation.XmlElement(name: 'set', namespace: namespaceDav, includeIfNull: false)
+  final WebDavSet? set;
+}
+
 @immutable
 @annotation.XmlSerializable(createMixin: true)
 @annotation.XmlRootElement(name: 'set', namespace: namespaceDav)

packages/nextcloud/lib/src/api/webdav/models/webdav.g.dart

@@ -1,7 +1,6 @@
 // ignore_for_file: non_constant_identifier_names
 
 import 'dart:async';
-import 'dart:convert';
 import 'dart:typed_data';
 
 import 'package:http/http.dart' as http;
@@ -62,23 +61,41 @@ class WebDavClient {
 
   /// Returns a request to create a collection at [path].
   ///
+  /// The props in [set] will be added.
+  ///
   /// See:
-  ///   * http://www.webdav.org/specs/rfc2518.html#METHOD_MKCOL for more information.
+  ///   * http://www.webdav.org/specs/rfc2518.html#METHOD_MKCOL and http://www.webdav.org/specs/rfc5689.html for more information.
   ///   * [mkcol] for a complete operation executing this request.
-  http.Request mkcol_Request(PathUri path) {
+  http.Request mkcol_Request(
+    PathUri path, {
+    WebDavProp? set,
+  }) {
     final request = http.Request('MKCOL', _constructUri(path));
+    if (set != null) {
+      request.body = WebDavMkcol(
+        set: WebDavSet(prop: set),
+      ).toXmlElement(namespaces: namespaces).toXmlString();
+    }
 
     _addBaseHeaders(request);
     return request;
   }
 
   /// Creates a collection at [path].
   ///
+  /// The props in [set] will be added.
+  ///
   /// See:
-  ///  * http://www.webdav.org/specs/rfc2518.html#METHOD_MKCOL for more information.
+  ///  * http://www.webdav.org/specs/rfc2518.html#METHOD_MKCOL and http://www.webdav.org/specs/rfc5689.html for more information.
   ///  * [mkcol_Request] for the request sent by this method.
-  Future<http.StreamedResponse> mkcol(PathUri path) {
-    final request = mkcol_Request(path);
+  Future<http.StreamedResponse> mkcol(
+    PathUri path, {
+    WebDavProp? set,
+  }) {
+    final request = mkcol_Request(
+      path,
+      set: set,
+    );
 
     return csrfClient.send(request);
   }
@@ -412,7 +429,6 @@ class WebDavClient {
     WebDavDepth? depth,
   }) {
     final request = http.Request('PROPFIND', _constructUri(path))
-      ..encoding = utf8
       ..body = WebDavPropfind(prop: prop ?? const WebDavPropWithoutValues())
           .toXmlElement(namespaces: namespaces)
           .toXmlString();
@@ -461,7 +477,6 @@ class WebDavClient {
     WebDavPropWithoutValues? prop,
   }) {
     final request = http.Request('REPORT', _constructUri(path))
-      ..encoding = utf8
       ..body = WebDavOcFilterFiles(
         filterRules: filterRules,
         prop: prop ?? const WebDavPropWithoutValues(), // coverage:ignore-line
@@ -508,7 +523,6 @@ class WebDavClient {
     WebDavPropWithoutValues? remove,
   }) {
     final request = http.Request('PROPPATCH', _constructUri(path))
-      ..encoding = utf8
       ..body = WebDavPropertyupdate(
         set: set != null ? WebDavSet(prop: set) : null,
         remove: remove != null ? WebDavRemove(prop: remove) : null,

packages/nextcloud/lib/src/api/webdav/webdav_client.dart

@@ -523,6 +523,26 @@ void main() {
       );
     });
 
+    test('Extended mkcol', () async {
+      final response = await tester.client.webdav.mkcol(
+        PathUri.parse('test/extended-mkcol'),
+        set: const WebDavProp(
+          davResourcetype: WebDavResourcetype(collection: [null]),
+          ocTags: WebDavOcTags(tags: ['extended']),
+        ),
+      );
+      expect(response.statusCode, 201);
+
+      final propfindResponse = await tester.client.webdav.propfind(
+        PathUri.parse('test/extended-mkcol'),
+        prop: const WebDavPropWithoutValues.fromBools(
+          ocTags: true,
+        ),
+      );
+      final props = propfindResponse.responses.single.propstats.first.prop;
+      expect(props.ocTags!.tags!.single, 'extended');
+    });
+
     group('litmus', () {
       group('basic', () {
         test('options', () async {

packages/nextcloud/test/api/webdav/webdav_test.dart

@@ -0,0 +1,12 @@
+MKCOL http://localhost/remote\.php/webdav/test/extended-mkcol
+authorization: Bearer mock
+content-type: application/xml
+ocs-apirequest: true
+requesttoken: token
+<d:mkcol xmlns:d="DAV:" xmlns:oc="http://owncloud\.org/ns" xmlns:nc="http://nextcloud\.org/ns" xmlns:ocs="http://open-collaboration-services\.org/ns" xmlns:ocm="http://open-cloud-mesh\.org/ns"><d:set><d:prop><d:resourcetype><d:collection/></d:resourcetype><oc:tags><oc:tag>extended</oc:tag></oc:tags></d:prop></d:set></d:mkcol>
+PROPFIND http://localhost/remote\.php/webdav/test/extended-mkcol
+authorization: Bearer mock
+content-type: application/xml
+ocs-apirequest: true
+requesttoken: token
+<d:propfind xmlns:d="DAV:" xmlns:oc="http://owncloud\.org/ns" xmlns:nc="http://nextcloud\.org/ns" xmlns:ocs="http://open-collaboration-services\.org/ns" xmlns:ocm="http://open-cloud-mesh\.org/ns"><d:prop><oc:tags/></d:prop></d:propfind>