From 527371dc36f4f3adc5d5e287e047c09769072913 Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Thu, 4 Apr 2024 07:46:07 -0700 Subject: [PATCH] Use old config var with default true --- docs/configuration.md | 6 +++--- src/documents/admin.py | 4 ++-- src/documents/management/commands/document_exporter.py | 4 ++-- src/documents/management/commands/document_importer.py | 4 ++-- src/documents/models.py | 4 ++-- src/documents/tasks.py | 4 ++-- src/documents/tests/test_management_exporter.py | 2 +- src/documents/views.py | 6 +++--- src/paperless/checks.py | 4 ++-- src/paperless/settings.py | 4 ++-- src/paperless/tests/test_checks.py | 4 ++-- src/setup.cfg | 4 ++-- 12 files changed, 25 insertions(+), 25 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index 725d7c522..1b5cc510d 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -1309,11 +1309,11 @@ assigns or creates tags if a properly formatted barcode is detected. ## Audit Trail -#### [`PAPERLESS_AUDIT_LOG_DISABLED=`](#PAPERLESS_AUDIT_LOG_DISABLED) {#PAPERLESS_AUDIT_LOG_DISABLED} +#### [`PAPERLESS_AUDIT_LOG_ENABLED=`](#PAPERLESS_AUDIT_LOG_ENABLED) {#PAPERLESS_AUDIT_LOG_ENABLED} -: Disables the audit trail for documents, document types, correspondents, and tags. +: Enables the audit trail for documents, document types, correspondents, and tags. - Defaults to false. + Defaults to true. ## Collate Double-Sided Documents {#collate} diff --git a/src/documents/admin.py b/src/documents/admin.py index 1eb9ba65b..5df235618 100644 --- a/src/documents/admin.py +++ b/src/documents/admin.py @@ -15,7 +15,7 @@ from documents.models import ShareLink from documents.models import StoragePath from documents.models import Tag -if not settings.AUDIT_LOG_DISABLED: +if settings.AUDIT_LOG_ENABLED: from auditlog.admin import LogEntryAdmin from auditlog.models import LogEntry @@ -197,7 +197,7 @@ admin.site.register(ShareLink, ShareLinksAdmin) admin.site.register(CustomField, CustomFieldsAdmin) admin.site.register(CustomFieldInstance, CustomFieldInstancesAdmin) -if not settings.AUDIT_LOG_DISABLED: +if settings.AUDIT_LOG_ENABLED: class LogEntryAUDIT(LogEntryAdmin): def has_delete_permission(self, request, obj=None): diff --git a/src/documents/management/commands/document_exporter.py b/src/documents/management/commands/document_exporter.py index b19a5d376..b02fd686b 100644 --- a/src/documents/management/commands/document_exporter.py +++ b/src/documents/management/commands/document_exporter.py @@ -10,7 +10,7 @@ from typing import Optional import tqdm from django.conf import settings -if not settings.AUDIT_LOG_DISABLED: +if settings.AUDIT_LOG_ENABLED: from auditlog.models import LogEntry from django.contrib.auth.models import Group from django.contrib.auth.models import Permission @@ -310,7 +310,7 @@ class Command(BaseCommand): serializers.serialize("json", ApplicationConfiguration.objects.all()), ) - if not settings.AUDIT_LOG_DISABLED: + if settings.AUDIT_LOG_ENABLED: manifest += json.loads( serializers.serialize("json", LogEntry.objects.all()), ) diff --git a/src/documents/management/commands/document_importer.py b/src/documents/management/commands/document_importer.py index 38755d73f..dc0ac36fd 100644 --- a/src/documents/management/commands/document_importer.py +++ b/src/documents/management/commands/document_importer.py @@ -36,7 +36,7 @@ from documents.signals.handlers import update_filename_and_move_files from documents.utils import copy_file_with_basic_stats from paperless import version -if not settings.AUDIT_LOG_DISABLED: +if settings.AUDIT_LOG_ENABLED: from auditlog.registry import auditlog @@ -160,7 +160,7 @@ class Command(BaseCommand): receiver=update_filename_and_move_files, sender=Document.tags.through, ): - if not settings.AUDIT_LOG_DISABLED: + if settings.AUDIT_LOG_ENABLED: auditlog.unregister(Document) auditlog.unregister(Correspondent) auditlog.unregister(Tag) diff --git a/src/documents/models.py b/src/documents/models.py index d46c11dd9..8e7a16a60 100644 --- a/src/documents/models.py +++ b/src/documents/models.py @@ -20,7 +20,7 @@ from django.utils import timezone from django.utils.translation import gettext_lazy as _ from multiselectfield import MultiSelectField -if not settings.AUDIT_LOG_DISABLED: +if settings.AUDIT_LOG_ENABLED: from auditlog.registry import auditlog from documents.data_models import DocumentSource @@ -881,7 +881,7 @@ class CustomFieldInstance(models.Model): raise NotImplementedError(self.field.data_type) -if not settings.AUDIT_LOG_DISABLED: +if settings.AUDIT_LOG_ENABLED: auditlog.register(Document, m2m_fields={"tags"}) auditlog.register(Correspondent) auditlog.register(Tag) diff --git a/src/documents/tasks.py b/src/documents/tasks.py index c011a4935..0ab55ac45 100644 --- a/src/documents/tasks.py +++ b/src/documents/tasks.py @@ -43,7 +43,7 @@ from documents.plugins.helpers import ProgressStatusOptions from documents.sanity_checker import SanityCheckFailedException from documents.signals import document_updated -if not settings.AUDIT_LOG_DISABLED: +if settings.AUDIT_LOG_ENABLED: import json from auditlog.models import LogEntry @@ -275,7 +275,7 @@ def update_document_archive_file(document_id): archive_filename=document.archive_filename, ) newDocument = Document.objects.get(pk=document.pk) - if not settings.AUDIT_LOG_DISABLED: + if settings.AUDIT_LOG_ENABLED: LogEntry.objects.log_create( instance=oldDocument, changes=json.dumps( diff --git a/src/documents/tests/test_management_exporter.py b/src/documents/tests/test_management_exporter.py index 8e2f1758c..b95d07dec 100644 --- a/src/documents/tests/test_management_exporter.py +++ b/src/documents/tests/test_management_exporter.py @@ -789,7 +789,7 @@ class TestExportImport(DirectoriesMixin, FileSystemAssertsMixin, TestCase): ) with override_settings( - AUDIT_LOG_DISABLED=True, + AUDIT_LOG_ENABLED=False, ): manifest = self._do_export(use_filename_format=True) for obj in manifest: diff --git a/src/documents/views.py b/src/documents/views.py index e700b39eb..3fcc54023 100644 --- a/src/documents/views.py +++ b/src/documents/views.py @@ -153,7 +153,7 @@ from paperless.config import GeneralConfig from paperless.db import GnuPG from paperless.views import StandardPagination -if not settings.AUDIT_LOG_DISABLED: +if settings.AUDIT_LOG_ENABLED: from auditlog.models import LogEntry logger = logging.getLogger("paperless.api") @@ -636,7 +636,7 @@ class DocumentViewSet( c.save() # If audit log is enabled make an entry in the log # about this note change - if not settings.AUDIT_LOG_DISABLED: + if settings.AUDIT_LOG_ENABLED: LogEntry.objects.log_create( instance=doc, changes=json.dumps( @@ -671,7 +671,7 @@ class DocumentViewSet( return HttpResponseForbidden("Insufficient permissions to delete notes") note = Note.objects.get(id=int(request.GET.get("id"))) - if not settings.AUDIT_LOG_DISABLED: + if settings.AUDIT_LOG_ENABLED: LogEntry.objects.log_create( instance=doc, changes=json.dumps( diff --git a/src/paperless/checks.py b/src/paperless/checks.py index 2909eae86..cbc8da5cf 100644 --- a/src/paperless/checks.py +++ b/src/paperless/checks.py @@ -204,10 +204,10 @@ def audit_log_check(app_configs, **kwargs): all_tables = db_conn.introspection.table_names() result = [] - if ("auditlog_logentry" in all_tables) and (settings.AUDIT_LOG_DISABLED): + if ("auditlog_logentry" in all_tables) and not settings.AUDIT_LOG_ENABLED: result.append( Warning( - ("auditlog table was found but AUDIT_LOG_DISABLED is active."), + ("auditlog table was found but audit log is disabled."), ), ) diff --git a/src/paperless/settings.py b/src/paperless/settings.py index 2e2472701..64af7c9b7 100644 --- a/src/paperless/settings.py +++ b/src/paperless/settings.py @@ -1045,8 +1045,8 @@ TIKA_GOTENBERG_ENDPOINT = os.getenv( if TIKA_ENABLED: INSTALLED_APPS.append("paperless_tika.apps.PaperlessTikaConfig") -AUDIT_LOG_DISABLED = __get_boolean("PAPERLESS_AUDIT_LOG_DISABLED", "NO") -if not AUDIT_LOG_DISABLED: +AUDIT_LOG_ENABLED = __get_boolean("PAPERLESS_AUDIT_LOG_ENABLED", "true") +if AUDIT_LOG_ENABLED: INSTALLED_APPS.append("auditlog") MIDDLEWARE.append("auditlog.middleware.AuditlogMiddleware") diff --git a/src/paperless/tests/test_checks.py b/src/paperless/tests/test_checks.py index 61a637322..d2ea9102b 100644 --- a/src/paperless/tests/test_checks.py +++ b/src/paperless/tests/test_checks.py @@ -247,7 +247,7 @@ class TestAuditLogChecks(TestCase): """ introspect_mock = mock.MagicMock() introspect_mock.introspection.table_names.return_value = ["auditlog_logentry"] - with override_settings(AUDIT_LOG_DISABLED=True): + with override_settings(AUDIT_LOG_ENABLED=False): with mock.patch.dict( "paperless.checks.connections", {"default": introspect_mock}, @@ -259,6 +259,6 @@ class TestAuditLogChecks(TestCase): msg = msgs[0] self.assertIn( - ("auditlog table was found but AUDIT_LOG_DISABLED is active."), + ("auditlog table was found but audit log is disabled."), msg.msg, ) diff --git a/src/setup.cfg b/src/setup.cfg index eda3daae2..1877cb16e 100644 --- a/src/setup.cfg +++ b/src/setup.cfg @@ -17,8 +17,8 @@ omit = [coverage:report] exclude_also = - if settings.AUDIT_LOG_DISABLED: - if AUDIT_LOG_DISABLED: + if settings.AUDIT_LOG_ENABLED: + if AUDIT_LOG_ENABLED: if TYPE_CHECKING: [mypy]