educommon 3.15.0__py3-none-any.whl → 3.17.0__py3-none-any.whl

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/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/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/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.dist-info → educommon-3.17.0.dist-info}/METADATA

@@ -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.dist-info → educommon-3.17.0.dist-info}/RECORD

@@ -40,9 +40,9 @@ educommon/async_tasks/fixtures/initial_data.json,sha256=d5EGMoCY8CVJL80C8ZaPwVVU
 educommon/async_tasks/migrations/0001_initial.py,sha256=ohWQK9rzMdM6kSWs7IPmlOA5amkWdaWZ7u3MBl1uWd0,5632
 educommon/async_tasks/migrations/0002_load_initial_data.py,sha256=MMLyXnEl9KFb1jYNfDfunwoLrTLyZfSqmcUQUhr2V-M,477
 educommon/async_tasks/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-educommon/audit_log/README.rst,sha256=qz0PxwnAMNnSYMemX_WQzttDA7068YzPc-jHMCSRxDY,2777
+educommon/audit_log/README.rst,sha256=eiYUkU6T7l_vFjGYsbYNjTmrs_YqZzEmPtfUjTezaII,4123
 educommon/audit_log/__init__.py,sha256=fNpKUKim4ybYWxSXjJ77G0YsvtFiZcWb0x6SDT3GxMo,2773
-educommon/audit_log/actions.py,sha256=vsfoohNC4MOqCmi_WxuIF9jQMgYSR5BUBFaJw3eESC8,7381
+educommon/audit_log/actions.py,sha256=kLdekdEkCyKAsV9IXKKuvXLmS2TgJBikrX34L-5hA-o,7243
 educommon/audit_log/app_meta.py,sha256=2xg9OKRhAFNmE_k10J5nTnFL8CVuI9iPbEBJha_UXsU,309
 educommon/audit_log/apps.py,sha256=A27iSAEWAVr7LmBmexVDrbWm3eQ-zFq1FYGQRClMJVM,6278
 educommon/audit_log/constants.py,sha256=8C1SCiwD1s_ED9C3Hh50LMAnToGvZmF21nrv18hRLEg,903
@@ -57,7 +57,7 @@ educommon/audit_log/error_log/__init__.py,sha256=lfAIm5GTGQ1-kRFxH1s0agSt2Oeguwj
 educommon/audit_log/error_log/actions.py,sha256=-KSy3RrBsbPWCML-gl5Hl5UGQdEsPZhoKrHq16LRmm8,2305
 educommon/audit_log/management/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 educommon/audit_log/management/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-educommon/audit_log/management/commands/reinstall_audit_log.py,sha256=o7deAmr2DXcqprjrnfs7pfHtqbyO8fUwYFlwqGwE5wM,3013
+educommon/audit_log/management/commands/reinstall_audit_log.py,sha256=HHpUeQwG_SuSsaxwZIq66piNhip_GHHQmAzpEzOFgaM,3573
 educommon/audit_log/migrations/0001_initial.py,sha256=HDhvBNyVSx_NlFmyA-t_ooFo_TiKf0UHNCZp1GOpLA8,6115
 educommon/audit_log/migrations/0002_install_audit_log.py,sha256=kAhtd1Xz8b6g33wmxBQyRBJIl-LGJdOc7yFy5yhoRJ8,2825
 educommon/audit_log/migrations/0003_logproxy.py,sha256=fx6nCoDtr3bZTtlwiOKP4QTVPxnnqyYDPMAT20Bv4n8,391
@@ -70,7 +70,7 @@ educommon/audit_log/migrations/0009_reinstall_audit_log.py,sha256=c95H2yamWyrCoG
 educommon/audit_log/migrations/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
 educommon/audit_log/sql/configure_audit_log.sql,sha256=M3QxNKTZbn-uNRxGDvNxE9iJh1EOQUTIho7rvc3yhlY,1511
 educommon/audit_log/sql/install_audit_log.sql,sha256=SHrZ7WaYxawUKQEpZnj9k4HTU25NvBlxX_POqZ95HU0,14107
-educommon/audit_log/utils/__init__.py,sha256=FSq-L4wNOrCTqve16c4KruIxTwHZuTh1lNLNgznAcv8,14843
+educommon/audit_log/utils/__init__.py,sha256=14BHRbKdnvHNgomM-R__GqLk1N32ww_GN2xy81Ph_gs,16388
 educommon/audit_log/utils/operations.py,sha256=skxL7wE4Jx1XlNdPx-Pl3SfiZ1G9jBmcZrXKSQDUGzw,2555
 educommon/auth/__init__.py,sha256=xkGJgqQ5QaEU86n6tJV77ux-2bMTAKbjpVYBCDhcS0E,79
 educommon/auth/rbac/__init__.py,sha256=guO7sOX6e1Z-dqptsqXjbnMdgbSdKp2suDKJa5_pdVU,317
@@ -349,7 +349,7 @@ educommon/ws_log/smev/exceptions.py,sha256=VNfzNHlj5Pz8D4979d_msTkxC-RQVoMctsgoJ
 educommon/ws_log/templates/report/smev_logs.xlsx,sha256=nnYgB0Z_ix8HoxsRICjsZfFRQBdra-5Gd8nWhCxTjYg,10439
 educommon/ws_log/templates/ui-js/smev-logs-list-window.js,sha256=AGup3D8GTJSY9WdDPj0zBJeYQBFOmGgcbxPOJbKK-nY,513
 educommon/ws_log/templates/ui-js/smev-logs-report-setting-window.js,sha256=nQ7QYK9frJcE7g7kIt6INg9TlEEJAPPayBJgRaoTePA,1103
-educommon-3.15.0.dist-info/METADATA,sha256=_8hCUYe-OqYdSUa0pDvbkIF4peIPvOZT4_SU0kXkFek,2380
-educommon-3.15.0.dist-info/WHEEL,sha256=1tXe9gY0PYatrMPMDd6jXqjfpz_B-Wqm32CPfRC58XU,91
-educommon-3.15.0.dist-info/top_level.txt,sha256=z5fbW7bz_0V1foUm_FGcZ9_MTpW3N1dBN7-kEmMowl4,10
-educommon-3.15.0.dist-info/RECORD,,
+educommon-3.17.0.dist-info/METADATA,sha256=XU8hoY7CgSTjP2GH8wgaRb1EHhjRQYyCdI69uYHmmk8,2380
+educommon-3.17.0.dist-info/WHEEL,sha256=1tXe9gY0PYatrMPMDd6jXqjfpz_B-Wqm32CPfRC58XU,91
+educommon-3.17.0.dist-info/top_level.txt,sha256=z5fbW7bz_0V1foUm_FGcZ9_MTpW3N1dBN7-kEmMowl4,10
+educommon-3.17.0.dist-info/RECORD,,