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
|
# Copyright (C) 2016-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/>.
"""REST for banned emails."""
from mailman.interfaces.bans import IBanManager
from mailman.rest.helpers import (
CollectionMixin, bad_request, child, created, etag, no_content, not_found,
okay)
from mailman.rest.validator import Validator
from public import public
class _BannedBase:
"""Common base class."""
def __init__(self, mlist):
self._mlist = mlist
self.ban_manager = IBanManager(self._mlist)
def _location(self, email):
if self._mlist is None:
base_location = ''
else:
base_location = 'lists/{}/'.format(self._mlist.list_id)
return self.api.path_to('{}bans/{}'.format(base_location, email))
@public
class BannedEmail(_BannedBase):
"""A banned email."""
def __init__(self, mlist, email):
super().__init__(mlist)
self._email = email
def on_get(self, request, response):
"""Get a banned email."""
if self.ban_manager.is_banned(self._email):
resource = dict(
email=self._email,
self_link=self._location(self._email),
)
if self._mlist is not None:
resource['list_id'] = self._mlist.list_id
okay(response, etag(resource))
else:
not_found(response, 'Email is not banned: {}'.format(self._email))
def on_delete(self, request, response):
"""Remove an email from the ban list."""
if self.ban_manager.is_banned(self._email):
self.ban_manager.unban(self._email)
no_content(response)
else:
not_found(response, 'Email is not banned: {}'.format(self._email))
@public
class BannedEmails(_BannedBase, CollectionMixin):
"""The list of all banned emails."""
def _resource_as_dict(self, ban):
"""See `CollectionMixin`."""
resource = dict(
email=ban.email,
self_link=self._location(ban.email),
)
if ban.list_id is not None:
resource['list_id'] = ban.list_id
return resource
def _get_collection(self, request):
"""See `CollectionMixin`."""
return self.ban_manager.bans
def on_get(self, request, response):
"""/bans"""
resource = self._make_collection(request)
okay(response, etag(resource))
def on_post(self, request, response):
"""Ban some email from subscribing."""
validator = Validator(email=str)
try:
email = validator(request)['email']
except ValueError as error:
bad_request(response, str(error))
return
if self.ban_manager.is_banned(email):
bad_request(response, b'Address is already banned')
else:
self.ban_manager.ban(email)
created(response, self._location(email))
@child(r'^(?P<email>[^/]+)')
def email(self, context, segments, **kw):
return BannedEmail(self._mlist, kw['email'])
|
