zhenxun_bot/zhenxun/utils/platform.py

662 lines
23 KiB
Python
Raw Normal View History

2024-05-20 22:03:11 +08:00
import random
from typing import Literal
2024-09-09 23:01:15 +08:00
from collections.abc import Callable, Awaitable
2024-05-04 13:48:12 +08:00
import httpx
import nonebot
2024-09-09 23:01:15 +08:00
from pydantic import BaseModel
2024-02-25 03:18:34 +08:00
from nonebot.adapters import Bot
2024-09-09 23:01:15 +08:00
from nonebot.utils import is_coroutine_callable
2024-10-18 18:57:55 +08:00
from nonebot_plugin_alconna import SupportScope
2024-02-25 03:18:34 +08:00
from nonebot.adapters.dodo import Bot as DodoBot
from nonebot.adapters.onebot.v11 import Bot as v11Bot
from nonebot.adapters.onebot.v12 import Bot as v12Bot
2024-10-18 18:57:55 +08:00
from nonebot_plugin_uninfo import Uninfo, get_interface
2024-09-09 23:01:15 +08:00
from nonebot.adapters.kaiheila import Bot as KaiheilaBot
from nonebot_plugin_alconna.uniseg import Target, Receipt, UniMessage
2024-02-25 03:18:34 +08:00
2024-09-09 23:01:15 +08:00
from zhenxun.services.log import logger
from zhenxun.configs.config import BotConfig
2024-09-09 23:01:15 +08:00
from zhenxun.utils.message import MessageUtils
2024-10-18 18:57:55 +08:00
from zhenxun.utils.http_utils import AsyncHttpx
from zhenxun.models.friend_user import FriendUser
2024-09-04 21:10:54 +08:00
from zhenxun.utils.exception import NotFindSuperuser
2024-09-09 23:01:15 +08:00
from zhenxun.models.group_console import GroupConsole
2024-02-25 03:18:34 +08:00
2024-10-18 18:57:55 +08:00
driver = nonebot.get_driver()
2024-02-25 03:18:34 +08:00
2024-05-16 19:54:30 +08:00
class UserData(BaseModel):
name: str
"""昵称"""
card: str | None = None
"""名片/备注"""
user_id: str
"""用户id"""
group_id: str | None = None
"""群组id"""
role: str | None = None
"""角色"""
avatar_url: str | None = None
"""头像url"""
join_time: int | None = None
"""加入时间"""
2024-03-27 20:09:30 +08:00
class PlatformUtils:
2024-10-18 18:57:55 +08:00
@classmethod
def is_qbot(cls, session: Uninfo) -> bool:
"""判断bot是否为qq官bot
参数:
session: Uninfo
返回:
bool: 是否为官bot
"""
return session.scope == SupportScope.qq_api
2024-05-29 02:01:26 +08:00
@classmethod
async def ban_user(cls, bot: Bot, user_id: str, group_id: str, duration: int):
"""禁言
参数:
bot: Bot
user_id: 用户id
group_id: 群组id
duration: 禁言时长(分钟)
"""
if isinstance(bot, v11Bot):
await bot.set_group_ban(
group_id=int(group_id),
user_id=int(user_id),
duration=duration * 60,
)
2024-05-20 22:03:11 +08:00
@classmethod
async def send_superuser(
cls,
bot: Bot,
2024-08-19 23:07:43 +08:00
message: UniMessage | str,
2024-05-20 22:03:11 +08:00
superuser_id: str | None = None,
) -> Receipt | None:
"""发送消息给超级用户
参数:
bot: Bot
message: 消息
superuser_id: 指定超级用户id.
异常:
NotFindSuperuser: 未找到超级用户id
返回:
Receipt | None: Receipt
"""
if not superuser_id:
if platform := cls.get_platform(bot):
if platform_superusers := BotConfig.get_superuser(platform):
superuser_id = random.choice(platform_superusers)
else:
raise NotFindSuperuser()
2024-08-19 23:07:43 +08:00
if isinstance(message, str):
message = MessageUtils.build_message(message)
2024-05-20 22:03:11 +08:00
return await cls.send_message(bot, superuser_id, None, message)
2024-05-16 19:54:30 +08:00
@classmethod
async def get_group_member_list(cls, bot: Bot, group_id: str) -> list[UserData]:
"""获取群组/频道成员列表
参数:
bot: Bot
group_id: 群组/频道id
返回:
list[UserData]: 用户数据列表
"""
if isinstance(bot, v11Bot):
if member_list := await bot.get_group_member_list(group_id=int(group_id)):
return [
UserData(
name=user["nickname"],
card=user["card"],
user_id=user["user_id"],
group_id=user["group_id"],
role=user["role"],
join_time=user["join_time"],
)
for user in member_list
]
if isinstance(bot, v12Bot):
if member_list := await bot.get_group_member_list(group_id=group_id):
return [
UserData(
name=user["user_name"],
card=user["user_displayname"],
user_id=user["user_id"],
group_id=group_id,
)
for user in member_list
]
if isinstance(bot, DodoBot):
if result_data := await bot.get_member_list(
island_source_id=group_id, page_size=100, max_id=0
):
max_id = result_data.max_id
result_list = result_data.list
while max_id == 100:
result_data = await bot.get_member_list(
island_source_id=group_id, page_size=100, max_id=0
)
result_list += result_data.list
max_id = result_data.max_id
return [
UserData(
name=user.nick_name,
card=user.personal_nick_name,
avatar_url=user.avatar_url,
user_id=user.dodo_source_id,
group_id=user.island_source_id,
join_time=int(user.join_time.timestamp()),
2024-05-16 19:54:30 +08:00
)
for user in result_list
]
2024-05-16 19:54:30 +08:00
if isinstance(bot, KaiheilaBot):
if result_data := await bot.guild_userList(guild_id=group_id):
if result_data.users:
data_list = []
for user in result_data.users:
second = None
if user.joined_at:
second = int(user.joined_at / 1000)
data_list.append(
UserData(
name=user.nickname or "",
avatar_url=user.avatar,
user_id=user.id_, # type: ignore
group_id=group_id,
join_time=second,
)
)
return data_list
return []
@classmethod
async def get_user(
cls, bot: Bot, user_id: str, group_id: str | None = None
) -> UserData | None:
"""获取用户信息
参数:
bot: Bot
user_id: 用户id
group_id: 群组/频道id.
返回:
UserData | None: 用户数据
"""
if isinstance(bot, v11Bot):
if group_id:
if user := await bot.get_group_member_info(
group_id=int(group_id), user_id=int(user_id)
):
return UserData(
name=user["nickname"],
card=user["card"],
user_id=user["user_id"],
group_id=user["group_id"],
role=user["role"],
join_time=user["join_time"],
)
elif friend_list := await bot.get_friend_list():
for f in friend_list:
if f["user_id"] == int(user_id):
return UserData(
name=f["nickname"],
card=f["remark"],
user_id=f["user_id"],
)
2024-05-16 19:54:30 +08:00
if isinstance(bot, v12Bot):
if group_id:
if user := await bot.get_group_member_info(
group_id=group_id, user_id=user_id
):
return UserData(
name=user["user_name"],
card=user["user_displayname"],
user_id=user["user_id"],
group_id=group_id,
)
elif friend_list := await bot.get_friend_list():
for f in friend_list:
if f["user_id"] == int(user_id):
return UserData(
name=f["user_name"],
card=f["user_remark"],
user_id=f["user_id"],
)
if isinstance(bot, DodoBot) and group_id:
if user := await bot.get_member_info(
island_source_id=group_id, dodo_source_id=user_id
):
return UserData(
name=user.nick_name,
card=user.personal_nick_name,
avatar_url=user.avatar_url,
user_id=user.dodo_source_id,
group_id=user.island_source_id,
join_time=int(user.join_time.timestamp()),
)
if isinstance(bot, KaiheilaBot) and group_id:
if user := await bot.user_view(guild_id=group_id, user_id=user_id):
second = int(user.joined_at / 1000) if user.joined_at else None
return UserData(
name=user.nickname or "",
avatar_url=user.avatar,
user_id=user_id,
group_id=group_id,
join_time=second,
)
2024-05-16 19:54:30 +08:00
return None
2024-05-04 13:48:12 +08:00
@classmethod
2024-10-18 18:57:55 +08:00
async def get_user_avatar(
cls, user_id: str, platform: str, appid: str | None = None
) -> bytes | None:
2024-05-04 13:48:12 +08:00
"""快捷获取用户头像
参数:
user_id: 用户id
platform: 平台
"""
2024-10-18 18:57:55 +08:00
url = None
2024-05-04 13:48:12 +08:00
if platform == "qq":
2024-10-18 18:57:55 +08:00
if user_id.isdigit():
url = f"http://q1.qlogo.cn/g?b=qq&nk={user_id}&s=160"
else:
url = f"https://q.qlogo.cn/qqapp/{appid}/{user_id}/100"
return await AsyncHttpx.get_content(url) if url else None
2024-05-04 13:48:12 +08:00
@classmethod
2024-10-18 18:57:55 +08:00
def get_user_avatar_url(
cls, user_id: str, platform: str, appid: str | None = None
) -> str | None:
"""快捷获取用户头像url
参数:
user_id: 用户id
platform: 平台
"""
if platform == "qq":
2024-10-18 18:57:55 +08:00
return (
f"http://q1.qlogo.cn/g?b=qq&nk={user_id}&s=160"
if user_id.isdigit()
else f"https://q.qlogo.cn/qqapp/{appid}/{user_id}/100"
)
else:
return None
2024-05-04 13:48:12 +08:00
@classmethod
async def get_group_avatar(cls, gid: str, platform: str) -> bytes | None:
"""快捷获取用群头像
参数:
gid: 群组id
platform: 平台
"""
if platform == "qq":
url = f"http://p.qlogo.cn/gh/{gid}/{gid}/640/"
async with httpx.AsyncClient() as client:
for _ in range(3):
try:
return (await client.get(url)).content
except Exception:
2024-05-04 13:48:12 +08:00
logger.error(
"获取群头像错误", "Util", target=gid, platform=platform
)
return None
2024-03-18 16:10:44 +08:00
@classmethod
async def send_message(
cls,
bot: Bot,
user_id: str | None,
group_id: str | None,
2024-08-11 15:57:33 +08:00
message: str | UniMessage,
2024-05-20 22:03:11 +08:00
) -> Receipt | None:
2024-03-18 16:10:44 +08:00
"""发送消息
参数:
bot: Bot
user_id: 用户id
group_id: 群组id或频道id
message: 消息文本
返回:
2024-05-20 22:03:11 +08:00
Receipt | None: 是否发送成功
2024-03-18 16:10:44 +08:00
"""
if target := cls.get_target(bot, user_id, group_id):
2024-08-11 15:57:33 +08:00
send_message = (
MessageUtils.build_message(message)
if isinstance(message, str)
else message
)
return await send_message.send(target=target, bot=bot)
2024-05-20 22:03:11 +08:00
return None
2024-03-18 16:10:44 +08:00
2024-02-25 03:18:34 +08:00
@classmethod
2024-02-28 13:51:16 +08:00
async def update_group(cls, bot: Bot) -> int:
2024-02-25 03:18:34 +08:00
"""更新群组信息
参数:
bot: Bot
返回:
int: 更新个数
"""
create_list = []
2024-08-25 15:49:36 +08:00
update_list = []
group_list, platform = await cls.get_group_list(bot)
2024-02-28 13:51:16 +08:00
if group_list:
2024-08-25 15:49:36 +08:00
db_group = await GroupConsole.all()
db_group_id = [(group.group_id, group.channel_id) for group in db_group]
2024-02-25 03:18:34 +08:00
for group in group_list:
group.platform = platform
2024-08-25 15:49:36 +08:00
if (group.group_id, group.channel_id) not in db_group_id:
2024-02-25 03:18:34 +08:00
create_list.append(group)
logger.debug(
"群聊信息更新成功",
"更新群信息",
target=f"{group.group_id}:{group.channel_id}",
)
2024-08-25 15:49:36 +08:00
else:
_group = next(
2024-08-25 15:49:36 +08:00
g
for g in db_group
if g.group_id == group.group_id
and g.channel_id == group.channel_id
)
2024-08-25 15:49:36 +08:00
_group.group_name = group.group_name
_group.max_member_count = group.max_member_count
_group.member_count = group.member_count
update_list.append(_group)
2024-02-25 03:18:34 +08:00
if create_list:
await GroupConsole.bulk_create(create_list, 10)
2024-08-25 15:49:36 +08:00
if group_list:
await GroupConsole.bulk_update(
update_list, ["group_name", "max_member_count", "member_count"], 10
)
2024-02-25 03:18:34 +08:00
return len(create_list)
@classmethod
2024-10-18 18:57:55 +08:00
def get_platform(cls, t: Bot | Uninfo) -> str:
"""获取平台
参数:
bot: Bot
返回:
str | None: 平台
"""
2024-10-18 18:57:55 +08:00
if isinstance(t, Bot):
if interface := get_interface(t):
info = interface.basic_info()
platform = info["scope"].lower()
return "qq" if platform.startswith("qq") else platform
else:
platform = t.basic["scope"].lower()
return "qq" if platform.startswith("qq") else platform
return "unknown"
@classmethod
async def get_group_list(cls, bot: Bot) -> tuple[list[GroupConsole], str]:
2024-02-25 03:18:34 +08:00
"""获取群组列表
参数:
bot: Bot
返回:
2024-05-04 13:48:12 +08:00
tuple[list[GroupConsole], str]: 群组列表, 平台
2024-02-25 03:18:34 +08:00
"""
if isinstance(bot, v11Bot):
group_list = await bot.get_group_list()
return [
GroupConsole(
group_id=str(g["group_id"]),
group_name=g["group_name"],
max_member_count=g["max_member_count"],
member_count=g["member_count"],
)
for g in group_list
2024-02-28 13:51:16 +08:00
], "qq"
2024-02-25 03:18:34 +08:00
if isinstance(bot, v12Bot):
group_list = await bot.get_group_list()
return [
GroupConsole(
group_id=g.group_id, # type: ignore
user_name=g.group_name, # type: ignore
)
for g in group_list
2024-02-28 13:51:16 +08:00
], "qq"
2024-02-25 03:18:34 +08:00
if isinstance(bot, DodoBot):
island_list = await bot.get_island_list()
source_id_list = [
(g.island_source_id, g.island_name)
for g in island_list
if g.island_source_id
]
group_list = []
for id, name in source_id_list:
channel_list = await bot.get_channel_list(island_source_id=id)
group_list.append(GroupConsole(group_id=id, group_name=name))
group_list += [
GroupConsole(
group_id=id, group_name=c.channel_name, channel_id=c.channel_id
)
for c in channel_list
]
2024-02-28 13:51:16 +08:00
return group_list, "dodo"
2024-02-25 03:18:34 +08:00
if isinstance(bot, KaiheilaBot):
2024-02-28 13:51:16 +08:00
group_list = []
guilds = await bot.guild_list()
if guilds.guilds:
for guild_id, name in [(g.id_, g.name) for g in guilds.guilds if g.id_]:
view = await bot.guild_view(guild_id=guild_id)
group_list.append(GroupConsole(group_id=guild_id, group_name=name))
if view.channels:
group_list += [
GroupConsole(
group_id=guild_id, group_name=c.name, channel_id=c.id_
)
for c in view.channels
if c.type != 0
]
return group_list, "kaiheila"
return [], ""
2024-02-25 03:18:34 +08:00
@classmethod
2024-02-28 13:51:16 +08:00
async def update_friend(cls, bot: Bot) -> int:
2024-02-25 03:18:34 +08:00
"""更新好友信息
参数:
bot: Bot
返回:
int: 更新个数
"""
create_list = []
friend_list, platform = await cls.get_friend_list(bot)
2024-02-28 13:51:16 +08:00
if friend_list:
2024-02-25 03:18:34 +08:00
user_id_list = await FriendUser.all().values_list("user_id", flat=True)
for friend in friend_list:
friend.platform = platform
if friend.user_id not in user_id_list:
create_list.append(friend)
if create_list:
await FriendUser.bulk_create(create_list, 10)
return len(create_list)
@classmethod
async def get_friend_list(cls, bot: Bot) -> tuple[list[FriendUser], str]:
2024-02-25 03:18:34 +08:00
"""获取好友列表
参数:
bot: Bot
返回:
list[FriendUser]: 好友列表
"""
if isinstance(bot, v11Bot):
friend_list = await bot.get_friend_list()
return [
FriendUser(user_id=str(f["user_id"]), user_name=f["nickname"])
for f in friend_list
2024-02-28 13:51:16 +08:00
], "qq"
2024-02-25 03:18:34 +08:00
if isinstance(bot, v12Bot):
friend_list = await bot.get_friend_list()
return [
FriendUser(
user_id=f.user_id, # type: ignore
user_name=f.user_displayname or f.user_remark or f.user_name, # type: ignore
)
for f in friend_list
2024-02-28 13:51:16 +08:00
], "qq"
# if isinstance(bot, DodoBot):
# # TODO: dodo好友列表
# pass
# if isinstance(bot, KaiheilaBot):
# # TODO: kaiheila好友列表
# pass
# if isinstance(bot, DiscordBot):
# # TODO: discord好友列表
# pass
2024-02-28 13:51:16 +08:00
return [], ""
@classmethod
2024-03-18 16:10:44 +08:00
def get_target(
cls,
bot: Bot,
user_id: str | None = None,
group_id: str | None = None,
2024-08-11 15:57:33 +08:00
channel_id: str | None = None,
2024-03-18 16:10:44 +08:00
):
"""获取发生Target
参数:
bot: Bot
2024-05-04 13:48:12 +08:00
user_id: 用户id
group_id: 频道id或群组id
2024-08-11 15:57:33 +08:00
channel_id: 频道id
返回:
target: 对应平台Target
"""
target = None
if isinstance(bot, v11Bot | v12Bot):
if group_id:
2024-08-11 15:57:33 +08:00
target = Target(group_id)
2024-03-18 16:10:44 +08:00
elif user_id:
2024-08-11 15:57:33 +08:00
target = Target(user_id, private=True)
elif isinstance(bot, DodoBot | KaiheilaBot):
2024-08-11 15:57:33 +08:00
if group_id and channel_id:
target = Target(channel_id, parent_id=group_id, channel=True)
2024-03-18 16:10:44 +08:00
elif user_id:
2024-08-11 15:57:33 +08:00
target = Target(user_id, private=True)
return target
async def broadcast_group(
2024-08-11 15:57:33 +08:00
message: str | UniMessage,
bot: Bot | list[Bot] | None = None,
bot_id: str | set[str] | None = None,
ignore_group: set[int] | None = None,
2024-10-18 18:57:55 +08:00
check_func: Callable[[Bot, str], Awaitable] | None = None,
log_cmd: str | None = None,
platform: Literal["qq", "dodo", "kaiheila"] | None = None,
):
"""获取所有Bot或指定Bot对象广播群聊
2024-03-29 23:27:25 +08:00
参数:
message: 广播消息内容
bot: 指定bot对象.
bot_id: 指定bot id.
ignore_group: 忽略群聊列表.
check_func: 发送前对群聊检测方法判断是否发送.
log_cmd: 日志标记.
platform: 指定平台
"""
if platform and platform not in ["qq", "dodo", "kaiheila"]:
raise ValueError("指定平台不支持")
if not message:
raise ValueError("群聊广播消息不能为空")
bot_dict = nonebot.get_bots()
bot_list: list[Bot] = []
if bot:
if isinstance(bot, list):
bot_list = bot
else:
bot_list.append(bot)
elif bot_id:
_bot_id_list = bot_id
if isinstance(bot_id, str):
_bot_id_list = [bot_id]
for id_ in _bot_id_list:
if bot_id in bot_dict:
bot_list.append(bot_dict[bot_id])
else:
logger.warning(f"Bot:{id_} 对象未连接或不存在")
else:
bot_list = list(bot_dict.values())
_used_group = []
for _bot in bot_list:
try:
2024-03-27 20:09:30 +08:00
if platform and platform != PlatformUtils.get_platform(_bot):
continue
2024-03-27 20:09:30 +08:00
group_list, _ = await PlatformUtils.get_group_list(_bot)
if group_list:
for group in group_list:
key = f"{group.group_id}:{group.channel_id}"
try:
if (
ignore_group
and (
group.group_id in ignore_group
or group.channel_id in ignore_group
)
) or key in _used_group:
logger.debug(
"广播方法群组重复, 已跳过...",
log_cmd,
group_id=group.group_id,
)
continue
2024-08-05 00:20:27 +08:00
is_run = False
if check_func:
if is_coroutine_callable(check_func):
2024-10-18 18:57:55 +08:00
is_run = await check_func(_bot, group.group_id)
else:
2024-10-18 18:57:55 +08:00
is_run = check_func(_bot, group.group_id)
2024-08-05 00:20:27 +08:00
if not is_run:
logger.debug(
"广播方法检测运行方法为 False, 已跳过...",
log_cmd,
group_id=group.group_id,
)
continue
2024-03-27 20:09:30 +08:00
target = PlatformUtils.get_target(
2024-08-11 15:57:33 +08:00
_bot, None, group.group_id, group.channel_id
)
if target:
_used_group.append(key)
message_list = message
2024-08-11 15:57:33 +08:00
await MessageUtils.build_message(message_list).send(
target, _bot
)
logger.debug("发送成功", log_cmd, target=key)
else:
logger.warning("target为空", log_cmd, target=key)
except Exception as e:
logger.error("发送失败", log_cmd, target=key, e=e)
except Exception as e:
logger.error(f"Bot: {_bot.self_id} 获取群聊列表失败", command=log_cmd, e=e)