Extracted duplicated mail-sending code...

...from mailgw, roundupdb and client.py to the new mailer.py module.

Author: Johannes Gijsbers

roundup/cgi/client.py

@@ -1,4 +1,4 @@
-# $Id: client.py,v 1.135 2003-09-07 22:12:24 richard Exp $
+# $Id: client.py,v 1.136 2003-09-08 09:28:28 jlgijsbers Exp $
 
 __doc__ = """
 WWW request handler (also used in the stand-alone server).
@@ -14,7 +14,8 @@
 from roundup.cgi import cgitb
 from roundup.cgi.PageTemplates import PageTemplate
 from roundup.rfc2822 import encode_header
-from roundup.mailgw import uidFromAddress, openSMTPConnection
+from roundup.mailgw import uidFromAddress
+from roundup.mailer import Mailer, MessageSendError
 
 class HTTPException(Exception):
       pass
@@ -27,10 +28,6 @@ class  Redirect(HTTPException):
 class  NotModified(HTTPException):
        pass
 
-# set to indicate to roundup not to actually _send_ email
-# this var must contain a file to write the mail to
-SENDMAILDEBUG = os.environ.get('SENDMAILDEBUG', '')
-
 # used by a couple of routines
 if hasattr(string, 'ascii_letters'):
     chars = string.ascii_letters+string.digits
@@ -164,6 +161,7 @@ def __init__(self, instance, request, env, form=None):
         self.instance = instance
         self.request = request
         self.env = env
+        self.mailer = Mailer(instance.config)
 
         # save off the path
         self.path = env['PATH_INFO']
@@ -776,7 +774,7 @@ def registerAction(self):
    %(url)s?@action=confrego&otk=%(otk)s
 '''%{'name': props['username'], 'tracker': tracker_name, 'url': self.base,
                 'otk': otk}
-        if not self.sendEmail(props['address'], subject, body):
+        if not self.standard_message(props['address'], subject, body):
             return
 
         # commit changes to the database
@@ -785,49 +783,13 @@ def registerAction(self):
         # redirect to the "you're almost there" page
         raise Redirect, '%suser?@template=rego_progress'%self.base
 
-    def sendEmail(self, to, subject, content):
-        # send email to the user's email address
-        message = StringIO.StringIO()
-        writer = MimeWriter.MimeWriter(message)
-        tracker_name = self.db.config.TRACKER_NAME
-        writer.addheader('Subject', encode_header(subject))
-        writer.addheader('To', to)
-        writer.addheader('From', roundupdb.straddr((tracker_name,
-            self.db.config.ADMIN_EMAIL)))
-        writer.addheader('Date', time.strftime("%a, %d %b %Y %H:%M:%S +0000",
-            time.gmtime()))
-        # add a uniquely Roundup header to help filtering
-        writer.addheader('X-Roundup-Name', tracker_name)
-        # avoid email loops
-        writer.addheader('X-Roundup-Loop', 'hello')
-        writer.addheader('Content-Transfer-Encoding', 'quoted-printable')
-        body = writer.startbody('text/plain; charset=utf-8')
-
-        # message body, encoded quoted-printable
-        content = StringIO.StringIO(content)
-        quopri.encode(content, body, 0)
-
-        if SENDMAILDEBUG:
-            # don't send - just write to a file
-            open(SENDMAILDEBUG, 'a').write('FROM: %s\nTO: %s\n%s\n'%(
-                self.db.config.ADMIN_EMAIL,
-                ', '.join(to),message.getvalue()))
-        else:
-            # now try to send the message
-            try:
-                # send the message as admin so bounces are sent there
-                # instead of to roundup
-                smtp = openSMTPConnection(self.db.config)
-                smtp.sendmail(self.db.config.ADMIN_EMAIL, [to],
-                    message.getvalue())
-            except socket.error, value:
-                self.error_message.append("Error: couldn't send email: "
-                    "mailhost %s"%value)
-                return 0
-            except smtplib.SMTPException, msg:
-                self.error_message.append("Error: couldn't send email: %s"%msg)
-                return 0
-        return 1
+    def standard_message(self, to, subject, body):
+        try:
+            self.mailer.standard_message(to, subject, body)
+            return 1
+        except MessageSendException, e:
+            self.error_message.append(str(e))
+            
 
     def registerPermission(self, props):
         ''' Determine whether the user has permission to register
@@ -917,7 +879,7 @@ def passResetAction(self):
 
 Your password is now: %(password)s
 '''%{'name': name, 'password': newpw}
-            if not self.sendEmail(address, subject, body):
+            if not self.standard_message(address, subject, body):
                 return
 
             self.ok_message.append('Password reset and email sent to %s'%address)
@@ -960,7 +922,7 @@ def passResetAction(self):
 
 You should then receive another email with the new password.
 '''%{'name': name, 'tracker': tracker_name, 'url': self.base, 'otk': otk}
-        if not self.sendEmail(address, subject, body):
+        if not self.standard_message(address, subject, body):
             return
 
         self.ok_message.append('Email sent to %s'%address)

roundup/mailer.py

@@ -0,0 +1,148 @@
+"""Sending Roundup-specific mail over SMTP."""
+# $Id: mailer.py,v 1.1 2003-09-08 09:28:28 jlgijsbers Exp $
+
+import time, quopri, os, socket, smtplib, re
+
+from cStringIO import StringIO
+from MimeWriter import MimeWriter
+
+from roundup.rfc2822 import encode_header
+
+class MessageSendError(RuntimeError):
+    pass
+
+class Mailer:
+    """Roundup-specific mail sending."""
+    def __init__(self, config):
+        self.config = config
+
+        # set to indicate to roundup not to actually _send_ email
+        # this var must contain a file to write the mail to
+        self.debug = os.environ.get('SENDMAILDEBUG', '')
+
+    def get_standard_message(self, to, subject, author=None):
+        if not author:
+            author = straddr((self.config.TRACKER_NAME,
+                              self.config.ADMIN_EMAIL))
+        message = StringIO()
+        writer = MimeWriter(message)
+        writer.addheader('Subject', encode_header(subject))
+        writer.addheader('To', to)
+        writer.addheader('From', author)
+        writer.addheader('Date', time.strftime("%a, %d %b %Y %H:%M:%S +0000",
+                                               time.gmtime()))
+
+        # Add a unique Roundup header to help filtering
+        writer.addheader('X-Roundup-Name', self.config.TRACKER_NAME)
+        # and another one to avoid loops
+        writer.addheader('X-Roundup-Loop', 'hello')
+
+        writer.addheader('MIME-Version', '1.0')       
+        
+        return message, writer
+
+    def standard_message(self, to, subject, content):
+        message, writer = self.get_standard_message(to, subject)
+
+        writer.addheader('Content-Transfer-Encoding', 'quoted-printable')
+        body = writer.startbody('text/plain; charset=utf-8')
+        content = StringIO(content)
+        quopri.encode(content, body, 0)
+
+        self.smtp_send(to, message)
+       
+    def bounce_message(self, bounced_message, to, error,
+                       subject='Failed issue tracker submission'):
+        message, writer = self.get_standard_message(', '.join(to), subject)
+
+        part = writer.startmultipartbody('mixed')
+        part = writer.nextpart()
+        part.addheader('Content-Transfer-Encoding', 'quoted-printable')
+        body = part.startbody('text/plain; charset=utf-8')
+        body.write('\n'.join(error))
+
+        # attach the original message to the returned message
+        part = writer.nextpart()
+        part.addheader('Content-Disposition', 'attachment')
+        part.addheader('Content-Description', 'Message you sent')
+        body = part.startbody('text/plain')
+
+        for header in bounced_message.headers:
+            body.write(header)
+        body.write('\n')
+        try:
+            bounced_message.rewindbody()
+        except IOError, message:
+            body.write("*** couldn't include message body: %s ***"
+                       % bounced_message)
+        else:
+            body.write(bounced_message.fp.read())
+
+        writer.lastpart()
+
+        self.smtp_send(to, message)
+        
+    def smtp_send(self, to, message):
+        if self.debug:
+            # don't send - just write to a file
+            open(self.debug, 'a').write('FROM: %s\nTO: %s\n%s\n' %
+                                        (self.config.ADMIN_EMAIL,
+                                         ', '.join(to),
+                                         message.getvalue()))
+        else:
+            # now try to send the message
+            try:
+                # send the message as admin so bounces are sent there
+                # instead of to roundup
+                smtp = SMTPConnection(self.config)
+                smtp.sendmail(self.config.ADMIN_EMAIL, [to],
+                              message.getvalue())
+            except socket.error, value:
+                raise MessageSendError("Error: couldn't send email: "
+                                       "mailhost %s"%value)
+            except smtplib.SMTPException, msg:
+                raise MessageSendError("Error: couldn't send email: %s"%msg)
+
+class SMTPConnection(smtplib.SMTP):
+    ''' Open an SMTP connection to the mailhost specified in the config
+    '''
+    def __init__(self, config):
+        
+        smtplib.SMTP.__init__(self, config.MAILHOST)
+
+        # use TLS?
+        use_tls = getattr(config, 'MAILHOST_TLS', 'no')
+        if use_tls == 'yes':
+            # do we have key files too?
+            keyfile = getattr(config, 'MAILHOST_TLS_KEYFILE', '')
+            if keyfile:
+                certfile = getattr(config, 'MAILHOST_TLS_CERTFILE', '')
+                if certfile:
+                    args = (keyfile, certfile)
+                else:
+                    args = (keyfile, )
+            else:
+                args = ()
+            # start the TLS
+            self.starttls(*args)
+
+        # ok, now do we also need to log in?
+        mailuser = getattr(config, 'MAILUSER', None)
+        if mailuser:
+            self.login(*config.MAILUSER)
+
+# use the 'email' module, either imported, or our copied version
+try :
+    from email.Utils import formataddr as straddr
+except ImportError :
+    # code taken from the email package 2.4.3
+    def straddr(pair, specialsre = re.compile(r'[][\()<>@,:;".]'),
+            escapesre = re.compile(r'[][\()"]')):
+        name, address = pair
+        if name:
+            quotes = ''
+            if specialsre.search(name):
+                quotes = '"'
+            name = escapesre.sub(r'\\\g<0>', name)
+            return '%s%s%s <%s>' % (quotes, name, quotes, address)
+        return address