![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/roundup/mailgw.py b/roundup/mailgw.py
index a1c21ac82da78bfa4ec7dc39131ee57f315baea9..7818d21b8652e940080963638ccd113d20d750c9 100644 (file)
--- a/roundup/mailgw.py
+++ b/roundup/mailgw.py
+# -*- coding: utf-8 -*-
#
# Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/)
# This module is free software, and you may redistribute it and/or modify
# SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
#
-__doc__ = '''
-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
examined. The text/plain subparts are assembled to form the textual
body of the message, to be stored in the file associated with a "msg"
class node. Any parts of other types are each stored in separate files
- and given "file" class nodes that are linked to the "msg" node.
+ and given "file" class nodes that are linked to the "msg" node.
. In a multipart/alternative message or part, we look for a text/plain
subpart and ignore the other parts.
+ . A message/rfc822 is treated similar tomultipart/mixed (except for
+ special handling of the first text part) if unpack_rfc822 is set in
+ the mailgw config section.
Summary
-------
section in the message body. The message body is divided into sections by
blank lines. Sections where the second and all subsequent lines begin with
a ">" or "|" character are considered "quoting sections". The first line of
-the first non-quoting section becomes the summary of the message.
+the first non-quoting section becomes the summary of the message.
Addresses
---------
address. (The web interface does not permit logins for users with no
passwords.) If we prefer to reject mail from outside sources, we can simply
register an auditor on the "user" class that prevents the creation of user
-nodes with no passwords.
+nodes with no passwords.
Actions
-------
The subject line of the incoming message is examined to determine whether
the message is an attempt to create a new item or to discuss an existing
item. A designator enclosed in square brackets is sought as the first thing
-on the subject line (after skipping any "Fwd:" or "Re:" prefixes).
+on the subject line (after skipping any "Fwd:" or "Re:" prefixes).
If an item designator (class name and id number) is found there, the newly
created "msg" node is added to the "messages" property for that item, and
-any new "file" nodes are added to the "files" property for the item.
+any new "file" nodes are added to the "files" property for the item.
If just an item class name is found there, we attempt to create a new item
of that class with its "messages" property initialized to contain the new
"msg" node and its "files" property initialized to contain any new "file"
-nodes.
+nodes.
Triggers
--------
set() method to add the message to the item's spool; in the second case we
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.79 2002-07-26 08:26:59 richard Exp $
-'''
+explanatory message given in the exception.
+$Id: mailgw.py,v 1.196 2008-07-23 03:04:44 richard Exp $
+"""
+__docformat__ = 'restructuredtext'
import string, re, os, mimetools, cStringIO, smtplib, socket, binascii, quopri
-import time, random
-import traceback, MimeWriter
-import hyperdb, date, password
+import time, random, sys, logging
+import traceback, rfc822
+
+from email.Header import decode_header
+
+from roundup import configuration, hyperdb, date, password, rfc2822, exceptions
+from roundup.mailer import Mailer, MessageSendError
+from roundup.i18n import _
+from roundup.hyperdb import iter_roles
+
+try:
+ import pyme, pyme.core, pyme.constants, pyme.constants.sigsum
+except ImportError:
+ pyme = None
SENDMAILDEBUG = os.environ.get('SENDMAILDEBUG', '')
pass
class MailUsageHelp(Exception):
+ """ We need to send the help message to the user. """
pass
class Unauthorized(Exception):
""" Access denied """
+ pass
+
+class IgnoreMessage(Exception):
+ """ A general class of message that we should ignore. """
+ pass
+class IgnoreBulk(IgnoreMessage):
+ """ This is email from a mailing list or from a vacation program. """
+ pass
+class IgnoreLoop(IgnoreMessage):
+ """ We've seen this message before... """
+ pass
def initialiseSecurity(security):
''' Create some Permissions and Roles on the security object
This function is directly invoked by security.Security.__init__()
as a part of the Security object instantiation.
'''
- newid = security.addPermission(name="Email Registration",
- description="Anonymous may register through e-mail")
+ p = security.addPermission(name="Email Access",
+ description="User may use the email interface")
+ security.addPermissionToRole('Admin', p)
+
+def getparam(str, param):
+ ''' From the rfc822 "header" string, extract "param" if it appears.
+ '''
+ if ';' not in str:
+ return None
+ str = str[str.index(';'):]
+ while str[:1] == ';':
+ str = str[1:]
+ if ';' in str:
+ # XXX Should parse quotes!
+ end = str.index(';')
+ else:
+ end = len(str)
+ f = str[:end]
+ if '=' in f:
+ i = f.index('=')
+ if f[:i].strip().lower() == param:
+ return rfc822.unquote(f[i+1:].strip())
+ return None
+
+def gpgh_key_getall(key, attr):
+ ''' return list of given attribute for all uids in
+ a key
+ '''
+ for u in key.uids:
+ yield getattr(u, attr)
+
+def check_pgp_sigs(sigs, gpgctx, author, may_be_unsigned=False):
+ ''' Theoretically a PGP message can have several signatures. GPGME
+ returns status on all signatures in a list. Walk that list
+ looking for the author's signature. Note that even if incoming
+ signatures are not required, the processing fails if there is an
+ invalid signature.
+ '''
+ for sig in sigs:
+ key = gpgctx.get_key(sig.fpr, False)
+ # we really only care about the signature of the user who
+ # submitted the email
+ if key and (author in gpgh_key_getall(key, 'email')):
+ if sig.summary & pyme.constants.sigsum.VALID:
+ return True
+ else:
+ # try to narrow down the actual problem to give a more useful
+ # message in our bounce
+ if sig.summary & pyme.constants.sigsum.KEY_MISSING:
+ raise MailUsageError, \
+ _("Message signed with unknown key: %s") % sig.fpr
+ elif sig.summary & pyme.constants.sigsum.KEY_EXPIRED:
+ raise MailUsageError, \
+ _("Message signed with an expired key: %s") % sig.fpr
+ elif sig.summary & pyme.constants.sigsum.KEY_REVOKED:
+ raise MailUsageError, \
+ _("Message signed with a revoked key: %s") % sig.fpr
+ else:
+ raise MailUsageError, \
+ _("Invalid PGP signature detected.")
+
+ # we couldn't find a key belonging to the author of the email
+ if sigs:
+ raise MailUsageError, _("Message signed with unknown key: %s") % sig.fpr
+ elif not may_be_unsigned:
+ raise MailUsageError, _("Unsigned Message")
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.
'''
if not line:
break
if line.strip() in (mid, end):
+ # according to rfc 1431 the preceding line ending is part of
+ # the boundary so we need to strip that
+ length = s.tell()
+ s.seek(-2, 1)
+ lineending = s.read(2)
+ if lineending == '\r\n':
+ s.truncate(length - 2)
+ elif lineending[1] in ('\r', '\n'):
+ s.truncate(length - 1)
+ else:
+ raise ValueError('Unknown line ending in message.')
break
s.write(line)
if not s.getvalue().strip():
s.seek(0)
return Message(s)
-subject_re = re.compile(r'(?P<refwd>\s*\W?\s*(fwd|re|aw)\s*\W?\s*)*'
- r'\s*(\[(?P<classname>[^\d\s]+)(?P<nodeid>\d+)?\])?'
- r'\s*(?P<title>[^[]+)?(\[(?P<args>.+?)\])?', re.I)
-
-class MailGW:
- def __init__(self, instance, db):
- self.instance = instance
- self.db = db
-
- # should we trap exceptions (normal usage) or pass them through
- # (for testing)
- self.trapExceptions = 1
+ def getparts(self):
+ """Get all parts of this multipart message."""
+ # skip over the intro to the first boundary
+ self.fp.seek(0)
+ self.getpart()
- def main(self, fp):
- ''' fp - the file from which to read the Message.
- '''
- return self.handle_Message(Message(fp))
-
- def handle_Message(self, message):
- '''Handle an RFC822 Message
-
- Handle the Message object by calling handle_message() and then cope
- with any errors raised by handle_message.
- This method's job is to make that call and handle any
- errors in a sane manner. It should be replaced if you wish to
- handle errors in a different manner.
- '''
- # in some rare cases, a particularly stuffed-up e-mail will make
- # its way into here... try to handle it gracefully
- sendto = message.getaddrlist('from')
- if sendto:
- if not self.trapExceptions:
- return self.handle_message(message)
- try:
- return self.handle_message(message)
- except MailUsageHelp:
- # bounce the message back to the sender with the usage message
- fulldoc = '\n'.join(string.split(__doc__, '\n')[2:])
- sendto = [sendto[0][1]]
- m = ['']
- m.append('\n\nMail Gateway Help\n=================')
- m.append(fulldoc)
- m = self.bounce_message(message, sendto, m,
- subject="Mail Gateway Help")
- except MailUsageError, value:
- # bounce the message back to the sender with the usage message
- fulldoc = '\n'.join(string.split(__doc__, '\n')[2:])
- sendto = [sendto[0][1]]
- m = ['']
- m.append(str(value))
- m.append('\n\nMail Gateway Help\n=================')
- m.append(fulldoc)
- m = self.bounce_message(message, sendto, m)
- except Unauthorized, value:
- # just inform the user that he is not authorized
- sendto = [sendto[0][1]]
- m = ['']
- m.append(str(value))
- m = self.bounce_message(message, sendto, m)
- except:
- # bounce the message back to the sender with the error message
- sendto = [sendto[0][1], self.instance.ADMIN_EMAIL]
- m = ['']
- m.append('An unexpected error occurred during the processing')
- m.append('of your message. The tracker administrator is being')
- m.append('notified.\n')
- m.append('---- traceback of failure ----')
- s = cStringIO.StringIO()
- import traceback
- traceback.print_exc(None, s)
- m.append(s.getvalue())
- m = self.bounce_message(message, sendto, m)
- else:
- # very bad-looking message - we don't even know who sent it
- sendto = [self.instance.ADMIN_EMAIL]
- m = ['Subject: badly formed message from mail gateway']
- m.append('')
- m.append('The mail gateway retrieved a message which has no From:')
- m.append('line, indicating that it is corrupt. Please check your')
- m.append('mail gateway source. Failed message is attached.')
- m.append('')
- m = self.bounce_message(message, sendto, m,
- subject='Badly formed message from mail gateway')
-
- # now send the message
- if SENDMAILDEBUG:
- open(SENDMAILDEBUG, 'w').write('From: %s\nTo: %s\n%s\n'%(
- self.instance.ADMIN_EMAIL, ', '.join(sendto), m.getvalue()))
- else:
- try:
- smtp = smtplib.SMTP(self.instance.MAILHOST)
- smtp.sendmail(self.instance.ADMIN_EMAIL, sendto, m.getvalue())
- except socket.error, value:
- raise MailGWError, "Couldn't send error email: "\
- "mailhost %s"%value
- except smtplib.SMTPException, value:
- raise MailGWError, "Couldn't send error email: %s"%value
-
- def bounce_message(self, message, sendto, error,
- subject='Failed issue tracker submission'):
- ''' create a message that explains the reason for the failed
- issue submission to the author and attach the original
- message.
- '''
- msg = cStringIO.StringIO()
- writer = MimeWriter.MimeWriter(msg)
- writer.addheader('Subject', subject)
- writer.addheader('From', '%s <%s>'% (self.instance.INSTANCE_NAME,
- self.instance.ISSUE_TRACKER_EMAIL))
- writer.addheader('To', ','.join(sendto))
- writer.addheader('MIME-Version', '1.0')
- part = writer.startmultipartbody('mixed')
- part = writer.nextpart()
- body = part.startbody('text/plain')
- body.write('\n'.join(error))
-
- # reconstruct the original message
- m = cStringIO.StringIO()
- w = MimeWriter.MimeWriter(m)
- # default the content_type, just in case...
- content_type = 'text/plain'
- # add the headers except the content-type
- for header in message.headers:
- header_name = header.split(':')[0]
- if header_name.lower() == 'content-type':
- content_type = message.getheader(header_name)
- elif message.getheader(header_name):
- w.addheader(header_name, message.getheader(header_name))
- # now attach the message body
- body = w.startbody(content_type)
- try:
- message.rewindbody()
- except IOError:
- body.write("*** couldn't include message body: read from pipe ***")
- else:
- body.write(message.fp.read())
-
- # attach the original message to the returned message
- part = writer.nextpart()
- part.addheader('Content-Disposition','attachment')
- part.addheader('Content-Description','Message you sent')
- part.addheader('Content-Transfer-Encoding', '7bit')
- body = part.startbody('message/rfc822')
- body.write(m.getvalue())
+ # accumulate the other parts
+ parts = []
+ while 1:
+ part = self.getpart()
+ if part is None:
+ break
+ parts.append(part)
+ return parts
+
+ def _decode_header_to_utf8(self, hdr):
+ l = []
+ prev_encoded = False
+ for part, encoding in decode_header(hdr):
+ if encoding:
+ part = part.decode(encoding)
+ # RFC 2047 specifies that between encoded parts spaces are
+ # swallowed while at the borders from encoded to non-encoded
+ # or vice-versa we must preserve a space. Multiple adjacent
+ # non-encoded parts should not occur.
+ if l and prev_encoded != bool(encoding):
+ l.append(' ')
+ prev_encoded = bool(encoding)
+ l.append(part)
+ return ''.join([s.encode('utf-8') for s in l])
+
+ def getheader(self, name, default=None):
+ hdr = mimetools.Message.getheader(self, name, default)
+ # TODO are there any other False values possible?
+ # TODO if not hdr: return hdr
+ if hdr is None:
+ return None
+ if not hdr:
+ return ''
+ if hdr:
+ hdr = hdr.replace('\n','') # Inserted by rfc822.readheaders
+ return self._decode_header_to_utf8(hdr)
+
+ def getaddrlist(self, name):
+ # overload to decode the name part of the address
+ l = []
+ for (name, addr) in mimetools.Message.getaddrlist(self, name):
+ name = self._decode_header_to_utf8(name)
+ l.append((name, addr))
+ return l
+
+ def getname(self):
+ """Find an appropriate name for this message."""
+ name = None
+ if self.gettype() == 'message/rfc822':
+ # handle message/rfc822 specially - the name should be
+ # the subject of the actual e-mail embedded here
+ # we add a '.eml' extension like other email software does it
+ self.fp.seek(0)
+ s = cStringIO.StringIO(self.getbody())
+ name = Message(s).getheader('subject')
+ if name:
+ name = name + '.eml'
+ if not name:
+ # try name on Content-Type
+ name = self.getparam('name')
+ if not name:
+ disp = self.getheader('content-disposition', None)
+ if disp:
+ name = getparam(disp, 'filename')
- writer.lastpart()
- return msg
+ if name:
+ return name.strip()
- def get_part_data_decoded(self,part):
- encoding = part.getencoding()
+ 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(part.fp.read())
+ # 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(part.fp, decoded)
+ quopri.decode(self.fp, decoded)
data = decoded.getvalue()
elif encoding == 'uuencoded':
- data = binascii.a2b_uu(part.fp.read())
+ data = binascii.a2b_uu(self.fp.read())
else:
# take it as text
- data = part.fp.read()
- return data
-
- def handle_message(self, message):
- ''' message - a Message instance
+ data = self.fp.read()
+
+ # Encode message to unicode
+ charset = rfc2822.unaliasCharset(self.getparam("charset"))
+ if charset:
+ # Do conversion only if charset specified - handle
+ # badly-specified charsets
+ edata = unicode(data, charset, 'replace').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/Alternative (rfc 1521):
+ # Like multipart/mixed, except that we'd only want one of the
+ # alternatives. Generally a top-level part from MUAs sending HTML
+ # mail - there will be a text/plain version.
+ # 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, usually HTML mail with embedded
+ # images. Usually appears as an alternative.
+ # ACTION: Default, if we must.
+ # 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.
+ # message/rfc822:
+ # Only if configured in [mailgw] unpack_rfc822
+
+ def extract_content(self, parent_type=None, ignore_alternatives=False,
+ unpack_rfc822=False):
+ """Extract the body and the attachments recursively.
+
+ If the content is hidden inside a multipart/alternative part,
+ we use the *last* text/plain part of the *first*
+ multipart/alternative in the whole message.
+ """
+ content_type = self.gettype()
+ content = None
+ attachments = []
- Parse the message as per the module docstring.
+ if content_type == 'text/plain':
+ content = self.getbody()
+ elif content_type[:10] == 'multipart/':
+ content_found = bool (content)
+ ig = ignore_alternatives and not content_found
+ for part in self.getparts():
+ new_content, new_attach = part.extract_content(content_type,
+ not content and ig, unpack_rfc822)
+
+ # If we haven't found a text/plain part yet, take this one,
+ # otherwise make it an attachment.
+ if not content:
+ content = new_content
+ cpart = part
+ elif new_content:
+ if content_found or content_type != 'multipart/alternative':
+ attachments.append(part.text_as_attachment())
+ else:
+ # if we have found a text/plain in the current
+ # multipart/alternative and find another one, we
+ # use the first as an attachment (if configured)
+ # and use the second one because rfc 2046, sec.
+ # 5.1.4. specifies that later parts are better
+ # (thanks to Philipp Gortan for pointing this
+ # out)
+ attachments.append(cpart.text_as_attachment())
+ content = new_content
+ cpart = part
+
+ attachments.extend(new_attach)
+ if ig and content_type == 'multipart/alternative' and content:
+ attachments = []
+ elif unpack_rfc822 and content_type == 'message/rfc822':
+ s = cStringIO.StringIO(self.getbody())
+ m = Message(s)
+ ig = ignore_alternatives and not content
+ new_content, attachments = m.extract_content(m.gettype(), ig,
+ unpack_rfc822)
+ attachments.insert(0, m.text_as_attachment())
+ 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 text_as_attachment(self):
+ """Return first text/plain part as Message"""
+ if not self.gettype().startswith ('multipart/'):
+ return self.as_attachment()
+ for part in self.getparts():
+ content_type = part.gettype()
+ if content_type == 'text/plain':
+ return part.as_attachment()
+ elif content_type.startswith ('multipart/'):
+ p = part.text_as_attachment()
+ if p:
+ return p
+ return None
+
+ def as_attachment(self):
+ """Return this message as an attachment."""
+ return (self.getname(), self.gettype(), self.getbody())
+
+ def pgp_signed(self):
+ ''' RFC 3156 requires OpenPGP MIME mail to have the protocol parameter
'''
- # handle the subject line
- subject = message.getheader('subject', '')
+ return self.gettype() == 'multipart/signed' \
+ and self.typeheader.find('protocol="application/pgp-signature"') != -1
- if subject.strip() == 'help':
+ def pgp_encrypted(self):
+ ''' RFC 3156 requires OpenPGP MIME mail to have the protocol parameter
+ '''
+ return self.gettype() == 'multipart/encrypted' \
+ and self.typeheader.find('protocol="application/pgp-encrypted"') != -1
+
+ def decrypt(self, author, may_be_unsigned=False):
+ ''' decrypt an OpenPGP MIME message
+ This message must be signed as well as encrypted using the
+ "combined" method if incoming signatures are configured.
+ The decrypted contents are returned as a new message.
+ '''
+ (hdr, msg) = self.getparts()
+ # According to the RFC 3156 encrypted mail must have exactly two parts.
+ # The first part contains the control information. Let's verify that
+ # the message meets the RFC before we try to decrypt it.
+ if hdr.getbody().strip() != 'Version: 1' \
+ or hdr.gettype() != 'application/pgp-encrypted':
+ raise MailUsageError, \
+ _("Unknown multipart/encrypted version.")
+
+ context = pyme.core.Context()
+ ciphertext = pyme.core.Data(msg.getbody())
+ plaintext = pyme.core.Data()
+
+ result = context.op_decrypt_verify(ciphertext, plaintext)
+
+ if result:
+ raise MailUsageError, _("Unable to decrypt your message.")
+
+ # we've decrypted it but that just means they used our public
+ # key to send it to us. now check the signatures to see if it
+ # was signed by someone we trust
+ result = context.op_verify_result()
+ check_pgp_sigs(result.signatures, context, author,
+ may_be_unsigned = may_be_unsigned)
+
+ plaintext.seek(0,0)
+ # pyme.core.Data implements a seek method with a different signature
+ # than roundup can handle. So we'll put the data in a container that
+ # the Message class can work with.
+ c = cStringIO.StringIO()
+ c.write(plaintext.read())
+ c.seek(0)
+ return Message(c)
+
+ def verify_signature(self, author):
+ ''' verify the signature of an OpenPGP MIME message
+ This only handles detached signatures. Old style
+ PGP mail (i.e. '-----BEGIN PGP SIGNED MESSAGE----')
+ is archaic and not supported :)
+ '''
+ # we don't check the micalg parameter...gpgme seems to
+ # figure things out on its own
+ (msg, sig) = self.getparts()
+
+ if sig.gettype() != 'application/pgp-signature':
+ raise MailUsageError, \
+ _("No PGP signature found in message.")
+
+ # msg.getbody() is skipping over some headers that are
+ # required to be present for verification to succeed so
+ # we'll do this by hand
+ msg.fp.seek(0)
+ # according to rfc 3156 the data "MUST first be converted
+ # to its content-type specific canonical form. For
+ # text/plain this means conversion to an appropriate
+ # character set and conversion of line endings to the
+ # canonical <CR><LF> sequence."
+ # TODO: what about character set conversion?
+ canonical_msg = re.sub('(?<!\r)\n', '\r\n', msg.fp.read())
+ msg_data = pyme.core.Data(canonical_msg)
+ sig_data = pyme.core.Data(sig.getbody())
+
+ context = pyme.core.Context()
+ context.op_verify(sig_data, msg_data, None)
+
+ # check all signatures for validity
+ result = context.op_verify_result()
+ check_pgp_sigs(result.signatures, context, author)
+
+class parsedMessage:
+
+ def __init__(self, mailgw, message):
+ self.mailgw = mailgw
+ self.config = mailgw.instance.config
+ self.db = mailgw.db
+ self.message = message
+ self.subject = message.getheader('subject', '')
+ self.has_prefix = False
+ self.matches = dict.fromkeys(['refwd', 'quote', 'classname',
+ 'nodeid', 'title', 'args', 'argswhole'])
+ self.from_list = message.getaddrlist('resent-from') \
+ or message.getaddrlist('from')
+ self.pfxmode = self.config['MAILGW_SUBJECT_PREFIX_PARSING']
+ self.sfxmode = self.config['MAILGW_SUBJECT_SUFFIX_PARSING']
+ # these are filled in by subsequent parsing steps
+ self.classname = None
+ self.properties = None
+ self.cl = None
+ self.nodeid = None
+ self.author = None
+ self.recipients = None
+ self.msg_props = {}
+ self.props = None
+ self.content = None
+ self.attachments = None
+ self.crypt = False
+
+ def handle_ignore(self):
+ ''' Check to see if message can be safely ignored:
+ detect loops and
+ Precedence: Bulk, or Microsoft Outlook autoreplies
+ '''
+ if self.message.getheader('x-roundup-loop', ''):
+ raise IgnoreLoop
+ if (self.message.getheader('precedence', '') == 'bulk'
+ or self.subject.lower().find("autoreply") > 0):
+ raise IgnoreBulk
+
+ def handle_help(self):
+ ''' Check to see if the message contains a usage/help request
+ '''
+ if self.subject.strip().lower() == 'help':
raise MailUsageHelp
- m = subject_re.match(subject)
+ def check_subject(self):
+ ''' Check to see if the message contains a valid subject line
+ '''
+ if not self.subject:
+ raise MailUsageError, _("""
+Emails to Roundup trackers must include a Subject: line!
+""")
+
+ def parse_subject(self):
+ ''' Matches subjects like:
+ Re: "[issue1234] title of issue [status=resolved]"
+
+ Each part of the subject is matched, stored, then removed from the
+ start of the subject string as needed. The stored values are then
+ returned
+ '''
+
+ tmpsubject = self.subject
+
+ sd_open, sd_close = self.config['MAILGW_SUBJECT_SUFFIX_DELIMITERS']
+ delim_open = re.escape(sd_open)
+ if delim_open in '[(': delim_open = '\\' + delim_open
+ delim_close = re.escape(sd_close)
+ if delim_close in '[(': delim_close = '\\' + delim_close
- # check for well-formed subject line
+ # Look for Re: et. al. Used later on for MAILGW_SUBJECT_CONTENT_MATCH
+ re_re = r"(?P<refwd>%s)\s*" % self.config["MAILGW_REFWD_RE"].pattern
+ m = re.match(re_re, tmpsubject, re.IGNORECASE|re.VERBOSE|re.UNICODE)
if m:
- # get the classname
- classname = m.group('classname')
- if classname is None:
- # no classname, fallback on the default
- if hasattr(self.instance, 'MAIL_DEFAULT_CLASS') and \
- self.instance.MAIL_DEFAULT_CLASS:
- classname = self.instance.MAIL_DEFAULT_CLASS
- else:
- # fail
- m = None
+ m = m.groupdict()
+ if m['refwd']:
+ self.matches.update(m)
+ tmpsubject = tmpsubject[len(m['refwd']):] # Consume Re:
+
+ # Look for Leading "
+ m = re.match(r'(?P<quote>\s*")', tmpsubject,
+ re.IGNORECASE)
+ if m:
+ self.matches.update(m.groupdict())
+ tmpsubject = tmpsubject[len(self.matches['quote']):] # Consume quote
+
+ # Check if the subject includes a prefix
+ self.has_prefix = re.search(r'^%s(\w+)%s'%(delim_open,
+ delim_close), tmpsubject.strip())
+
+ # Match the classname if specified
+ class_re = r'%s(?P<classname>(%s))(?P<nodeid>\d+)?%s'%(delim_open,
+ "|".join(self.db.getclasses()), delim_close)
+ # Note: re.search, not re.match as there might be garbage
+ # (mailing list prefix, etc.) before the class identifier
+ m = re.search(class_re, tmpsubject, re.IGNORECASE)
+ if m:
+ self.matches.update(m.groupdict())
+ # Skip to the end of the class identifier, including any
+ # garbage before it.
+
+ tmpsubject = tmpsubject[m.end():]
+
+ # Match the title of the subject
+ # if we've not found a valid classname prefix then force the
+ # scanning to handle there being a leading delimiter
+ title_re = r'(?P<title>%s[^%s]*)'%(
+ not self.matches['classname'] and '.' or '', delim_open)
+ m = re.match(title_re, tmpsubject.strip(), re.IGNORECASE)
+ if m:
+ self.matches.update(m.groupdict())
+ tmpsubject = tmpsubject[len(self.matches['title']):] # Consume title
+
+ if self.matches['title']:
+ self.matches['title'] = self.matches['title'].strip()
+ else:
+ self.matches['title'] = ''
+
+ # strip off the quotes that dumb emailers put around the subject, like
+ # Re: "[issue1] bla blah"
+ if self.matches['quote'] and self.matches['title'].endswith('"'):
+ self.matches['title'] = self.matches['title'][:-1]
+
+ # Match any arguments specified
+ args_re = r'(?P<argswhole>%s(?P<args>.+?)%s)?'%(delim_open,
+ delim_close)
+ m = re.search(args_re, tmpsubject.strip(), re.IGNORECASE|re.VERBOSE)
+ if m:
+ self.matches.update(m.groupdict())
+
+ def rego_confirm(self):
+ ''' Check for registration OTK and confirm the registration if found
+ '''
+
+ if self.config['EMAIL_REGISTRATION_CONFIRMATION']:
+ otk_re = re.compile('-- key (?P<otk>[a-zA-Z0-9]{32})')
+ otk = otk_re.search(self.matches['title'] or '')
+ if otk:
+ self.db.confirm_registration(otk.group('otk'))
+ subject = 'Your registration to %s is complete' % \
+ self.config['TRACKER_NAME']
+ sendto = [self.from_list[0][1]]
+ self.mailgw.mailer.standard_message(sendto, subject, '')
+ return 1
+ return 0
+
+ def get_classname(self):
+ ''' Determine the classname of the node being created/edited
+ '''
+ subject = self.subject
+
+ # get the classname
+ if self.pfxmode == 'none':
+ classname = None
+ else:
+ classname = self.matches['classname']
- if not m:
- raise MailUsageError, '''
+ if not classname and self.has_prefix and self.pfxmode == 'strict':
+ raise MailUsageError, _("""
The message you sent to roundup did not contain a properly formed subject
line. The subject must contain a class name or designator to indicate the
-"topic" of the message. For example:
+'topic' of the message. For example:
Subject: [issue] This is a new issue
- - this will create a new issue in the tracker with the title "This is
- a new issue".
+ - this will create a new issue in the tracker with the title 'This is
+ a new issue'.
Subject: [issue1234] This is a followup to issue 1234
- this will append the message's contents to the existing issue 1234
in the tracker.
-Subject was: "%s"
-'''%subject
+Subject was: '%(subject)s'
+""") % locals()
- # get the class
- try:
- cl = self.db.getclass(classname)
- except KeyError:
- raise MailUsageError, '''
-The class name you identified in the subject line ("%s") does not exist in the
-database.
+ # try to get the class specified - if "loose" or "none" then fall
+ # back on the default
+ attempts = []
+ if classname:
+ attempts.append(classname)
-Valid class names are: %s
-Subject was: "%s"
-'''%(classname, ', '.join(self.db.getclasses()), subject)
+ if self.mailgw.default_class:
+ attempts.append(self.mailgw.default_class)
+ else:
+ attempts.append(self.config['MAILGW_DEFAULT_CLASS'])
+
+ # first valid class name wins
+ self.cl = None
+ for trycl in attempts:
+ try:
+ self.cl = self.db.getclass(trycl)
+ classname = self.classname = trycl
+ break
+ except KeyError:
+ pass
+
+ if not self.cl:
+ validname = ', '.join(self.db.getclasses())
+ if classname:
+ raise MailUsageError, _("""
+The class name you identified in the subject line ("%(classname)s") does
+not exist in the database.
+
+Valid class names are: %(validname)s
+Subject was: "%(subject)s"
+""") % locals()
+ else:
+ raise MailUsageError, _("""
+You did not identify a class name in the subject line and there is no
+default set for this tracker. The subject must contain a class name or
+designator to indicate the 'topic' of the message. For example:
+ Subject: [issue] This is a new issue
+ - this will create a new issue in the tracker with the title 'This is
+ a new issue'.
+ Subject: [issue1234] This is a followup to issue 1234
+ - this will append the message's contents to the existing issue 1234
+ in the tracker.
- # get the optional nodeid
- nodeid = m.group('nodeid')
+Subject was: '%(subject)s'
+""") % locals()
+ # get the class properties
+ self.properties = self.cl.getprops()
+
- # title is optional too
- title = m.group('title')
- if title:
- title = title.strip()
+ def get_nodeid(self):
+ ''' Determine the nodeid from the message and return it if found
+ '''
+ title = self.matches['title']
+ subject = self.subject
+
+ if self.pfxmode == 'none':
+ nodeid = None
else:
- title = ''
+ nodeid = self.matches['nodeid']
+
+ # try in-reply-to to match the message if there's no nodeid
+ inreplyto = self.message.getheader('in-reply-to') or ''
+ if nodeid is None and inreplyto:
+ l = self.db.getclass('msg').stringFind(messageid=inreplyto)
+ if l:
+ nodeid = self.cl.filter(None, {'messages':l})[0]
+
# but we do need either a title or a nodeid...
if nodeid is None and not title:
- raise MailUsageError, '''
+ raise MailUsageError, _("""
I cannot match your message to a node in the database - you need to either
-supply a full node identifier (with number, eg "[issue123]" or keep the
+supply a full designator (with number, eg "[issue123]") or keep the
previous subject title intact so I can match that.
-Subject was: "%s"
-'''%subject
+Subject was: "%(subject)s"
+""") % locals()
# If there's no nodeid, check to see if this is a followup and
# maybe someone's responded to the initial mail that created an
# entry. Try to find the matching nodes with the same title, and
# use the _last_ one matched (since that'll _usually_ be the most
- # recent...)
- if nodeid is None and m.group('refwd'):
- l = cl.stringFind(title=title)
- if l:
- nodeid = l[-1]
+ # recent...). The subject_content_match config may specify an
+ # additional restriction based on the matched node's creation or
+ # activity.
+ tmatch_mode = self.config['MAILGW_SUBJECT_CONTENT_MATCH']
+ if tmatch_mode != 'never' and nodeid is None and self.matches['refwd']:
+ l = self.cl.stringFind(title=title)
+ limit = None
+ if (tmatch_mode.startswith('creation') or
+ tmatch_mode.startswith('activity')):
+ limit, interval = tmatch_mode.split(' ', 1)
+ threshold = date.Date('.') - date.Interval(interval)
+ for id in l:
+ if limit:
+ if threshold < self.cl.get(id, limit):
+ nodeid = id
+ else:
+ nodeid = id
# if a nodeid was specified, make sure it's valid
- if nodeid is not None and not cl.hasnode(nodeid):
- raise MailUsageError, '''
-The node specified by the designator in the subject of your message ("%s")
-does not exist.
-
-Subject was: "%s"
-'''%(nodeid, subject)
-
- #
- # extract the args
- #
- subject_args = m.group('args')
-
- #
- # handle the subject argument list
- #
- # figure what the properties of this Class are
- properties = cl.getprops()
- props = {}
- args = m.group('args')
- if args:
- errors = []
- for prop in string.split(args, ';'):
- # extract the property name and value
- try:
- propname, value = prop.split('=')
- except ValueError, message:
- errors.append('not of form [arg=value,'
- 'value,...;arg=value,value...]')
- break
-
- # ensure it's a valid property name
- propname = propname.strip()
- try:
- proptype = properties[propname]
- except KeyError:
- errors.append('refers to an invalid property: '
- '"%s"'%propname)
- continue
-
- # convert the string value to a real property value
- if isinstance(proptype, hyperdb.String):
- props[propname] = value.strip()
- if isinstance(proptype, hyperdb.Password):
- props[propname] = password.Password(value.strip())
- elif isinstance(proptype, hyperdb.Date):
- try:
- props[propname] = date.Date(value.strip())
- except ValueError, message:
- errors.append('contains an invalid date for '
- '%s.'%propname)
- elif isinstance(proptype, hyperdb.Interval):
- try:
- props[propname] = date.Interval(value)
- except ValueError, message:
- errors.append('contains an invalid date interval'
- 'for %s.'%propname)
- elif isinstance(proptype, hyperdb.Link):
- linkcl = self.db.classes[proptype.classname]
- propkey = linkcl.labelprop(default_to_id=1)
- try:
- props[propname] = linkcl.lookup(value)
- except KeyError, message:
- errors.append('"%s" is not a value for %s.'%(value,
- propname))
- elif isinstance(proptype, hyperdb.Multilink):
- # get the linked class
- linkcl = self.db.classes[proptype.classname]
- propkey = linkcl.labelprop(default_to_id=1)
- if nodeid:
- curvalue = cl.get(nodeid, propname)
- else:
- curvalue = []
-
- # handle each add/remove in turn
- # keep an extra list for all items that are
- # definitely in the new list (in case of e.g.
- # <propname>=A,+B, which should replace the old
- # list with A,B)
- set = 0
- newvalue = []
- for item in value.split(','):
- item = item.strip()
-
- # handle +/-
- remove = 0
- if item.startswith('-'):
- remove = 1
- item = item[1:]
- elif item.startswith('+'):
- item = item[1:]
- else:
- set = 1
-
- # look up the value
- try:
- item = linkcl.lookup(item)
- except KeyError, message:
- errors.append('"%s" is not a value for %s.'%(item,
- propname))
- continue
-
- # perform the add/remove
- if remove:
- try:
- curvalue.remove(item)
- except ValueError:
- errors.append('"%s" is not currently in '
- 'for %s.'%(item, propname))
- continue
- else:
- newvalue.append(item)
- if item not in curvalue:
- curvalue.append(item)
-
- # that's it, set the new Multilink property value,
- # or overwrite it completely
- if set:
- props[propname] = newvalue
- else:
- props[propname] = curvalue
- elif isinstance(proptype, hyperdb.Boolean):
- value = value.strip()
- props[propname] = value.lower() in ('yes', 'true', 'on', '1')
- elif isinstance(proptype, hyperdb.Number):
- value = value.strip()
- props[propname] = int(value)
-
- # handle any errors parsing the argument list
- if errors:
- errors = '\n- '.join(errors)
- raise MailUsageError, '''
-There were problems handling your subject line argument list:
-- %s
-
-Subject was: "%s"
-'''%(errors, subject)
-
- #
- # handle the users
- #
+ if nodeid is not None and not self.cl.hasnode(nodeid):
+ if self.pfxmode == 'strict':
+ raise MailUsageError, _("""
+The node specified by the designator in the subject of your message
+("%(nodeid)s") does not exist.
+
+Subject was: "%(subject)s"
+""") % locals()
+ else:
+ nodeid = None
+ self.nodeid = nodeid
+ def get_author_id(self):
+ ''' Attempt to get the author id from the existing registered users,
+ otherwise attempt to register a new user and return their id
+ '''
# Don't create users if anonymous isn't allowed to register
create = 1
anonid = self.db.user.lookup('anonymous')
- if not self.db.security.hasPermission('Email Registration', anonid):
+ if not (self.db.security.hasPermission('Register', anonid, 'user')
+ and self.db.security.hasPermission('Email Access', anonid)):
create = 0
- author = uidFromAddress(self.db, message.getaddrlist('from')[0],
- create=create)
+ # ok, now figure out who the author is - create a new user if the
+ # "create" flag is true
+ author = uidFromAddress(self.db, self.from_list[0], create=create)
+
+ # if we're not recognised, and we don't get added as a user, then we
+ # must be anonymous
if not author:
- raise Unauthorized, '''
-You are not a registered user.
+ author = anonid
-Unknown address: %s
-'''%message.getaddrlist('from')[0][1]
+ # make sure the author has permission to use the email interface
+ if not self.db.security.hasPermission('Email Access', author):
+ if author == anonid:
+ # we're anonymous and we need to be a registered user
+ from_address = self.from_list[0][1]
+ registration_info = ""
+ if self.db.security.hasPermission('Web Access', author) and \
+ self.db.security.hasPermission('Register', anonid, 'user'):
+ tracker_web = self.config.TRACKER_WEB
+ registration_info = """ Please register at:
- # the author may have been created - make sure the change is
- # committed before we reopen the database
+%(tracker_web)suser?template=register
+
+...before sending mail to the tracker.""" % locals()
+
+ raise Unauthorized, _("""
+You are not a registered user.%(registration_info)s
+
+Unknown address: %(from_address)s
+""") % locals()
+ else:
+ # we're registered and we're _still_ not allowed access
+ raise Unauthorized, _(
+ 'You are not permitted to access this tracker.')
+ self.author = author
+
+ def check_permissions(self):
+ ''' Check if the author has permission to edit or create this
+ class of node
+ '''
+ if self.nodeid:
+ if not self.db.security.hasPermission('Edit', self.author,
+ self.classname, itemid=self.nodeid):
+ raise Unauthorized, _(
+ 'You are not permitted to edit %(classname)s.'
+ ) % self.__dict__
+ else:
+ if not self.db.security.hasPermission('Create', self.author,
+ self.classname):
+ raise Unauthorized, _(
+ 'You are not permitted to create %(classname)s.'
+ ) % self.__dict__
+
+ def commit_and_reopen_as_author(self):
+ ''' the author may have been created - make sure the change is
+ committed before we reopen the database
+ then re-open the database as the author
+ '''
self.db.commit()
-
- # reopen the database as the author
- username = self.db.user.get(author, 'username')
- self.db = self.instance.open(username)
+
+ # set the database user as the author
+ username = self.db.user.get(self.author, 'username')
+ self.db.setCurrentUser(username)
# re-get the class with the new database connection
- cl = self.db.getclass(classname)
+ self.cl = self.db.getclass(self.classname)
+
+ def get_recipients(self):
+ ''' Get the list of recipients who were included in message and
+ register them as users if possible
+ '''
+ # Don't create users if anonymous isn't allowed to register
+ create = 1
+ anonid = self.db.user.lookup('anonymous')
+ if not (self.db.security.hasPermission('Register', anonid, 'user')
+ and self.db.security.hasPermission('Email Access', anonid)):
+ create = 0
+
+ # get the user class arguments from the commandline
+ user_props = self.mailgw.get_class_arguments('user')
# now update the recipients list
recipients = []
- tracker_email = self.instance.ISSUE_TRACKER_EMAIL.lower()
- for recipient in message.getaddrlist('to') + message.getaddrlist('cc'):
+ tracker_email = self.config['TRACKER_EMAIL'].lower()
+ msg_to = self.message.getaddrlist('to')
+ msg_cc = self.message.getaddrlist('cc')
+ for recipient in msg_to + msg_cc:
r = recipient[1].strip().lower()
if r == tracker_email or not r:
continue
# look up the recipient - create if necessary (and we're
# allowed to)
- recipient = uidFromAddress(self.db, recipient, create)
+ recipient = uidFromAddress(self.db, recipient, create, **user_props)
# if all's well, add the recipient to the list
if recipient:
recipients.append(recipient)
+ self.recipients = recipients
+ def get_props(self):
+ ''' Generate all the props for the new/updated node and return them
+ '''
+ subject = self.subject
+
+ # get the commandline arguments for issues
+ issue_props = self.mailgw.get_class_arguments('issue', self.classname)
+
#
- # handle message-id and in-reply-to
+ # handle the subject argument list
#
- messageid = message.getheader('message-id')
- inreplyto = message.getheader('in-reply-to') or ''
+ # figure what the properties of this Class are
+ props = {}
+ args = self.matches['args']
+ argswhole = self.matches['argswhole']
+ title = self.matches['title']
+
+ # Reform the title
+ if self.matches['nodeid'] and self.nodeid is None:
+ title = subject
+
+ if args:
+ if self.sfxmode == 'none':
+ title += ' ' + argswhole
+ else:
+ errors, props = setPropArrayFromString(self, self.cl, args,
+ self.nodeid)
+ # handle any errors parsing the argument list
+ if errors:
+ if self.sfxmode == 'strict':
+ errors = '\n- '.join(map(str, errors))
+ raise MailUsageError, _("""
+There were problems handling your subject line argument list:
+- %(errors)s
+
+Subject was: "%(subject)s"
+""") % locals()
+ else:
+ title += ' ' + argswhole
+
+
+ # set the issue title to the subject
+ title = title.strip()
+ if (title and self.properties.has_key('title') and not
+ issue_props.has_key('title')):
+ issue_props['title'] = title
+ if (self.nodeid and self.properties.has_key('title') and not
+ self.config['MAILGW_SUBJECT_UPDATES_TITLE']):
+ issue_props['title'] = self.cl.get(self.nodeid,'title')
+
+ # merge the command line props defined in issue_props into
+ # the props dictionary because function(**props, **issue_props)
+ # is a syntax error.
+ for prop in issue_props.keys() :
+ if not props.has_key(prop) :
+ props[prop] = issue_props[prop]
+
+ self.props = props
+
+ def get_pgp_message(self):
+ ''' If they've enabled PGP processing then verify the signature
+ or decrypt the message
+ '''
+ def pgp_role():
+ """ if PGP_ROLES is specified the user must have a Role in the list
+ or we will skip PGP processing
+ """
+ if self.config.PGP_ROLES:
+ return self.db.user.has_role(self.author,
+ *iter_roles(self.config.PGP_ROLES))
+ else:
+ return True
+
+ if self.config.PGP_ENABLE:
+ if pgp_role() and self.config.PGP_ENCRYPT:
+ self.crypt = True
+ assert pyme, 'pyme is not installed'
+ # signed/encrypted mail must come from the primary address
+ author_address = self.db.user.get(self.author, 'address')
+ if self.config.PGP_HOMEDIR:
+ os.environ['GNUPGHOME'] = self.config.PGP_HOMEDIR
+ if self.config.PGP_REQUIRE_INCOMING in ('encrypted', 'both') \
+ and pgp_role() and not self.message.pgp_encrypted():
+ raise MailUsageError, _(
+ "This tracker has been configured to require all email "
+ "be PGP encrypted.")
+ if self.message.pgp_signed():
+ self.message.verify_signature(author_address)
+ elif self.message.pgp_encrypted():
+ # Replace message with the contents of the decrypted
+ # message for content extraction
+ # Note: the bounce-handling code now makes sure that
+ # either the encrypted mail received is sent back or
+ # that the error message is encrypted if needed.
+ encr_only = self.config.PGP_REQUIRE_INCOMING == 'encrypted'
+ encr_only = encr_only or not pgp_role()
+ self.crypt = True
+ self.message = self.message.decrypt(author_address,
+ may_be_unsigned = encr_only)
+ elif pgp_role():
+ raise MailUsageError, _("""
+This tracker has been configured to require all email be PGP signed or
+encrypted.""")
+
+ def get_content_and_attachments(self):
+ ''' get the attachments and first text part from the message
+ '''
+ ig = self.config.MAILGW_IGNORE_ALTERNATIVES
+ self.content, self.attachments = self.message.extract_content(
+ ignore_alternatives=ig,
+ unpack_rfc822=self.config.MAILGW_UNPACK_RFC822)
+
+
+ def create_files(self):
+ ''' Create a file for each attachment in the message
+ '''
+ if not self.properties.has_key('files'):
+ return
+ files = []
+ file_props = self.mailgw.get_class_arguments('file')
+
+ if self.attachments:
+ for (name, mime_type, data) in self.attachments:
+ if not self.db.security.hasPermission('Create', self.author,
+ 'file'):
+ raise Unauthorized, _(
+ 'You are not permitted to create files.')
+ if not name:
+ name = "unnamed"
+ try:
+ fileid = self.db.file.create(type=mime_type, name=name,
+ content=data, **file_props)
+ except exceptions.Reject:
+ pass
+ else:
+ files.append(fileid)
+ # allowed to attach the files to an existing node?
+ if self.nodeid and not self.db.security.hasPermission('Edit',
+ self.author, self.classname, 'files'):
+ raise Unauthorized, _(
+ 'You are not permitted to add files to %(classname)s.'
+ ) % self.__dict__
+
+ self.msg_props['files'] = files
+ if self.nodeid:
+ # extend the existing files list
+ fileprop = self.cl.get(self.nodeid, 'files')
+ fileprop.extend(files)
+ files = fileprop
+
+ self.props['files'] = files
+
+ def create_msg(self):
+ ''' Create msg containing all the relevant information from the message
+ '''
+ if not self.properties.has_key('messages'):
+ return
+ msg_props = self.mailgw.get_class_arguments('msg')
+ self.msg_props.update (msg_props)
+
+ # Get the message ids
+ inreplyto = self.message.getheader('in-reply-to') or ''
+ messageid = self.message.getheader('message-id')
# generate a messageid if there isn't one
if not messageid:
messageid = "<%s.%s.%s%s@%s>"%(time.time(), random.random(),
- classname, nodeid, self.instance.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()))
- else:
- # try name on Content-Type
- name = part.getparam('name')
- # 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':
- raise MailUsageError, '''
+ self.classname, self.nodeid, self.config['MAIL_DOMAIN'])
+
+ if self.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, 'EMAIL_KEEP_QUOTED_TEXT',
- 'no') == 'yes'
- keep_body = getattr(self.instance, 'EMAIL_LEAVE_BODY_UNCHANGED',
- 'no') == 'yes'
+""")
# parse the body of the message, stripping out bits as appropriate
- summary, content = parseContent(content, keep_citations,
- keep_body)
-
- #
- # handle the attachments
- #
- files = []
- for (name, mime_type, data) in attachments:
- if not name:
- name = "unnamed"
- files.append(self.db.file.create(type=mime_type, name=name,
- content=data))
+ summary, content = parseContent(self.content, config=self.config)
+ content = content.strip()
- #
- # create the message if there's a message body (content)
- #
if content:
- message_id = self.db.msg.create(author=author,
- recipients=recipients, date=date.Date('.'), summary=summary,
- content=content, files=files, messageid=messageid,
- inreplyto=inreplyto)
+ if not self.db.security.hasPermission('Create', self.author, 'msg'):
+ raise Unauthorized, _(
+ 'You are not permitted to create messages.')
- # attach the message to the node
- if nodeid:
+ try:
+ message_id = self.db.msg.create(author=self.author,
+ recipients=self.recipients, date=date.Date('.'),
+ summary=summary, content=content,
+ messageid=messageid, inreplyto=inreplyto, **self.msg_props)
+ except exceptions.Reject, error:
+ raise MailUsageError, _("""
+Mail message was rejected by a detector.
+%(error)s
+""") % locals()
+ # allowed to attach the message to the existing node?
+ if self.nodeid and not self.db.security.hasPermission('Edit',
+ self.author, self.classname, 'messages'):
+ raise Unauthorized, _(
+ 'You are not permitted to add messages to %(classname)s.'
+ ) % self.__dict__
+
+ if self.nodeid:
# add the message to the node's list
- messages = cl.get(nodeid, 'messages')
+ messages = self.cl.get(self.nodeid, 'messages')
messages.append(message_id)
- props['messages'] = messages
+ self.props['messages'] = messages
else:
# pre-load the messages list
- props['messages'] = [message_id]
-
- # set the title to the subject
- if properties.has_key('title') and not props.has_key('title'):
- props['title'] = title
+ self.props['messages'] = [message_id]
- #
- # perform the node change / create
- #
+ def create_node(self):
+ ''' Create/update a node using self.props
+ '''
+ classname = self.classname
try:
- if nodeid:
- cl.set(nodeid, **props)
+ if self.nodeid:
+ # Check permissions for each property
+ for prop in self.props.keys():
+ if not self.db.security.hasPermission('Edit', self.author,
+ classname, prop):
+ raise Unauthorized, _('You are not permitted to edit '
+ 'property %(prop)s of class %(classname)s.'
+ ) % locals()
+ self.cl.set(self.nodeid, **self.props)
else:
- nodeid = cl.create(**props)
- except (TypeError, IndexError, ValueError), message:
- raise MailUsageError, '''
+ # Check permissions for each property
+ for prop in self.props.keys():
+ if not self.db.security.hasPermission('Create', self.author,
+ classname, prop):
+ raise Unauthorized, _('You are not permitted to set '
+ 'property %(prop)s of class %(classname)s.'
+ ) % locals()
+ self.nodeid = self.cl.create(**self.props)
+ except (TypeError, IndexError, ValueError, exceptions.Reject), message:
+ raise MailUsageError, _("""
There was a problem with the message you sent:
- %s
-'''%message
+ %(message)s
+""") % locals()
+
+ return self.nodeid
+
+ # XXX Don't enable. This doesn't work yet.
+# "[^A-z.]tracker\+(?P<classname>[^\d\s]+)(?P<nodeid>\d+)\@some.dom.ain[^A-z.]"
+ # handle delivery to addresses like:tracker+issue25@some.dom.ain
+ # use the embedded issue number as our issue
+# issue_re = config['MAILGW_ISSUE_ADDRESS_RE']
+# if issue_re:
+# for header in ['to', 'cc', 'bcc']:
+# addresses = message.getheader(header, '')
+# if addresses:
+# # FIXME, this only finds the first match in the addresses.
+# issue = re.search(issue_re, addresses, 'i')
+# if issue:
+# classname = issue.group('classname')
+# nodeid = issue.group('nodeid')
+# break
+
+ # Default sequence of methods to be called on message. Use this for
+ # easier override of the default message processing
+ # list consists of tuples (method, return_if_true), the parsing
+ # returns if the return_if_true flag is set for a method *and* the
+ # method returns something that evaluates to True.
+ method_list = [
+ # Filter out messages to ignore
+ ("handle_ignore", False),
+ # Check for usage/help requests
+ ("handle_help", False),
+ # Check if the subject line is valid
+ ("check_subject", False),
+ # get importants parts from subject
+ ("parse_subject", False),
+ # check for registration OTK
+ ("rego_confirm", True),
+ # get the classname
+ ("get_classname", False),
+ # get the optional nodeid:
+ ("get_nodeid", False),
+ # Determine who the author is:
+ ("get_author_id", False),
+ # allowed to edit or create this class?
+ ("check_permissions", False),
+ # author may have been created:
+ # commit author to database and re-open as author
+ ("commit_and_reopen_as_author", False),
+ # Get the recipients list
+ ("get_recipients", False),
+ # get the new/updated node props
+ ("get_props", False),
+ # Handle PGP signed or encrypted messages
+ ("get_pgp_message", False),
+ # extract content and attachments from message body:
+ ("get_content_and_attachments", False),
+ # put attachments into files linked to the issue:
+ ("create_files", False),
+ # create the message if there's a message body (content):
+ ("create_msg", False),
+ ]
+
+
+ def parse (self):
+ for methodname, flag in self.method_list:
+ method = getattr (self, methodname)
+ ret = method()
+ if flag and ret:
+ return
+ # perform the node change / create:
+ return self.create_node()
+
+
+class MailGW:
+
+ # To override the message parsing, derive your own class from
+ # parsedMessage and assign to parsed_message_class in a derived
+ # class of MailGW
+ parsed_message_class = parsedMessage
+
+ def __init__(self, instance, arguments=()):
+ self.instance = instance
+ self.arguments = arguments
+ self.default_class = None
+ for option, value in self.arguments:
+ if option == '-c':
+ self.default_class = value.strip()
+
+ self.mailer = Mailer(instance.config)
+ self.logger = logging.getLogger('roundup.mailgw')
+
+ # should we trap exceptions (normal usage) or pass them through
+ # (for testing)
+ self.trapExceptions = 1
+
+ def do_pipe(self):
+ """ Read a message from standard input and pass it to the mail handler.
+
+ Read into an internal structure that we can seek on (in case
+ there's an error).
+
+ XXX: we may want to read this into a temporary file instead...
+ """
+ s = cStringIO.StringIO()
+ s.write(sys.stdin.read())
+ s.seek(0)
+ self.main(s)
+ return 0
+
+ def do_mailbox(self, filename):
+ """ Read a series of messages from the specified unix mailbox file and
+ pass each to the mail handler.
+ """
+ # open the spool file and lock it
+ import fcntl
+ # FCNTL is deprecated in py2.3 and fcntl takes over all the symbols
+ if hasattr(fcntl, 'LOCK_EX'):
+ FCNTL = fcntl
+ else:
+ import FCNTL
+ f = open(filename, 'r+')
+ fcntl.flock(f.fileno(), FCNTL.LOCK_EX)
+
+ # handle and clear the mailbox
+ try:
+ from mailbox import UnixMailbox
+ mailbox = UnixMailbox(f, factory=Message)
+ # grab one message
+ message = mailbox.next()
+ while message:
+ # handle this message
+ self.handle_Message(message)
+ message = mailbox.next()
+ # nuke the file contents
+ os.ftruncate(f.fileno(), 0)
+ except:
+ import traceback
+ traceback.print_exc()
+ return 1
+ fcntl.flock(f.fileno(), FCNTL.LOCK_UN)
+ return 0
+
+ def do_imap(self, server, user='', password='', mailbox='', ssl=0,
+ cram=0):
+ ''' Do an IMAP connection
+ '''
+ import getpass, imaplib, socket
+ try:
+ if not user:
+ user = raw_input('User: ')
+ if not password:
+ password = getpass.getpass()
+ except (KeyboardInterrupt, EOFError):
+ # Ctrl C or D maybe also Ctrl Z under Windows.
+ print "\nAborted by user."
+ return 1
+ # open a connection to the server and retrieve all messages
+ try:
+ if ssl:
+ self.logger.debug('Trying server %r with ssl'%server)
+ server = imaplib.IMAP4_SSL(server)
+ else:
+ self.logger.debug('Trying server %r without ssl'%server)
+ server = imaplib.IMAP4(server)
+ except (imaplib.IMAP4.error, socket.error, socket.sslerror):
+ self.logger.exception('IMAP server error')
+ return 1
+
+ try:
+ if cram:
+ server.login_cram_md5(user, password)
+ else:
+ server.login(user, password)
+ except imaplib.IMAP4.error, e:
+ self.logger.exception('IMAP login failure')
+ return 1
+
+ try:
+ if not mailbox:
+ (typ, data) = server.select()
+ else:
+ (typ, data) = server.select(mailbox=mailbox)
+ if typ != 'OK':
+ self.logger.error('Failed to get mailbox %r: %s'%(mailbox,
+ data))
+ return 1
+ try:
+ numMessages = int(data[0])
+ except ValueError, value:
+ self.logger.error('Invalid message count from mailbox %r'%
+ data[0])
+ return 1
+ for i in range(1, numMessages+1):
+ (typ, data) = server.fetch(str(i), '(RFC822)')
+
+ # mark the message as deleted.
+ server.store(str(i), '+FLAGS', r'(\Deleted)')
+
+ # process the message
+ s = cStringIO.StringIO(data[0][1])
+ s.seek(0)
+ self.handle_Message(Message(s))
+ server.close()
+ finally:
+ try:
+ server.expunge()
+ except:
+ pass
+ server.logout()
+
+ return 0
+
+
+ def do_apop(self, server, user='', password='', ssl=False):
+ ''' Do authentication POP
+ '''
+ self._do_pop(server, user, password, True, ssl)
+
+ def do_pop(self, server, user='', password='', ssl=False):
+ ''' Do plain POP
+ '''
+ self._do_pop(server, user, password, False, ssl)
+
+ def _do_pop(self, server, user, password, apop, ssl):
+ '''Read a series of messages from the specified POP server.
+ '''
+ import getpass, poplib, socket
+ try:
+ if not user:
+ user = raw_input('User: ')
+ if not password:
+ password = getpass.getpass()
+ except (KeyboardInterrupt, EOFError):
+ # Ctrl C or D maybe also Ctrl Z under Windows.
+ print "\nAborted by user."
+ return 1
+
+ # open a connection to the server and retrieve all messages
+ try:
+ if ssl:
+ klass = poplib.POP3_SSL
+ else:
+ klass = poplib.POP3
+ server = klass(server)
+ except socket.error:
+ self.logger.exception('POP server error')
+ return 1
+ if apop:
+ server.apop(user, password)
+ else:
+ server.user(user)
+ server.pass_(password)
+ numMessages = len(server.list()[1])
+ for i in range(1, numMessages+1):
+ # retr: returns
+ # [ pop response e.g. '+OK 459 octets',
+ # [ array of message lines ],
+ # number of octets ]
+ lines = server.retr(i)[1]
+ s = cStringIO.StringIO('\n'.join(lines))
+ s.seek(0)
+ self.handle_Message(Message(s))
+ # delete the message
+ server.dele(i)
+
+ # quit the server to commit changes.
+ server.quit()
+ return 0
+
+ def main(self, fp):
+ ''' fp - the file from which to read the Message.
+ '''
+ return self.handle_Message(Message(fp))
+
+ def handle_Message(self, message):
+ """Handle an RFC822 Message
+
+ Handle the Message object by calling handle_message() and then cope
+ with any errors raised by handle_message.
+ This method's job is to make that call and handle any
+ errors in a sane manner. It should be replaced if you wish to
+ handle errors in a different manner.
+ """
+ # in some rare cases, a particularly stuffed-up e-mail will make
+ # its way into here... try to handle it gracefully
+
+ self.parsed_message = None
+ sendto = message.getaddrlist('resent-from')
+ if not sendto:
+ sendto = message.getaddrlist('from')
+ if not sendto:
+ # very bad-looking message - we don't even know who sent it
+ msg = ['Badly formed message from mail gateway. Headers:']
+ msg.extend(message.headers)
+ msg = '\n'.join(map(str, msg))
+ self.logger.error(msg)
+ return
+
+ msg = 'Handling message'
+ if message.getheader('message-id'):
+ msg += ' (Message-id=%r)'%message.getheader('message-id')
+ self.logger.info(msg)
+
+ # try normal message-handling
+ if not self.trapExceptions:
+ return self.handle_message(message)
+
+ # no, we want to trap exceptions
+ # Note: by default we return the message received not the
+ # internal state of the parsedMessage -- except for
+ # MailUsageError, Unauthorized and for unknown exceptions. For
+ # the latter cases we make sure the error message is encrypted
+ # if needed (if it either was received encrypted or pgp
+ # processing is turned on for the user).
+ try:
+ return self.handle_message(message)
+ except MailUsageHelp:
+ # bounce the message back to the sender with the usage message
+ fulldoc = '\n'.join(string.split(__doc__, '\n')[2:])
+ m = ['']
+ m.append('\n\nMail Gateway Help\n=================')
+ m.append(fulldoc)
+ self.mailer.bounce_message(message, [sendto[0][1]], m,
+ subject="Mail Gateway Help")
+ except MailUsageError, value:
+ # bounce the message back to the sender with the usage message
+ fulldoc = '\n'.join(string.split(__doc__, '\n')[2:])
+ m = ['']
+ m.append(str(value))
+ m.append('\n\nMail Gateway Help\n=================')
+ m.append(fulldoc)
+ if self.parsed_message:
+ message = self.parsed_message.message
+ crypt = self.parsed_message.crypt
+ self.mailer.bounce_message(message, [sendto[0][1]], m, crypt=crypt)
+ except Unauthorized, value:
+ # just inform the user that he is not authorized
+ m = ['']
+ m.append(str(value))
+ if self.parsed_message:
+ message = self.parsed_message.message
+ crypt = self.parsed_message.crypt
+ self.mailer.bounce_message(message, [sendto[0][1]], m, crypt=crypt)
+ except IgnoreMessage:
+ # do not take any action
+ # this exception is thrown when email should be ignored
+ msg = 'IgnoreMessage raised'
+ if message.getheader('message-id'):
+ msg += ' (Message-id=%r)'%message.getheader('message-id')
+ self.logger.info(msg)
+ return
+ except:
+ msg = 'Exception handling message'
+ if message.getheader('message-id'):
+ msg += ' (Message-id=%r)'%message.getheader('message-id')
+ self.logger.exception(msg)
+
+ # bounce the message back to the sender with the error message
+ # let the admin know that something very bad is happening
+ m = ['']
+ m.append('An unexpected error occurred during the processing')
+ m.append('of your message. The tracker administrator is being')
+ m.append('notified.\n')
+ if self.parsed_message:
+ message = self.parsed_message.message
+ crypt = self.parsed_message.crypt
+ self.mailer.bounce_message(message, [sendto[0][1]], m, crypt=crypt)
+
+ m.append('----------------')
+ m.append(traceback.format_exc())
+ self.mailer.bounce_message(message, [self.instance.config.ADMIN_EMAIL], m)
+
+ def handle_message(self, message):
+ ''' message - a Message instance
+
+ Parse the message as per the module docstring.
+ '''
+ # get database handle for handling one email
+ self.db = self.instance.open ('admin')
+ try:
+ return self._handle_message(message)
+ finally:
+ self.db.close()
+
+ def _handle_message(self, message):
+ ''' message - a Message instance
+
+ Parse the message as per the module docstring.
+ The following code expects an opened database and a try/finally
+ that closes the database.
+ '''
+ self.parsed_message = self.parsed_message_class(self, message)
+ nodeid = self.parsed_message.parse ()
# commit the changes to the DB
self.db.commit()
+ self.parsed_message = None
return nodeid
+ def get_class_arguments(self, class_type, classname=None):
+ ''' class_type - a valid node class type:
+ - 'user' refers to the author of a message
+ - 'issue' refers to an issue-type class (to which the
+ message is appended) specified in parameter classname
+ Note that this need not be the real classname, we get
+ the real classname used as a parameter (from previous
+ message-parsing steps)
+ - 'file' specifies a file-type class
+ - 'msg' is the message-class
+ classname - the name of the current issue-type class
+
+ Parse the commandline arguments and retrieve the properties that
+ are relevant to the class_type. We now allow multiple -S options
+ per class_type (-C option).
+ '''
+ allprops = {}
+
+ classname = classname or class_type
+ cls_lookup = { 'issue' : classname }
+
+ # Allow other issue-type classes -- take the real classname from
+ # previous parsing-steps of the message:
+ clsname = cls_lookup.get (class_type, class_type)
+
+ # check if the clsname is valid
+ try:
+ self.db.getclass(clsname)
+ except KeyError:
+ mailadmin = self.instance.config['ADMIN_EMAIL']
+ raise MailUsageError, _("""
+The mail gateway is not properly set up. Please contact
+%(mailadmin)s and have them fix the incorrect class specified as:
+ %(clsname)s
+""") % locals()
+
+ if self.arguments:
+ # The default type on the commandline is msg
+ if class_type == 'msg':
+ current_type = class_type
+ else:
+ current_type = None
+
+ # Handle the arguments specified by the email gateway command line.
+ # We do this by looping over the list of self.arguments looking for
+ # a -C to match the class we want, then use the -S setting string.
+ for option, propstring in self.arguments:
+ if option in ( '-C', '--class'):
+ current_type = propstring.strip()
+
+ if current_type != class_type:
+ current_type = None
+
+ elif current_type and option in ('-S', '--set'):
+ cls = cls_lookup.get (current_type, current_type)
+ temp_cl = self.db.getclass(cls)
+ errors, props = setPropArrayFromString(self,
+ temp_cl, propstring.strip())
+
+ if errors:
+ mailadmin = self.instance.config['ADMIN_EMAIL']
+ raise MailUsageError, _("""
+The mail gateway is not properly set up. Please contact
+%(mailadmin)s and have them fix the incorrect properties:
+ %(errors)s
+""") % locals()
+ allprops.update(props)
+
+ return allprops
+
+
+def setPropArrayFromString(self, cl, propString, nodeid=None):
+ ''' takes string of form prop=value,value;prop2=value
+ and returns (error, prop[..])
+ '''
+ props = {}
+ errors = []
+ for prop in string.split(propString, ';'):
+ # extract the property name and value
+ try:
+ propname, value = prop.split('=')
+ except ValueError, message:
+ errors.append(_('not of form [arg=value,value,...;'
+ 'arg=value,value,...]'))
+ return (errors, props)
+ # convert the value to a hyperdb-usable value
+ propname = propname.strip()
+ try:
+ props[propname] = hyperdb.rawToHyperdb(self.db, cl, nodeid,
+ propname, value)
+ except hyperdb.HyperdbValueError, message:
+ errors.append(str(message))
+ return errors, props
+
+
def extractUserFromList(userClass, users):
'''Given a list of users, try to extract the first non-anonymous user
and return that user, otherwise return None
return users[0]
return None
-def uidFromAddress(db, address, create=1):
+
+def uidFromAddress(db, address, create=1, **user_props):
''' address is from the rfc822 module, and therefore is (name, addr)
user is created if they don't exist in the db already
+ user_props may supply additional user information
'''
(realname, address) = address
# try a straight match of the address
user = extractUserFromList(db.user, db.user.stringFind(address=address))
- if user is not None: return user
+ if user is not None:
+ return user
# try the user alternate addresses if possible
props = db.user.getprops()
if props.has_key('alternate_addresses'):
- users = db.user.filter(None, {'alternate_addresses': address},
- [], [])
- user = extractUserFromList(db.user, users)
- if user is not None: return user
+ users = db.user.filter(None, {'alternate_addresses': address})
+ # We want an exact match of the email, not just a substring
+ # match. Otherwise e.g. support@example.com would match
+ # discuss-support@example.com which is not what we want.
+ found_users = []
+ for u in users:
+ alt = db.user.get(u, 'alternate_addresses').split('\n')
+ for a in alt:
+ if a.strip().lower() == address.lower():
+ found_users.append(u)
+ break
+ user = extractUserFromList(db.user, found_users)
+ if user is not None:
+ return user
# try to match the username to the address (for local
# submissions where the address is empty)
# couldn't match address or username, so create a new user
if create:
- return db.user.create(username=address, address=address,
- realname=realname, roles=db.config.NEW_EMAIL_USER_ROLES)
+ # generate a username
+ if '@' in address:
+ username = address.split('@')[0]
+ else:
+ username = address
+ trying = username
+ n = 0
+ while 1:
+ try:
+ # does this username exist already?
+ db.user.lookup(trying)
+ except KeyError:
+ break
+ n += 1
+ trying = username + str(n)
+
+ # create!
+ try:
+ return db.user.create(username=trying, address=address,
+ realname=realname, roles=db.config.NEW_EMAIL_USER_ROLES,
+ password=password.Password(password.generatePassword(), config=db.config),
+ **user_props)
+ except exceptions.Reject:
+ return 0
else:
return 0
-def parseContent(content, keep_citations, keep_body,
- blank_line=re.compile(r'[\r\n]+\s*[\r\n]+'),
- eol=re.compile(r'[\r\n]+'),
- signature=re.compile(r'^[>|\s]*[-_]+\s*$'),
- original_message=re.compile(r'^[>|\s]*-----Original Message-----$')):
- ''' The message body is divided into sections by blank lines.
- Sections where the second and all subsequent lines begin with a ">" or "|"
- character are considered "quoting sections". The first line of the first
- non-quoting section becomes the summary of the message.
- '''
+def parseContent(content, keep_citations=None, keep_body=None, config=None):
+ """Parse mail message; return message summary and stripped content
+
+ The message body is divided into sections by blank lines.
+ Sections where the second and all subsequent lines begin with a ">"
+ or "|" character are considered "quoting sections". The first line of
+ the first non-quoting section becomes the summary of the message.
+
+ Arguments:
+
+ keep_citations: declared for backward compatibility.
+ If omitted or None, use config["MAILGW_KEEP_QUOTED_TEXT"]
+
+ keep_body: declared for backward compatibility.
+ If omitted or None, use config["MAILGW_LEAVE_BODY_UNCHANGED"]
+
+ config: tracker configuration object.
+ If omitted or None, use default configuration.
+
+ """
+ if config is None:
+ config = configuration.CoreConfig()
+ if keep_citations is None:
+ keep_citations = config["MAILGW_KEEP_QUOTED_TEXT"]
+ if keep_body is None:
+ keep_body = config["MAILGW_LEAVE_BODY_UNCHANGED"]
+ eol = config["MAILGW_EOL_RE"]
+ signature = config["MAILGW_SIGN_RE"]
+ original_msg = config["MAILGW_ORIGMSG_RE"]
+
# strip off leading carriage-returns / newlines
i = 0
for i in range(len(content)):
if content[i] not in '\r\n':
break
if i > 0:
- sections = blank_line.split(content[i:])
+ sections = config["MAILGW_BLANKLINE_RE"].split(content[i:])
else:
- sections = blank_line.split(content)
+ sections = config["MAILGW_BLANKLINE_RE"].split(content)
# extract out the summary from the message
summary = ''
# see if there's a response somewhere inside this section (ie.
# no blank line between quoted message and response)
for line in lines[1:]:
- if line[0] not in '>|':
+ if line and line[0] not in '>|':
break
else:
# we keep quoted bits if specified in the config
l.append(section)
continue
# keep this section - it has reponse stuff in it
- if not summary:
- # and while we're at it, use the first non-quoted bit as
- # our summary
- summary = line
lines = lines[lines.index(line):]
section = '\n'.join(lines)
+ # and while we're at it, use the first non-quoted bit as
+ # our summary
+ summary = section
if not summary:
# if we don't have our summary yet use the first line of this
# section
- summary = lines[0]
+ summary = section
elif signature.match(lines[0]) and 2 <= len(lines) <= 10:
# lose any signature
break
- elif original_message.match(lines[0]):
+ elif original_msg.match(lines[0]):
# ditch the stupid Outlook quoting of the entire original message
break
# and add the section to the output
l.append(section)
- # we only set content for those who want to delete cruft from the
- # message body, otherwise the body is left untouched.
+
+ # figure the summary - find the first sentence-ending punctuation or the
+ # first whole line, whichever is longest
+ sentence = re.search(r'^([^!?\.]+[!?\.])', summary)
+ if sentence:
+ sentence = sentence.group(1)
+ else:
+ sentence = ''
+ first = eol.split(summary)[0]
+ summary = max(sentence, first)
+
+ # Now reconstitute the message content minus the bits we don't care
+ # about.
if not keep_body:
content = '\n\n'.join(l)
+
return summary, content
-#
-# $Log: not supported by cvs2svn $
-# Revision 1.78 2002/07/25 07:14:06 richard
-# Bugger it. Here's the current shape of the new security implementation.
-# Still to do:
-# . call the security funcs from cgi and mailgw
-# . change shipped templates to include correct initialisation and remove
-# the old config vars
-# ... that seems like a lot. The bulk of the work has been done though. Honest :)
-#
-# Revision 1.77 2002/07/18 11:17:31 gmcm
-# Add Number and Boolean types to hyperdb.
-# Add conversion cases to web, mail & admin interfaces.
-# Add storage/serialization cases to back_anydbm & back_metakit.
-#
-# Revision 1.76 2002/07/10 06:39:37 richard
-# . made mailgw handle set and modify operations on multilinks (bug #579094)
-#
-# Revision 1.75 2002/07/09 01:21:24 richard
-# Added ability for unit tests to turn off exception handling in mailgw so
-# that exceptions are reported earlier (and hence make sense).
-#
-# Revision 1.74 2002/05/29 01:16:17 richard
-# Sorry about this huge checkin! It's fixing a lot of related stuff in one go
-# though.
-#
-# . #541941 ] changing multilink properties by mail
-# . #526730 ] search for messages capability
-# . #505180 ] split MailGW.handle_Message
-# - also changed cgi client since it was duplicating the functionality
-# . build htmlbase if tests are run using CVS checkout (removed note from
-# installation.txt)
-# . don't create an empty message on email issue creation if the email is empty
-#
-# Revision 1.73 2002/05/22 04:12:05 richard
-# . applied patch #558876 ] cgi client customization
-# ... with significant additions and modifications ;)
-# - extended handling of ML assignedto to all places it's handled
-# - added more NotFound info
-#
-# Revision 1.72 2002/05/22 01:24:51 richard
-# Added note to MIGRATION about new config vars. Also made us more resilient
-# for upgraders. Reinstated list header style (oops)
-#
-# Revision 1.71 2002/05/08 02:40:55 richard
-# grr
-#
-# Revision 1.70 2002/05/06 23:40:07 richard
-# hrm
-#
-# Revision 1.69 2002/05/06 23:37:21 richard
-# Tweaking the signature deletion from mail messages.
-# Added nuking of the "-----Original Message-----" crap from Outlook.
-#
-# Revision 1.68 2002/05/02 07:56:34 richard
-# . added option to automatically add the authors and recipients of messages
-# to the nosy lists with the options ADD_AUTHOR_TO_NOSY (default 'new') and
-# ADD_RECIPIENTS_TO_NOSY (default 'new'). These settings emulate the current
-# behaviour. Setting them to 'yes' will add the author/recipients to the nosy
-# on messages that create issues and followup messages.
-# . added missing documentation for a few of the config option values
-#
-# Revision 1.67 2002/04/23 15:46:49 rochecompaan
-# . stripping of the email message body can now be controlled through
-# the config variables EMAIL_KEEP_QUOTED_TEST and
-# EMAIL_LEAVE_BODY_UNCHANGED.
-#
-# Revision 1.66 2002/03/14 23:59:24 richard
-# . #517734 ] web header customisation is obscure
-#
-# Revision 1.65 2002/02/15 00:13:38 richard
-# . #503204 ] mailgw needs a default class
-# - partially done - the setting of additional properties can wait for a
-# better configuration system.
-#
-# Revision 1.64 2002/02/14 23:46:02 richard
-# . #516883 ] mail interface + ANONYMOUS_REGISTER
-#
-# Revision 1.63 2002/02/12 08:08:55 grubert
-# . Clean up mail handling, multipart handling.
-#
-# Revision 1.62 2002/02/05 14:15:29 grubert
-# . respect encodings in non multipart messages.
-#
-# Revision 1.61 2002/02/04 09:40:21 grubert
-# . add test for multipart messages with first part being encoded.
-#
-# Revision 1.60 2002/02/01 07:43:12 grubert
-# . mailgw checks encoding on first part too.
-#
-# Revision 1.59 2002/01/23 21:43:23 richard
-# tabnuke
-#
-# Revision 1.58 2002/01/23 21:41:56 richard
-# . mailgw failures (unexpected ones) are forwarded to the roundup admin
-#
-# Revision 1.57 2002/01/22 22:27:43 richard
-# . handle stripping of "AW:" from subject line
-#
-# Revision 1.56 2002/01/22 11:54:45 rochecompaan
-# Fixed status change in mail gateway.
-#
-# Revision 1.55 2002/01/21 10:05:47 rochecompaan
-# Feature:
-# . the mail gateway now responds with an error message when invalid
-# values for arguments are specified for link or multilink properties
-# . modified unit test to check nosy and assignedto when specified as
-# arguments
-#
-# Fixed:
-# . fixed setting nosy as argument in subject line
-#
-# Revision 1.54 2002/01/16 09:14:45 grubert
-# . if the attachment has no name, name it unnamed, happens with tnefs.
-#
-# Revision 1.53 2002/01/16 07:20:54 richard
-# simple help command for mailgw
-#
-# Revision 1.52 2002/01/15 00:12:40 richard
-# #503340 ] creating issue with [asignedto=p.ohly]
-#
-# Revision 1.51 2002/01/14 02:20:15 richard
-# . changed all config accesses so they access either the instance or the
-# config attriubute on the db. This means that all config is obtained from
-# instance_config instead of the mish-mash of classes. This will make
-# switching to a ConfigParser setup easier too, I hope.
-#
-# At a minimum, this makes migration a _little_ easier (a lot easier in the
-# 0.5.0 switch, I hope!)
-#
-# Revision 1.50 2002/01/11 22:59:01 richard
-# . #502342 ] pipe interface
-#
-# Revision 1.49 2002/01/10 06:19:18 richard
-# followup lines directly after a quoted section were being eaten.
-#
-# Revision 1.48 2002/01/08 04:12:05 richard
-# Changed message-id format to "<%s.%s.%s%s@%s>" so it complies with RFC822
-#
-# Revision 1.47 2002/01/02 02:32:38 richard
-# ANONYMOUS_ACCESS -> ANONYMOUS_REGISTER
-#
-# Revision 1.46 2002/01/02 02:31:38 richard
-# Sorry for the huge checkin message - I was only intending to implement #496356
-# but I found a number of places where things had been broken by transactions:
-# . modified ROUNDUPDBSENDMAILDEBUG to be SENDMAILDEBUG and hold a filename
-# for _all_ roundup-generated smtp messages to be sent to.
-# . the transaction cache had broken the roundupdb.Class set() reactors
-# . newly-created author users in the mailgw weren't being committed to the db
-#
-# Stuff that made it into CHANGES.txt (ie. the stuff I was actually working
-# on when I found that stuff :):
-# . #496356 ] Use threading in messages
-# . detectors were being registered multiple times
-# . added tests for mailgw
-# . much better attaching of erroneous messages in the mail gateway
-#
-# Revision 1.45 2001/12/20 15:43:01 rochecompaan
-# Features added:
-# . Multilink properties are now displayed as comma separated values in
-# a textbox
-# . The add user link is now only visible to the admin user
-# . Modified the mail gateway to reject submissions from unknown
-# addresses if ANONYMOUS_ACCESS is denied
-#
-# Revision 1.44 2001/12/18 15:30:34 rochecompaan
-# Fixed bugs:
-# . Fixed file creation and retrieval in same transaction in anydbm
-# backend
-# . Cgi interface now renders new issue after issue creation
-# . Could not set issue status to resolved through cgi interface
-# . Mail gateway was changing status back to 'chatting' if status was
-# omitted as an argument
-#
-# Revision 1.43 2001/12/15 19:39:01 rochecompaan
-# Oops.
-#
-# Revision 1.42 2001/12/15 19:24:39 rochecompaan
-# . Modified cgi interface to change properties only once all changes are
-# collected, files created and messages generated.
-# . Moved generation of change note to nosyreactors.
-# . We now check for changes to "assignedto" to ensure it's added to the
-# nosy list.
-#
-# Revision 1.41 2001/12/10 00:57:38 richard
-# From CHANGES:
-# . Added the "display" command to the admin tool - displays a node's values
-# . #489760 ] [issue] only subject
-# . fixed the doc/index.html to include the quoting in the mail alias.
-#
-# Also:
-# . fixed roundup-admin so it works with transactions
-# . disabled the back_anydbm module if anydbm tries to use dumbdbm
-#
-# Revision 1.40 2001/12/05 14:26:44 rochecompaan
-# Removed generation of change note from "sendmessage" in roundupdb.py.
-# The change note is now generated when the message is created.
-#
-# Revision 1.39 2001/12/02 05:06:16 richard
-# . We now use weakrefs in the Classes to keep the database reference, so
-# the close() method on the database is no longer needed.
-# I bumped the minimum python requirement up to 2.1 accordingly.
-# . #487480 ] roundup-server
-# . #487476 ] INSTALL.txt
-#
-# I also cleaned up the change message / post-edit stuff in the cgi client.
-# There's now a clearly marked "TODO: append the change note" where I believe
-# the change note should be added there. The "changes" list will obviously
-# have to be modified to be a dict of the changes, or somesuch.
-#
-# More testing needed.
-#
-# Revision 1.38 2001/12/01 07:17:50 richard
-# . We now have basic transaction support! Information is only written to
-# the database when the commit() method is called. Only the anydbm
-# backend is modified in this way - neither of the bsddb backends have been.
-# The mail, admin and cgi interfaces all use commit (except the admin tool
-# doesn't have a commit command, so interactive users can't commit...)
-# . Fixed login/registration forwarding the user to the right page (or not,
-# on a failure)
-#
-# Revision 1.37 2001/11/28 21:55:35 richard
-# . login_action and newuser_action return values were being ignored
-# . Woohoo! Found that bloody re-login bug that was killing the mail
-# gateway.
-# (also a minor cleanup in hyperdb)
-#
-# Revision 1.36 2001/11/26 22:55:56 richard
-# Feature:
-# . Added INSTANCE_NAME to configuration - used in web and email to identify
-# the instance.
-# . Added EMAIL_SIGNATURE_POSITION to indicate where to place the roundup
-# signature info in e-mails.
-# . Some more flexibility in the mail gateway and more error handling.
-# . Login now takes you to the page you back to the were denied access to.
-#
-# Fixed:
-# . Lots of bugs, thanks Roché and others on the devel mailing list!
-#
-# Revision 1.35 2001/11/22 15:46:42 jhermann
-# Added module docstrings to all modules.
-#
-# Revision 1.34 2001/11/15 10:24:27 richard
-# handle the case where there is no file attached
-#
-# Revision 1.33 2001/11/13 21:44:44 richard
-# . re-open the database as the author in mail handling
-#
-# Revision 1.32 2001/11/12 22:04:29 richard
-# oops, left debug in there
-#
-# Revision 1.31 2001/11/12 22:01:06 richard
-# Fixed issues with nosy reaction and author copies.
-#
-# Revision 1.30 2001/11/09 22:33:28 richard
-# More error handling fixes.
-#
-# Revision 1.29 2001/11/07 05:29:26 richard
-# Modified roundup-mailgw so it can read e-mails from a local mail spool
-# file. Truncates the spool file after parsing.
-# Fixed a couple of small bugs introduced in roundup.mailgw when I started
-# the popgw.
-#
-# Revision 1.28 2001/11/01 22:04:37 richard
-# Started work on supporting a pop3-fetching server
-# Fixed bugs:
-# . bug #477104 ] HTML tag error in roundup-server
-# . bug #477107 ] HTTP header problem
-#
-# Revision 1.27 2001/10/30 11:26:10 richard
-# Case-insensitive match for ISSUE_TRACKER_EMAIL in address in e-mail.
-#
-# Revision 1.26 2001/10/30 00:54:45 richard
-# Features:
-# . #467129 ] Lossage when username=e-mail-address
-# . #473123 ] Change message generation for author
-# . MailGW now moves 'resolved' to 'chatting' on receiving e-mail for an issue.
-#
-# Revision 1.25 2001/10/28 23:22:28 richard
-# fixed bug #474749 ] Indentations lost
-#
-# Revision 1.24 2001/10/23 22:57:52 richard
-# Fix unread->chatting auto transition, thanks Roch'e
-#
-# Revision 1.23 2001/10/21 04:00:20 richard
-# MailGW now moves 'unread' to 'chatting' on receiving e-mail for an issue.
-#
-# Revision 1.22 2001/10/21 03:35:13 richard
-# bug #473125: Paragraph in e-mails
-#
-# Revision 1.21 2001/10/21 00:53:42 richard
-# bug #473130: Nosy list not set correctly
-#
-# Revision 1.20 2001/10/17 23:13:19 richard
-# Did a fair bit of work on the admin tool. Now has an extra command "table"
-# which displays node information in a tabular format. Also fixed import and
-# export so they work. Removed freshen.
-# Fixed quopri usage in mailgw from bug reports.
-#
-# Revision 1.19 2001/10/11 23:43:04 richard
-# Implemented the comma-separated printing option in the admin tool.
-# Fixed a typo (more of a vim-o actually :) in mailgw.
-#
-# Revision 1.18 2001/10/11 06:38:57 richard
-# Initial cut at trying to handle people responding to CC'ed messages that
-# create an issue.
-#
-# Revision 1.17 2001/10/09 07:25:59 richard
-# Added the Password property type. See "pydoc roundup.password" for
-# implementation details. Have updated some of the documentation too.
-#
-# Revision 1.16 2001/10/05 02:23:24 richard
-# . roundup-admin create now prompts for property info if none is supplied
-# on the command-line.
-# . hyperdb Class getprops() method may now return only the mutable
-# properties.
-# . Login now uses cookies, which makes it a whole lot more flexible. We can
-# now support anonymous user access (read-only, unless there's an
-# "anonymous" user, in which case write access is permitted). Login
-# handling has been moved into cgi_client.Client.main()
-# . The "extended" schema is now the default in roundup init.
-# . The schemas have had their page headings modified to cope with the new
-# login handling. Existing installations should copy the interfaces.py
-# file from the roundup lib directory to their instance home.
-# . Incorrectly had a Bizar Software copyright on the cgitb.py module from
-# Ping - has been removed.
-# . Fixed a whole bunch of places in the CGI interface where we should have
-# been returning Not Found instead of throwing an exception.
-# . Fixed a deviation from the spec: trying to modify the 'id' property of
-# an item now throws an exception.
-#
-# Revision 1.15 2001/08/30 06:01:17 richard
-# Fixed missing import in mailgw :(
-#
-# Revision 1.14 2001/08/13 23:02:54 richard
-# Make the mail parser a little more robust.
-#
-# Revision 1.13 2001/08/12 06:32:36 richard
-# using isinstance(blah, Foo) now instead of isFooType
-#
-# Revision 1.12 2001/08/08 01:27:00 richard
-# Added better error handling to mailgw.
-#
-# Revision 1.11 2001/08/08 00:08:03 richard
-# oops ;)
-#
-# Revision 1.10 2001/08/07 00:24:42 richard
-# stupid typo
-#
-# Revision 1.9 2001/08/07 00:15:51 richard
-# Added the copyright/license notice to (nearly) all files at request of
-# Bizar Software.
-#
-# Revision 1.8 2001/08/05 07:06:07 richard
-# removed some print statements
-#
-# Revision 1.7 2001/08/03 07:18:22 richard
-# Implemented correct mail splitting (was taking a shortcut). Added unit
-# tests. Also snips signatures now too.
-#
-# Revision 1.6 2001/08/01 04:24:21 richard
-# mailgw was assuming certain properties existed on the issues being created.
-#
-# Revision 1.5 2001/07/29 07:01:39 richard
-# Added vim command to all source so that we don't get no steenkin' tabs :)
-#
-# Revision 1.4 2001/07/28 06:43:02 richard
-# Multipart message class has the getPart method now. Added some tests for it.
-#
-# Revision 1.3 2001/07/28 00:34:34 richard
-# Fixed some non-string node ids.
-#
-# Revision 1.2 2001/07/22 12:09:32 richard
-# Final commit of Grande Splite
-#
-#
-# vim: set filetype=python ts=4 sw=4 et si
+# vim: set filetype=python sts=4 sw=4 et si :