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