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

codex/views/browser/paginate.py

@@ -9,148 +9,63 @@ from codex.models import (
     Comic,
     Folder,
 )
-from codex.views.browser.annotations import BrowserAnnotationsView
+from codex.views.browser.page_in_bounds import BrowserPageInBoundsView
 from codex.views.const import (
     MAX_OBJ_PER_PAGE,
 )
-from codex.views.util import Route
 
 LOG = get_logger(__name__)
 
 
-class BrowserPaginateView(BrowserAnnotationsView):
-    """Browser pagination."""
-
-    def _get_back_one_page_route(self, num_pages):
-        """Get max page if oob or 1."""
-        LOG.debug("Redirect back one page.")
-        group = self.kwargs.get("group")
-        pks = self.kwargs.get("pks")
-        page = self.kwargs.get("page", 1)
-        new_page = num_pages if num_pages and page > num_pages else 1
-        pks = pks if pks else "0"
-        return {"group": group, "pks": pks, "page": new_page}
-
-    def _get_up_breadcrumbs(self):
-        """Walk up the breadcrumbs to get the next level up."""
-        breadcrumbs = self.params.get("breadcrumbs", [])
-        new_breadcrumbs = []
-        level = False
-        group = self.kwargs.get("group")
-        pks = self.kwargs.get("pks")
-        page = self.kwargs.get("page", 1)
-        current_route = Route(group=group, pks=pks, page=page)
-        for crumb in reversed(breadcrumbs):
-            if not level:
-                crumb_route = Route(**crumb)
-                level = current_route & crumb_route
-                continue
-            new_breadcrumbs = [crumb, *new_breadcrumbs]
-
-        if not new_breadcrumbs:
-            if group not in ("f", "a"):
-                group = "r"
-            top_route = {"group": group, "pks": (), "page": 1}
-            new_breadcrumbs = [top_route]
-        return new_breadcrumbs
-
-    def _get_up_page_redirect(self):
-        """Walk up the breadcrumbs."""
-        try:
-            up_breadcrumbs = self._get_up_breadcrumbs()
-            route_mask = up_breadcrumbs[-1]
-            settings_mask = {"breadcrumbs": up_breadcrumbs}
-            LOG.debug("Redirect up a level.")
-        except IndexError:
-            group = self.kwargs.get("group")
-            pks = "0"
-            new_page = 1
-            route_mask = {"group": group, "pks": pks, "page": new_page}
-            settings_mask = {"breadcrumbs": [route_mask]}
-            LOG.debug("Redirect to all at current group.")
-        return route_mask, settings_mask
-
-    def _check_page_in_bounds(self, total_count):
-        """Redirect page out of bounds."""
-        pks = self.kwargs.get("pks")
-        page = self.kwargs.get("page", 1)
-        num_pages = ceil(total_count / MAX_OBJ_PER_PAGE)
-        if page == 1 or (page >= 1 and page <= num_pages):
-            # Don't redirect if on the root page for the group.
-            # Or page within valid range.
-            return num_pages
-
-        group = self.kwargs.get("group")
-        reason = f"{group=} {pks=} {page=} does not exist."
-
-        # Adjust route mask for redirect
-        if num_pages and page > 1:
-            route_mask = self._get_back_one_page_route(num_pages)
-            settings_mask = None
-        else:
-            # This now only occurs when page < 1
-            route_mask, settings_mask = self._get_up_page_redirect()
-
-        return self.raise_redirect(
-            reason, route_mask=route_mask, settings_mask=settings_mask
-        )
+class BrowserPaginateView(BrowserPageInBoundsView):
+    """Paginate Groups and Books."""
 
     def _paginate_section(self, model, qs, page):
         """Paginate a group or Comic section."""
         orphans = 0 if self.model_group == "f" or self.params.get("q") else 5
         paginator = Paginator(qs, MAX_OBJ_PER_PAGE, orphans=orphans)
         try:
-            qs = paginator.page(page).object_list
+            paginator_page = paginator.page(page)
+            qs = paginator_page.object_list
         except EmptyPage:
             if model != Folder:
-                model_name = self.model.__name__ if self.model else "NO_MODEL"
+                model_name = self.model.__name__ if self.model else "UnknownGroup"
                 LOG.warning(f"No {model_name}s on page {page}")
             qs = model.objects.none()
 
         return qs
 
-    def _paginate_groups(self, group_qs, total_group_count):
+    def _paginate_groups(self, group_qs):
         """Paginate the group object list before books."""
-        if total_group_count:
-            page = self.kwargs.get("page", 1)
-            page_group_qs = self._paginate_section(self.model, group_qs, page)
-        else:
-            page_group_qs = self.model.objects.none()  # type: ignore
-        return page_group_qs
+        page = self.kwargs.get("page", 1)
+        return self._paginate_section(self.model, group_qs, page)
 
-    def _paginate_books(self, book_qs, total_group_count, page_obj_count):
+    def _paginate_books(self, book_qs, total_group_count, page_group_count):
         """Paginate the book object list based on how many group/folders are showing."""
-        if page_obj_count >= MAX_OBJ_PER_PAGE:
-            # No books for this page
-            page_book_qs = Comic.objects.none()
+        group_remainder = page_group_count % MAX_OBJ_PER_PAGE
+        num_books_on_mixed_page = MAX_OBJ_PER_PAGE - group_remainder
+        if page_group_count:
+            # There are books after the groups on the same page
+            # Add remainder books without the paginator
+            page_book_qs = book_qs[:num_books_on_mixed_page]
         else:
-            group_remainder = total_group_count % MAX_OBJ_PER_PAGE
-            if page_obj_count:
-                # There are books after the groups on the same page
-                # Manually add books without the paginator
-                book_limit = MAX_OBJ_PER_PAGE - group_remainder
-                page_book_qs = book_qs[:book_limit]
-            else:
-                # There are books after the groups on a new page
-                if group_remainder:
-                    book_offset = MAX_OBJ_PER_PAGE - group_remainder
-                    page_book_qs = book_qs[book_offset:]
-                else:
-                    page_book_qs = book_qs
+            # There are books after the groups on a new page
+            book_offset = 0 if group_remainder else num_books_on_mixed_page
+            page_book_qs = book_qs[book_offset:]
+
+            # Which book page are we on after groups?
+            page = self.kwargs.get("page", 1)
+            num_group_and_mixed_pages = ceil(total_group_count / MAX_OBJ_PER_PAGE)
+            book_only_page = page - num_group_and_mixed_pages
 
-                num_group_and_mixed_pages = ceil(total_group_count / MAX_OBJ_PER_PAGE)
-                book_only_page = self.kwargs.get("page", 1) - num_group_and_mixed_pages
-                page_book_qs = self._paginate_section(
-                    Comic, page_book_qs, book_only_page
-                )
+            page_book_qs = self._paginate_section(Comic, page_book_qs, book_only_page)
         return page_book_qs
 
-    def paginate(self, group_qs, book_qs, group_count, book_count):
+    def paginate(self, group_qs, book_qs, group_count):
         """Paginate the queryset into a group and book object lists."""
-        num_pages = self._check_page_in_bounds(group_count + book_count)
-        page_group_qs = self._paginate_groups(group_qs, group_count)
+        page_group_qs = self._paginate_groups(group_qs)
         page_group_count = page_group_qs.count()
         page_book_qs = self._paginate_books(book_qs, group_count, page_group_count)
         page_book_count = page_book_qs.count()
 
-        return page_group_qs, page_book_qs, num_pages, page_group_count, page_book_count
+        return page_group_qs, page_book_qs, page_group_count, page_book_count

codex/views/const.py

@@ -39,7 +39,6 @@ from codex.models import (
 )
 from codex.settings.settings import CODEX_PATH
 
-FALSY = {None, "", "false", "0", False}
 GROUP_NAME_MAP = MappingProxyType(
     {"p": "publisher", "i": "imprint", "s": "series", "v": "volume"}
 )

codex/views/opds/v1/feed.py

@@ -14,7 +14,8 @@ from codex.serializers.browser.settings import OPDSSettingsSerializer
 from codex.serializers.opds.v1 import (
     OPDS1TemplateSerializer,
 )
-from codex.views.const import FALSY, MAX_OBJ_PER_PAGE
+from codex.settings.settings import FALSY
+from codex.views.const import MAX_OBJ_PER_PAGE
 from codex.views.opds.auth import OPDSTemplateView
 from codex.views.opds.const import BLANK_TITLE, MimeType, UserAgentNames
 from codex.views.opds.util import get_user_agent_name

codex/views/opds/v2/feed.py

@@ -9,7 +9,8 @@ from codex.logger.logging import get_logger
 from codex.models import AdminFlag
 from codex.serializers.browser.settings import OPDSSettingsSerializer
 from codex.serializers.opds.v2 import OPDS2FeedSerializer
-from codex.views.const import FALSY, MAX_OBJ_PER_PAGE
+from codex.settings.settings import FALSY
+from codex.views.const import MAX_OBJ_PER_PAGE
 from codex.views.opds.auth import OPDSAuthMixin
 from codex.views.opds.const import BLANK_TITLE
 from codex.views.opds.v2.const import (

codex/views/opds/v2/links.py

@@ -6,8 +6,8 @@ from urllib.parse import parse_qsl, urlparse
 
 from django.urls import reverse
 
+from codex.settings.settings import FALSY
 from codex.views.browser.browser import BrowserView
-from codex.views.const import FALSY
 from codex.views.opds.const import MimeType, Rel
 from codex.views.opds.util import update_href_query_params
 from codex.views.util import pop_name

codex/views/reader/books.py

@@ -92,8 +92,8 @@ class ReaderBooksView(BookmarkFilterBaseView, ReaderInitView, SharedAnnotationsM
         arc_pks = self._get_reader_arc_pks(
             arc, arc_pk_select_related, prefetch_related, arc_pk_rel, arc_group
         )
-        nav_filter = {f"{rel}__in": arc_pks}
         group_acl_filter = self.get_group_acl_filter(Comic)
+        nav_filter = {f"{rel}__in": arc_pks}
 
         qs = Comic.objects.filter(group_acl_filter).filter(**nav_filter)
         if browser_filters := arc.get("filters"):

codex/views/reader/page.py

@@ -10,9 +10,9 @@ from rest_framework.exceptions import NotFound
 from rest_framework.negotiation import BaseContentNegotiation
 
 from codex.logger.logging import get_logger
-from codex.models import Comic
+from codex.models.comic import Comic, FileType
+from codex.settings.settings import FALSY
 from codex.views.bookmark import BookmarkBaseView
-from codex.views.const import FALSY
 from codex.views.util import chunker
 
 LOG = get_logger(__name__)
@@ -68,7 +68,7 @@ class ReaderPageView(BookmarkBaseView):
         comic = Comic.objects.filter(group_acl_filter).only("path").get(pk=pk)
         page = self.kwargs.get("page")
         to_pixmap = self.request.GET.get("pixmap", "").lower() not in FALSY
-        if comic.file_type == Comic.FileType.PDF.value and not to_pixmap:
+        if comic.file_type == FileType.PDF.value and not to_pixmap:
             content_type = _PDF_MIME_TYPE
         else:
             content_type = self.content_type

{codex-1.6.19.dist-info → codex-1.7.0a0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: codex
-Version: 1.6.19
+Version: 1.7.0a0
 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,15 @@ 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 a quick full database integrity check
+  on startup.
+- `CODEX_INTEGRITY_CHECK=full` will perform a more thorough 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 +510,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 +525,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>