bazis-permit 2.2.0__py3-none-any.whl

bazis/contrib/permit/__init__.py

@@ -0,0 +1,35 @@
+# Copyright 2026 EcoFuture Technology Services LLC and contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+try:
+    from importlib.metadata import PackageNotFoundError, version
+    __version__ = version('bazis-permit')
+except PackageNotFoundError:
+    __version__ = 'dev'
+
+
+"""
+TODO: there is a problem now:
+if the add action is available for an object, it can be added with a reference to
+an external object that the user does not have access to.
+this happens because the object does not have filled selectors at the addition stage.
+
+we need a solution that will allow checking the availability of related objects
+at the stage of adding or editing the main object.
+
+that is, we need a solution that will make such a permission work:
+'entity.extended_entity.item.add.author_parent', # only those who are the author of the
+parent record can add entries
+
+"""

bazis/contrib/permit/_version.py

@@ -0,0 +1,34 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
+else:
+    VERSION_TUPLE = object
+    COMMIT_ID = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
+
+__version__ = version = '2.2.0'
+__version_tuple__ = version_tuple = (2, 2, 0)
+
+__commit_id__ = commit_id = None

bazis/contrib/permit/admin.py

@@ -0,0 +1,33 @@
+# Copyright 2026 EcoFuture Technology Services LLC and contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from django.contrib import admin
+
+from . import models
+from .admin_abstract import GroupPermissionAdminBase, PermissionAdminBase, RoleAdminBase
+
+
+@admin.register(models.Role)
+class RoleAdmin(RoleAdminBase):
+    pass
+
+
+@admin.register(models.GroupPermission)
+class GroupPermissionAdmin(GroupPermissionAdminBase):
+    pass
+
+
+@admin.register(models.Permission)
+class PermissionAdmin(PermissionAdminBase):
+    pass

bazis/contrib/permit/admin_abstract.py

@@ -0,0 +1,198 @@
+# Copyright 2026 EcoFuture Technology Services LLC and contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import re
+
+from django import forms
+from django.contrib import admin
+from django.contrib.admin.views.autocomplete import AutocompleteJsonView
+from django.contrib.admin.widgets import AutocompleteMixin as AutocompleteMixinDjango
+from django.urls import re_path, reverse
+from django.utils.html import mark_safe
+from django.utils.text import capfirst
+from django.utils.translation import gettext_lazy as _
+
+from translated_fields import TranslatedFieldAdmin
+
+from bazis.contrib.permit.schemas import PATTERN_SELECTORS
+from bazis.contrib.users import get_user_model
+from bazis.core.admin_abstract import AutocompleteMixin, DtAdminMixin, M2mThroughMixin
+from bazis.core.utils.sets_order import OrderedSet
+
+
+User = get_user_model()
+
+
+class UserPermitAdminMixin:
+    """
+    A mixin class for customizing the Django admin interface for user permits,
+    adding additional fields and display options related to user roles.
+    """
+
+    def get_fields_permissions(self, request, obj=None):
+        """
+        Extends the parent method to include 'roles' and 'role_current' in the fields
+        permissions for the admin interface.
+        """
+        return super().get_fields_permissions(request, obj) + ('roles', 'role_current')
+
+    def get_list_display(self, request):
+        """
+        Extends the parent method to include 'get_roles_name' and 'role_current' in the
+        list display for the admin interface, ensuring unique display fields using
+        OrderedSet.
+        """
+        return tuple(
+            OrderedSet(
+                ('id',) + super().get_list_display(request) + ('get_roles_name', 'role_current')
+            )
+        )
+
+    @admin.display(description=_('Roles'))
+    def get_roles_name(self, user):
+        """
+        Returns a safe HTML string that displays the names of all roles associated with
+        a user, separated by line breaks. This method is used in the admin interface to
+        show user roles.
+        """
+        return mark_safe('<br/>'.join([role.name for role in user.roles.all()]))
+
+
+class RoleAdminBase(M2mThroughMixin, DtAdminMixin, TranslatedFieldAdmin, admin.ModelAdmin):
+    """
+    Admin configuration for the Role model, including list display, editable fields,
+    and horizontal filters.
+    """
+
+    list_display = (
+        '__str__',
+        'slug',
+        'is_system',
+    )
+    list_editable = ('is_system',)
+    filter_horizontal = ('groups_permission',)
+
+
+class GroupPermissionAdminBase(DtAdminMixin, TranslatedFieldAdmin, admin.ModelAdmin):
+    """
+    Admin configuration for the GroupPermission model, including list display,
+    editable fields, and horizontal filters.
+    """
+
+    filter_horizontal = ('permissions',)
+    list_display = (
+        'pk',
+        'name',
+        'slug',
+    )
+    list_editable = (
+        'slug',
+    )
+
+
+class PermissionAdminBase(DtAdminMixin, TranslatedFieldAdmin, admin.ModelAdmin):
+    """
+    Admin configuration for the Permission model, including list display, editable
+    fields, and search fields.
+    """
+
+    list_display = (
+        '__str__',
+        'slug',
+    )
+    search_fields = ('slug',)
+    list_editable = ('slug',)
+
+
+class PermitAutocompleteJsonView(AutocompleteJsonView):
+    def process_request(self, request):
+        if match := re.match(PATTERN_SELECTORS, request.GET['field_name']):
+            target_field = match.group(1)
+            request_GET = request.GET.copy() # noqa: N806
+            request_GET['field_name'] = target_field
+            request.GET = request_GET
+        return super().process_request(request)
+
+
+class PermitAutocompleteSelectMultiple(AutocompleteMixinDjango, forms.SelectMultiple):
+    def __init__(self, origin_field, ref_field, admin_site, using, url_autocomplete, **kwargs):
+        self.url_autocomplete = url_autocomplete
+        self.origin_field = origin_field
+        super().__init__(ref_field, admin_site, using=using, **kwargs)
+
+    def build_attrs(self, base_attrs, extra_attrs=None):
+        attrs = super().build_attrs(base_attrs, extra_attrs=extra_attrs)
+        attrs['data-field-name'] = self.origin_field.name
+        return attrs
+
+    def get_url(self):
+        return reverse(f'{self.admin_site.name}:{self.url_autocomplete}')
+
+
+class PermitAutocompleteMultipleChoiceField(forms.ModelMultipleChoiceField):
+    def prepare_value(self, value):
+        if isinstance(value, list):
+            return value
+        return super().prepare_value(value)
+
+    def clean(self, value):
+        if value:
+            return [str(user.pk) for user in super().clean(value)]
+        return []
+
+
+class PermitAutocompleteMixin(AutocompleteMixin):
+    """
+    Admin configuration for the ParentEntity model, including display, filter,
+    search options, and related inlines.
+    """
+
+    class Media:
+        js = ('admin/js/autocomplete.js',)
+
+    def formfield_for_dbfield(self, db_field, **kwargs):
+        if match := re.match(PATTERN_SELECTORS, db_field.name):
+            target_field_name = match.group(1)
+            origin_field = db_field
+            db_field = self.model.get_fields_info().relations.get(target_field_name).model_field
+
+            kwargs['widget'] = PermitAutocompleteSelectMultiple(
+                origin_field,
+                db_field,
+                self.admin_site,
+                using=kwargs.get("using"),
+                url_autocomplete=self.get_url_autocomplete()
+            )
+            kwargs['label'] = capfirst(origin_field.verbose_name.strip())
+            kwargs['form_class'] = PermitAutocompleteMultipleChoiceField
+
+        formfield = super().formfield_for_dbfield(db_field, **kwargs)
+
+        return formfield
+
+    def get_url_autocomplete(self):
+        return f'{self.opts.app_label}_{self.opts.model_name}_changelist-autocomplete'
+
+    def get_urls(self):
+        urls = super().get_urls()
+
+        urls = [
+                   re_path(
+                       r'^autocomplete/$', self.autocomplete_view, name=self.get_url_autocomplete()
+                       ),
+               ] + urls
+        return urls
+
+    def autocomplete_view(self, request):
+        return PermitAutocompleteJsonView.as_view(admin_site=self.admin_site)(request)

bazis/contrib/permit/apps.py

@@ -0,0 +1,40 @@
+# Copyright 2026 EcoFuture Technology Services LLC and contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from django.utils.translation import gettext_lazy as _
+
+from bazis.core.utils.apps import BaseConfig
+
+
+class PermitConfig(BaseConfig):
+    """
+    Configuration class for the 'permit' application within the Bazis project. It
+    sets the application name and provides a human-readable name for the application
+    using Django's translation utilities.
+    """
+
+    name = 'bazis.contrib.permit'
+    verbose_name = _('Permit')
+
+    def ready(self):
+        """
+        Method to perform actions when the application is ready, such as importing
+        signals.
+        """
+        super().ready()
+
+        from . import signals  # noqa: F401
+        from .models_abstract import PermitModelMixin
+
+        PermitModelMixin.setup_selectors_fields()

bazis/contrib/permit/conf.py

@@ -0,0 +1,33 @@
+# Copyright 2026 EcoFuture Technology Services LLC and contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from django.utils.translation import gettext_lazy as _
+
+from pydantic import Field
+
+from bazis.core.utils.schemas import BazisSettings
+
+
+class Settings(BazisSettings):
+    """
+    Represents the settings configuration for the application, extending
+    BazisSettings to include a specific permission cache expiry time.
+    """
+
+    BAZIS_PERMISSION_CACHE_EXPIRE: int = Field(
+        7, title=_('Time to store user permissions, sec'), dynamic=True
+    )
+
+
+settings = Settings()

bazis/contrib/permit/locale/en/LC_MESSAGES/django.po

@@ -0,0 +1,93 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
+# This file is distributed under the same license as the PACKAGE package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+# 
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2024-07-04 11:08+0000\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"Language: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+
+#: admin_abstract.py:32 models.py:89
+msgid "Roles"
+msgstr ""
+
+#: apps.py:13
+msgid "Permit"
+msgstr ""
+
+#: conf.py:13
+msgid "Time to store user permissions, sec"
+msgstr ""
+
+#: models.py:28
+msgid "Label"
+msgstr ""
+
+#: models.py:57
+msgid "Name"
+msgstr ""
+
+#: models.py:78 models.py:104
+msgid "Permission Groups"
+msgstr ""
+
+#: models.py:80
+msgid "For Anonymous Users"
+msgstr ""
+
+#: models.py:81
+msgid "System Role"
+msgstr ""
+
+#: models.py:88
+msgid "Role"
+msgstr ""
+
+#: models.py:96 models.py:117
+msgid "Permissions"
+msgstr ""
+
+#: models.py:103
+msgid "Permission Group"
+msgstr ""
+
+#: models.py:116
+msgid "Permission"
+msgstr ""
+
+#: models_abstract.py:128
+msgid "User roles"
+msgstr ""
+
+#: models_abstract.py:131
+msgid "Current user role"
+msgstr ""
+
+#: router.py:8
+msgid "Role model"
+msgstr ""
+
+#: routes_abstract.py:449
+msgid "Available for editing"
+msgstr ""
+
+#: routes_abstract.py:460
+msgid "Available for deletion"
+msgstr ""
+
+#: routes_abstract.py:471
+msgid "Available for creation"
+msgstr ""
+
+#: routes_abstract.py:483
+msgid "Available actions"
+msgstr ""

bazis/contrib/permit/locale/messages.pot

@@ -0,0 +1,97 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
+# This file is distributed under the same license as the PACKAGE package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2024-06-06 00:19+0200\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"Language: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=CHARSET\n"
+"Content-Transfer-Encoding: 8bit\n"
+
+#: contrib/permit/routes_abstract.py:353
+msgid "Available for editing"
+msgstr ""
+
+#: contrib/permit/routes_abstract.py:363
+msgid "Available for deletion"
+msgstr ""
+
+#: contrib/permit/routes_abstract.py:373
+msgid "Available for creation"
+msgstr ""
+
+#: contrib/permit/routes_abstract.py:385
+msgid "Available actions"
+msgstr ""
+
+#: contrib/permit/models_abstract.py:96
+msgid "User roles"
+msgstr ""
+
+#: contrib/permit/models_abstract.py:99
+msgid "Current user role"
+msgstr ""
+
+#: contrib/permit/models.py:17
+msgid "Label"
+msgstr ""
+
+#: contrib/permit/models.py:32
+msgid "Name"
+msgstr ""
+
+#: contrib/permit/models.py:42
+#: contrib/permit/models.py:56
+msgid "Permission Groups"
+msgstr ""
+
+#: contrib/permit/models.py:43
+msgid "For Anonymous Users"
+msgstr ""
+
+#: contrib/permit/models.py:44
+msgid "System Role"
+msgstr ""
+
+#: contrib/permit/models.py:47
+msgid "Role"
+msgstr ""
+
+#: contrib/permit/models.py:48
+#: contrib/permit/admin_abstract.py:19
+msgid "Roles"
+msgstr ""
+
+#: contrib/permit/models.py:52
+#: contrib/permit/models.py:62
+msgid "Permissions"
+msgstr ""
+
+#: contrib/permit/models.py:55
+msgid "Permission Group"
+msgstr ""
+
+#: contrib/permit/models.py:61
+msgid "Permission"
+msgstr ""
+
+#: contrib/permit/conf.py:8
+msgid "Time to store user permissions, sec"
+msgstr ""
+
+#: contrib/permit/apps.py:7
+msgid "Permit"
+msgstr ""
+
+#: contrib/permit/router.py:8
+msgid "Role model"
+msgstr ""

bazis/contrib/permit/locale/ru/LC_MESSAGES/django.po

@@ -0,0 +1,93 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
+# This file is distributed under the same license as the PACKAGE package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+# 
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2024-07-04 11:08+0000\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"Language: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+
+#: admin_abstract.py:32 models.py:89
+msgid "Roles"
+msgstr "Роли"
+
+#: apps.py:13
+msgid "Permit"
+msgstr "Разрешение"
+
+#: conf.py:13
+msgid "Time to store user permissions, sec"
+msgstr "Время хранения разрешений пользователя, сек"
+
+#: models.py:28
+msgid "Label"
+msgstr "Метка"
+
+#: models.py:57
+msgid "Name"
+msgstr "Название"
+
+#: models.py:78 models.py:104
+msgid "Permission Groups"
+msgstr "Группы разрешений"
+
+#: models.py:80
+msgid "For Anonymous Users"
+msgstr "Для анонимных юзеров"
+
+#: models.py:81
+msgid "System Role"
+msgstr "Системная роль"
+
+#: models.py:88
+msgid "Role"
+msgstr "Роль"
+
+#: models.py:96 models.py:117
+msgid "Permissions"
+msgstr "Разрешения"
+
+#: models.py:103
+msgid "Permission Group"
+msgstr "Группа разрешений"
+
+#: models.py:116
+msgid "Permission"
+msgstr "Разрешение"
+
+#: models_abstract.py:128
+msgid "User roles"
+msgstr "Роли пользователя"
+
+#: models_abstract.py:131
+msgid "Current user role"
+msgstr "Текущая роль пользователя"
+
+#: router.py:8
+msgid "Role model"
+msgstr "Ролевая модель"
+
+#: routes_abstract.py:449
+msgid "Available for editing"
+msgstr "Доступны для редактирования"
+
+#: routes_abstract.py:460
+msgid "Available for deletion"
+msgstr "Доступны для удаления"
+
+#: routes_abstract.py:471
+msgid "Available for creation"
+msgstr "Доступно для создания"
+
+#: routes_abstract.py:483
+msgid "Available actions"
+msgstr "Доступные действия"