Skip to content

NickAuth: refer to "services accounts" instead of "nicks" in help #1616

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 20, 2025
Merged

NickAuth: refer to "services accounts" instead of "nicks" in help #1616

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 25 additions & 23 deletions plugins/NickAuth/plugin.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ 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
They first have to use ``@nickauth nick add <services account name>`` while
identified to the bot, and then use ``@auth`` when they want to
identify to the bot.
"""

Expand All @@ -59,24 +59,24 @@ def __init__(self, irc):
class nick(callbacks.Commands):
def _check_auth(self, irc, msg, user):
if user is None:
irc.error(_('You are not authenticated.'), Raise=True)
irc.error(_('You are not logged in to the bot.'), Raise=True)
if not user.checkHostmask(msg.prefix):
try:
u = ircdb.users.getUser(msg.prefix)
except KeyError:
irc.error(_('You are not authenticated.'),
irc.error(_('You are not logged in to the bot.'),
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>
"""[<network>] [<bot username>] <account>

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.
Add <account> to the list of network services accounts owned by
<bot username> on <network>. <bot username> is only required if you
are not already logged in to Limnoria.
<network> defaults to the current network.
"""
network = network.network or irc.network
Expand All @@ -85,19 +85,20 @@ def add(self, irc, msg, args, network, user, nick):
try:
user.addNick(network, nick)
except KeyError:
irc.error(_('This nick is already used by someone on this '
'network.'), Raise=True)
irc.error(_('This services account 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>
"""[<network>] [<bot username>] <account>

Remove <nick> from the list of nicks owned by the <user> on the
<network>.
Remove <account> from the list of network services accounts owned by
<bot username> on <network>. <bot username> is only required if you
are not already logged in to Limnoria.
<network> defaults to the current network.
"""
network = network.network or irc.network
Expand All @@ -106,18 +107,19 @@ def remove(self, irc, msg, args, network, user, nick):
try:
user.removeNick(network, nick)
except KeyError:
irc.error(_('This nick is not registered to you on this '
'network.'), Raise=True)
irc.error(_('This services account 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>]
"""[<network>] [<bot username>]

Lists nicks of the <user> on the network.
Lists services accounts registered to <bot username> on the network,
or your own bot account if no username is given.
<network> defaults to the current network.
"""
network = network.network or irc.network
Expand All @@ -135,11 +137,11 @@ def list(self, irc, msg, args, network, user):
raise KeyError
except KeyError:
if user == ircdb.users.getUser(msg.prefix):
irc.error(_('You have no recognized nick on this '
'network.'), Raise=True)
irc.error(_('You have no recognized services accounts on '
'this network.'), Raise=True)
else:
irc.error(_('%s has no recognized nick on this '
'network.') % user.name, Raise=True)
irc.error(_('%s has no recognized services accounts on this '
'network.') % user.name, Raise=True)
list = wrap(list, [optional('networkIrc'),
optional('otherUser')])

Expand All @@ -148,7 +150,7 @@ 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
If you get no reply, it means you are not authenticated to
network services."""
nick = ircutils.toLower(msg.nick)
self._requests[(irc.network, msg.nick)] = (time.time(), msg.prefix, irc)
Expand Down Expand Up @@ -183,7 +185,7 @@ def do330(self, irc, msg):
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. '
irc.error(_('No user claimed the account %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.')
Expand Down
2 changes: 1 addition & 1 deletion plugins/NickAuth/test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ def testBotJoin(self):

def testList(self):
self.assertNotError('register foobar 123')
self.assertRegexp('nick list', 'You have no recognized nick')
self.assertRegexp('nick list', 'You have no recognized services accounts')
self.assertNotError('nick add foo')
self.assertRegexp('nick list', 'foo')
self.assertNotError('nick add %s bar' % self.nick)
Expand Down