Peler

: / opt / cpanel-ccs / txdav / who /
Filename : xml.py
back
# -*- test-case-name: txdav.who.test.test_xml -*-
##
# Copyright (c) 2014-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.
##

from __future__ import print_function
from __future__ import absolute_import

"""
Calendar and contacts directory extentions to L{twext.who.xml}.

Example:

    <directory realm="Test Realm">
      <record type="location">
        <uid>__wsanchez_office__</uid>
        <short-name>Wilfredo Sanchez' Office</short-name>
        <service-node>Node B</service-node> <!-- unicode -->
        <auto-accept-group>__wsanchez_staff__</auto-accept-group> <!-- UID of group -->
        <login-allowed><true /></login-allowed>
        <has-calendars><true /></has-calendars>
        <has-contacts><true /></has-contacts>
        <auto-schedule-mode><accept-if-free-decline-if-busy /></auto-schedule-mode>
      </record>
    </directory>
"""

__all__ = [
    "DirectoryService",
]

from twisted.python.constants import Values, ValueConstant

from twext.who.xml import DirectoryService as BaseDirectoryService
from twext.who.util import ConstantsContainer

from .idirectory import RecordType, FieldName, AutoScheduleMode


#
# XML constants
#

class Element(Values):
    """
    XML calendar and contacts element names.
    """

    # Provisioning fields

    serviceNodeUID = ValueConstant(u"service-node")
    serviceNodeUID.fieldName = FieldName.serviceNodeUID

    loginAllowed = ValueConstant(u"login-allowed")
    loginAllowed.fieldName = FieldName.loginAllowed

    hasCalendars = ValueConstant(u"has-calendars")
    hasCalendars.fieldName = FieldName.hasCalendars

    hasContacts = ValueConstant(u"has-contacts")
    hasContacts.fieldName = FieldName.hasContacts

    # Auto-schedule fields

    autoScheduleMode = ValueConstant(u"auto-schedule-mode")
    autoScheduleMode.fieldName = FieldName.autoScheduleMode

    autoAcceptGroup = ValueConstant(u"auto-accept-group")
    autoAcceptGroup.fieldName = FieldName.autoAcceptGroup

    # Auto-schedule modes

    none = ValueConstant(u"none")
    none.constantValue = AutoScheduleMode.none

    accept = ValueConstant(u"accept")
    accept.constantValue = AutoScheduleMode.accept

    decline = ValueConstant(u"decline")
    decline.constantValue = AutoScheduleMode.decline

    acceptIfFree = ValueConstant(u"accept-if-free")
    acceptIfFree.constantValue = AutoScheduleMode.acceptIfFree

    declineIfBusy = ValueConstant(u"decline-if-busy")
    declineIfBusy.constantValue = AutoScheduleMode.declineIfBusy

    acceptIfFreeDeclineIfBusy = ValueConstant(
        u"accept-if-free-decline-if-busy"
    )
    acceptIfFreeDeclineIfBusy.constantValue = (
        AutoScheduleMode.acceptIfFreeDeclineIfBusy
    )

    # For "locations", i.e., scheduled spaces:

    capacity = ValueConstant(u"capacity")
    capacity.fieldName = FieldName.capacity

    floor = ValueConstant(u"floor")
    floor.fieldName = FieldName.floor

    associatedAddress = ValueConstant(u"associated-address")
    associatedAddress.fieldName = FieldName.associatedAddress

    # For "addresses", i.e., non-scheduled areas containing locations:

    abbreviatedName = ValueConstant(u"abbreviated-name")
    abbreviatedName.fieldName = FieldName.abbreviatedName

    streetAddress = ValueConstant(u"street-address")
    streetAddress.fieldName = FieldName.streetAddress

    geographicLocation = ValueConstant(u"geographic-location")
    geographicLocation.fieldName = FieldName.geographicLocation


class Attribute(Values):
    """
    XML calendar and contacts attribute names.
    """


class RecordTypeValue(Values):
    """
    XML attribute values for calendar and contacts record types.
    """

    location = ValueConstant(u"location")
    location.recordType = RecordType.location

    resource = ValueConstant(u"resource")
    resource.recordType = RecordType.resource

    address = ValueConstant(u"address")
    address.recordType = RecordType.address


#
# Directory Service
#

class DirectoryService(BaseDirectoryService):
    """
    XML directory service with calendar and contacts data.
    """

    recordType = ConstantsContainer(
        (BaseDirectoryService.recordType, RecordType)
    )

    # MOVE2WHO: Wilfredo had added augment fields into xml, which does make
    # some sense, but for backwards compatibility right now I will take those
    # out, and rely on a separate augment service

    # fieldName = ConstantsContainer(
    #     (BaseDirectoryService.fieldName, FieldName)
    # )

    # XML schema constants

    element = ConstantsContainer(
        (BaseDirectoryService.element, Element)
    )

    attribute = ConstantsContainer(
        (BaseDirectoryService.attribute, Attribute)
    )

    recordTypeValue = ConstantsContainer(
        (BaseDirectoryService.recordTypeValue, RecordTypeValue)
    )

    xmlFieldOrder = BaseDirectoryService.xmlFieldOrder + (
        FieldName.capacity,
        FieldName.floor,
        FieldName.associatedAddress,
        FieldName.abbreviatedName,
        FieldName.streetAddress,
        FieldName.geographicLocation,
    )