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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
# Copyright (C) 2008-2016 by the Free Software Foundation, Inc.
#
# This file is part of GNU Mailman.
#
# GNU Mailman 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 3 of the License, or (at your option)
# any later version.
#
# GNU Mailman 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
# GNU Mailman. If not, see <http://www.gnu.org/licenses/>.
"""Built-in pipelines."""
import logging
from mailman import public
from mailman.app.bounces import bounce_message
from mailman.config import config
from mailman.core.i18n import _
from mailman.interfaces.handler import IHandler
from mailman.interfaces.pipeline import (
DiscardMessage, IPipeline, RejectMessage)
from mailman.utilities.modules import find_components
from zope.interface import implementer
from zope.interface.verify import verifyObject
dlog = logging.getLogger('mailman.debug')
vlog = logging.getLogger('mailman.vette')
@public
def process(mlist, msg, msgdata, pipeline_name='built-in'):
"""Process the message through the given pipeline.
:param mlist: the IMailingList for this message.
:param msg: The Message object.
:param msgdata: The message metadata dictionary.
:param pipeline_name: The name of the pipeline to process through.
"""
message_id = msg.get('message-id', 'n/a')
pipeline = config.pipelines[pipeline_name]
for handler in pipeline:
dlog.debug('{} pipeline {} processing: {}'.format(
message_id, pipeline_name, handler.name))
try:
handler.process(mlist, msg, msgdata)
except DiscardMessage as error:
vlog.info(
'{} discarded by "{}" pipeline handler "{}": {}'.format(
message_id, pipeline_name, handler.name, error.message))
except RejectMessage as error:
vlog.info(
'{} rejected by "{}" pipeline handler "{}": {}'.format(
message_id, pipeline_name, handler.name, error.message))
bounce_message(mlist, msg, error)
@public
@implementer(IPipeline)
class BasePipeline:
"""Base pipeline implementation."""
_default_handlers = ()
def __init__(self):
self._handlers = []
for handler_name in self._default_handlers:
self._handlers.append(config.handlers[handler_name])
def __iter__(self):
"""See `IPipeline`."""
yield from self._handlers
@public
class OwnerPipeline(BasePipeline):
"""The built-in owner pipeline."""
name = 'default-owner-pipeline'
description = _('The built-in owner pipeline.')
_default_handlers = (
'owner-recipients',
'to-outgoing',
)
@public
class PostingPipeline(BasePipeline):
"""The built-in posting pipeline."""
name = 'default-posting-pipeline'
description = _('The built-in posting pipeline.')
_default_handlers = (
'mime-delete',
'tagger',
'member-recipients',
'avoid-duplicates',
'cleanse',
'cleanse-dkim',
'cook-headers',
'subject-prefix',
'rfc-2369',
'to-archive',
'to-digest',
'to-usenet',
'after-delivery',
'acknowledge',
'decorate',
'dmarc',
'to-outgoing',
)
@public
class VirginPipeline(BasePipeline):
"""The processing pipeline for virgin messages.
Virgin messages are those that are crafted internally by Mailman.
"""
name = 'virgin'
description = _('The virgin queue pipeline.')
_default_handlers = (
'cook-headers',
'to-outgoing',
)
@public
def initialize():
"""Initialize the pipelines."""
# Find all handlers in the registered plugins.
for handler_class in find_components('mailman.handlers', IHandler):
handler = handler_class()
verifyObject(IHandler, handler)
assert handler.name not in config.handlers, (
'Duplicate handler "{}" found in {}'.format(
handler.name, handler_class))
config.handlers[handler.name] = handler
# Set up some pipelines.
for pipeline_class in (OwnerPipeline, PostingPipeline, VirginPipeline):
pipeline = pipeline_class()
config.pipelines[pipeline.name] = pipeline
|
