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.66 2002-03-14 23:59:24 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         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 not nodeid 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         # extract the args
 357         subject_args = m.group('args')
 358
 359         # If there's no nodeid, check to see if this is a followup and
 360         # maybe someone's responded to the initial mail that created an
 361         # entry. Try to find the matching nodes with the same title, and
 362         # use the _last_ one matched (since that'll _usually_ be the most
 363         # recent...)
 364         if not nodeid and m.group('refwd'):
 365             l = cl.stringFind(title=title)
 366             if l:
 367                 nodeid = l[-1]
 368
 369         # start of the props
 370         properties = cl.getprops()
 371         props = {}
 372
 373         # handle the args
 374         args = m.group('args')
 375         if args:
 376             for prop in string.split(args, ';'):
 377                 # extract the property name and value
 378                 try:
 379                     key, value = prop.split('=')
 380                 except ValueError, message:
 381                     raise MailUsageError, '''
 382 Subject argument list not of form [arg=value,value,...;arg=value,value...]
 383    (specific exception message was "%s")
 384
 385 Subject was: "%s"
 386 '''%(message, subject)
 387
 388                 # ensure it's a valid property name
 389                 key = key.strip()
 390                 try:
 391                     proptype =  properties[key]
 392                 except KeyError:
 393                     raise MailUsageError, '''
 394 Subject argument list refers to an invalid property: "%s"
 395
 396 Subject was: "%s"
 397 '''%(key, subject)
 398
 399                 # convert the string value to a real property value
 400                 if isinstance(proptype, hyperdb.String):
 401                     props[key] = value.strip()
 402                 if isinstance(proptype, hyperdb.Password):
 403                     props[key] = password.Password(value.strip())
 404                 elif isinstance(proptype, hyperdb.Date):
 405                     try:
 406                         props[key] = date.Date(value.strip())
 407                     except ValueError, message:
 408                         raise UsageError, '''
 409 Subject argument list contains an invalid date for %s.
 410
 411 Error was: %s
 412 Subject was: "%s"
 413 '''%(key, message, subject)
 414                 elif isinstance(proptype, hyperdb.Interval):
 415                     try:
 416                         props[key] = date.Interval(value) # no strip needed
 417                     except ValueError, message:
 418                         raise UsageError, '''
 419 Subject argument list contains an invalid date interval for %s.
 420
 421 Error was: %s
 422 Subject was: "%s"
 423 '''%(key, message, subject)
 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[key] = linkcl.lookup(value)
 429                     except KeyError, message:
 430                         raise MailUsageError, '''
 431 Subject argument list contains an invalid value for %s.
 432
 433 Error was: %s
 434 Subject was: "%s"
 435 '''%(key, message, subject)
 436                 elif isinstance(proptype, hyperdb.Multilink):
 437                     # get the linked class
 438                     linkcl = self.db.classes[proptype.classname]
 439                     propkey = linkcl.labelprop(default_to_id=1)
 440                     for item in value.split(','):
 441                         item = item.strip()
 442                         try:
 443                             item = linkcl.lookup(item)
 444                         except KeyError, message:
 445                             raise MailUsageError, '''
 446 Subject argument list contains an invalid value for %s.
 447
 448 Error was: %s
 449 Subject was: "%s"
 450 '''%(key, message, subject)
 451                         if props.has_key(key):
 452                             props[key].append(item)
 453                         else:
 454                             props[key] = [item]
 455
 456         #
 457         # handle the users
 458         #
 459
 460         # Don't create users if ANONYMOUS_REGISTER_MAIL is denied
 461         # ... fall back on ANONYMOUS_REGISTER if the other doesn't exist
 462         create = 1
 463         if hasattr(self.instance, 'ANONYMOUS_REGISTER_MAIL'):
 464             if self.instance.ANONYMOUS_REGISTER_MAIL == 'deny':
 465                 create = 0
 466         elif self.instance.ANONYMOUS_REGISTER == 'deny':
 467             create = 0
 468
 469         author = self.db.uidFromAddress(message.getaddrlist('from')[0],
 470             create=create)
 471         if not author:
 472             raise UnAuthorized, '''
 473 You are not a registered user.
 474
 475 Unknown address: %s
 476 '''%message.getaddrlist('from')[0][1]
 477
 478         # the author may have been created - make sure the change is
 479         # committed before we reopen the database
 480         self.db.commit()
 481
 482         # reopen the database as the author
 483         username = self.db.user.get(author, 'username')
 484         self.db = self.instance.open(username)
 485
 486         # re-get the class with the new database connection
 487         cl = self.db.getclass(classname)
 488
 489         # now update the recipients list
 490         recipients = []
 491         tracker_email = self.instance.ISSUE_TRACKER_EMAIL.lower()
 492         for recipient in message.getaddrlist('to') + message.getaddrlist('cc'):
 493             r = recipient[1].strip().lower()
 494             if r == tracker_email or not r:
 495                 continue
 496             recipients.append(self.db.uidFromAddress(recipient))
 497
 498         #
 499         # handle message-id and in-reply-to
 500         #
 501         messageid = message.getheader('message-id')
 502         inreplyto = message.getheader('in-reply-to') or ''
 503         # generate a messageid if there isn't one
 504         if not messageid:
 505             messageid = "<%s.%s.%s%s@%s>"%(time.time(), random.random(),
 506                 classname, nodeid, self.instance.MAIL_DOMAIN)
 507
 508         #
 509         # now handle the body - find the message
 510         #
 511         content_type =  message.gettype()
 512         attachments = []
 513         # General multipart handling:
 514         #   Take the first text/plain part, anything else is considered an
 515         #   attachment.
 516         # multipart/mixed: multiple "unrelated" parts.
 517         # multipart/signed (rfc 1847):
 518         #   The control information is carried in the second of the two
 519         #   required body parts.
 520         #   ACTION: Default, so if content is text/plain we get it.
 521         # multipart/encrypted (rfc 1847):
 522         #   The control information is carried in the first of the two
 523         #   required body parts.
 524         #   ACTION: Not handleable as the content is encrypted.
 525         # multipart/related (rfc 1872, 2112, 2387):
 526         #   The Multipart/Related content-type addresses the MIME
 527         #   representation of compound objects.
 528         #   ACTION: Default. If we are lucky there is a text/plain.
 529         #   TODO: One should use the start part and look for an Alternative
 530         #   that is text/plain.
 531         # multipart/Alternative (rfc 1872, 1892):
 532         #   only in "related" ?
 533         # multipart/report (rfc 1892):
 534         #   e.g. mail system delivery status reports.
 535         #   ACTION: Default. Could be ignored or used for Delivery Notification
 536         #   flagging.
 537         # multipart/form-data:
 538         #   For web forms only.
 539         if content_type == 'multipart/mixed':
 540             # skip over the intro to the first boundary
 541             part = message.getPart()
 542             content = None
 543             while 1:
 544                 # get the next part
 545                 part = message.getPart()
 546                 if part is None:
 547                     break
 548                 # parse it
 549                 subtype = part.gettype()
 550                 if subtype == 'text/plain' and not content:
 551                     # The first text/plain part is the message content.
 552                     content = self.get_part_data_decoded(part)
 553                 elif subtype == 'message/rfc822':
 554                     # handle message/rfc822 specially - the name should be
 555                     # the subject of the actual e-mail embedded here
 556                     i = part.fp.tell()
 557                     mailmess = Message(part.fp)
 558                     name = mailmess.getheader('subject')
 559                     part.fp.seek(i)
 560                     attachments.append((name, 'message/rfc822', part.fp.read()))
 561                 else:
 562                     # try name on Content-Type
 563                     name = part.getparam('name')
 564                     # this is just an attachment
 565                     data = self.get_part_data_decoded(part)
 566                     attachments.append((name, part.gettype(), data))
 567             if content is None:
 568                 raise MailUsageError, '''
 569 Roundup requires the submission to be plain text. The message parser could
 570 not find a text/plain part to use.
 571 '''
 572
 573         elif content_type[:10] == 'multipart/':
 574             # skip over the intro to the first boundary
 575             message.getPart()
 576             content = None
 577             while 1:
 578                 # get the next part
 579                 part = message.getPart()
 580                 if part is None:
 581                     break
 582                 # parse it
 583                 if part.gettype() == 'text/plain' and not content:
 584                     content = self.get_part_data_decoded(part)
 585             if content is None:
 586                 raise MailUsageError, '''
 587 Roundup requires the submission to be plain text. The message parser could
 588 not find a text/plain part to use.
 589 '''
 590
 591         elif content_type != 'text/plain':
 592             raise MailUsageError, '''
 593 Roundup requires the submission to be plain text. The message parser could
 594 not find a text/plain part to use.
 595 '''
 596
 597         else:
 598             content = self.get_part_data_decoded(message)
 599
 600         summary, content = parseContent(content)
 601
 602         #
 603         # handle the attachments
 604         #
 605         files = []
 606         for (name, mime_type, data) in attachments:
 607             if not name:
 608                 name = "unnamed"
 609             files.append(self.db.file.create(type=mime_type, name=name,
 610                 content=data))
 611
 612         #
 613         # now handle the db stuff
 614         #
 615         if nodeid:
 616             # If an item designator (class name and id number) is found there,
 617             # the newly created "msg" node is added to the "messages" property
 618             # for that item, and any new "file" nodes are added to the "files"
 619             # property for the item.
 620
 621             # if the message is currently 'unread' or 'resolved', then set
 622             # it to 'chatting'
 623             if properties.has_key('status'):
 624                 try:
 625                     # determine the id of 'unread', 'resolved' and 'chatting'
 626                     unread_id = self.db.status.lookup('unread')
 627                     resolved_id = self.db.status.lookup('resolved')
 628                     chatting_id = self.db.status.lookup('chatting')
 629                 except KeyError:
 630                     pass
 631                 else:
 632                     current_status = cl.get(nodeid, 'status')
 633                     if (not props.has_key('status') and
 634                             current_status == unread_id or
 635                             current_status == resolved_id):
 636                         props['status'] = chatting_id
 637
 638             # add nosy in arguments to issue's nosy list
 639             if not props.has_key('nosy'): props['nosy'] = []
 640             n = {}
 641             for nid in cl.get(nodeid, 'nosy'):
 642                 n[nid] = 1
 643             for value in props['nosy']:
 644                 if self.db.hasnode('user', value):
 645                     nid = value
 646                 else:
 647                     continue
 648                 if n.has_key(nid): continue
 649                 n[nid] = 1
 650             props['nosy'] = n.keys()
 651             # add assignedto to the nosy list
 652             if props.has_key('assignedto'):
 653                 assignedto = props['assignedto']
 654                 if assignedto not in props['nosy']:
 655                     props['nosy'].append(assignedto)
 656
 657             message_id = self.db.msg.create(author=author,
 658                 recipients=recipients, date=date.Date('.'), summary=summary,
 659                 content=content, files=files, messageid=messageid,
 660                 inreplyto=inreplyto)
 661             try:
 662                 messages = cl.get(nodeid, 'messages')
 663             except IndexError:
 664                 raise MailUsageError, '''
 665 The node specified by the designator in the subject of your message ("%s")
 666 does not exist.
 667
 668 Subject was: "%s"
 669 '''%(nodeid, subject)
 670             messages.append(message_id)
 671             props['messages'] = messages
 672
 673             # now apply the changes
 674             try:
 675                 cl.set(nodeid, **props)
 676             except (TypeError, IndexError, ValueError), message:
 677                 raise MailUsageError, '''
 678 There was a problem with the message you sent:
 679    %s
 680 '''%message
 681             # commit the changes to the DB
 682             self.db.commit()
 683         else:
 684             # If just an item class name is found there, we attempt to create a
 685             # new item of that class with its "messages" property initialized to
 686             # contain the new "msg" node and its "files" property initialized to
 687             # contain any new "file" nodes.
 688             message_id = self.db.msg.create(author=author,
 689                 recipients=recipients, date=date.Date('.'), summary=summary,
 690                 content=content, files=files, messageid=messageid,
 691                 inreplyto=inreplyto)
 692
 693             # pre-set the issue to unread
 694             if properties.has_key('status') and not props.has_key('status'):
 695                 try:
 696                     # determine the id of 'unread'
 697                     unread_id = self.db.status.lookup('unread')
 698                 except KeyError:
 699                     pass
 700                 else:
 701                     props['status'] = '1'
 702
 703             # set the title to the subject
 704             if properties.has_key('title') and not props.has_key('title'):
 705                 props['title'] = title
 706
 707             # pre-load the messages list
 708             props['messages'] = [message_id]
 709
 710             # set up (clean) the nosy list
 711             nosy = props.get('nosy', [])
 712             n = {}
 713             for value in nosy:
 714                 nid = value
 715                 if n.has_key(nid): continue
 716                 n[nid] = 1
 717             props['nosy'] = n.keys()
 718             # add on the recipients of the message
 719             for recipient in recipients:
 720                 if not n.has_key(recipient):
 721                     props['nosy'].append(recipient)
 722                     n[recipient] = 1
 723
 724             # add the author to the nosy list
 725             if not n.has_key(author):
 726                 props['nosy'].append(author)
 727                 n[author] = 1
 728
 729             # add assignedto to the nosy list
 730             if properties.has_key('assignedto') and props.has_key('assignedto'):
 731                 assignedto = props['assignedto']
 732                 if not n.has_key(assignedto):
 733                     props['nosy'].append(assignedto)
 734                     n[assignedto] = 1
 735
 736             # and attempt to create the new node
 737             try:
 738                 nodeid = cl.create(**props)
 739             except (TypeError, IndexError, ValueError), message:
 740                 raise MailUsageError, '''
 741 There was a problem with the message you sent:
 742    %s
 743 '''%message
 744
 745             # commit the new node(s) to the DB
 746             self.db.commit()
 747
 748 def parseContent(content, blank_line=re.compile(r'[\r\n]+\s*[\r\n]+'),
 749         eol=re.compile(r'[\r\n]+'), signature=re.compile(r'^[>|\s]*[-_]+\s*$')):
 750     ''' The message body is divided into sections by blank lines.
 751     Sections where the second and all subsequent lines begin with a ">" or "|"
 752     character are considered "quoting sections". The first line of the first
 753     non-quoting section becomes the summary of the message.
 754     '''
 755     # strip off leading carriage-returns / newlines
 756     i = 0
 757     for i in range(len(content)):
 758         if content[i] not in '\r\n':
 759             break
 760     if i > 0:
 761         sections = blank_line.split(content[i:])
 762     else:
 763         sections = blank_line.split(content)
 764
 765     # extract out the summary from the message
 766     summary = ''
 767     l = []
 768     for section in sections:
 769         #section = section.strip()
 770         if not section:
 771             continue
 772         lines = eol.split(section)
 773         if (lines[0] and lines[0][0] in '>|') or (len(lines) > 1 and
 774                 lines[1] and lines[1][0] in '>|'):
 775             # see if there's a response somewhere inside this section (ie.
 776             # no blank line between quoted message and response)
 777             for line in lines[1:]:
 778                 if line[0] not in '>|':
 779                     break
 780             else:
 781                 # TODO: people who want to keep quoted bits will want the
 782                 # next line...
 783                 # l.append(section)
 784                 continue
 785             # keep this section - it has reponse stuff in it
 786             if not summary:
 787                 # and while we're at it, use the first non-quoted bit as
 788                 # our summary
 789                 summary = line
 790             lines = lines[lines.index(line):]
 791             section = '\n'.join(lines)
 792
 793         if not summary:
 794             # if we don't have our summary yet use the first line of this
 795             # section
 796             summary = lines[0]
 797         elif signature.match(lines[0]):
 798             break
 799
 800         # and add the section to the output
 801         l.append(section)
 802     return summary, '\n\n'.join(l)
 803
 804 #
 805 # $Log: not supported by cvs2svn $
 806 # Revision 1.65  2002/02/15 00:13:38  richard
 807 #  . #503204 ] mailgw needs a default class
 808 #     - partially done - the setting of additional properties can wait for a
 809 #       better configuration system.
 810 #
 811 # Revision 1.64  2002/02/14 23:46:02  richard
 812 # . #516883 ] mail interface + ANONYMOUS_REGISTER
 813 #
 814 # Revision 1.63  2002/02/12 08:08:55  grubert
 815 #  . Clean up mail handling, multipart handling.
 816 #
 817 # Revision 1.62  2002/02/05 14:15:29  grubert
 818 #  . respect encodings in non multipart messages.
 819 #
 820 # Revision 1.61  2002/02/04 09:40:21  grubert
 821 #  . add test for multipart messages with first part being encoded.
 822 #
 823 # Revision 1.60  2002/02/01 07:43:12  grubert
 824 #  . mailgw checks encoding on first part too.
 825 #
 826 # Revision 1.59  2002/01/23 21:43:23  richard
 827 # tabnuke
 828 #
 829 # Revision 1.58  2002/01/23 21:41:56  richard
 830 #  . mailgw failures (unexpected ones) are forwarded to the roundup admin
 831 #
 832 # Revision 1.57  2002/01/22 22:27:43  richard
 833 #  . handle stripping of "AW:" from subject line
 834 #
 835 # Revision 1.56  2002/01/22 11:54:45  rochecompaan
 836 # Fixed status change in mail gateway.
 837 #
 838 # Revision 1.55  2002/01/21 10:05:47  rochecompaan
 839 # Feature:
 840 #  . the mail gateway now responds with an error message when invalid
 841 #    values for arguments are specified for link or multilink properties
 842 #  . modified unit test to check nosy and assignedto when specified as
 843 #    arguments
 844 #
 845 # Fixed:
 846 #  . fixed setting nosy as argument in subject line
 847 #
 848 # Revision 1.54  2002/01/16 09:14:45  grubert
 849 #  . if the attachment has no name, name it unnamed, happens with tnefs.
 850 #
 851 # Revision 1.53  2002/01/16 07:20:54  richard
 852 # simple help command for mailgw
 853 #
 854 # Revision 1.52  2002/01/15 00:12:40  richard
 855 # #503340 ] creating issue with [asignedto=p.ohly]
 856 #
 857 # Revision 1.51  2002/01/14 02:20:15  richard
 858 #  . changed all config accesses so they access either the instance or the
 859 #    config attriubute on the db. This means that all config is obtained from
 860 #    instance_config instead of the mish-mash of classes. This will make
 861 #    switching to a ConfigParser setup easier too, I hope.
 862 #
 863 # At a minimum, this makes migration a _little_ easier (a lot easier in the
 864 # 0.5.0 switch, I hope!)
 865 #
 866 # Revision 1.50  2002/01/11 22:59:01  richard
 867 #  . #502342 ] pipe interface
 868 #
 869 # Revision 1.49  2002/01/10 06:19:18  richard
 870 # followup lines directly after a quoted section were being eaten.
 871 #
 872 # Revision 1.48  2002/01/08 04:12:05  richard
 873 # Changed message-id format to "<%s.%s.%s%s@%s>" so it complies with RFC822
 874 #
 875 # Revision 1.47  2002/01/02 02:32:38  richard
 876 # ANONYMOUS_ACCESS -> ANONYMOUS_REGISTER
 877 #
 878 # Revision 1.46  2002/01/02 02:31:38  richard
 879 # Sorry for the huge checkin message - I was only intending to implement #496356
 880 # but I found a number of places where things had been broken by transactions:
 881 #  . modified ROUNDUPDBSENDMAILDEBUG to be SENDMAILDEBUG and hold a filename
 882 #    for _all_ roundup-generated smtp messages to be sent to.
 883 #  . the transaction cache had broken the roundupdb.Class set() reactors
 884 #  . newly-created author users in the mailgw weren't being committed to the db
 885 #
 886 # Stuff that made it into CHANGES.txt (ie. the stuff I was actually working
 887 # on when I found that stuff :):
 888 #  . #496356 ] Use threading in messages
 889 #  . detectors were being registered multiple times
 890 #  . added tests for mailgw
 891 #  . much better attaching of erroneous messages in the mail gateway
 892 #
 893 # Revision 1.45  2001/12/20 15:43:01  rochecompaan
 894 # Features added:
 895 #  .  Multilink properties are now displayed as comma separated values in
 896 #     a textbox
 897 #  .  The add user link is now only visible to the admin user
 898 #  .  Modified the mail gateway to reject submissions from unknown
 899 #     addresses if ANONYMOUS_ACCESS is denied
 900 #
 901 # Revision 1.44  2001/12/18 15:30:34  rochecompaan
 902 # Fixed bugs:
 903 #  .  Fixed file creation and retrieval in same transaction in anydbm
 904 #     backend
 905 #  .  Cgi interface now renders new issue after issue creation
 906 #  .  Could not set issue status to resolved through cgi interface
 907 #  .  Mail gateway was changing status back to 'chatting' if status was
 908 #     omitted as an argument
 909 #
 910 # Revision 1.43  2001/12/15 19:39:01  rochecompaan
 911 # Oops.
 912 #
 913 # Revision 1.42  2001/12/15 19:24:39  rochecompaan
 914 #  . Modified cgi interface to change properties only once all changes are
 915 #    collected, files created and messages generated.
 916 #  . Moved generation of change note to nosyreactors.
 917 #  . We now check for changes to "assignedto" to ensure it's added to the
 918 #    nosy list.
 919 #
 920 # Revision 1.41  2001/12/10 00:57:38  richard
 921 # From CHANGES:
 922 #  . Added the "display" command to the admin tool - displays a node's values
 923 #  . #489760 ] [issue] only subject
 924 #  . fixed the doc/index.html to include the quoting in the mail alias.
 925 #
 926 # Also:
 927 #  . fixed roundup-admin so it works with transactions
 928 #  . disabled the back_anydbm module if anydbm tries to use dumbdbm
 929 #
 930 # Revision 1.40  2001/12/05 14:26:44  rochecompaan
 931 # Removed generation of change note from "sendmessage" in roundupdb.py.
 932 # The change note is now generated when the message is created.
 933 #
 934 # Revision 1.39  2001/12/02 05:06:16  richard
 935 # . We now use weakrefs in the Classes to keep the database reference, so
 936 #   the close() method on the database is no longer needed.
 937 #   I bumped the minimum python requirement up to 2.1 accordingly.
 938 # . #487480 ] roundup-server
 939 # . #487476 ] INSTALL.txt
 940 #
 941 # I also cleaned up the change message / post-edit stuff in the cgi client.
 942 # There's now a clearly marked "TODO: append the change note" where I believe
 943 # the change note should be added there. The "changes" list will obviously
 944 # have to be modified to be a dict of the changes, or somesuch.
 945 #
 946 # More testing needed.
 947 #
 948 # Revision 1.38  2001/12/01 07:17:50  richard
 949 # . We now have basic transaction support! Information is only written to
 950 #   the database when the commit() method is called. Only the anydbm
 951 #   backend is modified in this way - neither of the bsddb backends have been.
 952 #   The mail, admin and cgi interfaces all use commit (except the admin tool
 953 #   doesn't have a commit command, so interactive users can't commit...)
 954 # . Fixed login/registration forwarding the user to the right page (or not,
 955 #   on a failure)
 956 #
 957 # Revision 1.37  2001/11/28 21:55:35  richard
 958 #  . login_action and newuser_action return values were being ignored
 959 #  . Woohoo! Found that bloody re-login bug that was killing the mail
 960 #    gateway.
 961 #  (also a minor cleanup in hyperdb)
 962 #
 963 # Revision 1.36  2001/11/26 22:55:56  richard
 964 # Feature:
 965 #  . Added INSTANCE_NAME to configuration - used in web and email to identify
 966 #    the instance.
 967 #  . Added EMAIL_SIGNATURE_POSITION to indicate where to place the roundup
 968 #    signature info in e-mails.
 969 #  . Some more flexibility in the mail gateway and more error handling.
 970 #  . Login now takes you to the page you back to the were denied access to.
 971 #
 972 # Fixed:
 973 #  . Lots of bugs, thanks Roché and others on the devel mailing list!
 974 #
 975 # Revision 1.35  2001/11/22 15:46:42  jhermann
 976 # Added module docstrings to all modules.
 977 #
 978 # Revision 1.34  2001/11/15 10:24:27  richard
 979 # handle the case where there is no file attached
 980 #
 981 # Revision 1.33  2001/11/13 21:44:44  richard
 982 #  . re-open the database as the author in mail handling
 983 #
 984 # Revision 1.32  2001/11/12 22:04:29  richard
 985 # oops, left debug in there
 986 #
 987 # Revision 1.31  2001/11/12 22:01:06  richard
 988 # Fixed issues with nosy reaction and author copies.
 989 #
 990 # Revision 1.30  2001/11/09 22:33:28  richard
 991 # More error handling fixes.
 992 #
 993 # Revision 1.29  2001/11/07 05:29:26  richard
 994 # Modified roundup-mailgw so it can read e-mails from a local mail spool
 995 # file. Truncates the spool file after parsing.
 996 # Fixed a couple of small bugs introduced in roundup.mailgw when I started
 997 # the popgw.
 998 #
 999 # Revision 1.28  2001/11/01 22:04:37  richard
1000 # Started work on supporting a pop3-fetching server
1001 # Fixed bugs:
1002 #  . bug #477104 ] HTML tag error in roundup-server
1003 #  . bug #477107 ] HTTP header problem
1004 #
1005 # Revision 1.27  2001/10/30 11:26:10  richard
1006 # Case-insensitive match for ISSUE_TRACKER_EMAIL in address in e-mail.
1007 #
1008 # Revision 1.26  2001/10/30 00:54:45  richard
1009 # Features:
1010 #  . #467129 ] Lossage when username=e-mail-address
1011 #  . #473123 ] Change message generation for author
1012 #  . MailGW now moves 'resolved' to 'chatting' on receiving e-mail for an issue.
1013 #
1014 # Revision 1.25  2001/10/28 23:22:28  richard
1015 # fixed bug #474749 ] Indentations lost
1016 #
1017 # Revision 1.24  2001/10/23 22:57:52  richard
1018 # Fix unread->chatting auto transition, thanks Roch'e
1019 #
1020 # Revision 1.23  2001/10/21 04:00:20  richard
1021 # MailGW now moves 'unread' to 'chatting' on receiving e-mail for an issue.
1022 #
1023 # Revision 1.22  2001/10/21 03:35:13  richard
1024 # bug #473125: Paragraph in e-mails
1025 #
1026 # Revision 1.21  2001/10/21 00:53:42  richard
1027 # bug #473130: Nosy list not set correctly
1028 #
1029 # Revision 1.20  2001/10/17 23:13:19  richard
1030 # Did a fair bit of work on the admin tool. Now has an extra command "table"
1031 # which displays node information in a tabular format. Also fixed import and
1032 # export so they work. Removed freshen.
1033 # Fixed quopri usage in mailgw from bug reports.
1034 #
1035 # Revision 1.19  2001/10/11 23:43:04  richard
1036 # Implemented the comma-separated printing option in the admin tool.
1037 # Fixed a typo (more of a vim-o actually :) in mailgw.
1038 #
1039 # Revision 1.18  2001/10/11 06:38:57  richard
1040 # Initial cut at trying to handle people responding to CC'ed messages that
1041 # create an issue.
1042 #
1043 # Revision 1.17  2001/10/09 07:25:59  richard
1044 # Added the Password property type. See "pydoc roundup.password" for
1045 # implementation details. Have updated some of the documentation too.
1046 #
1047 # Revision 1.16  2001/10/05 02:23:24  richard
1048 #  . roundup-admin create now prompts for property info if none is supplied
1049 #    on the command-line.
1050 #  . hyperdb Class getprops() method may now return only the mutable
1051 #    properties.
1052 #  . Login now uses cookies, which makes it a whole lot more flexible. We can
1053 #    now support anonymous user access (read-only, unless there's an
1054 #    "anonymous" user, in which case write access is permitted). Login
1055 #    handling has been moved into cgi_client.Client.main()
1056 #  . The "extended" schema is now the default in roundup init.
1057 #  . The schemas have had their page headings modified to cope with the new
1058 #    login handling. Existing installations should copy the interfaces.py
1059 #    file from the roundup lib directory to their instance home.
1060 #  . Incorrectly had a Bizar Software copyright on the cgitb.py module from
1061 #    Ping - has been removed.
1062 #  . Fixed a whole bunch of places in the CGI interface where we should have
1063 #    been returning Not Found instead of throwing an exception.
1064 #  . Fixed a deviation from the spec: trying to modify the 'id' property of
1065 #    an item now throws an exception.
1066 #
1067 # Revision 1.15  2001/08/30 06:01:17  richard
1068 # Fixed missing import in mailgw :(
1069 #
1070 # Revision 1.14  2001/08/13 23:02:54  richard
1071 # Make the mail parser a little more robust.
1072 #
1073 # Revision 1.13  2001/08/12 06:32:36  richard
1074 # using isinstance(blah, Foo) now instead of isFooType
1075 #
1076 # Revision 1.12  2001/08/08 01:27:00  richard
1077 # Added better error handling to mailgw.
1078 #
1079 # Revision 1.11  2001/08/08 00:08:03  richard
1080 # oops ;)
1081 #
1082 # Revision 1.10  2001/08/07 00:24:42  richard
1083 # stupid typo
1084 #
1085 # Revision 1.9  2001/08/07 00:15:51  richard
1086 # Added the copyright/license notice to (nearly) all files at request of
1087 # Bizar Software.
1088 #
1089 # Revision 1.8  2001/08/05 07:06:07  richard
1090 # removed some print statements
1091 #
1092 # Revision 1.7  2001/08/03 07:18:22  richard
1093 # Implemented correct mail splitting (was taking a shortcut). Added unit
1094 # tests. Also snips signatures now too.
1095 #
1096 # Revision 1.6  2001/08/01 04:24:21  richard
1097 # mailgw was assuming certain properties existed on the issues being created.
1098 #
1099 # Revision 1.5  2001/07/29 07:01:39  richard
1100 # Added vim command to all source so that we don't get no steenkin' tabs :)
1101 #
1102 # Revision 1.4  2001/07/28 06:43:02  richard
1103 # Multipart message class has the getPart method now. Added some tests for it.
1104 #
1105 # Revision 1.3  2001/07/28 00:34:34  richard
1106 # Fixed some non-string node ids.
1107 #
1108 # Revision 1.2  2001/07/22 12:09:32  richard
1109 # Final commit of Grande Splite
1110 #
1111 #
1112 # vim: set filetype=python ts=4 sw=4 et si