Changeset 633

Timestamp:

08/06/13 16:02:40 (10 years ago)

Author:

bas

Message:

rewrote notification system for email2trac: see #266, #297

I have defined my own TicketNotifyEmail? class: Email2TracNotifyEmail. Now it easy to implemenent:

• notify_reporter
• notify_replyto_rewrite

notify_replyto_rewrite can handle 2 formats for email2trac.conf

• use_mail_domain:email2trac.surfsara.nl
  • the replyto field will be set to <ticket_id>@email2trac.surfsara.nl
• use_trac_smtp_replyto:+
  • Will use the setting in trac.ini for smtp_replto and use '+' as recipient delimiter eg: smtp_replyto: email2trac@… then reply_to will be: email2trac+<ticket_id>@surfsara.nl

File:

• trunk/email2trac.py.in (modified) (10 diffs)

trunk/email2trac.py.in

@@ -75 +75 @@
 m = None 
 
-# This is to for the function AlwaysNotifyReporter
-sender_email = None
-
-# This is to for the function set_reply_to_fiedl
-REPLY_TO_ADDRESS = None
-
-
-
 class SaraDict(UserDict.UserDict):
     def __init__(self, dictin = None):
@@ -128 +120 @@
     def __iter__(self):
         return iter(self.data.keys())
+
+
 
 class TicketEmailParser(object):
@@ -2416 +2410 @@
         self.logger.debug('function notify()')
 
-        if self.parameters.notify_reporter:
-            self.logger.debug('\t Notify reporter set')
-            global sender_email
-            sender_email = self.email_addr
- 
-            self.logger.debug('\t Using Email2TracNotification function AlwaysNotifyReporter')
-            import trac.notification as Email2TracNotification
-            Email2TracNotification.Notify.notify = AlwaysNotifyReporter
-
+
+        #if self.parameters.notification_replyto_rewrite:
+        #    global REPLY_TO_ADDRESS
+        #    dummy = self.smtp_replyto.split('@')
+            
+        #    if len(dummy) > 1:
+        #        REPLY_TO_ADDRESS = '%s+%s@%s' %(dummy[0], self.id, dummy[1])
+        #    else:
+        #        REPLY_TO_ADDRESS = '%s+%s' %(dummy[0], self.id)
+
+        #    import trac.notification as Email2TracNotification
+        #    Email2TracNotification.Notify.notify = set_reply_to_field
+
+        class Email2TracNotifyEmail(TicketNotifyEmail):
+
+            def __init__(self, env): 
+                TicketNotifyEmail.__init__(self, env)
+                self.email2trac_notify_reporter = None
+                self.email2trac_replyto = None
+
+            def send(self, torcpts, ccrcpts):
+                #print 'Yes this works'
+                dest = self.reporter or 'anonymous'
+                hdrs = {}
+                hdrs['Message-ID'] = self.get_message_id(dest, self.modtime)
+                hdrs['X-Trac-Ticket-ID'] = str(self.ticket.id)
+                hdrs['X-Trac-Ticket-URL'] = self.data['ticket']['link']
+                if not self.newticket:
+                    msgid = self.get_message_id(dest)
+                    hdrs['In-Reply-To'] = msgid
+                    hdrs['References'] = msgid
+
+
+                if self.email2trac_notify_reporter:
+                    if not self.email2trac_notify_reporter in torcpts:
+                        torcpts.append(sender_email)
+
+                if self.email2trac_replyto:
+                    # use to rewrite reply to
+                    # hdrs does not work, multiple reply addresses
+                    #hdrs['Reply-To'] = 'bas.van.der.vlies@gmail.com'
+                    self.replyto_email = self.email2trac_replyto
         
-        if self.parameters.notification_replyto_rewrite:
-            global REPLY_TO_ADDRESS
-            dummy = self.smtp_replyto.split('@')
-            
-            if len(dummy) > 1:
-                REPLY_TO_ADDRESS = '%s+%s@%s' %(dummy[0], self.id, dummy[1])
-            else:
-                REPLY_TO_ADDRESS = '%s+%s' %(dummy[0], self.id)
-
-            import trac.notification as Email2TracNotification
-            Email2TracNotification.Notify.notify = set_reply_to_field
+                NotifyEmail.send(self, torcpts, ccrcpts, hdrs)
 
         if self.parameters.dry_run  :
@@ -2443 +2460 @@
         try:
 
-            #from trac.ticket.notification import TicketNotificationSystem
-            #tn_sys = TicketNotificationSystem(self.env)
-            #print tn_sys
-            #print tn_sys.__dict__
-            #sys.exit(0)
-
             ## create false {abs_}href properties, to trick Notify()
             #
@@ -2455 +2466 @@
                 self.env.href = Href(self.get_config('project', 'url'))
 
-            tn = TicketNotifyEmail(self.env)
+            tn = Email2TracNotifyEmail(self.env)
+
+            ## additionally append sender (regardeless of settings in trac.ini)
+            # 
+            if self.parameters.notify_reporter: 
+
+                self.logger.debug('\t Notify reporter set')
+
+                if not self.email_header_acl('notify_reporter_black_list', self.email_addr, False):
+                    tn.email2trac_notify_reporter = self.email_addr
+
+            if self.parameters.notify_replyto_rewrite: 
+
+                self.logger.debug('\t Notify replyto rewrite set')
+
+                action, value = self.parameters.notify_replyto_rewrite.split(':')
+
+                if action in ['use_mail_domain']:
+                    self.logger.debug('\t\t use_mail_domain:%s'i %value)
+                    tn.email2trac_replyto = '%s@%s' %(self.id, value)
+
+                elif action in ['use_trac_smtp_replyto']:
+                    self.logger.debug('\t\t use_trac_smtp_replyto delimiter:%s'i %value)
+                    dummy = self.smtp_replyto.split('@')
+                    if len(dummy) > 1:
+                        tn.email2trac_replyto = '%s%s%s@%s' %(dummy[0], value, self.id, dummy[1])
+                    else:
+                        tn.email2trac_replyto = '%s%s%s' %(dummy[0], value, self.id)
 
             if self.parameters.alternate_notify_template:
@@ -2481 +2519 @@
 ########## END Class Definition  ########################################################
 
-########## Global Notificaition Function ################################################
-def AlwaysNotifyReporter(self, resid):
-    """
-    Copy of def notify() to manipulate recipents to always include reporter for the
-    notification.
-    """
-    #print sender_email, resid
-    (torcpts, ccrcpts) = self.get_recipients(resid)
-    #print "get_recipients finished"
-
-    if not tktparser.email_header_acl('notify_reporter_black_list', sender_email, False):
-        ## additionally append sender (regardeless of settings in trac.ini)
-        # 
-        if not sender_email in torcpts:
-            torcpts.append(sender_email)
-
-    #self.replyto_email = "bas.van.der.vlies@gmail.com"
-
-    self.begin_send()
-    self.send(torcpts, ccrcpts)
-    self.finish_send()
-
-def set_reply_to_field(self, resid):
-    """
-    Copy of def notify() to manipulate recipents to always include reporter for the
-    notification.
-    """
-    print sender_email, resid, REPLY_TO_ADDRESS
-    (torcpts, ccrcpts) = self.get_recipients(resid)
-    
-    self.replyto_email = '%s' %(REPLY_TO_ADDRESS)
-    print self.replyto_email
-
-    self.begin_send()
-    self.send(torcpts, ccrcpts)
-    self.finish_send()
 
 ########## Parse Config File  ###########################################################
@@ -2653 +2655 @@
     return logger
 
+########## Own TicketNotifyEmail class ###############################################################
 
 if __name__ == '__main__':
@@ -2763 +2766 @@
             from trac.core import TracError
 
-        elif version in ['0.11', '0.12', '0.13', '1.0']:
+        elif version in ['0.11', '0.12', '0.13', '1.0', '1.1']:
             from trac import attachment 
             from trac import config as trac_config
@@ -2795 +2798 @@
             # see http://projects.edgewall.com/trac/changeset/2799
             from trac.ticket.notification import TicketNotifyEmail
+            from trac.notification import NotifyEmail
 
         else:
@@ -2833 +2837 @@
 
         sys.exit(1)
+
 # EOB