Fix date strings in ban reason parsed as duration (#41)

getTs treated a token as a duration whenever a duration substring
appeared anywhere inside it. A reason word like 'username5d' was read
as 5 days, added to the expiry, and dropped from the stored reason.

Require the whole token to be duration units (re.fullmatch) so only
genuine duration words (4w, 2h, 1w2d3h) are consumed; any other word
falls through to the reason via rest('text').

Author: ncoevoet-enreach

plugin.py

@@ -1406,8 +1406,13 @@ def isRe(s):
 
 # Taken from plugins.Time.seconds
 _SECONDS_RE = re.compile(r'-?[0-9]+[ywdhms]')
+# A duration argument must consist *only* of duration tokens, so a reason
+# word like "username5d" is not mistaken for "5 days" (issue #41).
+_DURATION_RE = re.compile(r'(?:-?[0-9]+[ywdhms])+')
 def getTs(irc, msg, args, state):
     seconds = None
+    if not args or _DURATION_RE.fullmatch(args[0]) is None:
+        raise callbacks.ArgumentError
     secs = _SECONDS_RE.findall(args[0])
     for sec in secs:
         (i, kind) = int(sec[:-1]), sec[-1]

test.py

@@ -30,6 +30,7 @@
 from supybot.test import *
 
 import time
+import supybot.callbacks as callbacks
 import supybot.conf as conf
 import supybot.ircmsgs as ircmsgs
 
@@ -229,6 +230,40 @@ def testGetDuration(self):
         self.assertEqual(plugin.getDuration([60, 30, 10]), 100)
         self.assertEqual(plugin.getDuration([3600]), 3600)
 
+    def testGetTs(self):
+        # getTs is the duration converter: it reads/mutates the args list and
+        # appends to state.args; its irc/msg params are unused (issue #41)
+        class _State:
+            def __init__(self):
+                self.args = []
+        # a bare duration word parses and is consumed
+        st = _State(); args = ['4w']
+        plugin.getTs(None, None, args, st)
+        self.assertEqual(st.args, [4 * 604800.0])
+        self.assertEqual(args, [], 'a consumed duration word is removed')
+        # a compound word "1w2d3h" sums its parts
+        st = _State(); args = ['1w2d3h']
+        plugin.getTs(None, None, args, st)
+        self.assertEqual(st.args, [float(604800 + 2 * 86400 + 3 * 3600)])
+        # a multi-word duration "4d 2h ...": getTs is called once per word,
+        # each whole word is a valid duration, so both are accepted
+        st = _State(); args = ['4d', '2h', 'ban', 'evading']
+        plugin.getTs(None, None, args, st)
+        plugin.getTs(None, None, args, st)
+        self.assertEqual(st.args, [4 * 86400.0, 2 * 3600.0])
+        self.assertEqual(args, ['ban', 'evading'],
+                         'words after the duration are left for the reason')
+        # issue #41: a date string inside a word is NOT a duration
+        st = _State(); args = ['username5d', 'ban', 'evading']
+        self.assertRaises(callbacks.ArgumentError,
+                          plugin.getTs, None, None, args, st)
+        self.assertEqual(args, ['username5d', 'ban', 'evading'],
+                         'a rejected word is left in place for the reason')
+        # a plain word is rejected
+        st = _State(); args = ['evading']
+        self.assertRaises(callbacks.ArgumentError,
+                          plugin.getTs, None, None, args, st)
+
     def testClearExtendedBanPattern(self):
         # extban support is read from irc.state.supported (prefix,modes)
         self.irc.state.supported['extban'] = '$,ajrxz'