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 # $Id: roundupdb.py,v 1.26 2001-12-05 14:26:44 rochecompaan Exp $
20 __doc__ = """
21 Extending hyperdb with types specific to issue-tracking.
22 """
24 import re, os, smtplib, socket
25 import mimetools, MimeWriter, cStringIO
26 import base64, mimetypes
28 import hyperdb, date
30 class DesignatorError(ValueError):
31 pass
32 def splitDesignator(designator, dre=re.compile(r'([^\d]+)(\d+)')):
33 ''' Take a foo123 and return ('foo', 123)
34 '''
35 m = dre.match(designator)
36 if m is None:
37 raise DesignatorError, '"%s" not a node designator'%designator
38 return m.group(1), m.group(2)
41 class Database:
42 def getuid(self):
43 """Return the id of the "user" node associated with the user
44 that owns this connection to the hyperdatabase."""
45 return self.user.lookup(self.journaltag)
47 def uidFromAddress(self, address, create=1):
48 ''' address is from the rfc822 module, and therefore is (name, addr)
50 user is created if they don't exist in the db already
51 '''
52 (realname, address) = address
53 users = self.user.stringFind(address=address)
54 for dummy in range(2):
55 if len(users) > 1:
56 # make sure we don't match the anonymous or admin user
57 for user in users:
58 if user == '1': continue
59 if self.user.get(user, 'username') == 'anonymous': continue
60 # first valid match will do
61 return user
62 # well, I guess we have no choice
63 return user[0]
64 elif users:
65 return users[0]
66 # try to match the username to the address (for local
67 # submissions where the address is empty)
68 users = self.user.stringFind(username=address)
70 # couldn't match address or username, so create a new user
71 return self.user.create(username=address, address=address,
72 realname=realname)
74 _marker = []
75 # XXX: added the 'creator' faked attribute
76 class Class(hyperdb.Class):
77 # Overridden methods:
78 def __init__(self, db, classname, **properties):
79 if (properties.has_key('creation') or properties.has_key('activity')
80 or properties.has_key('creator')):
81 raise ValueError, '"creation", "activity" and "creator" are reserved'
82 hyperdb.Class.__init__(self, db, classname, **properties)
83 self.auditors = {'create': [], 'set': [], 'retire': []}
84 self.reactors = {'create': [], 'set': [], 'retire': []}
86 def create(self, **propvalues):
87 """These operations trigger detectors and can be vetoed. Attempts
88 to modify the "creation" or "activity" properties cause a KeyError.
89 """
90 if propvalues.has_key('creation') or propvalues.has_key('activity'):
91 raise KeyError, '"creation" and "activity" are reserved'
92 for audit in self.auditors['create']:
93 audit(self.db, self, None, propvalues)
94 nodeid = hyperdb.Class.create(self, **propvalues)
95 for react in self.reactors['create']:
96 react(self.db, self, nodeid, None)
97 return nodeid
99 def set(self, nodeid, **propvalues):
100 """These operations trigger detectors and can be vetoed. Attempts
101 to modify the "creation" or "activity" properties cause a KeyError.
102 """
103 if propvalues.has_key('creation') or propvalues.has_key('activity'):
104 raise KeyError, '"creation" and "activity" are reserved'
105 for audit in self.auditors['set']:
106 audit(self.db, self, nodeid, propvalues)
107 oldvalues = self.db.getnode(self.classname, nodeid)
108 hyperdb.Class.set(self, nodeid, **propvalues)
109 for react in self.reactors['set']:
110 react(self.db, self, nodeid, oldvalues)
112 def retire(self, nodeid):
113 """These operations trigger detectors and can be vetoed. Attempts
114 to modify the "creation" or "activity" properties cause a KeyError.
115 """
116 for audit in self.auditors['retire']:
117 audit(self.db, self, nodeid, None)
118 hyperdb.Class.retire(self, nodeid)
119 for react in self.reactors['retire']:
120 react(self.db, self, nodeid, None)
122 def get(self, nodeid, propname, default=_marker):
123 """Attempts to get the "creation" or "activity" properties should
124 do the right thing.
125 """
126 if propname == 'creation':
127 journal = self.db.getjournal(self.classname, nodeid)
128 if journal:
129 return self.db.getjournal(self.classname, nodeid)[0][1]
130 else:
131 # on the strange chance that there's no journal
132 return date.Date()
133 if propname == 'activity':
134 journal = self.db.getjournal(self.classname, nodeid)
135 if journal:
136 return self.db.getjournal(self.classname, nodeid)[-1][1]
137 else:
138 # on the strange chance that there's no journal
139 return date.Date()
140 if propname == 'creator':
141 journal = self.db.getjournal(self.classname, nodeid)
142 if journal:
143 name = self.db.getjournal(self.classname, nodeid)[0][2]
144 else:
145 return None
146 return self.db.user.lookup(name)
147 if default is not _marker:
148 return hyperdb.Class.get(self, nodeid, propname, default)
149 else:
150 return hyperdb.Class.get(self, nodeid, propname)
152 def getprops(self, protected=1):
153 """In addition to the actual properties on the node, these
154 methods provide the "creation" and "activity" properties. If the
155 "protected" flag is true, we include protected properties - those
156 which may not be modified.
157 """
158 d = hyperdb.Class.getprops(self, protected=protected).copy()
159 if protected:
160 d['creation'] = hyperdb.Date()
161 d['activity'] = hyperdb.Date()
162 d['creator'] = hyperdb.Link("user")
163 return d
165 #
166 # Detector interface
167 #
168 def audit(self, event, detector):
169 """Register a detector
170 """
171 self.auditors[event].append(detector)
173 def react(self, event, detector):
174 """Register a detector
175 """
176 self.reactors[event].append(detector)
179 class FileClass(Class):
180 def create(self, **propvalues):
181 ''' snaffle the file propvalue and store in a file
182 '''
183 content = propvalues['content']
184 del propvalues['content']
185 newid = Class.create(self, **propvalues)
186 self.setcontent(self.classname, newid, content)
187 return newid
189 def filename(self, classname, nodeid):
190 # TODO: split into multiple files directories
191 return os.path.join(self.db.dir, 'files', '%s%s'%(classname, nodeid))
193 def setcontent(self, classname, nodeid, content):
194 ''' set the content file for this file
195 '''
196 open(self.filename(classname, nodeid), 'wb').write(content)
198 def getcontent(self, classname, nodeid):
199 ''' get the content file for this file
200 '''
201 return open(self.filename(classname, nodeid), 'rb').read()
203 def get(self, nodeid, propname, default=_marker):
204 ''' trap the content propname and get it from the file
205 '''
206 if propname == 'content':
207 return self.getcontent(self.classname, nodeid)
208 if default is not _marker:
209 return Class.get(self, nodeid, propname, default)
210 else:
211 return Class.get(self, nodeid, propname)
213 def getprops(self, protected=1):
214 ''' In addition to the actual properties on the node, these methods
215 provide the "content" property. If the "protected" flag is true,
216 we include protected properties - those which may not be
217 modified.
218 '''
219 d = Class.getprops(self, protected=protected).copy()
220 if protected:
221 d['content'] = hyperdb.String()
222 return d
224 class MessageSendError(RuntimeError):
225 pass
227 class DetectorError(RuntimeError):
228 pass
230 # XXX deviation from spec - was called ItemClass
231 class IssueClass(Class):
232 # configuration
233 MESSAGES_TO_AUTHOR = 'no'
234 INSTANCE_NAME = 'Roundup issue tracker'
235 EMAIL_SIGNATURE_POSITION = 'bottom'
237 # Overridden methods:
239 def __init__(self, db, classname, **properties):
240 """The newly-created class automatically includes the "messages",
241 "files", "nosy", and "superseder" properties. If the 'properties'
242 dictionary attempts to specify any of these properties or a
243 "creation" or "activity" property, a ValueError is raised."""
244 if not properties.has_key('title'):
245 properties['title'] = hyperdb.String()
246 if not properties.has_key('messages'):
247 properties['messages'] = hyperdb.Multilink("msg")
248 if not properties.has_key('files'):
249 properties['files'] = hyperdb.Multilink("file")
250 if not properties.has_key('nosy'):
251 properties['nosy'] = hyperdb.Multilink("user")
252 if not properties.has_key('superseder'):
253 properties['superseder'] = hyperdb.Multilink(classname)
254 Class.__init__(self, db, classname, **properties)
256 # New methods:
258 def addmessage(self, nodeid, summary, text):
259 """Add a message to an issue's mail spool.
261 A new "msg" node is constructed using the current date, the user that
262 owns the database connection as the author, and the specified summary
263 text.
265 The "files" and "recipients" fields are left empty.
267 The given text is saved as the body of the message and the node is
268 appended to the "messages" field of the specified issue.
269 """
271 def sendmessage(self, nodeid, msgid):
272 """Send a message to the members of an issue's nosy list.
274 The message is sent only to users on the nosy list who are not
275 already on the "recipients" list for the message.
277 These users are then added to the message's "recipients" list.
278 """
279 # figure the recipient ids
280 recipients = self.db.msg.get(msgid, 'recipients')
281 r = {}
282 for recipid in recipients:
283 r[recipid] = 1
284 rlen = len(recipients)
286 # figure the author's id, and indicate they've received the message
287 authid = self.db.msg.get(msgid, 'author')
289 # get the current nosy list, we'll need it
290 nosy = self.get(nodeid, 'nosy')
292 # ... but duplicate the message to the author as long as it's not
293 # the anonymous user
294 if (self.MESSAGES_TO_AUTHOR == 'yes' and
295 self.db.user.get(authid, 'username') != 'anonymous'):
296 if not r.has_key(authid):
297 recipients.append(authid)
298 r[authid] = 1
300 # now figure the nosy people who weren't recipients
301 for nosyid in nosy:
302 # Don't send nosy mail to the anonymous user (that user
303 # shouldn't appear in the nosy list, but just in case they
304 # do...)
305 if self.db.user.get(nosyid, 'username') == 'anonymous': continue
306 if not r.has_key(nosyid):
307 recipients.append(nosyid)
309 # no new recipients
310 if rlen == len(recipients):
311 return
313 # update the message's recipients list
314 self.db.msg.set(msgid, recipients=recipients)
316 # send an email to the people who missed out
317 sendto = [self.db.user.get(i, 'address') for i in recipients]
318 cn = self.classname
319 title = self.get(nodeid, 'title') or '%s message copy'%cn
320 # figure author information
321 authname = self.db.user.get(authid, 'realname')
322 if not authname:
323 authname = self.db.user.get(authid, 'username')
324 authaddr = self.db.user.get(authid, 'address')
325 if authaddr:
326 authaddr = ' <%s>'%authaddr
327 else:
328 authaddr = ''
330 # make the message body
331 m = ['']
333 # put in roundup's signature
334 if self.EMAIL_SIGNATURE_POSITION == 'top':
335 m.append(self.email_signature(nodeid, msgid))
337 # add author information
338 if len(self.get(nodeid,'messages')) == 1:
339 m.append("New submission from %s%s:"%(authname, authaddr))
340 else:
341 m.append("%s%s added the comment:"%(authname, authaddr))
342 m.append('')
344 # add the content
345 m.append(self.db.msg.get(msgid, 'content'))
347 # put in roundup's signature
348 if self.EMAIL_SIGNATURE_POSITION == 'bottom':
349 m.append(self.email_signature(nodeid, msgid))
351 # get the files for this message
352 files = self.db.msg.get(msgid, 'files')
354 # create the message
355 message = cStringIO.StringIO()
356 writer = MimeWriter.MimeWriter(message)
357 writer.addheader('Subject', '[%s%s] %s'%(cn, nodeid, title))
358 writer.addheader('To', ', '.join(sendto))
359 writer.addheader('From', '%s <%s>'%(self.INSTANCE_NAME,
360 self.ISSUE_TRACKER_EMAIL))
361 writer.addheader('Reply-To', '%s <%s>'%(self.INSTANCE_NAME,
362 self.ISSUE_TRACKER_EMAIL))
363 writer.addheader('MIME-Version', '1.0')
365 # attach files
366 if files:
367 part = writer.startmultipartbody('mixed')
368 part = writer.nextpart()
369 body = part.startbody('text/plain')
370 body.write('\n'.join(m))
371 for fileid in files:
372 name = self.db.file.get(fileid, 'name')
373 mime_type = self.db.file.get(fileid, 'type')
374 content = self.db.file.get(fileid, 'content')
375 part = writer.nextpart()
376 if mime_type == 'text/plain':
377 part.addheader('Content-Disposition',
378 'attachment;\n filename="%s"'%name)
379 part.addheader('Content-Transfer-Encoding', '7bit')
380 body = part.startbody('text/plain')
381 body.write(content)
382 else:
383 # some other type, so encode it
384 if not mime_type:
385 # this should have been done when the file was saved
386 mime_type = mimetypes.guess_type(name)[0]
387 if mime_type is None:
388 mime_type = 'application/octet-stream'
389 part.addheader('Content-Disposition',
390 'attachment;\n filename="%s"'%name)
391 part.addheader('Content-Transfer-Encoding', 'base64')
392 body = part.startbody(mime_type)
393 body.write(base64.encodestring(content))
394 writer.lastpart()
395 else:
396 body = writer.startbody('text/plain')
397 body.write('\n'.join(m))
399 # now try to send the message
400 try:
401 smtp = smtplib.SMTP(self.MAILHOST)
402 smtp.sendmail(self.ISSUE_TRACKER_EMAIL, sendto, message.getvalue())
403 except socket.error, value:
404 raise MessageSendError, \
405 "Couldn't send confirmation email: mailhost %s"%value
406 except smtplib.SMTPException, value:
407 raise MessageSendError, \
408 "Couldn't send confirmation email: %s"%value
410 def email_signature(self, nodeid, msgid):
411 ''' Add a signature to the e-mail with some useful information
412 '''
413 web = self.ISSUE_TRACKER_WEB + 'issue'+ nodeid
414 email = '"%s" <%s>'%(self.INSTANCE_NAME, self.ISSUE_TRACKER_EMAIL)
415 line = '_' * max(len(web), len(email))
416 return '%s\n%s\n%s\n%s'%(line, email, web, line)
418 def generateChangeNote(self, nodeid, newvalues):
419 """Generate a change note that lists property changes
420 """
421 cn = self.classname
422 cl = self.db.classes[cn]
423 changed = {}
424 props = cl.getprops(protected=0)
426 # determine what changed
427 for key in newvalues.keys():
428 if key in ['files','messages']: continue
429 new_value = newvalues[key]
430 # the old value might be non existent
431 try:
432 old_value = cl.get(nodeid, key)
433 if type(old_value) is type([]):
434 old_value.sort()
435 new_value.sort()
436 if old_value != new_value:
437 changed[key] = new_value
438 except:
439 changed[key] = new_value
441 # list the changes
442 m = ['','----------']
443 for propname, value in changed.items():
444 prop = cl.properties[propname]
445 oldvalue = cl.get(nodeid, propname, None)
446 change = '%s -> %s'%(oldvalue, value)
447 if isinstance(prop, hyperdb.Link):
448 link = self.db.classes[prop.classname]
449 key = link.labelprop(default_to_id=1)
450 if key:
451 if value:
452 value = link.get(value, key)
453 else:
454 value = ''
455 if oldvalue:
456 oldvalue = link.get(oldvalue, key)
457 else:
458 oldvalue = ''
459 change = '%s -> %s'%(oldvalue, value)
460 elif isinstance(prop, hyperdb.Multilink):
461 change = ''
462 if value is None: value = []
463 if oldvalue is None: oldvalue = []
464 l = []
465 link = self.db.classes[prop.classname]
466 key = link.labelprop(default_to_id=1)
467 # check for additions
468 for entry in value:
469 if entry in oldvalue: continue
470 if key:
471 l.append(link.get(entry, key))
472 else:
473 l.append(entry)
474 if l:
475 change = '+%s'%(', '.join(l))
476 l = []
477 # check for removals
478 for entry in oldvalue:
479 if entry in value: continue
480 if key:
481 l.append(link.get(entry, key))
482 else:
483 l.append(entry)
484 if l:
485 change += ' -%s'%(', '.join(l))
486 m.append('%s: %s'%(propname, change))
487 return '\n'.join(m)
489 #
490 # $Log: not supported by cvs2svn $
491 # Revision 1.25 2001/11/30 20:28:10 rochecompaan
492 # Property changes are now completely traceable, whether changes are
493 # made through the web or by email
494 #
495 # Revision 1.24 2001/11/30 11:29:04 rochecompaan
496 # Property changes are now listed in emails generated by Roundup
497 #
498 # Revision 1.23 2001/11/27 03:17:13 richard
499 # oops
500 #
501 # Revision 1.22 2001/11/27 03:00:50 richard
502 # couple of bugfixes from latest patch integration
503 #
504 # Revision 1.21 2001/11/26 22:55:56 richard
505 # Feature:
506 # . Added INSTANCE_NAME to configuration - used in web and email to identify
507 # the instance.
508 # . Added EMAIL_SIGNATURE_POSITION to indicate where to place the roundup
509 # signature info in e-mails.
510 # . Some more flexibility in the mail gateway and more error handling.
511 # . Login now takes you to the page you back to the were denied access to.
512 #
513 # Fixed:
514 # . Lots of bugs, thanks Roché and others on the devel mailing list!
515 #
516 # Revision 1.20 2001/11/25 10:11:14 jhermann
517 # Typo fix
518 #
519 # Revision 1.19 2001/11/22 15:46:42 jhermann
520 # Added module docstrings to all modules.
521 #
522 # Revision 1.18 2001/11/15 10:36:17 richard
523 # . incorporated patch from Roch'e Compaan implementing attachments in nosy
524 # e-mail
525 #
526 # Revision 1.17 2001/11/12 22:01:06 richard
527 # Fixed issues with nosy reaction and author copies.
528 #
529 # Revision 1.16 2001/10/30 00:54:45 richard
530 # Features:
531 # . #467129 ] Lossage when username=e-mail-address
532 # . #473123 ] Change message generation for author
533 # . MailGW now moves 'resolved' to 'chatting' on receiving e-mail for an issue.
534 #
535 # Revision 1.15 2001/10/23 01:00:18 richard
536 # Re-enabled login and registration access after lopping them off via
537 # disabling access for anonymous users.
538 # Major re-org of the htmltemplate code, cleaning it up significantly. Fixed
539 # a couple of bugs while I was there. Probably introduced a couple, but
540 # things seem to work OK at the moment.
541 #
542 # Revision 1.14 2001/10/21 07:26:35 richard
543 # feature #473127: Filenames. I modified the file.index and htmltemplate
544 # source so that the filename is used in the link and the creation
545 # information is displayed.
546 #
547 # Revision 1.13 2001/10/21 00:45:15 richard
548 # Added author identification to e-mail messages from roundup.
549 #
550 # Revision 1.12 2001/10/04 02:16:15 richard
551 # Forgot to pass the protected flag down *sigh*.
552 #
553 # Revision 1.11 2001/10/04 02:12:42 richard
554 # Added nicer command-line item adding: passing no arguments will enter an
555 # interactive more which asks for each property in turn. While I was at it, I
556 # fixed an implementation problem WRT the spec - I wasn't raising a
557 # ValueError if the key property was missing from a create(). Also added a
558 # protected=boolean argument to getprops() so we can list only the mutable
559 # properties (defaults to yes, which lists the immutables).
560 #
561 # Revision 1.10 2001/08/07 00:24:42 richard
562 # stupid typo
563 #
564 # Revision 1.9 2001/08/07 00:15:51 richard
565 # Added the copyright/license notice to (nearly) all files at request of
566 # Bizar Software.
567 #
568 # Revision 1.8 2001/08/02 06:38:17 richard
569 # Roundupdb now appends "mailing list" information to its messages which
570 # include the e-mail address and web interface address. Templates may
571 # override this in their db classes to include specific information (support
572 # instructions, etc).
573 #
574 # Revision 1.7 2001/07/30 02:38:31 richard
575 # get() now has a default arg - for migration only.
576 #
577 # Revision 1.6 2001/07/30 00:05:54 richard
578 # Fixed IssueClass so that superseders links to its classname rather than
579 # hard-coded to "issue".
580 #
581 # Revision 1.5 2001/07/29 07:01:39 richard
582 # Added vim command to all source so that we don't get no steenkin' tabs :)
583 #
584 # Revision 1.4 2001/07/29 04:05:37 richard
585 # Added the fabricated property "id".
586 #
587 # Revision 1.3 2001/07/23 07:14:41 richard
588 # Moved the database backends off into backends.
589 #
590 # Revision 1.2 2001/07/22 12:09:32 richard
591 # Final commit of Grande Splite
592 #
593 # Revision 1.1 2001/07/22 11:58:35 richard
594 # More Grande Splite
595 #
596 #
597 # vim: set filetype=python ts=4 sw=4 et si