mirror of
https://github.com/nonebot/nonebot2.git
synced 2024-11-25 01:25:04 +08:00
569 lines
14 KiB
Python
569 lines
14 KiB
Python
import inspect
|
|
from typing_extensions import Literal
|
|
from typing import Type, List, Optional, TYPE_CHECKING
|
|
|
|
from pydantic import BaseModel
|
|
from pygtrie import StringTrie
|
|
from nonebot.utils import escape_tag
|
|
from nonebot.typing import overrides
|
|
from nonebot.exception import NoLogException
|
|
from nonebot.adapters import Event as BaseEvent
|
|
|
|
from .message import Message
|
|
|
|
if TYPE_CHECKING:
|
|
from .bot import Bot
|
|
|
|
|
|
class Event(BaseEvent):
|
|
"""
|
|
CQHTTP 协议事件，字段与 CQHTTP 一致。各事件字段参考 `CQHTTP 文档`_
|
|
|
|
.. _CQHTTP 文档:
|
|
https://github.com/howmanybots/onebot/blob/master/README.md
|
|
"""
|
|
__event__ = ""
|
|
time: int
|
|
self_id: int
|
|
post_type: Literal["message", "notice", "request", "meta_event"]
|
|
|
|
@overrides(BaseEvent)
|
|
def get_type(self) -> Literal["message", "notice", "request", "meta_event"]:
|
|
return self.post_type
|
|
|
|
@overrides(BaseEvent)
|
|
def get_event_name(self) -> str:
|
|
return self.post_type
|
|
|
|
@overrides(BaseEvent)
|
|
def get_event_description(self) -> str:
|
|
return str(self.dict())
|
|
|
|
@overrides(BaseEvent)
|
|
def get_message(self) -> Message:
|
|
raise ValueError("Event has no message!")
|
|
|
|
@overrides(BaseEvent)
|
|
def get_plaintext(self) -> str:
|
|
raise ValueError("Event has no message!")
|
|
|
|
@overrides(BaseEvent)
|
|
def get_user_id(self) -> str:
|
|
raise ValueError("Event has no message!")
|
|
|
|
@overrides(BaseEvent)
|
|
def get_session_id(self) -> str:
|
|
raise ValueError("Event has no message!")
|
|
|
|
@overrides(BaseEvent)
|
|
def is_tome(self) -> bool:
|
|
return False
|
|
|
|
|
|
# Models
|
|
class Sender(BaseModel):
|
|
user_id: Optional[int] = None
|
|
nickname: Optional[str] = None
|
|
sex: Optional[str] = None
|
|
age: Optional[int] = None
|
|
card: Optional[str] = None
|
|
area: Optional[str] = None
|
|
level: Optional[str] = None
|
|
role: Optional[str] = None
|
|
title: Optional[str] = None
|
|
|
|
class Config:
|
|
extra = "allow"
|
|
|
|
|
|
class Reply(BaseModel):
|
|
time: int
|
|
message_type: str
|
|
message_id: int
|
|
real_id: int
|
|
sender: Sender
|
|
message: Message
|
|
|
|
class Config:
|
|
extra = "allow"
|
|
|
|
|
|
class Anonymous(BaseModel):
|
|
id: int
|
|
name: str
|
|
flag: str
|
|
|
|
class Config:
|
|
extra = "allow"
|
|
|
|
|
|
class File(BaseModel):
|
|
id: str
|
|
name: str
|
|
size: int
|
|
busid: int
|
|
|
|
class Config:
|
|
extra = "allow"
|
|
|
|
|
|
class Status(BaseModel):
|
|
online: bool
|
|
good: bool
|
|
|
|
class Config:
|
|
extra = "allow"
|
|
|
|
|
|
# Message Events
|
|
class MessageEvent(Event):
|
|
"""消息事件"""
|
|
__event__ = "message"
|
|
post_type: Literal["message"]
|
|
sub_type: str
|
|
user_id: int
|
|
message_type: str
|
|
message_id: int
|
|
message: Message
|
|
raw_message: str
|
|
font: int
|
|
sender: Sender
|
|
to_me: bool = False
|
|
"""
|
|
:说明: 消息是否与机器人有关
|
|
|
|
:类型: ``bool``
|
|
"""
|
|
reply: Optional[Reply] = None
|
|
"""
|
|
:说明: 消息中提取的回复消息，内容为 ``get_msg`` API 返回结果
|
|
|
|
:类型: ``Optional[Reply]``
|
|
"""
|
|
|
|
@overrides(Event)
|
|
def get_event_name(self) -> str:
|
|
sub_type = getattr(self, "sub_type", None)
|
|
return f"{self.post_type}.{self.message_type}" + (f".{sub_type}"
|
|
if sub_type else "")
|
|
|
|
@overrides(Event)
|
|
def get_message(self) -> Message:
|
|
return self.message
|
|
|
|
@overrides(Event)
|
|
def get_plaintext(self) -> str:
|
|
return self.message.extract_plain_text()
|
|
|
|
@overrides(Event)
|
|
def get_user_id(self) -> str:
|
|
return str(self.user_id)
|
|
|
|
@overrides(Event)
|
|
def get_session_id(self) -> str:
|
|
return str(self.user_id)
|
|
|
|
@overrides(Event)
|
|
def is_tome(self) -> bool:
|
|
return self.to_me
|
|
|
|
|
|
class PrivateMessageEvent(MessageEvent):
|
|
"""私聊消息"""
|
|
__event__ = "message.private"
|
|
message_type: Literal["private"]
|
|
|
|
@overrides(Event)
|
|
def get_event_description(self) -> str:
|
|
return (f'Message {self.message_id} from {self.user_id} "' + "".join(
|
|
map(
|
|
lambda x: escape_tag(str(x))
|
|
if x.is_text() else f"<le>{escape_tag(str(x))}</le>",
|
|
self.message)) + '"')
|
|
|
|
|
|
class GroupMessageEvent(MessageEvent):
|
|
"""群消息"""
|
|
__event__ = "message.group"
|
|
message_type: Literal["group"]
|
|
group_id: int
|
|
anonymous: Optional[Anonymous] = None
|
|
|
|
@overrides(Event)
|
|
def get_event_description(self) -> str:
|
|
return (
|
|
f'Message {self.message_id} from {self.user_id}@[群:{self.group_id}] "'
|
|
+ "".join(
|
|
map(
|
|
lambda x: escape_tag(str(x))
|
|
if x.is_text() else f"<le>{escape_tag(str(x))}</le>",
|
|
self.message)) + '"')
|
|
|
|
|
|
# Notice Events
|
|
class NoticeEvent(Event):
|
|
"""通知事件"""
|
|
__event__ = "notice"
|
|
post_type: Literal["notice"]
|
|
notice_type: str
|
|
|
|
@overrides(Event)
|
|
def get_event_name(self) -> str:
|
|
sub_type = getattr(self, "sub_type", None)
|
|
return f"{self.post_type}.{self.notice_type}" + (f".{sub_type}"
|
|
if sub_type else "")
|
|
|
|
|
|
class GroupUploadNoticeEvent(NoticeEvent):
|
|
"""群文件上传事件"""
|
|
__event__ = "notice.group_upload"
|
|
notice_type: Literal["group_upload"]
|
|
user_id: int
|
|
group_id: int
|
|
file: File
|
|
|
|
@overrides(NoticeEvent)
|
|
def get_user_id(self) -> str:
|
|
return str(self.user_id)
|
|
|
|
@overrides(NoticeEvent)
|
|
def get_session_id(self) -> str:
|
|
return str(self.user_id)
|
|
|
|
|
|
class GroupAdminNoticeEvent(NoticeEvent):
|
|
"""群管理员变动"""
|
|
__event__ = "notice.group_admin"
|
|
notice_type: Literal["group_admin"]
|
|
sub_type: str
|
|
user_id: int
|
|
group_id: int
|
|
|
|
@overrides(NoticeEvent)
|
|
def is_tome(self) -> bool:
|
|
return self.user_id == self.self_id
|
|
|
|
@overrides(NoticeEvent)
|
|
def get_user_id(self) -> str:
|
|
return str(self.user_id)
|
|
|
|
@overrides(NoticeEvent)
|
|
def get_session_id(self) -> str:
|
|
return str(self.user_id)
|
|
|
|
|
|
class GroupDecreaseNoticeEvent(NoticeEvent):
|
|
"""群成员减少事件"""
|
|
__event__ = "notice.group_decrease"
|
|
notice_type: Literal["group_decrease"]
|
|
sub_type: str
|
|
user_id: int
|
|
group_id: int
|
|
operator_id: int
|
|
|
|
@overrides(NoticeEvent)
|
|
def is_tome(self) -> bool:
|
|
return self.user_id == self.self_id
|
|
|
|
@overrides(NoticeEvent)
|
|
def get_user_id(self) -> str:
|
|
return str(self.user_id)
|
|
|
|
@overrides(NoticeEvent)
|
|
def get_session_id(self) -> str:
|
|
return str(self.user_id)
|
|
|
|
|
|
class GroupIncreaseNoticeEvent(NoticeEvent):
|
|
"""群成员增加事件"""
|
|
__event__ = "notice.group_increase"
|
|
notice_type: Literal["group_increase"]
|
|
sub_type: str
|
|
user_id: int
|
|
group_id: int
|
|
operator_id: int
|
|
|
|
@overrides(NoticeEvent)
|
|
def is_tome(self) -> bool:
|
|
return self.user_id == self.self_id
|
|
|
|
@overrides(NoticeEvent)
|
|
def get_user_id(self) -> str:
|
|
return str(self.user_id)
|
|
|
|
@overrides(NoticeEvent)
|
|
def get_session_id(self) -> str:
|
|
return str(self.user_id)
|
|
|
|
|
|
class GroupBanNoticeEvent(NoticeEvent):
|
|
"""群禁言事件"""
|
|
__event__ = "notice.group_ban"
|
|
notice_type: Literal["group_ban"]
|
|
sub_type: str
|
|
user_id: int
|
|
group_id: int
|
|
operator_id: int
|
|
duration: int
|
|
|
|
@overrides(NoticeEvent)
|
|
def is_tome(self) -> bool:
|
|
return self.user_id == self.self_id
|
|
|
|
@overrides(NoticeEvent)
|
|
def get_user_id(self) -> str:
|
|
return str(self.user_id)
|
|
|
|
@overrides(NoticeEvent)
|
|
def get_session_id(self) -> str:
|
|
return str(self.user_id)
|
|
|
|
|
|
class FriendAddNoticeEvent(NoticeEvent):
|
|
"""好友添加事件"""
|
|
__event__ = "notice.friend_add"
|
|
notice_type: Literal["friend_add"]
|
|
user_id: int
|
|
|
|
@overrides(NoticeEvent)
|
|
def get_user_id(self) -> str:
|
|
return str(self.user_id)
|
|
|
|
@overrides(NoticeEvent)
|
|
def get_session_id(self) -> str:
|
|
return str(self.user_id)
|
|
|
|
|
|
class GroupRecallNoticeEvent(NoticeEvent):
|
|
"""群消息撤回事件"""
|
|
__event__ = "notice.group_recall"
|
|
notice_type: Literal["group_recall"]
|
|
user_id: int
|
|
group_id: int
|
|
operator_id: int
|
|
message_id: int
|
|
|
|
@overrides(Event)
|
|
def is_tome(self) -> bool:
|
|
return self.user_id == self.self_id
|
|
|
|
@overrides(NoticeEvent)
|
|
def get_user_id(self) -> str:
|
|
return str(self.user_id)
|
|
|
|
@overrides(NoticeEvent)
|
|
def get_session_id(self) -> str:
|
|
return str(self.user_id)
|
|
|
|
|
|
class FriendRecallNoticeEvent(NoticeEvent):
|
|
"""好友消息撤回事件"""
|
|
__event__ = "notice.friend_recall"
|
|
notice_type: Literal["friend_recall"]
|
|
user_id: int
|
|
message_id: int
|
|
|
|
@overrides(NoticeEvent)
|
|
def get_user_id(self) -> str:
|
|
return str(self.user_id)
|
|
|
|
@overrides(NoticeEvent)
|
|
def get_session_id(self) -> str:
|
|
return str(self.user_id)
|
|
|
|
|
|
class NotifyEvent(NoticeEvent):
|
|
"""提醒事件"""
|
|
__event__ = "notice.notify"
|
|
notice_type: Literal["notify"]
|
|
sub_type: str
|
|
user_id: int
|
|
group_id: int
|
|
|
|
@overrides(NoticeEvent)
|
|
def get_user_id(self) -> str:
|
|
return str(self.user_id)
|
|
|
|
@overrides(NoticeEvent)
|
|
def get_session_id(self) -> str:
|
|
return str(self.user_id)
|
|
|
|
|
|
class PokeNotifyEvent(NotifyEvent):
|
|
"""戳一戳提醒事件"""
|
|
__event__ = "notice.notify.poke"
|
|
sub_type: Literal["poke"]
|
|
target_id: int
|
|
group_id: Optional[int] = None
|
|
|
|
@overrides(Event)
|
|
def is_tome(self) -> bool:
|
|
return self.target_id == self.self_id
|
|
|
|
|
|
class LuckyKingNotifyEvent(NotifyEvent):
|
|
"""群红包运气王提醒事件"""
|
|
__event__ = "notice.notify.lucky_king"
|
|
sub_type: Literal["lucky_king"]
|
|
target_id: int
|
|
|
|
@overrides(Event)
|
|
def is_tome(self) -> bool:
|
|
return self.target_id == self.self_id
|
|
|
|
@overrides(NotifyEvent)
|
|
def get_user_id(self) -> str:
|
|
return str(self.target_id)
|
|
|
|
@overrides(NotifyEvent)
|
|
def get_session_id(self) -> str:
|
|
return str(self.target_id)
|
|
|
|
|
|
class HonorNotifyEvent(NotifyEvent):
|
|
"""群荣誉变更提醒事件"""
|
|
__event__ = "notice.notify.honor"
|
|
sub_type: Literal["honor"]
|
|
honor_type: str
|
|
|
|
@overrides(Event)
|
|
def is_tome(self) -> bool:
|
|
return self.user_id == self.self_id
|
|
|
|
|
|
# Request Events
|
|
class RequestEvent(Event):
|
|
"""请求事件"""
|
|
__event__ = "request"
|
|
post_type: Literal["request"]
|
|
request_type: str
|
|
|
|
@overrides(Event)
|
|
def get_event_name(self) -> str:
|
|
sub_type = getattr(self, "sub_type", None)
|
|
return f"{self.post_type}.{self.request_type}" + (f".{sub_type}"
|
|
if sub_type else "")
|
|
|
|
|
|
class FriendRequestEvent(RequestEvent):
|
|
"""加好友请求事件"""
|
|
__event__ = "request.friend"
|
|
request_type: Literal["friend"]
|
|
user_id: int
|
|
comment: str
|
|
flag: str
|
|
|
|
@overrides(RequestEvent)
|
|
def get_user_id(self) -> str:
|
|
return str(self.user_id)
|
|
|
|
@overrides(RequestEvent)
|
|
def get_session_id(self) -> str:
|
|
return str(self.user_id)
|
|
|
|
async def approve(self, bot: "Bot", remark: str = ""):
|
|
return await bot.set_friend_add_request(flag=self.flag,
|
|
approve=True,
|
|
remark=remark)
|
|
|
|
async def reject(self, bot: "Bot"):
|
|
return await bot.set_friend_add_request(flag=self.flag, approve=False)
|
|
|
|
|
|
class GroupRequestEvent(RequestEvent):
|
|
"""加群请求/邀请事件"""
|
|
__event__ = "request.group"
|
|
request_type: Literal["group"]
|
|
sub_type: str
|
|
group_id: int
|
|
user_id: int
|
|
comment: str
|
|
flag: str
|
|
|
|
@overrides(RequestEvent)
|
|
def get_user_id(self) -> str:
|
|
return str(self.user_id)
|
|
|
|
@overrides(RequestEvent)
|
|
def get_session_id(self) -> str:
|
|
return str(self.user_id)
|
|
|
|
async def approve(self, bot: "Bot"):
|
|
return await bot.set_group_add_request(flag=self.flag,
|
|
sub_type=self.sub_type,
|
|
approve=True)
|
|
|
|
async def reject(self, bot: "Bot", reason: str = ""):
|
|
return await bot.set_group_add_request(flag=self.flag,
|
|
sub_type=self.sub_type,
|
|
approve=False,
|
|
reason=reason)
|
|
|
|
|
|
# Meta Events
|
|
class MetaEvent(Event):
|
|
"""元事件"""
|
|
__event__ = "meta_event"
|
|
post_type: Literal["meta_event"]
|
|
meta_event_type: str
|
|
|
|
@overrides(Event)
|
|
def get_event_name(self) -> str:
|
|
sub_type = getattr(self, "sub_type", None)
|
|
return f"{self.post_type}.{self.meta_event_type}" + (f".{sub_type}" if
|
|
sub_type else "")
|
|
|
|
@overrides(Event)
|
|
def get_log_string(self) -> str:
|
|
raise NoLogException
|
|
|
|
|
|
class LifecycleMetaEvent(MetaEvent):
|
|
"""生命周期元事件"""
|
|
__event__ = "meta_event.lifecycle"
|
|
meta_event_type: Literal["lifecycle"]
|
|
sub_type: str
|
|
|
|
|
|
class HeartbeatMetaEvent(MetaEvent):
|
|
"""心跳元事件"""
|
|
__event__ = "meta_event.heartbeat"
|
|
meta_event_type: Literal["heartbeat"]
|
|
status: Status
|
|
interval: int
|
|
|
|
|
|
_t = StringTrie(separator=".")
|
|
|
|
# define `model` first to avoid globals changing while `for`
|
|
model = None
|
|
for model in globals().values():
|
|
if not inspect.isclass(model) or not issubclass(model, Event):
|
|
continue
|
|
_t["." + model.__event__] = model
|
|
|
|
|
|
def get_event_model(event_name) -> List[Type[Event]]:
|
|
"""
|
|
:说明:
|
|
|
|
根据事件名获取对应 ``Event Model`` 及 ``FallBack Event Model`` 列表
|
|
|
|
:返回:
|
|
|
|
- ``List[Type[Event]]``
|
|
"""
|
|
return [model.value for model in _t.prefixes("." + event_name)][::-1]
|
|
|
|
|
|
__all__ = [
|
|
"Event", "MessageEvent", "PrivateMessageEvent", "GroupMessageEvent",
|
|
"NoticeEvent", "GroupUploadNoticeEvent", "GroupAdminNoticeEvent",
|
|
"GroupDecreaseNoticeEvent", "GroupIncreaseNoticeEvent",
|
|
"GroupBanNoticeEvent", "FriendAddNoticeEvent", "GroupRecallNoticeEvent",
|
|
"FriendRecallNoticeEvent", "NotifyEvent", "PokeNotifyEvent",
|
|
"LuckyKingNotifyEvent", "HonorNotifyEvent", "RequestEvent",
|
|
"FriendRequestEvent", "GroupRequestEvent", "MetaEvent",
|
|
"LifecycleMetaEvent", "HeartbeatMetaEvent", "get_event_model"
|
|
]
|