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

codex/views/reader/{init.py → params.py}

@@ -1,8 +1,9 @@
 """Views for reading comic books."""
 
-from copy import deepcopy
 from types import MappingProxyType
+from typing import Any
 
+from codex.choices import mapping_to_dict
 from codex.logger.logging import get_logger
 from codex.models import Comic
 from codex.serializers.reader import (
@@ -14,7 +15,7 @@ from codex.views.util import reparse_json_query_params
 
 LOG = get_logger(__name__)
 VALID_ARC_GROUPS = "pisvfa"
-_JSON_KEYS = frozenset({"arc", "breadcrumbs", "browser_arc", "show"})
+_JSON_KEYS = frozenset({"arc", "breadcrumbs", "browserArc", "show"})
 _BROWSER_SESSION_DEFAULTS = SessionView.SESSION_DEFAULTS[
     SessionView.BROWSER_SESSION_KEY
 ]
@@ -25,7 +26,7 @@ _DEFAULT_PARAMS = {
 }
 
 
-class ReaderInitView(SessionView):
+class ReaderParamsView(SessionView):
     """Reader initialization."""
 
     input_serializer_class = ReaderViewInputSerializer
@@ -33,9 +34,10 @@ class ReaderInitView(SessionView):
     def __init__(self, *args, **kwargs):
         """Initialize instance vars."""
         super().__init__(*args, **kwargs)
-        self.group_pks: dict[str, tuple[int, ...]] = {}
+        self._group_pks: dict[str, tuple[int, ...]] = {}
+        self._params: MappingProxyType[str, Any] | None = None
 
-    def _set_group_pks_from_breadcrumbs(self, groups, breadcrumbs):
+    def _get_group_pks_from_breadcrumbs(self, groups, breadcrumbs):
         """Set Multi-Group pks from breadcrumbs to the cache."""
         index = len(breadcrumbs) - 1
         min_index = max(index - 1, 0) if FOLDER_GROUP in groups else 0
@@ -44,29 +46,29 @@ class ReaderInitView(SessionView):
             crumb_group = crumb.get("group")
             if crumb_group in groups:
                 pks = crumb.get("pks", ())
-                self.group_pks[crumb_group] = pks
+                self._group_pks[crumb_group] = pks
                 break
             index -= 1
         else:
             crumb_group = ""
             pks = ()
             for group in groups:
-                self.group_pks[group] = pks
+                self._group_pks[group] = pks
         return crumb_group, pks
 
-    def get_group_pks_from_breadcrumbs(self, groups):
+    def get_group_pks_from_breadcrumbs(self, groups, params=None):
         """Get Multi-Group pks from the breadcrumbs."""
         # Return cached values
         for group in groups:
-            if pks := self.group_pks.get(group):
+            pks = self._group_pks.get(group)
+            if pks is not None:
                 return group, pks
 
-        # Validate input
-        breadcrumbs: tuple = self.params.get("breadcrumbs")  # type: ignore
-        if not breadcrumbs:
-            return "", ()
+        if params is None:
+            params = self.params
+        breadcrumbs: tuple = params.get("breadcrumbs", ())
 
-        return self._set_group_pks_from_breadcrumbs(groups, breadcrumbs)
+        return self._get_group_pks_from_breadcrumbs(groups, breadcrumbs)
 
     def _ensure_arc_contains_comic(self, params):
         """Arc sanity check."""
@@ -99,7 +101,7 @@ class ReaderInitView(SessionView):
             else:
                 search_groups = "vsip"
 
-            group, pks = self.get_group_pks_from_breadcrumbs(search_groups)
+            group, pks = self.get_group_pks_from_breadcrumbs(search_groups, params)
             if not group:
                 group = "s"
 
@@ -109,20 +111,24 @@ class ReaderInitView(SessionView):
 
         params["arc"] = arc
 
-    def _parse_params(self):
-        try:
-            data = self.request.GET
-            data = reparse_json_query_params(self.request.GET, _JSON_KEYS)
-            serializer = self.input_serializer_class(data=data)
-            serializer.is_valid(raise_exception=True)
-
-            params = deepcopy(_DEFAULT_PARAMS)
-            if serializer.validated_data:
-                params.update(serializer.validated_data)  # type: ignore
-            self._ensure_arc_contains_comic(params)
-            self._ensure_arc(params)
-
-            self.params = MappingProxyType(params)
-        except Exception:
-            LOG.exception("validate")
-            raise
+    @property
+    def params(self):
+        """Memoized params property."""
+        if self._params is None:
+            try:
+                data = self.request.GET
+                data = reparse_json_query_params(self.request.GET, _JSON_KEYS)
+                serializer = self.input_serializer_class(data=data)
+                serializer.is_valid(raise_exception=True)
+
+                params: dict = mapping_to_dict(_DEFAULT_PARAMS)  # type: ignore
+                if serializer.validated_data:
+                    params.update(serializer.validated_data)  # type: ignore
+                self._ensure_arc_contains_comic(params)
+                self._ensure_arc(params)
+
+                self._params = MappingProxyType(params)
+            except Exception:
+                LOG.exception("validate")
+                raise
+        return self._params

codex/views/reader/reader.py

@@ -58,7 +58,7 @@ class ReaderView(ReaderArcsView):
             task = LazyImportComicsTask(frozenset(import_pks))
             LIBRARIAN_QUEUE.put(task)
 
-    def get_object(self):
+    def get_object(self):  # type: ignore
         """Get the previous and next comics in a group or story arc."""
         # Books
         books = self.get_book_collection()
@@ -101,7 +101,6 @@ class ReaderView(ReaderArcsView):
     @extend_schema(parameters=[ReaderViewInputSerializer])
     def get(self, *args, **kwargs):
         """Get the book info."""
-        self._parse_params()
         obj = self.get_object()
         serializer = self.get_serializer(obj)
         return Response(serializer.data)

codex/views/session.py

@@ -4,77 +4,63 @@ from abc import ABC
 from copy import deepcopy
 from types import MappingProxyType
 
+from codex.choices import BROWSER_DEFAULTS, READER_DEFAULTS, mapping_to_dict
 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__)
 
+CONTRIBUTOR_PERSON_UI_FIELD = "contributors"
+STORY_ARC_UI_FIELD = "story_arcs"
+IDENTIFIER_TYPE_UI_FIELD = "identifier_type"
+
+_DYNAMIC_FILTER_DEFAULTS = MappingProxyType(
+    {
+        "age_rating": [],
+        "characters": [],
+        "country": [],
+        CONTRIBUTOR_PERSON_UI_FIELD: [],
+        "community_rating": [],
+        "critical_rating": [],
+        "decade": [],
+        "file_type": [],
+        "genres": [],
+        IDENTIFIER_TYPE_UI_FIELD: [],
+        "language": [],
+        "locations": [],
+        "monochrome": [],
+        "original_format": [],
+        "reading_direction": [],
+        "series_groups": [],
+        "stories": [],
+        STORY_ARC_UI_FIELD: [],
+        "tagger": [],
+        "tags": [],
+        "teams": [],
+        "year": [],
+    }
+)
+
 
 class SessionView(AuthFilterGenericAPIView, ABC):
     """Generic Session View."""
 
-    # Must override both of these
+    # Must override this
     SESSION_KEY = ""
-
-    CONTRIBUTOR_PERSON_UI_FIELD = "contributors"
-    STORY_ARC_UI_FIELD = "story_arcs"
-    IDENTIFIER_TYPE_UI_FIELD = "identifier_type"
-    _DYNAMIC_FILTER_DEFAULTS = MappingProxyType(
-        {
-            "age_rating": [],
-            "characters": [],
-            "country": [],
-            CONTRIBUTOR_PERSON_UI_FIELD: [],
-            "community_rating": [],
-            "critical_rating": [],
-            "decade": [],
-            "file_type": [],
-            "genres": [],
-            IDENTIFIER_TYPE_UI_FIELD: [],
-            "language": [],
-            "locations": [],
-            "monochrome": [],
-            "original_format": [],
-            "reading_direction": [],
-            "series_groups": [],
-            "stories": [],
-            STORY_ARC_UI_FIELD: [],
-            "tagger": [],
-            "tags": [],
-            "teams": [],
-            "year": [],
-        }
-    )
     FILTER_ATTRIBUTES = frozenset(_DYNAMIC_FILTER_DEFAULTS.keys())
     BROWSER_SESSION_KEY = "browser"
     READER_SESSION_KEY = "reader"
     SESSION_DEFAULTS = MappingProxyType(
         {
             BROWSER_SESSION_KEY: {
-                "breadcrumbs": DEFAULTS["breadcrumbs"],
+                **BROWSER_DEFAULTS,
                 "filters": {
-                    "bookmark": DEFAULTS["bookmarkFilter"],
+                    "bookmark": BROWSER_DEFAULTS["bookmark_filter"],
                     **_DYNAMIC_FILTER_DEFAULTS,
                 },
-                "order_by": DEFAULTS["orderBy"],
-                "order_reverse": DEFAULTS["orderReverse"],
-                "q": DEFAULTS["q"],
-                "search_results_limit": DEFAULTS["searchResultsLimit"],
-                "show": DEFAULTS["show"],
-                "dynamic_covers": DEFAULTS["dynamicCovers"],
-                "custom_covers": DEFAULTS["customCovers"],
-                "twenty_four_hour_time": DEFAULTS["twentyFourHourTime"],
-                "top_group": DEFAULTS["topGroup"],
-            },
-            READER_SESSION_KEY: {
-                "finish_on_last_page": DEFAULTS["finishOnLastPage"],
-                "fit_to": DEFAULTS["fitTo"],
-                "two_pages": DEFAULTS["twoPages"],
-                "read_rtl_in_reverse": DEFAULTS["readRtlInReverse"],
-                "reading_direction": DEFAULTS["readingDirection"],
             },
+            READER_SESSION_KEY: READER_DEFAULTS,
         }
     )
 
@@ -97,7 +83,8 @@ class SessionView(AuthFilterGenericAPIView, ABC):
             "breadcrumbs", session_key=self.BROWSER_SESSION_KEY
         )
         if not breadcrumbs:
-            breadcrumbs = DEFAULTS["breadcrumbs"]
+            default_breadcrumbs: tuple[dict] = BROWSER_DEFAULTS["breadcrumbs"]  # type: ignore
+            breadcrumbs = default_breadcrumbs
         last_route = breadcrumbs[-1]
         if not name:
             last_route = pop_name(last_route)
@@ -127,9 +114,11 @@ class SessionView(AuthFilterGenericAPIView, ABC):
             defaults = {}
             for key in only:
                 if key:
-                    defaults[key] = self.SESSION_DEFAULTS[session_key][key]
+                    defaults[key] = mapping_to_dict(
+                        self.SESSION_DEFAULTS[session_key][key]
+                    )
         else:
-            defaults = self.SESSION_DEFAULTS[session_key]
+            defaults = mapping_to_dict(self.SESSION_DEFAULTS[session_key])
 
         session = self.request.session.get(session_key, defaults)
         return self._get_source_values_or_set_defaults(defaults, session, {})
@@ -139,7 +128,7 @@ class SessionView(AuthFilterGenericAPIView, ABC):
         try:
             # Deepcopy this so serializing the values later later for http response doesn't alter them
             params = deepcopy(dict(params))
-            defaults = self.SESSION_DEFAULTS[self.SESSION_KEY]
+            defaults = mapping_to_dict(self.SESSION_DEFAULTS[self.SESSION_KEY])
             data = self._get_source_values_or_set_defaults(defaults, params, {})
             self.request.session[self.SESSION_KEY] = data
             self.request.session.save()

codex/views/timezone.py

@@ -0,0 +1,54 @@
+"""Set timezone from browser endpoint."""
+
+from drf_spectacular.utils import extend_schema
+from rest_framework.response import Response
+
+from codex.logger.logging import get_logger
+from codex.models import UserActive
+from codex.serializers.auth import TimezoneSerializer
+from codex.serializers.mixins import OKSerializer
+from codex.views.auth import AuthGenericAPIView
+
+LOG = get_logger(__name__)
+
+
+class TimezoneView(AuthGenericAPIView):
+    """User info."""
+
+    input_serializer_class = TimezoneSerializer
+    serializer_class = OKSerializer
+
+    def _save_timezone(self, django_timezone):
+        """Save django timezone in session."""
+        if not django_timezone:
+            return
+        session = self.request.session
+        session["django_timezone"] = django_timezone
+        session.save()
+
+    def _update_user_active(self):
+        """Update user activity."""
+        user = self.request.user
+        if user and user.is_authenticated:
+            UserActive.objects.update_or_create(user=user)
+
+    @extend_schema(request=input_serializer_class)
+    def put(self, *args, **kwargs):
+        """Get the user info for the current user."""
+        data = self.request.data  # type: ignore
+        serializer = self.input_serializer_class(data=data)
+        serializer.is_valid(raise_exception=True)
+        try:
+            self._save_timezone(serializer.validated_data.get("timezone"))  # type: ignore
+        except Exception as exc:
+            reason = f"update user timezone {exc}"
+            LOG.warning(reason)
+
+        try:
+            self._update_user_active()
+        except Exception as exc:
+            reason = f"update user activity {exc}"
+            LOG.warning(reason)
+
+        serializer = self.get_serializer()
+        return Response(serializer.data)

codex/views/version.py

@@ -15,7 +15,7 @@ class VersionView(AuthGenericAPIView):
 
     serializer_class = VersionsSerializer
 
-    def get_object(self):
+    def get_object(self) -> dict[str, str]:  # type: ignore
         """Get the versions."""
         ts = Timestamp.objects.get(key=Timestamp.TimestampChoices.CODEX_VERSION.value)
         if ts.version:

{codex-1.6.18.dist-info → codex-1.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: codex
-Version: 1.6.18
+Version: 1.7.0
 Summary: A comic archive web server.
 Home-page: https://github.com/ajslater/codex
 License: GPL-3.0-only
@@ -30,6 +30,7 @@ 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.2.0,<2.0.0)
+Requires-Dist: dateparser (>=1.2.0,<2.0.0)
 Requires-Dist: django (>=5.1.0,<6.0.0)
 Requires-Dist: django-cachalot (>=2.6.3,<3.0.0)
 Requires-Dist: django-cors-headers (>=4.0,<5.0)
@@ -43,15 +44,14 @@ Requires-Dist: humanfriendly (>=10.0,<11.0)
 Requires-Dist: humanize (>=4.0.0,<5.0.0)
 Requires-Dist: hypercorn[h3] (>=0.17.3,<0.18.0)
 Requires-Dist: psutil (>=6.0.0,<7.0.0)
+Requires-Dist: pyparsing (>=3.1.2,<4.0.0)
 Requires-Dist: python-dateutil (>=2.8.2,<3.0.0)
 Requires-Dist: requests (>=2.24,<3.0)
-Requires-Dist: setuptools (>=74.1.2,<75.0.0)
 Requires-Dist: tzlocal (>=5.0,<6.0)
 Requires-Dist: versio (>=0.5.0,<0.6.0)
 Requires-Dist: watchdog (>=5.0.2,<6.0.0)
 Requires-Dist: websocket_client (>=1.2,<2.0)
 Requires-Dist: whitenoise[brotli] (>=6.0,<7.0)
-Requires-Dist: whoosh-reloaded (>=2.7.5,<3.0.0)
 Project-URL: Documentation, https://github.com/ajslater/codex
 Project-URL: Docker Image, https://hub.docker.com/r/ajslater/codex
 Project-URL: News, https://github.com/ajslater/codex/blob/main/NEWS.md
@@ -145,7 +145,7 @@ before installing Codex.
 <!-- eslint-skip -->
 
 ```sh
-apt install build-essential libimagequant0 libjpeg-turbo8 libopenjp2-7 libssl libyaml-0-2 libtiff6 libwebp7 python3-dev python3-pip mupdf unrar zlib1g
+apt install build-essential libimagequant0 libjpeg-turbo8 libopenjp2-7 libssl libyaml-0-2 libtiff6 libwebp7 python3-dev python3-pip mupdf sqlite3 unrar zlib1g
 ```
 
 Versions of packages like libjpeg, libssl, libtiff may differ between flavors
@@ -164,7 +164,7 @@ apt-cache search libjpeg-turbo
 <!-- eslint-skip -->
 
 ```sh
-apk add bsd-compat-headers build-base jpeg-dev libffi-dev libwebp openssl-dev yaml-dev zlib-dev
+apk add bsd-compat-headers build-base jpeg-dev libffi-dev libwebp openssl-dev sqlite yaml-dev zlib-dev
 ```
 
 ##### Install unrar Runtime Dependency on non-debian Linux
@@ -182,7 +182,7 @@ Using [Homebrew](https://brew.sh/):
 <!-- eslint-skip -->
 
 ```sh
-brew install jpeg libffi libyaml libzip openssl python unrar webp
+brew install jpeg libffi libyaml libzip openssl python sqlite unrar webp
 ```
 
 ##### <a href="#windows">Windows</a> Dependencies
@@ -336,8 +336,12 @@ index, a Django cache and comic book cover thumbnails.
   `$CWD/config`
 - `CODEX_RESET_ADMIN=1` will reset the admin user and its password to defaults
   when codex starts.
-- `CODEX_SKIP_INTEGRITY_CHECK=1` will skip the database integrity repair that
-  runs when codex starts.
+- `CODEX_FIX_FOREIGN_KEYS=1` will check for and try to repair illegal foreign
+  keys on startup.
+- `CODEX_INTEGRITY_CHECK=1` will perform database integrity check on startup.
+- `CODEX_FTS_INTEGRITY_CHECK=1` will perform an integrity check on the full text
+  search index.
+- `CODEX_FTS_REBUILD=1` will rebuild the full text search index.
 - `DEBUG_TRANSFORM` will show verbose information about how the comicbox library
   reads all archive metadata sources and transforms it into a the comicbox
   schema.
@@ -503,7 +507,7 @@ you.
 
 ### Emergency Database Repair
 
-If the database becomes corrupt, Codex includes a facitlity to rebuild the
+If the database becomes corrupt, Codex includes a facility to rebuild the
 database. Place a file named `rebuild_db` in your Codex config directory like
 so:
 
@@ -518,7 +522,8 @@ Shut down and restart Codex.
 The next time Codex starts it will back up the existing database and try to
 rebuild it. The database lives in the config directory as the file
 `config/db.sqlite3`. If this procedure goes kablooey, you may recover the
-original database at `config/db.sqlite3.backup`.
+original database at `config/backups/codex.sqlite3.before-rebuild`. Codex will
+remove the `rebuild_db` file.
 
 ## <a name="alternatives-to-codex">📚Alternatives</a>