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

codex/views/util.py

@@ -0,0 +1,77 @@
+"""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
+
+# Maximum cover size is around 24 Kb
+DEFAULT_CHUNK_SIZE = 64 * 1024  # 64 Kb
+
+
+@dataclass()
+class Route(dict):
+    """Breadcrumb, like a route."""
+
+    group: str
+    pks: tuple[int, ...]
+    page: int = 1
+    name: str = ""
+
+    def __eq__(self, cmp):
+        """Breadcrumb equality."""
+        return (
+            bool(cmp is not None)
+            and (self.group == cmp.group)
+            and (set(self.pks) == set(cmp.pks))
+            and (self.page == cmp.page)
+        )
+
+    def __and__(self, cmp):
+        """Breadcrumb intersection."""
+        return (
+            bool(cmp is not None)
+            and (self.group == cmp.group)
+            and (self.pks == cmp.pks or (set(self.pks) & set(cmp.pks)))
+        )
+
+    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
+
+
+async def chunker(open_file, chunk_size=DEFAULT_CHUNK_SIZE):
+    """Asynchronous iterator for serving files."""
+    while True:
+        chunk = open_file.read(chunk_size)
+        if not chunk:
+            open_file.close()
+            break
+        yield chunk

codex/views/version.py

@@ -1,13 +1,13 @@
 """Version View."""
 
-from rest_framework.generics import GenericAPIView
 from rest_framework.response import Response
 
 from codex.serializers.versions import VersionsSerializer
 from codex.version import PACKAGE_NAME, VERSION, get_latest_version
+from codex.views.auth import AuthGenericAPIView
 
 
-class VersionView(GenericAPIView):
+class VersionView(AuthGenericAPIView):
     """Return Codex Versions."""
 
     serializer_class = VersionsSerializer

codex/websockets/consumers.py

@@ -14,24 +14,28 @@ LOG = get_logger(__name__)
 class NotifierConsumer(AsyncWebsocketConsumer):
     """Base Notifier Consumer."""
 
-    @staticmethod
-    def _get_groups(user):
+    def _get_groups(self):
         """Dynamic groups by user type."""
         groups = [ChannelGroups.ALL.name]
-        if user.is_staff:
+        user = self.scope.get("user") if self.scope else None
+        user_channel = None
+        if user:
+            user_channel = f"user_{user.id}"
+        else:
+            session = self.scope.get("session")
+            if session:
+                user_channel = f"user_{session.session_key}"
+        if user_channel:
+            groups += [user_channel]
+        if user and user.is_staff:
             groups += [ChannelGroups.ADMIN.name]
         return groups
 
     async def websocket_connect(self, message):
         """Authorize with user and connect websocket to groups."""
         # Authorization
-        user = self.scope.get("user") if self.scope else None
-        if not user:
-            LOG.warning("Websockets not available for unregistered users.")
-            return
-
         # Set groups for user.
-        self.groups = self._get_groups(user)
+        self.groups = self._get_groups()
 
         await super().websocket_connect(message)
         LOG.debug(f"Websocket connected to {self.groups}")
@@ -44,6 +48,6 @@ class NotifierConsumer(AsyncWebsocketConsumer):
         """Send message to client."""
         text = event.get("text")
         if not text:
-            LOG.warning("No text in message")
+            LOG.warning(f"No text in websockets message: {event}")
             return
         await self.send(text)

{codex-1.5.17.dist-info → codex-1.6.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: codex
-Version: 1.5.17
+Version: 1.6.0
 Summary: A comic archive web server.
 Home-page: https://github.com/ajslater/codex
 License: GPL-3.0-only
@@ -26,24 +26,26 @@ Classifier: Topic :: Multimedia :: Graphics :: Viewers
 Requires-Dist: Pillow (>=10.0.0,<11.0.0)
 Requires-Dist: aioprocessing (>=2.0.1,<3.0.0)
 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.5,<2.0.0)
-Requires-Dist: django (>=5.0.3,<6.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)
-Requires-Dist: django-rest-registration (>=0.8.0,<0.9.0)
+Requires-Dist: django-rest-registration (>=0.8.3,<0.9.0)
 Requires-Dist: django-vite (>=3.0.1,<4.0.0)
-Requires-Dist: djangorestframework (>=3.11,<4.0)
-Requires-Dist: djangorestframework-camel-case (>=1.3.0,<2.0.0)
-Requires-Dist: drf-spectacular (>=0.27.0,<0.28.0)
+Requires-Dist: djangorestframework (>=3.15.1,<4.0.0)
+Requires-Dist: djangorestframework-camel-case (>=1.4.2,<2.0.0)
+Requires-Dist: drf-spectacular (>=0.27.2,<0.28.0)
 Requires-Dist: fnvhash (>=0.1,<0.2)
 Requires-Dist: humanfriendly (>=10.0,<11.0)
 Requires-Dist: humanize (>=4.0.0,<5.0.0)
-Requires-Dist: hypercorn[h3] (>=0.16.0,<0.17.0)
+Requires-Dist: hypercorn[h3] (>=0.17.3,<0.18.0)
 Requires-Dist: psutil (>=5.9.4,<6.0.0)
 Requires-Dist: python-dateutil (>=2.8.2,<3.0.0)
 Requires-Dist: requests (>=2.24,<3.0)
+Requires-Dist: setuptools (>=70.0.0,<71.0.0)
 Requires-Dist: tzlocal (>=5.0,<6.0)
 Requires-Dist: watchdog (>=4.0,<5.0)
 Requires-Dist: websocket_client (>=1.2,<2.0)
@@ -56,7 +58,7 @@ Project-URL: Repository, https://github.com/ajslater/codex
 Project-URL: Report Issues, https://github.com/ajslater/codex/issues
 Description-Content-Type: text/markdown
 
-Codex
+# Codex
 
 A comic archive browser and reader.
 
@@ -73,6 +75,7 @@ border-radius: 128px;
 - Filter and sort on all comic metadata and unread status per user.
 - Browse a tree of publishers, imprints, series, volumes, or your own folder
   hierarchy.
+- Add custom covers to Folders, Publishers, Imprints, Series, and Story Arcs.
 - Read comics in a variety of aspect ratios and directions that fit your screen.
 - Per user bookmarking. Per browser bookmarks even before you make an account.
 - Watches the filesystem and automatically imports new or changed comics.
@@ -318,10 +321,8 @@ index, a Django cache and comic book cover thumbnails.
 
 ### Environment Variables
 
-### Codex
+#### General
 
-- `LOGLEVEL` will change how verbose codex's logging is. Valid values are
-  `ERROR`, `WARNING`, `INFO`, `DEBUG`. The default is `INFO`.
 - `TIMEZONE` or `TZ` will explicitly set the timezone in long format (e.g.
   `"America/Los Angeles"`). This is useful inside Docker because codex cannot
   automatically detect the host machine's timezone.
@@ -331,16 +332,30 @@ index, a Django cache and comic book cover thumbnails.
   when codex starts.
 - `CODEX_SKIP_INTEGRITY_CHECK=1` will skip the database integrity repair that
   runs when codex starts.
+- `DEBUG_TRANSFORM` will show verbose information about how the comicbox library
+  reads all archive metadata sources and transforms it into a the comicbox
+  schema.
+
+#### Logging
+
+- `LOGLEVEL` will change how verbose codex's logging is. Valid values are
+  `ERROR`, `WARNING`, `INFO`, `DEBUG`. The default is `INFO`.
 - `CODEX_LOG_DIR` sets a custom directory for saving logfiles. Defaults to
   `$CODEX_CONFIG_DIR/logs`
 - `CODEX_LOG_TO_FILE=0` will not log to files.
 - `CODEX_LOG_TO_CONSOLE=0` will not log to the console.
 
-#### Comicbox
+#### Throttling
 
-- `DEBUG_TRANSFORM` will show verbose information about how the comicbox library
-  reads all archive metadata sources and transforms it into a the comicbox
-  schema.
+Codex contains some experimental throttling controls. The value supplied to
+these variables will be interpreted as the maximum number of allowed requests
+per minute. For example, the following settings would limit each described group
+to 2 queries per second.
+
+- `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
 
@@ -426,14 +441,17 @@ OPDS 2.0 book readers exist, but I am not yet aware of an OPDS 2.0 comic reader.
 
 #### Clients
 
-- iOS has [Panels](https://panels.app/), [KYBook 3](http://kybook-reader.com/),
-  and
+- iOS has [Panels](https://panels.app/), [PocketBooks](https://pocketbook.ch/),
+  [KYBook 3](http://kybook-reader.com/), and
   [Chunky Comic Reader](https://apps.apple.com/us/app/chunky-comic-reader/id663567628)
 - Android has
   [Moon+](https://play.google.com/store/apps/details?id=com.flyersoft.moonreader)
   and
   [Librera](https://play.google.com/store/apps/details?id=com.foobnix.pdf.reader)
 
+Kybook 3 does not seem to support http basic authentication, so Cbbodex users
+are not supported.
+
 #### HTTP Basic Authentication
 
 If you wish to access OPDS as your Codex User. You will have to add your