mirror of
https://github.com/Mikaela/Limnoria.git
synced 2024-10-03 01:48:52 +02:00
833af36b08
Starting with this commit, there should be no "original" text in READMEs. Instead, the entire text should be in docstrings, and READMEs should be automatically generated from these docstrings. Motivation: * The same help is available both via IRC and in the README (although the README can be more detailed, as only the first paragraph will be shown on IRC) * This will allow auto-generating plugin help on docs.limnoria.net using the same content as the README, as it's sourced from the docstrings Additionally, this converts all READMEs from Markdown to ReST, because the documentation already uses ReST, and other docstrings in the codebase are in ReST for this reason.
103 lines
4.2 KiB
Python
103 lines
4.2 KiB
Python
###
|
|
# Copyright (c) 2005, Daniel DiPaolo
|
|
# 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 re
|
|
|
|
from supybot.commands import *
|
|
import supybot.plugins as plugins
|
|
import supybot.ircutils as ircutils
|
|
from supybot.i18n import PluginInternationalization, internationalizeDocstring
|
|
_ = PluginInternationalization('Praise')
|
|
|
|
class Praise(plugins.ChannelIdDatabasePlugin):
|
|
"""
|
|
Praise is a plugin for ... well, praising things. Feel free to add
|
|
your own flavor to it by customizing what praises it gives. Use "praise
|
|
add <text>" to add new ones, making sure to include "$who" in <text> where
|
|
you want to insert the thing being praised.
|
|
|
|
Example:
|
|
|
|
* If you add ``hugs $who``
|
|
* Someone says ``@praise ChanServ``.
|
|
* ``* bot hugs ChanServ``
|
|
"""
|
|
_meRe = re.compile(r'\bme\b', re.I)
|
|
_myRe = re.compile(r'\bmy\b', re.I)
|
|
def _replaceFirstPerson(self, s, nick):
|
|
s = self._meRe.sub(nick, s)
|
|
s = self._myRe.sub('%s\'s' % nick, s)
|
|
return s
|
|
|
|
def addValidator(self, irc, text):
|
|
if '$who' not in text:
|
|
irc.error(_('Praises must contain $who.'), Raise=True)
|
|
|
|
@internationalizeDocstring
|
|
def praise(self, irc, msg, args, channel, id, text):
|
|
"""[<channel>] [<id>] <who|what> [for <reason>]
|
|
|
|
Praises <who|what> (for <reason>, if given). If <id> is given, uses
|
|
that specific praise. <channel> is only necessary if the message isn't
|
|
sent in the channel itself.
|
|
"""
|
|
if ' for ' in text:
|
|
(target, reason) = list(map(str.strip, text.split(' for ', 1)))
|
|
else:
|
|
(target, reason) = (text, '')
|
|
if ircutils.strEqual(target, irc.nick):
|
|
target = 'itself'
|
|
if id is not None:
|
|
try:
|
|
praise = self.db.get(channel, id)
|
|
except KeyError:
|
|
irc.error(format(_('There is no praise with id #%i.'), id))
|
|
return
|
|
else:
|
|
praise = self.db.random(channel)
|
|
if not praise:
|
|
irc.error(format(_('There are no praises in my database ' \
|
|
'for %s.'), channel))
|
|
return
|
|
text = self._replaceFirstPerson(praise.text, msg.nick)
|
|
reason = self._replaceFirstPerson(reason, msg.nick)
|
|
target = self._replaceFirstPerson(target, msg.nick)
|
|
text = text.replace('$who', target)
|
|
if reason:
|
|
text += _(' for ') + reason
|
|
if self.registryValue('showIds', channel, irc.network):
|
|
text += format(' (#%i)', praise.id)
|
|
irc.reply(text, action=True)
|
|
praise = wrap(praise, ['channeldb', optional('id'), 'text'])
|
|
Praise = internationalizeDocstring(Praise)
|
|
|
|
Class = Praise
|
|
|
|
# vim:set shiftwidth=4 softtabstop=4 expandtab textwidth=79:
|