summaryrefslogtreecommitdiff
path: root/mailman/core/styles.py
blob: 76428a9551a4c16afaa9b81359e877894a89e57c (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
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
# Copyright (C) 2007-2008 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/>.

"""Application of list styles to new and existing lists."""

__metaclass__ = type
__all__ = [
    'DefaultStyle',
    'style_manager',
    ]

# XXX Styles need to be reconciled with lazr.config.

import datetime

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

from mailman import Defaults
from mailman import Utils
from mailman.config import config
from mailman.core.plugins import get_plugins
from mailman.i18n import _
from mailman.interfaces import (
    Action, DuplicateStyleError, IStyle, IStyleManager, NewsModeration,
    Personalization)



class DefaultStyle:
    """The defalt (i.e. legacy) style."""

    implements(IStyle)

    name = 'default'
    priority = 0    # the lowest priority style

    def apply(self, mailing_list):
        """See `IStyle`."""
        # For cut-n-paste convenience.
        mlist = mailing_list
        # Most of these were ripped from the old MailList.InitVars() method.
        mlist.volume = 1
        mlist.post_id = 1
        mlist.new_member_options = Defaults.DEFAULT_NEW_MEMBER_OPTIONS
        # This stuff is configurable
        mlist.real_name = mlist.list_name.capitalize()
        mlist.respond_to_post_requests = True
        mlist.advertised = Defaults.DEFAULT_LIST_ADVERTISED
        mlist.max_num_recipients = Defaults.DEFAULT_MAX_NUM_RECIPIENTS
        mlist.max_message_size = Defaults.DEFAULT_MAX_MESSAGE_SIZE
        mlist.reply_goes_to_list = Defaults.DEFAULT_REPLY_GOES_TO_LIST
        mlist.reply_to_address = u''
        mlist.first_strip_reply_to = Defaults.DEFAULT_FIRST_STRIP_REPLY_TO
        mlist.admin_immed_notify = Defaults.DEFAULT_ADMIN_IMMED_NOTIFY
        mlist.admin_notify_mchanges = (
            Defaults.DEFAULT_ADMIN_NOTIFY_MCHANGES)
        mlist.require_explicit_destination = (
            Defaults.DEFAULT_REQUIRE_EXPLICIT_DESTINATION)
        mlist.acceptable_aliases = Defaults.DEFAULT_ACCEPTABLE_ALIASES
        mlist.send_reminders = Defaults.DEFAULT_SEND_REMINDERS
        mlist.send_welcome_msg = Defaults.DEFAULT_SEND_WELCOME_MSG
        mlist.send_goodbye_msg = Defaults.DEFAULT_SEND_GOODBYE_MSG
        mlist.bounce_matching_headers = (
            Defaults.DEFAULT_BOUNCE_MATCHING_HEADERS)
        mlist.header_matches = []
        mlist.anonymous_list = Defaults.DEFAULT_ANONYMOUS_LIST
        mlist.description = u''
        mlist.info = u''
        mlist.welcome_msg = u''
        mlist.goodbye_msg = u''
        mlist.subscribe_policy = Defaults.DEFAULT_SUBSCRIBE_POLICY
        mlist.subscribe_auto_approval = Defaults.DEFAULT_SUBSCRIBE_AUTO_APPROVAL
        mlist.unsubscribe_policy = Defaults.DEFAULT_UNSUBSCRIBE_POLICY
        mlist.private_roster = Defaults.DEFAULT_PRIVATE_ROSTER
        mlist.obscure_addresses = Defaults.DEFAULT_OBSCURE_ADDRESSES
        mlist.admin_member_chunksize = Defaults.DEFAULT_ADMIN_MEMBER_CHUNKSIZE
        mlist.administrivia = Defaults.DEFAULT_ADMINISTRIVIA
        mlist.preferred_language = Defaults.DEFAULT_SERVER_LANGUAGE
        mlist.include_rfc2369_headers = True
        mlist.include_list_post_header = True
        mlist.filter_mime_types = Defaults.DEFAULT_FILTER_MIME_TYPES
        mlist.pass_mime_types = Defaults.DEFAULT_PASS_MIME_TYPES
        mlist.filter_filename_extensions = (
            Defaults.DEFAULT_FILTER_FILENAME_EXTENSIONS)
        mlist.pass_filename_extensions = Defaults.DEFAULT_PASS_FILENAME_EXTENSIONS
        mlist.filter_content = Defaults.DEFAULT_FILTER_CONTENT
        mlist.collapse_alternatives = Defaults.DEFAULT_COLLAPSE_ALTERNATIVES
        mlist.convert_html_to_plaintext = (
            Defaults.DEFAULT_CONVERT_HTML_TO_PLAINTEXT)
        mlist.filter_action = Defaults.DEFAULT_FILTER_ACTION
        # Digest related variables
        mlist.digestable = Defaults.DEFAULT_DIGESTABLE
        mlist.digest_is_default = Defaults.DEFAULT_DIGEST_IS_DEFAULT
        mlist.mime_is_default_digest = Defaults.DEFAULT_MIME_IS_DEFAULT_DIGEST
        mlist.digest_size_threshhold = Defaults.DEFAULT_DIGEST_SIZE_THRESHHOLD
        mlist.digest_send_periodic = Defaults.DEFAULT_DIGEST_SEND_PERIODIC
        mlist.digest_header = Defaults.DEFAULT_DIGEST_HEADER
        mlist.digest_footer = Defaults.DEFAULT_DIGEST_FOOTER
        mlist.digest_volume_frequency = Defaults.DEFAULT_DIGEST_VOLUME_FREQUENCY
        mlist.one_last_digest = {}
        mlist.digest_members = {}
        mlist.next_digest_number = 1
        mlist.nondigestable = Defaults.DEFAULT_NONDIGESTABLE
        mlist.personalize = Personalization.none
        # New sender-centric moderation (privacy) options
        mlist.default_member_moderation = (
            Defaults.DEFAULT_DEFAULT_MEMBER_MODERATION)
        # Archiver
        mlist.archive = Defaults.DEFAULT_ARCHIVE
        mlist.archive_private = Defaults.DEFAULT_ARCHIVE_PRIVATE
        mlist.archive_volume_frequency = (
            Defaults.DEFAULT_ARCHIVE_VOLUME_FREQUENCY)
        mlist.emergency = False
        mlist.member_moderation_action = Action.hold
        mlist.member_moderation_notice = u''
        mlist.accept_these_nonmembers = []
        mlist.hold_these_nonmembers = []
        mlist.reject_these_nonmembers = []
        mlist.discard_these_nonmembers = []
        mlist.forward_auto_discards = Defaults.DEFAULT_FORWARD_AUTO_DISCARDS
        mlist.generic_nonmember_action = (
            Defaults.DEFAULT_GENERIC_NONMEMBER_ACTION)
        mlist.nonmember_rejection_notice = u''
        # Ban lists
        mlist.ban_list = []
        # Max autoresponses per day.  A mapping between addresses and a
        # 2-tuple of the date of the last autoresponse and the number of
        # autoresponses sent on that date.
        mlist.hold_and_cmd_autoresponses = {}
        mlist.subject_prefix = _(Defaults.DEFAULT_SUBJECT_PREFIX)
        mlist.msg_header = Defaults.DEFAULT_MSG_HEADER
        mlist.msg_footer = Defaults.DEFAULT_MSG_FOOTER
        # Set this to Never if the list's preferred language uses us-ascii,
        # otherwise set it to As Needed
        if Utils.GetCharSet(mlist.preferred_language) == 'us-ascii':
            mlist.encode_ascii_prefixes = 0
        else:
            mlist.encode_ascii_prefixes = 2
        # scrub regular delivery
        mlist.scrub_nondigest = Defaults.DEFAULT_SCRUB_NONDIGEST
        # automatic discarding
        mlist.max_days_to_hold = Defaults.DEFAULT_MAX_DAYS_TO_HOLD
        # Autoresponder
        mlist.autorespond_postings = False
        mlist.autorespond_admin = False
        # this value can be
        #  0 - no autoresponse on the -request line
        #  1 - autorespond, but discard the original message
        #  2 - autorespond, and forward the message on to be processed
        mlist.autorespond_requests = 0
        mlist.autoresponse_postings_text = u''
        mlist.autoresponse_admin_text = u''
        mlist.autoresponse_request_text = u''
        mlist.autoresponse_graceperiod = datetime.timedelta(days=90)
        mlist.postings_responses = {}
        mlist.admin_responses = {}
        mlist.request_responses = {}
        # Bounces
        mlist.bounce_processing = Defaults.DEFAULT_BOUNCE_PROCESSING
        mlist.bounce_score_threshold = Defaults.DEFAULT_BOUNCE_SCORE_THRESHOLD
        mlist.bounce_info_stale_after = Defaults.DEFAULT_BOUNCE_INFO_STALE_AFTER
        mlist.bounce_you_are_disabled_warnings = (
            Defaults.DEFAULT_BOUNCE_YOU_ARE_DISABLED_WARNINGS)
        mlist.bounce_you_are_disabled_warnings_interval = (
            Defaults.DEFAULT_BOUNCE_YOU_ARE_DISABLED_WARNINGS_INTERVAL)
        mlist.bounce_unrecognized_goes_to_list_owner = (
            Defaults.DEFAULT_BOUNCE_UNRECOGNIZED_GOES_TO_LIST_OWNER)
        mlist.bounce_notify_owner_on_disable = (
            Defaults.DEFAULT_BOUNCE_NOTIFY_OWNER_ON_DISABLE)
        mlist.bounce_notify_owner_on_removal = (
            Defaults.DEFAULT_BOUNCE_NOTIFY_OWNER_ON_REMOVAL)
        # This holds legacy member related information.  It's keyed by the
        # member address, and the value is an object containing the bounce
        # score, the date of the last received bounce, and a count of the
        # notifications left to send.
        mlist.bounce_info = {}
        # New style delivery status
        mlist.delivery_status = {}
        # NNTP gateway
        mlist.nntp_host = Defaults.DEFAULT_NNTP_HOST
        mlist.linked_newsgroup = u''
        mlist.gateway_to_news = False
        mlist.gateway_to_mail = False
        mlist.news_prefix_subject_too = True
        # In patch #401270, this was called newsgroup_is_moderated, but the
        # semantics weren't quite the same.
        mlist.news_moderation = NewsModeration.none
        # Topics
        #
        # `topics' is a list of 4-tuples of the following form:
        #
        #     (name, pattern, description, emptyflag)
        #
        # name is a required arbitrary string displayed to the user when they
        # get to select their topics of interest
        #
        # pattern is a required verbose regular expression pattern which is
        # used as IGNORECASE.
        #
        # description is an optional description of what this topic is
        # supposed to match
        #
        # emptyflag is a boolean used internally in the admin interface to
        # signal whether a topic entry is new or not (new ones which do not
        # have a name or pattern are not saved when the submit button is
        # pressed).
        mlist.topics = []
        mlist.topics_enabled = False
        mlist.topics_bodylines_limit = 5
        # This is a mapping between user "names" (i.e. addresses) and
        # information about which topics that user is interested in.  The
        # values are a list of topic names that the user is interested in,
        # which should match the topic names in mlist.topics above.
        #
        # If the user has not selected any topics of interest, then the rule
        # is that they will get all messages, and they will not have an entry
        # in this dictionary.
        mlist.topics_userinterest = {}
        # The processing chain that messages coming into this list get
        # processed by.
        mlist.start_chain = u'built-in'
        # The default pipeline to send accepted messages through.
        mlist.pipeline = u'built-in'

    def match(self, mailing_list, styles):
        """See `IStyle`."""
        # If no other styles have matched, then the default style matches.
        if len(styles) == 0:
            styles.append(self)



class StyleManager:
    """The built-in style manager."""

    implements(IStyleManager)

    def __init__(self):
        """Install all styles from registered plugins, and install them."""
        self._styles = {}
        # Install all the styles provided by plugins.
        for style_factory in get_plugins('mailman.styles'):
            style = style_factory()
            # Let DuplicateStyleErrors percolate up.
            self.register(style)

    def get(self, name):
        """See `IStyleManager`."""
        return self._styles.get(name)

    def lookup(self, mailing_list):
        """See `IStyleManager`."""
        matched_styles = []
        for style in self.styles:
            style.match(mailing_list, matched_styles)
        for style in matched_styles:
            yield style

    @property
    def styles(self):
        """See `IStyleManager`."""
        for style in sorted(self._styles.values(),
                            key=attrgetter('priority'),
                            reverse=True):
            yield style

    def register(self, style):
        """See `IStyleManager`."""
        verifyObject(IStyle, style)
        if style.name in self._styles:
            raise DuplicateStyleError(style.name)
        self._styles[style.name] = style

    def unregister(self, style):
        """See `IStyleManager`."""
        # Let KeyErrors percolate up.
        del self._styles[style.name]



style_manager = StyleManager()