codex 1.5.17__py3-none-any.whl → 1.6.0__py3-none-any.whl

codex/serializers/mixins.py

@@ -2,32 +2,10 @@
 
 from rest_framework.serializers import (
     BooleanField,
-    CharField,
-    DateTimeField,
-    DecimalField,
-    IntegerField,
     Serializer,
 )
 
 
-class BrowserAggregateSerializerMixin(Serializer):
-    """Mixin for browser, opds & metadata serializers."""
-
-    group = CharField(read_only=True, max_length=1)
-
-    # Aggregate Annotations
-    child_count = IntegerField(read_only=True)
-    cover_pk = IntegerField(read_only=True)
-
-    # Bookmark annotations
-    page = IntegerField(read_only=True)
-    bookmark_updated_at = DateTimeField(read_only=True, allow_null=True)
-    finished = BooleanField(read_only=True)
-    progress = DecimalField(
-        max_digits=5, decimal_places=2, read_only=True, coerce_to_string=False
-    )
-
-
 class OKSerializer(Serializer):
     """Default serializer for views without much response."""
 

codex/serializers/models/pycountry.py

@@ -1,73 +1,33 @@
 """Pycountry Model Serializers."""
 
-import pycountry
-from drf_spectacular.types import OpenApiTypes
-from drf_spectacular.utils import extend_schema_field
-from rest_framework.serializers import (
-    SerializerMethodField,
-)
-
+from codex.logger.logging import get_logger
 from codex.models import (
     Country,
     Language,
 )
+from codex.serializers.fields import CountryField, LanguageField
 from codex.serializers.models.named import NamedModelSerializer
 
+LOG = get_logger(__name__)
 
-class PyCountrySerializer(NamedModelSerializer):
-    """PyCountry tag serializer to include long names.
 
-    Takes a single string value and serializes the value to
-    a pk attribute and a pycountry long name lookup of that value to
-    the name.
-    """
-
-    LOOKUP_MODULE = pycountry.countries
-    _ALPHA_2_LEN = 2
+class CountrySerializer(NamedModelSerializer):
+    """Pycountry serializer for country field."""
 
-    name = SerializerMethodField()
+    name = CountryField(read_only=True)
 
     class Meta(NamedModelSerializer.Meta):
-        """Abstract class."""
-
-        abstract = True
-
-    @classmethod
-    def lookup_name(cls, lookup_module, obj):
-        """Lookup the name with pycountry, just copy the key on fail."""
-        name = obj.name
-        if not name:
-            return ""
-        # fix for https://github.com/flyingcircusio/pycountry/issues/41
-        lookup_obj = (
-            lookup_module.get(alpha_2=name)
-            if len(name) == cls._ALPHA_2_LEN
-            else lookup_module.lookup(name)
-        )
-        # If lookup fails, return the key as the name
-        return lookup_obj.name if lookup_obj else name
+        """Configure model."""
 
-    @extend_schema_field(OpenApiTypes.STR)
-    def get_name(self, obj):
-        """Lookup the name with pycountry, just copy the key on fail."""
-        return self.lookup_name(self.LOOKUP_MODULE, obj)
+        model = Country
 
 
-class LanguageSerializer(PyCountrySerializer):
+class LanguageSerializer(NamedModelSerializer):
     """Pycountry serializer for language field."""
 
-    LOOKUP_MODULE = pycountry.languages
+    name = LanguageField(read_only=True)
 
-    class Meta(PyCountrySerializer.Meta):
+    class Meta(NamedModelSerializer.Meta):
         """Configure model."""
 
         model = Language
-
-
-class CountrySerializer(PyCountrySerializer):
-    """Pycountry serializer for country field."""
-
-    class Meta(PyCountrySerializer.Meta):
-        """Configure model."""
-
-        model = Country

codex/serializers/opds/urls.py

@@ -0,0 +1,10 @@
+"""OPDS URLs."""
+
+from rest_framework.serializers import CharField, Serializer
+
+
+class OPDSURLsSerializer(Serializer):
+    """OPDS Urls."""
+
+    v1 = CharField(read_only=True)
+    v2 = CharField(read_only=True)

codex/serializers/opds/v2.py

@@ -12,12 +12,6 @@ from rest_framework.fields import (
 from rest_framework.serializers import Serializer
 
 
-class CharListField(ListField):
-    """List of CharFields."""
-
-    child = CharField()
-
-
 class OPDS2LinkPropertiesSerializer(Serializer):
     """Link Properties.
 
@@ -55,9 +49,9 @@ class OPDS2LinkSerializer(Serializer):
     width = IntegerField(read_only=True, required=False)
     # bitrate = IntegerField(read_only=True, required=False)
     # duration = IntegerField(read_only=True, required=False)
-    # language = CharListField(read_only=True, required=False)
-    alternate = CharListField(read_only=True, required=False)
-    children = CharListField(read_only=True, required=False)
+    # language = CharField(many=True, read_only=True, required=False)
+    alternate = ListField(child=CharField(), read_only=True, required=False)
+    children = ListField(child=CharField(), read_only=True, required=False)
     properties = OPDS2LinkPropertiesSerializer(read_only=True, required=False)
 
     def get_rel(self, obj) -> str | None:
@@ -69,7 +63,7 @@ class OPDS2LinkSerializer(Serializer):
         return obj.get("rel")
 
 
-class LinkListField(ListField):
+class OPDS2LinkListField(ListField):
     """Link List."""
 
     child = OPDS2LinkSerializer()
@@ -131,7 +125,7 @@ class OPDS2PublicationMetadataSerializer(OPDS2MetadataSerializer):
     #####################
     # Extended metadata #
     #####################
-    subject = CharListField(read_only=True, required=False)
+    subject = ListField(child=CharField(), read_only=True, required=False)
     author = OPDS2ContributorObjectSerializer(many=True, required=False)
     # translator = OPDS2ContributorObjectSerializer(many=True, required=False)
     editor = OPDS2ContributorObjectSerializer(many=True, required=False)
@@ -148,7 +142,7 @@ class OPDS2FacetSerializer(Serializer):
     """Facets."""
 
     metadata = OPDS2MetadataSerializer(read_only=True)
-    links = LinkListField(read_only=True)
+    links = OPDS2LinkListField(read_only=True)
 
 
 class OPDS2PublicationSerializer(OPDS2FacetSerializer):
@@ -158,19 +152,19 @@ class OPDS2PublicationSerializer(OPDS2FacetSerializer):
     """
 
     metadata = OPDS2PublicationMetadataSerializer(read_only=True)
-    links = LinkListField(read_only=True)
-    images = LinkListField(read_only=True, required=False)
+    links = OPDS2LinkListField(read_only=True)
+    images = OPDS2LinkListField(read_only=True, required=False)
 
 
 class OPDS2GroupSerializer(Serializer):
     """Group."""
 
     metadata = OPDS2MetadataSerializer(read_only=True)
-    links = LinkListField(read_only=True, required=False)
+    links = OPDS2LinkListField(read_only=True, required=False)
     publications = ListField(
         child=OPDS2PublicationSerializer(), read_only=True, required=False
     )
-    navigation = LinkListField(read_only=True, required=False)
+    navigation = OPDS2LinkListField(read_only=True, required=False)
 
 
 class OPDS2FeedSerializer(OPDS2GroupSerializer):

codex/serializers/opds/v2_unused.py

@@ -3,7 +3,7 @@
 from rest_framework.fields import CharField, DateTimeField, DecimalField, IntegerField
 from rest_framework.serializers import ChoiceField, Serializer
 
-from codex.serializers.opds.v2 import LinkListField
+from codex.serializers.opds.v2 import OPDS2LinkListField
 
 
 class RecursiveField(Serializer):
@@ -15,7 +15,9 @@ class RecursiveField(Serializer):
 
     def to_representation(self, instance):
         """Represent with own class."""
-        serializer = self.parent.parent.__class__(instance, context=self.context)
+        parent = self.parent
+        # Should not be ignored but is currently unused
+        serializer = parent.parent.__class__(instance, context=self.context)  # type: ignore
         return serializer.data
 
 
@@ -68,7 +70,7 @@ class OPDS2ProfileSerializer(Serializer):
 
     name = CharField(read_only=True)
     email = CharField(read_only=True)
-    links = LinkListField(read_only=True, required=False)
+    links = OPDS2LinkListField(read_only=True, required=False)
     loans = OPDS2CopiesSerializer(read_only=True)
     holds = OPDS2HoldsSerializer(read_only=True)
 

codex/serializers/reader.py

@@ -4,13 +4,15 @@ from rest_framework.serializers import (
     BooleanField,
     CharField,
     ChoiceField,
-    DateTimeField,
     DecimalField,
     IntegerField,
     Serializer,
 )
 
 from codex.models import Bookmark
+from codex.serializers.browser.settings import BrowserSettingsShowGroupFlagsSerializer
+from codex.serializers.fields import BreadcrumbsField, TimestampField, TopGroupField
+from codex.serializers.route import RouteSerializer, SimpleRouteSerializer
 
 
 class ReaderSettingsSerializer(Serializer):
@@ -24,14 +26,8 @@ class ReaderSettingsSerializer(Serializer):
     two_pages = BooleanField(allow_null=True, required=False)
     reading_direction = CharField(allow_null=True, required=False)
     read_rtl_in_reverse = BooleanField(allow_null=True, required=False)
-
-
-class ReaderArcSerializer(Serializer):
-    """A group of comics or a story arc."""
-
-    group = CharField(read_only=True)
-    pk = IntegerField(read_only=True)
-    name = CharField(read_only=True)
+    finish_on_last_page = BooleanField(allow_null=True, required=False)
+    mtime = TimestampField(read_only=True)
 
 
 class ReaderComicSerializer(Serializer):
@@ -41,16 +37,25 @@ class ReaderComicSerializer(Serializer):
     settings = ReaderSettingsSerializer(read_only=True)
     max_page = IntegerField(read_only=True)
     reading_direction = CharField(read_only=True)
-    mtime = DateTimeField(format="%s", read_only=True)
+    mtime = TimestampField(read_only=True)
 
 
-class ReaderCurrentArcSerializer(Serializer):
+class ReaderArcSerializer(SimpleRouteSerializer):
     """Information about the current Arc."""
 
-    group = CharField(read_only=True)
-    pk = IntegerField(read_only=True)
-    index = IntegerField(read_only=True)
-    count = IntegerField(read_only=True, required=False)
+    name = CharField(required=False)
+    index = IntegerField(required=False)
+    count = IntegerField(required=False)
+    mtime = TimestampField(read_only=True)
+
+
+class ReaderViewInputSerializer(Serializer):
+    """Input for the reader serailizer."""
+
+    arc = ReaderArcSerializer(required=False)
+    breadcrumbs = BreadcrumbsField(required=False)
+    show = BrowserSettingsShowGroupFlagsSerializer(required=False)
+    top_group = TopGroupField(required=False)
 
 
 class ReaderCurrentComicSerializer(ReaderComicSerializer):
@@ -74,6 +79,7 @@ class ReaderCurrentComicSerializer(ReaderComicSerializer):
 
     file_type = CharField(read_only=True, required=False)
     filename = CharField(read_only=True, required=False)
+    name = CharField(read_only=True, required=False)
 
 
 class ReaderBooksSerializer(Serializer):
@@ -89,4 +95,6 @@ class ReaderComicsSerializer(Serializer):
 
     books = ReaderBooksSerializer(read_only=True)
     arcs = ReaderArcSerializer(many=True, read_only=True)
-    arc = ReaderCurrentArcSerializer(read_only=True)
+    arc = ReaderArcSerializer(read_only=True)
+    close_route = RouteSerializer(read_only=True)
+    mtime = TimestampField(read_only=True)

codex/serializers/redirect.py

@@ -1,15 +1,16 @@
 """Notification serializers."""
 
-from rest_framework.serializers import CharField, JSONField, Serializer
+from rest_framework.serializers import CharField, Serializer
 
 from codex.serializers.browser.settings import BrowserSettingsSerializer
+from codex.serializers.route import RouteSerializer
 
 
 class ReaderRedirectSerializer(Serializer):
     """Reader 404 message."""
 
     reason = CharField(read_only=True)
-    route = JSONField(read_only=True)
+    route = RouteSerializer(read_only=True)
 
 
 class BrowserRedirectSerializer(ReaderRedirectSerializer):

codex/serializers/route.py

@@ -0,0 +1,45 @@
+"""Vue Route Serializer."""
+
+from rest_framework.fields import CharField, IntegerField
+from rest_framework.serializers import Serializer
+
+from codex.views.util import Route
+
+
+class SimpleRouteSerializer(Serializer):
+    """A an abbreviated vue route for the browser."""
+
+    group = CharField()
+    pks = CharField()
+
+    def to_representation(self, instance):
+        """Allow submission of sequences instead of strings for pks."""
+        if isinstance(instance, Route):
+            instance = instance.dict()
+        pks = instance["pks"]
+        if not pks:
+            instance["pks"] = "0"
+        elif not isinstance(pks, str):
+            instance["pks"] = ",".join(str(pk) for pk in sorted(pks))
+        return super().to_representation(instance)
+
+    def to_internal_value(self, data):
+        """Convert pk strings to tuples."""
+        instance = super().to_internal_value(data)
+        try:
+            pks = instance.get("pks")
+            if isinstance(pks, str):
+                pks = tuple(sorted(int(pk) for pk in pks.split(",")))
+            if 0 in pks:  # type: ignore
+                pks = ()
+            instance["pks"] = tuple(pks)  # type: ignore
+        except ValueError:
+            instance["pks"] = ()
+        return instance
+
+
+class RouteSerializer(SimpleRouteSerializer):
+    """A vue route for the browser."""
+
+    page = IntegerField()
+    name = CharField(allow_blank=True, required=False)

codex/serializers/settings.py

@@ -0,0 +1,12 @@
+"""Settings Serializer."""
+
+from rest_framework.fields import BooleanField, CharField
+from rest_framework.serializers import ListSerializer, Serializer
+
+
+class SettingsSerializer(Serializer):
+    """For requesting settings."""
+
+    only = ListSerializer(child=CharField(), required=False)
+    group = CharField(required=False)
+    breadcrumb_names = BooleanField(required=False, default=True)

codex/settings/settings.py

@@ -9,11 +9,11 @@ For the full list of settings and their values, see
 https://docs.djangoproject.com/en/dev/ref/settings/
 """
 
-import socket
 from logging import WARN, getLogger
 from os import environ
 from pathlib import Path
 from sys import maxsize
+from types import MappingProxyType
 
 from codex.settings.hypercorn import load_hypercorn_config
 from codex.settings.logging import get_loglevel
@@ -21,43 +21,58 @@ from codex.settings.secret_key import get_secret_key
 from codex.settings.timezone import get_time_zone
 from codex.settings.whitenoise import immutable_file_test
 
-# Base paths
-BASE_DIR = Path(__file__).resolve().parent.parent.parent
-CODEX_PATH = BASE_DIR / "codex"
-CONFIG_PATH = Path(environ.get("CODEX_CONFIG_DIR", Path.cwd() / "config"))
-CONFIG_PATH.mkdir(exist_ok=True, parents=True)
-
-# SECURITY WARNING: keep the secret key used in production secret!
-SECRET_KEY = get_secret_key(CONFIG_PATH)
-
+######################################
+# Undocumented Environment Variables #
+######################################
 # SECURITY WARNING: don't run with debug turned on in production!
 DEBUG = bool(environ.get("DEBUG", "").lower() not in ("0", "false", ""))
-
-RESET_ADMIN = bool(environ.get("CODEX_RESET_ADMIN"))
-SKIP_INTEGRITY_CHECK = bool(environ.get("CODEX_SKIP_INTEGRITY_CHECK"))
-
-# Logging
-LOGLEVEL = get_loglevel(DEBUG)
-LOG_DIR = Path(environ.get("CODEX_LOG_DIR", CONFIG_PATH / "logs"))
-LOG_TO_CONSOLE = environ.get("CODEX_LOG_TO_CONSOLE") != "0"
-LOG_TO_FILE = environ.get("CODEX_LOG_TO_FILE") != "0"
 BUILD = environ.get("BUILD", False)
 # Slow query middleware
 # limit in seconds
 SLOW_QUERY_LIMIT = float(environ.get("CODEX_SLOW_QUERY_LIMIT", 0.5))
 LOG_RESPONSE_TIME = bool(environ.get("CODEX_LOG_RESPONSE_TIME", False))
-TZ = environ.get("TIMEZONE", environ.get("TZ"))
 # Search indexing memory controls
 MMAP_RATIO = int(environ.get("CODEX_MMAP_RATIO", 240))
 WRITER_MEMORY_PERCENT = float(environ.get("CODEX_WRITER_MEMORY_PERCENT", 0.6))
 CPU_MULTIPLIER = float(environ.get("CODEX_CPU_MULTIPLIER", 1.25))
 CHUNK_PER_GB = int(environ.get("CODEX_CHUNK_PER_GB", 250))
 MAX_CHUNK_SIZE = int(environ.get("CODEX_MAX_CHUNK_SIZE", 1000))
-# sqlite parser breaks with more than 1000 variables in a query and django only
-# fixes this in the bulk_create & bulk_update functions. So for complicated
-# queries I gotta batch them myself. Filter arg count is a proxy, but it works.
-FILTER_BATCH_SIZE = int(environ.get("CODEX_FILTER_BATCH_SIZE", 990))
-VITE_HOST = environ.get("VITE_HOST", socket.gethostname())
+# sqlite parser breaks with more than 1000 variables in a query and
+# django only fixes this in the bulk_create & bulk_update functions.
+# So for complicated queries I gotta batch them myself. Filter arg
+# count is a proxy, but it works. 990 errors sometimes.
+FILTER_BATCH_SIZE = int(environ.get("CODEX_FILTER_BATCH_SIZE", 900))
+VITE_HOST = environ.get("VITE_HOST")
+
+####################################
+# Documented Environment Variables #
+####################################
+LOGLEVEL = get_loglevel(DEBUG)
+TZ = environ.get("TIMEZONE", environ.get("TZ"))
+CONFIG_PATH = Path(environ.get("CODEX_CONFIG_DIR", Path.cwd() / "config"))
+RESET_ADMIN = bool(environ.get("CODEX_RESET_ADMIN"))
+SKIP_INTEGRITY_CHECK = bool(environ.get("CODEX_SKIP_INTEGRITY_CHECK"))
+LOG_DIR = Path(environ.get("CODEX_LOG_DIR", CONFIG_PATH / "logs"))
+LOG_TO_CONSOLE = environ.get("CODEX_LOG_TO_CONSOLE") != "0"
+LOG_TO_FILE = environ.get("CODEX_LOG_TO_FILE") != "0"
+THROTTLE_ANON = int(environ.get("CODEX_THROTTLE_ANON", 0))
+THROTTLE_USER = int(environ.get("CODEX_THROTTLE_USER", 0))
+THROTTLE_OPDS = int(environ.get("CODEX_THROTTLE_OPDS", 0))
+THROTTLE_OPENSEARCH = int(environ.get("CODEX_THROTTLE_OPENSEARCH", 0))
+
+# Base paths
+BASE_DIR = Path(__file__).resolve().parent.parent.parent
+CODEX_PATH = BASE_DIR / "codex"
+CUSTOM_COVERS_SUBDIR = "custom-covers"
+CUSTOM_COVERS_DIR = CONFIG_PATH / CUSTOM_COVERS_SUBDIR
+CUSTOM_COVERS_GROUP_DIRS = ("publishers", "imprints", "series", "volumes", "story-arcs")
+for group_dir in CUSTOM_COVERS_GROUP_DIRS:
+    custom_cover_group_dir = CUSTOM_COVERS_DIR / group_dir
+    custom_cover_group_dir.mkdir(exist_ok=True, parents=True)
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = get_secret_key(CONFIG_PATH)
+
 
 if not DEBUG:
     LOGGING = {
@@ -247,6 +262,26 @@ SESSION_COOKIE_AGE = 60 * 60 * 24 * 60  # 60 days
 USE_X_FORWARDED_HOST = True
 SECURE_PROXY_SSL_HEADER = ("HTTP_X_FORWARDED_PROTO", "https")
 
+_THROTTLE_MAP = MappingProxyType(
+    {
+        "anon": ("rest_framework.throttling.AnonRateThrottle", THROTTLE_ANON),
+        "user": ("rest_framework.throttling.UserRateThrottle", THROTTLE_USER),
+        "opds": ("rest_framework.throttling.ScopedRateThrottle", THROTTLE_OPDS),
+        "opensearch": (
+            "rest_framework.throttling.ScopedRateThrottle",
+            THROTTLE_OPENSEARCH,
+        ),
+    }
+)
+_THROTTLE_CLASSES = set()
+_THROTTLE_RATES = {}
+for scope, value in _THROTTLE_MAP.items():
+    classname, rate_value = value
+    if rate_value or classname == "rest_framework.throttling.ScopedRateThrottle":
+        _THROTTLE_CLASSES.add(classname)
+        rate = f"{rate_value}/min" if value[1] else None
+        _THROTTLE_RATES[scope] = rate
+
 REST_FRAMEWORK = {
     "DEFAULT_AUTHENTICATION_CLASSES": (
         "rest_framework.authentication.SessionAuthentication",
@@ -256,12 +291,14 @@ REST_FRAMEWORK = {
         "djangorestframework_camel_case.render.CamelCaseBrowsableAPIRenderer",
     ),
     "DEFAULT_PARSER_CLASSES": (
-        "djangorestframework_camel_case.parser.CamelCaseFormParser",
-        "djangorestframework_camel_case.parser.CamelCaseMultiPartParser",
         "djangorestframework_camel_case.parser.CamelCaseJSONParser",
+        # "djangorestframework_camel_case.parser.CamelCaseFormParser",
+        # "djangorestframework_camel_case.parser.CamelCaseMultiPartParser",
     ),
     "DEFAULT_SCHEMA_CLASS": "drf_spectacular.openapi.AutoSchema",
     "EXCEPTION_HANDLER": "codex.views.error.codex_exception_handler",
+    "DEFAULT_THROTTLE_CLASSES": tuple(_THROTTLE_CLASSES),
+    "DEFAULT_THROTTLE_RATES": _THROTTLE_RATES,
 }
 
 REST_REGISTRATION = {
@@ -288,9 +325,18 @@ REST_REGISTRATION = {
 SPECTACULAR_SETTINGS = {
     "TITLE": "Codex API",
     "DESCRIPTION": "Comic Library Browser and Reader",
+    "OAS_VERSION": "3.1.0",
     "VERSION": "3.0.0",
-    "CONTACT": {"name": "Repository", "url": "https://github.com/ajslater/codex/"},
+    "CONTACT": {
+        "name": "Support",
+        "url": "https://github.com/ajslater/codex?tab=readme-ov-file#-support",
+    },
     "PREPROCESSING_HOOKS": ["codex.urls.spectacular.allow_list"],
+    "SERVE_PERMISSIONS": ["rest_framework.permissions.IsAdminUser"],
+    "EXTERNAL_DOCS": {
+        "url": "https://github.com/ajslater/codex/",
+        "description": "Codex Docs",
+    },
 }
 
 CORS_ALLOW_CREDENTIALS = True
@@ -305,9 +351,7 @@ CACHES = {
     },
 }
 
-INTERNAL_IPS = [
-    "127.0.0.1",
-]
+INTERNAL_IPS = ("127.0.0.1",)
 
 SEARCH_INDEX_PATH = CONFIG_PATH / "whoosh_index"
 SEARCH_INDEX_PATH.mkdir(exist_ok=True, parents=True)
@@ -325,10 +369,13 @@ CHANNEL_LAYERS = {
 }
 
 if DEBUG and not BUILD:
+    import socket
+
+    DEV_SERVER_HOST = VITE_HOST if VITE_HOST else socket.gethostname()
     DJANGO_VITE = {
         "default": {
             "dev_mode": DEBUG,
-            "dev_server_host": VITE_HOST,
+            "dev_server_host": DEV_SERVER_HOST,
         }
     }
 

codex/signals/django_signals.py

@@ -43,9 +43,15 @@ def _user_group_change(**kwargs):
     LIBRARIAN_QUEUE.put(task)
 
 
+# def _cache_invalidated(sender, **kwargs):
+#    """For cache debugging."""
+#    print(f"invalidated signal {sender}")
+
+
 def connect_signals():
     """Connect actions to signals."""
     logger = get_logger(__name__)
     connection_created.connect(_activate_wal_journal)
     logger.debug("sqlite journal_mode=wal")
     m2m_changed.connect(_user_group_change)
+    # post_invalidation.connect(_cache_invalidated)