reverse relation from Folder to Realm-Models

Author: jrief

finder/admin/folder.py

@@ -335,10 +335,12 @@ def undo_discarded_inodes(self, request):
     def erase_trash_folder(self, request):
         if request.method != 'DELETE':
             return HttpResponseBadRequest(f"Method {request.method} not allowed. Only DELETE requests are allowed.")
-        trash_folder = self.get_trash_folder(request)
-        for inode in trash_folder.listdir():
-            DiscardedInode.objects.get(inode=inode.id).delete()
-            inode.delete()
+        trash_folder_entries = self.get_trash_folder(request).listdir()
+        DiscardedInode.objects.filter(inode__in=list(trash_folder_entries.values_list('id', flat=True))).delete()
+        for entry in trash_folder_entries:
+            # bulk delete does not work here because file must be erased from disk
+            dummy_obj = FolderModel.objects.get_proxy_object(entry)
+            dummy_obj.delete()
         fallback_folder = self.get_fallback_folder(request)
         return JsonResponse({
             'success_url': reverse(
@@ -359,7 +361,6 @@ def add_folder(self, request, folder_id):
         new_folder = FolderModel.objects.create(
             name=body['name'],
             parent=parent_folder,
-            realm=self.get_realm(request),
             owner=request.user,
         )
         return JsonResponse({'new_folder': self.serialize_inode(new_folder)})

finder/admin/inode.py

@@ -10,7 +10,8 @@
 from django.urls import path, reverse
 
 from finder.lookups import annotate_unified_queryset, lookup_by_label, sort_by_attribute
-from finder.models.folder import FolderModel, PinnedFolder, RealmModel
+from finder.models.folder import FolderModel, PinnedFolder
+from finder.models.realm import RealmModel
 
 
 class InodeAdmin(admin.ModelAdmin):
@@ -45,7 +46,12 @@ def toggle_pin(self, request, folder_id):
         current_folder = self.get_object(request, folder_id)
         if not (pinned_id := body.get('pinned_id')):
             return HttpResponseBadRequest("No pinned_id provided.")
-        pinned_folder, created = PinnedFolder.objects.get_or_create(owner=request.user, folder_id=pinned_id)
+        realm = self.get_realm(request)
+        pinned_folder, created = PinnedFolder.objects.get_or_create(
+            realm=realm,
+            owner=request.user,
+            folder_id=pinned_id,
+        )
         if created:
             request.session['finder_last_folder_id'] = None
         else:
@@ -86,18 +92,19 @@ def get_realm(self, request):
         return realm
 
     def get_root_folder(self, request):
-        return FolderModel.objects.get_root_folder(self.get_realm(request))
+        realm = self.get_realm(request)
+        return FolderModel.objects.get_root_folder(realm)
 
     def get_trash_folder(self, request):
-        return FolderModel.objects.get_trash_folder(self.get_realm(request), request.user)
+        realm = self.get_realm(request)
+        return FolderModel.objects.get_trash_folder(realm, request.user)
 
     def get_fallback_folder(self, request):
-        realm = self.get_realm(request)
         try:
             last_folder_id = request.session['finder_last_folder_id']
-            return FolderModel.objects.get(id=last_folder_id, realm=realm)
+            return FolderModel.objects.get(id=last_folder_id)
         except (FolderModel.DoesNotExist, KeyError):
-            return FolderModel.objects.get_root_folder(realm)
+            return self.get_root_folder(request)
 
     def get_inodes(self, request, **lookup):
         """
@@ -106,7 +113,7 @@ def get_inodes(self, request, **lookup):
         lookup = dict(lookup_by_label(request), **lookup)
         unified_queryset = FolderModel.objects.filter_unified(**lookup)
         unified_queryset = sort_by_attribute(request, unified_queryset)
-        annotate_unified_queryset(unified_queryset, self.admin_site.name)
+        self.annotate_unified_queryset(unified_queryset)
         return unified_queryset
 
     def get_breadcrumbs(self, obj):
@@ -122,10 +129,11 @@ def get_breadcrumbs(self, obj):
         return breadcrumbs
 
     def get_favorite_folders(self, request, current_folder):
-        realm = self.get_realm(request)
+        site = get_current_site(request)
         folders = PinnedFolder.objects.filter(
+            realm__site=site,
+            realm__slug=self.admin_site.name,
             owner=request.user,
-            folder__realm__id=realm.id,
         ).values(
             'folder__id',
             'folder__name',
@@ -211,3 +219,13 @@ def get_menu_extension_settings(self, request):
         """
         return {}
 
+    def annotate_unified_queryset(self, queryset):
+        annotate_unified_queryset(queryset)
+        for entry in queryset:
+            entry.update(
+                change_url=reverse(
+                    'admin:finder_inodemodel_change',
+                    args=(entry['id'],),
+                    current_app=self.admin_site.name,
+                )
+            )

finder/browser/urls.py

@@ -7,7 +7,7 @@
 app_name = 'finder-api'
 urlpatterns = [
     path(
-        'structure/<slug:realm>',
+        'structure/<slug:slug>',
         BrowserView.as_view(action='structure'),
     ),
     path(

finder/browser/views.py

@@ -9,8 +9,9 @@
 
 from finder.lookups import annotate_unified_queryset, lookup_by_label, sort_by_attribute
 from finder.models.file import FileModel
-from finder.models.folder import FolderModel, RealmModel
+from finder.models.folder import FolderModel
 from finder.models.label import Label
+from finder.models.realm import RealmModel
 
 
 class FormRenderer(DjangoTemplates):
@@ -53,12 +54,15 @@ def _get_children(cls, open_folders, parent):
             })
         return children
 
-    def structure(self, request, realm):
+    def _get_realm(self, request, slug):
         site = get_current_site(request)
         try:
-            realm = RealmModel.objects.get(site=site, slug=realm)
+            return RealmModel.objects.get(site=site, slug=slug)
         except RealmModel.DoesNotExist:
-            raise ObjectDoesNotExist(f"Realm {realm} not found for {site.domain}.")
+            raise ObjectDoesNotExist(f"Realm named {slug} not found for {site.domain}.")
+
+    def structure(self, request, slug):
+        realm = self._get_realm(request, slug)
         root_folder = FolderModel.objects.get_root_folder(realm)
         root_folder_id = str(root_folder.id)
         request.session.setdefault('finder.open_folders', [])
@@ -135,7 +139,7 @@ def list(self, request, folder_id):
         lookup = lookup_by_label(request)
         unified_queryset = FileModel.objects.filter_unified(parent_id=folder_id, is_folder=False, **lookup)
         unified_queryset = sort_by_attribute(request, unified_queryset)
-        annotate_unified_queryset(unified_queryset, folder.realm.slug)
+        annotate_unified_queryset(unified_queryset)
         return {'files': list(unified_queryset)}
 
     def search(self, request, folder_id):
@@ -159,7 +163,7 @@ def search(self, request, folder_id):
             'name_lower__icontains': search_query,
         }
         unified_queryset = FileModel.objects.filter_unified(is_folder=False, **lookup)
-        annotate_unified_queryset(unified_queryset, starting_folder.realm.slug)
+        annotate_unified_queryset(unified_queryset)
         return {'files': list(unified_queryset)}
 
     def upload(self, request, folder_id):

finder/contrib/archive/admin.py

@@ -100,7 +100,6 @@ def unarchive_file(self, request, file_id):
             return HttpResponseBadRequest(f"Method {request.method} not allowed. Only POST requests are allowed.")
         if not (zip_file_obj := self.get_object(request, file_id)):
             return HttpResponseNotFound(f"File {file_id} not found.")
-        realm = self.get_realm(request)
         archive_name = pathlib.Path(zip_file_obj.name)
         if archive_name.suffix in ['.zip', '.tar', '.tar.gz', '.gz']:
             archive_name = archive_name.stem
@@ -109,15 +108,13 @@ def unarchive_file(self, request, file_id):
         if FolderModel.objects.filter(
             name=archive_name,
             parent=zip_file_obj.folder,
-            realm=realm,
         ).exists():
             msg = gettext("Can not extract archive. A folder named “{name}” already exists.")
             return HttpResponseBadRequest(msg.format(name=archive_name), status=409)
         try:
             folder_obj = FolderModel.objects.create(
                 name=archive_name,
                 parent=zip_file_obj.folder,
-                realm=realm,
                 owner=request.user,
             )
             zip_file_path = default_storage.path(zip_file_obj.file_path)
@@ -129,7 +126,6 @@ def unarchive_file(self, request, file_id):
                         FolderModel.objects.create(
                             name=parts[-1],
                             parent=folder_obj.retrieve(parts[:-1]),
-                            realm=realm,
                             owner=request.user,
                         )
                         continue

finder/lookups.py

@@ -4,7 +4,7 @@
 from finder.models.label import Label
 
 
-def annotate_unified_queryset(queryset, realm):
+def annotate_unified_queryset(queryset):
     """
     Annotates the given queryset with additional fields for the frontend.
     This step must be applied after filtering and sorting.
@@ -13,11 +13,6 @@ def annotate_unified_queryset(queryset, realm):
     for entry in queryset:
         dummy_obj = FolderModel.objects.get_proxy_object(entry)
         entry.update(
-            change_url=reverse(
-                'admin:finder_inodemodel_change',
-                args=(entry['id'],),
-                current_app=realm,
-            ),
             download_url=dummy_obj.get_download_url(),
             thumbnail_url=dummy_obj.get_thumbnail_url(),
             sample_url=getattr(dummy_obj, 'get_sample_url', lambda: None)(),

finder/migrations/0001_initial.py

@@ -1,4 +1,4 @@
-# Generated by Django 5.2 on 2024-11-04 11:02
+# Generated by Django 5.2 on 2024-11-10 10:34
 
 import django.db.models.deletion
 import finder.models.file
@@ -186,37 +186,35 @@ class Migration(migrations.Migration):
             name='labels',
             field=models.ManyToManyField(blank=True, related_name='+', to='finder.label', verbose_name='Labels'),
         ),
-        migrations.CreateModel(
-            name='PinnedFolder',
-            fields=[
-                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
-                ('created_at', models.DateTimeField(auto_now_add=True, verbose_name='Created at')),
-                ('folder', models.ForeignKey(editable=False, on_delete=django.db.models.deletion.CASCADE, related_name='pinned_folders', to='finder.foldermodel')),
-                ('owner', models.ForeignKey(editable=False, on_delete=django.db.models.deletion.CASCADE, related_name='+', to=settings.AUTH_USER_MODEL)),
-            ],
-        ),
         migrations.CreateModel(
             name='RealmModel',
             fields=[
                 ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
                 ('slug', models.SlugField(editable=False, max_length=200, null=True, verbose_name='Slug')),
+                ('root_folder', models.OneToOneField(editable=False, on_delete=django.db.models.deletion.CASCADE, related_name='realm', to='finder.foldermodel')),
                 ('site', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='sites.site', verbose_name='Site')),
+                ('trash_folders', models.ManyToManyField(editable=False, related_name='+', to='finder.foldermodel')),
             ],
             options={
                 'ordering': ['site', 'slug'],
             },
         ),
-        migrations.AddField(
+        migrations.CreateModel(
+            name='PinnedFolder',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('created_at', models.DateTimeField(auto_now_add=True, verbose_name='Created at')),
+                ('folder', models.ForeignKey(editable=False, on_delete=django.db.models.deletion.CASCADE, related_name='pinned_folders', to='finder.foldermodel')),
+                ('owner', models.ForeignKey(editable=False, on_delete=django.db.models.deletion.CASCADE, related_name='+', to=settings.AUTH_USER_MODEL)),
+                ('realm', models.ForeignKey(editable=False, on_delete=django.db.models.deletion.CASCADE, related_name='+', to='finder.realmmodel')),
+            ],
+        ),
+        migrations.AddConstraint(
             model_name='foldermodel',
-            name='realm',
-            field=models.ForeignKey(editable=False, on_delete=django.db.models.deletion.CASCADE, to='finder.realmmodel', verbose_name='Realm'),
+            constraint=models.UniqueConstraint(fields=('parent', 'name'), name='unique_realm'),
         ),
         migrations.AddConstraint(
             model_name='realmmodel',
             constraint=models.UniqueConstraint(fields=('site', 'slug'), name='unique_site'),
         ),
-        migrations.AddConstraint(
-            model_name='foldermodel',
-            constraint=models.UniqueConstraint(fields=('parent', 'name'), name='unique_realm'),
-        ),
     ]

finder/models/folder.py

@@ -1,5 +1,6 @@
+from functools import lru_cache
+
 from django.conf import settings
-from django.contrib.sites.models import Site
 from django.contrib.staticfiles.storage import staticfiles_storage
 from django.core.exceptions import ValidationError
 from django.db import models
@@ -12,51 +13,30 @@
     ModelManager = models.Manager
 
 from .inode import InodeManagerMixin, InodeModel
-
-
-class RealmModel(models.Model):
-    site = models.ForeignKey(
-        Site,
-        on_delete=models.CASCADE,
-        verbose_name=_("Site"),
-    )
-
-    slug = models.SlugField(
-        _("Slug"),
-        max_length=200,
-        null=True,
-        editable=False,
-    )
-
-    class Meta:
-        ordering = ['site', 'slug']
-        constraints = [models.UniqueConstraint(fields=['site', 'slug'], name='unique_site')]
-
-    def __str__(self):
-        return f"{self.slug} @ {self.site.name}"
+from.realm import RealmModel
 
 
 class FolderModelManager(InodeManagerMixin, ModelManager):
     def get_root_folder(self, realm):
-        root_folder, _ = self.get_or_create(parent=None, realm=realm, name='__root__')
-        return root_folder
+        try:
+            return realm.root_folder
+        except FolderModel.DoesNotExist:
+            realm.root_folder = self.create(parent=None, name='__root__')
+            return realm.root_folder
 
     def get_trash_folder(self, realm, owner):
-        trash_folder, _ = self.get_or_create(parent=None, realm=realm, owner=owner, name='__trash__')
+        try:
+            trash_folder = realm.trash_folders.get(owner=owner)
+        except FolderModel.DoesNotExist:
+            trash_folder = self.create(parent=None, owner=owner, name='__trash__')
+            realm.trash_folders.add(trash_folder)
         return trash_folder
 
 
 class FolderModel(InodeModel):
     is_folder = True
     folderitem_component = None
 
-    realm = models.ForeignKey(
-        RealmModel,
-        verbose_name=_("Realm"),
-        editable=False,
-        on_delete=models.CASCADE,
-    )
-
     class Meta:
         verbose_name = _("Folder")
         verbose_name_plural = _("Folders")
@@ -77,6 +57,12 @@ def cast(self):
         raise NotImplementedError
         return self
 
+    @lru_cache
+    def get_realm(self):
+        if isinstance(self.ancestors, models.QuerySet):
+            return self.ancestors.last().realm
+        return list(self.ancestors)[-1].realm
+
     @property
     def folder(self):
         return self
@@ -239,6 +225,12 @@ def retrieve(self, path):
 
 
 class PinnedFolder(models.Model):
+    realm = models.ForeignKey(
+        RealmModel,
+        related_name='+',
+        on_delete=models.CASCADE,
+        editable=False,
+    )
     owner = models.ForeignKey(
         settings.AUTH_USER_MODEL,
         related_name='+',

finder/models/inode.py

@@ -115,7 +115,7 @@ def get_queryset(model):
 
         unified_fields = {
             field.name: field for field in FolderModel._meta.get_fields()
-            if field.concrete and not field.many_to_many and field.name is not 'realm'
+            if field.concrete and not field.many_to_many and field.name != 'realm'
         }
         for model in FileModel.get_models():
             for field in model._meta.get_fields():
@@ -250,6 +250,9 @@ def serializable_value(self, field_name):
 
 
 class DiscardedInode(models.Model):
+    """
+    Store information about inodes that have been moved to the trash folder so that they can be restored again.
+    """
     inode = models.UUIDField(
         primary_key=True,
     )