feat✨: 添加shortcut和usage

zhenxun/builtin_plugins/chat_history/chat_message_handle.py

@@ -25,9 +25,20 @@ from zhenxun.utils.enum import PluginType
 from zhenxun.utils.image_utils import ImageTemplate
 
 __plugin_meta__ = PluginMetadata(
-    name="消息统计查询",
+    name="消息统计",
     description="消息统计查询",
-    usage="",
+    usage="""
+    格式:
+    消息排行 ?[type [日,周,月,年]] ?[--des]
+
+    快捷:
+    [日,周,月,年]消息排行
+
+    示例:
+    消息排行            : 所有记录排行
+    日消息排行          : 今日记录排行
+    消息排行 周 --des    : 逆序周记录排行
+    """.strip(),
     extra=PluginExtraData(
         author="HibiKier",
         version="0.1",
@@ -36,7 +47,6 @@ __plugin_meta__ = PluginMetadata(
     ).dict(),
 )
 
-# TODO: shortcut
 
 _matcher = on_alconna(
     Alconna(
@@ -51,7 +61,7 @@ _matcher = on_alconna(
 _matcher.shortcut(
     r"(?P<type>.+)?消息排行",
     command="消息排行",
-    arguments=["type", "{type}"],
+    arguments=["{type}"],
     prefix=True,
 )
 

zhenxun/builtin_plugins/help/_utils.py

@@ -54,7 +54,7 @@ class HelpImageBuild:
                     self._sort_data[menu_type] = []
                 self._sort_data[menu_type].append(plugin)
 
-    async def build_image(self, group_id: int | None):
+    async def build_image(self, group_id: str | None):
         if group_id:
             help_image = GROUP_HELP_PATH / f"{group_id}.png"
         else:
@@ -68,7 +68,7 @@ class HelpImageBuild:
             img = await self.build_pil_image(group_id)
             await img.save(help_image)
 
-    async def build_html_image(self, group_id: int | None) -> bytes:
+    async def build_html_image(self, group_id: str | None) -> bytes:
         from nonebot_plugin_htmlrender import template_to_pic
 
         await self.sort_type()
@@ -133,7 +133,7 @@ class HelpImageBuild:
         )
         return pic
 
-    async def build_pil_image(self, group_id: int | None) -> BuildImage:
+    async def build_pil_image(self, group_id: str | None) -> BuildImage:
         """构造帮助图片
 
         参数:

zhenxun/builtin_plugins/hooks/chkdsk_hook.py

@@ -77,7 +77,7 @@ async def _(matcher: Matcher, bot: Bot, session: EventSession, state: T_State):
         raise ValueError("模块: [hook], 配置项: [MALICIOUS_BAN_TIME] 为空或小于0")
     if user_id:
         command = state["_prefix"]["raw_command"]
-        if state["_alc_result"]:
+        if state.get("_alc_result"):
             command = state["_alc_result"].source.command
         if command:
             if _blmt.check(f"{user_id}__{command}"):

zhenxun/builtin_plugins/sign_in/__init__.py

@@ -25,7 +25,8 @@ __plugin_meta__ = PluginMetadata(
     usage="""
     每日签到
     会影响色图概率和开箱次数，以及签到的随机道具获取
-    指令：
+    指令:
+        签到
         我的签到
         好感度排行
     * 签到时有 3% 概率 * 2 *
@@ -88,7 +89,19 @@ _sign_matcher = on_alconna(
     block=True,
 )
 
-# TODO: shortcut
+_sign_matcher.shortcut(
+    "我的签到",
+    command="签到",
+    arguments=["--my"],
+    prefix=True,
+)
+
+_sign_matcher.shortcut(
+    "好感度排行",
+    command="签到",
+    arguments=["--list"],
+    prefix=True,
+)
 
 
 @_sign_matcher.assign("$main")

zhenxun/builtin_plugins/superuser/broadcast/_data_source.py

@@ -107,6 +107,7 @@ class BroadcastManage:
                 ]
             return channel_id_list
         if isinstance(bot, KaiheilaBot):
+            # TODO: kaiheila获取群组列表
             pass
             # group_list = await bot.guild_list()
             # if group_list.guilds:

zhenxun/builtin_plugins/superuser/exec_sql.py

@@ -1,18 +1,9 @@
+from nonebot import on_command
 from nonebot.permission import SUPERUSER
 from nonebot.plugin import PluginMetadata
 from nonebot.rule import to_me
-from nonebot_plugin_alconna import (
-    Alconna,
-    AlconnaQuery,
-    Args,
-    Arparma,
-    Match,
-    Option,
-    Query,
-    on_alconna,
-    store_true,
-)
-from nonebot_plugin_saa import Text
+from nonebot_plugin_alconna import UniMsg
+from nonebot_plugin_saa import Image, Text
 from nonebot_plugin_session import EventSession
 from tortoise import Tortoise
 
@@ -20,6 +11,7 @@ from zhenxun.configs.utils import PluginExtraData
 from zhenxun.services.db_context import TestSQL
 from zhenxun.services.log import logger
 from zhenxun.utils.enum import PluginType
+from zhenxun.utils.image_utils import ImageTemplate
 
 __plugin_meta__ = PluginMetadata(
     name="数据库操作",
@@ -35,44 +27,59 @@ __plugin_meta__ = PluginMetadata(
     ).dict(),
 )
 
-
-_matcher = on_alconna(
-    Alconna(
-        "exec",
-        Args["sql?", str],
-        Option("-l|--list", action=store_true, help_text="查看数据表"),
-    ),
+_matcher = on_command(
+    "exec",
     rule=to_me(),
     permission=SUPERUSER,
     priority=1,
     block=True,
 )
 
+_table_matcher = on_command(
+    "查看所有表",
+    rule=to_me(),
+    permission=SUPERUSER,
+    priority=1,
+    block=True,
+)
+
+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'
+"""
+
 
 @_matcher.handle()
-async def _(
-    sql: Match[str],
-    session: EventSession,
-    arparma: Arparma,
-    query_list: Query[bool] = AlconnaQuery("list.value", False),
-):
-    db = Tortoise.get_connection("default")
-    if query_list.result:
-        query = await db.execute_query_dict(
-            "select tablename from pg_tables where schemaname = 'public'"
-        )
-        msg = "数据库中的所有表名：\n"
-        for tablename in query:
-            msg += str(tablename["tablename"]) + "\n"
-        logger.info("查看数据库所有表", arparma.header_result, session=session)
-        await Text(msg[:-1]).finish()
-    else:
-        if not sql.available:
-            await Text("必须带有需要执行的 SQL 语句...").finish()
-        sql_text = sql.result
+async def _(session: EventSession, message: UniMsg):
+    sql_text = message.extract_plain_text().strip()
+    if sql_text.startswith("exec"):
+        sql_text = sql_text[4:]
+    logger.info(f"执行SQL语句: {sql_text}", "exec", session=session)
+    try:
         if not sql_text.lower().startswith("select"):
             await TestSQL.raw(sql_text)
-            await Text("执行 SQL 语句成功!").finish()
         else:
+            db = Tortoise.get_connection("default")
             res = await db.execute_query_dict(sql_text)
-            # TODO: Alconna空格sql无法接收
+    except Exception as e:
+        logger.error("执行 SQL 语句失败...", session=session, e=e)
+        await Text(f"执行 SQL 语句失败... {type(e)}").finish()
+    await Text("执行 SQL 语句成功!").finish()
+
+
+@_table_matcher.handle()
+async def _(session: EventSession):
+    try:
+        db = Tortoise.get_connection("default")
+        query = await db.execute_query_dict(SELECT_TABLE_SQL)
+        column_name = ["表名", "简介"]
+        data_list = []
+        for table in query:
+            data_list.append([table["name"], table["desc"]])
+        logger.info("查看数据库所有表", "查看所有表", session=session)
+        table = await ImageTemplate.table_page("数据库表", "", column_name, data_list)
+        await Image(table.pic2bs4()).send()
+    except Exception as e:
+        logger.error("获取表数据失败...", session=session, e=e)
+        await Text(f"获取表数据失败... {type(e)}").send()

zhenxun/builtin_plugins/superuser/group_manage.py

@@ -30,13 +30,25 @@ __plugin_meta__ = PluginMetadata(
     群权限 | 群白名单 | 退出群 操作
     退群，添加/删除群白名单，添加/删除群认证，当在群组中这五个命令且没有指定群号时，默认指定当前群组
     指令:
-        退群 ?[group_id]
-        修改群权限 [group_id] [等级]
-        修改群权限 [等级]: 该命令仅在群组时生效，默认修改当前群组
-        添加群白名单 ?*[group_id]
-        删除群白名单 ?*[group_id]
-        添加群认证 ?*[group_id]
-        删除群认证 ?*[group_id]
+        格式:
+        group-manage modify-level [权限等级] ?[群组Id]      : 修改群权限
+        group-manage super-handle [群组Id] [--del 删除操作] : 添加/删除群白名单
+        group-manage auth-handle [群组Id] [--del 删除操作]  : 添加/删除群认证
+        group-manage del-group [群组Id]                    : 退出指定群
+
+        快捷:
+        group-manage modify-level : 修改群权限
+        group-manage super-handle : 添加/删除群白名单
+        group-manage auth-handle  : 添加/删除群认证
+        group-manage del-group    : 退群
+        
+        示例:
+        修改群权限 7                              : 在群组中修改当前群组权限为7
+        group-manage modify-level 7             : 在群组中修改当前群组权限为7
+        group-manage modify-level 7 1234556     : 修改 123456 群组的权限等级为7
+        添加/删除群白名单 1234567                  : 添加/删除 1234567 为群白名单
+        添加/删除群认证 1234567                    : 添加/删除 1234567 为群认证
+        退群 12344566                            : 退出指定群组
     """.strip(),
     extra=PluginExtraData(
         author="HibiKier",
@@ -62,7 +74,7 @@ _matcher = on_alconna(
             "auth-handle",
             Option("--del", action=store_true, help_text="删除"),
             Args["group_id", int],
-            help_text="添加群白名单",
+            help_text="添加/删除群认证",
         ),
         Subcommand("del-group", Args["group_id", int], help_text="退出群组"),
     ),
@@ -71,7 +83,47 @@ _matcher = on_alconna(
     block=True,
 )
 
-# TODO: shortcut
+_matcher.shortcut(
+    "修改群权限",
+    command="group-manage",
+    arguments=["modify-level", "{%0}"],
+    prefix=True,
+)
+
+_matcher.shortcut(
+    "添加群白名单",
+    command="group-manage",
+    arguments=["super-handle", "{%0}"],
+    prefix=True,
+)
+
+_matcher.shortcut(
+    "删除群白名单",
+    command="group-manage",
+    arguments=["super-handle", "{%0}", "--del"],
+    prefix=True,
+)
+
+_matcher.shortcut(
+    "添加群认证",
+    command="group-manage",
+    arguments=["auth-handle", "{%0}"],
+    prefix=True,
+)
+
+_matcher.shortcut(
+    "删除群认证",
+    command="group-manage",
+    arguments=["auth-handle", "{%0}", "--del"],
+    prefix=True,
+)
+
+_matcher.shortcut(
+    "退群",
+    command="group-manage",
+    arguments=["del-group", "{%0}"],
+    prefix=True,
+)
 
 
 def CheckGroupId():