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.25 2001-11-30 20:28:10 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         # get the change note
 314         if oldvalues:
 315             change_note = self.generateChangeNote(nodeid, oldvalues)
 316         else:
 317             change_note = ''
 318
 319         # add the change note to the message content
 320         content = self.db.msg.get(msgid, 'content')
 321         content += change_note
 322
 323         # update the message's recipients list
 324         self.db.msg.set(msgid, recipients=recipients)
 325         self.db.msg.setcontent('msg', msgid, content)
 326
 327         # send an email to the people who missed out
 328         sendto = [self.db.user.get(i, 'address') for i in recipients]
 329         cn = self.classname
 330         title = self.get(nodeid, 'title') or '%s message copy'%cn
 331         # figure author information
 332         authname = self.db.user.get(authid, 'realname')
 333         if not authname:
 334             authname = self.db.user.get(authid, 'username')
 335         authaddr = self.db.user.get(authid, 'address')
 336         if authaddr:
 337             authaddr = ' <%s>'%authaddr
 338         else:
 339             authaddr = ''
 340
 341         # make the message body
 342         m = ['']
 343
 344         # put in roundup's signature
 345         if self.EMAIL_SIGNATURE_POSITION == 'top':
 346             m.append(self.email_signature(nodeid, msgid))
 347
 348         # add author information
 349         if oldvalues:
 350             m.append("%s%s added the comment:"%(authname, authaddr))
 351         else:
 352             m.append("New submission from %s%s:"%(authname, authaddr))
 353         m.append('')
 354
 355         # add the content
 356         m.append(content)
 357
 358         # put in roundup's signature
 359         if self.EMAIL_SIGNATURE_POSITION == 'bottom':
 360             m.append(self.email_signature(nodeid, msgid))
 361
 362         # get the files for this message
 363         files = self.db.msg.get(msgid, 'files')
 364
 365         # create the message
 366         message = cStringIO.StringIO()
 367         writer = MimeWriter.MimeWriter(message)
 368         writer.addheader('Subject', '[%s%s] %s'%(cn, nodeid, title))
 369         writer.addheader('To', ', '.join(sendto))
 370         writer.addheader('From', '%s <%s>'%(self.INSTANCE_NAME,
 371             self.ISSUE_TRACKER_EMAIL))
 372         writer.addheader('Reply-To', '%s <%s>'%(self.INSTANCE_NAME,
 373             self.ISSUE_TRACKER_EMAIL))
 374         writer.addheader('MIME-Version', '1.0')
 375
 376         # attach files
 377         if files:
 378             part = writer.startmultipartbody('mixed')
 379             part = writer.nextpart()
 380             body = part.startbody('text/plain')
 381             body.write('\n'.join(m))
 382             for fileid in files:
 383                 name = self.db.file.get(fileid, 'name')
 384                 mime_type = self.db.file.get(fileid, 'type')
 385                 content = self.db.file.get(fileid, 'content')
 386                 part = writer.nextpart()
 387                 if mime_type == 'text/plain':
 388                     part.addheader('Content-Disposition',
 389                         'attachment;\n filename="%s"'%name)
 390                     part.addheader('Content-Transfer-Encoding', '7bit')
 391                     body = part.startbody('text/plain')
 392                     body.write(content)
 393                 else:
 394                     # some other type, so encode it
 395                     if not mime_type:
 396                         # this should have been done when the file was saved
 397                         mime_type = mimetypes.guess_type(name)[0]
 398                     if mime_type is None:
 399                         mime_type = 'application/octet-stream'
 400                     part.addheader('Content-Disposition',
 401                         'attachment;\n filename="%s"'%name)
 402                     part.addheader('Content-Transfer-Encoding', 'base64')
 403                     body = part.startbody(mime_type)
 404                     body.write(base64.encodestring(content))
 405             writer.lastpart()
 406         else:
 407             body = writer.startbody('text/plain')
 408             body.write('\n'.join(m))
 409
 410         # now try to send the message
 411         try:
 412             smtp = smtplib.SMTP(self.MAILHOST)
 413             smtp.sendmail(self.ISSUE_TRACKER_EMAIL, sendto, message.getvalue())
 414         except socket.error, value:
 415             raise MessageSendError, \
 416                 "Couldn't send confirmation email: mailhost %s"%value
 417         except smtplib.SMTPException, value:
 418             raise MessageSendError, \
 419                 "Couldn't send confirmation email: %s"%value
 420
 421     def email_signature(self, nodeid, msgid):
 422         ''' Add a signature to the e-mail with some useful information
 423         '''
 424         web = self.ISSUE_TRACKER_WEB + 'issue'+ nodeid
 425         email = '"%s" <%s>'%(self.INSTANCE_NAME, self.ISSUE_TRACKER_EMAIL)
 426         line = '_' * max(len(web), len(email))
 427         return '%s\n%s\n%s\n%s'%(line, email, web, line)
 428
 429     def generateChangeNote(self, nodeid, oldvalues):
 430         """Generate a change note that lists property changes
 431         """
 432         cn = self.classname
 433         cl = self.db.classes[cn]
 434         changed = {}
 435         props = cl.getprops(protected=0)
 436
 437         # determine what changed
 438         for key in props.keys():
 439             if key in ['files','messages']: continue
 440             new_value = cl.get(nodeid, key)
 441             # the old value might be non existent
 442             try:
 443                 old_value = oldvalues[key]
 444                 if type(old_value) is type([]):
 445                     old_value.sort()
 446                     new_value.sort()
 447                 if old_value != new_value:
 448                     changed[key] = old_value
 449             except:
 450                 old_value = None
 451                 changed[key] = old_value
 452
 453         # list the changes
 454         m = ['','----------']
 455         for propname, oldvalue in changed.items():
 456             prop = cl.properties[propname]
 457             value = cl.get(nodeid, propname, None)
 458             change = '%s -> %s'%(oldvalue, value)
 459             if isinstance(prop, hyperdb.Link):
 460                 link = self.db.classes[prop.classname]
 461                 key = link.labelprop(default_to_id=1)
 462                 if key:
 463                     if value:
 464                         value = link.get(value, key)
 465                     else:
 466                         value = ''
 467                     if oldvalue:
 468                         oldvalue = link.get(oldvalue, key)
 469                     else:
 470                         oldvalue = ''
 471                 change = '%s -> %s'%(oldvalue, value)
 472             elif isinstance(prop, hyperdb.Multilink):
 473                 change = ''
 474                 if value is None: value = []
 475                 l = []
 476                 link = self.db.classes[prop.classname]
 477                 key = link.labelprop(default_to_id=1)
 478                 if oldvalue is None: oldvalue = []
 479                 # check for additions
 480                 for entry in value:
 481                     if entry in oldvalue: continue
 482                     if key:
 483                         l.append(link.get(entry, key))
 484                     else:
 485                         l.append(entry)
 486                 if l:
 487                     change = '+%s'%(', '.join(l))
 488                     l = []
 489                 # check for removals
 490                 for entry in oldvalue:
 491                     if entry in value: continue
 492                     if key:
 493                         l.append(link.get(entry, key))
 494                     else:
 495                         l.append(entry)
 496                 if l:
 497                     change += ' -%s'%(', '.join(l))
 498             m.append('%s: %s'%(propname, change))
 499         return '\n'.join(m)
 500
 501 #
 502 # $Log: not supported by cvs2svn $
 503 # Revision 1.24  2001/11/30 11:29:04  rochecompaan
 504 # Property changes are now listed in emails generated by Roundup
 505 #
 506 # Revision 1.23  2001/11/27 03:17:13  richard
 507 # oops
 508 #
 509 # Revision 1.22  2001/11/27 03:00:50  richard
 510 # couple of bugfixes from latest patch integration
 511 #
 512 # Revision 1.21  2001/11/26 22:55:56  richard
 513 # Feature:
 514 #  . Added INSTANCE_NAME to configuration - used in web and email to identify
 515 #    the instance.
 516 #  . Added EMAIL_SIGNATURE_POSITION to indicate where to place the roundup
 517 #    signature info in e-mails.
 518 #  . Some more flexibility in the mail gateway and more error handling.
 519 #  . Login now takes you to the page you back to the were denied access to.
 520 #
 521 # Fixed:
 522 #  . Lots of bugs, thanks Roché and others on the devel mailing list!
 523 #
 524 # Revision 1.20  2001/11/25 10:11:14  jhermann
 525 # Typo fix
 526 #
 527 # Revision 1.19  2001/11/22 15:46:42  jhermann
 528 # Added module docstrings to all modules.
 529 #
 530 # Revision 1.18  2001/11/15 10:36:17  richard
 531 #  . incorporated patch from Roch'e Compaan implementing attachments in nosy
 532 #     e-mail
 533 #
 534 # Revision 1.17  2001/11/12 22:01:06  richard
 535 # Fixed issues with nosy reaction and author copies.
 536 #
 537 # Revision 1.16  2001/10/30 00:54:45  richard
 538 # Features:
 539 #  . #467129 ] Lossage when username=e-mail-address
 540 #  . #473123 ] Change message generation for author
 541 #  . MailGW now moves 'resolved' to 'chatting' on receiving e-mail for an issue.
 542 #
 543 # Revision 1.15  2001/10/23 01:00:18  richard
 544 # Re-enabled login and registration access after lopping them off via
 545 # disabling access for anonymous users.
 546 # Major re-org of the htmltemplate code, cleaning it up significantly. Fixed
 547 # a couple of bugs while I was there. Probably introduced a couple, but
 548 # things seem to work OK at the moment.
 549 #
 550 # Revision 1.14  2001/10/21 07:26:35  richard
 551 # feature #473127: Filenames. I modified the file.index and htmltemplate
 552 #  source so that the filename is used in the link and the creation
 553 #  information is displayed.
 554 #
 555 # Revision 1.13  2001/10/21 00:45:15  richard
 556 # Added author identification to e-mail messages from roundup.
 557 #
 558 # Revision 1.12  2001/10/04 02:16:15  richard
 559 # Forgot to pass the protected flag down *sigh*.
 560 #
 561 # Revision 1.11  2001/10/04 02:12:42  richard
 562 # Added nicer command-line item adding: passing no arguments will enter an
 563 # interactive more which asks for each property in turn. While I was at it, I
 564 # fixed an implementation problem WRT the spec - I wasn't raising a
 565 # ValueError if the key property was missing from a create(). Also added a
 566 # protected=boolean argument to getprops() so we can list only the mutable
 567 # properties (defaults to yes, which lists the immutables).
 568 #
 569 # Revision 1.10  2001/08/07 00:24:42  richard
 570 # stupid typo
 571 #
 572 # Revision 1.9  2001/08/07 00:15:51  richard
 573 # Added the copyright/license notice to (nearly) all files at request of
 574 # Bizar Software.
 575 #
 576 # Revision 1.8  2001/08/02 06:38:17  richard
 577 # Roundupdb now appends "mailing list" information to its messages which
 578 # include the e-mail address and web interface address. Templates may
 579 # override this in their db classes to include specific information (support
 580 # instructions, etc).
 581 #
 582 # Revision 1.7  2001/07/30 02:38:31  richard
 583 # get() now has a default arg - for migration only.
 584 #
 585 # Revision 1.6  2001/07/30 00:05:54  richard
 586 # Fixed IssueClass so that superseders links to its classname rather than
 587 # hard-coded to "issue".
 588 #
 589 # Revision 1.5  2001/07/29 07:01:39  richard
 590 # Added vim command to all source so that we don't get no steenkin' tabs :)
 591 #
 592 # Revision 1.4  2001/07/29 04:05:37  richard
 593 # Added the fabricated property "id".
 594 #
 595 # Revision 1.3  2001/07/23 07:14:41  richard
 596 # Moved the database backends off into backends.
 597 #
 598 # Revision 1.2  2001/07/22 12:09:32  richard
 599 # Final commit of Grande Splite
 600 #
 601 # Revision 1.1  2001/07/22 11:58:35  richard
 602 # More Grande Splite
 603 #
 604 #
 605 # vim: set filetype=python ts=4 sw=4 et si