fix: Respect site-specific language configurations (#480)

* fix: Respect site-specific language configurations

* Update djangocms_versioning/admin.py

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>

* Update djangocms_versioning/admin.py

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>

* Update djangocms_versioning/cms_config.py

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>

* fix: Take get_current_site from Django

* Update admin markup

* Fix: Archive form markup

* fix: Ruff linting

* fix: make the python 3.10 plus

* fix:  lint issues

---------

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Co-authored-by: Vinit kumar <[email protected]>

Author: 3 people

djangocms_versioning/admin.py

@@ -8,6 +8,7 @@
 from cms.utils.urlutils import admin_reverse
 from django.conf import settings
 from django.contrib.admin.utils import flatten_fieldsets
+from django.contrib.sites.shortcuts import get_current_site
 from django.core.exceptions import (
     ImproperlyConfigured,
     ObjectDoesNotExist,
@@ -52,13 +53,10 @@ def __init__(self):
     @cached_property
     def versionables_by_content(self):
         """Returns a dict of {content_model_cls: VersionableItem obj}"""
-        return {
-            versionable.content_model: versionable for versionable in self.versionables
-        }
+        return {versionable.content_model: versionable for versionable in self.versionables}
 
     def is_content_model_versioned(self, content_model):
-        """Returns if the content model is registered for versioning.
-        """
+        """Returns if the content model is registered for versioning."""
         return content_model in self.versionables_by_content
 
     @cached_property
@@ -91,9 +89,7 @@ def handle_versioning_setting(self, cms_config):
             # still changing and needs to be calculated on the fly
             registered_so_far = [v.content_model for v in self.versionables]
             if versionable.content_model in registered_so_far:
-                raise ImproperlyConfigured(
-                    f"{versionable.content_model!r} has already been registered"
-                )
+                raise ImproperlyConfigured(f"{versionable.content_model!r} has already been registered")
             # Checks passed. Add versionable to our master list
             self.versionables.append(versionable)
 
@@ -118,15 +114,13 @@ def handle_admin_classes(self, cms_config):
         with an admin model class that inherits from `versionable.content_admin_mixin`.
         """
         replace_admin_for_models(
-            [
-                (versionable.content_model, versionable.content_admin_mixin)
-                for versionable in cms_config.versioning
-            ]
+            [(versionable.content_model, versionable.content_admin_mixin) for versionable in cms_config.versioning]
         )
         replace_admin_for_models(
             [
                 (versionable.grouper_model, versionable.grouper_admin_mixin)
-                for versionable in cms_config.versioning if versionable.grouper_admin_mixin is not None
+                for versionable in cms_config.versioning
+                if versionable.grouper_admin_mixin is not None
             ]
         )
 
@@ -153,12 +147,15 @@ def handle_content_model_manager(self, cms_config):
         """
         for versionable in cms_config.versioning:
             replace_manager(versionable.content_model, "objects", PublishedContentManagerMixin)
-            replace_manager(versionable.content_model, "admin_manager", AdminManagerMixin,
-                            _group_by_key=list(versionable.grouping_fields))
+            replace_manager(
+                versionable.content_model,
+                "admin_manager",
+                AdminManagerMixin,
+                _group_by_key=list(versionable.grouping_fields),
+            )
 
     def handle_admin_field_modifiers(self, cms_config):
-        """Allows for the transformation of a given field in the ExtendedVersionAdminMixin
-        """
+        """Allows for the transformation of a given field in the ExtendedVersionAdminMixin"""
         extended_admin_field_modifiers = getattr(cms_config, "extended_admin_field_modifiers", None)
         if not isinstance(extended_admin_field_modifiers, list):
             raise ImproperlyConfigured("extended_admin_field_modifiers must be list of dictionaries")
@@ -171,9 +168,7 @@ def configure_app(self, cms_config):
             self.handle_admin_field_modifiers(cms_config)
         # Validation to ensure either the versioning or the
         # versioning_add_to_confirmation_context config has been defined
-        has_extra_context = hasattr(
-            cms_config, "versioning_add_to_confirmation_context"
-        )
+        has_extra_context = hasattr(cms_config, "versioning_add_to_confirmation_context")
         has_models_to_register = hasattr(cms_config, "versioning")
         if not has_extra_context and not has_models_to_register:
             raise ImproperlyConfigured(
@@ -257,9 +252,11 @@ def get_readonly_fields(self, request, obj=None):
         return fields
 
     def get_queryset(self, request):
-        queryset = super().get_queryset(request)\
+        return (
+            super()
+            .get_queryset(request)
             .prefetch_related(Prefetch("versions", to_attr="prefetched_versions"))
-        return queryset
+        )
 
     def copy_language(self, request, object_id):
         target_language = request.POST.get("target_language")
@@ -338,18 +335,18 @@ def get_indicator_menu(cls, request, page_content):
 
 
 class VersioningCMSConfig(CMSAppConfig):
-    """Implement versioning for core cms models
-    """
+    """Implement versioning for core cms models"""
+
     cms_enabled = True
-    djangocms_versioning_enabled = getattr(
-        settings, "VERSIONING_CMS_MODELS_ENABLED", True
-    )
+    djangocms_versioning_enabled = getattr(settings, "VERSIONING_CMS_MODELS_ENABLED", True)
     versioning = [
         VersionableItem(
             content_model=PageContent,
             grouper_field_name="page",
             extra_grouping_fields=["language"],
-            version_list_filter_lookups={"language": get_language_tuple},
+            version_list_filter_lookups={
+                "language": lambda *args: get_language_tuple(site_id=get_current_site(args[0]).pk)
+            },
             copy_function=copy_page_content,
             grouper_selector_option_label=label_from_instance,
             on_publish=on_page_content_publish,

djangocms_versioning/cms_config.py

@@ -1,6 +1,7 @@
+from __future__ import annotations
+
 from collections import OrderedDict
 from copy import copy
-from typing import Optional
 
 from cms import __version__ as cms_version
 from cms.cms_toolbars import (
@@ -297,10 +298,10 @@ class VersioningPageToolbar(PageToolbar):
     """
 
     def __init__(self, *args, **kwargs):
-        self.page_content: Optional[PageContent] = None
+        self.page_content: PageContent | None = None
         super().__init__(*args, **kwargs)
 
-    def get_page_content(self, language: Optional[str] = None) -> PageContent:
+    def get_page_content(self, language: str | None = None) -> PageContent:
         # This method overwrites the method in django CMS core. Not necessary
         # for django CMS 4.2+
         if not language:

djangocms_versioning/cms_toolbars.py

@@ -1,6 +1,8 @@
+from __future__ import annotations
+
 from collections.abc import Iterable
 from itertools import chain
-from typing import Any, Optional
+from typing import Any
 
 from cms.extensions.models import BaseExtension
 from cms.models import Placeholder, PlaceholderRelationField
@@ -16,7 +18,7 @@
 class BaseVersionableItem:
     concrete = False
 
-    def __init__(self, content_model: type[models.Model], content_admin_mixin: Optional[type] = None):
+    def __init__(self, content_model: type[models.Model], content_admin_mixin: type | None = None):
         self.content_model = content_model
         self.content_admin_mixin = content_admin_mixin or VersioningAdminMixin
 
@@ -29,15 +31,15 @@ def __init__(
         content_model: type[models.Model],
         grouper_field_name: str,
         copy_function: callable,
-        extra_grouping_fields: Optional[Iterable[str]] = None,
-        version_list_filter_lookups: Optional[dict[str, Any]] = None,
+        extra_grouping_fields: Iterable[str] | None = None,
+        version_list_filter_lookups: dict[str, Any] | None = None,
         on_publish=None,
         on_unpublish=None,
         on_draft_create=None,
         on_archive=None,
         grouper_selector_option_label=False,
-        grouper_admin_mixin: Optional[type] = None,
-        content_admin_mixin: Optional[type] = None,
+        grouper_admin_mixin: type | None = None,
+        content_admin_mixin: type | None = None,
         preview_url=None,
     ):
         super().__init__(content_model, content_admin_mixin)
@@ -161,7 +163,7 @@ def grouper_choices_queryset(self) -> models.QuerySet:
         cache_name = self.grouper_field.remote_field.get_accessor_name()
         return self.grouper_model._base_manager.prefetch_related(models.Prefetch(cache_name, queryset=content_objects))
 
-    def get_grouper_with_fallbacks(self, grouper_id) -> Optional[models.Model]:
+    def get_grouper_with_fallbacks(self, grouper_id) -> models.Model | None:
         return self.grouper_choices_queryset().filter(pk=grouper_id).first()
 
     def _get_content_types(self) -> set[int]:
@@ -193,7 +195,7 @@ class VersionableItemAlias(BaseVersionableItem):
     """
 
     def __init__(
-        self, content_model: type[models.Model], to: BaseVersionableItem, content_admin_mixin: Optional[type] = None
+        self, content_model: type[models.Model], to: BaseVersionableItem, content_admin_mixin: type | None = None
     ):
         super().__init__(content_model, content_admin_mixin)
         self.to = to

djangocms_versioning/datastructures.py

@@ -1,4 +1,3 @@
-import typing
 from urllib.parse import urljoin
 
 from cms.toolbar.utils import get_object_preview_url
@@ -11,7 +10,7 @@
 from djangocms_versioning.helpers import send_email
 
 
-def get_full_url(location: str, site: typing.Union[Site, None] = None) -> str:
+def get_full_url(location: str, site: Site | None = None) -> str:
     if not site:
         site = Site.objects.get_current()
 

djangocms_versioning/emails.py

@@ -1,8 +1,9 @@
+from __future__ import annotations
+
 import copy
 import warnings
 from collections.abc import Iterable
 from contextlib import contextmanager
-from typing import Optional
 
 from cms.models import Page, PageContent, Placeholder
 from cms.toolbar.utils import get_object_edit_url, get_object_preview_url
@@ -71,7 +72,7 @@ def _replace_admin_for_model(modeladmin: type[admin.ModelAdmin], mixin: type, ad
     admin_site.register(modeladmin.model, new_admin_class)
 
 
-def replace_admin_for_models(pairs: tuple[type[models.Model], type], admin_site: Optional[admin.AdminSite] = None):
+def replace_admin_for_models(pairs: tuple[type[models.Model], type], admin_site: admin.AdminSite | None = None):
     """
     :param models: List of (model class, admin mixin class) tuples
     :param admin_site: AdminSite instance
@@ -86,7 +87,7 @@ def replace_admin_for_models(pairs: tuple[type[models.Model], type], admin_site:
         _replace_admin_for_model(modeladmin, mixin, admin_site)
 
 
-def register_versionadmin_proxy(versionable, admin_site: Optional[admin.AdminSite] = None):
+def register_versionadmin_proxy(versionable, admin_site: admin.AdminSite | None = None):
     """Creates a model admin class based on `VersionAdmin` and registers
     it with `admin_site` for `versionable.version_model_proxy`.
 
@@ -281,7 +282,7 @@ def get_content_types_with_subclasses(models: Iterable[type[models.Model]], usin
 
 
 def get_preview_url(
-    content_obj: models.Model, language: Optional[str] = None
+    content_obj: models.Model, language: str | None = None
 ) -> str:
     """If the object is editable the cms preview view should be used, with the toolbar.
     This method provides the URL for it. It falls back the standard change view

djangocms_versioning/helpers.py

@@ -1,4 +1,4 @@
-import typing
+from __future__ import annotations
 
 from cms.utils.urlutils import admin_reverse
 from django.contrib.auth import get_permission_codename
@@ -92,8 +92,8 @@ def content_indicator_menu(request, status, versions, back=""):
 
 def content_indicator(
     content_obj: models.Model,
-    versions: typing.Optional[list[Version]] = None
-) -> typing.Optional[str]:
+    versions: list[Version] | None = None
+) -> str | None:
     """Translates available versions into status to be reflected by the indicator.
     Function caches the result in the page_content object"""
 

djangocms_versioning/indicators.py

@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
 # Generated by Django 1.11.13 on 2018-06-12 12:21
-from __future__ import unicode_literals
 
 from django.db import migrations, models
 

djangocms_versioning/migrations/0001_initial.py

@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
 # Generated by Django 1.11.14 on 2018-07-24 12:42
-from __future__ import unicode_literals
 
 from django.db import migrations
 

djangocms_versioning/migrations/0002_delete_campaign.py

@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
 # Generated by Django 1.11 on 2018-07-30 14:41
-from __future__ import unicode_literals
 
 from django.db import migrations, models
 import django.db.models.deletion