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