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
|
# Copyright (C) 2010-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/>.
"""The root of the REST API."""
__all__ = [
'Root',
]
import falcon
from base64 import b64decode
from mailman.config import config
from mailman.core.constants import system_preferences
from mailman.core.system import system
from mailman.interfaces.listmanager import IListManager
from mailman.rest.addresses import AllAddresses, AnAddress
from mailman.rest.domains import ADomain, AllDomains
from mailman.rest.helpers import (
BadRequest, NotFound, child, etag, not_found, okay, path_to)
from mailman.rest.lists import AList, AllLists, Styles
from mailman.rest.members import AMember, AllMembers, FindMembers
from mailman.rest.preferences import ReadOnlyPreferences
from mailman.rest.queues import AQueue, AQueueFile, AllQueues
from mailman.rest.templates import TemplateFinder
from mailman.rest.users import AUser, AllUsers
from zope.component import getUtility
class Root:
"""The RESTful root resource.
At the root of the tree are the API version numbers. Everything else
lives underneath those. Currently there is only one API version number,
and we start at 3.0 to match the Mailman version number. That may not
always be the case though.
"""
@child(config.webservice.api_version)
def api_version(self, request, segments):
# We have to do this here instead of in a @falcon.before() handler
# because those handlers are not compatible with our custom traversal
# logic. Specifically, falcon's before/after handlers will call the
# responder, but the method we're wrapping isn't a responder, it's a
# child traversal method. There's no way to cause the thing that
# calls the before hook to follow through with the child traversal in
# the case where no error is raised.
if request.auth is None:
raise falcon.HTTPUnauthorized(
'401 Unauthorized',
'The REST API requires authentication')
if request.auth.startswith('Basic '):
# b64decode() returns bytes, but we require a str.
credentials = b64decode(request.auth[6:]).decode('utf-8')
username, password = credentials.split(':', 1)
if (username != config.webservice.admin_user or
password != config.webservice.admin_pass):
# Not authorized.
raise falcon.HTTPUnauthorized(
'401 Unauthorized',
'User is not authorized for the REST API')
return TopLevel()
class Versions:
def on_get(self, request, response):
"""/<api>/system/versions"""
resource = dict(
mailman_version=system.mailman_version,
python_version=system.python_version,
self_link=path_to('system/versions'),
)
okay(response, etag(resource))
class SystemConfiguration:
def __init__(self, section=None):
self._section = section
def on_get(self, request, response):
if self._section is None:
resource = dict(
sections=sorted(section.name for section in config))
okay(response, etag(resource))
return
missing = object()
section = getattr(config, self._section, missing)
if section is missing:
not_found(response)
return
# Sections don't have .keys(), .values(), or .items() but we can
# iterate over them.
resource = {key: section[key] for key in section}
okay(response, etag(resource))
class TopLevel:
"""Top level collections and entries."""
@child()
def system(self, request, segments):
"""/<api>/system"""
if len(segments) == 0:
# This provides backward compatibility; see /system/versions.
return Versions()
elif segments[0] == 'preferences':
if len(segments) > 1:
return BadRequest(), []
return ReadOnlyPreferences(system_preferences, 'system'), []
elif segments[0] == 'versions':
if len(segments) > 1:
return BadRequest(), []
return Versions(), []
elif segments[0] == 'configuration':
if len(segments) <= 2:
return SystemConfiguration(*segments[1:]), []
return BadRequest(), []
else:
return NotFound(), []
@child()
def addresses(self, request, segments):
"""/<api>/addresses
/<api>/addresses/<email>
"""
if len(segments) == 0:
return AllAddresses()
else:
email = segments.pop(0)
return AnAddress(email), segments
@child()
def domains(self, request, segments):
"""/<api>/domains
/<api>/domains/<domain>
"""
if len(segments) == 0:
return AllDomains()
else:
domain = segments.pop(0)
return ADomain(domain), segments
@child()
def lists(self, request, segments):
"""/<api>/lists
/<api>/lists/<list>
/<api>/lists/<list>/...
"""
if len(segments) == 0:
return AllLists()
elif len(segments) == 1 and segments[0] == 'styles':
return Styles(), []
else:
# list-id is preferred, but for backward compatibility,
# fqdn_listname is also accepted.
list_identifier = segments.pop(0)
return AList(list_identifier), segments
@child()
def members(self, request, segments):
"""/<api>/members"""
if len(segments) == 0:
return AllMembers()
# Either the next segment is the string "find" or a member id. They
# cannot collide.
segment = segments.pop(0)
if segment == 'find':
return FindMembers(), segments
else:
return AMember(segment), segments
@child()
def users(self, request, segments):
"""/<api>/users"""
if len(segments) == 0:
return AllUsers()
else:
user_id = segments.pop(0)
return AUser(user_id), segments
@child()
def templates(self, request, segments):
"""/<api>/templates/<fqdn_listname>/<template>/[<language>]
Use content negotiation to request language and suffix (content-type).
"""
if len(segments) == 3:
fqdn_listname, template, language = segments
elif len(segments) == 2:
fqdn_listname, template = segments
language = 'en'
else:
return BadRequest(), []
mlist = getUtility(IListManager).get(fqdn_listname)
if mlist is None:
return NotFound(), []
# XXX dig out content-type from request
content_type = None
return TemplateFinder(
fqdn_listname, template, language, content_type)
@child()
def queues(self, request, segments):
"""/<api>/queues[/<name>[/file]]"""
if len(segments) == 0:
return AllQueues()
elif len(segments) == 1:
return AQueue(segments[0]), []
elif len(segments) == 2:
return AQueueFile(segments[0], segments[1]), []
else:
return BadRequest(), []
|
