Authentication Class Reference

Class Authentication: Part of the module to hold the data of the current authentication session. More...

Public Member Functions
None	__init__ (self, "MainWindow" ui)
bool	check_user_login (self, EUser|list[EUser] user, Optional[EUser|str] user_to_check=None)
	Check if user log in.
bool	get_article_view_state (self)
	Get status if articles view.
str	get_user_name_from_position (self, int position)
	Get user name from position.
int|None	get_user_position (self, Optional[EUser|str] user=None)
	Get user position.
None	log_in (self)
	Log in user.
None	log_out (self)
	Log out user.
None	logout_callback (self)
	Logout timer callback.
None	refresh_timer (self)
	Start auto logout.
None	start_timer (self)
	Start auto logout.
None	stop_timer (self)
	deactivate auto logout.

Public Attributes
bool	b_login_state = False
	e_view = EWindowView.MAIN
	logout_timer = create_timer(parent=self.ui, callback=self.logout_callback)
str|None	s_login_user = None
str	s_pw = ""
	ui = ui

Detailed Description

Class Authentication: Part of the module to hold the data of the current authentication session.

Parameters

ui	: main window object

Definition at line 30 of file authentication.py.

Constructor & Destructor Documentation

__init__()

None __init__	(		self,
		"MainWindow"	ui )

Definition at line 36 of file authentication.py.

    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
 

Member Function Documentation

check_user_login()

bool check_user_login	(		self,
		EUser | list[EUser]	user,
		Optional[EUser | str]	user_to_check = None )

Check if user log in.

Parameters

user	: check if this user is logged in or list
user_to_check	: check this user (not logged in user)

Returns

status if this user is logged in

Definition at line 73 of file authentication.py.

    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
 

get_article_view_state()

bool get_article_view_state

(

self

)

Get status if articles view.

Returns

status of article view

Definition at line 155 of file authentication.py.

    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))

get_user_name_from_position()

str get_user_name_from_position	(		self,
		int	position )

Get user name from position.

Parameters

position

: user position

Returns

user name

Definition at line 123 of file authentication.py.

    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
 

get_user_position()

int | None get_user_position	(		self,
		Optional[EUser | str]	user = None )

Get user position.

Parameters

user	: get position of this user

Returns

user position

Definition at line 99 of file authentication.py.

    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
 

log_in()

None log_in

(

self

)

Log in user.

Definition at line 135 of file authentication.py.

    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
 

log_out()

None log_out

(

self

)

Log out user.

Definition at line 144 of file authentication.py.

    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
 

logout_callback()

None logout_callback

(

self

)

Logout timer callback.

Definition at line 44 of file authentication.py.

    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"])
 

refresh_timer()

None refresh_timer

(

self

)

Start auto logout.

Definition at line 66 of file authentication.py.

    def refresh_timer(self) -> None:
        """!
        @brief Start auto logout.
        """
        if self.logout_timer.isActive():
            self.start_timer()
 

start_timer()

None start_timer

(

self

)

Start auto logout.

Definition at line 53 of file authentication.py.

    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))
 

stop_timer()

None stop_timer

(

self

)

deactivate auto logout.

Definition at line 60 of file authentication.py.

    def stop_timer(self) -> None:
        """!
        @brief deactivate auto logout.
        """
        self.logout_timer.stop()
 

Member Data Documentation

b_login_state

bool b_login_state = False

Definition at line 39 of file authentication.py.

e_view

e_view = EWindowView.MAIN

Definition at line 40 of file authentication.py.

logout_timer

logout_timer = create_timer(parent=self.ui, callback=self.logout_callback)

Definition at line 42 of file authentication.py.

s_login_user

str | None s_login_user = None

Definition at line 38 of file authentication.py.

s_pw

str s_pw = ""

Definition at line 41 of file authentication.py.

ui

ui = ui

Definition at line 37 of file authentication.py.

---

The documentation for this class was generated from the following file:

• authentication.py