Source code for TUI.UIManager

"""
.. module:: UIManager
    :synopsis:

This module implements the necessary functions to make a functional Terminal User Interface application. This module
uses the `rich <https://pypi.org/project/rich/>`_ package to make a prettier TUI.

.. moduleauthor::
    `Alberto Jiménez <https://github.com/VLB3R70>`_
"""
import signal

import pyperclip as pc
from rich import print as nice_print
from rich.console import Console
from rich.markdown import Markdown
from rich.prompt import Prompt
from rich.table import Table

from CORE.DAODatabase import DAO
from .TUIHelp import HELP

dao = DAO()

USER = ""
USER_ID = 0


def handler(signum, frame):
    nice_print("\n[magenta][bold]Goodbye! 👋")
    exit(1)



[docs]def login():
    """

    This function is the first one to run. It shows the app logo and three decisions.

    * login
    * register
    * remember password

    The user has to select one of them by typing the number given. This function responds if the user types ``Ctrl+C``
    and leaves the app without throwing an exception. This function implements an infinite loop and asks the user for
    the three options. If the user fails during the login it asks about the three options again until enters the data
    successfully.
    When the user finish to register his account the prompt asks once again to select one of the three options.

    1. If the user decides to log in, the prompt ask for the username and the passwords. If they are correct it shows
    the main menu, if not, it asks once again for the password.

    2. If the user decides to register a new one, the prompt ask for the new username, his master password and his
    email. Before that, the prompt automatically redirects to the log in prompt again.

    .. note:: The `remember password` function is under development but in resume; this function will email the user
            with the value of the password.

    """
    global USER
    global USER_ID
    log_in = True
    logo = """[bold][magenta]________         ________      
|   ____|        |   __  |     
|   |__    ___   |  |__| |  __ _      ____   ____
|   ___|  |___|  |  _____| / _` |    / __/  / __/
|   |___         |  |      |(_| |  __\ \  __\ \ 
|_______|        |__|      \__,_| |____/ |____/"""
    description = "\n\n[bold][blue]Welcome to a fast and smart password manager for the linux terminal lovers.\n\n\n\n"
    signal.signal(signal.SIGINT, handler)
    console = Console()

    nice_print(logo + description)
    if dao.database_empty():
        nice_print(
            "[red]There is no user in this database. Please create a new one.\n\n"
        )

    while log_in:
        election = Prompt.ask(
            prompt="1. Login. \n2. Create a new user\n3. Remember password",
            choices=["1", "2", "3"],
        )
        if election == "1":
            username = Prompt.ask(prompt="[magenta]Enter your username:", default="")
            master_password = Prompt.ask(
                prompt="[magenta]Enter the master password:", default="", password=True
            )
            USER = username
            for i in dao.get_users():
                if (username in i) and (master_password == dao.get_master_password(user=USER)):
                    USER_ID = dao.get_user_id(username=USER)
                    nice_print("[green]Succesful login!")
                    main_menu()
                    log_in = False
                elif username not in i and master_password != dao.get_master_password(user=USER):
                    nice_print("[bold][red]Wrong password![yellow]Nice try[/yellow] 😉")
        elif election == "2":
            new_username = Prompt.ask(prompt="[cyan]Enter the username:", default="")
            new_master_password = Prompt.ask(
                prompt="[cyan]Enter the new master password",
                default="",
                password=True,
            )
            new_email = Prompt.ask("[cyan]Enter your email", default="")
            dao.new_user(
                username=new_username,
                master_password=new_master_password,
                email=new_email,
            )
            console.log(
                "[bold][italic][red]New master password created and all previous data deleted."
            )
        elif election == "3":
            # send an email with the password
            pass







[docs]def tui_help():
    """

    This function just simply shows a simple help for the user. It prints all the data from :py:mod:`TUI.TUIHelp` and
    then it exists the app

    """
    markdown = Markdown(HELP)
    nice_print(markdown)
    pass




[docs]def create_user_data_menu():
    """

    This function prints a table with all the data of the user. This function is called by the :py:func:`mainMenu()`
    when the user selects the option: 1. `List user data`

    :return: It returns a table with all the data

    :rtype: ``rich.table.Table``

    """
    menu = Table(show_lines=True)
    menu.add_column("ID", style="orange1")
    menu.add_column("Site name", style="purple3")
    menu.add_column("User name", style="green1")
    menu.add_column("Password")
    for row in dao.get_user_data(user_id=USER_ID):
        menu.add_row(str(row[0]), row[2], row[3], "*******")

    return menu




[docs]def create_main_menu():
    """

    This function prints a table with all the options to the user. This function is called by the :py:func:`mainMenu()`

    :return: It returns the table with the six options

    :rtype: ``rich.table.Table``

    """
    menu = Table(show_lines=True)
    menu.add_column("Selection number")
    menu.add_column("Description")
    menu.add_row("0", "Show menu")
    menu.add_row("1.", "List user data")
    menu.add_row("2", "Select a password")
    menu.add_row("3", "Add new entry")
    menu.add_row("4", "Update password")
    menu.add_row("5", "Update username")
    menu.add_row("6", "[bold][red]Delete an entry")
    menu.add_row("exit", "[yellow]Exit")

    return menu