Limnoria/plugins/NickAuth/plugin.py
Valentin Lorentz 833af36b08 all plugins: auto-generate READMEs
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.
2021-04-05 17:42:31 +02:00

236 lines
9.0 KiB
Python

###
# Copyright (c) 2012, Valentin Lorentz
# 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 time
import supybot.conf as conf
import supybot.utils as utils
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.callbacks as callbacks
from supybot.i18n import PluginInternationalization, internationalizeDocstring
_ = PluginInternationalization('NickAuth')
@internationalizeDocstring
class NickAuth(callbacks.Plugin):
"""
This plugin allows users to use their network services account to
authenticate to the bot.
They first have to use ``@nickauth nick add <the nick>`` while being
identified to the bot and then use ``@auth`` when they want to
identify to the bot.
"""
def __init__(self, irc):
super(NickAuth, self).__init__(irc)
self._requests = {}
class nick(callbacks.Commands):
def _check_auth(self, irc, msg, user):
if user is None:
irc.error(_('You are not authenticated.'), Raise=True)
if not user.checkHostmask(msg.prefix):
try:
u = ircdb.users.getUser(msg.prefix)
except KeyError:
irc.error(_('You are not authenticated.'),
Raise=True)
if not u._checkCapability('owner'):
irc.error(_('You must be owner to do that.'),
Raise=True)
@internationalizeDocstring
def add(self, irc, msg, args, network, user, nick):
"""[<network>] <user> <nick>
Add <nick> to the list of nicks owned by the <user> on the
<network>. You have to register this nick to the network
services to be authenticated.
<network> defaults to the current network.
"""
network = network.network or irc.network
user = user or ircdb.users.getUser(msg.prefix)
self._check_auth(irc, msg, user)
try:
user.addNick(network, nick)
except KeyError:
irc.error(_('This nick is already used by someone on this '
'network.'), Raise=True)
irc.replySuccess()
add = wrap(add, [optional('networkIrc'),
optional('otherUser'),
'nick'])
@internationalizeDocstring
def remove(self, irc, msg, args, network, user, nick):
"""[<network>] <user> <nick>
Remove <nick> from the list of nicks owned by the <user> on the
<network>.
<network> defaults to the current network.
"""
network = network.network or irc.network
user = user or ircdb.users.getUser(msg.prefix)
self._check_auth(irc, msg, user)
try:
user.removeNick(network, nick)
except KeyError:
irc.error(_('This nick is not registered to you on this '
'network.'), Raise=True)
irc.replySuccess()
remove = wrap(remove, [optional('networkIrc'),
optional('otherUser'),
'nick'])
@internationalizeDocstring
def list(self, irc, msg, args, network, user):
"""[<network>] [<user>]
Lists nicks of the <user> on the network.
<network> defaults to the current network.
"""
network = network.network or irc.network
try:
user = user or ircdb.users.getUser(msg.prefix)
except KeyError:
irc.error(_('You are not identified and <user> is not given.'),
Raise=True)
self._check_auth(irc, msg, user)
try:
list_ = user.nicks[network]
if list_:
irc.reply(format('%L', list_))
else:
raise KeyError
except KeyError:
if user == ircdb.users.getUser(msg.prefix):
irc.error(_('You have no recognized nick on this '
'network.'), Raise=True)
else:
irc.error(_('%s has no recognized nick on this '
'network.') % user.name, Raise=True)
list = wrap(list, [optional('networkIrc'),
optional('otherUser')])
@internationalizeDocstring
def auth(self, irc, msg, args):
"""takes no argument
Tries to authenticate you using network services.
If you get no reply, it means you are not authenticated to the
network services."""
nick = ircutils.toLower(msg.nick)
self._requests[(irc.network, msg.nick)] = (time.time(), msg.prefix, irc)
irc.queueMsg(ircmsgs.whois(nick, nick))
auth = wrap(auth, [])
def inFilter(self, irc, msg):
"""If the messages has a server tag with account name, tries to
authenticate it."""
if msg.server_tags and 'account' in msg.server_tags:
self._auth(irc, msg.prefix, msg.server_tags['account'])
return msg
def do330(self, irc, msg):
# RPL_WHOISACCOUNT
mynick, theirnick, theiraccount, garbage = msg.args
now = time.time()
self._requests = {
x: y for x,y in self._requests.items() if y[0]+60 > now}
try:
(timestamp, prefix, irc) = self._requests.pop((irc.network, theirnick))
except KeyError:
return
user = ircdb.users.getUserFromNick(irc.network, theiraccount)
if user:
try:
user.addAuth(prefix)
except ValueError:
irc.error(_('Your secure flag is true and your hostmask '
'doesn\'t match any of your known hostmasks.'),
Raise=True)
ircdb.users.setUser(user, flush=False)
irc.reply(_('You are now authenticated as %s.') % user.name)
else:
irc.error(_('No user claimed the nick %s on this network. '
'If this is you, you should connect with an other '
'method and use the "nickauth nick add" command, '
'or ask the owner of the bot to do it.')
% (theiraccount,))
def doAccount(self, irc, msg):
account = msg.args[0]
if account != '*':
self._auth(irc, msg.prefix, account)
def doJoin(self, irc, msg):
if 'extended-join' not in irc.state.capabilities_ack:
return
account = msg.args[1]
if account != '*':
self._auth(irc, msg.prefix, account)
def do354(self, irc, msg):
# RPL_WHOSPCRPL, ie. WHOX reply
if len(msg.args) != 9 or msg.args[1] != '1':
return
# irc.nick 1 user ip host nick status account gecos
(n, t, ident, ip, host, nick, status, account, gecos) = msg.args
prefix = '%s!%s@%s' % (nick, ident, host)
if account != '0':
self._auth(irc, prefix, account)
def _auth(self, irc, prefix, account):
user = ircdb.users.getUserFromNick(irc.network, account)
if not user:
try:
user = ircdb.users.getUser(prefix)
except KeyError:
user = None
if user:
user.addAuth(prefix)
ircdb.users.setUser(user, flush=False)
Class = NickAuth
# vim:set shiftwidth=4 softtabstop=4 expandtab textwidth=79: