summaryrefslogtreecommitdiff
path: root/Mailman/app/rules.py
blob: f0209c7678efea0af2e878cf4f48e58a701e77d0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
# Copyright (C) 2007 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.

"""Various rule helpers"""

__all__ = [
    'TruthRule',
    'initialize',
    ]
__metaclass__ = type


from zope.interface import implements
from zope.interface.verify import verifyObject

from Mailman.app.plugins import get_plugins
from Mailman.configuration import config
from Mailman.interfaces import IRule



class TruthRule:
    """A rule that always matches."""
    implements(IRule)

    name = 'truth'
    description = 'A rule which always matches.'
    record = False

    def check(self, mlist, msg, msgdata):
        """See `IRule`."""
        return True



def initialize():
    """Find and register all rules in all plugins."""
    # Register built in rules.
    config.rules[TruthRule.name] = TruthRule()
    # Find rules in plugins.
    for rule_finder in get_plugins('mailman.rules'):
        for rule_class in rule_finder():
            rule = rule_class()
            verifyObject(IRule, rule)
            assert rule.name not in config.rules, (
                'Duplicate rule "%s" found in %s' % (rule.name, rule_finder))
            config.rules[rule.name] = rule