codex 1.6.0a7__py3-none-any.whl → 1.6.0a9__py3-none-any.whl

codex/views/reader/books.py

@@ -1,6 +1,5 @@
 """Get Books methods."""
 
-from copy import deepcopy
 from typing import TYPE_CHECKING
 
 from django.db.models import F, IntegerField, Value
@@ -26,6 +25,10 @@ _COMIC_FIELDS = (
     "reading_direction",
     "updated_at",
 )
+_SHOW = {
+    "series": True,
+    "volume": True,
+}
 
 
 class ReaderBooksView(BookmarkBaseView, SessionView, SharedAnnotationsMixin):
@@ -75,7 +78,7 @@ class ReaderBooksView(BookmarkBaseView, SessionView, SharedAnnotationsMixin):
 
     def _get_comics_list(self):
         """Get the reader naviation group filter."""
-        select_related = ("series", "volume")
+        select_related = ("series",)
         prefetch_related = ()
 
         arc: Mapping = self.params.get("arc", {})  # type: ignore
@@ -134,13 +137,8 @@ class ReaderBooksView(BookmarkBaseView, SessionView, SharedAnnotationsMixin):
         )
         qs = self.annotate_group_names(qs, Comic)
         if arc_group == "s":
-            show = deepcopy(
-                self.get_from_session("show", session_key=self.BROWSER_SESSION_KEY)
-            )
-            show.pop("p", None)
-            show.pop("i", None)
             qs, comic_sort_names = self.alias_sort_names(
-                qs, Comic, pks=arc_pks, model_group="i", show=show
+                qs, Comic, pks=arc_pks, model_group="i", show=_SHOW
             )
             ordering = (
                 *comic_sort_names,
@@ -169,7 +167,7 @@ class ReaderBooksView(BookmarkBaseView, SessionView, SharedAnnotationsMixin):
         Yields 1 to 3 books
         """
         comics, arc_group = self._get_comics_list()
-        bookmark_filter = self.get_bookmark_filter()
+        bookmark_filter = self.get_bookmark_search_kwargs()
         books = {}
         prev_book = None
         pk = self.kwargs.get("pk")

codex/views/reader/reader.py

@@ -15,9 +15,11 @@ from codex.logger.logging import get_logger
 from codex.serializers.reader import ReaderArcSerializer, ReaderComicsSerializer
 from codex.serializers.redirect import ReaderRedirectSerializer
 from codex.views.reader.arcs import ReaderArcsView
+from codex.views.util import pop_name, reparse_json_query_params
 
 LOG = get_logger(__name__)
 _VALID_ARC_GROUPS = frozenset({"f", "s", "a"})
+_JSON_KEYS = frozenset({"arc"})
 
 
 class ReaderView(
@@ -46,26 +48,8 @@ class ReaderView(
         }
         raise NotFound(detail=detail)
 
-    def _parse_params(self):
-        data = self.request.GET
-        # Hack for query_parm parser
-        arc_data = MappingProxyType(
-            {"group": data.get("arc[group]"), "pks": data.get("arc[pks]")}
-        )
-        serializer = self.input_serializer_class(data=arc_data)
-        arc = {}
-        try:
-            serializer.is_valid()
-            arc: dict = serializer.validated_data  # type: ignore
-        except ValidationError:
-            pass
-
-        # PARAMS
-        top_group = self.get_from_session(
-            "top_group", "s", session_key=self.BROWSER_SESSION_KEY
-        )
-
-        # arc.group validation
+    def _validate_params(self, arc, top_group):
+        """arc.group validation."""
         # Can't be in the serializer
         arc_group = arc.get("group", "")
         if not arc_group:
@@ -78,6 +62,26 @@ class ReaderView(
         if arc_group not in _VALID_ARC_GROUPS:
             arc_group = None
 
+    def _parse_params(self):
+        data = self.request.GET
+        arc = {}
+        data = reparse_json_query_params(self.request.GET, _JSON_KEYS)
+        arc_data = data.get("arc", [])
+        if arc_data:
+            serializer = self.input_serializer_class(data=arc_data)
+            try:
+                serializer.is_valid()
+                arc: dict = serializer.validated_data  # type: ignore
+            except ValidationError:
+                pass
+
+        # From Browser Session
+        top_group = self.get_from_session(
+            "top_group", "s", session_key=self.BROWSER_SESSION_KEY
+        )
+
+        self._validate_params(arc, top_group)
+
         params = MappingProxyType(
             {
                 "arc": arc,
@@ -140,8 +144,7 @@ class ReaderView(
             arc["pks"] = (current.arc_pk,)  # type: ignore
         arc["index"] = current.arc_index  # type:ignore
         arc["count"] = current.arc_count  # type: ignore
-        close_route = self.last_route
-        close_route.pop("name", None)
+        close_route = pop_name(self.last_route)
 
         return {
             "books": books,

codex/views/session.py

@@ -7,6 +7,7 @@ from types import MappingProxyType
 from codex.logger.logging import get_logger
 from codex.serializers.choices import DEFAULTS
 from codex.views.auth import AuthFilterGenericAPIView
+from codex.views.util import pop_name
 
 LOG = get_logger(__name__)
 
@@ -62,8 +63,9 @@ class SessionView(AuthFilterGenericAPIView, ABC):
                 "q": DEFAULTS["q"],
                 "search_results_limit": DEFAULTS["searchResultsLimit"],
                 "show": DEFAULTS["show"],
-                "cover_style": DEFAULTS["coverStyle"],
-                "twenty_four_hour_time": False,
+                "dynamic_covers": DEFAULTS["dynamicCovers"],
+                "custom_covers": DEFAULTS["customCovers"],
+                "twenty_four_hour_time": DEFAULTS["twentyFourHourTime"],
                 "top_group": DEFAULTS["topGroup"],
             },
             READER_SESSION_KEY: {
@@ -96,7 +98,7 @@ class SessionView(AuthFilterGenericAPIView, ABC):
             breadcrumbs = DEFAULTS["breadcrumbs"]
         last_route = breadcrumbs[-1]
         if not name:
-            last_route.pop("name", None)
+            last_route = pop_name(last_route)
 
         return last_route
 

codex/views/util.py

@@ -1,6 +1,14 @@
 """Utility classes by many views."""
 
+import json
+from collections.abc import Mapping
+from contextlib import suppress
 from dataclasses import asdict, dataclass
+from json.decoder import JSONDecodeError
+from urllib.parse import unquote_plus
+
+from djangorestframework_camel_case.settings import api_settings
+from djangorestframework_camel_case.util import underscoreize
 
 
 @dataclass()
@@ -29,3 +37,27 @@ class Route(dict):
         )
 
     dict = asdict
+
+
+def reparse_json_query_params(query_params, keys) -> dict:
+    """Reparse JSON encoded query_params."""
+    # It is an unbelievable amount of trouble to try to parse axios native bracket
+    # encoded complex objects in python
+    parsed_dict = {}
+    for key, value in query_params.items():
+        if key in keys:
+            parsed_value = unquote_plus(value)
+            with suppress(JSONDecodeError):
+                parsed_value = json.loads(parsed_value)
+        else:
+            parsed_value = value
+
+        parsed_dict[key] = parsed_value
+    return dict(underscoreize(parsed_dict, **api_settings.JSON_UNDERSCOREIZE))  # type:ignore
+
+
+def pop_name(kwargs: Mapping):
+    """Pop name from a mapping route."""
+    kwargs = dict(kwargs)
+    kwargs.pop("name", None)
+    return kwargs

{codex-1.6.0a7.dist-info → codex-1.6.0a9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: codex
-Version: 1.6.0a7
+Version: 1.6.0a9
 Summary: A comic archive web server.
 Home-page: https://github.com/ajslater/codex
 License: GPL-3.0-only
@@ -29,7 +29,7 @@ Requires-Dist: ansicolors (>=1.1,<2.0)
 Requires-Dist: bidict (>=0.23.1,<0.24.0)
 Requires-Dist: case-converter (>=1.1.0,<2.0.0)
 Requires-Dist: channels (>=4.0.0,<5.0.0)
-Requires-Dist: comicbox[pdf] (>=1.1.7,<2.0.0)
+Requires-Dist: comicbox[pdf] (>=1.1.8,<2.0.0)
 Requires-Dist: django (>=5.0.6,<6.0.0)
 Requires-Dist: django-cachalot (>=2.6.2,<3.0.0)
 Requires-Dist: django-cors-headers (>=4.0,<5.0)
@@ -348,12 +348,13 @@ index, a Django cache and comic book cover thumbnails.
 
 Codex contains some experimental throttling controls. The value supplied to
 these variables will be interpreted as the maximum number of allowed requests
-per minute.
+per minute. For example, the following settings would limit each described group
+to 2 queries per second.
 
-- `CODEX_THROTTLE_ANON=60` Anonymous users
-- `CODEX_THROTTLE_USER=60` Authenticated users
-- `CODEX_THROTTLE_OPDS=60` The OPDS v1 & v2 APIs
-- `CODEX_THROTTLE_OPENSEARCH=60` The OPDS v1 Opensearch API
+- `CODEX_THROTTLE_ANON=30` Anonymous users
+- `CODEX_THROTTLE_USER=30` Authenticated users
+- `CODEX_THROTTLE_OPDS=30` The OPDS v1 & v2 APIs (Panels uses this for search)
+- `CODEX_THROTTLE_OPENSEARCH=30` The OPDS v1 Opensearch API
 
 ### Reverse Proxy