feat: Use grouper admin to resolve usability issues (#167)

* feat: grouper admin

* Update to new GrouperModelAdmin

* Update to match latest cms.admin.utils

* Fix message, isort, flake8 and transifex integration

* Remove unneeded svg

* Update tests

* Run tests on any branch

* Update test dependencies

* Update readme, add created by and modified fields in versioned change list

* Fix: MySql annotation error

* Flipped lines fixed

* Fix: alias content admin redirect

* Add some type hints

* fix isort

* Update changelog

* add messages

* fix isort

* Fix missing icons

* ci: auto fixes from pre-commit hooks

for more information, see https://pre-commit.ci

* fix flake8

* Fix static alias language detection bug

* ci: auto fixes from pre-commit hooks

for more information, see https://pre-commit.ci

* Fix flake8

* ci: auto fixes from pre-commit hooks

for more information, see https://pre-commit.ci

* Adjust tests

* fix pre-commit.ci

* Remove get_versioning_state from admin list_display

* Update changelog

* Fix: get_langauge_from_request to get the language of toolbar object does not have one.

* ci: auto fixes from pre-commit hooks

for more information, see https://pre-commit.ci

* Create alias content warning-free

* ci: auto fixes from pre-commit hooks

for more information, see https://pre-commit.ci

* Django 4.2 compatibility

* Refactor

* ci: auto fixes from pre-commit hooks

for more information, see https://pre-commit.ci

* Fix lint errors

* Remove unused admin filter and tests

* Update translations

* Fix cms config

* ci: auto fixes from pre-commit hooks

for more information, see https://pre-commit.ci

* Update test requirements

* Undo change to site selection logic

* update messages, simplify alias plugin ui, update tests

* fix flake8

* Fix: Typo in jquery selector

* Update some comments

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: fsbraun

.github/workflows/test.yml

@@ -7,8 +7,6 @@ concurrency:
 on:
   pull_request:
   push:
-    branches:
-    - master
 
 jobs:
   unit-tests:
@@ -18,8 +16,6 @@ jobs:
     strategy:
       matrix:
         python-version:
-          - 3.7
-          - 3.8
           - 3.9
           - '3.10'
           - '3.11'

.tx/config

@@ -1,7 +1,7 @@
 [main]
 host = https://www.transifex.com
 
-[o:divio:p:django-cms-alias:r:djangopo]
+[o:divio:p:django-cms-alias:r:djangocms-alias-locale-en-lc-messages-django-po--master]
 file_filter   = djangocms_alias/locale/<lang>/LC_MESSAGES/django.po
 source_file   = djangocms_alias/locale/en/LC_MESSAGES/django.po
 type          = PO

CHANGELOG.rst

@@ -8,6 +8,9 @@ Unreleased
 * Django 2.2 support removed
 * Python 3.7 support removed
 * Changed test setup to run tox from github actions for consistency in testing
+* Use django CMS 4.1 GrouperModelAdmin utility (breaking change wrt. django CMS 4.0)
+* Admin menu entry show alias change list in the language of the currently shown object
+* Automatically create static aliases in the language needed (fixing #162)
 
 1.11.0 (2022-10-14)
 ===================

MANIFEST.in

@@ -2,4 +2,5 @@ include LICENSE.txt
 include README.rst
 recursive-include djangocms_alias/static *
 recursive-include djangocms_alias/templates *
+recursive-include djangocms_alias/locale *
 recursive-exclude * *.pyc

README.rst

@@ -6,13 +6,9 @@ django CMS Alias
 
 |coverage| |python| |django| |djangocms4|
 
-django CMS Alias replicates and extends the alias function of django CMS version 3
-for django CMS version 4.
+django CMS Alias replicates and extends the alias function of django CMS version 3 for django CMS version 4.
 
-An alias is a collection of plugins that is managed centrally. A reference
-can be added to any placeholder using the Alias plugin. Since the Alias plugin
-creates a reference any changes to the alias are immediately reflected at all
-places it is used.
+An alias is a collection of plugins that is managed centrally. A reference can be added to any placeholder using the Alias plugin. Since the Alias plugin creates a reference any changes to the alias are immediately reflected at all places it is used.
 
 django CMS Alias supports versioning aliases by django CMS Versioning.
 
@@ -53,13 +49,31 @@ to perform the application's database migrations.
 Usage
 =====
 
+Static aliases
+==============
+
+Static aliases appear in templates and replace static placeholders which were part of django CMS up to version 3.x.
+
+Example::
+
+    {% load djangocms_alias_tags %}
+    ...
+    <footer>
+      {% static_alias 'footer' %}
+    </footer>
+
+Alias plugin
+============
+
+Alternatively, aliases can be used with the Alias plugin. It allows to select which alias content is shown at the exact position the alias plugin is placed.
+
 .. |coverage| image:: https://codecov.io/gh/django-cms/djangocms-alias/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/django-cms/djangocms-alias
 
 .. |python| image:: https://img.shields.io/badge/python-3.7+-blue.svg
    :target: https://pypi.org/project/djangocms-alias/
 
-.. |django| image:: https://img.shields.io/badge/django-2.2,%203.2-blue.svg
+.. |django| image:: https://img.shields.io/badge/django-3.2--4.1-blue.svg
    :target: https://www.djangoproject.com/
 
 .. |djangocms4| image:: https://img.shields.io/badge/django%20CMS-4-blue.svg

djangocms_alias/admin.py

@@ -1,17 +1,29 @@
+from django import forms
 from django.contrib import admin
-from django.db.models.functions import Lower
-from django.template.loader import render_to_string
+from django.http import (
+    Http404,
+    HttpRequest,
+    HttpResponse,
+    HttpResponseRedirect,
+)
+from django.utils.safestring import mark_safe
 from django.utils.translation import gettext_lazy as _
 
+from cms.admin.utils import GrouperModelAdmin
 from cms.utils.permissions import get_model_permission_codename
 from cms.utils.urlutils import admin_reverse
 
 from parler.admin import TranslatableAdmin
 
 from .cms_config import AliasCMSConfig
-from .constants import USAGE_ALIAS_URL_NAME
-from .filters import CategoryFilter, LanguageFilter, SiteFilter
-from .forms import AliasContentForm
+from .constants import (
+    CHANGE_ALIAS_URL_NAME,
+    DELETE_ALIAS_URL_NAME,
+    LIST_ALIAS_URL_NAME,
+    USAGE_ALIAS_URL_NAME,
+)
+from .filters import CategoryFilter, SiteFilter
+from .forms import AliasGrouperAdminForm
 from .models import Alias, AliasContent, Category
 from .urls import urlpatterns
 from .utils import (
@@ -27,18 +39,22 @@
     'AliasContentAdmin',
 ]
 
-alias_content_admin_classes = [admin.ModelAdmin]
-alias_content_admin_list_display = ('name', 'get_category',)
-alias_content_admin_list_filter = (SiteFilter, CategoryFilter, LanguageFilter,)
+alias_admin_classes = [GrouperModelAdmin]
+alias_admin_list_display = ['content__name', 'category', 'admin_list_actions']
 djangocms_versioning_enabled = AliasCMSConfig.djangocms_versioning_enabled
 
 if djangocms_versioning_enabled:
-    from djangocms_versioning.admin import ExtendedVersionAdminMixin
+    from djangocms_versioning.admin import (
+        ExtendedGrouperVersionAdminMixin,
+        StateIndicatorMixin,
+    )
+    from djangocms_versioning.models import Version
 
-    from .filters import UnpublishedFilter
-    alias_content_admin_classes.insert(0, ExtendedVersionAdminMixin)
-    alias_content_admin_list_display = ('name', 'get_category',)
-    alias_content_admin_list_filter = (SiteFilter, CategoryFilter, LanguageFilter, UnpublishedFilter)
+    alias_admin_classes.insert(0, ExtendedGrouperVersionAdminMixin)
+    alias_admin_classes.insert(0, StateIndicatorMixin)
+    alias_admin_list_display.insert(-1, "get_author")
+    alias_admin_list_display.insert(-1, "get_modified_date")
+    alias_admin_list_display.insert(-1, "state_indicator")
 
 
 @admin.register(Category)
@@ -49,7 +65,7 @@ def save_model(self, request, obj, form, change):
         change = not obj._state.adding
         super().save_model(request, obj, form, change)
         if change:
-            # Dont emit delete content because there is on_delete=PROTECT for
+            # Don't emit delete content because there is on_delete=PROTECT for
             # category FK on alias
             emit_content_change(
                 AliasContent._base_manager.filter(alias__in=obj.aliases.all()),
@@ -58,19 +74,31 @@ def save_model(self, request, obj, form, change):
 
 
 @admin.register(Alias)
-class AliasAdmin(admin.ModelAdmin):
-    list_display = ['name', 'category']
-    list_filter = ['site', 'category']
-    fields = ('category', 'site')
+class AliasAdmin(*alias_admin_classes):
+    list_display = alias_admin_list_display
+    list_display_links = None
+    list_filter = (SiteFilter, CategoryFilter,)
+    fields = ('content__name', 'category', 'site', 'content__language')
     readonly_fields = ('static_code', )
+    form = AliasGrouperAdminForm
+    extra_grouping_fields = ("language",)
+    EMPTY_CONTENT_VALUE = mark_safe(_("<i>Missing language</i>"))
 
-    def get_urls(self):
+    def get_urls(self) -> list:
         return urlpatterns + super().get_urls()
 
-    def has_add_permission(self, request):
-        return False
+    def get_actions_list(self) -> list:
+        """Add alias usage list actions"""
+        return super().get_actions_list() + [self._get_alias_usage_link]
+
+    def can_change_content(self, request: HttpRequest, content_obj: AliasContent) -> bool:
+        """Returns True if user can change content_obj"""
+        if content_obj and is_versioning_enabled():
+            version = Version.objects.get_for_content(content_obj)
+            return version.check_modify.as_bool(request.user)
+        return True
 
-    def has_delete_permission(self, request, obj=None):
+    def has_delete_permission(self, request: HttpRequest, obj: Alias = None) -> bool:
         # Alias can be deleted by users who can add aliases,
         # if that alias is not referenced anywhere.
         if obj:
@@ -81,142 +109,67 @@ def has_delete_permission(self, request, obj=None):
             return request.user.is_superuser
         return False
 
-    def get_deleted_objects(self, objs, request):
+    def save_model(self, request: HttpRequest, obj: Alias, form: forms.Form, change: bool) -> None:
+        super().save_model(request, obj, form, change)
+
+        # Only emit content changes if Versioning is not installed because
+        # Versioning emits its own signals for changes
+        if not is_versioning_enabled():
+            emit_content_change(
+                AliasContent._base_manager.filter(alias=obj),
+                sender=self.model,
+            )
+
+    def get_deleted_objects(self, objs, request: HttpRequest) -> tuple:
         deleted_objects, model_count, perms_needed, protected = super().get_deleted_objects(objs, request)
         # This is bad and I should feel bad.
         if 'placeholder' in perms_needed:
             perms_needed.remove('placeholder')
         return deleted_objects, model_count, perms_needed, protected
 
-    def save_model(self, request, obj, form, change):
-        super().save_model(request, obj, form, change)
-        emit_content_change(
-            AliasContent._base_manager.filter(alias=obj),
-            sender=self.model,
-        )
-
-    def delete_model(self, request, obj):
+    def delete_model(self, request: HttpRequest, obj: Alias):
         super().delete_model(request, obj)
-        emit_content_delete(
-            AliasContent._base_manager.filter(alias=obj),
-            sender=self.model,
-        )
 
-    def has_module_permission(self, request):
-        return False
+        # Only emit content changes if Versioning is not installed because
+        # Versioning emits it' own signals for changes
+        if not is_versioning_enabled():
+            emit_content_delete(
+                AliasContent._base_manager.filter(alias=obj),
+                sender=self.model,
+            )
+
+    def _get_alias_usage_link(self, obj: Alias, request: HttpRequest, disabled: bool = False) -> str:
+        url = admin_reverse(USAGE_ALIAS_URL_NAME, args=[obj.pk])
+        return self.admin_action_button(url, "info", _("View usage"), disabled=disabled)
+
+    def _get_alias_delete_link(self, obj: Alias, request: HttpRequest) -> str:
+        url = admin_reverse(DELETE_ALIAS_URL_NAME, args=[obj.pk])
+        return self.admin_action_button(url, "bin", _("Delete Alias"),
+                                        disabled=not self.has_delete_permission(request, obj))
 
 
 @admin.register(AliasContent)
-class AliasContentAdmin(*alias_content_admin_classes):
-    form = AliasContentForm
-    list_filter = alias_content_admin_list_filter
-    list_display = alias_content_admin_list_display
+class AliasContentAdmin(admin.ModelAdmin):
     # Disable dropdown actions
     actions = None
     change_form_template = "admin/djangocms_alias/aliascontent/change_form.html"
 
-    def get_queryset(self, request):
-        queryset = super().get_queryset(request)
-        # Force the category set to Lower, to be able to sort the category in ascending/descending order
-        queryset = queryset.annotate(alias_category_translations_ordered=Lower("alias__category__translations__name"))
-        return queryset
-
-    # Add Alias category in the admin manager list and order field
-    @admin.display(
-        description=_('category'),
-        ordering="alias_category_translations_ordered",
-    )
-    def get_category(self, obj):
-        return obj.alias.category
-
-    def has_add_permission(self, request, obj=None):
-        # FIXME: It is not currently possible to add an alias from the django admin changelist issue #97
-        # https://github.com/django-cms/djangocms-alias/issues/97
-        return False
-
-    def save_model(self, request, obj, form, change):
-        super().save_model(request, obj, form, change)
+    def changelist_view(self, request: HttpRequest, extra_context: dict = None) -> HttpResponse:
+        """Needed for the Alias Content Admin breadcrumbs"""
+        return HttpResponseRedirect(admin_reverse(
+            LIST_ALIAS_URL_NAME,
+        ))
 
-        # Only emit content changes if Versioning is not installed because
-        # Versioning emits it's own signals for changes
-        if not is_versioning_enabled():
-            emit_content_change([obj], sender=self.model)
+    def change_view(self, request: HttpRequest, object_id: int, form_url: str = '', extra_context: dict = None) -> HttpResponse:
+        """Needed for the Alias Content Admin breadcrumbs"""
+        obj = self.model.admin_manager.filter(pk=object_id).first()
+        if not obj:
+            raise Http404()
+        return HttpResponseRedirect(admin_reverse(
+            CHANGE_ALIAS_URL_NAME, args=(obj.alias_id,)
+        ) + f"?language={obj.language}")
 
-    def delete_model(self, request, obj):
-        super().delete_model(request, obj)
+    def has_module_permission(self, request: HttpRequest) -> bool:
+        """Hides admin class in admin site overview"""
 
-        # Only emit content changes if Versioning is not installed because
-        # Versioning emits it's own signals for changes
-        if not is_versioning_enabled():
-            emit_content_delete([obj], sender=self.model)
-
-    def get_list_actions(self):
-        """
-        Collect rendered actions from implemented methods and return as list
-        """
-        return [
-            self._get_preview_link,
-            self._get_edit_link,
-            self._get_manage_versions_link,
-            self._get_change_alias_settings_link,
-            self._get_rename_alias_link,
-            self._get_alias_usage_link,
-        ]
-
-    def get_list_display_links(self, request, list_display):
-        """
-        Remove the linked text when versioning is enabled, because versioning adds actions
-        """
-        if is_versioning_enabled():
-            self.list_display_links = None
-        return super().get_list_display_links(request, list_display)
-
-    def _get_rename_alias_link(self, obj, request, disabled=False):
-        url = admin_reverse('{}_{}_change'.format(
-            obj._meta.app_label, obj._meta.model_name), args=(obj.pk,)
-        )
-        return render_to_string(
-            "admin/djangocms_alias/icons/rename_alias.html",
-            {"url": url, "disabled": disabled},
-        )
-
-    def _get_alias_usage_link(self, obj, request, disabled=False):
-        url = admin_reverse(USAGE_ALIAS_URL_NAME, args=[obj.alias.pk])
-        return render_to_string(
-            "admin/djangocms_alias/icons/view_usage.html",
-            {"url": url, "disabled": disabled},
-        )
-
-    def _get_change_alias_settings_link(self, obj, request, disabled=False):
-        url = admin_reverse('{}_{}_change'.format(
-            obj._meta.app_label, obj.alias._meta.model_name), args=(obj.alias.pk,)
-        )
-        return render_to_string(
-            "admin/djangocms_alias/icons/change_alias_settings.html",
-            {"url": url, "disabled": disabled},
-        )
-
-    def _get_preview_link(self, obj, request, disabled=False):
-        """
-        Return a user friendly button for previewing the content model
-        :param obj: Instance of versioned content model
-        :param request: The request to admin menu
-        :param disabled: Should the link be marked disabled?
-        :return: Preview icon template
-        """
-        preview_url = obj.get_absolute_url()
-        if not preview_url:
-            disabled = True
-
-        return render_to_string(
-            "djangocms_versioning/admin/icons/preview.html",
-            {"url": preview_url, "disabled": disabled, "keepsideframe": False},
-        )
-
-    def change_view(self, request, object_id, form_url='', extra_context=None):
-        extra_context = extra_context or {}
-        # Provide additional context to the changeform
-        extra_context['is_versioning_enabled'] = is_versioning_enabled()
-        return super().change_view(
-            request, object_id, form_url, extra_context=extra_context,
-        )
+        return False