plugin.py

###
# Copyright (c) 2013, James McCoy
# 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.ircdb as ircdb
import supybot.callbacks as callbacks


class IgnoreUnknownPrivateMessages(callbacks.Plugin):
    """When this plugin is loaded, private messages from unknown users are
    ignored unless the user is also in a channel with the bot."""

    def inFilter(self, irc, msg):
        if msg.command == 'PRIVMSG' and not irc.isChannel(msg.args[0]):
            # Allow registered users to converse with the bot
            if ircdb.users.hasUser(msg.prefix):
                return msg
            for chan in irc.state.channels:
                # Recognize the nick, we can accept the msg
                if msg.nick in irc.state.channels[chan].users:
                    return msg
            self.log.debug('%s doesn\'t share any channels with me, ignoring '
                           'private message' % msg.prefix)
            return None
        return msg


Class = IgnoreUnknownPrivateMessages


# vim:set shiftwidth=4 softtabstop=4 expandtab textwidth=79: