Limnoria/plugins/Services.py

#!/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.
###

"""
Services: Handles management of nicks with NickServ, and ops with ChanServ.
"""

__revision__ = "$Id$"

import supybot.plugins as plugins

import re
import time

import supybot.conf as conf
import supybot.ircmsgs as ircmsgs
import supybot.privmsgs as privmsgs
import supybot.ircutils as ircutils
import supybot.registry as registry
import supybot.schedule as schedule
import supybot.callbacks as callbacks

def configure(advanced):
    from questions import output, expect, anything, something, yn
    conf.registerPlugin('Services', True)
    nick = something('What is your registered nick?')
    password = something('What is your password for that nick?')
    chanserv = something('What is your ChanServ named?', default='ChanServ')
    nickserv = something('What is your NickServ named?', default='NickServ')
    conf.supybot.plugins.Services.nick.setValue(nick)
    conf.supybot.plugins.Services.NickServ.setValue(nickserv)
    conf.supybot.plugins.Services.NickServ.password.setValue(password)
    conf.supybot.plugins.Services.ChanServ.setValue(chanserv)

class ValidNickOrEmptyString(registry.String):
    def setValue(self, v):
        if v and not ircutils.isNick(v):
            raise registry.InvalidRegistryValue, \
                  'Value must be a valid nick or the empty string.'
        registry.String.setValue(self, v)

conf.registerPlugin('Services')
# Not really ChannelValues: but we can have values for each network.  We
# should probably document that this is possible.
conf.registerGlobalValue(conf.supybot.plugins.Services, 'nick',
    ValidNickOrEmptyString('', """Determines what nick the bot will use with
    services."""))
conf.registerGlobalValue(conf.supybot.plugins.Services, 'NickServ',
    ValidNickOrEmptyString('', """Determines what nick the 'NickServ' service
    has."""))
conf.registerGlobalValue(conf.supybot.plugins.Services.NickServ, 'password',
    registry.String('', """Determines what password the bot will use with
    NickServ.""", private=True))
conf.registerGlobalValue(conf.supybot.plugins.Services, 'ChanServ',
    ValidNickOrEmptyString('', """Determines what nick the 'ChanServ' service
    has."""))
conf.registerChannelValue(conf.supybot.plugins.Services.ChanServ, 'password',
    registry.String('', """Determines what password the bot will use with
    ChanServ.""", private=True))
conf.registerChannelValue(conf.supybot.plugins.Services.ChanServ, 'op',
    registry.Boolean(False, """Determines whether the bot will request to get
    opped by the ChanServ when it joins the channel."""))
conf.registerChannelValue(conf.supybot.plugins.Services.ChanServ, 'halfop',
    registry.Boolean(False, """Determines whether the bot will request to get
    half-opped by the ChanServ when it joins the channel."""))
conf.registerChannelValue(conf.supybot.plugins.Services.ChanServ, 'voice',
    registry.Boolean(False, """Determines whether the bot will request to get
    voiced by the ChanServ when it joins the channel."""))


class Services(privmsgs.CapabilityCheckingPrivmsg):
    capability = 'admin'
    def __init__(self):
        callbacks.Privmsg.__init__(self)
        self.reset()

    def reset(self):
        self.channels = []
        self.sentGhost = False
        self.identified = False

    def _doIdentify(self, irc):
        nickserv = self.registryValue('NickServ')
        if not nickserv:
            self.log.warning('_doIdentify called without a set NickServ.')
            return
        password = self.registryValue('NickServ.password')
        assert irc.nick == self.registryValue('nick'), \
               'Identifying with not normal nick.'
        self.log.info('Sending identify (current nick: %s)' % irc.nick)
        identify = 'IDENTIFY %s' % password
        # It's important that this next statement is irc.sendMsg, not
        # irc.queueMsg.  We want this message to get through before any
        # JOIN messages also being sent on 376.
        irc.sendMsg(ircmsgs.privmsg(nickserv, identify))

    def _doGhost(self, irc):
        nickserv = self.registryValue('NickServ')
        if not nickserv:
            self.log.warning('Tried to ghost without a NickServ set.')
            return
        if self.sentGhost:
            self.log.warning('Refusing to send GHOST twice.')
        else:
            nick = self.registryValue('nick')
            password = self.registryValue('NickServ.password')
            self.log.info('Sending ghost (current nick: %s)', irc.nick)
            ghost = 'GHOST %s %s' % (nick, password)
            # Ditto about the sendMsg (see _doIdentify).
            irc.sendMsg(ircmsgs.privmsg(nickserv, ghost))
            self.sentGhost = True

    def __call__(self, irc, msg):
        callbacks.Privmsg.__call__(self, irc, msg)
        nick = self.registryValue('nick')
        if nick and irc.nick != nick:
            if irc.afterConnect and not self.sentGhost:
                irc.sendMsg(ircmsgs.nick(nick)) # The 433 is handled elsewhere.

    def do001(self, irc, msg):
        # New connection, make sure sentGhost is False.
        self.sentGhost = False

    def do376(self, irc, msg):
        nickserv = self.registryValue('NickServ')
        if nickserv: # Check to see if we're started.
            nick = self.registryValue('nick')
            if not nick:
                self.log.warning('Cannot identify without a nick being set.  '
                                 'Set supybot.plugins.Services.nick.')
                return
            if irc.nick == nick:
                self._doIdentify(irc)
            else:
                self._doGhost(irc)
        else:
            s = 'supybot.plugins.Services.NickServ is unset; cannot identify.'
            self.log.warning(s)
    do422 = do377 = do376

    def do433(self, irc, msg):
        if irc.afterConnect:
            nickserv = self.registryValue('NickServ')
            self._doGhost(irc)

##     def do474(self, irc, msg):
##         # Can't join this channel, it's banned us.
##         channel = msg.args[1]
##         chanserv = self.registryValue('ChanServ')
##         if chanserv:
##             # This artificially conflates OP and UNBAN, but we'll assume until
##             # we get a complaint from someone.
##             if self.registryValue('ChanServ.op', channel):
##                 if self.identified:
##                     irc.sendMsg(ircmsgs.privmsg(chanserv,'UNBAN %s' % channel))
##                     irc.sendMsg(ircmsgs.join(channel))
##                 else:
##                     self._doIdentify(irc)
##         pass

    def do515(self, irc, msg):
        # Can't join this channel, it's +r (we must be identified).
        self.channels.append(msg.args[1])

    def doNick(self, irc, msg):
        nick = self.registryValue('nick')
        if msg.args[0] == nick:
            self._doIdentify(irc)

    def _ghosted(self, s):
        nick = self.registryValue('nick')
        lowered = s.lower()
        return bool('killed' in lowered and (nick in s or 'ghost' in lowered))

    def doNotice(self, irc, msg):
        if irc.afterConnect:
            nickserv = self.registryValue('NickServ')
            if not nickserv or msg.nick != nickserv:
                return
            nick = self.registryValue('nick')
            self.log.debug('Notice received from NickServ: %r', msg)
            s = msg.args[1].lower()
            if self._ghosted(s):
                self.log.info('Received "GHOST succeeded" from NickServ')
                self.sentGhost = False
                irc.queueMsg(ircmsgs.nick(nick))
            elif ('registered' in s or 'protected' in s) and \
               ('not' not in s and 'isn\'t' not in s):
                self.log.info('Received "Registered Nick" from NickServ')
                if nick == irc.nick:
                    self._doIdentify(irc)
                else:
                    irc.sendMsg(ircmsgs.nick(nick))
            elif '/msg' in s and 'identify' in s and 'password' in s:
                # Usage info for identify command; ignore.
                self.log.debug('Got usage info for identify command.')
            elif 'now recognized' in s:
                self.log.info('Received "Password accepted" from NickServ')
                self.identified = True
                for channel in irc.state.channels.keys():
                    self.checkPrivileges(irc, channel)
                if self.channels:
                    irc.queueMsg(ircmsgs.joins(self.channels))
            elif 'incorrect' in s:
                log = 'Received "Password Incorrect" from NickServ.'
                self.log.warning(log)
            else:
                self.log.debug('Unexpected notice from NickServ: %r', s)

    def checkPrivileges(self, irc, channel):
        chanserv = self.registryValue('ChanServ')
        if chanserv and self.registryValue('ChanServ.op', channel):
            if irc.nick not in irc.state.channels[channel].ops:
                self.log.info('Requesting op from %s in %s', chanserv, channel)
                irc.sendMsg(ircmsgs.privmsg(chanserv, 'op %s' % channel))
        if chanserv and self.registryValue('ChanServ.halfop', channel):
            if irc.nick not in irc.state.channels[channel].halfops:
                self.log.info('Requesting halfop from %s in %s',
                              chanserv, channel)
                irc.sendMsg(ircmsgs.privmsg(chanserv, 'halfop %s' % channel))
        if chanserv and self.registryValue('ChanServ.voice', channel):
            if irc.nick not in irc.state.channels[channel].voices:
                self.log.info('Requesting voice from %s in %s',
                              chanserv, channel)
                irc.sendMsg(ircmsgs.privmsg(chanserv, 'voice %s' % channel))

    def do366(self, irc, msg): # End of /NAMES list; finished joining a channel
        if self.identified:
            channel = msg.args[1] # nick is msg.args[0].
            self.checkPrivileges(irc, channel)

    def getops(self, irc, msg, args):
        """[<channel>]

        Attempts to get ops from ChanServ in <channel>.  If no channel is
        given, the current channel is assumed.
        """
        channel = privmsgs.getChannel(msg, args)
        try:
            if irc.nick in irc.state.channels[channel].ops:
                irc.error('I\'ve already got ops in %s' % channel)
            else:
                chanserv = self.registryValue('ChanServ')
                if chanserv:
                    irc.sendMsg(ircmsgs.privmsg(chanserv, 'op %s' % channel))
                else:
                    irc.error('You must set supybot.plugins.Services.ChanServ '
                              'before I\'m able to do get ops.')
        except KeyError:
            irc.error('I\'m not in %s.' % channel)

    def identify(self, irc, msg, args):
        """takes no arguments

        Identifies with NickServ.
        """
        if self.registryValue('NickServ'):
            nick = self.registryValue('nick')
            if nick != irc.nick:
                irc.error('I can\'t identify without having my normal nick!')
            elif not nick:
                irc.error('You must set supybot.plugins.Services.nick before '
                          'I\'m able to identify.')
            else:
                self._doIdentify(irc)
                irc.replySuccess()
        else:
            irc.error('You must set supybot.plugins.Services.NickServ before '
                      'I\'m able to do identify.')

    def ghost(self, irc, msg, args):
        """takes no arguments

        Ghosts the bot's configured nick and retakes it.
        """
        if self.registryValue('NickServ'):
            nick = self.registryValue('nick')
            if nick == irc.nick:
                irc.error('I cowardly refuse to ghost myself.')
            elif not nick:
                irc.error('You must set supybot.plugins.Services.nick before '
                          'I\'m able to ghost a nick.')
            else:
                self._doGhost(irc)
                irc.replySuccess()
        else:
            irc.error('You must set supybot.plugins.Services.NickServ before '
                      'I\'m able to ghost a nick.')



Class = Services

# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78: