移动 poster 模块到 common

konabot/plugins/kona_ph/__init__.py

@@ -6,29 +6,34 @@ from loguru import logger
 from nonebot import on_message
 import nonebot
 from nonebot.rule import to_me
-from nonebot_plugin_alconna import (Alconna, Args, UniMessage, UniMsg,
-                                    on_alconna)
+from nonebot_plugin_alconna import Alconna, Args, UniMessage, UniMsg, on_alconna
 from nonebot_plugin_apscheduler import scheduler
 
 from konabot.common import username
 from konabot.common.longtask import DepLongTaskTarget
 from konabot.common.pager import PagerQuery
-from konabot.plugins.kona_ph.core.message import (get_daily_report,
-                                                  get_daily_report_v2,
-                                                  get_puzzle_description,
-                                                  get_submission_message)
+from konabot.plugins.kona_ph.core.message import (
+    get_daily_report,
+    get_daily_report_v2,
+    get_puzzle_description,
+    get_submission_message,
+)
 from konabot.plugins.kona_ph.core.storage import get_today_date
-from konabot.plugins.kona_ph.manager import (PUZZLE_PAGE_SIZE,
-                                             create_admin_commands,
-                                             puzzle_manager)
-from konabot.plugins.poster.poster_info import PosterInfo, register_poster_info
-from konabot.plugins.poster.service import broadcast
+from konabot.plugins.kona_ph.manager import (
+    PUZZLE_PAGE_SIZE,
+    create_admin_commands,
+    puzzle_manager,
+)
+from konabot.common.subscribe import PosterInfo, register_poster_info, broadcast
 
 create_admin_commands()
-register_poster_info("每日谜题", info=PosterInfo(
-    aliases={"konaph", "kona_ph", "KonaPH", "此方谜题", "KONAPH"},
-    description="此方 BOT 每日谜题推送",
-))
+register_poster_info(
+    "每日谜题",
+    info=PosterInfo(
+        aliases={"konaph", "kona_ph", "KonaPH", "此方谜题", "KONAPH"},
+        description="此方 BOT 每日谜题推送",
+    ),
+)
 
 
 cmd_submit = on_message(rule=to_me())
@@ -44,16 +49,22 @@ async def _(msg: UniMsg, target: DepLongTaskTarget):
             if isinstance(result, str):
                 await target.send_message(result)
             else:
-                await target.send_message(get_submission_message(
-                    daily_puzzle_info=result.info,
-                    submission=result.submission,
-                    puzzle=result.puzzle,
-                ))
+                await target.send_message(
+                    get_submission_message(
+                        daily_puzzle_info=result.info,
+                        submission=result.submission,
+                        puzzle=result.puzzle,
+                    )
+                )
 
 
-cmd_query = on_alconna(Alconna(
-    r"re:(?:((?:(?:所以|话)说?)?今天的题目是什么[啊呀哇呢]?(?:\?？)?)|今日谜?题目?)"
-), rule=to_me())
+cmd_query = on_alconna(
+    Alconna(
+        r"re:(?:((?:(?:所以|话)说?)?今天的题目是什么[啊呀哇呢]?(?:\?？)?)|今日谜?题目?)"
+    ),
+    rule=to_me(),
+)
+
 
 @cmd_query.handle()
 async def _(target: DepLongTaskTarget):
@@ -64,9 +75,8 @@ async def _(target: DepLongTaskTarget):
         await target.send_message(get_puzzle_description(p))
 
 
-cmd_query_submission = on_alconna(Alconna(
-    "今日答题情况"
-), rule=to_me())
+cmd_query_submission = on_alconna(Alconna("今日答题情况"), rule=to_me())
+
 
 @cmd_query_submission.handle()
 async def _(target: DepLongTaskTarget):
@@ -77,11 +87,15 @@ async def _(target: DepLongTaskTarget):
         await target.send_message(get_daily_report_v2(manager, gid))
 
 
-cmd_history = on_alconna(Alconna(
-    "re:历史(题目|谜题)",
-    Args["page?", int],
-    Args["index_id?", str],
-), rule=to_me())
+cmd_history = on_alconna(
+    Alconna(
+        "re:历史(题目|谜题)",
+        Args["page?", int],
+        Args["index_id?", str],
+    ),
+    rule=to_me(),
+)
+
 
 @cmd_history.handle()
 async def _(target: DepLongTaskTarget, index_id: str = "", page: int = 1):
@@ -105,10 +119,10 @@ async def _(target: DepLongTaskTarget, index_id: str = "", page: int = 1):
         puzzles = sorted(puzzles, key=lambda u: u[1], reverse=True)
         count_pages = ceil(len(puzzles) / PUZZLE_PAGE_SIZE)
         if page <= 0 or page > count_pages:
-            return await target.send_message(UniMessage.text(
-                f"页数只有 1 ~ {count_pages} 啦！"
-            ))
-        puzzles = puzzles[(page - 1) * PUZZLE_PAGE_SIZE: page * PUZZLE_PAGE_SIZE]
+            return await target.send_message(
+                UniMessage.text(f"页数只有 1 ~ {count_pages} 啦！")
+            )
+        puzzles = puzzles[(page - 1) * PUZZLE_PAGE_SIZE : page * PUZZLE_PAGE_SIZE]
         for p, d in puzzles:
             info = manager.daily_puzzle[manager.daily_puzzle_of_date[d]]
             msg = msg.text(
@@ -120,22 +134,26 @@ async def _(target: DepLongTaskTarget, index_id: str = "", page: int = 1):
         await target.send_message(msg)
 
 
-cmd_leadboard = on_alconna(Alconna(
-    "re:此方(解谜|谜题)排行榜",
-    Args["page?", int],
-))
+cmd_leadboard = on_alconna(
+    Alconna(
+        "re:此方(解谜|谜题)排行榜",
+        Args["page?", int],
+    )
+)
+
 
 @cmd_leadboard.handle()
 async def _(target: DepLongTaskTarget, page: int = 1):
     async with puzzle_manager() as manager:
         result = manager.get_leadboard(PagerQuery(page, 10))
-    await target.send_message(result.to_unimessage(
-        title="此方解谜排行榜",
-        formatter=lambda data: (
-            f"✨ {data[1]} 已完成 | "
-            f"{username.get_username(data[0])}"
+    await target.send_message(
+        result.to_unimessage(
+            title="此方解谜排行榜",
+            formatter=lambda data: (
+                f"✨ {data[1]} 已完成 | {username.get_username(data[0])}"
+            ),
         )
-    ))
+    )
 
 
 @scheduler.scheduled_job("cron", hour="8")
@@ -155,4 +173,3 @@ async def _():
 
 
 driver = nonebot.get_driver()
-

konabot/plugins/kona_ph/manager.py

@@ -33,7 +33,7 @@ from konabot.plugins.kona_ph.core.storage import (
     get_today_date,
     puzzle_manager,
 )
-from konabot.plugins.poster.service import broadcast
+from konabot.common.subscribe import broadcast
 
 PUZZLE_PAGE_SIZE = 10
 

konabot/plugins/poster/__init__.py

@@ -3,14 +3,15 @@ from nonebot_plugin_alconna import Alconna, Args, on_alconna
 
 from konabot.common.longtask import DepLongTaskTarget
 from konabot.common.pager import PagerQuery
-from konabot.plugins.poster.poster_info import POSTER_INFO_DATA
-from konabot.plugins.poster.service import dep_poster_service
+from konabot.common.subscribe import POSTER_INFO_DATA, dep_poster_service
 
 
-cmd_subscribe = on_alconna(Alconna(
-    "订阅",
-    Args["channel", str],
-))
+cmd_subscribe = on_alconna(
+    Alconna(
+        "订阅",
+        Args["channel", str],
+    )
+)
 
 
 @cmd_subscribe.handle()
@@ -23,10 +24,12 @@ async def _(target: DepLongTaskTarget, channel: str):
         await target.send_message(f"已经订阅过「{channel}」了")
 
 
-cmd_list = on_alconna(Alconna(
-    "re:(?:查询|我的|获取)订阅(列表)?",
-    Args["page?", int],
-))
+cmd_list = on_alconna(
+    Alconna(
+        "re:(?:查询|我的|获取)订阅(列表)?",
+        Args["page?", int],
+    )
+)
 
 
 def better_channel_message(channel_id: str) -> str:
@@ -39,17 +42,24 @@ def better_channel_message(channel_id: str) -> str:
 @cmd_list.handle()
 async def _(target: DepLongTaskTarget, page: int = 1):
     async with dep_poster_service() as service:
-        result = await service.get_channels(target, PagerQuery(
-            page_index=page,
-            page_size=10,
-        ))
-        await target.send_message(result.to_unimessage(title="订阅列表", formatter=better_channel_message))
+        result = await service.get_channels(
+            target,
+            PagerQuery(
+                page_index=page,
+                page_size=10,
+            ),
+        )
+        await target.send_message(
+            result.to_unimessage(title="订阅列表", formatter=better_channel_message)
+        )
 
 
-cmd_list_available = on_alconna(Alconna(
-    "re:(查询)?可用订阅(列表)?",
-    Args["page?", int],
-))
+cmd_list_available = on_alconna(
+    Alconna(
+        "re:(查询)?可用订阅(列表)?",
+        Args["page?", int],
+    )
+)
 
 
 @cmd_list_available.handle()
@@ -58,13 +68,17 @@ async def _(target: DepLongTaskTarget, page: int = 1):
         page_index=page,
         page_size=10,
     ).apply(sorted(POSTER_INFO_DATA.keys()))
-    await target.send_message(result.to_unimessage(title="可用订阅列表", formatter=better_channel_message))
+    await target.send_message(
+        result.to_unimessage(title="可用订阅列表", formatter=better_channel_message)
+    )
 
 
-cmd_unsubscribe = on_alconna(Alconna(
-    "取消订阅",
-    Args["channel", str],
-))
+cmd_unsubscribe = on_alconna(
+    Alconna(
+        "取消订阅",
+        Args["channel", str],
+    )
+)
 
 
 @cmd_unsubscribe.handle()
@@ -79,6 +93,7 @@ async def _(target: DepLongTaskTarget, channel: str):
 
 driver = nonebot.get_driver()
 
+
 @driver.on_startup
 async def _():
     async with dep_poster_service() as service:

konabot/plugins/poster/poster_info.py

@@ -1,15 +0,0 @@
-from dataclasses import dataclass, field
-
-
-@dataclass
-class PosterInfo:
-    aliases: set[str] = field(default_factory=set)
-    description: str = field(default='')
-
-
-POSTER_INFO_DATA: dict[str, PosterInfo] = {}
-
-
-def register_poster_info(channel: str, info: PosterInfo):
-    POSTER_INFO_DATA[channel] = info
-

konabot/plugins/poster/repo_local_data.py

@@ -1,112 +0,0 @@
-import asyncio
-from contextlib import asynccontextmanager
-from typing import Annotated
-from nonebot.params import Depends
-from pydantic import BaseModel, ValidationError
-from konabot.common.longtask import LongTaskTarget
-from konabot.common.pager import PagerQuery, PagerResult
-from konabot.common.path import DATA_PATH
-from konabot.plugins.poster.repository import IPosterRepo
-
-
-class ChannelData(BaseModel):
-    targets: list[LongTaskTarget] = []
-
-
-class PosterData(BaseModel):
-    channels: dict[str, ChannelData] = {}
-
-
-def is_the_same_target(target1: LongTaskTarget, target2: LongTaskTarget) -> bool:
-    if (target1.is_private_chat and not target2.is_private_chat):
-        return False
-    if (target2.is_private_chat and not target1.is_private_chat):
-        return False
-    if target1.platform != target2.platform:
-        return False
-
-    # 如果是群聊，则要求 channel_id 相同
-    if not target1.is_private_chat:
-        return target1.channel_id == target2.channel_id
-    return target1.target_id == target2.target_id
-
-
-class LocalPosterRepo(IPosterRepo):
-    def __init__(self, data: PosterData) -> None:
-        self.data = data
-        super().__init__()
-
-    async def get_channel_targets(self, channel: str) -> list[LongTaskTarget]:
-        if channel not in self.data.channels:
-            self.data.channels[channel] = ChannelData()
-        return self.data.channels[channel].targets
-
-    async def add_channel_target(self, channel: str, target: LongTaskTarget) -> bool:
-        targets = await self.get_channel_targets(channel)
-        for t in targets:
-            if is_the_same_target(t, target):
-                return False
-        targets.append(target)
-        return True
-
-    async def remove_channel_target(self, channel: str, target: LongTaskTarget) -> bool:
-        targets = await self.get_channel_targets(channel)
-        len0 = len(targets)
-        self.data.channels[channel].targets = [
-            t for t in targets if not is_the_same_target(t, target)
-        ]
-        len1 = len(self.data.channels[channel].targets)
-        return len0 != len1
-
-    async def get_subscribed_channels(self, target: LongTaskTarget, pager: PagerQuery) -> PagerResult[str]:
-        channels: list[str] = []
-        for channel_id, channel in self.data.channels.items():
-            for t in channel.targets:
-                if is_the_same_target(target, t):
-                    channels.append(channel_id)
-                    break
-        channels = sorted(channels)
-        return pager.apply(channels)
-
-    async def merge_channel(self, from_channel: str, to_channel: str) -> None:
-        channel_from = await self.get_channel_targets(from_channel)
-        channel_to = await self.get_channel_targets(to_channel)
-
-        for t1 in channel_from:
-            flag = True
-            for t2 in channel_to:
-                if is_the_same_target(t1, t2):
-                    flag = False
-                    break
-            if flag:
-                channel_to.append(t1)
-
-        del self.data.channels[from_channel]
-
-
-LOCAL_POSTER_DATA_LOCK = asyncio.Lock()
-LOCAL_POSTER_DATA_PATH = DATA_PATH / "module_poster_data.json"
-
-
-@asynccontextmanager
-async def local_poster_data():
-    async with LOCAL_POSTER_DATA_LOCK:
-        if not LOCAL_POSTER_DATA_PATH.exists():
-            data = PosterData()
-        else:
-            try:
-                data = PosterData.model_validate_json(LOCAL_POSTER_DATA_PATH.read_text())
-            except ValidationError:
-                data = PosterData()
-        yield data
-        LOCAL_POSTER_DATA_PATH.write_text(data.model_dump_json())
-
-
-@asynccontextmanager
-async def local_poster():
-    async with local_poster_data() as data:
-        yield LocalPosterRepo(data)
-
-
-DepLocalPosterRepo = Annotated[LocalPosterRepo, Depends(local_poster)]
-

konabot/plugins/poster/repository.py

@@ -1,37 +0,0 @@
-from abc import ABC, abstractmethod
-
-from konabot.common.longtask import LongTaskTarget
-from konabot.common.pager import PagerQuery, PagerResult
-
-
-class IPosterRepo(ABC):
-    @abstractmethod
-    async def get_channel_targets(self, channel: str) -> list[LongTaskTarget]:
-        """
-        获取广播通道的所有广播对象
-        """
-
-    @abstractmethod
-    async def add_channel_target(self, channel: str, target: LongTaskTarget) -> bool:
-        """
-        向广播通道添加一个广播目标。若目标已存在，则返回 False
-        """
-
-    @abstractmethod
-    async def remove_channel_target(self, channel: str, target: LongTaskTarget) -> bool:
-        """
-        移除一个广播通道的目标。若目标不存在，则返回 False
-        """
-
-    @abstractmethod
-    async def get_subscribed_channels(self, target: LongTaskTarget, pager: PagerQuery) -> PagerResult[str]:
-        """
-        获得一个目标已经订阅了的广播通道
-        """
-
-    @abstractmethod
-    async def merge_channel(self, from_channel: str, to_channel: str) -> None:
-        """
-        合并两个 Channel 为一个，并移除另一个
-        """
-

konabot/plugins/poster/service.py

@@ -1,59 +0,0 @@
-from contextlib import asynccontextmanager
-from typing import Annotated, Any
-from nonebot.params import Depends
-from nonebot_plugin_alconna import UniMessage
-from konabot.common.longtask import LongTaskTarget
-from konabot.common.pager import PagerQuery, PagerResult
-from konabot.plugins.poster.poster_info import POSTER_INFO_DATA
-from konabot.plugins.poster.repo_local_data import local_poster
-from konabot.plugins.poster.repository import IPosterRepo
-
-
-class PosterService:
-    def __init__(self, repo: IPosterRepo) -> None:
-        self.repo = repo
-
-    def parse_channel_id(self, channel: str):
-        for cid, cinfo in POSTER_INFO_DATA.items():
-            if channel in cinfo.aliases:
-                return cid
-        return channel
-
-    async def subscribe(self, channel: str, target: LongTaskTarget) -> bool:
-        channel = self.parse_channel_id(channel)
-        return await self.repo.add_channel_target(channel, target)
-
-    async def unsubscribe(self, channel: str, target: LongTaskTarget) -> bool:
-        channel = self.parse_channel_id(channel)
-        return await self.repo.remove_channel_target(channel, target)
-
-    async def broadcast(self, channel: str, message: UniMessage[Any] | str) -> list[LongTaskTarget]:
-        channel = self.parse_channel_id(channel)
-        targets = await self.repo.get_channel_targets(channel)
-        for target in targets:
-            # 因为是订阅消息，就不要 At 对方了
-            await target.send_message(message, at=False)
-        return targets
-
-    async def get_channels(self, target: LongTaskTarget, pager: PagerQuery) -> PagerResult[str]:
-        return await self.repo.get_subscribed_channels(target, pager)
-
-    async def fix_data(self):
-        for cid, cinfo in POSTER_INFO_DATA.items():
-            for alias in cinfo.aliases:
-                await self.repo.merge_channel(alias, cid)
-
-
-@asynccontextmanager
-async def dep_poster_service():
-    async with local_poster() as repo:
-        yield PosterService(repo)
-
-
-async def broadcast(channel: str, message: UniMessage[Any] | str):
-    async with dep_poster_service() as service:
-        return await service.broadcast(channel, message)
-
-
-DepPosterService = Annotated[PosterService, Depends(dep_poster_service)]
-

konabot/plugins/solar_terms/__init__.py

@@ -4,8 +4,7 @@ from nonebot.internal.adapter.event import Event
 from nonebot_plugin_alconna import UniMessage
 from nonebot_plugin_apscheduler import scheduler
 
-from konabot.plugins.poster.poster_info import PosterInfo, register_poster_info
-from konabot.plugins.poster.service import broadcast
+from konabot.common.subscribe import PosterInfo, register_poster_info, broadcast
 
 register_poster_info(
     "二十四节气",
@@ -98,4 +97,3 @@ async def _(event: Event):
 
     msg = UniMessage.text(f"现在的节气是{date.term}")
     await msg.send(event)
-

konabot/plugins/startup_notify.py

@@ -1,20 +1,23 @@
 import asyncio
 from nonebot import get_driver
 from nonebot_plugin_alconna import UniMessage
-from konabot.plugins.poster.poster_info import register_poster_info, PosterInfo
-from konabot.plugins.poster.service import broadcast
+from konabot.common.subscribe import register_poster_info, PosterInfo, broadcast
 
 
 CHANNEL_STARTUP = "启动通知"
 
 
-register_poster_info(CHANNEL_STARTUP, PosterInfo(
-    aliases=set(),
-    description="当 Bot 重启时告知",
-))
+register_poster_info(
+    CHANNEL_STARTUP,
+    PosterInfo(
+        aliases=set(),
+        description="当 Bot 重启时告知",
+    ),
+)
 
 driver = get_driver()
 
+
 @driver.on_startup
 async def _():
     # 要尽量保证接受讯息的服务存在
@@ -30,4 +33,3 @@ async def _():
         await broadcast(CHANNEL_STARTUP, UniMessage.text("此方 BOT 重启好了"))
 
     asyncio.create_task(task())
-