Toggle navigation

.rst .pdf

Contents

univention.lib package

univention.lib.get_lock(name, nonblocking=False)

Get a exclusive lock.

Parameters

• name (str) – The name for the lock file.

• nonblocking (bool) – Return None instead of waiting indefinitely to get the exclusive lock if the lock is already taken.

Returns

a file descriptor for a lock file after the file has been locked exclusively. In non-blocking mode None is returned if the lock cannot be gained.

Return type

file or None

The returned file descriptor has to be kept. Otherwise the lock will be release automatically on file descriptor’s destruction.

>>> fd = get_lock('myapp')
>>> # ...... do some critical stuff ......
>>> release_lock(fd)
>>>
>>> fd = get_lock('myapp', nonblocking=True)
>>> if not fd:
>>>     print('cannot get lock')
>>> else:
>>>     # ...... do some critical stuff ......
>>>     release_lock(fd)

univention.lib.release_lock(fd)

Releases the previously gained lock.

Parameters

fd (file) – The file descriptor of the lock file.

class univention.lib.Translation(namespace, locale_spec=None, localedir=None)

Bases: univention.lib.i18n.NullTranslation

Translation.

locale = <univention.lib.i18n.Locale object>

set_language(language='')

Select language.

Parameters

language (str) – The language code.

Raises

I18N_Error – if the given locale is not valid.

class univention.lib.NullTranslation(namespace, locale_spec=None, localedir=None)

Bases: object

Dummy translation.

Parameters

• namespace (str) – The name of the translation domain.

• locale_spec (str) – The selected locale.

• localedir (str) – The name of the directory containing the translation files.

property domain

set_language(language='')

Select language.

Parameters

language (str) – The language code.

property locale

Return currently selected locale.

Returns

The currently selected locale.

Return type

Locale

translate(message)

Translate message.

Parameters

message (str) – The message to translate.

Returns

The localized message.

Return type

str

class univention.lib.Locale(locale=None)

Bases: object

Represents a locale specification and provides simple access to language, territory, codeset and modifier.

Parameters

locale (str or None) – The locale string language[_territory][.codeset][@modifier].

>>> Locale("deu_GER")
>>> str(Locale("ca_ES@valencia"))
>>> str(Locale(""))

REGEX = re.compile('^(?P<language>([a-z]{2}|C|POSIX))(?:_(?P<territory>[A-Z]{2}))?(?:\\.(?P<codeset>[a-zA-Z-0-9]+))?(?:@(?P<modifier>.+))?$')

parse(locale)

Parse locale string.

Parameters

locale (str) – The locale string language[_territory][.codeset][@modifier].

Raises

• TypeError – if locale is not a string.

• I18N_Error – if locale does not match the format.

exception univention.lib.I18N_Error

Bases: Exception

Error in Internationalization.

Submodules

univention.lib.account module

python -m univention.lib.account lock –dn “$user_dn” –lock-time “$(date –utc ‘+%Y%m%d%H%M%SZ’)”

univention.lib.account.initialize_debug()

univention.lib.account.lock(userdn, lock_timestamp)

Lock a user account

• used by ppolicy OpenLDAP overlay

• used by PAM tally

>>> from univention.lib.account import lock  
>>> lock('uid=user1,dc=example,dc=com', '20141006192950Z')  

univention.lib.admember module

univention.lib.admember.initialize_debug()

exception univention.lib.admember.failedToSetService

Bases: Exception

ucs_addServiceToLocalhost failed

exception univention.lib.admember.invalidUCSServerRole

Bases: Exception

Invalid UCS Server Role

exception univention.lib.admember.failedADConnect

Bases: Exception

Connection to AD Server failed

exception univention.lib.admember.failedToSetAdministratorPassword

Bases: Exception

Failed to set the password of the UCS Administrator to the AD password

exception univention.lib.admember.failedToCreateAdministratorAccount

Bases: Exception

Failed to create the administrator account in UCS

exception univention.lib.admember.sambaSidNotSetForAdministratorAccount

Bases: Exception

sambaSID is not set for Administrator account in UCS

exception univention.lib.admember.failedToSearchForWellKnownSid

Bases: Exception

failed to search for well known SID

exception univention.lib.admember.failedToAddAdministratorAccountToDomainAdmins

Bases: Exception

failed to add Administrator account to Domain Admins

exception univention.lib.admember.domainnameMismatch

Bases: Exception

Domain Names don’t match

exception univention.lib.admember.connectionFailed

Bases: Exception

Connection to AD failed

exception univention.lib.admember.notDomainAdminInAD

Bases: Exception

User is not member of Domain Admins group in AD

exception univention.lib.admember.univentionSambaWrongVersion

Bases: Exception

univention-samba candidate has wrong version

exception univention.lib.admember.timeSyncronizationFailed

Bases: Exception

Time synchronization failed.

exception univention.lib.admember.manualTimeSyncronizationRequired

Bases: univention.lib.admember.timeSyncronizationFailed

Time difference critical for Kerberos but synchronization aborted.

exception univention.lib.admember.sambaJoinScriptFailed

Bases: Exception

26univention-samba.inst failed

exception univention.lib.admember.failedToAddServiceRecordToAD

Bases: Exception

failed to add SRV record in AD

exception univention.lib.admember.failedToGetUcrVariable

Bases: Exception

failed to get ucr variable

univention.lib.admember.is_localhost_in_admember_mode(ucr=None)

univention.lib.admember.is_localhost_in_adconnector_mode(ucr=None)

univention.lib.admember.is_domain_in_admember_mode(ucr=None)

univention.lib.admember.check_connection(ad_domain_info, username, password)

univention.lib.admember.flush_nscd_hosts_cache()

univention.lib.admember.decode_sid(value)

univention.lib.admember.check_ad_account(ad_domain_info, username, password, ucr=None)

returns True if account is Administrator in AD returns False if account is just a member of Domain Admins raises exception notDomainAdminInAD if neither criterion is met.

univention.lib.admember.prepare_administrator(username, password, ucr=None)

univention.lib.admember.synchronize_account_position(ad_domain_info, username, password, ucr=None)

univention.lib.admember.server_supports_ssl(server)

univention.lib.admember.enable_ssl()

univention.lib.admember.disable_ssl()

univention.lib.admember.add_admember_service_to_localhost()

univention.lib.admember.add_adconnector_service_to_localhost()

univention.lib.admember.remove_admember_service_from_localhost()

univention.lib.admember.info_handler(msg)

univention.lib.admember.error_handler(msg)

univention.lib.admember.remove_install_univention_samba(info_handler=<function info_handler>, step_handler=None, error_handler=<function error_handler>, install=True, uninstall=True)

univention.lib.admember.cldap_finddc(ip, use_samba_lib=True)

univention.lib.admember.get_defaultNamingContext(ad_server_ip, use_samba_lib=True)

univention.lib.admember.lookup_adds_dc(ad_server=None, ucr=None, check_dns=True)

CLDAP lookup

univention.lib.admember.set_timeserver(timeserver, ucr=None)

univention.lib.admember.stop_service(service)

univention.lib.admember.start_service(service)

univention.lib.admember.restart_service(service)

univention.lib.admember.invoke_service(service, cmd)

univention.lib.admember.do_time_sync(ad_ip)

univention.lib.admember.time_sync(ad_ip, tolerance=180, critical_difference=360)

Try to sync the local time with an AD server

univention.lib.admember.check_server_role(ucr=None)

univention.lib.admember.check_domain(ad_domain_info, ucr=None)

univention.lib.admember.set_nameserver(server_ips, ucr=None)

univention.lib.admember.rename_well_known_sid_objects(username, password, ucr=None)

univention.lib.admember.make_deleted_objects_readable_for_this_machine(username, password, ucr=None)

univention.lib.admember.prepare_dns_reverse_settings(ad_domain_info, ucr=None)

univention.lib.admember.prepare_kerberos_ucr_settings(realm=None, ucr=None)

univention.lib.admember.set_ucr(ucr_set, ucr_unset)

univention.lib.admember.prepare_ucr_settings()

univention.lib.admember.revert_ucr_settings()

univention.lib.admember.prepare_connector_settings(username, password, ad_domain_info, ucr=None)

univention.lib.admember.revert_connector_settings(ucr=None)

univention.lib.admember.disable_local_samba4()

univention.lib.admember.disable_local_heimdal()

univention.lib.admember.run_samba_join_script(username, password, ucr=None)

univention.lib.admember.add_host_record_in_ad(uid=None, binddn=None, bindpw=None, bindpwdfile=None, fqdn=None, ip=None, sso=False)

univention.lib.admember.get_domaincontroller_srv_record(domain, nameserver=None)

univention.lib.admember.add_domaincontroller_srv_record_in_ad(ad_ip, username, password, ucr=None)

univention.lib.admember.get_ucr_variable_from_ucs(host, server, var)

univention.lib.admember.set_nameserver_from_ucs_master(ucr=None)

univention.lib.admember.configure_ad_member(ad_server_ip, username, password)

univention.lib.admember.configure_backup_as_ad_member()

univention.lib.admember.configure_slave_as_ad_member()

univention.lib.admember.configure_member_as_ad_member()

univention.lib.admember.configure_container_as_ad_member()

univention.lib.admember.revert_backup_ad_member()

univention.lib.admember.revert_slave_ad_member()

univention.lib.admember.revert_member_ad_member()

univention.lib.admember.revert_container_ad_member()

univention.lib.atjobs module

Univention common Python library for handling at jobs.

This module abstracts the handling of at-jobs, each job is encapsulated by the class AtJob. Use the method add() in order to add a new command to the queue of at-jobs. Use the methods list() and load() to get a list of all registered jobs or to load a specific job given an ID, respectively. The module uses time stamps in seconds for scheduling jobs.

univention.lib.atjobs.add(cmd, execTime=None, comments={})

Add a new command to the job queue given a time at which the job will be executed.

Parameters

• execTime (int or float or datetime.datetime or None) – execution time either as seconds since the epoch or as a datetime.datetime instance. Defaults to now.

• comments (dict) – A optional dictionary with comments to be associated with the job.

Returns

The created job or None.

Return type

AtJob or None

univention.lib.atjobs.list(extended=False)

Returns a list of all registered jobs.

Parameters

extended (bool) – If set to True also the comments and the command to execute are fetched.

Returns

A list of AtJob instances.

Return type

list[AtJob]

This can be used to re-schedule a job.

univention.lib.atjobs.load(nr, extended=False)

Load the job given.

Parameters

• nr – Job number.

• extended (bool) – If set to True also the comments and the command to execute are fetched.

Returns

None if job does not exist, otherwise an instance of AtJob.

Return type

AtJob

univention.lib.atjobs.remove(nr)

Removes the at job with the given number.

Parameters

nr (int) – Job number.

univention.lib.atjobs.reschedule(nr, execTime=None)

Re-schedules the at job with the given number for the specified time.

Parameters

• nr (int) – The job number.

• execTime (int or float or datetime.datetime or None) – execution time either as seconds since the epoch or as a datetime.datetime instance. Defaults to now.

Returns

The created job or None.

Return type

AtJob or None

Raises

AttributeError: if the job cannot be found.

class univention.lib.atjobs.AtJob(nr, owner, execTime, isRunning)

Bases: object

This class is an abstract representation of an at-job. Do not initiate the class directly, but use the methods provided in this module.

Parameters

• nr (int) – Job number.

• owner (str) – User owning the job.

• execTime (datetime.datetime) – Planned job execution time.

• isRunning (bool) – True is the jub is currently running, False otherwise.

rm()

Remove the job from the queue.

univention.lib.fstab module

Handle parsing and writing /etc/fstab.

See <http://linux.die.net/include/mntent.h>.

exception univention.lib.fstab.InvalidEntry

Bases: Exception

Invalid entry in file system table

class univention.lib.fstab.File(file='/etc/fstab')

Bases: list

Handle lines of /etc/fstab.

Parameters

file (str) – The name of the file.

load()

Load entries from file.

find(**kargs)

Search and return the entry matching the criteria.

Parameters

kwargs – A mapping of Entry attributes to values.

Returns

The first entry matching all criteria or None.

Return type

Entry or None

get(filesystem=[], ignore_root=True)

Return list of entries matching a list of file system types.

Parameters

• filesystem (List[str]) – A list of file system names.

• ignore_root (bool) – Skip the root file system if True.

Returns

A list of matching entries.

Return type

List[Entry]

save(filename=None)

Save entries to file.

class univention.lib.fstab.Entry(spec, mount_point, fs_type, options='', dump=None, passno=None, comment=None)

Bases: object

Mount table entry of fstab(5).

Parameters

• spec (str) – This field describes the block special device or remote filesystem to be mounted.

• mount_point (str) – This field describes the mount point (target) for the filesystem.

• type (str) – The type of the filesystem.

• options (List[str]) – The list of mount options associated with the filesystem.

• dump (int) – Option for dump(8).

• passno (int) – Order information for fsck(8).

• comment (str) – Optional comment from end of line.

Variables

uuid (str) – The file system UUID if the file system is mounted by it. Otherwise None.

classmethod quote(s)

Quote string to octal.

>>> Entry.quote('a b')
'a\\040b'

classmethod unquote(s)

Unquote octal to string.

>>> Entry.unquote('a\040b')
'a b'

hasopt(opt)

Search for an option matching OPT.

>>> Entry('/dev/sda', '/', 'ext3', 'default,ro,user_xattr,acl', 0, 0).hasopt('user')
['user_xattr']

univention.lib.i18n module

Internationalization (i18n) utilities.

exception univention.lib.i18n.I18N_Error

Bases: Exception

Error in Internationalization.

class univention.lib.i18n.Locale(locale=None)

Bases: object

Represents a locale specification and provides simple access to language, territory, codeset and modifier.

Parameters

locale (str or None) – The locale string language[_territory][.codeset][@modifier].

>>> Locale("deu_GER")
>>> str(Locale("ca_ES@valencia"))
>>> str(Locale(""))

REGEX = re.compile('^(?P<language>([a-z]{2}|C|POSIX))(?:_(?P<territory>[A-Z]{2}))?(?:\\.(?P<codeset>[a-zA-Z-0-9]+))?(?:@(?P<modifier>.+))?$')

parse(locale)

Parse locale string.

Parameters

locale (str) – The locale string language[_territory][.codeset][@modifier].

Raises

• TypeError – if locale is not a string.

• I18N_Error – if locale does not match the format.

class univention.lib.i18n.NullTranslation(namespace, locale_spec=None, localedir=None)

Bases: object

Dummy translation.

Parameters

• namespace (str) – The name of the translation domain.

• locale_spec (str) – The selected locale.

• localedir (str) – The name of the directory containing the translation files.

property domain

set_language(language='')

Select language.

Parameters

language (str) – The language code.

property locale

Return currently selected locale.

Returns

The currently selected locale.

Return type

Locale

translate(message)

Translate message.

Parameters

message (str) – The message to translate.

Returns

The localized message.

Return type

str

class univention.lib.i18n.Translation(namespace, locale_spec=None, localedir=None)

Bases: univention.lib.i18n.NullTranslation

Translation.

locale = <univention.lib.i18n.Locale object>

set_language(language='')

Select language.

Parameters

language (str) – The language code.

Raises

I18N_Error – if the given locale is not valid.

univention.lib.ldap_extension module

Python function to register UDM extensions in LDAP.

exception univention.lib.ldap_extension.BaseDirRestriction

Bases: Exception

univention.lib.ldap_extension.safe_path_join(basedir, filename)

univention.lib.ldap_extension.set_handler_message(name, dn, msg)

univention.lib.ldap_extension.get_handler_message(name, binddn, bindpw)

class univention.lib.ldap_extension.UniventionLDAPExtension(ucr)

Bases: object

abstract property udm_module_name

abstract property target_container_name

abstract property active_flag_attribute

abstract property filesuffix

classmethod create_base_container(ucr, udm_passthrough_options)

is_local_active()

is_applicable_for_current_ucs_version(ucr)

wait_for_activation(timeout=180)

udm_find_object()

udm_find_object_dn()

register(filename, options, udm_passthrough_options, target_filename=None)

unregister(objectname, options, udm_passthrough_options)

mark_active(handler_name=None)

class univention.lib.ldap_extension.UniventionLDAPExtensionWithListenerHandler(ucr)

Bases: univention.lib.ldap_extension.UniventionLDAPExtension

abstract handler(dn, new, old, name=None)

class univention.lib.ldap_extension.UniventionLDAPSchema(ucr)

Bases: univention.lib.ldap_extension.UniventionLDAPExtensionWithListenerHandler

target_container_name = 'ldapschema'

udm_module_name = 'settings/ldapschema'

active_flag_attribute = 'univentionLDAPSchemaActive'

filesuffix = '.schema'

basedir = '/var/lib/univention-ldap/local-schema'

is_applicable_for_current_ucs_version(ucr)

handler(dn, new, old, name=None)

class univention.lib.ldap_extension.UniventionLDAPACL(ucr)

Bases: univention.lib.ldap_extension.UniventionLDAPExtensionWithListenerHandler

target_container_name = 'ldapacl'

udm_module_name = 'settings/ldapacl'

active_flag_attribute = 'univentionLDAPACLActive'

filesuffix = '.acl'

file_prefix = 'ldapacl_'

handler(dn, new, old, name=None)

class univention.lib.ldap_extension.UniventionDataExtension(ucr)

Bases: univention.lib.ldap_extension.UniventionLDAPExtension

target_container_name = 'data'

udm_module_name = 'settings/data'

active_flag_attribute = ''

filesuffix = ''

is_local_active()

wait_for_activation(timeout=180)

class univention.lib.ldap_extension.UniventionUDMExtension(ucr)

Bases: univention.lib.ldap_extension.UniventionLDAPExtension

target_subdir = ''

property target_filepath

return the most likely path where the listener will write the file to

wait_for_activation(timeout=180)

class univention.lib.ldap_extension.UniventionUDMModule(ucr)

Bases: univention.lib.ldap_extension.UniventionUDMExtension

target_container_name = 'udm_module'

udm_module_name = 'settings/udm_module'

active_flag_attribute = 'univentionUDMModuleActive'

filesuffix = '.py'

target_udm_module = None

target_subdir = 'handlers'

property target_filepath

return the most likely path where the listener will write the file to

register(filename, options, udm_passthrough_options, target_filename=None)

wait_for_activation(timeout=180)

class univention.lib.ldap_extension.UniventionUDMSyntax(ucr)

Bases: univention.lib.ldap_extension.UniventionUDMExtension

target_container_name = 'udm_syntax'

udm_module_name = 'settings/udm_syntax'

active_flag_attribute = 'univentionUDMSyntaxActive'

filesuffix = '.py'

target_subdir = 'syntax.d'

class univention.lib.ldap_extension.UniventionUDMHook(ucr)

Bases: univention.lib.ldap_extension.UniventionUDMExtension

target_container_name = 'udm_hook'

udm_module_name = 'settings/udm_hook'

active_flag_attribute = 'univentionUDMHookActive'

filesuffix = '.py'

target_subdir = 'hooks.d'

univention.lib.ldap_extension.option_validate_existing_filename(option, opt, value)

univention.lib.ldap_extension.option_validate_ucs_version(option, opt, value)

univention.lib.ldap_extension.option_validate_gnu_message_catalogfile(option, opt, value)

class univention.lib.ldap_extension.UCSOption(*opts, **attrs)

Bases: optparse.Option

TYPES = ('string', 'int', 'long', 'float', 'complex', 'choice', 'existing_filename', 'ucs_version')

TYPE_CHECKER = {'choice': <function check_choice>, 'complex': <function check_builtin>, 'existing_filename': <function option_validate_existing_filename>, 'float': <function check_builtin>, 'gnu_message_catalogfile': <function option_validate_gnu_message_catalogfile>, 'int': <function check_builtin>, 'long': <function check_builtin>, 'ucs_version': <function option_validate_ucs_version>}

univention.lib.ldap_extension.option_callback_udm_passthrough_options(option, opt_str, value, parser, *args)

univention.lib.ldap_extension.check_data_module_options(option, opt_str, value, parser)

univention.lib.ldap_extension.option_callback_set_data_module_options(option, opt_str, value, parser)

univention.lib.ldap_extension.option_callback_append_data_module_options(option, opt_str, value, parser)

univention.lib.ldap_extension.check_udm_module_options(option, opt_str, value, parser)

univention.lib.ldap_extension.option_callback_set_udm_module_options(option, opt_str, value, parser)

univention.lib.ldap_extension.option_callback_append_udm_module_options(option, opt_str, value, parser)

univention.lib.ldap_extension.check_udm_syntax_options(option, opt_str, value, parser)

univention.lib.ldap_extension.option_callback_append_udm_syntax_options(option, opt_str, value, parser)

univention.lib.ldap_extension.check_udm_hook_options(option, opt_str, value, parser)

univention.lib.ldap_extension.option_callback_append_udm_hook_options(option, opt_str, value, parser)

univention.lib.ldap_extension.ucs_registerLDAPExtension()

univention.lib.ldap_extension.ucs_unregisterLDAPExtension()

univention.lib.license_tools module

exception univention.lib.license_tools.LicenseCheckError

Bases: Exception

Generic error during license check

exception univention.lib.license_tools.LicenseExpired

Bases: univention.lib.license_tools.LicenseCheckError

The license is expired

exception univention.lib.license_tools.LicenseNotFound

Bases: univention.lib.license_tools.LicenseCheckError

The license cannot be found in LDAP

univention.lib.license_tools.is_CSP_license(lo=None)

Function to detect if installed license is a cloud service provider license (CSP).

Parameters

lo (univention.uldap.acceess) – Optional LDAP connection to re-use. Otherwise a new LDAP connection with machine credentials is created.

Returns

True if a valid CSP license has been found or False if a valid non-CSP license has been found.

Raises

• LicenseNotFound – if no license was found.

• LicenseExpired – if the license has expired.

univention.lib.listenerSharePath module

Univention Helper functions for creating or renaming share directories

univention.lib.listenerSharePath.dirIsMountPoint(path)

Check if path is a mount point.

Parameters

path (str) – The path to check.

Returns

A string if the path is a mount point, None otherwise.

Return type

str or None

univention.lib.listenerSharePath.checkDirFileSystem(path, cr)

Check if the given path is of a known file system type.

Parameters

• path (str) – A file system path.

• cr (ConfigRegistry) – A UCR instance.

Returns

A string if the path is a known file system, None otherwise.

Return type

str or None

univention.lib.listenerSharePath.createOrRename(old, new, cr)

Create or rename a share.

Parameters

• old (str) – The old path.

• new (str) – The new path.

• cr (ConfigRegistry) – A UCR instance.

Returns

A string if an error occurs, None on success.

Return type

str or None

univention.lib.listenerSharePath.is_blacklisted(path, ucr)

>>> is_blacklisted('/home/', {})
True
>>> is_blacklisted('/home/', {'listener/shares/whitelist/defaults': '/home/*:/var/*'})
False
>>> is_blacklisted('/home', {})
True
>>> is_blacklisted('/home', {'listener/shares/whitelist/defaults': '/home/*:/var/*'})
False
>>> is_blacklisted('/home/Administrator', {})
True
>>> is_blacklisted('/home/Administrator', {'listener/shares/whitelist/defaults': '/home/*:/var/*'})
False
>>> is_blacklisted('/home/Administrator/', {'listener/shares/whitelist/admin': '/home/Administrator'})
False
>>> is_blacklisted('/var/', {'listener/shares/whitelist/univention-printserver-pdf': '/var/spool/cups-pdf/*'})
True
>>> is_blacklisted('/var', {'listener/shares/whitelist/univention-printserver-pdf': '/var/spool/cups-pdf/*'})
True
>>> is_blacklisted('/var/spool/', {'listener/shares/whitelist/univention-printserver-pdf': '/var/spool/cups-pdf/*'})
True
>>> is_blacklisted('/var/spool/cups-pdf/', {'listener/shares/whitelist/univention-printserver-pdf': '/var/spool/cups-pdf/*'})
False

univention.lib.locking module

Univention Common Python Library for file locking

univention.lib.locking.get_lock(name, nonblocking=False)

Get a exclusive lock.

Parameters

• name (str) – The name for the lock file.

• nonblocking (bool) – Return None instead of waiting indefinitely to get the exclusive lock if the lock is already taken.

Returns

a file descriptor for a lock file after the file has been locked exclusively. In non-blocking mode None is returned if the lock cannot be gained.

Return type

file or None

The returned file descriptor has to be kept. Otherwise the lock will be release automatically on file descriptor’s destruction.

>>> fd = get_lock('myapp')
>>> # ...... do some critical stuff ......
>>> release_lock(fd)
>>>
>>> fd = get_lock('myapp', nonblocking=True)
>>> if not fd:
>>>     print('cannot get lock')
>>> else:
>>>     # ...... do some critical stuff ......
>>>     release_lock(fd)

univention.lib.locking.release_lock(fd)

Releases the previously gained lock.

Parameters

fd (file) – The file descriptor of the lock file.

univention.lib.misc module

Univention Common Python Library

univention.lib.misc.createMachinePassword()

Returns a $(pwgen) generated password according to the requirements in UCR variables machine/password/length and machine/password/complexity.

Returns

A password.

Return type

str

univention.lib.misc.getLDAPURIs(ucr=None)

Returns a space separated list of all configured LDAP servers, according to UCR variables ldap/server/name and ldap/server/addition.

Parameters

ucr (ConfigRegistry) – An optional UCR instance.

Returns

A space separated list of LDAP URI.

Return type

str

univention.lib.misc.getLDAPServersCommaList(ucr=None)

Returns a comma-separated string with all configured LDAP servers, ldap/server/name and ldap/server/addition.

Parameters

ucr (ConfigRegistry) – An optional UCR instance.

Returns

A space separated list of LDAP host names.

Return type

str

univention.lib.misc.custom_username(name, ucr=None)

Returns the customized user name configured via UCR users/default/*.

Parameters

• name (str) – A user name.

• ucr (ConfigRegistry) – An optional UCR instance.

Returns

The translated user name.

Return type

str

Raises

ValueError – if no name is given.

univention.lib.misc.custom_groupname(name, ucr=None)

Returns the customized group name configured via UCR groups/default/*.

Parameters

• name (str) – A group name.

• ucr (ConfigRegistry) – An optional UCR instance.

Returns

The translated group name.

Return type

str

Raises

ValueError – if no name is given.

univention.lib.package_manager module

Univention common Python Library for package management (info/install/progress…)

exception univention.lib.package_manager.LockError

Bases: Exception

Lock error for the package manager. Not to be confused with LockFailedException

class univention.lib.package_manager.ProgressState(parent_logger)

Bases: object

Track APT progress and report.

Parameters

parent_logger (logging.Logger) – The Logger of the parent.

reset()

Reset minimal progress state.

hard_reset()

Reset full progress state.

set_finished()

Mark installation as finished.

get_logger(logger_name=None)

Return (sub-)logger.

Parameters

logger_name (str) – The optional name for the sub-logger. If not given, the shared logger of the manager is used.

Returns

A Logger instance.

Return type

logging.Logger

info(info, logger_name=None)

Log info message.

Parameters

• info (str) – The info message to log.

• logger_name (str) – The optional name for the sub-logger. If not given, the shared logger of the manager is used.

percentage(percentage, logger_name='percentage')

Update progress information.

Parameters

• percentage (float) – The percentage of completeness.

• logger_name (str) – The optional name for the sub-logger. If not given, the shared logger of the manager is used.

error(error, logger_name=None)

Log error message.

Parameters

• error (str) – The error message to log.

• logger_name (str) – The optional name for the sub-logger. If not given, the shared logger of the manager is used.

add_start_steps(steps)

Add additional planned steps.

Parameters

steps (int) – The number of additional steps to add.

poll()

Return the aggregated state. The state is reset afterwards using reset().

Returns

A dictionary containing the last info and error message, number of steps and finished state.

Return type

dict

class univention.lib.package_manager.MessageWriter(progress_state)

Bases: object

Mimics a file() object supports flush() and write(). Writes no ‘r’, writes no empty strings, writes not just spaces. If it writes it is handled by progress_state.

Parameters

progress_state (ProgressState) – Instance which is responsible for collecting the state.

flush()

Dummy function to flush all pending writes.

write(msg)

Write sanitized message to the state collector.

Parameters

msg (str) – The message to write.

class univention.lib.package_manager.FetchProgress(*args: Any, **kwargs: Any)

Bases: apt.progress.text.AcquireProgress

Used to handle information about fetching packages. Writes a lot of __MSG__`es, as it uses :py:class:`MessageWriter.

Parameters

outfile (ProgressState) – An instance to receive the progress information.

start()

Start collection progress information.

class univention.lib.package_manager.DpkgProgress(*args: Any, **kwargs: Any)

Bases: apt.progress.base.InstallProgress

Report progress when installing or removing software. Writes messages (and percentage) from APT status file descriptor

fork()

Fork a child process for calling APT and setup pipes for progress reporting. The parent process will also start a Thread for reading the pipe.

Returns

The process identifier: 0 for the child, != 0 for the parent process.

Return type

int

check_pipe(pipe_read)

Internal function for reading the pipe and updating the progress status.

Parameters

read (file) – The pipe to read.

status_change(pkg, percent, status)

Update installation status and progress.

Parameters

• pkg (str) – The currently process package name.

• percent (float) – The progress.

• status (str) – The status message.

error(pkg, errormsg)

Report an error.

Parameters

• pkg (str) – The name of the binary package currently being processed.

• errormsg (str) – An error message.

class univention.lib.package_manager.PackageManager(lock=True, info_handler=None, step_handler=None, error_handler=None, always_noninteractive=True)

Bases: object

High-level package manager for UCS.

Parameters

• lock (bool) – Get an exclusive lock to prevent other instances from running in parallel.

• info_handler – Some handler to handle info messages.

• step_handler – Some handler to handle progress messages.

• error_handler – Some handler to handle error messages.

• always_noninteractive – Run dpkg in non-interactive mode to prevent any user input.

always_install(pkgs=None, just_mark=False)

Set packages that should be installed and never uninstalled. If you overwrite old always_install, make sure to call reopen_cache().

Parameters

• pkgs (list) – The list of packages to .

• just_mark (bool) – if True, process the previously saved list of packages instead of the given new list.

lock(raise_on_fail=True)

Get locks to prevent concurrent calls.

Parameters

raise_on_fail (bool) – Raise LockError instead of returning False.

Returns

True if all locks were are acquired, False otherwise.

Return type

bool

Raises

LockError – if the lock cannot be acquired.

unlock()

Release locks.

Returns

True if the manager lock was taken, False otherwise.

Return type

bool

is_locked()

Return the state of the lock.

Returns

True if the lock is acquired, False otherwise.

Return type

bool

locked(reset_status=False, set_finished=False)

Perform locking and cleanup actions before and after working with package state.

Parameters

• reset_status (bool) – Cancel all pending actions.

• set_finished (bool) – Call set_finished() at the end.

no_umc_restart(exclude_apache=False)

Run package manager with restart of UMC (and Apache) disabled.

Parameters

exclude_apache (bool) – If True Apache may be restarted.

add_hundred_percent()

Add another 100 steps.

set_max_steps(steps)

Set maximum number of steps.

Parameters

steps (int) – Number of steps.

set_finished()

Signal all steps done.

poll(timeout)

Poll for progress.

Parameters

timeout – Ignored

Returns

A dictionary containing the last info and error message, number of steps and finished state.

Return type

dict

reset_status()

Reset progress indicator back to start.

brutal_noninteractive()

Configure package manager to never ask for user input and to overwrite changed files

noninteractive()

Configure package manager to never ask for user input.

update()

apt-get update

Returns

True on success, `False otherwise.

Return type

bool

get_packages(pkg_names)

Get many Package-objects at once (only those that exist, write error for others)

Parameters

pkg_names – A list of binary package names.

Returns

A list of APT cache entries.

get_package(pkg_name, raise_key_error=False)

Get Package-object for package name.

Parameters

• pkg_name (str) – A binary package name.

• raise_key_error – Raise error when True, otherwise write an error message.

Returns

The APT cache entry for the binary package.

is_installed(pkg_name, reopen=False)

Returns whether a package is installed.

Parameters

• pkg_name (str) – A binary package name.

• reopen (bool) – Re-open the APT cache before checking.

Returns

True if installed, False if not, and None if package is not found.

packages(reopen=False)

Yields all packages in cache.

Parameters

reopen (bool) – Re-open the APT cache before returning.

mark_auto(auto, *pkgs)

Immediately sets packages to automatically installed (or not).

Parameters

• auto (bool) – Mark the packages as automatically installed (True) or not.

• pkgs – A list of binary package names.

Calls commit()!

mark(install, remove, dry_run=False)

Mark packages as automatically installed (or not).

Parameters

• install – A list of packages to install.

• remove – A list of packages to remove.

• dry_run (bool) – Only simulate the action if True.

Returns

A 3-tuple (to_be_installed, to_be_removed, broken), where each argument is a list of package names.

commit(install=None, remove=None, upgrade=False, dist_upgrade=False, msg_if_failed='')

Really commit changes (mark_install or mark_delete) or pass Package-objects that shall be committed. Never forgets to pass progress objects, may print error messages, always reopens cache.

Parameters

• install – List of package names to install.

• remove – List of package names to remove.

• upgrade – Perform upgrade were no new packages are installed.

• dist_upgrade – Perform upgrade were new packages may be installed and old packages may be removed.

• msg_if_failed – Test message to output if things go wrong.

Returns

True on success, False otherwise.

reopen_cache()

Reopen the APT cache.

Has to be done when the APT database changed.

autoremove()

Remove all packages which are no longer required.

It seems that there is nothing like self.cache.autoremove.

upgrade()

Instantly performs an apt-get upgrade.

Returns

True on success, False otherwise.

dist_upgrade()

Instantly performs an apt-get dist-upgrade.

Returns

True on success, False otherwise.

install(*pkg_names)

Instantly installs packages when found. Works like apt-get install and apt-get upgrade.

Parameters

pkg_names – A list of binary package names to install.

Returns

True on success, False otherwise.

uninstall(*pkg_names)

Instantly deletes packages when found.

Parameters

pkg_names – A list of binary package names to remove.

Returns

True on success, False otherwise.

univention.lib.password module

UDM library for changing user pasword

univention.lib.password.change(username, password)

Change the password of the given user

>>> from univention.lib.password import change  
>>> change('Administrator', 'secret12345')  
>>> change('Administrator@DOMAIN.DE', 'secret12345')  

univention.lib.policy_result module

exception univention.lib.policy_result.PolicyResultFailed(message, returncode)

Bases: Exception

univention.lib.policy_result.policy_result(dn, binddn='', bindpw='', encoding='UTF-8', ldap_server=None)

Return a tuple of hash-lists, mapping attributes to a list of values and mapping attributes to the matching Policy-DN.

>>> (results, policies) = policy_result('dc=univention,dc=local')
>>> policies['univentionDhcpDomainNameServers']
'cn=default-settings,cn=dns,cn=dhcp,cn=policies,dc=univention,dc=local'
results['univentionDhcpDomainNameServers']
['192.168.0.111']

univention.lib.policy_result.ucr_policy_result(dn, binddn='', bindpw='', encoding='UTF-8', ldap_server=None)

Return a tuple of hash-lists, mapping attributes to a list of values and mapping attributes to the matching Policy-DN.

univention.lib.s4 module

Univention common Python Library for common AD constants.

univention.lib.s4.well_known_sids = {'S-1-2': 'Local Authority', 'S-1-2-0': 'Local', 'S-1-2-1': 'Console Logon', 'S-1-3': 'Creator Authority', 'S-1-3-2': 'Creator Owner Server', 'S-1-3-3': 'Creator Group Server', 'S-1-4': 'Non-unique Authority', 'S-1-5': 'NT Authority', 'S-1-5-1': 'Dialup', 'S-1-5-32-544': 'Administrators', 'S-1-5-32-545': 'Users', 'S-1-5-32-546': 'Guests', 'S-1-5-32-547': 'Power Users', 'S-1-5-32-548': 'Account Operators', 'S-1-5-32-549': 'Server Operators', 'S-1-5-32-550': 'Print Operators', 'S-1-5-32-551': 'Backup Operators', 'S-1-5-32-552': 'Replicator', 'S-1-5-32-554': 'Pre-Windows 2000 Compatible Access', 'S-1-5-32-555': 'Remote Desktop Users', 'S-1-5-32-556': 'Network Configuration Operators', 'S-1-5-32-557': 'Incoming Forest Trust Builders', 'S-1-5-32-558': 'Performance Monitor Users', 'S-1-5-32-559': 'Performance Log Users', 'S-1-5-32-560': 'Windows Authorization Access Group', 'S-1-5-32-561': 'Terminal Server License Servers', 'S-1-5-32-562': 'Distributed COM Users', 'S-1-5-32-568': 'IIS_IUSRS', 'S-1-5-32-569': 'Cryptographic Operators', 'S-1-5-32-573': 'Event Log Readers', 'S-1-5-32-574': 'Certificate Service DCOM Access', 'S-1-5-80-0': 'All Services'}

Well known security identifiers.

univention.lib.s4.well_known_domain_rids = {'498': 'Enterprise Read-only Domain Controllers', '500': 'Administrator', '501': 'Guest', '502': 'KRBTGT', '512': 'Domain Admins', '513': 'Domain Users', '514': 'Domain Guests', '515': 'Domain Computers', '516': 'Domain Controllers', '517': 'Cert Publishers', '518': 'Schema Admins', '519': 'Enterprise Admins', '520': 'Group Policy Creator Owners', '521': 'Read-Only Domain Controllers', '522': 'Cloneable Domain Controllers', '553': 'RAS and IAS Servers', '571': 'Allowed RODC Password Replication Group', '572': 'Denied RODC Password Replication Group'}

Mapping of well known relative (security) identifiers to their (English) names.

See rids_for_well_known_security_identifiers for the reverse mapping.

univention.lib.s4.rids_for_well_known_security_identifiers = {'administrator': '500', 'allowed rodc password replication group': '571', 'cert publishers': '517', 'cloneable domain controllers': '522', 'denied rodc password replication group': '572', 'domain admins': '512', 'domain computers': '515', 'domain controllers': '516', 'domain guests': '514', 'domain users': '513', 'enterprise admins': '519', 'enterprise read-only domain controllers': '498', 'group policy creator owners': '520', 'guest': '501', 'krbtgt': '502', 'ras and ias servers': '553', 'read-only domain controllers': '521', 'schema admins': '518'}

Mapping of lower cases English names to to well known relative (security) identifiers.

See well_known_domain_rids for the reverse mapping.

univention.lib.share_restrictions module

class univention.lib.share_restrictions.Restrictions(name)

Bases: dict

INVALID_USERS = 'invalid users'

VALID_USERS = 'valid users'

HOSTS_DENY = 'hosts deny'

HOSTS_ALLOW = 'hosts allow'

property invalid_users

property valid_users

property hosts_deny

property hosts_allow

class univention.lib.share_restrictions.Share(name)

Bases: univention.lib.share_restrictions.Restrictions

class univention.lib.share_restrictions.Printer(name)

Bases: univention.lib.share_restrictions.Restrictions

property smbname

class univention.lib.share_restrictions.ShareConfiguration

Bases: object

SHARES_DIR = '/etc/samba/local.config.d'

SHARES_UDM_DIR = '/etc/samba/shares.conf.d'

PRINTERS_UDM_DIR = '/etc/samba/printers.conf.d'

POSTFIX = '.local.config.conf'

PREFIX = 'printer.'

INCLUDE_CONF = '/etc/samba/local.config.conf'

GLOBAL_CONF = '/etc/samba/local.config.d/global.local.config.conf'

CUPS_CONF = '/etc/cups/printers.conf'

delete()

delete all conf’s in SHARES_DIR and INCLUDE_CONF

read_shares()

get invalid user from samba share conf

read_printers()

get invalid/valid users from cups and samba config

read_ucr()

read()

write()

property globals

property shares

property printers

univention.lib.ucrLogrotate module

Univention common Python library for logrotate configuration files.

univention.lib.ucrLogrotate.getLogrotateConfig(name, configRegistry)

Build aggregated configuration for log file rotation.

Parameters

• name (str) – The name of the log file or service.

• configRegistry (ConfigRegistry) – An UCR instance.

Returns

A dictionary containing the merged configuration.

Return type

dict

>>> ucr = ConfigRegistry()
>>> ucr.load()
>>> conf = getLogrotateConfig('service', ucr)

univention.lib.ucs module

UCS release version.

class univention.lib.ucs.UCS_Version(version)

Bases: object

Version object consisting of major-, minor-number and patch-level

Parameters

version (list(int) or tuple(int) or str or UCS_Version) – must a str matching the pattern X.Y-Z or a triple with major, minor and patchlevel.

Raises

TypeError – if the version cannot be parsed.

>>> v = UCS_Version((2,3,1))
>>> UCS_Version([2,3,1]) == v
True
>>> UCS_Version("2.3-1") == v
True
>>> UCS_Version(v) == v
True

FORMAT = '%(major)d.%(minor)d'

FULLFORMAT = '%(major)d.%(minor)d-%(patchlevel)d'

property mm

2-tuple (major, minor) version

property mmp

3-tuple (major, minor, patch-level) version

set(version)

Parse string and set version.

Parameters

version (str) – A UCS release version string.

Raises

ValueError – if the string is not a valid UCS release version string.

univention.lib.umc module

Univention common Python library to manage connections to remote UMC servers

>>> umc = Client()
>>> umc.authenticate_with_machine_account()
>>> response = umc.umc_get('session-info')
>>> response.status
200
>>> response = umc.umc_logout()
>>> response.status
303

exception univention.lib.umc.ConnectionError(msg, reason=None)

Bases: Exception

Signal an error during connection setup.

Parameters

• msg (str) – A message string.

• reason – The optional underlying exception.

exception univention.lib.umc.HTTPError(request, response, hostname)

Bases: Exception

Base class for HTTP errors. A specialized sub-class if automatically instantiated based on the HTTP return code.

Parameters

• request – The HTTP request.

• response (httplib.HTTPResponse) – The HTTP response.

• hostname (str) – The host name of the failed server.

codes = {300: <class 'univention.lib.umc.HTTPRedirect'>, 301: <class 'univention.lib.umc.MovedPermanently'>, 302: <class 'univention.lib.umc.Found'>, 303: <class 'univention.lib.umc.SeeOther'>, 304: <class 'univention.lib.umc.NotModified'>, 400: <class 'univention.lib.umc.BadRequest'>, 401: <class 'univention.lib.umc.Unauthorized'>, 403: <class 'univention.lib.umc.Forbidden'>, 404: <class 'univention.lib.umc.NotFound'>, 405: <class 'univention.lib.umc.MethodNotAllowed'>, 406: <class 'univention.lib.umc.NotAcceptable'>, 422: <class 'univention.lib.umc.UnprocessableEntity'>, 500: <class 'univention.lib.umc.InternalServerError'>, 502: <class 'univention.lib.umc.BadGateway'>, 503: <class 'univention.lib.umc.ServiceUnavailable'>}

Specialized sub-classes for individual HTTP error codes.

property status

Return the HTTP status code.

Returns

the numerical status code.

Return type

int

property message

Return the HTTP status message.

Returns

the textual status message.

Return type

str

property result

Return the HTTP result.

Returns

the result data

Return type

str

exception univention.lib.umc.HTTPRedirect(request, response, hostname)

Bases: univention.lib.umc.HTTPError

httplib.MULTIPLE_CHOICES HTTP/1.1, RFC 2616, Section 10.3.1

code = 300

exception univention.lib.umc.MovedPermanently(request, response, hostname)

Bases: univention.lib.umc.HTTPRedirect

httplib.MOVED_PERMANENTLY HTTP/1.1, RFC 2616, Section 10.3.2

code = 301

exception univention.lib.umc.Found(request, response, hostname)

Bases: univention.lib.umc.HTTPRedirect

httplib.FOUND HTTP/1.1, RFC 2616, Section 10.3.3

code = 302

exception univention.lib.umc.SeeOther(request, response, hostname)

Bases: univention.lib.umc.HTTPRedirect

httplib.SEE_OTHER HTTP/1.1, RFC 2616, Section 10.3.4

code = 303

exception univention.lib.umc.NotModified(request, response, hostname)

Bases: univention.lib.umc.HTTPRedirect

httplib.NOT_MODIFIED HTTP/1.1, RFC 2616, Section 10.3.5

code = 304

exception univention.lib.umc.BadRequest(request, response, hostname)

Bases: univention.lib.umc.HTTPError

httplib.BAD_REQUEST HTTP/1.1, RFC 2616, Section 10.4.1

code = 400

exception univention.lib.umc.Unauthorized(request, response, hostname)

Bases: univention.lib.umc.HTTPError

httplib.UNAUTHORIZED HTTP/1.1, RFC 2616, Section 10.4.2

code = 401

exception univention.lib.umc.Forbidden(request, response, hostname)

Bases: univention.lib.umc.HTTPError

httplib.UNAUTHORIZED HTTP/1.1, RFC 2616, Section 10.4.4

code = 403

exception univention.lib.umc.NotFound(request, response, hostname)

Bases: univention.lib.umc.HTTPError

httplib.NOT_FOUND HTTP/1.1, RFC 2616, Section 10.4.5

code = 404

exception univention.lib.umc.MethodNotAllowed(request, response, hostname)

Bases: univention.lib.umc.HTTPError

httplib.METHOD_NOT_ALLOWED HTTP/1.1, RFC 2616, Section 10.4.6

code = 405

exception univention.lib.umc.NotAcceptable(request, response, hostname)

Bases: univention.lib.umc.HTTPError

httplib.NOT_ACCEPTABLE HTTP/1.1, RFC 2616, Section 10.4.7

code = 406

exception univention.lib.umc.UnprocessableEntity(request, response, hostname)

Bases: univention.lib.umc.HTTPError

httplib.UNPROCESSABLE_ENTITY WEBDAV, RFC 22518, Section 10.3

code = 422

exception univention.lib.umc.InternalServerError(request, response, hostname)

Bases: univention.lib.umc.HTTPError

httplib.INTERNAL_SERVER_ERROR HTTP/1.1, RFC 2616, Section 10.5.1

code = 500

exception univention.lib.umc.BadGateway(request, response, hostname)

Bases: univention.lib.umc.HTTPError

httplib.BAD_GATEWAY HTTP/1.1, RFC 2616, Section 10.5.3

code = 502

exception univention.lib.umc.ServiceUnavailable(request, response, hostname)

Bases: univention.lib.umc.HTTPError

httplib.SERVICE_UNAVAILABLE HTTP/1.1, RFC 2616, Section 10.5.4

code = 503

class univention.lib.umc.Request(method, path, data=None, headers=None)

Bases: object

The HTTP request.

Parameters

• method (str) – GET / POST / PUT / DELETE

• path (str) – the relative path to /univention/.

• data (str) – either the raw request payload or some data which must be encoded by get_body()

• headers (dict) – a mapping of HTTP headers

get_body()

Return the request data.

Returns

encodes data in JSON if Content-Type wants it

Return type

bytes

class univention.lib.umc.Response(status, reason, body, headers, _response)

Bases: object

The HTTP response.

Parameters

• status (int) – HTTP status code between 200 and 599.

• reason (str) – string with the reason phrase e.g. ‘OK’

• body (str) – the raw response body

• headers (list) – the response headers as list of tuples

• _response (httplib.HTTPResponse) – The original HTTP response.

property result

Return result from JSON data.

Returns

The result.

property message

Return message from JSON data.

Returns

The message.

get_header(name, default=None)

Return original HTTP response header.

Parameters

• name (str) – HTTP respone header name, e.g. Content-Type.

• default – Default value of the header is not set. Defaults to None.

Returns

The header value or None.

Return type

str or None

decode_body()

Decode HTTP response and return JSON data as dictionary.

Returns

JSON data is returned as a dictionary, all other as raw.

Return type

dict or str

class univention.lib.umc.Client(hostname=None, username=None, password=None, language=None, timeout=None, automatic_reauthentication=False)

Bases: object

A client capable to speak with a UMC server.

Parameters

• hostname (str) – The name of the host to connect. Defaults to the FQDN of the localhost.

• username (str) – A user name.

• password (str) – The password of the user.

• language (str) – The preferred language.

• timeout (float) – Set the default timeout in seconds (float) for new connections.

• automatic_reauthentication (bool) – Automatically re-authenticate and re-do requests if the authentication cookie expires.

ConnectionType

alias of http.client.HTTPSConnection

authenticate(username, password)

Authenticate against the host and preserves the cookie. Has to be done only once (but keep in mind that the session probably expires after 10 minutes of inactivity)

Parameters

• username (str) – A user name.

• password (str) – The password of the user.

reauthenticate()

Re-authenticate using the stored username and password.

set_basic_http_authentication(username, password)

Setup authentication using HTTP Basic authentication.

Parameters

• username (str) – A user name.

• password (str) – The password of the user.

authenticate_saml(username, password)

Setup authentication using SAML.

Parameters

• username (str) – A user name.

• password (str) – The password of the user.

Warning

not implemented.

authenticate_with_machine_account()

Setup authentication using the machine account.

Raises

ConnectionError – if /etc/machine.secret cannot be read.

umc_command(path, options=None, flavor=None, headers=None)

Perform generic UMC command.

Parameters

• path (str) – The URL path of the command after the command/ prefix.

• options (dict) – The argument for the UMC command.

• flavor (str) – Optional name of the UMC module flavor, e.g. users/user for UDM modules.

• headers (dict) – Optional HTTP headers.

Returns

The UMC response.

Return type

Response

umc_set(options, headers=None)

Perform UMC set command.

Parameters

• options (dict) – The argument for the UMC set command.

• headers (dict) – Optional HTTP headers.

Returns

The UMC response.

Return type

Response

umc_get(path, options=None, headers=None)

Perform UMC get command.

Parameters

• path (str) – The URL path of the command after the get/ prefix.

• options (dict) – The argument for the UMC get command.

• headers (dict) – Optional HTTP headers.

Returns

The UMC response.

Return type

Response

umc_upload()

Perform UMC upload action.

Warning

not implemented.

umc_auth(username, password, **data)

Perform UMC authentication command.

Parameters

• username (str) – A user name.

• password (str) – The password of the user.

• data – Additional argument for the UMC auth command.

Returns

The UMC response.

Return type

Response

umc_logout()

Perform UMC logout action.

Returns

The UMC response.

Return type

Response

request(method, path, data=None, headers=None)

Send request to UMC server handling re-authentication.

Parameters

• method (str) – The HTTP method for the request.

• path (str) – The URL of the request.

• data – The message body.

• headers (dict) – Optional HTTP headers.

Returns

The UMC response.

Return type

Response

Raises

Unauthorized – if the session expired and re-authentication was disabled.

send(request)

Low-level function to send request to UMC server.

Parameters

request (Request) – A UMC request.

Returns

The UMC response.

Return type

Response

Raises

• ConnectionError – if the request cannot be send.

• HTTPError – if an UMC error occurs.

univention.lib.umc_module module

Univention common Python library with helper functions for MIME type handling.

univention.lib.umc_module.get_mime_type(data)

Guess MIME type of data.

Parameters

data (bytes) – Some data.

Returns

The MIME type string.

Return type

str

univention.lib.umc_module.get_mime_description(data)

Guess type of data silimar to file.

Parameters

data (bytes) – Some data.

Returns

A descriptive string.

Return type

str

univention.lib.umc_module.compression_mime_type_of_buffer(data)

Guess MIME type of compressed data.

Parameters

data (bytes) – Some compressed data.

Returns

A 2-tuple (mime_type, uncompress_function).

Return type

tuple[str, str]

Raises

univention.admin.uexceptions.valueError – if the compression format is not recognized.

univention.lib.umc_module.uncompress_buffer(data)

Return uncompressed data and its MIME type.

Parameters

data (bytes) – Some compressed data.

Returns

A 2-tuple (mime_type, uncompressed_data). On errors mime_type is None and uncompressed_data is data.

Return type

tuple[str, bytes]

univention.lib.umc_module.uncompress_file(filename)

Return uncompressed file content and its MIME type.

Parameters

filename (str) – The name of the file.

Returns

A 2-tuple (mime_type, uncompressed_data). On errors mime_type is None and uncompressed_data is data.

Return type

tuple[str, bytes]

univention.lib.umc_module.image_mime_type_of_buffer(data)

Guess MIME type of image.

Parameters

data (bytes) – Some image data.

Returns

The MIME type string.

Return type

str

Raises

univention.admin.uexceptions.valueError – if the image format is not supported.

univention.lib.umc_module.imagedimensions_of_buffer(data)

Return image dimension of image.

Parameters

data (bytes) – Some image data.

Returns

A 2-tuple (width, height)

Return type

tuple[int, int]

univention.lib.umc_module.imagecategory_of_buffer(data)

Return MIME types and size information for image.

Strparam bytes data

Some (compressed) image data.

Returns

a 3-tuple (image_mime_type, compression_mime_type, dimension) where dimension is {width}x{height} or scalable. None if the format is not recognized.

Return type

tuple[str, str, str]

univention.lib.umc_module.default_filename_suffix_for_mime_type(mime_type, compression_mime_type)

Return default file name suffix for image.

Parameters

• mime_type (str) – The MIME type of the image.

• compression_mime_type (str) – The MIME type of the compression.

Returns

A suffix string or None if the image format is not supported.

Rytpe

str

previous

univention.ldap_cache.cache.backend package

next

univention.listener package