Merge branch 'master' into i18

Author: wu-clan

backend/.env.example

@@ -15,17 +15,19 @@ REDIS_DATABASE=0
 TOKEN_SECRET_KEY='1VkVF75nsNABBjK_7-qz7GtzNy3AMvktc9TCPwKczCk'
 # Opera Log
 OPERA_LOG_ENCRYPT_SECRET_KEY='d77b25790a804c2b4a339dd0207941e4cefa5751935a33735bc73bb7071a005b'
-# App Admin
-# OAuth2
-OAUTH2_GITHUB_CLIENT_ID='test'
-OAUTH2_GITHUB_CLIENT_SECRET='test'
-OAUTH2_LINUX_DO_CLIENT_ID='test'
-OAUTH2_LINUX_DO_CLIENT_SECRET='test'
-# App Task
+# [ App ] task
 # Celery
 CELERY_BROKER_REDIS_DATABASE=1
 # Rabbitmq
 CELERY_RABBITMQ_HOST='127.0.0.1'
 CELERY_RABBITMQ_PORT=5672
 CELERY_RABBITMQ_USERNAME='guest'
 CELERY_RABBITMQ_PASSWORD='guest'
+# [ Plugin ] oauth2
+OAUTH2_GITHUB_CLIENT_ID='test'
+OAUTH2_GITHUB_CLIENT_SECRET='test'
+OAUTH2_LINUX_DO_CLIENT_ID='test'
+OAUTH2_LINUX_DO_CLIENT_SECRET='test'
+# [ Plugin ] email
+EMAIL_USERNAME=''
+EMAIL_PASSWORD=''

backend/app/admin/api/v1/sys/user.py

@@ -133,6 +133,18 @@ async def update_user_avatar(
     return response_base.fail()
 
 
+@router.put('/me/email', summary='更新当前用户邮箱', dependencies=[DependsJwtAuth])
+async def update_user_email(
+    request: Request,
+    captcha: Annotated[str, Body(embed=True, description='邮箱验证码')],
+    email: Annotated[str, Body(embed=True, description='用户邮箱')],
+) -> ResponseModel:
+    count = await user_service.update_email(request=request, captcha=captcha, email=email)
+    if count > 0:
+        return response_base.success()
+    return response_base.fail()
+
+
 @router.delete(
     path='/{pk}',
     summary='删除用户',

backend/app/admin/crud/crud_opera_log.py

@@ -37,11 +37,21 @@ async def create(self, db: AsyncSession, obj: CreateOperaLogParam) -> None:
         创建操作日志
 
         :param db: 数据库会话
-        :param obj: 创建操作日志参数
+        :param obj: 操作日志创建参数
         :return:
         """
         await self.create_model(db, obj)
 
+    async def bulk_create(self, db: AsyncSession, objs: list[CreateOperaLogParam]) -> None:
+        """
+        批量创建操作日志
+
+        :param db: 数据库会话
+        :param objs: 操作日志创建参数列表
+        :return:
+        """
+        await self.create_models(db, objs)
+
     async def delete(self, db: AsyncSession, pks: list[int]) -> int:
         """
         批量删除操作日志

backend/app/admin/crud/crud_user.py

@@ -139,6 +139,17 @@ async def update_avatar(self, db: AsyncSession, user_id: int, avatar: str) -> in
         """
         return await self.update_model(db, user_id, {'avatar': avatar})
 
+    async def update_email(self, db: AsyncSession, user_id: int, email: str) -> int:
+        """
+        更新用户邮箱
+
+        :param db: 数据库会话
+        :param user_id: 用户 ID
+        :param email: 邮箱
+        :return:
+        """
+        return await self.update_model(db, user_id, {'email': email})
+
     async def delete(self, db: AsyncSession, user_id: int) -> int:
         """
         删除用户

backend/app/admin/service/opera_log_service.py

@@ -33,6 +33,17 @@ async def create(*, obj: CreateOperaLogParam) -> None:
         async with async_db_session.begin() as db:
             await opera_log_dao.create(db, obj)
 
+    @staticmethod
+    async def bulk_create(*, objs: list[CreateOperaLogParam]) -> None:
+        """
+        批量创建操作日志
+
+        :param objs: 操作日志创建参数列表
+        :return:
+        """
+        async with async_db_session.begin() as db:
+            await opera_log_dao.bulk_create(db, objs)
+
     @staticmethod
     async def delete(*, obj: DeleteOperaLogParam) -> int:
         """

backend/app/admin/service/user_service.py

@@ -18,6 +18,7 @@
 )
 from backend.common.enums import UserPermissionType
 from backend.common.exception import errors
+from backend.common.response.response_code import CustomErrorCode
 from backend.common.security.jwt import get_token, jwt_decode, password_verify, superuser_verify
 from backend.core.conf import settings
 from backend.database.db import async_db_session
@@ -206,7 +207,7 @@ async def reset_password(*, request: Request, pk: int, password: str) -> int:
     @staticmethod
     async def update_nickname(*, request: Request, nickname: str) -> int:
         """
-        更新用户昵称
+        更新当前用户昵称
 
         :param request: FastAPI 请求对象
         :param nickname: 用户昵称
@@ -225,7 +226,7 @@ async def update_nickname(*, request: Request, nickname: str) -> int:
     @staticmethod
     async def update_avatar(*, request: Request, avatar: str) -> int:
         """
-        更新用户头像
+        更新当前用户头像
 
         :param request: FastAPI 请求对象
         :param avatar: 头像地址
@@ -241,10 +242,36 @@ async def update_avatar(*, request: Request, avatar: str) -> int:
             await redis_client.delete(f'{settings.JWT_USER_REDIS_PREFIX}:{user.id}')
             return count
 
+    @staticmethod
+    async def update_email(*, request: Request, captcha: str, email: str) -> int:
+        """
+        更新当前用户邮箱
+
+        :param request: FastAPI 请求对象
+        :param captcha: 邮箱验证码
+        :param email: 邮箱
+        :return:
+        """
+        async with async_db_session.begin() as db:
+            token = get_token(request)
+            token_payload = jwt_decode(token)
+            user = await user_dao.get(db, token_payload.id)
+            if not user:
+                raise errors.NotFoundError(msg='用户不存在')
+            captcha_code = await redis_client.get(f'{settings.EMAIL_CAPTCHA_REDIS_PREFIX}:{request.state.ip}')
+            if not captcha_code:
+                raise errors.RequestError(msg='验证码已失效，请重新获取')
+            if captcha != captcha_code:
+                raise errors.CustomError(error=CustomErrorCode.CAPTCHA_ERROR)
+            await redis_client.delete(f'{settings.EMAIL_CAPTCHA_REDIS_PREFIX}:{request.state.ip}')
+            count = await user_dao.update_email(db, token_payload.id, email)
+            await redis_client.delete(f'{settings.JWT_USER_REDIS_PREFIX}:{user.id}')
+            return count
+
     @staticmethod
     async def update_password(*, request: Request, obj: ResetPasswordParam) -> int:
         """
-        更新用户密码
+        更新当前用户密码
 
         :param request: FastAPI 请求对象
         :param obj: 密码重置参数

backend/common/exception/exception_handler.py

@@ -52,9 +52,9 @@ async def _validation_exception_handler(request: Request, exc: RequestValidation
             if not ctx:
                 error['msg'] = custom_message
             else:
-                error['msg'] = custom_message.format(**ctx)
                 ctx_error = ctx.get('error')
                 if ctx_error:
+                    error['msg'] = custom_message.format(**ctx)
                     error['ctx']['error'] = (
                         ctx_error.__str__().replace("'", '"') if isinstance(ctx_error, Exception) else None
                     )

backend/common/log.py

@@ -3,6 +3,7 @@
 import inspect
 import logging
 import os
+import re
 import sys
 
 from asgi_correlation_id import correlation_id
@@ -36,6 +37,18 @@ def emit(self, record: logging.LogRecord):
         logger.opt(depth=depth, exception=record.exc_info).log(level, record.getMessage())
 
 
+def default_formatter(record):
+    """默认日志格式化程序"""
+
+    # 重写 sqlalchemy echo 输出
+    # https://github.com/sqlalchemy/sqlalchemy/discussions/12791
+    record_name = record['name'] or ''
+    if record_name.startswith('sqlalchemy'):
+        record['message'] = re.sub(r'\s+', ' ', record['message']).strip()
+
+    return settings.LOG_FORMAT if settings.LOG_FORMAT.endswith('\n') else f'{settings.LOG_FORMAT}\n'
+
+
 def setup_logging() -> None:
     """
     设置日志处理器
@@ -48,9 +61,11 @@ def setup_logging() -> None:
     logging.root.handlers = [InterceptHandler()]
     logging.root.setLevel(settings.LOG_STD_LEVEL)
 
-    # 配置日志传播规则
     for name in logging.root.manager.loggerDict.keys():
+        # 清空所有默认日志处理器
         logging.getLogger(name).handlers = []
+
+        # 配置日志传播规则
         if 'uvicorn.access' in name or 'watchfiles.main' in name:
             logging.getLogger(name).propagate = False
         else:
@@ -59,22 +74,24 @@ def setup_logging() -> None:
         # Debug log handlers
         # logging.debug(f'{logging.getLogger(name)}, {logging.getLogger(name).propagate}')
 
+    # 移除 loguru 默认处理器
+    logger.remove()
+
     # correlation_id 过滤器
     # https://github.com/snok/asgi-correlation-id/issues/7
     def correlation_id_filter(record):
         cid = correlation_id.get(settings.TRACE_ID_LOG_DEFAULT_VALUE)
-        record['correlation_id'] = cid[: settings.TRACE_ID_LOG_UUID_LENGTH]
+        record['correlation_id'] = cid[: settings.TRACE_ID_LOG_LENGTH]
         return record
 
     # 配置 loguru 处理器
-    logger.remove()  # 移除默认处理器
     logger.configure(
         handlers=[
             {
                 'sink': sys.stdout,
                 'level': settings.LOG_STD_LEVEL,
+                'format': default_formatter,
                 'filter': lambda record: correlation_id_filter(record),
-                'format': settings.LOG_STD_FORMAT,
             }
         ]
     )
@@ -100,7 +117,7 @@ def compression(filepath):
     # 日志文件通用配置
     # https://loguru.readthedocs.io/en/stable/api/logger.html#loguru._logger.Logger.add
     log_config = {
-        'format': settings.LOG_FILE_FORMAT,
+        'format': default_formatter,
         'enqueue': True,
         'rotation': '00:00',
         'retention': '7 days',
@@ -110,7 +127,7 @@ def compression(filepath):
     # 标准输出文件
     logger.add(
         str(log_access_file),
-        level=settings.LOG_ACCESS_FILE_LEVEL,
+        level=settings.LOG_FILE_ACCESS_LEVEL,
         filter=lambda record: record['level'].no <= 25,
         backtrace=False,
         diagnose=False,
@@ -120,7 +137,7 @@ def compression(filepath):
     # 标准错误文件
     logger.add(
         str(log_error_file),
-        level=settings.LOG_ERROR_FILE_LEVEL,
+        level=settings.LOG_FILE_ERROR_LEVEL,
         filter=lambda record: record['level'].no >= 30,
         backtrace=True,
         diagnose=True,

backend/common/queue.py

@@ -0,0 +1,29 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+import asyncio
+
+from asyncio import Queue
+
+
+async def batch_dequeue(queue: Queue, max_items: int, timeout: float) -> list:
+    """
+    从异步队列中获取多个项目
+
+    :param queue: 用于获取项目的 `asyncio.Queue` 队列
+    :param max_items: 从队列中获取的最大项目数量
+    :param timeout: 总的等待超时时间（秒）
+    :return:
+    """
+    items = []
+
+    async def collector():
+        while len(items) < max_items:
+            item = await queue.get()
+            items.append(item)
+
+    try:
+        await asyncio.wait_for(collector(), timeout=timeout)
+    except asyncio.TimeoutError:
+        pass
+
+    return items

backend/common/schema.py

@@ -5,7 +5,7 @@
 
 from pydantic import BaseModel, ConfigDict, EmailStr, Field, validate_email
 
-from backend.core.conf import settings
+from backend.utils.timezone import timezone
 
 # 自定义验证错误信息，参考：
 # https://github.com/pydantic/pydantic-core/blob/a5cb7382643415b716b1a7a5392914e50f726528/tests/test_errors.py#L266
@@ -124,5 +124,9 @@ class SchemaBase(BaseModel):
 
     model_config = ConfigDict(
         use_enum_values=True,
-        json_encoders={datetime: lambda x: x.strftime(settings.DATETIME_FORMAT)},
+        json_encoders={
+            datetime: lambda x: timezone.to_str(timezone.from_datetime(x))
+            if x.tzinfo is not None
+            else timezone.to_str(x)
+        },
     )