diff --git a/plugins/Limiter/README.txt b/plugins/Limiter/README.txt new file mode 100644 index 000000000..d60b47a97 --- /dev/null +++ b/plugins/Limiter/README.txt @@ -0,0 +1 @@ +Insert a description of your plugin here, with any notes, etc. about using it. diff --git a/plugins/Limiter/__init__.py b/plugins/Limiter/__init__.py new file mode 100644 index 000000000..bf84bfdc2 --- /dev/null +++ b/plugins/Limiter/__init__.py @@ -0,0 +1,60 @@ +### +# Copyright (c) 2004-2005, 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. +### + +""" +This plugin handles channel limits (MODE +l). +""" + +import supybot +import supybot.world as world + +# Use this for the version of this plugin. You may wish to put a CVS keyword +# in here if you're keeping the plugin in CVS or some similar system. +__version__ = "%%VERSION%%" + +__author__ = supybot.authors.jemfinch + +# This is a dictionary mapping supybot.Author instances to lists of +# contributions. +__contributors__ = {} + +import config +import plugin +reload(plugin) # In case we're being reloaded. +# Add more reloads here if you add third-party modules and want them to be +# reloaded when this plugin is reloaded. Don't forget to import them as well! + +if world.testing: + import test + +Class = plugin.Class +configure = config.configure + + +# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78: diff --git a/plugins/Limiter/config.py b/plugins/Limiter/config.py new file mode 100644 index 000000000..b3987411a --- /dev/null +++ b/plugins/Limiter/config.py @@ -0,0 +1,57 @@ +### +# Copyright (c) 2004-2005, 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. +### + +import supybot.conf as conf +import supybot.registry as registry + +def configure(advanced): + # This will be called by supybot to configure this module. advanced is + # a bool that specifies whether the user identified himself as an advanced + # user or not. You should effect your configuration by manipulating the + # registry as appropriate. + from supybot.questions import expect, anything, something, yn + conf.registerPlugin('Limiter', True) + + +Limiter = conf.registerPlugin('Limiter') +conf.registerChannelValue(Limiter, 'enable', + registry.Boolean(False, """Determines whether the bot will maintain the + channel limit to be slightly above the current number of people in the + channel, in order to make clone/drone attacks harder.""")) +conf.registerChannelValue(Limiter, 'minimumExcess', + registry.PositiveInteger(5, """Determines the minimum number of free + spots that will be saved when limits are being enforced. This should + always be smaller than supybot.plugins.Limiter.limit.maximumExcess.""")) +conf.registerChannelValue(Limiter, 'maximumExcess', + registry.PositiveInteger(10, """Determines the maximum number of free spots + that will be saved when limits are being enforced. This should always be + larger than supybot.plugins.Limiter.limit.minimumExcess.""")) + + +# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78 diff --git a/plugins/Limiter/plugin.py b/plugins/Limiter/plugin.py new file mode 100644 index 000000000..c612432b3 --- /dev/null +++ b/plugins/Limiter/plugin.py @@ -0,0 +1,75 @@ +### +# Copyright (c) 2004-2005, 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. +### + +from supybot.commands import * +import supybot.ircmsgs as ircmsgs +import supybot.ircutils as ircutils +import supybot.callbacks as callbacks + + +class Limiter(callbacks.Plugin): + """In order to use this plugin, its config values need to be properly + setup. supybot.plugins.Limiter.enable needs to be set to True and + supybot.plugins.Limiter.{maximumExcess,minimumExcess} should be set to + values appropriate to your channel (if the defaults aren't satisfactory. + Once these are set, and someone enters/leaves the channel, Supybot will + start setting the proper +l modes. + """ + def _enforce(self, irc, limit): + irc.queueMsg(limit) + irc.noReply() + + def _enforceLimit(self, irc, channel): + if self.registryValue('enable', channel): + maximum = self.registryValue('maximumExcess', channel) + minimum = self.registryValue('minimumExcess', channel) + assert maximum > minimum + currentUsers = len(irc.state.channels[channel].users) + currentLimit = irc.state.channels[channel].modes.get('l', 0) + if currentLimit - currentUsers < minimum: + self._enforce(irc, ircmsgs.limit(channel,currentUsers+maximum)) + elif currentLimit - currentUsers > maximum: + self._enforce(irc, ircmsgs.limit(channel,currentUsers-minimum)) + + def doJoin(self, irc, msg): + if not ircutils.strEqual(msg.nick, irc.nick): + irc = callbacks.SimpleProxy(irc, msg) + self._enforceLimit(irc, msg.args[0]) + doPart = doJoin + doKick = doJoin + + def doQuit(self, irc, msg): + for channel in irc.state.channels: + self._enforceLimit(irc, channel) + + +Class = Limiter + + +# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78: diff --git a/plugins/Limiter/test.py b/plugins/Limiter/test.py new file mode 100644 index 000000000..935093f8f --- /dev/null +++ b/plugins/Limiter/test.py @@ -0,0 +1,56 @@ +### +# Copyright (c) 2004-2005, 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. +### + +from supybot.test import * + +class LimiterTestCase(ChannelPluginTestCase): + plugins = ('Limiter',) + config = {'supybot.plugins.Limiter.enable': True} + def testEnforceLimit(self): + origMin = conf.supybot.plugins.Limiter.minimumExcess() + origMax = conf.supybot.plugins.Limiter.maximumExcess() + try: + conf.supybot.plugins.Limiter.minimumExcess.setValue(5) + conf.supybot.plugins.Limiter.maximumExcess.setValue(10) + self.irc.feedMsg(ircmsgs.join('#foo', prefix='foo!root@host')) + m = self.irc.takeMsg() + self.assertEqual(m, ircmsgs.limit('#foo', 1+10)) + self.irc.feedMsg(ircmsgs.join('#foo', prefix='bar!root@host')) + m = self.irc.takeMsg() + self.failIf(m is not None) + conf.supybot.plugins.Limiter.maximumExcess.setValue(7) + self.irc.feedMsg(ircmsgs.part('#foo', prefix='bar!root@host')) + m = self.irc.takeMsg() + self.assertEqual(m, ircmsgs.limit('#foo', 1-5)) + finally: + conf.supybot.plugins.Limiter.minimumExcess.setValue(origMin) + conf.supybot.plugins.Limiter.maximumExcess.setValue(origMax) + + +# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78: