Fix issue1615201: Added a new configuration option EMAIL_KEEP_REAL_FROM

which makes the mail gateway ignore a Resent-From:-header and use the
real From:-header of the original author for further processing of the
message.  Setting this option to 'yes' restores the original behaviour
of Roundup before the change in version 0.7.0 where the processing of
Resent-From: was added unconditionally.

Author: pefu

CHANGES.txt

@@ -6,10 +6,10 @@ and template changes not listed here.
 Each entry has the developer who committed the change in brackets.
 Entries without name were done by Richard Jones.
 
-**IMPORTANT** The v1.5.x releases of Roundup will be the last to support
-Python v2.5. Support for Python v2.5 will be dropped with the v1.6
-release of Roundup, at which point users will need to run Roundup using
-either Python v2.6 or v2.7.
+**IMPORTANT** The v1.5.x releases of Roundup were the last to support
+Python v2.5. Support for Python v2.5 is dropped starting with the v1.6.x
+releases of Roundup, at which point either Python v2.6 or v2.7 is
+required to run those releases of Roundup.
 
 
 201?-??-??: 1.6.0
@@ -20,7 +20,10 @@ Features:
 
 Fixed
 
-- (none yet)
+- issue1615201: Optionally restore the original (version 0.6) mailgw 
+  behaviour of ignoring a Resent-From:-header and using the real 
+  From-header instead: new configuration option EMAIL_KEEP_REAL_FROM 
+  (Peter Funk aka Pefu).
 
 
 2016-01-11: 1.5.1

doc/user_guide.txt

@@ -549,6 +549,10 @@ the message may be added to the `nosy list`_ depending on:
  creates a new issue. If 'yes', then the recipients will be added on
  followups too. If 'no', they're never added to the nosy.
 
+Some organisations might prefer to have someone moderate emails before
+they are delivered into Roundup.  Those might want to set the 
+configuration option ``EMAIL_KEEP_REAL_FROM`` to ``'yes'`` to avoid
+having the moderators address appearing as the creator of issues.
 
 Nosy List
 ~~~~~~~~~

roundup/configuration.py

@@ -818,7 +818,13 @@ def str2value(self, value):
             "multipart/alternative, and this option is set, all other\n"
             "parts of the multipart/alternative are ignored. The default\n"
             "is to keep all parts and attach them to the issue."),
-    ), "Roundup Mail Gateway options"),
+        (BooleanOption, "keep_real_from", "no",
+            "When handling emails ignore the Resent-From:-header\n"
+            "and use the original senders From:-header instead.\n"
+            "(This might be desirable in some situations where a moderator\n"
+            "reads incoming messages first before bouncing them to Roundup)",
+            ["EMAIL_KEEP_REAL_FROM"]),
+     ), "Roundup Mail Gateway options"),
     ("pgp", (
         (BooleanOption, "enable", "no",
             "Enable PGP processing. Requires pyme. If you're planning\n"

roundup/mailgw.py

@@ -540,8 +540,12 @@ def __init__(self, mailgw, message):
         self.has_prefix = False
         self.matches = dict.fromkeys(['refwd', 'quote', 'classname',
                                  'nodeid', 'title', 'args', 'argswhole'])
-        self.from_list = message.getaddrlist('resent-from') \
-                         or message.getaddrlist('from')
+        self.keep_real_from = self.config['EMAIL_KEEP_REAL_FROM']
+        if self.keep_real_from:
+            self.from_list = message.getaddrlist('from')
+        else:
+            self.from_list = message.getaddrlist('resent-from') \
+                          or message.getaddrlist('from')
         self.pfxmode = self.config['MAILGW_SUBJECT_PREFIX_PARSING']
         self.sfxmode = self.config['MAILGW_SUBJECT_SUFFIX_PARSING']
         # these are filled in by subsequent parsing steps
@@ -1469,7 +1473,7 @@ def handle_Message(self, message):
         self.parsed_message = None
         crypt = False
         sendto = message.getaddrlist('resent-from')
-        if not sendto:
+        if not sendto or self.instance.config['EMAIL_KEEP_REAL_FROM']:
             sendto = message.getaddrlist('from')
         if not sendto:
             # very bad-looking message - we don't even know who sent it

test/test_mailgw.py

@@ -2586,6 +2586,25 @@ def testResentFrom(self):
         self.assertEqual(l, [self.richard_id, self.mary_id])
         return nodeid
 
+    def testResentFromSwitchedOff(self):
+        self.instance.config.EMAIL_KEEP_REAL_FROM = 'yes'
+        nodeid = self._handle_mail('''Content-Type: text/plain;
+  charset="iso-8859-1"
+From: Chef <[email protected]>
+Resent-From: mary <[email protected]>
+To: [email protected]
+Cc: [email protected]
+Message-Id: <dummy_test_message_id>
+Subject: [issue] Testing...
+
+This is a test submission of a new issue.
+''')
+        assert not os.path.exists(SENDMAILDEBUG)
+        l = self.db.issue.get(nodeid, 'nosy')
+        l.sort()
+        self.assertEqual(l, [self.chef_id, self.richard_id])
+        return nodeid
+
     def testDejaVu(self):
         self.assertRaises(IgnoreLoop, self._handle_mail,
             '''Content-Type: text/plain;