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
|
# 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 domains."""
from __future__ import absolute_import, unicode_literals
__metaclass__ = type
__all__ = [
'ADomain',
'AllDomains',
]
from restish import http, resource
from zope.component import getUtility
from mailman.interfaces.domain import (
BadDomainSpecificationError, IDomainManager)
from mailman.rest.helpers import CollectionMixin, etag, no_content, path_to
from mailman.rest.validator import Validator
from mailman.rest.lists import ListsForDomain
class _DomainBase(resource.Resource, CollectionMixin):
"""Shared base class for domain representations."""
def _resource_as_dict(self, domain):
"""See `CollectionMixin`."""
return dict(
base_url=domain.base_url,
contact_address=domain.contact_address,
description=domain.description,
email_host=domain.email_host,
self_link=path_to('domains/{0}'.format(domain.email_host)),
url_host=domain.url_host,
)
def _get_collection(self, request):
"""See `CollectionMixin`."""
return list(getUtility(IDomainManager))
class ADomain(_DomainBase):
"""A domain."""
def __init__(self, domain):
self._domain = domain
@resource.GET()
def domain(self, request):
"""Return a single domain end-point."""
domain = getUtility(IDomainManager).get(self._domain)
if domain is None:
return http.not_found()
return http.ok([], self._resource_as_json(domain))
@resource.DELETE()
def delete(self, request):
"""Delete the domain."""
try:
getUtility(IDomainManager).remove(self._domain)
except KeyError:
# The domain does not exist.
return http.not_found()
return no_content()
@resource.child()
def lists(self, request, segments):
"""/<api>/domains/<domain>/lists"""
if len(segments) == 0:
return ListsForDomain(self._domain)
else:
return http.bad_request()
class AllDomains(_DomainBase):
"""The domains."""
@resource.POST()
def create(self, request):
"""Create a new domain."""
domain_manager = getUtility(IDomainManager)
try:
validator = Validator(email_host=unicode,
description=unicode,
base_url=unicode,
contact_address=unicode,
_optional=('description', 'base_url',
'contact_address'))
domain = domain_manager.add(**validator(request))
except BadDomainSpecificationError:
return http.bad_request([], b'Domain exists')
except ValueError as error:
return http.bad_request([], str(error))
location = path_to('domains/{0}'.format(domain.email_host))
# Include no extra headers or body.
return http.created(location, [], None)
@resource.GET()
def collection(self, request):
"""/domains"""
resource = self._make_collection(request)
return http.ok([], etag(resource))
|
