def handle_teleirc_commands(bot, trigger):
"""Trigger for handling bridged messages from TeleIRC"""
# Group 1 has sender's Telegram username
#sender = trigger.group(1)
# Group 2 has the rest of the line, including the bot nickname
line = trigger.group(2)
# Compare against the known commands
regex = get_nickname_command_regexp(bot.config.core.nick,
TOPIC_COMMANDS_COMBINED,
bot.config.core.alias_nicks)
match = re.match(regex, line)
# Bail if no commands matched
if not match:
return
# parse the channel and status
channel = trigger.sender
status = match.group(1).lower().translate(str.maketrans('', '', ',:'))
# grab extra (if any), should always be in group 2
rest = None
if len(match.groups()) > 1:
rest = match.group(2)
# Fire an update
update_clubroom_status(bot, channel, status, rest)
def clean_callable(func, config):
"""Compiles the regexes, moves commands into func.rule, fixes up docs and
puts them in func._docs, and sets defaults"""
nick = config.core.nick
alias_nicks = config.core.alias_nicks
prefix = config.core.prefix
help_prefix = config.core.help_prefix
func._docs = {}
doc = trim_docstring(func.__doc__)
example = None
func.unblockable = getattr(func, 'unblockable', False)
func.priority = getattr(func, 'priority', 'medium')
func.thread = getattr(func, 'thread', True)
func.rate = getattr(func, 'rate', 0)
func.channel_rate = getattr(func, 'channel_rate', 0)
func.global_rate = getattr(func, 'global_rate', 0)
if not hasattr(func, 'event'):
func.event = ['PRIVMSG']
else:
if isinstance(func.event, basestring):
func.event = [func.event.upper()]
else:
func.event = [event.upper() for event in func.event]
if hasattr(func, 'rule'):
if isinstance(func.rule, basestring):
func.rule = [func.rule]
func.rule = [
compile_rule(nick, rule, alias_nicks) for rule in func.rule
]
if hasattr(func, 'commands') or hasattr(func, 'nickname_commands'):
func.rule = getattr(func, 'rule', [])
for command in getattr(func, 'commands', []):
regexp = get_command_regexp(prefix, command)
func.rule.append(regexp)
for command in getattr(func, 'nickname_commands', []):
regexp = get_nickname_command_regexp(nick, command, alias_nicks)
func.rule.append(regexp)
if hasattr(func, 'example'):
example = func.example[0]["example"]
example = example.replace('$nickname', nick)
if example[0] != help_prefix and not example.startswith(nick):
example = help_prefix + example[len(help_prefix):]
if doc or example:
cmds = []
cmds.extend(getattr(func, 'commands', []))
cmds.extend(getattr(func, 'nickname_commands', []))
for command in cmds:
func._docs[command] = (doc, example)
if hasattr(func, 'intents'):
func.intents = [
re.compile(intent, re.IGNORECASE) for intent in func.intents
]
def test_nickname_command_groups(command, nick, groups, nickname_command_line):
regex = tools.get_nickname_command_regexp(nick, command, [])
match = re.match(regex, nickname_command_line)
assert match.group(0) == nickname_command_line
assert match.group(1) == command
assert match.group(2) == ' '.join(groups.values())
assert match.group(3) == groups[3]
assert match.group(4) == groups[4]
assert match.group(5) == groups[5]
assert match.group(6) == groups[6]
def test_nickname_command_groups(command, nick, groups, nickname_command_line):
regex = get_nickname_command_regexp(nick, command, [])
match = re.match(regex, nickname_command_line)
assert match.group(0) == nickname_command_line
assert match.group(1) == command
assert match.group(2) == ' '.join(groups.values())
assert match.group(3) == groups[3]
assert match.group(4) == groups[4]
assert match.group(5) == groups[5]
assert match.group(6) == groups[6]
def test_nickname_command_aliased(command, nick, alias_nicks, groups, nickname_command_line):
aliased_command_line = nickname_command_line.replace(nick, alias_nicks[0])
regex = tools.get_nickname_command_regexp(nick, command, alias_nicks)
match = re.match(regex, aliased_command_line)
assert match.group(0) == aliased_command_line
assert match.group(1) == command
assert match.group(2) == ' '.join(groups.values())
assert match.group(3) == groups[3]
assert match.group(4) == groups[4]
assert match.group(5) == groups[5]
assert match.group(6) == groups[6]
def test_nickname_command_aliased(command, nick, alias_nicks, groups, nickname_command_line):
aliased_command_line = nickname_command_line.replace(nick, alias_nicks[0])
regex = get_nickname_command_regexp(nick, command, alias_nicks)
match = re.match(regex, aliased_command_line)
assert match.group(0) == aliased_command_line
assert match.group(1) == command
assert match.group(2) == ' '.join(groups.values())
assert match.group(3) == groups[3]
assert match.group(4) == groups[4]
assert match.group(5) == groups[5]
assert match.group(6) == groups[6]
def clean_callable(func, config):
"""Compiles the regexes, moves commands into func.rule, fixes up docs and
puts them in func._docs, and sets defaults"""
nick = config.core.nick
alias_nicks = config.core.alias_nicks
prefix = config.core.prefix
help_prefix = config.core.help_prefix
func._docs = {}
doc = trim_docstring(func.__doc__)
example = None
func.unblockable = getattr(func, 'unblockable', False)
func.priority = getattr(func, 'priority', 'medium')
func.thread = getattr(func, 'thread', True)
func.rate = getattr(func, 'rate', 0)
func.channel_rate = getattr(func, 'channel_rate', 0)
func.global_rate = getattr(func, 'global_rate', 0)
if not hasattr(func, 'event'):
func.event = ['PRIVMSG']
else:
if isinstance(func.event, basestring):
func.event = [func.event.upper()]
else:
func.event = [event.upper() for event in func.event]
if hasattr(func, 'rule'):
if isinstance(func.rule, basestring):
func.rule = [func.rule]
func.rule = [compile_rule(nick, rule, alias_nicks) for rule in func.rule]
if hasattr(func, 'commands') or hasattr(func, 'nickname_commands'):
func.rule = getattr(func, 'rule', [])
for command in getattr(func, 'commands', []):
regexp = get_command_regexp(prefix, command)
func.rule.append(regexp)
for command in getattr(func, 'nickname_commands', []):
regexp = get_nickname_command_regexp(nick, command, alias_nicks)
func.rule.append(regexp)
if hasattr(func, 'example'):
example = func.example[0]["example"]
example = example.replace('$nickname', nick)
if example[0] != help_prefix and not example.startswith(nick):
example = example.replace(default_prefix, help_prefix, 1)
if doc or example:
cmds = []
cmds.extend(getattr(func, 'commands', []))
cmds.extend(getattr(func, 'nickname_commands', []))
for command in cmds:
func._docs[command] = (doc, example)
if hasattr(func, 'intents'):
func.intents = [re.compile(intent, re.IGNORECASE) for intent in func.intents]
def get_rule_regex(self):
"""Make the rule regex for this nick command.
:return: a compiled regex for this nick command and its aliases
The command regex factors in:
* the nicks to react to,
* the rule's name (escaped for regex),
* all of its aliases (escaped for regex),
and everything is then given to
:func:`sopel.tools.get_nickname_command_regexp`, which creates a
compiled regex to return.
"""
name = [self.escape_name(self._name)]
aliases = [self.escape_name(alias) for alias in self._aliases]
pattern = r'|'.join(name + aliases)
return tools.get_nickname_command_regexp(self._nick, pattern,
self._nick_aliases)
def clean_callable(func, config):
"""Compiles the regexes, moves commands into func.rule, fixes up docs and
puts them in func._docs, and sets defaults"""
nick = config.core.nick
alias_nicks = config.core.alias_nicks
prefix = config.core.prefix
help_prefix = config.core.help_prefix
func._docs = {}
doc = trim_docstring(func.__doc__)
examples = []
func.unblockable = getattr(func, 'unblockable', False)
func.echo = getattr(func, 'echo', False)
func.priority = getattr(func, 'priority', 'medium')
func.thread = getattr(func, 'thread', True)
func.rate = getattr(func, 'rate', 0)
func.channel_rate = getattr(func, 'channel_rate', 0)
func.global_rate = getattr(func, 'global_rate', 0)
if not hasattr(func, 'event'):
func.event = ['PRIVMSG']
else:
if isinstance(func.event, basestring):
func.event = [func.event.upper()]
else:
func.event = [event.upper() for event in func.event]
if hasattr(func, 'rule'):
if isinstance(func.rule, basestring):
func.rule = [func.rule]
func.rule = [
compile_rule(nick, rule, alias_nicks) for rule in func.rule
]
if hasattr(func, 'commands') or hasattr(func, 'nickname_commands'):
func.rule = getattr(func, 'rule', [])
for command in getattr(func, 'commands', []):
regexp = get_command_regexp(prefix, command)
func.rule.append(regexp)
for command in getattr(func, 'nickname_commands', []):
regexp = get_nickname_command_regexp(nick, command, alias_nicks)
func.rule.append(regexp)
if hasattr(func, 'example'):
# If no examples are flagged as user-facing, just show the first one like Sopel<7 did
examples = [rec["example"] for rec in func.example if rec["help"]
] or [func.example[0]["example"]]
for i, example in enumerate(examples):
example = example.replace('$nickname', nick)
if example[0] != help_prefix and not example.startswith(nick):
example = example.replace(default_prefix, help_prefix, 1)
examples[i] = example
if doc or examples:
cmds = []
cmds.extend(getattr(func, 'commands', []))
cmds.extend(getattr(func, 'nickname_commands', []))
for command in cmds:
func._docs[command] = (doc, examples)
if hasattr(func, 'intents'):
func.intents = [
re.compile(intent, re.IGNORECASE) for intent in func.intents
]
def clean_callable(func, config):
"""Compiles the regexes, moves commands into func.rule, fixes up docs and
puts them in func._docs, and sets defaults"""
nick = config.core.nick
alias_nicks = config.core.alias_nicks
prefix = config.core.prefix
help_prefix = config.core.help_prefix
func._docs = {}
doc = trim_docstring(func.__doc__)
examples = []
func.unblockable = getattr(func, 'unblockable', False)
func.echo = getattr(func, 'echo', False)
func.priority = getattr(func, 'priority', 'medium')
func.thread = getattr(func, 'thread', True)
func.rate = getattr(func, 'rate', 0)
func.channel_rate = getattr(func, 'channel_rate', 0)
func.global_rate = getattr(func, 'global_rate', 0)
if not hasattr(func, 'event'):
func.event = ['PRIVMSG']
else:
if isinstance(func.event, basestring):
func.event = [func.event.upper()]
else:
func.event = [event.upper() for event in func.event]
if hasattr(func, 'rule'):
if isinstance(func.rule, basestring):
func.rule = [func.rule]
func.rule = [compile_rule(nick, rule, alias_nicks) for rule in func.rule]
if hasattr(func, 'commands') or hasattr(func, 'nickname_commands'):
func.rule = getattr(func, 'rule', [])
for command in getattr(func, 'commands', []):
regexp = get_command_regexp(prefix, command)
if regexp not in func.rule:
func.rule.append(regexp)
for command in getattr(func, 'nickname_commands', []):
regexp = get_nickname_command_regexp(nick, command, alias_nicks)
if regexp not in func.rule:
func.rule.append(regexp)
if hasattr(func, 'example'):
# If no examples are flagged as user-facing, just show the first one like Sopel<7 did
examples = [rec["example"] for rec in func.example if rec["help"]] or [func.example[0]["example"]]
for i, example in enumerate(examples):
example = example.replace('$nickname', nick)
if example[0] != help_prefix and not example.startswith(nick):
example = example.replace(default_prefix, help_prefix, 1)
examples[i] = example
if doc or examples:
cmds = []
cmds.extend(getattr(func, 'commands', []))
cmds.extend(getattr(func, 'nickname_commands', []))
for command in cmds:
func._docs[command] = (doc, examples)
if hasattr(func, 'intents'):
# Can be implementation-dependent
_regex_type = type(re.compile(''))
func.intents = [
(intent
if isinstance(intent, _regex_type)
else re.compile(intent, re.IGNORECASE))
for intent in func.intents
]
def clean_callable(func, config):
"""Compiles the regexes, moves commands into func.rule, fixes up docs and
puts them in func._docs, and sets defaults"""
nick = config.core.nick
alias_nicks = config.core.alias_nicks
prefix = config.core.prefix
help_prefix = config.core.help_prefix
func._docs = {}
doc = trim_docstring(func.__doc__)
examples = []
func.thread = getattr(func, 'thread', True)
if not is_triggerable(func):
# Rate-limiting, priority, etc. doesn't apply to non-triggerable functions.
# Adding the default attributes below is a waste of memory, as well as
# potentially confusing to other code.
return
func.unblockable = getattr(func, 'unblockable', False)
func.echo = getattr(func, 'echo', False)
func.priority = getattr(func, 'priority', 'medium')
func.rate = getattr(func, 'rate', 0)
func.channel_rate = getattr(func, 'channel_rate', 0)
func.global_rate = getattr(func, 'global_rate', 0)
func.output_prefix = getattr(func, 'output_prefix', '')
if not hasattr(func, 'event'):
func.event = ['PRIVMSG']
else:
if isinstance(func.event, basestring):
func.event = [func.event.upper()]
else:
func.event = [event.upper() for event in func.event]
if hasattr(func, 'rule'):
if isinstance(func.rule, basestring):
func.rule = [func.rule]
func.rule = [compile_rule(nick, rule, alias_nicks) for rule in func.rule]
if any(hasattr(func, attr) for attr in ['commands', 'nickname_commands', 'action_commands']):
func.rule = getattr(func, 'rule', [])
for command in getattr(func, 'commands', []):
regexp = get_command_regexp(prefix, command)
if regexp not in func.rule:
func.rule.append(regexp)
for command in getattr(func, 'nickname_commands', []):
regexp = get_nickname_command_regexp(nick, command, alias_nicks)
if regexp not in func.rule:
func.rule.append(regexp)
for command in getattr(func, 'action_commands', []):
regexp = get_action_command_regexp(command)
if regexp not in func.rule:
func.rule.append(regexp)
if hasattr(func, 'example'):
# If no examples are flagged as user-facing, just show the first one like Sopel<7.0 did
examples = [rec["example"] for rec in func.example if rec["help"]] or [func.example[0]["example"]]
for i, example in enumerate(examples):
example = example.replace('$nickname', nick)
if example[0] != help_prefix and not example.startswith(nick):
example = example.replace(default_prefix, help_prefix, 1)
examples[i] = example
if doc or examples:
cmds = []
cmds.extend(getattr(func, 'commands', []))
cmds.extend(getattr(func, 'nickname_commands', []))
for command in cmds:
func._docs[command] = (doc, examples)
if hasattr(func, 'intents'):
# Can be implementation-dependent
_regex_type = type(re.compile(''))
func.intents = [
(intent
if isinstance(intent, _regex_type)
else re.compile(intent, re.IGNORECASE))
for intent in func.intents
]
