Update the OAuth2 module to plugin (#620)

* Update the OAuth2 module to plugin

* update create user social param

Author: wu-clan

backend/app/admin/api/router.py

@@ -5,14 +5,12 @@
 from backend.app.admin.api.v1.auth import router as auth_router
 from backend.app.admin.api.v1.log import router as log_router
 from backend.app.admin.api.v1.monitor import router as monitor_router
-from backend.app.admin.api.v1.oauth2 import router as oauth2_router
 from backend.app.admin.api.v1.sys import router as sys_router
 from backend.core.conf import settings
 
 v1 = APIRouter(prefix=settings.FASTAPI_API_V1_PATH)
 
 v1.include_router(auth_router)
-v1.include_router(oauth2_router)
 v1.include_router(sys_router)
 v1.include_router(log_router)
 v1.include_router(monitor_router)

backend/app/admin/api/v1/oauth2/__init__.py

@@ -189,8 +189,7 @@ async def get_list(self, dept: int | None, username: str | None, phone: str | No
             select(self.model)
             .options(
                 selectinload(self.model.dept).options(noload(Dept.parent), noload(Dept.children), noload(Dept.users)),
-                noload(self.model.socials),
-                selectinload(self.model.roles).options(noload(Role.users), noload(Role.menus), noload(Role.rules)),
+                selectinload(self.model.roles).options(noload(Role.users), noload(Role.menus), noload(Role.scopes)),
             )
             .order_by(desc(self.model.join_time))
         )

backend/app/admin/crud/crud_user.py

@@ -8,4 +8,3 @@
 from backend.app.admin.model.opera_log import OperaLog
 from backend.app.admin.model.role import Role
 from backend.app.admin.model.user import User
-from backend.app.admin.model.user_social import UserSocial

backend/app/admin/model/__init__.py

@@ -15,7 +15,7 @@
 from backend.utils.timezone import timezone
 
 if TYPE_CHECKING:
-    from backend.app.admin.model import Dept, Role, UserSocial
+    from backend.app.admin.model import Dept, Role
 
 
 class User(Base):
@@ -55,8 +55,5 @@ class User(Base):
     )
     dept: Mapped[Dept | None] = relationship(init=False, back_populates='users')
 
-    # 用户社交信息一对多
-    socials: Mapped[list[UserSocial]] = relationship(init=False, back_populates='user')
-
     # 用户角色多对多
     roles: Mapped[list[Role]] = relationship(init=False, secondary=sys_user_role, back_populates='users')

backend/app/admin/model/user.py

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

backend/plugin/oauth2/__init__.py

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

backend/plugin/oauth2/api/__init__.py

@@ -0,0 +1,12 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+from fastapi import APIRouter
+
+from backend.core.conf import settings
+from backend.plugin.oauth2.api.v1.github import router as github_router
+from backend.plugin.oauth2.api.v1.linux_do import router as linux_do_router
+
+v1 = APIRouter(prefix=f'{settings.FASTAPI_API_V1_PATH}/oauth2')
+
+v1.include_router(github_router, prefix='/github', tags=['Github OAuth2'])
+v1.include_router(linux_do_router, prefix='/linux-do', tags=['LinuxDo OAuth2'])

backend/plugin/oauth2/api/router.py

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

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

@@ -5,10 +5,10 @@
 from fastapi_oauth20 import FastAPIOAuth20, GitHubOAuth20
 from starlette.responses import RedirectResponse
 
-from backend.app.admin.service.oauth2_service import oauth2_service
 from backend.common.enums import UserSocialType
 from backend.common.response.response_schema import ResponseSchemaModel, response_base
 from backend.core.conf import settings
+from backend.plugin.oauth2.service.oauth2_service import oauth2_service
 
 router = APIRouter()
 

backend/app/admin/api/v1/oauth2/github.py renamed to backend/plugin/oauth2/api/v1/github.py

@@ -5,10 +5,10 @@
 from fastapi_oauth20 import FastAPIOAuth20, LinuxDoOAuth20
 from starlette.responses import RedirectResponse
 
-from backend.app.admin.service.oauth2_service import oauth2_service
 from backend.common.enums import UserSocialType
 from backend.common.response.response_schema import ResponseSchemaModel, response_base
 from backend.core.conf import settings
+from backend.plugin.oauth2.service.oauth2_service import oauth2_service
 
 router = APIRouter()
 

backend/app/admin/api/v1/oauth2/linux_do.py renamed to backend/plugin/oauth2/api/v1/linux_do.py

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

backend/plugin/oauth2/crud/__init__.py

@@ -3,15 +3,14 @@
 from sqlalchemy.ext.asyncio import AsyncSession
 from sqlalchemy_crud_plus import CRUDPlus
 
-from backend.app.admin.model import UserSocial
-from backend.app.admin.schema.user_social import CreateUserSocialParam
-from backend.common.enums import UserSocialType
+from backend.plugin.oauth2.model import UserSocial
+from backend.plugin.oauth2.schema.user_social import CreateUserSocialParam
 
 
 class CRUDUserSocial(CRUDPlus[UserSocial]):
     """用户社交账号数据库操作类"""
 
-    async def get(self, db: AsyncSession, pk: int, source: UserSocialType) -> UserSocial | None:
+    async def get(self, db: AsyncSession, pk: int, source: str) -> UserSocial | None:
         """
         获取用户社交账号绑定详情
 

backend/app/admin/crud/crud_user_social.py renamed to backend/plugin/oauth2/crud/crud_user_social.py

@@ -0,0 +1,3 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+from backend.plugin.oauth2.model.user_social import UserSocial

backend/plugin/oauth2/model/__init__.py

@@ -20,14 +20,14 @@ class UserSocial(Base):
 
     id: Mapped[id_key] = mapped_column(init=False)
     source: Mapped[str] = mapped_column(String(20), comment='第三方用户来源')
-    open_id: Mapped[str | None] = mapped_column(String(20), default=None, comment='第三方用户的 open id')
-    uid: Mapped[str | None] = mapped_column(String(20), default=None, comment='第三方用户的 ID')
-    union_id: Mapped[str | None] = mapped_column(String(20), default=None, comment='第三方用户的 union id')
+    open_id: Mapped[str | None] = mapped_column(String(20), default=None, comment='第三方用户 open id')
+    sid: Mapped[str | None] = mapped_column(String(20), default=None, comment='第三方用户 ID')
+    union_id: Mapped[str | None] = mapped_column(String(20), default=None, comment='第三方用户 union id')
     scope: Mapped[str | None] = mapped_column(String(120), default=None, comment='第三方用户授予的权限')
     code: Mapped[str | None] = mapped_column(String(50), default=None, comment='用户的授权 code')
 
     # 用户社交信息一对多
     user_id: Mapped[int | None] = mapped_column(
         ForeignKey('sys_user.id', ondelete='SET NULL'), default=None, comment='用户关联ID'
     )
-    user: Mapped[User | None] = relationship(init=False, back_populates='socials')
+    user: Mapped[User | None] = relationship(init=False, backref='socials')

backend/app/admin/model/user_social.py renamed to backend/plugin/oauth2/model/user_social.py

@@ -0,0 +1,8 @@
+[plugin]
+summary = 'OAuth 2.0'
+version = '0.0.1'
+description = '通过 OAuth 2.0 的方式登录系统'
+author = 'wu-clan'
+
+[app]
+router = ['v1']

backend/plugin/oauth2/plugin.toml

@@ -0,0 +1 @@
+fastapi-oauth20>=0.0.1

backend/plugin/oauth2/requirements.txt

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

backend/plugin/oauth2/schema/__init__.py

@@ -11,7 +11,7 @@ class UserSocialSchemaBase(SchemaBase):
 
     source: UserSocialType = Field(description='社交平台')
     open_id: str | None = Field(None, description='开放平台 ID')
-    uid: str | None = Field(None, description='用户 ID')
+    sid: str | None = Field(None, description='第三方用户 ID')
     union_id: str | None = Field(None, description='开放平台唯一 ID')
     scope: str | None = Field(None, description='授权范围')
     code: str | None = Field(None, description='授权码')

backend/app/admin/schema/user_social.py renamed to backend/plugin/oauth2/schema/user_social.py

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

backend/plugin/oauth2/service/__init__.py

@@ -6,17 +6,17 @@
 from fastapi import BackgroundTasks, Request, Response
 
 from backend.app.admin.crud.crud_user import user_dao
-from backend.app.admin.crud.crud_user_social import user_social_dao
 from backend.app.admin.schema.token import GetLoginToken
 from backend.app.admin.schema.user import RegisterUserParam
-from backend.app.admin.schema.user_social import CreateUserSocialParam
 from backend.app.admin.service.login_log_service import login_log_service
 from backend.common.enums import LoginLogStatusType, UserSocialType
 from backend.common.exception.errors import AuthorizationError
 from backend.common.security import jwt
 from backend.core.conf import settings
 from backend.database.db import async_db_session
 from backend.database.redis import redis_client
+from backend.plugin.oauth2.crud.crud_user_social import user_social_dao
+from backend.plugin.oauth2.schema.user_social import CreateUserSocialParam
 from backend.utils.timezone import timezone
 
 
@@ -45,15 +45,18 @@ async def create_with_login(
         async with async_db_session.begin() as db:
             # 获取 OAuth2 平台用户信息
             social_id = user.get('id')
+            social_nickname = user.get('name')
+
             social_username = user.get('username')
             if social == UserSocialType.github:
                 social_username = user.get('login')
-            social_nickname = user.get('name')
+
             social_email = user.get('email')
-            if social == UserSocialType.linux_do:  # 不提供明文邮箱的平台
+            if social == UserSocialType.linux_do:
                 social_email = f'{social_username}@linux.do'
             if not social_email:
                 raise AuthorizationError(msg=f'授权失败，{social.value} 账户未绑定邮箱')
+
             # 创建系统用户
             sys_user = await user_dao.check_email(db, social_email)
             if not sys_user:
@@ -73,7 +76,7 @@ async def create_with_login(
             sys_user_id = sys_user.id
             user_social = await user_social_dao.get(db, sys_user_id, social.value)
             if not user_social:
-                new_user_social = CreateUserSocialParam(source=social.value, uid=str(social_id), user_id=sys_user_id)
+                new_user_social = CreateUserSocialParam(source=social.value, sid=str(social_id), user_id=sys_user_id)
                 await user_social_dao.create(db, new_user_social)
             # 创建 token
             access_token = await jwt.create_access_token(

backend/app/admin/service/oauth2_service.py renamed to backend/plugin/oauth2/service/oauth2_service.py

@@ -149,9 +149,9 @@ def inject_extra_router(plugin: dict[str, Any]) -> None:
                 continue
 
             # 解析插件路由配置
-            file_config = plugin.get('api', {}).get(f'{file[:-3]}', {})
-            prefix = file_config.get('prefix', '')
-            tags = file_config.get('tags', [])
+            file_config = plugin['api'][file[:-3]]
+            prefix = file_config['prefix']
+            tags = file_config['tags']
 
             # 获取插件路由模块
             file_path = os.path.join(root, file)
@@ -204,7 +204,7 @@ def inject_app_router(plugin: dict[str, Any], target_router: APIRouter) -> None:
     module_path = f'backend.plugin.{plugin_name}.api.router'
     try:
         module = import_module_cached(module_path)
-        routers = plugin.get('app', {}).get('router')
+        routers = plugin['app']['router']
         if not routers or not isinstance(routers, list):
             raise PluginConfigError(f'应用级插件 {plugin_name} 配置文件存在错误，请检查')
 

backend/plugin/tools.py

@@ -418,9 +418,9 @@ create table sys_user_social
     id           int auto_increment comment '主键 ID'
         primary key,
     source       varchar(20)  not null comment '第三方用户来源',
-    open_id      varchar(20)  null comment '第三方用户的 open id',
-    uid          varchar(20)  null comment '第三方用户的 ID',
-    union_id     varchar(20)  null comment '第三方用户的 union id',
+    open_id      varchar(20)  null comment '第三方用户 open id',
+    sid          varchar(20)  null comment '第三方用户 ID',
+    union_id     varchar(20)  null comment '第三方用户 union id',
     scope        varchar(120) null comment '第三方用户授予的权限',
     code         varchar(50)  null comment '用户的授权 code',
     user_id      int          null comment '用户关联ID',
@@ -437,3 +437,4 @@ create index ix_sys_user_social_id
 
 create index user_id
     on sys_user_social (user_id);
+

backend/sql/mysql/create_tables.sql

@@ -6,13 +6,13 @@ values  (1, '测试', 'Test', 'test', 0, null, 0, null, null, 0, 0, 1, null, nul
         (2, '仪表盘', 'Dashboard', 'dashboard', 0, 'material-symbols:dashboard', 0, null, null, 1, 1, 1, null, null, null, '2023-07-27 19:15:45', null),
         (3, '工作台', 'Workspace', 'workspace', 0, null, 1, '/dashboard/workspace/index.vue', null, 1, 1, 1, null, null, 2, '2023-07-27 19:17:59', null),
         (4, '数据分析', 'Analytics', 'analytics', 0, null, 1, '/dashboard/analytics/index.vue', null, 1, 1, 1, null, null, 2, '2023-07-27 19:17:59', null),
-        (5, '系统管理', 'Admin', 'admin', 0, 'eos-icons:admin', 0, null, null, 1, 1, 1, null, null, null, '2023-07-27 19:23:00', null),
-        (6, '部门管理', 'SysDept', 'sys-dept', 0, null, 1, '/admin/dept/index.vue', null, 1, 1, 1, null, null, 5, '2023-07-27 19:23:42', null),
-        (7, '用户管理', 'SysUser', 'sys-user', 0, null, 1, '/admin/user/index.vue', null, 1, 1, 1, null, null, 5, '2023-07-27 19:25:13', null),
-        (8, '角色管理', 'SysRole', 'sys-role', 0, null, 1, '/admin/role/index.vue', null, 1, 1, 1, null, null, 5, '2023-07-27 19:25:45', null),
-        (9, '菜单管理', 'SysMenu', 'sys-menu', 0, null, 1, '/admin/menu/index.vue', null, 1, 1, 1, null, null, 5, '2023-07-27 19:45:29', null),
-        (10, 'API 管理', 'SysApi', 'sys-api', 0, null, 1, '/admin/api/index.vue', null, 1, 1, 1, null, null, 5, '2023-07-27 19:24:12', null),
-        (11, '数据规则管理', 'SysDataRule', 'sys-data-rule', 0, null, 1, '/admin/data-rule/index.vue', null, 1, 1, 1, null, null, 5, '2023-07-27 19:24:12', null),
+        (5, '系统管理', 'System', 'system', 0, 'eos-icons:admin', 0, null, null, 1, 1, 1, null, null, null, '2023-07-27 19:23:00', null),
+        (6, '部门管理', 'SysDept', 'sys-dept', 0, null, 1, '/system/dept/index.vue', null, 1, 1, 1, null, null, 5, '2023-07-27 19:23:42', null),
+        (7, '用户管理', 'SysUser', 'sys-user', 0, null, 1, '/system/user/index.vue', null, 1, 1, 1, null, null, 5, '2023-07-27 19:25:13', null),
+        (8, '角色管理', 'SysRole', 'sys-role', 0, null, 1, '/system/role/index.vue', null, 1, 1, 1, null, null, 5, '2023-07-27 19:25:45', null),
+        (9, '菜单管理', 'SysMenu', 'sys-menu', 0, null, 1, '/system/menu/index.vue', null, 1, 1, 1, null, null, 5, '2023-07-27 19:45:29', null),
+        (10, '插件管理', 'SysPlugin', 'sys-plugin', 0, null, 1, '/system/plugin/index.vue', null, 1, 1, 1, null, null, 5, '2023-07-27 19:24:12', null),
+        (11, '数据权限', 'SysDataPermission', 'sys-data-permission', 0, null, 1, '/system/data-permission/index.vue', null, 1, 1, 1, null, null, 5, '2023-07-27 19:24:12', null),
         (12, '系统自动化', 'Automation', 'automation', 0, 'material-symbols:automation', 0, null, null, 1, 1, 1, null, null, null, '2024-07-27 02:06:20', null),
         (13, '代码生成', 'CodeGenerator', 'code-generator', 0, null, 1, '/automation/code-generator/index.vue', null, 1, 1, 1, null, null, 12, '2024-07-27 12:24:54', null),
         (14, '系统监控', 'Monitor', 'monitor', 0, 'mdi:monitor-eye', 0, null, null, 1, 1, 1, null, null, null, '2023-07-27 19:27:08', null),

backend/sql/mysql/init_test_data.sql

@@ -727,7 +727,7 @@ create table sys_user_social
         primary key,
     source       varchar(20)              not null,
     open_id      varchar(20),
-    uid          varchar(20),
+    sid          varchar(20),
     union_id     varchar(20),
     scope        varchar(120),
     code         varchar(50),
@@ -744,11 +744,11 @@ comment on column sys_user_social.id is '主键 ID';
 
 comment on column sys_user_social.source is '第三方用户来源';
 
-comment on column sys_user_social.open_id is '第三方用户的 open id';
+comment on column sys_user_social.open_id is '第三方用户 open id';
 
-comment on column sys_user_social.uid is '第三方用户的 ID';
+comment on column sys_user_social.uid is '第三方用户 ID';
 
-comment on column sys_user_social.union_id is '第三方用户的 union id';
+comment on column sys_user_social.union_id is '第三方用户 union id';
 
 comment on column sys_user_social.scope is '第三方用户授予的权限';
 

backend/sql/postgresql/create_tables.sql

@@ -6,13 +6,13 @@ values  (1, '测试', 'Test', 'test', 0, null, 0, null, null, 0, 0, 1, null, nul
         (2, '仪表盘', 'Dashboard', 'dashboard', 0, 'material-symbols:dashboard', 0, null, null, 1, 1, 1, null, null, null, '2023-07-27 19:15:45', null),
         (3, '工作台', 'Workspace', 'workspace', 0, null, 1, '/dashboard/workspace/index.vue', null, 1, 1, 1, null, null, 2, '2023-07-27 19:17:59', null),
         (4, '数据分析', 'Analytics', 'analytics', 0, null, 1, '/dashboard/analytics/index.vue', null, 1, 1, 1, null, null, 2, '2023-07-27 19:17:59', null),
-        (5, '系统管理', 'Admin', 'admin', 0, 'eos-icons:admin', 0, null, null, 1, 1, 1, null, null, null, '2023-07-27 19:23:00', null),
-        (6, '部门管理', 'SysDept', 'sys-dept', 0, null, 1, '/admin/dept/index.vue', null, 1, 1, 1, null, null, 5, '2023-07-27 19:23:42', null),
-        (7, '用户管理', 'SysUser', 'sys-user', 0, null, 1, '/admin/user/index.vue', null, 1, 1, 1, null, null, 5, '2023-07-27 19:25:13', null),
-        (8, '角色管理', 'SysRole', 'sys-role', 0, null, 1, '/admin/role/index.vue', null, 1, 1, 1, null, null, 5, '2023-07-27 19:25:45', null),
-        (9, '菜单管理', 'SysMenu', 'sys-menu', 0, null, 1, '/admin/menu/index.vue', null, 1, 1, 1, null, null, 5, '2023-07-27 19:45:29', null),
-        (10, 'API 管理', 'SysApi', 'sys-api', 0, null, 1, '/admin/api/index.vue', null, 1, 1, 1, null, null, 5, '2023-07-27 19:24:12', null),
-        (11, '数据规则管理', 'SysDataRule', 'sys-data-rule', 0, null, 1, '/admin/data-rule/index.vue', null, 1, 1, 1, null, null, 5, '2023-07-27 19:24:12', null),
+        (5, '系统管理', 'System', 'system', 0, 'eos-icons:admin', 0, null, null, 1, 1, 1, null, null, null, '2023-07-27 19:23:00', null),
+        (6, '部门管理', 'SysDept', 'sys-dept', 0, null, 1, '/system/dept/index.vue', null, 1, 1, 1, null, null, 5, '2023-07-27 19:23:42', null),
+        (7, '用户管理', 'SysUser', 'sys-user', 0, null, 1, '/system/user/index.vue', null, 1, 1, 1, null, null, 5, '2023-07-27 19:25:13', null),
+        (8, '角色管理', 'SysRole', 'sys-role', 0, null, 1, '/system/role/index.vue', null, 1, 1, 1, null, null, 5, '2023-07-27 19:25:45', null),
+        (9, '菜单管理', 'SysMenu', 'sys-menu', 0, null, 1, '/system/menu/index.vue', null, 1, 1, 1, null, null, 5, '2023-07-27 19:45:29', null),
+        (10, '插件管理', 'SysPlugin', 'sys-plugin', 0, null, 1, '/system/plugin/index.vue', null, 1, 1, 1, null, null, 5, '2023-07-27 19:24:12', null),
+        (11, '数据权限', 'SysDataPermission', 'sys-data-permission', 0, null, 1, '/system/data-permission/index.vue', null, 1, 1, 1, null, null, 5, '2023-07-27 19:24:12', null),
         (12, '系统自动化', 'Automation', 'automation', 0, 'material-symbols:automation', 0, null, null, 1, 1, 1, null, null, null, '2024-07-27 02:06:20', null),
         (13, '代码生成', 'CodeGenerator', 'code-generator', 0, null, 1, '/automation/code-generator/index.vue', null, 1, 1, 1, null, null, 12, '2024-07-27 12:24:54', null),
         (14, '系统监控', 'Monitor', 'monitor', 0, 'mdi:monitor-eye', 0, null, null, 1, 1, 1, null, null, null, '2023-07-27 19:27:08', null),

backend/sql/postgresql/init_test_data.sql

@@ -28,7 +28,6 @@ dependencies = [
     "fast-captcha>=0.3.2",
     "fastapi-cli==0.0.5",
     "fastapi-limiter>=0.1.6",
-    "fastapi-oauth20>=0.0.1",
     "fastapi-pagination>=0.13.0",
     "fastapi[standard]==0.115.11",
     "flower>=2.0.0",

pyproject.toml

@@ -97,8 +97,6 @@ fastapi-cli==0.0.5
     #   fastapi-best-architecture
 fastapi-limiter==0.1.6
     # via fastapi-best-architecture
-fastapi-oauth20==0.0.1
-    # via fastapi-best-architecture
 fastapi-pagination==0.13.0
     # via fastapi-best-architecture
 filelock==3.18.0
@@ -123,9 +121,7 @@ httpcore==1.0.7
 httptools==0.6.4
     # via uvicorn
 httpx==0.28.1
-    # via
-    #   fastapi
-    #   fastapi-oauth20
+    # via fastapi
 humanize==4.12.2
     # via flower
 identify==2.6.9