summaryrefslogtreecommitdiff
path: root/src/mailman/rest/configuration.py
blob: af1f90551379b320e884548a9dcfcdfa7b7410f4 (plain)
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
# Copyright (C) 2009 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/>.

"""Mailman admin web service configuration."""

from __future__ import absolute_import, unicode_literals

__metaclass__ = type
__all__ = [
    'AdminWebServiceConfiguration',
    ]


from lazr.restful.interfaces import IWebServiceConfiguration
from zope.interface import implements

from mailman import version
from mailman.config import config
from mailman.rest.publication import AdminWebServicePublication
from mailman.rest.root import AdminWebServiceRootResource



class AdminWebServiceConfiguration:
    """A configuration object for the Mailman admin web service."""

    implements(IWebServiceConfiguration)

    @property
    def view_permission(self):
        if config.webservice.view_permission.lower() == 'none':
            return None
        return config.webservice.view_permission

    path_override = None

    @property
    def use_https(self):
        """See `IWebServiceConfiguration`."""
        return config.webservice.use_https

    # This should match the major.minor Mailman version.
    service_version_uri_prefix = '{0.MAJOR_REV}.{0.MINOR_REV}'.format(version)
    code_revision = version.VERSION

    @property
    def show_tracebacks(self):
        """See `IWebServiceConfiguration`."""
        return config.webservice.show_tracebacks
        
    default_batch_size = 50
    max_batch_size = 300

    ## # XXX What's this for?
    ## def createRequest(self, body_instream, environ):
    ##     """See `IWebServiceConfiguration`."""
    ##     request = AdminWebServiceRequest(body_instream, environ)
    ##     request.setPublication(
    ##         AdminWebServicePublication(AdminWebServiceRootResource()))
    ##     return request

    def get_request_user(self):
        """See `IWebServiceConfiguration`."""
        return None