# SPDX-FileCopyrightText: 2004-2025 Univention GmbH
# SPDX-License-Identifier: AGPL-3.0-only
"""|UDM| module for syntax objects"""
import univention.admin.filter
import univention.admin.handlers
import univention.admin.localization
from univention.admin.layout import Group, Tab
translation = univention.admin.localization.translation('univention.admin.handlers.settings')
_ = translation.translate
module = 'settings/syntax'
superordinate = 'settings/cn'
childs = False
operations = ['add', 'edit', 'remove', 'search', 'move']
short_description = _('Settings: Syntax Definition')
object_name = _('Syntax Definition')
object_name_plural = _('Syntax Definitions')
long_description = ''
# fmt: off
options = {
'default': univention.admin.option(
short_description=short_description,
default=True,
objectClasses=['top', 'univentionSyntax'],
),
}
property_descriptions = {
'name': univention.admin.property(
short_description=_('Syntax Name'),
long_description='',
syntax=univention.admin.syntax.string,
include_in_default_search=True,
required=True,
identifies=True,
),
'description': univention.admin.property(
short_description=_('Syntax Description'),
long_description='',
syntax=univention.admin.syntax.string,
include_in_default_search=True,
),
'filter': univention.admin.property(
short_description=_('LDAP Search Filter'),
long_description='',
syntax=univention.admin.syntax.string,
required=True,
),
'base': univention.admin.property(
short_description=_('LDAP Base'),
long_description='',
syntax=univention.admin.syntax.ldapDn,
),
'attribute': univention.admin.property(
short_description=_('Displayed Attributes'),
long_description='',
# syntax = univention.admin.syntax.UDM_PropertySelect,
syntax=univention.admin.syntax.listAttributes,
multivalue=True,
include_in_default_search=True,
),
'ldapattribute': univention.admin.property(
short_description=_('Displayed LDAP Attributes'),
long_description='',
syntax=univention.admin.syntax.string,
multivalue=True,
),
'viewonly': univention.admin.property(
short_description=_('Show Only'),
long_description='',
syntax=univention.admin.syntax.TrueFalseUp,
),
'addEmptyValue': univention.admin.property(
short_description=_('Add an empty value to choice list'),
long_description='',
syntax=univention.admin.syntax.TrueFalseUp,
),
'value': univention.admin.property(
short_description=_('Stored Attribute'),
long_description='',
# syntax = univention.admin.syntax.UDM_PropertySelect,
syntax=univention.admin.syntax.listAttributes,
include_in_default_search=True,
),
'ldapvalue': univention.admin.property(
short_description=_('Stored LDAP Attribute'),
long_description='',
syntax=univention.admin.syntax.string,
),
}
layout = [
Tab(_('General'), _('Basic values'), layout=[
Group(_('General syntax definition settings'), layout=[
["name", "description"],
["filter", "base"]]),
Group(_('Display'), layout=[
"attribute",
"ldapattribute"]),
Group(_('Storage'), layout=[
"value",
"ldapvalue"]),
Group(_('Options'), layout=[
"viewonly",
"addEmptyValue"]),
]),
]
mapping = univention.admin.mapping.mapping()
mapping.register('name', 'cn', None, univention.admin.mapping.ListToString)
mapping.register('filter', 'univentionSyntaxLDAPFilter', None, univention.admin.mapping.ListToString, encoding='ASCII')
mapping.register('base', 'univentionSyntaxLDAPBase', None, univention.admin.mapping.ListToString, encoding='ASCII')
mapping.register('viewonly', 'univentionSyntaxViewOnly', None, univention.admin.mapping.ListToString, encoding='ASCII')
mapping.register('description', 'univentionSyntaxDescription', None, univention.admin.mapping.ListToString)
mapping.register('addEmptyValue', 'univentionSyntaxAddEmptyValue', None, univention.admin.mapping.ListToString)
# fmt: on
[docs]
class object(univention.admin.handlers.simpleLdap):
module = module
def __check(self):
if self.info.get('viewonly', 'FALSE') == 'FALSE' and not (self['value'] or self['ldapvalue']):
raise univention.admin.uexceptions.insufficientInformation(_('An LDAP attribute is required of which the information will be stored.'))
[docs]
def open(self):
univention.admin.handlers.simpleLdap.open(self)
if self.exists():
# initialize items
self['attribute'] = []
self['ldapattribute'] = []
self['value'] = ''
self['ldapvalue'] = ''
# split ldap attribute value into two parts and add them to separate dir manager widgets
for item in self.oldattr.get('univentionSyntaxLDAPAttribute', []):
if b':' in item:
self['attribute'].append(item.decode('ASCII'))
else:
self['ldapattribute'].append(item.decode('ASCII'))
# set attribute name of value that shall be written to LDAP
# WARNING: drop down box is only used if string is not set
val = self.oldattr.get('univentionSyntaxLDAPValue', [b''])[0].decode('ASCII')
if val and ':' in val:
self['value'] = val
else:
self['ldapvalue'] = val
self.save()
def _ldap_pre_create(self):
self.__check()
super()._ldap_pre_create()
def _ldap_pre_modify(self):
super()._ldap_pre_modify()
self.__check()
def _ldap_modlist(self):
ml = univention.admin.handlers.simpleLdap._ldap_modlist(self)
attr = [val.encode('ASCII') for prop in ('attribute', 'ldapattribute') for val in self[prop]]
ml.append(('univentionSyntaxLDAPAttribute', self.oldattr.get('univentionSyntaxLDAPAttribute', []), attr))
val = self['ldapvalue'] or self['value']
ml.append(('univentionSyntaxLDAPValue', self.oldattr.get('univentionSyntaxLDAPValue', []), [val.encode('ASCII')]))
return ml
lookup = object.lookup
lookup_filter = object.lookup_filter
identify = object.identify
