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
|
# Copyright (C) 2010-2012 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."""
from __future__ import absolute_import, unicode_literals
__metaclass__ = type
__all__ = [
'Root',
]
from base64 import b64decode
from restish import guard, http, resource
from mailman.config import config
from mailman.core.constants import system_preferences
from mailman.core.system import system
from mailman.rest.addresses import AllAddresses, AnAddress
from mailman.rest.domains import ADomain, AllDomains
from mailman.rest.helpers import etag, path_to
from mailman.rest.lists import AList, AllLists
from mailman.rest.members import AMember, AllMembers, FindMembers
from mailman.rest.preferences import ReadOnlyPreferences
from mailman.rest.users import AUser, AllUsers
def webservice_auth_checker(request, obj):
auth = request.environ.get('HTTP_AUTHORIZATION', '')
if auth.startswith('Basic '):
credentials = b64decode(auth[6:])
username, password = credentials.split(':', 1)
if (username != config.webservice.admin_user or
password != config.webservice.admin_pass):
# Not authorized.
raise guard.GuardError(b'User is not authorized for the REST API')
else:
raise guard.GuardError(b'The REST API requires authentication')
class Root(resource.Resource):
"""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.
"""
@resource.child(config.webservice.api_version)
@guard.guard(webservice_auth_checker)
def api_version(self, request, segments):
return TopLevel()
class TopLevel(resource.Resource):
"""Top level collections and entries."""
@resource.child()
def system(self, request, segments):
"""/<api>/system"""
if len(segments) == 0:
resource = dict(
mailman_version=system.mailman_version,
python_version=system.python_version,
self_link=path_to('system'),
)
elif len(segments) > 1:
return http.bad_request()
elif segments[0] == 'preferences':
return ReadOnlyPreferences(system_preferences, 'system'), []
else:
return http.bad_request()
return http.ok([], etag(resource))
@resource.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
@resource.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
@resource.child()
def lists(self, request, segments):
"""/<api>/lists
/<api>/lists/<list>
/<api>/lists/<list>/...
"""
if len(segments) == 0:
return AllLists()
else:
list_name = segments.pop(0)
return AList(list_name), segments
@resource.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
@resource.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
|
