X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=roundup%2Fmailgw.py;h=f45eedc9d51af4e3e6e0a88259c054676215dcdb;hb=d53f951d3021166e7f3bebc037708accdecb7ff5;hp=468333ec42bd4eca5deb6d89bb1ae0cb12f1aea4;hpb=02f4dc6224081ba4ed4c34618ed5e365c054ad0a;p=roundup.git diff --git a/roundup/mailgw.py b/roundup/mailgw.py index 468333e..f45eedc 100644 --- a/roundup/mailgw.py +++ b/roundup/mailgw.py @@ -16,8 +16,7 @@ # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. # -""" -An e-mail gateway for Roundup. +"""An e-mail gateway for Roundup. Incoming messages are examined for multiple parts: . In a multipart/mixed message or part, each subpart is extracted and @@ -73,8 +72,9 @@ are calling the create() method to create a new node). If an auditor raises an exception, the original message is bounced back to the sender with the explanatory message given in the exception. -$Id: mailgw.py,v 1.139 2003-12-04 23:34:25 richard Exp $ +$Id: mailgw.py,v 1.143 2004-02-11 23:55:08 richard Exp $ """ +__docformat__ = 'restructuredtext' import string, re, os, mimetools, cStringIO, smtplib, socket, binascii, quopri import time, random, sys @@ -145,7 +145,7 @@ class Message(mimetools.Message): ''' subclass mimetools.Message so we can retrieve the parts of the message... ''' - def getPart(self): + def getpart(self): ''' Get a single part of a multipart message and return it as a new Message instance. ''' @@ -164,12 +164,136 @@ class Message(mimetools.Message): s.seek(0) return Message(s) + def getparts(self): + """Get all parts of this multipart message.""" + # skip over the intro to the first boundary + self.getpart() + + # accumulate the other parts + parts = [] + while 1: + part = self.getpart() + if part is None: + break + parts.append(part) + return parts + def getheader(self, name, default=None): hdr = mimetools.Message.getheader(self, name, default) if hdr: hdr = hdr.replace('\n','') # Inserted by rfc822.readheaders return rfc2822.decode_header(hdr) - + + def getname(self): + """Find an appropriate name for this message.""" + if self.gettype() == 'message/rfc822': + # handle message/rfc822 specially - the name should be + # the subject of the actual e-mail embedded here + self.fp.seek(0) + name = Message(self.fp).getheader('subject') + else: + # try name on Content-Type + name = self.getparam('name') + if not name: + disp = self.getheader('content-disposition', None) + if disp: + name = getparam(disp, 'filename') + + if name: + return name.strip() + + def getbody(self): + """Get the decoded message body.""" + self.rewindbody() + encoding = self.getencoding() + data = None + if encoding == 'base64': + # BUG: is base64 really used for text encoding or + # are we inserting zip files here. + data = binascii.a2b_base64(self.fp.read()) + elif encoding == 'quoted-printable': + # the quopri module wants to work with files + decoded = cStringIO.StringIO() + quopri.decode(self.fp, decoded) + data = decoded.getvalue() + elif encoding == 'uuencoded': + data = binascii.a2b_uu(self.fp.read()) + else: + # take it as text + data = self.fp.read() + + # Encode message to unicode + charset = rfc2822.unaliasCharset(self.getparam("charset")) + if charset: + # Do conversion only if charset specified + edata = unicode(data, charset).encode('utf-8') + # Convert from dos eol to unix + edata = edata.replace('\r\n', '\n') + else: + # Leave message content as is + edata = data + + return edata + + # General multipart handling: + # Take the first text/plain part, anything else is considered an + # attachment. + # multipart/mixed: multiple "unrelated" parts. + # multipart/signed (rfc 1847): + # The control information is carried in the second of the two + # required body parts. + # ACTION: Default, so if content is text/plain we get it. + # multipart/encrypted (rfc 1847): + # The control information is carried in the first of the two + # required body parts. + # ACTION: Not handleable as the content is encrypted. + # multipart/related (rfc 1872, 2112, 2387): + # The Multipart/Related content-type addresses the MIME + # representation of compound objects. + # ACTION: Default. If we are lucky there is a text/plain. + # TODO: One should use the start part and look for an Alternative + # that is text/plain. + # multipart/Alternative (rfc 1872, 1892): + # only in "related" ? + # multipart/report (rfc 1892): + # e.g. mail system delivery status reports. + # ACTION: Default. Could be ignored or used for Delivery Notification + # flagging. + # multipart/form-data: + # For web forms only. + + def extract_content(self, parent_type=None): + """Extract the body and the attachments recursively.""" + content_type = self.gettype() + content = None + attachments = [] + + if content_type == 'text/plain': + content = self.getbody() + elif content_type[:10] == 'multipart/': + for part in self.getparts(): + new_content, new_attach = part.extract_content(content_type) + + # If we haven't found a text/plain part yet, take this one, + # otherwise make it an attachment. + if not content: + content = new_content + elif new_content: + attachments.append(part.as_attachment()) + + attachments.extend(new_attach) + elif (parent_type == 'multipart/signed' and + content_type == 'application/pgp-signature'): + # ignore it so it won't be saved as an attachment + pass + else: + attachments.append(self.as_attachment()) + return content, attachments + + def as_attachment(self): + """Return this message as an attachment.""" + return (self.getname(), self.gettype(), self.getbody()) + class MailGW: # Matches subjects like: @@ -253,7 +377,7 @@ class MailGW: import getpass, poplib, socket try: if not user: - user = raw_input(_('User: ')) + user = raw_input('User: ') if not password: password = getpass.getpass() except (KeyboardInterrupt, EOFError): @@ -371,37 +495,6 @@ class MailGW: m.append(s.getvalue()) self.mailer.bounce_message(message, sendto, m) - def get_part_data_decoded(self,part): - encoding = part.getencoding() - data = None - if encoding == 'base64': - # BUG: is base64 really used for text encoding or - # are we inserting zip files here. - data = binascii.a2b_base64(part.fp.read()) - elif encoding == 'quoted-printable': - # the quopri module wants to work with files - decoded = cStringIO.StringIO() - quopri.decode(part.fp, decoded) - data = decoded.getvalue() - elif encoding == 'uuencoded': - data = binascii.a2b_uu(part.fp.read()) - else: - # take it as text - data = part.fp.read() - - # Encode message to unicode - charset = rfc2822.unaliasCharset(part.getparam("charset")) - if charset: - # Do conversion only if charset specified - edata = unicode(data, charset).encode('utf-8') - # Convert from dos eol to unix - edata = edata.replace('\r\n', '\n') - else: - # Leave message content as is - edata = data - - return edata - def handle_message(self, message): ''' message - a Message instance @@ -661,7 +754,7 @@ Unknown address: %s errors, props = setPropArrayFromString(self, cl, args, nodeid) # handle any errors parsing the argument list if errors: - errors = '\n- '.join(errors) + errors = '\n- '.join(map(str, errors)) raise MailUsageError, ''' There were problems handling your subject line argument list: - %s @@ -684,118 +777,13 @@ Subject was: "%s" messageid = "<%s.%s.%s%s@%s>"%(time.time(), random.random(), classname, nodeid, self.instance.config.MAIL_DOMAIN) - # # now handle the body - find the message - # - content_type = message.gettype() - attachments = [] - # General multipart handling: - # Take the first text/plain part, anything else is considered an - # attachment. - # multipart/mixed: multiple "unrelated" parts. - # multipart/signed (rfc 1847): - # The control information is carried in the second of the two - # required body parts. - # ACTION: Default, so if content is text/plain we get it. - # multipart/encrypted (rfc 1847): - # The control information is carried in the first of the two - # required body parts. - # ACTION: Not handleable as the content is encrypted. - # multipart/related (rfc 1872, 2112, 2387): - # The Multipart/Related content-type addresses the MIME - # representation of compound objects. - # ACTION: Default. If we are lucky there is a text/plain. - # TODO: One should use the start part and look for an Alternative - # that is text/plain. - # multipart/Alternative (rfc 1872, 1892): - # only in "related" ? - # multipart/report (rfc 1892): - # e.g. mail system delivery status reports. - # ACTION: Default. Could be ignored or used for Delivery Notification - # flagging. - # multipart/form-data: - # For web forms only. - if content_type == 'multipart/mixed': - # skip over the intro to the first boundary - part = message.getPart() - content = None - while 1: - # get the next part - part = message.getPart() - if part is None: - break - # parse it - subtype = part.gettype() - if subtype == 'text/plain' and not content: - # The first text/plain part is the message content. - content = self.get_part_data_decoded(part) - elif subtype == 'message/rfc822': - # handle message/rfc822 specially - the name should be - # the subject of the actual e-mail embedded here - i = part.fp.tell() - mailmess = Message(part.fp) - name = mailmess.getheader('subject') - part.fp.seek(i) - attachments.append((name, 'message/rfc822', part.fp.read())) - elif subtype == 'multipart/alternative': - # Search for text/plain in message with attachment and - # alternative text representation - # skip over intro to first boundary - part.getPart() - while 1: - # get the next part - subpart = part.getPart() - if subpart is None: - break - # parse it - if subpart.gettype() == 'text/plain' and not content: - content = self.get_part_data_decoded(subpart) - else: - # try name on Content-Type - name = part.getparam('name') - if name: - name = name.strip() - if not name: - disp = part.getheader('content-disposition', None) - if disp: - name = getparam(disp, 'filename') - if name: - name = name.strip() - # this is just an attachment - data = self.get_part_data_decoded(part) - attachments.append((name, part.gettype(), data)) - if content is None: - raise MailUsageError, ''' -Roundup requires the submission to be plain text. The message parser could -not find a text/plain part to use. -''' - - elif content_type[:10] == 'multipart/': - # skip over the intro to the first boundary - message.getPart() - content = None - while 1: - # get the next part - part = message.getPart() - if part is None: - break - # parse it - if part.gettype() == 'text/plain' and not content: - content = self.get_part_data_decoded(part) - if content is None: - raise MailUsageError, ''' -Roundup requires the submission to be plain text. The message parser could -not find a text/plain part to use. -''' - - elif content_type != 'text/plain': + content, attachments = message.extract_content() + if content is None: raise MailUsageError, ''' Roundup requires the submission to be plain text. The message parser could not find a text/plain part to use. ''' - - else: - content = self.get_part_data_decoded(message) # figure how much we should muck around with the email body keep_citations = getattr(self.instance.config, 'EMAIL_KEEP_QUOTED_TEXT',