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
|
# Copyright (C) 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 addresses."""
from __future__ import absolute_import, unicode_literals
__metaclass__ = type
__all__ = [
'AllAddresses',
'AnAddress',
'UserAddresses',
]
from operator import attrgetter
from restish import http, resource
from zope.component import getUtility
from mailman.rest.helpers import CollectionMixin, etag, path_to
from mailman.rest.members import MemberCollection
from mailman.rest.preferences import Preferences
from mailman.interfaces.usermanager import IUserManager
class _AddressBase(resource.Resource, CollectionMixin):
"""Shared base class for address representations."""
def _resource_as_dict(self, address):
"""See `CollectionMixin`."""
# The canonical url for an address is its lower-cased version,
# although it can be looked up with either its original or lower-cased
# email address.
representation = dict(
email=address.email,
original_email=address.original_email,
registered_on=address.registered_on,
self_link=path_to('addresses/{0}'.format(address.email)),
)
# Add optional attributes. These can be None or the empty string.
if address.real_name:
representation['real_name'] = address.real_name
if address.verified_on:
representation['verified_on'] = address.verified_on
return representation
def _get_collection(self, request):
"""See `CollectionMixin`."""
return list(getUtility(IUserManager).addresses)
class AllAddresses(_AddressBase):
"""The addresses."""
@resource.GET()
def collection(self, request):
"""/addresses"""
resource = self._make_collection(request)
return http.ok([], etag(resource))
class AnAddress(_AddressBase):
"""An address."""
def __init__(self, email):
"""Get an address by either its original or lower-cased email.
:param email: The email address of the `IAddress`.
:type email: string
"""
self._address = getUtility(IUserManager).get_address(email)
@resource.GET()
def address(self, request):
"""Return a single address."""
if self._address is None:
return http.not_found()
return http.ok([], self._resource_as_json(self._address))
@resource.child()
def memberships(self, request, segments):
"""/addresses/<email>/memberships"""
if len(segments) != 0:
return http.bad_request()
if self._address is None:
return http.not_found()
return AddressMemberships(self._address)
@resource.child()
def preferences(self, request, segments):
"""/addresses/<email>/preferences"""
if len(segments) != 0:
return http.bad_request()
if self._address is None:
return http.not_found()
child = Preferences(
self._address.preferences,
'addresses/{0}'.format(self._address.email))
return child, []
class UserAddresses(_AddressBase):
"""The addresses of a user."""
def __init__(self, user):
self._user = user
super(UserAddresses, self).__init__()
def _get_collection(self, request):
"""See `CollectionMixin`."""
return sorted(self._user.addresses,
key=attrgetter('original_email'))
@resource.GET()
def collection(self, request):
"""/addresses"""
resource = self._make_collection(request)
return http.ok([], etag(resource))
class AddressMemberships(MemberCollection):
"""All the memberships of a particular email address."""
def __init__(self, address):
super(AddressMemberships, self).__init__()
self._address = address
def _get_collection(self, request):
"""See `CollectionMixin`."""
# XXX Improve this by implementing a .memberships attribute on
# IAddress, similar to the way IUser does it.
#
# Start by getting the IUser that controls this address. For now, if
# the address is not controlled by a user, return the empty set.
# Later when we address the XXX comment, it will return some
# memberships. But really, it should not be legal to subscribe an
# address to a mailing list that isn't controlled by a user -- maybe!
user = getUtility(IUserManager).get_user(self._address.email)
if user is None:
return []
return [member for member in user.memberships.members
if member.address == self._address]
|
