issue2109308 add subject argument to nosymessage. Initial patch Frank Niessink. Test and application with slight mods by rouilj

Author: rouilj

CHANGES.txt

@@ -37,6 +37,9 @@ Features:
   errors now include the left hand menu, a proper page title and
   body content. Note added to doc/upgrading.txt on how to add it to
   deployed trackers. (John Rouillard)
+- issue2109308 - Allow subject of nosy messages be changed from reactor
+  Adds a subject parameter to nosymessage function. Patch initally
+  generated by Frank Niessink. Tests, adaptation by John Rouillard.
 
 Fixed:
 

roundup/roundupdb.py

@@ -227,7 +227,8 @@ def addmessage(self, issueid, summary, text):
         """
 
     def nosymessage(self, issueid, msgid, oldvalues, whichnosy='nosy',
-            from_address=None, cc=[], bcc=[], cc_emails = [], bcc_emails = []):
+            from_address=None, cc=[], bcc=[], cc_emails = [],
+            bcc_emails = [], subject=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
@@ -238,6 +239,12 @@ def nosymessage(self, issueid, msgid, oldvalues, whichnosy='nosy',
         If 'msgid' is None, the message gets sent only to the nosy
         list, and it's called a 'System Message'.
 
+        The "subject" argument is used as subject for the message. If no
+        subject is passed, a subject will be generated from the message.
+        Note the subject does not include the item designator [classID]
+        prefix that allows proper processing of reply emails. The caller
+        needs to include that label in the subject if needed.
+
         The "cc" argument indicates additional recipients to send the
         message to that may not be specified in the message's recipients
         list.
@@ -248,12 +255,12 @@ def nosymessage(self, issueid, msgid, oldvalues, whichnosy='nosy',
         address lists. Note that the list of bcc users *is* updated in
         the recipient list of the message, so this field has to be
         protected (using appropriate permissions), otherwise the bcc
-        will be decuceable for users who have web access to the tracker.
+        will be deduceable for users who have web access to the tracker.
 
         The cc_emails and bcc_emails arguments take a list of additional
         recipient email addresses (just the mail address not roundup users)
         this can be useful for sending to additional email addresses
-        which are no roundup users. These arguments are currently not
+        which are not roundup users. These arguments are currently not
         used by roundups nosyreaction but can be used by customized
         (nosy-)reactors.
 
@@ -350,10 +357,10 @@ def good_recipient(userid):
                 self.db.msg.set(msgid, recipients=recipients)
         if sendto['plain'] or bcc_sendto['plain']:
             self.send_message(issueid, msgid, note, sendto['plain'],
-                from_address, bcc_sendto['plain'])
+                              from_address, bcc_sendto['plain'], subject)
         if sendto['crypt'] or bcc_sendto['crypt']:
             self.send_message(issueid, msgid, note, sendto['crypt'],
-                from_address, bcc_sendto['crypt'], crypt=True)
+                from_address, bcc_sendto['crypt'], subject, crypt=True)
 
     # backwards compatibility - don't remove
     sendmessage = nosymessage
@@ -390,7 +397,7 @@ def encrypt_to(self, message, sendto):
         return msg
 
     def send_message(self, issueid, msgid, note, sendto, from_address=None,
-            bcc_sendto=[], crypt=False):
+            bcc_sendto=[], subject=None, crypt=False):
         '''Actually send the nominated message from this issue to the sendto
            recipients, with the note appended.
         '''
@@ -498,7 +505,9 @@ def send_message(self, issueid, msgid, note, sendto, from_address=None,
         if from_tag:
             from_tag = ' ' + from_tag
 
-        subject = '[%s%s] %s'%(cn, issueid, title)
+        if subject is None:
+            subject = '[%s%s] %s'%(cn, issueid, title)
+
         author = (authname + from_tag, from_address)
 
         # send an individual message per recipient?

test/test_mailgw.py

@@ -1407,6 +1407,57 @@ def testPropertyChangeOnly(self):
 """)
 
 
+    def testNosyMessageSettingSubject(self):
+        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, subject="test")
+
+        new_mail = ""
+        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]
+Content-Type: text/plain; charset="utf-8"
+Subject: test
+To: [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]>:
+
+
+----------
+assignedto:  -> Chef
+
+_______________________________________________________________________
+Roundup issue tracker <[email protected]>
+<http://tracker.example/cgi-bin/roundup.cgi/bugs/issue1>
+_______________________________________________________________________
+""")
+
     #
     # FOLLOWUP TITLE MATCH
     #