#!/usr/bin/python3
# SPDX-FileCopyrightText: 2021-2025 Univention GmbH
# SPDX-License-Identifier: AGPL-3.0-only
from collections.abc import Iterator, Mapping, Sequence
from typing import Any
from univention.ldap_cache.log import debug
DB_DIRECTORY = '/usr/share/univention-group-membership-cache/caches'
[docs]
class Caches:
def __init__(self, db_directory: str = DB_DIRECTORY) -> None:
self._directory = db_directory
self._caches: dict[str, Any] = {}
def __iter__(self) -> Iterator[tuple[str, Any]]:
yield from self._caches.items()
[docs]
def get_shards_for_query(self, query: str) -> list['Shard']:
ret = []
for cache in self._caches.values():
for shard in cache.shards:
if shard.ldap_filter == query:
ret.append(shard)
return ret
[docs]
def get_sub_cache(self, name: str) -> Any:
return self._caches.get(name)
[docs]
def add(self, klass: type) -> None:
if not klass.ldap_filter or not klass.value:
return
debug('Adding %r', klass)
name = klass.db_name or klass.__name__
cache = self.get_sub_cache(name)
if cache is None:
cache = self._add_sub_cache(name, klass.single_value, klass.reverse)
cache.add_shard(klass)
def _add_sub_cache(self, name: str, single_value: bool, reverse: bool) -> Any:
raise NotImplementedError()
[docs]
class Shard:
ldap_filter: str | None = None
db_name: str | None = None
single_value = False
key = 'entryUUID'
value: str | None = None
attributes: list[str] = []
reverse = False
def __init__(self, cache: Any) -> None:
self._cache = cache
[docs]
def rm_object(self, obj: tuple[str, Mapping[str, Sequence[bytes]]]) -> None:
try:
key = self.get_key(obj)
except ValueError:
return
values = self.get_values(obj)
debug('Removing %s', key)
self._cache.delete(key, values)
[docs]
def add_object(self, obj: tuple[str, Mapping[str, Sequence[bytes]]]) -> None:
try:
key = self.get_key(obj)
except ValueError:
return
debug('Adding %s', key)
values = self.get_values(obj)
if values:
self._cache.save(key, values)
else:
self._cache.delete(key, [])
def _get_from_object(self, obj: tuple[str, Mapping[str, Sequence[bytes]]], attr: str) -> Sequence[Any]:
if attr == 'dn':
return [obj[0]]
return obj[1].get(attr, [])
[docs]
def get_values(self, obj: tuple[str, Mapping[str, Sequence[bytes]]]) -> Any:
return _s(self._get_from_object(obj, self.value))
[docs]
def get_key(self, obj: tuple[str, Mapping[str, Sequence[bytes]]]) -> Any:
values = self._get_from_object(obj, self.key)
if values:
return _s(values[0]).lower()
raise ValueError(self.key)
[docs]
class LdapCache:
def __init__(self, name: str, single_value: bool, reverse: bool) -> None:
self.name = name
self.single_value = single_value
self.reverse = reverse
self.shards: list[Shard] = []
[docs]
def add_shard(self, shard_class: type[Shard]) -> None:
self.shards.append(shard_class(self))
def _s(input: Any) -> Any:
if isinstance(input, list | tuple):
res: Any = []
for n in input:
if isinstance(n, bytes):
res.append(n.decode('utf-8'))
elif isinstance(list, tuple):
res.append(_s(n))
else:
res.append(n)
elif isinstance(input, bytes):
res = input.decode('utf-8')
else:
res = input
return res
