feat(nextcloud)!: Allow configurable WebDAV endpoint

Signed-off-by: provokateurin <[email protected]>
nextcloud · Jul 27, 2024 · 6b76021 · 6b76021
1 parent 8bb843d
commit 6b76021
Show file tree

Hide file tree

Showing 11 changed files with 416 additions and 337 deletions.
diff --git a/packages/neon/neon_files/lib/src/blocs/browser.dart b/packages/neon/neon_files/lib/src/blocs/browser.dart
@@ -91,19 +91,19 @@ class _FilesBrowserBloc extends InteractiveBloc implements FilesBrowserBloc {
     await RequestManager.instance.wrap(
       account: account,
       subject: files,
-      getRequest: () => account.client.webdav.propfind_Request(
-        uri.value,
-        prop: const WebDavPropWithoutValues.fromBools(
-          davGetcontenttype: true,
-          davGetetag: true,
-          davGetlastmodified: true,
-          ncHasPreview: true,
-          ncMetadataBlurhash: true,
-          ocSize: true,
-          ocFavorite: true,
-        ),
-        depth: WebDavDepth.one,
-      ),
+      getRequest: () => account.client.webdav().propfind_Request(
+            uri.value,
+            prop: const WebDavPropWithoutValues.fromBools(
+              davGetcontenttype: true,
+              davGetetag: true,
+              davGetlastmodified: true,
+              ncHasPreview: true,
+              ncMetadataBlurhash: true,
+              ocSize: true,
+              ocFavorite: true,
+            ),
+            depth: WebDavDepth.one,
+          ),
       converter: const WebDavResponseConverter(),
       unwrap: (response) => BuiltList<WebDavFile>.build((b) {
         for (final file in response.toWebDavFiles()) {
@@ -144,6 +144,6 @@ class _FilesBrowserBloc extends InteractiveBloc implements FilesBrowserBloc {
 
   @override
   Future<void> createFolder(PathUri uri) async {
-    await wrapAction(() async => account.client.webdav.mkcol(uri));
+    await wrapAction(() async => account.client.webdav().mkcol(uri));
   }
 }
diff --git a/packages/neon/neon_files/lib/src/blocs/files.dart b/packages/neon/neon_files/lib/src/blocs/files.dart
@@ -164,46 +164,46 @@ class _FilesBloc extends InteractiveBloc implements FilesBloc {
 
   @override
   Future<void> delete(PathUri uri) async {
-    await wrapAction(() async => account.client.webdav.delete(uri));
+    await wrapAction(() async => account.client.webdav().delete(uri));
   }
 
   @override
   Future<void> rename(PathUri uri, String name) async {
     await wrapAction(
-      () async => account.client.webdav.move(
-        uri,
-        uri.rename(name),
-      ),
+      () async => account.client.webdav().move(
+            uri,
+            uri.rename(name),
+          ),
     );
   }
 
   @override
   Future<void> move(PathUri uri, PathUri destination) async {
-    await wrapAction(() async => account.client.webdav.move(uri, destination));
+    await wrapAction(() async => account.client.webdav().move(uri, destination));
   }
 
   @override
   Future<void> copy(PathUri uri, PathUri destination) async {
-    await wrapAction(() async => account.client.webdav.copy(uri, destination));
+    await wrapAction(() async => account.client.webdav().copy(uri, destination));
   }
 
   @override
   Future<void> addFavorite(PathUri uri) async {
     await wrapAction(
-      () async => account.client.webdav.proppatch(
-        uri,
-        set: const WebDavProp(ocFavorite: true),
-      ),
+      () async => account.client.webdav().proppatch(
+            uri,
+            set: const WebDavProp(ocFavorite: true),
+          ),
     );
   }
 
   @override
   Future<void> removeFavorite(PathUri uri) async {
     await wrapAction(
-      () async => account.client.webdav.proppatch(
-        uri,
-        set: const WebDavProp(ocFavorite: false),
-      ),
+      () async => account.client.webdav().proppatch(
+            uri,
+            set: const WebDavProp(ocFavorite: false),
+          ),
     );
   }
 

diff --git a/packages/neon/neon_files/lib/src/utils/task.dart b/packages/neon/neon_files/lib/src/utils/task.dart
@@ -67,11 +67,11 @@ class FilesDownloadTaskIO extends FilesTaskIO implements FilesDownloadTask {
   });
 
   Future<void> execute(NextcloudClient client) async {
-    await client.webdav.getFile(
-      uri,
-      file,
-      onProgress: progressController.add,
-    );
+    await client.webdav().getFile(
+          uri,
+          file,
+          onProgress: progressController.add,
+        );
     await progressController.close();
   }
 }
@@ -91,13 +91,13 @@ class FilesUploadTaskIO extends FilesTaskIO implements FilesUploadTask {
   late tz.TZDateTime lastModified = tz.TZDateTime.from(_stat.modified, tz.UTC);
 
   Future<void> execute(NextcloudClient client) async {
-    await client.webdav.putFile(
-      file,
-      _stat,
-      uri,
-      lastModified: _stat.modified,
-      onProgress: progressController.add,
-    );
+    await client.webdav().putFile(
+          file,
+          _stat,
+          uri,
+          lastModified: _stat.modified,
+          onProgress: progressController.add,
+        );
     await progressController.close();
   }
 }
@@ -108,10 +108,10 @@ class FilesDownloadTaskMemory extends FilesTaskMemory implements FilesDownloadTa
   });
 
   Future<void> execute(NextcloudClient client) async {
-    final stream = client.webdav.getStream(
-      uri,
-      onProgress: progressController.add,
-    );
+    final stream = client.webdav().getStream(
+          uri,
+          onProgress: progressController.add,
+        );
     await stream.pipe(_stream);
     await progressController.close();
   }
@@ -134,13 +134,13 @@ class FilesUploadTaskMemory extends FilesTaskMemory implements FilesUploadTask {
   final tz.TZDateTime? lastModified;
 
   Future<void> execute(NextcloudClient client) async {
-    await client.webdav.putStream(
-      _stream.stream,
-      uri,
-      lastModified: lastModified,
-      contentLength: size,
-      onProgress: progressController.add,
-    );
+    await client.webdav().putStream(
+          _stream.stream,
+          uri,
+          lastModified: lastModified,
+          contentLength: size,
+          onProgress: progressController.add,
+        );
     await progressController.close();
   }
 }
diff --git a/packages/neon_http_client/lib/src/interceptors/csrf_interceptor.dart b/packages/neon_http_client/lib/src/interceptors/csrf_interceptor.dart
@@ -1,11 +1,10 @@
 import 'dart:convert';
 
+import 'package:dynamite_runtime/http_client.dart';
 import 'package:http/http.dart' as http;
 import 'package:logging/logging.dart';
 import 'package:meta/meta.dart';
 import 'package:neon_http_client/src/interceptors/http_interceptor.dart';
-import 'package:nextcloud/nextcloud.dart';
-import 'package:nextcloud/webdav.dart';
 import 'package:universal_io/io.dart';
 
 /// A HttpInterceptor that works around a Nextcloud CSRF bug when cookies are sent.
@@ -44,7 +43,7 @@ final class CSRFInterceptor implements HttpInterceptor {
 
   @override
   bool shouldInterceptRequest(http.BaseRequest request) {
-    if (request.url.host != _baseURL.host || !request.url.path.startsWith('${_baseURL.path}$webdavBase')) {
+    if (request.url.host != _baseURL.host || !request.url.path.startsWith('${_baseURL.path}/remote.php')) {
       return false;
     }
 

diff --git a/packages/neon_http_client/pubspec.yaml b/packages/neon_http_client/pubspec.yaml
@@ -12,10 +12,13 @@ dependencies:
     git:
       url: https://github.com/nextcloud/neon
       path: packages/cookie_store
+  dynamite_runtime:
+    git:
+      url: https://github.com/nextcloud/neon
+      path: packages/dynamite/dynamite_runtime
   http: ^1.0.0
   logging: ^1.0.0
   meta: ^1.0.0
-  nextcloud: ^6.1.0
   universal_io: ^2.0.0
 
 dev_dependencies:

diff --git a/packages/nextcloud/lib/src/api/webdav/models/webdav_file.dart b/packages/nextcloud/lib/src/api/webdav/models/webdav_file.dart
@@ -4,18 +4,28 @@ import 'package:timezone/timezone.dart' as tz;
 // ignore: public_member_api_docs
 extension WebDavMultistatusFile on WebDavMultistatus {
   /// Convert the [WebDavMultistatus] into a [WebDavFile] for easier handling
-  List<WebDavFile> toWebDavFiles() =>
-      responses.where((response) => response.href != null).map((response) => WebDavFile(response: response)).toList();
+  List<WebDavFile> toWebDavFiles({String endpoint = 'remote.php/webdav'}) => responses
+      .where((response) => response.href != null)
+      .map(
+        (response) => WebDavFile(
+          response: response,
+          endpoint: endpoint,
+        ),
+      )
+      .toList();
 }
 
 /// WebDavFile class
 class WebDavFile {
   /// Creates a new WebDavFile object with the given path
   WebDavFile({
     required WebDavResponse response,
-  }) : _response = response;
+    required String endpoint,
+  })  : _response = response,
+        _endpoint = PathUri.parse(endpoint);
 
   final WebDavResponse _response;
+  final PathUri _endpoint;
 
   /// Get the props of the file
   late final WebDavProp props = _response.propstats.singleWhere((propstat) => propstat.status.contains('200')).prop;
@@ -26,7 +36,7 @@ class WebDavFile {
     return PathUri(
       isAbsolute: false,
       isDirectory: href.isDirectory,
-      pathSegments: href.pathSegments.sublist(webdavBase.pathSegments.length),
+      pathSegments: href.pathSegments.sublist(_endpoint.pathSegments.length),
     );
   }();
 

diff --git a/packages/nextcloud/lib/src/api/webdav/utils/webdav_uri.dart b/packages/nextcloud/lib/src/api/webdav/utils/webdav_uri.dart
@@ -1,13 +1,10 @@
 import 'package:meta/meta.dart';
 import 'package:nextcloud/src/api/webdav/webdav.dart';
 
-/// Base path used on the server
-final webdavBase = PathUri.parse('/remote.php/webdav');
-
 /// Constructs the uri for a webdav request for a given server [baseURL] and file [path].
 @internal
-Uri constructUri(Uri baseURL, [PathUri? path]) {
-  final segments = baseURL.pathSegments.toList()..addAll(webdavBase.pathSegments);
+Uri constructUri(Uri baseURL, String endpoint, [PathUri? path]) {
+  final segments = baseURL.pathSegments.toList()..addAll(PathUri.parse(endpoint).pathSegments);
   if (path != null) {
     segments.addAll(path.pathSegments);
   }

diff --git a/packages/nextcloud/lib/src/api/webdav/webdav_client.dart b/packages/nextcloud/lib/src/api/webdav/webdav_client.dart
@@ -13,7 +13,10 @@ import 'package:universal_io/io.dart' show File, FileStat;
 /// WebDavClient class
 class WebDavClient {
   // ignore: public_member_api_docs
-  WebDavClient(this.rootClient) : csrfClient = WebDavCSRFClient(rootClient);
+  WebDavClient(
+    this.rootClient, {
+    this.endpoint = 'remote.php/webdav',
+  }) : csrfClient = WebDavCSRFClient(rootClient);
 
   // ignore: public_member_api_docs
   final NextcloudClient rootClient;
@@ -22,7 +25,12 @@ class WebDavClient {
   // TODO: Fix this bug in server.
   final WebDavCSRFClient csrfClient;
 
-  Uri _constructUri([PathUri? path]) => constructUri(rootClient.baseURL, path);
+  /// WebDAV endpoint used for all operations.
+  ///
+  /// Defaults to `remote.php/webdav` for accessing "Files".
+  final String endpoint;
+
+  Uri _constructUri([PathUri? path]) => constructUri(rootClient.baseURL, endpoint, path);
 
   /// Request to get the WebDAV capabilities of the server.
   ///

diff --git a/packages/nextcloud/lib/webdav.dart b/packages/nextcloud/lib/webdav.dart
@@ -6,8 +6,17 @@ export 'src/api/webdav/webdav.dart' hide DurationXMLConverter, WebDavCSRFClient,
 
 // ignore: public_member_api_docs
 extension WebDAVExtension on NextcloudClient {
-  static final _webdav = Expando<WebDavClient>();
+  static final _webdav = Expando<Map<String, WebDavClient>>();
 
-  /// Client for WebDAV
-  WebDavClient get webdav => _webdav[this] ??= WebDavClient(this);
+  /// Client for WebDAV.
+  ///
+  /// Defaults to `remote.php/webdav` for accessing "Files".
+  WebDavClient webdav({String endpoint = 'remote.php/webdav'}) {
+    _webdav[this] ??= {};
+
+    return _webdav[this]![endpoint] ??= WebDavClient(
+      this,
+      endpoint: endpoint,
+    );
+  }
 }
diff --git a/packages/nextcloud/test/core_test.dart b/packages/nextcloud/test/core_test.dart
@@ -133,10 +133,10 @@ void main() {
       group('Preview', () {
         test('Get', () async {
           final file = File('test/files/test.png');
-          await client.webdav.putFile(file, file.statSync(), PathUri.parse('preview.png'));
+          await client.webdav().putFile(file, file.statSync(), PathUri.parse('preview.png'));
           addTearDown(() async {
             closeFixture();
-            await client.webdav.delete(PathUri.parse('preview.png'));
+            await client.webdav().delete(PathUri.parse('preview.png'));
           });
 
           final response = await client.core.preview.getPreview(