issue2551018 add new nosy_filter parameter to nosymessage. Function

passed as nosy_filter can rewrite the nosy message body before it's
sent. Tom Ekberg tekberg did the work.

Author: rouilj

CHANGES.txt

@@ -73,6 +73,11 @@ Features:
   action to return the same data as the old export_csv action. (Tom
   Ekberg (tekberg), Andreas (anrounham14) edited/applied and tests
   created by John Rouillard)
+- issue2551018: Add new note_filter parameter to nosymessage. The
+  function supplied by this parameter can rewrite the body of the
+  nosymessage before it gets sent. See issue:
+  https://issues.roundup-tracker.org/issue2551018 for example
+  nosyreaction and generated email. (Tom Ekberg (tekberg))
 
 Fixed:
 

roundup/roundupdb.py

@@ -223,7 +223,8 @@ def addmessage(self, issueid, summary, text):
 
     def nosymessage(self, issueid, msgid, oldvalues, whichnosy='nosy',
             from_address=None, cc=[], bcc=[], cc_emails = [],
-            bcc_emails = [], subject=None ):
+            bcc_emails = [], subject=None,
+            note_filter = None):
         """Send a message to the members of an issue's nosy list.
 
         The message is sent only to users on the nosy list who are not
@@ -264,6 +265,11 @@ def nosymessage(self, issueid, msgid, oldvalues, whichnosy='nosy',
         defined, we try to send encrypted mail to *all* users
         *including* cc, bcc, cc_emails and bcc_emails and this might
         fail if not all the keys are available in roundups keyring.
+
+        If note_filter is specified it is a function with this
+        prototype:
+            note_filter(original_note, issueid, newvalues, oldvalues)
+        If called, note_filter returns the new value for the message body.
         """
         encrypt = self.db.config.PGP_ENABLE and self.db.config.PGP_ENCRYPT
         pgproles = self.db.config.PGP_ROLES
@@ -345,6 +351,10 @@ def good_recipient(userid):
             note = self.generateChangeNote(issueid, oldvalues)
         else:
             note = self.generateCreateNote(issueid)
+        if note_filter:
+            cn = self.classname
+            cl = self.db.classes[cn]
+            note = note_filter(note, issueid, self.db, cl, oldvalues)
 
         # If we have new recipients, update the message's recipients
         # and send the mail.

test/test_mailgw.py

@@ -1852,6 +1852,61 @@ def testNosyMessageCcBccEtc(self):
 ----------
 assignedto:  -> Chef
 
+_______________________________________________________________________
+Roundup issue tracker <[email protected]>
+<http://tracker.example/cgi-bin/roundup.cgi/bugs/issue1>
+_______________________________________________________________________
+""")
+
+
+    def testNosyMessageNoteFilter(self):
+        def note_filter(original_note, issue_id, db, newvalues, oldvalues):
+            return 'This content came from note_filter().'
+        self.doNewIssue()
+        oldvalues = self.db.getnode('issue', '1').copy()
+        oldvalues['assignedto'] = None
+        # reconstruct old behaviour: This would reuse the
+        # database-handle from the doNewIssue above which has committed
+        # as user "Chef". So we close and reopen the db as that user.
+        #self.db.close() actually don't close 'cos this empties memorydb
+        self.db = self.instance.open('Chef')
+        self.db.issue.set('1', assignedto=self.chef_id)
+        self.db.commit()
+        self.db.issue.nosymessage('1', None, oldvalues,
+                                  cc=['3','4', '5'],
+                                  cc_emails=['[email protected]'],
+                                  note_filter=note_filter)
+        new_mail = ""
+        # Message-Id: and Date: change every time - remove them.
+        for line in self._get_mail().split("\n"):
+            if "Message-Id: " in line:
+                continue
+            if "Date: " in line:
+                continue
+            new_mail += line+"\n"
+
+        self.compareMessages(new_mail, """
+FROM: [email protected]
+TO: [email protected], [email protected], [email protected], [email protected]
+Content-Type: text/plain; charset="utf-8"
+Subject: [issue1] Testing...
+To: [email protected], [email protected], [email protected], [email protected]
+From: "Bork, Chef" <[email protected]>
+X-Roundup-Name: Roundup issue tracker
+X-Roundup-Loop: hello
+X-Roundup-Issue-Status: unread
+X-Roundup-Version: 1.3.3
+In-Reply-To: <dummy_test_message_id>
+MIME-Version: 1.0
+Reply-To: Roundup issue tracker
+ <[email protected]>
+Content-Transfer-Encoding: quoted-printable
+
+
+Change by Bork, Chef <[email protected]>:
+
+This content came from note_filter().
+
 _______________________________________________________________________
 Roundup issue tracker <[email protected]>
 <http://tracker.example/cgi-bin/roundup.cgi/bugs/issue1>