Limnoria/plugins/BadWords.py

186 lines
6.9 KiB
Python
Raw Normal View History

2003-03-12 07:26:59 +01:00
###
# Copyright (c) 2002-2004, Jeremiah Fincher
2003-03-12 07:26:59 +01:00
# 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.
###
"""
Filters bad words on outgoing messages from the bot, so the bot can't be made
to say bad words.
"""
2003-11-25 09:23:47 +01:00
__revision__ = "$Id$"
2004-07-24 07:18:26 +02:00
import supybot.plugins as plugins
2003-03-12 07:26:59 +01:00
import re
import math
2003-07-31 08:20:58 +02:00
import sets
import time
2003-03-12 07:26:59 +01:00
2004-07-24 07:18:26 +02:00
import supybot.conf as conf
import supybot.utils as utils
import supybot.ircdb as ircdb
import supybot.ircmsgs as ircmsgs
from supybot.commands import wrap
2004-07-24 07:18:26 +02:00
import supybot.ircutils as ircutils
import supybot.privmsgs as privmsgs
import supybot.registry as registry
import supybot.callbacks as callbacks
2003-03-12 07:26:59 +01:00
def configure(advanced):
2004-07-25 20:24:51 +02:00
from supybot.questions import output, expect, anything, something, yn
conf.registerPlugin('BadWords', True)
if yn('Would you like to add some bad words?'):
words = anything('What words? (separate individual words by spaces)')
conf.supybot.plugins.BadWords.words.set(words)
class LastModifiedSetOfStrings(registry.SpaceSeparatedListOfStrings):
List = sets.Set
lastModified = 0
def setValue(self, v):
self.lastModified = time.time()
2004-02-08 09:04:40 +01:00
registry.SpaceSeparatedListOfStrings.setValue(self, v)
conf.registerPlugin('BadWords')
conf.registerGlobalValue(conf.supybot.plugins.BadWords, 'words',
2004-02-08 09:04:40 +01:00
LastModifiedSetOfStrings([], """Determines what words are
considered to be 'bad' so the bot won't say them."""))
conf.registerGlobalValue(conf.supybot.plugins.BadWords,'requireWordBoundaries',
registry.Boolean(False, """Determines whether the bot will require bad
words to be independent words, or whether it will censor them within other
words. For instance, if 'darn' is a bad word, then if this is true, 'darn'
will be censored, but 'darnit' will not. You probably want this to be
false."""))
class String256(registry.String):
2004-08-18 18:12:27 +02:00
def __call__(self):
s = registry.String.__call__(self)
return s * (1024/len(s))
def __str__(self):
return self.value
2004-07-21 03:00:37 +02:00
conf.registerGlobalValue(conf.supybot.plugins.BadWords, 'nastyChars',
String256('!@#&', """Determines what characters will replace bad words; a
chunk of these characters matching the size of the replaced bad word will
be used to replace the bad words you've configured."""))
class ReplacementMethods(registry.OnlySomeStrings):
validStrings = ('simple', 'nastyCharacters')
2004-07-21 03:00:37 +02:00
conf.registerGlobalValue(conf.supybot.plugins.BadWords, 'replaceMethod',
ReplacementMethods('nastyCharacters', """Determines the manner in which
bad words will be replaced. 'nastyCharacters' (the default) will replace a
bad word with the same number of 'nasty characters' (like those used in
comic books; configurable by supybot.plugins.BadWords.nastyChars).
'simple' will replace a bad word with a simple strings (regardless of the
length of the bad word); this string is configurable via
supybot.plugins.BadWords.simpleReplacement."""))
conf.registerGlobalValue(conf.supybot.plugins.BadWords,'simpleReplacement',
registry.String('[CENSORED]', """Determines what word will replace bad
words if the replacement method is 'simple'."""))
2003-10-22 07:35:52 +02:00
class BadWords(privmsgs.CapabilityCheckingPrivmsg):
2003-09-05 21:28:04 +02:00
priority = 1
2004-02-08 09:04:40 +01:00
capability = 'admin'
2003-03-12 07:26:59 +01:00
def __init__(self):
privmsgs.CapabilityCheckingPrivmsg.__init__(self)
2004-07-20 08:37:21 +02:00
self.filtering = True
self.lastModified = 0
self.words = conf.supybot.plugins.BadWords.words
2003-03-12 07:26:59 +01:00
def sub(self, m):
replaceMethod = self.registryValue('replaceMethod')
if replaceMethod == 'simple':
return self.registryValue('simpleReplacement')
elif replaceMethod == 'nastyCharacters':
return self.registryValue('nastyChars')[:len(m.group(1))]
2004-07-20 08:37:21 +02:00
def inFilter(self, irc, msg):
self.filtering = True
return msg
2004-07-21 03:00:37 +02:00
2003-03-12 07:26:59 +01:00
def outFilter(self, irc, msg):
2004-07-20 08:37:21 +02:00
if self.filtering and msg.command == 'PRIVMSG':
if self.lastModified < self.words.lastModified:
self.makeRegexp(self.words())
self.lastModified = time.time()
2003-03-12 07:26:59 +01:00
s = msg.args[1]
s = ircutils.stripFormatting(s)
s = self.regexp.sub(self.sub, s)
msg = ircmsgs.privmsg(msg.args[0], s, msg=msg)
2004-07-20 08:37:21 +02:00
return msg
2003-03-12 07:26:59 +01:00
def makeRegexp(self, iterable):
s = '(%s)' % '|'.join(map(re.escape, iterable))
if self.registryValue('requireWordBoundaries'):
s = r'\b%s\b' % s
self.regexp = re.compile(s, re.I)
2003-03-12 07:26:59 +01:00
2004-07-20 08:37:21 +02:00
def list(self, irc, msg, args):
"""takes no arguments
Returns the list of words being censored.
"""
L = list(self.words())
if L:
self.filtering = False
utils.sortBy(str.lower, L)
irc.reply(utils.commaAndify(L))
else:
irc.reply('I\'m not currently censoring any bad words.')
list = wrap(list)
2004-07-21 03:00:37 +02:00
def add(self, irc, msg, args, words):
2004-02-08 09:04:40 +01:00
"""<word> [<word> ...]
Adds all <word>s to the list of words the bot isn't to say.
"""
set = self.words()
set.update(words)
2004-02-08 09:04:40 +01:00
self.words.setValue(set)
irc.replySuccess()
add = wrap(add, ['something+'])
2004-02-08 09:04:40 +01:00
def remove(self, irc, msg, args, words):
2004-02-08 09:04:40 +01:00
"""<word> [<word> ...]
Removes a <word>s from the list of words the bot isn't to say.
"""
set = self.words()
for word in words:
2004-02-08 09:04:40 +01:00
set.discard(word)
self.words.setValue(set)
irc.replySuccess()
remove = wrap(remove, ['something+'])
2004-07-21 03:00:37 +02:00
2003-03-12 07:26:59 +01:00
Class = BadWords
2003-10-22 07:35:52 +02:00
# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78: