perf👌: 添加shortcut

zhenxun/builtin_plugins/admin/ban/__init__.py

@@ -29,12 +29,31 @@ __plugin_meta__ = PluginMetadata(
     name="封禁用户/群组",
     description="你被逮捕了！丢进小黑屋！封禁用户以及群组，屏蔽消息",
     usage="""
-    .ban [at] ?[小时] ?[分钟]
-    .unban
-    示例：.ban @user
-    示例：.ban @user 6
-    示例：.ban @user 3 10
-    示例：.unban @user
+    普通管理员
+        格式:
+        ban [At用户] [时长]
+
+        示例:
+        ban @用户       : 永久拉黑用户
+        ban @用户 100   : 拉黑用户100分钟
+        unban @用户     : 从小黑屋中拉出来
+
+    超级管理员额外命令
+        格式:
+        ban [At用户/用户Id] [时长]
+        ban列表: 获取所有Ban数据
+        群组ban列表: 获取群组Ban数据
+        用户ban列表: 获取用户Ban数据
+
+        私聊下:
+            示例:
+            ban 123456789       : 永久拉黑用户123456789
+            ban 123456789 100   : 拉黑用户123456789 100分钟
+
+            ban -g 999999       : 拉黑群组为999999的群组
+
+            unban 123456789     : 从小黑屋中拉出来
+            unban -g 999999     : 将群组9999999从小黑屋中拉出来
     """.strip(),
     extra=PluginExtraData(
         author="HibiKier",
@@ -54,19 +73,22 @@ __plugin_meta__ = PluginMetadata(
 )
 
 
-_matcher = on_alconna(
+_ban_matcher = on_alconna(
     Alconna(
-        "ban-console",
-        Subcommand(
-            "ban",
-            Args["user?", [str, At]]["duration?", int],
-            Option("-g|--group", Args["group_id", str]),
-        ),
-        Subcommand(
-            "unban",
-            Args["user?", [str, At]],
-            Option("-g|--group", Args["group_id", str]),
-        ),
+        "ban",
+        Args["user?", [str, At]]["duration?", int],
+        Option("-g|--group", Args["group_id", str]),
+    ),
+    rule=admin_check("ban", "BAN_LEVEL"),
+    priority=5,
+    block=True,
+)
+
+_unban_matcher = on_alconna(
+    Alconna(
+        "unban",
+        Args["user?", [str, At]],
+        Option("-g|--group", Args["group_id", str]),
     ),
     rule=admin_check("ban", "BAN_LEVEL"),
     priority=5,
@@ -76,14 +98,35 @@ _matcher = on_alconna(
 _status_matcher = on_alconna(
     Alconna(
         "ban-status",
-        Option("-u|--user", Args["user_id", str]),
-        Option("-g|--group", Args["group_id", str]),
+        Option("-u|--user", action=store_true, help_text="过滤用户"),
+        Option("-g|--group", action=store_true, help_text="过滤群组"),
     ),
     permission=SUPERUSER,
     priority=1,
     block=True,
 )
-# TODO: shortcut
+
+_status_matcher.shortcut(
+    "ban列表",
+    command="ban-status",
+    arguments=[],
+    prefix=True,
+)
+
+
+_status_matcher.shortcut(
+    "用户ban列表",
+    command="ban-status",
+    arguments=["--user"],
+    prefix=True,
+)
+
+_status_matcher.shortcut(
+    "群组ban列表",
+    command="ban-status",
+    arguments=["--group"],
+    prefix=True,
+)
 
 
 @_status_matcher.handle()
@@ -94,15 +137,20 @@ async def _(
     user_id: Match[str],
     group_id: Match[str],
 ):
+    filter_type = None
+    if arparma.find("user"):
+        filter_type = "user"
+    if arparma.find("group"):
+        filter_type = "group"
     _user_id = user_id.result if user_id.available else None
     _group_id = group_id.result if group_id.available else None
-    if image := await BanManage.build_ban_image(_user_id, _group_id):
+    if image := await BanManage.build_ban_image(filter_type):
         await Image(image.pic2bs4()).finish(reply=True)
     else:
         await Text("数据为空捏...").finish(reply=True)
 
 
-@_matcher.assign("ban")
+@_ban_matcher.handle()
 async def _(
     bot: Bot,
     session: EventSession,
@@ -150,7 +198,7 @@ async def _(
         await Text(f"对 {at_msg} 狠狠惩戒了一番，一脚踢进了小黑屋!").finish(reply=True)
 
 
-@_matcher.assign("unban")
+@_unban_matcher.handle()
 async def _(
     bot: Bot,
     session: EventSession,

zhenxun/builtin_plugins/admin/ban/_data_source.py

@@ -1,33 +1,35 @@
 import time
+from typing import Literal
 
 from nonebot_plugin_session import EventSession
 
 from zhenxun.models.ban_console import BanConsole
 from zhenxun.models.level_user import LevelUser
-from zhenxun.utils.image_utils import ImageTemplate
+from zhenxun.utils.image_utils import BuildImage, ImageTemplate
 
 
 class BanManage:
 
     @classmethod
-    async def build_ban_image(cls, user_id: str | None, group_id: str | None):
+    async def build_ban_image(
+        cls,
+        filter_type: Literal["group", "user"] | None,
+    ) -> BuildImage | None:
+        """构造Ban列表图片
+
+        参数:
+            filter_type: 过滤类型
+
+        返回:
+            BuildImage | None: Ban列表图片
+        """
         data_list = None
-        if not user_id and not group_id:
+        if not filter_type:
             data_list = await BanConsole.all()
-        elif user_id:
-            if group_id:
-                data_list = await BanConsole.filter(
-                    user_id=user_id, group_id=group_id
-                ).all()
-            else:
-                data_list = await BanConsole.filter(
-                    user_id=user_id, group_id__isnull=True
-                ).all()
-        else:
-            if group_id:
-                data_list = await BanConsole.filter(
-                    user_id__isnull=True, group_id=group_id
-                ).all()
+        elif filter_type == "user":
+            data_list = await BanConsole.filter(group_id__isnull=True).all()
+        elif filter_type == "group":
+            data_list = await BanConsole.filter(user_id__isnull=True).all()
         if not data_list:
             return None
         column_name = [
@@ -41,8 +43,8 @@ class BanManage:
         row_data = []
         for data in data_list:
             duration = int((data.ban_time + data.duration - time.time()) / 60)
-            if duration < 0:
-                duration = 0
+            if data.duration < 0:
+                duration = "∞"
             row_data.append(
                 [
                     data.id,

zhenxun/builtin_plugins/admin/plugin_switch/__init__.py

@@ -19,11 +19,28 @@ __plugin_meta__ = PluginMetadata(
     name="功能开关",
     description="对群组内的功能限制，超级用户可以对群组以及全局的功能被动开关限制",
     usage="""
-    开启/关闭[功能]
-    群被动状态
-    开启全部被动
-    关闭全部被动
-    醒来/休息吧
+    普通管理员
+        格式:
+        开启/关闭[功能名称]    : 开关功能
+        群被动状态            : 查看被动技能开关状态
+        醒来                 : 结束休眠
+        休息吧                : 群组休眠, 不会再响应命令
+
+        示例:
+        开启签到              : 开启签到
+        关闭签到              : 关闭签到
+
+    超级管理员额外命令
+        格式:
+        插件列表
+        开启/关闭[功能名称] ?[-t ["private", "p", "group", "g"](关闭类型)] ?[-g 群组Id]
+
+        私聊下:
+            示例:
+            开启签到                : 全局开启签到
+            关闭签到                : 全局关闭签到
+            关闭签到 p              : 全局私聊关闭签到
+            关闭签到 -g 12345678    : 关闭群组12345678的签到功能(普通管理员无法开启)
     """.strip(),
     extra=PluginExtraData(
         author="HibiKier",
@@ -43,9 +60,6 @@ __plugin_meta__ = PluginMetadata(
 )
 
 
-# TODO: shortcut
-
-
 @_status_matcher.assign("$main")
 async def _(bot: Bot, session: EventSession, arparma: Arparma):
     image = None

zhenxun/builtin_plugins/admin/plugin_switch/command.py

@@ -40,8 +40,6 @@ _status_matcher = on_alconna(
     block=True,
 )
 
-# TODO: shortcut
-
 _group_status_matcher = on_alconna(
     Alconna("group-status", Args["status", ["sleep", "wake"]]),
     rule=admin_check("admin_bot_manage", "CHANGE_GROUP_SWITCH_LEVEL")