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
|
# Copyright (C) 2009-2011 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/>.
"""Generate Mailman alias files for your MTA."""
from __future__ import absolute_import, unicode_literals
__metaclass__ = type
__all__ = [
'Aliases',
]
import sys
from operator import attrgetter
from zope.component import getUtility
from zope.interface import implements
from mailman.config import config
from mailman.core.i18n import _
from mailman.interfaces.command import ICLISubCommand
from mailman.interfaces.listmanager import IListManager
from mailman.interfaces.mta import (
IMailTransportAgentAliases, IMailTransportAgentLifecycle)
from mailman.utilities.modules import call_name
class Aliases:
"""Regenerate the aliases appropriate for your MTA."""
implements(ICLISubCommand)
name = 'aliases'
def add(self, parser, command_parser):
"""See `ICLISubCommand`."""
self.parser = parser
command_parser.add_argument(
'-o', '--output',
action='store', help=_("""\
File to send the output to. If not given, a file in $VAR/data is
used. The argument can be '-' to use standard output.."""))
command_parser.add_argument(
'-f', '--format',
action='store', help=_("""\
Alternative output format to use. This is the Python object path
to an implementation of the `IMailTransportAgentLifecycle`
interface."""))
command_parser.add_argument(
'-s', '--simple',
action='store_true', default=False, help=_("""\
Simply output the list of aliases.
"""))
def process(self, args):
"""See `ICLISubCommand`."""
if args.format is not None and args.simple:
self.parser.error(_('Cannot use both -s and -f'))
# Does not return.
output = None
if args.output == '-':
output = sys.stdout
elif args.output is None:
output = None
else:
output = args.output
if args.simple:
Dummy().regenerate(output)
else:
format_arg = (config.mta.incoming
if args.format is None
else args.format)
# Call the MTA-specific regeneration method.
call_name(format_arg).regenerate(output)
class Dummy:
"""Dummy aliases implementation for simpler output format."""
implements(IMailTransportAgentLifecycle)
def create(self, mlist):
"""See `IMailTransportAgentLifecycle`."""
raise NotImplementedError
def delete(self, mlist):
"""See `IMailTransportAgentLifecycle`."""
raise NotImplementedError
def regenerate(self, output=None):
"""See `IMailTransportAgentLifecycle`."""
fp = None
close = False
try:
if output is None:
# There's really no place to print the output.
return
elif isinstance(output, basestring):
fp = open(output, 'w')
close = True
else:
fp = output
self._do_write_file(fp)
finally:
if fp is not None and close:
fp.close()
def _do_write_file(self, fp):
# First, sort mailing lists by domain.
by_domain = {}
for mlist in getUtility(IListManager).mailing_lists:
by_domain.setdefault(mlist.mail_host, []).append(mlist)
sort_key = attrgetter('list_name')
for domain in sorted(by_domain):
for mlist in sorted(by_domain[domain], key=sort_key):
utility = getUtility(IMailTransportAgentAliases)
for alias in utility.aliases(mlist):
print >> fp, alias
print >> fp
|
