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 __doc__ = '''
  20 An e-mail gateway for Roundup.
  21
  22 Incoming messages are examined for multiple parts:
  23  . In a multipart/mixed message or part, each subpart is extracted and
  24    examined. The text/plain subparts are assembled to form the textual
  25    body of the message, to be stored in the file associated with a "msg"
  26    class node. Any parts of other types are each stored in separate files
  27    and given "file" class nodes that are linked to the "msg" node.
  28  . In a multipart/alternative message or part, we look for a text/plain
  29    subpart and ignore the other parts.
  30
  31 Summary
  32 -------
  33 The "summary" property on message nodes is taken from the first non-quoting
  34 section in the message body. The message body is divided into sections by
  35 blank lines. Sections where the second and all subsequent lines begin with
  36 a ">" or "|" character are considered "quoting sections". The first line of
  37 the first non-quoting section becomes the summary of the message.
  38
  39 Addresses
  40 ---------
  41 All of the addresses in the To: and Cc: headers of the incoming message are
  42 looked up among the user nodes, and the corresponding users are placed in
  43 the "recipients" property on the new "msg" node. The address in the From:
  44 header similarly determines the "author" property of the new "msg"
  45 node. The default handling for addresses that don't have corresponding
  46 users is to create new users with no passwords and a username equal to the
  47 address. (The web interface does not permit logins for users with no
  48 passwords.) If we prefer to reject mail from outside sources, we can simply
  49 register an auditor on the "user" class that prevents the creation of user
  50 nodes with no passwords.
  51
  52 Actions
  53 -------
  54 The subject line of the incoming message is examined to determine whether
  55 the message is an attempt to create a new item or to discuss an existing
  56 item. A designator enclosed in square brackets is sought as the first thing
  57 on the subject line (after skipping any "Fwd:" or "Re:" prefixes).
  58
  59 If an item designator (class name and id number) is found there, the newly
  60 created "msg" node is added to the "messages" property for that item, and
  61 any new "file" nodes are added to the "files" property for the item.
  62
  63 If just an item class name is found there, we attempt to create a new item
  64 of that class with its "messages" property initialized to contain the new
  65 "msg" node and its "files" property initialized to contain any new "file"
  66 nodes.
  67
  68 Triggers
  69 --------
  70 Both cases may trigger detectors (in the first case we are calling the
  71 set() method to add the message to the item's spool; in the second case we
  72 are calling the create() method to create a new node). If an auditor raises
  73 an exception, the original message is bounced back to the sender with the
  74 explanatory message given in the exception.
  75
  76 $Id: mailgw.py,v 1.74 2002-05-29 01:16:17 richard Exp $
  77 '''
  78
  79
  80 import string, re, os, mimetools, cStringIO, smtplib, socket, binascii, quopri
  81 import time, random
  82 import traceback, MimeWriter
  83 import hyperdb, date, password
  84
  85 SENDMAILDEBUG = os.environ.get('SENDMAILDEBUG', '')
  86
  87 class MailGWError(ValueError):
  88     pass
  89
  90 class MailUsageError(ValueError):
  91     pass
  92
  93 class MailUsageHelp(Exception):
  94     pass
  95
  96 class UnAuthorized(Exception):
  97     """ Access denied """
  98
  99 class Message(mimetools.Message):
 100     ''' subclass mimetools.Message so we can retrieve the parts of the
 101         message...
 102     '''
 103     def getPart(self):
 104         ''' Get a single part of a multipart message and return it as a new
 105             Message instance.
 106         '''
 107         boundary = self.getparam('boundary')
 108         mid, end = '--'+boundary, '--'+boundary+'--'
 109         s = cStringIO.StringIO()
 110         while 1:
 111             line = self.fp.readline()
 112             if not line:
 113                 break
 114             if line.strip() in (mid, end):
 115                 break
 116             s.write(line)
 117         if not s.getvalue().strip():
 118             return None
 119         s.seek(0)
 120         return Message(s)
 121
 122 subject_re = re.compile(r'(?P<refwd>\s*\W?\s*(fwd|re|aw)\s*\W?\s*)*'
 123     r'\s*(\[(?P<classname>[^\d\s]+)(?P<nodeid>\d+)?\])?'
 124     r'\s*(?P<title>[^[]+)?(\[(?P<args>.+?)\])?', re.I)
 125
 126 class MailGW:
 127     def __init__(self, instance, db):
 128         self.instance = instance
 129         self.db = db
 130
 131     def main(self, fp):
 132         ''' fp - the file from which to read the Message.
 133         '''
 134         return self.handle_Message(Message(fp))
 135
 136     def handle_Message(self, message):
 137         '''Handle an RFC822 Message
 138
 139         Handle the Message object by calling handle_message() and then cope
 140         with any errors raised by handle_message.
 141         This method's job is to make that call and handle any
 142         errors in a sane manner. It should be replaced if you wish to
 143         handle errors in a different manner.
 144         '''
 145         # in some rare cases, a particularly stuffed-up e-mail will make
 146         # its way into here... try to handle it gracefully
 147         sendto = message.getaddrlist('from')
 148         if sendto:
 149             try:
 150                 return self.handle_message(message)
 151             except MailUsageHelp:
 152                 # bounce the message back to the sender with the usage message
 153                 fulldoc = '\n'.join(string.split(__doc__, '\n')[2:])
 154                 sendto = [sendto[0][1]]
 155                 m = ['']
 156                 m.append('\n\nMail Gateway Help\n=================')
 157                 m.append(fulldoc)
 158                 m = self.bounce_message(message, sendto, m,
 159                     subject="Mail Gateway Help")
 160             except MailUsageError, value:
 161                 # bounce the message back to the sender with the usage message
 162                 fulldoc = '\n'.join(string.split(__doc__, '\n')[2:])
 163                 sendto = [sendto[0][1]]
 164                 m = ['']
 165                 m.append(str(value))
 166                 m.append('\n\nMail Gateway Help\n=================')
 167                 m.append(fulldoc)
 168                 m = self.bounce_message(message, sendto, m)
 169             except UnAuthorized, value:
 170                 # just inform the user that he is not authorized
 171                 sendto = [sendto[0][1]]
 172                 m = ['']
 173                 m.append(str(value))
 174                 m = self.bounce_message(message, sendto, m)
 175             except:
 176                 # bounce the message back to the sender with the error message
 177                 sendto = [sendto[0][1], self.instance.ADMIN_EMAIL]
 178                 m = ['']
 179                 m.append('An unexpected error occurred during the processing')
 180                 m.append('of your message. The tracker administrator is being')
 181                 m.append('notified.\n')
 182                 m.append('----  traceback of failure  ----')
 183                 s = cStringIO.StringIO()
 184                 import traceback
 185                 traceback.print_exc(None, s)
 186                 m.append(s.getvalue())
 187                 m = self.bounce_message(message, sendto, m)
 188         else:
 189             # very bad-looking message - we don't even know who sent it
 190             sendto = [self.instance.ADMIN_EMAIL]
 191             m = ['Subject: badly formed message from mail gateway']
 192             m.append('')
 193             m.append('The mail gateway retrieved a message which has no From:')
 194             m.append('line, indicating that it is corrupt. Please check your')
 195             m.append('mail gateway source. Failed message is attached.')
 196             m.append('')
 197             m = self.bounce_message(message, sendto, m,
 198                 subject='Badly formed message from mail gateway')
 199
 200         # now send the message
 201         if SENDMAILDEBUG:
 202             open(SENDMAILDEBUG, 'w').write('From: %s\nTo: %s\n%s\n'%(
 203                 self.instance.ADMIN_EMAIL, ', '.join(sendto), m.getvalue()))
 204         else:
 205             try:
 206                 smtp = smtplib.SMTP(self.instance.MAILHOST)
 207                 smtp.sendmail(self.instance.ADMIN_EMAIL, sendto, m.getvalue())
 208             except socket.error, value:
 209                 raise MailGWError, "Couldn't send error email: "\
 210                     "mailhost %s"%value
 211             except smtplib.SMTPException, value:
 212                 raise MailGWError, "Couldn't send error email: %s"%value
 213
 214     def bounce_message(self, message, sendto, error,
 215             subject='Failed issue tracker submission'):
 216         ''' create a message that explains the reason for the failed
 217             issue submission to the author and attach the original
 218             message.
 219         '''
 220         msg = cStringIO.StringIO()
 221         writer = MimeWriter.MimeWriter(msg)
 222         writer.addheader('Subject', subject)
 223         writer.addheader('From', '%s <%s>'% (self.instance.INSTANCE_NAME,
 224                                             self.instance.ISSUE_TRACKER_EMAIL))
 225         writer.addheader('To', ','.join(sendto))
 226         writer.addheader('MIME-Version', '1.0')
 227         part = writer.startmultipartbody('mixed')
 228         part = writer.nextpart()
 229         body = part.startbody('text/plain')
 230         body.write('\n'.join(error))
 231
 232         # reconstruct the original message
 233         m = cStringIO.StringIO()
 234         w = MimeWriter.MimeWriter(m)
 235         # default the content_type, just in case...
 236         content_type = 'text/plain'
 237         # add the headers except the content-type
 238         for header in message.headers:
 239             header_name = header.split(':')[0]
 240             if header_name.lower() == 'content-type':
 241                 content_type = message.getheader(header_name)
 242             elif message.getheader(header_name):
 243                 w.addheader(header_name, message.getheader(header_name))
 244         # now attach the message body
 245         body = w.startbody(content_type)
 246         try:
 247             message.rewindbody()
 248         except IOError:
 249             body.write("*** couldn't include message body: read from pipe ***")
 250         else:
 251             body.write(message.fp.read())
 252
 253         # attach the original message to the returned message
 254         part = writer.nextpart()
 255         part.addheader('Content-Disposition','attachment')
 256         part.addheader('Content-Description','Message you sent')
 257         part.addheader('Content-Transfer-Encoding', '7bit')
 258         body = part.startbody('message/rfc822')
 259         body.write(m.getvalue())
 260
 261         writer.lastpart()
 262         return msg
 263
 264     def get_part_data_decoded(self,part):
 265         encoding = part.getencoding()
 266         data = None
 267         if encoding == 'base64':
 268             # BUG: is base64 really used for text encoding or
 269             # are we inserting zip files here.
 270             data = binascii.a2b_base64(part.fp.read())
 271         elif encoding == 'quoted-printable':
 272             # the quopri module wants to work with files
 273             decoded = cStringIO.StringIO()
 274             quopri.decode(part.fp, decoded)
 275             data = decoded.getvalue()
 276         elif encoding == 'uuencoded':
 277             data = binascii.a2b_uu(part.fp.read())
 278         else:
 279             # take it as text
 280             data = part.fp.read()
 281         return data
 282
 283     def handle_message(self, message):
 284         ''' message - a Message instance
 285
 286         Parse the message as per the module docstring.
 287         '''
 288         # handle the subject line
 289         subject = message.getheader('subject', '')
 290
 291         if subject.strip() == 'help':
 292             raise MailUsageHelp
 293
 294         m = subject_re.match(subject)
 295
 296         # check for well-formed subject line
 297         if m:
 298             # get the classname
 299             classname = m.group('classname')
 300             if classname is None:
 301                 # no classname, fallback on the default
 302                 if hasattr(self.instance, 'MAIL_DEFAULT_CLASS') and \
 303                         self.instance.MAIL_DEFAULT_CLASS:
 304                     classname = self.instance.MAIL_DEFAULT_CLASS
 305                 else:
 306                     # fail
 307                     m = None
 308
 309         if not m:
 310             raise MailUsageError, '''
 311 The message you sent to roundup did not contain a properly formed subject
 312 line. The subject must contain a class name or designator to indicate the
 313 "topic" of the message. For example:
 314     Subject: [issue] This is a new issue
 315       - this will create a new issue in the tracker with the title "This is
 316         a new issue".
 317     Subject: [issue1234] This is a followup to issue 1234
 318       - this will append the message's contents to the existing issue 1234
 319         in the tracker.
 320
 321 Subject was: "%s"
 322 '''%subject
 323
 324         # get the class
 325         try:
 326             cl = self.db.getclass(classname)
 327         except KeyError:
 328             raise MailUsageError, '''
 329 The class name you identified in the subject line ("%s") does not exist in the
 330 database.
 331
 332 Valid class names are: %s
 333 Subject was: "%s"
 334 '''%(classname, ', '.join(self.db.getclasses()), subject)
 335
 336         # get the optional nodeid
 337         nodeid = m.group('nodeid')
 338
 339         # title is optional too
 340         title = m.group('title')
 341         if title:
 342             title = title.strip()
 343         else:
 344             title = ''
 345
 346         # but we do need either a title or a nodeid...
 347         if nodeid is None and not title:
 348             raise MailUsageError, '''
 349 I cannot match your message to a node in the database - you need to either
 350 supply a full node identifier (with number, eg "[issue123]" or keep the
 351 previous subject title intact so I can match that.
 352
 353 Subject was: "%s"
 354 '''%subject
 355
 356         # If there's no nodeid, check to see if this is a followup and
 357         # maybe someone's responded to the initial mail that created an
 358         # entry. Try to find the matching nodes with the same title, and
 359         # use the _last_ one matched (since that'll _usually_ be the most
 360         # recent...)
 361         if nodeid is None and m.group('refwd'):
 362             l = cl.stringFind(title=title)
 363             if l:
 364                 nodeid = l[-1]
 365
 366         # if a nodeid was specified, make sure it's valid
 367         if nodeid is not None and not cl.hasnode(nodeid):
 368             raise MailUsageError, '''
 369 The node specified by the designator in the subject of your message ("%s")
 370 does not exist.
 371
 372 Subject was: "%s"
 373 '''%(nodeid, subject)
 374
 375         #
 376         # extract the args
 377         #
 378         subject_args = m.group('args')
 379
 380         #
 381         # handle the subject argument list
 382         #
 383         # figure what the properties of this Class are
 384         properties = cl.getprops()
 385         props = {}
 386         args = m.group('args')
 387         if args:
 388             errors = []
 389             for prop in string.split(args, ';'):
 390                 # extract the property name and value
 391                 try:
 392                     propname, value = prop.split('=')
 393                 except ValueError, message:
 394                     errors.append('not of form [arg=value,'
 395                         'value,...;arg=value,value...]')
 396                     break
 397
 398                 # ensure it's a valid property name
 399                 propname = propname.strip()
 400                 try:
 401                     proptype =  properties[propname]
 402                 except KeyError:
 403                     errors.append('refers to an invalid property: '
 404                         '"%s"'%propname)
 405                     continue
 406
 407                 # convert the string value to a real property value
 408                 if isinstance(proptype, hyperdb.String):
 409                     props[propname] = value.strip()
 410                 if isinstance(proptype, hyperdb.Password):
 411                     props[propname] = password.Password(value.strip())
 412                 elif isinstance(proptype, hyperdb.Date):
 413                     try:
 414                         props[propname] = date.Date(value.strip())
 415                     except ValueError, message:
 416                         errors.append('contains an invalid date for '
 417                             '%s.'%propname)
 418                 elif isinstance(proptype, hyperdb.Interval):
 419                     try:
 420                         props[propname] = date.Interval(value)
 421                     except ValueError, message:
 422                         errors.append('contains an invalid date interval'
 423                             'for %s.'%propname)
 424                 elif isinstance(proptype, hyperdb.Link):
 425                     linkcl = self.db.classes[proptype.classname]
 426                     propkey = linkcl.labelprop(default_to_id=1)
 427                     try:
 428                         props[propname] = linkcl.lookup(value)
 429                     except KeyError, message:
 430                         errors.append('"%s" is not a value for %s.'%(value,
 431                             propname))
 432                 elif isinstance(proptype, hyperdb.Multilink):
 433                     # get the linked class
 434                     linkcl = self.db.classes[proptype.classname]
 435                     propkey = linkcl.labelprop(default_to_id=1)
 436                     if nodeid:
 437                         curvalue = cl.get(nodeid, propname)
 438                     else:
 439                         curvalue = []
 440
 441                     # handle each add/remove in turn
 442                     for item in value.split(','):
 443                         item = item.strip()
 444
 445                         # handle +/-
 446                         remove = 0
 447                         if item.startswith('-'):
 448                             remove = 1
 449                             item = item[1:]
 450                         elif item.startswith('+'):
 451                             item = item[1:]
 452
 453                         # look up the value
 454                         try:
 455                             item = linkcl.lookup(item)
 456                         except KeyError, message:
 457                             errors.append('"%s" is not a value for %s.'%(item,
 458                                 propname))
 459                             continue
 460
 461                         # perform the add/remove
 462                         if remove:
 463                             try:
 464                                 curvalue.remove(item)
 465                             except ValueError:
 466                                 errors.append('"%s" is not currently in '
 467                                     'for %s.'%(item, propname))
 468                                 continue
 469                         else:
 470                             if item not in curvalue:
 471                                 curvalue.append(item)
 472
 473                     # that's it, set the new Multilink property value
 474                     props[propname] = curvalue
 475
 476             # handle any errors parsing the argument list
 477             if errors:
 478                 errors = '\n- '.join(errors)
 479                 raise MailUsageError, '''
 480 There were problems handling your subject line argument list:
 481 - %s
 482
 483 Subject was: "%s"
 484 '''%(errors, subject)
 485
 486         #
 487         # handle the users
 488         #
 489
 490         # Don't create users if ANONYMOUS_REGISTER_MAIL is denied
 491         # ... fall back on ANONYMOUS_REGISTER if the other doesn't exist
 492         create = 1
 493         if hasattr(self.instance, 'ANONYMOUS_REGISTER_MAIL'):
 494             if self.instance.ANONYMOUS_REGISTER_MAIL == 'deny':
 495                 create = 0
 496         elif self.instance.ANONYMOUS_REGISTER == 'deny':
 497             create = 0
 498
 499         author = self.db.uidFromAddress(message.getaddrlist('from')[0],
 500             create=create)
 501         if not author:
 502             raise UnAuthorized, '''
 503 You are not a registered user.
 504
 505 Unknown address: %s
 506 '''%message.getaddrlist('from')[0][1]
 507
 508         # the author may have been created - make sure the change is
 509         # committed before we reopen the database
 510         self.db.commit()
 511
 512         # reopen the database as the author
 513         username = self.db.user.get(author, 'username')
 514         self.db = self.instance.open(username)
 515
 516         # re-get the class with the new database connection
 517         cl = self.db.getclass(classname)
 518
 519         # now update the recipients list
 520         recipients = []
 521         tracker_email = self.instance.ISSUE_TRACKER_EMAIL.lower()
 522         for recipient in message.getaddrlist('to') + message.getaddrlist('cc'):
 523             r = recipient[1].strip().lower()
 524             if r == tracker_email or not r:
 525                 continue
 526
 527             # look up the recipient - create if necessary (and we're
 528             # allowed to)
 529             recipient = self.db.uidFromAddress(recipient, create)
 530
 531             # if all's well, add the recipient to the list
 532             if recipient:
 533                 recipients.append(recipient)
 534
 535         #
 536         # handle message-id and in-reply-to
 537         #
 538         messageid = message.getheader('message-id')
 539         inreplyto = message.getheader('in-reply-to') or ''
 540         # generate a messageid if there isn't one
 541         if not messageid:
 542             messageid = "<%s.%s.%s%s@%s>"%(time.time(), random.random(),
 543                 classname, nodeid, self.instance.MAIL_DOMAIN)
 544
 545         #
 546         # now handle the body - find the message
 547         #
 548         content_type =  message.gettype()
 549         attachments = []
 550         # General multipart handling:
 551         #   Take the first text/plain part, anything else is considered an
 552         #   attachment.
 553         # multipart/mixed: multiple "unrelated" parts.
 554         # multipart/signed (rfc 1847):
 555         #   The control information is carried in the second of the two
 556         #   required body parts.
 557         #   ACTION: Default, so if content is text/plain we get it.
 558         # multipart/encrypted (rfc 1847):
 559         #   The control information is carried in the first of the two
 560         #   required body parts.
 561         #   ACTION: Not handleable as the content is encrypted.
 562         # multipart/related (rfc 1872, 2112, 2387):
 563         #   The Multipart/Related content-type addresses the MIME
 564         #   representation of compound objects.
 565         #   ACTION: Default. If we are lucky there is a text/plain.
 566         #   TODO: One should use the start part and look for an Alternative
 567         #   that is text/plain.
 568         # multipart/Alternative (rfc 1872, 1892):
 569         #   only in "related" ?
 570         # multipart/report (rfc 1892):
 571         #   e.g. mail system delivery status reports.
 572         #   ACTION: Default. Could be ignored or used for Delivery Notification
 573         #   flagging.
 574         # multipart/form-data:
 575         #   For web forms only.
 576         if content_type == 'multipart/mixed':
 577             # skip over the intro to the first boundary
 578             part = message.getPart()
 579             content = None
 580             while 1:
 581                 # get the next part
 582                 part = message.getPart()
 583                 if part is None:
 584                     break
 585                 # parse it
 586                 subtype = part.gettype()
 587                 if subtype == 'text/plain' and not content:
 588                     # The first text/plain part is the message content.
 589                     content = self.get_part_data_decoded(part)
 590                 elif subtype == 'message/rfc822':
 591                     # handle message/rfc822 specially - the name should be
 592                     # the subject of the actual e-mail embedded here
 593                     i = part.fp.tell()
 594                     mailmess = Message(part.fp)
 595                     name = mailmess.getheader('subject')
 596                     part.fp.seek(i)
 597                     attachments.append((name, 'message/rfc822', part.fp.read()))
 598                 else:
 599                     # try name on Content-Type
 600                     name = part.getparam('name')
 601                     # this is just an attachment
 602                     data = self.get_part_data_decoded(part)
 603                     attachments.append((name, part.gettype(), data))
 604             if content is None:
 605                 raise MailUsageError, '''
 606 Roundup requires the submission to be plain text. The message parser could
 607 not find a text/plain part to use.
 608 '''
 609
 610         elif content_type[:10] == 'multipart/':
 611             # skip over the intro to the first boundary
 612             message.getPart()
 613             content = None
 614             while 1:
 615                 # get the next part
 616                 part = message.getPart()
 617                 if part is None:
 618                     break
 619                 # parse it
 620                 if part.gettype() == 'text/plain' and not content:
 621                     content = self.get_part_data_decoded(part)
 622             if content is None:
 623                 raise MailUsageError, '''
 624 Roundup requires the submission to be plain text. The message parser could
 625 not find a text/plain part to use.
 626 '''
 627
 628         elif content_type != 'text/plain':
 629             raise MailUsageError, '''
 630 Roundup requires the submission to be plain text. The message parser could
 631 not find a text/plain part to use.
 632 '''
 633
 634         else:
 635             content = self.get_part_data_decoded(message)
 636
 637         # figure how much we should muck around with the email body
 638         keep_citations = getattr(self.instance, 'EMAIL_KEEP_QUOTED_TEXT',
 639             'no') == 'yes'
 640         keep_body = getattr(self.instance, 'EMAIL_LEAVE_BODY_UNCHANGED',
 641             'no') == 'yes'
 642
 643         # parse the body of the message, stripping out bits as appropriate
 644         summary, content = parseContent(content, keep_citations,
 645             keep_body)
 646
 647         #
 648         # handle the attachments
 649         #
 650         files = []
 651         for (name, mime_type, data) in attachments:
 652             if not name:
 653                 name = "unnamed"
 654             files.append(self.db.file.create(type=mime_type, name=name,
 655                 content=data))
 656
 657         #
 658         # create the message if there's a message body (content)
 659         #
 660         if content:
 661             message_id = self.db.msg.create(author=author,
 662                 recipients=recipients, date=date.Date('.'), summary=summary,
 663                 content=content, files=files, messageid=messageid,
 664                 inreplyto=inreplyto)
 665
 666             # attach the message to the node
 667             if nodeid:
 668                 # add the message to the node's list
 669                 messages = cl.get(nodeid, 'messages')
 670                 messages.append(message_id)
 671                 props['messages'] = messages
 672             else:
 673                 # pre-load the messages list
 674                 props['messages'] = [message_id]
 675
 676                 # set the title to the subject
 677                 if properties.has_key('title') and not props.has_key('title'):
 678                     props['title'] = title
 679
 680         #
 681         # perform the node change / create
 682         #
 683         try:
 684             if nodeid:
 685                 cl.set(nodeid, **props)
 686             else:
 687                 nodeid = cl.create(**props)
 688         except (TypeError, IndexError, ValueError), message:
 689             raise MailUsageError, '''
 690 There was a problem with the message you sent:
 691    %s
 692 '''%message
 693
 694         # commit the changes to the DB
 695         self.db.commit()
 696
 697         return nodeid
 698
 699 def parseContent(content, keep_citations, keep_body,
 700         blank_line=re.compile(r'[\r\n]+\s*[\r\n]+'),
 701         eol=re.compile(r'[\r\n]+'),
 702         signature=re.compile(r'^[>|\s]*[-_]+\s*$'),
 703         original_message=re.compile(r'^[>|\s]*-----Original Message-----$')):
 704     ''' The message body is divided into sections by blank lines.
 705     Sections where the second and all subsequent lines begin with a ">" or "|"
 706     character are considered "quoting sections". The first line of the first
 707     non-quoting section becomes the summary of the message.
 708     '''
 709     # strip off leading carriage-returns / newlines
 710     i = 0
 711     for i in range(len(content)):
 712         if content[i] not in '\r\n':
 713             break
 714     if i > 0:
 715         sections = blank_line.split(content[i:])
 716     else:
 717         sections = blank_line.split(content)
 718
 719     # extract out the summary from the message
 720     summary = ''
 721     l = []
 722     for section in sections:
 723         #section = section.strip()
 724         if not section:
 725             continue
 726         lines = eol.split(section)
 727         if (lines[0] and lines[0][0] in '>|') or (len(lines) > 1 and
 728                 lines[1] and lines[1][0] in '>|'):
 729             # see if there's a response somewhere inside this section (ie.
 730             # no blank line between quoted message and response)
 731             for line in lines[1:]:
 732                 if line[0] not in '>|':
 733                     break
 734             else:
 735                 # we keep quoted bits if specified in the config
 736                 if keep_citations:
 737                     l.append(section)
 738                 continue
 739             # keep this section - it has reponse stuff in it
 740             if not summary:
 741                 # and while we're at it, use the first non-quoted bit as
 742                 # our summary
 743                 summary = line
 744             lines = lines[lines.index(line):]
 745             section = '\n'.join(lines)
 746
 747         if not summary:
 748             # if we don't have our summary yet use the first line of this
 749             # section
 750             summary = lines[0]
 751         elif signature.match(lines[0]) and 2 <= len(lines) <= 10:
 752             # lose any signature
 753             break
 754         elif original_message.match(lines[0]):
 755             # ditch the stupid Outlook quoting of the entire original message
 756             break
 757
 758         # and add the section to the output
 759         l.append(section)
 760     # we only set content for those who want to delete cruft from the
 761     # message body, otherwise the body is left untouched.
 762     if not keep_body:
 763         content = '\n\n'.join(l)
 764     return summary, content
 765
 766 #
 767 # $Log: not supported by cvs2svn $
 768 # Revision 1.73  2002/05/22 04:12:05  richard
 769 #  . applied patch #558876 ] cgi client customization
 770 #    ... with significant additions and modifications ;)
 771 #    - extended handling of ML assignedto to all places it's handled
 772 #    - added more NotFound info
 773 #
 774 # Revision 1.72  2002/05/22 01:24:51  richard
 775 # Added note to MIGRATION about new config vars. Also made us more resilient
 776 # for upgraders. Reinstated list header style (oops)
 777 #
 778 # Revision 1.71  2002/05/08 02:40:55  richard
 779 # grr
 780 #
 781 # Revision 1.70  2002/05/06 23:40:07  richard
 782 # hrm
 783 #
 784 # Revision 1.69  2002/05/06 23:37:21  richard
 785 # Tweaking the signature deletion from mail messages.
 786 # Added nuking of the "-----Original Message-----" crap from Outlook.
 787 #
 788 # Revision 1.68  2002/05/02 07:56:34  richard
 789 # . added option to automatically add the authors and recipients of messages
 790 #   to the nosy lists with the options ADD_AUTHOR_TO_NOSY (default 'new') and
 791 #   ADD_RECIPIENTS_TO_NOSY (default 'new'). These settings emulate the current
 792 #   behaviour. Setting them to 'yes' will add the author/recipients to the nosy
 793 #   on messages that create issues and followup messages.
 794 # . added missing documentation for a few of the config option values
 795 #
 796 # Revision 1.67  2002/04/23 15:46:49  rochecompaan
 797 #  . stripping of the email message body can now be controlled through
 798 #    the config variables EMAIL_KEEP_QUOTED_TEST and
 799 #    EMAIL_LEAVE_BODY_UNCHANGED.
 800 #
 801 # Revision 1.66  2002/03/14 23:59:24  richard
 802 #  . #517734 ] web header customisation is obscure
 803 #
 804 # Revision 1.65  2002/02/15 00:13:38  richard
 805 #  . #503204 ] mailgw needs a default class
 806 #     - partially done - the setting of additional properties can wait for a
 807 #       better configuration system.
 808 #
 809 # Revision 1.64  2002/02/14 23:46:02  richard
 810 # . #516883 ] mail interface + ANONYMOUS_REGISTER
 811 #
 812 # Revision 1.63  2002/02/12 08:08:55  grubert
 813 #  . Clean up mail handling, multipart handling.
 814 #
 815 # Revision 1.62  2002/02/05 14:15:29  grubert
 816 #  . respect encodings in non multipart messages.
 817 #
 818 # Revision 1.61  2002/02/04 09:40:21  grubert
 819 #  . add test for multipart messages with first part being encoded.
 820 #
 821 # Revision 1.60  2002/02/01 07:43:12  grubert
 822 #  . mailgw checks encoding on first part too.
 823 #
 824 # Revision 1.59  2002/01/23 21:43:23  richard
 825 # tabnuke
 826 #
 827 # Revision 1.58  2002/01/23 21:41:56  richard
 828 #  . mailgw failures (unexpected ones) are forwarded to the roundup admin
 829 #
 830 # Revision 1.57  2002/01/22 22:27:43  richard
 831 #  . handle stripping of "AW:" from subject line
 832 #
 833 # Revision 1.56  2002/01/22 11:54:45  rochecompaan
 834 # Fixed status change in mail gateway.
 835 #
 836 # Revision 1.55  2002/01/21 10:05:47  rochecompaan
 837 # Feature:
 838 #  . the mail gateway now responds with an error message when invalid
 839 #    values for arguments are specified for link or multilink properties
 840 #  . modified unit test to check nosy and assignedto when specified as
 841 #    arguments
 842 #
 843 # Fixed:
 844 #  . fixed setting nosy as argument in subject line
 845 #
 846 # Revision 1.54  2002/01/16 09:14:45  grubert
 847 #  . if the attachment has no name, name it unnamed, happens with tnefs.
 848 #
 849 # Revision 1.53  2002/01/16 07:20:54  richard
 850 # simple help command for mailgw
 851 #
 852 # Revision 1.52  2002/01/15 00:12:40  richard
 853 # #503340 ] creating issue with [asignedto=p.ohly]
 854 #
 855 # Revision 1.51  2002/01/14 02:20:15  richard
 856 #  . changed all config accesses so they access either the instance or the
 857 #    config attriubute on the db. This means that all config is obtained from
 858 #    instance_config instead of the mish-mash of classes. This will make
 859 #    switching to a ConfigParser setup easier too, I hope.
 860 #
 861 # At a minimum, this makes migration a _little_ easier (a lot easier in the
 862 # 0.5.0 switch, I hope!)
 863 #
 864 # Revision 1.50  2002/01/11 22:59:01  richard
 865 #  . #502342 ] pipe interface
 866 #
 867 # Revision 1.49  2002/01/10 06:19:18  richard
 868 # followup lines directly after a quoted section were being eaten.
 869 #
 870 # Revision 1.48  2002/01/08 04:12:05  richard
 871 # Changed message-id format to "<%s.%s.%s%s@%s>" so it complies with RFC822
 872 #
 873 # Revision 1.47  2002/01/02 02:32:38  richard
 874 # ANONYMOUS_ACCESS -> ANONYMOUS_REGISTER
 875 #
 876 # Revision 1.46  2002/01/02 02:31:38  richard
 877 # Sorry for the huge checkin message - I was only intending to implement #496356
 878 # but I found a number of places where things had been broken by transactions:
 879 #  . modified ROUNDUPDBSENDMAILDEBUG to be SENDMAILDEBUG and hold a filename
 880 #    for _all_ roundup-generated smtp messages to be sent to.
 881 #  . the transaction cache had broken the roundupdb.Class set() reactors
 882 #  . newly-created author users in the mailgw weren't being committed to the db
 883 #
 884 # Stuff that made it into CHANGES.txt (ie. the stuff I was actually working
 885 # on when I found that stuff :):
 886 #  . #496356 ] Use threading in messages
 887 #  . detectors were being registered multiple times
 888 #  . added tests for mailgw
 889 #  . much better attaching of erroneous messages in the mail gateway
 890 #
 891 # Revision 1.45  2001/12/20 15:43:01  rochecompaan
 892 # Features added:
 893 #  .  Multilink properties are now displayed as comma separated values in
 894 #     a textbox
 895 #  .  The add user link is now only visible to the admin user
 896 #  .  Modified the mail gateway to reject submissions from unknown
 897 #     addresses if ANONYMOUS_ACCESS is denied
 898 #
 899 # Revision 1.44  2001/12/18 15:30:34  rochecompaan
 900 # Fixed bugs:
 901 #  .  Fixed file creation and retrieval in same transaction in anydbm
 902 #     backend
 903 #  .  Cgi interface now renders new issue after issue creation
 904 #  .  Could not set issue status to resolved through cgi interface
 905 #  .  Mail gateway was changing status back to 'chatting' if status was
 906 #     omitted as an argument
 907 #
 908 # Revision 1.43  2001/12/15 19:39:01  rochecompaan
 909 # Oops.
 910 #
 911 # Revision 1.42  2001/12/15 19:24:39  rochecompaan
 912 #  . Modified cgi interface to change properties only once all changes are
 913 #    collected, files created and messages generated.
 914 #  . Moved generation of change note to nosyreactors.
 915 #  . We now check for changes to "assignedto" to ensure it's added to the
 916 #    nosy list.
 917 #
 918 # Revision 1.41  2001/12/10 00:57:38  richard
 919 # From CHANGES:
 920 #  . Added the "display" command to the admin tool - displays a node's values
 921 #  . #489760 ] [issue] only subject
 922 #  . fixed the doc/index.html to include the quoting in the mail alias.
 923 #
 924 # Also:
 925 #  . fixed roundup-admin so it works with transactions
 926 #  . disabled the back_anydbm module if anydbm tries to use dumbdbm
 927 #
 928 # Revision 1.40  2001/12/05 14:26:44  rochecompaan
 929 # Removed generation of change note from "sendmessage" in roundupdb.py.
 930 # The change note is now generated when the message is created.
 931 #
 932 # Revision 1.39  2001/12/02 05:06:16  richard
 933 # . We now use weakrefs in the Classes to keep the database reference, so
 934 #   the close() method on the database is no longer needed.
 935 #   I bumped the minimum python requirement up to 2.1 accordingly.
 936 # . #487480 ] roundup-server
 937 # . #487476 ] INSTALL.txt
 938 #
 939 # I also cleaned up the change message / post-edit stuff in the cgi client.
 940 # There's now a clearly marked "TODO: append the change note" where I believe
 941 # the change note should be added there. The "changes" list will obviously
 942 # have to be modified to be a dict of the changes, or somesuch.
 943 #
 944 # More testing needed.
 945 #
 946 # Revision 1.38  2001/12/01 07:17:50  richard
 947 # . We now have basic transaction support! Information is only written to
 948 #   the database when the commit() method is called. Only the anydbm
 949 #   backend is modified in this way - neither of the bsddb backends have been.
 950 #   The mail, admin and cgi interfaces all use commit (except the admin tool
 951 #   doesn't have a commit command, so interactive users can't commit...)
 952 # . Fixed login/registration forwarding the user to the right page (or not,
 953 #   on a failure)
 954 #
 955 # Revision 1.37  2001/11/28 21:55:35  richard
 956 #  . login_action and newuser_action return values were being ignored
 957 #  . Woohoo! Found that bloody re-login bug that was killing the mail
 958 #    gateway.
 959 #  (also a minor cleanup in hyperdb)
 960 #
 961 # Revision 1.36  2001/11/26 22:55:56  richard
 962 # Feature:
 963 #  . Added INSTANCE_NAME to configuration - used in web and email to identify
 964 #    the instance.
 965 #  . Added EMAIL_SIGNATURE_POSITION to indicate where to place the roundup
 966 #    signature info in e-mails.
 967 #  . Some more flexibility in the mail gateway and more error handling.
 968 #  . Login now takes you to the page you back to the were denied access to.
 969 #
 970 # Fixed:
 971 #  . Lots of bugs, thanks Roché and others on the devel mailing list!
 972 #
 973 # Revision 1.35  2001/11/22 15:46:42  jhermann
 974 # Added module docstrings to all modules.
 975 #
 976 # Revision 1.34  2001/11/15 10:24:27  richard
 977 # handle the case where there is no file attached
 978 #
 979 # Revision 1.33  2001/11/13 21:44:44  richard
 980 #  . re-open the database as the author in mail handling
 981 #
 982 # Revision 1.32  2001/11/12 22:04:29  richard
 983 # oops, left debug in there
 984 #
 985 # Revision 1.31  2001/11/12 22:01:06  richard
 986 # Fixed issues with nosy reaction and author copies.
 987 #
 988 # Revision 1.30  2001/11/09 22:33:28  richard
 989 # More error handling fixes.
 990 #
 991 # Revision 1.29  2001/11/07 05:29:26  richard
 992 # Modified roundup-mailgw so it can read e-mails from a local mail spool
 993 # file. Truncates the spool file after parsing.
 994 # Fixed a couple of small bugs introduced in roundup.mailgw when I started
 995 # the popgw.
 996 #
 997 # Revision 1.28  2001/11/01 22:04:37  richard
 998 # Started work on supporting a pop3-fetching server
 999 # Fixed bugs:
1000 #  . bug #477104 ] HTML tag error in roundup-server
1001 #  . bug #477107 ] HTTP header problem
1002 #
1003 # Revision 1.27  2001/10/30 11:26:10  richard
1004 # Case-insensitive match for ISSUE_TRACKER_EMAIL in address in e-mail.
1005 #
1006 # Revision 1.26  2001/10/30 00:54:45  richard
1007 # Features:
1008 #  . #467129 ] Lossage when username=e-mail-address
1009 #  . #473123 ] Change message generation for author
1010 #  . MailGW now moves 'resolved' to 'chatting' on receiving e-mail for an issue.
1011 #
1012 # Revision 1.25  2001/10/28 23:22:28  richard
1013 # fixed bug #474749 ] Indentations lost
1014 #
1015 # Revision 1.24  2001/10/23 22:57:52  richard
1016 # Fix unread->chatting auto transition, thanks Roch'e
1017 #
1018 # Revision 1.23  2001/10/21 04:00:20  richard
1019 # MailGW now moves 'unread' to 'chatting' on receiving e-mail for an issue.
1020 #
1021 # Revision 1.22  2001/10/21 03:35:13  richard
1022 # bug #473125: Paragraph in e-mails
1023 #
1024 # Revision 1.21  2001/10/21 00:53:42  richard
1025 # bug #473130: Nosy list not set correctly
1026 #
1027 # Revision 1.20  2001/10/17 23:13:19  richard
1028 # Did a fair bit of work on the admin tool. Now has an extra command "table"
1029 # which displays node information in a tabular format. Also fixed import and
1030 # export so they work. Removed freshen.
1031 # Fixed quopri usage in mailgw from bug reports.
1032 #
1033 # Revision 1.19  2001/10/11 23:43:04  richard
1034 # Implemented the comma-separated printing option in the admin tool.
1035 # Fixed a typo (more of a vim-o actually :) in mailgw.
1036 #
1037 # Revision 1.18  2001/10/11 06:38:57  richard
1038 # Initial cut at trying to handle people responding to CC'ed messages that
1039 # create an issue.
1040 #
1041 # Revision 1.17  2001/10/09 07:25:59  richard
1042 # Added the Password property type. See "pydoc roundup.password" for
1043 # implementation details. Have updated some of the documentation too.
1044 #
1045 # Revision 1.16  2001/10/05 02:23:24  richard
1046 #  . roundup-admin create now prompts for property info if none is supplied
1047 #    on the command-line.
1048 #  . hyperdb Class getprops() method may now return only the mutable
1049 #    properties.
1050 #  . Login now uses cookies, which makes it a whole lot more flexible. We can
1051 #    now support anonymous user access (read-only, unless there's an
1052 #    "anonymous" user, in which case write access is permitted). Login
1053 #    handling has been moved into cgi_client.Client.main()
1054 #  . The "extended" schema is now the default in roundup init.
1055 #  . The schemas have had their page headings modified to cope with the new
1056 #    login handling. Existing installations should copy the interfaces.py
1057 #    file from the roundup lib directory to their instance home.
1058 #  . Incorrectly had a Bizar Software copyright on the cgitb.py module from
1059 #    Ping - has been removed.
1060 #  . Fixed a whole bunch of places in the CGI interface where we should have
1061 #    been returning Not Found instead of throwing an exception.
1062 #  . Fixed a deviation from the spec: trying to modify the 'id' property of
1063 #    an item now throws an exception.
1064 #
1065 # Revision 1.15  2001/08/30 06:01:17  richard
1066 # Fixed missing import in mailgw :(
1067 #
1068 # Revision 1.14  2001/08/13 23:02:54  richard
1069 # Make the mail parser a little more robust.
1070 #
1071 # Revision 1.13  2001/08/12 06:32:36  richard
1072 # using isinstance(blah, Foo) now instead of isFooType
1073 #
1074 # Revision 1.12  2001/08/08 01:27:00  richard
1075 # Added better error handling to mailgw.
1076 #
1077 # Revision 1.11  2001/08/08 00:08:03  richard
1078 # oops ;)
1079 #
1080 # Revision 1.10  2001/08/07 00:24:42  richard
1081 # stupid typo
1082 #
1083 # Revision 1.9  2001/08/07 00:15:51  richard
1084 # Added the copyright/license notice to (nearly) all files at request of
1085 # Bizar Software.
1086 #
1087 # Revision 1.8  2001/08/05 07:06:07  richard
1088 # removed some print statements
1089 #
1090 # Revision 1.7  2001/08/03 07:18:22  richard
1091 # Implemented correct mail splitting (was taking a shortcut). Added unit
1092 # tests. Also snips signatures now too.
1093 #
1094 # Revision 1.6  2001/08/01 04:24:21  richard
1095 # mailgw was assuming certain properties existed on the issues being created.
1096 #
1097 # Revision 1.5  2001/07/29 07:01:39  richard
1098 # Added vim command to all source so that we don't get no steenkin' tabs :)
1099 #
1100 # Revision 1.4  2001/07/28 06:43:02  richard
1101 # Multipart message class has the getPart method now. Added some tests for it.
1102 #
1103 # Revision 1.3  2001/07/28 00:34:34  richard
1104 # Fixed some non-string node ids.
1105 #
1106 # Revision 1.2  2001/07/22 12:09:32  richard
1107 # Final commit of Grande Splite
1108 #
1109 #
1110 # vim: set filetype=python ts=4 sw=4 et si