![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/roundup/mailgw.py b/roundup/mailgw.py
index 52e4057e39d9e13c879672ebaa6705ba3ec709c7..f715ee82c477bcd81c1a3a97bb5379f186f1300b 100644 (file)
--- a/roundup/mailgw.py
+++ b/roundup/mailgw.py
+#
+# 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
+# under the same terms as Python, so long as this copyright message and
+# disclaimer are retained in their original form.
+#
+# IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR
+# DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING
+# OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+#
+# BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
+# BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+# FOR A PARTICULAR PURPOSE. THE CODE PROVIDED HEREUNDER IS ON AN "AS IS"
+# BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
+# SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
+#
'''
-Incoming messages are examined for multiple parts. In a multipart/mixed
-message or part, each subpart is extracted and examined. In a
-multipart/alternative message or part, we look for a text/plain subpart and
-ignore the other parts. 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.
+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.
+ . In a multipart/alternative message or part, we look for a text/plain
+ subpart and ignore the other parts.
+
+Summary
+-------
The "summary" property on message nodes is taken from the first non-quoting
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.
+Addresses
+---------
All of the addresses in the To: and Cc: headers of the incoming message are
looked up among the user nodes, and the corresponding users are placed in
the "recipients" property on the new "msg" node. The address in the From:
register an auditor on the "user" class that prevents the creation of user
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
"msg" node and its "files" property initialized to contain any new "file"
nodes.
+Triggers
+--------
Both cases may trigger detectors (in the first case we are calling the
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.1 2001-07-22 11:58:35 richard Exp $
+$Id: mailgw.py,v 1.14 2001-08-13 23:02:54 richard Exp $
'''
-import string, re, os, mimetools, StringIO, smtplib, socket, binascii, quopri
+import string, re, os, mimetools, cStringIO, smtplib, socket, binascii, quopri
import traceback
import date
-def getPart(fp, boundary):
- line = ''
- s = StringIO.StringIO()
- while 1:
- line_n = fp.readline()
- if not line_n:
- break
- line = line_n.strip()
- if line == '--'+boundary+'--':
- break
- if line == '--'+boundary:
- break
- s.write(line_n)
- if not s.getvalue().strip():
- return None
- return s
+class MailUsageError(ValueError):
+ pass
+
+class Message(mimetools.Message):
+ ''' subclass mimetools.Message so we can retrieve the parts of the
+ message...
+ '''
+ def getPart(self):
+ ''' Get a single part of a multipart message and return it as a new
+ Message instance.
+ '''
+ boundary = self.getparam('boundary')
+ mid, end = '--'+boundary, '--'+boundary+'--'
+ s = cStringIO.StringIO()
+ while 1:
+ line = self.fp.readline()
+ if not line:
+ break
+ if line.strip() in (mid, end):
+ break
+ s.write(line)
+ if not s.getvalue().strip():
+ return None
+ s.seek(0)
+ return Message(s)
subject_re = re.compile(r'(\[?(fwd|re):\s*)*'
r'(\[(?P<classname>[^\d]+)(?P<nodeid>\d+)?\])'
self.db = db
def main(self, fp):
+ ''' fp - the file from which to read the Message.
+
+ Read a message from fp and then call handle_message() with the
+ result. 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.
+ '''
# ok, figure the subject, author, recipients and content-type
- message = mimetools.Message(fp)
+ message = Message(fp)
+ m = []
try:
self.handle_message(message)
+ except MailUsageError, value:
+ # bounce the message back to the sender with the usage message
+ fulldoc = '\n'.join(string.split(__doc__, '\n')[2:])
+ sendto = [message.getaddrlist('from')[0][1]]
+ m = ['Subject: Failed issue tracker submission', '']
+ m.append(str(value))
+ m.append('\nMail Gateway Help\n=================')
+ m.append(fulldoc)
except:
# bounce the message back to the sender with the error message
sendto = [message.getaddrlist('from')[0][1]]
m.append('')
# TODO as attachments?
m.append('---- traceback of failure ----')
- s = StringIO.StringIO()
+ s = cStringIO.StringIO()
import traceback
traceback.print_exc(None, s)
m.append(s.getvalue())
except:
pass
m.append(fp.read())
+ if m:
try:
smtp = smtplib.SMTP(self.MAILHOST)
smtp.sendmail(self.ADMIN_EMAIL, sendto, '\n'.join(m))
return "Couldn't send confirmation email: %s"%value
def handle_message(self, message):
+ ''' message - a Message instance
+
+ Parse the message as per the module docstring.
+ '''
# handle the subject line
- m = subject_re.match(message.getheader('subject'))
+ subject = message.getheader('subject', '')
+ m = subject_re.match(subject)
if not m:
- raise ValueError, 'No [designator] found in subject "%s"'
+ 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:
+ 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: "%s"
+'''%subject
classname = m.group('classname')
nodeid = m.group('nodeid')
title = m.group('title').strip()
subject_args = m.group('args')
- cl = self.db.getclass(classname)
+ 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.
+
+Valid class names are: %s
+Subject was: "%s"
+'''%(classname, ', '.join(self.db.getclasses()), subject)
properties = cl.getprops()
props = {}
args = m.group('args')
try:
key, value = prop.split('=')
except ValueError, message:
- raise ValueError, 'Args list not of form [arg=value,value,...;arg=value,value,value..] (specific exception message was "%s")'%message
- type = properties[key]
- if type.isStringType:
+ raise MailUsageError, '''
+Subject argument list not of form [arg=value,value,...;arg=value,value...]
+ (specific exception message was "%s")
+
+Subject was: "%s"
+'''%(message, subject)
+ try:
+ type = properties[key]
+ except KeyError:
+ raise MailUsageError, '''
+Subject argument list refers to an invalid property: "%s"
+
+Subject was: "%s"
+'''%(key, subject)
+ if isinstance(type, hyperdb.String):
props[key] = value
- elif type.isDateType:
+ elif isinstance(type, hyperdb.Date):
props[key] = date.Date(value)
- elif type.isIntervalType:
+ elif isinstance(type, hyperdb.Interval):
props[key] = date.Interval(value)
- elif type.isLinkType:
+ elif isinstance(type, hyperdb.Link):
props[key] = value
- elif type.isMultilinkType:
+ elif isinstance(type, hyperdb.Multilink):
props[key] = value.split(',')
# handle the users
content_type = message.gettype()
attachments = []
if content_type == 'multipart/mixed':
- boundary = message.getparam('boundary')
# skip over the intro to the first boundary
- part = getPart(message.fp, boundary)
+ part = message.getPart()
content = None
while 1:
# get the next part
- part = getPart(message.fp, boundary)
+ part = message.getPart()
if part is None:
break
# parse it
- part.seek(0)
- submessage = mimetools.Message(part)
- subtype = submessage.gettype()
+ subtype = part.gettype()
if subtype == 'text/plain' and not content:
- # this one's our content
- content = part.read()
+ # add all text/plain parts to the message content
+ if content is None:
+ content = part.fp.read()
+ else:
+ content = content + part.fp.read()
+
elif subtype == 'message/rfc822':
- i = part.tell()
- subsubmess = mimetools.Message(part)
- name = subsubmess.getheader('subject')
- part.seek(i)
- attachments.append((name, 'message/rfc822', part.read()))
+ # 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 = submessage.getparam('name')
+ name = part.getparam('name')
# this is just an attachment
- data = part.read()
- encoding = submessage.getencoding()
+ data = part.fp.read()
+ encoding = part.getencoding()
if encoding == 'base64':
data = binascii.a2b_base64(data)
elif encoding == 'quoted-printable':
data = quopri.decode(data)
elif encoding == 'uuencoded':
data = binascii.a2b_uu(data)
- attachments.append((name, submessage.gettype(), data))
+ attachments.append((name, part.gettype(), data))
+
if content is None:
- raise ValueError, 'No text/plain part found'
+ raise MailUsageError, '''
+Roundup requires the submission to be plain text. The message parser could
+not find a text/plain part o use.
+'''
elif content_type[:10] == 'multipart/':
- boundary = message.getparam('boundary')
# skip over the intro to the first boundary
- getPart(message.fp, boundary)
+ message.getPart()
content = None
while 1:
# get the next part
- part = getPart(message.fp, boundary)
+ part = message.getPart()
if part is None:
break
# parse it
- part.seek(0)
- submessage = mimetools.Message(part)
- if submessage.gettype() == 'text/plain' and not content:
+ if part.gettype() == 'text/plain' and not content:
# this one's our content
- content = part.read()
+ content = part.fp.read()
if content is None:
- raise ValueError, 'No text/plain part found'
+ raise MailUsageError, '''
+Roundup requires the submission to be plain text. The message parser could
+not find a text/plain part o use.
+'''
elif content_type != 'text/plain':
- raise ValueError, 'No text/plain part found'
+ raise MailUsageError, '''
+Roundup requires the submission to be plain text. The message parser could
+not find a text/plain part o use.
+'''
else:
content = message.fp.read()
- # extract out the summary from the message
- summary = []
- for line in content.split('\n'):
- line = line.strip()
- if summary and not line:
- break
- if not line:
- summary.append('')
- elif line[0] not in '>|':
- summary.append(line)
- summary = '\n'.join(summary)
+ summary, content = parseContent(content)
# handle the files
files = []
for (name, type, data) in attachments:
- files.append(self.db.file.create(type=type, name=name, content=data))
+ files.append(self.db.file.create(type=type, name=name,
+ content=data))
# now handle the db stuff
if nodeid:
- # 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"
+ # 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.
- message_id = self.db.msg.create(author=author, recipients=recipients,
- date=date.Date('.'), summary=summary, content=content,
- files=files)
- messages = cl.get(nodeid, 'messages')
+ message_id = self.db.msg.create(author=author,
+ recipients=recipients, date=date.Date('.'), summary=summary,
+ content=content, files=files)
+ try:
+ messages = cl.get(nodeid, 'messages')
+ except IndexError:
+ raise MailUsageError, '''
+The node specified by the designator in the subject of your message ("%s")
+does not exist.
+
+Subject was: "%s"
+'''%(nodeid, subject)
messages.append(message_id)
props['messages'] = messages
- apply(cl.set, (nodeid, ), props)
+ cl.set(nodeid, **props)
else:
# 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.
- message_id = self.db.msg.create(author=author, recipients=recipients,
- date=date.Date('.'), summary=summary, content=content,
- files=files)
- if not props.has_key('assignedto'):
- props['assignedto'] = 1 # "admin"
- if not props.has_key('priority'):
- props['priority'] = 1 # "bug-fatal"
- if not props.has_key('status'):
- props['status'] = 1 # "unread"
- if not props.has_key('title'):
+ message_id = self.db.msg.create(author=author,
+ recipients=recipients, date=date.Date('.'), summary=summary,
+ content=content, files=files)
+ # fill out the properties with defaults where required
+ if properties.has_key('assignedto') and \
+ not props.has_key('assignedto'):
+ props['assignedto'] = '1' # "admin"
+ if properties.has_key('status') and not props.has_key('status'):
+ props['status'] = '1' # "unread"
+ if properties.has_key('title') and not props.has_key('title'):
props['title'] = title
props['messages'] = [message_id]
props['nosy'] = recipients[:]
props['nosy'].sort()
nodeid = cl.create(**props)
+def parseContent(content, blank_line=re.compile(r'[\r\n]+\s*[\r\n]+'),
+ eol=re.compile(r'[\r\n]+'), signature=re.compile(r'^[>|\s]*[-_]+\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.
+ '''
+ sections = blank_line.split(content)
+ # extract out the summary from the message
+ summary = ''
+ l = []
+ for section in sections:
+ section = section.strip()
+ if not section:
+ continue
+ lines = eol.split(section)
+ if lines[0] and lines[0][0] in '>|':
+ continue
+ if len(lines) > 1 and lines[1] and lines[1][0] in '>|':
+ continue
+ if not summary:
+ summary = lines[0]
+ l.append(section)
+ continue
+ if signature.match(lines[0]):
+ break
+ l.append(section)
+ return summary, '\n'.join(l)
+
+#
+# $Log: not supported by cvs2svn $
+# 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