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
|
# Copyright (C) 2012-2014 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 API for Message moderation."""
from __future__ import absolute_import, print_function, unicode_literals
__metaclass__ = type
__all__ = [
'HeldMessage',
'HeldMessages',
'MembershipChangeRequest',
'SubscriptionRequests',
]
from restish import http, resource
from zope.component import getUtility
from mailman.app.moderator import (
handle_message, handle_subscription, handle_unsubscription)
from mailman.interfaces.action import Action
from mailman.interfaces.messages import IMessageStore
from mailman.interfaces.requests import IListRequests, RequestType
from mailman.rest.helpers import CollectionMixin, etag, no_content
from mailman.rest.validator import Validator, enum_validator
HELD_MESSAGE_REQUESTS = (RequestType.held_message,)
MEMBERSHIP_CHANGE_REQUESTS = (RequestType.subscription,
RequestType.unsubscription)
class _ModerationBase:
"""Common base class."""
def _make_resource(self, request_id, expected_request_types):
requests = IListRequests(self._mlist)
results = requests.get_request(request_id)
if results is None:
return None
key, data = results
resource = dict(key=key, request_id=request_id)
# Flatten the IRequest payload into the JSON representation.
resource.update(data)
# Check for a matching request type, and insert the type name into the
# resource.
request_type = RequestType[resource.pop('_request_type')]
if request_type not in expected_request_types:
return None
resource['type'] = request_type.name
# This key isn't what you think it is. Usually, it's the Pendable
# record's row id, which isn't helpful at all. If it's not there,
# that's fine too.
resource.pop('id', None)
return resource
class _HeldMessageBase(_ModerationBase):
"""Held messages are a little different."""
def _make_resource(self, request_id):
resource = super(_HeldMessageBase, self)._make_resource(
request_id, HELD_MESSAGE_REQUESTS)
if resource is None:
return None
# Grab the message and insert its text representation into the
# resource. XXX See LP: #967954
key = resource.pop('key')
msg = getUtility(IMessageStore).get_message_by_id(key)
resource['msg'] = msg.as_string()
# Some of the _mod_* keys we want to rename and place into the JSON
# resource. Others we can drop. Since we're mutating the dictionary,
# we need to make a copy of the keys. When you port this to Python 3,
# you'll need to list()-ify the .keys() dictionary view.
for key in resource.keys():
if key in ('_mod_subject', '_mod_hold_date', '_mod_reason',
'_mod_sender', '_mod_message_id'):
resource[key[5:]] = resource.pop(key)
elif key.startswith('_mod_'):
del resource[key]
# Also, held message resources will always be this type, so ignore
# this key value.
del resource['type']
return resource
class HeldMessage(_HeldMessageBase, resource.Resource):
"""Resource for moderating a held message."""
def __init__(self, mlist, request_id):
self._mlist = mlist
self._request_id = request_id
@resource.GET()
def details(self, request):
try:
request_id = int(self._request_id)
except ValueError:
return http.bad_request()
resource = self._make_resource(request_id)
if resource is None:
return http.not_found()
return http.ok([], etag(resource))
@resource.POST()
def moderate(self, request):
try:
validator = Validator(action=enum_validator(Action))
arguments = validator(request)
except ValueError as error:
return http.bad_request([], str(error))
requests = IListRequests(self._mlist)
try:
request_id = int(self._request_id)
except ValueError:
return http.bad_request()
results = requests.get_request(request_id, RequestType.held_message)
if results is None:
return http.not_found()
handle_message(self._mlist, request_id, **arguments)
return no_content()
class HeldMessages(_HeldMessageBase, resource.Resource, CollectionMixin):
"""Resource for messages held for moderation."""
def __init__(self, mlist):
self._mlist = mlist
self._requests = None
def _resource_as_dict(self, request):
"""See `CollectionMixin`."""
return self._make_resource(request.id)
def _get_collection(self, request):
requests = IListRequests(self._mlist)
self._requests = requests
return list(requests.of_type(RequestType.held_message))
@resource.GET()
def requests(self, request):
"""/lists/listname/held"""
# `request` is a restish.http.Request object.
resource = self._make_collection(request)
return http.ok([], etag(resource))
@resource.child('{id}')
def message(self, request, segments, **kw):
return HeldMessage(self._mlist, kw['id'])
class MembershipChangeRequest(resource.Resource, _ModerationBase):
"""Resource for moderating a membership change."""
def __init__(self, mlist, request_id):
self._mlist = mlist
self._request_id = request_id
@resource.GET()
def details(self, request):
try:
request_id = int(self._request_id)
except ValueError:
return http.bad_request()
resource = self._make_resource(request_id, MEMBERSHIP_CHANGE_REQUESTS)
if resource is None:
return http.not_found()
# Remove unnecessary keys.
del resource['key']
return http.ok([], etag(resource))
@resource.POST()
def moderate(self, request):
try:
validator = Validator(action=enum_validator(Action))
arguments = validator(request)
except ValueError as error:
return http.bad_request([], str(error))
requests = IListRequests(self._mlist)
try:
request_id = int(self._request_id)
except ValueError:
return http.bad_request()
results = requests.get_request(request_id)
if results is None:
return http.not_found()
key, data = results
try:
request_type = RequestType[data['_request_type']]
except ValueError:
return http.bad_request()
if request_type is RequestType.subscription:
handle_subscription(self._mlist, request_id, **arguments)
elif request_type is RequestType.unsubscription:
handle_unsubscription(self._mlist, request_id, **arguments)
else:
return http.bad_request()
return no_content()
class SubscriptionRequests(
_ModerationBase, resource.Resource, CollectionMixin):
"""Resource for membership change requests."""
def __init__(self, mlist):
self._mlist = mlist
self._requests = None
def _resource_as_dict(self, request):
"""See `CollectionMixin`."""
resource = self._make_resource(request.id, MEMBERSHIP_CHANGE_REQUESTS)
# Remove unnecessary keys.
del resource['key']
return resource
def _get_collection(self, request):
requests = IListRequests(self._mlist)
self._requests = requests
items = []
for request_type in MEMBERSHIP_CHANGE_REQUESTS:
for request in requests.of_type(request_type):
items.append(request)
return items
@resource.GET()
def requests(self, request):
"""/lists/listname/requests"""
# `request` is a restish.http.Request object.
resource = self._make_collection(request)
return http.ok([], etag(resource))
@resource.child('{id}')
def subscription(self, request, segments, **kw):
return MembershipChangeRequest(self._mlist, kw['id'])
|
