amate.py

#!/usr/bin/python
# Arch Mate - Arch Linux management and configuration tool
# A simple, user-friendly tool for managing and configuring Arch Linux systems
# If it's installed just run 'amate' in your terminal!
# Description: "Arch Mate is a Python script designed to make it easier for users to manage and configure their Arch Linux systems. It provides a range of features, including package management, system configuration, and more, all within a user-friendly interface. With Arch Mate, you can easily maintain and optimize your Arch Linux system, saving time and effort."

import os
from time import sleep

# ----------------- Developer Variables -----------------------------
# If you are a developer and want to contribute, then change two Variables as needed.
# Set `__URL_ADDRESS__` to the raw file of your `amate.py`
# Set `__CURRENT_VERSION__` to a higher number to avoid conflicts.
__URL_ADDRESS__     = "https://raw.githubusercontent.com/SharafatKarim/archmate/main/amate.py"
__CURRENT_VERSION__ = "2.1"
# -------------------------------------------------------------------

# --------------------- Update Hook ---------------------------------
def compare_versions(current, new):
    new = new.split('\n')

    for i in new:
        if i[0:19] == "__CURRENT_VERSION__":
            new = i.split('"')[1]

    print("Updated version:", new)
    print("-----")

    if float(new) > float(current):
        return True
    elif float(new) < float(current):
        print("Ops... This is kinda weird.\nYou are currently running a newer version of Arch Mate.\nProbably you made some changes to the program!")
        print("The update is up to you. You will lose the changes you have done\n")
        print("Are you sure you want to download the version from the repository?")

        while True:
            response = input("(y/N) -> ")
            if response.lower() in ['y', 'Y', 'yes', 'YES', 'Yes']:
                return True
            elif response.lower() in ['n', 'N', 'no', 'NO', 'No']:
                exit()
            else:
                print("Please select either 'y' or 'n'")
    else:
        return False


# Makes an HTTP request to the amate.py from repo and return its content
def fetch_newer_version():
    import urllib.request
    with urllib.request.urlopen(__URL_ADDRESS__) as response:
        status = int(response.status)
        if status == 200:
            fetched_version = response.read()
            fetched_version = fetched_version.decode('utf-8')
            return fetched_version
        else:
            return -1


# Re-download not required!
def run_update(contents):
    user = os.getenv('USER')
    with open(f'/home/{user}/amate.py','w') as f:
        for i in contents:
            f.write(i)
    print("Update finished.")


# Shows the current version, grabs from the web the new version, then choose if run the update or no
def update_amate():
    print(f"Current version: {__CURRENT_VERSION__}")

    import urllib.error
    try:
        fetched_version = fetch_newer_version()
    except (urllib.error.HTTPError, urllib.error.URLError) :
        print("Can't fetch the version from the server! (Probably a network error)")
        exit()

    if compare_versions(__CURRENT_VERSION__, fetched_version):
        run_update(fetched_version)
    else:
        print("You are already up-to-date")
        print("There is nothing to do")

def check_amate_installed():
    user = os.getenv('USER')
    if os.path.isfile(f'/home/{user}/amate.py'):
        return True
    else:
        return False
# -------------------------------------------------------------------

# -------------------- Command Class --------------------------------
class Command:
    def __init__(self, category: str, description: str, command: str, prompt: str) -> None:
        self.category = category
        self.description = description
        self.command = command
        self.prompt = prompt
# -------------------------------------------------------------------
        
# Insert this in the command string. It will be replaced with the actual argument
argument_identifier = "__AMATE_ARGUMENT__"
classic_ask = "Your Choice -> "

###############################################################################################
# Insert here new commands
all_commands = [
    Command("Setup and Updates", "Package Data Sync Only", "sudo pacman -Syy", ""),
    Command("Setup and Updates", "Full System Update", "sudo pacman -Syyu", ""),
    Command("Setup and Updates", "Refresh Keys", "sudo pacman-key --refresh-keys", ""),
    Command("Setup and Updates", "Keyring Update/ Installation", "sudo pacman -Sy archlinux-keyring", ""),
    Command("Setup and Updates", "Base Package Ensure", "sudo pacman -S --needed --noconfirm base base-devel wget man", ""),
    Command("Setup and Updates", "Noto Sans (full dependency)", "sudo pacman -S --needed --noconfirm noto-fonts && sudo pacman -S --needed --noconfirm --asdeps noto-fonts-cjk  noto-fonts-emoji noto-fonts-extra", ""),
    Command("Setup and Updates", "Chaotic AUR Installer", "wget -q -O chaotic-AUR-installer.bash https://raw.githubusercontent.com/SharafatKarim/chaotic-AUR-installer/main/install.bash && sudo bash chaotic-AUR-installer.bash && rm chaotic-AUR-installer.bash", ""),

    Command("Mirror and Repository Management", "Print current mirrors", "cat /etc/pacman.d/mirrorlist", ""),
    Command("Mirror and Repository Management", "Mirrorlist Edit", "sudo ${EDITOR:-nano} /etc/pacman.d/mirrorlist", ""),
    Command("Mirror and Repository Management", "Reflector Install or Update", "sudo pacman -S --needed --noconfirm reflector", ""),
    Command("Mirror and Repository Management", "Reflector Mirror Setup for Specific Country", f"sudo reflector -c {argument_identifier} --save /etc/pacman.d/mirrorlist", "Your country name or code -> "),
    Command("Mirror and Repository Management", "List all Repository", "grep '^\[.*\]' /etc/pacman.conf | grep -v 'options' | sed 's/\[//g' | sed 's/\]//g'", ""),
    Command("Mirror and Repository Management", "Pacman Configuration", "sudo ${EDITOR:-nano} /etc/pacman.conf", ""),
    
    Command("Package Management", "Install packages", f"sudo pacman -S --needed --noconfirm {argument_identifier}", "Enter your package names (for multiple value, separate with space)\n-> "),
    Command("Package Management", "Install packages as dependency", f"sudo pacman -S --needed --noconfirm --asdeps {argument_identifier}", "Enter your package names (for multiple value, separate with space)\n-> "),
    Command("Package Management", "Uninstall packages", f"sudo pacman -Rns {argument_identifier}", "Enter your package names (for multiple value, separate with space)\n-> "),
    Command("Package Management", "Search packages", f"sudo pacman -Ss {argument_identifier}", "Enter your package name\n-> "),
    Command("Package Management", "DB lock remove", "sudo rm /var/lib/pacman/db.lck", ""),
    Command("Package Management", "List system + explicit + dependency packages", "pacman -Q", ""),
    Command("Package Management", "List system packages", "pacman -Qet", ""),
    Command("Package Management", "List explicit packages", "pacman -Qe", ""),
    Command("Package Management", "List orphan packages", "pacman -Qdt", ""),
    
    Command("System Cleanups", "Remove orphan packages", "sudo -S pacman -R --noconfirm $(pacman -Qdtq)", ""),
    Command("System Cleanups", "Pacman Cache Cleanup", "sudo pacman -Scc", ""),
    Command("System Cleanups", "Home directory cache Size", "du -sh ~/.cache/", ""),
    Command("System Cleanups", "Home directory cache Clean", "rm -rf ~/.cache/*", ""),
    Command("System Cleanups", "Systemd jounal Cleanup", "sudo journalctl --vacuum-size=50M", ""),
    Command("System Cleanups", "Filelight install/update", "pacman -S --noconfirm --needed filelight", ""),

    Command("System Configuration", "GRUB Configuration", "sudo ${EDITOR:-nano} /etc/default/grub", ""),
    Command("System Configuration", "GRUB Update", "sudo grub-mkconfig -o /boot/grub/grub.cfg", ""),
    Command("System Configuration", "locale-gen file", "sudo ${EDITOR:-nano} /etc/locale.gen", ""),
    Command("System Configuration", "locale-gen update", "sudo locale-gen", ""),

    Command("User Management", "List Users", "cat /etc/passwd | grep /home/", ""),
    Command("User Management", "List Active Users", "who", ""),
    Command("User Management", "Add User (wheel)", f"sudo useradd -m -G wheel {argument_identifier}", "Enter your username -> "),
    Command("User Management", "Add User without group", f"sudo useradd -m {argument_identifier}", "Enter your username -> "),
    Command("User Management", "Remove User including home data", f"sudo userdel -r {argument_identifier}", "Enter your username -> "),
    Command("User Management", "Remove User keeping home data", f"sudo userdel {argument_identifier}", "Enter your username -> "),
    Command("User Management", "VISUDO - users permission", "sudo EDITOR=$EDITOR visudo", ""),

    Command("Information Center", "Operating System and Kernel", "uname -a && cat /etc/os-release", ""),
    Command("Information Center", "CPU", "lscpu", ""),
    Command("Information Center", "Disks and Partitions", "lsblk -a", ""),
    Command("Information Center", "PCI devices and USB", "lspci", ""),
    Command("Information Center", "Partition and File System", "sudo fsdisk -l", ""),
    Command("Information Center", "DMI table", "sudo dmidecode", ""),
    Command("Information Center", "IP address", "ip addr", ""),

    Command("Troubleshooting", "Uninstall this script (if installed)", "curl -s https://raw.githubusercontent.com/SharafatKarim/archmate/main/uninstall.py > .amate-uninstaller.py && python .amate-uninstaller.py && rm .amate-uninstaller.py", ""),
    Command("Troubleshooting", "Manjaro Bangla font issue", "curl -s https://raw.githubusercontent.com/SharafatKarim/Manjaro-Bangla-Font-Fix/main/main.sh | bash", ""),
]
###############################################################################################


# ------------------------ Welcome Screen -------------------------------------------
def cowsay(message):
    lines = message.split('\n')
    width = max(len(line) for line in lines)
    cow = r'''
         \   ^__^
          \  (oo)\_______
             (__)\       )\/\
                 ||----w |
                 ||     ||
    '''
    result = []
    result.append(' ' + '_' * width)
    for line in lines:
        result.append('< ' + line.ljust(width) + ' >')
    result.append(' ' + '-' * width)
    result.append(cow)
    return '\n'.join(result)

def welcome_screen():
    message = "Welcome to ArchMate!\nIt'll help you to configure and manage\nyour system easily and efficiently!"
    print(cowsay(message))
# -------------------------------------------------------------------

# ---------------------- I/O ----------------------------------------
# parameters: menu title, list to be printend, if the 0) option is exit
def menu_formatter(title, list, exit: bool):
    are_commands = True if type(list[0]) == Command else False
    
    print(title)
    print("------")
    for i in range(len(list)):
        if are_commands:
            print(f"{i+1}) {list[i].description}")
        else:
            print(f"{i+1}) {list[i]}")
    print("------")
    if exit:
        if check_amate_installed():
            print(f"{len(list)+1}) Update Arch Mate")
        print("0) Exit")
    else:
        print("0) Back")


# Reads only integers in a given range. Asks again if invalid
def secure_input_int(prompt, range):
    value = 0
    while True:
        try:
            value = int(input(prompt)) - 1
            if -1 <= value < range:
                break
            else:
                print('Invalid input. Please try again.')
                sleep(0.5)
        except ValueError:
            print('Invalid input. Please try again.')
            sleep(0.5)
    return value

# Reads only valid strings. Asks again if invalid
def secure_input_string(prompt):
    value = ""
    while True:
        try:
            value = input(prompt)
            if value != '':
                break
            else:
                print('Invalid input. Please try again')
                sleep(0.5)
        except ValueError:
                print('Invalid input. Please try again')
                sleep(0.5)
    return value
# -------------------------------------------------------------------


def sub_menu(category: str):
    # grab all commands of the chosen category
    category_commands = [cmd for cmd in all_commands if cmd.category == category]
    while True:
        print("\n")
        menu_formatter(category, category_commands, False)
        selected_command = secure_input_int(classic_ask, len(category_commands))
        if selected_command == -1:
            break
        if category_commands[selected_command].prompt != "":
            # Asks the user for the additional input
            command_argument = secure_input_string(category_commands[selected_command].prompt)
            # Compose the command using the new input
            category_commands[selected_command].command = category_commands[selected_command].command.replace(argument_identifier, command_argument)
        os.system(category_commands[selected_command].command)
        print("\n")
    

def main_menu():
    # take categories
    categories = [cmd.category for cmd in all_commands]
    unique_elements = []
    for element in categories:
        if element not in unique_elements:
            unique_elements.append(element)
    categories = unique_elements
    n_categories = len(categories)
    updater_index = n_categories
    
    while True:
        print("\n")
        menu_formatter("Main Menu", categories, True)
        if check_amate_installed():
            chosen_category = secure_input_int(classic_ask, n_categories+1)
        else:
            chosen_category = secure_input_int(classic_ask, n_categories)
        if chosen_category == -1:
            break
        elif chosen_category == updater_index:
            update_amate()
        else:
            sub_menu(categories[chosen_category])


if __name__ == "__main__":
    welcome_screen()
    main_menu()