Attachment #3046 for bug #17915




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

  * Fix installation path of translation catalog (Bug #17915)
  * Fix creating entry with immediate --redirect.
  * Handle errors in ip-phone-tool.
  * Parameter errors should exit with 2.
  * debian/rules: Fix clean target.
  * Fix quoting.
  * Add simple script to test implementation.

 -- Philipp Hahn <hahn@univention.de>  Thu, 17 Feb 2011 07:08:03 +0100

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

  * fix default value for TrueFalseUp syntax (Bug #17915)





PYVERS := $(shell pyversions -vr)

PO_FILES := $(shell find modules -name '*.po')
MO_FILES := $(PO_FILES:%.po=%.mo)

%.mo:	%.po
	msgfmt -o $@ $<

configure: configure-stamp
configure-stamp:
	dh_testdir
	touch $@

build: configure-stamp build-stamp
build-stamp: $(MO_FILES)
	dh_testdir
	touch $@

clean:
	dh_testdir
	dh_testroot
	dh_clean
	$(RM) build-stamp configure-stamp
	$(RM) debian/*.conffiles
	$(RM) $(MO_FILES)
	$(RM) *~

install: build-stamp
	dh_testdir


	@for i in $(shell find modules/univention/admin/ -name '*.py'); do\
		o=${D}/usr/share/pyshared/$${i#modules/};\
		install -d "`dirname "$$o"`";\
		install -m755 "$$i" "$$o";\
	done
	@for i in `find modules/univention/admin/handlers/ -name "*.png" -o -name "*.gif"`; do\
		o=${D}/usr/share/univention-webui-style/icon/$${i#modules/univention/admin/handlers/};\
		install -d "`dirname "$$o"`";\
		install -m 644 "$$i" "$$o";\
	done
	@for i in $(MO_FILES); do\
		lang=`basename "$$i" .mo`;\
		domain=`dirname "$$i" | sed 's,^modules/,,;s,/,-,g'`;\
		o=${D}/usr/share/locale/$$lang/LC_MESSAGES/$$domain.mo;\
		install -d "`dirname "$$o"`";\
		install -m 644 "$$i" "$$o";\
	done

	# Install example script




#!/bin/sh
#
# Test module and script
#
set -e

ip-phone-tool set voip1 10.1.0.42 sip:user1@dom.local
ip-phone-tool set voip1 10.1.0.42 sip:user1@dom.local --redirect sip:otheruser@dom.local
ip-phone-tool set voip2 10.1.0.43 sip:user2@dom.local --redirect sip:otheruser@dom.local
ip-phone-tool clear_redirect voip1
ip-phone-tool remove voip1
ip-phone-tool remove voip2

udm test/ip_phone create --set name=voip1 --set ip=10.1.0.42 --set active=TRUE --set priuser=sip:user1@dom.local
dn=$(udm test/ip_phone list --filter name=voip1 | sed -ne 's/^DN: //p')
udm test/ip_phone modify --dn "$dn" --option redirection --set redirect_user=sip:otheruser@dom.local
udm test/ip_phone create --set name=voip2 --set ip=10.1.0.43 --set active=TRUE --set priuser=sip:user2@dom.local --option redirection --set redirect_user=sip:otheruser@dom.local
udm test/ip_phone modify --dn "$dn" --set redirect_user=
udm test/ip_phone remove --dn "$dn"
udm test/ip_phone remove --filter name=voip2

echo "Success."

(-)scripts/ip-phone-tool (-29 / +62 lines)

Lines 30-38	Link Here

"""Univention IP-Phone Example UDM Client."""

"""Univention IP-Phone Example UDM Client."""

import sys, os

import sys

import os

import univention.debug

import univention.debug

univention.debug.init('/var/log/univention/ip-phone-tool.log', 1, 0)

univention.debug.init('/var/log/univention/ip-phone-tool.log', univention.debug.FLUSH, univention.debug.NO_FUNCTION)

import univention.config_registry

import univention.config_registry

import univention.admin.uldap

import univention.admin.uldap

Lines 45-53	Link Here

from optparse import OptionParser, OptionValueError

from optparse import OptionParser, OptionValueError

translation=univention.admin.localization.translation('univention.admin.handlers.test')	## missing in this example

translation=univention.admin.localization.translation('univention.admin.handlers.test')	## missing in this example

_=translation.translate

_ = translation.translate

class ipphonetool:

class ipphonetool:

	"""Simple example demonstrating how to implement and how to use custom Univention Directory Manager modules.

	This is an example tool to manage IP phones.

"""

	def __init__(self, options, ucr=None):

	def __init__(self, options, ucr=None):

		"""Initialize an authenticated LDAP connection

		"""Initialize an authenticated LDAP connection

Lines 63-75	Link Here

			binddn = ','.join(('cn=admin', self.ldap_base))

			binddn = ','.join(('cn=admin', self.ldap_base))

			server_role = ucr.get('server/role', '')

			server_role = ucr.get('server/role', '')

			if server_role in ('domaincontroller_master', 'domaincontroller_backup'):

			if server_role in ('domaincontroller_master', 'domaincontroller_backup'):

				bindpw = open('/etc/ldap.secret','r').read().strip()

				try:

					bindpw = open('/etc/ldap.secret','r').read().strip()

				except IOError, e:

					print >>sys.stderr, "Could not read credentials."

					sys.exit(1)

			else:

			else:

				print >>sys.stderr, "No credentials available"

				print >>sys.stderr, "No credentials available"

				sys.exit(1)

				sys.exit(1)

		try:

		try:

			self.lo=univention.admin.uldap.access(host=ldap_master, base=self.ldap_base, binddn=binddn, bindpw=bindpw, start_tls=2)

			self.lo = univention.admin.uldap.access(host=ldap_master, base=self.ldap_base, binddn=binddn, bindpw=bindpw, start_tls=2)

		except Exception, e:

		except Exception, e:

			univention.debug.debug(univention.debug.ADMIN, univention.debug.WARN, 'authentication error: %s' % str(e))

			univention.debug.debug(univention.debug.ADMIN, univention.debug.WARN, 'authentication error: %s' % str(e))

			print 'authentication error: %s' % str(e)

			print 'authentication error: %s' % str(e)

Lines 85-98	Link Here

		"""This uses the lookup function of the udm module, allowing filtering in terms of UDM properties

		"""This uses the lookup function of the udm module, allowing filtering in terms of UDM properties

"""

"""

		filter=univention.admin.filter.expression('name', name)

		filter = univention.admin.filter.expression('name', name)

		objs = self.module.lookup(self.co, self.lo, filter, scope='domain', base=self.position.getDomain(), unique=1)

		objs = self.module.lookup(self.co, self.lo, filter, scope='domain', base=self.position.getDomain(), unique=1)

		if objs:

		if objs:

			obj=objs[0]

100

			obj = objs[0]

		else:

101

		else:

			obj = self.module.object(self.co, self.lo, self.position)

102

			obj = self.module.object(self.co, self.lo, self.position)

			obj['name']=name

103

			obj['name'] = name

104

		if not ip == obj['ip']:

105

		if not ip == obj['ip']:

			obj['ip'] = ip

106

			obj['ip'] = ip

Lines 100-106	Link Here

100

			obj['priuser'] = priuser

108

			obj['priuser'] = priuser

101

109

102

		if options.redirect:

110

		if options.redirect:

103

			obj.options.append('redirection')

111

			if 'redirection' not in obj.options:

112

				obj.options.append('redirection')

104

			obj['redirect_user'] = options.redirect

113

			obj['redirect_user'] = options.redirect

105

		else:		## if no redirection is given, this example removes the objectclass

114

		else:		## if no redirection is given, this example removes the objectclass

106

			if 'redirection' in obj.options:

115

			if 'redirection' in obj.options:

Lines 108-152	Link Here

108

			obj['redirect_user'] = options.redirect

117

			obj['redirect_user'] = options.redirect

109

118

110

		if objs:

119

		if objs:

111

			obj.modify()

120

			try:

121

				obj.modify()

122

			except univention.admin.uexceptions.ldapError, e:

123

				univention.debug.debug(univention.debug.ADMIN, univention.debug.ERROR, 'Could not modify entry: %s' % e)

124

				print >>sys.stderr, 'Could not modify entry: %s' % name

125

				sys.exit(1)

112

		else:

126

		else:

113

			obj.create()

127

			try:

128

				obj.create()

129

			except univention.admin.uexceptions.ldapError, e:

130

				univention.debug.debug(univention.debug.ADMIN, univention.debug.ERROR, 'Could not create entry: %s' % e)

131

				print >>sys.stderr, 'Could not create entry: %s' % name

132

				sys.exit(1)

114

133

115

	def remove(self, name):

134

	def remove(self, name):

116

		"""remove the object, no safty belt in this example"""

135

		"""remove the object, no safty belt in this example"""

117

136

118

		filter=univention.admin.filter.expression('name', name)

137

		filter = univention.admin.filter.expression('name', name)

119

138

120

		objs = self.module.lookup(self.co, self.lo, filter, scope='domain', base=self.position.getDomain(), unique=1)

139

		objs = self.module.lookup(self.co, self.lo, filter, scope='domain', base=self.position.getDomain(), unique=1)

121

		if objs:

140

		if objs:

122

			obj=objs[0]

141

			obj = objs[0]

123

			obj.remove()

142

			try:

143

				obj.remove()

144

			except univention.admin.uexceptions.ldapError, e:

145

				univention.debug.debug(univention.debug.ADMIN, univention.debug.ERROR, 'Could not remove entry: %s' % e)

146

				print >>sys.stderr, 'Could not remove entry: %s' % name

147

				sys.exit(1)

148

		else:

149

			print >>sys.stderr, 'Entry not found: %s' % name

150

			sys.exit(1)

124

151

125

	def clear_redirect(self, name):

152

	def clear_redirect(self, name):

126

		"""This example uses a raw LDAP search instead of performing a lookup to determine the dn

153

		"""This example uses a raw LDAP search instead of performing a lookup to determine the dn

127

"""

154

"""

128

		try:

155

		try:

129

			filter = unicode('(&(cn=%s)(objectClass=testPhoneCallRedirect))' % name, 'utf8')

156

			filter = unicode('(&(cn=%s)(objectClass=testPhoneCallRedirect))' % name, 'utf8')

130

			dn=self.lo.searchDn(filter=filter, base=self.ldap_base, unique=1)

157

			dn = self.lo.searchDn(filter=filter, base=self.ldap_base, unique=1)

131

			if not dn:

158

			if not dn:

132

				print "No object found matching filter %s" % filter

159

				print "No object found matching filter %s" % filter

133

				sys.exit(1)

160

				sys.exit(1)

134

161

135

			object=univention.admin.objects.get(self.module, self.co, self.lo, position=self.position, dn=dn[0])

162

			object = univention.admin.objects.get(self.module, self.co, self.lo, position=self.position, dn=dn[0])

136

			object.open()						## open the object

163

			object.open()						## open the object

137

164

138

			if 'redirection' in object.options:

165

			if 'redirection' in object.options:

139

				object.options.remove('redirection')

166

				object.options.remove('redirection')

140

167

141

			object['redirect_user']=''

168

			object['redirect_user'] = ''

142

169

143

			univention.debug.debug(univention.debug.ADMIN, univention.debug.INFO, 'ip-phone-tool: redirect_user cleared, modify object')

170

			univention.debug.debug(univention.debug.ADMIN, univention.debug.INFO, 'ip-phone-tool: redirect_user cleared, modify object')

144

			dn=object.modify()

171

			dn = object.modify()

145

172

146

			univention.debug.debug(univention.debug.ADMIN, univention.debug.INFO, 'ip-phone-tool: Redirection deactivated')

173

			univention.debug.debug(univention.debug.ADMIN, univention.debug.INFO, 'ip-phone-tool: Redirection deactivated')

147

174

148

		except univention.admin.uexceptions.valueError, e:

175

		except univention.admin.uexceptions.valueError, e:

149

			univention.debug.debug(univention.debug.ADMIN, univention.debug.ERROR, 'error: invalid syntax (%s)' % e)

176

			univention.debug.debug(univention.debug.ADMIN, univention.debug.ERROR, 'error: invalid syntax (%s)' % e)

177

			print >>sys.stderr, 'Could not modify entry: %s' % name

178

			sys.exit(1)

179

		except univention.admin.uexceptions.ldapError, e:

180

			univention.debug.debug(univention.debug.ADMIN, univention.debug.ERROR, 'Could not modify entry: %s' % e)

181

			print >>sys.stderr, 'Could not modify entry: %s' % name

182

			sys.exit(1)

150

183

151

184

152

if __name__ == '__main__':

185

if __name__ == '__main__':

Lines 185-191	Link Here

185

			action = 'store', dest = 'username',

218

			action = 'store', dest = 'username',

186

			help = _('Username') )

219

			help = _('Username') )

187

220

188

	parser.add_option( '', '--redirect',

221

	parser.add_option( '--redirect',

189

			action = 'store', dest = 'redirect',

222

			action = 'store', dest = 'redirect',

190

			help = _('Redirect address') )

223

			help = _('Redirect address') )

191

	(options, arguments) = parser.parse_args()

224

	(options, arguments) = parser.parse_args()

Lines 198-222	Link Here

198

	ucr.load()

231

	ucr.load()

199

232

200

	if len(arguments) < 1:

233

	if len(arguments) < 1:

201

		parser.print_help()

234

		parser.print_help(sys.stderr)

202

		sys.exit(1)

235

		sys.exit(2)

203

236

204

	udm_ipphone = ipphonetool(options, ucr)

237

	udm_ipphone = ipphonetool(options, ucr)

205

	if arguments[0] == 'set':

238

	if arguments[0] == 'set':

206

		if len(arguments) < 4:

239

		if len(arguments) < 4:

207

			parser.print_usage()

240

			parser.print_usage(sys.stderr)

208

			sys.exit(1)

241

			sys.exit(2)

209

		udm_ipphone.set( options, arguments[1], arguments[2], arguments[3] )

242

		udm_ipphone.set( options, arguments[1], arguments[2], arguments[3] )

210

	elif  arguments[0] == 'remove':

243

	elif  arguments[0] == 'remove':

211

		if len(arguments) < 2:

244

		if len(arguments) < 2:

212

			parser.print_usage()

245

			parser.print_usage(sys.stderr)

213

			sys.exit(1)

246

			sys.exit(2)

214

		udm_ipphone.remove( arguments[1] )

247

		udm_ipphone.remove( arguments[1] )

215

	elif  arguments[0] == 'clear_redirect':

248

	elif  arguments[0] == 'clear_redirect':

216

		if len(arguments) < 2:

249

		if len(arguments) < 2:

217

			parser.print_usage()

250

			parser.print_usage(sys.stderr)

218

			sys.exit(1)

251

			sys.exit(2)

219

		udm_ipphone.clear_redirect( arguments[1] )

252

		udm_ipphone.clear_redirect( arguments[1] )

220

	else:

253

	else:

221

		parser.print_usage()

254

		parser.print_usage(sys.stderr)

222

		sys.exit(0)

255

		sys.exit(2)




		## weitere Entscheidungen getroffen werden können.
		self.options = []
		if self.oldattr.has_key('objectClass'):
			# Das Objekt existiert bereits im LDAP und wurde von dort geladen
			ocs = set(self.oldattr['objectClass'])
			for opt in ('redirection', ):
				if options[opt].matches(ocs):
					self.options.append(opt)
			self.old_options = copy.deepcopy(self.options)
		else:
			# Das Objekt existiert nocht nicht im LDAP und wird neu angelegt.
			univention.debug.debug(univention.debug.ADMIN, univention.debug.INFO, '%s: reset options to default by _define_options' % module)
			self._define_options(options)
			self.old_options = []

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

	def exists(self):
		u"""Von SimpleLdap intern verwendete Methode, um zu entscheiden, ob ein

		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.
		## Das self.info Dictionary kann indirekt angesprochen werden, d.h. z.B. durch self['active'] = 1
		## Da der Basistyp von 'simpleLdap' (und damit von 'object') die Klasse 'base' ist, verhält sich
		## 'self' wie ein spezielles Dictionary. Es überprüft Operationen anhand der 'property_descriptions'

		## in self.oldinfo und self.oldpolicies gespeichert. Diese dienen später zum Vergleich mit dem
		## aktualisierten Eigenschaften in self.info.
		self.save()
		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."""

		pass

	def _update_policies(self):
		u""""Wird bim Anlegen und Modifizieren des Objekts aufgerufen, um ggf.
		aktivierte Policies auf das Objekt anzuwenden."""
		pass

	def _ldap_addlist(self):




po=de
i18nfile=./modules/univention/admin/handlers/test/$po

xgettext -L Python -o "$po.pot" modules/univention/admin/handlers/test/*.py scripts/ip-phone-tool

if grep -qs "Content-Type: text/plain; charset=CHARSET" "$po.pot"
then
if [ $? -eq 0 ]; then
	echo "Rewriting encoding information from CHARSET to ISO-8859-15"
	sed -i "s#Content-Type: text/plain; charset=CHARSET#Content-Type: text/plain; charset=ISO-8859-15#" "$po.pot"
fi

echo "Merging old gettext data with newly introduced strings"
msgmerge "$i18nfile.po" "$po.pot" > "$po.pox"

echo "Now you need to fix up all "fuzzy" entries in your editor"
read

if [ -n "$EDITOR" ]; then
    $EDITOR "$po.pox"
else
	sensible-editor "$po.pox"
fi

echo "Use this entry? (Y/n)"
read yn

if [ -z "$yn" ] || [ "$yn" = "y" ]; then
    echo "Copying po file"
    cp "$po.pox" "$i18nfile.po"
    echo "Regenerating mo file"
    msgfmt -o "$i18nfile.mo" "$i18nfile.po"
fi

rm -rf "$po.pot" "$po.pox"

Return to bug 17915