summaryrefslogtreecommitdiff
path: root/Mailman/rules/approved.py
diff options
context:
space:
mode:
authorBarry Warsaw2008-02-02 23:03:19 -0500
committerBarry Warsaw2008-02-02 23:03:19 -0500
commitf03c31acb800d79c606ee3e206868aef8a08bfda (patch)
tree15e0b72f129b6ee5f4515647c8c25e0c970a80d9 /Mailman/rules/approved.py
parent7c5b4d64df6532548742460d405a8a64e35b22c2 (diff)
parent4823801716b1bf1711d63b649b0fafd6acd30821 (diff)
downloadmailman-f03c31acb800d79c606ee3e206868aef8a08bfda.tar.gz
mailman-f03c31acb800d79c606ee3e206868aef8a08bfda.tar.zst
mailman-f03c31acb800d79c606ee3e206868aef8a08bfda.zip
Merge the 'rules' branch.
Give the first alpha a code name. This branch mostly gets rid of all the approval oriented handlers in favor of a chain-of-rules based approach. This will be much more powerful and extensible, allowing rule definition by plugin and chain creation via web page. When a message is processed by the incoming queue, it gets sent through a chain of rules. The starting chain is defined on the mailing list object, and there is a built-in default starting chain, called 'built-in'. Each chain is made up of links, which describe a rule and an action, along with possibly some other information. Actions allow processing to take a detour through another chain, jump to another chain, stop processing, run a function, etc. The built-in chain essentially implements the original early part of the handler pipeline. If a message makes it through the built-in chain, it gets sent to the prep queue, where the message is decorated and such before sending out to the list membership. The 'accept' chain is what moves the message into the prep queue. There are also 'hold', 'discard', and 'reject' chains, which do what you would expect them to. There are lots of built-in rules, implementing everything from the old emergency handler to new handlers such as one not allowing empty subject headers. IMember grows an is_moderated attribute. The 'adminapproved' metadata key is renamed 'moderator_approved'. Fix some bogus uses of noreply_address to no_reply_address. Stash an 'original_size' attribute on the message after parsing its plain text. This can be used later to ensure the original message does not exceed a specified size without have to flatten the message again. The KNOWN_SPAMMERS global variable is replaced with HEADER_MATCHES. The mailing list's header_filter_rules variable is replaced with header_matches which has the same semantics as HEADER_MATCHES, but is list-specific. DEFAULT_MAIL_COMMANDS_MAX_LINES -> EMAIL_COMMANDS_MAX_LINES. Update smtplistener.py to be much better, to use maildir format instead of mbox format, to respond to RSET commands by clearing the maildir, and by silencing annoying asyncore error messages. Extend the doctest runner so that it will run .txt files in any docs subdirectory in the code tree. Add plugable keys 'mailman.mta' and 'mailman.rules'. The latter may have only one setting while the former is extensible. There are lots of doctests which should give all the gory details. Mailman/Post.py -> Mailman/inject.py and the command line usage of this module is removed. SQLALCHEMY_ECHO, which was unused, is removed. Backport the ability to specify additional footer interpolation variables by the message metadata 'decoration-data' key. can_acknowledge() defines whether a message can be responded to by the email robot. Simplify the implementation of _reset() based on Storm fixes. Be able to handle lists in Storm values. Do some reorganization.
Diffstat (limited to 'Mailman/rules/approved.py')
-rw-r--r--Mailman/rules/approved.py117
1 files changed, 117 insertions, 0 deletions
diff --git a/Mailman/rules/approved.py b/Mailman/rules/approved.py
new file mode 100644
index 000000000..f3c1dc412
--- /dev/null
+++ b/Mailman/rules/approved.py
@@ -0,0 +1,117 @@
+# Copyright (C) 2007-2008 by the Free Software Foundation, Inc.
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
+# USA.
+
+"""Look for moderator pre-approval."""
+
+__all__ = ['Approved']
+__metaclass__ = type
+
+
+import re
+from email.iterators import typed_subpart_iterator
+from zope.interface import implements
+
+from Mailman.i18n import _
+from Mailman.interfaces import IRule
+
+
+EMPTYSTRING = u''
+
+
+
+class Approved:
+ """Look for moderator pre-approval."""
+ implements(IRule)
+
+ name = 'approved'
+ description = _('The message has a matching Approve or Approved header.')
+ record = True
+
+ def check(self, mlist, msg, msgdata):
+ """See `IRule`."""
+ # See if the message has an Approved or Approve header with a valid
+ # moderator password. Also look at the first non-whitespace line in
+ # the file to see if it looks like an Approved header.
+ missing = object()
+ password = msg.get('approved', msg.get('approve', missing))
+ if password is missing:
+ # Find the first text/plain part in the message
+ part = None
+ stripped = False
+ for part in typed_subpart_iterator(msg, 'text', 'plain'):
+ break
+ payload = part.get_payload(decode=True)
+ if payload is not None:
+ lines = payload.splitlines(True)
+ for lineno, line in enumerate(lines):
+ if line.strip() <> '':
+ break
+ if ':' in line:
+ header, value = line.split(':', 1)
+ if header.lower() in ('approved', 'approve'):
+ password = value.strip()
+ # Now strip the first line from the payload so the
+ # password doesn't leak.
+ del lines[lineno]
+ reset_payload(part, EMPTYSTRING.join(lines))
+ stripped = True
+ if stripped:
+ # Now try all the text parts in case it's
+ # multipart/alternative with the approved line in HTML or
+ # other text part. We make a pattern from the Approved line
+ # and delete it from all text/* parts in which we find it. It
+ # would be better to just iterate forward, but email
+ # compatability for pre Python 2.2 returns a list, not a true
+ # iterator.
+ #
+ # This will process all the multipart/alternative parts in the
+ # message as well as all other text parts. We shouldn't find
+ # the pattern outside the multipart/alternative parts, but if
+ # we do, it is probably best to delete it anyway as it does
+ # contain the password.
+ #
+ # Make a pattern to delete. We can't just delete a line
+ # because line of HTML or other fancy text may include
+ # additional message text. This pattern works with HTML. It
+ # may not work with rtf or whatever else is possible.
+ pattern = header + ':(\s|&nbsp;)*' + re.escape(password)
+ for part in typed_subpart_iterator(msg, 'text'):
+ payload = part.get_payload(decode=True)
+ if payload is not None:
+ if re.search(pattern, payload):
+ reset_payload(part, re.sub(pattern, '', payload))
+ else:
+ del msg['approved']
+ del msg['approve']
+ return password is not missing and password == mlist.moderator_password
+
+
+
+def reset_payload(part, payload):
+ # Set decoded payload maintaining content-type, charset, format and delsp.
+ charset = part.get_content_charset() or 'us-ascii'
+ content_type = part.get_content_type()
+ format = part.get_param('format')
+ delsp = part.get_param('delsp')
+ del part['content-transfer-encoding']
+ del part['content-type']
+ part.set_payload(payload, charset)
+ part.set_type(content_type)
+ if format:
+ part.set_param('Format', format)
+ if delsp:
+ part.set_param('DelSp', delsp)