refactor: Add logs to the system operation method

ziyujiahao · ziyujiahao · commit 1df98cec0ff1 · 2025-12-26T17:14:34.000+08:00
diff --git a/backend/apps/chat/api/chat.py b/backend/apps/chat/api/chat.py
@@ -21,8 +21,8 @@
 from common.core.deps import CurrentAssistant, SessionDep, CurrentUser, Trans
 from common.utils.command_utils import parse_quick_command
 from common.utils.data_format import DataFormat
-from sqlbot_xpack.audit.models.log_model import OperationType, OperationModules
-from sqlbot_xpack.audit.schemas.logger_decorator import LogConfig, system_log
+from common.audit.models.log_model import OperationType, OperationModules
+from common.audit.schemas.logger_decorator import LogConfig, system_log
 
 router = APIRouter(tags=["Data Q&A"], prefix="/chat")
 
diff --git a/backend/apps/dashboard/api/dashboard_api.py b/backend/apps/dashboard/api/dashboard_api.py
@@ -3,8 +3,8 @@
 from apps.dashboard.crud.dashboard_service import list_resource, load_resource, \
     create_resource, create_canvas, validate_name, delete_resource, update_resource, update_canvas
 from apps.dashboard.models.dashboard_model import CreateDashboard, BaseDashboard, QueryDashboard, DashboardResponse
-from sqlbot_xpack.audit.models.log_model import OperationType, OperationModules
-from sqlbot_xpack.audit.schemas.logger_decorator import LogConfig, system_log
+from common.audit.models.log_model import OperationType, OperationModules
+from common.audit.schemas.logger_decorator import LogConfig, system_log
 from common.core.deps import SessionDep, CurrentUser
 
 router = APIRouter(tags=["dashboard"], prefix="/dashboard")
diff --git a/backend/apps/data_training/api/data_training.py b/backend/apps/data_training/api/data_training.py
@@ -19,8 +19,8 @@
 from common.core.deps import SessionDep, CurrentUser, Trans
 from common.utils.data_format import DataFormat
 from common.utils.excel import get_excel_column_count
-from sqlbot_xpack.audit.models.log_model import OperationType, OperationModules
-from sqlbot_xpack.audit.schemas.logger_decorator import LogConfig, system_log
+from common.audit.models.log_model import OperationType, OperationModules
+from common.audit.schemas.logger_decorator import LogConfig, system_log
 
 router = APIRouter(tags=["SQL Examples"], prefix="/system/data-training")
 
diff --git a/backend/apps/datasource/api/datasource.py b/backend/apps/datasource/api/datasource.py
@@ -28,8 +28,8 @@
 from ..crud.table import get_tables_by_ds_id
 from ..models.datasource import CoreDatasource, CreateDatasource, TableObj, CoreTable, CoreField, FieldObj, \
     TableSchemaResponse, ColumnSchemaResponse, PreviewResponse
-from sqlbot_xpack.audit.models.log_model import OperationType, OperationModules
-from sqlbot_xpack.audit.schemas.logger_decorator import LogConfig, system_log
+from common.audit.models.log_model import OperationType, OperationModules
+from common.audit.schemas.logger_decorator import LogConfig, system_log
 
 router = APIRouter(tags=["Datasource"], prefix="/datasource")
 path = settings.EXCEL_PATH
diff --git a/backend/apps/datasource/api/recommended_problem.py b/backend/apps/datasource/api/recommended_problem.py
@@ -5,8 +5,8 @@
     save_recommended_problem, get_datasource_recommended_base
 from apps.datasource.models.datasource import RecommendedProblemBase
 from common.core.deps import SessionDep, CurrentUser
-from sqlbot_xpack.audit.models.log_model import OperationType, OperationModules
-from sqlbot_xpack.audit.schemas.logger_decorator import LogConfig, system_log
+from common.audit.models.log_model import OperationType, OperationModules
+from common.audit.schemas.logger_decorator import LogConfig, system_log
 
 router = APIRouter(tags=["recommended_problem"], prefix="/recommended_problem")
 
diff --git a/backend/apps/system/api/aimodel.py b/backend/apps/system/api/aimodel.py
@@ -16,8 +16,8 @@
 from common.utils.utils import SQLBotLogUtil, prepare_model_arg
 
 router = APIRouter(tags=["system_model"], prefix="/system/aimodel")
-from sqlbot_xpack.audit.models.log_model import OperationType, OperationModules
-from sqlbot_xpack.audit.schemas.logger_decorator import LogConfig, system_log
+from common.audit.models.log_model import OperationType, OperationModules
+from common.audit.schemas.logger_decorator import LogConfig, system_log
 
 @router.post("/status", include_in_schema=False)
 @require_permissions(permission=SqlbotPermission(role=['admin'])) 
diff --git a/backend/apps/system/api/apikey.py b/backend/apps/system/api/apikey.py
@@ -9,8 +9,8 @@
 import secrets
 
 router = APIRouter(tags=["system_apikey"], prefix="/system/apikey", include_in_schema=False)
-from sqlbot_xpack.audit.models.log_model import OperationType, OperationModules
-from sqlbot_xpack.audit.schemas.logger_decorator import LogConfig, system_log
+from common.audit.models.log_model import OperationType, OperationModules
+from common.audit.schemas.logger_decorator import LogConfig, system_log
 
 @router.get("")
 async def grid(session: SessionDep, current_user: CurrentUser) -> list[ApikeyGridItem]:
diff --git a/backend/apps/system/api/assistant.py b/backend/apps/system/api/assistant.py
@@ -21,8 +21,8 @@
 from common.utils.utils import get_origin_from_referer, origin_match_domain
 
 router = APIRouter(tags=["system_assistant"], prefix="/system/assistant")
-from sqlbot_xpack.audit.models.log_model import OperationType, OperationModules
-from sqlbot_xpack.audit.schemas.logger_decorator import LogConfig, system_log
+from common.audit.models.log_model import OperationType, OperationModules
+from common.audit.schemas.logger_decorator import LogConfig, system_log
 
 
 @router.get("/info/{id}", include_in_schema=False)
diff --git a/backend/apps/system/api/login.py b/backend/apps/system/api/login.py
@@ -12,8 +12,8 @@
 from common.core.schemas import Token
 from sqlbot_xpack.authentication.manage import logout as xpack_logout
 
-from sqlbot_xpack.audit.models.log_model import OperationType, OperationModules
-from sqlbot_xpack.audit.schemas.logger_decorator import system_log, LogConfig
+from common.audit.models.log_model import OperationType, OperationModules
+from common.audit.schemas.logger_decorator import system_log, LogConfig
 
 router = APIRouter(tags=["login"], prefix="/login")
 
diff --git a/backend/apps/system/api/parameter.py b/backend/apps/system/api/parameter.py
@@ -6,8 +6,8 @@
 from common.core.deps import SessionDep
 
 router = APIRouter(tags=["system/parameter"], prefix="/system/parameter", include_in_schema=False)
-from sqlbot_xpack.audit.models.log_model import OperationType, OperationModules
-from sqlbot_xpack.audit.schemas.logger_decorator import LogConfig, system_log
+from common.audit.models.log_model import OperationType, OperationModules
+from common.audit.schemas.logger_decorator import LogConfig, system_log
 
 @router.get("/login")
 async def get_login_args(session: SessionDep) -> list[SysArgModel]:
diff --git a/backend/apps/system/api/user.py b/backend/apps/system/api/user.py
@@ -9,8 +9,8 @@
 from apps.system.schemas.auth import CacheName, CacheNamespace
 from apps.system.schemas.permission import SqlbotPermission, require_permissions
 from apps.system.schemas.system_schema import PwdEditor, UserCreator, UserEditor, UserGrid, UserInfoDTO, UserLanguage, UserStatus, UserWs
-from sqlbot_xpack.audit.models.log_model import OperationType, OperationModules
-from sqlbot_xpack.audit.schemas.logger_decorator import LogConfig, system_log
+from common.audit.models.log_model import OperationType, OperationModules
+from common.audit.schemas.logger_decorator import LogConfig, system_log
 from common.core.deps import CurrentUser, SessionDep, Trans
 from common.core.pagination import Paginator
 from common.core.schemas import PaginatedResponse, PaginationParams
diff --git a/backend/apps/system/api/workspace.py b/backend/apps/system/api/workspace.py
@@ -8,8 +8,8 @@
 from apps.system.models.user import UserModel
 from apps.system.schemas.permission import SqlbotPermission, require_permissions
 from apps.system.schemas.system_schema import UserWsBase, UserWsDTO, UserWsEditor, UserWsOption, WorkspaceUser
-from sqlbot_xpack.audit.models.log_model import OperationType, OperationModules
-from sqlbot_xpack.audit.schemas.logger_decorator import system_log, LogConfig
+from common.audit.models.log_model import OperationType, OperationModules
+from common.audit.schemas.logger_decorator import system_log, LogConfig
 from common.core.deps import CurrentUser, SessionDep, Trans
 from common.core.pagination import Paginator
 from common.core.schemas import PaginatedResponse, PaginationParams
diff --git a/backend/apps/terminology/api/terminology.py b/backend/apps/terminology/api/terminology.py
@@ -19,8 +19,8 @@
 from common.core.deps import SessionDep, CurrentUser, Trans
 from common.utils.data_format import DataFormat
 from common.utils.excel import get_excel_column_count
-from sqlbot_xpack.audit.models.log_model import OperationType, OperationModules
-from sqlbot_xpack.audit.schemas.logger_decorator import LogConfig, system_log
+from common.audit.models.log_model import OperationType, OperationModules
+from common.audit.schemas.logger_decorator import LogConfig, system_log
 router = APIRouter(tags=["Terminology"], prefix="/system/terminology")
 
 
diff --git a/backend/common/audit/__init__.py b/backend/common/audit/__init__.py
diff --git a/backend/common/audit/models/__init__.py b/backend/common/audit/models/__init__.py
diff --git a/backend/common/audit/models/log_model.py b/backend/common/audit/models/log_model.py
@@ -0,0 +1,90 @@
+from sqlmodel import Field, SQLModel
+from datetime import datetime
+from typing import Optional
+from enum import Enum
+from pydantic import BaseModel
+
+class OperationModules(str, Enum):
+    CHAT = "chat"  # 问数
+    DATASOURCE = "datasource"  # 数据源
+    DASHBOARD = "dashboard"  # 仪表板
+    MEMBER = "member"  # 成员
+    PERMISSION = "permission"  # 权限
+    RULES = "rules"  # q组
+    TERMINOLOGY = "terminology"  # 术语
+    DATA_TRAINING = "data_training"  # SQL 示例库
+    PROMPT_WORDS = "prompt_words"  # 自定义提示词
+    USER = "user"  # 用户
+    WORKSPACE = "workspace"  # 工作空间
+    AI_MODEL = "ai_model"  # AI 模型
+    APPLICATION = "application"  # 嵌入式管理 应用
+    THEME = "theme"  # 外观配置
+    PARAMS_SETTING = "params_setting"  # 参数配置
+    API_KEY = "api_key"  # api key
+    LOG_SETTING = "log_setting"  # api key
+
+class OperationStatus(str, Enum):
+    SUCCESS = "success"
+    FAILED = "failed"
+
+class OperationType(str, Enum):
+    CREATE = "create"
+    DELETE = "delete"
+    UPDATE = "update"
+    EDIT = "edit"
+    LOGIN = "login"
+    VIEW = "view"
+    EXPORT = "export"
+    IMPORT = "import"
+    ADD = "add"
+    CREATE_OR_UPDATE = "create_or_update"
+
+
+class SystemLog(SQLModel, table=True):
+    __tablename__ = "sys_logs"
+    id: Optional[int] = Field(default=None, primary_key=True)
+    operation_type: str = Field(default=None)
+    operation_detail: str = Field(default=None)
+    user_id: Optional[int] = Field(default=None)
+    operation_status: str = Field(default=None)
+    ip_address: Optional[str] = Field(default=None)
+    user_agent: Optional[str] = Field(default=None)
+    execution_time: int = Field(default=0, description="执行时间(毫秒)")
+    error_message: Optional[str] = Field(default=None)
+    create_time: datetime = Field(default_factory=datetime.now)
+    module: Optional[str] = Field(default=None)
+    oid: Optional[int] = Field(default=None)
+    resource_id: Optional[str] = Field(default=None)
+    request_method: Optional[str] = Field(default=None)
+    request_path: Optional[str] = Field(default=None)
+    remark: Optional[str] = Field(default=None)
+    user_name: Optional[str] = Field(default=None)
+    resource_name: Optional[str] = Field(default=None)
+
+
+class SystemLogInfo(BaseModel):
+    id: str = Field(default=None)
+    operation_type_name: str = Field(default=None)
+    operation_detail_info: str = Field(default=None)
+    user_name: str = Field(default=None)
+    resource_name: str = Field(default=None)
+    operation_status:  str = Field(default=None)
+    ip_address: Optional[str] = Field(default=None)
+    create_time: datetime = Field(default_factory=datetime.now)
+    oid_list:  str = Field(default=None)
+    remark:  str = Field(default=None)
+
+class SystemLogInfoResult(BaseModel):
+    id: str = Field(default=None)
+    operation_type_name: str = Field(default=None)
+    operation_detail_info: str = Field(default=None)
+    user_name: str = Field(default=None)
+    resource_name: str = Field(default=None)
+    operation_status:  str = Field(default=None)
+    operation_status_name:  str = Field(default=None)
+    ip_address: Optional[str] = Field(default=None)
+    create_time: datetime = Field(default_factory=datetime.now)
+    oid_name:  str = Field(default=None)
+    oid:  str = Field(default=None)
+    error_message:  str = Field(default=None)
+    remark:  str = Field(default=None)
diff --git a/backend/common/audit/schemas/__init__.py b/backend/common/audit/schemas/__init__.py
diff --git a/backend/common/audit/schemas/log_utils.py b/backend/common/audit/schemas/log_utils.py
@@ -0,0 +1,144 @@
+from sqlalchemy import select, func
+from sqlalchemy.sql import Select
+from sqlalchemy import String, union_all
+
+from apps.chat.models.chat_model import Chat
+from apps.dashboard.models.dashboard_model import CoreDashboard
+from apps.data_training.models.data_training_model import DataTraining
+from apps.datasource.models.datasource import CoreDatasource
+from apps.system.models.system_model import WorkspaceModel, AiModelDetail, ApiKeyModel
+from apps.system.models.user import UserModel
+from apps.terminology.models.terminology_model import Terminology
+from apps.system.models.system_model import AssistantModel
+
+from sqlbot_xpack.permissions.models.ds_rules import DsRules
+from sqlbot_xpack.custom_prompt.models.custom_prompt_model import CustomPrompt
+from sqlbot_xpack.permissions.models.ds_permission import DsPermission
+from sqlalchemy import literal_column
+
+
+def build_resource_union_query() -> Select:
+    """
+    构建资源名称的union查询
+    返回包含id, name, module的查询
+    """
+    # 创建各个子查询，每个查询都包含module字段
+
+    # ai_model 表查询
+    ai_model_query = select(
+        func.cast(AiModelDetail.id, String).label("id"),
+        AiModelDetail.name.label("name"),
+        literal_column("'ai_model'").label("module")
+    ).select_from(AiModelDetail)
+
+    # chat 表查询（使用brief作为name）
+    chat_query = select(
+        func.cast(Chat.id, String).label("id"),
+        Chat.brief.label("name"),
+        literal_column("'chat'").label("module")
+    ).select_from(Chat)
+
+    # dashboard 表查询
+    dashboard_query = select(
+        func.cast(CoreDashboard.id, String).label("id"),
+        CoreDashboard.name.label("name"),
+        literal_column("'dashboard'").label("module")
+    ).select_from(CoreDashboard)
+
+    # datasource 表查询
+    datasource_query = select(
+        func.cast(CoreDatasource.id, String).label("id"),
+        CoreDatasource.name.label("name"),
+        literal_column("'datasource'").label("module")
+    ).select_from(CoreDatasource)
+
+    # custom_prompt 表查询
+    custom_prompt_query = select(
+        func.cast(CustomPrompt.id, String).label("id"),
+        CustomPrompt.name.label("name"),
+        literal_column("'prompt_words'").label("module")
+    ).select_from(CustomPrompt)
+
+    # data_training 表查询（使用question作为name）
+    data_training_query = select(
+        func.cast(DataTraining.id, String).label("id"),
+        DataTraining.question.label("name"),
+        literal_column("'data_training'").label("module")
+    ).select_from(DataTraining)
+
+    # ds_permission 表查询
+    ds_permission_query = select(
+        func.cast(DsPermission.id, String).label("id"),
+        DsPermission.name.label("name"),
+        literal_column("'permission'").label("module")
+    ).select_from(DsPermission)
+
+    # ds_rules 表查询
+    ds_rules_query = select(
+        func.cast(DsRules.id, String).label("id"),
+        DsRules.name.label("name"),
+        literal_column("'rules'").label("module")
+    ).select_from(DsRules)
+
+    # sys_user 表查询
+    user_query = select(
+        func.cast(UserModel.id, String).label("id"),
+        UserModel.name.label("name"),
+        literal_column("'user'").label("module")
+    ).select_from(UserModel)
+
+    # sys_user 表查询
+    member_query = select(
+        func.cast(UserModel.id, String).label("id"),
+        UserModel.name.label("name"),
+        literal_column("'member'").label("module")
+    ).select_from(UserModel)
+
+    # sys_workspace 表查询
+    sys_workspace_query = select(
+        func.cast(WorkspaceModel.id, String).label("id"),
+        WorkspaceModel.name.label("name"),
+        literal_column("'workspace'").label("module")
+    ).select_from(WorkspaceModel)
+
+    # terminology 表查询（使用word作为name）
+    terminology_query = select(
+        func.cast(Terminology.id, String).label("id"),
+        Terminology.word.label("name"),
+        literal_column("'terminology'").label("module")
+    ).select_from(Terminology)
+
+    # sys_assistant 表查询
+    sys_assistant_query = select(
+        func.cast(AssistantModel.id, String).label("id"),
+        AssistantModel.name.label("name"),
+        literal_column("'application'").label("module")
+    ).select_from(AssistantModel)
+
+    # sys_apikey 表查询
+    sys_apikey_query = select(
+        func.cast(ApiKeyModel.id, String).label("id"),
+        ApiKeyModel.access_key.label("name"),
+        literal_column("'api_key'").label("module")
+    ).select_from(ApiKeyModel)
+
+    # 使用 union_all() 方法连接所有查询
+    union_query = union_all(
+        ai_model_query,
+        chat_query,
+        dashboard_query,
+        datasource_query,
+        custom_prompt_query,
+        data_training_query,
+        ds_permission_query,
+        ds_rules_query,
+        user_query,
+        member_query,
+        sys_workspace_query,
+        terminology_query,
+        sys_assistant_query,
+        sys_apikey_query
+    )
+
+    # 返回查询，包含所有字段
+    return select(union_query.c.id, union_query.c.name, union_query.c.module)
diff --git a/backend/common/audit/schemas/logger_decorator.py b/backend/common/audit/schemas/logger_decorator.py
diff --git a/backend/common/audit/schemas/request_context.py b/backend/common/audit/schemas/request_context.py
diff --git a/backend/main.py b/backend/main.py
