![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/roundup/mailgw.py b/roundup/mailgw.py
index 468a3b7f2f25cfbd2add7fdf6d4325da176da930..67cf6a3739e10ad27d22d5f4913e58b7f4d92432 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.
#
-'''
-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.
+explanatory message given in the exception.
-$Id: mailgw.py,v 1.114 2003-04-10 05:12:41 richard Exp $
-'''
+$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, sys
-import traceback, MimeWriter, rfc822
+import time, random, sys, logging
+import traceback, rfc822
-from roundup import hyperdb, date, password, rfc2822
+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.gpgme
+except ImportError:
+ pyme = None
SENDMAILDEBUG = os.environ.get('SENDMAILDEBUG', '')
pass
class MailUsageHelp(Exception):
- pass
-
-class MailLoop(Exception):
- ''' We've seen this message before... '''
+ """ 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.
'''
- 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)
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
+ '''
+ u = key.uids
+ while u:
+ yield getattr(u, attr)
+ u = u.next
+
+def gpgh_sigs(sig):
+ ''' more pythonic iteration over GPG signatures '''
+ while sig:
+ yield sig
+ sig = sig.next
+
+def check_pgp_sigs(sig, gpgctx, author):
+ ''' Theoretically a PGP message can have several signatures. GPGME
+ returns status on all signatures in a linked list. Walk that
+ linked list looking for the author's signature
+ '''
+ for sig in gpgh_sigs(sig):
+ 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.gpgme.GPGME_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.gpgme.GPGME_SIGSUM_KEY_MISSING:
+ raise MailUsageError, \
+ _("Message signed with unknown key: %s") % sig.fpr
+ elif sig.summary & pyme.gpgme.GPGME_SIGSUM_KEY_EXPIRED:
+ raise MailUsageError, \
+ _("Message signed with an expired key: %s") % sig.fpr
+ elif sig.summary & pyme.gpgme.GPGME_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
+ raise MailUsageError, _("Message signed with unknown key: %s") % sig.fpr
+
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)
+ def getparts(self):
+ """Get all parts of this multipart message."""
+ # skip over the intro to the first boundary
+ self.fp.seek(0)
+ 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)
- return rfc2822.decode_header(hdr)
-
-subject_re = re.compile(r'(?P<refwd>\s*\W?\s*(fw|fwd|re|aw)\W\s*)*'
- r'\s*(?P<quote>")?(\[(?P<classname>[^\d\s]+)(?P<nodeid>\d+)?\])?'
- r'\s*(?P<title>[^[]+)?"?(\[(?P<args>.+?)\])?', re.I)
+ # 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
+ # historically this method has returned utf-8 encoded string
+ l = []
+ for part, encoding in decode_header(hdr):
+ if encoding:
+ part = part.decode(encoding)
+ l.append(part)
+ return ''.join([s.encode('utf-8') for s in l])
+
+ def getaddrlist(self, name):
+ # overload to decode the name part of the address
+ l = []
+ for (name, addr) in mimetools.Message.getaddrlist(self, name):
+ p = []
+ for part, encoding in decode_header(name):
+ if encoding:
+ part = part.decode(encoding)
+ p.append(part)
+ name = ''.join([s.encode('utf-8') for s in p])
+ 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')
+
+ 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 - 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 = []
+
+ 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
+ '''
+ return self.gettype() == 'multipart/signed' \
+ and self.typeheader.find('protocol="application/pgp-signature"') != -1
+
+ 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):
+ ''' decrypt an OpenPGP MIME message
+ This message must be signed as well as encrypted using the "combined"
+ method. 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() != '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)
+
+ 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.")
+
+ context = pyme.core.Context()
+ # 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.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 MailGW:
- def __init__(self, instance, db, arguments={}):
+
+ def __init__(self, instance, arguments=()):
self.instance = instance
- self.db = db
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 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)
return 0
def do_mailbox(self, filename):
- ''' Read a series of messages from the specified unix mailbox file and
+ """ 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
+ 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)
fcntl.flock(f.fileno(), FCNTL.LOCK_UN)
return 0
- def do_apop(self, server, user='', password=''):
+ 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, apop=1)
+ self._do_pop(server, user, password, True, ssl)
- def do_pop(self, server, user='', password='', apop=0):
+ 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: '))
+ user = raw_input('User: ')
if not password:
password = getpass.getpass()
except (KeyboardInterrupt, EOFError):
# open a connection to the server and retrieve all messages
try:
- server = poplib.POP3(server)
- except socket.error, message:
- print "POP server error:", message
+ 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)
server.pass_(password)
numMessages = len(server.list()[1])
for i in range(1, numMessages+1):
- # retr: returns
+ # retr: returns
# [ pop response e.g. '+OK 459 octets',
# [ array of message lines ],
# number of octets ]
return self.handle_Message(Message(fp))
def handle_Message(self, message):
- '''Handle an RFC822 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 MailLoop:
- # XXX we should use a log file here...
- return
- except:
- # bounce the message back to the sender with the error message
- # XXX we should use a log file here...
- sendto = [sendto[0][1], self.instance.config.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:
+
+ 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
- # XXX we should use a log file here...
- sendto = [self.instance.config.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, 'a').write('From: %s\nTo: %s\n%s\n'%(
- self.instance.config.ADMIN_EMAIL, ', '.join(sendto),
- m.getvalue()))
- else:
- try:
- smtp = smtplib.SMTP(self.instance.config.MAILHOST)
- smtp.sendmail(self.instance.config.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('X-Roundup-Loop', 'hello')
- writer.addheader('Subject', subject)
- writer.addheader('From', '%s <%s>'% (self.instance.config.TRACKER_NAME,
- self.instance.config.TRACKER_EMAIL))
- writer.addheader('To', ','.join(sendto))
- writer.addheader('Date', time.strftime("%a, %d %b %Y %H:%M:%S +0000",
- time.gmtime()))
- writer.addheader('MIME-Version', '1.0')
- part = writer.startmultipartbody('mixed')
- part = writer.nextpart()
- body = part.startbody('text/plain; charset=utf-8')
- body.write('\n'.join(error))
-
- # attach the original message to the returned message
- part = writer.nextpart()
- part.addheader('Content-Disposition','attachment')
- part.addheader('Content-Description','Message you sent')
- body = part.startbody('text/plain')
- for header in message.headers:
- body.write(header)
- body.write('\n')
+ 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
try:
- message.rewindbody()
- except IOError, message:
- body.write("*** couldn't include message body: %s ***"%message)
- else:
- body.write(message.fp.read())
+ 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)
+ self.mailer.bounce_message(message, [sendto[0][1]], m)
+ except Unauthorized, value:
+ # just inform the user that he is not authorized
+ m = ['']
+ m.append(str(value))
+ self.mailer.bounce_message(message, [sendto[0][1]], m)
+ 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')
+ self.mailer.bounce_message(message, [sendto[0][1]], m)
+
+ m.append('----------------')
+ m.append(traceback.format_exc())
+ self.mailer.bounce_message(message, [self.instance.config.ADMIN_EMAIL], m)
- writer.lastpart()
- return msg
+ def handle_message(self, message):
+ ''' message - a Message instance
- 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
+ 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):
+ def _handle_message(self, message):
''' message - a Message instance
Parse the message as per the module docstring.
+
+ The implementation expects an opened database and a try/finally
+ that closes the database.
'''
# detect loops
if message.getheader('x-roundup-loop', ''):
- raise MailLoop
+ raise IgnoreLoop
+
+ # handle the subject line
+ subject = message.getheader('subject', '')
+ if not subject:
+ raise MailUsageError, _("""
+Emails to Roundup trackers must include a Subject: line!
+""")
+
+ # detect Precedence: Bulk, or Microsoft Outlook autoreplies
+ if (message.getheader('precedence', '') == 'bulk'
+ or subject.lower().find("autoreply") > 0):
+ raise IgnoreBulk
+
+ if subject.strip().lower() == 'help':
+ raise MailUsageHelp
+
+ # config is used many times in this method.
+ # make local variable for easier access
+ config = self.instance.config
+
+ # determine the sender's address
+ from_list = message.getaddrlist('resent-from')
+ if not from_list:
+ from_list = message.getaddrlist('from')
# 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
-# if hasattr(self.instance.config, 'EMAIL_ISSUE_ADDRESS_RE') and \
-# self.instance.config.EMAIL_ISSUE_ADDRESS_RE:
-# issue_re = self.instance.config.EMAIL_ISSUE_ADDRESS_RE
+# issue_re = config['MAILGW_ISSUE_ADDRESS_RE']
+# if issue_re:
# for header in ['to', 'cc', 'bcc']:
# addresses = message.getheader(header, '')
# if addresses:
# nodeid = issue.group('nodeid')
# break
- # handle the subject line
- subject = message.getheader('subject', '')
+ # Matches subjects like:
+ # Re: "[issue1234] title of issue [status=resolved]"
- if subject.strip().lower() == 'help':
- raise MailUsageHelp
+ # Alias since we need a reference to the original subject for
+ # later use in error messages
+ tmpsubject = subject
- m = subject_re.match(subject)
+ sd_open, sd_close = 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
+ matches = dict.fromkeys(['refwd', 'quote', 'classname',
+ 'nodeid', 'title', 'args',
+ 'argswhole'])
+
+ # Look for Re: et. al. Used later on for MAILGW_SUBJECT_CONTENT_MATCH
+ re_re = r"(?P<refwd>%s)\s*" % 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.config, 'MAIL_DEFAULT_CLASS') and \
- self.instance.config.MAIL_DEFAULT_CLASS:
- classname = self.instance.config.MAIL_DEFAULT_CLASS
- else:
- # fail
- m = None
+ m = m.groupdict()
+ if m['refwd']:
+ 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:
+ matches.update(m.groupdict())
+ tmpsubject = tmpsubject[len(matches['quote']):] # Consume quote
+
+ has_prefix = re.search(r'^%s(\w+)%s'%(delim_open,
+ delim_close), tmpsubject.strip())
+
+ 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:
+ matches.update(m.groupdict())
+ # Skip to the end of the class identifier, including any
+ # garbage before it.
+
+ tmpsubject = tmpsubject[m.end():]
+
+ # 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 matches['classname'] and '.' or '', delim_open)
+ m = re.match(title_re, tmpsubject.strip(), re.IGNORECASE)
+ if m:
+ matches.update(m.groupdict())
+ tmpsubject = tmpsubject[len(matches['title']):] # Consume title
+
+ 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:
+ matches.update(m.groupdict())
+
+ # figure subject line parsing modes
+ pfxmode = config['MAILGW_SUBJECT_PREFIX_PARSING']
+ sfxmode = config['MAILGW_SUBJECT_SUFFIX_PARSING']
+
+ # check for registration OTK
+ # or fallback on the default class
+ if self.db.config['EMAIL_REGISTRATION_CONFIRMATION']:
+ otk_re = re.compile('-- key (?P<otk>[a-zA-Z0-9]{32})')
+ otk = otk_re.search(matches['title'] or '')
+ if otk:
+ self.db.confirm_registration(otk.group('otk'))
+ subject = 'Your registration to %s is complete' % \
+ config['TRACKER_NAME']
+ sendto = [from_list[0][1]]
+ self.mailer.standard_message(sendto, subject, '')
+ return
+
+ # get the classname
+ if pfxmode == 'none':
+ classname = None
+ else:
+ classname = matches['classname']
- if not m:
- raise MailUsageError, '''
+ if not classname and has_prefix and 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.default_class:
+ attempts.append(self.default_class)
+ else:
+ attempts.append(config['MAILGW_DEFAULT_CLASS'])
+
+ # first valid class name wins
+ cl = None
+ for trycl in attempts:
+ try:
+ cl = self.db.getclass(trycl)
+ classname = trycl
+ break
+ except KeyError:
+ pass
+
+ if not 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.
+
+Subject was: '%(subject)s'
+""") % locals()
# get the optional nodeid
- nodeid = m.group('nodeid')
+ if pfxmode == 'none':
+ nodeid = None
+ else:
+ nodeid = matches['nodeid']
+
+ # try in-reply-to to match the message if there's no nodeid
+ inreplyto = message.getheader('in-reply-to') or ''
+ if nodeid is None and inreplyto:
+ l = self.db.getclass('msg').stringFind(messageid=inreplyto)
+ if l:
+ nodeid = cl.filter(None, {'messages':l})[0]
# title is optional too
- title = m.group('title')
+ title = matches['title']
if title:
title = title.strip()
else:
# strip off the quotes that dumb emailers put around the subject, like
# Re: "[issue1] bla blah"
- if m.group('quote') and title.endswith('"'):
+ if matches['quote'] and title.endswith('"'):
title = title[:-1]
# 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'):
+ # recent...). The subject_content_match config may specify an
+ # additional restriction based on the matched node's creation or
+ # activity.
+ tmatch_mode = config['MAILGW_SUBJECT_CONTENT_MATCH']
+ if tmatch_mode != 'never' and nodeid is None and matches['refwd']:
l = cl.stringFind(title=title)
- if l:
- nodeid = l[-1]
+ 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 < 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)
+ if 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:
+ title = subject
+ nodeid = None
# Handle the arguments specified by the email gateway command line.
# We do this by looping over the list of self.arguments looking for
for option, propstring in self.arguments:
if option in ( '-C', '--class'):
current_class = propstring.strip()
+ # XXX this is not flexible enough.
+ # we should chect for subclasses of these classes,
+ # not for the class name...
if current_class not in ('msg', 'file', 'user', 'issue'):
- raise MailUsageError, '''
+ mailadmin = config['ADMIN_EMAIL']
+ raise MailUsageError, _("""
The mail gateway is not properly set up. Please contact
-%s and have them fix the incorrect class specified as:
- %s
-'''%(self.instance.config.ADMIN_EMAIL, current_class)
+%(mailadmin)s and have them fix the incorrect class specified as:
+ %(current_class)s
+""") % locals()
if option in ('-S', '--set'):
if current_class == 'issue' :
errors, issue_props = setPropArrayFromString(self,
errors, user_props = setPropArrayFromString(self,
temp_cl, propstring.strip())
if errors:
- raise MailUsageError, '''
+ mailadmin = config['ADMIN_EMAIL']
+ raise MailUsageError, _("""
The mail gateway is not properly set up. Please contact
-%s and have them fix the incorrect properties:
- %s
-'''%(self.instance.config.ADMIN_EMAIL, errors)
+%(mailadmin)s and have them fix the incorrect properties:
+ %(errors)s
+""") % locals()
#
# handle the users
# 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
# ok, now figure out who the author is - create a new user if the
# "create" flag is true
- author = uidFromAddress(self.db, message.getaddrlist('from')[0],
- create=create)
+ author = uidFromAddress(self.db, 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 self.db.security.hasPermission('Email Access', author):
if author == anonid:
# we're anonymous and we need to be a registered user
- raise Unauthorized, '''
-You are not a registered user.
+ from_address = 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.instance.config.TRACKER_WEB
+ registration_info = """ Please register at:
+
+%(tracker_web)suser?template=register
-Unknown address: %s
-'''%message.getaddrlist('from')[0][1]
+...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.'
-
- # make sure they're allowed to edit this class of information
- if not self.db.security.hasPermission('Edit', author, classname):
- raise Unauthorized, 'You are not permitted to edit %s.'%classname
+ raise Unauthorized, _(
+ 'You are not permitted to access this tracker.')
+
+ # make sure they're allowed to edit or create this class of information
+ if nodeid:
+ if not self.db.security.hasPermission('Edit', author, classname,
+ itemid=nodeid):
+ raise Unauthorized, _(
+ 'You are not permitted to edit %(classname)s.') % locals()
+ else:
+ if not self.db.security.hasPermission('Create', author, classname):
+ raise Unauthorized, _(
+ 'You are not permitted to create %(classname)s.'
+ ) % locals()
# the author may have been created - make sure the change is
# committed before we reopen the database
self.db.commit()
- # reopen the database as the author
+ # set the database user as the author
username = self.db.user.get(author, 'username')
- self.db.close()
- self.db = self.instance.open(username)
+ self.db.setCurrentUser(username)
# re-get the class with the new database connection
cl = self.db.getclass(classname)
# now update the recipients list
recipients = []
- tracker_email = self.instance.config.TRACKER_EMAIL.lower()
+ tracker_email = config['TRACKER_EMAIL'].lower()
for recipient in message.getaddrlist('to') + message.getaddrlist('cc'):
r = recipient[1].strip().lower()
if r == tracker_email or not r:
if recipient:
recipients.append(recipient)
- #
- # XXX extract the args NOT USED WHY -- rouilj
- #
- 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')
+ args = matches['args']
+ argswhole = matches['argswhole']
if args:
- errors, props = setPropArrayFromString(self, cl, args, nodeid)
- # handle any errors parsing the argument list
- if errors:
- errors = '\n- '.join(errors)
- raise MailUsageError, '''
+ if sfxmode == 'none':
+ title += ' ' + argswhole
+ else:
+ errors, props = setPropArrayFromString(self, cl, args, nodeid)
+ # handle any errors parsing the argument list
+ if errors:
+ if sfxmode == 'strict':
+ errors = '\n- '.join(map(str, errors))
+ raise MailUsageError, _("""
There were problems handling your subject line argument list:
-- %s
+- %(errors)s
+
+Subject was: "%(subject)s"
+""") % locals()
+ else:
+ title += ' ' + argswhole
-Subject was: "%s"
-'''%(errors, subject)
+
+ # set the issue title to the subject
+ title = title.strip()
+ if (title and properties.has_key('title') and not
+ issue_props.has_key('title')):
+ issue_props['title'] = title
+ if (nodeid and properties.has_key('title') and not
+ config['MAILGW_SUBJECT_UPDATES_TITLE']):
+ issue_props['title'] = cl.get(nodeid,'title')
#
# handle message-id and in-reply-to
#
messageid = message.getheader('message-id')
- inreplyto = message.getheader('in-reply-to') or ''
# 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.config.MAIL_DOMAIN)
+ classname, nodeid, 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.
-'''
+ # if they've enabled PGP processing then verify the signature
+ # or decrypt the message
- elif content_type != 'text/plain':
- raise MailUsageError, '''
+ # if PGP_ROLES is specified the user must have a Role in the list
+ # or we will skip PGP processing
+ def pgp_role():
+ if self.instance.config.PGP_ROLES:
+ return self.db.user.has_role(author,
+ iter_roles(self.instance.config.PGP_ROLES))
+ else:
+ return True
+
+ if self.instance.config.PGP_ENABLE and pgp_role():
+ assert pyme, 'pyme is not installed'
+ # signed/encrypted mail must come from the primary address
+ author_address = self.db.user.get(author, 'address')
+ if self.instance.config.PGP_HOMEDIR:
+ os.environ['GNUPGHOME'] = self.instance.config.PGP_HOMEDIR
+ if message.pgp_signed():
+ message.verify_signature(author_address)
+ elif message.pgp_encrypted():
+ # replace message with the contents of the decrypted
+ # message for content extraction
+ # TODO: encrypted message handling is far from perfect
+ # bounces probably include the decrypted message, for
+ # instance :(
+ message = message.decrypt(author_address)
+ else:
+ raise MailUsageError, _("""
+This tracker has been configured to require all email be PGP signed or
+encrypted.""")
+ # now handle the body - find the message
+ ig = self.instance.config.MAILGW_IGNORE_ALTERNATIVES
+ content, attachments = message.extract_content(ignore_alternatives=ig,
+ unpack_rfc822 = self.instance.config.MAILGW_UNPACK_RFC822)
+ 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',
- 'no') == 'yes'
- keep_body = getattr(self.instance.config, '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)
+ summary, content = parseContent(content, config=config)
+ content = content.strip()
- #
+ #
# 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, **file_props))
+ if attachments and properties.has_key('files'):
+ for (name, mime_type, data) in attachments:
+ if not self.db.security.hasPermission('Create', 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 nodeid and not self.db.security.hasPermission('Edit', author,
+ classname, 'files'):
+ raise Unauthorized, _(
+ 'You are not permitted to add files to %(classname)s.'
+ ) % locals()
- #
+ if nodeid:
+ # extend the existing files list
+ fileprop = cl.get(nodeid, 'files')
+ fileprop.extend(files)
+ props['files'] = fileprop
+ else:
+ # pre-load the files list
+ props['files'] = files
+
+ #
# 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, **msg_props)
+ if (content and properties.has_key('messages')):
+ if not self.db.security.hasPermission('Create', author, 'msg'):
+ raise Unauthorized, _(
+ 'You are not permitted to create messages.')
+
+ try:
+ message_id = self.db.msg.create(author=author,
+ recipients=recipients, date=date.Date('.'),
+ summary=summary, content=content, files=files,
+ messageid=messageid, inreplyto=inreplyto, **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 nodeid and not self.db.security.hasPermission('Edit', author,
+ classname, 'messages'):
+ raise Unauthorized, _(
+ 'You are not permitted to add messages to %(classname)s.'
+ ) % locals()
- # attach the message to the node
if nodeid:
# add the message to the node's list
messages = cl.get(nodeid, 'messages')
# 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
-
#
# perform the node change / create
#
for prop in issue_props.keys() :
if not props.has_key(prop) :
props[prop] = issue_props[prop]
+
if nodeid:
+ # Check permissions for each property
+ for prop in props.keys():
+ if not self.db.security.hasPermission('Edit', author,
+ classname, prop):
+ raise Unauthorized, _('You are not permitted to edit '
+ 'property %(prop)s of class %(classname)s.') % locals()
cl.set(nodeid, **props)
else:
+ # Check permissions for each property
+ for prop in props.keys():
+ if not self.db.security.hasPermission('Create', author,
+ classname, prop):
+ raise Unauthorized, _('You are not permitted to set '
+ 'property %(prop)s of class %(classname)s.') % locals()
nodeid = cl.create(**props)
- except (TypeError, IndexError, ValueError), message:
- raise MailUsageError, '''
+ except (TypeError, IndexError, ValueError, exceptions.Reject), message:
+ raise MailUsageError, _("""
There was a problem with the message you sent:
- %s
-'''%message
+ %(message)s
+""") % locals()
# commit the changes to the DB
self.db.commit()
return nodeid
-
-def setPropArrayFromString(self, cl, propString, nodeid = None):
+
+def setPropArrayFromString(self, cl, propString, nodeid=None):
''' takes string of form prop=value,value;prop2=value
and returns (error, prop[..])
'''
- properties = cl.getprops()
props = {}
errors = []
for prop in string.split(propString, ';'):
try:
propname, value = prop.split('=')
except ValueError, message:
- errors.append('not of form [arg=value,value,...;'
- 'arg=value,value,...]')
+ errors.append(_('not of form [arg=value,value,...;'
+ 'arg=value,value,...]'))
return (errors, props)
-
- # ensure it's a valid property name
+ # convert the value to a hyperdb-usable value
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()).local(self.db.getUserTimezone())
- 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] = float(value)
+ props[propname] = hyperdb.rawToHyperdb(self.db, cl, nodeid,
+ propname, value)
+ except hyperdb.HyperdbValueError, message:
+ errors.append(str(message))
return errors, props
# 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,
- password=password.Password(password.generatePassword()),
- **user_props)
+ # 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()),
+ **user_props)
+ except exceptions.Reject:
+ return 0
else:
return 0
+def parseContent(content, keep_citations=None, keep_body=None, config=None):
+ """Parse mail message; return message summary and stripped content
-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_msg=re.compile(r'^[>|\s]*-----\s?Original Message\s?-----$')):
- ''' 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 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"]
- If keep_citations is true, then we keep the "quoting sections" in the
- content.
- If keep_body is true, we even keep the signature sections.
- '''
# 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 = ''
return summary, content
-# vim: set filetype=python ts=4 sw=4 et si
+# vim: set filetype=python sts=4 sw=4 et si :