kmoe-manga-downloader 1.2.0__py3-none-any.whl → 1.2.2__py3-none-any.whl

kmdr/core/__init__.py

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

kmdr/core/bases.py

@@ -7,7 +7,7 @@ from aiohttp import ClientSession
 from .error import LoginError
 from .registry import Registry
 from .structure import VolInfo, BookInfo
-from .utils import construct_callback
+from .utils import construct_callback, async_retry
 
 from .context import TerminalContext, SessionContext, UserProfileContext, ConfigContext
 
@@ -19,6 +19,14 @@ class Configurer(ConfigContext, TerminalContext):
     @abstractmethod
     def operate(self) -> None: ...
 
+class SessionManager(SessionContext, ConfigContext, TerminalContext):
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+    @abstractmethod
+    async def session(self) -> ClientSession: ...
+
 class Authenticator(SessionContext, ConfigContext, UserProfileContext, TerminalContext):
 
     def __init__(self, *args, **kwargs):
@@ -31,10 +39,10 @@ class Authenticator(SessionContext, ConfigContext, UserProfileContext, TerminalC
     async def authenticate(self) -> None:
         with self._console.status("认证中..."):
             try:
-                assert await self._authenticate()
+                assert await async_retry()(self._authenticate)()
             except LoginError as e:
-                self._console.print("[red]认证失败。请检查您的登录凭据或会话 cookie。[/red]")
                 self._console.print(f"[yellow]详细信息：{e}[/yellow]")
+                self._console.print("[red]认证失败。请检查您的登录凭据或会话 cookie。[/red]")
                 exit(1)
 
     @abstractmethod
@@ -74,7 +82,7 @@ class Downloader(SessionContext, UserProfileContext, TerminalContext):
 
     async def download(self, book: BookInfo, volumes: list[VolInfo]):
         if not volumes:
-            self._console.print("No volumes to download.")
+            self._console.print("没有可下载的卷。", style="blue")
             exit(0)
 
         try:
@@ -89,7 +97,7 @@ class Downloader(SessionContext, UserProfileContext, TerminalContext):
     @abstractmethod
     async def _download(self, book: BookInfo, volume: VolInfo): ...
 
-KMDR_SESSION = Registry[ClientSession]('KmdrSession', True)
+SESSION_MANAGER = Registry[SessionManager]('SessionManager', True)
 AUTHENTICATOR = Registry[Authenticator]('Authenticator')
 LISTERS = Registry[Lister]('Lister')
 PICKERS = Registry[Picker]('Picker')

kmdr/core/constants.py

@@ -0,0 +1,74 @@
+from dataclasses import dataclass
+from enum import Enum
+from typing import Union
+
+from typing_extensions import deprecated
+
+class BASE_URL(Enum):
+
+    @property
+    @deprecated("KOX 已过时，请使用 KXO 或 KOZ。")
+    def KOX(self) -> str:
+        return 'https://kox.moe'
+    
+    KXX = 'https://kxx.moe'
+
+    KXO = 'https://kxo.moe'
+
+    KOZ = 'https://koz.moe'
+
+    MOX = 'https://mox.moe'
+
+    @classmethod
+    def alternatives(cls) -> set[str]:
+        """返回备用的基础 URL 列表"""
+        return {cls.KXO.value, cls.KOZ.value, cls.MOX.value}
+
+    DEFAULT = 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)
+
+    @classmethod
+    def ok(cls, code: Union[str, 'LoginResponse']) -> bool:
+        if isinstance(code, LoginResponse):
+            return code == cls.m100
+        return cls.from_code(code) == cls.m100
+
+API_ROUTE = _ApiRoute()
+"""API 路由常量实例"""

kmdr/core/context.py

@@ -1,6 +1,7 @@
 from aiohttp import ClientSession
 
-from .defaults import Configurer as InnerConfigurer, UserProfile, session_var, progress, console
+
+from .defaults import Configurer as InnerConfigurer, UserProfile, session_var, progress, console, base_url_var
 
 class TerminalContext:
 
@@ -9,12 +10,6 @@ class TerminalContext:
         self._progress = progress
         self._console = console
 
-class SessionContext:
-
-    def __init__(self, *args, **kwargs):
-        super().__init__()
-        self._session: ClientSession = session_var.get()
-
 class UserProfileContext:
 
     def __init__(self, *args, **kwargs):
@@ -26,3 +21,24 @@ 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()
+    
+    @_session.setter
+    def _session(self, value: ClientSession):
+        session_var.set(value)
+
+    @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,6 +1,6 @@
 import os
 import json
-from typing import Optional
+from typing import Optional, Any
 import argparse
 from contextvars import ContextVar
 from rich.console import Console
@@ -15,6 +15,7 @@ from rich.progress import (
 
 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)'
@@ -75,6 +76,7 @@ def argument_parser():
     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='删除特定的配置选项')
 
@@ -137,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':
@@ -162,12 +167,27 @@ 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.value
+        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 get_base_url(self) -> str:
+        return self._config.base_url
+    
     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)
@@ -184,7 +204,7 @@ class Configurer:
 
         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 = {}
 
@@ -209,5 +229,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

@@ -7,9 +7,32 @@ class KmdrError(RuntimeError):
 
         self._solution = "" if solution is None else "\n[bold cyan]推荐解决方法:[/bold cyan] \n" + "\n".join(f"[cyan]>>> {sol}[/cyan]" for sol in solution)
 
+class InitializationError(KmdrError):
+    def __init__(self, message, solution: Optional[list[str]] = None):
+        super().__init__(message, solution)
+
+    def __str__(self):
+        return f"{self.message}\n{self._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}"
+
+class ResponseError(KmdrError):
+    def __init__(self, message, status_code: int):
+        super().__init__(message)
+        self.status_code = status_code
+
+    def __str__(self):
+        return f"{self.message} (状态码: {self.status_code})"

kmdr/core/protocol.py

@@ -0,0 +1,10 @@
+from typing import Protocol, TypeVar
+
+S = TypeVar('S', covariant=True)
+T = TypeVar('T', contravariant=True)
+
+class Supplier(Protocol[S]):
+    def __call__(self) -> S: ...
+
+class Consumer(Protocol[T]):
+    def __call__(self, value: T) -> None: ...

kmdr/core/session.py

@@ -1,16 +1,115 @@
 from typing import Optional
+from urllib.parse import urlsplit, urljoin
 
 from aiohttp import ClientSession
 
-from .bases import KMDR_SESSION
-from .defaults import session_var, HEADERS
+from .constants import BASE_URL, API_ROUTE
+from .utils import async_retry, PrioritySorter
+from .bases import SESSION_MANAGER, SessionManager
+from .defaults import HEADERS
+from .error import InitializationError, RedirectError
+from .protocol import Supplier
 
-@KMDR_SESSION.register()
-class KmdrSession(ClientSession):
+
+
+# 通常只会有一个 SessionManager 的实现
+# 因此这里直接注册为默认实现
+@SESSION_MANAGER.register()
+class KmdrSessionManager(SessionManager):
     """
-    Kmdr 的 HTTP 会话管理类，支持从参数中初始化。简化 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)
+    def __init__(self, proxy: Optional[str] = None, book_url: Optional[str] = None, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self._proxy = proxy
+
+        self._sorter = PrioritySorter[str]()
+        [self._sorter.set(alt) for alt in BASE_URL.alternatives()]
+        self._sorter.incr(BASE_URL.DEFAULT.value, 2)
+        self._sorter.incr(self._base_url, 5)
+
+        if book_url is not None and book_url.strip() != "" :
+            splited = urlsplit(book_url)
+            primary_base_url = f"{splited.scheme}://{splited.netloc}"
+
+            self._sorter.incr(primary_base_url, 10)
+
+    async def session(self) -> ClientSession:
+        try:
+            if self._session is not None and not self._session.closed:
+                # 幂等性检查：如果 session 已经存在且未关闭，直接返回
+                return self._session
+        except LookupError:
+            # session_var 尚未设置
+            pass
+
+        with self._console.status("初始化中..."):
+            
+            self._base_url = await self._probing_base_url()
+            # 持久化配置
+            self._configurer.set_base_url(self._base_url)
+
+            self._session = ClientSession(
+                base_url=self._base_url,
+                proxy=self._proxy,
+                trust_env=True,
+                headers=HEADERS,
+            )
+
+            return self._session
+    
+    async def validate_url(self, session: ClientSession, url_supplier: Supplier[str]) -> bool:
+        try:
+            async with session.head(
+                # 这里只请求登录页面的头信息保证快速响应
+                # 选择登录页面，一个是因为登录页面对所有用户都开放
+                # 另外是因为不同网站的登录页面通常是不同的，可以有效区分不同的网站
+                # 如果后续发现有更合适的探测方式，可以考虑替换
+                urljoin(url_supplier(), API_ROUTE.LOGIN),
+                allow_redirects=False
+            ) as response:
+                if response.status in (301, 302, 307, 308) and 'Location' in response.headers:
+                    new_location = urlsplit(response.headers['Location'])
+                    raise RedirectError("检测到重定向", new_base_url=f"{new_location.scheme}://{new_location.netloc}")
+
+                return response.status == 200
+        except Exception as e:
+            self._console.print(f"[yellow]无法连接到镜像: {url_supplier()}，错误信息: {e}[/yellow]")
+            return False
+
+    async def _probing_base_url(self) -> str:
+        """
+        探测可用的镜像地址。
+        顺序为：首选地址 -> 备用地址
+        当前首选地址不可用时，尝试备用地址，直到找到可用的地址或耗尽所有选项。
+        如果所有地址均不可用，则抛出 InitializationError 异常。
+
+        :raises InitializationError: 如果所有镜像地址均不可用。
+        :return: 可用的镜像地址。
+        """
+
+        ret_base_url: str
+    
+        def get_base_url() -> str:
+            nonlocal ret_base_url
+            return ret_base_url
+        
+        def set_base_url(value: str) -> None:
+            nonlocal ret_base_url
+            ret_base_url = value
+
+        async with ClientSession(proxy=self._proxy, trust_env=True, headers=HEADERS) as probe_session:
+            # TODO: 请求远程仓库中的镜像列表，并添加到 sorter 中
+
+            for bu in self._sorter.sort():
+                set_base_url(bu)
+
+                if await async_retry(
+                    base_url_setter=set_base_url,
+                    on_failure=lambda e: self._console.print(f"[yellow]无法连接到镜像: {get_base_url()}，错误信息: {e}[/yellow]"),
+                )(self.validate_url)(probe_session, get_base_url):
+                    return get_base_url()
+
+            raise InitializationError(f"所有镜像均不可用，请检查您的网络连接或使用其他镜像。\n详情参考：https://github.com/chrisis58/kmoe-manga-downloader/blob/main/mirror/mirrors.json")
+

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,13 +1,14 @@
 import functools
-from typing import Optional, Callable
+from typing import Optional, Callable, TypeVar, Hashable, Generic
 import asyncio
 
 import aiohttp
 
-from deprecation import deprecated
 import subprocess
 
 from .structure import BookInfo, VolInfo
+from .error import RedirectError
+from .protocol import Consumer
 
 
 def singleton(cls):
@@ -43,7 +44,9 @@ 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}
+    retry_on_status: set[int] = {500, 502, 503, 504, 429, 408},
+    base_url_setter: Optional[Consumer[str]] = None,
+    on_failure: Optional[Callable[[Exception], None]] = None
 ):
     def decorator(func):
         @functools.wraps(func)
@@ -62,9 +65,63 @@ def async_retry(
                     # 对于所有其他 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
+                except Exception as e:
+                    if on_failure:
+                        on_failure(e)
+                        break
+                    else:
+                        raise
                 
                 await asyncio.sleep(current_delay)
 
                 current_delay *= backoff
         return wrapper
-    return decorator
+    return decorator
+
+
+H = TypeVar('H', bound=Hashable)
+class PrioritySorter(Generic[H]):
+    """
+    根据优先级对元素进行排序的工具类
+    """
+
+    DEFAULT_ORDER = 10
+
+    def __init__(self):
+        self._items: dict[H, int] = {}
+
+    def __repr__(self) -> str:
+        return f"PrioritySorter({self._items})"
+
+    def get(self, key: H) -> Optional[int]:
+        """获取对应元素的优先级"""
+        return self._items.get(key)
+
+    def set(self, key: H, value: int = DEFAULT_ORDER) -> None:
+        """设置对应元素的优先级"""
+        self._items[key] = value
+
+    def remove(self, key: H) -> None:
+        """移除对应元素"""
+        self._items.pop(key, None)
+
+    def incr(self, key: H, offset: int = 1) -> None:
+        """提升对应元素的优先级"""
+        current_value = self._items.get(key, self.DEFAULT_ORDER)
+        self._items[key] = current_value + offset
+
+    def decr(self, key: H, offset: int = 1) -> None:
+        """降低对应元素的优先级"""
+        current_value = self._items.get(key, self.DEFAULT_ORDER)
+        self._items[key] = current_value - offset
+
+    def sort(self) -> list[H]:
+        """返回根据优先级排序后的元素列表，优先级高的元素排在前面"""
+        return [k for k, v in sorted(self._items.items(), key=lambda item: item[1], reverse=True)]

kmdr/main.py

@@ -11,8 +11,7 @@ async def main(args: Namespace, fallback: Callable[[], None] = lambda: print('NO
         CONFIGURER.get(args).operate()
         return
 
-    async with KMDR_SESSION.get(args):
-
+    async with (await SESSION_MANAGER.get(args).session()):
         if args.command == 'login':
             await AUTHENTICATOR.get(args).authenticate()
 
@@ -41,8 +40,11 @@ def entry_point():
 
         main_coro = main(args, lambda: parser.print_help())
         asyncio.run(main_coro)
+    except KmdrError as e:
+        console.print(f"[red]错误: {e}[/red]")
+        exit(1)
     except KeyboardInterrupt:
-        print("\n操作已取消（KeyboardInterrupt）")
+        console.print("\n操作已取消（KeyboardInterrupt）", style="yellow")
         exit(130)
 
 if __name__ == '__main__':

kmdr/module/__init__.py

@@ -1,5 +1,5 @@
-from .authenticator import CookieAuthenticator, LoginAuthenticator
-from .lister import BookUrlLister, FollowedBookLister
-from .picker import ArgsFilterPicker, DefaultVolPicker
-from .downloader import DirectDownloader, ReferViaDownloader
-from .configurer import OptionLister, OptionSetter, ConfigClearer, ConfigUnsetter
+from .authenticator import *
+from .lister import *
+from .picker import *
+from .downloader import *
+from .configurer import *

kmdr/module/authenticator/CookieAuthenticator.py

@@ -5,7 +5,6 @@ from yarl import URL
 from kmdr.core import Authenticator, AUTHENTICATOR, LoginError
 
 from .utils import check_status
-from .utils import PROFILE_URL
 
 @AUTHENTICATOR.register()
 class CookieAuthenticator(Authenticator):
@@ -22,12 +21,12 @@ class CookieAuthenticator(Authenticator):
         
         if not cookie:
             raise LoginError("无法找到 Cookie，请先完成登录。", ['kmdr login -u <username>'])
-        
-        self._session.cookie_jar.update_cookies(cookie, response_url=URL(PROFILE_URL))
+
+        self._session.cookie_jar.update_cookies(cookie, response_url=URL(self._base_url))
         return await check_status(
             self._session,
             self._console,
             show_quota=self._show_quota,
             is_vip_setter=lambda value: setattr(self._profile, 'is_vip', value),
             level_setter=lambda value: setattr(self._profile, 'user_level', value),
-        )
+        )

kmdr/module/authenticator/LoginAuthenticator.py

@@ -1,20 +1,14 @@
 from typing import Optional
 import re
+from yarl import URL
 
 from rich.prompt import Prompt
 
 from kmdr.core import Authenticator, AUTHENTICATOR, LoginError
+from kmdr.core.constants import API_ROUTE, LoginResponse
 
 from .utils import check_status
 
-CODE_OK = 'm100'
-
-CODE_MAPPING = {
-    'e400': "帳號或密碼錯誤。",
-    'e401': "非法訪問，請使用瀏覽器正常打開本站",
-    'e402': "帳號已經註銷。不會解釋原因，無需提問。",
-    'e403': "驗證失效，請刷新頁面重新操作。",
-}
 
 @AUTHENTICATOR.register(
     hasvalues = {'command': 'login'}
@@ -33,7 +27,7 @@ class LoginAuthenticator(Authenticator):
     async def _authenticate(self) -> bool:
 
         async with self._session.post(
-            url = 'https://kox.moe/login_do.php', 
+            url = API_ROUTE.LOGIN_DO,
             data = {
                 'email': self._username,
                 'passwd': self._password,
@@ -42,17 +36,20 @@ class LoginAuthenticator(Authenticator):
         ) as response:
 
             response.raise_for_status()
+
             match = re.search(r'"\w+"', await response.text())
 
             if not match:
                 raise LoginError("无法解析登录响应。")
             
             code = match.group(0).split('"')[1]
-            if code != CODE_OK:
-                raise LoginError(f"认证失败，错误代码：{code} " + CODE_MAPPING.get(code, "未知错误。"))
+
+            login_response = LoginResponse.from_code(code)
+            if not LoginResponse.ok(login_response):
+                raise LoginError(f"认证失败，错误代码：{login_response.name} {login_response.value}" )
 
             if await check_status(self._session, self._console, show_quota=self._show_quota):
-                cookie = self._session.cookie_jar.filter_cookies('https://kox.moe')
+                cookie = self._session.cookie_jar.filter_cookies(URL(self._base_url))
                 self._configurer.cookie = {key: morsel.value for key, morsel in cookie.items()}
 
                 return True

kmdr/module/authenticator/__init__.py

@@ -0,0 +1,2 @@
+from .CookieAuthenticator import CookieAuthenticator
+from .LoginAuthenticator import LoginAuthenticator