Channel & core: Add support for ban descriptions. Closes GH-1092.

This commit is contained in:
Valentin Lorentz 2015-05-15 13:43:26 +02:00
parent 39e0073b8f
commit 6efea561a5
3 changed files with 29 additions and 16 deletions

View File

@ -575,8 +575,8 @@ class Channel(callbacks.Plugin):
hostmask = wrap(hostmask, ['op', ('haveHalfop+', _('ban someone')), 'text']) hostmask = wrap(hostmask, ['op', ('haveHalfop+', _('ban someone')), 'text'])
@internationalizeDocstring @internationalizeDocstring
def add(self, irc, msg, args, channel, banmask, expires): def add(self, irc, msg, args, channel, banmask, expires, description):
"""[<channel>] <nick|hostmask> [<expires>] """[<channel>] <nick|hostmask> [<expires>] [<description>]
If you have the #channel,op capability, this will effect a If you have the #channel,op capability, this will effect a
persistent ban from interacting with the bot on the given persistent ban from interacting with the bot on the given
@ -589,10 +589,11 @@ class Channel(callbacks.Plugin):
channel itself. channel itself.
""" """
c = ircdb.channels.getChannel(channel) c = ircdb.channels.getChannel(channel)
c.addBan(banmask, expires) c.addBan(banmask, expires or 0, description)
ircdb.channels.setChannel(channel, c) ircdb.channels.setChannel(channel, c)
irc.replySuccess() irc.replySuccess()
add = wrap(add, ['op', first('hostmask', 'banmask'), additional('expiry', 0)]) add = wrap(add, ['op', first('hostmask', 'banmask'),
optional('expiry'), optional('text')])
@internationalizeDocstring @internationalizeDocstring
def remove(self, irc, msg, args, channel, banmask): def remove(self, irc, msg, args, channel, banmask):
@ -630,12 +631,16 @@ class Channel(callbacks.Plugin):
if filtered_bans: if filtered_bans:
bans = [] bans = []
for ban in filtered_bans: for ban in filtered_bans:
if all_bans[ban]: (expiration, description) = all_bans[ban]
bans.append(format(_('%q (expires %t)'), if expiration:
ban, all_bans[ban])) bans.append(format(_('%q (%s, expires %t)'),
ban,
description or _('no description'),
expiration))
else: else:
bans.append(format(_('%q (never expires)'), bans.append(format(_('%q (%s, never expires)'),
ban, all_bans[ban])) ban,
description or _('no description')))
irc.reply(format('%L', bans)) irc.reply(format('%L', bans))
else: else:
irc.reply(format(_('There are no persistent bans on %s.'), irc.reply(format(_('There are no persistent bans on %s.'),

View File

@ -234,7 +234,15 @@ class ChannelTestCase(ChannelPluginTestCase):
self.assertRegexp('ban list foobar!*@baz', r'.*foobar!\*@baz.*') self.assertRegexp('ban list foobar!*@baz', r'.*foobar!\*@baz.*')
self.assertRegexp('ban list foobar!*@baz', r'.*foobar!qux@baz.*') self.assertRegexp('ban list foobar!*@baz', r'.*foobar!qux@baz.*')
self.assertResponse('ban list foobar!\*@baz', self.assertResponse('ban list foobar!\*@baz',
'"foobar!*@baz" (never expires)') '"foobar!*@baz" (no description, never expires)')
self.assertNotError('ban add foobarbaz!qux@baz foo')
self.assertResponse('ban list foobarbaz!*@baz',
'"foobarbaz!qux@baz" (foo, never expires)')
self.assertNotError('ban add foobarbazqux!qux@baz 5 bar')
self.assertRegexp('ban list foobarbazqux!*@baz',
r'"foobarbazqux!qux@baz" \(bar, expires [^ ]+\)')
def testIgnore(self): def testIgnore(self):
orig = conf.supybot.protocols.irc.banmask() orig = conf.supybot.protocols.irc.banmask()

View File

@ -389,11 +389,11 @@ class IrcChannel(object):
self.capabilities, self.lobotomized, self.capabilities, self.lobotomized,
self.defaultAllow, self.silences, self.exceptions) self.defaultAllow, self.silences, self.exceptions)
def addBan(self, hostmask, expiration=0): def addBan(self, hostmask, expiration=0, description=None):
"""Adds a ban to the channel banlist.""" """Adds a ban to the channel banlist."""
assert not conf.supybot.protocols.irc.strictRfc() or \ assert not conf.supybot.protocols.irc.strictRfc() or \
ircutils.isUserHostmask(hostmask), 'got %s' % hostmask ircutils.isUserHostmask(hostmask), 'got %s' % hostmask
self.bans[hostmask] = int(expiration) self.bans[hostmask] = (int(expiration), description)
def removeBan(self, hostmask): def removeBan(self, hostmask):
"""Removes a ban from the channel banlist.""" """Removes a ban from the channel banlist."""
@ -405,7 +405,7 @@ class IrcChannel(object):
"""Checks whether a given hostmask is banned by the channel banlist.""" """Checks whether a given hostmask is banned by the channel banlist."""
assert ircutils.isUserHostmask(hostmask), 'got %s' % hostmask assert ircutils.isUserHostmask(hostmask), 'got %s' % hostmask
now = time.time() now = time.time()
for (pattern, expiration) in self.bans.items(): for (pattern, (expiration, description)) in self.bans.items():
if now < expiration or not expiration: if now < expiration or not expiration:
if ircutils.hostmaskPatternEqual(pattern, hostmask): if ircutils.hostmaskPatternEqual(pattern, hostmask):
return True return True
@ -478,9 +478,9 @@ class IrcChannel(object):
for capability in self.capabilities: for capability in self.capabilities:
write('capability ' + capability) write('capability ' + capability)
bans = self.bans.items() bans = self.bans.items()
utils.sortBy(operator.itemgetter(1), bans) utils.sortBy(lambda x:x[1][0], bans)
for (ban, expiration) in bans: for (ban, (expiration, description)) in bans:
write('ban %s %d' % (ban, expiration)) write('ban %s %d %s' % (ban, expiration, description))
ignores = self.ignores.items() ignores = self.ignores.items()
utils.sortBy(operator.itemgetter(1), ignores) utils.sortBy(operator.itemgetter(1), ignores)
for (ignore, expiration) in ignores: for (ignore, expiration) in ignores: