Merge branch 'master' into test/django51

Author: fsbraun

.github/workflows/test.yml

@@ -8,7 +8,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ['3.10', '3.11', '3.12']
+        python-version: [3.8, 3.9, '3.10', '3.11', '3.12']
         requirements-file: [
           django-4.2.txt,
           django-5.0.txt,
@@ -19,6 +19,15 @@ jobs:
         os: [
           ubuntu-20.04,
         ]
+        exclude:
+          - requirements-file: django-5.0.txt
+            python-version: 3.8
+          - requirements-file: django-5.0.txt
+            python-version: 3.9
+          - requirements-file: django-main.txt
+            python-version: 3.8
+          - requirements-file: django-main.txt
+            python-version: 3.9
 
     steps:
     - uses: actions/checkout@v1
@@ -35,7 +44,7 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install -r tests/requirements/${{ matrix.requirements-file }}
-        python setup.py install
+        pip install -e .
     - name: Enable the custom image model
       run: echo "CUSTOM_IMAGE=custom_image.Image" >> $GITHUB_ENV
       if: ${{ matrix.custom-image-model }}

.pre-commit-config.yaml

@@ -21,7 +21,7 @@ repos:
 #        args: [--target-version, "2.2"]
 
   - repo: https://github.com/PyCQA/flake8
-    rev: 7.0.0
+    rev: 7.1.0
     hooks:
       - id: flake8
 

CHANGELOG.rst

@@ -2,12 +2,39 @@
 CHANGELOG
 =========
 
-3.1.3 (2025-05-17)
+3.2.1 (2024-09-05)
+==================
+
+* fix: Restore python 3.8 and python 3.9 compatibility
+
+3.2.0 (2024-08-23)
+==================
+
+* feat: Add cache for permission checks by @fsbraun in https://github.com/django-cms/django-filer/pull/1486
+* fix: Reduce number of thumbnails created for admin, avoid admin thumbnails for svg files by @fsbraun in https://github.com/django-cms/django-filer/pull/1490
+* fix: Allow ``Image.MAX_IMAGE_PIXELS`` to be ``None`` by @fsbraun in https://github.com/django-cms/django-filer/pull/1475
+* docs: Update extending_filer.rst by @DmytroLitvinov in https://github.com/django-cms/django-filer/pull/1488
+
+**New contributor:**
+
+* @DmytroLitvinov made their first contribution in https://github.com/django-cms/django-filer/pull/1488
+
+3.1.4 (2024-07-15)
+==================
+
+* feat: Accept new `STORAGES` setting, introduced in Django 4.2 by @fsbraun in https://github.com/django-cms/django-filer/pull/1472
+* feat: Replace `render` with `TemplateResponse` in admin views by @fsbraun in https://github.com/django-cms/django-filer/pull/1473
+* fix: File expand url incorrect and worked not with custom image models by @fsbraun in https://github.com/django-cms/django-filer/pull/1471
+* fix: Crash when moving files from a filtered directory listing by @W1ldPo1nter in https://github.com/django-cms/django-filer/pull/1482
+* ci: pre-commit autoupdate by @pre-commit-ci in https://github.com/django-cms/django-filer/pull/1477
+
+
+3.1.3 (2024-05-17)
 ==================
 * Fix: Folder select widget did not render correctly with standard Django admin
   styles.
 
-3.1.2 (2025-05-17)
+3.1.2 (2024-05-17)
 ==================
 
 * Made the filer check command compatible with custom image models.

docs/extending_filer.rst

@@ -214,7 +214,7 @@ field.  You can override this behavior by subclassing the
 You can also override the search behavior for :py:class:`Folders<filer.models.foldermodels.Folder>`.
 Just override :py:attr:`~filer.admin.folderadmin.FolderAdmin.search_fields` by subclassing
 the :py:class:`filer.admin.folderadmin.FolderAdmin`. It works as described in
-`Django's docs <https://docs.djangoproject.com/en/1.8/ref/contrib/admin/#django.contrib.admin.ModelAdmin.search_fields>`_. E.g.:
+`Django's docs <https://docs.djangoproject.com/en/4.2/ref/contrib/admin/#django.contrib.admin.ModelAdmin.search_fields>`_. E.g.:
 
 
 .. code-block:: python
@@ -230,7 +230,7 @@ Providing custom Image model
 ----------------------------
 
 As the ``Image`` model is special, a different way to implement custom Image model is required, which uses the Django
-`swappable models <https://docs.djangoproject.com/en/2.0/topics/auth/customizing/#substituting-a-custom-user-model>`_ interface.
+`swappable models <https://docs.djangoproject.com/en/4.2/topics/auth/customizing/#substituting-a-custom-user-model>`_ interface.
 
 Defining the model
 ..................

filer/__init__.py

@@ -13,4 +13,4 @@
  8. Publish the release and it will automatically release to pypi
 """
 
-__version__ = '3.1.3'
+__version__ = '3.2.1'

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

@@ -28,8 +28,11 @@
 from easy_thumbnails.models import Thumbnail
 
 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
@@ -107,6 +110,9 @@ def save_form(self, request, form, change):
         Given a ModelForm return an unsaved instance. ``change`` is True if
         the object is being changed, and False if it's being added.
         """
+        if not change:
+            # New folder invalidates the folder permission cache (or it will not be visible)
+            clear_folder_permission_cache(request.user)
         r = form.save(commit=False)
         parent_id = request.GET.get('parent_id', None)
         if not parent_id:
@@ -267,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)
@@ -321,14 +329,13 @@ def directory_listing(self, request, folder_id=None, viewtype=None):
         order_by = request.GET.get('order_by', None)
         order_by_annotation = None
         if order_by is None:
-            file_qs = file_qs.annotate(coalesce_sort_field=Coalesce(
+            order_by_annotation = Lower(Coalesce(
                 Case(
                     When(name__exact='', then=None),
                     When(name__isnull=False, then='name')
                 ),
                 'original_filename'
             ))
-            order_by_annotation = Lower('coalesce_sort_field')
 
         order_by = order_by.split(',') if order_by else []
         order_by = [field for field in order_by
@@ -464,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/admin/permissionadmin.py

@@ -2,6 +2,7 @@
 from django.utils.translation import gettext_lazy as _
 
 from .. import settings
+from ..cache import clear_folder_permission_cache
 
 
 class PermissionAdmin(admin.ModelAdmin):
@@ -31,3 +32,11 @@ def get_model_perms(self, request):
             'change': enable_permissions,
             'delete': enable_permissions,
         }
+
+    def save_model(self, request, obj, form, change):
+        clear_folder_permission_cache(request.user)
+        super().save_model(request, obj, form, change)
+
+    def delete_model(self, request, obj):
+        clear_folder_permission_cache(request.user)
+        super().delete_model(request, obj)

filer/cache.py

@@ -0,0 +1,83 @@
+import typing
+
+from django.contrib.auth import get_user_model
+from django.core.cache import cache
+
+
+User = get_user_model()
+
+
+def get_folder_perm_cache_key(user: User, permission: str) -> str:
+    """
+    Generates a unique cache key for a given user and permission.
+
+    The key is a string in the format "filer:perm:<permission>", i.e. it does not
+    contain the user id. This will be sufficient for most use cases.
+
+    Patch this method to include the user id in the cache key if necessary, e.g.,
+    for far more than 1,000 admin users to make the cached unit require less memory.
+
+    Parameters:
+    user (User): The user for whom the cache key is being generated.
+    permission (str): The permission for which the cache key is being generated.
+
+    Returns:
+    str: The generated cache key.
+    """
+    return f"filer:perm:{permission}"
+
+
+def get_folder_permission_cache(user: User, permission: str) -> typing.Optional[dict]:
+    """
+    Retrieves the cached folder permissions for a given user and permission.
+
+    If the cache value exists, it returns the permissions for the user.
+    If the cache value does not exist, it returns None.
+
+    Parameters:
+    user (User): The user for whom the permissions are being retrieved.
+    permission (str): The permission for which the permissions are being retrieved.
+
+    Returns:
+    dict or None: The permissions for the user, or None if no cache value exists.
+    """
+    cache_value = cache.get(get_folder_perm_cache_key(user, permission))
+    if cache_value:
+        return cache_value.get(user.pk, None)
+    return None
+
+
+def clear_folder_permission_cache(user: User, permission: typing.Optional[str] = None) -> None:
+    """
+    Clears the cached folder permissions for a given user.
+
+    If a specific permission is provided, it clears the cache for that permission only.
+    If no specific permission is provided, it clears the cache for all permissions.
+
+    Parameters:
+    user (User): The user for whom the permissions are being cleared.
+    permission (str, optional): The specific permission to clear. Defaults to None.
+    """
+    if permission is None:
+        for perm in ['can_read', 'can_edit', 'can_add_children']:
+            cache.delete(get_folder_perm_cache_key(user, perm))
+    else:
+        cache.delete(get_folder_perm_cache_key(user, permission))
+
+
+def update_folder_permission_cache(user: User, permission: str, id_list: typing.List[int]) -> None:
+    """
+    Updates the cached folder permissions for a given user and permission.
+
+    It first retrieves the current permissions from the cache (or an empty dictionary if none exist).
+    Then it updates the permissions for the user with the provided list of IDs.
+    Finally, it sets the updated permissions back into the cache.
+
+    Parameters:
+    user (User): The user for whom the permissions are being updated.
+    permission (str): The permission to update.
+    id_list (list): The list of IDs to set as the new permissions.
+    """
+    perms = get_folder_permission_cache(user, permission) or {}
+    perms[user.pk] = id_list
+    cache.set(get_folder_perm_cache_key(user, permission), perms)