diff options
Diffstat (limited to 'src/mailman/rest/moderation.py')
| -rw-r--r-- | src/mailman/rest/moderation.py | 179 |
1 files changed, 158 insertions, 21 deletions
diff --git a/src/mailman/rest/moderation.py b/src/mailman/rest/moderation.py index 7075a75be..8fc519996 100644 --- a/src/mailman/rest/moderation.py +++ b/src/mailman/rest/moderation.py @@ -23,13 +23,16 @@ __metaclass__ = type __all__ = [ 'HeldMessage', 'HeldMessages', + 'MembershipChangeRequest', + 'SubscriptionRequests', ] from restish import http, resource from zope.component import getUtility -from mailman.app.moderator import handle_message +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 @@ -37,8 +40,68 @@ 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 HeldMessage(resource.Resource, CollectionMixin): +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): @@ -47,22 +110,13 @@ class HeldMessage(resource.Resource, CollectionMixin): @resource.GET() def details(self, request): - 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: + resource = self._make_resource(request_id) + if resource is None: return http.not_found() - key, data = results - msg = getUtility(IMessageStore).get_message_by_id(key) - resource = dict( - key=key, - data=data, - msg=msg.as_string(), - id=request_id, - ) return http.ok([], etag(resource)) @resource.POST() @@ -85,20 +139,16 @@ class HeldMessage(resource.Resource, CollectionMixin): -class HeldMessages(resource.Resource, CollectionMixin): +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, req): + def _resource_as_dict(self, request): """See `CollectionMixin`.""" - key, data = self._requests.get_request(req.id) - return dict( - key=key, - data=data, - id=req.id, - ) + return self._make_resource(request.id) def _get_collection(self, request): requests = IListRequests(self._mlist) @@ -108,9 +158,96 @@ class HeldMessages(resource.Resource, CollectionMixin): @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']) |