codex 1.6.0a6__py3-none-any.whl → 1.6.0a8__py3-none-any.whl

codex/librarian/janitor/janitor.py

@@ -2,6 +2,11 @@
 
 from codex.librarian.covers.status import CoverStatusTypes
 from codex.librarian.covers.tasks import CoverRemoveOrphansTask
+from codex.librarian.importer.status import ImportStatusTypes
+from codex.librarian.importer.tasks import (
+    AdoptOrphanFoldersTask,
+    UpdateGroupsFirstComic,
+)
 from codex.librarian.janitor.cleanup import TOTAL_NUM_FK_CLASSES, CleanupMixin
 from codex.librarian.janitor.failed_imports import UpdateFailedImportsMixin
 from codex.librarian.janitor.status import JanitorStatusTypes
@@ -36,8 +41,11 @@ _JANITOR_STATII = (
     Status(JanitorStatusTypes.DB_OPTIMIZE),
     Status(JanitorStatusTypes.DB_BACKUP),
     Status(JanitorStatusTypes.CODEX_UPDATE),
+    Status(ImportStatusTypes.GROUP_UPDATE),
     Status(CoverStatusTypes.FIND_ORPHAN),
     Status(CoverStatusTypes.PURGE_COVERS),
+    Status(ImportStatusTypes.ADOPT_FOLDERS),
+    Status(ImportStatusTypes.DIRS_MOVED),
     Status(SearchIndexStatusTypes.SEARCH_INDEX_UPDATE),
     Status(SearchIndexStatusTypes.SEARCH_INDEX_REMOVE),
     Status(SearchIndexStatusTypes.SEARCH_INDEX_MERGE),
@@ -66,6 +74,8 @@ class Janitor(CleanupMixin, UpdateMixin, VacuumMixin, UpdateFailedImportsMixin):
                 JanitorVacuumTask(),
                 JanitorBackupTask(),
                 JanitorUpdateTask(force=False),
+                AdoptOrphanFoldersTask(),
+                UpdateGroupsFirstComic(),
                 CoverRemoveOrphansTask(),
                 SearchIndexUpdateTask(False),
                 SearchIndexMergeTask(optimize),
@@ -76,7 +86,7 @@ class Janitor(CleanupMixin, UpdateMixin, VacuumMixin, UpdateFailedImportsMixin):
         except Exception:
             self.log.exception(f"In {self.__class__.__name__}")
 
-    def run(self, task):
+    def run(self, task):  # noqa: PLR0912,C901
         """Run Janitor tasks as the librarian process directly."""
         try:
             match task:

codex/librarian/librariand.py

@@ -11,7 +11,11 @@ from codex.librarian.covers.coverd import CoverThread
 from codex.librarian.covers.tasks import CoverTask
 from codex.librarian.delayed_taskd import DelayedTasksThread
 from codex.librarian.importer.importerd import ComicImporterThread
-from codex.librarian.importer.tasks import AdoptOrphanFoldersTask, ImportTask
+from codex.librarian.importer.tasks import (
+    AdoptOrphanFoldersTask,
+    ImportTask,
+    UpdateGroupsFirstComic,
+)
 from codex.librarian.janitor.janitor import Janitor
 from codex.librarian.janitor.janitord import JanitorThread
 from codex.librarian.janitor.tasks import JanitorTask
@@ -70,14 +74,16 @@ class LibrarianDaemon(Process, LoggerBaseMixin):
         self.broadcast_queue = broadcast_queue
         startup_tasks = (
             AdoptOrphanFoldersTask(),
+            UpdateGroupsFirstComic(),
             WatchdogSyncTask(),
             SearchIndexRebuildIfDBChangedTask(),
         )
+
         for task in startup_tasks:
             self.queue.put(task)
         self.search_indexer_abort_event = Manager().Event()
 
-    def _process_task(self, task):
+    def _process_task(self, task):  # noqa: PLR0912,C901
         """Process an individual task popped off the queue."""
         match task:
             case CoverTask():

codex/migrations/0027_import_order_and_covers.py

@@ -0,0 +1,345 @@
+"""Generated by Django 5.0.6 on 2024-06-06 02:22."""
+
+import os
+from contextlib import suppress
+from pathlib import Path
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+from codex.models.util import get_sort_name
+
+CONFIG_PATH = Path(os.environ.get("CODEX_CONFIG_DIR", Path.cwd() / "config"))
+COVER_ROOT = CONFIG_PATH / "cache" / "covers"
+_GROUP_MODEL_NAMES = (
+    "publisher",
+    "imprint",
+    "series",
+    "storyarc",
+    "folder",
+    "comic",
+)
+
+
+def _set_sort_name(obj):
+    """Create sort_name for model."""
+    obj.sort_name = get_sort_name(obj.name)
+
+
+def _generate_sort_name(apps, _schema_editor):
+    """Update new sort_name field."""
+    for model_name in _GROUP_MODEL_NAMES:
+        model = apps.get_model("codex", model_name)
+        update_fields = ("sort_name",)
+        only_fields = ("name", *update_fields)
+        update_groups = []
+        objs = model.objects.only(*only_fields)
+        for obj in objs:
+            _set_sort_name(obj)
+            update_groups.append(obj)
+        if update_groups:
+            model.objects.bulk_update(update_groups, update_fields)
+            print(f"\tUpdated sort_name for {len(update_groups)} {model_name}s")
+
+
+def _remove_cover_symlinks(_apps, _schema_editor):
+    """Remove old missing cover symlinks."""
+    # Handled programmatically now.
+    count = 0
+    for dirpath_str, _, filenames in os.walk(COVER_ROOT):
+        dirpath = Path(dirpath_str)
+        for filename in filenames:
+            full_path = dirpath / filename
+            if full_path.is_symlink():
+                with suppress(OSError):
+                    full_path.unlink(missing_ok=True)
+                    count += 1
+    if count:
+        print(f"Removed {count} missing-cover symlinks from cover cache.")
+
+
+class Migration(migrations.Migration):
+    """Migrate db."""
+
+    dependencies = [
+        ("codex", "0026_comicbox_1"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="comic",
+            name="sort_name",
+            field=models.CharField(db_index=True, default="", max_length=128),
+        ),
+        migrations.AddField(
+            model_name="folder",
+            name="first_comic",
+            field=models.ForeignKey(
+                default=None,
+                null=True,
+                on_delete=django.db.models.deletion.SET_DEFAULT,
+                related_name="+",
+                to="codex.comic",
+            ),
+        ),
+        migrations.AddField(
+            model_name="folder",
+            name="sort_name",
+            field=models.CharField(db_index=True, default="", max_length=128),
+        ),
+        migrations.AddField(
+            model_name="imprint",
+            name="first_comic",
+            field=models.ForeignKey(
+                default=None,
+                null=True,
+                on_delete=django.db.models.deletion.SET_DEFAULT,
+                related_name="+",
+                to="codex.comic",
+            ),
+        ),
+        migrations.AddField(
+            model_name="imprint",
+            name="sort_name",
+            field=models.CharField(db_index=True, default="", max_length=128),
+        ),
+        migrations.AddField(
+            model_name="library",
+            name="covers_only",
+            field=models.BooleanField(db_index=True, default=False),
+        ),
+        migrations.AddField(
+            model_name="publisher",
+            name="first_comic",
+            field=models.ForeignKey(
+                default=None,
+                null=True,
+                on_delete=django.db.models.deletion.SET_DEFAULT,
+                related_name="+",
+                to="codex.comic",
+            ),
+        ),
+        migrations.AddField(
+            model_name="publisher",
+            name="sort_name",
+            field=models.CharField(db_index=True, default="", max_length=128),
+        ),
+        migrations.AddField(
+            model_name="series",
+            name="first_comic",
+            field=models.ForeignKey(
+                default=None,
+                null=True,
+                on_delete=django.db.models.deletion.SET_DEFAULT,
+                related_name="+",
+                to="codex.comic",
+            ),
+        ),
+        migrations.AddField(
+            model_name="series",
+            name="sort_name",
+            field=models.CharField(db_index=True, default="", max_length=128),
+        ),
+        migrations.AddField(
+            model_name="storyarc",
+            name="first_comic",
+            field=models.ForeignKey(
+                default=None,
+                null=True,
+                on_delete=django.db.models.deletion.SET_DEFAULT,
+                related_name="+",
+                to="codex.comic",
+            ),
+        ),
+        migrations.AddField(
+            model_name="storyarc",
+            name="sort_name",
+            field=models.CharField(db_index=True, default="", max_length=128),
+        ),
+        migrations.AddField(
+            model_name="volume",
+            name="first_comic",
+            field=models.ForeignKey(
+                default=None,
+                null=True,
+                on_delete=django.db.models.deletion.SET_DEFAULT,
+                related_name="+",
+                to="codex.comic",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="adminflag",
+            name="key",
+            field=models.CharField(
+                choices=[
+                    ("FV", "Folder View"),
+                    ("RG", "Registration"),
+                    ("NU", "Non Users"),
+                    ("AU", "Auto Update"),
+                    ("SO", "Search Index Optimize"),
+                    ("IM", "Import Metadata"),
+                ],
+                db_index=True,
+                max_length=2,
+            ),
+        ),
+        migrations.AlterField(
+            model_name="librarianstatus",
+            name="status_type",
+            field=models.CharField(
+                choices=[
+                    ("CCC", "Create Covers"),
+                    ("CCD", "Purge Covers"),
+                    ("CFO", "Find Orphan"),
+                    ("IDM", "Dirs Moved"),
+                    ("IFM", "Files Moved"),
+                    ("ITR", "Aggregate Tags"),
+                    ("ITQ", "Query Missing Fks"),
+                    ("ITC", "Create Fks"),
+                    ("IDU", "Dirs Modified"),
+                    ("IFU", "Files Modified"),
+                    ("IFC", "Files Created"),
+                    ("IMQ", "Query M2M Fields"),
+                    ("IMC", "Link M2M Fields"),
+                    ("IDD", "Dirs Deleted"),
+                    ("IFD", "Files Deleted"),
+                    ("IFI", "Failed Imports"),
+                    ("ICQ", "Query Missing Covers"),
+                    ("ICM", "Covers Moved"),
+                    ("ICU", "Covers Modified"),
+                    ("ICC", "Covers Created"),
+                    ("ICD", "Covers Deleted"),
+                    ("ICL", "Covers Link"),
+                    ("IGU", "Group Update"),
+                    ("JTD", "Cleanup Fk"),
+                    ("JCU", "Codex Update"),
+                    ("JCR", "Codex Restart"),
+                    ("JCS", "Codex Stop"),
+                    ("JDO", "Db Optimize"),
+                    ("JDB", "Db Backup"),
+                    ("JSD", "Cleanup Sessions"),
+                    ("JCD", "Cleanup Covers"),
+                    ("SIX", "Search Index Clear"),
+                    ("SIU", "Search Index Update"),
+                    ("SID", "Search Index Remove"),
+                    ("SIM", "Search Index Merge"),
+                    ("WPO", "Poll"),
+                ],
+                db_index=True,
+                max_length=3,
+            ),
+        ),
+        migrations.AlterField(
+            model_name="timestamp",
+            name="key",
+            field=models.CharField(
+                choices=[
+                    ("JA", "Janitor"),
+                    ("VR", "Codex Version"),
+                    ("SI", "Search Index UUID"),
+                    ("AP", "API Key"),
+                ],
+                db_index=True,
+                max_length=2,
+            ),
+        ),
+        migrations.CreateModel(
+            name="CustomCover",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("created_at", models.DateTimeField(auto_now_add=True)),
+                ("updated_at", models.DateTimeField(auto_now=True)),
+                ("path", models.CharField(db_index=True, max_length=4095)),
+                ("stat", models.JSONField(null=True)),
+                (
+                    "group",
+                    models.CharField(
+                        choices=[
+                            ("p", "P"),
+                            ("i", "I"),
+                            ("s", "S"),
+                            ("a", "A"),
+                            ("f", "F"),
+                        ],
+                        db_index=True,
+                        max_length=1,
+                    ),
+                ),
+                (
+                    "sort_name",
+                    models.CharField(db_index=True, default="", max_length=128),
+                ),
+                (
+                    "library",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE, to="codex.library"
+                    ),
+                ),
+            ],
+            options={
+                "get_latest_by": "updated_at",
+                "abstract": False,
+                "unique_together": {("library", "path")},
+            },
+        ),
+        migrations.AddField(
+            model_name="folder",
+            name="custom_cover",
+            field=models.ForeignKey(
+                default=None,
+                null=True,
+                on_delete=django.db.models.deletion.SET_DEFAULT,
+                to="codex.customcover",
+            ),
+        ),
+        migrations.AddField(
+            model_name="imprint",
+            name="custom_cover",
+            field=models.ForeignKey(
+                default=None,
+                null=True,
+                on_delete=django.db.models.deletion.SET_DEFAULT,
+                to="codex.customcover",
+            ),
+        ),
+        migrations.AddField(
+            model_name="publisher",
+            name="custom_cover",
+            field=models.ForeignKey(
+                default=None,
+                null=True,
+                on_delete=django.db.models.deletion.SET_DEFAULT,
+                to="codex.customcover",
+            ),
+        ),
+        migrations.AddField(
+            model_name="series",
+            name="custom_cover",
+            field=models.ForeignKey(
+                default=None,
+                null=True,
+                on_delete=django.db.models.deletion.SET_DEFAULT,
+                to="codex.customcover",
+            ),
+        ),
+        migrations.AddField(
+            model_name="storyarc",
+            name="custom_cover",
+            field=models.ForeignKey(
+                default=None,
+                null=True,
+                on_delete=django.db.models.deletion.SET_DEFAULT,
+                to="codex.customcover",
+            ),
+        ),
+        migrations.RunPython(_generate_sort_name),
+        migrations.RunPython(_remove_cover_symlinks),
+    ]

codex/models/comic.py

@@ -176,12 +176,11 @@ class Comic(WatchedPathBrowserGroup):
 
     # Not useful
     custom_cover = None
+    first_comic = None
 
     class Meta(WatchedPathBrowserGroup.Meta):
         """Constraints."""
 
-        # TODO see if this inherits properly
-        # unique_together = ("library", "path")
         verbose_name = "Issue"
 
     def _set_date(self):

codex/models/groups.py

@@ -25,6 +25,9 @@ class BrowserGroupModel(BaseModel):
     custom_cover = ForeignKey(
         CustomCover, on_delete=SET_DEFAULT, null=True, default=None
     )
+    first_comic = ForeignKey(
+        "Comic", on_delete=SET_DEFAULT, null=True, default=None, related_name="+"
+    )
 
     def set_sort_name(self):
         """Create sort_name for model."""
@@ -128,14 +131,12 @@ class WatchedPathBrowserGroup(BrowserGroupModel, WatchedPath):
 
     def presave(self):
         """Fix multiple inheritance presave."""
-        # TODO test presave calling bgm & stat
         super().presave()
         WatchedPath.presave(self)
 
     class Meta(WatchedPath.Meta):  # type: ignore
         """Use Mixin Meta."""
 
-        # TODO see if this does unique properly.
         abstract = True
 
 

codex/models/paths.py

@@ -66,7 +66,6 @@ class WatchedPath(BaseModel):
 class FailedImport(WatchedPath):
     """Failed Comic Imports. Displayed in Admin Panel."""
 
-    # TODO rename reason
     name = CharField(db_index=True, max_length=MAX_NAME_LEN, default="")
 
     def set_reason(self, exc):

codex/permissions.py

@@ -8,7 +8,7 @@ from codex.models import Timestamp
 class HasAPIKeyOrIsAdminUser(BasePermission):
     """Does the request have the current api key."""
 
-    def has_permission(self, request, view):
+    def has_permission(self, request, view):  # type: ignore
         """Test the request api key against the database."""
         data = request.GET if request.method == "GET" else request.POST
         api_key = data.get("apiKey")

codex/search/query.py

@@ -3,6 +3,7 @@
 from codex._vendor.haystack.backends.whoosh_backend import (
     WhooshSearchQuery,
 )
+from codex._vendor.haystack.constants import DJANGO_ID
 from codex._vendor.haystack.query import SearchQuerySet
 
 
@@ -12,7 +13,8 @@ class CodexSearchQuery(WhooshSearchQuery):
     def __init__(self, *args, **kwargs):
         """Give CodexSearchQuery a reverse attribute."""
         super().__init__(*args, **kwargs)
-        self._reverse = False
+        self._reverse: bool = False
+        self._filter_comic_ids: frozenset | None = None
 
     def clean(self, query_fragment):
         """Optimize to noop because RESERVED_ consts are empty in the backend."""
@@ -22,9 +24,23 @@ class CodexSearchQuery(WhooshSearchQuery):
         """Invert the reverse attribute."""
         self._reverse = not self._reverse
 
+    def filter_comic_ids(self, ids):
+        """Set a filter for the query."""
+        self._filter_comic_ids = frozenset(ids)
+
     def get_results(self, **kwargs):
         """Send custom get results the reverse flag."""
-        return super().get_results(reverse=self._reverse, **kwargs)
+        custom_params = {}
+        if self._reverse:
+            custom_params["reverse"] = self._reverse
+
+        if self._filter_comic_ids:
+            filter_query = " OR ".join(
+                [f"{DJANGO_ID}:{pk}" for pk in self._filter_comic_ids]
+            )
+            custom_params["narrow_queries"] = {filter_query}
+
+        return super().get_results(**custom_params, **kwargs)
 
 
 class CodexSearchQuerySet(SearchQuerySet):
@@ -36,9 +52,16 @@ class CodexSearchQuerySet(SearchQuerySet):
         clone.query.order_reverse()  # type: ignore
         return clone
 
+    def filter_comic_ids(self, ids):
+        """Filter search by comic ids."""
+        clone = self._clone()
+        clone.query.filter_comic_ids(ids)  # type: ignore
+        return clone
+
     def values_list(self, *args, **kwargs):
         """Copy reverse setting into CodexSearchQuery."""
         clone = super().values_list(*args, **kwargs)
         if clone.query and self.query:
             clone.query._reverse = self.query._reverse  # noqa: SLF001
+            clone.query._filter_comic_ids = self.query._filter_comic_ids  # noqa: SLF001
         return clone

codex/search/writing.py

@@ -16,7 +16,7 @@ class CodexWriter(BufferedWriter):
     """MP safe Buffered Writer that locks the index writer much more granularly.
 
     XXX The period and limit args are ignored and this writer behaves more like the
-    AsycnWriter. The AsyncWriter could possibly be extended to not lock until commit
+    AsycWriter. The AsyncWriter could possibly be extended to not lock until commit
     time like this one and use less code.
     """
 

codex/serializers/admin.py

@@ -173,8 +173,7 @@ class AdminFolderSerializer(Serializer):
     def validate_show_hidden(self, show_hidden):
         """Snakecase the showHidden field."""
         return (
-            show_hidden == "true"
-            or self.initial_data.get("showHidden", False) == "true"
+            show_hidden == "true" or self.initial_data.get("showHidden") == "true"  # type: ignore
         )
 
 

codex/serializers/browser/filters.py

@@ -1,23 +1,19 @@
 """Browser Settings Filter Serializers."""
 
-from abc import ABC
-
-from django.core.exceptions import ValidationError
-from django.utils.translation import gettext_lazy as _
-from rest_framework.fields import Field
 from rest_framework.serializers import (
     BooleanField,
-    CharField,
     ChoiceField,
-    FloatField,
-    IntegerField,
-    ListField,
     Serializer,
 )
 
-from codex.serializers.choices import CHOICES, VUETIFY_NULL_CODE
-
-VUETIFY_NULL_CODE_STR = str(VUETIFY_NULL_CODE)
+from codex.serializers.choices import CHOICES
+from codex.serializers.fields import (
+    BooleanListField,
+    CharListField,
+    DecadeListField,
+    FloatListField,
+    IntListField,
+)
 
 
 class BrowserFilterChoicesSerializer(Serializer):
@@ -47,95 +43,6 @@ class BrowserFilterChoicesSerializer(Serializer):
     year = BooleanField(read_only=True)
 
 
-def validate_decades(decades):
-    """Validate decades."""
-    if not decades:
-        return
-    # * We don't need a whole db call just to be perfectly accurate
-    # * -1s are decoded back into None before validation
-    exists = False
-    for decade in decades:
-        if decade is None or decade % 10 == 0:
-            exists = True
-            break
-    if not exists:
-        raise ValidationError(_(f"Invalid decade in: {decades}"))
-
-
-def validate_int_null(values):
-    """Use a special code for null.
-
-    Because if a vuetify component has a null key it changes it to the
-    array index.
-    """
-    for index, value in enumerate(values):
-        if value == VUETIFY_NULL_CODE:
-            values[index] = None
-    return values
-
-
-def validate_str_null(values):
-    """Use a special code for null.
-
-    Because if a vuetify component has a null key it changes it to the
-    array index. This is the version for CharFields.
-    """
-    for index, value in enumerate(values):
-        if value == VUETIFY_NULL_CODE_STR:
-            values[index] = None
-    return values
-
-
-class FilterListField(ListField, ABC):
-    """Filter List field with custom arguments."""
-
-    CHILD_CLASS = Field
-    VALIDATORS = ()
-
-    def __init__(self, *args, **kwargs):
-        """Apply the subclass's arguments."""
-        super().__init__(
-            *args,
-            child=self.CHILD_CLASS(allow_null=True, **kwargs),
-            required=False,
-            validators=self.VALIDATORS,
-        )
-
-
-class FloatListField(FilterListField):
-    """Decimal List Field with validation."""
-
-    CHILD_CLASS = FloatField  # type: ignore
-    VALIDATORS = (validate_int_null,)
-
-
-class IntListField(FilterListField):
-    """Integer List Field with validation."""
-
-    CHILD_CLASS = IntegerField  # type: ignore
-    VALIDATORS = (validate_int_null,)
-
-
-class DecadeListField(IntListField):
-    """Integer List Field with validation for decades."""
-
-    VALIDATORS = (validate_int_null, validate_decades)
-
-
-class CharListField(FilterListField):
-    """Char List Field with validation."""
-
-    CHILD_CLASS = CharField  # type: ignore
-    VALIDATORS = (validate_str_null,)
-
-
-class BooleanListField(FilterListField):
-    """Bool List Field with validation."""
-
-    CHILD_CLASS = BooleanField  # type: ignore
-    VALIDATORS = (validate_int_null,)
-
-
 class BrowserSettingsFilterSerializer(Serializer):
     """Filter values for settings."""