Refactor folder permissions (#1264)

* fix code style according to Django’s style guide

* fix code style according to Django’s style guide

* separate Permission in where, who and what

* fix FolderPermissions: Unable to read child folders.

* simplify code for better readability

* Update German translation strings

* fix steps to build documentation

* changes for version 2.1.3

* Add more changes to the log.

* replace test for deprecated quoted_logical_path against pretty_logical_path

* fix failing unit tests

* adopt __init__ to GH actions

* drop support for Python-3.6

* fix isort complains

* fix failing unit tests

* fix isort complains

* increase test coverage

* increase test coverage

* fix annotation #1264 (comment)

* fix annotation #1264 (comment)

* exclude some version combinations

* readd Python-3.10 with Django-3.2

* add missing requirements

* force testing

* install lxml only for Python-3.10

* fix yaml syntax

* swap dependencies with e.d.

* apt-get install extra development libraries

Co-authored-by: Jacob Rief <jacob.rief@uibk.ac.at>

Author: jrief

.github/workflows/test.yml

@@ -8,13 +8,22 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [ 3.6, 3.7, 3.8, 3.9 ]
+        python-version: [ '3.7', '3.8', '3.9', '3.10' ]
         requirements-file: [
           django-2.2.txt,
           django-3.0.txt,
           django-3.1.txt,
           django-3.2.txt
         ]
+        exclude:
+          - python-version: 3.9
+            requirements-file: django-2.2.txt
+          - python-version: 3.10
+            requirements-file: django-2.2.txt
+          - python-version: 3.10
+            requirements-file: django-3.0.txt
+          - python-version: 3.10
+            requirements-file: django-3.1.txt
         os: [
           ubuntu-20.04,
         ]
@@ -25,12 +34,16 @@ jobs:
       uses: actions/setup-python@v2
       with:
         python-version: ${{ matrix.python-version }}
+    - name: library prerequisites
+      run: sudo apt-get install python-dev libpq-dev libmagic1 gcc libxml2-dev libxslt1-dev libjpeg62 libopenjp2-7 -y
+    - name: Install extra dependencies
+      run: pip install lxml
+      if: matrix.python-version == '3.10'
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
         pip install -r tests/requirements/${{ matrix.requirements-file }}
         python setup.py install
-
     - name: Run coverage
       run: coverage run setup.py test
 

.gitignore

@@ -13,7 +13,7 @@
 .settings/
 .tox/
 __pycache__/
-build/
+docs/_build/
 dist/
 env/
 .venv/

CHANGELOG.rst

@@ -2,6 +2,15 @@
 CHANGELOG
 =========
 
+2.1.3 (next)
+============
+
+* Improve the list view of Folder permissions.
+* Fix: Folder permissions were disabled for descendants, if parent folder
+  has type set to CHILDREN.
+* The input field for Folder changes from a standard HTML select element to
+  a very wide autocomplete field, showing the complete path in Filer.
+
 
 2.1.2 (2021-11-09)
 ==================

docs/conf.py

@@ -57,11 +57,6 @@
 # The full version, including alpha/beta/rc tags.
 release = __version__
 
-for c in ('a', 'b', 'dev', 'r'):
-    if c in release:
-        tags.add('develop')
-        break
-
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #language = None

filer/__init__.py

@@ -7,13 +7,12 @@
  3. git add filer/__init__.py CHANGELOG.rst
  4. git commit -m 'Bump to {new version}'
  5. git push
- 6. Assure that all tests pass on https://travis-ci.org/github/divio/django-filer.
+ 6. Assure that all tests pass on https://github.com/django-cms/django-filer/actions
  7. git tag {new version}
  8. git push --tags
- 9. python setup.py sdist
-10. twine upload dist/django-filer-{new version}.tar.gz
+ 9. Check that new version is published on PyPI
 """
 
-__version__ = '2.1.2'
+__version__ = '2.2dev1'
 
 default_app_config = 'filer.apps.FilerConfig'

filer/admin/folderadmin.py

@@ -319,18 +319,18 @@ def directory_listing(self, request, folder_id=None, viewtype=None):
             virtual_items = []
 
         perms = FolderPermission.objects.get_read_id_list(request.user)
-        root_exclude_kw = {'parent__isnull': False, 'parent__id__in': perms}
         if perms != 'All':
             file_qs = file_qs.filter(
                 models.Q(folder__id__in=perms)
                 | models.Q(folder_id__isnull=True)
                 | models.Q(owner=request.user)
             )
             folder_qs = folder_qs.filter(models.Q(id__in=perms) | models.Q(owner=request.user))
+            root_exclude_kwargs = {'parent__isnull': False, 'parent__id__in': perms}
         else:
-            root_exclude_kw.pop('parent__id__in')
+            root_exclude_kwargs = {'parent__isnull': False}
         if folder.is_root:
-            folder_qs = folder_qs.exclude(**root_exclude_kw)
+            folder_qs = folder_qs.exclude(**root_exclude_kwargs)
 
         folder_children += folder_qs
         folder_files += file_qs

filer/admin/permissionadmin.py

@@ -1,19 +1,22 @@
 from django.contrib import admin
+from django.utils.translation import gettext_lazy as _
 
 from .. import settings
 
 
 class PermissionAdmin(admin.ModelAdmin):
     fieldsets = [
         (None, {'fields': ['type', 'folder']}),
-        (None, {'fields': ['user', 'group', 'everybody']}),
-        (None, {'fields': ['can_edit', 'can_read', 'can_add_children']}),
+        (_("Who"), {'fields': ['user', 'group', 'everybody']}),
+        (_("What"), {'fields': ['can_edit', 'can_read', 'can_add_children']}),
     ]
-    raw_id_fields = ['user', 'group']
     list_filter = ['group']
-    list_display = ['__str__', 'folder', 'user']
+    list_display = ['pretty_logical_path', 'who', 'what']
     search_fields = ['user__username', 'group__name', 'folder__name']
-    autocomplete_fields = ['user', 'group']
+    autocomplete_fields = ['user', 'group', 'folder']
+
+    class Media:
+        css = {'all': ['filer/css/admin_folderpermissions.css']}
 
     def get_queryset(self, request):
         qs = super(PermissionAdmin, self).get_queryset(request)