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
|
# Copyright (C) 2009-2017 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/>.
"""The 'lists' subcommand."""
import sys
import click
from mailman.app.lifecycle import create_list, remove_list
from mailman.core.constants import system_preferences
from mailman.core.i18n import _
from mailman.database.transaction import transaction
from mailman.email.message import UserNotification
from mailman.interfaces.address import (
IEmailValidator, InvalidEmailAddressError)
from mailman.interfaces.command import ICLISubCommand
from mailman.interfaces.domain import (
BadDomainSpecificationError, IDomainManager)
from mailman.interfaces.languages import ILanguageManager
from mailman.interfaces.listmanager import IListManager, ListAlreadyExistsError
from mailman.interfaces.template import ITemplateLoader
from mailman.utilities.options import I18nCommand
from mailman.utilities.string import expand, wrap
from operator import attrgetter
from public import public
from zope.component import getUtility
from zope.interface import implementer
COMMASPACE = ', '
@click.command(
cls=I18nCommand,
help=_('List all mailing lists.'))
@click.option(
'--advertised', '-a',
is_flag=True, default=False,
help=_('List only those mailing lists that are publicly advertised'))
@click.option(
'--names/--no-names', '-n/-N',
is_flag=True, default=False,
help=_('Show also the list names'))
@click.option(
'--descriptions/--no-descriptions', '-d/-D',
is_flag=True, default=False,
help=_('Show also the list descriptions'))
@click.option(
'--quiet', '-q',
is_flag=True, default=False,
help=_('Less verbosity'))
@click.option(
'--domain', 'domains',
multiple=True, metavar='DOMAIN',
help=_("""\
List only those mailing lists hosted on the given domain, which
must be the email host name. Multiple -d options may be given.
"""))
@click.pass_context
def lists(ctx, advertised, names, descriptions, quiet, domains):
mailing_lists = set()
list_manager = getUtility(IListManager)
# Gather the matching mailing lists.
for mlist in list_manager.mailing_lists:
if advertised and not mlist.advertised:
continue
if len(domains) > 0 and mlist.mail_host not in domains:
continue
mailing_lists.add(mlist)
# Maybe no mailing lists matched.
if len(mailing_lists) == 0:
if not quiet:
print(_('No matching mailing lists found'))
ctx.exit()
count = len(mailing_lists) # noqa: F841
if not quiet:
print(_('$count matching mailing lists found:'))
# Calculate the longest identifier.
longest = 0
output = []
for mlist in sorted(mailing_lists, key=attrgetter('list_id')):
if names:
identifier = '{} [{}]'.format(
mlist.fqdn_listname, mlist.display_name)
else:
identifier = mlist.fqdn_listname
longest = max(len(identifier), longest)
output.append((identifier, mlist.description))
# Print it out.
if descriptions:
format_string = '{0:{2}} - {1:{3}}'
else:
format_string = '{0:{2}}'
for identifier, description in output:
print(format_string.format(
identifier, description, longest, 70 - longest))
@public
@implementer(ICLISubCommand)
class Lists:
name = 'lists'
command = lists
@click.command(
cls=I18nCommand,
help=_("""\
Create a mailing list.
The 'fully qualified list name', i.e. the posting address of the mailing
list is required. It must be a valid email address and the domain must be
registered with Mailman. List names are forced to lower case."""))
@click.option(
'--language', metavar='CODE',
help=_("""\
Set the list's preferred language to CODE, which must be a registered two
letter language code."""))
@click.option(
'--owner', '-o', 'owners',
multiple=True, metavar='OWNER',
help=_("""\
Specify a list owner email address. If the address is not currently
registered with Mailman, the address is registered and linked to a user.
Mailman will send a confirmation message to the address, but it will also
send a list creation notice to the address. More than one owner can be
specified."""))
@click.option(
'--notify/-no-notify', '-n/-N',
default=False,
help=_("""\
Notify the list owner by email that their mailing list has been
created."""))
@click.option(
'--quiet', '-q',
is_flag=True, default=False,
help=_('Print less output.'))
@click.option(
'--domain/--no-domain', '-d/-D', 'create_domain',
default=True,
help=_("""\
Register the mailing list's domain if not yet registered. This is
the default behavior, but these options are provided for backward
compatibility. With -D do not register the mailing list's domain."""))
@click.argument('fqdn_listname', metavar='LISTNAME')
@click.pass_context
def create(ctx, language, owners, notify, quiet, create_domain, fqdn_listname):
language_code = (language if language is not None
else system_preferences.preferred_language.code)
# Make sure that the selected language code is known.
if language_code not in getUtility(ILanguageManager).codes:
ctx.fail(_('Invalid language code: $language_code'))
# Check to see if the domain exists or not.
listname, at, domain = fqdn_listname.partition('@')
domain_manager = getUtility(IDomainManager)
if domain_manager.get(domain) is None and create_domain:
domain_manager.add(domain)
# Validate the owner email addresses. The problem with doing this check in
# create_list() is that you wouldn't be able to distinguish between an
# InvalidEmailAddressError for the list name or the owners. I suppose we
# could subclass that exception though.
if len(owners) > 0:
validator = getUtility(IEmailValidator)
invalid_owners = [owner for owner in owners
if not validator.is_valid(owner)]
if invalid_owners:
invalid = COMMASPACE.join(sorted(invalid_owners)) # noqa: F841
ctx.fail(_('Illegal owner addresses: $invalid'))
try:
mlist = create_list(fqdn_listname, owners)
except InvalidEmailAddressError:
ctx.fail(_('Illegal list name: $fqdn_listname'))
except ListAlreadyExistsError:
ctx.fail(_('List already exists: $fqdn_listname'))
except BadDomainSpecificationError as domain:
ctx.fail(_('Undefined domain: $domain'))
# Find the language associated with the code, then set the mailing list's
# preferred language to that.
language_manager = getUtility(ILanguageManager)
with transaction():
mlist.preferred_language = language_manager[language_code]
# Do the notification.
if not quiet:
print(_('Created mailing list: $mlist.fqdn_listname'))
if notify:
template = getUtility(ITemplateLoader).get(
'domain:admin:notice:new-list', mlist)
text = wrap(expand(template, mlist, dict(
# For backward compatibility.
requestaddr=mlist.request_address,
siteowner=mlist.no_reply_address,
)))
# Set the I18N language to the list's preferred language so the header
# will match the template language. Stashing and restoring the old
# translation context is just (healthy? :) paranoia.
with _.using(mlist.preferred_language.code):
msg = UserNotification(
owners, mlist.no_reply_address,
_('Your new mailing list: $fqdn_listname'),
text, mlist.preferred_language)
msg.send(mlist)
@public
@implementer(ICLISubCommand)
class Create:
name = 'create'
command = create
@click.command(
cls=I18nCommand,
help=_('Remove a mailing list.'))
@click.option(
'--quiet', '-q',
is_flag=True, default=False,
help=_('Suppress status messages'))
@click.argument('listspec')
def remove(quiet, listspec):
mlist = getUtility(IListManager).get(listspec)
if mlist is None:
if not quiet:
print(_('No such list matching spec: $listspec'))
sys.exit(0)
with transaction():
remove_list(mlist)
if not quiet:
print(_('Removed list: $listspec'))
@public
@implementer(ICLISubCommand)
class Remove:
name = 'remove'
command = remove
|
