![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/roundup/roundupdb.py b/roundup/roundupdb.py
index 9af9735dc732d9b68d6d1200e26a6438e2b70ec6..f69e1fe4d7063efe7ae166690a295600ff9f7a01 100644 (file)
--- a/roundup/roundupdb.py
+++ b/roundup/roundupdb.py
# BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
# SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
#
-# $Id: roundupdb.py,v 1.65 2002-09-10 02:37:28 richard Exp $
+# $Id: roundupdb.py,v 1.93 2003-11-06 19:01:57 jlgijsbers Exp $
__doc__ = """
Extending hyperdb with types specific to issue-tracking.
"""
+from __future__ import nested_scopes
import re, os, smtplib, socket, time, random
-import MimeWriter, cStringIO
-import base64, quopri, mimetypes
-# if available, use the 'email' module, otherwise fallback to 'rfc822'
-try :
- from email.Utils import dump_address_pair as straddr
-except ImportError :
- from rfc822 import dump_address_pair as straddr
+import cStringIO, base64, quopri, mimetypes
-import hyperdb
+from rfc2822 import encode_header
-# set to indicate to roundup not to actually _send_ email
-# this var must contain a file to write the mail to
-SENDMAILDEBUG = os.environ.get('SENDMAILDEBUG', '')
+from roundup import password, date, hyperdb
+
+# MessageSendError is imported for backwards compatibility
+from roundup.mailer import Mailer, straddr, MessageSendError
class Database:
def getuid(self):
"""Return the id of the "user" node associated with the user
that owns this connection to the hyperdatabase."""
- return self.user.lookup(self.journaltag)
+ if self.journaltag is None:
+ return None
+ elif self.journaltag == 'admin':
+ # admin user may not exist, but always has ID 1
+ return '1'
+ else:
+ return self.user.lookup(self.journaltag)
+
+ def getUserTimezone(self):
+ """Return user timezone defined in 'timezone' property of user class.
+ If no such property exists return 0
+ """
+ userid = self.getuid()
+ try:
+ timezone = int(self.user.get(userid, 'timezone'))
+ except (KeyError, ValueError, TypeError):
+ # If there is no class 'user' or current user doesn't have timezone
+ # property or that property is not numeric assume he/she lives in
+ # Greenwich :)
+ timezone = 0
+ return timezone
+
+ def confirm_registration(self, otk):
+ props = self.otks.getall(otk)
+ for propname, proptype in self.user.getprops().items():
+ value = props.get(propname, None)
+ if value is None:
+ pass
+ elif isinstance(proptype, hyperdb.Date):
+ props[propname] = date.Date(value)
+ elif isinstance(proptype, hyperdb.Interval):
+ props[propname] = date.Interval(value)
+ elif isinstance(proptype, hyperdb.Password):
+ props[propname] = password.Password()
+ props[propname].unpack(value)
+
+ # tag new user creation with 'admin'
+ self.journaltag = 'admin'
+
+ # create the new user
+ cl = self.user
+
+ props['roles'] = self.config.NEW_WEB_USER_ROLES
+ del props['__time']
+ userid = cl.create(**props)
+ # clear the props from the otk database
+ self.otks.destroy(otk)
+ self.commit()
+
+ return userid
-class MessageSendError(RuntimeError):
- pass
class DetectorError(RuntimeError):
+ """ Raised by detectors that want to indicate that something's amiss
+ """
pass
-# XXX deviation from spec - was called ItemClass
+# deviation from spec - was called IssueClass
class IssueClass:
""" This class is intended to be mixed-in with a hyperdb backend
implementation. The backend should provide a mechanism that
appended to the "messages" field of the specified issue.
"""
- def nosymessage(self, nodeid, msgid, oldvalues):
+ # XXX "bcc" is an optional extra here...
+ def nosymessage(self, nodeid, msgid, oldvalues, whichnosy='nosy',
+ from_address=None, cc=[]): #, bcc=[]):
"""Send a message to the members of an issue's nosy list.
The message is sent only to users on the nosy list who are not
already on the "recipients" list for the message.
These users are then added to the message's "recipients" list.
- """
- users = self.db.user
- messages = self.db.msg
- # figure the recipient ids
+ If 'msgid' is None, the message gets sent only to the nosy
+ list, and it's called a 'System Message'.
+ """
+ authid, recipients = None, []
+ if msgid:
+ authid = self.db.msg.get(msgid, 'author')
+ recipients = self.db.msg.get(msgid, 'recipients')
+
sendto = []
- r = {}
- recipients = messages.get(msgid, 'recipients')
- for recipid in messages.get(msgid, 'recipients'):
- r[recipid] = 1
-
- # figure the author's id, and indicate they've received the message
- authid = messages.get(msgid, 'author')
-
+ seen_message = dict([(recipient, 1) for recipient in recipients])
+
+ def add_recipient(userid):
+ # make sure they have an address
+ address = self.db.user.get(userid, 'address')
+ if address:
+ sendto.append(address)
+ recipients.append(userid)
+
+ def good_recipient(userid):
+ # Make sure we don't send mail to either the anonymous
+ # user or a user who has already seen the message.
+ return (userid and
+ self.db.user.get(userid, 'username') != 'anonymous' and
+ not seen_message.has_key(userid))
+
# possibly send the message to the author, as long as they aren't
# anonymous
- if (self.db.config.MESSAGES_TO_AUTHOR == 'yes' and
- users.get(authid, 'username') != 'anonymous'):
- sendto.append(authid)
- r[authid] = 1
-
- # now figure the nosy people who weren't recipients
- nosy = self.get(nodeid, 'nosy')
- for nosyid in nosy:
- # Don't send nosy mail to the anonymous user (that user
- # shouldn't appear in the nosy list, but just in case they
- # do...)
- if users.get(nosyid, 'username') == 'anonymous':
- continue
- # make sure they haven't seen the message already
- if not r.has_key(nosyid):
- # send it to them
- sendto.append(nosyid)
- recipients.append(nosyid)
+ if (good_recipient(authid) and
+ (self.db.config.MESSAGES_TO_AUTHOR == 'yes' or
+ (self.db.config.MESSAGES_TO_AUTHOR == 'new' and not oldvalues))):
+ add_recipient(authid)
+
+ if authid:
+ seen_message[authid] = 1
+
+ # now deal with the nosy and cc people who weren't recipients.
+ for userid in cc + self.get(nodeid, whichnosy):
+ if good_recipient(userid):
+ add_recipient(userid)
- # generate a change note
if oldvalues:
note = self.generateChangeNote(nodeid, oldvalues)
else:
note = self.generateCreateNote(nodeid)
- # we have new recipients
+ # If we have new recipients, update the message's recipients
+ # and send the mail.
if sendto:
- # map userids to addresses
- sendto = [users.get(i, 'address') for i in sendto]
-
- # update the message's recipients list
- messages.set(msgid, recipients=recipients)
-
- # send the message
- self.send_message(nodeid, msgid, note, sendto)
+ if msgid:
+ self.db.msg.set(msgid, recipients=recipients)
+ self.send_message(nodeid, msgid, note, sendto, from_address)
- # XXX backwards compatibility - don't remove
+ # backwards compatibility - don't remove
sendmessage = nosymessage
- def send_message(self, nodeid, msgid, note, sendto):
+ def send_message(self, nodeid, msgid, note, sendto, from_address=None):
'''Actually send the nominated message from this node to the sendto
recipients, with the note appended.
'''
messages = self.db.msg
files = self.db.file
- # determine the messageid and inreplyto of the message
- inreplyto = messages.get(msgid, 'inreplyto')
- messageid = messages.get(msgid, 'messageid')
+ inreplyto, messageid = None, None
+ if msgid:
+ inreplyto = messages.get(msgid, 'inreplyto')
+ messageid = messages.get(msgid, 'messageid')
- # make up a messageid if there isn't one (web edit)
- if not messageid:
- # this is an old message that didn't get a messageid, so
- # create one
- messageid = "<%s.%s.%s%s@%s>"%(time.time(), random.random(),
- self.classname, nodeid, self.db.config.MAIL_DOMAIN)
- messages.set(msgid, messageid=messageid)
+ # make up a messageid if there isn't one (web edit)
+ if not messageid:
+ # this is an old message that didn't get a messageid, so
+ # create one
+ messageid = "<%s.%s.%s%s@%s>"%(time.time(), random.random(),
+ self.classname, nodeid,
+ self.db.config.MAIL_DOMAIN)
+ messages.set(msgid, messageid=messageid)
# send an email to the people who missed out
cn = self.classname
title = self.get(nodeid, 'title') or '%s message copy'%cn
- # figure author information
- authid = messages.get(msgid, 'author')
- authname = users.get(authid, 'realname')
- if not authname:
- authname = users.get(authid, 'username')
- authaddr = users.get(authid, 'address')
- if authaddr:
- authaddr = " <%s>" % straddr( ('',authaddr) )
- else:
- authaddr = ''
+
+ authid, authname, authaddr = None, '', ''
+ if msgid:
+ authid = messages.get(msgid, 'author')
+ authname = users.get(authid, 'realname')
+ if not authname:
+ authname = users.get(authid, 'username')
+ authaddr = users.get(authid, 'address')
+ if authaddr:
+ authaddr = " <%s>" % straddr( ('',authaddr) )
+ else:
+ authaddr = ''
# make the message body
m = ['']
m.append(self.email_signature(nodeid, msgid))
# add author information
- if len(self.get(nodeid,'messages')) == 1:
- m.append("New submission from %s%s:"%(authname, authaddr))
+ if authid:
+ if len(self.get(nodeid,'messages')) == 1:
+ m.append("New submission from %s%s:"%(authname, authaddr))
+ else:
+ m.append("%s%s added the comment:"%(authname, authaddr))
else:
- m.append("%s%s added the comment:"%(authname, authaddr))
+ m.append("System message:")
m.append('')
# add the content
- m.append(messages.get(msgid, 'content'))
+ if msgid:
+ m.append(messages.get(msgid, 'content'))
# add the change note
if note:
content_encoded = content_encoded.getvalue()
# get the files for this message
- message_files = messages.get(msgid, 'files')
+ message_files = msgid and messages.get(msgid, 'files') or None
# make sure the To line is always the same (for testing mostly)
sendto.sort()
+ # make sure we have a from address
+ if from_address is None:
+ from_address = self.db.config.TRACKER_EMAIL
+
+ # additional bit for after the From: "name"
+ from_tag = getattr(self.db.config, 'EMAIL_FROM_TAG', '')
+ if from_tag:
+ from_tag = ' ' + from_tag
+
+ subject = '[%s%s] %s' % (cn, nodeid, encode_header(title))
+ author = straddr((encode_header(authname) + from_tag, from_address))
+
# create the message
- message = cStringIO.StringIO()
- writer = MimeWriter.MimeWriter(message)
- writer.addheader('Subject', '[%s%s] %s'%(cn, nodeid, title))
- writer.addheader('To', ', '.join(sendto))
- writer.addheader('From', straddr(
- (authname, self.db.config.ISSUE_TRACKER_EMAIL) ) )
- writer.addheader('Reply-To', straddr(
- (self.db.config.INSTANCE_NAME,
- self.db.config.ISSUE_TRACKER_EMAIL) ) )
- writer.addheader('MIME-Version', '1.0')
+ mailer = Mailer(self.db.config)
+ message, writer = mailer.get_standard_message(sendto, subject, author)
+
+ tracker_name = encode_header(self.db.config.TRACKER_NAME)
+ writer.addheader('Reply-To', straddr((tracker_name, from_address)))
if messageid:
writer.addheader('Message-Id', messageid)
if inreplyto:
writer.addheader('In-Reply-To', inreplyto)
- # add a uniquely Roundup header to help filtering
- writer.addheader('X-Roundup-Name', self.db.config.INSTANCE_NAME)
-
# attach files
if message_files:
part = writer.startmultipartbody('mixed')
part = writer.nextpart()
part.addheader('Content-Transfer-Encoding', 'quoted-printable')
- body = part.startbody('text/plain')
+ body = part.startbody('text/plain; charset=utf-8')
body.write(content_encoded)
for fileid in message_files:
name = files.get(fileid, 'name')
writer.lastpart()
else:
writer.addheader('Content-Transfer-Encoding', 'quoted-printable')
- body = writer.startbody('text/plain')
+ body = writer.startbody('text/plain; charset=utf-8')
body.write(content_encoded)
- # now try to send the message
- if SENDMAILDEBUG:
- open(SENDMAILDEBUG, 'w').write('FROM: %s\nTO: %s\n%s\n'%(
- self.db.config.ADMIN_EMAIL,
- ', '.join(sendto),message.getvalue()))
- else:
- try:
- # send the message as admin so bounces are sent there
- # instead of to roundup
- smtp = smtplib.SMTP(self.db.config.MAILHOST)
- smtp.sendmail(self.db.config.ADMIN_EMAIL, sendto,
- message.getvalue())
- except socket.error, value:
- raise MessageSendError, \
- "Couldn't send confirmation email: mailhost %s"%value
- except smtplib.SMTPException, value:
- raise MessageSendError, \
- "Couldn't send confirmation email: %s"%value
+ mailer.smtp_send(sendto, message)
def email_signature(self, nodeid, msgid):
''' Add a signature to the e-mail with some useful information
'''
-
# simplistic check to see if the url is valid,
# then append a trailing slash if it is missing
- base = self.db.config.ISSUE_TRACKER_WEB
- if not isinstance(base , type('')) or not base.startswith('http://'):
- base = "Configuration Error: ISSUE_TRACKER_WEB isn't a " \
+ base = self.db.config.TRACKER_WEB
+ if (not isinstance(base , type('')) or
+ not (base.startswith('http://') or base.startswith('https://'))):
+ base = "Configuration Error: TRACKER_WEB isn't a " \
"fully-qualified URL"
elif base[-1] != '/' :
base += '/'
- web = base + 'issue'+ nodeid
+ web = base + self.classname + nodeid
# ensure the email address is properly quoted
- email = straddr((self.db.config.INSTANCE_NAME,
- self.db.config.ISSUE_TRACKER_EMAIL))
+ email = straddr((self.db.config.TRACKER_NAME,
+ self.db.config.TRACKER_EMAIL))
- line = '_' * max(len(web), len(email))
- return '%s\n%s\n%s\n%s'%(line, email, web, line)
+ line = '_' * max(len(web)+2, len(email))
+ return '%s\n%s\n<%s>\n%s'%(line, email, web, line)
def generateCreateNote(self, nodeid):
# determine what changed
for key in oldvalues.keys():
- if key in ['files','messages']: continue
- new_value = cl.get(nodeid, key)
+ if key in ['files','messages']:
+ continue
+ if key in ('activity', 'creator', 'creation'):
+ continue
+ # not all keys from oldvalues might be available in database
+ # this happens when property was deleted
+ try:
+ new_value = cl.get(nodeid, key)
+ except KeyError:
+ continue
# the old value might be non existent
+ # this happens when property was added
try:
old_value = oldvalues[key]
if type(new_value) is type([]):