educommon 3.13.2__tar.gz → 3.14.0__tar.gz

{educommon-3.13.2 → educommon-3.14.0}/CHANGELOG.md

@@ -28,6 +28,24 @@
 ### Удалено
 
 
+## [3.14.0] - 2025-04-09
+
+Доработки журнала изменений до состояния старого журнала в ЭШ
+
+### Добавлено
+
+- [EDUSCHL-23386](https://jira.bars.group/browse/EDUSCHL-23386)
+  PATCH Столбец имитация (без функциональности, для доработки работоспособности в последующих задачах).
+
+### Изменено
+
+- [EDUSCHL-23386](https://jira.bars.group/browse/EDUSCHL-23386)
+  MINOR Классы LogProxy, AuditLogPack преобразованы в абстрактные с добавлением абстрактных методов для 
+  извлечения исходных данных необходимых при: отображении ФИО пользователя в журнале изменений; фильтрации по ФИО;
+  отображении ФИО, организации в окне редактирования записи журнала изменений. 
+  Подробнее о необходимых настройках в audit_log/README.rst.
+
+
 ## [3.13.2] - 2024-04-09
 
 Небольшой рефакторинг для корректной сборки пакета.

{educommon-3.13.2 → educommon-3.14.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: educommon
-Version: 3.13.2
+Version: 3.14.0
 Summary: Общая кодовая база для проектов БЦ Образование
 Author-email: BARS Group <education_dev@bars-open.ru>
 Project-URL: Homepage, https://stash.bars-open.ru/projects/EDUBASE/repos/educommon/browse

educommon-3.14.0/src/educommon/audit_log/README.rst

@@ -0,0 +1,64 @@
+Приложение "Логирование изменений объектов на уровне БД"
+=================================
+
+Установка
+--------------
+1. На основе абстрактного класса LogProxy из educommon/audit_log/proxies.py создать класс и реализовать его абстрактные 
+методы. 
+
+.. code-block:: python
+
+    class AuditLogProxy(LogProxy):
+        """Прокси-модель для отображения логов."""
+
+        class Meta:
+            proxy = True
+
+        @property
+        def user_fullname(self) -> str:
+            """Полное имя пользователя."""
+            pass
+
+        @property
+        def user_organization(self) -> str:
+            """Название организации, к которой привязан пользователь."""
+            pass
+
+
+В случае использования сервисной базы для нового класса необходимо реализовать
+роутер на основе ServiceDbRouterBase из educommon/django/db/routers.py и добавить его в settings.DATABASE_ROUTERS
+
+.. code-block:: python
+
+    class AuditLogProxyDbRouter(MyServiceDbRouterBase):
+        """Роутер базы данных для AuditLogProxy."""
+
+        app_name = 'model_app_name'
+        service_db_model_names = {'AuditLogProxy'}
+
+
+2. На основе абстрактного класса AuditLogPack из educommon/audit_log/actions.py создать класс и реализовать его абстрактные 
+методы. В атрибуте model указать модель из пункта "1".
+
+.. code-block:: python
+
+    class AuditPack(AuditLogPack):
+        """Журнал изменений."""
+
+        title = 'Журнал изменений (новый)'
+        model = AuditLogProxy
+
+        def _make_name_filter(self, field, value):
+            """Создает lookup фильтра по фамилии/имени/отчеству пользователя.
+
+            :param str field: название поля ('firstname', 'surname', 'patronymic').
+            :param str value: значение, по которому фильтруется queryset.
+            """
+            pass
+
+Выполнить регистрацию нового пака с помощью контроллера основных приложений проекта.
+
+3. Добавить 'educommon.audit_log.middleware.AuditLogMiddleware', расположив его так, чтобы при его отработке 
+в request уже был определен пользователь.
+
+4. Создать и выполнить миграции.

{educommon-3.13.2 → educommon-3.14.0}/src/educommon/audit_log/actions.py

@@ -1,3 +1,7 @@
+from abc import (
+    ABCMeta,
+    abstractmethod,
+)
 from datetime import (
     date,
     timedelta,
@@ -45,7 +49,6 @@ from educommon.audit_log.ui import (
 from educommon.audit_log.utils import (
     get_model_choices,
     make_hstore_filter,
-    make_name_filter,
 )
 from educommon.m3 import (
     PackValidationMixin,
@@ -59,7 +62,7 @@ from educommon.utils.ui import (
 )
 
 
-class AuditLogPack(ViewWindowPackMixin, PackValidationMixin, ObjectPack):
+class AuditLogPack(ViewWindowPackMixin, PackValidationMixin, ObjectPack, metaclass=ABCMeta):
     """Журнал изменений."""
 
     title = 'Журнал изменений'
@@ -82,64 +85,81 @@ class AuditLogPack(ViewWindowPackMixin, PackValidationMixin, ObjectPack):
         model, 'time', get_from=lambda: date.today() - timedelta(days=2), get_to=date.today
     )
 
-    columns = [
-        {'data_index': 'time', 'width': 140, 'header': 'Дата и время', 'sortable': True, 'filter': date_filter.filter},
-        {
-            'data_index': 'user_name',
-            'width': 130,
-            'header': 'Пользователь',
-            'filter': ff('table__name', lookup=lambda x: make_name_filter('surname', x))
-            & ff('table__name', lookup=lambda x: make_name_filter('firstname', x))
-            & ff('table__name', lookup=lambda x: make_name_filter('patronymic', x)),
-        },
-        {
-            'data_index': 'operation',
-            'width': 60,
-            'header': 'Операция',
-            'filter': ff('operation', ask_before_deleting=False),
-        },
-        {
-            'data_index': 'model_name',
-            'width': 220,
-            'header': 'Модель объекта',
-            'filter': ff(
-                'table',
-                control_creator=lambda: make_combo_box(
-                    data=get_model_choices(),
-                    ask_before_deleting=False,
+    def _generate_columns(self):
+        """Формирует наполнение столбцов."""
+        columns = [
+            {
+                'data_index': 'time',
+                'width': 140,
+                'header': 'Дата и время',
+                'sortable': True,
+                'filter': self.date_filter.filter
+            },
+            {
+                'data_index': 'user_name',
+                'width': 130,
+                'header': 'Пользователь',
+                'filter': self.ff('table__name', lookup=lambda x: self._make_name_filter('surname', x))
+                & self.ff('table__name', lookup=lambda x: self._make_name_filter('firstname', x))
+                & self.ff('table__name', lookup=lambda x: self._make_name_filter('patronymic', x)),
+            },
+            {
+                'data_index': 'operation',
+                'width': 60,
+                'header': 'Операция',
+                'filter': self.ff('operation', ask_before_deleting=False),
+            },
+            {
+                'data_index': 'model_name',
+                'width': 220,
+                'header': 'Модель объекта',
+                'filter': self.ff(
+                    'table',
+                    control_creator=lambda: make_combo_box(
+                        data=get_model_choices(),
+                        ask_before_deleting=False,
+                    ),
+                ),
+            },
+            {
+                'data_index': 'object_id',
+                'width': 50,
+                'header': 'Код объекта',
+                'filter': self.ff('object_id'),
+            },
+            {
+                'data_index': 'ip',
+                'width': 60,
+                'header': 'IP',
+                'filter': self.ff(
+                    'ip',
+                    parser_map=(GenericIPAddressField, 'str', '%s__contains'),
+                    control_creator=ExtStringField,
                 ),
-            ),
-        },
-        {
-            'data_index': 'object_id',
-            'width': 50,
-            'header': 'Код объекта',
-            'filter': ff('object_id'),
-        },
-        {
-            'data_index': 'ip',
-            'width': 60,
-            'header': 'IP',
-            'filter': ff(
-                'ip',
-                parser_map=(GenericIPAddressField, 'str', '%s__contains'),
-                control_creator=ExtStringField,
-            ),
-        },
-        {
-            'data_index': 'object_string',
-            'width': 180,
-            'header': 'Объект',
-            'filter': ff(
-                'data',
-                parser_map=(HStoreField, 'str', '%s__values__icontains'),
-                lookup=lambda x: make_hstore_filter('data', x),
-                control_creator=ExtStringField,
-            ),
-        },
-    ]
+            },
+            {
+                'data_index': 'object_string',
+                'width': 180,
+                'header': 'Объект',
+                'filter': self.ff(
+                    'data',
+                    parser_map=(HStoreField, 'str', '%s__values__icontains'),
+                    lookup=lambda x: make_hstore_filter('data', x),
+                    control_creator=ExtStringField,
+                ),
+            },
+            {
+                'data_index': '',
+                'width': 40,
+                'header': 'Имитация',
+            },
+        ]
+
+        return columns
 
     def __init__(self):
+        self.columns = self._generate_columns()
+
         super().__init__()
 
         self.view_changes_action = ViewChangeAction()
@@ -187,6 +207,14 @@ class AuditLogPack(ViewWindowPackMixin, PackValidationMixin, ObjectPack):
             menu.Item(self.title, self.list_window_action),
         )
 
+    @abstractmethod
+    def _make_name_filter(self, field, value):
+        """Создает lookup фильтра по фамилии/имени/отчеству пользователя.
+
+        :param str field: название поля ('firstname', 'surname', 'patronymic').
+        :param str value: значение, по которому фильтруется queryset.
+        """
+
 
 class ViewChangeAction(BaseAction):
     """Action для просмотра изменений."""
@@ -203,7 +231,7 @@ class ViewChangeAction(BaseAction):
         """Тело Action, вызывается при обработке запроса к серверу."""
         object_id = getattr(context, self.parent.id_param_name)
         if object_id:
-            rows = LogProxy.objects.get(id=object_id).diff
+            rows = self.parent.model.objects.get(id=object_id).diff
         else:
             rows = []
 

{educommon-3.13.2 → educommon-3.14.0}/src/educommon/audit_log/app_meta.py

@@ -1,9 +1,6 @@
 from educommon import (
     ioc,
 )
-from educommon.audit_log.actions import (
-    AuditLogPack,
-)
 from educommon.audit_log.error_log.actions import (
     PostgreSQLErrorPack,
 )
@@ -13,7 +10,6 @@ def register_actions():
     """Регистрация паков и экшенов."""
     ioc.get('main_controller').packs.extend(
         (
-            AuditLogPack(),
             PostgreSQLErrorPack(),
         )
     )

{educommon-3.13.2 → educommon-3.14.0}/src/educommon/audit_log/proxies.py

@@ -1,5 +1,10 @@
 import os
 
+from abc import (
+    ABCMeta,
+    abstractmethod,
+)
+
 from django.conf import (
     settings,
 )
@@ -36,8 +41,12 @@ from educommon.audit_log.models import (
 )
 
 
-class LogProxy(AuditLog):
-    """Прокси-модель для отображения."""
+class LogProxyMeta(type(AuditLog), ABCMeta):
+    """Метакласс для устранения конфликта при наследовании от AuditLog и использовании ABCMeta"""
+
+
+class LogProxy(AuditLog, metaclass=LogProxyMeta):
+    """Абстрактный класс прокси-модели для отображения."""
 
     class Meta:
         proxy = True
@@ -53,15 +62,22 @@ class LogProxy(AuditLog):
             except ContentType.DoesNotExist:
                 result = 'Model:{}, id:{}'.format(user_type_id, user_id)
             else:
-                try:
-                    result = model.objects.get(id=user_id).person.fullname
-                except model.DoesNotExist:
-                    result = f'{model._meta.verbose_name}({user_id})'
+                result = self.user_fullname or f'{model._meta.verbose_name}({user_id})'
         else:
             result = ''
 
         return result
 
+    @property
+    @abstractmethod
+    def user_fullname(self) -> str:
+        """Полное имя пользователя."""
+
+    @property
+    @abstractmethod
+    def user_organization(self) -> str:
+        """Название организации, к которой привязан пользователь."""
+
     @property
     def model_fullname(self):
         """Отображаемое и системное имя модели."""

{educommon-3.13.2 → educommon-3.14.0}/src/educommon/audit_log/ui.py

@@ -60,11 +60,5 @@ class ViewChangeWindow(BaseWindow):
         log_record = params['object']
         self.title = '{}: {}'.format(log_record.get_operation_display(), log_record.model_name)
         if log_record.user:
-            self.user_field.value = '{} / {}'.format(
-                log_record.user.person.fullname, log_record.user.person.user.username
-            )
-            unit = getattr(log_record.user, 'unit', None)
-            if unit:
-                self.unit_field.value = unit.short_name
-            else:
-                self.unit_field.value = ''
+            self.user_field.value = f'{log_record.user_fullname} / {log_record.user.username}'
+            self.unit_field.value = log_record.user_organization

{educommon-3.13.2 → educommon-3.14.0}/src/educommon/audit_log/utils/__init__.py

@@ -345,28 +345,6 @@ def make_hstore_filter(field, value):
     return result
 
 
-def make_name_filter(field, value):
-    """Создает lookup фильтра по фамилии/имени/отчеству пользователя.
-
-    :param str field: название поля ('firstname', 'surname', 'patronymic').
-    :param str value: значение, по которому фильтруется queryset.
-    """
-    ContentType = apps.get_model('contenttypes', 'ContentType')
-    Employee = apps.get_model('employee', 'Employee')
-    SysAdmin = apps.get_model('sysadmin', 'SysAdmin')
-
-    result = None
-    for model in (Employee, SysAdmin):
-        type_id = ContentType.objects.get_for_model(model).id
-        user_ids = list(model.objects.filter(**{f'person__{field}__icontains': value}).values_list('id', flat=True))
-        qobj = Q(user_id__in=user_ids, user_type_id=type_id)
-        if result:
-            result |= qobj
-        else:
-            result = qobj
-    return result
-
-
 class ModelRegistry:
     """Реестр моделей Django по имени таблицы.
 
@@ -447,7 +425,7 @@ def get_audit_log_context(request):
     result = {}
 
     current_user = ioc.get('get_current_user')(request)
-    if current_user:
+    if current_user and current_user.is_authenticated:
         ContentType = apps.get_model('contenttypes', 'ContentType')
 
         result['user_id'] = current_user.id

{educommon-3.13.2 → educommon-3.14.0}/src/educommon.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: educommon
-Version: 3.13.2
+Version: 3.14.0
 Summary: Общая кодовая база для проектов БЦ Образование
 Author-email: BARS Group <education_dev@bars-open.ru>
 Project-URL: Homepage, https://stash.bars-open.ru/projects/EDUBASE/repos/educommon/browse

{educommon-3.13.2 → educommon-3.14.0}/src/educommon.egg-info/SOURCES.txt

@@ -51,6 +51,7 @@ src/educommon/async_tasks/fixtures/initial_data.json
 src/educommon/async_tasks/migrations/0001_initial.py
 src/educommon/async_tasks/migrations/0002_load_initial_data.py
 src/educommon/async_tasks/migrations/__init__.py
+src/educommon/audit_log/README.rst
 src/educommon/audit_log/__init__.py
 src/educommon/audit_log/actions.py
 src/educommon/audit_log/app_meta.py