lodel2_mirror/lodel/auth/exceptions.py

from lodel import logger
from lodel.plugin.hooks import LodelHook

##@brief Handles common errors with a Client
class ClientError(Exception):
    ##@brief The logger function to use to log the error message
    _loglvl = 'warning'
    ##@brief Error str
    _err_str = "Error"
    ##@brief the hook name to trigger with error
    _action = 'lodel2_ui_error'
    ##@brief the hook payload
    _payload = None

    ##@brief Constructor
    #
    #Log message are build using the following format :
    #"<client infos> : <_err_str>[ : <msg>]"
    def __init__(self, client, msg = ""):
        msg = self.build_message(client, msg)
        if self._loglvl is not None:
            logfun = getattr(logger, self._loglvl)
            logfun(msg)
        super().__init__(msg)
        if self._action is not None:
            LodelHook.call_hook(self._action, self, self._payload)

    ##@brief build error message
    def build_message(self, client, msg):
        res = "%s : %s" % (client, self._err_str)
        if len(msg) > 0:
            res += " : %s" % msg
        return res

##@brief Handles authentication failure errors
class ClientAuthenticationFailure(ClientError):
    _loglvl = 'security'
    _err_str = 'Authentication failure'
    _action = 'lodel2_ui_authentication_failure'


##@brief Handles permission denied errors
class ClientPermissionDenied(ClientError):
    _loglvl = 'security'
    _err_str = 'Permission denied'
    _action = 'lodel2_ui_permission_denied'
    

##@brief Handles common errors on authentication
class ClientAuthenticationError(ClientError):
    _loglvl = 'error'
    _err_str = 'Authentication error'
    _action = 'lodel2_ui_error'