Release v2.3.2

[Fix] help_message问题、额度检测接口问题

README.md

@@ -47,6 +47,9 @@
 
 ## ✅功能
 
+<details>
+<summary>点击此处展开概述</summary>
+
 <details>
 <summary>✅支持敏感词过滤，避免账号风险</summary>
 
@@ -124,6 +127,7 @@
   - 目前已支持正向代理访问接口
   - 详细请查看config.py中的`openai_config`的说明
 </details>
+</details>
 
 详情请查看[Wiki功能使用页](https://github.com/RockChinQ/QChatGPT/wiki/%E5%8A%9F%E8%83%BD%E4%BD%BF%E7%94%A8#%E5%8A%9F%E8%83%BD%E7%82%B9%E5%88%97%E4%B8%BE)
 
@@ -245,7 +249,8 @@ python3 main.py
 - [dominoar/QCP-NovelAi](https://github.com/dominoar/QCP-NovelAi) - NovelAI 故事叙述与绘画
 - [oliverkirk-sudo/chat_voice](https://github.com/oliverkirk-sudo/chat_voice) - 文字转语音输出，使用HuggingFace上的[VITS-Umamusume-voice-synthesizer模型](https://huggingface.co/spaces/Plachta/VITS-Umamusume-voice-synthesizer)
 - [RockChinQ/WaitYiYan](https://github.com/RockChinQ/WaitYiYan) - 实时获取百度`文心一言`等待列表人数
-- [QChartGPT_Emoticon_Plugin](https://github.com/chordfish-k/QChartGPT_Emoticon_Plugin) - 使机器人根据回复内容发送表情包
+- [chordfish-k/QChartGPT_Emoticon_Plugin](https://github.com/chordfish-k/QChartGPT_Emoticon_Plugin) - 使机器人根据回复内容发送表情包
+- [oliverkirk-sudo/ChatPoeBot](https://github.com/oliverkirk-sudo/ChatPoeBot) - 接入[Poe](https://poe.com/)上的机器人
 </details>
 
 ## 😘致谢

cmdpriv-template.json

@@ -19,6 +19,7 @@
     "prompt": 1,
     "resend": 1,
     "reset": 1,
+    "cmd": 1,
     "help": 1,
     "reload": 2,
     "update": 2,

config-template.py

@@ -33,9 +33,9 @@ mirai_http_api_config = {
 #     },
 #     "http_proxy": "http://127.0.0.1:12345"
 # }
-# 
+#
 # 现已支持反向代理，可以添加reverse_proxy字段以使用反向代理
-# 使用反向代理可以在国内使用OpenAI的API，反向代理的配置请参考 
+# 使用反向代理可以在国内使用OpenAI的API，反向代理的配置请参考
 # https://github.com/Ice-Hazymoon/openai-scf-proxy
 #
 # 反向代理填写示例：
@@ -63,7 +63,7 @@ admin_qq = 0
 # 情景预设（机器人人格）
 # 每个会话的预设信息，影响所有会话，无视指令重置
 # 可以通过这个字段指定某些情况的回复，可直接用自然语言描述指令
-# 例如: 
+# 例如:
 # default_prompt = "如果我之后想获取帮助，请你说“输入!help获取帮助”"
 #   这样用户在不知所措的时候机器人就会提示其输入!help获取帮助
 # 可参考 https://github.com/PlexPt/awesome-chatgpt-prompts-zh
@@ -81,14 +81,14 @@ admin_qq = 0
 # 例如：
 # !reset linux-terminal
 # 若不指定名称，则使用默认情景预设
-# 
+#
 # 也可以使用指令：
 # !default <名称>
 #   将指定的情景预设设置为默认情景预设
 # 例如：
 # !default linux-terminal
 # 之后的会话重置时若不指定名称，则使用linux-terminal情景预设
-# 
+#
 # 还可以加载文件中的预设文字，使用方法请查看：https://github.com/RockChinQ/QChatGPT/wiki/%E5%8A%9F%E8%83%BD%E4%BD%BF%E7%94%A8#%E9%A2%84%E8%AE%BE%E6%96%87%E5%AD%97
 default_prompt = {
     "default": "如果我之后想获取帮助，请你说“输入!help获取帮助”",
@@ -160,7 +160,7 @@ prompt_submit_length = 2048
 # OpenAI补全API的参数
 # 请在下方填写模型，程序自动选择接口
 # 现已支持的模型有：
-# 
+#
 #    'gpt-4'
 #    'gpt-4-0314'
 #    'gpt-4-32k'

pkg/openai/__init__.py

@@ -1,2 +1 @@
-"""OpenAI 接口处理及会话管理相关
-"""
+"""OpenAI 接口处理及会话管理相关"""

pkg/openai/keymgr.py

@@ -11,8 +11,7 @@ class KeysManager:
     """所有api-key"""
 
     using_key = ""
-    """当前使用的api-key
-    """
+    """当前使用的api-key"""
 
     alerted = []
     """已提示过超额的key
@@ -48,7 +47,7 @@ class KeysManager:
 
         self.auto_switch()
 
-    def auto_switch(self) -> (bool, str):
+    def auto_switch(self) -> tuple[bool, str]:
         """尝试切换api-key
 
         Returns:
@@ -79,8 +78,7 @@ class KeysManager:
         self.api_key[key_name] = key
 
     def set_current_exceeded(self):
-        """设置当前使用的api-key使用量超限
-        """
+        """设置当前使用的api-key使用量超限"""
         self.exceeded.append(self.using_key)
 
     def get_key_name(self, api_key):

pkg/openai/manager.py

@@ -48,8 +48,8 @@ class OpenAIInteract:
 
         # 根据模型选择使用的接口
         ai: ModelRequest = create_openai_model_request(
-            config.completion_api_params['model'], 
-            'user', 
+            config.completion_api_params['model'],
+            'user',
             config.openai_config["http_proxy"] if "http_proxy" in config.openai_config else None
         )
         ai.request(

pkg/plugin/host.py

@@ -15,8 +15,7 @@ import pkg.plugin.settings as settings
 from mirai import Mirai
 
 __plugins__ = {}
-"""
-插件列表
+"""插件列表
 
 示例:
 {
@@ -35,14 +34,15 @@ __plugins__ = {}
         },
         "instance": None
     }
-}"""
+}
+"""
 
 __plugins_order__ = []
 """插件顺序"""
 
 
 def generate_plugin_order():
-    """ 根据__plugin__生成插件初始顺序，无视是否启用 """
+    """根据__plugin__生成插件初始顺序，无视是否启用"""
     global __plugins_order__
     __plugins_order__ = []
     for plugin_name in __plugins__:
@@ -50,13 +50,13 @@ def generate_plugin_order():
 
 
 def iter_plugins():
-    """ 按照顺序迭代插件 """
+    """按照顺序迭代插件"""
     for plugin_name in __plugins_order__:
         yield __plugins__[plugin_name]
 
 
 def iter_plugins_name():
-    """ 迭代插件名 """
+    """迭代插件名"""
     for plugin_name in __plugins_order__:
         yield plugin_name
 
@@ -85,7 +85,7 @@ def walk_plugin_path(module, prefix='', path_prefix=''):
 
 
 def load_plugins():
-    """ 加载插件 """
+    """加载插件"""
     logging.info("加载插件")
     PluginHost()
     walk_plugin_path(__import__('plugins'))
@@ -102,7 +102,7 @@ def load_plugins():
 
 
 def initialize_plugins():
-    """ 初始化插件 """
+    """初始化插件"""
     logging.info("初始化插件")
     import pkg.plugin.models as models
     for plugin in iter_plugins():
@@ -117,8 +117,7 @@ def initialize_plugins():
 
 
 def unload_plugins():
-    """ 卸载插件
-    """
+    """卸载插件"""
     # 不再显式卸载插件，因为当程序结束时，插件的析构函数会被系统执行
     # for plugin in __plugins__.values():
     #     if plugin['enabled'] and plugin['instance'] is not None:
@@ -134,7 +133,7 @@ def unload_plugins():
 
 
 def install_plugin(repo_url: str):
-    """ 安装插件，从git储存库获取并解决依赖 """
+    """安装插件，从git储存库获取并解决依赖"""
     try:
         import pkg.utils.pkgmgr
         pkg.utils.pkgmgr.ensure_dulwich()
@@ -162,7 +161,7 @@ def install_plugin(repo_url: str):
 
 
 def uninstall_plugin(plugin_name: str) -> str:
-    """ 卸载插件 """
+    """卸载插件"""
     if plugin_name not in __plugins__:
         raise Exception("插件不存在")
     
@@ -178,17 +177,17 @@ def uninstall_plugin(plugin_name: str) -> str:
 
 
 class EventContext:
-    """ 事件上下文 """
+    """事件上下文"""
     eid = 0
     """事件编号"""
 
     name = ""
 
     __prevent_default__ = False
-    """ 是否阻止默认行为 """
+    """是否阻止默认行为"""
 
     __prevent_postorder__ = False
-    """ 是否阻止后续插件的执行 """
+    """是否阻止后续插件的执行"""
 
     __return_value__ = {}
     """ 返回值 
@@ -251,7 +250,7 @@ class EventContext:
 
 
 def emit(event_name: str, **kwargs) -> EventContext:
-    """ 触发事件 """
+    """触发事件"""
     import pkg.utils.context as context
     if context.get_plugin_host() is None:
         return None
@@ -290,7 +289,7 @@ class PluginHost:
         context.get_qqbot_manager().notify_admin(message)
 
     def emit(self, event_name: str, **kwargs) -> EventContext:
-        """ 触发事件 """
+        """触发事件"""
         import json
 
         event_context = EventContext(event_name)

pkg/plugin/switch.py

@@ -7,7 +7,7 @@ import pkg.plugin.host as host
 
 
 def wrapper_dict_from_plugin_list() -> dict:
-    """ 将插件列表转换为开关json """
+    """将插件列表转换为开关json"""
     switch = {}
 
     for plugin_name in host.__plugins__:
@@ -30,7 +30,7 @@ def apply_switch(switch: dict):
 
 
 def dump_switch():
-    """ 保存开关数据 """
+    """保存开关数据"""
     logging.debug("保存开关数据")
     # 将开关数据写入plugins/switch.json
 
@@ -41,7 +41,7 @@ def dump_switch():
 
 
 def load_switch():
-    """ 加载开关数据 """
+    """加载开关数据"""
     logging.debug("加载开关数据")
     # 读取plugins/switch.json
 

pkg/qqbot/cmds/mgr.py

@@ -315,12 +315,16 @@ def register_all():
 
 def apply_privileges():
     """读取cmdpriv.json并应用指令权限"""
-    with open('cmdpriv.json', 'r') as f:
-        data = json.load(f)
-        for path, priv in data.items():
-            if path == 'comment':
-                continue
-            if __command_list__[path]['privilege'] != priv:
-                logging.debug('应用权限: {} -> {}(default: {})'.format(path, priv, __command_list__[path]['privilege']))
+    # 读取内容
+    json_str = ""
+    with open('cmdpriv.json', 'r', encoding="utf-8") as f:
+        json_str = f.read()
 
-            __command_list__[path]['privilege'] = priv
+    data = json.loads(json_str)
+    for path, priv in data.items():
+        if path == 'comment':
+            continue
+        if __command_list__[path]['privilege'] != priv:
+            logging.debug('应用权限: {} -> {}(default: {})'.format(path, priv, __command_list__[path]['privilege']))
+
+        __command_list__[path]['privilege'] = priv

pkg/qqbot/cmds/plugin/plugin.py

@@ -98,28 +98,33 @@ class PluginUpdateCommand(AbstractCommandNode):
 
         reply = []
         def closure():
-            import pkg.utils.context
-            updated = []
-            for key in plugin_list:
-                plugin = plugin_list[key]
-                if updater.is_repo("/".join(plugin['path'].split('/')[:-1])):
-                    success = updater.pull_latest("/".join(plugin['path'].split('/')[:-1]))
-                    if success:
-                        updated.append(plugin['name'])
+            try:
+                import pkg.utils.context
+                updated = []
+                for key in plugin_list:
+                    plugin = plugin_list[key]
+                    if updater.is_repo("/".join(plugin['path'].split('/')[:-1])):
+                        success = updater.pull_latest("/".join(plugin['path'].split('/')[:-1]))
+                        if success:
+                            updated.append(plugin['name'])
 
-            # 检查是否有requirements.txt
-            pkg.utils.context.get_qqbot_manager().notify_admin("正在安装依赖...")
-            for key in plugin_list:
-                plugin = plugin_list[key]
-                if os.path.exists("/".join(plugin['path'].split('/')[:-1])+"/requirements.txt"):
-                    logging.info("{}检测到requirements.txt，安装依赖".format(plugin['name']))
-                    import pkg.utils.pkgmgr
-                    pkg.utils.pkgmgr.install_requirements("/".join(plugin['path'].split('/')[:-1])+"/requirements.txt")
+                # 检查是否有requirements.txt
+                pkg.utils.context.get_qqbot_manager().notify_admin("正在安装依赖...")
+                for key in plugin_list:
+                    plugin = plugin_list[key]
+                    if os.path.exists("/".join(plugin['path'].split('/')[:-1])+"/requirements.txt"):
+                        logging.info("{}检测到requirements.txt，安装依赖".format(plugin['name']))
+                        import pkg.utils.pkgmgr
+                        pkg.utils.pkgmgr.install_requirements("/".join(plugin['path'].split('/')[:-1])+"/requirements.txt")
 
-                    import main
-                    main.reset_logging()
+                        import main
+                        main.reset_logging()
+
+                pkg.utils.context.get_qqbot_manager().notify_admin("已更新插件: {}".format(", ".join(updated)))
+            except Exception as e:
+                logging.error("插件更新失败:{}".format(e))
+                pkg.utils.context.get_qqbot_manager().notify_admin("插件更新失败:{} 请尝试手动更新插件".format(e))
 
-            pkg.utils.context.get_qqbot_manager().notify_admin("已更新插件: {}".format(", ".join(updated)))
 
         threading.Thread(target=closure).start()
         reply = ["[bot]正在更新所有插件，请勿重复发起..."]

pkg/qqbot/cmds/system/cmd.py

@@ -0,0 +1,39 @@
+from ..mgr import AbstractCommandNode, Context, __command_list__
+
+
+@AbstractCommandNode.register(
+    parent=None,
+    name="cmd",
+    description="显示指令列表",
+    usage="!cmd\n!cmd <指令名称>",
+    aliases=[],
+    privilege=1
+)
+class CmdCommand(AbstractCommandNode):
+    @classmethod
+    def process(cls, ctx: Context) -> tuple[bool, list]:
+        command_list = __command_list__
+
+        reply = []
+
+        if len(ctx.params) == 0:
+            reply_str = "[bot]当前所有指令:\n\n"
+
+            # 遍历顶级指令
+            for key in command_list:
+                command = command_list[key]
+                if command['parent'] is None:
+                    reply_str += "!{} - {}\n".format(key, command['description'])
+
+            reply_str += "\n请使用 !cmd <指令名称> 来查看指令的详细信息"
+
+            reply = [reply_str]
+        else:
+            command_name = ctx.params[0]
+            if command_name in command_list:
+                reply = [command_list[command_name]['cls'].help()]
+            else:
+                reply = ["[bot]指令 {} 不存在".format(command_name)]
+
+        return True, reply
+    

pkg/qqbot/cmds/system/cmds.py

@@ -0,0 +1,39 @@
+from ..mgr import AbstractCommandNode, Context, __command_list__
+
+
+@AbstractCommandNode.register(
+    parent=None,
+    name="cmd",
+    description="显示指令列表",
+    usage="!help\n!help <指令名称>",
+    aliases=[],
+    privilege=1
+)
+class CmdCommand(AbstractCommandNode):
+    @classmethod
+    def process(cls, ctx: Context) -> tuple[bool, list]:
+        command_list = __command_list__
+
+        reply = []
+
+        if len(ctx.params) == 0:
+            reply_str = "[bot]当前所有指令:\n\n"
+
+            # 遍历顶级指令
+            for key in command_list:
+                command = command_list[key]
+                if command['parent'] is None:
+                    reply_str += "!{} - {}\n".format(key, command['description'])
+
+            reply_str += "\n请使用 !cmd <指令名称> 来查看指令的详细信息"
+
+            reply = [reply_str]
+        else:
+            command_name = ctx.params[0]
+            if command_name in command_list:
+                reply = [command_list[command_name]['cls'].help()]
+            else:
+                reply = ["[bot]指令 {} 不存在".format(command_name)]
+
+        return True, reply
+    

pkg/qqbot/cmds/system/help.py

@@ -1,38 +1,19 @@
-from ..mgr import AbstractCommandNode, Context, __command_list__
+from ..mgr import AbstractCommandNode, Context
 
 
 @AbstractCommandNode.register(
     parent=None,
     name="help",
-    description="显示帮助信息",
-    usage="!help\n!help <指令名称>",
+    description="显示自定义的帮助信息",
+    usage="!help",
     aliases=[],
     privilege=1
 )
 class HelpCommand(AbstractCommandNode):
     @classmethod
     def process(cls, ctx: Context) -> tuple[bool, list]:
-        command_list = __command_list__
+        import config
+        reply = [(config.help_message if hasattr(config, 'help_message') else "") + "\n请输入 !cmds 查看指令列表"]
 
-        reply = []
-
-        if len(ctx.params) == 0:
-            reply_str = "[bot]当前所有指令:\n\n"
-
-            # 遍历顶级指令
-            for key in command_list:
-                command = command_list[key]
-                if command['parent'] is None:
-                    reply_str += "!{} - {}\n".format(key, command['description'])
-
-            reply_str += "\n请使用 !help <指令名称> 来查看指令的详细信息"
-
-            reply = [reply_str]
-        else:
-            command_name = ctx.params[0]
-            if command_name in command_list:
-                reply = [command_list[command_name]['cls'].help()]
-            else:
-                reply = ["[bot]指令 {} 不存在".format(command_name)]
-
-        return True, reply
+        return True, reply
+    

pkg/qqbot/cmds/system/usage.py

@@ -29,13 +29,6 @@ class UsageCommand(AbstractCommandNode):
                 .get_image_count_of_key(api_keys[key_name])
             reply_str += "{}:\n - 文本长度:{}\n - 图片数量:{}\n".format(key_name, int(text_length),
                                                                         int(image_count))
-            # 获取此key的额度
-            try:
-                http_proxy = config.openai_config["http_proxy"] if "http_proxy" in config.openai_config else None
-                credit_data = credit.fetch_credit_data(api_keys[key_name], http_proxy)
-                reply_str += " - 使用额度:{:.2f}/{:.2f}\n".format(credit_data['total_used'],credit_data['total_granted'])
-            except Exception as e:
-                logging.warning("获取额度失败:{}".format(e))
 
         reply = [reply_str]
 

pkg/qqbot/command.py

@@ -32,7 +32,7 @@ def process_command(session_name: str, text_message: str, mgr, config,
 
         params = text_message[1:].strip().split(' ')[1:]
 
-        # 把!~开头的转换成!cfg 
+        # 把!~开头的转换成!cfg
         if cmd.startswith('~'):
             params = [cmd[1:]] + params
             cmd = 'cfg'

pkg/qqbot/filter.py

@@ -50,8 +50,8 @@ class ReplyFilter:
 
             # 百度云审核URL
             baidu_url = "https://aip.baidubce.com/rest/2.0/solution/v1/text_censor/v2/user_defined?access_token=" + \
-                str(requests.post("https://aip.baidubce.com/oauth/2.0/token", 
-                      params={"grant_type": "client_credentials", 
+                str(requests.post("https://aip.baidubce.com/oauth/2.0/token",
+                      params={"grant_type": "client_credentials",
                               "client_id": self.baidu_api_key,
                               "client_secret": self.baidu_secret_key}).json().get("access_token"))
 

pkg/utils/announcement.py

@@ -22,10 +22,10 @@ def read_saved() -> str:
     # 已保存的在res/announcement_saved
     # 检查是否存在
     if not os.path.exists("res/announcement_saved"):
-        with open("res/announcement_saved", "w") as f:
+        with open("res/announcement_saved", "w", encoding="utf-8") as f:
             f.write("")
 
-    with open("res/announcement_saved", "r") as f:
+    with open("res/announcement_saved", "r", encoding="utf-8") as f:
         content = f.read()
 
     return content
@@ -33,7 +33,7 @@ def read_saved() -> str:
 
 def write_saved(content: str):
     # 已保存的在res/announcement_saved
-    with open("res/announcement_saved", "w") as f:
+    with open("res/announcement_saved", "w", encoding="utf-8") as f:
         f.write(content)
 
 

pkg/utils/threadctl.py

@@ -4,9 +4,7 @@ from concurrent.futures import ThreadPoolExecutor
 
 
 class Pool:
-    '''
-    线程池结构
-    '''
+    """线程池结构"""
     pool_num:int = None
     ctl:ThreadPoolExecutor = None
     task_list:list = None
@@ -33,12 +31,11 @@ class Pool:
 
 class ThreadCtl:
     def __init__(self, sys_pool_num, admin_pool_num, user_pool_num):
-        '''
-        线程池控制类
+        """线程池控制类
         sys_pool_num：分配系统使用的线程池数量(>=8)
         admin_pool_num：用于处理管理员消息的线程池数量(>=1)
         user_pool_num：分配用于处理用户消息的线程池的数量(>=1)
-        '''
+        """
         if sys_pool_num < 5:
             raise Exception("Too few system threads(sys_pool_num needs >= 8, but received {})".format(sys_pool_num))
         if admin_pool_num < 1:

res/announcement

@@ -1 +1 @@
-
+2023/3/31 21:35 【插件兼容性问题】若您使用了revLibs插件，并将主程序升级到了v2.3.0，请立即使用管理员账号向机器人账号发送!plugin update命令更新逆向库插件，以解决由于情景预设重构引起的兼容性问题。