feat✨: 新增Web UI功能及数据库、日志等API接口

zhenxun/plugins/web_ui/api/tabs/database/__init__.py

@@ -0,0 +1,121 @@
+import nonebot
+from fastapi import APIRouter, Request
+from nonebot.drivers import Driver
+from tortoise import Tortoise
+from tortoise.exceptions import OperationalError
+
+from zhenxun.models.plugin_info import PluginInfo
+from zhenxun.services.db_context import TestSQL
+
+from ....base_model import BaseResultModel, QueryModel, Result
+from ....utils import authentication
+from .models.model import SqlModel, SqlText
+from .models.sql_log import SqlLog
+
+router = APIRouter(prefix="/database")
+
+
+driver: Driver = nonebot.get_driver()
+
+
+SQL_DICT = {}
+
+
+SELECT_TABLE_SQL = """
+select a.tablename as name,d.description as desc from pg_tables a
+    left join pg_class c on relname=tablename
+    left join pg_description d on oid=objoid and objsubid=0 where a.schemaname = 'public'
+"""
+
+SELECT_TABLE_COLUMN_SQL = """
+SELECT column_name, data_type, character_maximum_length as max_length, is_nullable
+FROM information_schema.columns
+WHERE table_name = '{}';
+"""
+
+
+@driver.on_startup
+async def _():
+    for plugin in nonebot.get_loaded_plugins():
+        module = plugin.name
+        sql_list = []
+        if plugin.metadata and plugin.metadata.extra:
+            sql_list = plugin.metadata.extra.get("sql_list")
+        if module in SQL_DICT:
+            raise ValueError(f"{module} 常用SQL module 重复")
+        if sql_list:
+            SqlModel(
+                name="",
+                module=module,
+                sql_list=sql_list,
+            )
+            SQL_DICT[module] = SqlModel
+    if SQL_DICT:
+        result = await PluginInfo.filter(module__in=SQL_DICT.keys()).values_list(
+            "module", "name"
+        )
+        module2name = {r[0]: r[1] for r in result}
+        for s in SQL_DICT:
+            module = SQL_DICT[s].module
+            if module in module2name:
+                SQL_DICT[s].name = module2name[module]
+            else:
+                SQL_DICT[s].name = module
+
+
+@router.get(
+    "/get_table_list", dependencies=[authentication()], description="获取数据库表"
+)
+async def _() -> Result:
+    db = Tortoise.get_connection("default")
+    query = await db.execute_query_dict(SELECT_TABLE_SQL)
+    return Result.ok(query)
+
+
+@router.get(
+    "/get_table_column", dependencies=[authentication()], description="获取表字段"
+)
+async def _(table_name: str) -> Result:
+    db = Tortoise.get_connection("default")
+    print(SELECT_TABLE_COLUMN_SQL.format(table_name))
+    query = await db.execute_query_dict(SELECT_TABLE_COLUMN_SQL.format(table_name))
+    return Result.ok(query)
+
+
+@router.post("/exec_sql", dependencies=[authentication()], description="执行sql")
+async def _(sql: SqlText, request: Request) -> Result:
+    ip = request.client.host if request.client else "unknown"
+    try:
+        if sql.sql.lower().startswith("select"):
+            db = Tortoise.get_connection("default")
+            res = await db.execute_query_dict(sql.sql)
+            await SqlLog.add(ip or "0.0.0.0", sql.sql, "")
+            return Result.ok(res, "执行成功啦!")
+        else:
+            result = await TestSQL.raw(sql.sql)
+            await SqlLog.add(ip or "0.0.0.0", sql.sql, str(result))
+            return Result.ok(info="执行成功啦!")
+    except OperationalError as e:
+        await SqlLog.add(ip or "0.0.0.0", sql.sql, str(e), False)
+        return Result.warning_(f"sql执行错误: {e}")
+
+
+@router.post("/get_sql_log", dependencies=[authentication()], description="sql日志列表")
+async def _(query: QueryModel) -> Result:
+    total = await SqlLog.all().count()
+    if total % query.size:
+        total += 1
+    data = (
+        await SqlLog.all()
+        .order_by("-id")
+        .offset((query.index - 1) * query.size)
+        .limit(query.size)
+    )
+    return Result.ok(BaseResultModel(total=total, data=data))
+
+
+@router.get("/get_common_sql", dependencies=[authentication()], description="常用sql")
+async def _(plugin_name: str | None = None) -> Result:
+    if plugin_name:
+        return Result.ok(SQL_DICT.get(plugin_name))
+    return Result.ok(str(SQL_DICT))

zhenxun/plugins/web_ui/api/tabs/database/models/model.py

@@ -0,0 +1,24 @@
+from pydantic import BaseModel
+
+from zhenxun.utils.plugin_models.base import CommonSql
+
+
+class SqlText(BaseModel):
+    """
+    sql语句
+    """
+
+    sql: str
+
+
+class SqlModel(BaseModel):
+    """
+    常用sql
+    """
+
+    name: str
+    """插件中文名称"""
+    module: str
+    """插件名称"""
+    sql_list: list[CommonSql]
+    """插件列表"""

zhenxun/plugins/web_ui/api/tabs/database/models/sql_log.py

@@ -0,0 +1,37 @@
+from tortoise import fields
+
+from zhenxun.services.db_context import Model
+
+
+class SqlLog(Model):
+
+    id = fields.IntField(pk=True, generated=True, auto_increment=True)
+    """自增id"""
+    ip = fields.CharField(255)
+    """ip"""
+    sql = fields.CharField(255)
+    """sql"""
+    result = fields.CharField(255, null=True)
+    """结果"""
+    is_suc = fields.BooleanField(default=True)
+    """是否成功"""
+    create_time = fields.DatetimeField(auto_now_add=True)
+    """创建时间"""
+
+    class Meta:
+        table = "sql_log"
+        table_description = "sql执行日志"
+
+    @classmethod
+    async def add(
+        cls, ip: str, sql: str, result: str | None = None, is_suc: bool = True
+    ):
+        """获取用户在群内的等级
+
+        参数:
+            ip: ip
+            sql: sql
+            result: 返回结果
+            is_suc: 是否成功
+        """
+        await cls.create(ip=ip, sql=sql, result=result, is_suc=is_suc)