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
|
# Copyright (C) 2010-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/>.
"""REST for members."""
from __future__ import absolute_import, unicode_literals
__metaclass__ = type
__all__ = [
'AMember',
'AllMembers',
'MembersOfList',
]
from operator import attrgetter
from restish import http, resource
from urllib import quote
from zope.component import getUtility
from mailman.app.membership import delete_member
from mailman.interfaces.address import InvalidEmailAddressError
from mailman.interfaces.listmanager import NoSuchListError
from mailman.interfaces.member import (
AlreadySubscribedError, DeliveryMode, MemberRole)
from mailman.interfaces.membership import ISubscriptionService
from mailman.rest.helpers import CollectionMixin, etag, path_to
from mailman.rest.validator import Validator, enum_validator
class _MemberBase(resource.Resource, CollectionMixin):
"""Shared base class for member representations."""
def _resource_as_dict(self, member):
"""See `CollectionMixin`."""
enum, dot, role = str(member.role).partition('.')
return dict(
fqdn_listname=member.mailing_list,
address=member.address.email,
self_link=path_to('lists/{0}/{1}/{2}'.format(
member.mailing_list, role, member.address.email)),
)
def _get_collection(self, request):
"""See `CollectionMixin`."""
return list(getUtility(ISubscriptionService))
class AMember(_MemberBase):
"""A member."""
def __init__(self, mailing_list, role, address):
self._mlist = mailing_list
self._role = role
self._address = address
roster = self._mlist.get_roster(role)
self._member = roster.get_member(self._address)
@resource.GET()
def member(self, request):
"""Return a single member end-point."""
return http.ok([], self._resource_as_json(self._member))
@resource.DELETE()
def delete(self, request):
"""Delete the member (i.e. unsubscribe)."""
# Leaving a list is a bit different than deleting a moderator or
# owner. Handle the former case first. For now too, we will not send
# an admin or user notification.
if self._role is MemberRole.member:
delete_member(self._mlist, self._address, False, False)
else:
self._member.unsubscribe()
return http.ok([], '')
class AllMembers(_MemberBase):
"""The members."""
@resource.POST()
def create(self, request):
"""Create a new member."""
service = getUtility(ISubscriptionService)
try:
validator = Validator(fqdn_listname=unicode,
address=unicode,
real_name=unicode,
delivery_mode=enum_validator(DeliveryMode),
_optional=('real_name', 'delivery_mode'))
member = service.join(**validator(request))
except AlreadySubscribedError:
return http.conflict([], b'Member already subscribed')
except NoSuchListError:
return http.bad_request([], b'No such list')
except InvalidEmailAddressError:
return http.bad_request([], b'Invalid email address')
except ValueError as error:
return http.bad_request([], str(error))
# wsgiref wants headers to be bytes, not unicodes. Also, we have to
# quote any unsafe characters in the address. Specifically, we need
# to quote forward slashes, but not @-signs.
quoted_address = quote(member.address.email, safe=b'@')
location = path_to('lists/{0}/member/{1}'.format(
member.mailing_list, quoted_address))
# Include no extra headers or body.
return http.created(location, [], None)
@resource.GET()
def container(self, request):
"""/members"""
resource = self._make_collection(request)
return http.ok([], etag(resource))
class MembersOfList(_MemberBase):
"""The members of a mailing list."""
def __init__(self, mailing_list, role):
self._mlist = mailing_list
self._role = role
def _get_collection(self, request):
"""See `CollectionMixin`."""
# Overrides _MemberBase._get_collection() because we only want to
# return the members from the requested roster.
roster = self._mlist.get_roster(self._role)
address_of_member = attrgetter('address.email')
return list(sorted(roster.members, key=address_of_member))
@resource.GET()
def container(self, request):
"""roster/[members|owners|moderators]"""
resource = self._make_collection(request)
return http.ok([], etag(resource))
|
