ssh-reg/private/ListUsers.py

#!/usr/bin/env python3

import configparser
import sqlite3  # sqlite3.Row-Object
from typing import List  # Typing support!

import lib.uis.default as default_cmd  # Follows -u, -a, -f flags
from lib.sqlitedb import SQLiteDB


class ListUsers:
    db = None
    usersFetch = None

    def __init__(self, db: str, unapproved: bool = False, approved: bool = True, single_user: str = None):
        """Constructs ListUsers

        :param db: Database to access
        :type db: str
        :param unapproved: only List unapproved users
        :type unapproved: bool
        :param approved: only list approved users
        :type approved: bool
        """

        self.db = SQLiteDB(db)
        if unapproved:  # only unapproved users
            query = "SELECT * FROM `applications` WHERE `status` = '0'"
        elif approved:  # Approved users
            query = "SELECT * FROM `applications` WHERE `status` = '1'"
        else:  # All users
            query = "SELECT * FROM `applications`"
        self.usersFetch = self.db.query(query)
        if single_user is not None:
            query = "SELECT * FROM `applications` WHERE `username` = ?"
            self.usersFetch = self.db.safequery(query, tuple([single_user]))

    def output_as_list(self) -> str:
        """Generates a string with one (approved) user per line and one newline at the end

        :rtype: str
        :return: String consisting with one(activated) user per line
        """

        list_str: str = ""
        query = "SELECT `username` FROM `applications` WHERE `status` = '1' ORDER BY timestamp ASC"
        self.usersFetch = self.db.query(query)
        for users in self.usersFetch:
            list_str += users["username"] + "\n"
        return list_str

    def prettyPrint(self) -> None:
        pass  # see below why not implemented yet, texttable...

    def get_fetch(self) -> List[sqlite3.Row]:
        """ Returns a complete fetch done by the lib.sqlitedb-class

        :return: Complete fetchall(). A List[sqlite3.Row] with dict-emulation objects.
        :rtype: List[sqlite3.Row]
        """

        return self.usersFetch


# @TODO MAYBE best solution: https://pypi.org/project/texttable/
# examle:
"""
from texttable import Texttable
t = Texttable()
t.add_rows([['Name', 'Age'], ['Alice', 24], ['Bob', 19]])
print(t.draw())
---------------> Results in:

+-------+-----+
| Name  | Age |
+=======+=====+
| Alice | 24  |
+-------+-----+
| Bob   | 19  |
+-------+-----+

              for user in fetch:
            print("ID: {}; Username: \"{}\"; Mail: {}; Name: \"{}\"; Registered: {}; Status: {}".format(
                user["id"], user["username"], user["email"], user["name"], user["timestamp"], user["status"]
            ))
"""
if __name__ == "__main__":
    default_cmd.argparser.description += " - Lists Users from the Tilde database."
    default_cmd.argparser.add_argument('--list-asc', default=False, action="store_true",
                                       help='Output a newline seperated list of users', required=False, dest="args_asc")
    default_cmd.argparser.add_argument('--user', default=None, type=str,
                                       help="Just show a specific user by it's name", required=False)
    args = default_cmd.argparser.parse_args()
    config = configparser.ConfigParser()
    config.read(args.config)

    ret = ""
    if args.user is not None:
        L = ListUsers(config['DEFAULT']['applications_db'], unapproved=args.unapproved, approved=args.approved,
                      single_user=args.user)
    else:
        L = ListUsers(config['DEFAULT']['applications_db'], unapproved=args.unapproved, approved=args.approved)
    if args.args_asc:
        ret = L.output_as_list()
    else:
        fetch = L.get_fetch()
        ret += "ID %-1s| Username %-5s| Mail %-20s| Name %-17s| Registered %-8s | State |\n" % (
            " ", " ", " ", " ", " "
        )
        ret += 102 * "-" + "\n"
        for user in fetch:
            ret += "%-4i| %-14s| %-25s| %-22s| %-8s | %-5i |\n" % (
                user["id"], user["username"], user["email"], user["name"], user["timestamp"], user["status"]
            )
    if args.file != "stdout":
        with open(args.file, 'w') as f:
            print(ret, file=f)
    else:
        print(ret)
    exit(0)