#!/usr/bin/python3
# -*- coding: utf-8 -*-
"""
Univention common Python library for :command:`logrotate` configuration files.
"""
# Copyright 2010-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/>.
from typing import Dict # noqa: F401
from univention.config_registry import ConfigRegistry # noqa: F401
def _getBoolDefault(varGlobal, varLocal, settings, configRegistry):
# type: (str, str, Dict[str, str], ConfigRegistry) -> None
"""
Get default value of type boolean.
:param str varGlobal: The |UCR| variable name of the global setting.
:param str varLocal: The |UCR| variable name of the service specific setting.
:param dict settings: A mapping, where the configuration is stored in.
:param ConfigRegistry configRegistry: An |UCR| instance.
"""
configName = varGlobal.split("/")[-1]
if configRegistry.is_true(varGlobal, True):
settings[configName] = configName
if configRegistry.is_false(varLocal):
if settings.get(configName):
del settings[configName]
if configRegistry.is_true(varLocal, False):
settings[configName] = configName
[docs]def getLogrotateConfig(name, configRegistry):
# type: (str, ConfigRegistry) -> Dict[str, str]
"""
Build aggregated configuration for log file rotation.
:param str name: The name of the log file or service.
:param ConfigRegistry configRegistry: An |UCR| instance.
:returns: A dictionary containing the merged configuration.
:rtype: dict
>>> ucr = ConfigRegistry()
>>> ucr.load()
>>> conf = getLogrotateConfig('service', ucr)
"""
settings = {}
for var in ["logrotate/", "logrotate/" + name + "/"]:
if configRegistry.get(var + "rotate"):
settings["rotate"] = configRegistry[var + "rotate"]
if configRegistry.get(var + "rotate/count"):
settings["rotate/count"] = "rotate " + configRegistry[var + "rotate/count"]
if configRegistry.get(var + "create"):
settings["create"] = "create " + configRegistry[var + "create"]
_getBoolDefault("logrotate/missingok", "logrotate/" + name + "/missingok", settings, configRegistry)
_getBoolDefault("logrotate/compress", "logrotate/" + name + "/compress", settings, configRegistry)
_getBoolDefault("logrotate/notifempty", "logrotate/" + name + "/notifempty", settings, configRegistry)
return settings
