diff --git a/.circleci/config.yml b/.circleci/config.yml
index 750c461..c1364f5 100644
--- a/.circleci/config.yml
+++ b/.circleci/config.yml
@@ -14,10 +14,10 @@ workflows:
pre-steps:
- run:
command: |
- if [ -z "${CIRCLE_PULL_REQUEST##*/}" ]
+ if [[ -n "${CIRCLE_PULL_REQUEST##*/}" && ${CIRCLE_BRANCH} =~ "pull/" ]]
then
- IS_PR=false
- else
IS_PR=true
+ else
+ IS_PR=false
fi
echo '{ "is_pr": '$IS_PR' }' >> /home/circleci/params.json
diff --git a/.circleci/main.yml b/.circleci/main.yml
index 0e5e293..0d9d5ab 100644
--- a/.circleci/main.yml
+++ b/.circleci/main.yml
@@ -90,13 +90,13 @@ workflows:
filters:
tags:
ignore: /.*/
- tag: ${CIRCLE_BRANCH}
+ tag: ${CIRCLE_BRANCH//\//-}
cache_from: '$CIRCLE_PROJECT_USERNAME/$CIRCLE_PROJECT_REPONAME:${CIRCLE_BRANCH}'
- docker/publish:
<<: *docker-push
dockerfile: docker/Dockerfile_with_frontend_sentry
name: "docker/publish-sentry"
- tag: sentry,${CIRCLE_TAG}-sentry
+ tag: sentry,${CIRCLE_TAG//\//-}-sentry
cache_from: '$CIRCLE_PROJECT_USERNAME/$CIRCLE_PROJECT_REPONAME:sentry'
- docker/publish:
<<: *docker-push
@@ -107,7 +107,7 @@ workflows:
only: [main, dev]
tags:
ignore: /.*/
- tag: ${CIRCLE_BRANCH}-sentry
+ tag: ${CIRCLE_BRANCH//\//-}-sentry
cache_from: '$CIRCLE_PROJECT_USERNAME/$CIRCLE_PROJECT_REPONAME:${CIRCLE_BRANCH}-sentry'
jobs:
diff --git a/.gitignore b/.gitignore
index d6029a3..c47520e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -22,6 +22,7 @@
__pycache__/
*.py[cod]
*$py.class
+venv_test/
# C extensions
*.so
diff --git a/docs/dev/README.md b/docs/dev/README.md
index f69fe22..945e47c 100644
--- a/docs/dev/README.md
+++ b/docs/dev/README.md
@@ -2,7 +2,32 @@
sidebar: auto
---
-# 开发指南
+# 基本开发须知
+
+## 语言以及工具
+
+1. 本项目使用了`python3.9`的特性进行开发，所以请确保你的 Python 版本>=3.9
+2. 本项目使用 poetry 进行依赖管理，请确保开发之前已经进行过`poetry install`，运行时在`poetry shell`的环境中进行运行
+3. 本项目使用的 node 项目管理工具是 yarn
+
+## 前端
+
+本项目使用了前端，如果单独 clone 仓库本身，里面是**不包含**编译过的前端的，请使用`yarn && yarn build`进行前端的构建。
+如果想要开发前端，推荐在`.env.dev`中加入`BISON_OUTER_URL="http://localhost:3000/bison/"`，然后分别运行 bot 和`yarn dev`
+::: warning
+请在开发前端的时候删除项目根目录中的`node_modules`，否则编译和运行的时候可能会出现奇怪的问题。
+:::
+
+## 文档
+
+文档的相关部分在`docs`目录中，可以在项目根目录执行`yarn docs:dev`预览文件更改效果。
+
+## 代码格式
+
+本项目使用了 pre-commit 来进行代码美化和格式化。在`poetry shell`状态下执行`pre-commit install`来安装 git hook，可自动在 commit 时
+格式化代码。
+
+# 适配新网站
本插件需要你的帮助！只需要会写简单的爬虫，就能给本插件适配新的网站。
diff --git a/src/plugins/nonebot_bison/config_manager.py b/src/plugins/nonebot_bison/config_manager.py
index 301cf25..b939b88 100644
--- a/src/plugins/nonebot_bison/config_manager.py
+++ b/src/plugins/nonebot_bison/config_manager.py
@@ -1,5 +1,4 @@
import asyncio
-from asyncio.tasks import Task
from datetime import datetime
from typing import Optional, Type
@@ -12,10 +11,11 @@ from nonebot.internal.params import ArgStr
from nonebot.internal.rule import Rule
from nonebot.log import logger
from nonebot.matcher import Matcher
-from nonebot.params import Depends, EventMessage, EventPlainText, EventToMe
+from nonebot.params import Depends, EventPlainText, EventToMe
from nonebot.permission import SUPERUSER
from nonebot.rule import to_me
from nonebot.typing import T_State
+from nonebot_bison.platform.platform import Platform
from .config import Config
from .platform import check_sub_target, platform_manager
@@ -109,8 +109,11 @@ def do_add_sub(add_sub: Type[Matcher]):
"platform", _gen_prompt_template("{_prompt}"), [Depends(parse_platform)]
)
async def init_id(state: T_State):
- if platform_manager[state["platform"]].has_target:
- state["_prompt"] = "请输入订阅用户的id:\n查询id获取方法请回复:“查询”"
+ cur_platform = platform_manager[state["platform"]]
+ if cur_platform.has_target:
+ state["_prompt"] = (
+ cur_platform.parse_target_promot or "请输入订阅用户的id:\n查询id获取方法请回复:“查询”"
+ )
else:
state["id"] = "default"
state["name"] = await platform_manager[state["platform"]].get_target_name(
@@ -126,6 +129,8 @@ def do_add_sub(add_sub: Type[Matcher]):
raise LookupError
if target == "取消":
raise KeyboardInterrupt
+ platform = platform_manager[state["platform"]]
+ target = await platform.parse_target(target)
name = await check_sub_target(state["platform"], target)
if not name:
raise ValueError
@@ -142,6 +147,8 @@ def do_add_sub(add_sub: Type[Matcher]):
await add_sub.finish("已中止订阅")
except (ValueError):
await add_sub.reject("id输入错误")
+ except (Platform.ParseTargetException):
+ await add_sub.reject("不能从你的输入中提取出id，请检查你输入的内容是否符合预期")
else:
await add_sub.send(
"即将订阅的用户为:{} {} {}\n如有错误请输入“取消”重新订阅".format(
@@ -321,7 +328,7 @@ group_manage_matcher = on_command("群管理", rule=to_me(), permission=SUPERUSE
@group_manage_matcher.handle()
-async def send_group_list(bot: Bot, event: GroupMessageEvent, state: T_State):
+async def send_group_list_private(bot: Bot, event: GroupMessageEvent, state: T_State):
await group_manage_matcher.finish(Message("该功能只支持私聊使用，请私聊Bot"))
@@ -383,13 +390,13 @@ async def do_dispatch_command(
"message",
Rule(),
permission,
- None,
- True,
+ handlers=None,
+ temp=True,
priority=0,
block=True,
plugin=matcher.plugin,
module=matcher.module,
- expire_time=datetime.now() + bot.config.session_expire_timeout,
+ expire_time=datetime.now(),
default_state=matcher.state,
default_type_updater=matcher.__class__._default_type_updater,
default_permission_updater=matcher.__class__._default_permission_updater,
@@ -402,34 +409,3 @@ async def do_dispatch_command(
do_del_sub(new_matcher)
new_matcher_ins = new_matcher()
asyncio.create_task(new_matcher_ins.run(bot, event, state))
-
-
-test_matcher = on_command("testtt")
-
-
-@test_matcher.handle()
-async def _handler(bot: Bot, event: Event, matcher: Matcher, state: T_State):
- permission = await matcher.update_permission(bot, event)
- new_matcher = Matcher.new(
- "message",
- Rule(),
- permission,
- None,
- True,
- priority=0,
- block=True,
- plugin=matcher.plugin,
- module=matcher.module,
- expire_time=datetime.now() + bot.config.session_expire_timeout,
- default_state=matcher.state,
- default_type_updater=matcher.__class__._default_type_updater,
- default_permission_updater=matcher.__class__._default_permission_updater,
- )
-
- async def h():
- logger.warning("yes")
- await new_matcher.send("666")
-
- new_matcher.handle()(h)
- new_matcher_ins = new_matcher()
- await new_matcher_ins.run(bot, event, state)
diff --git a/src/plugins/nonebot_bison/platform/bilibili.py b/src/plugins/nonebot_bison/platform/bilibili.py
index 5ff3cc1..94327ec 100644
--- a/src/plugins/nonebot_bison/platform/bilibili.py
+++ b/src/plugins/nonebot_bison/platform/bilibili.py
@@ -1,11 +1,12 @@
import json
+import re
from typing import Any, Optional
import httpx
from ..post import Post
from ..types import Category, RawPost, Tag, Target
-from .platform import CategoryNotSupport, NewMessage
+from .platform import CategoryNotSupport, NewMessage, Platform
class Bilibili(NewMessage):
@@ -26,6 +27,7 @@ class Bilibili(NewMessage):
schedule_kw = {"seconds": 10}
name = "B站"
has_target = True
+ parse_target_promot = "请输入用户主页的链接"
async def get_target_name(self, target: Target) -> Optional[str]:
async with httpx.AsyncClient() as client:
@@ -37,6 +39,14 @@ class Bilibili(NewMessage):
return None
return res_data["data"]["name"]
+ async def parse_target(self, target_text: str) -> Target:
+ if re.match(r"\d+", target_text):
+ return Target(target_text)
+ elif match := re.match(r"(?:https://)?space.bilibili.com/(\d+)", target_text):
+ return Target(match.group(1))
+ else:
+ raise Platform.ParseTargetException()
+
async def get_sub_list(self, target: Target) -> list[RawPost]:
async with httpx.AsyncClient() as client:
params = {"host_uid": target, "offset": 0, "need_top": 0}
diff --git a/src/plugins/nonebot_bison/platform/platform.py b/src/plugins/nonebot_bison/platform/platform.py
index e1c3471..19f002d 100644
--- a/src/plugins/nonebot_bison/platform/platform.py
+++ b/src/plugins/nonebot_bison/platform/platform.py
@@ -47,6 +47,7 @@ class Platform(metaclass=RegistryABCMeta, base=True):
enable_tag: bool
store: dict[Target, Any]
platform_name: str
+ parse_target_promot: Optional[str] = None
@abstractmethod
async def get_target_name(self, target: Target) -> Optional[str]:
@@ -73,6 +74,12 @@ class Platform(metaclass=RegistryABCMeta, base=True):
self.reverse_category[val] = key
self.store = dict()
+ class ParseTargetException(Exception):
+ pass
+
+ async def parse_target(self, target_string: str) -> Target:
+ return Target(target_string)
+
@abstractmethod
def get_tags(self, raw_post: RawPost) -> Optional[Collection[Tag]]:
"Return Tag list of given RawPost"
diff --git a/src/plugins/nonebot_bison/post.py b/src/plugins/nonebot_bison/post.py
index c668607..d7c1cad 100644
--- a/src/plugins/nonebot_bison/post.py
+++ b/src/plugins/nonebot_bison/post.py
@@ -139,6 +139,7 @@ class Post:
msgs = [reduce(lambda x, y: x.append(y), msgs, Message())]
msgs.extend(self.extra_msg)
self._message = msgs
+ assert len(self._message) > 0, f"message list empty, {self}"
return self._message
def __str__(self):
diff --git a/tests/platforms/static/bilibili_arknights_profile.json b/tests/platforms/static/bilibili_arknights_profile.json
new file mode 100644
index 0000000..6e46b23
--- /dev/null
+++ b/tests/platforms/static/bilibili_arknights_profile.json
@@ -0,0 +1 @@
+{"code":0,"message":"0","ttl":1,"data":{"mid":161775300,"name":"明日方舟","sex":"保密","face":"http://i0.hdslb.com/bfs/face/89154378c06a5ed332c40c2ca56f50cd641c0c90.jpg","face_nft":0,"sign":"重铸未来 方舟启航","rank":10000,"level":6,"jointime":0,"moral":0,"silence":0,"coins":0,"fans_badge":true,"fans_medal":{"show":false,"wear":false,"medal":null},"official":{"role":3,"title":"明日方舟官方账号","desc":"","type":1},"vip":{"type":2,"status":1,"due_date":1648828800000,"vip_pay_type":0,"theme_type":0,"label":{"path":"","text":"年度大会员","label_theme":"annual_vip","text_color":"#FFFFFF","bg_style":1,"bg_color":"#FB7299","border_color":""},"avatar_subscript":1,"nickname_color":"#FB7299","role":3,"avatar_subscript_url":"http://i0.hdslb.com/bfs/vip/icon_Certification_big_member_22_3x.png"},"pendant":{"pid":5305,"name":"明日方舟音律系列","image":"http://i0.hdslb.com/bfs/garb/item/615a1653281141ddf64cbb98c792ddaee78f7f40.png","expire":0,"image_enhance":"http://i0.hdslb.com/bfs/garb/item/516ecdf2d495a62f1bac31497c831b711823140c.webp","image_enhance_frame":"http://i0.hdslb.com/bfs/garb/item/c0751afbf950373c260254d02768eabf30ff3906.png"},"nameplate":{"nid":0,"name":"","image":"","image_small":"","level":"","condition":""},"user_honour_info":{"mid":0,"colour":null,"tags":[]},"is_followed":true,"top_photo":"http://i1.hdslb.com/bfs/space/6c6084808ec5bdff1985acc05ce0e126c49ad76e.png","theme":{},"sys_notice":{},"live_room":{"roomStatus":1,"liveStatus":0,"url":"https://live.bilibili.com/5555734?broadcast_type=0\u0026is_room_feed=1","title":"《明日方舟》2022新春前瞻特辑","cover":"http://i0.hdslb.com/bfs/live/new_room_cover/79af83a27f6001c1acfb47d1c0b879290f7c3308.jpg","roomid":5555734,"roundStatus":1,"broadcast_type":0,"watched_show":{"switch":true,"num":13033,"text_small":"1.3万","text_large":"1.3万人看过","icon":"https://i0.hdslb.com/bfs/live/a725a9e61242ef44d764ac911691a7ce07f36c1d.png","icon_location":"","icon_web":"https://i0.hdslb.com/bfs/live/8d9d0f33ef8bf6f308742752d13dd0df731df19c.png"}},"birthday":"","school":null,"profession":{"name":"","department":"","title":"","is_show":0},"tags":null,"series":{"user_upgrade_status":3,"show_upgrade_window":false},"is_senior_member":0}}
diff --git a/tests/test_config_manager_add.py b/tests/test_config_manager_add.py
index 65447ed..1f7552b 100644
--- a/tests/test_config_manager_add.py
+++ b/tests/test_config_manager_add.py
@@ -383,7 +383,7 @@ async def test_add_with_get_id(app: App):
ctx.should_rejected()
ctx.should_call_send(
event_4_query,
- [MessageSegment(*BotReply.add_reply_on_id_input_search())],
+ Message([MessageSegment(*BotReply.add_reply_on_id_input_search())]),
True,
)
"""
@@ -403,3 +403,114 @@ async def test_add_with_get_id(app: App):
True,
)
ctx.should_finished()
+ subs = config.list_subscribe(10000, "group")
+ assert len(subs) == 0
+
+
+@pytest.mark.asyncio
+@respx.mock
+async def test_add_with_target_parser(app: App):
+ from nonebot.adapters.onebot.v11.event import Sender
+ from nonebot.adapters.onebot.v11.message import Message
+ from nonebot_bison.config import Config
+ from nonebot_bison.config_manager import add_sub_matcher, common_platform
+ from nonebot_bison.platform import platform_manager
+ from nonebot_bison.platform.bilibili import Bilibili
+
+ config = Config()
+ config.user_target.truncate()
+
+ ak_list_router = respx.get(
+ "https://api.bilibili.com/x/space/acc/info?mid=161775300"
+ )
+ ak_list_router.mock(
+ return_value=Response(200, json=get_json("bilibili_arknights_profile.json"))
+ )
+
+ async with app.test_matcher(add_sub_matcher) as ctx:
+ bot = ctx.create_bot()
+ event_1 = fake_group_message_event(
+ message=Message("添加订阅"),
+ sender=Sender(card="", nickname="test", role="admin"),
+ to_me=True,
+ )
+ ctx.receive_event(bot, event_1)
+ ctx.should_pass_rule()
+ ctx.should_call_send(
+ event_1,
+ Message(
+ BotReply.add_reply_on_platform(
+ platform_manager=platform_manager, common_platform=common_platform
+ )
+ ),
+ True,
+ )
+ event_2 = fake_group_message_event(
+ message=Message("全部"), sender=Sender(card="", nickname="test", role="admin")
+ )
+ ctx.receive_event(bot, event_2)
+ ctx.should_rejected()
+ ctx.should_call_send(
+ event_2,
+ BotReply.add_reply_on_platform_input_allplatform(platform_manager),
+ True,
+ )
+ event_3 = fake_group_message_event(
+ message=Message("bilibili"), sender=fake_admin_user
+ )
+ ctx.receive_event(bot, event_3)
+ assert Bilibili.parse_target_promot
+ ctx.should_call_send(
+ event_3,
+ Message(Bilibili.parse_target_promot),
+ True,
+ )
+ event_4_err = fake_group_message_event(
+ message=Message(
+ "htps://space.bilbili.com/161775300?from=search&seid=13051774060625135297&spm_id_from=333.337.0.0"
+ ),
+ sender=fake_admin_user,
+ )
+ ctx.receive_event(bot, event_4_err)
+ ctx.should_call_send(
+ event_4_err, BotReply.add_reply_on_target_parse_input_error, True
+ )
+ ctx.should_rejected()
+ event_4_ok = fake_group_message_event(
+ message=Message(
+ "https://space.bilibili.com/161775300?from=search&seid=13051774060625135297&spm_id_from=333.337.0.0"
+ ),
+ sender=fake_admin_user,
+ )
+ ctx.receive_event(bot, event_4_ok)
+ ctx.should_call_send(
+ event_4_ok,
+ BotReply.add_reply_on_target_confirm("bilibili", "明日方舟", "161775300"),
+ True,
+ )
+ ctx.should_call_send(
+ event_4_ok,
+ Message(BotReply.add_reply_on_cats(platform_manager, "bilibili")),
+ True,
+ )
+ event_5_ok = fake_group_message_event(
+ message=Message("视频"), sender=fake_admin_user
+ )
+ ctx.receive_event(bot, event_5_ok)
+ ctx.should_call_send(event_5_ok, Message(BotReply.add_reply_on_tags), True)
+ event_6 = fake_group_message_event(
+ message=Message("全部标签"), sender=fake_admin_user
+ )
+ ctx.receive_event(bot, event_6)
+ ctx.should_call_send(
+ event_6, BotReply.add_reply_subscribe_success("明日方舟"), True
+ )
+ ctx.should_finished()
+ subs = config.list_subscribe(10000, "group")
+ assert len(subs) == 1
+ sub = subs[0]
+ assert sub["target"] == "161775300"
+ assert sub["tags"] == []
+ assert sub["cats"] == [platform_manager["bilibili"].reverse_category["视频"]]
+ assert sub["target_type"] == "bilibili"
+ assert sub["target_name"] == "明日方舟"
diff --git a/tests/test_config_manager_query_del.py b/tests/test_config_manager_query_del.py
index 0ae3f2d..51dd80d 100644
--- a/tests/test_config_manager_query_del.py
+++ b/tests/test_config_manager_query_del.py
@@ -85,17 +85,3 @@ async def test_del_sub(app: App):
ctx.should_finished()
subs = config.list_subscribe(10000, "group")
assert len(subs) == 0
-
-
-async def test_test(app: App):
- from nonebot.adapters.onebot.v11.bot import Bot
- from nonebot.adapters.onebot.v11.message import Message
- from nonebot_bison.config_manager import test_matcher
-
- async with app.test_matcher(test_matcher) as ctx:
- bot = ctx.create_bot(base=Bot)
- event = fake_group_message_event(message=Message("testtt"))
- ctx.receive_event(bot, event)
- ctx.should_pass_permission()
- ctx.should_pass_rule()
- ctx.should_call_send(event, "666", True)
diff --git a/tests/utils.py b/tests/utils.py
index bd1930d..821544a 100644
--- a/tests/utils.py
+++ b/tests/utils.py
@@ -131,6 +131,7 @@ class BotReply:
return "添加 {} 成功".format(name)
add_reply_on_id_input_error = "id输入错误"
+ add_reply_on_target_parse_input_error = "不能从你的输入中提取出id，请检查你输入的内容是否符合预期"
add_reply_on_platform_input_error = "平台输入错误"
add_reply_on_id = "请输入订阅用户的id:\n查询id获取方法请回复:“查询”"
add_reply_on_tags = '请输入要订阅的tag，订阅所有tag输入"全部标签"'