Source code for univention.management.console.error

#!/usr/bin/python3
#
# Univention Management Console
#  Exception classes for UMC modules
#
# SPDX-FileCopyrightText: 2017-2025 Univention GmbH
# SPDX-License-Identifier: AGPL-3.0-only


from tornado.web import HTTPError

from univention.lib.i18n import Translation
from univention.management.console.config import ucr


_ = Translation('univention.management.console').translate




[docs]
class UMC_Error(HTTPError):
    status = 400
    msg = None
    include_traceback = False

    def __init__(self, message=None, status=None, result=None, headers=None, traceback=None, reason=None):
        message = message or self.msg
        self.msg = message
        self.result = result
        self.headers = headers
        self.traceback = traceback
        if isinstance(status, int):
            self.status = status
        super().__init__(self.status, message, reason=reason)

    def __str__(self):
        return self.msg

    def __repr__(self):
        return HTTPError.__str__(self)






[docs]
class BadRequest(UMC_Error):
    msg = _('Bad request')
    status = 400






[docs]
class Unauthorized(UMC_Error):
    msg = _('Unauthorized')
    status = 401






[docs]
class Forbidden(UMC_Error):
    msg = _('Forbidden')
    status = 403






[docs]
class NotFound(UMC_Error):
    msg = _('Not found')
    status = 404






[docs]
class MethodNotAllowed(UMC_Error):
    msg = _('Method not allowed')
    status = 405






[docs]
class NotAcceptable(UMC_Error):
    status = 406






[docs]
class UnprocessableEntity(UMC_Error):
    status = 422






[docs]
class ServerError(UMC_Error):
    msg = _('Internal error')
    status = 500






[docs]
class BadGateway(UMC_Error):
    status = 502






[docs]
class ServiceUnavailable(UMC_Error):
    status = 503






[docs]
class PasswordRequired(Unauthorized):

    def __init__(self):
        message = _('This action requires you to supply your password.')
        super().__init__(message, self.status, {'password_required': True})






[docs]
class LDAP_ServerDown(UMC_Error):

    def __init__(self):
        ucr.load()
        self._is_master = ucr.get('server/role') == 'domaincontroller_master'
        self._updates_available = ucr.is_true('update/available')
        self._fqdn = '%(hostname)s.%(domainname)s' % ucr
        message = '\n'.join(self._error_msg())
        super().__init__(message, status=503, reason='LDAP Service Unavailable')

    def _error_msg(self):
        yield _('Cannot connect to the LDAP service.')
        yield _('The following steps can help to solve this problem:')
        if self._is_master:
            yield ' * ' + _('Check if enough hard disk space and free RAM is available on this server or free some resources')
        else:
            yield ' * ' + _('Make sure the Primary Directory Node is running and reachable from %s') % (self._fqdn,)
            yield ' * ' + _('Check if enough hard disk space and free RAM is available on this server and on the Primary Directory Node or free some resources')
        yield ' * ' + _('Restart the LDAP service on the Primary Directory Node either via "service slapd restart" on command line or with the UMC module "System services"')
        if self._updates_available:
            yield ' * ' + _('Install the latest software updates')


        # TODO: reuse but not in LDAP_ServerDown
        # yield _('If the problem persists additional hints about the cause can be found in the following log file(s):')
        # yield ' * /var/log/univention/management-console-server.log'
        # yield ' * /var/log/univention/management-console-module-*.log'




[docs]
class LDAP_ConnectionFailed(LDAP_ServerDown):

    def __init__(self, exc):
        self.exc = exc
        super().__init__()

    def _error_msg(self):
        yield _('Cannot connect to the LDAP service.')
        yield _('Error message: %s') % (self.exc.args[0].get('info', ''),)
        yield ''
        yield _('The following steps can help to solve this problem:')
        if not self._is_master:
            yield ' * ' + _('Make sure the Primary Directory Node is running and reachable from %s') % (self._fqdn,)
        yield ' * ' + _('Check the SSL certificates, proxy and firewall settings')
        yield ' * ' + _('In case the SSL certificates are expired or a recent renewal of the root SSL CA has been done, please consider http://sdb.univention.de/1183')
        yield ' * ' + _('Restart the LDAP service on the Primary Directory Node either via "service slapd restart" on command line or with the UMC module "System services"')
        if self._updates_available:
            yield ' * ' + _('Install the latest software updates')






[docs]
class OpenIDProvideUnavailable(ServiceUnavailable):

    def __init__(self, *args, **kwargs):
        kwargs['reason'] = 'OpenID-Provider Unavailable'
        super().__init__(*args, **kwargs)