educommon 3.15.0__tar.gz → 3.17.0__tar.gz

{educommon-3.15.0 → educommon-3.17.0}/CHANGELOG.md

@@ -28,6 +28,34 @@
 ### Удалено
 
 
+# [3.17.0] - 2025-05-28
+
+Добавлена проверка конфликтующих таблиц которые должны логироваться, но находятся в сервисных приложениях.
+
+### Добавлено
+
+- [EDUSCHL-23590](https://jira.bars.group/browse/EDUSCHL-23590)
+  MINOR Добавлена функция get_table_names_for_app_labels для получения множества с именами таблиц для указанных приложений.
+  Добавлена проверка конфликтующих таблиц которые должны логироваться, но находятся в сервисных приложениях.
+
+
+# [3.16.0] - 2025-05-15
+
+Добавлена настройка передачи дополнительных SQL файлов для выполнения в МК reinstall_audit_log.
+
+### Добавлено
+
+- [EDUSCHL-23389](https://jira.bars.group/browse/EDUSCHL-23389)
+  MINOR Добавлена настройка AUDIT_LOG_EXTENSION_SCRIPTS для хранения путей к дополнительным SQL файлам,
+  которые будут выполнены в МК reinstall_audit_log.
+  Явное указание настройки в продукте не обязательно. Пример заполнения указан в audit_log/README.rst.
+
+### Удалено
+
+- [EDUSCHL-23389](https://jira.bars.group/browse/EDUSCHL-23389)
+  MINOR Удален столбец имитации в AuditLogPack
+
+
 ## [3.15.0] - 2025-04-29
 
 Добавлен фильтр, позволяющий работать с датой в формате d.m.Y, m.Y, Y.

{educommon-3.15.0 → educommon-3.17.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: educommon
-Version: 3.15.0
+Version: 3.17.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.15.0 → educommon-3.17.0}/src/educommon/audit_log/README.rst

@@ -62,3 +62,32 @@
 в request уже был определен пользователь.
 
 4. Создать и выполнить миграции.
+
+Расширение
+--------------
+
+Для реализации локальных расширений логирования продукта на уровне БД реализовано применение настройки
+AUDIT_LOG_EXTENSION_SCRIPTS при выполнении МК reinstall_audit_log.
+
+Настройка может содержать пути до SQL-скриптов, которые будут выполняться помимо основного скрипта install_audit_log.sql.
+
+Примером заполнения настройки может послужить установка через AppConfig приложения,
+в котором хранится необходимый SQL файл.
+
+Например:
+.. code-block:: python
+
+    class PluginAppConfig(AppConfig):
+        """Конфигурация плагина."""
+
+        name = 'project.plugins.plugin'
+        label = 'plugin'
+
+        def ready(self):
+            """Добавляет SQL скрипт в процесс установки audit_log."""
+            sql_files_dir = os.path.abspath(
+                os.path.join(os.path.dirname(__file__), 'sql')
+            )
+
+            sql_file_path = os.path.join(sql_files_dir, 'audit_log_extension.sql')
+            settings.AUDIT_LOG_EXTENSION_SCRIPTS += (sql_file_path,)

{educommon-3.15.0 → educommon-3.17.0}/src/educommon/audit_log/actions.py

@@ -148,11 +148,6 @@ class AuditLogPack(ViewWindowPackMixin, PackValidationMixin, ObjectPack, metacla
                     control_creator=ExtStringField,
                 ),
             },
-            {
-                'data_index': '',
-                'width': 40,
-                'header': 'Имитация',
-            },
         ]
 
         return columns

{educommon-3.15.0 → educommon-3.17.0}/src/educommon/audit_log/management/commands/reinstall_audit_log.py

@@ -1,6 +1,9 @@
 import codecs
 import os
 
+from django.conf import (
+    settings,
+)
 from django.core.management.base import (
     BaseCommand,
 )
@@ -31,19 +34,19 @@ class Command(BaseCommand):
     Удаляет схему audit. В этой схеме не должно храниться никаких таблиц
     с данными.
     После удаления устанавливает audit_log заново.
+    Через настройки проекта возможна передача дополнительных sql файлов
+    для выполнения вместе с основным скриптом установки.
     """
 
     help = 'Команда для переустановки audit_log.'
 
-    def add_arguments(self, parser):
+    def add_arguments(self, parser) -> None:
         """Добавление аргументов команды."""
-        (
-            parser.add_argument(
-                '--clear_audit_logs',
-                action='store_true',
-                default=False,
-                help='Удалить записи из audit_log для неотслеживаемых таблиц',
-            ),
+        parser.add_argument(
+            '--clear_audit_logs',
+            action='store_true',
+            default=False,
+            help='Удалить записи из audit_log для неотслеживаемых таблиц',
         )
         parser.add_argument(
             '--chunk_size',
@@ -52,33 +55,42 @@ class Command(BaseCommand):
             help='Кол-во единовременно удаляемых записей',
         )
 
-    def _read_sql(self, filename):
+    def _read_sql(self, sql_file_path: str) -> str:
         """Чтение SQL-кода из файла."""
-        sql_file_path = os.path.join(SQL_FILES_DIR, filename)
-
         with codecs.open(sql_file_path, 'r', 'utf-8') as sql_file:
             sql = sql_file.read()
 
-        self.stdout.write('reading SQL-code..\n')
+        file_name = os.path.basename(sql_file_path)
+        self.stdout.write(f'reading {file_name}..\n')
 
         return sql
 
-    def _prepare_sql(self):
+    def _prepare_sql(self) -> list[str]:
         """Подготовка SQL-кода."""
         params = get_db_connection_params()
         params['lock_id'] = PG_LOCK_ID
 
         self.stdout.write('preparing SQL-code..\n')
 
-        return self._read_sql(INSTALL_AUDIT_LOG_SQL_FILE_NAME).format(**params)
+        sql_files = [
+            os.path.join(SQL_FILES_DIR, INSTALL_AUDIT_LOG_SQL_FILE_NAME),
+            *getattr(settings, 'AUDIT_LOG_EXTENSION_SCRIPTS', [])
+        ]
+
+        sql_scripts = []
+        for sql_file_path in sql_files:
+            sql_scripts.append(self._read_sql(sql_file_path).format(**params))
+
+        return sql_scripts
 
-    def handle(self, *args, **options):
+    def handle(self, *args, **options) -> None:
         """Формирование SQL-кода и его исполнение."""
         self.stdout.write('start reinstalling audit_log..\n')
 
         cursor = connection.cursor()
 
-        cursor.execute(self._prepare_sql())
+        for sql in self._prepare_sql():
+            cursor.execute(sql)
 
         configure(force_update_triggers=True)
 

{educommon-3.15.0 → educommon-3.17.0}/src/educommon/audit_log/utils/__init__.py

@@ -40,6 +40,7 @@ from django.db.transaction import (
 from django.http import (
     HttpRequest,
 )
+
 from m3_django_compat import (
     get_related,
 )
@@ -52,6 +53,9 @@ from educommon.audit_log.constants import (
     PG_LOCK_ID,
     SQL_FILES_DIR,
 )
+from educommon.logger import (
+    error as logger_error,
+)
 from educommon.utils.misc import (
     cached_property,
 )
@@ -99,6 +103,19 @@ def get_need_to_log_table_names() -> Set[str]:
     return table_names
 
 
+def get_table_names_for_app_labels(app_labels: Iterable[str]) -> Set[str]:
+    """Возвращает множество с именами таблиц для указанных приложений."""
+    tables = set()
+    for app_label in app_labels:
+        try:
+            app_config = apps.get_app_config(app_label)
+            tables.update(model._meta.db_table for model in app_config.get_models())
+        except LookupError:
+            continue
+
+    return tables
+
+
 def update_or_create_tables(need_to_log_table_names: Iterable[str]) -> bool:
     """Создаёт записи Table для отслеживаемых таблиц, либо меняет флаг logged.
 
@@ -109,6 +126,21 @@ def update_or_create_tables(need_to_log_table_names: Iterable[str]) -> bool:
     need_to_log_table_names = set(need_to_log_table_names)
     existed_table_names = set(Table.objects.filter(schema='public').values_list('name', flat=True))
 
+    # Таблицы сервисных приложений, которые не должны отслеживаться аудит-логом
+    allowed_service_apps_labels = getattr(settings, 'ALLOWED_SERVICE_APPS_LABELS', [])
+    service_table_names = get_table_names_for_app_labels(allowed_service_apps_labels)
+
+    # Проверка конфликтных таблиц: должны логироваться, но находятся в сервисных приложениях
+    conflicting_tables = need_to_log_table_names & service_table_names
+    if conflicting_tables:
+        tables = ', '.join(sorted(conflicting_tables))
+        error_msg = (
+            f'Невозможно включить логирование для сервисных таблиц: {tables}. '
+            'Исключите их из отслеживания или перенесите таблицы в основную БД.'
+        )
+        logger_error(error_msg)
+        raise ValueError(error_msg)
+
     to_create_table_names = need_to_log_table_names - existed_table_names
     to_disable_table_names = existed_table_names - need_to_log_table_names
 

{educommon-3.15.0 → educommon-3.17.0}/src/educommon.egg-info/PKG-INFO

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