feat(neon_files): Implement file syncing

Signed-off-by: jld3103 <[email protected]>

packages/app/pubspec.lock

@@ -1397,6 +1397,14 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "1.1.0"
+  watcher:
+    dependency: transitive
+    description:
+      name: watcher
+      sha256: "3d2ad6751b3c16cf07c7fca317a1413b3f26530319181b37e3b9039b84fc01d8"
+      url: "https://pub.dev"
+    source: hosted
+    version: "1.1.0"
   web:
     dependency: transitive
     description:

packages/neon/neon_files/lib/src/app.dart

@@ -5,6 +5,7 @@ import 'package:neon_files/src/blocs/files.dart';
 import 'package:neon_files/src/options.dart';
 import 'package:neon_files/src/pages/main.dart';
 import 'package:neon_files/src/routes.dart';
+import 'package:neon_files/src/sync/implementation.dart';
 import 'package:neon_framework/models.dart';
 import 'package:nextcloud/nextcloud.dart';
 
@@ -32,6 +33,9 @@ class FilesApp extends AppImplementation<FilesBloc, FilesOptions> {
   @override
   final Widget page = const FilesMainPage();
 
+  @override
+  final FilesSync syncImplementation = const FilesSync();
+
   @override
   final RouteBase route = $filesAppRoute;
 }

packages/neon/neon_files/lib/src/blocs/files.dart

@@ -89,6 +89,21 @@ class _FilesBloc extends InteractiveBloc implements FilesBloc {
   @override
   BehaviorSubject<List<FilesTask>> tasks = BehaviorSubject<List<FilesTask>>.seeded([]);
 
+  @override
+  Future<void> refresh() async {
+    await browser.refresh();
+  }
+
+  @override
+  void removeFavorite(PathUri uri) {
+    wrapAction(
+      () async => account.client.webdav.proppatch(
+        uri,
+        set: const WebDavProp(ocfavorite: 0),
+      ),
+    );
+  }
+
   @override
   void addFavorite(PathUri uri) {
     wrapAction(
@@ -141,21 +156,6 @@ class _FilesBloc extends InteractiveBloc implements FilesBloc {
     );
   }
 
-  @override
-  Future<void> refresh() async {
-    await browser.refresh();
-  }
-
-  @override
-  void removeFavorite(PathUri uri) {
-    wrapAction(
-      () async => account.client.webdav.proppatch(
-        uri,
-        set: const WebDavProp(ocfavorite: 0),
-      ),
-    );
-  }
-
   @override
   void rename(PathUri uri, String name) {
     wrapAction(

packages/neon/neon_files/lib/src/sync/implementation.dart

@@ -0,0 +1,108 @@
+import 'package:flutter/material.dart';
+import 'package:neon_files/src/blocs/files.dart';
+import 'package:neon_files/src/models/file_details.dart';
+import 'package:neon_files/src/sync/mapping.dart';
+import 'package:neon_files/src/sync/sources.dart';
+import 'package:neon_files/src/utils/dialog.dart';
+import 'package:neon_files/src/widgets/file_tile.dart';
+import 'package:neon_framework/models.dart';
+import 'package:neon_framework/sync.dart';
+import 'package:neon_framework/utils.dart';
+import 'package:nextcloud/ids.dart';
+import 'package:nextcloud/webdav.dart';
+import 'package:permission_handler/permission_handler.dart';
+import 'package:universal_io/io.dart';
+
+@immutable
+class FilesSync implements SyncImplementation<FilesSyncMapping, WebDavFile, FileSystemEntity> {
+  const FilesSync();
+
+  @override
+  String get id => AppIDs.files;
+
+  @override
+  Future<FilesSyncSources> getSources(Account account, FilesSyncMapping mapping) async {
+    // This shouldn't be necessary, but it sadly is because of https://github.com/flutter/flutter/issues/25659.
+    // Alternative would be to use https://pub.dev/packages/shared_storage,
+    // but to be efficient we'd need https://github.com/alexrintt/shared-storage/issues/91
+    // or copy the files to the app cache (which is also not optimal).
+    if (Platform.isAndroid && !await Permission.manageExternalStorage.request().isGranted) {
+      throw const MissingPermissionException(Permission.manageExternalStorage);
+    }
+    return FilesSyncSources(
+      account.client,
+      mapping.remotePath,
+      mapping.localPath,
+    );
+  }
+
+  @override
+  Map<String, dynamic> serializeMapping(FilesSyncMapping mapping) => mapping.toJson();
+
+  @override
+  FilesSyncMapping deserializeMapping(Map<String, dynamic> json) => FilesSyncMapping.fromJson(json);
+
+  @override
+  Future<FilesSyncMapping?> addMapping(BuildContext context, Account account) async {
+    final remotePath = await showChooseFolderDialog(context, PathUri.cwd());
+    if (remotePath == null) {
+      return null;
+    }
+
+    final localPath = await FileUtils.pickDirectory();
+    if (localPath == null) {
+      return null;
+    }
+    if (!context.mounted) {
+      return null;
+    }
+
+    return FilesSyncMapping(
+      appId: AppIDs.files,
+      accountId: account.id,
+      remotePath: remotePath,
+      localPath: Directory(localPath),
+      journal: SyncJournal(),
+    );
+  }
+
+  @override
+  String getMappingDisplayTitle(FilesSyncMapping mapping) {
+    final path = mapping.remotePath.toString();
+    return path.substring(0, path.length - 1);
+  }
+
+  @override
+  String getMappingDisplaySubtitle(FilesSyncMapping mapping) => mapping.localPath.path;
+
+  @override
+  String getMappingId(FilesSyncMapping mapping) =>
+      '${Uri.encodeComponent(mapping.remotePath.toString())}-${Uri.encodeComponent(mapping.localPath.path)}';
+
+  @override
+  Widget getConflictDetailsLocal(BuildContext context, FileSystemEntity object) {
+    final stat = object.statSync();
+    return FilesFileTile(
+      showFullPath: true,
+      filesBloc: NeonProvider.of<FilesBloc>(context),
+      details: FileDetails(
+        uri: PathUri.parse(object.path),
+        size: stat.size,
+        etag: '',
+        mimeType: '',
+        lastModified: stat.modified,
+        hasPreview: false,
+        isFavorite: false,
+      ),
+    );
+  }
+
+  @override
+  Widget getConflictDetailsRemote(BuildContext context, WebDavFile object) => FilesFileTile(
+        showFullPath: true,
+        filesBloc: NeonProvider.of<FilesBloc>(context),
+        details: FileDetails.fromWebDav(
+          file: object,
+        ),
+      );
+}

packages/neon/neon_files/lib/src/sync/mapping.dart

@@ -0,0 +1,69 @@
+import 'dart:async';
+
+import 'package:flutter/foundation.dart';
+import 'package:json_annotation/json_annotation.dart';
+import 'package:neon_framework/sync.dart';
+import 'package:nextcloud/webdav.dart' as webdav;
+import 'package:nextcloud/webdav.dart';
+import 'package:universal_io/io.dart';
+import 'package:watcher/watcher.dart';
+
+part 'mapping.g.dart';
+
+@JsonSerializable()
+class FilesSyncMapping implements SyncMapping<webdav.WebDavFile, FileSystemEntity> {
+  FilesSyncMapping({
+    required this.accountId,
+    required this.appId,
+    required this.journal,
+    required this.remotePath,
+    required this.localPath,
+  });
+
+  factory FilesSyncMapping.fromJson(Map<String, dynamic> json) => _$FilesSyncMappingFromJson(json);
+  Map<String, dynamic> toJson() => _$FilesSyncMappingToJson(this);
+
+  @override
+  final String accountId;
+
+  @override
+  final String appId;
+
+  @override
+  final SyncJournal journal;
+
+  @JsonKey(
+    fromJson: PathUri.parse,
+    toJson: _pathUriToJson,
+  )
+  final PathUri remotePath;
+
+  static String _pathUriToJson(PathUri uri) => uri.toString();
+
+  @JsonKey(
+    fromJson: _directoryFromJson,
+    toJson: _directoryToJson,
+  )
+  final Directory localPath;
+
+  static Directory _directoryFromJson(String value) => Directory(value);
+  static String _directoryToJson(Directory value) => value.path;
+
+  StreamSubscription<WatchEvent>? _subscription;
+
+  @override
+  void watch(void Function() onUpdated) {
+    debugPrint('Watching file changes: $localPath');
+    _subscription ??= DirectoryWatcher(localPath.path).events.listen(
+      (event) {
+        debugPrint('Registered file change: ${event.path} ${event.type}');
+        onUpdated();
+      },
+    );
+  }
+
+  @override
+  void dispose() {
+    unawaited(_subscription?.cancel());
+  }
+}