Mercurial Repository: p/roundup/code: roundup/mailgw.py comparison

comparison roundup/mailgw.py @ 2631:2bbcfc80ba5b

MailGW.handle_message(): as config is used many times in this method, have a local variable instead of going through self.instance.config each time; change config attribute access to container (item) access; where possible, avoid duplicate computing of config settings; fix MAILGW_KEEP_QUOTED_TEXT and MAILGW_LEAVE_BODY_UNCHANGED - config values are boolean now; trim trailing spaces, fix vim modeline

author	Alexander Smishlajev <a1s@users.sourceforge.net>
date	Mon, 26 Jul 2004 09:29:22 +0000
parents	58848e3b6bb8
children	1df7d4a41da4

comparison

equal deleted inserted replaced

-:a65bae7af6d1
+:2bbcfc80ba5b
 Incoming messages are examined for multiple parts:
 . In a multipart/mixed message or part, each subpart is extracted and
 examined. The text/plain subparts are assembled to form the textual
 body of the message, to be stored in the file associated with a "msg"
 class node. Any parts of other types are each stored in separate files
 and given "file" class nodes that are linked to the "msg" node.
 . In a multipart/alternative message or part, we look for a text/plain
 subpart and ignore the other parts.
 Summary
 -------
 The "summary" property on message nodes is taken from the first non-quoting
 section in the message body. The message body is divided into sections by
 blank lines. Sections where the second and all subsequent lines begin with
 a ">" or "|" character are considered "quoting sections". The first line of
 the first non-quoting section becomes the summary of the message.
 Addresses
 ---------
 All of the addresses in the To: and Cc: headers of the incoming message are
 looked up among the user nodes, and the corresponding users are placed in
 node. The default handling for addresses that don't have corresponding
 users is to create new users with no passwords and a username equal to the
 address. (The web interface does not permit logins for users with no
 passwords.) If we prefer to reject mail from outside sources, we can simply
 register an auditor on the "user" class that prevents the creation of user
 nodes with no passwords.
 Actions
 -------
 The subject line of the incoming message is examined to determine whether
 the message is an attempt to create a new item or to discuss an existing
 item. A designator enclosed in square brackets is sought as the first thing
 on the subject line (after skipping any "Fwd:" or "Re:" prefixes).
 If an item designator (class name and id number) is found there, the newly
 created "msg" node is added to the "messages" property for that item, and
 any new "file" nodes are added to the "files" property for the item.
 If just an item class name is found there, we attempt to create a new item
 of that class with its "messages" property initialized to contain the new
 "msg" node and its "files" property initialized to contain any new "file"
 nodes.
 Triggers
 --------
 Both cases may trigger detectors (in the first case we are calling the
 set() method to add the message to the item's spool; in the second case we
 are calling the create() method to create a new node). If an auditor raises
 an exception, the original message is bounced back to the sender with the
 explanatory message given in the exception.
-$Id: mailgw.py,v 1.151 2004-07-14 01:12:25 richard Exp $
+$Id: mailgw.py,v 1.152 2004-07-26 09:29:22 a1s Exp $
 """
 __docformat__ = 'restructuredtext'
 import string, re, os, mimetools, cStringIO, smtplib, socket, binascii, quopri
 import time, random, sys
 self.rewindbody()
 encoding = self.getencoding()
 data = None
 if encoding == 'base64':
 # BUG: is base64 really used for text encoding or
 # are we inserting zip files here.
 data = binascii.a2b_base64(self.fp.read())
 elif encoding == 'quoted-printable':
 # the quopri module wants to work with files
 decoded = cStringIO.StringIO()
 quopri.decode(self.fp, decoded)
 elif encoding == 'uuencoded':
 data = binascii.a2b_uu(self.fp.read())
 else:
 # take it as text
 data = self.fp.read()
 # Encode message to unicode
 charset = rfc2822.unaliasCharset(self.getparam("charset"))
 if charset:
 # Do conversion only if charset specified
 edata = unicode(data, charset).encode('utf-8')
 # Convert from dos eol to unix
 edata = edata.replace('\r\n', '\n')
 else:
 # Leave message content as is
 edata = data
 return edata
 # General multipart handling:
 #   Take the first text/plain part, anything else is considered an
 #   attachment.
 # multipart/mixed:
 #   Multiple "unrelated" parts.
 # multipart/Alternative (rfc 1521):
 #   Like multipart/mixed, except that we'd only want one of the
 #   alternatives. Generally a top-level part from MUAs sending HTML
 #   mail - there will be a text/plain version.
 # multipart/signed (rfc 1847):
 #   The control information is carried in the second of the two
 #   required body parts.
 #   ACTION: Default, so if content is text/plain we get it.
 # multipart/encrypted (rfc 1847):
 #   The control information is carried in the first of the two
 #   required body parts.
 #   ACTION: Not handleable as the content is encrypted.
 # multipart/related (rfc 1872, 2112, 2387):
 #   The Multipart/Related content-type addresses the MIME
 #   representation of compound objects, usually HTML mail with embedded
 #   images. Usually appears as an alternative.
 #   ACTION: Default, if we must.
 # multipart/report (rfc 1892):
 #   e.g. mail system delivery status reports.
 #   ACTION: Default. Could be ignored or used for Delivery Notification
 #   flagging.
 # multipart/form-data:
 #   For web forms only.
 def extract_content(self, parent_type=None):
 """Extract the body and the attachments recursively."""
 content_type = self.gettype()
 content = None
 attachments = []
 if content_type == 'text/plain':
 content = self.getbody()
 elif content_type[:10] == 'multipart/':
 for part in self.getparts():
 new_content, new_attach = part.extract_content(content_type)
 # otherwise make it an attachment.
 if not content:
 content = new_content
 elif new_content:
 attachments.append(part.as_attachment())
 attachments.extend(new_attach)
 elif (parent_type == 'multipart/signed' and
 content_type == 'application/pgp-signature'):
 # ignore it so it won't be saved as an attachment
 pass
 (?P<refwd>\s*\W?\s*(fw|fwd|re|aw)\W\s*)*\s*   # Re:
 (?P<quote>")?                                 # Leading "
 (\[(?P<classname>[^\d\s]+)                    # [issue..
 (?P<nodeid>\d+)?                           # ..1234]
 \])?\s*
 (?P<title>[^[]+)?                             # issue title
 "?                                            # Trailing "
 (\[(?P<args>.+?)\])?                          # [prop=value]
 ''', re.IGNORECASE|re.VERBOSE)
 def __init__(self, instance, db, arguments={}):
 else:
 server.user(user)
 server.pass_(password)
 numMessages = len(server.list()[1])
 for i in range(1, numMessages+1):
 # retr: returns
 # [ pop response e.g. '+OK 459 octets',
 #   [ array of message lines ],
 #   number of octets ]
 lines = server.retr(i)[1]
 s = cStringIO.StringIO('\n'.join(lines))
 # detect Precedence: Bulk
 if (message.getheader('precedence', '') == 'bulk'):
 raise IgnoreBulk
+# config is used many times in this method.
+# make local variable for easier access
+config = self.instance.config
 # XXX Don't enable. This doesn't work yet.
 #  "[^A-z.]tracker\+(?P<classname>[^\d\s]+)(?P<nodeid>\d+)\@some.dom.ain[^A-z.]"
 # handle delivery to addresses like:tracker+issue25@some.dom.ain
 # use the embedded issue number as our issue
-#        if hasattr(self.instance.config, 'EMAIL_ISSUE_ADDRESS_RE') and \
+#        issue_re = config['MAILGW_ISSUE_ADDRESS_RE']
-#                self.instance.config.EMAIL_ISSUE_ADDRESS_RE:
+#        if issue_re:
-#            issue_re = self.instance.config.EMAIL_ISSUE_ADDRESS_RE
 #            for header in ['to', 'cc', 'bcc']:
 #                addresses = message.getheader(header, '')
 #            if addresses:
 #              # FIXME, this only finds the first match in the addresses.
 #                issue = re.search(issue_re, addresses, 'i')
 otk_re = re.compile('-- key (?P<otk>[a-zA-Z0-9]{32})')
 otk = otk_re.search(m.group('title'))
 if otk:
 self.db.confirm_registration(otk.group('otk'))
 subject = 'Your registration to %s is complete' % \
-self.instance.config.TRACKER_NAME
+config['TRACKER_NAME']
 sendto = [from_list[0][1]]
 self.mailer.standard_message(sendto, subject, '')
 return
-elif hasattr(self.instance.config, 'MAIL_DEFAULT_CLASS') and \
-self.instance.config.MAIL_DEFAULT_CLASS:
-classname = self.instance.config.MAIL_DEFAULT_CLASS
 else:
-# fail
+classname = config['MAILGW_DEFAULT_CLASS']
-m = None
+if not classname:
+# fail
+m = None
 if not m:
 raise MailUsageError, """
 The message you sent to roundup did not contain a properly formed subject
 line. The subject must contain a class name or designator to indicate the
 if self.arguments:
 current_class = 'msg'
 for option, propstring in self.arguments:
 if option in ( '-C', '--class'):
 current_class = propstring.strip()
+# XXX this is not flexible enough.
+#   we should chect for subclasses of these classes,
+#   not for the class name...
 if current_class not in ('msg', 'file', 'user', 'issue'):
 raise MailUsageError, '''
 The mail gateway is not properly set up. Please contact
 %s and have them fix the incorrect class specified as:
 %s
-'''%(self.instance.config.ADMIN_EMAIL, current_class)
+''' % (config['ADMIN_EMAIL'], current_class)
 if option in ('-S', '--set'):
 if current_class == 'issue' :
 errors, issue_props = setPropArrayFromString(self,
 cl, propstring.strip(), nodeid)
 elif current_class == 'file' :
 if errors:
 raise MailUsageError, '''
 The mail gateway is not properly set up. Please contact
 %s and have them fix the incorrect properties:
 %s
-'''%(self.instance.config.ADMIN_EMAIL, errors)
+'''%(config['ADMIN_EMAIL'], errors)
 #
 # handle the users
 #
 # Don't create users if anonymous isn't allowed to register
 # re-get the class with the new database connection
 cl = self.db.getclass(classname)
 # now update the recipients list
 recipients = []
-tracker_email = self.instance.config.TRACKER_EMAIL.lower()
+tracker_email = config['TRACKER_EMAIL'].lower()
 for recipient in message.getaddrlist('to') + message.getaddrlist('cc'):
 r = recipient[1].strip().lower()
 if r == tracker_email or not r:
 continue
 messageid = message.getheader('message-id')
 inreplyto = message.getheader('in-reply-to') or ''
 # generate a messageid if there isn't one
 if not messageid:
 messageid = "<%s.%s.%s%s@%s>"%(time.time(), random.random(),
-classname, nodeid, self.instance.config.MAIL_DOMAIN)
+classname, nodeid, config['MAIL_DOMAIN'])
 # now handle the body - find the message
 content, attachments = message.extract_content()
 if content is None:
 raise MailUsageError, '''
 Roundup requires the submission to be plain text. The message parser could
 not find a text/plain part to use.
 '''
 # figure how much we should muck around with the email body
-keep_citations = getattr(self.instance.config, 'EMAIL_KEEP_QUOTED_TEXT',
+keep_citations = config['MAILGW_KEEP_QUOTED_TEXT']
-'no') == 'yes'
+keep_body = config['MAILGW_LEAVE_BODY_UNCHANGED']
-keep_body = getattr(self.instance.config, 'EMAIL_LEAVE_BODY_UNCHANGED',
-'no') == 'yes'
 # parse the body of the message, stripping out bits as appropriate
 summary, content = parseContent(content, keep_citations,
 keep_body)
 content = content.strip()
 #
 # handle the attachments
 #
 if properties.has_key('files'):
 files = []
 for (name, mime_type, data) in attachments:
 props['files'] = fileprop
 else:
 # pre-load the files list
 props['files'] = files
 #
 # create the message if there's a message body (content)
 #
 if (content and properties.has_key('messages')):
 try:
 message_id = self.db.msg.create(author=author,
 # commit the changes to the DB
 self.db.commit()
 return nodeid
 def setPropArrayFromString(self, cl, propString, nodeid=None):
 ''' takes string of form prop=value,value;prop2=value
 and returns (error, prop[..])
 '''
 props = {}
 return 0
 def parseContent(content, keep_citations, keep_body,
 blank_line=re.compile(r'[\r\n]+\s*[\r\n]+'),
 eol=re.compile(r'[\r\n]+'),
 signature=re.compile(r'^[>|\s]*-- ?$'),
 original_msg=re.compile(r'^[>|\s]*-----\s?Original Message\s?-----$')):
 ''' The message body is divided into sections by blank lines.
 Sections where the second and all subsequent lines begin with a ">"
 or "|" character are considered "quoting sections". The first line of
 the first non-quoting section becomes the summary of the message.
 If keep_citations is true, then we keep the "quoting sections" in the
 content.
 If keep_body is true, we even keep the signature sections.
 '''
 if not keep_body:
 content = '\n\n'.join(l)
 return summary, content
-# vim: set filetype=python sts=4 sw=4 et si
+# vim: set filetype=python sts=4 sw=4 et si :

Mercurial > p > roundup > code

comparison roundup/mailgw.py @ 2631:2bbcfc80ba5b