codex 1.6.19__py3-none-any.whl → 1.7.0__py3-none-any.whl

codex/librarian/janitor/integrity.py

@@ -0,0 +1,371 @@
+"""Database integrity checks and remedies."""
+# Uses app.get_model() because functions may also be called before the models are ready on startup.
+
+import re
+
+from django.apps import apps
+from django.db import DEFAULT_DB_ALIAS, connections
+from django.db.models.functions import Now
+from django.db.utils import OperationalError
+
+from codex.librarian.janitor.status import JanitorStatusTypes
+from codex.librarian.janitor.tasks import JanitorFTSRebuildTask
+from codex.logger.logging import get_logger
+from codex.settings.settings import (
+    CONFIG_PATH,
+    CUSTOM_COVERS_DIR,
+    DB_PATH,
+)
+from codex.status import Status
+from codex.worker_base import WorkerBaseMixin
+
+REPAIR_FLAG_PATH = CONFIG_PATH / "rebuild_db"
+REBUILT_DB_PATH = DB_PATH.parent / (DB_PATH.name + ".rebuilt")
+BACKUP_DB_PATH = DB_PATH.parent / (DB_PATH.name + ".bak")
+DUMP_LINE_MATCHER = re.compile("TRANSACTION|ROLLBACK|COMMIT")
+
+LOG = get_logger(__name__)
+
+_FTS_INSERT_TMPL = "INSERT INTO codex_comicfts (codex_comicfts) VALUES('%s');"
+_PRAGMA_TMPL = "PRAGMA %s;"
+
+
+def _exec_sql(sql):
+    """Run sql on an potentially unready database.."""
+    connection = connections[DEFAULT_DB_ALIAS]
+    connection.prepare_database()
+    with connection.cursor() as cursor:
+        cursor.execute("PRAGMA wal_checkpoint(TRUNCATE)")
+        cursor.execute(sql)
+        return cursor.fetchall()
+
+
+def _foreign_key_check(log):
+    """Get table and row ids from foreign_key_check."""
+    sql = _PRAGMA_TMPL % "foreign_key_check"
+    if results := _exec_sql(sql):
+        log.warning(f"Found {len(results)} database rows with illegal foreign keys.")
+        log.debug(results)
+    else:
+        log.info("Database passed foreign key check.")
+    return results
+
+
+def _compile_foreign_key_results(results, log):
+    bad_fk_rels = {}
+    bad_m2m_rows = {}
+
+    for row in results:
+        table_name, rowid, _parent, fkid = row
+        if fkid:
+            if table_name not in bad_fk_rels:
+                bad_fk_rels[table_name] = {}
+            if rowid not in bad_fk_rels[table_name]:
+                bad_fk_rels[table_name][rowid] = set()
+            bad_fk_rels[table_name][rowid].add(fkid)
+        else:
+            if table_name not in bad_m2m_rows:
+                bad_m2m_rows[table_name] = set()
+            bad_m2m_rows[table_name].add(rowid)
+
+    if bad_fk_rels:
+        log.debug(f"Found {len(bad_fk_rels)} tables with illegal foreign keys.")
+    if bad_m2m_rows:
+        log.debug(
+            f"Found {len(bad_m2m_rows)} many to many through tables with illegal relations."
+        )
+
+    return bad_fk_rels, bad_m2m_rows
+
+
+def _get_model(table_name):
+    """Get a django model from the table name."""
+    app_name, model_name = table_name.split("_", 1)
+    app_config = apps.get_app_config(app_name)
+    try:
+        from_rel_model_name, to_rel_model_name = model_name.split("_", 1)
+    except ValueError:
+        from_rel_model_name = to_rel_model_name = ""
+    if from_rel_model_name in ("comic", "library"):
+        # Use the from model to create an m2m through model because I don't know a simpler way.
+        from_model = app_config.get_model(from_rel_model_name)
+        field_name = to_rel_model_name.replace("_", "")
+        model = getattr(from_model, field_name).through
+    else:
+        # Not an m2m through model.
+        model_name = model_name.replace("_", "")
+        model = app_config.get_model(model_name)
+    return model
+
+
+def _null_bad_fk_rels_table(table_name, bad_rows, log):
+    """Null bad foreign key relations by table."""
+    fix_comic_pks = set()
+    model = _get_model(table_name)
+    fields = model._meta.fields
+    field_names = {}
+    update_objs = []
+    objs = model.objects.filter(pk__in=bad_rows.keys())
+    update_fields = {"updated_at"}
+    now = Now()
+    for obj in objs:
+        try:
+            fkids = bad_rows.get(obj.pk)
+            if not fkids:
+                continue
+            for fkid in fkids:
+                if fkid not in field_names:
+                    field_names[fkid] = fields[fkid].name
+                field_name = field_names[fkid]
+                setattr(obj, field_name, None)
+                update_fields.add(field_name)
+            obj.updated_at = now  # type: ignore
+            update_objs.append(obj)
+        except Exception as exc:
+            log.warning(
+                f"Unable to null bad foreign keys in {table_name}:{obj.pk} - {exc}"
+            )
+        if table_name == "comic":
+            fix_comic_pks.add(obj.pk)
+
+    if update_objs:
+        model.objects.bulk_update(update_objs, sorted(update_fields))
+        log.info(
+            f"Removed illegal foreign key relations from {len(update_objs)} {table_name}s"
+        )
+    return fix_comic_pks
+
+
+def _null_bad_fk_rels(bad_fk_rels, log):
+    """Null bad foreign key relations."""
+    fix_comic_pks = set()
+    for table_name, bad_rows in bad_fk_rels.items():
+        try:
+            fix_comic_pks |= _null_bad_fk_rels_table(table_name, bad_rows, log)
+        except Exception as exc:
+            pks = sorted(bad_rows.keys())
+            log.error(  # noqa: TRY400
+                f"Unable to null {len(pks)} {table_name} rows with bad foreign keys - {exc}"
+            )
+            log.error(f"{table_name}: {pks}")  # noqa: TRY400
+    return fix_comic_pks
+
+
+def _delete_bad_m2m_rows_table(table_name, ids, fix_comic_pks, log):
+    """Delete illegal foreign keys for one table."""
+    model = _get_model(table_name)
+
+    count = len(ids)
+    qs = model.objects.filter(id__in=ids)
+    try:
+        comic_ids = qs.values_list("comic_id", flat=True)
+        fix_comic_pks |= set(comic_ids)
+    except (OperationalError, AttributeError):
+        log.exception("Add comic ids to fix list.")
+
+    qs.delete()
+    log.info(f"Deleted {count} {table_name} rows that failed integrity check.")
+    return count
+
+
+def _delete_bad_m2m_rows(bad_m2m_rows, log):
+    """Delete illegal foreign keys for all tables."""
+    fix_comic_pks = set()
+    count = 0
+    for table_name, ids in bad_m2m_rows.items():
+        try:
+            count += _delete_bad_m2m_rows_table(table_name, ids, fix_comic_pks, log)
+        except Exception as exc:
+            log.error(  # noqa: TRY400
+                f"Could not delete bad foreign keys in table {table_name} - {exc}"
+            )
+    if count:
+        log.info(f"Removed {count} bad foreign key relations.")
+    return fix_comic_pks
+
+
+def _mark_comics_for_update(fix_comic_pks, log):
+    """Mark comics with altered foreign keys for update."""
+    if not fix_comic_pks:
+        return
+    comic_model = apps.get_model(app_label="codex", model_name="comic")
+    outdated_comics = comic_model.objects.filter(pk__in=fix_comic_pks).only(
+        "stat", "updated_at"
+    )
+    if not outdated_comics:
+        return
+
+    update_comics = []
+    now = Now()
+    for comic in outdated_comics:
+        stat_list = comic.stat  # type: ignore
+        if not stat_list:
+            continue
+        stat_list[8] = 0.0
+        comic.stat = stat_list  # type: ignore
+        comic.updated_at = now  # type: ignore
+        update_comics.append(comic)
+
+    if update_comics:
+        count = comic_model.objects.bulk_update(
+            update_comics, fields=["stat", "updated_at"]
+        )
+        log.info(f"Marked {count} comics with bad relations for update by poller.")
+
+
+def fix_foreign_keys(log=None):
+    """Foreign Key Check."""
+    if not log:
+        log = LOG
+    try:
+        results = _foreign_key_check(log)
+        bad_fk_rels, bad_m2m_rows = _compile_foreign_key_results(results, log)
+    except Exception:
+        log.exception("Integrity: foreign_key_check")
+        return
+    fix_comic_pks = _null_bad_fk_rels(bad_fk_rels, log)
+    fix_comic_pks |= _delete_bad_m2m_rows(bad_m2m_rows, log)
+    try:
+        _mark_comics_for_update(fix_comic_pks, log)
+    except Exception as exc:
+        LOG.warning(f"Could not mark comics with bad relations for update: {exc}")
+
+
+def _repair_extra_custom_cover_libraries(library_model, log):
+    """Attempt to remove the bad ones, probably futile."""
+    delete_libs = library_model.objects.filter(covers_only=True).exclude(
+        path=CUSTOM_COVERS_DIR
+    )
+    count = delete_libs.count()
+    if count:
+        delete_libs.delete()
+        log.warning(
+            f"Removed {count} duplicate custom cover libraries pointing to unused custom cover dirs."
+        )
+
+
+def cleanup_custom_cover_libraries(log=None):
+    """Cleanup extra custom cover libraries."""
+    if not log:
+        log = LOG
+    try:
+        try:
+            library_model = apps.get_model("codex", "library")
+        except LookupError:
+            log.debug("Library model doesn't exist yet.")
+            return
+        if not library_model or not hasattr(library_model, "covers_only"):
+            log.debug("Library model doesn't support custom cover library yet.")
+            return
+        _repair_extra_custom_cover_libraries(library_model, log)
+
+        custom_cover_libraries = library_model.objects.filter(covers_only=True)
+        count = custom_cover_libraries.count()
+        if count <= 1:
+            return
+        custom_cover_libraries.delete()
+        log.warning(
+            f"Removed all ({count}) custom cover libraries, Unable to determine valid one. Will recreate upon startup."
+        )
+    except Exception as exc:
+        log.warning(f"Failed to check custom cover library for integrity - {exc}")
+
+
+def _is_integrity_ok(results):
+    return (
+        results and len(results) == 1 and len(results[0]) == 1 and results[0][0] == "ok"
+    )
+
+
+def integrity_check(long=True, log=None):
+    """Run sqlite3 integrity check."""
+    if not log:
+        log = LOG
+    pragma = "integrity_check" if long else "quick_check"
+    sql = _PRAGMA_TMPL % pragma
+    log.debug(f"Running database '{sql}'...")
+    results = _exec_sql(sql)
+
+    if _is_integrity_ok(results):
+        length = "" if long else "quick "
+        log.info(f"Database passed {length}integrity check.")
+    else:
+        log.warning(f"Database '{sql}' returned results:")
+        log.warning(results)
+        log.warning(
+            "See the README for database rebuild instructions if the above warning looks severe."
+        )
+
+
+def fts_rebuild(log=None):
+    """FTS Rebuild."""
+    sql = _FTS_INSERT_TMPL % "rebuild"
+    if not log:
+        log = LOG
+    _exec_sql(sql)
+    log.info("Rebuilt FTS Virtual Table.")
+
+
+def fts_integrity_check(log=None):
+    """Run sqlite3 fts integrity check."""
+    if not log:
+        log = LOG
+    results = []
+    sql = _FTS_INSERT_TMPL % "integrity-check"
+    success = False
+    try:
+        results = _exec_sql(sql)
+        if results:
+            # I'm not sure if this raises or puts the error in the results.
+            raise ValueError(results)  # noqa: TRY301
+    except Exception as exc:
+        log.warning("Full Text Search Index failed integrity check.")
+        log.warning(exc)
+    else:
+        log.info("Full Text Search Index passed integrity check.")
+        success = True
+    return success
+
+
+class IntegrityMixin(WorkerBaseMixin):
+    """Integrity Check Mixin."""
+
+    def foreign_key_check(self):
+        """Foreign Key Check task."""
+        status = Status(JanitorStatusTypes.INTEGRITY_FK)
+        try:
+            self.status_controller.start(status)
+            fix_foreign_keys(self.log)
+
+        finally:
+            self.status_controller.finish(status)
+
+    def integrity_check(self, long=False):
+        """Integrity check task."""
+        subtitle = "" if long else "Quick"
+        status = Status(JanitorStatusTypes.INTEGRITY_CHECK, subtitle=subtitle)
+        try:
+            self.status_controller.start(status)
+            integrity_check(long, self.log)
+        finally:
+            self.status_controller.finish(status)
+
+    def fts_rebuild(self):
+        """FTS rebuild task."""
+        status = Status(JanitorStatusTypes.FTS_REBUILD)
+        try:
+            self.status_controller.start(status)
+            fts_rebuild(self.log)
+        finally:
+            self.status_controller.finish(status)
+
+    def fts_integrity_check(self):
+        """FTS integrity check task."""
+        status = Status(JanitorStatusTypes.FTS_INTEGRITY_CHECK)
+        try:
+            self.status_controller.start(status)
+            success = fts_integrity_check(self.log)
+            if not success:
+                self.librarian_queue.put(JanitorFTSRebuildTask())
+        finally:
+            self.status_controller.finish(status)

codex/librarian/janitor/janitor.py

@@ -8,18 +8,26 @@ from codex.librarian.importer.tasks import (
 )
 from codex.librarian.janitor.cleanup import TOTAL_NUM_FK_CLASSES, CleanupMixin
 from codex.librarian.janitor.failed_imports import UpdateFailedImportsMixin
+from codex.librarian.janitor.integrity import IntegrityMixin
 from codex.librarian.janitor.latest_version import LatestVersionMixin
 from codex.librarian.janitor.status import JanitorStatusTypes
 from codex.librarian.janitor.tasks import (
     ForceUpdateAllFailedImportsTask,
+    JanitorAdoptOrphanFoldersFinishedTask,
     JanitorBackupTask,
     JanitorCleanCoversTask,
     JanitorCleanFKsTask,
+    JanitorCleanupBookmarksTask,
     JanitorCleanupSessionsTask,
     JanitorClearStatusTask,
+    JanitorForeignKeyCheck,
+    JanitorFTSIntegrityCheck,
+    JanitorFTSRebuildTask,
+    JanitorIntegrityCheck,
     JanitorLatestVersionTask,
     JanitorNightlyTask,
     JanitorRestartTask,
+    JanitorSearchOptimizeFinishedTask,
     JanitorShutdownTask,
     JanitorUpdateTask,
     JanitorVacuumTask,
@@ -29,16 +37,20 @@ from codex.librarian.janitor.vacuum import VacuumMixin
 from codex.librarian.search.status import SearchIndexStatusTypes
 from codex.librarian.search.tasks import (
     SearchIndexAbortTask,
-    SearchIndexMergeTask,
+    SearchIndexOptimizeTask,
     SearchIndexUpdateTask,
 )
-from codex.models import AdminFlag, Timestamp
+from codex.models import Timestamp
 from codex.status import Status
 
 _JANITOR_STATII = (
+    Status(JanitorStatusTypes.CODEX_LATEST_VERSION),
+    Status(JanitorStatusTypes.INTEGRITY_FK),
+    Status(JanitorStatusTypes.INTEGRITY_CHECK),
     Status(JanitorStatusTypes.CLEANUP_FK, 0, TOTAL_NUM_FK_CLASSES),
     Status(JanitorStatusTypes.CLEANUP_COVERS),
     Status(JanitorStatusTypes.CLEANUP_SESSIONS),
+    Status(JanitorStatusTypes.CLEANUP_BOOKMARKS),
     Status(JanitorStatusTypes.DB_OPTIMIZE),
     Status(JanitorStatusTypes.DB_BACKUP),
     Status(JanitorStatusTypes.CODEX_UPDATE),
@@ -48,13 +60,17 @@ _JANITOR_STATII = (
     Status(ImportStatusTypes.DIRS_MOVED),
     Status(SearchIndexStatusTypes.SEARCH_INDEX_UPDATE),
     Status(SearchIndexStatusTypes.SEARCH_INDEX_REMOVE),
-    Status(SearchIndexStatusTypes.SEARCH_INDEX_MERGE),
-    Status(JanitorStatusTypes.CODEX_LATEST_VERSION),
+    Status(SearchIndexStatusTypes.SEARCH_INDEX_OPTIMIZE),
 )
 
 
 class Janitor(
-    CleanupMixin, LatestVersionMixin, UpdateMixin, UpdateFailedImportsMixin, VacuumMixin
+    CleanupMixin,
+    LatestVersionMixin,
+    UpdateMixin,
+    UpdateFailedImportsMixin,
+    VacuumMixin,
+    IntegrityMixin,
 ):
     """Janitor inline task runner."""
 
@@ -65,23 +81,20 @@ class Janitor(
     def queue_tasks(self):
         """Queue all the janitor tasks."""
         try:
-            optimize = AdminFlag.objects.get(
-                key=AdminFlag.FlagChoices.SEARCH_INDEX_OPTIMIZE.value
-            ).on
             self.status_controller.start_many(_JANITOR_STATII)
             tasks = (
-                JanitorLatestVersionTask(),
-                JanitorUpdateTask(force=False),
                 SearchIndexAbortTask(),
+                JanitorLatestVersionTask(),
+                JanitorUpdateTask(),
+                JanitorForeignKeyCheck(),
+                JanitorIntegrityCheck(),
+                JanitorFTSIntegrityCheck(),
                 JanitorCleanFKsTask(),
                 JanitorCleanCoversTask(),
                 JanitorCleanupSessionsTask(),
-                AdoptOrphanFoldersTask(),
-                JanitorVacuumTask(),
-                JanitorBackupTask(),
+                JanitorCleanupBookmarksTask(),
+                AdoptOrphanFoldersTask(janitor=True),
                 CoverRemoveOrphansTask(),
-                SearchIndexUpdateTask(False),
-                SearchIndexMergeTask(optimize),
             )
             for task in tasks:
                 self.librarian_queue.put(task)
@@ -111,12 +124,34 @@ class Janitor(
                     self.cleanup_custom_covers()
                 case JanitorCleanupSessionsTask():
                     self.cleanup_sessions()
+                case JanitorCleanupBookmarksTask():
+                    self.cleanup_orphan_bookmarks()
                 case JanitorClearStatusTask():
                     self.status_controller.finish_many([])
                 case ForceUpdateAllFailedImportsTask():
                     self.force_update_all_failed_imports()
+                case JanitorForeignKeyCheck():
+                    self.foreign_key_check()
+                case JanitorIntegrityCheck():
+                    self.integrity_check(task.long)
+                case JanitorFTSIntegrityCheck():
+                    self.fts_integrity_check()
+                case JanitorFTSRebuildTask():
+                    self.fts_rebuild()
                 case JanitorNightlyTask():
                     self.queue_tasks()
+                case JanitorAdoptOrphanFoldersFinishedTask():
+                    next_tasks = (
+                        SearchIndexAbortTask(),
+                        SearchIndexUpdateTask(),
+                        SearchIndexOptimizeTask(janitor=True),
+                    )
+                    for next_task in next_tasks:
+                        self.librarian_queue.put(next_task)
+                case JanitorSearchOptimizeFinishedTask():
+                    next_tasks = (JanitorVacuumTask(), JanitorBackupTask())
+                    for next_task in next_tasks:
+                        self.librarian_queue.put(next_task)
                 case _:
                     self.log.warning(f"Janitor received unknown task {task}")
         except Exception:

codex/librarian/janitor/latest_version.py

@@ -2,6 +2,7 @@
 
 import json
 from datetime import timedelta
+from time import time
 
 import requests
 from django.utils import timezone
@@ -51,4 +52,4 @@ class LatestVersionMixin(WorkerBaseMixin):
             else:
                 self.log.debug("Not fetching new latest version, not expired.")
         finally:
-            self.status_controller.finish(status)
+            self.status_controller.finish(status, until=time() + 2)

codex/librarian/janitor/status.py

@@ -15,3 +15,8 @@ class JanitorStatusTypes(Choices):
     DB_BACKUP = "JDB"
     CLEANUP_SESSIONS = "JSD"
     CLEANUP_COVERS = "JCD"
+    CLEANUP_BOOKMARKS = "JCB"
+    INTEGRITY_FK = "JIF"
+    INTEGRITY_CHECK = "JIC"
+    FTS_INTEGRITY_CHECK = "JFC"
+    FTS_REBUILD = "JFR"

codex/librarian/janitor/tasks.py

@@ -62,11 +62,48 @@ class JanitorCleanupSessionsTask(JanitorTask):
     """Cleanup Session table."""
 
 
+@dataclass
+class JanitorCleanupBookmarksTask(JanitorTask):
+    """Clean unused bookmarks."""
+
+
 @dataclass
 class ForceUpdateAllFailedImportsTask(JanitorTask):
     """Force update for failed imports in every library."""
 
 
+@dataclass
+class JanitorForeignKeyCheck(JanitorTask):
+    """Check and repair foreign keys integrity."""
+
+
+@dataclass
+class JanitorIntegrityCheck(JanitorTask):
+    """Check integrity and warn."""
+
+    long: bool = True
+
+
+@dataclass
+class JanitorFTSIntegrityCheck(JanitorTask):
+    """Check fts integrity."""
+
+
+@dataclass
+class JanitorFTSRebuildTask(JanitorTask):
+    """Rebuild fts table in place."""
+
+
 @dataclass
 class JanitorNightlyTask(JanitorTask):
     """Submit all janitor nightly tasks to the queue."""
+
+
+@dataclass
+class JanitorAdoptOrphanFoldersFinishedTask(JanitorTask):
+    """Signals to the Janitor that the Adopt Orphan Folders task is finished."""
+
+
+@dataclass
+class JanitorSearchOptimizeFinishedTask(JanitorTask):
+    """Signals to the Janitor that the Search Optimize task is finished."""

codex/librarian/janitor/update.py

@@ -32,7 +32,7 @@ class UpdateMixin(WorkerBaseMixin):
         else:
             result = versio_latest_version > installed_versio_version
             pre_blurb = ""
-        self.log.info(f"{latest_version=} > {VERSION=} = {result}{pre_blurb}")
+        self.log.debug(f"{latest_version=} > {VERSION=} = {result}{pre_blurb}")
         return result
 
     def update_codex(self, force=False):