mirror of
https://github.com/jlu5/SupyPlugins.git
synced 2025-04-27 05:21:10 -05:00
This requires commit b54d8f8073
, which separates the timeout and no match cases.
Also, raise the default processTimeout as the plugin now aborts on the first message that times out.
194 lines
7.9 KiB
Python
194 lines
7.9 KiB
Python
###
|
|
# Copyright (c) 2015, Michael Daniel Telatynski <postmaster@webdevguru.co.uk>
|
|
# Copyright (c) 2015-2019, James Lu <james@overdrivenetworks.com>
|
|
# All rights reserved.
|
|
#
|
|
# Redistribution and use in source and binary forms, with or without
|
|
# modification, are permitted provided that the following conditions are met:
|
|
#
|
|
# * Redistributions of source code must retain the above copyright notice,
|
|
# this list of conditions, and the following disclaimer.
|
|
# * Redistributions in binary form must reproduce the above copyright notice,
|
|
# this list of conditions, and the following disclaimer in the
|
|
# documentation and/or other materials provided with the distribution.
|
|
# * Neither the name of the author of this software nor the name of
|
|
# contributors to this software may be used to endorse or promote products
|
|
# derived from this software without specific prior written consent.
|
|
#
|
|
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
|
|
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
# POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
###
|
|
|
|
from supybot.commands import *
|
|
import supybot.plugins as plugins
|
|
import supybot.ircmsgs as ircmsgs
|
|
import supybot.callbacks as callbacks
|
|
import supybot.ircutils as ircutils
|
|
import supybot.ircdb as ircdb
|
|
import supybot.utils as utils
|
|
|
|
import re
|
|
import sys
|
|
|
|
try:
|
|
from supybot.i18n import PluginInternationalization
|
|
_ = PluginInternationalization('SedRegex')
|
|
except ImportError:
|
|
_ = lambda x: x
|
|
|
|
if sys.version_info[0] < 3:
|
|
raise ImportError('This plugin requires Python 3. For a legacy version of this plugin that still '
|
|
'supports Python 2, consult the python2-legacy branch at '
|
|
'https://github.com/jlu5/SupyPlugins/tree/python2-legacy')
|
|
|
|
SED_REGEX = re.compile(r"^(?:(?P<nick>.+?)[:,] )?s(?P<delim>[^\w\s])(?P<pattern>.*?)(?P=delim)"
|
|
r"(?P<replacement>.*?)(?P=delim)(?P<flags>[a-z]*)$")
|
|
|
|
# Replace newlines and friends with things like literal "\n" (backslash and "n")
|
|
axe_spaces = utils.str.MultipleReplacer({'\n': '\\n', '\t': '\\t', '\r': '\\r'})
|
|
|
|
class SedRegex(callbacks.PluginRegexp):
|
|
"""History replacer using sed-style regex syntax."""
|
|
threaded = True
|
|
public = True
|
|
unaddressedRegexps = ['replacer']
|
|
|
|
@staticmethod
|
|
def _unpack_sed(expr):
|
|
if '\0' in expr:
|
|
raise ValueError('Expression can\'t contain NUL')
|
|
|
|
delim = expr[1]
|
|
escaped_expr = ''
|
|
|
|
for (i, c) in enumerate(expr):
|
|
if c == delim and i > 0:
|
|
if expr[i - 1] == '\\':
|
|
escaped_expr = escaped_expr[:-1] + '\0'
|
|
continue
|
|
|
|
escaped_expr += c
|
|
|
|
match = SED_REGEX.search(escaped_expr)
|
|
|
|
if not match:
|
|
return
|
|
|
|
groups = match.groupdict()
|
|
pattern = groups['pattern'].replace('\0', delim)
|
|
replacement = groups['replacement'].replace('\0', delim)
|
|
|
|
if groups['flags']:
|
|
raw_flags = set(groups['flags'])
|
|
else:
|
|
raw_flags = set()
|
|
|
|
flags = 0
|
|
count = 1
|
|
|
|
for flag in raw_flags:
|
|
if flag == 'g':
|
|
count = 0
|
|
if flag == 'i':
|
|
flags |= re.IGNORECASE
|
|
|
|
pattern = re.compile(pattern, flags)
|
|
|
|
return (pattern, replacement, count, raw_flags)
|
|
|
|
def replacer(self, irc, msg, regex):
|
|
if not self.registryValue('enable', msg.args[0]):
|
|
return
|
|
iterable = reversed(irc.state.history)
|
|
msg.tag('Replacer')
|
|
|
|
try:
|
|
(pattern, replacement, count, flags) = self._unpack_sed(msg.args[1])
|
|
except Exception as e:
|
|
self.log.warning(_("SedRegex error: %s"), e, exc_info=True)
|
|
if self.registryValue('displayErrors', msg.args[0]):
|
|
irc.error('%s.%s: %s' % (e.__class__.__module__, e.__class__.__name__, e))
|
|
return
|
|
|
|
next(iterable)
|
|
if 's' in flags: # Special 's' flag lets the bot only look at self messages
|
|
target = msg.nick
|
|
else:
|
|
target = regex.group('nick')
|
|
if not ircutils.isNick(str(target), strictRfc=True):
|
|
return
|
|
|
|
for m in iterable:
|
|
if m.command in ('PRIVMSG', 'NOTICE') and \
|
|
ircutils.strEqual(m.args[0], msg.args[0]) and m.tagged('receivedBy') == irc:
|
|
if target and m.nick != target:
|
|
continue
|
|
# Don't snarf ignored users' messages unless specifically
|
|
# told to.
|
|
if ircdb.checkIgnored(m.prefix) and not target:
|
|
continue
|
|
|
|
# When running substitutions, ignore the "* nick" part of any actions.
|
|
action = ircmsgs.isAction(m)
|
|
if action:
|
|
text = ircmsgs.unAction(m)
|
|
else:
|
|
text = m.args[1]
|
|
|
|
if self.registryValue('ignoreRegex', msg.args[0]) and \
|
|
m.tagged('Replacer'):
|
|
continue
|
|
if m.nick == msg.nick:
|
|
messageprefix = msg.nick
|
|
else:
|
|
messageprefix = '%s thinks %s' % (msg.nick, m.nick)
|
|
try:
|
|
regex_timeout = self.registryValue('processTimeout')
|
|
replace_result = regexp_wrapper(text, pattern, timeout=regex_timeout, plugin_name=self.name(),
|
|
fcn_name='replacer')
|
|
if replace_result is True:
|
|
if self.registryValue('boldReplacementText', msg.args[0]):
|
|
replacement = ircutils.bold(replacement)
|
|
subst = process(pattern.sub, replacement,
|
|
text, count, timeout=regex_timeout)
|
|
if action: # If the message was an ACTION, prepend the nick back.
|
|
subst = '* %s %s' % (m.nick, subst)
|
|
|
|
subst = axe_spaces(subst)
|
|
|
|
irc.reply(_("%s meant to say: %s") %
|
|
(messageprefix, subst), prefixNick=False)
|
|
return
|
|
elif replace_result is None:
|
|
# Abort on timeout instead of looking against older messages - this prevents
|
|
# replacing the wrong message when we get a one off timeout, which usually leads
|
|
# to very confusing results.
|
|
# This requires commit https://github.com/ProgVal/Limnoria/commit/b54d8f8073b4fca1787012b211337dc707cfea45
|
|
irc.error(_("Search timed out."), Raise=True)
|
|
except Exception as e:
|
|
self.log.warning(_("SedRegex error: %s"), e, exc_info=True)
|
|
if self.registryValue('displayErrors', msg.args[0]):
|
|
irc.error('%s.%s: %s' % (e.__class__.__module__, e.__class__.__name__, e))
|
|
return
|
|
|
|
self.log.debug(_("SedRegex: Search %r not found in the last %i messages of %s."),
|
|
msg.args[1], len(irc.state.history), msg.args[0])
|
|
irc.error(_("Search not found in the last %i messages.") %
|
|
len(irc.state.history), Raise=True)
|
|
replacer.__doc__ = SED_REGEX.pattern
|
|
|
|
Class = SedRegex
|
|
|
|
|
|
# vim:set shiftwidth=4 softtabstop=4 expandtab textwidth=79:
|