roundup/roundupdb.py

   1 #
   2 # Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/)
   3 # This module is free software, and you may redistribute it and/or modify
   4 # under the same terms as Python, so long as this copyright message and
   5 # disclaimer are retained in their original form.
   6 #
   7 # IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR
   8 # DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING
   9 # OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE
  10 # POSSIBILITY OF SUCH DAMAGE.
  11 #
  12 # BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
  13 # BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  14 # FOR A PARTICULAR PURPOSE.  THE CODE PROVIDED HEREUNDER IS ON AN "AS IS"
  15 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
  16 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  17 #
  18 # $Id: roundupdb.py,v 1.24 2001-11-30 11:29:04 rochecompaan Exp $
  19
  20 __doc__ = """
  21 Extending hyperdb with types specific to issue-tracking.
  22 """
  23
  24 import re, os, smtplib, socket
  25 import mimetools, MimeWriter, cStringIO
  26 import base64, mimetypes
  27
  28 import hyperdb, date
  29
  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)
  39
  40
  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)
  46
  47     def uidFromAddress(self, address, create=1):
  48         ''' address is from the rfc822 module, and therefore is (name, addr)
  49
  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)
  69
  70         # couldn't match address or username, so create a new user
  71         return self.user.create(username=address, address=address,
  72             realname=realname)
  73
  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': []}
  85
  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
  98
  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)
 111
 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)
 121
 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)
 151
 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
 164
 165     #
 166     # Detector interface
 167     #
 168     def audit(self, event, detector):
 169         """Register a detector
 170         """
 171         self.auditors[event].append(detector)
 172
 173     def react(self, event, detector):
 174         """Register a detector
 175         """
 176         self.reactors[event].append(detector)
 177
 178
 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
 188
 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))
 192
 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)
 197
 198     def getcontent(self, classname, nodeid):
 199         ''' get the content file for this file
 200         '''
 201         return open(self.filename(classname, nodeid), 'rb').read()
 202
 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)
 212
 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
 223
 224 class MessageSendError(RuntimeError):
 225     pass
 226
 227 class DetectorError(RuntimeError):
 228     pass
 229
 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'
 236
 237     # Overridden methods:
 238
 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)
 255
 256     # New methods:
 257
 258     def addmessage(self, nodeid, summary, text):
 259         """Add a message to an issue's mail spool.
 260
 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.
 264
 265         The "files" and "recipients" fields are left empty.
 266
 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         """
 270
 271     def sendmessage(self, nodeid, msgid, oldvalues):
 272         """Send a message to the members of an issue's nosy list.
 273
 274         The message is sent only to users on the nosy list who are not
 275         already on the "recipients" list for the message.
 276
 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)
 285
 286         # figure the author's id, and indicate they've received the message
 287         authid = self.db.msg.get(msgid, 'author')
 288
 289         # get the current nosy list, we'll need it
 290         nosy = self.get(nodeid, 'nosy')
 291
 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
 299
 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)
 308
 309         # no new recipients
 310         if rlen == len(recipients):
 311             return
 312
 313         # update the message's recipients list
 314         self.db.msg.set(msgid, recipients=recipients)
 315
 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 = ''
 329
 330         # get the change note
 331         if oldvalues:
 332             change_note = self.generateChangeNote(nodeid, oldvalues)
 333         else:
 334             change_note = ''
 335
 336         # make the message body
 337         m = ['']
 338
 339         # put in roundup's signature
 340         if self.EMAIL_SIGNATURE_POSITION == 'top':
 341             m.append(self.email_signature(nodeid, msgid, change_note))
 342
 343         # add author information
 344         if oldvalues:
 345             m.append("%s%s added the comment:"%(authname, authaddr))
 346         else:
 347             m.append("New submission from %s%s:"%(authname, authaddr))
 348         m.append('')
 349
 350         # add the content
 351         m.append(self.db.msg.get(msgid, 'content'))
 352
 353         # put in roundup's signature
 354         if self.EMAIL_SIGNATURE_POSITION == 'bottom':
 355             m.append(self.email_signature(nodeid, msgid, change_note))
 356
 357         # get the files for this message
 358         files = self.db.msg.get(msgid, 'files')
 359
 360         # create the message
 361         message = cStringIO.StringIO()
 362         writer = MimeWriter.MimeWriter(message)
 363         writer.addheader('Subject', '[%s%s] %s'%(cn, nodeid, title))
 364         writer.addheader('To', ', '.join(sendto))
 365         writer.addheader('From', '%s <%s>'%(self.INSTANCE_NAME,
 366             self.ISSUE_TRACKER_EMAIL))
 367         writer.addheader('Reply-To:', '%s <%s>'%(self.INSTANCE_NAME,
 368             self.ISSUE_TRACKER_EMAIL))
 369         writer.addheader('MIME-Version', '1.0')
 370
 371         # attach files
 372         if files:
 373             part = writer.startmultipartbody('mixed')
 374             part = writer.nextpart()
 375             body = part.startbody('text/plain')
 376             body.write('\n'.join(m))
 377             for fileid in files:
 378                 name = self.db.file.get(fileid, 'name')
 379                 mime_type = self.db.file.get(fileid, 'type')
 380                 content = self.db.file.get(fileid, 'content')
 381                 part = writer.nextpart()
 382                 if mime_type == 'text/plain':
 383                     part.addheader('Content-Disposition',
 384                         'attachment;\n filename="%s"'%name)
 385                     part.addheader('Content-Transfer-Encoding', '7bit')
 386                     body = part.startbody('text/plain')
 387                     body.write(content)
 388                 else:
 389                     # some other type, so encode it
 390                     if not mime_type:
 391                         # this should have been done when the file was saved
 392                         mime_type = mimetypes.guess_type(name)[0]
 393                     if mime_type is None:
 394                         mime_type = 'application/octet-stream'
 395                     part.addheader('Content-Disposition',
 396                         'attachment;\n filename="%s"'%name)
 397                     part.addheader('Content-Transfer-Encoding', 'base64')
 398                     body = part.startbody(mime_type)
 399                     body.write(base64.encodestring(content))
 400             writer.lastpart()
 401         else:
 402             body = writer.startbody('text/plain')
 403             body.write('\n'.join(m))
 404
 405         # now try to send the message
 406         try:
 407             smtp = smtplib.SMTP(self.MAILHOST)
 408             smtp.sendmail(self.ISSUE_TRACKER_EMAIL, sendto, message.getvalue())
 409         except socket.error, value:
 410             raise MessageSendError, \
 411                 "Couldn't send confirmation email: mailhost %s"%value
 412         except smtplib.SMTPException, value:
 413             raise MessageSendError, \
 414                 "Couldn't send confirmation email: %s"%value
 415
 416     def email_signature(self, nodeid, msgid, change_note):
 417         ''' Add a signature to the e-mail with some useful information
 418         '''
 419         web = self.ISSUE_TRACKER_WEB + 'issue'+ nodeid
 420         email = '"%s" <%s>'%(self.INSTANCE_NAME, self.ISSUE_TRACKER_EMAIL)
 421         line = '_' * max(len(web), len(email))
 422         return '%s\n%s\n%s\n%s\n%s'%(line, email, web, change_note, line)
 423
 424     def generateChangeNote(self, nodeid, oldvalues):
 425         """Generate a change note that lists property changes
 426         """
 427         cn = self.classname
 428         cl = self.db.classes[cn]
 429         changed = {}
 430         props = cl.getprops(protected=0)
 431
 432         # determine what changed
 433         for key in props.keys():
 434             if key in ['files','messages']: continue
 435             new_value = cl.get(nodeid, key)
 436             # the old value might be non existent
 437             try:
 438                 old_value = oldvalues[key]
 439                 if type(old_value) is type([]):
 440                     old_value.sort()
 441                     new_value.sort()
 442                 if old_value != new_value:
 443                     changed[key] = old_value
 444             except:
 445                 old_value = None
 446                 changed[key] = old_value
 447
 448         # list the changes
 449         m = []
 450         for propname, oldvalue in changed.items():
 451             prop = cl.properties[propname]
 452             value = cl.get(nodeid, propname, None)
 453             change = '%s -> %s'%(oldvalue, value)
 454             if isinstance(prop, hyperdb.Link):
 455                 link = self.db.classes[prop.classname]
 456                 key = link.labelprop(default_to_id=1)
 457                 if key:
 458                     if value:
 459                         value = link.get(value, key)
 460                     else:
 461                         value = ''
 462                     if oldvalue:
 463                         oldvalue = link.get(oldvalue, key)
 464                     else:
 465                         oldvalue = ''
 466                 change = '%s -> %s'%(oldvalue, value)
 467             elif isinstance(prop, hyperdb.Multilink):
 468                 if value is None: value = []
 469                 l = []
 470                 link = self.db.classes[prop.classname]
 471                 key = link.labelprop(default_to_id=1)
 472                 if oldvalue is None: oldvalue = []
 473                 # check for additions
 474                 for entry in value:
 475                     if entry in oldvalue: continue
 476                     if key:
 477                         l.append(link.get(entry, key))
 478                     else:
 479                         l.append(entry)
 480                 if l:
 481                     change = '+%s'%(', '.join(l))
 482                     l = []
 483                 # check for removals
 484                 for entry in oldvalue:
 485                     if entry in value: continue
 486                     if key:
 487                         l.append(link.get(entry, key))
 488                     else:
 489                         l.append(entry)
 490                 if l:
 491                     change = change + ' -%s'%(', '.join(l))
 492             m.append('%s: %s'%(propname, change))
 493         return '\n'.join(m)
 494
 495 #
 496 # $Log: not supported by cvs2svn $
 497 # Revision 1.23  2001/11/27 03:17:13  richard
 498 # oops
 499 #
 500 # Revision 1.22  2001/11/27 03:00:50  richard
 501 # couple of bugfixes from latest patch integration
 502 #
 503 # Revision 1.21  2001/11/26 22:55:56  richard
 504 # Feature:
 505 #  . Added INSTANCE_NAME to configuration - used in web and email to identify
 506 #    the instance.
 507 #  . Added EMAIL_SIGNATURE_POSITION to indicate where to place the roundup
 508 #    signature info in e-mails.
 509 #  . Some more flexibility in the mail gateway and more error handling.
 510 #  . Login now takes you to the page you back to the were denied access to.
 511 #
 512 # Fixed:
 513 #  . Lots of bugs, thanks Roché and others on the devel mailing list!
 514 #
 515 # Revision 1.20  2001/11/25 10:11:14  jhermann
 516 # Typo fix
 517 #
 518 # Revision 1.19  2001/11/22 15:46:42  jhermann
 519 # Added module docstrings to all modules.
 520 #
 521 # Revision 1.18  2001/11/15 10:36:17  richard
 522 #  . incorporated patch from Roch'e Compaan implementing attachments in nosy
 523 #     e-mail
 524 #
 525 # Revision 1.17  2001/11/12 22:01:06  richard
 526 # Fixed issues with nosy reaction and author copies.
 527 #
 528 # Revision 1.16  2001/10/30 00:54:45  richard
 529 # Features:
 530 #  . #467129 ] Lossage when username=e-mail-address
 531 #  . #473123 ] Change message generation for author
 532 #  . MailGW now moves 'resolved' to 'chatting' on receiving e-mail for an issue.
 533 #
 534 # Revision 1.15  2001/10/23 01:00:18  richard
 535 # Re-enabled login and registration access after lopping them off via
 536 # disabling access for anonymous users.
 537 # Major re-org of the htmltemplate code, cleaning it up significantly. Fixed
 538 # a couple of bugs while I was there. Probably introduced a couple, but
 539 # things seem to work OK at the moment.
 540 #
 541 # Revision 1.14  2001/10/21 07:26:35  richard
 542 # feature #473127: Filenames. I modified the file.index and htmltemplate
 543 #  source so that the filename is used in the link and the creation
 544 #  information is displayed.
 545 #
 546 # Revision 1.13  2001/10/21 00:45:15  richard
 547 # Added author identification to e-mail messages from roundup.
 548 #
 549 # Revision 1.12  2001/10/04 02:16:15  richard
 550 # Forgot to pass the protected flag down *sigh*.
 551 #
 552 # Revision 1.11  2001/10/04 02:12:42  richard
 553 # Added nicer command-line item adding: passing no arguments will enter an
 554 # interactive more which asks for each property in turn. While I was at it, I
 555 # fixed an implementation problem WRT the spec - I wasn't raising a
 556 # ValueError if the key property was missing from a create(). Also added a
 557 # protected=boolean argument to getprops() so we can list only the mutable
 558 # properties (defaults to yes, which lists the immutables).
 559 #
 560 # Revision 1.10  2001/08/07 00:24:42  richard
 561 # stupid typo
 562 #
 563 # Revision 1.9  2001/08/07 00:15:51  richard
 564 # Added the copyright/license notice to (nearly) all files at request of
 565 # Bizar Software.
 566 #
 567 # Revision 1.8  2001/08/02 06:38:17  richard
 568 # Roundupdb now appends "mailing list" information to its messages which
 569 # include the e-mail address and web interface address. Templates may
 570 # override this in their db classes to include specific information (support
 571 # instructions, etc).
 572 #
 573 # Revision 1.7  2001/07/30 02:38:31  richard
 574 # get() now has a default arg - for migration only.
 575 #
 576 # Revision 1.6  2001/07/30 00:05:54  richard
 577 # Fixed IssueClass so that superseders links to its classname rather than
 578 # hard-coded to "issue".
 579 #
 580 # Revision 1.5  2001/07/29 07:01:39  richard
 581 # Added vim command to all source so that we don't get no steenkin' tabs :)
 582 #
 583 # Revision 1.4  2001/07/29 04:05:37  richard
 584 # Added the fabricated property "id".
 585 #
 586 # Revision 1.3  2001/07/23 07:14:41  richard
 587 # Moved the database backends off into backends.
 588 #
 589 # Revision 1.2  2001/07/22 12:09:32  richard
 590 # Final commit of Grande Splite
 591 #
 592 # Revision 1.1  2001/07/22 11:58:35  richard
 593 # More Grande Splite
 594 #
 595 #
 596 # vim: set filetype=python ts=4 sw=4 et si