files: Cleanup folder provider and breadcrumbs bar

dvd-bnc · dvd-bnc · commit fc91b40cd072 · 2023-03-07T07:57:27.000+01:00
Also cool new feature the breadcrumbs bar will show a customized chip
if the user is navigating inside a builtin folder (much like how windows
and ubuntu already do it)
diff --git a/lib/backend/folder_provider.dart b/lib/backend/folder_provider.dart
@@ -18,23 +18,29 @@ limitations under the License.
 
 import 'dart:io';
 
+import 'package:collection/collection.dart';
 import 'package:flutter/material.dart';
 import 'package:windows_path_provider/windows_path_provider.dart';
 import 'package:xdg_directories/xdg_directories.dart';
 
 class FolderProvider {
-  final Map<String, IconData> directories;
+  final List<BuiltinFolder> _folders;
+
+  List<BuiltinFolder> get folders => List.from(_folders);
 
   static Future<FolderProvider> init() async {
-    final Map<String, IconData> directories = {};
+    final List<BuiltinFolder> folders = [];
 
     if (Platform.isWindows) {
       for (final WindowsFolder folder in WindowsFolder.values) {
         final String? path = await WindowsPathProvider.getPath(folder);
 
-        if (path != null) {
-          directories[path] = icons[windowsFolderToString(folder)]!;
-        }
+        if (path == null) continue;
+
+        final FolderType? type = folder.toFolderType();
+        if (type == null) continue;
+
+        folders.add(BuiltinFolder(type, Directory(path)));
       }
     } else if (Platform.isLinux) {
       final Set<String> dirNames = getUserDirectoryNames();
@@ -43,31 +49,77 @@ class FolderProvider {
           .path
           .split(Platform.pathSeparator)
         ..removeLast();
-      directories[backDir.join(Platform.pathSeparator)] = icons["HOME"]!;
+      folders.add(
+        BuiltinFolder(
+          FolderType.home,
+          Directory(backDir.join(Platform.pathSeparator)),
+        ),
+      );
 
       for (final String element in dirNames) {
-        directories[getUserDirectory(element)!.path] = icons[element]!;
+        final FolderType? type = FolderType.fromString(element);
+        if (type == null) continue;
+
+        folders.add(
+          BuiltinFolder(
+            type,
+            Directory(getUserDirectory(element)!.path),
+          ),
+        );
       }
     } else {
       throw Exception("Platform not supported");
     }
 
-    return FolderProvider(directories);
+    return FolderProvider._(folders);
   }
 
-  const FolderProvider(this.directories);
+  const FolderProvider._(this._folders);
+
+  IconData getIconForType(FolderType type) {
+    return _icons[type]!;
+  }
+
+  BuiltinFolder? isBuiltinFolder(String path) {
+    return _folders.firstWhereOrNull((v) => v.directory.path == path);
+  }
 }
 
-const Map<String, IconData> icons = {
-  "HOME": Icons.home_filled,
-  "DESKTOP": Icons.desktop_windows,
-  "DOCUMENTS": Icons.note_outlined,
-  "PICTURES": Icons.photo_library_outlined,
-  "DOWNLOAD": Icons.file_download,
-  "VIDEOS": Icons.videocam_outlined,
-  "MUSIC": Icons.music_note_outlined,
-  "PUBLICSHARE": Icons.public_outlined,
-  "TEMPLATES": Icons.file_copy_outlined,
+enum FolderType {
+  home,
+  desktop,
+  documents,
+  pictures,
+  download,
+  videos,
+  music,
+  publicShare,
+  templates;
+
+  static FolderType? fromString(String value) {
+    return FolderType.values
+        .asNameMap()
+        .map((k, v) => MapEntry(k.toUpperCase(), v))[value.toUpperCase()];
+  }
+}
+
+class BuiltinFolder {
+  final FolderType type;
+  final Directory directory;
+
+  const BuiltinFolder(this.type, this.directory);
+}
+
+const Map<FolderType, IconData> _icons = {
+  FolderType.home: Icons.home_filled,
+  FolderType.desktop: Icons.desktop_windows,
+  FolderType.documents: Icons.note_outlined,
+  FolderType.pictures: Icons.photo_library_outlined,
+  FolderType.download: Icons.file_download,
+  FolderType.videos: Icons.videocam_outlined,
+  FolderType.music: Icons.music_note_outlined,
+  FolderType.publicShare: Icons.public_outlined,
+  FolderType.templates: Icons.file_copy_outlined,
 };
 
 String windowsFolderToString(WindowsFolder folder) {
@@ -92,3 +144,16 @@ String windowsFolderToString(WindowsFolder folder) {
       return "TEMPLATES";
   }
 }
+
+extension on WindowsFolder {
+  FolderType? toFolderType() {
+    switch (this) {
+      case WindowsFolder.profile:
+        return FolderType.home;
+      case WindowsFolder.public:
+        return FolderType.publicShare;
+      default:
+        return FolderType.fromString(name);
+    }
+  }
+}
diff --git a/lib/backend/path_parts.dart b/lib/backend/path_parts.dart
@@ -40,6 +40,15 @@ class PathParts {
     return "$root$path";
   }
 
+  PathParts trim(int numOfParts) {
+    assert(numOfParts >= 0 && numOfParts <= parts.length);
+    final List<String> transformedPathParts = parts.sublist(0, numOfParts);
+
+    return PathParts(root, transformedPathParts, separator);
+  }
+
+  List<String> get integralParts => [root, ...parts];
+
   @override
   String toString() {
     return {
diff --git a/lib/backend/providers.dart b/lib/backend/providers.dart
@@ -19,6 +19,7 @@ Future<void> initProviders() async {
   final isar = await Isar.open(
     [EntityStatSchema],
     directory: _isarPath(dir),
+    inspector: false,
   );
   final folderProvider = await FolderProvider.init();
 
diff --git a/lib/backend/utils.dart b/lib/backend/utils.dart
@@ -1,5 +1,6 @@
 import 'dart:io';
 
+import 'package:files/backend/folder_provider.dart';
 import 'package:files/backend/path_parts.dart';
 import 'package:files/backend/providers.dart';
 import 'package:flutter/material.dart';
@@ -58,14 +59,17 @@ class Utils {
   }
 
   static IconData iconForFolder(String path) {
-    final IconData? builtinFolderIcon = folderProvider.directories[path];
+    final BuiltinFolder? builtinFolder = folderProvider.isBuiltinFolder(path);
+    final IconData? builtinFolderIcon = builtinFolder != null
+        ? folderProvider.getIconForType(builtinFolder.type)
+        : null;
 
     return builtinFolderIcon ?? Icons.folder;
   }
 
   static String getEntityName(String path) {
     final PathParts pathParts = PathParts.parse(path);
-    return pathParts.parts.isNotEmpty ? pathParts.parts.last : pathParts.root;
+    return pathParts.integralParts.last;
   }
 
   static void moveFileToDest(FileSystemEntity origin, String dest) {
diff --git a/lib/main.dart b/lib/main.dart
@@ -15,6 +15,7 @@ limitations under the License.
 */
 
 import 'package:animations/animations.dart';
+import 'package:files/backend/folder_provider.dart';
 import 'package:files/backend/providers.dart';
 import 'package:files/backend/utils.dart';
 import 'package:files/widgets/context_menu/context_menu_theme.dart';
@@ -90,13 +91,12 @@ class _FilesHomeState extends State<FilesHome> {
   @override
   void initState() {
     super.initState();
-    for (final MapEntry<String, IconData> element
-        in folderProvider.directories.entries) {
+    for (final BuiltinFolder element in folderProvider.folders) {
       sideDestinations.add(
         SideDestination(
-          element.value,
-          Utils.getEntityName(element.key),
-          element.key,
+          folderProvider.getIconForType(element.type),
+          Utils.getEntityName(element.directory.path),
+          element.directory.path,
         ),
       );
     }
diff --git a/lib/widgets/breadcrumbs_bar.dart b/lib/widgets/breadcrumbs_bar.dart
@@ -1,12 +1,15 @@
 import 'dart:io';
 
+import 'package:collection/collection.dart';
+import 'package:files/backend/folder_provider.dart';
 import 'package:files/backend/path_parts.dart';
+import 'package:files/backend/providers.dart';
 import 'package:files/backend/utils.dart';
 import 'package:flutter/material.dart';
 
 class BreadcrumbsBar extends StatefulWidget {
   final PathParts path;
-  final ValueChanged<int>? onBreadcrumbPress;
+  final ValueChanged<String>? onBreadcrumbPress;
   final ValueChanged<String>? onPathSubmitted;
   final List<Widget>? leading;
   final List<Widget>? actions;
@@ -86,38 +89,7 @@ class _BreadcrumbsBarState extends State<BreadcrumbsBar> {
                         child: Container(
                           height: double.infinity,
                           alignment: AlignmentDirectional.centerStart,
-                          child: focusNode.hasFocus
-                              ? TextField(
-                                  decoration: const InputDecoration(
-                                    border: InputBorder.none,
-                                    contentPadding:
-                                        EdgeInsets.symmetric(horizontal: 8),
-                                    isCollapsed: true,
-                                  ),
-                                  focusNode: focusNode,
-                                  controller: controller,
-                                  style: const TextStyle(fontSize: 14),
-                                  onSubmitted: widget.onPathSubmitted,
-                                )
-                              : ListView.separated(
-                                  scrollDirection: Axis.horizontal,
-                                  itemBuilder: (context, index) {
-                                    if (index == 0) {
-                                      return _buildItemChip(
-                                        index,
-                                        widget.path.root,
-                                      );
-                                    } else {
-                                      return _buildItemChip(
-                                        index,
-                                        widget.path.parts[index - 1],
-                                      );
-                                    }
-                                  },
-                                  itemCount: widget.path.parts.length + 1,
-                                  separatorBuilder: (context, index) =>
-                                      const VerticalDivider(width: 2),
-                                ),
+                          child: _guts,
                         ),
                       ),
                     ),
@@ -133,25 +105,111 @@ class _BreadcrumbsBarState extends State<BreadcrumbsBar> {
     );
   }
 
-  Widget _buildItemChip(int index, String part) {
+  Widget get _guts {
+    if (focusNode.hasFocus) {
+      return TextField(
+        decoration: const InputDecoration(
+          border: InputBorder.none,
+          contentPadding: EdgeInsets.symmetric(horizontal: 8),
+          isCollapsed: true,
+        ),
+        focusNode: focusNode,
+        controller: controller,
+        style: const TextStyle(fontSize: 14),
+        onSubmitted: widget.onPathSubmitted,
+      );
+    } else {
+      final List<PathParts> actualParts;
+
+      // We need home folder on last position here to emulate a low priority entry
+      final List<BuiltinFolder> sortedFolders = folderProvider.folders;
+      final int homeIndex =
+          sortedFolders.indexWhere((e) => e.type == FolderType.home);
+      sortedFolders.add(sortedFolders.removeAt(homeIndex));
+
+      final BuiltinFolder? builtinFolder = sortedFolders.firstWhereOrNull(
+        (e) => widget.path.toPath().startsWith(e.directory.path),
+      );
+
+      if (builtinFolder != null) {
+        final PathParts builtinParts =
+            PathParts.parse(builtinFolder.directory.path);
+        actualParts = [
+          builtinParts,
+          ...List.generate(
+            widget.path.integralParts.length -
+                builtinParts.integralParts.length,
+            (index) =>
+                widget.path.trim(index + builtinParts.integralParts.length),
+          ),
+        ];
+      } else {
+        actualParts = List.generate(
+          widget.path.integralParts.length,
+          (index) => widget.path.trim(index),
+        );
+      }
+
+      return ListView.separated(
+        scrollDirection: Axis.horizontal,
+        itemBuilder: (context, index) {
+          final bool isInsideBuiltin = builtinFolder != null &&
+              actualParts[index].toPath() == builtinFolder.directory.path;
+
+          return _BreadcrumbChip(
+            path: actualParts[index],
+            onTap: widget.onBreadcrumbPress,
+            childOverride: isInsideBuiltin
+                ? Row(
+                    children: [
+                      Icon(
+                        folderProvider.getIconForType(builtinFolder.type),
+                        size: 16,
+                      ),
+                      const SizedBox(width: 8),
+                      Text(Utils.getEntityName(builtinFolder.directory.path)),
+                    ],
+                  )
+                : null,
+          );
+        },
+        itemCount: actualParts.length,
+        separatorBuilder: (context, index) => const VerticalDivider(width: 2),
+      );
+    }
+  }
+}
+
+class _BreadcrumbChip extends StatelessWidget {
+  const _BreadcrumbChip({
+    required this.path,
+    this.onTap,
+    this.childOverride,
+  });
+
+  final PathParts path;
+  final ValueChanged<String>? onTap;
+  final Widget? childOverride;
+
+  @override
+  Widget build(BuildContext context) {
     return SizedBox(
       height: double.infinity,
       child: DragTarget<FileSystemEntity>(
-        onAccept: (data) =>
-            Utils.moveFileToDest(data, widget.path.toPath(index)),
+        onAccept: (data) => Utils.moveFileToDest(data, path.toPath()),
         builder: (context, candidateData, rejectedData) {
           return InkWell(
             child: Row(
               children: [
                 Container(
                   alignment: Alignment.center,
                   padding: const EdgeInsetsDirectional.only(start: 12, end: 4),
-                  child: Text(part),
+                  child: childOverride ?? Text(path.integralParts.last),
                 ),
                 const Icon(Icons.chevron_right, size: 16),
               ],
             ),
-            onTap: () => widget.onBreadcrumbPress?.call(index),
+            onTap: () => onTap?.call(path.toPath()),
           );
         },
       ),
diff --git a/lib/widgets/workspace.dart b/lib/widgets/workspace.dart
