于小丘
ccadfe57cd
All checks were successful
Test / test (push) Successful in 1m45s
- Migrate SQLModel base classes, mixins, and database management to external sqlmodel-ext package; remove sqlmodels/base/, sqlmodels/mixin/, and sqlmodels/database.py - Add file viewer/editor system with WOPI protocol support for collaborative editing (OnlyOffice, Collabora) - Add enterprise edition license verification module (ee/) - Add Dockerfile multi-stage build with Cython compilation support - Add new dependencies: sqlmodel-ext, cryptography, whatthepatch Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
558 lines
18 KiB
Python
558 lines
18 KiB
Python
from typing import Annotated
|
||
from uuid import UUID
|
||
|
||
from fastapi import APIRouter, Depends, HTTPException, status
|
||
from itsdangerous import URLSafeTimedSerializer, BadSignature, SignatureExpired
|
||
|
||
import sqlmodels
|
||
from middleware.auth import auth_required
|
||
from middleware.dependencies import SessionDep
|
||
from sqlmodels import (
|
||
BUILTIN_DEFAULT_COLORS, ThemePreset, UserThemeUpdateRequest,
|
||
SettingOption, UserSettingUpdateRequest,
|
||
AuthIdentity, AuthIdentityResponse, AuthProviderType, BindIdentityRequest,
|
||
AuthnDetailResponse, AuthnRenameRequest,
|
||
)
|
||
from sqlmodels.color import ThemeColorsBase
|
||
from sqlmodels.user_authn import UserAuthn
|
||
from utils import JWT, Password, http_exceptions
|
||
from utils.password.pwd import PasswordStatus, TwoFactorResponse, TwoFactorVerifyRequest
|
||
from .file_viewers import file_viewers_router
|
||
|
||
user_settings_router = APIRouter(
|
||
prefix='/settings',
|
||
tags=["user", "user_settings"],
|
||
dependencies=[Depends(auth_required)],
|
||
)
|
||
user_settings_router.include_router(file_viewers_router)
|
||
|
||
|
||
@user_settings_router.get(
|
||
path='/policies',
|
||
summary='获取用户可选存储策略',
|
||
description='Get user selectable storage policies.',
|
||
)
|
||
def router_user_settings_policies() -> sqlmodels.ResponseBase:
|
||
"""
|
||
Get user selectable storage policies.
|
||
|
||
Returns:
|
||
dict: A dictionary containing available storage policies for the user.
|
||
"""
|
||
http_exceptions.raise_not_implemented()
|
||
|
||
|
||
@user_settings_router.get(
|
||
path='/nodes',
|
||
summary='获取用户可选节点',
|
||
description='Get user selectable nodes.',
|
||
dependencies=[Depends(auth_required)],
|
||
)
|
||
def router_user_settings_nodes() -> sqlmodels.ResponseBase:
|
||
"""
|
||
Get user selectable nodes.
|
||
|
||
Returns:
|
||
dict: A dictionary containing available nodes for the user.
|
||
"""
|
||
http_exceptions.raise_not_implemented()
|
||
|
||
|
||
@user_settings_router.get(
|
||
path='/tasks',
|
||
summary='任务队列',
|
||
description='Get user task queue.',
|
||
dependencies=[Depends(auth_required)],
|
||
)
|
||
def router_user_settings_tasks() -> sqlmodels.ResponseBase:
|
||
"""
|
||
Get user task queue.
|
||
|
||
Returns:
|
||
dict: A dictionary containing the user's task queue information.
|
||
"""
|
||
http_exceptions.raise_not_implemented()
|
||
|
||
|
||
@user_settings_router.get(
|
||
path='/',
|
||
summary='获取当前用户设定',
|
||
description='Get current user settings.',
|
||
)
|
||
async def router_user_settings(
|
||
session: SessionDep,
|
||
user: Annotated[sqlmodels.user.User, Depends(auth_required)],
|
||
) -> sqlmodels.UserSettingResponse:
|
||
"""
|
||
获取当前用户设定
|
||
|
||
主题颜色合并策略：
|
||
1. 用户有颜色快照（7个字段均有值）→ 直接使用快照
|
||
2. 否则查找默认预设 → 使用默认预设颜色
|
||
3. 无默认预设 → 使用内置默认值
|
||
"""
|
||
# 计算主题颜色
|
||
has_snapshot = all([
|
||
user.color_primary, user.color_secondary, user.color_success,
|
||
user.color_info, user.color_warning, user.color_error, user.color_neutral,
|
||
])
|
||
if has_snapshot:
|
||
theme_colors = ThemeColorsBase(
|
||
primary=user.color_primary,
|
||
secondary=user.color_secondary,
|
||
success=user.color_success,
|
||
info=user.color_info,
|
||
warning=user.color_warning,
|
||
error=user.color_error,
|
||
neutral=user.color_neutral,
|
||
)
|
||
else:
|
||
default_preset: ThemePreset | None = await ThemePreset.get(
|
||
session, ThemePreset.is_default == True # noqa: E712
|
||
)
|
||
if default_preset:
|
||
theme_colors = ThemeColorsBase(
|
||
primary=default_preset.primary,
|
||
secondary=default_preset.secondary,
|
||
success=default_preset.success,
|
||
info=default_preset.info,
|
||
warning=default_preset.warning,
|
||
error=default_preset.error,
|
||
neutral=default_preset.neutral,
|
||
)
|
||
else:
|
||
theme_colors = BUILTIN_DEFAULT_COLORS
|
||
|
||
# 检查是否启用了两步验证（从 email_password AuthIdentity 的 extra_data 中读取）
|
||
has_two_factor = False
|
||
email_identity: AuthIdentity | None = await AuthIdentity.get(
|
||
session,
|
||
(AuthIdentity.user_id == user.id)
|
||
& (AuthIdentity.provider == AuthProviderType.EMAIL_PASSWORD),
|
||
)
|
||
if email_identity and email_identity.extra_data:
|
||
import orjson
|
||
extra: dict = orjson.loads(email_identity.extra_data)
|
||
has_two_factor = bool(extra.get("two_factor"))
|
||
|
||
return sqlmodels.UserSettingResponse(
|
||
id=user.id,
|
||
email=user.email,
|
||
phone=user.phone,
|
||
nickname=user.nickname,
|
||
created_at=user.created_at,
|
||
group_name=user.group.name,
|
||
language=user.language,
|
||
timezone=user.timezone,
|
||
group_expires=user.group_expires,
|
||
two_factor=has_two_factor,
|
||
theme_preset_id=user.theme_preset_id,
|
||
theme_colors=theme_colors,
|
||
)
|
||
|
||
|
||
@user_settings_router.post(
|
||
path='/avatar',
|
||
summary='从文件上传头像',
|
||
description='Upload user avatar from file.',
|
||
dependencies=[Depends(auth_required)],
|
||
)
|
||
def router_user_settings_avatar() -> sqlmodels.ResponseBase:
|
||
"""
|
||
Upload user avatar from file.
|
||
|
||
Returns:
|
||
dict: A dictionary containing the result of the avatar upload.
|
||
"""
|
||
http_exceptions.raise_not_implemented()
|
||
|
||
|
||
@user_settings_router.put(
|
||
path='/avatar',
|
||
summary='设定为Gravatar头像',
|
||
description='Set user avatar to Gravatar.',
|
||
dependencies=[Depends(auth_required)],
|
||
status_code=204,
|
||
)
|
||
def router_user_settings_avatar_gravatar() -> None:
|
||
"""
|
||
Set user avatar to Gravatar.
|
||
|
||
Returns:
|
||
dict: A dictionary containing the result of setting the Gravatar avatar.
|
||
"""
|
||
http_exceptions.raise_not_implemented()
|
||
|
||
|
||
@user_settings_router.patch(
|
||
path='/theme',
|
||
summary='更新用户主题设置',
|
||
status_code=status.HTTP_204_NO_CONTENT,
|
||
)
|
||
async def router_user_settings_theme(
|
||
session: SessionDep,
|
||
user: Annotated[sqlmodels.user.User, Depends(auth_required)],
|
||
request: UserThemeUpdateRequest,
|
||
) -> None:
|
||
"""
|
||
更新用户主题设置
|
||
|
||
请求体（均可选）：
|
||
- theme_preset_id: 主题预设UUID
|
||
- theme_colors: 颜色配置对象（写入颜色快照）
|
||
|
||
错误处理：
|
||
- 404: 指定的主题预设不存在
|
||
"""
|
||
# 验证 preset_id 存在性
|
||
if request.theme_preset_id is not None:
|
||
preset: ThemePreset | None = await ThemePreset.get(
|
||
session, ThemePreset.id == request.theme_preset_id
|
||
)
|
||
if not preset:
|
||
http_exceptions.raise_not_found("主题预设不存在")
|
||
user.theme_preset_id = request.theme_preset_id
|
||
|
||
# 将颜色解构到快照列
|
||
if request.theme_colors is not None:
|
||
user.color_primary = request.theme_colors.primary
|
||
user.color_secondary = request.theme_colors.secondary
|
||
user.color_success = request.theme_colors.success
|
||
user.color_info = request.theme_colors.info
|
||
user.color_warning = request.theme_colors.warning
|
||
user.color_error = request.theme_colors.error
|
||
user.color_neutral = request.theme_colors.neutral
|
||
|
||
await user.save(session)
|
||
|
||
|
||
@user_settings_router.patch(
|
||
path='/{option}',
|
||
summary='更新用户设定',
|
||
status_code=status.HTTP_204_NO_CONTENT,
|
||
)
|
||
async def router_user_settings_patch(
|
||
session: SessionDep,
|
||
user: Annotated[sqlmodels.user.User, Depends(auth_required)],
|
||
option: SettingOption,
|
||
request: UserSettingUpdateRequest,
|
||
) -> None:
|
||
"""
|
||
更新单个用户设置项
|
||
|
||
路径参数：
|
||
- option: 设置项名称（nickname / language / timezone）
|
||
|
||
请求体：
|
||
- 包含与 option 同名的字段及其新值
|
||
|
||
错误处理：
|
||
- 422: 无效的 option 或字段值不符合约束
|
||
- 400: 必填字段值缺失
|
||
"""
|
||
value = getattr(request, option.value)
|
||
|
||
# language / timezone 不允许设为 null
|
||
if value is None and option != SettingOption.NICKNAME:
|
||
http_exceptions.raise_bad_request(f"设置项 {option.value} 不允许为空")
|
||
|
||
setattr(user, option.value, value)
|
||
await user.save(session)
|
||
|
||
|
||
@user_settings_router.get(
|
||
path='/2fa',
|
||
summary='获取两步验证初始化信息',
|
||
description='Get two-factor authentication initialization information.',
|
||
dependencies=[Depends(auth_required)],
|
||
)
|
||
async def router_user_settings_2fa(
|
||
user: Annotated[sqlmodels.user.User, Depends(auth_required)],
|
||
) -> TwoFactorResponse:
|
||
"""
|
||
获取两步验证初始化信息
|
||
|
||
返回 setup_token（用于后续验证请求）和 uri（用于生成二维码）。
|
||
"""
|
||
return await Password.generate_totp(name=user.email or str(user.id))
|
||
|
||
|
||
@user_settings_router.post(
|
||
path='/2fa',
|
||
summary='启用两步验证',
|
||
description='Enable two-factor authentication.',
|
||
dependencies=[Depends(auth_required)],
|
||
status_code=204,
|
||
)
|
||
async def router_user_settings_2fa_enable(
|
||
session: SessionDep,
|
||
user: Annotated[sqlmodels.user.User, Depends(auth_required)],
|
||
request: TwoFactorVerifyRequest,
|
||
) -> None:
|
||
"""
|
||
启用两步验证
|
||
|
||
将 2FA secret 存储到 email_password AuthIdentity 的 extra_data 中。
|
||
"""
|
||
serializer = URLSafeTimedSerializer(JWT.SECRET_KEY)
|
||
|
||
try:
|
||
secret = serializer.loads(request.setup_token, salt="2fa-setup-salt", max_age=600)
|
||
except SignatureExpired:
|
||
raise HTTPException(status_code=400, detail="Setup session expired")
|
||
except BadSignature:
|
||
raise HTTPException(status_code=400, detail="Invalid token")
|
||
|
||
if Password.verify_totp(secret, request.code) != PasswordStatus.VALID:
|
||
raise HTTPException(status_code=400, detail="Invalid OTP code")
|
||
|
||
# 将 secret 存储到 AuthIdentity.extra_data 中
|
||
email_identity: AuthIdentity | None = await AuthIdentity.get(
|
||
session,
|
||
(AuthIdentity.user_id == user.id)
|
||
& (AuthIdentity.provider == AuthProviderType.EMAIL_PASSWORD),
|
||
)
|
||
if not email_identity:
|
||
raise HTTPException(status_code=400, detail="未找到邮箱密码认证身份")
|
||
|
||
import orjson
|
||
extra: dict = orjson.loads(email_identity.extra_data) if email_identity.extra_data else {}
|
||
extra["two_factor"] = secret
|
||
email_identity.extra_data = orjson.dumps(extra).decode('utf-8')
|
||
await email_identity.save(session)
|
||
|
||
|
||
# ==================== 认证身份管理 ====================
|
||
|
||
@user_settings_router.get(
|
||
path='/identities',
|
||
summary='列出已绑定的认证身份',
|
||
)
|
||
async def router_user_settings_identities(
|
||
session: SessionDep,
|
||
user: Annotated[sqlmodels.user.User, Depends(auth_required)],
|
||
) -> list[AuthIdentityResponse]:
|
||
"""
|
||
列出当前用户已绑定的所有认证身份
|
||
|
||
返回：
|
||
- 认证身份列表，包含 provider、identifier、display_name 等
|
||
"""
|
||
identities: list[AuthIdentity] = await AuthIdentity.get(
|
||
session,
|
||
AuthIdentity.user_id == user.id,
|
||
fetch_mode="all",
|
||
)
|
||
return [identity.to_response() for identity in identities]
|
||
|
||
|
||
@user_settings_router.post(
|
||
path='/identity',
|
||
summary='绑定新的认证身份',
|
||
status_code=status.HTTP_201_CREATED,
|
||
)
|
||
async def router_user_settings_bind_identity(
|
||
session: SessionDep,
|
||
user: Annotated[sqlmodels.user.User, Depends(auth_required)],
|
||
request: BindIdentityRequest,
|
||
) -> AuthIdentityResponse:
|
||
"""
|
||
绑定新的登录方式
|
||
|
||
请求体：
|
||
- provider: 提供者类型
|
||
- identifier: 标识符（邮箱 / 手机号 / OAuth code）
|
||
- credential: 凭证（密码、验证码等）
|
||
- redirect_uri: OAuth 回调地址（可选）
|
||
|
||
错误处理：
|
||
- 400: provider 未启用
|
||
- 409: 该身份已被其他用户绑定
|
||
"""
|
||
# 检查是否已被绑定
|
||
existing = await AuthIdentity.get(
|
||
session,
|
||
(AuthIdentity.provider == request.provider)
|
||
& (AuthIdentity.identifier == request.identifier),
|
||
)
|
||
if existing:
|
||
raise HTTPException(status_code=409, detail="该身份已被绑定")
|
||
|
||
# 处理密码类型的凭证
|
||
credential: str | None = None
|
||
if request.provider == AuthProviderType.EMAIL_PASSWORD and request.credential:
|
||
credential = Password.hash(request.credential)
|
||
|
||
identity = AuthIdentity(
|
||
provider=request.provider,
|
||
identifier=request.identifier,
|
||
credential=credential,
|
||
is_primary=False,
|
||
is_verified=False,
|
||
user_id=user.id,
|
||
)
|
||
identity = await identity.save(session)
|
||
return identity.to_response()
|
||
|
||
|
||
@user_settings_router.delete(
|
||
path='/identity/{identity_id}',
|
||
summary='解绑认证身份',
|
||
status_code=status.HTTP_204_NO_CONTENT,
|
||
)
|
||
async def router_user_settings_unbind_identity(
|
||
session: SessionDep,
|
||
user: Annotated[sqlmodels.user.User, Depends(auth_required)],
|
||
identity_id: UUID,
|
||
) -> None:
|
||
"""
|
||
解绑一个认证身份
|
||
|
||
约束：
|
||
- 不能解绑最后一个身份
|
||
- 站长配置强制绑定邮箱/手机号时，不能解绑对应身份
|
||
|
||
错误处理：
|
||
- 404: 身份不存在或不属于当前用户
|
||
- 400: 不能解绑最后一个身份 / 不能解绑强制绑定的身份
|
||
"""
|
||
# 查找目标身份
|
||
identity: AuthIdentity | None = await AuthIdentity.get(
|
||
session,
|
||
(AuthIdentity.id == identity_id) & (AuthIdentity.user_id == user.id),
|
||
)
|
||
if not identity:
|
||
http_exceptions.raise_not_found("认证身份不存在")
|
||
|
||
# 检查是否为最后一个身份
|
||
all_identities: list[AuthIdentity] = await AuthIdentity.get(
|
||
session,
|
||
AuthIdentity.user_id == user.id,
|
||
fetch_mode="all",
|
||
)
|
||
if len(all_identities) <= 1:
|
||
http_exceptions.raise_bad_request("不能解绑最后一个认证身份")
|
||
|
||
# 检查强制绑定约束
|
||
if identity.provider == AuthProviderType.EMAIL_PASSWORD:
|
||
email_required_setting = await sqlmodels.Setting.get(
|
||
session,
|
||
(sqlmodels.Setting.type == sqlmodels.SettingsType.AUTH)
|
||
& (sqlmodels.Setting.name == "auth_email_binding_required"),
|
||
)
|
||
if email_required_setting and email_required_setting.value == "1":
|
||
http_exceptions.raise_bad_request("站长要求必须绑定邮箱，不能解绑")
|
||
|
||
if identity.provider == AuthProviderType.PHONE_SMS:
|
||
phone_required_setting = await sqlmodels.Setting.get(
|
||
session,
|
||
(sqlmodels.Setting.type == sqlmodels.SettingsType.AUTH)
|
||
& (sqlmodels.Setting.name == "auth_phone_binding_required"),
|
||
)
|
||
if phone_required_setting and phone_required_setting.value == "1":
|
||
http_exceptions.raise_bad_request("站长要求必须绑定手机号，不能解绑")
|
||
|
||
await AuthIdentity.delete(session, identity)
|
||
|
||
|
||
# ==================== WebAuthn 凭证管理 ====================
|
||
|
||
@user_settings_router.get(
|
||
path='/authns',
|
||
summary='列出用户所有 WebAuthn 凭证',
|
||
)
|
||
async def router_user_settings_authns(
|
||
session: SessionDep,
|
||
user: Annotated[sqlmodels.user.User, Depends(auth_required)],
|
||
) -> list[AuthnDetailResponse]:
|
||
"""
|
||
列出当前用户所有已注册的 WebAuthn 凭证
|
||
|
||
返回：
|
||
- 凭证列表，包含 credential_id、name、device_type 等
|
||
"""
|
||
authns: list[UserAuthn] = await UserAuthn.get(
|
||
session,
|
||
UserAuthn.user_id == user.id,
|
||
fetch_mode="all",
|
||
)
|
||
return [authn.to_detail_response() for authn in authns]
|
||
|
||
|
||
@user_settings_router.patch(
|
||
path='/authn/{authn_id}',
|
||
summary='重命名 WebAuthn 凭证',
|
||
)
|
||
async def router_user_settings_rename_authn(
|
||
session: SessionDep,
|
||
user: Annotated[sqlmodels.user.User, Depends(auth_required)],
|
||
authn_id: int,
|
||
request: AuthnRenameRequest,
|
||
) -> AuthnDetailResponse:
|
||
"""
|
||
重命名一个 WebAuthn 凭证
|
||
|
||
错误处理：
|
||
- 404: 凭证不存在或不属于当前用户
|
||
"""
|
||
authn: UserAuthn | None = await UserAuthn.get(
|
||
session,
|
||
(UserAuthn.id == authn_id) & (UserAuthn.user_id == user.id),
|
||
)
|
||
if not authn:
|
||
http_exceptions.raise_not_found("WebAuthn 凭证不存在")
|
||
|
||
authn.name = request.name
|
||
authn = await authn.save(session)
|
||
return authn.to_detail_response()
|
||
|
||
|
||
@user_settings_router.delete(
|
||
path='/authn/{authn_id}',
|
||
summary='删除 WebAuthn 凭证',
|
||
status_code=status.HTTP_204_NO_CONTENT,
|
||
)
|
||
async def router_user_settings_delete_authn(
|
||
session: SessionDep,
|
||
user: Annotated[sqlmodels.user.User, Depends(auth_required)],
|
||
authn_id: int,
|
||
) -> None:
|
||
"""
|
||
删除一个 WebAuthn 凭证
|
||
|
||
同时删除对应的 AuthIdentity(provider=passkey) 记录。
|
||
如果这是用户最后一个认证身份，拒绝删除。
|
||
|
||
错误处理：
|
||
- 404: 凭证不存在或不属于当前用户
|
||
- 400: 不能删除最后一个认证身份
|
||
"""
|
||
authn: UserAuthn | None = await UserAuthn.get(
|
||
session,
|
||
(UserAuthn.id == authn_id) & (UserAuthn.user_id == user.id),
|
||
)
|
||
if not authn:
|
||
http_exceptions.raise_not_found("WebAuthn 凭证不存在")
|
||
|
||
# 检查是否为最后一个认证身份
|
||
all_identities: list[AuthIdentity] = await AuthIdentity.get(
|
||
session,
|
||
AuthIdentity.user_id == user.id,
|
||
fetch_mode="all",
|
||
)
|
||
if len(all_identities) <= 1:
|
||
http_exceptions.raise_bad_request("不能删除最后一个认证身份")
|
||
|
||
# 删除对应的 AuthIdentity
|
||
passkey_identity: AuthIdentity | None = await AuthIdentity.get(
|
||
session,
|
||
(AuthIdentity.provider == AuthProviderType.PASSKEY)
|
||
& (AuthIdentity.identifier == authn.credential_id)
|
||
& (AuthIdentity.user_id == user.id),
|
||
)
|
||
if passkey_identity:
|
||
await AuthIdentity.delete(session, passkey_identity, commit=False)
|
||
|
||
# 删除 UserAuthn
|
||
await UserAuthn.delete(session, authn)
|