A community-supported supercharged document management system: scan, index and archive all your documents
Python aiangulararchivingdjangodmsdocument-managementdocument-management-systemllmmachine-learningocroptical-character-recognitionpdf
Fix: re-run ASN check after barcode detection (#11681)
shamoon00ef0837d2ba
diff --git a/src/documents/consumer.py b/src/documents/consumer.pyindex 76aa293d0..d9a149ed5 100644--- a/src/documents/consumer.py+++ b/src/documents/consumer.py@@ -5,6 +5,7 @@ import tempfilefrom enum import Enumfrom pathlib import Pathfrom typing import TYPE_CHECKING+from typing import Finalimport magicfrom django.conf import settings@@ -49,6 +50,8 @@ from documents.utils import copy_file_with_basic_statsfrom documents.utils import run_subprocessfrom paperless_mail.parsers import MailDocumentParser+LOGGING_NAME: Final[str] = "paperless.consumer"+class WorkflowTriggerPlugin(NoCleanupPluginMixin,@@ -156,7 +159,7 @@ class ConsumerPlugin(ConsumerPluginMixin,ConsumeTaskPlugin,):- logging_name = "paperless.consumer"+ logging_name = LOGGING_NAMEdef run_pre_consume_script(self) -> None:"""@@ -756,7 +759,7 @@ class ConsumerPreflightPlugin(ConsumeTaskPlugin,):NAME: str = "ConsumerPreflightPlugin"- logging_name = "paperless.consumer"+ logging_name = LOGGING_NAMEdef pre_check_file_exists(self) -> None:"""@@ -831,6 +834,32 @@ class ConsumerPreflightPlugin(settings.ORIGINALS_DIR.mkdir(parents=True, exist_ok=True)settings.ARCHIVE_DIR.mkdir(parents=True, exist_ok=True)+ def run(self) -> None:+ self._send_progress(+ 0,+ 100,+ ProgressStatusOptions.STARTED,+ ConsumerStatusShortMessage.NEW_FILE,+ )++ # Make sure that preconditions for consuming the file are met.++ self.pre_check_file_exists()+ self.pre_check_duplicate()+ self.pre_check_directories()+++class AsnCheckPlugin(+ NoCleanupPluginMixin,+ NoSetupPluginMixin,+ AlwaysRunPluginMixin,+ LoggingMixin,+ ConsumerPluginMixin,+ ConsumeTaskPlugin,+):+ NAME: str = "AsnCheckPlugin"+ logging_name = LOGGING_NAME+def pre_check_asn_value(self) -> None:"""Check that if override_asn is given, it is unique and within a valid range@@ -868,16 +897,4 @@ class ConsumerPreflightPlugin()def run(self) -> None:- self._send_progress(- 0,- 100,- ProgressStatusOptions.STARTED,- ConsumerStatusShortMessage.NEW_FILE,- )-- # Make sure that preconditions for consuming the file are met.-- self.pre_check_file_exists()- self.pre_check_duplicate()- self.pre_check_directories()self.pre_check_asn_value()diff --git a/src/documents/tasks.py b/src/documents/tasks.pyindex 91a266856..1e8b35891 100644--- a/src/documents/tasks.py+++ b/src/documents/tasks.py@@ -29,6 +29,7 @@ from documents.bulk_download import OriginalsOnlyStrategyfrom documents.caching import clear_document_cachesfrom documents.classifier import DocumentClassifierfrom documents.classifier import load_classifier+from documents.consumer import AsnCheckPluginfrom documents.consumer import ConsumerPluginfrom documents.consumer import ConsumerPreflightPluginfrom documents.consumer import WorkflowTriggerPlugin@@ -157,8 +158,10 @@ def consume_file(plugins: list[type[ConsumeTaskPlugin]] = [ConsumerPreflightPlugin,+ AsnCheckPlugin,CollatePlugin,BarcodePlugin,+ AsnCheckPlugin, # Re-run ASN check after barcode readingWorkflowTriggerPlugin,ConsumerPlugin,]diff --git a/src/documents/tests/test_barcodes.py b/src/documents/tests/test_barcodes.pyindex beb4e2a9a..d7dab5a2d 100644--- a/src/documents/tests/test_barcodes.py+++ b/src/documents/tests/test_barcodes.py@@ -11,6 +11,7 @@ from django.test import override_settingsfrom documents import tasksfrom documents.barcodes import BarcodePlugin+from documents.consumer import ConsumerErrorfrom documents.data_models import ConsumableDocumentfrom documents.data_models import DocumentMetadataOverridesfrom documents.data_models import DocumentSource@@ -93,6 +94,41 @@ class TestBarcode(self.assertDictEqual(separator_page_numbers, {1: False})+ @override_settings(CONSUMER_ENABLE_ASN_BARCODE=True)+ def test_asn_barcode_duplicate_in_trash_fails(self):+ """+ GIVEN:+ - A document with ASN barcode 123 is in the trash+ WHEN:+ - A file with the same barcode ASN is consumed+ THEN:+ - The ASN check is re-run and consumption fails+ """+ test_file = self.BARCODE_SAMPLE_DIR / "barcode-39-asn-123.pdf"++ first_doc = Document.objects.create(+ title="First ASN 123",+ content="",+ checksum="asn123first",+ mime_type="application/pdf",+ archive_serial_number=123,+ )++ first_doc.delete()++ dupe_asn = settings.SCRATCH_DIR / "barcode-39-asn-123-second.pdf"+ shutil.copy(test_file, dupe_asn)++ with mock.patch("documents.tasks.ProgressManager", DummyProgressManager):+ with self.assertRaisesRegex(ConsumerError, r"ASN 123.*trash"):+ tasks.consume_file(+ ConsumableDocument(+ source=DocumentSource.ConsumeFolder,+ original_file=dupe_asn,+ ),+ None,+ )+@override_settings(CONSUMER_BARCODE_TIFF_SUPPORT=True,)diff --git a/src/documents/tests/utils.py b/src/documents/tests/utils.pyindex dc89322c9..f099cd92e 100644--- a/src/documents/tests/utils.py+++ b/src/documents/tests/utils.py@@ -20,6 +20,7 @@ from django.db.migrations.executor import MigrationExecutorfrom django.test import TransactionTestCasefrom django.test import override_settings+from documents.consumer import AsnCheckPluginfrom documents.consumer import ConsumerPluginfrom documents.consumer import ConsumerPreflightPluginfrom documents.data_models import ConsumableDocument@@ -371,6 +372,14 @@ class GetConsumerMixin:"task-id",)preflight_plugin.setup()+ asncheck_plugin = AsnCheckPlugin(+ doc,+ overrides or DocumentMetadataOverrides(),+ self.status, # type: ignore+ self.dirs.scratch_dir,+ "task-id",+ )+ asncheck_plugin.setup()reader = ConsumerPlugin(doc,overrides or DocumentMetadataOverrides(),@@ -381,6 +390,7 @@ class GetConsumerMixin:reader.setup()try:preflight_plugin.run()+ asncheck_plugin.run()yield readerfinally:reader.cleanup()