Code

simple help command for mailgw
[roundup.git] / 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 #
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.53 2002-01-16 07:20:54 richard 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)\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]]
178                 m = ['']
179                 m.append('----  traceback of failure  ----')
180                 s = cStringIO.StringIO()
181                 import traceback
182                 traceback.print_exc(None, s)
183                 m.append(s.getvalue())
184                 m = self.bounce_message(message, sendto, m)
185         else:
186             # very bad-looking message - we don't even know who sent it
187             sendto = [self.instance.ADMIN_EMAIL]
188             m = ['Subject: badly formed message from mail gateway']
189             m.append('')
190             m.append('The mail gateway retrieved a message which has no From:')
191             m.append('line, indicating that it is corrupt. Please check your')
192             m.append('mail gateway source. Failed message is attached.')
193             m.append('')
194             m = self.bounce_message(message, sendto, m,
195                 subject='Badly formed message from mail gateway')
197         # now send the message
198         if SENDMAILDEBUG:
199             open(SENDMAILDEBUG, 'w').write('From: %s\nTo: %s\n%s\n'%(
200                 self.instance.ADMIN_EMAIL, ', '.join(sendto), m.getvalue()))
201         else:
202             try:
203                 smtp = smtplib.SMTP(self.instance.MAILHOST)
204                 smtp.sendmail(self.instance.ADMIN_EMAIL, sendto, m.getvalue())
205             except socket.error, value:
206                 raise MailGWError, "Couldn't send error email: "\
207                     "mailhost %s"%value
208             except smtplib.SMTPException, value:
209                 raise MailGWError, "Couldn't send error email: %s"%value
211     def bounce_message(self, message, sendto, error,
212             subject='Failed issue tracker submission'):
213         ''' create a message that explains the reason for the failed
214             issue submission to the author and attach the original
215             message.
216         '''
217         msg = cStringIO.StringIO()
218         writer = MimeWriter.MimeWriter(msg)
219         writer.addheader('Subject', subject)
220         writer.addheader('From', '%s <%s>'% (self.instance.INSTANCE_NAME,
221                                             self.instance.ISSUE_TRACKER_EMAIL))
222         writer.addheader('To', ','.join(sendto))
223         writer.addheader('MIME-Version', '1.0')
224         part = writer.startmultipartbody('mixed')
225         part = writer.nextpart()
226         body = part.startbody('text/plain')
227         body.write('\n'.join(error))
229         # reconstruct the original message
230         m = cStringIO.StringIO()
231         w = MimeWriter.MimeWriter(m)
232         # default the content_type, just in case...
233         content_type = 'text/plain'
234         # add the headers except the content-type
235         for header in message.headers:
236             header_name = header.split(':')[0]
237             if header_name.lower() == 'content-type':
238                 content_type = message.getheader(header_name)
239             elif message.getheader(header_name):
240                 w.addheader(header_name, message.getheader(header_name))
241         # now attach the message body
242         body = w.startbody(content_type)
243         try:
244             message.rewindbody()
245         except IOError:
246             body.write("*** couldn't include message body: read from pipe ***")
247         else:
248             body.write(message.fp.read())
250         # attach the original message to the returned message
251         part = writer.nextpart()
252         part.addheader('Content-Disposition','attachment')
253         part.addheader('Content-Description','Message you sent')
254         part.addheader('Content-Transfer-Encoding', '7bit')
255         body = part.startbody('message/rfc822')
256         body.write(m.getvalue())
258         writer.lastpart()
259         return msg
261     def handle_message(self, message):
262         ''' message - a Message instance
264         Parse the message as per the module docstring.
265         '''
266         # handle the subject line
267         subject = message.getheader('subject', '')
269         if subject.strip() == 'help':
270             raise MailUsageHelp
272         m = subject_re.match(subject)
273         if not m:
274             raise MailUsageError, '''
275 The message you sent to roundup did not contain a properly formed subject
276 line. The subject must contain a class name or designator to indicate the
277 "topic" of the message. For example:
278     Subject: [issue] This is a new issue
279       - this will create a new issue in the tracker with the title "This is
280         a new issue".
281     Subject: [issue1234] This is a followup to issue 1234
282       - this will append the message's contents to the existing issue 1234
283         in the tracker.
285 Subject was: "%s"
286 '''%subject
288         # get the classname
289         classname = m.group('classname')
290         try:
291             cl = self.db.getclass(classname)
292         except KeyError:
293             raise MailUsageError, '''
294 The class name you identified in the subject line ("%s") does not exist in the
295 database.
297 Valid class names are: %s
298 Subject was: "%s"
299 '''%(classname, ', '.join(self.db.getclasses()), subject)
301         # get the optional nodeid
302         nodeid = m.group('nodeid')
304         # title is optional too
305         title = m.group('title')
306         if title:
307             title = title.strip()
308         else:
309             title = ''
311         # but we do need either a title or a nodeid...
312         if not nodeid and not title:
313             raise MailUsageError, '''
314 I cannot match your message to a node in the database - you need to either
315 supply a full node identifier (with number, eg "[issue123]" or keep the
316 previous subject title intact so I can match that.
318 Subject was: "%s"
319 '''%subject
321         # extract the args
322         subject_args = m.group('args')
324         # If there's no nodeid, check to see if this is a followup and
325         # maybe someone's responded to the initial mail that created an
326         # entry. Try to find the matching nodes with the same title, and
327         # use the _last_ one matched (since that'll _usually_ be the most
328         # recent...)
329         if not nodeid and m.group('refwd'):
330             l = cl.stringFind(title=title)
331             if l:
332                 nodeid = l[-1]
334         # start of the props
335         properties = cl.getprops()
336         props = {}
338         # handle the args
339         args = m.group('args')
340         if args:
341             for prop in string.split(args, ';'):
342                 # extract the property name and value
343                 try:
344                     key, value = prop.split('=')
345                 except ValueError, message:
346                     raise MailUsageError, '''
347 Subject argument list not of form [arg=value,value,...;arg=value,value...]
348    (specific exception message was "%s")
350 Subject was: "%s"
351 '''%(message, subject)
353                 # ensure it's a valid property name
354                 key = key.strip()
355                 try:
356                     proptype =  properties[key]
357                 except KeyError:
358                     raise MailUsageError, '''
359 Subject argument list refers to an invalid property: "%s"
361 Subject was: "%s"
362 '''%(key, subject)
364                 # convert the string value to a real property value
365                 if isinstance(proptype, hyperdb.String):
366                     props[key] = value.strip()
367                 if isinstance(proptype, hyperdb.Password):
368                     props[key] = password.Password(value.strip())
369                 elif isinstance(proptype, hyperdb.Date):
370                     try:
371                         props[key] = date.Date(value.strip())
372                     except ValueError, message:
373                         raise UsageError, '''
374 Subject argument list contains an invalid date for %s.
376 Error was: %s
377 Subject was: "%s"
378 '''%(key, message, subject)
379                 elif isinstance(proptype, hyperdb.Interval):
380                     try:
381                         props[key] = date.Interval(value) # no strip needed
382                     except ValueError, message:
383                         raise UsageError, '''
384 Subject argument list contains an invalid date interval for %s.
386 Error was: %s
387 Subject was: "%s"
388 '''%(key, message, subject)
389                 elif isinstance(proptype, hyperdb.Link):
390                     link = self.db.classes[proptype.classname]
391                     propkey = link.labelprop(default_to_id=1)
392                     props[key] = value
393                 elif isinstance(proptype, hyperdb.Multilink):
394                     # get the linked class
395                     linkcl = self.db.classes[proptype.classname]
396                     propkey = linkcl.labelprop(default_to_id=1)
397                     for item in value.split(','):
398                         item = item.split()
399                         if props.has_key(key):
400                             props[key].append(item)
401                         else:
402                             props[key] = [item]
404         #
405         # handle the users
406         #
408         # Don't create users if ANONYMOUS_REGISTER is denied
409         if self.instance.ANONYMOUS_REGISTER == 'deny':
410             create = 0
411         else:
412             create = 1
413         author = self.db.uidFromAddress(message.getaddrlist('from')[0],
414             create=create)
415         if not author:
416             raise UnAuthorized, '''
417 You are not a registered user.
419 Unknown address: %s
420 '''%message.getaddrlist('from')[0][1]
422         # the author may have been created - make sure the change is
423         # committed before we reopen the database
424         self.db.commit()
425             
426         # reopen the database as the author
427         username = self.db.user.get(author, 'username')
428         self.db = self.instance.open(username)
430         # re-get the class with the new database connection
431         cl = self.db.getclass(classname)
433         # now update the recipients list
434         recipients = []
435         tracker_email = self.instance.ISSUE_TRACKER_EMAIL.lower()
436         for recipient in message.getaddrlist('to') + message.getaddrlist('cc'):
437             r = recipient[1].strip().lower()
438             if r == tracker_email or not r:
439                 continue
440             recipients.append(self.db.uidFromAddress(recipient))
442         #
443         # handle message-id and in-reply-to
444         #
445         messageid = message.getheader('message-id')
446         inreplyto = message.getheader('in-reply-to') or ''
447         # generate a messageid if there isn't one
448         if not messageid:
449             messageid = "<%s.%s.%s%s@%s>"%(time.time(), random.random(),
450                 classname, nodeid, self.instance.MAIL_DOMAIN)
452         #
453         # now handle the body - find the message
454         #
455         content_type =  message.gettype()
456         attachments = []
457         if content_type == 'multipart/mixed':
458             # skip over the intro to the first boundary
459             part = message.getPart()
460             content = None
461             while 1:
462                 # get the next part
463                 part = message.getPart()
464                 if part is None:
465                     break
466                 # parse it
467                 subtype = part.gettype()
468                 if subtype == 'text/plain' and not content:
469                     # add all text/plain parts to the message content
470                     if content is None:
471                         content = part.fp.read()
472                     else:
473                         content = content + part.fp.read()
475                 elif subtype == 'message/rfc822':
476                     # handle message/rfc822 specially - the name should be
477                     # the subject of the actual e-mail embedded here
478                     i = part.fp.tell()
479                     mailmess = Message(part.fp)
480                     name = mailmess.getheader('subject')
481                     part.fp.seek(i)
482                     attachments.append((name, 'message/rfc822', part.fp.read()))
484                 else:
485                     # try name on Content-Type
486                     name = part.getparam('name')
487                     # this is just an attachment
488                     encoding = part.getencoding()
489                     if encoding == 'base64':
490                         data = binascii.a2b_base64(part.fp.read())
491                     elif encoding == 'quoted-printable':
492                         # the quopri module wants to work with files
493                         decoded = cStringIO.StringIO()
494                         quopri.decode(part.fp, decoded)
495                         data = decoded.getvalue()
496                     elif encoding == 'uuencoded':
497                         data = binascii.a2b_uu(part.fp.read())
498                     attachments.append((name, part.gettype(), data))
500             if content is None:
501                 raise MailUsageError, '''
502 Roundup requires the submission to be plain text. The message parser could
503 not find a text/plain part to use.
504 '''
506         elif content_type[:10] == 'multipart/':
507             # skip over the intro to the first boundary
508             message.getPart()
509             content = None
510             while 1:
511                 # get the next part
512                 part = message.getPart()
513                 if part is None:
514                     break
515                 # parse it
516                 if part.gettype() == 'text/plain' and not content:
517                     # this one's our content
518                     content = part.fp.read()
519             if content is None:
520                 raise MailUsageError, '''
521 Roundup requires the submission to be plain text. The message parser could
522 not find a text/plain part to use.
523 '''
525         elif content_type != 'text/plain':
526             raise MailUsageError, '''
527 Roundup requires the submission to be plain text. The message parser could
528 not find a text/plain part to use.
529 '''
531         else:
532             content = message.fp.read()
534         summary, content = parseContent(content)
536         # 
537         # handle the attachments
538         #
539         files = []
540         for (name, mime_type, data) in attachments:
541             files.append(self.db.file.create(type=mime_type, name=name,
542                 content=data))
544         #
545         # now handle the db stuff
546         #
547         if nodeid:
548             # If an item designator (class name and id number) is found there,
549             # the newly created "msg" node is added to the "messages" property
550             # for that item, and any new "file" nodes are added to the "files" 
551             # property for the item. 
553             # if the message is currently 'unread' or 'resolved', then set
554             # it to 'chatting'
555             if properties.has_key('status'):
556                 try:
557                     # determine the id of 'unread', 'resolved' and 'chatting'
558                     unread_id = self.db.status.lookup('unread')
559                     resolved_id = self.db.status.lookup('resolved')
560                     chatting_id = self.db.status.lookup('chatting')
561                 except KeyError:
562                     pass
563                 else:
564                     if (not props.has_key('status') and
565                             properties['status'] == unread_id or
566                             properties['status'] == resolved_id):
567                         props['status'] = chatting_id
569             # add nosy in arguments to issue's nosy list
570             if not props.has_key('nosy'): props['nosy'] = []
571             n = {}
572             for nid in cl.get(nodeid, 'nosy'):
573                 n[nid] = 1
574             for value in props['nosy']:
575                 if self.db.hasnode('user', value):
576                     nid = value
577                 else: 
578                     continue
579                 if n.has_key(nid): continue
580                 n[nid] = 1
581             props['nosy'] = n.keys()
582             # add assignedto to the nosy list
583             try:
584                 assignedto = self.db.user.lookup(props['assignedto'])
585                 if assignedto not in props['nosy']:
586                     props['nosy'].append(assignedto)
587             except:
588                 pass
590             message_id = self.db.msg.create(author=author,
591                 recipients=recipients, date=date.Date('.'), summary=summary,
592                 content=content, files=files, messageid=messageid,
593                 inreplyto=inreplyto)
594             try:
595                 messages = cl.get(nodeid, 'messages')
596             except IndexError:
597                 raise MailUsageError, '''
598 The node specified by the designator in the subject of your message ("%s")
599 does not exist.
601 Subject was: "%s"
602 '''%(nodeid, subject)
603             messages.append(message_id)
604             props['messages'] = messages
606             # now apply the changes
607             try:
608                 cl.set(nodeid, **props)
609             except (TypeError, IndexError, ValueError), message:
610                 raise MailUsageError, '''
611 There was a problem with the message you sent:
612    %s
613 '''%message
614             # commit the changes to the DB
615             self.db.commit()
616         else:
617             # If just an item class name is found there, we attempt to create a
618             # new item of that class with its "messages" property initialized to
619             # contain the new "msg" node and its "files" property initialized to
620             # contain any new "file" nodes. 
621             message_id = self.db.msg.create(author=author,
622                 recipients=recipients, date=date.Date('.'), summary=summary,
623                 content=content, files=files, messageid=messageid,
624                 inreplyto=inreplyto)
626             # pre-set the issue to unread
627             if properties.has_key('status') and not props.has_key('status'):
628                 try:
629                     # determine the id of 'unread'
630                     unread_id = self.db.status.lookup('unread')
631                 except KeyError:
632                     pass
633                 else:
634                     props['status'] = '1'
636             # set the title to the subject
637             if properties.has_key('title') and not props.has_key('title'):
638                 props['title'] = title
640             # pre-load the messages list
641             props['messages'] = [message_id]
643             # set up (clean) the nosy list
644             nosy = props.get('nosy', [])
645             n = {}
646             for value in nosy:
647                 if self.db.hasnode('user', value):
648                     nid = value
649                 else:
650                     continue
651                 if n.has_key(nid): continue
652                 n[nid] = 1
653             props['nosy'] = n.keys()
654             # add on the recipients of the message
655             for recipient in recipients:
656                 if not n.has_key(recipient):
657                     props['nosy'].append(recipient)
658                     n[recipient] = 1
660             # add the author to the nosy list
661             if not n.has_key(author):
662                 props['nosy'].append(author)
663                 n[author] = 1
665             # add assignedto to the nosy list
666             if properties.has_key('assignedto') and props.has_key('assignedto'):
667                 assignedto = props['assignedto']
668                 if not re.match('^\d+$', assignedto):
669                     try:
670                         assignedto = self.db.user.lookup(assignedto)
671                     except KeyError:
672                         raise MailUsageError, '''
673 There was a problem with the message you sent:
674    Assignedto user '%s' doesn't exist
675 '''%props['assignedto']
676                 if not n.has_key(assignedto):
677                     props['nosy'].append(assignedto)
678                     n[assignedto] = 1
680             # and attempt to create the new node
681             try:
682                 nodeid = cl.create(**props)
683             except (TypeError, IndexError, ValueError), message:
684                 raise MailUsageError, '''
685 There was a problem with the message you sent:
686    %s
687 '''%message
689             # commit the new node(s) to the DB
690             self.db.commit()
692 def parseContent(content, blank_line=re.compile(r'[\r\n]+\s*[\r\n]+'),
693         eol=re.compile(r'[\r\n]+'), signature=re.compile(r'^[>|\s]*[-_]+\s*$')):
694     ''' The message body is divided into sections by blank lines.
695     Sections where the second and all subsequent lines begin with a ">" or "|"
696     character are considered "quoting sections". The first line of the first
697     non-quoting section becomes the summary of the message. 
698     '''
699     # strip off leading carriage-returns / newlines
700     i = 0
701     for i in range(len(content)):
702         if content[i] not in '\r\n':
703             break
704     if i > 0:
705         sections = blank_line.split(content[i:])
706     else:
707         sections = blank_line.split(content)
709     # extract out the summary from the message
710     summary = ''
711     l = []
712     for section in sections:
713         #section = section.strip()
714         if not section:
715             continue
716         lines = eol.split(section)
717         if (lines[0] and lines[0][0] in '>|') or (len(lines) > 1 and
718                 lines[1] and lines[1][0] in '>|'):
719             # see if there's a response somewhere inside this section (ie.
720             # no blank line between quoted message and response)
721             for line in lines[1:]:
722                 if line[0] not in '>|':
723                     break
724             else:
725                 # TODO: people who want to keep quoted bits will want the
726                 # next line...
727                 # l.append(section)
728                 continue
729             # keep this section - it has reponse stuff in it
730             if not summary:
731                 # and while we're at it, use the first non-quoted bit as
732                 # our summary
733                 summary = line
734             lines = lines[lines.index(line):]
735             section = '\n'.join(lines)
737         if not summary:
738             # if we don't have our summary yet use the first line of this
739             # section
740             summary = lines[0]
741         elif signature.match(lines[0]):
742             break
744         # and add the section to the output
745         l.append(section)
746     return summary, '\n\n'.join(l)
749 # $Log: not supported by cvs2svn $
750 # Revision 1.52  2002/01/15 00:12:40  richard
751 # #503340 ] creating issue with [asignedto=p.ohly]
753 # Revision 1.51  2002/01/14 02:20:15  richard
754 #  . changed all config accesses so they access either the instance or the
755 #    config attriubute on the db. This means that all config is obtained from
756 #    instance_config instead of the mish-mash of classes. This will make
757 #    switching to a ConfigParser setup easier too, I hope.
759 # At a minimum, this makes migration a _little_ easier (a lot easier in the
760 # 0.5.0 switch, I hope!)
762 # Revision 1.50  2002/01/11 22:59:01  richard
763 #  . #502342 ] pipe interface
765 # Revision 1.49  2002/01/10 06:19:18  richard
766 # followup lines directly after a quoted section were being eaten.
768 # Revision 1.48  2002/01/08 04:12:05  richard
769 # Changed message-id format to "<%s.%s.%s%s@%s>" so it complies with RFC822
771 # Revision 1.47  2002/01/02 02:32:38  richard
772 # ANONYMOUS_ACCESS -> ANONYMOUS_REGISTER
774 # Revision 1.46  2002/01/02 02:31:38  richard
775 # Sorry for the huge checkin message - I was only intending to implement #496356
776 # but I found a number of places where things had been broken by transactions:
777 #  . modified ROUNDUPDBSENDMAILDEBUG to be SENDMAILDEBUG and hold a filename
778 #    for _all_ roundup-generated smtp messages to be sent to.
779 #  . the transaction cache had broken the roundupdb.Class set() reactors
780 #  . newly-created author users in the mailgw weren't being committed to the db
782 # Stuff that made it into CHANGES.txt (ie. the stuff I was actually working
783 # on when I found that stuff :):
784 #  . #496356 ] Use threading in messages
785 #  . detectors were being registered multiple times
786 #  . added tests for mailgw
787 #  . much better attaching of erroneous messages in the mail gateway
789 # Revision 1.45  2001/12/20 15:43:01  rochecompaan
790 # Features added:
791 #  .  Multilink properties are now displayed as comma separated values in
792 #     a textbox
793 #  .  The add user link is now only visible to the admin user
794 #  .  Modified the mail gateway to reject submissions from unknown
795 #     addresses if ANONYMOUS_ACCESS is denied
797 # Revision 1.44  2001/12/18 15:30:34  rochecompaan
798 # Fixed bugs:
799 #  .  Fixed file creation and retrieval in same transaction in anydbm
800 #     backend
801 #  .  Cgi interface now renders new issue after issue creation
802 #  .  Could not set issue status to resolved through cgi interface
803 #  .  Mail gateway was changing status back to 'chatting' if status was
804 #     omitted as an argument
806 # Revision 1.43  2001/12/15 19:39:01  rochecompaan
807 # Oops.
809 # Revision 1.42  2001/12/15 19:24:39  rochecompaan
810 #  . Modified cgi interface to change properties only once all changes are
811 #    collected, files created and messages generated.
812 #  . Moved generation of change note to nosyreactors.
813 #  . We now check for changes to "assignedto" to ensure it's added to the
814 #    nosy list.
816 # Revision 1.41  2001/12/10 00:57:38  richard
817 # From CHANGES:
818 #  . Added the "display" command to the admin tool - displays a node's values
819 #  . #489760 ] [issue] only subject
820 #  . fixed the doc/index.html to include the quoting in the mail alias.
822 # Also:
823 #  . fixed roundup-admin so it works with transactions
824 #  . disabled the back_anydbm module if anydbm tries to use dumbdbm
826 # Revision 1.40  2001/12/05 14:26:44  rochecompaan
827 # Removed generation of change note from "sendmessage" in roundupdb.py.
828 # The change note is now generated when the message is created.
830 # Revision 1.39  2001/12/02 05:06:16  richard
831 # . We now use weakrefs in the Classes to keep the database reference, so
832 #   the close() method on the database is no longer needed.
833 #   I bumped the minimum python requirement up to 2.1 accordingly.
834 # . #487480 ] roundup-server
835 # . #487476 ] INSTALL.txt
837 # I also cleaned up the change message / post-edit stuff in the cgi client.
838 # There's now a clearly marked "TODO: append the change note" where I believe
839 # the change note should be added there. The "changes" list will obviously
840 # have to be modified to be a dict of the changes, or somesuch.
842 # More testing needed.
844 # Revision 1.38  2001/12/01 07:17:50  richard
845 # . We now have basic transaction support! Information is only written to
846 #   the database when the commit() method is called. Only the anydbm
847 #   backend is modified in this way - neither of the bsddb backends have been.
848 #   The mail, admin and cgi interfaces all use commit (except the admin tool
849 #   doesn't have a commit command, so interactive users can't commit...)
850 # . Fixed login/registration forwarding the user to the right page (or not,
851 #   on a failure)
853 # Revision 1.37  2001/11/28 21:55:35  richard
854 #  . login_action and newuser_action return values were being ignored
855 #  . Woohoo! Found that bloody re-login bug that was killing the mail
856 #    gateway.
857 #  (also a minor cleanup in hyperdb)
859 # Revision 1.36  2001/11/26 22:55:56  richard
860 # Feature:
861 #  . Added INSTANCE_NAME to configuration - used in web and email to identify
862 #    the instance.
863 #  . Added EMAIL_SIGNATURE_POSITION to indicate where to place the roundup
864 #    signature info in e-mails.
865 #  . Some more flexibility in the mail gateway and more error handling.
866 #  . Login now takes you to the page you back to the were denied access to.
868 # Fixed:
869 #  . Lots of bugs, thanks Roché and others on the devel mailing list!
871 # Revision 1.35  2001/11/22 15:46:42  jhermann
872 # Added module docstrings to all modules.
874 # Revision 1.34  2001/11/15 10:24:27  richard
875 # handle the case where there is no file attached
877 # Revision 1.33  2001/11/13 21:44:44  richard
878 #  . re-open the database as the author in mail handling
880 # Revision 1.32  2001/11/12 22:04:29  richard
881 # oops, left debug in there
883 # Revision 1.31  2001/11/12 22:01:06  richard
884 # Fixed issues with nosy reaction and author copies.
886 # Revision 1.30  2001/11/09 22:33:28  richard
887 # More error handling fixes.
889 # Revision 1.29  2001/11/07 05:29:26  richard
890 # Modified roundup-mailgw so it can read e-mails from a local mail spool
891 # file. Truncates the spool file after parsing.
892 # Fixed a couple of small bugs introduced in roundup.mailgw when I started
893 # the popgw.
895 # Revision 1.28  2001/11/01 22:04:37  richard
896 # Started work on supporting a pop3-fetching server
897 # Fixed bugs:
898 #  . bug #477104 ] HTML tag error in roundup-server
899 #  . bug #477107 ] HTTP header problem
901 # Revision 1.27  2001/10/30 11:26:10  richard
902 # Case-insensitive match for ISSUE_TRACKER_EMAIL in address in e-mail.
904 # Revision 1.26  2001/10/30 00:54:45  richard
905 # Features:
906 #  . #467129 ] Lossage when username=e-mail-address
907 #  . #473123 ] Change message generation for author
908 #  . MailGW now moves 'resolved' to 'chatting' on receiving e-mail for an issue.
910 # Revision 1.25  2001/10/28 23:22:28  richard
911 # fixed bug #474749 ] Indentations lost
913 # Revision 1.24  2001/10/23 22:57:52  richard
914 # Fix unread->chatting auto transition, thanks Roch'e
916 # Revision 1.23  2001/10/21 04:00:20  richard
917 # MailGW now moves 'unread' to 'chatting' on receiving e-mail for an issue.
919 # Revision 1.22  2001/10/21 03:35:13  richard
920 # bug #473125: Paragraph in e-mails
922 # Revision 1.21  2001/10/21 00:53:42  richard
923 # bug #473130: Nosy list not set correctly
925 # Revision 1.20  2001/10/17 23:13:19  richard
926 # Did a fair bit of work on the admin tool. Now has an extra command "table"
927 # which displays node information in a tabular format. Also fixed import and
928 # export so they work. Removed freshen.
929 # Fixed quopri usage in mailgw from bug reports.
931 # Revision 1.19  2001/10/11 23:43:04  richard
932 # Implemented the comma-separated printing option in the admin tool.
933 # Fixed a typo (more of a vim-o actually :) in mailgw.
935 # Revision 1.18  2001/10/11 06:38:57  richard
936 # Initial cut at trying to handle people responding to CC'ed messages that
937 # create an issue.
939 # Revision 1.17  2001/10/09 07:25:59  richard
940 # Added the Password property type. See "pydoc roundup.password" for
941 # implementation details. Have updated some of the documentation too.
943 # Revision 1.16  2001/10/05 02:23:24  richard
944 #  . roundup-admin create now prompts for property info if none is supplied
945 #    on the command-line.
946 #  . hyperdb Class getprops() method may now return only the mutable
947 #    properties.
948 #  . Login now uses cookies, which makes it a whole lot more flexible. We can
949 #    now support anonymous user access (read-only, unless there's an
950 #    "anonymous" user, in which case write access is permitted). Login
951 #    handling has been moved into cgi_client.Client.main()
952 #  . The "extended" schema is now the default in roundup init.
953 #  . The schemas have had their page headings modified to cope with the new
954 #    login handling. Existing installations should copy the interfaces.py
955 #    file from the roundup lib directory to their instance home.
956 #  . Incorrectly had a Bizar Software copyright on the cgitb.py module from
957 #    Ping - has been removed.
958 #  . Fixed a whole bunch of places in the CGI interface where we should have
959 #    been returning Not Found instead of throwing an exception.
960 #  . Fixed a deviation from the spec: trying to modify the 'id' property of
961 #    an item now throws an exception.
963 # Revision 1.15  2001/08/30 06:01:17  richard
964 # Fixed missing import in mailgw :(
966 # Revision 1.14  2001/08/13 23:02:54  richard
967 # Make the mail parser a little more robust.
969 # Revision 1.13  2001/08/12 06:32:36  richard
970 # using isinstance(blah, Foo) now instead of isFooType
972 # Revision 1.12  2001/08/08 01:27:00  richard
973 # Added better error handling to mailgw.
975 # Revision 1.11  2001/08/08 00:08:03  richard
976 # oops ;)
978 # Revision 1.10  2001/08/07 00:24:42  richard
979 # stupid typo
981 # Revision 1.9  2001/08/07 00:15:51  richard
982 # Added the copyright/license notice to (nearly) all files at request of
983 # Bizar Software.
985 # Revision 1.8  2001/08/05 07:06:07  richard
986 # removed some print statements
988 # Revision 1.7  2001/08/03 07:18:22  richard
989 # Implemented correct mail splitting (was taking a shortcut). Added unit
990 # tests. Also snips signatures now too.
992 # Revision 1.6  2001/08/01 04:24:21  richard
993 # mailgw was assuming certain properties existed on the issues being created.
995 # Revision 1.5  2001/07/29 07:01:39  richard
996 # Added vim command to all source so that we don't get no steenkin' tabs :)
998 # Revision 1.4  2001/07/28 06:43:02  richard
999 # Multipart message class has the getPart method now. Added some tests for it.
1001 # Revision 1.3  2001/07/28 00:34:34  richard
1002 # Fixed some non-string node ids.
1004 # Revision 1.2  2001/07/22 12:09:32  richard
1005 # Final commit of Grande Splite
1008 # vim: set filetype=python ts=4 sw=4 et si