kiauh/kiauh/extensions/extensions_menu.py

# ======================================================================= #
#  Copyright (C) 2020 - 2026 Dominik Willner <th33xitus@gmail.com>        #
#                                                                         #
#  This file is part of KIAUH - Klipper Installation And Update Helper    #
#  https://github.com/dw-0/kiauh                                          #
#                                                                         #
#  This file may be distributed under the terms of the GNU GPLv3 license  #
# ======================================================================= #
from __future__ import annotations

import importlib
import inspect
import json
import textwrap
from pathlib import Path
from typing import Dict, List, Type

from core.logger import Logger
from core.menus import Option
from core.menus.base_menu import BaseMenu
from core.types.color import Color
from extensions import EXTENSION_ROOT, GITHUB_ISSUES_URL
from extensions.base_extension import BaseExtension


# noinspection PyUnusedLocal
# noinspection PyMethodMayBeStatic
class ExtensionsMenu(BaseMenu):
    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
        super().__init__()
        self.title = "Extensions Menu"
        self.title_color = Color.CYAN
        self.previous_menu: Type[BaseMenu] | None = previous_menu
        self.extensions: Dict[str, BaseExtension] = self.discover_extensions()

    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
        from core.menus.main_menu import MainMenu

        self.previous_menu = previous_menu if previous_menu is not None else MainMenu

    def set_options(self) -> None:
        self.options = {
            i: Option(self.extension_submenu, opt_data=self.extensions.get(i))
            for i in self.extensions
        }

    def discover_extensions(self) -> Dict[str, BaseExtension]:
        ext_dict = {}

        for ext in EXTENSION_ROOT.iterdir():
            metadata_json = Path(ext).joinpath("metadata.json")
            if not metadata_json.exists():
                continue

            try:
                with open(metadata_json, "r") as m:
                    # read extension metadata from json
                    metadata = json.load(m).get("metadata")
                    index = str(metadata.get("index"))

                    # Prevent collisions where one extension silently overrides another.
                    if index in ext_dict:
                        existing_name = ext_dict[index].metadata.get("display_name")
                        duplicate_name = metadata.get("display_name")
                        Logger.print_warn(
                            "Failed loading extension"
                            f" {ext}: duplicate index '{index}'"
                            f" already used by '{existing_name}'."
                            f" Skipping '{duplicate_name}'."
                            f" Please report this at {GITHUB_ISSUES_URL}."
                        )
                        continue

                    int(index)
                    module_name = metadata.get("module")
                    module_path = f"kiauh.extensions.{ext.name}.{module_name}"

                    # get the class name of the extension
                    module = importlib.import_module(module_path)

                    def predicate(o):
                        return (
                            inspect.isclass(o)
                            and issubclass(o, BaseExtension)
                            and o != BaseExtension
                        )

                    ext_class: type = inspect.getmembers(module, predicate)[0][1]

                    # instantiate the extension with its metadata and add to dict
                    ext_instance: BaseExtension = ext_class(metadata)
                    ext_dict[index] = ext_instance

            except (
                IOError,
                json.JSONDecodeError,
                ImportError,
                TypeError,
                ValueError,
                AttributeError,
            ) as e:
                Logger.print_warn(
                    f"Failed loading extension {ext}: {e}. "
                    f"Please report this at {GITHUB_ISSUES_URL}."
                )

        return dict(sorted(ext_dict.items(), key=lambda x: int(x[0])))

    def extension_submenu(self, **kwargs):
        ExtensionSubmenu(kwargs.get("opt_data"), self.__class__).run()

    def print_menu(self) -> None:
        line1 = Color.apply("Available Extensions:", Color.YELLOW)
        menu = textwrap.dedent(
            f"""
            ╟───────────────────────────────────────────────────────╢
            ║ {line1:<62} ║
            ║                                                       ║
            """
        )[1:]
        print(menu, end="")

        for extension in self.extensions.values():
            index = extension.metadata.get("index")
            name = extension.metadata.get("display_name")
            row = f"{index}) {name}"
            print(f"║ {row:<53} ║")
        print("╟───────────────────────────────────────────────────────╢")


# noinspection PyUnusedLocal
# noinspection PyMethodMayBeStatic
class ExtensionSubmenu(BaseMenu):
    def __init__(
        self, extension: BaseExtension, previous_menu: Type[BaseMenu] | None = None
    ):
        super().__init__()
        self.title = extension.metadata.get("display_name")
        self.title_color = Color.YELLOW
        self.extension = extension
        self.previous_menu: Type[BaseMenu] | None = previous_menu

    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
        self.previous_menu = (
            previous_menu if previous_menu is not None else ExtensionsMenu
        )

    def set_options(self) -> None:
        self.options["1"] = Option(self.extension.install_extension)
        if self.extension.metadata.get("updates"):
            self.options["2"] = Option(self.extension.update_extension)
            self.options["3"] = Option(self.extension.remove_extension)
        else:
            self.options["2"] = Option(self.extension.remove_extension)

    def print_menu(self) -> None:
        line_width = 53
        description: List[str] = self.extension.metadata.get("description", [])
        description_text = Logger.format_content(
            description,
            line_width,
            border_left="║",
            border_right="║",
        )

        menu = textwrap.dedent(
            """
            ╟───────────────────────────────────────────────────────╢
            """
        )[1:]
        menu += f"{description_text}\n"

        # add links if available
        website: str = (self.extension.metadata.get("website") or "").strip()
        repo: str = (self.extension.metadata.get("repo") or "").strip()
        if website or repo:
            links_lines: List[str] = ["Links:"]
            if website:
                links_lines.append(f"● {website}")
            if repo:
                links_lines.append(f"● {repo}")

            links_text = Logger.format_content(
                links_lines,
                line_width,
                border_left="║",
                border_right="║",
            )

            menu += textwrap.dedent(
                """
                ╟───────────────────────────────────────────────────────╢
                """
            )[1:]
            menu += f"{links_text}\n"

        menu += textwrap.dedent(
            """
            ╟───────────────────────────────────────────────────────╢
            ║ 1) Install                                            ║
            """
        )[1:]

        if self.extension.metadata.get("updates"):
            menu += "║ 2) Update                                             ║\n"
            menu += "║ 3) Remove                                             ║\n"
        else:
            menu += "║ 2) Remove                                             ║\n"
        menu += "╟───────────────────────────────────────────────────────╢\n"

        print(menu, end="")