Limnoria/plugins/Enforcer.py

254 lines
11 KiB
Python
Raw Normal View History

2003-04-08 10:40:50 +02:00
#!/usr/bin/env python
###
# Copyright (c) 2002, Jeremiah Fincher
# 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.
###
"""
2003-09-03 20:45:29 +02:00
Enforcer: Enforces capabilities on a channel, watching MODEs, KICKs,
2003-04-08 10:40:50 +02:00
JOINs, etc. to make sure they match the channel's config.
"""
import plugins
2003-04-08 10:40:50 +02:00
import conf
2003-10-11 23:03:02 +02:00
import debug
2003-04-08 10:40:50 +02:00
import ircdb
import ircmsgs
import plugins
2003-04-08 10:40:50 +02:00
import privmsgs
import ircutils
2003-08-29 16:02:14 +02:00
import callbacks
2003-04-08 10:40:50 +02:00
def configure(onStart, afterConnect, advanced):
2003-09-11 14:32:39 +02:00
from questions import expect, anything, something, yn
onStart.append('load Enforcer')
chanserv = something('What\'s the name of ChanServ on your network?')
if yn('Do you want the bot to take revenge on rule breakers?') == 'y':
revenge = True
else:
revenge = False
onStart.append('enforcer start %s %s' % (chanserv, revenge))
2003-04-08 10:40:50 +02:00
###
2003-09-03 20:45:29 +02:00
# Enforcer: Enforces capabilities on JOIN, MODE, KICK, etc.
2003-04-08 10:40:50 +02:00
###
_chanCap = ircdb.makeChannelCapability
2003-11-08 01:10:38 +01:00
class Enforcer(callbacks.Privmsg, plugins.Configurable):
configurables = plugins.ConfigurableDictionary(
[('auto-op', plugins.ConfigurableTypes.bool, False,
"""Determines whether the bot will automatically op people with
the <channel>.op capability when they join the channel."""),
('auto-voice', plugins.ConfigurableTypes.bool, False,
"""Determines whether the bot will automatically voice people with
the <channel>.voice capability when they join the channel."""),
('auto-halfop', plugins.ConfigurableTypes.bool, False,
"""Determines whether the bot will automatically halfop people with
the <channel>.halfop capability when they join the channel."""),]
)
2003-09-03 20:45:29 +02:00
started = False
def __init__(self):
callbacks.Privmsg.__init__(self)
def start(self, irc, msg, args):
2003-09-06 20:29:44 +02:00
"""[<CHANSERV> <revenge>]
Starts the Enforcer plugin. <chanserv> is the nick for the chanserv
aspect of Services (it defaults to ChanServ). <revenge> is whether to
be *really* nasty to people who break the rules (it's often referred
to in other bots as 'bitch mode.') It defaults to True.
"""
2003-04-08 10:40:50 +02:00
self.topics = {}
(chanserv, revenge) = privmsgs.getArgs(args, needed=0, optional=2)
2003-04-08 10:40:50 +02:00
self.chanserv = chanserv or 'ChanServ'
self.started = True
revenge = revenge.capitalize()
2003-09-03 20:45:29 +02:00
if revenge == 'True' or revenge == '':
self.revenge = True
elif revenge == 'False':
self.revenge = False
else:
irc.error(msg,'Possible values for revenge are "True" and "False"')
return
for channel in irc.state.channels:
irc.queueMsg(ircmsgs.topic(channel))
2003-09-03 20:45:29 +02:00
irc.reply(msg, conf.replySuccess)
start = privmsgs.checkCapability(start, 'admin')
2003-04-08 10:40:50 +02:00
def doJoin(self, irc, msg):
2003-09-03 20:45:29 +02:00
if not self.started:
debug.msg('Enforcer not started.', 'normal')
2003-09-03 20:45:29 +02:00
return
2003-04-08 10:40:50 +02:00
channel = msg.args[0]
c = ircdb.channels.getChannel(channel)
if c.checkBan(msg.prefix):
irc.queueMsg(ircmsgs.ban(channel, ircutils.banmask(msg.prefix)))
irc.queueMsg(ircmsgs.kick(channel, msg.nick))
elif ircdb.checkCapability(msg.prefix, _chanCap(channel, 'op')):
2003-11-08 01:10:38 +01:00
if self.configurables.get('auto-op', channel):
irc.queueMsg(ircmsgs.op(channel, msg.nick))
2003-04-08 10:40:50 +02:00
elif ircdb.checkCapability(msg.prefix, _chanCap(channel, 'halfop')):
2003-11-08 01:10:38 +01:00
if self.configurables.get('auto-halfop', channel):
irc.queueMsg(ircmsgs.halfop(channel, msg.nick))
2003-04-08 10:40:50 +02:00
elif ircdb.checkCapability(msg.prefix, _chanCap(channel, 'voice')):
2003-11-08 01:10:38 +01:00
if self.configurables.get('auto-voice', channel):
irc.queueMsg(ircmsgs.voice(channel, msg.nick))
2003-04-08 10:40:50 +02:00
def doTopic(self, irc, msg):
2003-09-03 20:45:29 +02:00
if not self.started:
debug.msg('Enforcer not started.', 'normal')
2003-09-03 20:45:29 +02:00
return
2003-04-08 10:40:50 +02:00
channel = msg.args[0]
topic = msg.args[1]
if msg.nick != irc.nick and \
not ircdb.checkCapabilities(msg.prefix,
(_chanCap(channel, 'op'),
_chanCap(channel, 'topic'))):
irc.queueMsg(ircmsgs.topic(channel, self.topics[channel]))
if self.revenge:
irc.queueMsg(ircmsgs.kick(channel, msg.nick,
conf.replyNoCapability % \
_chanCap(channel, 'topic')))
else:
self.topics[channel] = msg.args[1]
def do332(self, irc, msg):
# This command gets sent right after joining a channel.
2003-09-06 03:15:32 +02:00
if not self.started:
debug.msg('Enforcer not started.', 'normal')
2003-09-06 03:15:32 +02:00
return
2003-04-08 10:40:50 +02:00
(channel, topic) = msg.args[1:]
self.topics[channel] = topic
def _isProtected(self, channel, hostmask):
capabilities = [_chanCap(channel, 'op'),_chanCap(channel, 'protected')]
return ircdb.checkCapabilities(hostmask, capabilities)
def _revenge(self, irc, channel, hostmask):
irc.queueMsg(ircmsgs.ban(channel, ircutils.banmask(hostmask)))
irc.queueMsg(ircmsgs.kick(channel,ircutils.nickFromHostmask(hostmask)))
def doKick(self, irc, msg):
2003-09-03 20:45:29 +02:00
if not self.started:
debug.msg('Enforcer not started.', 'normal')
2003-09-03 20:45:29 +02:00
return
2003-04-08 10:40:50 +02:00
channel = msg.args[0]
kicked = msg.args[1].split(',')
deop = False
if msg.nick != irc.nick and\
not ircdb.checkCapability(msg.prefix, _chanCap(channel, 'op')):
for nick in kicked:
hostmask = irc.state.nickToHostmask(nick)
if nick == irc.nick:
# Must be a sendMsg so he joins the channel before MODEing.
irc.sendMsg(ircmsgs.join(channel))
deop = True
2003-04-08 10:40:50 +02:00
if self._isProtected(channel, hostmask):
deop = True
irc.queueMsg(ircmsgs.invite(channel, msg.args[1]))
if deop:
deop = False
if self.revenge:
self._revenge(irc, channel, msg.prefix)
else:
irc.queueMsg(ircmsgs.deop(channel, msg.nick))
def doMode(self, irc, msg):
2003-09-03 20:45:29 +02:00
if not self.started:
debug.msg('Enforcer not started.', 'normal')
2003-09-03 20:45:29 +02:00
return
2003-04-08 10:40:50 +02:00
channel = msg.args[0]
if not ircutils.isChannel(channel) or msg.nick == self.chanserv:
2003-04-08 10:40:50 +02:00
return
if msg.nick != irc.nick and\
not ircdb.checkCapability(msg.prefix, _chanCap(channel, 'op')):
for (mode, value) in ircutils.separateModes(msg.args[1:]):
if value == msg.nick:
continue
elif mode == '+o' and value != irc.nick:
hostmask = irc.state.nickToHostmask(value)
if ircdb.checkCapability(channel,
ircdb.makeAntiCapability('op')):
irc.queueMsg(ircmsgs.deop(channel, value))
elif mode == '+h' and value != irc.nick:
hostmask = irc.state.nickToHostmask(value)
if ircdb.checkCapability(channel,
ircdb.makeAntiCapability('halfop')):
irc.queueMsg(ircmsgs.dehalfop(channel, value))
elif mode == '+v' and value != irc.nick:
hostmask = irc.state.nickToHostmask(value)
if ircdb.checkCapability(channel,
ircdb.makeAntiCapability('voice')):
irc.queueMsg(ircmsgs.devoice(channel, value))
elif mode == '-o':
hostmask = irc.state.nickToHostmask(value)
if self._isProtected(channel, hostmask):
irc.queueMsg(ircmsgs.op(channel, value))
if self.revenge:
self._revenge(irc, channel, msg.prefix)
else:
irc.queueMsg(ircmsgs.deop(channel, msg.nick))
elif mode == '-h':
hostmask = irc.state.nickToHostmask(value)
if self._isProtected(channel, hostmask):
irc.queueMsg(ircmsgs.halfop(channel, value))
if self.revenge:
self._revenge(irc, channel, msg.prefix)
else:
irc.queueMsg(ircmsgs.deop(channel, msg.nick))
elif mode == '-v':
hostmask = irc.state.nickToHostmask(value)
if self._isProtected(channel, hostmask):
irc.queueMsg(ircmsgs.voice(channel, value))
if self.revenge:
self._revenge(irc, channel, msg.prefix)
else:
irc.queueMsg(ircmsgs.deop(channel, msg.nick))
elif mode == '+b':
# To be safe, only #channel.ops are allowed to ban.
if not ircdb.checkCapability(msg.prefix,
_chanCap(channel, 'op')):
irc.queueMsg(ircmsgs.unban(channel, value))
if self.revenge:
self._revenge(irc, channel, msg.prefix)
else:
irc.queueMsg(ircmsgs.deop(channel, msg.nick))
def __call__(self, irc, msg):
if self.started:
2003-10-06 15:00:22 +02:00
if ircutils.isUserHostmask(msg.prefix) and \
not ircutils.nickEqual(msg.nick, self.chanserv):
return callbacks.Privmsg.__call__(self, irc, msg)
2003-04-08 10:40:50 +02:00
else:
debug.msg('Enforcer plugin not started. '
'Give the bot the start command.', 'normal')
2003-04-08 10:40:50 +02:00
2003-09-03 20:45:29 +02:00
Class = Enforcer
2003-04-08 10:40:50 +02:00
# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78: