kmoe-manga-downloader 1.1.2__py3-none-any.whl → 1.2.1__py3-none-any.whl

kmdr/core/__init__.py

@@ -1,7 +1,9 @@
 from .bases import Authenticator, Lister, Picker, Downloader, Configurer
 from .structure import VolInfo, BookInfo, VolumeType
-from .bases import AUTHENTICATOR, LISTERS, PICKERS, DOWNLOADER, CONFIGURER
+from .bases import AUTHENTICATOR, LISTERS, PICKERS, DOWNLOADER, CONFIGURER, KMDR_SESSION
 
-from .defaults import argument_parser
+from .defaults import argument_parser, session_var
 
-from .error import KmdrError, LoginError
+from .error import KmdrError, LoginError
+
+from .session import KmdrSession

kmdr/core/bases.py

@@ -1,133 +1,107 @@
-import os
-
 from typing import Callable, Optional
+from abc import abstractmethod
+
+import asyncio
+from aiohttp import ClientSession
 
 from .error import LoginError
 from .registry import Registry
 from .structure import VolInfo, BookInfo
-from .utils import get_singleton_session, construct_callback
-from .defaults import Configurer as InnerConfigurer, UserProfile
-
-class SessionContext:
-
-    def __init__(self, *args, **kwargs):
-        super().__init__()
-        self._session = get_singleton_session()
-
-class UserProfileContext:
+from .utils import construct_callback, async_retry
 
-    def __init__(self, *args, **kwargs):
-        super().__init__()
-        self._profile = UserProfile()
-
-class ConfigContext:
-
-    def __init__(self, *args, **kwargs):
-        super().__init__()
-        self._configurer = InnerConfigurer()
+from .context import TerminalContext, SessionContext, UserProfileContext, ConfigContext
 
-class Configurer(ConfigContext):
+class Configurer(ConfigContext, TerminalContext):
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
     
+    @abstractmethod
     def operate(self) -> None: ...
 
-class Authenticator(SessionContext, ConfigContext, UserProfileContext):
+class Authenticator(SessionContext, ConfigContext, UserProfileContext, TerminalContext):
 
-    def __init__(self, proxy: Optional[str] = None, *args, **kwargs):
+    def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
-
-        if proxy:
-            self._session.proxies.update({
-                'https': proxy,
-                'http': proxy,
-            })
+        # 这里的 base url 可能会在认证过程中被更新
+        self._inner_base_url: Optional[str] = None
 
     # 在使用代理登录时，可能会出现问题，但是现在还不清楚是不是代理的问题。
     # 主站正常情况下不使用代理也能登录成功。但是不排除特殊的网络环境下需要代理。
     # 所以暂时保留代理登录的功能，如果后续确认是代理的问题，可以考虑启用 @no_proxy 装饰器。
     # @no_proxy
-    def authenticate(self) -> None:
-        try:
-            assert self._authenticate()
-        except LoginError as e:
-            print("Authentication failed. Please check your login credentials or session cookies.")
-            print(f"Details: {e}")
-            exit(1)
+    async def authenticate(self) -> None:
+        with self._console.status("认证中..."):
+            try:
+                # 这里添加了 base_url_setter，以便在重定向时更新 base_url
+                assert await async_retry(
+                    base_url_setter=self._configurer.set_base_url
+                )(self._authenticate)()
+
+                # 登录成功后，更新 base_url
+                self._base_url = self.base_url
+            except LoginError as e:
+                self._console.print("[red]认证失败。请检查您的登录凭据或会话 cookie。[/red]")
+                self._console.print(f"[yellow]详细信息：{e}[/yellow]")
+                exit(1)
+    
+    @property
+    def base_url(self) -> str:
+        return self._inner_base_url or self._configurer.base_url
 
-    def _authenticate(self) -> bool: ...
+    @abstractmethod
+    async def _authenticate(self) -> bool: ...
 
-class Lister(SessionContext):
+class Lister(SessionContext, TerminalContext):
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
 
-    def list(self) -> tuple[BookInfo, list[VolInfo]]: ...
+    @abstractmethod
+    async def list(self) -> tuple[BookInfo, list[VolInfo]]: ...
 
-class Picker(SessionContext):
+class Picker(TerminalContext):
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
 
+    @abstractmethod
     def pick(self, volumes: list[VolInfo]) -> list[VolInfo]: ...
 
-class Downloader(SessionContext, UserProfileContext):
+class Downloader(SessionContext, UserProfileContext, TerminalContext):
 
-    def __init__(self, 
-            dest: str = '.',
-            callback: Optional[str] = None,
-            retry: int = 3,
-            num_workers: int = 1,
-            proxy: Optional[str] = None,
-            *args, **kwargs
+    def __init__(self,
+                 dest: str = '.',
+                 callback: Optional[str] = None,
+                 retry: int = 3,
+                 num_workers: int = 8,
+                 *args, **kwargs
     ):
         super().__init__(*args, **kwargs)
+
         self._dest: str = dest
-        self._callback: Optional[Callable[[BookInfo, VolInfo], int]] = construct_callback(callback)
+        self._callback: Optional[Callable] = construct_callback(callback)
         self._retry: int = retry
-        self._num_workers: int = num_workers
-
-        if proxy:
-            self._session.proxies.update({
-                'https': proxy,
-                'http': proxy,
-            })
-
-    def download(self, book: BookInfo, volumes: list[VolInfo]):
-        if volumes is None or not volumes:
-            raise ValueError("No volumes to download")
+        self._semaphore = asyncio.Semaphore(num_workers)
 
-        if self._num_workers <= 1:
-            for volume in volumes:
-                self._download(book, volume, self._retry)
-        else:
-            self._download_with_multiple_workers(book, volumes, self._retry)
-
-    def _download(self, book: BookInfo, volume: VolInfo, retry: int): ...
-
-    def _download_with_multiple_workers(self, book: BookInfo, volumes: list[VolInfo], retry: int):
-        from concurrent.futures import ThreadPoolExecutor, wait, FIRST_EXCEPTION
+    async def download(self, book: BookInfo, volumes: list[VolInfo]):
+        if not volumes:
+            self._console.print("No volumes to download.")
+            exit(0)
 
         try:
-            max_workers = min(self._num_workers, len(volumes))
-            with ThreadPoolExecutor(max_workers=max_workers) as executor:
-                futures = [
-                    executor.submit(self._download, book, volume, retry)
-                    for volume in volumes
-                ]
-            wait(futures, return_when=FIRST_EXCEPTION)
-            for future in futures:
-                future.result()
+            with self._progress:
+                tasks = [self._download(book, volume) for volume in volumes]
+                await asyncio.gather(*tasks, return_exceptions=True)
+
         except KeyboardInterrupt:
-            print("\n操作已取消（KeyboardInterrupt）")
-            try:
-                executor.shutdown(wait=False, cancel_futures=True)
-            except NameError:
-                pass
-            finally:
-                exit(130)
+            self._console.print("\n操作已取消（KeyboardInterrupt）")
+            exit(130)
+
+    @abstractmethod
+    async def _download(self, book: BookInfo, volume: VolInfo): ...
 
+KMDR_SESSION = Registry[ClientSession]('KmdrSession', True)
 AUTHENTICATOR = Registry[Authenticator]('Authenticator')
 LISTERS = Registry[Lister]('Lister')
 PICKERS = Registry[Picker]('Picker')

kmdr/core/constants.py

@@ -0,0 +1,79 @@
+from dataclasses import dataclass
+from enum import Enum
+from typing_extensions import deprecated
+
+
+@dataclass(frozen=True)
+class _BaseUrl:
+
+    @property
+    @deprecated("KOX 已过时，请使用 KXO 或 KOZ。")
+    def KOX(self) -> str:
+        return 'https://kox.moe'
+    
+    @property
+    def KXX(self) -> str:
+        return 'https://kxx.moe'
+
+    @property
+    def KXO(self) -> str:
+        return 'https://kxo.moe'
+
+    @property
+    def KOZ(self) -> str:
+        return 'https://koz.moe'
+
+    @property
+    def MOX(self) -> str:
+        return 'https://mox.moe'
+
+    @property
+    def DEFAULT(self) -> str:
+        """默认基础 URL"""
+        return self.KXX
+
+
+@dataclass(frozen=True)
+class _ApiRoute():
+    PROFILE: str = '/my.php'
+    """用户信息页面"""
+
+    LOGIN: str = '/login.php'
+    """登录页面"""
+
+    LOGIN_DO: str = '/login_do.php'
+    """登录接口"""
+
+    MY_FOLLOW: str = '/myfollow.php'
+    """关注列表页面"""
+
+    BOOK_DATA: str = '/book_data.php'
+    """书籍数据接口"""
+
+    DOWNLOAD: str = '/dl/{book_id}/{volume_id}/1/2/{is_vip}/'
+    """下载接口"""
+
+    GETDOWNURL: str = '/getdownurl.php?b={book_id}&v={volume_id}&mobi=2&vip={is_vip}&json=1'
+    """获取下载链接接口"""
+
+
+class LoginResponse(Enum):
+    m100 = "登录成功。"
+
+    e400 = "帳號或密碼錯誤。"
+    e401 = "非法訪問，請使用瀏覽器正常打開本站。"
+    e402 = "帳號已經註銷。不會解釋原因，無需提問。"
+    e403 = "驗證失效，請刷新頁面重新操作。"
+
+    unknown = "未知响应代码。"
+
+    @classmethod
+    def from_code(cls, code: str) -> 'LoginResponse':
+        return cls.__members__.get(code, cls.unknown)
+
+
+API_ROUTE = _ApiRoute()
+"""API 路由常量实例"""
+
+BASE_URL = _BaseUrl()
+"""基础 URL 实例"""

kmdr/core/context.py

@@ -0,0 +1,40 @@
+from aiohttp import ClientSession
+
+
+from .defaults import Configurer as InnerConfigurer, UserProfile, session_var, progress, console, base_url_var
+
+class TerminalContext:
+
+    def __init__(self, *args, **kwargs):
+        super().__init__()
+        self._progress = progress
+        self._console = console
+
+class UserProfileContext:
+
+    def __init__(self, *args, **kwargs):
+        super().__init__()
+        self._profile = UserProfile()
+
+class ConfigContext:
+
+    def __init__(self, *args, **kwargs):
+        super().__init__()
+        self._configurer = InnerConfigurer()
+
+class SessionContext:
+
+    def __init__(self, *args, **kwargs):
+        super().__init__()
+
+    @property
+    def _session(self) -> ClientSession:
+        return session_var.get()
+
+    @property
+    def _base_url(self) -> str:
+        return base_url_var.get()
+
+    @_base_url.setter
+    def _base_url(self, value: str):
+        base_url_var.set(value)

kmdr/core/defaults.py

@@ -1,10 +1,47 @@
 import os
 import json
-from typing import Optional
+from typing import Optional, Any
 import argparse
+from contextvars import ContextVar
+from rich.console import Console
+from rich.progress import (
+    Progress,
+    BarColumn,
+    DownloadColumn,
+    TextColumn,
+    TransferSpeedColumn,
+    TimeRemainingColumn,
+)
 
 from .utils import singleton
 from .structure import Config
+from .constants import BASE_URL
+
+HEADERS = {
+    'User-Agent': 'kmdr/1.0 (https://github.com/chrisis58/kmoe-manga-downloader)'
+}
+
+console = Console()
+
+def console_print(*args, **kwargs):
+    console.print(*args, **kwargs)
+
+progress = Progress(
+    TextColumn("[blue]{task.fields[filename]}", justify="left"),
+    TextColumn("{task.fields[status]}", justify="right"),
+    TextColumn("{task.percentage:>3.1f}%"),
+    BarColumn(bar_width=None),
+    "[progress.percentage]",
+    DownloadColumn(),
+    "[",
+    TransferSpeedColumn(),
+    ",",
+    TimeRemainingColumn(),
+    "]",
+    console=console,
+)
+
+session_var = ContextVar('session')
 
 parser: Optional[argparse.ArgumentParser] = None
 args: Optional[argparse.Namespace] = None
@@ -14,33 +51,34 @@ def argument_parser():
     if parser is not None:
         return parser
 
-    parser = argparse.ArgumentParser(description='Kox Downloader')
-    subparsers = parser.add_subparsers(title='subcommands', dest='command')
-
-    download_parser = subparsers.add_parser('download', help='Download books')
-    download_parser.add_argument('-d', '--dest', type=str, help='Download destination, default to current directory', required=False)
-    download_parser.add_argument('-l', '--book-url', type=str, help='Book page\'s url', required=False)
-    download_parser.add_argument('-v', '--volume', type=str, help='Volume(s), split using commas, `all` for all', required=False)
-    download_parser.add_argument('-t', '--vol-type', type=str, help='Volume type, `vol` for volume, `extra` for extras, `seri` for serialized', required=False, choices=['vol', 'extra', 'seri', 'all'], default='vol')
-    download_parser.add_argument('--max-size', type=float, help='Max size of volume in MB', required=False)
-    download_parser.add_argument('--limit', type=int, help='Limit number of volumes to download', required=False)
-    download_parser.add_argument('--num-workers', type=int, help='Number of workers to use for downloading', required=False)
-    download_parser.add_argument('-p', '--proxy', type=str, help='Proxy server', required=False)
-    download_parser.add_argument('-r', '--retry', type=int, help='Retry times', required=False)
-    download_parser.add_argument('-c', '--callback', type=str, help='Callback script, use as `echo {v.name} downloaded!`', required=False)
-
-    login_parser = subparsers.add_parser('login', help='Login to kox.moe')
-    login_parser.add_argument('-u', '--username', type=str, help='Your username', required=True)
-    login_parser.add_argument('-p', '--password', type=str, help='Your password', required=False)
-
-    status_parser = subparsers.add_parser('status', help='Show status of account and script')
-    status_parser.add_argument('-p', '--proxy', type=str, help='Proxy server', required=False)
-
-    config_parser = subparsers.add_parser('config', help='Configure the downloader')
-    config_parser.add_argument('-l', '--list-option', action='store_true', help='List all configurations')
-    config_parser.add_argument('-s', '--set', nargs='+', type=str, help='Configuration options to set, e.g. num_workers=3 dest=.')
-    config_parser.add_argument('-c', '--clear', type=str, help='Clear configurations, `all`, `cookie`, `option` are available')
-    config_parser.add_argument('-d', '--delete', '--unset', dest='unset', type=str, help='Delete a specific configuration option')
+    parser = argparse.ArgumentParser(description='Kmoe 漫画下载器')
+    subparsers = parser.add_subparsers(title='可用的子命令', dest='command')
+
+    download_parser = subparsers.add_parser('download', help='下载指定的漫画')
+    download_parser.add_argument('-d', '--dest', type=str, help='指定下载文件的保存路径，默认为当前目录', required=False)
+    download_parser.add_argument('-l', '--book-url', type=str, help='漫画详情页面的 URL', required=False)
+    download_parser.add_argument('-v', '--volume', type=str, help='指定下载的卷，多个用逗号分隔，例如 `1,2,3` 或 `1-5,8`，`all` 表示全部', required=False)
+    download_parser.add_argument('-t', '--vol-type', type=str, help='指定下载的卷类型，`vol` 为单行本, `extra` 为番外, `seri` 为连载', required=False, choices=['vol', 'extra', 'seri', 'all'], default='vol')
+    download_parser.add_argument('--max-size', type=float, help='限制下载卷的最大体积 (单位: MB)', required=False)
+    download_parser.add_argument('--limit', type=int, help='限制下载卷的总数量', required=False)
+    download_parser.add_argument('--num-workers', type=int, help='下载时使用的并发任务数', required=False)
+    download_parser.add_argument('-p', '--proxy', type=str, help='设置下载使用的代理服务器', required=False)
+    download_parser.add_argument('-r', '--retry', type=int, help='网络请求失败时的重试次数', required=False)
+    download_parser.add_argument('-c', '--callback', type=str, help='每个卷下载完成后执行的回调脚本，例如: `echo {v.name} downloaded!`', required=False)
+
+    login_parser = subparsers.add_parser('login', help='登录到 Kmoe')
+    login_parser.add_argument('-u', '--username', type=str, help='用户名', required=True)
+    login_parser.add_argument('-p', '--password', type=str, help='密码 (如果留空，应用将提示您输入)', required=False)
+
+    status_parser = subparsers.add_parser('status', help='显示账户信息以及配额')
+    status_parser.add_argument('-p', '--proxy', type=str, help='代理服务器', required=False)
+
+    config_parser = subparsers.add_parser('config', help='配置下载器')
+    config_parser.add_argument('-l', '--list-option', action='store_true', help='列出所有配置')
+    config_parser.add_argument('-s', '--set', nargs='+', type=str, help='设置一个或多个配置项，格式为 `key=value`，例如: `num_workers=8`')
+    config_parser.add_argument('-b', '--base-url', type=str, help='设置镜像站点的基础 URL, 例如: `https://kxx.moe`')
+    config_parser.add_argument('-c', '--clear', type=str, help='清除指定配置，可选值为 `all`, `cookie`, `option`')
+    config_parser.add_argument('-d', '--delete', '--unset', dest='unset', type=str, help='删除特定的配置选项')
 
     return parser
 
@@ -101,6 +139,9 @@ class Configurer:
             cookie = config.get('cookie', None)
             if cookie is not None and isinstance(cookie, dict):
                 self._config.cookie = cookie
+            base_url = config.get('base_url', None)
+            if base_url is not None and isinstance(base_url, str):
+                self._config.base_url = base_url
 
     @property
     def config(self) -> 'Config':
@@ -126,12 +167,24 @@ class Configurer:
         return self._config.option
     
     @option.setter
-    def option(self, value: Optional[dict[str, any]]):
+    def option(self, value: Optional[dict[str, Any]]):
         if self._config is None:
             self._config = Config()
         self._config.option = value
         self.update()
     
+    @property
+    def base_url(self) -> str:
+        if self._config is None or self._config.base_url is None:
+            return BASE_URL.DEFAULT 
+        return self._config.base_url
+    
+    def set_base_url(self, value: str):
+        if self._config is None:
+            self._config = Config()
+        self._config.base_url = value
+        self.update()
+    
     def update(self):
         with open(os.path.join(os.path.expanduser("~"), self.__filename), 'w') as f:
             json.dump(self._config.__dict__, f, indent=4, ensure_ascii=False)
@@ -144,11 +197,11 @@ class Configurer:
         elif key == 'option':
             self._config.option = None
         else:
-            raise ValueError(f"Unsupported clear option: {key}")
+            raise KeyError(f"[red]对应配置不存在: {key}。可用配置项：all, cookie, option[/red]")
 
         self.update()
     
-    def set_option(self, key: str, value: any):
+    def set_option(self, key: str, value: Any):
         if self._config.option is None:
             self._config.option = {}
 
@@ -173,5 +226,11 @@ def __combine_args(dest: argparse.Namespace, option: dict) -> argparse.Namespace
 
 def combine_args(dest: argparse.Namespace) -> argparse.Namespace:
     assert isinstance(dest, argparse.Namespace), "dest must be an argparse.Namespace instance"
-    option = Configurer().config.option
-    return __combine_args(dest, option)
+    option = Configurer().option
+    
+    if option is None:
+        return dest
+
+    return __combine_args(dest, option)
+
+base_url_var = ContextVar('base_url', default=Configurer().base_url)

kmdr/core/error.py

@@ -5,11 +5,19 @@ class KmdrError(RuntimeError):
         super().__init__(message, *args, **kwargs)
         self.message = message
 
-        self._solution = "" if solution is None else "\nSuggested Solution: \n" + "\n".join(f">>> {sol}" for sol in solution)
+        self._solution = "" if solution is None else "\n[bold cyan]推荐解决方法:[/bold cyan] \n" + "\n".join(f"[cyan]>>> {sol}[/cyan]" for sol in solution)
 
 class LoginError(KmdrError):
     def __init__(self, message, solution: Optional[list[str]] = None):
         super().__init__(message, solution)
 
     def __str__(self):
-        return f"{self.message}\n{self._solution}"
+        return f"{self.message}\n{self._solution}"
+
+class RedirectError(KmdrError):
+    def __init__(self, message, new_base_url: str):
+        super().__init__(message)
+        self.new_base_url = new_base_url
+
+    def __str__(self):
+        return f"{self.message} 新的地址: {self.new_base_url}"

kmdr/core/session.py

@@ -0,0 +1,16 @@
+from typing import Optional
+
+from aiohttp import ClientSession
+
+from .bases import KMDR_SESSION
+from .defaults import session_var, HEADERS
+
+@KMDR_SESSION.register()
+class KmdrSession(ClientSession):
+    """
+    Kmdr 的 HTTP 会话管理类，支持从参数中初始化。简化 ClientSession 的使用。
+    """
+
+    def __init__(self, proxy: Optional[str] = None, *args, **kwargs):
+        ClientSession.__init__(self, proxy=proxy, trust_env=True, headers=HEADERS)
+        session_var.set(self)

kmdr/core/structure.py

@@ -66,3 +66,5 @@ class Config:
     """
 
     cookie: Optional[dict[str, str]] = None
+
+    base_url: Optional[str] = None

kmdr/core/utils.py

@@ -1,37 +1,14 @@
 import functools
 from typing import Optional, Callable
+import asyncio
+
+import aiohttp
 
-from requests import Session
-import threading
 import subprocess
 
 from .structure import BookInfo, VolInfo
+from .error import RedirectError
 
-_session_instance: Optional[Session] = None
-
-_session_lock = threading.Lock()
-
-HEADERS = {
-    'User-Agent': 'kmdr/1.0 (https://github.com/chrisis58/kmoe-manga-downloader)'
-}
-
-def get_singleton_session() -> Session:
-    global _session_instance
-
-    if _session_instance is None:
-        with _session_lock:
-            if _session_instance is None:
-                _session_instance = Session()
-                _session_instance.headers.update(HEADERS)
-
-    return _session_instance
-
-def clear_session_context():
-    session = get_singleton_session()
-    session.proxies.clear()
-    session.headers.clear()
-    session.cookies.clear()
-    session.headers.update(HEADERS)
 
 def singleton(cls):
     """
@@ -61,17 +38,41 @@ def construct_callback(callback: Optional[str]) -> Optional[Callable]:
 
     return _callback
 
-def no_proxy(func):
-    @functools.wraps(func)
-    def wrapper(*args, **kwargs):
-        session = get_singleton_session()
-
-        cached_proxies = session.proxies.copy()
-        session.proxies.clear()
-
-        try:
-            return func(*args, **kwargs)
-        finally:
-            session.proxies = cached_proxies
 
-    return wrapper
+def async_retry(
+    attempts: int = 3,
+    delay: float = 1.0,
+    backoff: float = 2.0,
+    retry_on_status: set[int] = {500, 502, 503, 504, 429, 408},
+    base_url_setter: Optional[Callable[[str], None]] = None,
+):
+    def decorator(func):
+        @functools.wraps(func)
+        async def wrapper(*args, **kwargs):
+            current_delay = delay
+            for attempt in range(attempts):
+                try:
+                    return await func(*args, **kwargs)
+                except aiohttp.ClientResponseError as e:
+                    if e.status in retry_on_status:
+                        if attempt == attempts - 1:
+                            raise
+                    else:
+                        raise
+                except (aiohttp.ClientError, asyncio.TimeoutError) as e:
+                    # 对于所有其他 aiohttp 客户端异常和超时，进行重试
+                    if attempt == attempts - 1:
+                        raise
+                except RedirectError as e:
+                    if base_url_setter:
+                        base_url_setter(e.new_base_url)
+                        print(f"检测到重定向，已自动更新 base url 为: {e.new_base_url}。立即重试...")
+                        continue
+                    else:
+                        raise
+                
+                await asyncio.sleep(current_delay)
+
+                current_delay *= backoff
+        return wrapper
+    return decorator