novel-downloader 1.5.0__py3-none-any.whl → 2.0.0__py3-none-any.whl

novel_downloader/core/fetchers/xs63b.py

@@ -0,0 +1,171 @@
+#!/usr/bin/env python3
+"""
+novel_downloader.core.fetchers.xs63b
+------------------------------------
+
+"""
+
+import asyncio
+import base64
+import re
+from typing import Any
+
+from novel_downloader.core.fetchers.base import BaseSession
+from novel_downloader.core.fetchers.registry import register_fetcher
+from novel_downloader.models import FetcherConfig
+from novel_downloader.utils import async_jitter_sleep
+
+
+@register_fetcher(
+    site_keys=["xs63b"],
+)
+class Xs63bSession(BaseSession):
+    """
+    A session class for interacting with the 小说路上 (m.xs63b.com) novel website.
+    """
+
+    BOOK_INFO_URL = "https://m.xs63b.com/{book_id}/"
+    BOOK_CATALOG_URL = "https://www.xs63b.com/{book_id}/"
+    CHAPTER_URL = "https://m.xs63b.com/{book_id}/{chapter_id}.html"
+
+    _JSARR_PATTERN = re.compile(r"var\s+jsarr\s*=\s*\[([^\]]+)\]")
+    _JSSTR_PATTERN = re.compile(r"var\s+jsstr\s*=\s*\"([^\"]+)\";")
+
+    def __init__(
+        self,
+        config: FetcherConfig,
+        cookies: dict[str, str] | None = None,
+        **kwargs: Any,
+    ) -> None:
+        super().__init__("xs63b", config, cookies, **kwargs)
+
+    async def get_book_info(
+        self,
+        book_id: str,
+        **kwargs: Any,
+    ) -> list[str]:
+        """
+        Fetch the raw HTML of the book info page asynchronously.
+
+        Order: [info, catalog]
+
+        :param book_id: The book identifier.
+        :return: The page content as string list.
+        """
+        book_id = book_id.replace("-", "/")
+        info_url = self.book_info_url(book_id=book_id)
+        catalog_url = self.book_catalog_url(book_id=book_id)
+
+        info_html, catalog_html = await asyncio.gather(
+            self.fetch(info_url, ssl=False, **kwargs),
+            self.fetch(catalog_url, ssl=False, **kwargs),
+        )
+        return [info_html, catalog_html]
+
+    async def get_book_chapter(
+        self,
+        book_id: str,
+        chapter_id: str,
+        **kwargs: Any,
+    ) -> list[str]:
+        """
+        Fetch the raw HTML of a single chapter asynchronously.
+
+        Order: [page1, ..., pageN]
+
+        :param book_id: The book identifier.
+        :param chapter_id: The chapter identifier.
+        :return: The page content as string list.
+        """
+        book_id = book_id.replace("-", "/")
+        html_pages: list[str] = []
+        chapter_url = self.chapter_url(book_id=book_id, chapter_id=chapter_id)
+
+        while True:
+            try:
+                html = await self.fetch(chapter_url, **kwargs)
+            except Exception as exc:
+                self.logger.warning(
+                    "[async] get_book_chapter(%s page %d) failed: %s",
+                    chapter_url,
+                    exc,
+                )
+                break
+
+            html_pages.append(html)
+            if "/xs635/mobile/images/nextpage.png" not in html:
+                break
+
+            jsarr = self._parse_jsarr(html)
+            jsstr = self._parse_jsstr(html)
+            chapter_url = self._build_chapter_url(book_id, jsarr, jsstr)
+
+            await async_jitter_sleep(
+                self.request_interval,
+                mul_spread=1.1,
+                max_sleep=self.request_interval + 2,
+            )
+
+        return html_pages
+
+    @classmethod
+    def book_info_url(cls, book_id: str) -> str:
+        """
+        Construct the URL for fetching a book's info page.
+
+        :param book_id: The identifier of the book.
+        :return: Fully qualified URL for the book info page.
+        """
+        return cls.BOOK_INFO_URL.format(book_id=book_id)
+
+    @classmethod
+    def book_catalog_url(cls, book_id: str) -> str:
+        """
+        Construct the URL for fetching a book's catalog page.
+
+        :param book_id: The identifier of the book.
+        :return: Fully qualified catalog page URL.
+        """
+        return cls.BOOK_CATALOG_URL.format(book_id=book_id)
+
+    @classmethod
+    def chapter_url(cls, book_id: str, chapter_id: str) -> str:
+        """
+        Construct the URL for fetching a specific chapter.
+
+        :param book_id: The identifier of the book.
+        :param chapter_id: The identifier of the chapter.
+        :return: Fully qualified chapter URL.
+        """
+        return cls.CHAPTER_URL.format(book_id=book_id, chapter_id=chapter_id)
+
+    @classmethod
+    def _parse_jsarr(cls, text: str) -> list[int]:
+        """
+        Extract jsarr from `var jsarr = [...];`.
+
+        Raises ValueError if not found.
+        """
+        m = cls._JSARR_PATTERN.search(text)
+        if not m:
+            raise ValueError("jsarr not found")
+        return [int(x) for x in m.group(1).split(",")]
+
+    @classmethod
+    def _parse_jsstr(cls, text: str) -> str:
+        """
+        Extract jsstr from `var jsstr = "...";`.
+
+        Raises ValueError if not found.
+        """
+        m = cls._JSSTR_PATTERN.search(text)
+        if not m:
+            raise ValueError("jsstr not found")
+        return m.group(1)
+
+    @staticmethod
+    def _build_chapter_url(book_id: str, jsarr: list[int], jsstr: str) -> str:
+        decoded = base64.b64decode(jsstr).decode("utf-8")
+        nnarr = list(decoded)
+        nnstr = "".join(nnarr[i] for i in jsarr)
+        return f"https://m.xs63b.com/{book_id}/{nnstr}.html"

novel_downloader/core/fetchers/xshbook.py

@@ -0,0 +1,85 @@
+#!/usr/bin/env python3
+"""
+novel_downloader.core.fetchers.xshbook
+--------------------------------------
+
+"""
+
+from typing import Any
+
+from novel_downloader.core.fetchers.base import BaseSession
+from novel_downloader.core.fetchers.registry import register_fetcher
+from novel_downloader.models import FetcherConfig
+
+
+@register_fetcher(
+    site_keys=["xshbook"],
+)
+class XshbookSession(BaseSession):
+    """
+    A session class for interacting with the 小说虎 (www.xshbook.com) novel website.
+    """
+
+    BOOK_INFO_URL = "https://www.xshbook.com/{book_id}/"
+    CHAPTER_URL = "https://www.xshbook.com/{book_id}/{chapter_id}.html"
+
+    def __init__(
+        self,
+        config: FetcherConfig,
+        cookies: dict[str, str] | None = None,
+        **kwargs: Any,
+    ) -> None:
+        super().__init__("xshbook", config, cookies, **kwargs)
+
+    async def get_book_info(
+        self,
+        book_id: str,
+        **kwargs: Any,
+    ) -> list[str]:
+        """
+        Fetch the raw HTML of the book info page asynchronously.
+
+        :param book_id: The book identifier.
+        :return: The page content as string list.
+        """
+        book_id = book_id.replace("-", "/")
+        url = self.book_info_url(book_id=book_id)
+        return [await self.fetch(url, **kwargs)]
+
+    async def get_book_chapter(
+        self,
+        book_id: str,
+        chapter_id: str,
+        **kwargs: Any,
+    ) -> list[str]:
+        """
+        Fetch the raw HTML of a single chapter asynchronously.
+
+        :param book_id: The book identifier.
+        :param chapter_id: The chapter identifier.
+        :return: The page content as string list.
+        """
+        book_id = book_id.replace("-", "/")
+        url = self.chapter_url(book_id=book_id, chapter_id=chapter_id)
+        return [await self.fetch(url, **kwargs)]
+
+    @classmethod
+    def book_info_url(cls, book_id: str) -> str:
+        """
+        Construct the URL for fetching a book's info page.
+
+        :param book_id: The identifier of the book.
+        :return: Fully qualified URL for the book info page.
+        """
+        return cls.BOOK_INFO_URL.format(book_id=book_id)
+
+    @classmethod
+    def chapter_url(cls, book_id: str, chapter_id: str) -> str:
+        """
+        Construct the URL for fetching a specific chapter.
+
+        :param book_id: The identifier of the book.
+        :param chapter_id: The identifier of the chapter.
+        :return: Fully qualified chapter URL.
+        """
+        return cls.CHAPTER_URL.format(book_id=book_id, chapter_id=chapter_id)

novel_downloader/core/fetchers/{yamibo/session.py → yamibo.py}

@@ -1,10 +1,11 @@
 #!/usr/bin/env python3
 """
-novel_downloader.core.fetchers.yamibo.session
----------------------------------------------
+novel_downloader.core.fetchers.yamibo
+-------------------------------------
 
 """
 
+from collections.abc import Mapping
 from typing import Any
 
 from lxml import html
@@ -12,16 +13,15 @@ from lxml import html
 from novel_downloader.core.fetchers.base import BaseSession
 from novel_downloader.core.fetchers.registry import register_fetcher
 from novel_downloader.models import FetcherConfig, LoginField
-from novel_downloader.utils import async_sleep_with_random_delay
+from novel_downloader.utils import async_jitter_sleep
 
 
 @register_fetcher(
     site_keys=["yamibo"],
-    backends=["session"],
 )
 class YamiboSession(BaseSession):
     """
-    A session class for interacting with the Yamibo (www.yamibo.com) novel website.
+    A session class for interacting with the 百合会 (www.yamibo.com) novel website.
     """
 
     BASE_URL = "https://www.yamibo.com"
@@ -69,7 +69,7 @@ class YamiboSession(BaseSession):
             ):
                 self._is_logged_in = True
                 return True
-            await async_sleep_with_random_delay(
+            await async_jitter_sleep(
                 self.backoff_factor,
                 mul_spread=1.1,
                 max_sleep=self.backoff_factor + 2,
@@ -87,7 +87,7 @@ class YamiboSession(BaseSession):
         Fetch the raw HTML of the book info page asynchronously.
 
         :param book_id: The book identifier.
-        :return: The page content as a string.
+        :return: The page content as string list.
         """
         url = self.book_info_url(book_id=book_id)
         return [await self.fetch(url, **kwargs)]
@@ -103,7 +103,7 @@ class YamiboSession(BaseSession):
 
         :param book_id: The book identifier.
         :param chapter_id: The chapter identifier.
-        :return: The chapter content as a string.
+        :return: The page content as string list.
         """
         url = self.chapter_url(book_id=book_id, chapter_id=chapter_id)
         return [await self.fetch(url, **kwargs)]
@@ -171,10 +171,6 @@ class YamiboSession(BaseSession):
         """
         return cls.CHAPTER_URL.format(book_id=book_id, chapter_id=chapter_id)
 
-    @property
-    def hostname(self) -> str:
-        return "www.yamibo.com"
-
     async def _api_login(self, username: str, password: str) -> bool:
         """
         Login to the API using a 2-step token-based process.
@@ -232,3 +228,14 @@ class YamiboSession(BaseSession):
         if not resp_text:
             return False
         return not any(kw in resp_text[0] for kw in keywords)
+
+    @staticmethod
+    def _filter_cookies(
+        raw_cookies: list[Mapping[str, Any]],
+    ) -> dict[str, str]:
+        ALLOWED_DOMAINS = {"www.yamibo.com", "bbs.yamibo.com", ""}
+        return {
+            c["name"]: c["value"]
+            for c in raw_cookies
+            if c.get("domain", "") in ALLOWED_DOMAINS
+        }

novel_downloader/core/fetchers/yibige.py

@@ -0,0 +1,114 @@
+#!/usr/bin/env python3
+"""
+novel_downloader.core.fetchers.yibige
+-------------------------------------
+
+"""
+
+import asyncio
+from typing import Any
+
+from novel_downloader.core.fetchers.base import BaseSession
+from novel_downloader.core.fetchers.registry import register_fetcher
+from novel_downloader.models import FetcherConfig
+
+
+@register_fetcher(
+    site_keys=["yibige"],
+)
+class YibigeSession(BaseSession):
+    """
+    A session class for interacting with the 一笔阁 (www.yibige.org) novel website.
+    """
+
+    BOOK_INFO_URL = "https://{base_url}/{book_id}/"
+    BOOK_CATALOG_URL = "https://{base_url}/{book_id}/index.html"
+    CHAPTER_URL = "https://{base_url}/{book_id}/{chapter_id}.html"
+
+    def __init__(
+        self,
+        config: FetcherConfig,
+        cookies: dict[str, str] | None = None,
+        **kwargs: Any,
+    ) -> None:
+        super().__init__("yibige", config, cookies, **kwargs)
+        self.base_url = (
+            "www.yibige.org" if config.locale_style == "simplified" else "tw.yibige.org"
+        )
+        # 主站: www.yibige.org
+        # 新加坡: sg.yibige.org
+        # 臺灣正體: tw.yibige.org
+        # 香港繁體: hk.yibige.org
+
+    async def get_book_info(
+        self,
+        book_id: str,
+        **kwargs: Any,
+    ) -> list[str]:
+        """
+        Fetch the raw HTML of the book info page asynchronously.
+
+        Order: [info, catalog]
+
+        :param book_id: The book identifier.
+        :return: The page content as string list.
+        """
+        info_url = self.book_info_url(base_url=self.base_url, book_id=book_id)
+        catalog_url = self.book_catalog_url(base_url=self.base_url, book_id=book_id)
+
+        info_html, catalog_html = await asyncio.gather(
+            self.fetch(info_url, **kwargs),
+            self.fetch(catalog_url, **kwargs),
+        )
+        return [info_html, catalog_html]
+
+    async def get_book_chapter(
+        self,
+        book_id: str,
+        chapter_id: str,
+        **kwargs: Any,
+    ) -> list[str]:
+        """
+        Fetch the raw HTML of a single chapter asynchronously.
+
+        :param book_id: The book identifier.
+        :param chapter_id: The chapter identifier.
+        :return: The page content as string list.
+        """
+        url = self.chapter_url(
+            base_url=self.base_url, book_id=book_id, chapter_id=chapter_id
+        )
+        return [await self.fetch(url, **kwargs)]
+
+    @classmethod
+    def book_info_url(cls, base_url: str, book_id: str) -> str:
+        """
+        Construct the URL for fetching a book's info page.
+
+        :param book_id: The identifier of the book.
+        :return: Fully qualified URL for the book info page.
+        """
+        return cls.BOOK_INFO_URL.format(base_url=base_url, book_id=book_id)
+
+    @classmethod
+    def book_catalog_url(cls, base_url: str, book_id: str) -> str:
+        """
+        Construct the URL for fetching a book's catalog page.
+
+        :param book_id: The identifier of the book.
+        :return: Fully qualified catalog page URL.
+        """
+        return cls.BOOK_CATALOG_URL.format(base_url=base_url, book_id=book_id)
+
+    @classmethod
+    def chapter_url(cls, base_url: str, book_id: str, chapter_id: str) -> str:
+        """
+        Construct the URL for fetching a specific chapter.
+
+        :param book_id: The identifier of the book.
+        :param chapter_id: The identifier of the chapter.
+        :return: Fully qualified chapter URL.
+        """
+        return cls.CHAPTER_URL.format(
+            base_url=base_url, book_id=book_id, chapter_id=chapter_id
+        )

novel_downloader/core/interfaces/__init__.py

@@ -3,15 +3,7 @@
 novel_downloader.core.interfaces
 --------------------------------
 
-This package centralizes the protocol definitions used across the
-system to promote interface-based design and type-safe dependency
-injection.
-
-Included protocols:
-- DownloaderProtocol
-- FetcherProtocol
-- ParserProtocol
-- ExporterProtocol
+Protocol interfaces defining the contracts for core components.
 """
 
 __all__ = [

novel_downloader/core/interfaces/downloader.py

@@ -3,10 +3,10 @@
 novel_downloader.core.interfaces.downloader
 -------------------------------------------
 
-This module defines the DownloaderProtocol, a structural interface
-that outlines the expected behavior of any downloader class.
+Protocol defining the interface for asynchronous book downloaders.
 """
 
+import asyncio
 from collections.abc import Awaitable, Callable
 from typing import Any, Protocol, runtime_checkable
 
@@ -27,6 +27,7 @@ class DownloaderProtocol(Protocol):
         book: BookConfig,
         *,
         progress_hook: Callable[[int, int], Awaitable[None]] | None = None,
+        cancel_event: asyncio.Event | None = None,
         **kwargs: Any,
     ) -> None:
         """
@@ -35,6 +36,7 @@ class DownloaderProtocol(Protocol):
         :param book: BookConfig with at least 'book_id'.
         :param progress_hook: Optional async callback after each chapter.
                                 args: completed_count, total_count.
+        :param cancel_event: Optional asyncio.Event to allow cancellation.
         """
         ...
 
@@ -43,6 +45,7 @@ class DownloaderProtocol(Protocol):
         books: list[BookConfig],
         *,
         progress_hook: Callable[[int, int], Awaitable[None]] | None = None,
+        cancel_event: asyncio.Event | None = None,
         **kwargs: Any,
     ) -> None:
         """
@@ -51,5 +54,6 @@ class DownloaderProtocol(Protocol):
         :param books: List of BookConfig entries.
         :param progress_hook: Optional async callback after each chapter.
                                 args: completed_count, total_count.
+        :param cancel_event: Optional asyncio.Event to allow cancellation.
         """
         ...

novel_downloader/core/interfaces/exporter.py

@@ -3,10 +3,10 @@
 novel_downloader.core.interfaces.exporter
 -----------------------------------------
 
-Defines the ExporterProtocol interface for persisting completed books in
-TXT, EPUB, Markdown, and PDF formats.
+Protocol defining the interface for exporting books to text, EPUB, and other formats.
 """
 
+from pathlib import Path
 from typing import Protocol, runtime_checkable
 
 
@@ -18,7 +18,7 @@ class ExporterProtocol(Protocol):
     It may also optionally implement an EPUB (or other format) exporter.
     """
 
-    def export(self, book_id: str) -> None:
+    def export(self, book_id: str) -> dict[str, Path]:
         """
         Export the book in the formats specified in config.
         If a method is not implemented or fails, log the error and continue.
@@ -27,7 +27,7 @@ class ExporterProtocol(Protocol):
         """
         ...
 
-    def export_as_txt(self, book_id: str) -> None:
+    def export_as_txt(self, book_id: str) -> Path | None:
         """
         Persist the assembled book as a .txt file.
 
@@ -35,7 +35,7 @@ class ExporterProtocol(Protocol):
         """
         ...
 
-    def export_as_epub(self, book_id: str) -> None:
+    def export_as_epub(self, book_id: str) -> Path | None:
         """
         Optional: Persist the assembled book as an .epub file.
 
@@ -43,7 +43,7 @@ class ExporterProtocol(Protocol):
         """
         ...
 
-    def export_as_md(self, book_id: str) -> None:
+    def export_as_md(self, book_id: str) -> Path | None:
         """
         Optional: Persist the assembled book as a Markdown (.md) file.
 
@@ -51,7 +51,7 @@ class ExporterProtocol(Protocol):
         """
         ...
 
-    def export_as_pdf(self, book_id: str) -> None:
+    def export_as_pdf(self, book_id: str) -> Path | None:
         """
         Optional: Persist the assembled book as a PDF file.
 

novel_downloader/core/interfaces/fetcher.py

@@ -3,8 +3,7 @@
 novel_downloader.core.interfaces.fetcher
 ----------------------------------------
 
-Defines the Async FetcherProtocol interface for fetching raw HTML or JSON
-for book info pages, individual chapters, managing request lifecycle
+Protocol defining the interface for asynchronous fetching, login, and session management
 """
 
 import types
@@ -32,6 +31,7 @@ class FetcherProtocol(Protocol):
     ) -> bool:
         """
         Attempt to log in asynchronously.
+
         :returns: True if login succeeded.
         """
         ...
@@ -45,7 +45,7 @@ class FetcherProtocol(Protocol):
         Fetch the raw HTML (or JSON) of the book info page asynchronously.
 
         :param book_id: The book identifier.
-        :return: The page content as a string.
+        :return: The page content as string list.
         """
         ...
 
@@ -60,7 +60,7 @@ class FetcherProtocol(Protocol):
 
         :param book_id: The book identifier.
         :param chapter_id: The chapter identifier.
-        :return: The chapter content as string.
+        :return: The page content as string list.
         """
         ...
 
@@ -126,19 +126,6 @@ class FetcherProtocol(Protocol):
         """
         ...
 
-    async def set_interactive_mode(self, enable: bool) -> bool:
-        """
-        Enable or disable interactive mode for manual login.
-
-        :param enable: True to enable, False to disable interactive mode.
-        :return: True if operation or login check succeeded, False otherwise.
-        """
-        ...
-
-    @property
-    def requester_type(self) -> str:
-        ...
-
     @property
     def is_logged_in(self) -> bool:
         """

novel_downloader/core/interfaces/parser.py

@@ -3,13 +3,12 @@
 novel_downloader.core.interfaces.parser
 ---------------------------------------
 
-Defines the ParserProtocol interface for extracting book metadata,
-parsing individual chapter content, and setting parser context via book_id.
+Protocol defining the interface for parsing book metadata and chapter content.
 """
 
 from typing import Any, Protocol, runtime_checkable
 
-from novel_downloader.models import ChapterDict
+from novel_downloader.models import BookInfoDict, ChapterDict
 
 
 @runtime_checkable
@@ -24,7 +23,7 @@ class ParserProtocol(Protocol):
         self,
         html_list: list[str],
         **kwargs: Any,
-    ) -> dict[str, Any]:
+    ) -> BookInfoDict | None:
         """
         Parse and return a dictionary of book information from the raw HTML.
 
@@ -40,10 +39,10 @@ class ParserProtocol(Protocol):
         **kwargs: Any,
     ) -> ChapterDict | None:
         """
-        Parse and return the text content of one chapter.
+        Parse chapter page and extract the content of one chapter.
 
         :param html_list: The HTML list of the chapter pages.
         :param chapter_id: Identifier of the chapter being parsed.
-        :return: The chapter's text.
+        :return: The chapter's data.
         """
         ...

novel_downloader/core/interfaces/searcher.py

@@ -3,10 +3,13 @@
 novel_downloader.core.interfaces.searcher
 -----------------------------------------
 
+Protocol defining the interface for site search implementations.
 """
 
 from typing import Protocol
 
+import aiohttp
+
 from novel_downloader.models import SearchResult
 
 
@@ -14,5 +17,10 @@ class SearcherProtocol(Protocol):
     site_name: str
 
     @classmethod
-    def search(cls, keyword: str, limit: int | None = None) -> list[SearchResult]:
+    def configure(cls, session: aiohttp.ClientSession) -> None:
+        """Configure the shared session"""
+        ...
+
+    @classmethod
+    async def search(cls, keyword: str, limit: int | None = None) -> list[SearchResult]:
         ...