roundup/mailgw.py

   1 #
   2 # Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/)
   3 # This module is free software, and you may redistribute it and/or modify
   4 # under the same terms as Python, so long as this copyright message and
   5 # disclaimer are retained in their original form.
   6 #
   7 # IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR
   8 # DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING
   9 # OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE
  10 # POSSIBILITY OF SUCH DAMAGE.
  11 #
  12 # BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
  13 # BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  14 # FOR A PARTICULAR PURPOSE.  THE CODE PROVIDED HEREUNDER IS ON AN "AS IS"
  15 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
  16 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  17 #
  18 '''
  19 An e-mail gateway for Roundup.
  20
  21 Incoming messages are examined for multiple parts:
  22  . In a multipart/mixed message or part, each subpart is extracted and
  23    examined. The text/plain subparts are assembled to form the textual
  24    body of the message, to be stored in the file associated with a "msg"
  25    class node. Any parts of other types are each stored in separate files
  26    and given "file" class nodes that are linked to the "msg" node.
  27  . In a multipart/alternative message or part, we look for a text/plain
  28    subpart and ignore the other parts.
  29
  30 Summary
  31 -------
  32 The "summary" property on message nodes is taken from the first non-quoting
  33 section in the message body. The message body is divided into sections by
  34 blank lines. Sections where the second and all subsequent lines begin with
  35 a ">" or "|" character are considered "quoting sections". The first line of
  36 the first non-quoting section becomes the summary of the message.
  37
  38 Addresses
  39 ---------
  40 All of the addresses in the To: and Cc: headers of the incoming message are
  41 looked up among the user nodes, and the corresponding users are placed in
  42 the "recipients" property on the new "msg" node. The address in the From:
  43 header similarly determines the "author" property of the new "msg"
  44 node. The default handling for addresses that don't have corresponding
  45 users is to create new users with no passwords and a username equal to the
  46 address. (The web interface does not permit logins for users with no
  47 passwords.) If we prefer to reject mail from outside sources, we can simply
  48 register an auditor on the "user" class that prevents the creation of user
  49 nodes with no passwords.
  50
  51 Actions
  52 -------
  53 The subject line of the incoming message is examined to determine whether
  54 the message is an attempt to create a new item or to discuss an existing
  55 item. A designator enclosed in square brackets is sought as the first thing
  56 on the subject line (after skipping any "Fwd:" or "Re:" prefixes).
  57
  58 If an item designator (class name and id number) is found there, the newly
  59 created "msg" node is added to the "messages" property for that item, and
  60 any new "file" nodes are added to the "files" property for the item.
  61
  62 If just an item class name is found there, we attempt to create a new item
  63 of that class with its "messages" property initialized to contain the new
  64 "msg" node and its "files" property initialized to contain any new "file"
  65 nodes.
  66
  67 Triggers
  68 --------
  69 Both cases may trigger detectors (in the first case we are calling the
  70 set() method to add the message to the item's spool; in the second case we
  71 are calling the create() method to create a new node). If an auditor raises
  72 an exception, the original message is bounced back to the sender with the
  73 explanatory message given in the exception.
  74
  75 $Id: mailgw.py,v 1.19 2001-10-11 23:43:04 richard Exp $
  76 '''
  77
  78
  79 import string, re, os, mimetools, cStringIO, smtplib, socket, binascii, quopri
  80 import traceback
  81 import hyperdb, date, password
  82
  83 class MailUsageError(ValueError):
  84     pass
  85
  86 class Message(mimetools.Message):
  87     ''' subclass mimetools.Message so we can retrieve the parts of the
  88         message...
  89     '''
  90     def getPart(self):
  91         ''' Get a single part of a multipart message and return it as a new
  92             Message instance.
  93         '''
  94         boundary = self.getparam('boundary')
  95         mid, end = '--'+boundary, '--'+boundary+'--'
  96         s = cStringIO.StringIO()
  97         while 1:
  98             line = self.fp.readline()
  99             if not line:
 100                 break
 101             if line.strip() in (mid, end):
 102                 break
 103             s.write(line)
 104         if not s.getvalue().strip():
 105             return None
 106         s.seek(0)
 107         return Message(s)
 108
 109 subject_re = re.compile(r'(?P<refwd>\s*\W?\s*(fwd|re)\s*\W?\s*)*'
 110     r'\s*(\[(?P<classname>[^\d]+)(?P<nodeid>\d+)?\])'
 111     r'\s*(?P<title>[^\[]+)(\[(?P<args>.+?)\])?', re.I)
 112
 113 class MailGW:
 114     def __init__(self, db):
 115         self.db = db
 116
 117     def main(self, fp):
 118         ''' fp - the file from which to read the Message.
 119
 120         Read a message from fp and then call handle_message() with the
 121         result. This method's job is to make that call and handle any
 122         errors in a sane manner. It should be replaced if you wish to
 123         handle errors in a different manner.
 124         '''
 125         # ok, figure the subject, author, recipients and content-type
 126         message = Message(fp)
 127         m = []
 128         try:
 129             self.handle_message(message)
 130         except MailUsageError, value:
 131             # bounce the message back to the sender with the usage message
 132             fulldoc = '\n'.join(string.split(__doc__, '\n')[2:])
 133             sendto = [message.getaddrlist('from')[0][1]]
 134             m = ['Subject: Failed issue tracker submission', '']
 135             m.append(str(value))
 136             m.append('\n\nMail Gateway Help\n=================')
 137             m.append(fulldoc)
 138         except:
 139             # bounce the message back to the sender with the error message
 140             sendto = [message.getaddrlist('from')[0][1]]
 141             m = ['Subject: failed issue tracker submission']
 142             m.append('')
 143             # TODO as attachments?
 144             m.append('----  traceback of failure  ----')
 145             s = cStringIO.StringIO()
 146             import traceback
 147             traceback.print_exc(None, s)
 148             m.append(s.getvalue())
 149             m.append('---- failed message follows ----')
 150             try:
 151                 fp.seek(0)
 152             except:
 153                 pass
 154             m.append(fp.read())
 155         if m:
 156             try:
 157                 smtp = smtplib.SMTP(self.MAILHOST)
 158                 smtp.sendmail(self.ADMIN_EMAIL, sendto, '\n'.join(m))
 159             except socket.error, value:
 160                 return "Couldn't send confirmation email: mailhost %s"%value
 161             except smtplib.SMTPException, value:
 162                 return "Couldn't send confirmation email: %s"%value
 163
 164     def handle_message(self, message):
 165         ''' message - a Message instance
 166
 167         Parse the message as per the module docstring.
 168         '''
 169         # handle the subject line
 170         subject = message.getheader('subject', '')
 171         m = subject_re.match(subject)
 172         if not m:
 173             raise MailUsageError, '''
 174 The message you sent to roundup did not contain a properly formed subject
 175 line. The subject must contain a class name or designator to indicate the
 176 "topic" of the message. For example:
 177     Subject: [issue] This is a new issue
 178       - this will create a new issue in the tracker with the title "This is
 179         a new issue".
 180     Subject: [issue1234] This is a followup to issue 1234
 181       - this will append the message's contents to the existing issue 1234
 182         in the tracker.
 183
 184 Subject was: "%s"
 185 '''%subject
 186         classname = m.group('classname')
 187         nodeid = m.group('nodeid')
 188         title = m.group('title').strip()
 189         subject_args = m.group('args')
 190         try:
 191             cl = self.db.getclass(classname)
 192         except KeyError:
 193             raise MailUsageError, '''
 194 The class name you identified in the subject line ("%s") does not exist in the
 195 database.
 196
 197 Valid class names are: %s
 198 Subject was: "%s"
 199 '''%(classname, ', '.join(self.db.getclasses()), subject)
 200
 201         # If there's no nodeid, check to see if this is a followup and
 202         # maybe someone's responded to the initial mail that created an
 203         # entry. Try to find the matching nodes with the same title, and
 204         # use the _last_ one matched (since that'll _usually_ be the most
 205         # recent...)
 206         if not nodeid and m.group('refwd'):
 207             l = cl.stringFind(title=title)
 208             if l:
 209                 nodeid = l[-1]
 210
 211         # start of the props
 212         properties = cl.getprops()
 213         props = {}
 214
 215         # handle the args
 216         args = m.group('args')
 217         if args:
 218             for prop in string.split(args, ';'):
 219                 try:
 220                     key, value = prop.split('=')
 221                 except ValueError, message:
 222                     raise MailUsageError, '''
 223 Subject argument list not of form [arg=value,value,...;arg=value,value...]
 224    (specific exception message was "%s")
 225
 226 Subject was: "%s"
 227 '''%(message, subject)
 228                 try:
 229                     type =  properties[key]
 230                 except KeyError:
 231                     raise MailUsageError, '''
 232 Subject argument list refers to an invalid property: "%s"
 233
 234 Subject was: "%s"
 235 '''%(key, subject)
 236                 if isinstance(type, hyperdb.String):
 237                     props[key] = value
 238                 if isinstance(type, hyperdb.Password):
 239                     props[key] = password.Password(value)
 240                 elif isinstance(type, hyperdb.Date):
 241                     props[key] = date.Date(value)
 242                 elif isinstance(type, hyperdb.Interval):
 243                     props[key] = date.Interval(value)
 244                 elif isinstance(type, hyperdb.Link):
 245                     props[key] = value
 246                 elif isinstance(type, hyperdb.Multilink):
 247                     props[key] = value.split(',')
 248
 249         #
 250         # handle the users
 251         #
 252         author = self.db.uidFromAddress(message.getaddrlist('from')[0])
 253         recipients = []
 254         for recipient in message.getaddrlist('to') + message.getaddrlist('cc'):
 255             if recipient[1].strip().lower() == self.ISSUE_TRACKER_EMAIL:
 256                 continue
 257             recipients.append(self.db.uidFromAddress(recipient))
 258
 259         # now handle the body - find the message
 260         content_type =  message.gettype()
 261         attachments = []
 262         if content_type == 'multipart/mixed':
 263             # skip over the intro to the first boundary
 264             part = message.getPart()
 265             content = None
 266             while 1:
 267                 # get the next part
 268                 part = message.getPart()
 269                 if part is None:
 270                     break
 271                 # parse it
 272                 subtype = part.gettype()
 273                 if subtype == 'text/plain' and not content:
 274                     # add all text/plain parts to the message content
 275                     if content is None:
 276                         content = part.fp.read()
 277                     else:
 278                         content = content + part.fp.read()
 279
 280                 elif subtype == 'message/rfc822':
 281                     # handle message/rfc822 specially - the name should be
 282                     # the subject of the actual e-mail embedded here
 283                     i = part.fp.tell()
 284                     mailmess = Message(part.fp)
 285                     name = mailmess.getheader('subject')
 286                     part.fp.seek(i)
 287                     attachments.append((name, 'message/rfc822', part.fp.read()))
 288
 289                 else:
 290                     # try name on Content-Type
 291                     name = part.getparam('name')
 292                     # this is just an attachment
 293                     data = part.fp.read()
 294                     encoding = part.getencoding()
 295                     if encoding == 'base64':
 296                         data = binascii.a2b_base64(data)
 297                     elif encoding == 'quoted-printable':
 298                         data = quopri.decode(data)
 299                     elif encoding == 'uuencoded':
 300                         data = binascii.a2b_uu(data)
 301                     attachments.append((name, part.gettype(), data))
 302
 303             if content is None:
 304                 raise MailUsageError, '''
 305 Roundup requires the submission to be plain text. The message parser could
 306 not find a text/plain part to use.
 307 '''
 308
 309         elif content_type[:10] == 'multipart/':
 310             # skip over the intro to the first boundary
 311             message.getPart()
 312             content = None
 313             while 1:
 314                 # get the next part
 315                 part = message.getPart()
 316                 if part is None:
 317                     break
 318                 # parse it
 319                 if part.gettype() == 'text/plain' and not content:
 320                     # this one's our content
 321                     content = part.fp.read()
 322             if content is None:
 323                 raise MailUsageError, '''
 324 Roundup requires the submission to be plain text. The message parser could
 325 not find a text/plain part to use.
 326 '''
 327
 328         elif content_type != 'text/plain':
 329             raise MailUsageError, '''
 330 Roundup requires the submission to be plain text. The message parser could
 331 not find a text/plain part to use.
 332 '''
 333
 334         else:
 335             content = message.fp.read()
 336
 337         summary, content = parseContent(content)
 338
 339         # handle the files
 340         files = []
 341         for (name, type, data) in attachments:
 342             files.append(self.db.file.create(type=type, name=name,
 343                 content=data))
 344
 345         # now handle the db stuff
 346         if nodeid:
 347             # If an item designator (class name and id number) is found there,
 348             # the newly created "msg" node is added to the "messages" property
 349             # for that item, and any new "file" nodes are added to the "files"
 350             # property for the item.
 351             message_id = self.db.msg.create(author=author,
 352                 recipients=recipients, date=date.Date('.'), summary=summary,
 353                 content=content, files=files)
 354             try:
 355                 messages = cl.get(nodeid, 'messages')
 356             except IndexError:
 357                 raise MailUsageError, '''
 358 The node specified by the designator in the subject of your message ("%s")
 359 does not exist.
 360
 361 Subject was: "%s"
 362 '''%(nodeid, subject)
 363             messages.append(message_id)
 364             props['messages'] = messages
 365             cl.set(nodeid, **props)
 366         else:
 367             # If just an item class name is found there, we attempt to create a
 368             # new item of that class with its "messages" property initialized to
 369             # contain the new "msg" node and its "files" property initialized to
 370             # contain any new "file" nodes.
 371             message_id = self.db.msg.create(author=author,
 372                 recipients=recipients, date=date.Date('.'), summary=summary,
 373                 content=content, files=files)
 374             # fill out the properties with defaults where required
 375             if properties.has_key('assignedto') and \
 376                     not props.has_key('assignedto'):
 377                 props['assignedto'] = '1'             # "admin"
 378             if properties.has_key('status') and not props.has_key('status'):
 379                 props['status'] = '1'                 # "unread"
 380             if properties.has_key('title') and not props.has_key('title'):
 381                 props['title'] = title
 382             props['messages'] = [message_id]
 383             props['nosy'] = recipients[:]
 384             props['nosy'].append(author)
 385             props['nosy'].sort()
 386             nodeid = cl.create(**props)
 387
 388 def parseContent(content, blank_line=re.compile(r'[\r\n]+\s*[\r\n]+'),
 389         eol=re.compile(r'[\r\n]+'), signature=re.compile(r'^[>|\s]*[-_]+\s*$')):
 390     ''' The message body is divided into sections by blank lines.
 391     Sections where the second and all subsequent lines begin with a ">" or "|"
 392     character are considered "quoting sections". The first line of the first
 393     non-quoting section becomes the summary of the message.
 394     '''
 395     sections = blank_line.split(content)
 396     # extract out the summary from the message
 397     summary = ''
 398     l = []
 399     for section in sections:
 400         section = section.strip()
 401         if not section:
 402             continue
 403         lines = eol.split(section)
 404         if lines[0] and lines[0][0] in '>|':
 405             continue
 406         if len(lines) > 1 and lines[1] and lines[1][0] in '>|':
 407             continue
 408         if not summary:
 409             summary = lines[0]
 410             l.append(section)
 411             continue
 412         if signature.match(lines[0]):
 413             break
 414         l.append(section)
 415     return summary, '\n'.join(l)
 416
 417 #
 418 # $Log: not supported by cvs2svn $
 419 # Revision 1.18  2001/10/11 06:38:57  richard
 420 # Initial cut at trying to handle people responding to CC'ed messages that
 421 # create an issue.
 422 #
 423 # Revision 1.17  2001/10/09 07:25:59  richard
 424 # Added the Password property type. See "pydoc roundup.password" for
 425 # implementation details. Have updated some of the documentation too.
 426 #
 427 # Revision 1.16  2001/10/05 02:23:24  richard
 428 #  . roundup-admin create now prompts for property info if none is supplied
 429 #    on the command-line.
 430 #  . hyperdb Class getprops() method may now return only the mutable
 431 #    properties.
 432 #  . Login now uses cookies, which makes it a whole lot more flexible. We can
 433 #    now support anonymous user access (read-only, unless there's an
 434 #    "anonymous" user, in which case write access is permitted). Login
 435 #    handling has been moved into cgi_client.Client.main()
 436 #  . The "extended" schema is now the default in roundup init.
 437 #  . The schemas have had their page headings modified to cope with the new
 438 #    login handling. Existing installations should copy the interfaces.py
 439 #    file from the roundup lib directory to their instance home.
 440 #  . Incorrectly had a Bizar Software copyright on the cgitb.py module from
 441 #    Ping - has been removed.
 442 #  . Fixed a whole bunch of places in the CGI interface where we should have
 443 #    been returning Not Found instead of throwing an exception.
 444 #  . Fixed a deviation from the spec: trying to modify the 'id' property of
 445 #    an item now throws an exception.
 446 #
 447 # Revision 1.15  2001/08/30 06:01:17  richard
 448 # Fixed missing import in mailgw :(
 449 #
 450 # Revision 1.14  2001/08/13 23:02:54  richard
 451 # Make the mail parser a little more robust.
 452 #
 453 # Revision 1.13  2001/08/12 06:32:36  richard
 454 # using isinstance(blah, Foo) now instead of isFooType
 455 #
 456 # Revision 1.12  2001/08/08 01:27:00  richard
 457 # Added better error handling to mailgw.
 458 #
 459 # Revision 1.11  2001/08/08 00:08:03  richard
 460 # oops ;)
 461 #
 462 # Revision 1.10  2001/08/07 00:24:42  richard
 463 # stupid typo
 464 #
 465 # Revision 1.9  2001/08/07 00:15:51  richard
 466 # Added the copyright/license notice to (nearly) all files at request of
 467 # Bizar Software.
 468 #
 469 # Revision 1.8  2001/08/05 07:06:07  richard
 470 # removed some print statements
 471 #
 472 # Revision 1.7  2001/08/03 07:18:22  richard
 473 # Implemented correct mail splitting (was taking a shortcut). Added unit
 474 # tests. Also snips signatures now too.
 475 #
 476 # Revision 1.6  2001/08/01 04:24:21  richard
 477 # mailgw was assuming certain properties existed on the issues being created.
 478 #
 479 # Revision 1.5  2001/07/29 07:01:39  richard
 480 # Added vim command to all source so that we don't get no steenkin' tabs :)
 481 #
 482 # Revision 1.4  2001/07/28 06:43:02  richard
 483 # Multipart message class has the getPart method now. Added some tests for it.
 484 #
 485 # Revision 1.3  2001/07/28 00:34:34  richard
 486 # Fixed some non-string node ids.
 487 #
 488 # Revision 1.2  2001/07/22 12:09:32  richard
 489 # Final commit of Grande Splite
 490 #
 491 #
 492 # vim: set filetype=python ts=4 sw=4 et si