#!/usr/bin/python3
# -*- coding: utf-8 -*-
#
# Univention App Center
# univention-app wrapper for ucr functions
#
# Copyright 2015-2022 Univention GmbH
#
# https://www.univention.de/
#
# All rights reserved.
#
# The source code of this program is made available
# under the terms of the GNU Affero General Public License version 3
# (GNU AGPL V3) as published by the Free Software Foundation.
#
# Binary versions of this program provided by Univention to you as
# well as other copyrighted, protected or trademarked materials like
# Logos, graphics, fonts, specific documentations and configurations,
# cryptographic keys etc. are subject to a license agreement between
# you and Univention and not subject to the GNU AGPL V3.
#
# In the case you use this program under the terms of the GNU AGPL V3,
# the program is provided in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public
# License with the Debian GNU/Linux or Univention distribution in file
# /usr/share/common-licenses/AGPL-3; if not, see
# <https://www.gnu.org/licenses/>.
#
import six
from univention.config_registry import ConfigRegistry
from univention.config_registry.frontend import ucr_update
from univention.config_registry.handler import run_filter
from copy import deepcopy
_UCR = ConfigRegistry()
_UCR.load()
[docs]def ucr_load():
_UCR.load()
[docs]def ucr_get(key, default=None):
return _UCR.get(key, default)
[docs]def ucr_save(values):
changed_values = {}
_UCR.load()
for k, v in values.items():
if _UCR.get(k) != v:
changed_values[k] = v
if changed_values:
ucr_update(_UCR, changed_values)
return changed_values
[docs]def ucr_includes(key):
return key in _UCR
[docs]def ucr_is_true(key, default=False, value=None):
return _UCR.is_true(key, default=default, value=value)
[docs]def ucr_is_false(key):
return _UCR.is_false(key)
[docs]def ucr_keys():
return _UCR.keys()
[docs]def ucr_evaluated_as_true(value):
if isinstance(value, six.string_types):
value = value.lower()
return _UCR.is_true(value=value)
[docs]def ucr_run_filter(string, additional=None):
ucr = _UCR
if additional:
# memory only ucr. not saved.
# if we would... NEVER __setitem__ on ucr!
ucr = deepcopy(ucr)
for k, v in additional.items():
ucr[k] = str(v)
value = run_filter(string, ucr)
if six.PY2:
return value
return value.decode('UTF-8')
[docs]def ucr_instance():
return _UCR
