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

codex/migrations/0029_comicfts.py

@@ -0,0 +1,58 @@
+"""Generated by Django 5.0.8 on 2024-08-07 22:07."""
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    """Run migrations."""
+
+    dependencies = [
+        ("codex", "0028_telemeter"),
+    ]
+
+    operations = [
+        migrations.SeparateDatabaseAndState(
+            state_operations=[
+                migrations.CreateModel(
+                    name="ComicFTS",
+                    fields=[
+                        ("created_at", models.DateTimeField(auto_now_add=True)),
+                        ("updated_at", models.DateTimeField(auto_now=True)),
+                        (
+                            "comic",
+                            models.OneToOneField(
+                                on_delete=django.db.models.deletion.CASCADE,
+                                primary_key=True,
+                                serialize=False,
+                                to="codex.comic",
+                            ),
+                        ),
+                        ("body", models.TextField()),
+                    ],
+                    options={
+                        "get_latest_by": "updated_at",
+                        "managed": False,
+                    },
+                ),
+            ],
+            database_operations=[
+                migrations.RunSQL(
+                    sql=(
+                        "CREATE VIRTUAL TABLE codex_comicfts USING fts5("
+                        "comic_id UNINDEXED, created_at UNINDEXED, "
+                        "updated_at UNINDEXED, "
+                        "publisher, imprint, series, volume, issue, name, age_rating, "
+                        "country, language, "
+                        "notes, original_format, review, scan_info, summary, "
+                        "tagger, "
+                        "characters, contributors, genres,"
+                        "locations, roles, series_groups, stories, "
+                        "story_arcs, tags, teams, "
+                        "reading_direction, file_type)"
+                    ),
+                    reverse_sql="DROP TABLE IF EXISTS codex_comicfts",
+                ),
+            ],
+        )
+    ]

codex/migrations/0030_nocase_collation_day_month_indexes_status_types.py

@@ -0,0 +1,202 @@
+"""Generated by Django 5.1.1 on 2024-09-12 00:13."""
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    """Migrate db."""
+
+    dependencies = [
+        ("codex", "0029_comicfts"),
+    ]
+
+    operations = [
+        migrations.AlterUniqueTogether(
+            name="groupauth",
+            unique_together=set(),
+        ),
+        migrations.AlterField(
+            model_name="adminflag",
+            name="key",
+            field=models.CharField(
+                choices=[
+                    ("FV", "Folder View"),
+                    ("RG", "Registration"),
+                    ("NU", "Non Users"),
+                    ("AU", "Auto Update"),
+                    ("IM", "Import Metadata"),
+                    ("ST", "Send Telemetry"),
+                ],
+                db_index=True,
+                max_length=2,
+            ),
+        ),
+        migrations.AlterField(
+            model_name="comic",
+            name="day",
+            field=models.PositiveSmallIntegerField(db_index=True, null=True),
+        ),
+        migrations.AlterField(
+            model_name="comic",
+            name="file_type",
+            field=models.CharField(
+                blank=True,
+                choices=[
+                    ("CBZ", "Cbz"),
+                    ("CBR", "Cbr"),
+                    ("CBT", "Cbt"),
+                    ("PDF", "Pdf"),
+                ],
+                db_collation="nocase",
+                db_index=True,
+                default="",
+                max_length=3,
+            ),
+        ),
+        migrations.AlterField(
+            model_name="comic",
+            name="issue_suffix",
+            field=models.CharField(
+                db_collation="nocase", db_index=True, default="", max_length=16
+            ),
+        ),
+        migrations.AlterField(
+            model_name="comic",
+            name="month",
+            field=models.PositiveSmallIntegerField(db_index=True, null=True),
+        ),
+        migrations.AlterField(
+            model_name="comic",
+            name="notes",
+            field=models.TextField(db_collation="nocase", default=""),
+        ),
+        migrations.AlterField(
+            model_name="comic",
+            name="reading_direction",
+            field=models.CharField(
+                choices=[
+                    ("ltr", "Ltr"),
+                    ("rtl", "Rtl"),
+                    ("ttb", "Ttb"),
+                    ("btt", "Btt"),
+                ],
+                db_collation="nocase",
+                db_index=True,
+                default="ltr",
+                max_length=3,
+            ),
+        ),
+        migrations.AlterField(
+            model_name="comic",
+            name="review",
+            field=models.TextField(db_collation="nocase", default=""),
+        ),
+        migrations.AlterField(
+            model_name="comic",
+            name="sort_name",
+            field=models.CharField(
+                db_collation="nocase", db_index=True, default="", max_length=128
+            ),
+        ),
+        migrations.AlterField(
+            model_name="comic",
+            name="summary",
+            field=models.TextField(db_collation="nocase", default=""),
+        ),
+        migrations.AlterField(
+            model_name="customcover",
+            name="sort_name",
+            field=models.CharField(
+                db_collation="nocase", db_index=True, default="", max_length=128
+            ),
+        ),
+        migrations.AlterField(
+            model_name="folder",
+            name="sort_name",
+            field=models.CharField(
+                db_collation="nocase", db_index=True, default="", max_length=128
+            ),
+        ),
+        migrations.AlterField(
+            model_name="imprint",
+            name="sort_name",
+            field=models.CharField(
+                db_collation="nocase", db_index=True, default="", max_length=128
+            ),
+        ),
+        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"),
+                    ("IAF", "Adopt Folders"),
+                    ("JTD", "Cleanup Fk"),
+                    ("JLV", "Codex Latest Version"),
+                    ("JCU", "Codex Update"),
+                    ("JCR", "Codex Restart"),
+                    ("JCS", "Codex Stop"),
+                    ("JDO", "Db Optimize"),
+                    ("JDB", "Db Backup"),
+                    ("JSD", "Cleanup Sessions"),
+                    ("JCD", "Cleanup Covers"),
+                    ("JCB", "Cleanup Bookmarks"),
+                    ("JIF", "Integrity Fk"),
+                    ("JIC", "Integrity Check"),
+                    ("JFC", "Fts Integrity Check"),
+                    ("JFR", "Fts Rebuild"),
+                    ("SIX", "Search Index Clear"),
+                    ("SIU", "Search Index Update"),
+                    ("SIC", "Search Index Create"),
+                    ("SID", "Search Index Remove"),
+                    ("SIO", "Search Index Optimize"),
+                    ("WPO", "Poll"),
+                ],
+                db_index=True,
+                max_length=3,
+            ),
+        ),
+        migrations.AlterField(
+            model_name="publisher",
+            name="sort_name",
+            field=models.CharField(
+                db_collation="nocase", db_index=True, default="", max_length=128
+            ),
+        ),
+        migrations.AlterField(
+            model_name="series",
+            name="sort_name",
+            field=models.CharField(
+                db_collation="nocase", db_index=True, default="", max_length=128
+            ),
+        ),
+        migrations.AlterField(
+            model_name="storyarc",
+            name="sort_name",
+            field=models.CharField(
+                db_collation="nocase", db_index=True, default="", max_length=128
+            ),
+        ),
+    ]

codex/models/admin.py

@@ -22,7 +22,7 @@ from codex.librarian.importer.status import ImportStatusTypes
 from codex.librarian.janitor.status import JanitorStatusTypes
 from codex.librarian.search.status import SearchIndexStatusTypes
 from codex.librarian.watchdog.status import WatchdogStatusTypes
-from codex.models.base import MAX_FIELD_LEN, MAX_NAME_LEN, BaseModel
+from codex.models.base import MAX_FIELD_LEN, MAX_NAME_LEN, BaseModel, max_choices_len
 
 __all__ = ("AdminFlag", "LibrarianStatus", "Timestamp", "UserActive")
 
@@ -37,13 +37,16 @@ class AdminFlag(BaseModel):
         REGISTRATION = "RG"
         NON_USERS = "NU"
         AUTO_UPDATE = "AU"
-        SEARCH_INDEX_OPTIMIZE = "SO"
         IMPORT_METADATA = "IM"
         SEND_TELEMETRY = "ST"
 
     FALSE_DEFAULTS = frozenset({FlagChoices.AUTO_UPDATE})
 
-    key = CharField(db_index=True, max_length=2, choices=FlagChoices.choices)
+    key = CharField(
+        db_index=True,
+        max_length=max_choices_len(FlagChoices),
+        choices=FlagChoices.choices,
+    )
     on = BooleanField(default=True)
 
     class Meta(BaseModel.Meta):
@@ -55,7 +58,7 @@ class AdminFlag(BaseModel):
 class LibrarianStatus(BaseModel):
     """Active Library Tasks."""
 
-    CHOICES = (
+    CHOICES = tuple(
         CoverStatusTypes.choices
         + ImportStatusTypes.choices
         + JanitorStatusTypes.choices
@@ -63,7 +66,9 @@ class LibrarianStatus(BaseModel):
         + WatchdogStatusTypes.choices
     )
 
-    status_type = CharField(db_index=True, max_length=3, choices=CHOICES)
+    status_type = CharField(
+        db_index=True, max_length=max_choices_len(CHOICES), choices=CHOICES
+    )
     preactive = BooleanField(default=False)
     complete = PositiveSmallIntegerField(null=True, default=None)
     total = PositiveSmallIntegerField(null=True, default=None)
@@ -89,7 +94,11 @@ class Timestamp(BaseModel):
         API_KEY = "AP", _("API Key")
         TELEMETER_SENT = "TS", _("Telemeter Sent")
 
-    key = CharField(db_index=True, max_length=2, choices=TimestampChoices.choices)
+    key = CharField(
+        db_index=True,
+        max_length=max_choices_len(TimestampChoices),
+        choices=TimestampChoices.choices,
+    )
     version = CharField(max_length=MAX_FIELD_LEN, default="")
 
     @classmethod
@@ -125,8 +134,3 @@ class GroupAuth(BaseModel):
 
     group = OneToOneField(Group, db_index=True, on_delete=CASCADE)
     exclude = BooleanField(db_index=True, default=False)
-
-    class Meta(BaseModel.Meta):
-        """Constraints."""
-
-        unique_together = ("group",)

codex/models/base.py

@@ -7,8 +7,17 @@ from codex.models.query import GroupByManager
 
 __all__ = ("BaseModel",)
 
+MAX_PATH_LEN = 4095
 MAX_NAME_LEN = 128
 MAX_FIELD_LEN = 32
+MAX_ISSUE_SUFFIX_LEN = 16
+
+
+def max_choices_len(choices):
+    """Return the maximum possible size for a Choice's key."""
+    if not isinstance(choices, tuple):
+        choices = choices.choices
+    return max(len(choice[0]) for choice in choices)
 
 
 class BaseModel(Model):

codex/models/bookmark.py

@@ -11,7 +11,7 @@ from django.db.models import (
     PositiveSmallIntegerField,
 )
 
-from codex.models.base import BaseModel
+from codex.models.base import BaseModel, max_choices_len
 from codex.models.comic import Comic, ReadingDirection
 
 __all__ = ("Bookmark", "cascade_if_user_null")
@@ -73,14 +73,14 @@ class Bookmark(BaseModel):
         blank=True,
         choices=FitTo.choices,
         default="",
-        max_length=1,
+        max_length=max_choices_len(FitTo),
     )
     two_pages = BooleanField(default=None, null=True)
     reading_direction = CharField(
         blank=True,
         choices=ReadingDirection.choices,
         default="",
-        max_length=3,
+        max_length=max_choices_len(ReadingDirection),
     )
 
     class Meta(BaseModel.Meta):

codex/models/comic.py

@@ -17,11 +17,18 @@ from django.db.models import (
     DecimalField,
     ForeignKey,
     ManyToManyField,
+    OneToOneField,
     PositiveIntegerField,
     PositiveSmallIntegerField,
     TextField,
 )
 
+from codex.models.base import (
+    MAX_ISSUE_SUFFIX_LEN,
+    MAX_NAME_LEN,
+    BaseModel,
+    max_choices_len,
+)
 from codex.models.groups import (
     Folder,
     Imprint,
@@ -61,16 +68,17 @@ class ReadingDirection(Choices):
     BTT = ReadingDirectionEnum.BTT.value
 
 
-class Comic(WatchedPathBrowserGroup):
-    """Comic metadata."""
+class FileType(Choices):
+    """Identifiers for file formats."""
+
+    CBZ = "CBZ"
+    CBR = "CBR"
+    CBT = "CBT"
+    PDF = "PDF"
 
-    class FileType(Choices):
-        """Identifiers for file formats."""
 
-        CBZ = "CBZ"
-        CBR = "CBR"
-        CBT = "CBT"
-        PDF = "PDF"
+class Comic(WatchedPathBrowserGroup):
+    """Comic metadata."""
 
     _ORDERING = (
         "issue_number",
@@ -92,7 +100,12 @@ class Comic(WatchedPathBrowserGroup):
     issue_number = DecimalField(
         db_index=True, decimal_places=2, max_digits=10, null=True
     )
-    issue_suffix = CharField(db_index=True, max_length=16, default="")
+    issue_suffix = CharField(
+        db_index=True,
+        max_length=MAX_ISSUE_SUFFIX_LEN,
+        default="",
+        db_collation="nocase",
+    )
     # Group FKs
     volume = ForeignKey(Volume, db_index=True, on_delete=CASCADE)
     series = ForeignKey(Series, db_index=True, on_delete=CASCADE)
@@ -111,13 +124,13 @@ class Comic(WatchedPathBrowserGroup):
 
     # Date
     year = PositiveSmallIntegerField(db_index=True, null=True)
-    month = PositiveSmallIntegerField(null=True)
-    day = PositiveSmallIntegerField(null=True)
+    month = PositiveSmallIntegerField(db_index=True, null=True)
+    day = PositiveSmallIntegerField(db_index=True, null=True)
 
     # Text
-    summary = TextField(default="")
-    review = TextField(default="")
-    notes = TextField(default="")
+    summary = TextField(default="", db_collation="nocase")
+    review = TextField(default="", db_collation="nocase")
+    notes = TextField(default="", db_collation="nocase")
 
     # Ratings
     community_rating = DecimalField(
@@ -133,7 +146,8 @@ class Comic(WatchedPathBrowserGroup):
         db_index=True,
         choices=ReadingDirection.choices,
         default=ReadingDirectionEnum.LTR.value,
-        max_length=3,
+        max_length=max_choices_len(ReadingDirection),
+        db_collation="nocase",
     )
 
     # Misc
@@ -168,10 +182,12 @@ class Comic(WatchedPathBrowserGroup):
     folders = ManyToManyField(Folder)
     size = PositiveIntegerField(db_index=True)
     file_type = CharField(
+        db_index=True,
         choices=FileType.choices,
-        max_length=3,
+        max_length=max_choices_len(FileType),
         blank=True,
         default="",
+        db_collation="nocase",
     )
 
     # Not useful
@@ -287,3 +303,39 @@ class Comic(WatchedPathBrowserGroup):
         if self.issue_suffix:
             res += self.issue_suffix
         return res
+
+
+class ComicFTS(BaseModel):
+    comic = OneToOneField(primary_key=True, to=Comic, on_delete=CASCADE)
+    publisher = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
+    imprint = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
+    series = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
+    volume = PositiveIntegerField()
+    issue = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
+    name = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
+    age_rating = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
+    country = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
+    language = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
+    notes = TextField(db_collation="nocase")
+    original_format = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
+    review = TextField(db_collation="nocase")
+    scan_info = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
+    summary = TextField(db_collation="nocase")
+    tagger = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
+    characters = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
+    contributors = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
+    genres = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
+    locations = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
+    series_groups = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
+    stories = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
+    story_arcs = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
+    tags = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
+    teams = CharField(db_collation="nocase", max_length=MAX_NAME_LEN)
+
+    reading_direction = CharField(
+        db_collation="nocase", max_length=max_choices_len(ReadingDirection)
+    )
+    file_type = CharField(db_collation="nocase", max_length=max_choices_len(FileType))
+
+    class Meta(BaseModel.Meta):
+        managed = False

codex/models/functions.py

@@ -1,12 +1,70 @@
 """Custom Django DB functions."""
 
-from django.db.models import Aggregate, JSONField
+from django.db.models.aggregates import Aggregate
+from django.db.models.expressions import Func
+from django.db.models.fields import CharField, FloatField, TextField
+from django.db.models.fields.json import JSONField
+from django.db.models.fields.related import OneToOneField
+from django.db.models.lookups import Lookup
 
 
 class JsonGroupArray(Aggregate):
-    """Sqlite3 json_group_array() function."""
+    """Sqlite3 JSON_GROUP_ARRAY function."""
 
     allow_distinct = True
     function = "JSON_GROUP_ARRAY"
     name = "JsonGroupArray"
     output_field = JSONField()  # type: ignore
+
+
+class GroupConcat(Aggregate):
+    """Sqlite3 GROUP_CONCAT."""
+
+    # Defaults to " " separator which is all I need for now.
+
+    allow_distinct = True
+    function = "GROUP_CONCAT"
+    name = "GroupConcat"
+    output_field = CharField()  # type: ignore
+
+
+@OneToOneField.register_lookup
+class FTS5Match(Lookup):
+    """Sqlite3 FTS5 MATCH lookup."""
+
+    lookup_name = "match"
+
+    def as_sql(self, compiler, connection):
+        """Generate MATCH sql."""
+        # lhs, lhs_params = self.process_lhs(compiler, connection)
+        # fts_table = lhs.split(".")[0]
+        rhs, rhs_params = self.process_rhs(compiler, connection)
+        # MATCH works on the table itself not the one_to_one rel.
+        # Force the table name without substitutions by the optimizer
+        sql = "codex_comicfts MATCH " + rhs
+        params = rhs_params
+        return sql, params
+
+
+@CharField.register_lookup
+@TextField.register_lookup
+class Like(Lookup):
+    """SQL LIKE lookup."""
+
+    lookup_name = "like"
+
+    def as_sql(self, compiler, connection):
+        """Generate LIKE sql."""
+        lhs, lhs_params = self.process_lhs(compiler, connection)
+        rhs, rhs_params = self.process_rhs(compiler, connection)
+        params = lhs_params + rhs_params
+        sql = f"{lhs} LIKE {rhs}"
+        return sql, params
+
+
+class ComicFTSRank(Func):
+    """Sqlite3 FTS5 inverse rank function."""
+
+    function = "rank"
+    template = '("codex_comicfts"."rank" * -1)'
+    output_field = FloatField()  # type: ignore

codex/models/groups.py

@@ -21,7 +21,12 @@ class BrowserGroupModel(BaseModel):
     PARENT = ""
 
     name = CharField(db_index=True, max_length=MAX_NAME_LEN, default=DEFAULT_NAME)
-    sort_name = CharField(db_index=True, max_length=MAX_NAME_LEN, default=DEFAULT_NAME)
+    sort_name = CharField(
+        db_index=True,
+        max_length=MAX_NAME_LEN,
+        default=DEFAULT_NAME,
+        db_collation="nocase",
+    )
     custom_cover = ForeignKey(
         CustomCover, on_delete=SET_DEFAULT, null=True, default=None
     )

codex/models/library.py

@@ -15,12 +15,10 @@ from django.db.models import (
 )
 from django.utils.translation import gettext_lazy as _
 
-from codex.models.base import BaseModel
+from codex.models.base import MAX_PATH_LEN, BaseModel
 
 __all__ = ("Library", "validate_dir_exists")
 
-MAX_PATH_LEN = 4095
-
 
 def validate_dir_exists(path):
     """Validate that a library exists."""

codex/models/paths.py

@@ -6,7 +6,7 @@ from types import MappingProxyType
 from django.db.models import CASCADE, CharField, ForeignKey, JSONField
 from django.db.models.enums import Choices
 
-from codex.models.base import MAX_NAME_LEN, BaseModel
+from codex.models.base import MAX_NAME_LEN, BaseModel, max_choices_len
 from codex.models.library import MAX_PATH_LEN, Library
 from codex.models.util import get_sort_name
 
@@ -101,8 +101,14 @@ class CustomCover(WatchedPath):
     )
 
     parent_folder = None
-    group = CharField(max_length=1, db_index=True, choices=GroupChoice.choices)
-    sort_name = CharField(max_length=MAX_NAME_LEN, db_index=True, default="")
+    group = CharField(
+        max_length=max_choices_len(GroupChoice),
+        db_index=True,
+        choices=GroupChoice.choices,
+    )
+    sort_name = CharField(
+        max_length=MAX_NAME_LEN, db_index=True, default="", db_collation="nocase"
+    )
 
     def _set_group_and_sort_name(self):
         """Set group and sort_name from path."""

codex/models/query.py

@@ -86,6 +86,12 @@ class GroupByQuerySet(QuerySet):
         obj.query.set_force_group_by(fields, model=model)
         return obj
 
+    def demote_joins(self, tables):
+        """Force INNER JOINS."""
+        obj = self._chain()  # type: ignore
+        obj.query.demote_joins(tables)
+        return obj
+
 
 class GroupByManager(Manager.from_queryset(GroupByQuerySet)):
     """Use GroupBy QuerySet."""