add field FinderFolderField to chose an entire folder

Author: jrief

demoapp/models.py

@@ -1,6 +1,6 @@
 from django.db import models
 
-from finder.models.fields import FinderFileField
+from finder.models.fields import FinderFileField, FinderFolderField
 
 
 class DemoAppModel(models.Model):
@@ -11,3 +11,9 @@ class DemoAppModel(models.Model):
         accept_mime_types=['image/*'],
         realm='admin',
     )
+    folder = FinderFolderField(
+        verbose_name="Demo Folder",
+        null=True,
+        blank=True,
+        realm='admin',
+    )

finder/admin/file.py

@@ -1,7 +1,7 @@
 from django.contrib import admin
+from django.contrib.staticfiles.storage import staticfiles_storage
 from django.forms.widgets import Media
 from django.http.response import HttpResponse, HttpResponseBadRequest, HttpResponseNotFound
-from django.templatetags.static import static
 from django.urls import path, reverse
 from django.utils.html import format_html
 from django.utils.translation import gettext_lazy as _
@@ -24,7 +24,8 @@ def media(self):
         return Media(
             css={'all': ['finder/css/finder-admin.css', 'admin/css/forms.css']},
             js=[format_html(
-                '<script type="module" src="{}"></script>', static('finder/js/file-admin.js')
+                '<script type="module" src="{}"></script>',
+                 staticfiles_storage.url('finder/js/file-admin.js')
             )],
         )
 

finder/admin/folder.py

@@ -1,12 +1,11 @@
 import json
 
 from django.contrib import admin
+from django.contrib.staticfiles.storage import staticfiles_storage
 from django.core.exceptions import ObjectDoesNotExist, ValidationError
 from django.db.models import QuerySet, Subquery
-
 from django.forms.widgets import Media
 from django.http.response import HttpResponse, HttpResponseNotAllowed, HttpResponseNotFound, JsonResponse
-from django.templatetags.static import static
 from django.urls import path, reverse
 from django.utils.translation import gettext
 from django.utils.html import format_html
@@ -29,7 +28,8 @@ def media(self):
         return Media(
             css={'all': ['finder/css/finder-admin.css']},
             js=[format_html(
-                '<script type="module" src="{}"></script>', static('finder/js/folder-admin.js')
+                '<script type="module" src="{}"></script>',
+                staticfiles_storage.url('finder/js/folder-admin.js')
             )],
         )
 

finder/browser/views.py

@@ -47,19 +47,13 @@ def dispatch(self, request, *args, **kwargs):
 
     def _get_children(cls, open_folders, parent):
         children = []
-        for child in parent.subfolders:
-            child_id = str(child.id)
-            if child_id in open_folders:
-                grandchildren = cls._get_children(open_folders, child)
+        for subfolder in parent.subfolders:
+            child = subfolder.as_dict()
+            if str(subfolder.id) in open_folders:
+                child.update(children=cls._get_children(open_folders, subfolder), is_open=True)
             else:
-                grandchildren = None
-            children.append({
-                'id': child_id,
-                'name': child.name,
-                'children': grandchildren,
-                'is_open': grandchildren is not None,
-                'has_subfolders': child.subfolders.exists(),
-            })
+                child.update(children=None, is_open=False)
+            children.append(child)
         return children
 
     def _get_realm(self, request, slug):
@@ -72,9 +66,8 @@ def _get_realm(self, request, slug):
     @method_decorator(require_GET)
     def structure(self, request, slug=None):
         realm = self._get_realm(request, slug)
-        root_folder_id = str(realm.root_folder.id)
         request.session.setdefault('finder.open_folders', [])
-        request.session.setdefault('finder.last_folder', root_folder_id)
+        request.session.setdefault('finder.last_folder', str(realm.root_folder.id))
         last_folder_id = request.session['finder.last_folder']
         if is_open := realm.root_folder.subfolders.exists():
             # direct children of the root folder are open regardless of the `open_folders` session
@@ -93,12 +86,11 @@ def structure(self, request, slug=None):
             children = None
         return {
             'root_folder': {
-                'id': root_folder_id,
+                **realm.root_folder.as_dict(),
                 'name': None,  # the root folder has no readable name
                 'is_root': True,
                 'is_open': is_open,
                 'children': children,
-                'has_subfolders': is_open,
             },
             'labels': [
                 {'value': id, 'label': name, 'color': color}
@@ -271,6 +263,7 @@ def change(self, request, file_id):
 
     @method_decorator(require_POST)
     def crop(self, request, image_id):
+        raise NotImplementedError
         image = FileModel.objects.get_inode(id=image_id, mime_types=['image/*'], is_folder=False)
         width, height = request.POST.get('width'), request.POST.get('height')
         width = int(width) if str(width).isdigit() else None

finder/forms/fields.py

@@ -1,7 +1,7 @@
 from django.forms.fields import UUIDField
 from django.forms.models import ModelMultipleChoiceField
 
-from finder.forms.widgets import FinderFileSelect
+from finder.forms.widgets import FinderFileSelect, FinderFolderSelect
 from finder.models.realm import RealmModel
 
 
@@ -22,6 +22,21 @@ def widget_attrs(self, widget):
         return super().widget_attrs(widget)
 
 
+class FinderFolderField(UUIDField):
+    widget = FinderFolderSelect
+
+    def __init__(self, *args, **kwargs):
+        self.realm = kwargs.pop('realm', None)
+        super().__init__(*args, **kwargs)
+
+    def widget_attrs(self, widget):
+        if isinstance(self.realm, RealmModel):
+            widget.realm = self.realm
+        else:
+            widget.realm = RealmModel.objects.get_default(self.realm)
+        return super().widget_attrs(widget)
+
+
 class LabelsChoiceField(ModelMultipleChoiceField):
     def prepare_value(self, values):
         values = super().prepare_value(values)

finder/forms/widgets.py

@@ -1,30 +1,33 @@
 import json
 import uuid
 
+from django.contrib.staticfiles.storage import staticfiles_storage
 from django.core.serializers.json import DjangoJSONEncoder
 from django.forms.widgets import TextInput
-from django.templatetags.static import static
 from django.urls import reverse
 from django.utils.html import format_html
 
 from finder.models.file import AbstractFileModel, FileModel
+from finder.models.folder import FolderModel
 
 
-class FinderFileSelect(TextInput):
-    template_name = 'finder/widgets/finder_file_select.html'
-    accept_mime_types = None
-
+class FinderInodeSelect(TextInput):
     class Media:
         css = {'all': ['finder/css/finder-select.css']}
         js = [format_html(
             '<script type="module" src="{}"></script>',
-            static('finder/js/finder-select.js')
+            staticfiles_storage.url('finder/js/finder-select.js')
         )]
 
+
+class FinderFileSelect(FinderInodeSelect):
+    template_name = 'finder/widgets/finder_file_select.html'
+    accept_mime_types = None
+
     def get_context(self, name, value, attrs):
         attrs = attrs or {}
         css_classes = attrs.get('class', '').split()
-        css_classes.append('finder-file-field')
+        css_classes.append('finder-hidden-input')
         attrs['class'] = ' '.join(css_classes)
         if isinstance(value, str):
             # file reference has not been stored using a `finder.models.fields.FinderFileField`
@@ -38,15 +41,48 @@ def get_context(self, name, value, attrs):
         context.update(
             base_url=reverse('finder-api:base-url'),
             realm=self.realm.slug,
-            style_url=static('finder/css/finder-browser.css'),
+            style_url=staticfiles_storage.url('finder/css/finder-browser.css'),
         )
         if isinstance(self.accept_mime_types, (list, tuple)) and self.accept_mime_types:
             context['mime_types'] = ','.join(self.accept_mime_types)
         return context
 
     def format_value(self, value):
-        if value == "" or value is None:
+        if value == '' or value is None:
             return None
         if isinstance(value, AbstractFileModel):
             return value.id
         return value
+
+
+class FinderFolderSelect(FinderInodeSelect):
+    template_name = 'finder/widgets/finder_folder_select.html'
+
+    def get_context(self, name, value, attrs):
+        attrs = attrs or {}
+        css_classes = attrs.get('class', '').split()
+        css_classes.append('finder-hidden-input')
+        attrs['class'] = ' '.join(css_classes)
+        if isinstance(value, str):
+            # file reference has not been stored using a `finder.models.fields.FinderFileField`
+            try:
+                value = FolderModel.objects.get(id=uuid.UUID(value))
+            except (ValueError, FolderModel.DoesNotExist):
+                pass
+        if isinstance(value, FolderModel):
+            attrs['data-selected_folder'] = json.dumps(value.as_dict(self.realm), cls=DjangoJSONEncoder)
+        context = super().get_context(name, value, attrs)
+        context.update(
+            base_url=reverse('finder-api:base-url'),
+            realm=self.realm.slug,
+            style_url=staticfiles_storage.url('finder/css/finder-browser.css'),
+            folder_icon_url=staticfiles_storage.url('finder/icons/folder.svg'),
+        )
+        return context
+
+    def format_value(self, value):
+        if value == '' or value is None:
+            return None
+        if isinstance(value, FolderModel):
+            return value.id
+        return value

finder/models/fields.py

@@ -3,8 +3,9 @@
 from django.db.models.fields import UUIDField
 from django.utils.translation import gettext_lazy as _
 
-from finder.forms.fields import FinderFileField as FormFileField
+from finder.forms.fields import FinderFileField as FormFileField, FinderFolderField as FormFolderField
 from finder.models.file import FileModel
+from finder.models.folder import FolderModel
 
 
 class FinderFileField(UUIDField):
@@ -25,14 +26,35 @@ def formfield(self, **kwargs):
             }
         )
 
-    def deconstruct(self):
-        name, path, args, kwargs = super().deconstruct()
-        return name, path, args, kwargs
-
     def from_db_value(self, value, expression, connection):
         if not isinstance(value, uuid.UUID):
             return value
         try:
             return FileModel.objects.get_inode(id=value, is_folder=False, mime_types=self.accept_mime_types)
         except FileModel.DoesNotExist:
             return
+
+
+class FinderFolderField(UUIDField):
+    description = _("Reference to a folder in the finder app.")
+
+    def __init__(self, *args, **kwargs):
+        self.realm = kwargs.pop('realm', None)
+        super().__init__(*args, **kwargs)
+
+    def formfield(self, **kwargs):
+        return super().formfield(
+            **{
+                'form_class': FormFolderField,
+                'realm': self.realm,
+                **kwargs,
+            }
+        )
+
+    def from_db_value(self, value, expression, connection):
+        if not isinstance(value, uuid.UUID):
+            return value
+        try:
+            return FolderModel.objects.get(id=value)
+        except FolderModel.DoesNotExist:
+            return

finder/models/file.py

@@ -146,9 +146,6 @@ def file_path(self):
     def summary(self):
         return filesizeformat(self.file_size)
 
-    def get_meta_data(self):
-        return {}
-
     @classmethod
     @lru_cache
     def mime_types_query(cls):
@@ -173,7 +170,7 @@ def as_dict(self, realm):
             'file_size': self.file_size,
             'sha1': self.sha1,
             'mime_type': self.mime_type,
-            'last_modified_at': self.last_modified_at,
+            'last_modified_at': self.last_modified_at.replace(microsecond=0, tzinfo=None),
             'summary': self.summary,
             'meta_data': self.get_meta_data(),
             'folderitem_component': self.folderitem_component,

finder/models/folder.py

@@ -160,6 +160,17 @@ def summary(self):
             ngettext("{} File", "{} Files", num_files).format(num_files),
         ))
 
+    @lru_cache
+    def as_dict(self, realm=None):
+        return {
+            'id': self.id,
+            'name': self.name,
+            'has_subfolders': self.subfolders.exists(),
+            'last_modified_at': self.last_modified_at.replace(microsecond=0, tzinfo=None),
+            'summary': self.summary,
+            'meta_data': self.get_meta_data(),
+        }
+
     def get_download_url(self, realm):
         return None
 

finder/models/inode.py

@@ -287,6 +287,9 @@ def serializable_value(self, field_name):
             return list(self.labels.values('id', 'name', 'color'))
         return data
 
+    def get_meta_data(self):
+        return {}
+
 
 class DiscardedInode(models.Model):
     """