fix: Reduce number of thumbnails created for admin, avoid admin thumbnails for svg files (#1490)

* Fix #1377

* Simplify admin thumbnails sizes to 40, 80, 160. No thumbnails for svg in the admin.

* Update settings

* Fix undefined variable add_attrs

* Dynamic css for new setting `FILER_THUMBNAIL_ICON_SIZE`

* Replace SVG by icon if larger than 1MB (can be changed by setting)

* Dynamic folder icon size

* Default sizes 40, and 120px

* Update folderadmin.py for better naming

Author: fsbraun

filer/admin/clipboardadmin.py

@@ -2,12 +2,13 @@
 from django.core.exceptions import ValidationError
 from django.forms.models import modelform_factory
 from django.http import JsonResponse
-from django.urls import path
+from django.urls import path, reverse
 from django.utils.translation import gettext_lazy as _
 from django.views.decorators.csrf import csrf_exempt
 
 from .. import settings as filer_settings
 from ..models import Clipboard, ClipboardItem, Folder
+from ..settings import FILER_THUMBNAIL_ICON_SIZE
 from ..utils.files import handle_request_files_upload, handle_upload
 from ..utils.loader import load_model
 from ..validation import validate_upload
@@ -141,14 +142,10 @@ def ajax_upload(request, folder_id=None):
             }
             # prepare preview thumbnail
             if isinstance(file_obj, Image):
-                thumbnail_180_options = {
-                    'size': (180, 180),
-                    'crop': True,
-                    'upscale': True,
-                }
-                thumbnail_180 = file_obj.file.get_thumbnail(
-                    thumbnail_180_options)
-                data['thumbnail_180'] = thumbnail_180.url
+                data['thumbnail_180'] = reverse(
+                    f"admin:filer_{file_obj._meta.model_name}_fileicon",
+                    args=(file_obj.pk, FILER_THUMBNAIL_ICON_SIZE),
+                )
                 data['original_image'] = file_obj.url
             return JsonResponse(data)
         except Exception as error:

filer/admin/folderadmin.py

@@ -30,7 +30,9 @@
 from .. import settings
 from ..cache import clear_folder_permission_cache
 from ..models import File, Folder, FolderPermission, FolderRoot, ImagesWithMissingData, UnsortedImages, tools
-from ..settings import FILER_IMAGE_MODEL, FILER_PAGINATE_BY, TABLE_LIST_TYPE
+from ..settings import (
+    FILER_IMAGE_MODEL, FILER_PAGINATE_BY, FILER_TABLE_ICON_SIZE, FILER_THUMBNAIL_ICON_SIZE, TABLE_LIST_TYPE,
+)
 from ..thumbnail_processors import normalize_subject_location
 from ..utils.compatibility import get_delete_permission
 from ..utils.filer_easy_thumbnails import FilerActionThumbnailer
@@ -271,11 +273,13 @@ def directory_listing(self, request, folder_id=None, viewtype=None):
 
         list_type = get_directory_listing_type(request) or settings.FILER_FOLDER_ADMIN_DEFAULT_LIST_TYPE
         if list_type == TABLE_LIST_TYPE:
-            size = "40x40"  # Prefetch thumbnails for listing
-            size_x2 = "80x80"
+            # Prefetch thumbnails for table view
+            size = f"{FILER_TABLE_ICON_SIZE}x{FILER_TABLE_ICON_SIZE}"
+            size_x2 = f"{2 * FILER_TABLE_ICON_SIZE}x{2 * FILER_TABLE_ICON_SIZE}"
         else:
-            size = "160x160"  # Prefetch thumbnails for thumbnail view
-            size_x2 = "320x320"
+            # Prefetch thumbnails for thumbnail view
+            size = f"{FILER_THUMBNAIL_ICON_SIZE}x{FILER_THUMBNAIL_ICON_SIZE}"
+            size_x2 = f"{2 * FILER_THUMBNAIL_ICON_SIZE}x{2 * FILER_THUMBNAIL_ICON_SIZE}"
 
         # Check actions to see if any are available on this changelist
         actions = self.get_actions(request)
@@ -467,6 +471,7 @@ def directory_listing(self, request, folder_id=None, viewtype=None):
             'show_result_count': show_result_count,
             'folder_children': folder_qs,
             'folder_files': file_qs,
+            'thumbnail_size': FILER_TABLE_ICON_SIZE if list_type == TABLE_LIST_TYPE else FILER_THUMBNAIL_ICON_SIZE,
             'limit_search_to_folder': limit_search_to_folder,
             'is_popup': popup_status(request),
             'filer_admin_context': AdminContext(request),

filer/cache.py

@@ -1,8 +1,7 @@
 import typing
 
-from django.core.cache import cache
-
 from django.contrib.auth import get_user_model
+from django.core.cache import cache
 
 
 User = get_user_model()

filer/migrations/0001_squashed_0016_alter_folder_index_together_remove_folder_level_and_more.py

@@ -1,8 +1,9 @@
 # Generated by Django 3.2.25 on 2024-08-19 14:49
 
+import django.db.models.deletion
 from django.conf import settings
 from django.db import migrations, models
-import django.db.models.deletion
+
 import filer.fields.multistorage_file
 import filer.models.filemodels
 import filer.models.mixins

filer/models/abstract.py

@@ -1,13 +1,13 @@
 import logging
 
 from django.conf import settings
-from django.core.checks import Warning, register as register_check
+from django.core.checks import Warning
+from django.core.checks import register as register_check
 from django.core.exceptions import ValidationError
 from django.db import models
 from django.utils.functional import cached_property
 from django.utils.translation import gettext_lazy as _
 
-
 import easy_thumbnails.utils
 from easy_thumbnails.VIL import Image as VILImage
 from PIL.Image import MAX_IMAGE_PIXELS

filer/models/foldermodels.py

@@ -10,8 +10,8 @@
 from django.utils.translation import gettext_lazy as _
 
 from .. import settings as filer_settings
-from . import mixins
 from ..cache import get_folder_permission_cache, update_folder_permission_cache
+from . import mixins
 
 
 class FolderPermissionManager(models.Manager):

filer/private/sass/components/_navigator.scss

@@ -77,10 +77,6 @@ body {
         // removes padding to make sure that column has correct height #664
         padding-top: 0 !important;
         padding-bottom: 0 !important;
-        img {
-            width: 40px;
-            height: auto;
-        }
     }
     .column-action {
         text-align: center;
@@ -732,17 +728,17 @@ body {
         float: left;
         display: inline-block;
         padding: 10px;
-        width: 125px;
-        height: 125px;
+        width: calc(var(--thumbnail-size, 120px) + 5px);
+        height: calc(var(--thumbnail-size, 120px) + 5px);
         border: 1px solid $gray-lighter;
         margin: 16px 12px;
         background-color: $white;
         position: relative;
         overflow: hidden;
         .thumbnail-file-item-box {
             padding: 10px;
-            width: 125px;
-            height: 125px;
+            width: calc(var(--thumbnail-size, 120px) + 5px);
+            height: calc(var(--thumbnail-size, 120px) + 5px);
             border: 1px solid $gray-lighter;
             margin: 16px 12px;
             background-color: $white;
@@ -791,8 +787,8 @@ body {
     }
     .thumbnail-file-item {
         float: none;
-        width: 147px;
-        height: 200px;
+        width: calc(var(--thumbnail-size, 120px) + 27px);
+        height: calc(var(--thumbnail-size, 120px) + 80px);
         border: 0;
         padding: 0;
         background-color: transparent;

filer/settings.py

@@ -2,7 +2,6 @@
 import os
 
 from django.conf import settings
-from django.core.exceptions import ImproperlyConfigured
 from django.utils.module_loading import import_string as get_storage_class
 from django.utils.translation import gettext_lazy as _
 
@@ -38,20 +37,24 @@
 
 FILER_PAGINATE_BY = getattr(settings, 'FILER_PAGINATE_BY', 100)
 
+if hasattr(settings, "FILER_ADMIN_ICON_SIZES"):
+    logger.warning("FILER_ADMIN_ICON_SIZES is deprecated and will be removed in the future.")
+
 _ICON_SIZES = getattr(settings, 'FILER_ADMIN_ICON_SIZES', ('16', '32', '48', '64'))
-if not _ICON_SIZES:
-    raise ImproperlyConfigured('Please, configure FILER_ADMIN_ICON_SIZES')
 # Reliably sort by integer value, but keep icon size as string.
 # (There is some code in the wild that depends on this being strings.)
 FILER_ADMIN_ICON_SIZES = [str(i) for i in sorted([int(s) for s in _ICON_SIZES])]
 
-# Filer admin templates have specific icon sizes hardcoded: 32 and 48.
-_ESSENTIAL_ICON_SIZES = ('32', '48')
-if not all(x in FILER_ADMIN_ICON_SIZES for x in _ESSENTIAL_ICON_SIZES):
-    logger.warn(
-        "FILER_ADMIN_ICON_SIZES has not all of the essential icon sizes "
-        "listed: {}. Some icons might be missing in admin templates.".format(
-            _ESSENTIAL_ICON_SIZES))
+# Currently, these two icon sizes are hard-coded into the admin and admin templates
+FILER_TABLE_ICON_SIZE = getattr(settings, "FILER_TABLE_ICON_SIZE", 40)
+FILER_THUMBNAIL_ICON_SIZE = getattr(settings, "FILER_THUMBNAIL_ICON_SIZE", 120)
+DEFERRED_THUMBNAIL_SIZES = (
+    FILER_TABLE_ICON_SIZE,
+    2 * FILER_TABLE_ICON_SIZE,
+    FILER_THUMBNAIL_ICON_SIZE,
+    2 * FILER_THUMBNAIL_ICON_SIZE,
+)
+
 
 # This is an ordered iterable that describes a list of
 # classes that I should check for when adding files
@@ -283,7 +286,6 @@ def update_server_settings(settings, defaults, s, t):
     },
 }
 
-DEFERRED_THUMBNAIL_SIZES = (40, 80, 160)
 IMAGE_EXTENSIONS = ['.jpg', '.jpeg', '.png', '.gif', '.webp']
 IMAGE_MIME_TYPES = ['gif', 'jpeg', 'png', 'x-png', 'svg+xml', 'webp']
 
@@ -322,3 +324,7 @@ def update_server_settings(settings, defaults, s, t):
     except (ModuleNotFoundError, ImportError):
         # Import error? No django CMS used: stay with own icons
         pass
+
+
+# SVG are their own thumbnails if their size is below this limit
+FILER_MAX_SVG_THUMBNAIL_SIZE = getattr(settings, "FILER_MAX_SVG_THUMBNAIL_SIZE", 1024 * 1024)  # 1MB default