authentication.py

Go to the documentation of this file.

"""!
********************************************************************************
@file   authentication.py
@brief  User authentication
********************************************************************************
"""
 
import logging
import enum
from typing import Optional, TYPE_CHECKING
 
from Source.version import __title__
from Source.Util.app_data import EUser, L_CONFIG_USER
from Source.Util.gui_toolkit import create_timer
if TYPE_CHECKING:
    from Source.Controller.main_window import MainWindow
 
log = logging.getLogger(__title__)
 
 
class EWindowView(str, enum.Enum):
    """!
    @brief View of window.
    """
    MAIN = "main"
    CALC = "calc"
    MULTI = "multi"
 
 
class Authentication:
    """!
    @brief Class Authentication: Part of the module to hold the data of the current authentication session
    @param ui : main window object
    """
 
    def __init__(self, ui: "MainWindow") -> None:
        self.ui = ui
        self.s_login_user: str | None = None
        self.b_login_state = False
        self.e_view = EWindowView.MAIN
        self.s_pw = ""
        self.logout_timer = create_timer(parent=self.ui, callback=self.logout_callback)  # statusbar timer
 
    def logout_callback(self) -> None:
        """!
        @brief Logout timer callback
        """
        b_logout = True
        if b_logout:
            self.ui.btn_lock_clicked(b_auto_logout=True)
            self.ui.set_status(["Inactivity - automatic logout", "Inaktivität - automatische Abmeldung"])
 
    def start_timer(self) -> None:
        """!
        @brief Start auto logout.
        """
        f_timeout = self.ui.model.c_config.get_logout_time()
        self.logout_timer.start(int(f_timeout * 1000))
 
    def stop_timer(self) -> None:
        """!
        @brief deactivate auto logout.
        """
        self.logout_timer.stop()
 
    def refresh_timer(self) -> None:
        """!
        @brief Start auto logout.
        """
        if self.logout_timer.isActive():
            self.start_timer()
 
    def check_user_login(self, user: EUser | list[EUser], user_to_check: Optional[EUser | str] = None) -> bool:
        """!
        @brief Check if user log in.
        @param user : check if this user is logged in or list
        @param user_to_check : check this user (not logged in user)
        @return status if this user is logged in
        """
        b_user_logged_in = False
        check_user = self.s_login_user if (user_to_check is None) else user_to_check
        if check_user is not None:
            if isinstance(user, list):
                if check_user in user:
                    b_user_logged_in = True
                elif EUser.B in user:
                    if check_user[0] == EUser.B:
                        b_user_logged_in = True
            else:
                match user:
                    case EUser.B:
                        if check_user[0] == user:
                            b_user_logged_in = True
                    case _:
                        if check_user == user:
                            b_user_logged_in = True
        return b_user_logged_in
 
    def get_user_position(self, user: Optional[EUser | str] = None) -> int | None:
        """!
        @brief Get user position.
        @param user : get position of this user
        @return user position
        """
        i_user_pos = None
        get_user = self.s_login_user if (user is None) else user
        match get_user:
            case EUser.LOCAL | EUser.FREE:
                i_user_pos = 0
            case _:
                if self.check_user_login(EUser.B, user_to_check=get_user):
                    if get_user is not None:
                        i_user_pos = int(get_user[1:])
                    else:
                        i_user_pos = None
                        self.ui.set_status("Invalid User for B", True)  # state not possible
                else:
                    i_user_pos = None
                    if not self.check_user_login(EUser.USER, user_to_check=get_user):
                        self.ui.set_status(f"Invalid User for position: {get_user}", True)  # state not possible
        return i_user_pos
 
    def get_user_name_from_position(self, position: int) -> str:
        """!
        @brief Get user name from position
        @param position : user position
        @return user name
        """
        if position == 0:
            user = EUser.LOCAL.value
        else:
            user = EUser.B.value + str(position)
        return user
 
    def log_in(self) -> None:
        """!
        @brief Log in user.
        """
        self.b_login_state = True
        if self.check_user_login(EUser.B) or (self.check_user_login(EUser.FREE) and self.ui.model.c_config.get_free_auto_logout()):
            self.start_timer()
        self.ui.clear_status()  # to update user in statusbar
 
    def log_out(self) -> None:
        """!
        @brief Log out user.
        """
        if self.b_login_state:
            self.e_view = EWindowView.MAIN
            self.b_login_state = False
            self.s_login_user = None
        self.stop_timer()
        self.ui.clear_status()  # to update user in statusbar
 
    def get_article_view_state(self) -> bool:
        """!
        @brief Get status if articles view.
        @return status of article view
        """
        return bool(self.b_login_state and (self.e_view == EWindowView.MAIN))