# -*- coding: utf-8 -*-
#
"""Univention Configuration Registry helper functions."""
# main configuration registry classes
#
# Copyright 2004-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 __future__ import print_function
import sys
import os
import re
import string # pylint: disable-msg=W0402
from pipes import quote as escape_value
try:
from typing import Dict, IO, List, Text # noqa: F401
except ImportError: # pragma: no cover
pass
__all__ = [
'replace_dict', 'replace_umlaut', 'directory_files',
'escape_value',
'key_shell_escape', 'validate_key', 'INVALID_KEY_CHARS',
]
[docs]def replace_dict(line, dictionary):
# type: (Text, Dict[Text, str]) -> Text
"""
Map any character from line to its value from dictionary.
>>> replace_dict('kernel', {'e': 'E', 'k': '', 'n': 'pp'})
'ErppEl'
"""
return ''.join((dictionary.get(_, _) for _ in line))
[docs]def replace_umlaut(line):
# type: (Text) -> Text
u"""
Replace german umlauts.
>>> replace_umlaut(u'überschrieben') == u'ueberschrieben'
True
"""
return replace_dict(line, UMLAUTS) # pylint: disable-msg=E1101
UMLAUTS = { # type: ignore # pylint: disable-msg=W0612
u'Ä': 'Ae',
u'ä': 'ae',
u'Ö': 'Oe',
u'ö': 'oe',
u'Ü': 'Ue',
u'ü': 'ue',
u'ß': 'ss',
}
def asciify(text):
# type: (str) -> str
"""
Replace any non-ASCII characters.
:param text: Input text.
:returns: Replaced text.
"""
return text.encode('ascii', 'replace').decode("ascii")
[docs]def key_shell_escape(line):
# type: (str) -> str
"""
Escape variable name by substituting shell invalid characters by '_'.
:param line: UCR variable name.
:returns: substitued variable name
"""
if not line:
raise ValueError('got empty line')
new_line = []
if line[0] in string.digits:
new_line.append('_')
for letter in line:
if letter in VALID_CHARS: # pylint: disable-msg=E1101
new_line.append(letter)
else:
new_line.append('_')
return ''.join(new_line)
VALID_CHARS = ( # type: ignore # pylint: disable-msg=W0612
string.ascii_letters + string.digits + '_')
[docs]def validate_key(key, out=sys.stderr):
# type: (Text, IO) -> bool
"""
Check if key consists of only shell valid characters.
:param key: UCR variable name to check.
:param out: Output stream where error message is printed to.
:returns: `True` if the name is valid, `False` otherwise.
"""
old = key
key = replace_umlaut(key)
if old != key:
print('Umlauts in config variable key are not recommended. Please consider renaming "%s" to %s.' % (old, key), file=out)
# return False # Bug #53742
if len(key) > 0:
if ': ' in key:
print('Please fix invalid ": " in config variable key "%s".' % (key,), file=out)
return False
match = INVALID_KEY_CHARS.search(key)
if not match:
return True
print('Please fix invalid character "%s" in config variable key "%s".' % (match.group(), key), file=out)
return False
INVALID_KEY_CHARS = re.compile('[][\r\n!"#$%&\'()+,;<=>?\\\\`{}§]')
[docs]def directory_files(directory):
# type: (str) -> List[str]
"""
Return a list of all files below the given directory.
:param directory: Base directory path.
:returns: List of absolute file names.
"""
result = []
for dirpath, _dirnames, filenames in os.walk(directory):
for filename in filenames:
filename = os.path.join(dirpath, filename)
if os.path.isfile(filename):
result.append(filename)
return result
# vim:set sw=4 ts=4 noet:
