Attachment #3039 for bug #17915

(-)schema/ip-phone.schema (-1 / +5 lines)

Lines 1-4	Link Here

# univention registered the namespace 10176.

# univention registered the namespace 10176.

#objectIdentifier univention 1.3.6.1.4.1.10176

#objectIdentifier univentionCustomers univention:99999

#objectIdentifier univentionExampleAttributeType univentionCustomers:1

#objectIdentifier univentionExampleObjectClass univentionCustomers:2

attributetype ( 1.3.6.1.4.1.10176.9999.1.1 NAME 'testPhoneActive'

attributetype ( 1.3.6.1.4.1.10176.9999.1.1 NAME 'testPhoneActive'

	DESC 'state of the IP phone'

	DESC 'state of the IP phone'

	EQUALITY caseIgnoreIA5Match

	EQUALITY caseIgnoreIA5Match

Lines 42-45	Link Here

	MUST ( cn )

	MUST ( cn )

	MAY ( testPhoneRedirectUser )

	MAY ( testPhoneRedirectUser )

(-)debian/univention-directory-manager-module-example-schema.postrm (+4 lines)

Lines 36-44	Link Here

case "$1" in

case "$1" in

remove)

remove)

	case "$(/usr/sbin/univention-config-registry get server/role)" in

	domaincontroller_master)

	/usr/sbin/univention-config-registry commit /etc/ldap/slapd.conf

	/usr/sbin/univention-config-registry commit /etc/ldap/slapd.conf

	invoke-rc.d slapd restart

	invoke-rc.d slapd restart

;;

;;

	esac

;;

purge|upgrade|failed-upgrade|abort-install|abort-upgrade|disappear)

purge|upgrade|failed-upgrade|abort-install|abort-upgrade|disappear)

;;

;;




univention-directory-manager-module-example (2.0.5-1) unstable; urgency=low

  * Prepare for translation (Bug #17915)
  * Restart slapd only on domaincontroller_master.
  * Fix unicode strings.
  * Add missing DocString to exists() and _remove_attr().
  * Document advanced=True.
  * Use True and False instead of 1 and 0.

 -- Philipp Hahn <hahn@univention.de>  Wed, 16 Feb 2011 07:59:08 +0100

univention-directory-manager-module-example (2.0.4-1) unstable; urgency=low

  * suggestions from QA feedback (Bug #17915)




# /usr/share/common-licenses/AGPL-3; if not, see
# <http://www.gnu.org/licenses/>.

import re
import copy
import univention.admin.filter		# Definiert Filterausdruck-Objekt für 'lookup' Funktion unten
import univention.admin.handlers	# Enthält simpleLdap, die Basisklasse für 'object' unten
import univention.admin.syntax		# Liefert standard Syntax-Definitionen für die UDM 'property_descriptions' unten

# Für das Einbinden von Übersetzungskatalogen für verschiedene Sprachen
translation=univention.admin.localization.translation('univention.admin.handlers.test')
_=translation.translate



	## die Liste der Auswahlmöglichkeiten: Jedes der Elemente enthält einen eindeutigen Schlüssel
	## und den anzuzeigenden Text
	choices = [('sip', _(u'SIP')), ('h323', _(u'H.323')), ('skype', _(u'Skype'))]

class SynVoIP_Address(univention.admin.syntax.simple):
	"""Diese Klasse dient als Syntax für VoIP Adresse. Der Aufbau ist einer E-Mail Adresse ähnlich,

	def parse(self, text):
		if self._re.match(text) != None:
			return text
		raise univention.admin.uexceptions.valueError(_(u'Not a valid VoIP Address'))


############################ </Syntax definitions> ############################

## dieses Objekt kann keine Unterobjekte enthalten
childs = 0
## ein sprechender Name für das Web-Frontend
short_description = _(u'IP-Phone')
## eine ausführliche Beschreibung
long_description = _(u'An example module for the Univention Directory Manager')
## die LDAP Operationen, die auf diesem Objekt ausgeführt werden können
operations=['add','edit','remove','search','move']


##### Um einen eigenen Wizard zu erstellen, der im UDM-Web links in der Navigationsleiste erscheint:
## usewizard = 1
## wizardmenustring = "VoIP"
## wizarddescription =  _(u"Add, delete and search VoIP objects"
## wizardoperations = { 'add' : [_(u"add"), _(u"Add an VoIP object")],
##                    'find' : [_(u"Search"), _(u"Search VoIP objects"]) }
## wizardpath="univentionUsersObject"

############################ <UDM module options> #############################

	# durch 'options' werden optionale Eigenschaften eines Objekts definiert
	'redirection': univention.admin.option(
			short_description=_('Call redirect option'),
			default=True,
			editable=True,
			objectClasses = ['testPhoneCallRedirect'],
		)
}

property_descriptions={
	# der eindeutige Name eines IP-Telefons
	'name': univention.admin.property(
			short_description=_(u'Name'),
			long_description=_(u'ID of the IP-phone'),
			syntax=univention.admin.syntax.hostName,	# Eigenschaft muss der Syntax eines Rechnernamens entsprechen, Def. in syntax.py
			multivalue=False,
			options=[],
			required=True,								# Eigenschaft muss angegeben werden
			may_change=False,							# Eigenschaft darf nach Erstellung nicht verändert werden
			identifies=True								# Eigenschaft muss eindeutig sein
		),
	#
	'active': univention.admin.property(
			short_description=_(u'active'),
			long_description=_(u'The IP-phone can be deactivated'),
			syntax=univention.admin.syntax.boolean,		# kann nur die Werte '1' oder '0' annehmen, Definition in syntax.py
			multivalue=False,
			options=[],
			required=False,								# Eigenschaft muss nicht zwingend angegeben werden
			default='1',								# Eigenschaft ist standardmäßig aktiviert
			may_change=True,							# Eigenschaft darf modifiziert werden
			identifies=False
		),
	'protocol': univention.admin.property(
			short_description=_(u'Protocol'),
			long_description=_(u'Supported VoIP protocols'),
			syntax=SynVoIP_Protocols,					# nutzt die selbst definierte Auswahlliste als Syntax
			multivalue=False,
			options=[],
			required=False,
			default='sip',							# der Eintrag 'sip' ist vorausgewählt
			may_change=True,
			identifies=False
		),
	'ip': univention.admin.property(
			short_description=_(u'IP-Address'),
			long_description=_(u'IP-Address of the IP-phone'),
			syntax=univention.admin.syntax.ipAddress,	# muss der Syntax einer IP (Version 4) Adresse entsprechen
			multivalue=False,
			options=[],
			required=True,
			may_change=True,
			identifies=False
		),
	'priuser': univention.admin.property(
			short_description=_(u'Primary User'),
			long_description=_(u'The primary user of this IP-phone'),
			syntax=SynVoIP_Address,						# muss der Syntax einer VoIP Adresse entsprechen
			multivalue=False,
			options=[],
			required=True,
			may_change=True,
			identifies=False
		),
	'users': univention.admin.property(
			short_description=_(u'Additional Users'),
			long_description=_(u'Users, that may register with this phone'),
			syntax=SynVoIP_Address,						# jeder Eintrag muss der Syntax einer VoIP Adresse entsprechen
			multivalue=True,						# Dies ist eine Liste von Adressen
			options=[],
			required=False,
			may_change=True,
			identifies=False
		),
	'redirect_user': univention.admin.property(
			short_description=_(u'Redirection User'),
			long_description=_(u'Address for call redirection'),
			syntax=SynVoIP_Address,
			multivalue=False,
			options=['redirection'],					# Ist nur da, wenn die Option gesetzt ist
			required=False,
			may_change=True,
			identifies=False
		),
}


##   * Der erste Parameter ist der Name des Reiters und der zweite Parameter
##     ist eine Beschreibung der Einstellungsmöglich für diesen Reiter
##   * Die folgende Liste definiert die Anordnung der einzelnen Eigenschaftsfelder.
##   * Per advanced=True wird der Reiter nur angezeigt, wenn das Anzeigen der
##     erweiterten Einstellungen aktiviert ist.
layout=[
	univention.admin.tab((u'Gerneral'), _(u'Basic Settings'), [
			[ univention.admin.field("name"), univention.admin.field("active") ],
			[ univention.admin.field( "ip" ), univention.admin.field( "protocol" ) ],
			[ univention.admin.field("priuser") ],
			]),
	univention.admin.tab(_(u'Advanced'), _(u'Advanced Settings'), [
				[ univention.admin.field( "users" ) ],
			], advanced = True ),
	univention.admin.tab(_(u'Redirect'), _(u'Redirect Option'), [
				[ univention.admin.field( "redirect_user" ) ],
			], advanced = True ),
	]


## Die folgenden beiden Hilfsfunktionen dienen zur Abbildung von bool'schen Werten '0' und '1' auf 'no' und 'yes' (siehe Mapping)
def boolToString(value):
	u"""Wandelt den Wert des LDAP-Attributs in den Wert für die Anzeige der UDM Property."""
	if value == '1':
		return _('yes')
	else:
		return _('no')

def stringToBool(value):
	u"""Wandelt den Wert der UDM Property zurück in den Wert des LDAP-Attributs."""
	if value[0].lower() == _('yes'):
		return '1'
	else:
		return '0'

mapping.register('users', 'testPhoneUsers')
mapping.register('redirect_user', 'testPhoneRedirectUser', None, univention.admin.mapping.ListToString)


class object(univention.admin.handlers.simpleLdap):
	u"""Dieses Objekt unterstützt den Univention Directory Manager bei LDAP-Operationen,
	die sich auf dieses Modul beziehen.
	Die Basisklasse univention.admin.handlers.simpleLdap implementiert die komplette Kommunikation über LDAP,
	so dass hier nur die Anpassungen für dieses spezielle LDAP-Objekt implementiert werden müssen.

	module=module

	def __init__(self, co, lo, position, dn='', superordinate=None, arg=None):
		u"""Initialisierung des Objektes. Hier müssen die oben definierten globalen Variablen 'mapping'
		und 'property_descriptions' übernommen werden"""
		global options
		global mapping

		self.old_options= copy.deepcopy( self.options )

	def exists(self):
		u"""Von SimpleLdap intern verwendete Methode, um zu entscheiden, ob ein
		Objekt neu angelegt werden muß oder ein vorhandenes editiert wird."""
		return self._exists

	def open(self):
		u"""Öffnen des LDAP-Objekts."""

		univention.admin.handlers.simpleLdap.open(self)
		## In dieser Methode können die Eigenschaften des Objekts in self.info dynamisch Vor-initialisiert werden. 

		self.old_options= copy.deepcopy( self.options ) # Optionen zum späteren Vergleich speichern.

	def _ldap_pre_create(self):
		u"""Wird vor dem Anlegen des LDAP Objektes aufgerufen."""
		self.dn='%s=%s,%s' % (mapping.mapName('name'), mapping.mapValue('name', self.info['name']), self.position.getDn())

	def _ldap_post_create(self):
		u"""Wird nach dem Anlegen des Objektes aufgerufen."""
		pass

	def _ldap_pre_modify(self):
		u"""Wird vor dem Modifizieren des Objektes aufgerufen."""
		pass

	def _ldap_post_modify(self):
		u"""Wird nach dem Modifizieren des Objektes aufgerufen."""
		pass

	def _ldap_pre_remove(self):
		u"""Wird vor dem Löschen des Objektes aufgerufen."""
		pass

	def _ldap_post_remove(self):
		u"""Wird nach dem Löschen des Objektes aufgerufen."""
		pass

	def _update_policies(self):
		pass

	def _ldap_addlist(self):
		u"""Diese Funktion muss definiert werden, weil sie von 'create' verwendet wird.
		Sie sollte die nur zum Anlegen notwendigen LDAP-Attribute zurückgeben, d.h. mindestens die
		'objectClass' Definition. Nach dieser Methode ruft 'create' _ldap_modlist auf, um weitere
		Modifikationen an Eigenschaften festzustellen."""

		return al

	def _remove_attr(self, ml, attr):
		u"""Hilfmethode zum Entfernen das Attribut 'attr' aus der Liste der zu
		modifizierenden Attribute 'ml'."""
		for m in ml:
			if m[0] == attr:
				ml.remove(m)

		return ml

	def _ldap_modlist(self):
		u"""Diese Funktion kann definiert werden. Die gleichnamige ererbte Methode von 'simpleLdap'
		erstellt eine LDAP-modlist aus der Differenz zwischen self.oldinfo und self.info."""

		ml = univention.admin.handlers.simpleLdap._ldap_modlist(self)

 

def lookup(co, lo, filter_s, base='', superordinate=None, scope='sub', unique=0, required=0, timeout=-1, sizelimit=0):
	u"""Diese Function sucht nach Objekten, die dem in diesem Modul verwalteten Typ (objectClass)
	die den angegebenen Suchkriterien entsprechen. Der Rückgabewert dieser Funktion ist ein Liste
	der gefunden Objekte."""


	return res


def identify(dn, attr, canonical=False):
	u"""Prüft ob die verwaltete Objektklasse diese Moduls in der übergebenen Liste enthalten ist,
	d.h. ob dieses Modul für die Handhabung des Objekts zuständig ist."""

	return 'testPhone' in attr.get('objectClass', [])


Return to bug 17915