mirror of
https://github.com/Mikaela/Limnoria.git
synced 2024-11-03 01:39:23 +01:00
442 lines
18 KiB
Python
442 lines
18 KiB
Python
#!/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.utils as utils
|
|
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 supybot.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.
|
|
|
|
class ValidNickSet(conf.ValidNicks):
|
|
List = ircutils.IrcSet
|
|
|
|
conf.registerGlobalValue(conf.supybot.plugins.Services, 'nicks',
|
|
ValidNickSet([], """Determines what nicks the bot will use with
|
|
services."""))
|
|
conf.registerGlobalValue(conf.supybot.plugins.Services,
|
|
'noJoinsUntilIdentified',
|
|
registry.Boolean(False, """Determines whether the bot will not join any
|
|
channels until it is identified. This may be useful, for instances, if
|
|
you have a vhost that isn't set until you're identified, or if you're
|
|
joining +r channels that won't allow you to join unless you identify."""))
|
|
conf.registerGlobalValue(conf.supybot.plugins.Services, 'NickServ',
|
|
ValidNickOrEmptyString('', """Determines what nick the 'NickServ' service
|
|
has."""))
|
|
conf.registerGroup(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):
|
|
"""This plugin handles dealing with Services on networks that provide them.
|
|
Basically, you should use the "password" command to tell the bot what nick
|
|
to identify with using what password. You can use the password command
|
|
multiple times if your bot has multiple nicks registered. Also, be sure
|
|
to configure the NickServ and ChanServ configuration variables to match the
|
|
NickServ and ChanServ nicks on your network. Other commands
|
|
such as identify, getops, etc. should not be necessary if the bot is
|
|
properly configured."""
|
|
capability = 'admin'
|
|
def __init__(self):
|
|
callbacks.Privmsg.__init__(self)
|
|
for nick in self.registryValue('nicks'):
|
|
self._registerNick(nick)
|
|
self.reset()
|
|
|
|
def reset(self):
|
|
self.channels = []
|
|
self.sentGhost = False
|
|
self.identified = False
|
|
self.waitingJoins = []
|
|
|
|
def outFilter(self, irc, msg):
|
|
if msg.command == 'JOIN':
|
|
if not self.identified:
|
|
if self.registryValue('noJoinsUntilIdentified'):
|
|
self.log.info('Holding JOIN to %s until identified.',
|
|
msg.args[0])
|
|
self.waitingJoins.append(msg)
|
|
return None
|
|
return msg
|
|
|
|
def _registerNick(self, nick, password=''):
|
|
p = self.registryValue('NickServ.password', value=False)
|
|
p.register(nick, registry.String(password, '', private=True))
|
|
|
|
def _getNick(self):
|
|
return conf.supybot.nick()
|
|
|
|
## def _getNickServ(self, network):
|
|
## return self.registryValue('NickServ', network)
|
|
|
|
def _getNickServPassword(self, nick):
|
|
# This should later be nick-specific.
|
|
assert nick in self.registryValue('nicks')
|
|
return self.registryValue('NickServ.password.%s' % nick)
|
|
|
|
def _setNickServPassword(self, nick, password):
|
|
# This also should be nick-specific.
|
|
assert nick in self.registryValue('nicks')
|
|
self.setRegistryValue('NickServ.password.%s' % nick, password)
|
|
|
|
def _doIdentify(self, irc, nick=None):
|
|
if nick is None:
|
|
nick = self._getNick()
|
|
if nick not in self.registryValue('nicks'):
|
|
return
|
|
nickserv = self.registryValue('NickServ')
|
|
password = self._getNickServPassword(nick)
|
|
if not nickserv or not password:
|
|
s = 'Tried to identify without a NickServ or password set.'
|
|
self.log.warning(s)
|
|
return
|
|
assert irc.nick == 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, nick=None):
|
|
if nick is None:
|
|
nick = self._getNick()
|
|
if nick not in self.registryValue('nicks'):
|
|
return
|
|
nickserv = self.registryValue('NickServ')
|
|
password = self._getNickServPassword(nick)
|
|
if not nickserv or not password:
|
|
s = 'Tried to ghost without a NickServ or password set.'
|
|
self.log.warning(s)
|
|
return
|
|
if self.sentGhost:
|
|
self.log.warning('Refusing to send GHOST twice.')
|
|
elif not password:
|
|
self.log.warning('Not ghosting: no password set.')
|
|
return
|
|
else:
|
|
self.log.info('Sending ghost (current nick: %s; ghosting: %s)',
|
|
irc.nick, 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._getNick()
|
|
if nick not in self.registryValue('nicks'):
|
|
return
|
|
nickserv = self.registryValue('NickServ')
|
|
password = self._getNickServPassword(nick)
|
|
if nick and irc.nick != nick and nickserv and password:
|
|
if irc.afterConnect and not self.sentGhost:
|
|
if nick in irc.state.nicksToHostmasks:
|
|
self._doGhost(irc)
|
|
else:
|
|
irc.sendMsg(ircmsgs.nick(nick)) # 433 is handled elsewhere.
|
|
|
|
def do001(self, irc, msg):
|
|
# New connection, make sure sentGhost is False.
|
|
self.sentGhost = False
|
|
|
|
def do376(self, irc, msg):
|
|
nick = self._getNick()
|
|
if nick not in self.registryValue('nicks'):
|
|
return
|
|
nickserv = self.registryValue('NickServ')
|
|
if not nickserv:
|
|
self.log.warning('NickServ is unset, cannot identify.')
|
|
return
|
|
password = self._getNickServPassword(nick)
|
|
if not password:
|
|
self.log.warning('Password for %s is unset, cannot identify.',nick)
|
|
return
|
|
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)
|
|
do422 = do377 = do376
|
|
|
|
def do433(self, irc, msg):
|
|
nick = self._getNick()
|
|
if nick not in self.registryValue('nicks'):
|
|
return
|
|
if nick and irc.afterConnect:
|
|
password = self._getNickServPassword(nick)
|
|
if not password:
|
|
return
|
|
self._doGhost(irc)
|
|
|
|
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._getNick()
|
|
if msg.args[0] == irc.nick and irc.nick == nick:
|
|
self._doIdentify(irc)
|
|
elif ircutils.strEqual(msg.nick, nick):
|
|
irc.sendMsg(ircmsgs.nick(nick))
|
|
|
|
def _ghosted(self, s):
|
|
nick = self._getNick()
|
|
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._getNick()
|
|
self.log.debug('Notice received from NickServ: %r.', msg)
|
|
s = msg.args[1].lower()
|
|
if 'incorrect' in s or 'denied' in s:
|
|
log = 'Received "Password Incorrect" from NickServ. ' \
|
|
'Resetting password to empty.'
|
|
self.log.warning(log)
|
|
self.sentGhost = False
|
|
self._setNickServPassword(nick, '')
|
|
elif self._ghosted(s):
|
|
self.log.info('Received "GHOST succeeded" from NickServ.')
|
|
self.sentGhost = False
|
|
self.identified = False
|
|
irc.queueMsg(ircmsgs.nick(nick))
|
|
elif 'currently' in s and 'isn\'t' in s or 'is not' in s:
|
|
# The nick isn't online, let's change our nick to it.
|
|
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)
|
|
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))
|
|
if self.waitingJoins:
|
|
for m in self.waitingJoins:
|
|
irc.sendMsg(m)
|
|
self.waitingJoins = []
|
|
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 doMode(self, irc, msg):
|
|
chanserv = self.registryValue('ChanServ')
|
|
if msg.nick == chanserv:
|
|
channel = msg.args[0]
|
|
if len(msg.args) == 3:
|
|
if msg.args[2] == irc.nick:
|
|
mode = msg.args[1]
|
|
info = self.log.info
|
|
if mode == '+o':
|
|
info('Received op from ChanServ in %s.', channel)
|
|
elif mode == '+h':
|
|
info('Received halfop from ChanServ in %s.', channel)
|
|
elif mode == '+v':
|
|
info('Received voice from ChanServ in %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'):
|
|
if irc.nick in self.registryValue('nicks'):
|
|
self._doIdentify(irc, irc.nick)
|
|
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):
|
|
"""[<nick>]
|
|
|
|
Ghosts the bot's given nick and takes it. If no nick is given,
|
|
ghosts the bot's configured nick and takes it.
|
|
"""
|
|
if self.registryValue('NickServ'):
|
|
nick = privmsgs.getArgs(args, required=0, optional=1)
|
|
if not nick:
|
|
nick = self._getNick()
|
|
if nick == irc.nick:
|
|
irc.error('I cowardly refuse to ghost myself.')
|
|
else:
|
|
self._doGhost(irc, nick=nick)
|
|
irc.replySuccess()
|
|
else:
|
|
irc.error('You must set supybot.plugins.Services.NickServ before '
|
|
'I\'m able to ghost a nick.')
|
|
|
|
def password(self, irc, msg, args):
|
|
"""<nick> [<password>]
|
|
|
|
Sets the NickServ password for <nick> to <password>. If <password> is
|
|
not given, removes <nick> from the configured nicks.
|
|
"""
|
|
if ircutils.isChannel(msg.args[0]):
|
|
irc.errorRequiresPrivacy(Raise=True)
|
|
(nick, password) = privmsgs.getArgs(args, optional=1)
|
|
if not password:
|
|
try:
|
|
self.registryValue('nicks').remove(nick)
|
|
irc.replySuccess()
|
|
except KeyError:
|
|
irc.error('That nick was not configured with a password.')
|
|
return
|
|
else:
|
|
self.registryValue('nicks').add(nick)
|
|
self._registerNick(nick, password)
|
|
irc.replySuccess()
|
|
|
|
def nicks(self, irc, msg, args):
|
|
"""takes no arguments
|
|
|
|
Returns the nicks that this plugin is configured to identify and ghost
|
|
with."""
|
|
L = list(self.registryValue('nicks'))
|
|
if L:
|
|
utils.sortBy(ircutils.toLower, L)
|
|
irc.reply(utils.commaAndify(L))
|
|
else:
|
|
irc.reply('I\'m not currently configured for any nicks.')
|
|
|
|
|
|
Class = Services
|
|
|
|
# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78:
|