mirror of
https://github.com/nonebot/nonebot2.git
synced 2025-07-27 08:11:38 +00:00
Initial commit
This commit is contained in:
Richard Chien
278
command.py
Normal file
278
command.py
Normal file
@ -0,0 +1,278 @@
|
||||
import functools
|
||||
import re
|
||||
|
||||
from apiclient import client as api
|
||||
from little_shit import SkipException, get_command_name_separators
|
||||
|
||||
_command_name_seps = get_command_name_separators()
|
||||
|
||||
|
||||
class CommandNotExistsError(BaseException):
|
||||
pass
|
||||
|
||||
|
||||
class CommandPermissionError(BaseException):
|
||||
pass
|
||||
|
||||
|
||||
class CommandScopeError(BaseException):
|
||||
def __init__(self, msg_type):
|
||||
self.msg_type = msg_type
|
||||
|
||||
|
||||
class CommandRegistry:
|
||||
"""
|
||||
Represent a map of commands and functions.
|
||||
"""
|
||||
|
||||
def __init__(self, init_func=None):
|
||||
self.init_func = init_func
|
||||
self.command_map = {}
|
||||
self.alias_map = {}
|
||||
self.hidden_command_names = []
|
||||
|
||||
def register(self, command_name, *other_names, hidden=False):
|
||||
"""
|
||||
Register command names and map them to a command function.
|
||||
|
||||
:param command_name: command name to register
|
||||
:param other_names: other names of this command
|
||||
:param hidden: hide the command name or not
|
||||
NOTE: This is kind of like the 'full_command_only' in restrict(),
|
||||
but only controls ONE command name,
|
||||
while the later controls the whole command.
|
||||
"""
|
||||
|
||||
def decorator(func):
|
||||
if hidden:
|
||||
self.hidden_command_names.append(command_name)
|
||||
if not hasattr(func, 'restricted'):
|
||||
# Apply a default restriction
|
||||
func = self.restrict()(func)
|
||||
self.command_map[command_name] = func
|
||||
for name in other_names:
|
||||
self.command_map[name] = func
|
||||
|
||||
@functools.wraps(func)
|
||||
def wrapper(*args, **kwargs):
|
||||
func(*args, **kwargs)
|
||||
|
||||
return wrapper
|
||||
|
||||
return decorator
|
||||
|
||||
# noinspection PyMethodMayBeStatic
|
||||
def restrict(self, full_command_only=False, superuser_only=False,
|
||||
group_owner_only=False, group_admin_only=False,
|
||||
allow_private=True, allow_group=True):
|
||||
"""
|
||||
Give a command some restriction.
|
||||
This decorator must be put below all register() decorators.
|
||||
Example:
|
||||
@cr.register('wow', hidden=True)
|
||||
@cr.register('another_command_name')
|
||||
@cr.restrict(full_command_only=True)
|
||||
def wow(_1, _2):
|
||||
pass
|
||||
|
||||
:param full_command_only: whether to be called with full command (including registry name)
|
||||
:param superuser_only: superuser only
|
||||
:param group_owner_only: group owner only when processing group message
|
||||
:param group_admin_only: group admin only when processing group message
|
||||
:param allow_private: allow private message
|
||||
:param allow_group: allow group message
|
||||
"""
|
||||
|
||||
def decorator(func):
|
||||
func.restricted = True
|
||||
# Visibility
|
||||
func.full_command_only = full_command_only
|
||||
# Permission
|
||||
func.superuser_only = superuser_only
|
||||
func.group_owner_only = group_owner_only
|
||||
func.group_admin_only = group_admin_only
|
||||
# Scope
|
||||
func.allow_private = allow_private
|
||||
func.allow_group = allow_group
|
||||
return func
|
||||
|
||||
return decorator
|
||||
|
||||
def call(self, command_name, args_text, ctx_msg, **options):
|
||||
"""
|
||||
Call the command matching the specified command name.
|
||||
|
||||
:param command_name: command name
|
||||
:param args_text: arguments as a string
|
||||
:param ctx_msg: context message
|
||||
:param options: other possible options
|
||||
:return: things returned by the command function
|
||||
:raises CommandScopeError: the message scope (group or private) is not allowed
|
||||
:raises CommandPermissionError: the user is not permitted to call this command
|
||||
"""
|
||||
if command_name in self.command_map:
|
||||
func = self.command_map[command_name]
|
||||
if not self._check_scope(func, ctx_msg):
|
||||
raise CommandScopeError(
|
||||
'群组消息' if ctx_msg.get('type') == 'group_message' else '私聊消息'
|
||||
)
|
||||
if not self._check_permission(func, ctx_msg):
|
||||
raise CommandPermissionError
|
||||
return func(args_text, ctx_msg, **options)
|
||||
|
||||
@staticmethod
|
||||
def _check_scope(func, ctx_msg):
|
||||
"""
|
||||
Check if current message scope (group or private) is allowed.
|
||||
|
||||
:param func: command function to check
|
||||
:param ctx_msg: context message
|
||||
:return: allowed or not
|
||||
"""
|
||||
allowed_msg_type = set()
|
||||
if func.allow_group:
|
||||
allowed_msg_type.add('group_message')
|
||||
if func.allow_private:
|
||||
allowed_msg_type.add('message')
|
||||
|
||||
if ctx_msg.get('type') in allowed_msg_type:
|
||||
return True
|
||||
return False
|
||||
|
||||
@staticmethod
|
||||
def _check_permission(func, ctx_msg):
|
||||
"""
|
||||
Check if current message sender is permitted to call this command.
|
||||
|
||||
:param func: command function to check
|
||||
:param ctx_msg: context message
|
||||
:return: permitted or not
|
||||
"""
|
||||
|
||||
def check(b):
|
||||
if not b:
|
||||
raise SkipException
|
||||
|
||||
try:
|
||||
if func.superuser_only:
|
||||
check(str(ctx_msg.get('sender_qq')) == '1002647525')
|
||||
if ctx_msg.get('type') == 'group_message':
|
||||
allowed_roles = {'owner', 'admin', 'member'}
|
||||
if func.group_admin_only:
|
||||
allowed_roles = allowed_roles.intersection({'owner', 'admin'})
|
||||
if func.group_owner_only:
|
||||
allowed_roles = allowed_roles.intersection({'owner'})
|
||||
groups = list(filter(
|
||||
lambda g: str(g.get('gnumber')) == str(ctx_msg.get('gnumber')),
|
||||
api.get_group_info().json()
|
||||
))
|
||||
if len(groups) <= 0 or 'member' not in groups[0]:
|
||||
# This is strange, not likely happens
|
||||
raise SkipException
|
||||
|
||||
members = list(filter(
|
||||
lambda m: str(m.get('qq')) == str(ctx_msg.get('sender_qq')),
|
||||
groups[0].get('member')
|
||||
))
|
||||
if len(members) <= 0 or members[0].get('role') not in allowed_roles:
|
||||
# This is strange, not likely happens
|
||||
raise SkipException
|
||||
except SkipException:
|
||||
# Not allowed
|
||||
return False
|
||||
|
||||
# Still alive, so let it go
|
||||
return True
|
||||
|
||||
def has(self, command_name):
|
||||
"""
|
||||
Check if this registry has the specified command name,
|
||||
except command names that is hidden and full command only.
|
||||
|
||||
:param command_name: command name
|
||||
:return: has or not
|
||||
"""
|
||||
return command_name in self.command_map \
|
||||
and command_name not in self.hidden_command_names \
|
||||
and not self.command_map.get(command_name).full_command_only
|
||||
|
||||
def has_include_hidden(self, command_name):
|
||||
"""
|
||||
Check if this registry has the specified command name,
|
||||
including command names that is hidden and full command only.
|
||||
|
||||
:param command_name: command name
|
||||
:return: has or not
|
||||
"""
|
||||
return command_name in self.command_map
|
||||
|
||||
|
||||
class CommandHub:
|
||||
"""
|
||||
Represent series of command registries,
|
||||
which means it's used as a collection of different registries
|
||||
and allows same command names.
|
||||
"""
|
||||
|
||||
def __init__(self):
|
||||
self.registry_map = {}
|
||||
|
||||
def add_registry(self, registry_name, registry):
|
||||
"""
|
||||
Add a registry to the hub, running the init function of the registry.
|
||||
|
||||
:param registry_name: registry name
|
||||
:param registry: registry object
|
||||
"""
|
||||
if registry.init_func:
|
||||
registry.init_func()
|
||||
self.registry_map[registry_name] = registry
|
||||
|
||||
def call(self, command_name, args_text, ctx_msg, **options):
|
||||
"""
|
||||
Call the commands matching the specified command name.
|
||||
|
||||
:param command_name: command name
|
||||
:param args_text: arguments as a string
|
||||
:param ctx_msg: context message
|
||||
:param options: other possible options
|
||||
:return: things returned by the command function
|
||||
(list of things if more than one matching command)
|
||||
:raises CommandNotExistsError: no command exists
|
||||
:raises CommandScopeError: the message scope is disallowed by all commands
|
||||
:raises CommandPermissionError: the user is baned by all commands
|
||||
"""
|
||||
if not command_name:
|
||||
# If the command name is empty, we just return
|
||||
return None
|
||||
|
||||
command = re.split('|'.join(_command_name_seps), command_name, 1)
|
||||
if len(command) == 2 and command[0] in self.registry_map:
|
||||
registry = self.registry_map.get(command[0])
|
||||
if registry.has_include_hidden(command[1]):
|
||||
return registry.call(command[1], args_text, ctx_msg, **options)
|
||||
else:
|
||||
raise CommandNotExistsError
|
||||
else:
|
||||
results = []
|
||||
cmd_exists = False
|
||||
permitted = False
|
||||
for registry in self.registry_map.values():
|
||||
# Trying to call all commands with the name
|
||||
if registry.has(command_name):
|
||||
cmd_exists = True
|
||||
try:
|
||||
results.append(
|
||||
registry.call(command_name, args_text, ctx_msg, **options))
|
||||
permitted = True # If it's permitted, this will be set
|
||||
except CommandPermissionError:
|
||||
pass
|
||||
if not cmd_exists:
|
||||
raise CommandNotExistsError
|
||||
if not permitted:
|
||||
# No command was permitted
|
||||
raise CommandPermissionError
|
||||
return results
|
||||
|
||||
|
||||
hub = CommandHub()
|
||||
Reference in New Issue
Block a user