From 3732666bcf48800e32b222a12064c07256123026 Mon Sep 17 00:00:00 2001 From: Aaron Katz Date: Tue, 24 Oct 2023 17:27:07 +0200 Subject: [PATCH] Changed setting name to AUDIT_LOG_ENABLED --- docs/configuration.md | 2 +- src/documents/admin.py | 4 ++-- src/documents/models.py | 4 ++-- src/documents/views.py | 6 +++--- src/paperless/settings.py | 8 ++++---- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index a80700a4c..6040fa858 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -1138,7 +1138,7 @@ combination with PAPERLESS_CONSUMER_BARCODE_UPSCALE bigger than 1.0. ## Audit Trail -#### [`PAPERLESS_AUDIT_ENABLED=`](#PAPERLESS_AUDIT_ENABLED){#PAPERLESS_AUDIT_ENABLED} +#### [`PAPERLESS_AUDIT_LOG_ENABLED=`](#PAPERLESS_AUDIT_LOG_ENABLED){#PAPERLESS_AUDIT_LOG_ENABLED} : Enables an audit trail for each document,document type, correspondent, and tag. This records all changes made to the documents to make the changes traceable. diff --git a/src/documents/admin.py b/src/documents/admin.py index 16f707306..97871e4f8 100644 --- a/src/documents/admin.py +++ b/src/documents/admin.py @@ -13,7 +13,7 @@ from documents.models import ShareLink from documents.models import StoragePath from documents.models import Tag -if settings.AUDIT_ENABLED: +if settings.AUDIT_LOG_ENABLED: from auditlog.admin import LogEntryAdmin from auditlog.models import LogEntry @@ -154,7 +154,7 @@ admin.site.register(PaperlessTask, TaskAdmin) admin.site.register(Note, NotesAdmin) admin.site.register(ShareLink, ShareLinksAdmin) -if settings.AUDIT_ENABLED: +if settings.AUDIT_LOG_ENABLED: class LogEntryAUDIT(LogEntryAdmin): def has_delete_permission(self, request, obj=None): diff --git a/src/documents/models.py b/src/documents/models.py index 89bea1fb3..b0d347f20 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 settings.AUDIT_ENABLED: +if settings.AUDIT_LOG_ENABLED: from auditlog.registry import auditlog from documents.data_models import DocumentSource @@ -877,7 +877,7 @@ class ConsumptionTemplate(models.Model): return f"{self.name}" -if settings.AUDIT_ENABLED: +if settings.AUDIT_LOG_ENABLED: auditlog.register(Document, m2m_fields={"tags"}) auditlog.register(Correspondent) auditlog.register(Tag) diff --git a/src/documents/views.py b/src/documents/views.py index 5667c17e6..f921a67bc 100644 --- a/src/documents/views.py +++ b/src/documents/views.py @@ -115,7 +115,7 @@ from paperless import version from paperless.db import GnuPG from paperless.views import StandardPagination -if settings.AUDIT_ENABLED: +if settings.AUDIT_LOG_ENABLED: from auditlog.models import LogEntry logger = logging.getLogger("paperless.api") @@ -526,7 +526,7 @@ class DocumentViewSet( c.save() # If audit log is enabled make an entry in the log # about this note change - if settings.AUDIT_ENABLED: + if settings.AUDIT_LOG_ENABLED: timezone.now() LogEntry.objects.log_create( instance=doc, @@ -562,7 +562,7 @@ class DocumentViewSet( return HttpResponseForbidden("Insufficient permissions to delete") note = Note.objects.get(id=int(request.GET.get("id"))) - if settings.AUDIT_ENABLED: + if settings.AUDIT_LOG_ENABLED: timezone.now() LogEntry.objects.log_create( instance=doc, diff --git a/src/paperless/settings.py b/src/paperless/settings.py index ee2d7c74b..6e75278c2 100644 --- a/src/paperless/settings.py +++ b/src/paperless/settings.py @@ -936,17 +936,17 @@ TIKA_GOTENBERG_ENDPOINT = os.getenv( if TIKA_ENABLED: INSTALLED_APPS.append("paperless_tika.apps.PaperlessTikaConfig") -AUDIT_ENABLED = __get_boolean("PAPERLESS_AUDIT_ENABLED", "NO") -if AUDIT_ENABLED: +AUDIT_LOG_ENABLED = __get_boolean("PAPERLESS_AUDIT_LOG_ENABLED", "NO") +if AUDIT_LOG_ENABLED: INSTALLED_APPS.append("auditlog") MIDDLEWARE.append("auditlog.middleware.AuditlogMiddleware") db_conn = connections["default"] all_tables = db_conn.introspection.table_names() -if ("auditlog_logentry" in all_tables) and not (AUDIT_ENABLED): +if ("auditlog_logentry" in all_tables) and not (AUDIT_LOG_ENABLED): raise ImproperlyConfigured( - "auditlog table was found but PAPERLESS_AUDIT_ENABLED is not active.", + "auditlog table was found but PAPERLESS_AUDIT_LOG_ENABLED is not active.", )