djangocms-alias 2.0.0__tar.gz

djangocms-alias-2.0.0/LICENSE.txt

@@ -0,0 +1,24 @@
+Copyright (c) 2018, Divio AG
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of Divio AG nor the
+      names of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL DIVIO AG BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

djangocms-alias-2.0.0/MANIFEST.in

@@ -0,0 +1,6 @@
+include LICENSE.txt
+include README.rst
+recursive-include djangocms_alias/static *
+recursive-include djangocms_alias/templates *
+recursive-include djangocms_alias/locale *
+recursive-exclude * *.pyc

djangocms-alias-2.0.0/PKG-INFO

@@ -0,0 +1,116 @@
+Metadata-Version: 2.1
+Name: djangocms-alias
+Version: 2.0.0
+Home-page: https://github.com/django-cms/djangocms-alias
+Author: Divio AG
+Author-email: info@divio.ch
+Maintainer: Django CMS Association and contributors
+Maintainer-email: info@django-cms.org
+License: BSD
+Platform: OS Independent
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 3.2
+Classifier: Framework :: Django :: 4.0
+Classifier: Framework :: Django :: 4.1
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.0
+Classifier: Framework :: Django CMS :: 4.1
+Description-Content-Type: text/x-rst
+License-File: LICENSE.txt
+Requires-Dist: Django>=3.2
+Requires-Dist: django-parler>=1.4
+Requires-Dist: django-cms>=4.0rc3
+
+
+
+****************
+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.
+
+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.
+
+.. warning::
+
+    This is the development branch for django CMS version 4.1 support.
+
+    For django CMS V4.0 support, see `support/django-cms-4.0.x branch <https://github.com/django-cms/djangocms-alias/tree/support/django-cms-4.0.x>`_
+
+
+============
+Installation
+============
+
+Requirements
+============
+
+django CMS Alias requires that you have a django CMS 4 (or higher) project already running and set up.
+
+
+To install
+==========
+
+Run::
+
+    pip install git+https://github.com/django-cms/djangocms-alias@master#egg=djangocms-alias
+
+Add ``djangocms_alias`` and ``parler`` to your project's ``INSTALLED_APPS``.
+
+Run::
+
+    python manage.py migrate djangocms_alias
+
+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-3.2--4.1-blue.svg
+   :target: https://www.djangoproject.com/
+
+.. |djangocms4| image:: https://img.shields.io/badge/django%20CMS-4-blue.svg
+   :target: https://www.django-cms.org/

djangocms-alias-2.0.0/README.rst

@@ -0,0 +1,80 @@
+
+
+****************
+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.
+
+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.
+
+.. warning::
+
+    This is the development branch for django CMS version 4.1 support.
+
+    For django CMS V4.0 support, see `support/django-cms-4.0.x branch <https://github.com/django-cms/djangocms-alias/tree/support/django-cms-4.0.x>`_
+
+
+============
+Installation
+============
+
+Requirements
+============
+
+django CMS Alias requires that you have a django CMS 4 (or higher) project already running and set up.
+
+
+To install
+==========
+
+Run::
+
+    pip install git+https://github.com/django-cms/djangocms-alias@master#egg=djangocms-alias
+
+Add ``djangocms_alias`` and ``parler`` to your project's ``INSTALLED_APPS``.
+
+Run::
+
+    python manage.py migrate djangocms_alias
+
+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-3.2--4.1-blue.svg
+   :target: https://www.djangoproject.com/
+
+.. |djangocms4| image:: https://img.shields.io/badge/django%20CMS-4-blue.svg
+   :target: https://www.django-cms.org/

djangocms-alias-2.0.0/djangocms_alias/__init__.py

@@ -0,0 +1 @@
+__version__ = '2.0.0'

djangocms-alias-2.0.0/djangocms_alias/admin.py

@@ -0,0 +1,175 @@
+from django import forms
+from django.contrib import admin
+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 (
+    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 (
+    emit_content_change,
+    emit_content_delete,
+    is_versioning_enabled,
+)
+
+
+__all__ = [
+    'AliasAdmin',
+    'CategoryAdmin',
+    'AliasContentAdmin',
+]
+
+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 (
+        ExtendedGrouperVersionAdminMixin,
+        StateIndicatorMixin,
+    )
+    from djangocms_versioning.models import Version
+
+    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)
+class CategoryAdmin(TranslatableAdmin):
+    list_display = ['name']
+
+    def save_model(self, request, obj, form, change):
+        change = not obj._state.adding
+        super().save_model(request, obj, form, change)
+        if change:
+            # 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()),
+                sender=self.model,
+            )
+
+
+@admin.register(Alias)
+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) -> list:
+        return urlpatterns + super().get_urls()
+
+    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: HttpRequest, obj: Alias = None) -> bool:
+        # Alias can be deleted by users who can add aliases,
+        # if that alias is not referenced anywhere.
+        if obj:
+            if not obj.is_in_use:
+                return request.user.has_perm(
+                    get_model_permission_codename(self.model, 'add'),
+                )
+            return request.user.is_superuser
+        return False
+
+    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 delete_model(self, request: HttpRequest, obj: Alias):
+        super().delete_model(request, obj)
+
+        # 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(admin.ModelAdmin):
+    # Disable dropdown actions
+    actions = None
+    change_form_template = "admin/djangocms_alias/aliascontent/change_form.html"
+
+    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,
+        ))
+
+    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 has_module_permission(self, request: HttpRequest) -> bool:
+        """Hides admin class in admin site overview"""
+
+        return False

djangocms-alias-2.0.0/djangocms_alias/apps.py

@@ -0,0 +1,7 @@
+from django.apps import AppConfig
+from django.utils.translation import gettext_lazy as _
+
+
+class AliasConfig(AppConfig):
+    name = 'djangocms_alias'
+    verbose_name = _('django CMS Alias')

djangocms-alias-2.0.0/djangocms_alias/cms_config.py

@@ -0,0 +1,57 @@
+from django.apps import apps
+from django.conf import settings
+
+from cms.app_base import CMSAppConfig
+
+from .models import AliasContent, AliasPlugin, copy_alias_content
+from .rendering import render_alias_content
+
+
+try:
+    apps.get_app_config('djangocms_internalsearch')
+    from .internal_search import AliasContentConfig
+except (ImportError, LookupError):
+    AliasContentConfig = None
+
+djangocms_versioning_installed = apps.is_installed("djangocms_versioning")
+
+
+class AliasCMSConfig(CMSAppConfig):
+    cms_enabled = True
+    cms_toolbar_enabled_models = [(AliasContent, render_alias_content)]
+    moderated_models = [AliasContent]
+
+    djangocms_moderation_enabled = getattr(
+        settings, 'MODERATING_ALIAS_MODELS_ENABLED', True)
+    djangocms_versioning_enabled = getattr(
+        settings, 'VERSIONING_ALIAS_MODELS_ENABLED', True) and djangocms_versioning_installed
+
+    if djangocms_versioning_enabled:
+
+        from cms.utils.i18n import get_language_tuple
+
+        from djangocms_versioning.datastructures import VersionableItem
+
+        versioning = [
+            VersionableItem(
+                content_model=AliasContent,
+                grouper_field_name='alias',
+                extra_grouping_fields=["language"],
+                version_list_filter_lookups={"language": get_language_tuple},
+                copy_function=copy_alias_content,
+                grouper_selector_option_label=lambda obj, lang: obj.get_name(lang),
+            ),
+        ]
+
+    djangocms_references_enabled = getattr(
+        settings, 'REFERENCES_ALIAS_MODELS_ENABLED', True)
+    reference_fields = [
+        (AliasPlugin, 'alias'),
+    ]
+
+    # Internalsearch configuration
+    if AliasContentConfig:
+        djangocms_internalsearch_enabled = True
+        internalsearch_config_list = [
+            AliasContentConfig,
+        ]

djangocms-alias-2.0.0/djangocms_alias/cms_menus.py

@@ -0,0 +1,20 @@
+from menus.base import Modifier
+from menus.menu_pool import menu_pool
+
+from .constants import PLUGIN_URL_NAME_PREFIX
+from .models import AliasContent
+
+
+class AliasDisableMenu(Modifier):
+    """Disable menu rendering on alias pages"""
+
+    def modify(self, request, nodes, namespace, root_id, post_cut, breadcrumb):
+        if (
+            request.toolbar.app_name == PLUGIN_URL_NAME_PREFIX
+            or isinstance(request.toolbar.obj, AliasContent)
+        ):
+            return []
+        return nodes
+
+
+menu_pool.register_modifier(AliasDisableMenu)

djangocms-alias-2.0.0/djangocms_alias/cms_plugins.py

@@ -0,0 +1,165 @@
+from copy import copy
+
+from django.utils.translation import (
+    get_language_from_request,
+    gettext_lazy as _,
+)
+
+from cms.plugin_base import CMSPluginBase, PluginMenuItem
+from cms.plugin_pool import plugin_pool
+from cms.utils.permissions import (
+    get_model_permission_codename,
+    has_plugin_permission,
+)
+from cms.utils.plugins import copy_plugins_to_placeholder
+from cms.utils.urlutils import add_url_parameters, admin_reverse
+
+from .constants import CREATE_ALIAS_URL_NAME, DETACH_ALIAS_PLUGIN_URL_NAME
+from .forms import AliasPluginForm
+from .models import Alias as AliasModel, AliasContent, AliasPlugin
+
+
+__all__ = [
+    'Alias',
+]
+
+
+@plugin_pool.register_plugin
+class Alias(CMSPluginBase):
+    name = _('Alias')
+    model = AliasPlugin
+    form = AliasPluginForm
+
+    def get_render_template(self, context, instance, placeholder):
+        if (
+            isinstance(instance.placeholder.source, AliasContent)
+            and instance.is_recursive()
+        ):
+            return 'djangocms_alias/alias_recursive.html'
+        return f'djangocms_alias/{instance.template}/alias.html'
+
+    @classmethod
+    def get_extra_plugin_menu_items(cls, request, plugin):
+        if plugin.plugin_type == cls.__name__:
+            edit_endpoint = plugin.alias.get_absolute_url()
+            detach_endpoint = admin_reverse(
+                DETACH_ALIAS_PLUGIN_URL_NAME,
+                args=[plugin.pk],
+            )
+
+            plugin_menu_items = [
+                PluginMenuItem(
+                    _('Edit Alias'),
+                    edit_endpoint,
+                    action='sideframe',
+                    attributes={'cms-icon': 'alias'},
+                ),
+            ]
+
+            if cls.can_detach(
+                request.user,
+                plugin.placeholder,
+                plugin.alias.get_plugins(),
+            ):
+                plugin_menu_items.append(
+                    PluginMenuItem(
+                        _('Detach Alias'),
+                        detach_endpoint,
+                        action='modal',
+                        attributes={'cms-icon': 'alias'},
+                    )
+                )
+            return plugin_menu_items
+
+        data = {
+            'plugin': plugin.pk,
+            'language': get_language_from_request(request, check_path=True),
+        }
+        endpoint = add_url_parameters(admin_reverse(CREATE_ALIAS_URL_NAME), **data)
+        return [
+            PluginMenuItem(
+                _('Create Alias'),
+                endpoint,
+                action='modal',
+                attributes={'cms-icon': 'alias'},
+            ),
+        ]
+
+    @classmethod
+    def get_extra_placeholder_menu_items(cls, request, placeholder):
+        data = {
+            'placeholder': placeholder.pk,
+            'language': get_language_from_request(request, check_path=True),
+        }
+        endpoint = add_url_parameters(admin_reverse(CREATE_ALIAS_URL_NAME), **data)
+
+        menu_items = [
+            PluginMenuItem(
+                _('Create Alias'),
+                endpoint,
+                action='modal',
+                attributes={'cms-icon': 'alias'},
+            ),
+        ]
+        return menu_items
+
+    @classmethod
+    def can_create_alias(cls, user, plugins=None, replace=False):
+        if not user.has_perm(
+            get_model_permission_codename(AliasModel, 'add'),
+        ):
+            return False
+
+        if not plugins:
+            return True
+        elif replace:
+            target_placeholder = plugins[0].placeholder
+            if (
+                not target_placeholder.check_source(user)
+                or not has_plugin_permission(user, Alias.__name__, 'add')
+            ):
+                return False
+
+        return all(
+            has_plugin_permission(
+                user,
+                plugin.plugin_type,
+                'add',
+            ) for plugin in plugins
+        )
+
+    @classmethod
+    def can_detach(cls, user, target_placeholder, plugins):
+        return all(
+            has_plugin_permission(
+                user,
+                plugin.plugin_type,
+                'add',
+            ) for plugin in plugins
+        ) and target_placeholder.check_source(user)
+
+    @classmethod
+    def detach_alias_plugin(cls, plugin, language):
+        source_placeholder = plugin.alias.get_placeholder(language, show_draft_content=True)  # We're in edit mode
+        target_placeholder = plugin.placeholder
+
+        # Deleting uses a copy of a plugin to preserve pk on existing
+        # ``plugin`` object. This is done due to
+        # plugin.get_plugin_toolbar_info requiring a PK in a passed
+        # instance.
+        target_placeholder.delete_plugin(copy(plugin))
+        target_placeholder._shift_plugin_positions(
+            language,
+            plugin.position,
+            offset=target_placeholder.get_last_plugin_position(language),
+        )
+        if source_placeholder:
+            source_plugins = source_placeholder.get_plugins_list()
+            copied_plugins = copy_plugins_to_placeholder(
+                source_plugins,
+                placeholder=target_placeholder,
+                language=language,
+                start_positions={language: plugin.position},
+            )
+            return copied_plugins
+        return []