Peler

: / opt / cpanel-ccs / calendarserver / webadmin /
Filename : config.py
back
# -*- test-case-name: calendarserver.webadmin.test.test_landing -*-
##
# Copyright (c) 2009-2017 Apple Inc. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
##

"""
Calendar Server Configuration UI.
"""

__all__ = [
    "ConfigurationResource",
]

from twisted.web.template import renderer, tags as html

from twext.python.log import Logger

from .resource import PageElement, TemplateResource

log = Logger()


class ConfigurationPageElement(PageElement):
    """
    Configuration management page element.
    """

    def __init__(self, configuration):
        super(ConfigurationPageElement, self).__init__(u"config")

        self.configuration = configuration

    def pageSlots(self):
        slots = {
            u"title": u"Server Configuration",
        }

        for key in (
            "ServerHostName",
            "HTTPPort",
            "SSLPort",
            "BindAddresses",
            "BindHTTPPorts",
            "BindSSLPorts",
            "EnableSSL",
            "RedirectHTTPToHTTPS",
            "SSLCertificate",
            "SSLPrivateKey",
            "SSLAuthorityChain",
            "SSLKeychainIdentity",
            "SSLMethod",
            "SSLCiphers",
            "EnableCalDAV",
            "EnableCardDAV",
            "ServerRoot",
            "EnableSSL",
            "UserQuota",
            "MaxCollectionsPerHome",
            "MaxResourcesPerCollection",
            "MaxResourceSize",
            "UserName",
            "GroupName",
            "ProcessType",
            "MultiProcess.MinProcessCount",
            "MultiProcess.ProcessCount",
            "MaxRequests",
        ):
            value = self.configuration

            for subkey in key.split("."):
                value = getattr(value, subkey)

            def describe(value):
                if value == u"":
                    return u"(empty string)"

                if value is None:
                    return u"(no value)"

                if isinstance(value, str):
                    value = value.decode("utf-8")

                return html.code(unicode(value))

            if isinstance(value, list):
                if len(value) == 0:
                    result = u"(empty list)"
                else:
                    result = []
                    for item in value:
                        result.append(describe(item))
                        result.append(html.br())
                    result.pop()

            else:
                result = describe(value)

            slots[key] = result

        return slots

    @renderer
    def settings_header(self, request, tag):
        return tag(
            html.tr(
                html.th(u"Option"),
                html.th(u"Value"),
                html.th(u"Note"),
            ),
        )

    @renderer
    def log_level_row(self, request, tag):
        def rowsForNamespaces(namespaces):
            for namespace in namespaces:
                if namespace is None:
                    name = u"(default)"
                else:
                    name = html.code(namespace)

                value = html.code(
                    log.levels().logLevelForNamespace(
                        namespace
                    ).name
                )

                yield tag.clone().fillSlots(
                    log_level_name=name,
                    log_level_value=value,
                )

        # FIXME: Using private attributes is bad.
        namespaces = log.levels()._logLevelsByNamespace.keys()

        return rowsForNamespaces(namespaces)


class ConfigurationResource(TemplateResource):
    """
    Configuration management page resource.
    """

    addSlash = False

    def __init__(self, configuration, principalCollections):
        super(ConfigurationResource, self).__init__(
            lambda: ConfigurationPageElement(configuration), principalCollections, isdir=False
        )