![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/roundup/roundupdb.py b/roundup/roundupdb.py
index 1d15ab4f6b13bcca5aff159f24bacdf06a5b0c7e..ddcf0c37ccaa092ee7b64156a10165036808f7bd 100644 (file)
--- a/roundup/roundupdb.py
+++ b/roundup/roundupdb.py
+from __future__ import nested_scopes
#
# Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/)
# This module is free software, and you may redistribute it and/or modify
# FOR A PARTICULAR PURPOSE. THE CODE PROVIDED HEREUNDER IS ON AN "AS IS"
# BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
# SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
-#
-# $Id: roundupdb.py,v 1.27 2001-12-10 21:02:53 richard Exp $
+#
-__doc__ = """
-Extending hyperdb with types specific to issue-tracking.
+"""Extending hyperdb with types specific to issue-tracking.
"""
+__docformat__ = 'restructuredtext'
-import re, os, smtplib, socket
-import mimetools, MimeWriter, cStringIO
-import base64, mimetypes
+import re, os, smtplib, socket, time, random
+import cStringIO, base64, mimetypes
+import os.path
+import logging
+from email import Encoders
+from email.Utils import formataddr
+from email.Header import Header
+from email.MIMEText import MIMEText
+from email.MIMEBase import MIMEBase
+from email.MIMEMultipart import MIMEMultipart
-import hyperdb, date
+from anypy.email_ import FeedParser
-class DesignatorError(ValueError):
- pass
-def splitDesignator(designator, dre=re.compile(r'([^\d]+)(\d+)')):
- ''' Take a foo123 and return ('foo', 123)
- '''
- m = dre.match(designator)
- if m is None:
- raise DesignatorError, '"%s" not a node designator'%designator
- return m.group(1), m.group(2)
+from roundup import password, date, hyperdb
+from roundup.i18n import _
+from roundup.hyperdb import iter_roles
+
+from roundup.mailer import Mailer, MessageSendError, encode_quopri, \
+ nice_sender_header
+
+try:
+ import pyme, pyme.core
+except ImportError:
+ pyme = None
class Database:
+
+ # remember the journal uid for the current journaltag so that:
+ # a. we don't have to look it up every time we need it, and
+ # b. if the journaltag disappears during a transaction, we don't barf
+ # (eg. the current user edits their username)
+ journal_uid = None
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)
-
- def uidFromAddress(self, address, create=1):
- ''' address is from the rfc822 module, and therefore is (name, addr)
-
- user is created if they don't exist in the db already
- '''
- (realname, address) = address
- users = self.user.stringFind(address=address)
- for dummy in range(2):
- if len(users) > 1:
- # make sure we don't match the anonymous or admin user
- for user in users:
- if user == '1': continue
- if self.user.get(user, 'username') == 'anonymous': continue
- # first valid match will do
- return user
- # well, I guess we have no choice
- return user[0]
- elif users:
- return users[0]
- # try to match the username to the address (for local
- # submissions where the address is empty)
- users = self.user.stringFind(username=address)
-
- # couldn't match address or username, so create a new user
- return self.user.create(username=address, address=address,
- realname=realname)
-
-_marker = []
-# XXX: added the 'creator' faked attribute
-class Class(hyperdb.Class):
- # Overridden methods:
- def __init__(self, db, classname, **properties):
- if (properties.has_key('creation') or properties.has_key('activity')
- or properties.has_key('creator')):
- raise ValueError, '"creation", "activity" and "creator" are reserved'
- hyperdb.Class.__init__(self, db, classname, **properties)
- self.auditors = {'create': [], 'set': [], 'retire': []}
- self.reactors = {'create': [], 'set': [], 'retire': []}
-
- def create(self, **propvalues):
- """These operations trigger detectors and can be vetoed. Attempts
- to modify the "creation" or "activity" properties cause a KeyError.
- """
- if propvalues.has_key('creation') or propvalues.has_key('activity'):
- raise KeyError, '"creation" and "activity" are reserved'
- for audit in self.auditors['create']:
- audit(self.db, self, None, propvalues)
- nodeid = hyperdb.Class.create(self, **propvalues)
- for react in self.reactors['create']:
- react(self.db, self, nodeid, None)
- return nodeid
-
- def set(self, nodeid, **propvalues):
- """These operations trigger detectors and can be vetoed. Attempts
- to modify the "creation" or "activity" properties cause a KeyError.
- """
- if propvalues.has_key('creation') or propvalues.has_key('activity'):
- raise KeyError, '"creation" and "activity" are reserved'
- for audit in self.auditors['set']:
- audit(self.db, self, nodeid, propvalues)
- oldvalues = self.db.getnode(self.classname, nodeid)
- hyperdb.Class.set(self, nodeid, **propvalues)
- for react in self.reactors['set']:
- react(self.db, self, nodeid, oldvalues)
-
- def retire(self, nodeid):
- """These operations trigger detectors and can be vetoed. Attempts
- to modify the "creation" or "activity" properties cause a KeyError.
- """
- for audit in self.auditors['retire']:
- audit(self.db, self, nodeid, None)
- hyperdb.Class.retire(self, nodeid)
- for react in self.reactors['retire']:
- react(self.db, self, nodeid, None)
-
- def get(self, nodeid, propname, default=_marker):
- """Attempts to get the "creation" or "activity" properties should
- do the right thing.
- """
- if propname == 'creation':
- journal = self.db.getjournal(self.classname, nodeid)
- if journal:
- return self.db.getjournal(self.classname, nodeid)[0][1]
- else:
- # on the strange chance that there's no journal
- return date.Date()
- if propname == 'activity':
- journal = self.db.getjournal(self.classname, nodeid)
- if journal:
- return self.db.getjournal(self.classname, nodeid)[-1][1]
- else:
- # on the strange chance that there's no journal
- return date.Date()
- if propname == 'creator':
- journal = self.db.getjournal(self.classname, nodeid)
- if journal:
- name = self.db.getjournal(self.classname, nodeid)[0][2]
- else:
- return None
- return self.db.user.lookup(name)
- if default is not _marker:
- return hyperdb.Class.get(self, nodeid, propname, default)
+ 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 hyperdb.Class.get(self, nodeid, propname)
-
- def getprops(self, protected=1):
- """In addition to the actual properties on the node, these
- methods provide the "creation" and "activity" properties. If the
- "protected" flag is true, we include protected properties - those
- which may not be modified.
+ if (self.journal_uid is None or self.journal_uid[0] !=
+ self.journaltag):
+ uid = self.user.lookup(self.journaltag)
+ self.journal_uid = (self.journaltag, uid)
+ return self.journal_uid[1]
+
+ def setCurrentUser(self, username):
+ """Set the user that is responsible for current database
+ activities.
"""
- d = hyperdb.Class.getprops(self, protected=protected).copy()
- if protected:
- d['creation'] = hyperdb.Date()
- d['activity'] = hyperdb.Date()
- d['creator'] = hyperdb.Link("user")
- return d
+ self.journaltag = username
- #
- # Detector interface
- #
- def audit(self, event, detector):
- """Register a detector
+ def isCurrentUser(self, username):
+ """Check if a given username equals the already active user.
"""
- self.auditors[event].append(detector)
+ return self.journaltag == username
- def react(self, event, detector):
- """Register a detector
+ def getUserTimezone(self):
+ """Return user timezone defined in 'timezone' property of user class.
+ If no such property exists return 0
"""
- self.reactors[event].append(detector)
+ userid = self.getuid()
+ timezone = None
+ try:
+ tz = self.user.get(userid, 'timezone')
+ date.get_timezone(tz)
+ timezone = tz
+ except KeyError:
+ pass
+ # If there is no class 'user' or current user doesn't have timezone
+ # property or that property is not set assume he/she lives in
+ # the timezone set in the tracker config.
+ if timezone is None:
+ timezone = self.config['TIMEZONE']
+ return timezone
+ def confirm_registration(self, otk):
+ props = self.getOTKManager().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(encrypted=value)
-class FileClass(Class):
- def create(self, **propvalues):
- ''' snaffle the file propvalue and store in a file
- '''
- content = propvalues['content']
- del propvalues['content']
- newid = Class.create(self, **propvalues)
- self.setcontent(self.classname, newid, content)
- return newid
-
- def filename(self, classname, nodeid):
- # TODO: split into multiple files directories
- return os.path.join(self.db.dir, 'files', '%s%s'%(classname, nodeid))
-
- def setcontent(self, classname, nodeid, content):
- ''' set the content file for this file
- '''
- open(self.filename(classname, nodeid), 'wb').write(content)
+ # tag new user creation with 'admin'
+ self.journaltag = 'admin'
- def getcontent(self, classname, nodeid):
- ''' get the content file for this file
- '''
- return open(self.filename(classname, nodeid), 'rb').read()
+ # create the new user
+ cl = self.user
- def get(self, nodeid, propname, default=_marker):
- ''' trap the content propname and get it from the file
- '''
- if propname == 'content':
- return self.getcontent(self.classname, nodeid)
- if default is not _marker:
- return Class.get(self, nodeid, propname, default)
- else:
- return Class.get(self, nodeid, propname)
+ props['roles'] = self.config.NEW_WEB_USER_ROLES
+ userid = cl.create(**props)
+ # clear the props from the otk database
+ self.getOTKManager().destroy(otk)
+ self.commit()
- def getprops(self, protected=1):
- ''' In addition to the actual properties on the node, these methods
- provide the "content" property. If the "protected" flag is true,
- we include protected properties - those which may not be
- modified.
- '''
- d = Class.getprops(self, protected=protected).copy()
- if protected:
- d['content'] = hyperdb.String()
- return d
+ return userid
+
+
+ def log_debug(self, msg, *args, **kwargs):
+ """Log a message with level DEBUG."""
+
+ logger = self.get_logger()
+ logger.debug(msg, *args, **kwargs)
+
+ def log_info(self, msg, *args, **kwargs):
+ """Log a message with level INFO."""
+
+ logger = self.get_logger()
+ logger.info(msg, *args, **kwargs)
+
+ def get_logger(self):
+ """Return the logger for this database."""
+
+ # Because getting a logger requires acquiring a lock, we want
+ # to do it only once.
+ if not hasattr(self, '__logger'):
+ self.__logger = logging.getLogger('roundup.hyperdb')
+
+ return self.__logger
-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
-class IssueClass(Class):
- # configuration
- MESSAGES_TO_AUTHOR = 'no'
- INSTANCE_NAME = 'Roundup issue tracker'
- EMAIL_SIGNATURE_POSITION = 'bottom'
-
- # Overridden methods:
-
- def __init__(self, db, classname, **properties):
- """The newly-created class automatically includes the "messages",
- "files", "nosy", and "superseder" properties. If the 'properties'
- dictionary attempts to specify any of these properties or a
- "creation" or "activity" property, a ValueError is raised."""
- if not properties.has_key('title'):
- properties['title'] = hyperdb.String()
- if not properties.has_key('messages'):
- properties['messages'] = hyperdb.Multilink("msg")
- if not properties.has_key('files'):
- properties['files'] = hyperdb.Multilink("file")
- if not properties.has_key('nosy'):
- properties['nosy'] = hyperdb.Multilink("user")
- if not properties.has_key('superseder'):
- properties['superseder'] = hyperdb.Multilink(classname)
- Class.__init__(self, db, classname, **properties)
+# 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
+ enforces the title, messages, files, nosy and superseder
+ properties:
+
+ - title = hyperdb.String(indexme='yes')
+ - messages = hyperdb.Multilink("msg")
+ - files = hyperdb.Multilink("file")
+ - nosy = hyperdb.Multilink("user")
+ - superseder = hyperdb.Multilink(classname)
+ """
+
+ # The tuple below does not affect the class definition.
+ # It just lists all names of all issue properties
+ # marked for message extraction tool.
+ #
+ # XXX is there better way to get property names into message catalog??
+ #
+ # Note that this list also includes properties
+ # defined in the classic template:
+ # assignedto, keyword, priority, status.
+ (
+ ''"title", ''"messages", ''"files", ''"nosy", ''"superseder",
+ ''"assignedto", ''"keyword", ''"priority", ''"status",
+ # following properties are common for all hyperdb classes
+ # they are listed here to keep things in one place
+ ''"actor", ''"activity", ''"creator", ''"creation",
+ )
# New methods:
-
- def addmessage(self, nodeid, summary, text):
+ def addmessage(self, issueid, summary, text):
"""Add a message to an issue's mail spool.
A new "msg" node is constructed using the current date, the user that
appended to the "messages" field of the specified issue.
"""
- def sendmessage(self, nodeid, msgid):
+ def nosymessage(self, issueid, msgid, oldvalues, whichnosy='nosy',
+ from_address=None, cc=[], bcc=[], cc_emails = [], bcc_emails = []):
"""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.
+
+ If 'msgid' is None, the message gets sent only to the nosy
+ list, and it's called a 'System Message'.
+
+ The "cc" argument indicates additional recipients to send the
+ message to that may not be specified in the message's recipients
+ list.
+
+ The "bcc" argument also indicates additional recipients to send the
+ message to that may not be specified in the message's recipients
+ list. These recipients will not be included in the To: or Cc:
+ address lists. Note that the list of bcc users *is* updated in
+ the recipient list of the message, so this field has to be
+ protected (using appropriate permissions), otherwise the bcc
+ will be decuceable for users who have web access to the tracker.
+
+ The cc_emails and bcc_emails arguments take a list of additional
+ recipient email addresses (just the mail address not roundup users)
+ this can be useful for sending to additional email addresses
+ which are no roundup users. These arguments are currently not
+ used by roundups nosyreaction but can be used by customized
+ (nosy-)reactors.
+
+ A note on encryption: If pgp encryption for outgoing mails is
+ turned on in the configuration and no specific pgp roles are
+ defined, we try to send encrypted mail to *all* users
+ *including* cc, bcc, cc_emails and bcc_emails and this might
+ fail if not all the keys are available in roundups keyring.
"""
- # figure the recipient ids
- recipients = self.db.msg.get(msgid, 'recipients')
- r = {}
- for recipid in recipients:
- r[recipid] = 1
- rlen = len(recipients)
-
- # figure the author's id, and indicate they've received the message
- authid = self.db.msg.get(msgid, 'author')
-
- # get the current nosy list, we'll need it
- nosy = self.get(nodeid, 'nosy')
-
- # ... but duplicate the message to the author as long as it's not
- # the anonymous user
- if (self.MESSAGES_TO_AUTHOR == 'yes' and
- self.db.user.get(authid, 'username') != 'anonymous'):
- if not r.has_key(authid):
- recipients.append(authid)
- r[authid] = 1
-
- # now figure the nosy people who weren't recipients
- 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 self.db.user.get(nosyid, 'username') == 'anonymous': continue
- if not r.has_key(nosyid):
- recipients.append(nosyid)
-
- # no new recipients
- if rlen == len(recipients):
- return
-
- # update the message's recipients list
- self.db.msg.set(msgid, recipients=recipients)
-
- # send an email to the people who missed out
- sendto = [self.db.user.get(i, 'address') for i in recipients]
+ encrypt = self.db.config.PGP_ENABLE and self.db.config.PGP_ENCRYPT
+ pgproles = self.db.config.PGP_ROLES
+ if msgid:
+ authid = self.db.msg.get(msgid, 'author')
+ recipients = self.db.msg.get(msgid, 'recipients', [])
+ else:
+ # "system message"
+ authid = None
+ recipients = []
+
+ sendto = dict (plain = [], crypt = [])
+ bcc_sendto = dict (plain = [], crypt = [])
+ seen_message = {}
+ for recipient in recipients:
+ seen_message[recipient] = 1
+
+ def add_recipient(userid, to):
+ """ make sure they have an address """
+ address = self.db.user.get(userid, 'address')
+ if address:
+ ciphered = encrypt and (not pgproles or
+ self.db.user.has_role(userid, *iter_roles(pgproles)))
+ type = ['plain', 'crypt'][ciphered]
+ to[type].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.
+ Also check permissions on the message if not a system
+ message: A user must have view permission on content and
+ files to be on the receiver list. We do *not* check the
+ author etc. for now.
+ """
+ allowed = True
+ if msgid:
+ for prop in 'content', 'files':
+ if prop in self.db.msg.properties:
+ allowed = allowed and self.db.security.hasPermission(
+ 'View', userid, 'msg', prop, msgid)
+ return (userid and
+ (self.db.user.get(userid, 'username') != 'anonymous') and
+ allowed and not seen_message.has_key(userid))
+
+ # possibly send the message to the author, as long as they aren't
+ # anonymous
+ 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, sendto)
+
+ if authid:
+ seen_message[authid] = 1
+
+ # now deal with the nosy and cc people who weren't recipients.
+ for userid in cc + self.get(issueid, whichnosy):
+ if good_recipient(userid):
+ add_recipient(userid, sendto)
+ if encrypt and not pgproles:
+ sendto['crypt'].extend (cc_emails)
+ else:
+ sendto['plain'].extend (cc_emails)
+
+ # now deal with bcc people.
+ for userid in bcc:
+ if good_recipient(userid):
+ add_recipient(userid, bcc_sendto)
+ if encrypt and not pgproles:
+ bcc_sendto['crypt'].extend (bcc_emails)
+ else:
+ bcc_sendto['plain'].extend (bcc_emails)
+
+ if oldvalues:
+ note = self.generateChangeNote(issueid, oldvalues)
+ else:
+ note = self.generateCreateNote(issueid)
+
+ # If we have new recipients, update the message's recipients
+ # and send the mail.
+ if sendto['plain'] or sendto['crypt']:
+ # update msgid and recipients only if non-bcc have changed
+ if msgid is not None:
+ self.db.msg.set(msgid, recipients=recipients)
+ if sendto['plain'] or bcc_sendto['plain']:
+ self.send_message(issueid, msgid, note, sendto['plain'],
+ from_address, bcc_sendto['plain'])
+ if sendto['crypt'] or bcc_sendto['crypt']:
+ self.send_message(issueid, msgid, note, sendto['crypt'],
+ from_address, bcc_sendto['crypt'], crypt=True)
+
+ # backwards compatibility - don't remove
+ sendmessage = nosymessage
+
+ def encrypt_to(self, message, sendto):
+ """ Encrypt given message to sendto receivers.
+ Returns a new RFC 3156 conforming message.
+ """
+ plain = pyme.core.Data(message.as_string())
+ cipher = pyme.core.Data()
+ ctx = pyme.core.Context()
+ ctx.set_armor(1)
+ keys = []
+ for adr in sendto:
+ ctx.op_keylist_start(adr, 0)
+ # only first key per email
+ k = ctx.op_keylist_next()
+ if k is not None:
+ keys.append(k)
+ else:
+ msg = _('No key for "%(adr)s" in keyring')%locals()
+ raise MessageSendError, msg
+ ctx.op_keylist_end()
+ ctx.op_encrypt(keys, 1, plain, cipher)
+ cipher.seek(0,0)
+ msg = MIMEMultipart('encrypted', boundary=None, _subparts=None,
+ protocol="application/pgp-encrypted")
+ part = MIMEBase('application', 'pgp-encrypted')
+ part.set_payload("Version: 1\r\n")
+ msg.attach(part)
+ part = MIMEBase('application', 'octet-stream')
+ part.set_payload(cipher.read())
+ msg.attach(part)
+ return msg
+
+ def send_message(self, issueid, msgid, note, sendto, from_address=None,
+ bcc_sendto=[], crypt=False):
+ '''Actually send the nominated message from this issue to the sendto
+ recipients, with the note appended.
+ '''
+ users = self.db.user
+ messages = self.db.msg
+ files = self.db.file
+
+ if msgid is None:
+ inreplyto = None
+ messageid = None
+ else:
+ 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, issueid,
+ self.db.config.MAIL_DOMAIN)
+ if msgid is not None:
+ messages.set(msgid, messageid=messageid)
+
+ # compose title
cn = self.classname
- title = self.get(nodeid, 'title') or '%s message copy'%cn
+ title = self.get(issueid, 'title') or '%s message copy'%cn
+
# figure author information
- authname = self.db.user.get(authid, 'realname')
- if not authname:
- authname = self.db.user.get(authid, 'username')
- authaddr = self.db.user.get(authid, 'address')
- if authaddr:
- authaddr = ' <%s>'%authaddr
+ if msgid:
+ authid = messages.get(msgid, 'author')
else:
- authaddr = ''
+ authid = self.db.getuid()
+ authname = users.get(authid, 'realname')
+ if not authname:
+ authname = users.get(authid, 'username', '')
+ authaddr = users.get(authid, 'address', '')
+
+ if authaddr and self.db.config.MAIL_ADD_AUTHOREMAIL:
+ authaddr = " <%s>" % formataddr( ('',authaddr) )
+ elif authaddr:
+ authaddr = ""
# make the message body
m = ['']
# put in roundup's signature
- if self.EMAIL_SIGNATURE_POSITION == 'top':
- m.append(self.email_signature(nodeid, msgid))
+ if self.db.config.EMAIL_SIGNATURE_POSITION == 'top':
+ m.append(self.email_signature(issueid, msgid))
# add author information
- 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))
- m.append('')
+ if authid and self.db.config.MAIL_ADD_AUTHORINFO:
+ if msgid and len(self.get(issueid, 'messages')) == 1:
+ m.append(_("New submission from %(authname)s%(authaddr)s:")
+ % locals())
+ elif msgid:
+ m.append(_("%(authname)s%(authaddr)s added the comment:")
+ % locals())
+ else:
+ m.append(_("Change by %(authname)s%(authaddr)s:") % locals())
+ m.append('')
# add the content
- m.append(self.db.msg.get(msgid, 'content'))
-
- # put in roundup's signature
- if self.EMAIL_SIGNATURE_POSITION == 'bottom':
- m.append(self.email_signature(nodeid, msgid))
+ if msgid is not None:
+ m.append(messages.get(msgid, 'content', ''))
# get the files for this message
- files = self.db.msg.get(msgid, 'files')
-
- # 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', '%s <%s>'%(self.INSTANCE_NAME,
- self.ISSUE_TRACKER_EMAIL))
- writer.addheader('Reply-To', '%s <%s>'%(self.INSTANCE_NAME,
- self.ISSUE_TRACKER_EMAIL))
- writer.addheader('MIME-Version', '1.0')
-
- # attach files
- if files:
- part = writer.startmultipartbody('mixed')
- part = writer.nextpart()
- body = part.startbody('text/plain')
- body.write('\n'.join(m))
- for fileid in files:
- name = self.db.file.get(fileid, 'name')
- mime_type = self.db.file.get(fileid, 'type')
- content = self.db.file.get(fileid, 'content')
- part = writer.nextpart()
- if mime_type == 'text/plain':
- part.addheader('Content-Disposition',
- 'attachment;\n filename="%s"'%name)
- part.addheader('Content-Transfer-Encoding', '7bit')
- body = part.startbody('text/plain')
- body.write(content)
+ message_files = []
+ if msgid :
+ for fileid in messages.get(msgid, 'files') :
+ # check the attachment size
+ filesize = self.db.filesize('file', fileid, None)
+ if filesize <= self.db.config.NOSY_MAX_ATTACHMENT_SIZE:
+ message_files.append(fileid)
else:
- # some other type, so encode it
- if not mime_type:
- # this should have been done when the file was saved
- mime_type = mimetypes.guess_type(name)[0]
- if mime_type is None:
- mime_type = 'application/octet-stream'
- part.addheader('Content-Disposition',
- 'attachment;\n filename="%s"'%name)
- part.addheader('Content-Transfer-Encoding', 'base64')
- body = part.startbody(mime_type)
- body.write(base64.encodestring(content))
- writer.lastpart()
+ base = self.db.config.TRACKER_WEB
+ link = "".join((base, files.classname, fileid))
+ filename = files.get(fileid, 'name')
+ m.append(_("File '%(filename)s' not attached - "
+ "you can download it from %(link)s.") % locals())
+
+ # add the change note
+ if note:
+ m.append(note)
+
+ # put in roundup's signature
+ if self.db.config.EMAIL_SIGNATURE_POSITION == 'bottom':
+ m.append(self.email_signature(issueid, msgid))
+
+ # figure the encoding
+ charset = getattr(self.db.config, 'EMAIL_CHARSET', 'utf-8')
+
+ # construct the content and convert to unicode object
+ body = unicode('\n'.join(m), 'utf-8').encode(charset)
+
+ # 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, issueid, title)
+ author = (authname + from_tag, from_address)
+
+ # send an individual message per recipient?
+ if self.db.config.NOSY_EMAIL_SENDING != 'single':
+ sendto = [[address] for address in sendto]
else:
- body = writer.startbody('text/plain')
- body.write('\n'.join(m))
+ sendto = [sendto]
+
+ # tracker sender info
+ tracker_name = unicode(self.db.config.TRACKER_NAME, 'utf-8')
+ tracker_name = nice_sender_header(tracker_name, from_address,
+ charset)
+
+ # now send one or more messages
+ # TODO: I believe we have to create a new message each time as we
+ # can't fiddle the recipients in the message ... worth testing
+ # and/or fixing some day
+ first = True
+ for sendto in sendto:
+ # create the message
+ mailer = Mailer(self.db.config)
+
+ message = mailer.get_standard_message(multipart=message_files)
+
+ # set reply-to to the tracker
+ message['Reply-To'] = tracker_name
+
+ # message ids
+ if messageid:
+ message['Message-Id'] = messageid
+ if inreplyto:
+ message['In-Reply-To'] = inreplyto
+
+ # Generate a header for each link or multilink to
+ # a class that has a name attribute
+ for propname, prop in self.getprops().items():
+ if not isinstance(prop, (hyperdb.Link, hyperdb.Multilink)):
+ continue
+ cl = self.db.getclass(prop.classname)
+ if not 'name' in cl.getprops():
+ continue
+ if isinstance(prop, hyperdb.Link):
+ value = self.get(issueid, propname)
+ if value is None:
+ continue
+ values = [value]
+ else:
+ values = self.get(issueid, propname)
+ if not values:
+ continue
+ values = [cl.get(v, 'name') for v in values]
+ values = ', '.join(values)
+ header = "X-Roundup-%s-%s"%(self.classname, propname)
+ try:
+ message[header] = values.encode('ascii')
+ except UnicodeError:
+ message[header] = Header(values, charset)
+
+ if not inreplyto:
+ # Default the reply to the first message
+ msgs = self.get(issueid, 'messages')
+ # Assume messages are sorted by increasing message number here
+ # If the issue is just being created, and the submitter didn't
+ # provide a message, then msgs will be empty.
+ if msgs and msgs[0] != msgid:
+ inreplyto = messages.get(msgs[0], 'messageid')
+ if inreplyto:
+ message['In-Reply-To'] = inreplyto
+
+ # attach files
+ if message_files:
+ # first up the text as a part
+ part = MIMEText(body)
+ part.set_charset(charset)
+ encode_quopri(part)
+ message.attach(part)
+
+ for fileid in message_files:
+ name = files.get(fileid, 'name')
+ mime_type = files.get(fileid, 'type')
+ content = files.get(fileid, 'content')
+ if mime_type == 'text/plain':
+ try:
+ content.decode('ascii')
+ except UnicodeError:
+ # the content cannot be 7bit-encoded.
+ # use quoted printable
+ # XXX stuffed if we know the charset though :(
+ part = MIMEText(content)
+ encode_quopri(part)
+ else:
+ part = MIMEText(content)
+ part['Content-Transfer-Encoding'] = '7bit'
+ elif mime_type == 'message/rfc822':
+ main, sub = mime_type.split('/')
+ p = FeedParser()
+ p.feed(content)
+ part = MIMEBase(main, sub)
+ part.set_payload([p.close()])
+ else:
+ # some other type, so encode it
+ if not mime_type:
+ # this should have been done when the file was saved
+ mime_type = mimetypes.guess_type(name)[0]
+ if mime_type is None:
+ mime_type = 'application/octet-stream'
+ main, sub = mime_type.split('/')
+ part = MIMEBase(main, sub)
+ part.set_payload(content)
+ Encoders.encode_base64(part)
+ cd = 'Content-Disposition'
+ part[cd] = 'attachment;\n filename="%s"'%name
+ message.attach(part)
- # now try to send the message
- try:
- smtp = smtplib.SMTP(self.MAILHOST)
- smtp.sendmail(self.ISSUE_TRACKER_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
-
- def email_signature(self, nodeid, msgid):
+ else:
+ message.set_payload(body)
+ encode_quopri(message)
+
+ if crypt:
+ send_msg = self.encrypt_to (message, sendto)
+ else:
+ send_msg = message
+ mailer.set_message_attributes(send_msg, sendto, subject, author)
+ send_msg ['Message-Id'] = message ['Message-Id']
+ send_msg ['Reply-To'] = message ['Reply-To']
+ if message.get ('In-Reply-To'):
+ send_msg ['In-Reply-To'] = message ['In-Reply-To']
+ mailer.smtp_send(sendto, send_msg.as_string())
+ if first:
+ if crypt:
+ # send individual bcc mails, otherwise receivers can
+ # deduce bcc recipients from keys in message
+ for bcc in bcc_sendto:
+ send_msg = self.encrypt_to (message, [bcc])
+ send_msg ['Message-Id'] = message ['Message-Id']
+ send_msg ['Reply-To'] = message ['Reply-To']
+ if message.get ('In-Reply-To'):
+ send_msg ['In-Reply-To'] = message ['In-Reply-To']
+ mailer.smtp_send([bcc], send_msg.as_string())
+ elif bcc_sendto:
+ mailer.smtp_send(bcc_sendto, send_msg.as_string())
+ first = False
+
+ def email_signature(self, issueid, msgid):
''' Add a signature to the e-mail with some useful information
'''
- web = self.ISSUE_TRACKER_WEB + 'issue'+ nodeid
- email = '"%s" <%s>'%(self.INSTANCE_NAME, self.ISSUE_TRACKER_EMAIL)
- line = '_' * max(len(web), len(email))
- return '%s\n%s\n%s\n%s'%(line, email, web, line)
+ # simplistic check to see if the url is valid,
+ # then append a trailing slash if it is missing
+ base = self.db.config.TRACKER_WEB
+ if (not isinstance(base , type('')) or
+ not (base.startswith('http://') or base.startswith('https://'))):
+ web = "Configuration Error: TRACKER_WEB isn't a " \
+ "fully-qualified URL"
+ else:
+ if not base.endswith('/'):
+ base = base + '/'
+ web = base + self.classname + issueid
+
+ # ensure the email address is properly quoted
+ email = formataddr((self.db.config.TRACKER_NAME,
+ self.db.config.TRACKER_EMAIL))
+
+ line = '_' * max(len(web)+2, len(email))
+ return '\n%s\n%s\n<%s>\n%s'%(line, email, web, line)
+
+
+ def generateCreateNote(self, issueid):
+ """Generate a create note that lists initial property values
+ """
+ cn = self.classname
+ cl = self.db.classes[cn]
+ props = cl.getprops(protected=0)
+
+ # list the values
+ m = []
+ prop_items = props.items()
+ prop_items.sort()
+ for propname, prop in prop_items:
+ value = cl.get(issueid, propname, None)
+ # skip boring entries
+ if not value:
+ continue
+ if isinstance(prop, hyperdb.Link):
+ link = self.db.classes[prop.classname]
+ if value:
+ key = link.labelprop(default_to_id=1)
+ if key:
+ value = link.get(value, key)
+ else:
+ value = ''
+ elif isinstance(prop, hyperdb.Multilink):
+ if value is None: value = []
+ l = []
+ link = self.db.classes[prop.classname]
+ key = link.labelprop(default_to_id=1)
+ if key:
+ value = [link.get(entry, key) for entry in value]
+ value.sort()
+ value = ', '.join(value)
+ else:
+ value = str(value)
+ if '\n' in value:
+ value = '\n'+self.indentChangeNoteValue(value)
+ m.append('%s: %s'%(propname, value))
+ m.insert(0, '----------')
+ m.insert(0, '')
+ return '\n'.join(m)
- def generateChangeNote(self, nodeid, newvalues):
+ def generateChangeNote(self, issueid, oldvalues):
"""Generate a change note that lists property changes
"""
+ if not isinstance(oldvalues, type({})):
+ raise TypeError("'oldvalues' must be dict-like, not %s."%
+ type(oldvalues))
+
cn = self.classname
cl = self.db.classes[cn]
changed = {}
props = cl.getprops(protected=0)
# determine what changed
- for key in newvalues.keys():
- if key in ['files','messages']: continue
- new_value = newvalues[key]
+ for key in oldvalues.keys():
+ if key in ['files','messages']:
+ continue
+ if key in ('actor', '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(issueid, key)
+ except KeyError:
+ continue
# the old value might be non existent
+ # this happens when property was added
try:
- old_value = cl.get(nodeid, key)
- if type(old_value) is type([]):
- old_value.sort()
+ old_value = oldvalues[key]
+ if type(new_value) is type([]):
new_value.sort()
- if old_value != new_value:
- changed[key] = new_value
+ old_value.sort()
+ if new_value != old_value:
+ changed[key] = old_value
except:
changed[key] = new_value
# list the changes
- for propname, value in changed.items():
- prop = cl.properties[propname]
- oldvalue = cl.get(nodeid, propname, None)
- change = '%s -> %s'%(oldvalue, value)
+ m = []
+ changed_items = changed.items()
+ changed_items.sort()
+ for propname, oldvalue in changed_items:
+ prop = props[propname]
+ value = cl.get(issueid, propname, None)
if isinstance(prop, hyperdb.Link):
link = self.db.classes[prop.classname]
key = link.labelprop(default_to_id=1)
else:
l.append(entry)
if l:
+ l.sort()
change = '+%s'%(', '.join(l))
l = []
# check for removals
else:
l.append(entry)
if l:
+ l.sort()
change += ' -%s'%(', '.join(l))
+ else:
+ change = '%s -> %s'%(oldvalue, value)
+ if '\n' in change:
+ value = self.indentChangeNoteValue(str(value))
+ oldvalue = self.indentChangeNoteValue(str(oldvalue))
+ change = _('\nNow:\n%(new)s\nWas:\n%(old)s') % {
+ "new": value, "old": oldvalue}
m.append('%s: %s'%(propname, change))
if m:
- m.insert(0, '')
m.insert(0, '----------')
+ m.insert(0, '')
return '\n'.join(m)
-#
-# $Log: not supported by cvs2svn $
-# Revision 1.26 2001/12/05 14:26:44 rochecompaan
-# Removed generation of change note from "sendmessage" in roundupdb.py.
-# The change note is now generated when the message is created.
-#
-# Revision 1.25 2001/11/30 20:28:10 rochecompaan
-# Property changes are now completely traceable, whether changes are
-# made through the web or by email
-#
-# Revision 1.24 2001/11/30 11:29:04 rochecompaan
-# Property changes are now listed in emails generated by Roundup
-#
-# Revision 1.23 2001/11/27 03:17:13 richard
-# oops
-#
-# Revision 1.22 2001/11/27 03:00:50 richard
-# couple of bugfixes from latest patch integration
-#
-# Revision 1.21 2001/11/26 22:55:56 richard
-# Feature:
-# . Added INSTANCE_NAME to configuration - used in web and email to identify
-# the instance.
-# . Added EMAIL_SIGNATURE_POSITION to indicate where to place the roundup
-# signature info in e-mails.
-# . Some more flexibility in the mail gateway and more error handling.
-# . Login now takes you to the page you back to the were denied access to.
-#
-# Fixed:
-# . Lots of bugs, thanks Roché and others on the devel mailing list!
-#
-# Revision 1.20 2001/11/25 10:11:14 jhermann
-# Typo fix
-#
-# Revision 1.19 2001/11/22 15:46:42 jhermann
-# Added module docstrings to all modules.
-#
-# Revision 1.18 2001/11/15 10:36:17 richard
-# . incorporated patch from Roch'e Compaan implementing attachments in nosy
-# e-mail
-#
-# Revision 1.17 2001/11/12 22:01:06 richard
-# Fixed issues with nosy reaction and author copies.
-#
-# Revision 1.16 2001/10/30 00:54:45 richard
-# Features:
-# . #467129 ] Lossage when username=e-mail-address
-# . #473123 ] Change message generation for author
-# . MailGW now moves 'resolved' to 'chatting' on receiving e-mail for an issue.
-#
-# Revision 1.15 2001/10/23 01:00:18 richard
-# Re-enabled login and registration access after lopping them off via
-# disabling access for anonymous users.
-# Major re-org of the htmltemplate code, cleaning it up significantly. Fixed
-# a couple of bugs while I was there. Probably introduced a couple, but
-# things seem to work OK at the moment.
-#
-# Revision 1.14 2001/10/21 07:26:35 richard
-# feature #473127: Filenames. I modified the file.index and htmltemplate
-# source so that the filename is used in the link and the creation
-# information is displayed.
-#
-# Revision 1.13 2001/10/21 00:45:15 richard
-# Added author identification to e-mail messages from roundup.
-#
-# Revision 1.12 2001/10/04 02:16:15 richard
-# Forgot to pass the protected flag down *sigh*.
-#
-# Revision 1.11 2001/10/04 02:12:42 richard
-# Added nicer command-line item adding: passing no arguments will enter an
-# interactive more which asks for each property in turn. While I was at it, I
-# fixed an implementation problem WRT the spec - I wasn't raising a
-# ValueError if the key property was missing from a create(). Also added a
-# protected=boolean argument to getprops() so we can list only the mutable
-# properties (defaults to yes, which lists the immutables).
-#
-# Revision 1.10 2001/08/07 00:24:42 richard
-# stupid typo
-#
-# Revision 1.9 2001/08/07 00:15:51 richard
-# Added the copyright/license notice to (nearly) all files at request of
-# Bizar Software.
-#
-# Revision 1.8 2001/08/02 06:38:17 richard
-# Roundupdb now appends "mailing list" information to its messages which
-# include the e-mail address and web interface address. Templates may
-# override this in their db classes to include specific information (support
-# instructions, etc).
-#
-# Revision 1.7 2001/07/30 02:38:31 richard
-# get() now has a default arg - for migration only.
-#
-# Revision 1.6 2001/07/30 00:05:54 richard
-# Fixed IssueClass so that superseders links to its classname rather than
-# hard-coded to "issue".
-#
-# Revision 1.5 2001/07/29 07:01:39 richard
-# Added vim command to all source so that we don't get no steenkin' tabs :)
-#
-# Revision 1.4 2001/07/29 04:05:37 richard
-# Added the fabricated property "id".
-#
-# Revision 1.3 2001/07/23 07:14:41 richard
-# Moved the database backends off into backends.
-#
-# Revision 1.2 2001/07/22 12:09:32 richard
-# Final commit of Grande Splite
-#
-# Revision 1.1 2001/07/22 11:58:35 richard
-# More Grande Splite
-#
-#
-# vim: set filetype=python ts=4 sw=4 et si
+ def indentChangeNoteValue(self, text):
+ lines = text.rstrip('\n').split('\n')
+ lines = [ ' '+line for line in lines ]
+ return '\n'.join(lines)
+
+# vim: set filetype=python sts=4 sw=4 et si :