issue2551262 - make mail gateway subject prefix parsing accept spaces

Allow spaces before/after prefix. Also allow spaces between classname
and id number in prefix designator. So "[ issue 23 ] subject" is
parsed like "[issue23] subject".

Author: rouilj

CHANGES.txt

@@ -110,6 +110,10 @@ Features:
 - issue2551253 - new password hash PBDKF2-SHA512 added. Not available
   by default. See issue ticket for details.
 - roundup-admin migrate command reports the schema version.
+- issue2551262 - the mail gateway subject prefix now allows spaces
+  before/after prefix. Also allow spaces between classname and id
+  number in prefix designator. So "[ issue 23   ] subject" is parsed
+  like "[issue23] subject".
 
 2022-07-13 2.2.0
 

doc/user_guide.txt

@@ -454,9 +454,11 @@ If a one-time key is found, we're processing an in-progress
 registration confirmation.
 
 If the subject line contains a prefix in ``[square brackets]`` then
-we're looking at case 3 or 4 above. Any "re:" or "fwd:" prefixes are
-stripped off the subject line before we start looking for real
-information.
+we're looking at case 3 or 4 above. Spaces are allowed inside the
+brackets and after the class item name. So ``[issue2]`` and
+``[ issue 2 ]`` are treted the same where any whitespace is optional.
+Any "re:" or "fwd:" prefixes are stripped off the subject line before
+we start looking for real information.
 
 If an item designator (class name and id number, for example
 ``issue123``) is found there, a new "msg" item is added to the
@@ -492,15 +494,15 @@ For example,
 
 - adding yourself to a nosy list::
 
-   Subject: Re: [issue2] we're out of widgets [nosy=+richard]
+   Subject: Re: [ issue2 ] we're out of widgets [nosy=+richard]
 
 - setting the nosy list to just you and cliff::
 
-   Subject: Re: [issue2] we're out of widgets [nosy=richard,cliff]
+   Subject: Re: [issue 2] we're out of widgets [nosy=richard,cliff]
 
 - removing yourself from a nosy list and setting the priority::
 
-   Subject: Re: [issue2] we're out of widgets [nosy=-richard;priority=bug]
+   Subject: Re: [ issue 2 ] we're out of widgets [nosy=-richard;priority=bug]
 
 In all cases, the message relates to issue 2. The ``Re:`` prefix is
 stripped off.

roundup/mailgw.py

@@ -636,12 +636,12 @@ def parse_subject(self):
             tmpsubject = tmpsubject[len(self.matches['quote']):]
 
         # Check if the subject includes a prefix
-        self.has_prefix = re.search(r'^%s(\w+)%s' % (delim_open,
+        self.has_prefix = re.search(r'^%s\s*(\w+)\s*%s' % (delim_open,
                                                      delim_close),
                                     tmpsubject.strip())
 
         # Match the classname if specified
-        class_re = r'%s(?P<classname>(%s))(?P<nodeid>\d+)?%s' %  \
+        class_re = r'%s\s*(?P<classname>(%s))\s*(?P<nodeid>\d+)?\s*%s' %  \
                    (delim_open, "|".join(self.db.getclasses()),
                     delim_close)
         # Note: re.search, not re.match as there might be garbage

test/test_mailgw.py

@@ -4290,6 +4290,21 @@ def testMaillistSubject(self):
         assert not os.path.exists(SENDMAILDEBUG)
         self.assertEqual(self.db.keyword.get('1', 'name'), 'Bar')
 
+    def testSpacedPrefixSubject(self):
+        self.db.keyword.create(name='Foo')
+        self._handle_mail('''Content-Type: text/plain;
+  charset="iso-8859-1"
+From: Chef <[email protected]>
+To: [email protected]
+Subject: VeryStrangeRe: [  keyword  1  ] Testing.. [name=Bar]
+Cc: [email protected]
+Reply-To: [email protected]
+Message-Id: <dummy_test_message_id>
+
+''')
+        assert not os.path.exists(SENDMAILDEBUG)
+        self.assertEqual(self.db.keyword.get('1', 'name'), 'Bar')
+
     def testUnknownPrefixSubject(self):
         self.db.keyword.create(name='Foo')
         self._handle_mail('''Content-Type: text/plain;