Attachment #5190 for bug #31151

View | Details | Raw Unified | Return to bug 31151
Collapse All | Expand All




<!-- top level element -->
<!--  version: onyl 2.0 is allowed -->
<!ELEMENT umc (categories)>
<!ATTLIST umc
	version (2.0) #REQUIRED
	>

<!-- definition of categories -->
<!ELEMENT categories (category+)>

<!-- a category -->
<!--  priority: favories=100, monitor=1 -->
<!ELEMENT category (name+)>
<!ATTLIST category
	priority CDATA #REQUIRED
	id ID #REQUIRED
	>

<!-- translated names of vatehory -->
<!ELEMENT name (#PCDATA)>
<!ATTLIST name
	lang CDATA #IMPLIED
	>




<!-- top level element -->
<!--  version: onyl 2.0 is allowed -->
<!ELEMENT umc (module)>
<!ATTLIST umc
	version (2.0) #REQUIRED
	>

<!-- definition of a module -->
<!--  icon: path fragment for icon -->
<!--  version: onyl 1.0 is allowed -->
<!ELEMENT module ((name+, description+)?, flavor*, categories?, command*)>
<!ATTLIST module
	id CDATA #REQUIRED
	icon CDATA #REQUIRED
	priority CDATA #IMPLIED
	version (1.0) #REQUIRED
	translationId ID #IMPLIED
	>

<!-- translated names of module -->
<!ELEMENT name (#PCDATA)>
<!ATTLIST name
	lang CDATA #IMPLIED
	>

<!-- translated description for module -->
<!ELEMENT description (#PCDATA)>
<!ATTLIST description
	lang CDATA #IMPLIED
	>

<!-- LDAP modules -->
<!ELEMENT flavor (name,description)?>
<!ATTLIST flavor
	icon CDATA #IMPLIED
	priority CDATA #IMPLIED
	id CDATA #REQUIRED
	deactivated (yes|no) "no"
	>

<!-- definition of categories -->
<!ELEMENT categories (category+)>
<!-- a category -->
<!--  priority: favories=100, monitor=1 -->
<!ELEMENT category EMPTY>
<!ATTLIST category
	name ID #REQUIRED
	>

<!-- mapping from UMC command to Python function -->
<!--  name: UMC command -->
<!--  function: Python function name -->
<!ELEMENT command (description*, return?)>
<!ATTLIST command
	name CDATA #REQUIRED
	function NMTOKEN #REQUIRED
	>

<!-- return value type -->
<!ELEMENT return EMPTY>
<!ATTLIST return
	syntax (Boolean|Dictionary|UCR-Variables|umc-boolean) #REQUIRED
	>




<?xml version="1.0"?>
<rng:grammar
	xmlns:rng="http://relaxng.org/ns/structure/1.0"
	xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0"
	ns=""
	datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">

	<a:documentation>
		Univention Corporate Server Management Console definition.
		Copyriught 2013 Univention GmbH.
	</a:documentation>

	<rng:define name="language">
		<a:documentation>Counte_Language code.</a:documentation>
		<rng:data type="string">
			<param name="pattern">[a-z][a-z]_[A-Z][A-Z]</param>
		</rng:data>
	</rng:define>

	<rng:define name="translated">
		<a:documentation>Translation to multiple languages.</a:documentation>
		<rng:optional>
			<rng:attribute name="lang">
				<rng:ref name="language"/>
			</rng:attribute>
		</rng:optional>
		<rng:data type="string"/>
	</rng:define>

	<rng:define name="version">
		<a:documentation>Version string with major and minor number.</a:documentation>
		<rng:data type="string">
			<rng:param name="pattern">[0-9]+\.[0-9]+</rng:param>
		</rng:data>
	</rng:define>

	<rng:define name="category">
		<a:documentation>Category string.</a:documentation>
		<rng:data type="string"/>
	</rng:define>

	<rng:start>
		<rng:element name="umc">
			<a:documentation>Top level element to define either UMC modules or categories.</a:documentation>
			<rng:choice>
				<rng:ref name="Module"/>
				<rng:ref name="Categories"/>
			</rng:choice>
			<rng:attribute name="version">
				<rng:ref name="version"/>
			</rng:attribute>
		</rng:element>
	</rng:start>

	<rng:define name="Module">
		<rng:element name="module">
			<a:documentation>UMC module definition</a:documentation>
			<rng:interleave>
				<rng:optional>
					<rng:oneOrMore>
						<rng:element name="name">
							<rng:ref name="translated"/>
						</rng:element>
					</rng:oneOrMore>
					<rng:oneOrMore>
						<rng:element name="description">
							<rng:ref name="translated"/>
						</rng:element>
					</rng:oneOrMore>
				</rng:optional>
				<rng:optional>
					<rng:element name="categories">
						<rng:oneOrMore>
							<rng:element name="category">
								<rng:attribute name="name">
									<rng:ref name="category"/>
								</rng:attribute>
							</rng:element>
						</rng:oneOrMore>
					</rng:element>
				</rng:optional>
				<rng:zeroOrMore>
					<rng:choice>
						<rng:ref name="Flavor"/>
						<rng:ref name="Command"/>
					</rng:choice>
				</rng:zeroOrMore>
			</rng:interleave>
			<rng:optional>
				<rng:attribute name="id">
					<rng:data type="string"/>
				</rng:attribute>
			</rng:optional>
			<rng:attribute name="icon">
				<rng:data type="string"/>
			</rng:attribute>
			<rng:optional>
				<rng:attribute name="priority">
					<rng:data type="integer"/>
				</rng:attribute>
			</rng:optional>
			<rng:attribute name="version">
				<rng:ref name="version"/>
			</rng:attribute>
			<rng:optional>
				<rng:attribute name="translationId">
					<rng:data type="ID"/>
				</rng:attribute>
			</rng:optional>
		</rng:element>
	</rng:define>

	<rng:define name="Flavor">
		<rng:element name="flavor">
			<a:documentation>Definition of UDM modules.</a:documentation>
			<rng:attribute name="id">
				<rng:data type="string"/>
			</rng:attribute>
			<rng:choice>
				<rng:group>
					<rng:attribute name="deactivated">
						<rng:value>yes</rng:value>
					</rng:attribute>
					<rng:empty/>
				</rng:group>
				<rng:group>
					<rng:optional>
						<rng:attribute name="deactivated">
							<rng:value>no</rng:value>
						</rng:attribute>
					</rng:optional>
					<rng:oneOrMore>
						<rng:element name="name">
							<rng:ref name="translated"/>
						</rng:element>
					</rng:oneOrMore>
					<rng:oneOrMore>
						<rng:element name="description">
							<rng:ref name="translated"/>
						</rng:element>
					</rng:oneOrMore>
					<rng:optional>
						<rng:attribute name="icon">
							<rng:data type="string"/>
						</rng:attribute>
					</rng:optional>
					<rng:optional>
						<rng:attribute name="priority">
							<rng:data type="integer"/>
						</rng:attribute>
					</rng:optional>
				</rng:group>
			</rng:choice>
		</rng:element>
	</rng:define>

	<rng:define name="Command">
		<rng:element name="command">
			<a:documentation>Definition of UMC command mapping to Python functions.</a:documentation>
			<rng:zeroOrMore>
				<rng:element name="description">
					<rng:ref name="translated"/>
				</rng:element>
			</rng:zeroOrMore>
			<rng:optional>
				<rng:element name="return">
					<rng:attribute name="syntax">
						<rng:choice>
							<rng:value>Boolean</rng:value>
							<rng:value>Dictionary</rng:value>
							<rng:value>UCR-Variables</rng:value>
							<rng:value>umc-boolean</rng:value>
						</rng:choice>
					</rng:attribute>
				</rng:element>
			</rng:optional>
			<rng:attribute name="name">
				<rng:data type="string"/>
			</rng:attribute>
			<rng:attribute name="function">
				<rng:data type="string"/>
			</rng:attribute>
		</rng:element>
	</rng:define>

	<rng:define name="Categories">
		<rng:element name="categories">
			<a:documentation>Definition of UMC categories.</a:documentation>
			<rng:oneOrMore>
				<rng:element name="category">
					<rng:oneOrMore>
						<rng:element name="name">
							<rng:ref name="translated"/>
						</rng:element>
					</rng:oneOrMore>
					<rng:attribute name="priority">
						<rng:data type="integer"/>
					</rng:attribute>
					<rng:attribute name="id">
						<rng:ref name="category"/>
					</rng:attribute>
				</rng:element>
			</rng:oneOrMore>
		</rng:element>
	</rng:define>

</rng:grammar>




<?xml version="1.0" encoding="UTF-8"?>
<umc version="2.0">
	<module id="ucr/module" icon="ucr/module" version="1.0" priority="42" translationId="umc-module">
		<name>Univention Configuration Registry</name>
		<name lang="de_DE">Univention Configuration Registry</name>
		<description>Managing UCR variables</description>
		<description lang="de_DE">Verwaltung von UCR-Variablen</description>
		<flavor id="group/module" priority="42" icon="udm-group-module">
			<name>UDM Module</name>
			<description>Module description</description>
		</flavor>
		<flavor id="mail/mail" deactivated="yes"/>
		<categories>
			<category name="system"/>
		</categories>
		<command name="ucr/set" function="set">
			<description>Set UCR variables</description>
			<description lang="de_DE">Setzen von UCR-Variablen</description>
			<return syntax="umc-boolean"/>
		</command>
	</module>
</umc>




<?xml version='1.0' encoding='utf-8'?>
<xs:schema xmlns:xs='http://www.w3.org/2001/XMLSchema'>

	<xs:annotation>
		<xs:documentation xml:lang='en'>
			Univention Corporate Server Management Console definition.
			Copyriught 2013 Univention GmbH.
		</xs:documentation>
	</xs:annotation>

	<xs:complexType name='translated'>
		<xs:annotation>
			<xs:documentation xml:lang='en'>
				Translation to multiple languages.
			</xs:documentation>
		</xs:annotation>
		<xs:simpleContent>
			<xs:extension base='xs:string'>
				<xs:attribute name='lang' type='xs:language' use='optional'/>
			</xs:extension>
		</xs:simpleContent>
	</xs:complexType>

	<xs:simpleType name="version">
		<xs:annotation>
			<xs:documentation xml:lang='en'>
				Version string with major and minor number.
			</xs:documentation>
		</xs:annotation>
		<xs:restriction base="xs:string">
			<xs:pattern value="[0-9]+\.[0-9]+"/>
		</xs:restriction>
	</xs:simpleType>

	<xs:simpleType name="category">
		<xs:annotation>
			<xs:documentation xml:lang='en'>
				Category string.
			</xs:documentation>
		</xs:annotation>
		<xs:restriction base="xs:string"/>
	</xs:simpleType>

	<xs:element name='umc'>
		<xs:annotation>
			<xs:documentation xml:lang='en'>
				Top level element to define either UMC modules or categories.
			</xs:documentation>
		</xs:annotation>
		<xs:complexType>
			<xs:choice>
				<xs:element ref='module'/>
				<xs:element ref='categories'/>
			</xs:choice>
			<xs:attribute name='version' type='version' use='required' fixed='2.0'/>
		</xs:complexType>
	</xs:element>

	<xs:element name='module'>
		<xs:annotation>
			<xs:documentation xml:lang='en'>
				UMC module definition
			</xs:documentation>
		</xs:annotation>
		<xs:complexType>
			<xs:sequence>
				<xs:sequence minOccurs='0' maxOccurs='1'>
					<xs:element name='name' type='translated' maxOccurs='unbounded'/>
					<xs:element name='description' type='translated' maxOccurs='unbounded'/>
				</xs:sequence>
				<xs:element ref='flavor' minOccurs='0' maxOccurs='unbounded'/>
				<xs:element name='categories' minOccurs='0' maxOccurs='1'>
					<xs:complexType>
						<xs:sequence>
							<xs:element name='category' maxOccurs='unbounded'>
								<xs:complexType>
									<xs:attribute name='name' type='category' use='required'/>
								</xs:complexType>
							</xs:element>
						</xs:sequence>
					</xs:complexType>
				</xs:element>
				<xs:element ref='command' minOccurs='0' maxOccurs='unbounded'/>
			</xs:sequence>
			<xs:attribute name='id' type='xs:string' use='optional'/>
			<xs:attribute name='icon' type='xs:string' use='required'/>
			<xs:attribute name='priority' type='xs:integer' use='optional'/>
			<xs:attribute name='version' type='version' use='required' fixed='1.0'/>
			<xs:attribute name='translationId' type='xs:ID' use='optional'/>
		</xs:complexType>
	</xs:element>

	<xs:element name='flavor'>
		<xs:annotation>
			<xs:documentation xml:lang='en'>
				Definition of UDM modules.
			</xs:documentation>
		</xs:annotation>
		<xs:complexType>
			<xs:sequence minOccurs='0' maxOccurs='1'>
				<xs:element name='name' type='translated' maxOccurs='unbounded'/>
				<xs:element name='description' type='translated' maxOccurs='unbounded'/>
			</xs:sequence>
			<xs:attribute name='icon' type='xs:string' use='optional'/>
			<xs:attribute name='priority' type='xs:integer' use='optional'/>
			<xs:attribute name='id' type='xs:string' use='required'/>
			<xs:attribute name='deactivated' use='optional' default='no'>
				<xs:simpleType>
					<xs:restriction base='xs:string'>
						<xs:enumeration value='yes'/>
						<xs:enumeration value='no'/>
					</xs:restriction>
				</xs:simpleType>
			</xs:attribute>
		</xs:complexType>
	</xs:element>

	<xs:element name='command'>
		<xs:annotation>
			<xs:documentation xml:lang='en'>
				Definition of UMC command mapping to Python functions.
			</xs:documentation>
		</xs:annotation>
		<xs:complexType>
			<xs:sequence>
				<xs:element name='description' type='translated' minOccurs='0' maxOccurs='unbounded'/>
				<xs:element name='return' minOccurs='0' maxOccurs='1'>
					<xs:complexType>
						<xs:attribute name='syntax' use='required'>
							<xs:simpleType>
								<xs:restriction base='xs:string'>
									<xs:enumeration value='Boolean'/>
									<xs:enumeration value='Dictionary'/>
									<xs:enumeration value='UCR-Variables'/>
									<xs:enumeration value='umc-boolean'/>
								</xs:restriction>
							</xs:simpleType>
						</xs:attribute>
					</xs:complexType>
				</xs:element>
			</xs:sequence>
			<xs:attribute name='name' type='xs:string' use='required'/>
			<xs:attribute name='function' type='xs:string' use='required'/>
		</xs:complexType>
	</xs:element>

	<xs:element name='categories'>
		<xs:annotation>
			<xs:documentation xml:lang='en'>
				Definition of UMC categories.
			</xs:documentation>
		</xs:annotation>
		<xs:complexType>
			<xs:sequence>
				<xs:element name='category' maxOccurs='unbounded'>
					<xs:complexType>
						<xs:sequence>
							<xs:element name='name' type='translated' maxOccurs='unbounded'/>
						</xs:sequence>
						<xs:attribute name='priority' type='xs:integer' use='required'/>
						<xs:attribute name='id' type='category' use='required'/>
					</xs:complexType>
				</xs:element>
			</xs:sequence>
		</xs:complexType>
	</xs:element>

</xs:schema>

(-)a/branches/ucs-3.1/ucs-3.1-1/management/univention-management-console/debian/changelog (+8 lines)

Lines 1-3	Link Here

univention-management-console (5.0.62-3) UNRELEASED; urgency=low

  * Fix DTD and XSD for UMC module definition (Bug #00000)

  * Fix examples to be XML valid.

  * umc-create-module: Fix command line parsing.

 -- Philipp Hahn <hahn@univention.de>  Tue, 23 Apr 2013 21:10:02 +0200

univention-management-console (5.0.62-2) unstable; urgency=low

univention-management-console (5.0.62-2) unstable; urgency=low

  * Do not log UNIVENTION_DEBUG_{BEGIN, END} information (Bug #29603)

  * Do not log UNIVENTION_DEBUG_{BEGIN, END} information (Bug #29603)




# -*- coding: utf-8 -*-
#
# Univention Configuration Registry
"""
Install UMC modules. It parses a RFC 822 file called
$(package).umc-modules and installs the specified components of a module
into the correct directories.
"""
#
# Copyright 2011-2012 Univention GmbH
#

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

import os
import sys
from optparse import OptionParser

import univention.debhelper as dh_ucs
import univention.dh_umc as dh_umc

try:
	sys.path.insert( 0, './dev' )
	import dh_umc
except BaseException, e:
	print 'warning:', str( e )
	import univention.dh_umc as dh_umc

"""Helps installing UMC modules. It parses a RFC 822 file called
$(package).umc-modules and installs the specified components of a module
into the correct directories."""

def do_package(package, core):
	"""
	Compile translation files for package.
	"""
	try:
		modules = dh_umc.read_modules(package, core)
	except AttributeError, ex:
		print >> sys.stderr, ex
		sys.exit(1)

	if not core:
		# build python PO files
		for module in modules:
			for po_file in module.python_po_files:
				dh_umc.create_po_file(po_file, package, module.python_files)
				dh_umc.create_mo_file(po_file )

		# build javascript PO files
		for module in modules:
			for po_file in module.js_po_files:
				# using python as language seems to work better than perl
				dh_umc.create_po_file(po_file, package, module.js_files, 'python')
				dh_umc.create_json_file(po_file)

	# build xml PO files
	for module in modules:
		for lang, po_file in module.xml_po_files:
			dh_umc.module_xml2po(module, po_file, lang)
			dh_umc.create_mo_file(po_file)


def main():
	"""
	Compile translation files for all packages.
	"""
	# parse all options
	parser = OptionParser(usage='usage: %prog [--core]')
	parser.add_option('-c', '--core',
			action='store_true', dest='core',
			help='If specified modules without javascript and python code are excepted')

	options, _args = parser.parse_args()
	for package in dh_ucs.binary_packages():
		do_package(package, options.core)


if __name__ == '__main__':
	main()




# -*- coding: utf-8 -*-
#
# Univention Configuration Registry
"""
Install UMC modules. It parses a RFC 822 file called
$(package).umc-modules and installs the specified components of a module
into the correct directories.
"""
#
# Copyright 2011-2012 Univention GmbH
#

from optparse import OptionParser

import univention.debhelper as dh_ucs
import univention.dh_umc as dh_umc
	sys.path.insert( 0, './dev' )
	import dh_umc
except:
	import univention.dh_umc as dh_umc

"""Helps installing UMC modules. It parses a RFC 822 file called
$(package).umc-modules and installs the specified components of a module
into the correct directories."""

def do_python(module, destdir):
	"""
	Copy Python module and translation.
	"""
	# copy python module
	py_dir = os.path.join(destdir, 'usr', 'share', 'pyshared', 'univention',
			'management', 'console', 'modules', '%(Module)s' % module)
	dh_ucs.doIt('install', '-d', py_dir)

	filename = None
	for filename in module.python_files:
		dh_ucs.doIt('install',
				'-m', '644',
				'-t', py_dir, filename)
	if filename is None:
		print >> sys.stderr, 'W: no python files found in %s' % (module.python_path,)
		return

	# copy translation files (python)
	for lang in dh_umc.LANGUAGES:
		mo_dir = os.path.join(destdir, 'usr', 'share', 'locale', lang, 'LC_MESSAGES')
		dh_ucs.doIt('install', '-d', mo_dir)
		mo_file = os.path.join(module.python_path, '%s.mo' % lang)
		mo_dest = os.path.join(mo_dir, '%(package)s.mo' % module)
		dh_ucs.doIt('install',
				'-m', '644',
				'-D', mo_file, mo_dest)

		if module.xml_categories:
			dh_ucs.doIt( 'install', '-d', 'debian/%(package)s/usr/share/univention-management-console/categories' % module )
		else:
			print >>sys.stderr, 'info: no category definition file'

def do_javascript(module, destdir):
	"""
	Copy javaScript module and translation.
	"""
	# copy javascript files
	js_base = os.path.join(destdir, 'usr', 'share',
			'univention-management-console-frontend', 'js', 'umc', 'modules')

	filename = None
	for filename in module.js_files:
		js_dest = os.path.join(js_base, filename[len(module.js_path):])
		dh_ucs.doIt('install',
				'-m', '644',
				'-D', filename, js_dest)
	if filename is None:
		print >> sys.stderr, 'W: no javascript files found in %s' % (module.js_path,)
		return

	# copy translation files (javascript)
	for lang in dh_umc.LANGUAGES:
		json_dir = os.path.join(js_base, 'i18n', lang)
		dh_ucs.doIt('install', '-d', json_dir)
		json_file = os.path.join(module.js_path, '%s.json' % (lang,))
		json_dest = os.path.join(json_dir, '%(Module)s.json' % module)
		dh_ucs.doIt('install',
				'-m', '644',
				'-D', json_file, json_dest)


def do_html(module, destdir):
	"""
	Copy HTML files.
	"""
	html_base = os.path.join(destdir, 'usr', 'share',
			'univention-management-console-frontend', 'js', 'umc', 'modules')

	for filename in module.html_files:
		html_dest = os.path.join(html_base, filename[len(module.js_path):])
		dh_ucs.doIt('install',
				'-m', '644',
				'-D', filename, html_dest)


def do_xml(module, destdir):
	"""
	Copy XML definition and translation.
	"""
	# copy XML definitions
	xml_dir = os.path.join(destdir, 'usr', 'share',
			'univention-management-console', 'modules')
	dh_ucs.doIt('install',
			'-d', xml_dir)
	dh_ucs.doIt('install',
			'-m', '644',
			'-t', xml_dir, module.xml_definition)

	# copy translation files (xml)
	for lang in dh_umc.LANGUAGES:
		mo_dir = os.path.join(destdir, 'usr', 'share',
				'univention-management-console', 'i18n', lang)
		dh_ucs.doIt('install', '-d', mo_dir)
		mo_file = os.path.join(os.path.dirname(module.xml_definition),
				'%s.mo' % (lang,))
		mo_dest = os.path.join(mo_dir, '%(Module)s.mo' % module)
		dh_ucs.doIt('install',
				'-m', '644',
				'-D', mo_file, mo_dest)


def do_categories(module, destdir):
	"""
	Copy XML categories.
	"""
	if not module.xml_categories:
		print >> sys.stderr, 'I: no category definition file'
		return

	# copy XML categories
	cat_dir = os.path.join(destdir, 'usr', 'share',
			'univention-management-console', 'categories')
	dh_ucs.doIt('install',
			'-d', cat_dir)
	dh_ucs.doIt('install',
			'-m', '644',
			'-t', cat_dir, module.xml_categories)


def do_icons(module, destdir):
	"""
	Copy icons.
	"""
	if module.icons is None:
		return
	if not os.path.isdir(module.icons):
		print >> sys.stderr, 'W: could not find icon directory %s' % (module.icons,)
		return

	# copy icons
	icon_base = os.path.join(destdir, 'usr', 'share',
			'univention-management-console-frontend', 'js', 'dijit', 'themes',
			'umc', 'icons')
	for dirname, dirs, files in os.walk(module.icons):
		if '.svn' in dirs:
			dirs.remove( '.svn' )
		icon_dir = os.path.join(icon_base, dirname[len(module.icons):])
		dh_ucs.doIt('install',
				'-d', icon_dir)
		for icon in files:
			dh_ucs.doIt('install',
					'-m', '644',
					'-t', icon_dir, os.path.join(dirname, icon))


def do_join(package, destdir):
	"""
	Copy join script.
	"""
	join_dir = os.path.join(destdir, 'usr', 'lib', 'univention-install')
	for filename in os.listdir('.'):
		if filename.endswith('%s.inst' % (package,)):
			dh_ucs.doIt('install',
					'-d', join_dir)
			dh_ucs.doIt('install',
					'-m', '755',
					'-t', join_dir, filename)
			return filename
	return None


def do_package(package, core):
	"""
	Install files for one binary package.
	"""
	try:
		modules = dh_umc.read_modules(package, core)
	except AttributeError, ex:
		print >> sys.stderr, ex
		sys.exit(1)

	base = os.path.join('debian', package)

	for module in modules:
		do_xml(module, base)
		do_categories(module, base)

		if not core:
			do_python(module, base)
			do_javascript(module, base)
			do_html(module, base)
			do_icons(module, base)

	join_script = do_join(package, base)

	f_postinst = open(base + '.postinst.debhelper', 'a')
	f_postinst.write('# generated by dh-umc-module-install\n')
	if join_script:
		f_postinst.write('''\
		if join_exists:
			f_postinst.write( '''
# run join script on DC master and DC backup
. /usr/share/univention-lib/base.sh
call_joinscript %s || true
''' % (join_script,))
	f_postinst.write('invoke-rc.d univention-management-console-server reload '
			'|| true\n')
	f_postinst.write('''\
# generate a new hash for the UMC frontend in order to avoid caching problems
. /usr/share/univention-lib/umc.sh
umc_frontend_new_hash
''')
	f_postinst.close()

	f_postrm = open(base + '.prerm.debhelper', 'a')
	f_postrm.write('# generated by dh-umc-module-install\n')
	f_postrm.write('invoke-rc.d univention-management-console-server reload '
			'|| true\n')
	f_postrm.close()


def main():
	"""
	Install UMC modules. It parses a RFC 822 file called
	$(package).umc-modules and installs the specified components of a module
	into the correct directories.
	"""
	# parse all options
	parser = OptionParser(usage='usage: %prog [--core]')
	parser.add_option('-c', '--core',
			action='store_true', dest='core',
			help='If specified modules without javascript and python code are excepted')

	options, _args = parser.parse_args()
	for package in dh_ucs.binary_packages():
		do_package(package, options.core)


if __name__ == '__main__':
	main()

(-)a/branches/ucs-3.1/ucs-3.1-1/management/univention-management-console/dev/dh-umc-translate (-37 / +32 lines)

Lines 2-8	Link Here

# -*- coding: utf-8 -*-

# -*- coding: utf-8 -*-

# Univention Configuration Registry

# Univention Configuration Registry

#  build UMC module

"""

Tool creates .json files for translation using gettext.

"""

# Copyright 2011-2012 Univention GmbH

# Copyright 2011-2012 Univention GmbH

Lines 32-63	Link Here

# <http://www.gnu.org/licenses/>.

# <http://www.gnu.org/licenses/>.

import os

import os

import sys

from optparse import OptionParser

from optparse import OptionParser

import univention.dh_umc as dh_umc

import univention.dh_umc as dh_umc

import univention.debhelper as dh_ucs

"""Tool creates .json files for translation using gettext."""

def main():

def main():

"""

	Tool creates .json files for translation using gettext.

"""

	# parse all options

	# parse all options

	parser = OptionParser( usage = 'usage: %prog --package <packageName> --outdir <outDir> [options] <jsFile> ...' )

	parser = OptionParser(usage='usage: %prog --package <packageName> --outdir <outDir> [options] <jsFile> ...')

	parser.add_option( '-p', '--package', action = 'store',

	parser.add_option('-p', '--package',

					   dest = 'package',

			action='store', dest='package',

					   help = 'Specifies the package name which is needed for the creation of .po files. (Mandatory)' )

			help='Specifies the package name which is needed for the creation of .po files. (Mandatory)')

	parser.add_option( '-t', '--type', action = 'store', type = 'choice', choices = ['json', 'mo', 'po', 'core'],

	parser.add_option('-t', '--type',

					   dest = 'type', default = 'json',

			action='store', type='choice', choices=('json', 'mo', 'po',),

					   help = 'Type of the final output file; note that "json" and "mo" will both also create .po files [%default]')

			dest='type', default='json',

	parser.add_option( '-o', '--outdir', action = 'store',

			help='Type of the final output file; note that "json" and "mo" will both also create .po files [%default]')

					   dest = 'outdir',

	parser.add_option('-o', '--outdir',

					   help = 'Specifies the output directory where translations from all js files are saved to. (Mandatory)')

			action='store', dest='outdir',

	parser.add_option( '-l', '--lang', action = 'append',

			help='Specifies the output directory where translations from all js files are saved to. (Mandatory)')

					   dest = 'lang',

	parser.add_option('-l', '--lang',

					   help = 'Specifies the languages that are processed (default: de)')

			action='append', dest='lang',

			help='Specifies the languages that are processed (default: de)')

	( options, args ) = parser.parse_args()

	options, args = parser.parse_args()

#	# make sure we have javascript files

#	# make sure we have javascript files

#	if not len(args):

#	if not len(args):

Lines 70-105 def main():	Link Here

	# make sure we have enough parameters

	# make sure we have enough parameters

	if not options.package:

	if not options.package:

		print '\nYou need to specify a package-name (--package) as well as a list of JavaScript files to process!\n'

		parser.error('You need to specify a package-name (--package) as well as a list of JavaScript files to process!')

		sys.exit(1)

	# make sure that we have an output file specified

	# make sure that we have an output file specified

	if not options.outdir:

	if not options.outdir:

		print '\nYou need to specify an output directory (--outdir)!\n'

		parser.error('You need to specify an output directory (--outdir)!')

		sys.exit(1)

	# set the po/mo/json file names and the correct function for generating the

	# set the po/mo/json file names and the correct function for generating the

	# final output

	# final output

	po_file = '%s/%%s.po' % options.outdir

	create_final_output = {

	create_final_output = lambda x: None

			'json': dh_umc.create_json_file,

	if 'json' == options.type:

			'mo': dh_umc.create_mo_file,

		# output is json

			'po': lambda x: None,

		create_final_output = dh_umc.create_json_file

			}[options.type]

	elif 'mo' == options.type:

		# output is mo

		create_final_output = dh_umc.create_mo_file

	elif 'po' != options.type:

		# invalid output type

		print '\nThe output type needs to be one of the following: ".json", ".mo", ".po"!\n'

		sys.exit(1)

	# build translation files

	# build translation files

	for lang in dh_umc.LANGUAGES:

	for lang in dh_umc.LANGUAGES:

		ipo_file = po_file % lang

		ipo_file = os.path.join(options.outdir, '%s.po' % (lang,))

		if len(args):

		if len(args):

100

			# only re-create po files if javascript files are given

			# only re-create po files if javascript files are given

101

			dh_umc.create_po_file( ipo_file, options.package, args)

			dh_umc.create_po_file(ipo_file, options.package, args)

102

		create_final_output( ipo_file)

		create_final_output(ipo_file)

103

104

if __name__ == '__main__':

if __name__ == '__main__':

105

	main()

100

	main()




# -*- coding: utf-8 -*-
#
# Univention Configuration Registry
"""
Each module definition contains the following entries:

 Module: The internal name of the module
 Python: A directory containing the python module. There must be a subdirectory named like the internal name of the module.
 Definition: The XML definition of the module
 Javascript: The directory of the javascript code. In this directory must be a a file called <Module>.js
 Category: The XML definition of additional categories
 Icons: A directory containing the icons used by the module. The
   directory structure must follow the following pattern
   <weight>x<height>/<icon>.(png|gif)

The entry Category is optional.

Example:
 Module: ucr
 Python: umc/module
 Definition: umc/ucr.xml
 Javascript: umc/js
 Category: umc/categories/ucr.xml
 Icons: umc/icons
"""

#
# Copyright 2011-2012 Univention GmbH
#

CATEGORY = 'Category'
ICONS = 'Icons'

LANGUAGES = ('de',)

PO_HEADER = 'This file is auto-generated by the dh-umc tools and should not be edited!'
PO_METADATA = {

	'Content-Transfer-Encoding' : '8bit'
	}

"""Each module definition contains the following entries:

class UMC_Module(dict):
	"""
	Container for UMC module definition.
	"""
 Category: The XML definition of additional categories
 Icons: A directory containing the icons used by the module. The
   directory structure must follow the following pattern
   <weight>x<height>/<icon>.(png|gif)

	def __init__(self, *args):
		dict.__init__(self, *args)
		for key in (MODULE, PYTHON, JAVASCRIPT, DEFINITION, CATEGORY, ICONS):
			if key in self and self[key]:
				self[key] = self[key][0]
 Definition: umc/ucr.xml
 Javascript: umc/js
 Category: umc/categories/ucr.xml
 Icons: umc/icons
"""

class UMC_Module( dict ):
	def __init__( self, *args ):
		dict.__init__( self, *args )
		for key in ( MODULE, PYTHON, JAVASCRIPT, DEFINITION, CATEGORY, ICONS ):
			if key in self and self[ key ]:
				self[ key ] = self[ key ][ 0 ]

	@property
	def package(self):
		"""
		Return the name of the Debian binary package.
		"""
		return self.get('package')

	@property
	def python_path( self ):
		"""
		Return path to Python UMC directory.
		"""
		return '%(Python)s/%(Module)s/' % self

	@property
	def js_path( self ):
		"""
		Return path to JavaScript UMC directory.
		"""
		return '%(Javascript)s/' % self

	@property
	def js_module_file( self ):
		"""
		Return path to main JavaScript file.
		"""
		return '%(Javascript)s/%(Module)s.js' % self

	@staticmethod
	def _iter_files(base, suffix):
		"""
		Iterate over all files below base ending with suffix.
		"""
		for dirname, dirs, files in os.walk(base):
			# ignore .svn directories
			if '.svn' in dirs:
				dirs.remove('.svn')
			# we are only interested in .js files
			for ifile in files:
				if ifile.endswith(suffix):
					yield os.path.join(dirname, ifile)

	@property
	def js_files(self):
		"""
		Iterate over all JavaScript UMC files.
		"""
		return UMC_Module._iter_files(self.js_path, '.js')
		# 		dirs.remove( '.svn' )
		# 	# we are only interested in .js files
		# 	for ifile in files:
		# 		if ifile.endswith('.js'):
		# 			yield os.path.join(dirname, ifile)

	@property
	def html_files(self):
		"""
		Iterate over all JavaScript HTML files.
		"""
		return UMC_Module._iter_files(self.js_path, '.html')
		# 		dirs.remove( '.svn' )
		# 	# we are only interested in .js files
		# 	for ifile in files:
		# 		if ifile.endswith('.html'):
		# 			yield os.path.join(dirname, ifile)

	@property
	def module_name(self):
		"""
		Return the name of the UMC module.
		"""
		return self.__getitem__(MODULE)

	@property
	def xml_definition(self):
		"""
		Return the path to the XML UMC definition.
		"""
		return self.get(DEFINITION)

	@property
	def xml_categories(self):
		"""
		Return the path to the XML file defining categories.
		"""
		if CATEGORY in self:
			return self.get(CATEGORY, '')

	@property
	def python_files(self):
		"""
		Iterate over all Python UMC files.
		"""
		return UMC_Module._iter_files(self.python_path, '.py')

	@property
	def python_po_files(self):
		"""
		Iterate over all Python UMC message catalogs.
		"""
		path = '%(Python)s/%(Module)s/' % self
		for lang in LANGUAGES:
			yield os.path.join( path, '%s.po' % lang )

	@property
	def js_po_files( self ):
		"""
		Iterate over all JavaScript UMC message catalogs.
		"""
		for lang in LANGUAGES:
			yield os.path.join( self.__getitem__( JAVASCRIPT ), '%s.po' % lang )

	@property
	def xml_po_files(self):
		"""
		Iterate over all XML UMC message catalogs.
		"""
		if self.xml_definition is None:
			return
		dirpath = os.path.dirname(self.xml_definition)
		for lang in LANGUAGES:
			yield (lang, os.path.join(dirpath, '%s.po' % lang))

	@property
	def icons(self):
		"""
		Return path to UMC icon directory.
		"""
		return self.get(ICONS)


def read_modules(package, core=False):
	"""
	Read UMC module definition from debian/<package>.umc-modules.
	"""
	modules = []

	file_umc_module = os.path.join('debian', package + '.umc-modules')

	if not os.path.isfile(file_umc_module):
		return modules

	f_umc_module = open(file_umc_module, 'r')

	for item in dh_ucs.parseRfc822(f_umc_module.read()):
		# required fields
		if not core:
			for required in (MODULE, PYTHON, DEFINITION, JAVASCRIPT):
				if not required in item or not item[required]:
					raise AttributeError('UMC module definition incomplete. key %s missing' % (required,))

		# single values
		item['package'] = package
		module = UMC_Module(item)
		if core:
			if module.module_name != 'umc-core' or not module.xml_categories:
				raise ValueError( 'Module definition does not match core module' )
		modules.append(module)

	f_umc_module.close()

	return modules

def _appendPoEntry( poFile, xmlEntry ):
	"""Helper function to access text property of XML elements and to find the
	corresponding po-entry."""
	if xmlEntry != None:
		poFile.append( polib.POEntry( msgid = xmlEntry.text, msgstr = '' ) )

def module_xml2po(module, po_file, language):
	"""Create a PO file the XML definition of an UMC module"""
	message_pot = '%s/messages.pot' % (os.path.dirname(po_file) or '.',)

	pot = polib.POFile()
	pot.header = PO_HEADER
	pot.metadata = copy.copy(PO_METADATA)
	pot.metadata['Project-Id-Version'] = module.package
	pot.metadata['POT-Creation-Date'] = formatdate(localtime=True)
	pot.metadata['Language'] = language

	def _append_po_entry(xml_entry):
		"""Helper function to access text property of XML elements and to find the
		corresponding po-entry."""
		if xml_entry is not None:
			pot.append(polib.POEntry(msgid=xml_entry.text, msgstr=''))

	if module.xml_definition and os.path.isfile(module.xml_definition):
		tree = ET.ElementTree(file=module.xml_definition)
		_append_po_entry(tree.find('module/name'))
		_append_po_entry(tree.find('module/description'))
		for flavor in tree.findall('module/flavor'):
			_append_po_entry(flavor.find('name'))
			_append_po_entry(flavor.find('description'))

	if module.xml_categories and os.path.isfile(module.xml_categories):
		tree = ET.ElementTree(file=module.xml_categories)
		for cat in tree.findall('categories/category'):
			_append_po_entry(cat.find('name'))

	pot.save(message_pot)

	if os.path.isfile(po_file):
		dh_ucs.doIt('msgmerge', '--update', '--sort-output', po_file, message_pot)
		if os.path.isfile(message_pot):
			os.unlink(message_pot)
	else:
		dh_ucs.doIt('mv', message_pot, po_file)


def create_po_file(po_file, package, files, language='python'):
	"""Create a PO file for a defined set of files"""
	message_pot = '%s/messages.pot' % (os.path.dirname(po_file) or '.',)

	if os.path.isfile(message_pot):
		os.unlink(message_pot)
	if isinstance(files, basestring):
		files = [files]
	dh_ucs.doIt('xgettext',
			'--force-po',
			'--from-code=UTF-8',
			'--sort-output',
			'--package-name=%s' % (package,),
			'--msgid-bugs-address=packages@univention.de',
			'--copyright-holder=Univention GmbH',
			'--language', language,
			'-o', message_pot,
			*files)
	pot = polib.pofile(message_pot)
	pot.header = PO_HEADER
	pot.metadata['Content-Type'] = 'text/plain; charset=UTF-8'
	pot.save()

	if os.path.isfile(po_file):
		dh_ucs.doIt('msgmerge', '--update', '--sort-output', po_file, message_pot)
		if os.path.isfile(message_pot):
			os.unlink(message_pot)
	else:
		dh_ucs.doIt('mv', message_pot, po_file)


def create_mo_file( po_file ):
	"""
	Compile textual message catalog to binary message catalog.
	"""
	mo_file = po_file.replace('.po', '.mo')
	dh_ucs.doIt('msgfmt', '--check', '--output-file', mo_file, po_file)


def create_json_file( po_file ):
	"""
	Compile textual message catalog to JSON message catalog.
	"""
	json_file = po_file.replace('.po', '.json')
	pofile = polib.pofile(po_file)
	data = {}
	for entry in pofile:
		data[entry.msgid] = entry.msgstr

	json_fd = open(json_file, 'w')
	json_fd.write(json.dumps(data))
	json_fd.close()





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

# default values
MODULEID=
MODULENAME="Dummy module"
MODULEDESC="This is a dummy module"
PACKAGENAME=
CATEGORYNAME="system"
ICONFILE=
TEMPLATE="grid_with_detailpage"
NO_DEBIAN=

usage () {
	cat <<EOF
usage: ${0##*/} [<options>...] <moduleID> [<destinationDir>]
       ${0##*/} --list

destinationDir:
  If not given, it defaults to the current working directory.

options:
  --list         list available templates
  --name         displayed name of the module
  --description  verbose module description (shown as tooltip)
  --category     category id (default: $CATEGORYNAME)
  --package      package name
  --icon         path to SVG icon file
  --template     name of the template (default: $TEMPLATE)
  --template     name of the template (default: grid_with_detailpage)
  --no-debian    do not copy debian packages files

EOF
}

err () {
	usage
	exit 1
fi

function err() {
	echo
	echo "ERROR: $*"
	echo "... aborting"
	echo
	exit 1
}

warn () {
	echo
	echo "WARNING: $*"
	echo
}

SRC_DIR="/usr/share/univention-management-console-dev/umc-module-templates"
YEAR=$(date +'%Y')

replace_var () {
	local ikey str="$1"
	for ikey in MODULEID MODULENAME MODULEDESC PACKAGENAME CATEGORYNAME YEAR
	do
		str=${str//$ikey/${!ikey}}
	done
	echo "$str"
}

# default values
MODULEID=dummy
MODULENAME="Dummy module"
MODULEDESC="This is a dummy module"
PACKAGENAME=""
CATEGORYNAME="system"
ICONFILE=""
DESTDIR="$PWD"
TEMPLATE="grid_with_detailpage"
SRC_DIR="/usr/share/univention-management-console-dev/umc-module-templates"
YEAR=$(date +'%Y')
NO_DEBIAN=""

# parse the CLI parameters
while [ $# -ge 1 ]
do
	case "$1" in
		--help|-h)
			usgae
			exit 0
			;;
		--name)
			MODULENAME="$2"
			shift 2 || err "Missing argument"
			;;
		--description)
			MODULEDESC="$2"
			shift 2 || err "Missing argument"
			;;
		--category)
			CATEGORYNAME="$2"
			shift 2 || err "Missing argument"
			;;
		--package)
			PACKAGENAME="$2"
			shift 2 || err "Missing argument"
			;;
		--icon)
			ICONFILE="$2"
			shift 2 || err "Missing argument"
			;;
		--template)
			TEMPLATE="$2"
			shift 2 || err "Missing argument"
			;;
		--list)
			echo "Available templates:"
			find "$SRC_DIR" -maxdepth 1 -name debian -prune -o -type d -printf '  %P\n'
			exit 0
			;;
		--no-debian)
			NO_DEBIAN="yes"
			shift 1
			;;
		-*)
			err "Unknown option: $1"
			;;
		*)
			MODULEID="$1"
			break
			;;
	esac
done

[ -n "$MODULEID" ] || err "module ID missing!"
if [ ! -d "$SRC" ]; then
	echo "error: unknown template $TEMPLATE"
	exit 1
fi

SRC="$SRC_DIR/$TEMPLATE"
[ -d "$SRC" ] || err "unknown template $TEMPLATE"
	usage
	echo "error: module ID missing!"
	exit 1
fi

if [ $# -ge 1 ]
then
	DESTDIR=$(readlink -f "$1")
else
	DESTDIR="$PWD"
fi

# default values
if [ -z "$PACKAGENAME" ]
then
	PACKAGENAME=univention-management-console-module-$MODULEID
fi


[ -z "$NO_DEBIAN" ] && cp -r "$SRC_DIR/debian" "$moduleDir"

# fix directory and file names
for findParam in d f
do
	find "$moduleDir" -depth -type "$findParam" |
	while read ipath
	do
		jpath=$(replace_var "$ipath")
		[ "$ipath" != "$jpath" ] && mv "$ipath" "$jpath"
	done
done

# replace file content
sedParam=
for ikey in "${KEYS[@]}"
do
	eval "ival=\${$ikey}"
	sedParam="${sedParam}s/$ikey/$ival/g; "
done
find "$moduleDir" -type f -exec sed -i "$sedParam" {} +

# create empty changelog
cd "$moduleDir"
dch --create \
	--package "$PACKAGENAME" \
	--newversion 0.1.0-1 \
	--distribution unstable \
	"Initial release (Bug #XXXXXX)"

# custom icon file
icon="$moduleDir/umc/icons/scalable/$MODULEID.svgz"
if [ -n "$ICONFILE" ]
then
	# we got a custom icon file... remove the default and copy the custom icon
	ext=${ICONFILE##*.}
	rm -f "$icon"

fi

# scale icons
for size in 50 16
do
	out="$moduleDir/umc/icons/${size}x${size}/$MODULEID.png"
	mkdir -p "${out%/*}"
	if which inkscape > /dev/null 2>&1
	then
		# inkscape is available
		inkscape -C -w "$size" -h "$size" -e "$out" "$icon"
	elif which convert > /dev/null 2>&1
	then
		# ImageMagick is available
		convert -background none "$icon" -resize "${size}x${size}" "$out"
	else
		warn "Could not find inkscape or ImageMagick to convert SVG icon to PNG format."
	fi
done





		<categories>
			<category name="system"/>
		</categories>
		<command name="sanitize/bool" function="bool"/>
		<command name="sanitize/choices" function="choices"/>
		<command name="sanitize/dict" function="dict"/>
		<command name="sanitize/dict_a" function="dict_a"/>
		<command name="sanitize/email" function="email"/>
		<command name="sanitize/int" function="int"/>
		<command name="sanitize/ldapsearch" function="ldapsearch"/>
		<command name="sanitize/list" function="list"/>
		<command name="sanitize/list_a" function="list_a"/>
		<command name="sanitize/mapping" function="mapping"/>
		<command name="sanitize/pattern" function="pattern"/>
		<command name="sanitize/search" function="search"/>
		<command name="sanitize/string" function="string"/>
		<command name="sanitize/simple" function="simple"/>
		<command name="sanitize/multi" function="multi"/>
		<command name="sanitize/upload" function="upload"/>
	</module>
</umc>




<?xml version="1.0" encoding="UTF-8"?>
<umc version="2.0">
	<module id="MODULEID" icon="MODULEID" version="1.0">
		<name>MODULENAME</name>
		<description>MODULEDESC</description>
		<categories>
			<category name="CATEGORYNAME"/>
		</categories>
		<command name="MODULEID/query" function="query"/>
		<command name="MODULEID/colors" function="colors"/>
		<command name="MODULEID/get" function="get"/>
	</module>
</umc>




<?xml version="1.0" encoding="UTF-8"?>
<umc version="2.0">
	<module id="MODULEID" icon="MODULEID" version="1.0">
		<name>MODULENAME</name>
		<description>MODULEDESC</description>
		<categories>
			<category name="CATEGORYNAME"/>
		</categories>
		<command name="MODULEID/configuration" function="configuration"/>
		<command name="MODULEID/send" function="send"/>
	</module>
	<command name="MODULEID/send" function="send">
	</command>
  </module>
</umc>

Return to bug 31151