mirror of
https://github.com/Mikaela/Limnoria.git
synced 2024-11-14 06:39:23 +01:00
243 lines
9.8 KiB
Python
243 lines
9.8 KiB
Python
###
|
|
# Copyright (c) 2002-2004, 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.
|
|
###
|
|
|
|
"""
|
|
Greets users who join the channel with a recognized hostmask with a nice
|
|
little greeting.
|
|
"""
|
|
|
|
__revision__ = "$Id$"
|
|
|
|
import os
|
|
import time
|
|
import getopt
|
|
|
|
import supybot.log as log
|
|
import supybot.conf as conf
|
|
import supybot.utils as utils
|
|
import supybot.world as world
|
|
import supybot.ircdb as ircdb
|
|
from supybot.commands import *
|
|
import supybot.ircmsgs as ircmsgs
|
|
import supybot.plugins as plugins
|
|
import supybot.ircutils as ircutils
|
|
import supybot.registry as registry
|
|
import supybot.callbacks as callbacks
|
|
|
|
filename = conf.supybot.directories.data.dirize('Herald.db')
|
|
|
|
class HeraldDB(plugins.ChannelUserDB):
|
|
def serialize(self, v):
|
|
return [v]
|
|
|
|
def deserialize(self, channel, id, L):
|
|
if len(L) != 1:
|
|
raise ValueError
|
|
return L[0]
|
|
|
|
conf.registerPlugin('Herald')
|
|
conf.registerChannelValue(conf.supybot.plugins.Herald, 'heralding',
|
|
registry.Boolean(True, """Determines whether messages will be sent to the
|
|
channel when a recognized user joins; basically enables or disables the
|
|
plugin."""))
|
|
conf.registerChannelValue(conf.supybot.plugins.Herald, 'throttleTime',
|
|
registry.PositiveInteger(600, """Determines the minimum number of seconds
|
|
between heralds."""))
|
|
conf.registerChannelValue(conf.supybot.plugins.Herald, 'default',
|
|
registry.String('', """Sets the default herald to use. If a user has a
|
|
personal herald specified, that will be used instead. If set to the empty
|
|
string, the default herald will be disabled."""))
|
|
conf.registerChannelValue(conf.supybot.plugins.Herald.default, 'notice',
|
|
registry.Boolean(True, """Determines whether the default herald will be
|
|
sent as a NOTICE instead of a PRIVMSG."""))
|
|
conf.registerChannelValue(conf.supybot.plugins.Herald.default, 'public',
|
|
registry.Boolean(False, """Determines whether the default herald will be
|
|
sent publicly."""))
|
|
conf.registerChannelValue(conf.supybot.plugins.Herald, 'throttleTimeAfterPart',
|
|
registry.PositiveInteger(60, """Determines the minimum number of seconds
|
|
after parting that the bot will not herald the person when he or she
|
|
rejoins."""))
|
|
|
|
class Herald(callbacks.Privmsg):
|
|
def __init__(self):
|
|
self.__parent = super(Herald, self)
|
|
self.__parent.__init__()
|
|
self.db = HeraldDB(filename)
|
|
world.flushers.append(self.db.flush)
|
|
self.lastParts = plugins.ChannelUserDictionary()
|
|
self.lastHerald = plugins.ChannelUserDictionary()
|
|
|
|
def die(self):
|
|
if self.db.flush in world.flushers:
|
|
world.flushers.remove(self.db.flush)
|
|
self.db.close()
|
|
self.__parent.die()
|
|
|
|
def doJoin(self, irc, msg):
|
|
if ircutils.strEqual(irc.nick, msg.nick):
|
|
return # It's us.
|
|
channel = msg.args[0]
|
|
irc = callbacks.SimpleProxy(irc, msg)
|
|
if self.registryValue('heralding', channel):
|
|
try:
|
|
id = ircdb.users.getUserId(msg.prefix)
|
|
herald = self.db[channel, id]
|
|
except KeyError:
|
|
default = self.registryValue('default', channel)
|
|
if default:
|
|
default = ircutils.standardSubstitute(irc, msg, default)
|
|
msgmaker = ircmsgs.privmsg
|
|
if self.registryValue('default.notice', channel):
|
|
msgmaker = ircmsgs.notice
|
|
target = msg.nick
|
|
if self.registryValue('default.public', channel):
|
|
target = channel
|
|
irc.queueMsg(msgmaker(target, default))
|
|
return
|
|
now = time.time()
|
|
throttle = self.registryValue('throttleTime', channel)
|
|
if now - self.lastHerald.get((channel, id), 0) > throttle:
|
|
if (channel, id) in self.lastParts:
|
|
i = self.registryValue('throttleTimeAfterPart', channel)
|
|
if now - self.lastParts[channel, id] < i:
|
|
return
|
|
self.lastHerald[channel, id] = now
|
|
herald = ircutils.standardSubstitute(irc, msg, herald)
|
|
irc.reply(herald, prefixName=False)
|
|
|
|
def doPart(self, irc, msg):
|
|
try:
|
|
id = self._getId(irc, msg.prefix)
|
|
self.lastParts[msg.args[0], id] = time.time()
|
|
except KeyError:
|
|
pass
|
|
|
|
def _getId(self, irc, userNickHostmask):
|
|
try:
|
|
id = ircdb.users.getUserId(userNickHostmask)
|
|
except KeyError:
|
|
if not ircutils.isUserHostmask(userNickHostmask):
|
|
hostmask = irc.state.nickToHostmask(userNickHostmask)
|
|
id = ircdb.users.getUserId(hostmask)
|
|
else:
|
|
raise KeyError
|
|
return id
|
|
|
|
def default(self, irc, msg, args, channel, optlist, text):
|
|
"""[<channel>] [--remove|<msg>]
|
|
|
|
If <msg> is given, sets the default herald to <msg>. A <msg> of ""
|
|
will remove the default herald. If <msg> is not given, returns the
|
|
current default herald. <channel> is only necessary if the message
|
|
isn't sent in the channel itself.
|
|
"""
|
|
if optlist and text:
|
|
raise callbacks.ArgumentError
|
|
for (option, _) in optlist:
|
|
if option == 'remove':
|
|
self.setRegistryValue('default', '', channel)
|
|
irc.replySuccess()
|
|
return
|
|
if text:
|
|
self.setRegistryValue('default', text, channel)
|
|
irc.replySuccess()
|
|
else:
|
|
resp = self.registryValue('default', channel) or \
|
|
'I do not have a default herald set for %s.' % channel
|
|
irc.reply(resp)
|
|
default = wrap(default, ['channel',
|
|
getopts({'remove': ''}),
|
|
additional('text')])
|
|
|
|
def get(self, irc, msg, args, channel, user):
|
|
"""[<channel>] [<user|nick>]
|
|
|
|
Returns the current herald message for <user> (or the user
|
|
<nick|hostmask> is currently identified or recognized as). If <user>
|
|
is not given, defaults to the user giving the command. <channel>
|
|
is only necessary if the message isn't sent in the channel itself.
|
|
"""
|
|
try:
|
|
herald = self.db[channel, user.id]
|
|
irc.reply(herald)
|
|
except KeyError:
|
|
irc.error('I have no herald for %s.' % user.name)
|
|
get = wrap(get, ['channel', first('otherUser', 'user')])
|
|
|
|
# I chose not to make <user|nick> optional in this command because
|
|
# if it's not a valid username (e.g., if the user tyops and misspells a
|
|
# username), it may be nice not to clobber the user's herald.
|
|
def add(self, irc, msg, args, channel, user, herald):
|
|
"""[<channel>] <user|nick> <msg>
|
|
|
|
Sets the herald message for <user> (or the user <nick|hostmask> is
|
|
currently identified or recognized as) to <msg>. <channel> is only
|
|
necessary if the message isn't sent in the channel itself.
|
|
"""
|
|
self.db[channel, user.id] = herald
|
|
irc.replySuccess()
|
|
add = wrap(add, ['channel', 'otherUser', 'text'])
|
|
|
|
def remove(self, irc, msg, args, channel, user):
|
|
"""[<channel>] [<user|nick>]
|
|
|
|
Removes the herald message set for <user>, or the user
|
|
<nick|hostmask> is currently identified or recognized as. If <user>
|
|
is not given, defaults to the user giving the command.
|
|
<channel> is only necessary if the message isn't sent in the channel
|
|
itself.
|
|
"""
|
|
try:
|
|
del self.db[channel, user.id]
|
|
irc.replySuccess()
|
|
except KeyError:
|
|
irc.error('I have no herald for that user.')
|
|
remove = wrap(remove, ['channel', first('otherUser', 'user')])
|
|
|
|
def change(self, irc, msg, args, channel, user, changer):
|
|
"""[<channel>] [<user|nick>] <regexp>
|
|
|
|
Changes the herald message for <user>, or the user <nick|hostmask> is
|
|
currently identified or recognized as, according to <regexp>. If
|
|
<user> is not given, defaults to the calling user. <channel> is only
|
|
necessary if the message isn't sent in the channel itself.
|
|
"""
|
|
s = self.db[channel, user.id]
|
|
newS = changer(s)
|
|
self.db[channel, user.id] = newS
|
|
irc.replySuccess()
|
|
change = wrap(change, ['channel',
|
|
first('otherUser', 'user'),
|
|
'regexpReplacer'])
|
|
|
|
|
|
Class = Herald
|
|
|
|
# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78:
|