← Back to branch summary

~barry/mailman/events-and-web

« back to all changes in this revision

Viewing changes to Mailman/interfaces/chain.py

  • Committer: Barry Warsaw
  • Date: 2008-02-03 04:03:19 UTC
  • mfrom: (6581.1.27 rules)
  • Revision ID: barry@python.org-20080203040319-mnb1sar9bumaih01
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.

Show diffs side-by-side

added added

removed removed

Lines of Context:
Mailman/interfaces/chain.py
 
1
# Copyright (C) 2007 by the Free Software Foundation, Inc.
 
2
#
 
3
# This program is free software; you can redistribute it and/or
 
4
# modify it under the terms of the GNU General Public License
 
5
# as published by the Free Software Foundation; either version 2
 
6
# of the License, or (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
 
16
# USA.
 
17
 
 
18
"""Interface describing the basics of chains and links."""
 
19
 
 
20
from munepy import Enum
 
21
from zope.interface import Interface, Attribute
 
22
 
 
23
 
 
24
 
 
25
class LinkAction(Enum):
 
26
    # Jump to another chain.
 
27
    jump = 0
 
28
    # Take a detour to another chain, returning to the original chain when
 
29
    # completed (if no other jump occurs).
 
30
    detour = 1
 
31
    # Stop processing all chains.
 
32
    stop = 2
 
33
    # Continue processing the next link in the chain.
 
34
    defer = 3
 
35
    # Run a function and continue processing.
 
36
    run = 4
 
37
 
 
38
 
 
39
 
 
40
class IChainLink(Interface):
 
41
    """A link in the chain."""
 
42
 
 
43
    rule = Attribute('The rule to run for this link.')
 
44
 
 
45
    action = Attribute('The LinkAction to take if this rule matches.')
 
46
 
 
47
    chain = Attribute('The chain to jump or detour to.')
 
48
 
 
49
    function = Attribute(
 
50
        """The function to execute.
 
51
 
 
52
        The function takes three arguments and returns nothing.
 
53
        :param mlist: the IMailingList object
 
54
        :param msg: the message being processed
 
55
        :param msgdata: the message metadata dictionary
 
56
        """)
 
57
 
 
58
 
 
59
 
 
60
class IChain(Interface):
 
61
    """A chain of rules."""
 
62
 
 
63
    name = Attribute('Chain name; must be unique.')
 
64
    description = Attribute('A brief description of the chain.')
 
65
 
 
66
    def get_links(mlist, msg, msgdata):
 
67
        """Get an `IChainIterator` for processing.
 
68
 
 
69
        :param mlist: the IMailingList object
 
70
        :param msg: the message being processed
 
71
        :param msgdata: the message metadata dictionary
 
72
        :return: An `IChainIterator`.
 
73
        """
 
74
 
 
75
 
 
76
 
 
77
class IChainIterator(Interface):
 
78
    """An iterator over chain rules."""
 
79
 
 
80
    def __iter__():
 
81
        """Iterate over all the IChainLinks in this chain.
 
82
 
 
83
        :return: an IChainLink.
 
84
        """
 
85
 
 
86
 
 
87
 
 
88
class IMutableChain(IChain):
 
89
    """Like `IChain` but can be mutated."""
 
90
 
 
91
    def append_link(link):
 
92
        """Add a new chain link to the end of this chain.
 
93
 
 
94
        :param link: The chain link to add.
 
95
        """
 
96
 
 
97
    def flush():
 
98
        """Delete all links in this chain."""