better sanity checker that logs messages in the log files and does not fail on warnings.

src/documents/sanity_checker.py

@@ -1,4 +1,5 @@
 import hashlib
+import logging
 import os
 
 from django.conf import settings
@@ -7,40 +8,48 @@ from tqdm import tqdm
 from documents.models import Document
 
 
-class SanityMessage:
-    message = None
+class SanityCheckMessages:
+
+    def __init__(self):
+        self._messages = []
+
+    def error(self, message):
+        self._messages.append({"level": logging.ERROR, "message": message})
+
+    def warning(self, message):
+        self._messages.append({"level": logging.WARNING, "message": message})
+
+    def info(self, message):
+        self._messages.append({"level": logging.INFO, "message": message})
+
+    def log_messages(self):
+        logger = logging.getLogger("paperless.sanity_checker")
+
+        if len(self._messages) == 0:
+            logger.info("Sanity checker detected no issues.")
+        else:
+            for msg in self._messages:
+                logger.log(msg['level'], msg['message'])
+
+    def __len__(self):
+        return len(self._messages)
+
+    def __getitem__(self, item):
+        return self._messages[item]
+
+    def has_error(self):
+        return any([msg['level'] == logging.ERROR for msg in self._messages])
+
+    def has_warning(self):
+        return any([msg['level'] == logging.WARNING for msg in self._messages])
 
 
-class SanityWarning(SanityMessage):
-    def __init__(self, message):
-        self.message = message
-
-    def __str__(self):
-        return f"Warning: {self.message}"
-
-
-class SanityError(SanityMessage):
-    def __init__(self, message):
-        self.message = message
-
-    def __str__(self):
-        return f"ERROR: {self.message}"
-
-
-class SanityFailedError(Exception):
-
-    def __init__(self, messages):
-        self.messages = messages
-
-    def __str__(self):
-        message_string = "\n".join([str(m) for m in self.messages])
-        return (
-            f"The following issuse were found by the sanity checker:\n"
-            f"{message_string}\n\n===============\n\n")
+class SanityCheckFailedException(Exception):
+    pass
 
 
 def check_sanity(progress=False):
-    messages = []
+    messages = SanityCheckMessages()
 
     present_files = []
     for root, subdirs, files in os.walk(settings.MEDIA_ROOT):
@@ -59,8 +68,7 @@ def check_sanity(progress=False):
     for doc in docs:
         # Check sanity of the thumbnail
         if not os.path.isfile(doc.thumbnail_path):
-            messages.append(SanityError(
-                f"Thumbnail of document {doc.pk} does not exist."))
+            messages.error(f"Thumbnail of document {doc.pk} does not exist.")
         else:
             if os.path.normpath(doc.thumbnail_path) in present_files:
                 present_files.remove(os.path.normpath(doc.thumbnail_path))
@@ -68,15 +76,14 @@ def check_sanity(progress=False):
                 with doc.thumbnail_file as f:
                     f.read()
             except OSError as e:
-                messages.append(SanityError(
+                messages.error(
                     f"Cannot read thumbnail file of document {doc.pk}: {e}"
-                ))
+                )
 
         # Check sanity of the original file
         # TODO: extract method
         if not os.path.isfile(doc.source_path):
-            messages.append(SanityError(
-                f"Original of document {doc.pk} does not exist."))
+            messages.error(f"Original of document {doc.pk} does not exist.")
         else:
             if os.path.normpath(doc.source_path) in present_files:
                 present_files.remove(os.path.normpath(doc.source_path))
@@ -84,31 +91,31 @@ def check_sanity(progress=False):
                 with doc.source_file as f:
                     checksum = hashlib.md5(f.read()).hexdigest()
             except OSError as e:
-                messages.append(SanityError(
-                    f"Cannot read original file of document {doc.pk}: {e}"))
+                messages.error(
+                    f"Cannot read original file of document {doc.pk}: {e}")
             else:
                 if not checksum == doc.checksum:
-                    messages.append(SanityError(
+                    messages.error(
                         f"Checksum mismatch of document {doc.pk}. "
                         f"Stored: {doc.checksum}, actual: {checksum}."
-                    ))
+                    )
 
         # Check sanity of the archive file.
         if doc.archive_checksum and not doc.archive_filename:
-            messages.append(SanityError(
+            messages.error(
                 f"Document {doc.pk} has an archive file checksum, but no "
                 f"archive filename."
-            ))
+            )
         elif not doc.archive_checksum and doc.archive_filename:
-            messages.append(SanityError(
+            messages.error(
                 f"Document {doc.pk} has an archive file, but its checksum is "
                 f"missing."
-            ))
+            )
         elif doc.has_archive_version:
             if not os.path.isfile(doc.archive_path):
-                messages.append(SanityError(
+                messages.error(
                     f"Archived version of document {doc.pk} does not exist."
-                ))
+                )
             else:
                 if os.path.normpath(doc.archive_path) in present_files:
                     present_files.remove(os.path.normpath(doc.archive_path))
@@ -116,26 +123,23 @@ def check_sanity(progress=False):
                     with doc.archive_file as f:
                         checksum = hashlib.md5(f.read()).hexdigest()
                 except OSError as e:
-                    messages.append(SanityError(
+                    messages.error(
                         f"Cannot read archive file of document {doc.pk}: {e}"
-                    ))
+                    )
                 else:
                     if not checksum == doc.archive_checksum:
-                        messages.append(SanityError(
+                        messages.error(
                             f"Checksum mismatch of archived document "
                             f"{doc.pk}. "
-                            f"Stored: {doc.checksum}, actual: {checksum}."
-                        ))
+                            f"Stored: {doc.archive_checksum}, "
+                            f"actual: {checksum}."
+                        )
 
         # other document checks
         if not doc.content:
-            messages.append(SanityWarning(
-                f"Document {doc.pk} has no content."
-            ))
+            messages.info(f"Document {doc.pk} has no content.")
 
     for extra_file in present_files:
-        messages.append(SanityWarning(
-            f"Orphaned file in media dir: {extra_file}"
-        ))
+        messages.warning(f"Orphaned file in media dir: {extra_file}")
 
     return messages