This repository has been archived on 2026-10-02. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
NeteaseUrl/web/routers/admin.py
T
snowy-yang 095171e0b7 refactor: 两个根级游离模块并入 music_api 包,消除分层倒置
为什么:podcast_api.py(560 行) 与 qr_login.py(397 行) 既不属于任何包、也不是
入口脚本,却同时被 services 层与 web 层引用——`services/downloads.py` 直接
`from qr_login import ...`、`services/podcast.py` 直接 `import podcast_api`,
业务层反向依赖顶层游离模块,是本次架构体检里唯一的无争议分层倒置。
两者本就依赖 music_api(前者取 url_v1/APIConstants/APIException,后者取
QRLoginManager),与 music_api 下已有的 qr.py / compat.py 是同一层的同类物。

迁移(git 保留重命名历史):
- podcast_api.py -> music_api/podcast.py
- qr_login.py    -> music_api/qr_client.py

**命名避让**:不叫 music_api/qr_login.py——music_api/__init__ 已经从 .compat
导出了一个**同名函数** qr_login,同名子模块会与之互相遮蔽。改叫 qr_client
(其核心导出即 QRLoginClient),并在验证里专门确认 music_api.qr_login 仍是
可调用函数、music_api.podcast 是模块,两者不冲突。

内部导入顺带改为精确子模块,不再绕道包门面:
- podcast.py:from music_api import APIConstants/APIException/url_v1
  → from .compat import url_v1 / from .constants import ... / from .errors import ...
- qr_client.py:删掉那层 try/except ImportError 包装(它给的是「请确保
  music_api.py 文件存在」这类顶层脚本时代的提示,作为包内模块已无意义),
  改 from .cookies/.errors/.qr 相对导入
- CLI 用法文本 python qr_login.py → python -m music_api.qr_client
  (相对导入后直接跑脚本会失败,必须走 -m;全仓确认无脚本/文档引用旧入口)
- 路径安全性已核对:qr_client 用的是 CWD 相对的 cookie.txt,不是 __file__ 相对,
  迁移不改其解析结果

引用点全部更新(AST 扫描确认覆盖全集,替换后残留 0):
- podcast:services/podcast.py(1 + 5 处调用) · web/routers/podcast.py(1 + 6)
  · web/routers/download.py(2 处函数内 + 3),导入名统一为 `podcast`
- qr_login:services/downloads.py · web/routers/admin.py · web/routers/user.py(×2)
- services/__init__.py 依赖自检列表去掉这两个名字(已并入 music_api)
- pyproject include 去掉两个顶层文件名(music_api 目录已覆盖)

验证:
- 11 + 3 个符号在新位置全部 hasattr 通过;podcast_api / qr_login 已
  ModuleNotFoundError;6 个调用方模块均可 import;services 依赖自检仍生效
- 门禁:ruff 0 · pyright 0 errors/0 warnings · pytest 184 passed
- 真实 uvicorn 冒烟 10/10,含 /podcast/parse 与 /podcast/hot 返回 401
  (模块导入失败会是 500,路由缺失会是 404,401 证明两者都正常)
- 生产 data/ 指纹 before == after
2026-09-26 15:03:47 +08:00

183 lines
7.0 KiB
Python
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# -*- coding: utf-8 -*-
"""管理员扫码登录 / Cookie 管理 / 操作记录。
端点:
- POST /api/v1/admin/qr/create ↔ Flask /admin/qr/create
- POST /api/v1/admin/qr/check ↔ Flask /admin/qr/check
- POST /api/v1/admin/cookie/status ↔ Flask /admin/cookie/status
- POST /api/v1/admin/cookie/delete ↔ Flask /admin/cookie/delete
- POST /api/v1/admin/logs ↔ Flask /admin/logs
鉴权:管理员密码闸(文案"需要管理员权限,请使用管理员账号登录"),
与 auth_system.admin_required 的文案不同,故本模块用本地 admin 闸保持逐字对齐。
说明:QRLoginManager 已异步化(直接 await);QRLoginClient 的 save_cookie/logout/
_get_cookie_info 仍为同步文件操作,经 asyncio.to_thread 执行。
"""
import asyncio
import logging
from typing import Annotated
from fastapi import APIRouter, Depends, Request
from core.state import GLOBAL_MUSIC_U_CACHE, REQ_LOG, VIP_CACHE
from web import ratelimit
from web.deps import SiteUser, current_user
from web.errors import AppError
from web.request_utils import request_data as _request_data
from web.request_utils import safe_int as _safe_int
from web.response import error, success
router = APIRouter()
logger = logging.getLogger('web.admin')
async def _require_admin(user: Annotated[SiteUser | None, Depends(current_user)]) -> SiteUser:
"""管理员闸(文案与历史实现逐字对齐)。"""
if user is None or not user.is_admin:
raise AppError('需要管理员权限,请使用管理员账号登录', 403)
return user
AdminUser = Annotated[SiteUser, Depends(_require_admin)]
def _admin_client():
from music_api.qr_client import QRLoginClient
return QRLoginClient()
def _reset_caches() -> None:
"""Cookie 变更后清 VIP 探测缓存与全局 MUSIC_U 缓存。"""
VIP_CACHE['data'] = None
VIP_CACHE['ts'] = 0.0
GLOBAL_MUSIC_U_CACHE['v'] = None
GLOBAL_MUSIC_U_CACHE['ts'] = 0.0
async def _render_qr_svg(unikey: str) -> str:
def _build() -> str:
import qrcode
from qrcode.image.svg import SvgPathImage
qr = qrcode.QRCode(error_correction=qrcode.constants.ERROR_CORRECT_M) # type: ignore[attr-defined]
qr.add_data(f'https://music.163.com/login?codekey={unikey}')
qr.make(fit=True)
svg = qr.make_image(image_factory=SvgPathImage).to_string()
return svg.decode('utf-8') if isinstance(svg, bytes) else svg
return await asyncio.to_thread(_build)
@router.post('/admin/qr/create')
async def admin_qr_create(_admin: AdminUser, request: Request):
"""生成管理员登录二维码(返回 SVG)。"""
await ratelimit.guard(request, bucket='free', limit=30, window=60)
try:
client = _admin_client()
unikey = await client.qr_manager.generate_qr_key()
except Exception:
return error('服务暂时不可用,请稍后再试', 500)
if not unikey:
return error('生成二维码失败', 500)
try:
svg = await _render_qr_svg(unikey)
except Exception:
return error('服务暂时不可用,请稍后再试', 500)
return success({'unikey': unikey, 'qr_svg': svg, 'expires_in': 180}, '二维码生成成功')
@router.post('/admin/qr/check')
async def admin_qr_check(_admin: AdminUser, request: Request):
"""轮询二维码登录状态,成功时自动保存 Cookie。"""
await ratelimit.guard(request, bucket='free', limit=30, window=60)
data = await _request_data(request)
unikey = data.get('unikey')
if not unikey:
return error('缺少 unikey 参数')
try:
client = _admin_client()
code, cookie_dict = await client.qr_manager.check_qr_login(unikey)
except Exception:
return error('服务暂时不可用,请稍后再试', 500)
if code == 803:
musu_u = cookie_dict.get('MUSIC_U', '')
if not musu_u:
return error('登录成功但未获取到 Cookie', 500)
cookie = f'MUSIC_U={musu_u};os=pc;appver=8.9.70;'
if cookie_dict.get('__csrf'):
cookie += f"__csrf={cookie_dict['__csrf']};"
saved = await asyncio.to_thread(client.save_cookie, cookie)
if not saved:
return error('登录成功但 Cookie 保存失败', 500)
_reset_caches()
logger.info('二维码登录成功,Cookie 已自动保存')
info = await asyncio.to_thread(client._get_cookie_info)
return success({'status': 'success', 'cookie_info': info}, '登录成功,Cookie 已保存')
if code == 801:
return success({'status': 'waiting'}, '等待扫码')
if code == 802:
return success({'status': 'scanned'}, '已扫码,请在手机上确认登录')
if code == 800:
return success({'status': 'expired'}, '二维码已过期')
return success({'status': 'error', 'code': code}, f'登录状态异常({code})')
@router.post('/admin/cookie/status')
async def admin_cookie_status(_admin: AdminUser, request: Request):
"""获取当前 Cookie 状态。"""
await ratelimit.guard(request, bucket='free', limit=30, window=60)
try:
client = _admin_client()
info = await asyncio.to_thread(client._get_cookie_info)
return success(info, '获取 Cookie 状态成功')
except Exception:
return error('服务暂时不可用,请稍后再试', 500)
@router.post('/admin/cookie/delete')
async def admin_cookie_delete(_admin: AdminUser, request: Request):
"""删除(清除)Cookie,备份后删除,可重新扫码登录。"""
await ratelimit.guard(request, bucket='free', limit=30, window=60)
try:
client = _admin_client()
ok = await asyncio.to_thread(client.logout)
if not ok:
info = await asyncio.to_thread(client._get_cookie_info)
return error(
f"Cookie 清除失败(文件仍存在:{info.get('file_exists')},"
f"可能被占用或为挂载点,请手动删除)", 500)
_reset_caches()
logger.info('管理员已清除 Cookie')
info = await asyncio.to_thread(client._get_cookie_info)
return success(info, 'Cookie 已清除')
except Exception:
return error('服务暂时不可用,请稍后再试', 500)
@router.post('/admin/logs')
async def admin_logs(_admin: AdminUser, request: Request):
"""用户 IP 解析/下载记录(分页,最新在前)。"""
await ratelimit.guard(request, bucket='free', limit=30, window=60)
data = await _request_data(request)
try:
page = max(1, _safe_int(data.get('page'), 1))
page_size = max(1, min(50, _safe_int(data.get('page_size'), 10)))
except ValueError:
return error('参数格式错误')
logs = list(reversed(REQ_LOG))
total = len(logs)
start = (page - 1) * page_size
items = logs[start:start + page_size]
return success({
'total': total,
'page': page,
'page_size': page_size,
'pages': max(1, (total + page_size - 1) // page_size),
'items': items,
}, '获取操作记录成功')