Add a standalone email sending plugin (fastapi-practices#769)

Author: wu-clan

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_user.py

@@ -151,6 +151,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/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/plugin/config/crud/crud_config.py

@@ -1,5 +1,6 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
+from typing import Sequence
 
 from sqlalchemy import Select
 from sqlalchemy.ext.asyncio import AsyncSession
@@ -22,6 +23,16 @@ async def get(self, db: AsyncSession, pk: int) -> Config | None:
         """
         return await self.select_model_by_column(db, id=pk)
 
+    async def get_by_type(self, db: AsyncSession, type: str) -> Sequence[Config | None]:
+        """
+        通过键名获取参数配置
+
+        :param db: 数据库会话
+        :param type: 参数配置类型
+        :return:
+        """
+        return await self.select_models(db, type=type)
+
     async def get_by_key(self, db: AsyncSession, key: str) -> Config | None:
         """
         通过键名获取参数配置

backend/plugin/email/README.md

@@ -0,0 +1,5 @@
+## 参数配置
+
+默认使用本地电子邮件配置
+
+支持通过 `config 插件` 动态配置电子邮件参数，当动态配置 `EMAIL_STATUS` 为 `1` 时，将自动应用动态配置

backend/plugin/email/__init__.py

@@ -0,0 +1,2 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-

backend/plugin/email/api/__init__.py

@@ -0,0 +1,2 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-

backend/plugin/email/api/router.py

@@ -0,0 +1,10 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+from fastapi import APIRouter
+
+from backend.core.conf import settings
+from backend.plugin.email.api.v1.email import router as email_router
+
+v1 = APIRouter(prefix=f'{settings.FASTAPI_API_V1_PATH}/emails', tags=['电子邮件'])
+
+v1.include_router(email_router)

backend/plugin/email/api/v1/__init__.py

@@ -0,0 +1,2 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-

backend/plugin/email/api/v1/email.py

@@ -0,0 +1,34 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+import random
+
+from typing import Annotated
+
+from fastapi import APIRouter, Body, Request
+
+from backend.common.response.response_schema import response_base
+from backend.common.security.jwt import DependsJwtAuth
+from backend.core.conf import settings
+from backend.database.db import CurrentSession
+from backend.database.redis import redis_client
+from backend.plugin.email.utils.send import send_email
+
+router = APIRouter()
+
+
+@router.post('/captcha', summary='发送电子邮件验证码', dependencies=[DependsJwtAuth])
+async def send_email_captcha(
+    request: Request,
+    db: CurrentSession,
+    recipients: Annotated[str | list[str], Body(embed=True, description='邮件接收者')],
+):
+    code = ''.join([str(random.randint(1, 9)) for _ in range(6)])
+    ip = request.state.ip
+    await redis_client.set(
+        f'{settings.EMAIL_CAPTCHA_REDIS_PREFIX}:{ip}',
+        code,
+        ex=settings.EMAIL_CAPTCHA_EXPIRE_SECONDS,
+    )
+    content = {'code': code, 'expired': int(settings.EMAIL_CAPTCHA_EXPIRE_SECONDS / 60)}
+    await send_email(db, recipients, 'FBA 验证码', content, 'captcha.html')
+    return response_base.success()