plugin_manager.py

# ba_meta require api 9
import babase
import _babase
import _bauiv1
import _bascenev1
import bauiv1 as bui
from bauiv1lib import popup, confirm
from babase._meta import EXPORT_CLASS_NAME_SHORTCUTS
from bauiv1lib.settings.allsettings import AllSettingsWindow

import urllib.request
import http.client
import socket
import json
import ssl

import re
import os
import sys
import copy
import asyncio
import pathlib
import hashlib
import contextlib

from typing import cast
from datetime import datetime

# Modules used for overriding AllSettingsWindow
import logging

PLUGIN_MANAGER_VERSION = "1.1.0"
REPOSITORY_URL = "https://github.com/bombsquad-community/plugin-manager"
# https://github.com/bombsquad-community/plugin-manager/issues/new?template=bug_report.md
PLUGIN_ISSUE_TEMPLATE = "bug_report.md"
# Current tag can be changed to "staging" or any other branch in
# plugin manager repo for testing purpose.
CURRENT_TAG = "main"

_env = _babase.env()
_uiscale = bui.app.ui_v1.uiscale
_app_api_version = babase.app.env.api_version

INDEX_META = "{repository_url}/{content_type}/{tag}/index.json"
CHANGELOG_META = "{repository_url}/{content_type}/{tag}/CHANGELOG.md"
HEADERS = {
    "User-Agent": _env["legacy_user_agent_string"],
}
PLUGIN_DIRECTORY = _env["python_directory_user"]
loop = babase._asyncio._asyncio_event_loop


def _regexp_friendly_class_name_shortcut(string): return string.replace(".", "\\.")


REGEXP = {
    "plugin_api_version": re.compile(b"(?<=ba_meta require api )(.*)"),
    "plugin_entry_points": re.compile(
        bytes(
            "(ba_meta export (plugin|{})\n+class )(.*)\\(".format(
                _regexp_friendly_class_name_shortcut(EXPORT_CLASS_NAME_SHORTCUTS["plugin"]),
            ),
            "utf-8"
        ),
    ),
    "minigames": re.compile(
        bytes(
            "(ba_meta export ({})\n+class )(.*)\\(".format(
                _regexp_friendly_class_name_shortcut("bascenev1.GameActivity"),
            ),
            "utf-8"
        ),
    ),
}
DISCORD_URL = "https://ballistica.net/discord"


_CACHE = {}


class MD5CheckSumFailed(Exception):
    pass


class PluginNotInstalled(Exception):
    pass


class CategoryDoesNotExist(Exception):
    pass


class NoCompatibleVersion(Exception):
    pass


class PluginSourceNetworkError(Exception):
    pass


class CategoryMetadataParseError(Exception):
    pass


def send_network_request(request):
    return urllib.request.urlopen(request)


async def async_send_network_request(request):
    response = await loop.run_in_executor(None, send_network_request, request)
    return response


def stream_network_response_to_file(request, file, md5sum=None, retries=3):
    response = urllib.request.urlopen(request)
    chunk_size = 16 * 1024
    content = b""
    with open(file, "wb") as fout:
        while True:
            chunk = response.read(chunk_size)
            if not chunk:
                break
            fout.write(chunk)
            content += chunk
    if md5sum and hashlib.md5(content).hexdigest() != md5sum:
        if retries <= 0:
            raise MD5CheckSumFailed("MD5 checksum match failed.")
        return stream_network_response_to_file(
            request,
            file,
            md5sum=md5sum,
            retries=retries-1,
        )
    return content


async def async_stream_network_response_to_file(request, file, md5sum=None, retries=3):

    content = await loop.run_in_executor(
        None,
        stream_network_response_to_file,
        request,
        file,
        md5sum,
        retries,
    )
    return content


def partial_format(string_template, **kwargs):
    for key, value in kwargs.items():
        string_template = string_template.replace("{" + key + "}", value)
    return string_template


class DNSBlockWorkaround:
    """
    Some ISPs put a DNS block on domains that are needed for plugin manager to
    work properly. This class stores methods to workaround such blocks by adding
    dns.google as a fallback.

    Such as Jio, a pretty popular ISP in India has a DNS block on
    raw.githubusercontent.com (sigh..).

    References:
      * https://github.com/orgs/community/discussions/42655

    Usage:
    -----
    >>> import urllib.request
    >>> import http.client
    >>> import socket
    >>> import ssl
    >>> import json
    >>> DNSBlockWorkaround.apply()
    >>> response = urllib.request.urlopen("https://dnsblockeddomain.com/path/to/resource/")
    """

    _google_dns_cache = {}

    def apply():
        opener = urllib.request.build_opener(
            DNSBlockWorkaround._HTTPHandler,
            DNSBlockWorkaround._HTTPSHandler,
        )
        urllib.request.install_opener(opener)

    def _resolve_using_google_dns(hostname):
        response = urllib.request.urlopen(f"https://dns.google/resolve?name={hostname}")
        response = response.read()
        response = json.loads(response)
        resolved_host = response["Answer"][0]["data"]
        return resolved_host

    def _resolve_using_system_dns(hostname):
        resolved_host = socket.gethostbyname(hostname)
        return resolved_host

    def _resolve_with_workaround(hostname):
        resolved_host_from_cache = DNSBlockWorkaround._google_dns_cache.get(hostname)
        if resolved_host_from_cache:
            return resolved_host_from_cache

        resolved_host_by_system_dns = DNSBlockWorkaround._resolve_using_system_dns(hostname)

        if DNSBlockWorkaround._is_blocked(hostname, resolved_host_by_system_dns):
            resolved_host = DNSBlockWorkaround._resolve_using_google_dns(hostname)
            DNSBlockWorkaround._google_dns_cache[hostname] = resolved_host
        else:
            resolved_host = resolved_host_by_system_dns

        return resolved_host

    def _is_blocked(hostname, address):
        is_blocked = False
        if hostname == "raw.githubusercontent.com":
            # Jio's DNS server may be blocking it.
            is_blocked = address.startswith("49.44.")

        return is_blocked

    class _HTTPConnection(http.client.HTTPConnection):
        def connect(self):
            host = DNSBlockWorkaround._resolve_with_workaround(self.host)
            self.sock = socket.create_connection(
                (host, self.port),
                self.timeout,
            )

    class _HTTPSConnection(http.client.HTTPSConnection):
        def connect(self):
            host = DNSBlockWorkaround._resolve_with_workaround(self.host)
            sock = socket.create_connection(
                (host, self.port),
                self.timeout,
            )
            context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
            context.verify_mode = ssl.CERT_REQUIRED
            context.check_hostname = True
            context.load_default_certs()
            sock = context.wrap_socket(sock, server_hostname=self.host)
            self.sock = sock

    class _HTTPHandler(urllib.request.HTTPHandler):
        def http_open(self, req):
            return self.do_open(DNSBlockWorkaround._HTTPConnection, req)

    class _HTTPSHandler(urllib.request.HTTPSHandler):
        def https_open(self, req):
            return self.do_open(DNSBlockWorkaround._HTTPSConnection, req)


class StartupTasks:
    def __init__(self):
        self.plugin_manager = PluginManager()

    def setup_config(self):
        # is_config_updated = False
        existing_plugin_manager_config = copy.deepcopy(
            babase.app.config.get("Community Plugin Manager"))

        plugin_manager_config = babase.app.config.setdefault("Community Plugin Manager", {})
        plugin_manager_config.setdefault("Custom Sources", [])
        installed_plugins = plugin_manager_config.setdefault("Installed Plugins", {})
        for plugin_name in tuple(installed_plugins.keys()):
            plugin = PluginLocal(plugin_name)
            if not plugin.is_installed:
                del installed_plugins[plugin_name]

        # This order is the options will show up in Settings window.
        current_settings = {
            "Auto Update Plugin Manager": True,
            "Auto Update Plugins": True,
            "Auto Enable Plugins After Installation": True,
            "Notify New Plugins": True
        }
        settings = plugin_manager_config.setdefault("Settings", {})

        for setting, value in settings.items():
            if setting in current_settings:
                current_settings[setting] = value

        plugin_manager_config["Settings"] = current_settings

        if plugin_manager_config != existing_plugin_manager_config:
            babase.app.config.commit()

    async def update_plugin_manager(self):
        if not babase.app.config["Community Plugin Manager"]["Settings"]["Auto Update Plugin Manager"]:
            return
        update_details = await self.plugin_manager.get_update_details()
        if update_details:
            to_version, commit_sha = update_details
            bui.screenmessage(f"Plugin Manager is being updated to v{to_version}")
            try:
                await self.plugin_manager.update(to_version, commit_sha)
            except MD5CheckSumFailed:
                bui.getsound('error').play()
            else:
                bui.screenmessage("Update successful. Restart game to reload changes.",
                                  color=(0, 1, 0))
                bui.getsound('shieldUp').play()

    async def update_plugins(self):
        if not babase.app.config["Community Plugin Manager"]["Settings"]["Auto Update Plugins"]:
            return
        await self.plugin_manager.setup_index()
        all_plugins = await self.plugin_manager.categories["All"].get_plugins()
        plugins_to_update = []
        for plugin in all_plugins:
            if plugin.is_installed and await plugin.get_local().is_enabled() and plugin.has_update():
                plugins_to_update.append(plugin.update())
        await asyncio.gather(*plugins_to_update)

    @staticmethod
    def _is_new_supported_plugin(plugin):
        is_an_update = len(plugin.versions) > 1
        if is_an_update:
            return False
        try:
            plugin.latest_compatible_version
        except NoCompatibleVersion:
            return False
        else:
            return True

    async def notify_new_plugins(self):
        if not babase.app.config["Community Plugin Manager"]["Settings"]["Notify New Plugins"]:
            return
        show_max_names = 2
        await self.plugin_manager.setup_index()
        new_num_of_plugins = len(await self.plugin_manager.categories["All"].get_plugins())
        try:
            existing_num_of_plugins = babase.app.config["Community Plugin Manager"]["Existing Number of Plugins"]
        except KeyError:
            babase.app.config["Community Plugin Manager"]["Existing Number of Plugins"] = new_num_of_plugins
            babase.app.config.commit()
            return

        def title_it(plug):
            plug = str(plug).replace('_', ' ').title()
            return plug
        if existing_num_of_plugins < new_num_of_plugins:
            new_plugin_count = new_num_of_plugins - existing_num_of_plugins
            all_plugins = await self.plugin_manager.categories["All"].get_plugins()
            new_supported_plugins = list(filter(self._is_new_supported_plugin, all_plugins))
            new_supported_plugins.sort(
                key=lambda plugin: plugin.latest_compatible_version.released_on_date,
                reverse=True,
            )
            new_supported_plugins = new_supported_plugins[:new_plugin_count]
            new_supported_plugins_count = len(new_supported_plugins)
            if new_supported_plugins_count > 0:
                new_supported_plugins = ", ".join(map(title_it, (new_supported_plugins
                                                                 if new_supported_plugins_count <= show_max_names else
                                                                 new_supported_plugins[0:show_max_names])
                                                      ))
                if new_supported_plugins_count == 1:
                    notification_text = f"{new_supported_plugins_count} new plugin ({new_supported_plugins}) is available!"
                else:
                    notification_text = new_supported_plugins + \
                        ('' if new_supported_plugins_count <= show_max_names else ' and +' +
                         str(new_supported_plugins_count-show_max_names)) + " new plugins are available"
                bui.screenmessage(notification_text, color=(0, 1, 0))

        if existing_num_of_plugins != new_num_of_plugins:
            babase.app.config["Community Plugin Manager"]["Existing Number of Plugins"] = new_num_of_plugins
            babase.app.config.commit()

    async def execute(self):
        self.setup_config()
        try:
            await asyncio.gather(
                self.update_plugin_manager(),
                self.update_plugins(),
                self.notify_new_plugins(),
            )
        except urllib.error.URLError:
            pass


class Category:
    def __init__(self, meta_url, tag=CURRENT_TAG):
        self.meta_url = meta_url
        self.tag = tag
        self.request_headers = HEADERS
        self._metadata = _CACHE.get("categories", {}).get(meta_url, {}).get("metadata")
        self._plugins = _CACHE.get("categories", {}).get(meta_url, {}).get("plugins")

    async def fetch_metadata(self):
        if self._metadata is None:
            # Let's keep depending on the "main" branch for 3rd party sources
            # even if we're using a different branch of plugin manager's repository.
            request = urllib.request.Request(
                self.meta_url.format(content_type="raw", tag=self.tag),
                headers=self.request_headers,
            )
            response = await async_send_network_request(request)
            self._metadata = json.loads(response.read())
            self.set_category_global_cache("metadata", self._metadata)
        return self

    async def validate(self):
        try:
            await self.fetch_metadata()
        except urllib.error.HTTPError as e:
            raise PluginSourceNetworkError(str(e))
        except json.decoder.JSONDecodeError as e:
            raise CategoryMetadataParseError(f"Failed to parse JSON: {str(e)}")
        try:
            await asyncio.gather(
                self.get_name(),
                self.get_description(),
                self.get_plugins_base_url(),
                self.get_plugins(),
            )
        except KeyError:
            raise CategoryMetadataParseError(f"Failed to parse JSON; missing required fields.")
        else:
            return True

    async def get_name(self):
        await self.fetch_metadata()
        return self._metadata["name"]

    async def get_description(self):
        await self.fetch_metadata()
        return self._metadata["description"]

    async def get_plugins_base_url(self):
        await self.fetch_metadata()
        return self._metadata["plugins_base_url"]

    async def get_plugins(self):
        if self._plugins is None:
            await self.fetch_metadata()
            self._plugins = ([
                Plugin(
                    plugin_info,
                    f"{await self.get_plugins_base_url()}/{plugin_info[0]}.py",
                    tag=self.tag,
                )
                for plugin_info in self._metadata["plugins"].items()
            ])
            self.set_category_global_cache("plugins", self._plugins)
        return self._plugins

    def set_category_global_cache(self, key, value):
        if "categories" not in _CACHE:
            _CACHE["categories"] = {}
        if self.meta_url not in _CACHE["categories"]:
            _CACHE["categories"][self.meta_url] = {}
        _CACHE["categories"][self.meta_url][key] = value

    def unset_category_global_cache(self):
        try:
            del _CACHE["categories"][self.meta_url]
        except KeyError:
            pass

    def cleanup(self):
        self._metadata = None
        self._plugins.clear()
        self.unset_category_global_cache()

    async def refresh(self):
        self.cleanup()
        await self.get_plugins()

    def save(self):
        babase.app.config["Community Plugin Manager"]["Custom Sources"].append(self.meta_url)
        babase.app.config.commit()


class CategoryAll(Category):
    def __init__(self, plugins={}):
        super().__init__(meta_url=None)
        self._name = "All"
        self._description = "All plugins"
        self._plugins = plugins


class PluginLocal:
    def __init__(self, name):
        """
        Initialize a plugin locally installed on the device.
        """
        self.name = name
        self.install_path = os.path.join(PLUGIN_DIRECTORY, f"{name}.py")
        self._entry_point_initials = f"{self.name}."
        self.cleanup()

    def cleanup(self):
        self._content = None
        self._api_version = None
        self._entry_points = []
        self._has_minigames = None

    @property
    def is_installed(self):
        return os.path.isfile(self.install_path)

    @property
    def is_installed_via_plugin_manager(self):
        return self.name in babase.app.config["Community Plugin Manager"]["Installed Plugins"]

    def initialize(self):
        if self.name not in babase.app.config["Community Plugin Manager"]["Installed Plugins"]:
            babase.app.config["Community Plugin Manager"]["Installed Plugins"][self.name] = {}
        return self

    async def uninstall(self):
        if await self.has_minigames():
            self.unload_minigames()
        try:
            os.remove(self.install_path)
        except FileNotFoundError:
            pass
        try:
            del babase.app.config["Community Plugin Manager"]["Installed Plugins"][self.name]
        except KeyError:
            pass
        else:
            self.save()

    @property
    def version(self):
        try:
            version = (babase.app.config["Community Plugin Manager"]
                       ["Installed Plugins"][self.name]["version"])
        except KeyError:
            version = None
        return version

    def _get_content(self):
        with open(self.install_path, "rb") as fin:
            return fin.read()

    def _set_content(self, content):
        with open(self.install_path, "wb") as fout:
            fout.write(content)

    def has_settings(self):
        for plugin_entry_point, plugin_spec in bui.app.plugins.plugin_specs.items():
            if plugin_entry_point.startswith(self._entry_point_initials):
                return plugin_spec.plugin.has_settings_ui()

    def launch_settings(self, source_widget):
        for plugin_entry_point, plugin_spec in bui.app.plugins.plugin_specs.items():
            if plugin_entry_point.startswith(self._entry_point_initials):
                return plugin_spec.plugin.show_settings_ui(source_widget)

    async def get_content(self):
        if self._content is None:
            if not self.is_installed:
                raise PluginNotInstalled("Plugin is not available locally.")

            self._content = await loop.run_in_executor(None, self._get_content)
        return self._content

    async def get_api_version(self):
        if self._api_version is None:
            content = await self.get_content()
            self._api_version = REGEXP["plugin_api_version"].search(content).group()
        return self._api_version

    async def get_entry_points(self):
        if not self._entry_points:
            content = await self.get_content()
            groups = REGEXP["plugin_entry_points"].findall(content)
            # Actual entry points are stored in the last index inside the matching groups.
            entry_points = tuple(f"{self.name}.{group[-1].decode('utf-8')}" for group in groups)
            self._entry_points = entry_points
        return self._entry_points

    async def has_minigames(self):
        if self._has_minigames is None:
            content = await self.get_content()
            self._has_minigames = REGEXP["minigames"].search(content) is not None
        return self._has_minigames

    async def has_plugins(self):
        entry_points = await self.get_entry_points()
        return len(entry_points) > 0

    def load_minigames(self):
        scanner = babase._meta.DirectoryScan(paths="")
        directory, module = self.install_path.rsplit(os.path.sep, 1)
        scanner._scan_module(
            pathlib.Path(directory),
            pathlib.Path(module),
        )
        scanned_results = set(babase.app.meta.scanresults.exports["bascenev1.GameActivity"])
        for game in scanner.results.exports["bascenev1.GameActivity"]:
            if game not in scanned_results:
                bui.screenmessage(f"{game} minigame loaded")
                babase.app.meta.scanresults.exports["bascenev1.GameActivity"].append(game)

    def unload_minigames(self):
        scanner = babase._meta.DirectoryScan(paths="")
        directory, module = self.install_path.rsplit(os.path.sep, 1)
        scanner._scan_module(
            pathlib.Path(directory),
            pathlib.Path(module),
        )
        new_scanned_results_games = []
        for game in babase.app.meta.scanresults.exports["bascenev1.GameActivity"]:
            if game in scanner.results.exports["bascenev1.GameActivity"]:
                bui.screenmessage(f"{game} minigame unloaded")
            else:
                new_scanned_results_games.append(game)
        babase.app.meta.scanresults.exports["bascenev1.GameActivity"] = new_scanned_results_games

    async def is_enabled(self):
        """
        Return True even if a single entry point is enabled or contains minigames.
        """
        if not await self.has_plugins():
            return True
        for entry_point, plugin_info in babase.app.config["Plugins"].items():
            if entry_point.startswith(self._entry_point_initials) and plugin_info["enabled"]:
                return True
        return False

    async def enable(self):
        for entry_point in await self.get_entry_points():
            if entry_point not in babase.app.config["Plugins"]:
                babase.app.config["Plugins"][entry_point] = {}
            babase.app.config["Plugins"][entry_point]["enabled"] = True
            plugin_spec = bui.app.plugins.plugin_specs.get(entry_point)
            if plugin_spec not in bui.app.plugins.active_plugins:
                self.load_plugin(entry_point)
                bui.screenmessage(f"{entry_point} loaded")
        if await self.has_minigames():
            self.load_minigames()
        self.save()

    def load_plugin(self, entry_point):
        plugin_class = babase._general.getclass(entry_point, babase.Plugin)
        loaded_plugin_instance = plugin_class()
        loaded_plugin_instance.on_app_running()

        plugin_spec = babase.PluginSpec(class_path=entry_point, loadable=True)
        plugin_spec.enabled = True
        plugin_spec.plugin = loaded_plugin_instance
        bui.app.plugins.plugin_specs[entry_point] = plugin_spec
        bui.app.plugins.active_plugins.append(plugin_spec.plugin)

    def disable(self):
        for entry_point, plugin_info in babase.app.config["Plugins"].items():
            if entry_point.startswith(self._entry_point_initials):
                plugin_info["enabled"] = False
        self.save()

    def set_version(self, version):
        app = babase.app
        app.config["Community Plugin Manager"]["Installed Plugins"][self.name]["version"] = version
        return self

    async def set_content(self, content):
        if not self._content:

            await loop.run_in_executor(None, self._set_content, content)
            self._content = content
        return self

    async def set_content_from_network_response(self, request, md5sum=None, retries=3):
        if not self._content:
            self._content = await async_stream_network_response_to_file(
                request,
                self.install_path,
                md5sum=md5sum,
                retries=retries,
            )
        return self._content

    def save(self):
        babase.app.config.commit()
        return self


class PluginVersion:
    def __init__(self, plugin, version, tag=CURRENT_TAG):
        self.number, info = version
        self.plugin = plugin
        self.api_version = info["api_version"]
        self.released_on = info["released_on"]
        self.commit_sha = info["commit_sha"]
        self.md5sum = info["md5sum"]

        self.download_url = self.plugin.url.format(content_type="raw", tag=tag)
        self.view_url = self.plugin.url.format(content_type="blob", tag=tag)

    def __eq__(self, plugin_version):
        return (self.number, self.plugin.name) == (plugin_version.number,
                                                   plugin_version.plugin.name)

    def __repr__(self):
        return f"<PluginVersion({self.plugin.name} {self.number})>"

    @property
    def released_on_date(self):
        return datetime.strptime(self.released_on, "%d-%m-%Y")

    async def _download(self, retries=3):
        local_plugin = self.plugin.create_local()
        await local_plugin.set_content_from_network_response(
            self.download_url,
            md5sum=self.md5sum,
            retries=retries,
        )
        local_plugin.set_version(self.number)
        local_plugin.save()
        return local_plugin

    async def install(self, suppress_screenmessage=False):
        try:
            local_plugin = await self._download()
        except MD5CheckSumFailed:
            if not suppress_screenmessage:
                bui.screenmessage(
                    f"{self.plugin.name} failed MD5 checksum during installation", color=(1, 0, 0))
            return False
        else:
            if not suppress_screenmessage:
                bui.screenmessage(f"{self.plugin.name} installed", color=(0, 1, 0))
            check = babase.app.config["Community Plugin Manager"]["Settings"]
            if check["Auto Enable Plugins After Installation"]:
                await local_plugin.enable()
            return True


class Plugin:
    def __init__(self, plugin, url, tag=CURRENT_TAG):
        """
        Initialize a plugin from network repository.
        """
        self.name, self.info = plugin
        self.install_path = os.path.join(PLUGIN_DIRECTORY, f"{self.name}.py")
        self.url = url
        self.tag = tag
        self._local_plugin = None

        self._versions = None
        self._latest_version = None
        self._latest_compatible_version = None

    def __repr__(self):
        return f"<Plugin({self.name})>"

    def __str__(self):
        return self.name

    @property
    def view_url(self):
        if self.latest_compatible_version == self.latest_version:
            tag = CURRENT_TAG
        else:
            tag = self.latest_compatible_version.commit_sha
        return self.url.format(content_type="blob", tag=tag)

    @property
    def is_installed(self):
        return os.path.isfile(self.install_path)

    @property
    def versions(self):
        if self._versions is None:
            self._versions = [
                PluginVersion(
                    self,
                    version,
                    tag=self.tag,
                ) for version in self.info["versions"].items()
            ]
        return self._versions

    @property
    def latest_version(self):
        if self._latest_version is None:
            self._latest_version = PluginVersion(
                self,
                tuple(self.info["versions"].items())[0],
                tag=self.tag,
            )
        return self._latest_version

    @property
    def latest_compatible_version(self):
        if self._latest_compatible_version is None:
            for number, info in self.info["versions"].items():
                if info["api_version"] == _app_api_version:
                    self._latest_compatible_version = PluginVersion(
                        self,
                        (number, info),
                        tag=self.tag if self.latest_version.number == number else info["commit_sha"]
                    )
                    break
        if self._latest_compatible_version is None:
            raise NoCompatibleVersion(
                f"{self.name} has no version compatible with API {_app_api_version}."
            )
        return self._latest_compatible_version

    def get_local(self):
        if not self.is_installed:
            raise PluginNotInstalled(
                f"{self.name} needs to be installed to get its local plugin.")
        if self._local_plugin is None:
            self._local_plugin = PluginLocal(self.name)
        return self._local_plugin

    def create_local(self):
        return (
            PluginLocal(self.name)
            .initialize()
        )

    async def uninstall(self):
        await self.get_local().uninstall()
        bui.screenmessage(f"{self.name} uninstalled", color=(0.9, 1, 0))

    def has_update(self):
        try:
            latest_compatible_version = self.latest_compatible_version
        except NoCompatibleVersion:
            return False
        else:
            return self.get_local().version != latest_compatible_version.number

    async def update(self):
        if await self.latest_compatible_version.install(suppress_screenmessage=True):
            bui.screenmessage(f"{self.name} updated to {self.latest_compatible_version.number}",
                              color=(0, 1, 0))
            bui.getsound('shieldUp').play()
        else:
            bui.screenmessage(f"{self.name} failed MD5 checksum while updating to "
                              f"{self.latest_compatible_version.number}",
                              color=(1, 0, 0))
            bui.getsound('error').play()


class ChangelogWindow(popup.PopupWindow):
    def __init__(self, origin_widget):
        self.scale_origin = origin_widget.get_screen_space_center()
        bui.getsound('swish').play()
        s = 1.65 if _uiscale is babase.UIScale.SMALL else 1.39 if _uiscale is babase.UIScale.MEDIUM else 1.67
        width = 400 * s
        height = width * 0.5
        color = (1, 1, 1)
        text_scale = 0.7 * s
        self._transition_out = 'out_scale'
        transition = 'in_scale'

        self._root_widget = bui.containerwidget(size=(width, height),
                                                on_outside_click_call=self._back,
                                                transition=transition,
                                                scale=(1.5 if _uiscale is babase.UIScale.SMALL else 1.5
                                                       if _uiscale is babase.UIScale.MEDIUM else 1.0),
                                                scale_origin_stack_offset=self.scale_origin)

        bui.textwidget(parent=self._root_widget,
                       position=(width * 0.49, height * 0.87), size=(0, 0),
                       h_align='center', v_align='center', text='ChangeLog',
                       scale=text_scale * 1.25, color=bui.app.ui_v1.title_color,
                       maxwidth=width * 0.9)

        back_button = bui.buttonwidget(
            parent=self._root_widget,
            position=(width * 0.1, height * 0.8),
            size=(60, 60),
            scale=0.8,
            label=babase.charstr(babase.SpecialChar.BACK),
            button_type='backSmall',
            on_activate_call=self._back)

        bui.containerwidget(edit=self._root_widget, cancel_button=back_button)

        try:
            released_on = _CACHE['changelog']['released_on']
            logs = _CACHE['changelog']['info'].split('\n')
            h_align = 'left'
            extra = 0.1
        except KeyError:
            released_on = ''
            logs = ["Could not load ChangeLog"]
            h_align = 'center'
            extra = 1

        bui.textwidget(parent=self._root_widget,
                       position=(width * 0.49, height * 0.72), size=(0, 0),
                       h_align='center', v_align='center',
                       text=PLUGIN_MANAGER_VERSION + released_on,
                       scale=text_scale * 0.9, color=color,
                       maxwidth=width * 0.9)

        bui.buttonwidget(
            parent=self._root_widget,
            position=(width * 0.7, height * 0.72 - 20),
            size=(140, 60),
            scale=0.8,
            label='Full ChangeLog',
            button_type='square',
            on_activate_call=lambda: bui.open_url(REPOSITORY_URL + '/blob/main/CHANGELOG.md'))

        loop_height = height * 0.62
        for log in logs:
            bui.textwidget(parent=self._root_widget,
                           position=(width * 0.5 * extra, loop_height), size=(0, 0),
                           h_align=h_align, v_align='top', text=log,
                           scale=text_scale, color=color,
                           maxwidth=width * 0.9)
            loop_height -= 35

    def _back(self) -> None:
        bui.getsound('swish').play()
        bui.containerwidget(edit=self._root_widget, transition='out_scale')


class AuthorsWindow(popup.PopupWindow):
    def __init__(self, authors_info, origin_widget):
        self.authors_info = authors_info
        self.scale_origin = origin_widget.get_screen_space_center()
        bui.getsound('swish').play()
        s = 1.25 if _uiscale is babase.UIScale.SMALL else 1.39 if _uiscale is babase.UIScale.MEDIUM else 1.67
        width = 400 * s
        height = width * 0.8
        color = (1, 1, 1)
        text_scale = 0.7 * s
        self._transition_out = 'out_scale'
        transition = 'in_scale'

        self._root_widget = bui.containerwidget(size=(width, height),
                                                on_outside_click_call=self._back,
                                                transition=transition,
                                                scale=(1.5 if _uiscale is babase.UIScale.SMALL else 1.5
                                                       if _uiscale is babase.UIScale.MEDIUM else 1.0),
                                                scale_origin_stack_offset=self.scale_origin)

        pos = height * 0.9
        bui.textwidget(parent=self._root_widget,
                       position=(width * 0.49, pos), size=(0, 0),
                       h_align='center', v_align='center', text='Authors',
                       scale=text_scale * 1.25, color=color,
                       maxwidth=width * 0.9)

        back_button = bui.buttonwidget(
            parent=self._root_widget,
            position=(width * 0.1, height * 0.87),
            size=(60, 60),
            scale=0.8,
            label=babase.charstr(babase.SpecialChar.BACK),
            button_type='backSmall',
            on_activate_call=self._back)

        bui.containerwidget(edit=self._root_widget, cancel_button=back_button)

        self._scrollwidget = bui.scrollwidget(parent=self._root_widget,
                                              size=(width * 0.8, height * 0.75),
                                              position=(width * 0.1, height * 0.1))
        self._columnwidget = bui.columnwidget(parent=self._scrollwidget,
                                              border=1,
                                              left_border=-15,
                                              margin=0)

        for author in self.authors_info:
            for key, value in author.items():
                text = f"{key.title()}: {value if value != '' else 'Not Provided'}"
                if key == 'name':
                    text = value
                bui.textwidget(parent=self._columnwidget,
                               size=(width * 0.8, 35 if key == 'name' else 30),
                               color=color if key == 'name' else (0.75, 0.7, 0.8),
                               scale=(
                                   (1.1 if key == 'name' else 0.9) if _uiscale is babase.UIScale.SMALL else
                                   (1.2 if key == 'name' else 1.0)
                               ),
                               text=text,
                               h_align='center',
                               v_align='center',
                               maxwidth=420)
            bui.textwidget(parent=self._columnwidget,
                           size=(width * 0.8, 30),
                           always_highlight=True,
                           h_align='center',
                           v_align='center')

    def _back(self) -> None:
        bui.getsound('swish').play()
        bui.containerwidget(edit=self._root_widget, transition='out_scale')


class MoreWindow(popup.PopupWindow):
    def __init__(self, origin_widget, plugin):
        self.scale_origin = origin_widget.get_screen_space_center()
        bui.getsound('swish').play()
        s = 1.25 if _uiscale is babase.UIScale.SMALL else 1.39 if _uiscale is babase.UIScale.MEDIUM else 1.67
        width = 400 * s
        height = width * 0.8
        color = (1, 1, 1)
        text_scale = 0.7 * s
        self._transition_out = 'out_scale'
        transition = 'in_scale'
        for value in plugin.info['versions'].values():
            if value['api_version'] == _app_api_version:
                released_on = value['released_on']
        print(released_on)

        self._root_widget = bui.containerwidget(
            size=(width, height),
            on_outside_click_call=self._back,
            transition=transition,
            scale=(1.5 if _uiscale is babase.UIScale.SMALL else 1.5
                   if _uiscale is babase.UIScale.MEDIUM else 1.0),
            scale_origin_stack_offset=self.scale_origin)

        back_button = bui.buttonwidget(
            parent=self._root_widget,
            position=(width * 0.1, height * 0.87),
            size=(60, 60),
            scale=0.8,
            label=babase.charstr(babase.SpecialChar.BACK),
            button_type='backSmall',
            on_activate_call=self._back)
        bui.containerwidget(edit=self._root_widget, cancel_button=back_button)

        bui.textwidget(
            parent=self._root_widget,
            position=(width/4, height/1.5),
            text=f"RELEASED ON: {released_on}",
            h_align='left', v_align='center')

        bui.textwidget(
            parent=self._root_widget,
            position=(width/4, height/2),
            text="Source: ",
            h_align='left', v_align='center')

        source_btn_pos_x = (390 if _uiscale is babase.UIScale.SMALL else
                            450 if _uiscale is babase.UIScale.MEDIUM else 440)
        source_btn_pos_y = (100 if _uiscale is babase.UIScale.SMALL else
                            110 if _uiscale is babase.UIScale.MEDIUM else 120)
        source_button = bui.buttonwidget(
            parent=self._root_widget,
            autoselect=True,
            position=(width/2-25, height/2-25),
            size=(80, 80),
            button_type="square",
            label="",
            color=(0.6, 0.53, 0.63),
            on_activate_call=lambda: bui.open_url(self.plugin.view_url))
        bui.imagewidget(
            parent=self._root_widget,
            position=(width/2-25, height/2-25),
            size=(80, 80),
            color=(0.8, 0.95, 1),
            texture=bui.gettexture("file"),
            draw_controller=source_button)
        bui.textwidget(
            parent=self._root_widget,
            position=(width/2-16, height/2-2),
            text="Source",
            size=(20, 20),
            draw_controller=source_button,
            color=(1, 1, 1, 1),
            rotate=25,
            scale=0.7)

        bui.buttonwidget(
            parent=self._root_widget,
            size=(60, 60),
            label="report a bug",
            on_activate_call=babase.Call(
                bui.open_url, REPOSITORY_URL + "/issues/new?template=" + PLUGIN_ISSUE_TEMPLATE)
        )

    def _back(self) -> None:
        bui.getsound('swish').play()
        bui.containerwidget(edit=self._root_widget, transition='out_scale')


class PluginWindow(popup.PopupWindow):
    def __init__(self, plugin, origin_widget, button_callback=lambda: None):
        self.plugin = plugin
        self.button_callback = button_callback
        self.scale_origin = origin_widget.get_screen_space_center()

        loop.create_task(self.draw_ui())

    def get_description(self, minimum_character_offset=40):
        """
        Splits the loong plugin description into multiple lines.
        """
        string = self.plugin.info["description"]
        string_length = len(string)

        partitioned_string = ""
        partitioned_string_length = len(partitioned_string)

        while partitioned_string_length != string_length:
            next_empty_space = string[partitioned_string_length +
                                      minimum_character_offset:].find(" ")
            next_word_end_position = partitioned_string_length + \
                minimum_character_offset + max(0, next_empty_space)
            partitioned_string += string[partitioned_string_length:next_word_end_position]
            if next_empty_space != -1:
                # Insert a line break here, there's still more partitioning to do.
                partitioned_string += "\n"
            partitioned_string_length = len(partitioned_string)

        return partitioned_string

    async def draw_ui(self):
        bui.getsound('swish').play()
        b_text_color = (0.75, 0.7, 0.8)
        s = 1.25 if _uiscale is babase.UIScale.SMALL else 1.39 if babase.UIScale.MEDIUM else 1.67
        width = 400 * s
        height = 120 + 100 * s
        color = (1, 1, 1)
        text_scale = 0.7 * s
        self._transition_out = 'out_scale'
        transition = 'in_scale'

        self._root_widget = bui.containerwidget(size=(width, height),
                                                on_outside_click_call=self._cancel,
                                                transition=transition,
                                                scale=(2.1 if _uiscale is babase.UIScale.SMALL else 1.5
                                                       if _uiscale is babase.UIScale.MEDIUM else 1.0),
                                                scale_origin_stack_offset=self.scale_origin)

        pos = height * 0.8
        plug_name = self.plugin.name.replace('_', ' ').title()
        plugin_title = f"{plug_name} (v{self.plugin.latest_compatible_version.number})"
        bui.textwidget(parent=self._root_widget,
                       position=(width * 0.49, pos), size=(0, 0),
                       h_align='center', v_align='center', text=plugin_title,
                       scale=text_scale * 1.25, color=color,
                       maxwidth=width * 0.9)
        pos -= 25
        # Author
        text = 'by ' + ', '.join([author["name"] for author in self.plugin.info["authors"]])
        author_text_control_btn = bui.buttonwidget(parent=self._root_widget,
                                                   position=(width * 0.49 -
                                                             (len(text)*14/2), pos - 10),
                                                   size=(len(text)*14, 20),
                                                   label='',
                                                   texture=bui.gettexture("empty"),
                                                   on_activate_call=lambda:
                                                       AuthorsWindow(self.plugin.info["authors"], self._root_widget))
        bui.textwidget(parent=self._root_widget,
                       position=(width * 0.49 - (len(text)*14/2), pos - 10),
                       size=(len(text)*14, 20),
                       h_align='center',
                       v_align='center',
                       text=text,
                       scale=text_scale * 0.8,
                       color=(0.75, 0.7, 0.8),
                       maxwidth=width * 0.9,
                       draw_controller=author_text_control_btn,
                       )
        pos -= 60
        # Info
        bui.textwidget(parent=self._root_widget,
                       position=(width * 0.49, pos), size=(0, 0),
                       h_align='center', v_align='center',
                       text=self.get_description(),
                       scale=text_scale * 0.6, color=color,
                       maxwidth=width * 0.95)
        b1_color = None
        b2_color = (0.8, 0.15, 0.35)
        b3_color = (0.2, 0.8, 0.3)
        pos = height * 0.1
        button_size = (80 * s, 40 * s)

        to_draw_button1 = True
        to_draw_button4 = False
        if self.plugin.is_installed:
            self.local_plugin = self.plugin.get_local()
            if not await self.local_plugin.has_plugins():
                to_draw_button1 = False
            else:
                if await self.local_plugin.is_enabled():
                    button1_label = "Disable"
                    b1_color = (0.6, 0.53, 0.63)
                    button1_action = self.disable
                    if self.local_plugin.has_settings():
                        to_draw_button4 = True
                else:
                    button1_label = "Enable"
                    button1_action = self.enable
            button2_label = "Uninstall"
            button2_action = self.uninstall
            has_update = self.plugin.has_update()
            if has_update:
                button3_label = "Update"
                button3_action = self.update
        else:
            button1_label = "Install"
            button1_action = self.install

        if to_draw_button1:
            selected_btn = bui.buttonwidget(parent=self._root_widget,
                                            position=(
                                                width * (
                                                    0.1 if self.plugin.is_installed and has_update else
                                                    0.25 if self.plugin.is_installed else
                                                    0.4), pos),
                                            size=button_size,
                                            on_activate_call=button1_action,
                                            color=b1_color,
                                            textcolor=b_text_color,
                                            button_type='square',
                                            text_scale=1,
                                            label=button1_label)

        if self.plugin.is_installed:
            selected_btn = bui.buttonwidget(parent=self._root_widget,
                                            position=(
                                                width * (0.4 if has_update or not to_draw_button1 else 0.55), pos),
                                            size=button_size,
                                            on_activate_call=button2_action,
                                            color=b2_color,
                                            textcolor=b_text_color,
                                            button_type='square',
                                            text_scale=1,
                                            label=button2_label)

            if has_update:
                selected_btn = bui.buttonwidget(parent=self._root_widget,
                                                position=(width * 0.7, pos),
                                                size=button_size,
                                                on_activate_call=button3_action,
                                                color=b3_color,
                                                textcolor=b_text_color,
                                                autoselect=True,
                                                button_type='square',
                                                text_scale=1,
                                                label=button3_label)

        bui.containerwidget(edit=self._root_widget,
                            on_cancel_call=self._cancel,
                            selected_child=selected_btn)

        more_pos_x = (390 if _uiscale is babase.UIScale.SMALL else
                      450 if _uiscale is babase.UIScale.MEDIUM else 440)
        more_pos_y = (100 if _uiscale is babase.UIScale.SMALL else
                      110 if _uiscale is babase.UIScale.MEDIUM else 120)
        # MK:

        more_button = bui.buttonwidget(parent=self._root_widget,
                                       autoselect=True,
                                       position=(more_pos_x, more_pos_y),
                                       size=(40, 40),
                                       button_type="square",
                                       label="",
                                       color=(0.6, 0.53, 0.63),
                                       )
        bui.buttonwidget(edit=more_button,
                         on_activate_call=babase.Call(MoreWindow, more_button, self.plugin)
                         )

        bui.imagewidget(parent=self._root_widget,
                        position=(more_pos_x, more_pos_y),
                        size=(40, 40),
                        color=(0.8, 0.95, 1),
                        texture=bui.gettexture("file"),
                        draw_controller=more_button)
        bui.textwidget(parent=self._root_widget,
                       position=(more_pos_x-3, more_pos_y+12),
                       text="More...",
                       size=(10, 10),
                       draw_controller=more_button,
                       color=(1, 1, 1, 1),
                       rotate=25,
                       scale=0.45)

        # MK:
        # Below snippet handles the tutorial button in the plugin window
        tutorial_url = self.plugin.info["external_url"]
        if tutorial_url:
            def tutorial_confirm_window():
                text = "This will take you to \n\""+self.plugin.info["external_url"] + "\""
                tutorial_confirm_window = confirm.ConfirmWindow(
                    text=text,
                    action=lambda: bui.open_url(self.plugin.info["external_url"]),
                )
            more_pos_x = (440 if _uiscale is babase.UIScale.SMALL else
                          500 if _uiscale is babase.UIScale.MEDIUM else 490)
            more_pos_y = (100 if _uiscale is babase.UIScale.SMALL else
                          110 if _uiscale is babase.UIScale.MEDIUM else 120)
            tutorial_button = bui.buttonwidget(parent=self._root_widget,
                                               autoselect=True,
                                               position=(more_pos_x, more_pos_y),
                                               size=(40, 40),
                                               button_type="square",
                                               label="",
                                               color=(0.6, 0.53, 0.63),

                                               on_activate_call=tutorial_confirm_window)

            bui.imagewidget(parent=self._root_widget,
                            position=(more_pos_x, more_pos_y),
                            size=(40, 40),
                            color=(0.8, 0.95, 1),
                            texture=bui.gettexture("frameInset"),
                            draw_controller=tutorial_button)
            bui.textwidget(parent=self._root_widget,
                           position=(more_pos_x - 3, more_pos_y + 12),
                           text="Tutorial",
                           size=(10, 10),
                           draw_controller=tutorial_button,
                           color=(1, 1, 1, 1),
                           rotate=25,
                           scale=0.45)

        if to_draw_button4:
            settings_pos_x = (60 if _uiscale is babase.UIScale.SMALL else
                              60 if _uiscale is babase.UIScale.MEDIUM else 60)
            settings_pos_y = (100 if _uiscale is babase.UIScale.SMALL else
                              110 if _uiscale is babase.UIScale.MEDIUM else 120)
            settings_button = bui.buttonwidget(parent=self._root_widget,
                                               autoselect=True,
                                               position=(settings_pos_x, settings_pos_y),
                                               size=(40, 40),
                                               button_type="square",
                                               label="",
                                               color=(0, 0.75, 0.75),)
            bui.buttonwidget(
                edit=settings_button,
                on_activate_call=babase.Call(self.settings, settings_button),)
            bui.imagewidget(parent=self._root_widget,
                            position=(settings_pos_x, settings_pos_y),
                            size=(40, 40),
                            color=(0.8, 0.95, 1),
                            texture=bui.gettexture("settingsIcon"),
                            draw_controller=settings_button)

    def _ok(self) -> None:
        bui.containerwidget(edit=self._root_widget, transition='out_scale')

    def _cancel(self) -> None:
        bui.getsound('swish').play()
        bui.containerwidget(edit=self._root_widget, transition='out_scale')

    def button(fn):
        async def asyncio_handler(fn, self, *args, **kwargs):
            await fn(self, *args, **kwargs)
            await self.button_callback()

        def wrapper(self, *args, **kwargs):
            self._ok()

            if asyncio.iscoroutinefunction(fn):
                loop.create_task(asyncio_handler(fn, self, *args, **kwargs))
            else:
                fn(self, *args, **kwargs)
                loop.create_task(self.button_callback())

        return wrapper

    def settings(self, source_widget):
        self.local_plugin.launch_settings(source_widget)

    @button
    def disable(self) -> None:
        self.local_plugin.disable()

    @button
    async def enable(self) -> None:
        await self.local_plugin.enable()
        bui.getsound('gunCocking').play()

    @button
    async def install(self):
        await self.plugin.latest_compatible_version.install()
        bui.getsound('cashRegister2').play()

    @button
    async def uninstall(self):
        await self.plugin.uninstall()
        bui.getsound('shieldDown').play()

    @button
    async def update(self):
        await self.plugin.update()
        bui.getsound('shieldUp').play()


class PluginManager:
    def __init__(self):
        self.request_headers = HEADERS
        self._index = _CACHE.get("index", {})
        self._changelog = _CACHE.get("changelog", {})
        self.categories = {}
        self.module_path = sys.modules[__name__].__file__
        self._index_setup_in_progress = False
        self._changelog_setup_in_progress = False

    async def get_index(self):
        if not self._index:
            request = urllib.request.Request(
                INDEX_META.format(
                    repository_url=REPOSITORY_URL,
                    content_type="raw",
                    tag=CURRENT_TAG
                ),
                headers=self.request_headers,
            )
            response = await async_send_network_request(request)
            index = json.loads(response.read())
            self.set_index_global_cache(index)
            self._index = index
        return self._index

    async def setup_index(self):
        while self._index_setup_in_progress:
            # Avoid making multiple network calls to the same resource in parallel.
            # Rather wait for the previous network call to complete.
            await asyncio.sleep(0.1)
        self._index_setup_in_progress = not bool(self._index)
        index = await self.get_index()
        await self.setup_plugin_categories(index)
        self._index_setup_in_progress = False

    async def get_changelog(self) -> str:
        requested = False
        if not self._changelog:
            request = urllib.request.Request(CHANGELOG_META.format(
                repository_url=REPOSITORY_URL,
                content_type="raw",
                tag=CURRENT_TAG
            ),
                headers=self.request_headers)
            response = await async_send_network_request(request)
            self._changelog = response.read().decode()
            requested = True
        return [self._changelog, requested]

    async def setup_changelog(self, version=None) -> None:
        if version is None:
            version = PLUGIN_MANAGER_VERSION
        while self._changelog_setup_in_progress:
            # Avoid making multiple network calls to the same resource in parallel.
            # Rather wait for the previous network call to complete.
            await asyncio.sleep(0.1)
        self._changelog_setup_in_progress = not bool(self._changelog)
        try:
            full_changelog = await self.get_changelog()
            if full_changelog[1]:
                pattern = rf"### {version} \(\d\d-\d\d-\d{{4}}\)\n(.*?)(?=### \d+\.\d+\.\d+|\Z)"
                released_on = full_changelog[0].split(version)[1].split('\n')[0]
                matches = re.findall(pattern, full_changelog[0], re.DOTALL)
                if matches:
                    changelog = {
                        'released_on': released_on,
                        'info': matches[0].strip()
                    }
                else:
                    changelog = {'released_on': ' (Not Provided)',
                                 'info': f"Changelog entry for version {version} not found."}
            else:
                changelog = full_changelog[0]
        except urllib.error.URLError:
            changelog = {'released_on': ' (Not Provided)',
                         'info': 'Could not get ChangeLog due to Internet Issues.'}
        self.set_changelog_global_cache(changelog)
        self._changelog_setup_in_progress = False

    async def setup_plugin_categories(self, plugin_index):
        # A hack to have the "All" category show at the top.
        self.categories["All"] = None

        requests = []
        for meta_url in plugin_index["categories"]:
            category = Category(meta_url)
            request = category.fetch_metadata()
            requests.append(request)
        for source in babase.app.config["Community Plugin Manager"]["Custom Sources"]:
            source_splits = source.split("@", maxsplit=1)
            if len(source_splits) == 1:
                # Fallack to `main` if `@branchname` isn't specified in an external source URI.
                source_repo, source_tag = source_splits[0], "main"
            else:
                source_repo, source_tag = source_splits
            meta_url = partial_format(
                plugin_index["external_source_url"],
                repository=source_repo,
            )
            category = Category(meta_url, tag=source_tag)
            request = category.fetch_metadata()
            requests.append(request)
        categories = await asyncio.gather(*requests)

        all_plugins = []
        for category in categories:
            self.categories[await category.get_name()] = category
            all_plugins.extend(await category.get_plugins())
        self.categories["All"] = CategoryAll(plugins=all_plugins)

    def cleanup(self):
        for category in self.categories.values():
            if category is not None:
                category.cleanup()
        self.categories.clear()
        self._index.clear()
        self._changelog = None
        self.unset_index_global_cache()

    async def refresh(self):
        self.cleanup()
        await self.setup_index()

    def set_index_global_cache(self, index):
        _CACHE["index"] = index

    def set_changelog_global_cache(self, changelog):
        _CACHE["changelog"] = changelog

    def unset_index_global_cache(self):
        try:
            del _CACHE["index"]
            del _CACHE["changelog"]
        except KeyError:
            pass

    async def get_update_details(self):
        index = await self.get_index()
        for version, info in index["versions"].items():
            if info["api_version"] != _app_api_version:
                # No point checking a version of the API game doesn't support.
                continue
            if version == PLUGIN_MANAGER_VERSION:
                # We're already on the latest version for the current API.
                return
            else:
                if next(iter(index["versions"])) == version:
                    # Version on the top is the latest, so no need to specify
                    # the commit SHA explicitly to GitHub to access the latest file.
                    commit_sha = None
                else:
                    commit_sha = info["commit_sha"]
                return version, commit_sha

    async def update(self, to_version=None, commit_sha=None):
        index = await self.get_index()
        if to_version is None:
            to_version, commit_sha = await self.get_update_details()
        to_version_info = index["versions"][to_version]
        tag = commit_sha or CURRENT_TAG
        download_url = index["plugin_manager_url"].format(
            content_type="raw",
            tag=tag,
        )
        response = await async_send_network_request(download_url)
        content = response.read()
        if hashlib.md5(content).hexdigest() != to_version_info["md5sum"]:
            raise MD5CheckSumFailed("MD5 checksum failed during plugin manager update.")
        with open(self.module_path, "wb") as fout:
            fout.write(content)
        return to_version_info

    async def soft_refresh(self):
        pass


class PluginSourcesWindow(popup.PopupWindow):
    def __init__(self, origin_widget):
        self.selected_source = None

        self.scale_origin = origin_widget.get_screen_space_center()

        b_textcolor = (0.75, 0.7, 0.8)
        self._transition_out = 'out_scale'
        transition = 'in_scale'
        self._root_widget = bui.containerwidget(size=(400, 340),
                                                on_outside_click_call=self._ok,
                                                transition=transition,
                                                scale=(2.1 if _uiscale is babase.UIScale.SMALL else 1.5
                                                       if _uiscale is babase.UIScale.MEDIUM else 1.0),
                                                scale_origin_stack_offset=self.scale_origin,
                                                on_cancel_call=self._ok)

        bui.textwidget(
            parent=self._root_widget,
            position=(155, 300),
            size=(100, 25),
            text="Custom Plugin Sources",
            color=bui.app.ui_v1.title_color,
            scale=0.8,
            h_align="center",
            v_align="center",
            maxwidth=270,
        )

        scroll_size_x = (290 if _uiscale is babase.UIScale.SMALL else
                         300 if _uiscale is babase.UIScale.MEDIUM else 290)
        scroll_size_y = (170 if _uiscale is babase.UIScale.SMALL else
                         185 if _uiscale is babase.UIScale.MEDIUM else 180)
        scroll_pos_x = (55 if _uiscale is babase.UIScale.SMALL else
                        40 if _uiscale is babase.UIScale.MEDIUM else 60)
        scroll_pos_y = 105

        self._scrollwidget = bui.scrollwidget(parent=self._root_widget,
                                              size=(scroll_size_x, scroll_size_y),
                                              position=(scroll_pos_x, scroll_pos_y))
        self._columnwidget = bui.columnwidget(parent=self._scrollwidget,
                                              border=1,
                                              margin=0)

        delete_source_button_position_pos_x = 360
        delete_source_button_position_pos_y = 110
        delete_source_button = bui.buttonwidget(parent=self._root_widget,
                                                position=(delete_source_button_position_pos_x,
                                                          delete_source_button_position_pos_y),
                                                size=(25, 25), label="",
                                                on_activate_call=self.delete_selected_source,
                                                button_type="square",
                                                color=(0.6, 0, 0))

        bui.imagewidget(parent=self._root_widget,
                        position=(delete_source_button_position_pos_x + 2,
                                  delete_source_button_position_pos_y),
                        size=(25, 25), color=(5, 2, 2),
                        texture=bui.gettexture("crossOut"),
                        draw_controller=delete_source_button)

        warning_pos_x = (43 if _uiscale is babase.UIScale.SMALL else
                         35 if _uiscale is babase.UIScale.MEDIUM else
                         48)
        bui.textwidget(
            parent=self._root_widget,
            position=(warning_pos_x, 74),
            size=(50, 22),
            text=("Warning: 3rd party plugin sources are not moderated\n"
                  "               by the community and may be dangerous!"),
            color=(1, 0.23, 0.23),
            scale=0.5,
            h_align="left",
            v_align="center",
            maxwidth=400,
        )

        self._add_source_widget = bui.textwidget(parent=self._root_widget,
                                                 size=(335, 50),
                                                 position=(21, 22),
                                                 h_align='left',
                                                 v_align='center',
                                                 editable=True,
                                                 scale=0.75,
                                                 maxwidth=215,
                                                 description="Add Source")

        bui.buttonwidget(parent=self._root_widget,
                         position=(330, 28),
                         size=(37, 37),
                         on_activate_call=lambda: loop.create_task(self.add_source()),
                         label="",
                         texture=bui.gettexture("startButton"),
                         button_type="square",
                         color=(0, 0.9, 0),
                         textcolor=b_textcolor,
                         text_scale=1)

        self.draw_sources()

    def draw_sources(self):
        for plugin in self._columnwidget.get_children():
            plugin.delete()

        color = (1, 1, 1)
        for custom_source in babase.app.config["Community Plugin Manager"]["Custom Sources"]:
            bui.textwidget(parent=self._columnwidget,
                           selectable=True,
                           color=color,
                           text=custom_source,
                           on_select_call=lambda: self.select_source(custom_source),
                           h_align='left',
                           v_align='center',
                           scale=0.75,
                           maxwidth=260)

    def select_source(self, source):
        self.selected_source = source

    async def add_source(self):
        source = bui.textwidget(query=self._add_source_widget)
        # External source URIs can optionally suffix `@branchname`, for example:
        # `bombsquad-community/sample-plugin-source@experimental`
        source_splits = source.split("@", maxsplit=1)
        if len(source_splits) == 1:
            # Fallack to `main` if `@branchname` isn't specified in an external source URI.
            source_repo, source_tag = source_splits[0], "main"
        else:
            source_repo, source_tag = source_splits
        meta_url = partial_format(
            _CACHE["index"]["external_source_url"],
            repository=source_repo,
        )
        category = Category(meta_url, tag=source_tag)
        try:
            await category.validate()
        except (PluginSourceNetworkError, CategoryMetadataParseError) as e:
            bui.screenmessage(str(e), color=(1, 0, 0))
            bui.getsound('error').play()
            return
        if source in babase.app.config["Community Plugin Manager"]["Custom Sources"]:
            bui.screenmessage("Plugin source already exists")
            bui.getsound('error').play()
            return
        babase.app.config["Community Plugin Manager"]["Custom Sources"].append(source)
        babase.app.config.commit()
        bui.screenmessage("Plugin source added; Refresh plugin list to see changes",
                          color=(0, 1, 0))
        bui.getsound('cashRegister2').play()
        self.draw_sources()

    def delete_selected_source(self):
        if self.selected_source is None:
            return
        babase.app.config["Community Plugin Manager"]["Custom Sources"].remove(self.selected_source)
        babase.app.config.commit()
        bui.screenmessage("Plugin source deleted; Refresh plugin list to see changes",
                          color=(0.9, 1, 0))
        bui.getsound('shieldDown').play()
        self.draw_sources()

    def _ok(self) -> None:
        bui.getsound('swish').play()
        bui.containerwidget(edit=self._root_widget, transition='out_scale')


class PluginCategoryWindow(popup.PopupMenuWindow):
    def __init__(self, choices, current_choice, origin_widget, asyncio_callback):
        choices = (*choices, "Installed", "Custom Sources")
        self._asyncio_callback = asyncio_callback
        self.scale_origin = origin_widget.get_screen_space_center()
        super().__init__(
            position=(200, 0),
            scale=(2.3 if _uiscale is babase.UIScale.SMALL else
                   1.65 if _uiscale is babase.UIScale.MEDIUM else 1.23),
            choices=choices,
            current_choice=current_choice,
            delegate=self)
        self._update_custom_sources_widget()

    def _update_custom_sources_widget(self):
        bui.textwidget(edit=self._columnwidget.get_children()[-1],
                       color=(0.5, 0.5, 0.5),
                       on_activate_call=self.show_sources_window)

    def popup_menu_selected_choice(self, window, choice):

        loop.create_task(self._asyncio_callback(choice))

    def popup_menu_closing(self, window):
        pass

    def show_sources_window(self):
        self._ok()
        PluginSourcesWindow(origin_widget=self.root_widget)

    def _ok(self) -> None:
        bui.getsound('swish').play()
        bui.containerwidget(edit=self.root_widget, transition='out_scale')


class PluginManagerWindow(bui.MainWindow):
    def __init__(self, transition: str = "in_right", origin_widget: bui.Widget = None):
        self.plugin_manager = PluginManager()
        self.category_selection_button = None
        self.selected_category = 'All'
        self.plugins_in_current_view = {}
        self.selected_alphabet_order = 'a_z'
        self.alphabet_order_selection_button = None

        loop.create_task(self.draw_index())

        self._width = (700 if _uiscale is babase.UIScale.SMALL
                       else 550 if _uiscale is babase.UIScale.MEDIUM
                       else 570)
        self._height = (500 if _uiscale is babase.UIScale.SMALL
                        else 422 if _uiscale is babase.UIScale.MEDIUM
                        else 500)
        top_extra = 20 if _uiscale is babase.UIScale.SMALL else 0

        if origin_widget:
            self._transition_out = "out_scale"
            self._scale_origin = origin_widget.get_screen_space_center()
            transition = "in_scale"

        super().__init__(
            root_widget=bui.containerwidget(
                size=(self._width, self._height + top_extra),
                toolbar_visibility="menu_minimal",
                scale=(1.9 if _uiscale is babase.UIScale.SMALL
                       else 1.5 if _uiscale is babase.UIScale.MEDIUM
                       else 1.0),
                stack_offset=(0, -25) if _uiscale is babase.UIScale.SMALL else (0, 0)
            ),
            transition=transition,
            origin_widget=origin_widget,
        )

        back_pos_x = 5 + (37 if _uiscale is babase.UIScale.SMALL else
                          27 if _uiscale is babase.UIScale.MEDIUM else 68)
        back_pos_y = self._height - (95 if _uiscale is babase.UIScale.SMALL else
                                     65 if _uiscale is babase.UIScale.MEDIUM else 50)

        if _uiscale is bui.UIScale.SMALL:
            self._back_button = None
            bui.containerwidget(
                edit=self._root_widget, on_cancel_call=self.main_window_back
            )
        else:
            self._back_button = back_button = bui.buttonwidget(
                parent=self._root_widget,
                position=(back_pos_x, back_pos_y),
                size=(60, 60),
                scale=0.8,
                label=babase.charstr(babase.SpecialChar.BACK),
                button_type='backSmall',
                on_activate_call=self.main_window_back)

            bui.containerwidget(edit=self._root_widget, cancel_button=back_button)

        title_pos = self._height - (83 if _uiscale is babase.UIScale.SMALL else
                                    50 if _uiscale is babase.UIScale.MEDIUM else 50)
        bui.textwidget(
            parent=self._root_widget,
            position=(-10, title_pos),
            size=(self._width, 25),
            text="Community Plugin Manager",
            color=bui.app.ui_v1.title_color,
            scale=1.05,
            h_align="center",
            v_align="center",
            maxwidth=270,
        )

        loading_pos_y = self._height - (275 if _uiscale is babase.UIScale.SMALL else
                                        235 if _uiscale is babase.UIScale.MEDIUM else 270)

        self._plugin_manager_status_text = bui.textwidget(
            parent=self._root_widget,
            position=(-5, loading_pos_y),
            size=(self._width, 25),
            text="Loading",
            color=bui.app.ui_v1.title_color,
            scale=0.7,
            h_align="center",
            v_align="center",
            maxwidth=400,
        )
        self._dot_timer = babase.AppTimer(0.5, self._update_dots, repeat=True)

    @contextlib.contextmanager
    def exception_handler(self):
        try:
            yield
        except urllib.error.URLError:
            self._dot_timer = None
            try:
                bui.textwidget(
                    edit=self._plugin_manager_status_text,
                    text="Make sure you are connected\n to the Internet and try again."
                )
            except:
                pass
            self.plugin_manager._index_setup_in_progress = False
        except RuntimeError:
            # User probably went back before a bui.Window could finish loading.
            pass
        except Exception as e:
            self._dot_timer = None
            try:
                bui.textwidget(edit=self._plugin_manager_status_text, text=str(e))
            except:
                pass
            raise

    def _update_dots(self):
        try:
            text = cast(str, bui.textwidget(query=self._plugin_manager_status_text))
            if text.endswith('....'):
                text = text[0:len(text)-4]
            bui.textwidget(edit=self._plugin_manager_status_text, text=(text + '.'))
        except:
            pass

    async def draw_index(self):
        self.draw_search_bar()
        self.draw_plugins_scroll_bar()
        self.draw_category_selection_button(post_label="All")
        self.draw_refresh_icon()
        self.draw_settings_icon()
        with self.exception_handler():
            await self.plugin_manager.setup_changelog()
            await self.plugin_manager.setup_index()
            self._dot_timer = None
            try:
                bui.textwidget(edit=self._plugin_manager_status_text, text="")
            except:
                pass
            await self.select_category("All")

    def draw_plugins_scroll_bar(self):
        scroll_size_x = (515 if _uiscale is babase.UIScale.SMALL else
                         430 if _uiscale is babase.UIScale.MEDIUM else 420)
        scroll_size_y = (245 if _uiscale is babase.UIScale.SMALL else
                         265 if _uiscale is babase.UIScale.MEDIUM else 335)
        scroll_pos_x = (70 if _uiscale is babase.UIScale.SMALL else
                        50 if _uiscale is babase.UIScale.MEDIUM else 70)
        scroll_pos_y = (100 if _uiscale is babase.UIScale.SMALL else
                        35 if _uiscale is babase.UIScale.MEDIUM else 40)
        self._scrollwidget = bui.scrollwidget(parent=self._root_widget,
                                              size=(scroll_size_x, scroll_size_y),
                                              position=(scroll_pos_x, scroll_pos_y))
        self._columnwidget = bui.columnwidget(parent=self._scrollwidget,
                                              border=2,
                                              margin=0)

    def draw_category_selection_button(self, post_label):
        category_pos_x = (440 if _uiscale is babase.UIScale.SMALL else
                          340 if _uiscale is babase.UIScale.MEDIUM else 370)
        category_pos_y = self._height - (141 if _uiscale is babase.UIScale.SMALL else
                                         110 if _uiscale is babase.UIScale.MEDIUM else 110)
        b_size = (140, 30)
        b_textcolor = (0.8, 0.8, 0.85)

        if self.alphabet_order_selection_button is None:
            self.alphabet_order_selection_button = bui.buttonwidget(parent=self._root_widget,
                                                                    size=(40, 30),
                                                                    position=(
                                                                        category_pos_x - 47,
                                                                        category_pos_y),
                                                                    label=(
                                                                        'Z - A' if self.selected_alphabet_order == 'z_a'
                                                                        else 'A - Z'),
                                                                    on_activate_call=(
                                                                        lambda: loop.create_task(self._on_order_button_press())),
                                                                    button_type="square",
                                                                    textcolor=b_textcolor,
                                                                    text_scale=0.6)
        else:
            bui.buttonwidget(edit=self.alphabet_order_selection_button,
                             label=('Z - A' if self.selected_alphabet_order == 'z_a' else 'A - Z')
                             )

        label = f"Category: {post_label}"

        if self.category_selection_button is None:
            self.category_selection_button = bui.buttonwidget(parent=self._root_widget,
                                                              position=(category_pos_x,
                                                                        category_pos_y),
                                                              size=b_size,
                                                              on_activate_call=(
                                                                  self.show_categories_window),
                                                              label=label,
                                                              button_type="square",
                                                              textcolor=b_textcolor,
                                                              text_scale=0.6)
        else:
            self.category_selection_button = bui.buttonwidget(edit=self.category_selection_button,
                                                              label=label)

    async def _on_order_button_press(self) -> None:
        self.selected_alphabet_order = ('a_z' if self.selected_alphabet_order == 'z_a' else 'z_a')
        bui.buttonwidget(edit=self.alphabet_order_selection_button,
                         label=('Z - A' if self.selected_alphabet_order == 'z_a' else 'A - Z')
                         )
        filter_text = bui.textwidget(parent=self._root_widget, query=self._filter_widget)
        if self.plugin_manager.categories != {}:
            if self.plugin_manager.categories['All'] is not None:
                await self.draw_plugin_names(
                    self.selected_category, search_term=filter_text, refresh=True, order=self.selected_alphabet_order
                )

    def draw_search_bar(self):
        search_bar_pos_x = (85 if _uiscale is babase.UIScale.SMALL else
                            68 if _uiscale is babase.UIScale.MEDIUM else 75)
        search_bar_pos_y = self._height - (
            145 if _uiscale is babase.UIScale.SMALL else
            110 if _uiscale is babase.UIScale.MEDIUM else 116)

        search_bar_size_x = (320 if _uiscale is babase.UIScale.SMALL else
                             230 if _uiscale is babase.UIScale.MEDIUM else 260)
        search_bar_size_y = (
            35 if _uiscale is babase.UIScale.SMALL else
            35 if _uiscale is babase.UIScale.MEDIUM else 45)

        filter_txt_pos_x = (60 if _uiscale is babase.UIScale.SMALL else
                            40 if _uiscale is babase.UIScale.MEDIUM else 50)
        filter_txt_pos_y = search_bar_pos_y + (3 if _uiscale is babase.UIScale.SMALL else
                                               4 if _uiscale is babase.UIScale.MEDIUM else 8)

        bui.textwidget(parent=self._root_widget,
                       text="Filter",
                       position=(filter_txt_pos_x, filter_txt_pos_y),
                       selectable=False,
                       h_align='left',
                       v_align='center',
                       color=bui.app.ui_v1.title_color,
                       scale=0.5)

        filter_txt = babase.Lstr(resource='filterText')
        search_bar_maxwidth = search_bar_size_x - (95 if _uiscale is babase.UIScale.SMALL else
                                                   77 if _uiscale is babase.UIScale.MEDIUM else
                                                   85)
        self._filter_widget = bui.textwidget(parent=self._root_widget,
                                             text="",
                                             size=(search_bar_size_x, search_bar_size_y),
                                             position=(search_bar_pos_x, search_bar_pos_y),
                                             h_align='left',
                                             v_align='center',
                                             editable=True,
                                             scale=0.8,
                                             autoselect=True,
                                             maxwidth=search_bar_maxwidth,
                                             description=filter_txt)
        self._last_filter_text = ""
        self._last_filter_plugins = []

        loop.create_task(self.process_search_term())

    async def process_search_term(self):
        while True:
            await asyncio.sleep(0.2)
            if not self._filter_widget:
                # Search filter widget got destroyed. No point checking for filter text anymore.
                return
            filter_text = bui.textwidget(parent=self._root_widget, query=self._filter_widget)
            if self.selected_category is None:
                continue
            try:
                await self.draw_plugin_names(
                    self.selected_category, search_term=filter_text.lower(), order=self.selected_alphabet_order)
            except CategoryDoesNotExist:
                pass

    def draw_settings_icon(self):
        settings_pos_x = (610 if _uiscale is babase.UIScale.SMALL else
                          500 if _uiscale is babase.UIScale.MEDIUM else 510)
        settings_pos_y = (130 if _uiscale is babase.UIScale.SMALL else
                          60 if _uiscale is babase.UIScale.MEDIUM else 70)
        controller_button = bui.buttonwidget(parent=self._root_widget,
                                             position=(settings_pos_x, settings_pos_y),
                                             size=(30, 30),
                                             button_type="square",
                                             label="",
                                             on_activate_call=babase.Call(PluginManagerSettingsWindow,
                                                                          self.plugin_manager,
                                                                          self._root_widget))
        bui.imagewidget(parent=self._root_widget,
                        position=(settings_pos_x, settings_pos_y),
                        size=(30, 30),
                        color=(0.8, 0.95, 1),
                        texture=bui.gettexture("settingsIcon"),
                        draw_controller=controller_button)

    def draw_refresh_icon(self):
        refresh_pos_x = (610 if _uiscale is babase.UIScale.SMALL else
                         500 if _uiscale is babase.UIScale.MEDIUM else 510)
        refresh_pos_y = (180 if _uiscale is babase.UIScale.SMALL else
                         108 if _uiscale is babase.UIScale.MEDIUM else 120)

        controller_button = bui.buttonwidget(parent=self._root_widget,
                                             position=(refresh_pos_x, refresh_pos_y),
                                             size=(30, 30),
                                             button_type="square",
                                             label="",
                                             on_activate_call=lambda:
                                             loop.create_task(self.refresh()))
        bui.imagewidget(parent=self._root_widget,
                        position=(refresh_pos_x, refresh_pos_y),
                        size=(30, 30),
                        color=(0.8, 0.95, 1),
                        texture=bui.gettexture("replayIcon"),
                        draw_controller=controller_button)

    def search_term_filterer(self, plugin, search_term):
        # This helps resolve "plugin name" to "plugin_name".
        if search_term in plugin.info["description"].lower():
            return True
        search_term = search_term.replace(" ", "_")
        if search_term in plugin.name:
            return True
        for author in plugin.info["authors"]:
            if search_term in author["name"].lower():
                return True
        return False

    # XXX: Not sure if this is the best way to handle search filters.
    async def draw_plugin_names(self, category, search_term="", refresh=False, order='a_z'):
        # Re-draw plugin list UI if either search term or category was switched.
        to_draw_plugin_names = (search_term, category) != (self._last_filter_text,
                                                           self.selected_category)
        if not (to_draw_plugin_names or refresh):
            return

        try:
            if self.plugin_manager.categories != {}:
                if self.plugin_manager.categories['All'] is not None:
                    category_plugins = await self.plugin_manager.categories[category if category != 'Installed' else 'All'].get_plugins()
                else:
                    return
            else:
                return
        except (KeyError, AttributeError):
            no_internet_text = "Make sure you are connected\n to the Internet and try again."
            if bui.textwidget(query=self._plugin_manager_status_text) != no_internet_text:
                raise CategoryDoesNotExist(f"{category} does not exist.")
            else:
                return

        if search_term:
            plugins = list(filter(
                lambda plugin: self.search_term_filterer(plugin, search_term),
                category_plugins,
            ))
        else:
            plugins = category_plugins

        def return_name(val):
            return val.name
        plugins.sort(key=return_name, reverse=(True if order == 'z_a' else False))

        if plugins == self._last_filter_plugins and not refresh:
            # Plugins names to draw on UI are already drawn.
            return

        self._last_filter_text = search_term
        self._last_filter_plugins = plugins

        if category == 'Installed':
            plugin_names_to_draw = tuple(self.draw_plugin_name(plugin)
                                         for plugin in plugins if plugin.is_installed)
        else:
            plugin_names_to_draw = tuple(self.draw_plugin_name(plugin) for plugin in plugins)

        for plugin in self._columnwidget.get_children():
            plugin.delete()
        text_widget = bui.textwidget(parent=self._columnwidget)
        text_widget.delete()

        await asyncio.gather(*plugin_names_to_draw)

    async def draw_plugin_name(self, plugin):
        try:
            latest_compatible_version = plugin.latest_compatible_version
        except NoCompatibleVersion:
            # We currently don't show plugins that have no compatible versions.
            return

        if plugin.is_installed:
            local_plugin = plugin.get_local()
            if await local_plugin.is_enabled():
                if not local_plugin.is_installed_via_plugin_manager:
                    color = (0.8, 0.2, 0.2)
                elif local_plugin.version == latest_compatible_version.number:
                    color = (0, 0.95, 0.2)
                else:
                    color = (1, 0.6, 0)
            else:
                color = (1, 1, 1)
        else:
            color = (0.5, 0.5, 0.5)

        plugin_name_widget_to_update = self.plugins_in_current_view.get(plugin.name)
        if plugin_name_widget_to_update:
            bui.textwidget(edit=plugin_name_widget_to_update,
                           color=color)
        else:
            text_widget = bui.textwidget(parent=self._columnwidget,
                                         size=(410, 30),
                                         selectable=True,
                                         always_highlight=True,
                                         color=color,
                                         text=plugin.name.replace('_', ' ').title(),
                                         click_activate=True,
                                         on_activate_call=lambda: self.show_plugin_window(plugin),
                                         h_align='left',
                                         v_align='center',
                                         maxwidth=420)
            self.plugins_in_current_view[plugin.name] = text_widget
            # XXX: This seems nicer. Might wanna use this in future.
            # text_widget.add_delete_callback(lambda: self.plugins_in_current_view.pop(plugin.name))

    def show_plugin_window(self, plugin):
        PluginWindow(plugin, self._root_widget, lambda: self.draw_plugin_name(plugin))

    def show_categories_window(self):
        PluginCategoryWindow(
            self.plugin_manager.categories.keys(),
            self.selected_category,
            self._root_widget,
            self.select_category,
        )

    async def select_category(self, category):
        self.plugins_in_current_view.clear()
        self.draw_category_selection_button(post_label=category)
        await self.draw_plugin_names(
            category, search_term=self._last_filter_text, refresh=True, order=self.selected_alphabet_order)
        self.selected_category = category

    def cleanup(self):
        self.plugin_manager.cleanup()
        for plugin in self._columnwidget.get_children():
            plugin.delete()
        self.plugins_in_current_view.clear()
        self._last_filter_text = ""
        self._last_filter_plugins = []

    async def refresh(self):
        self.cleanup()
        try:
            bui.textwidget(edit=self._plugin_manager_status_text, text="Refreshing")
        except:
            pass
        if self._dot_timer is None:
            self._dot_timer = babase.AppTimer(0.5, self._update_dots, repeat=True)

        with self.exception_handler():
            await self.plugin_manager.refresh()
            await self.plugin_manager.setup_changelog()
            await self.plugin_manager.setup_index()
            self._dot_timer = None
            try:
                bui.textwidget(edit=self._plugin_manager_status_text, text="")
            except:
                pass
            await self.select_category(self.selected_category)

    def soft_refresh(self):
        pass


class PluginManagerSettingsWindow(popup.PopupWindow):
    def __init__(self, plugin_manager, origin_widget):
        self._plugin_manager = plugin_manager
        self.scale_origin = origin_widget.get_screen_space_center()
        self.settings = babase.app.config["Community Plugin Manager"]["Settings"].copy()

        loop.create_task(self.draw_ui())

    async def draw_ui(self):
        b_text_color = (0.8, 0.8, 0.85)
        s = 1.25 if _uiscale is babase.UIScale.SMALL else 1.27 if _uiscale is babase.UIScale.MEDIUM else 1.3
        width = 380 * s
        height = 150 + 150 * s
        color = (0.9, 0.9, 0.9)

        # Subtracting the default bluish-purple color from the texture, so it's as close
        # as to white as possible.
        discord_fg_color = (10 - 0.32, 10 - 0.39, 10 - 0.96)
        discord_bg_color = (0.525, 0.595, 1.458)
        github_bg_color = (0.23, 0.23, 0.23)
        text_scale = 0.7 * s
        self._transition_out = 'out_scale'
        transition = 'in_scale'
        button_size = (32 * s, 32 * s)
        # index = await self._plugin_manager.get_index()
        self._root_widget = bui.containerwidget(size=(width, height),
                                                on_outside_click_call=self._ok,
                                                transition=transition,
                                                scale=(2.1 if _uiscale is babase.UIScale.SMALL else 1.5
                                                       if _uiscale is babase.UIScale.MEDIUM else 1.0),
                                                scale_origin_stack_offset=self.scale_origin)
        pos = height * 0.9
        setting_title = "Settings"
        bui.textwidget(parent=self._root_widget,
                       position=(width * 0.49, pos),
                       size=(0, 0),
                       h_align='center',
                       v_align='center',
                       text=setting_title,
                       scale=text_scale,
                       color=bui.app.ui_v1.title_color,
                       maxwidth=width * 0.9)

        pos -= 20
        self._changelog_button = bui.buttonwidget(parent=self._root_widget,
                                                  position=((width * 0.2) - button_size[0] / 2 - 5,
                                                            pos),
                                                  size=(80, 30),
                                                  on_activate_call=lambda:
                                                      ChangelogWindow(self._root_widget),
                                                  textcolor=b_text_color,
                                                  button_type='square',
                                                  label='')
        bui.textwidget(parent=self._root_widget,
                       position=((width * 0.2) - button_size[0] / 2, pos),
                       size=(70, 30),
                       scale=0.6,
                       h_align='center',
                       v_align='center',
                       text='ChangeLog',
                       color=b_text_color,
                       draw_controller=self._changelog_button,
                       )
        self._save_button = bui.buttonwidget(parent=self._root_widget,
                                             position=((width * 0.82) - button_size[0] / 2, pos),
                                             size=(73, 35),
                                             on_activate_call=self.save_settings_button,
                                             textcolor=b_text_color,
                                             button_type='square',
                                             text_scale=1,
                                             scale=0,
                                             selectable=False,
                                             label="Save")
        pos -= 40

        for setting, value in self.settings.items():
            bui.checkboxwidget(parent=self._root_widget,
                               position=(width * 0.1, pos),
                               size=(170, 30),
                               text=setting,
                               value=value,
                               on_value_change_call=babase.Call(self.toggle_setting, setting),
                               maxwidth=500,
                               textcolor=(0.9, 0.9, 0.9),
                               scale=text_scale * 0.8)
            pos -= 34 * text_scale

        pos = height - 200
        bui.textwidget(parent=self._root_widget,
                       position=(width * 0.49, pos-5),
                       size=(0, 0),
                       h_align='center',
                       v_align='center',
                       text='Contribute to plugins or to this community plugin manager!',
                       scale=text_scale * 0.65,
                       color=color,
                       maxwidth=width * 0.95)

        pos -= 75
        try:
            plugin_manager_update_available = await self._plugin_manager.get_update_details()
        except urllib.error.URLError:
            plugin_manager_update_available = False
        discord_width = (width * 0.20) if plugin_manager_update_available else (width * 0.31)
        self.discord_button = bui.buttonwidget(parent=self._root_widget,
                                               position=(discord_width - button_size[0] / 2, pos),
                                               size=button_size,
                                               on_activate_call=lambda: bui.open_url(DISCORD_URL),
                                               textcolor=b_text_color,
                                               color=discord_bg_color,
                                               button_type='square',
                                               text_scale=1,
                                               label="")

        bui.imagewidget(parent=self._root_widget,
                        position=(discord_width+0.5 - button_size[0] / 2, pos),
                        size=button_size,
                        texture=bui.gettexture("discordLogo"),
                        color=discord_fg_color,
                        draw_controller=self.discord_button)

        github_width = (width * 0.49) if plugin_manager_update_available else (width * 0.65)
        self.github_button = bui.buttonwidget(parent=self._root_widget,
                                              position=(github_width - button_size[0] / 2, pos),
                                              size=button_size,
                                              on_activate_call=lambda: bui.open_url(REPOSITORY_URL),
                                              textcolor=b_text_color,
                                              color=github_bg_color,
                                              button_type='square',
                                              text_scale=1,
                                              label='')

        bui.imagewidget(parent=self._root_widget,
                        position=(github_width + 0.5 - button_size[0] / 2, pos),
                        size=button_size,
                        texture=bui.gettexture("githubLogo"),
                        color=(1, 1, 1),
                        draw_controller=self.github_button)

        bui.containerwidget(edit=self._root_widget, on_cancel_call=self._ok)

        try:
            plugin_manager_update_available = await self._plugin_manager.get_update_details()
        except urllib.error.URLError:
            plugin_manager_update_available = False
        if plugin_manager_update_available:
            text_color = (0.75, 0.2, 0.2)
            button_size = (95 * s, 32 * s)
            update_button_label = f'Update to v{plugin_manager_update_available[0]}'
            self._update_button = bui.buttonwidget(parent=self._root_widget,
                                                   position=((width * 0.77) - button_size[0] / 2,
                                                             pos),
                                                   size=button_size,
                                                   on_activate_call=lambda:
                                                   loop.create_task(
                                                       self.update(
                                                           *plugin_manager_update_available
                                                       )
                                                   ),
                                                   textcolor=b_text_color,
                                                   button_type='square',
                                                   text_scale=1,
                                                   color=(0, 0.7, 0),
                                                   label=update_button_label)
            self._restart_to_reload_changes_text = bui.textwidget(parent=self._root_widget,
                                                                  position=(width * 0.79, pos + 20),
                                                                  size=(0, 0),
                                                                  h_align='center',
                                                                  v_align='center',
                                                                  text='',
                                                                  scale=text_scale * 0.65,
                                                                  color=(0, 0.8, 0),
                                                                  maxwidth=width * 0.9)
        else:
            text_color = (0, 0.8, 0)
        pos -= 25
        bui.textwidget(parent=self._root_widget,
                       position=(width * 0.49, pos),
                       size=(0, 0),
                       h_align='center',
                       v_align='center',
                       text=f'Plugin Manager v{PLUGIN_MANAGER_VERSION}',
                       scale=text_scale * 0.8,
                       color=text_color,
                       maxwidth=width * 0.9)
        pos -= 25
        bui.textwidget(parent=self._root_widget,
                       position=(width * 0.49, pos),
                       size=(0, 0),
                       h_align='center',
                       v_align='center',
                       text=f'API Version: {_app_api_version}',
                       scale=text_scale * 0.7,
                       color=(0.4, 0.8, 1),
                       maxwidth=width * 0.95)

        pos = height * 0.1

    def toggle_setting(self, setting, set_value):
        self.settings[setting] = set_value
        check = self.settings == babase.app.config["Community Plugin Manager"]["Settings"]
        bui.buttonwidget(edit=self._save_button,
                         scale=0 if check else 1,
                         selectable=(not check))

    def save_settings_button(self):
        babase.app.config["Community Plugin Manager"]["Settings"] = self.settings.copy()
        babase.app.config.commit()
        self._ok()
        bui.getsound('gunCocking').play()

    async def update(self, to_version=None, commit_sha=None):
        try:
            await self._plugin_manager.update(to_version, commit_sha)
            await self._plugin_manager.setup_changelog()
        except MD5CheckSumFailed:
            bui.screenmessage("MD5 checksum failed during plugin manager update", color=(1, 0, 0))
            bui.getsound('error').play()
        else:
            bui.screenmessage("Plugin manager update successful", color=(0, 1, 0))
            bui.getsound('shieldUp').play()
            bui.textwidget(edit=self._restart_to_reload_changes_text,
                           text='Update Applied!\nRestart game to reload changes.')
            self._update_button.delete()

    def _ok(self) -> None:
        bui.getsound('swish').play()
        bui.containerwidget(edit=self._root_widget, transition='out_scale')


class NewAllSettingsWindow(AllSettingsWindow):
    """Window for selecting a settings category."""

    def __init__(
        self,
        transition: str | None = 'in_right',
        origin_widget: bui.Widget | None = None,
    ):
        # pylint: disable=too-many-statements
        # pylint: disable=too-many-locals
        assert bui.app.classic is not None
        uiscale = bui.app.ui_v1.uiscale
        width = 1000 if uiscale is bui.UIScale.SMALL else 800
        x_inset = 125 if uiscale is bui.UIScale.SMALL else 105
        height = 490
        top_extra = 20 if uiscale is bui.UIScale.SMALL else 0
        self._plugman_button = None

        super().__init__(transition, origin_widget)

        for child in self._root_widget.get_children():
            child.delete()

        bui.containerwidget(
            edit=self._root_widget, size=(width, height + top_extra)
        )

        if uiscale is bui.UIScale.SMALL:
            self._back_button = None
            bui.containerwidget(
                edit=self._root_widget, on_cancel_call=self.main_window_back
            )
        else:
            self._back_button = btn = bui.buttonwidget(
                parent=self._root_widget,
                autoselect=True,
                position=(x_inset - 20, height - 85),
                size=(130, 60),
                scale=0.8,
                text_scale=1.2,
                label=bui.Lstr(resource='backText'),
                button_type='back',
                on_activate_call=self.main_window_back,
            )
            bui.containerwidget(edit=self._root_widget, cancel_button=btn)

        bui.textwidget(
            parent=self._root_widget,
            position=(0, height - 80),
            size=(width, 25),
            text=bui.Lstr(resource=f'{self._r}.titleText'),
            color=bui.app.ui_v1.title_color,
            h_align='center',
            v_align='center',
            maxwidth=130,
        )

        if self._back_button is not None:
            bui.buttonwidget(
                edit=self._back_button,
                button_type='backSmall',
                size=(60, 60),
                label=bui.charstr(bui.SpecialChar.BACK),
            )

        v = height - 265
        basew = 280 if uiscale is bui.UIScale.SMALL else 230
        baseh = 170
        x_offs = (
            x_inset + (105 if uiscale is bui.UIScale.SMALL else 72) - basew
        )  # now unused
        x_dif = (basew - 7) / 2
        x_offs2 = x_offs + basew - 7
        x_offs3 = x_offs + 2 * (basew - 7)
        x_offs4 = x_offs + 3 * (basew - 7)
        x_offs5 = x_offs2
        x_offs6 = x_offs3
        x_offs2 -= x_dif
        x_offs3 -= x_dif
        x_offs4 -= x_dif

        def _b_title(
            x: float, y: float, button: bui.Widget, text: str | bui.Lstr
        ) -> None:
            bui.textwidget(
                parent=self._root_widget,
                text=text,
                position=(x + basew * 0.47, y + baseh * 0.22),
                maxwidth=basew * 0.7,
                size=(0, 0),
                h_align='center',
                v_align='center',
                draw_controller=button,
                color=(0.7, 0.9, 0.7, 1.0),
            )

        ctb = self._controllers_button = bui.buttonwidget(
            parent=self._root_widget,
            autoselect=True,
            position=(x_offs2, v),
            size=(basew, baseh),
            button_type='square',
            label='',
            on_activate_call=self._do_controllers,
        )
        if self._back_button is None:
            bbtn = bui.get_special_widget('back_button')
            bui.widget(edit=ctb, left_widget=bbtn)
        _b_title(
            x_offs2, v, ctb, bui.Lstr(resource=f'{self._r}.controllersText')
        )
        imgw = imgh = 130
        bui.imagewidget(
            parent=self._root_widget,
            position=(x_offs2 + basew * 0.49 - imgw * 0.5, v + 35),
            size=(imgw, imgh),
            texture=bui.gettexture('controllerIcon'),
            draw_controller=ctb,
        )

        gfxb = self._graphics_button = bui.buttonwidget(
            parent=self._root_widget,
            autoselect=True,
            position=(x_offs3, v),
            size=(basew, baseh),
            button_type='square',
            label='',
            on_activate_call=self._do_graphics,
        )
        pbtn = bui.get_special_widget('squad_button')
        bui.widget(edit=gfxb, up_widget=pbtn, right_widget=pbtn)
        _b_title(x_offs3, v, gfxb, bui.Lstr(resource=f'{self._r}.graphicsText'))
        imgw = imgh = 110
        bui.imagewidget(
            parent=self._root_widget,
            position=(x_offs3 + basew * 0.49 - imgw * 0.5, v + 42),
            size=(imgw, imgh),
            texture=bui.gettexture('graphicsIcon'),
            draw_controller=gfxb,
        )

        abtn = self._audio_button = bui.buttonwidget(
            parent=self._root_widget,
            autoselect=True,
            position=(x_offs4, v),
            size=(basew, baseh),
            button_type='square',
            label='',
            on_activate_call=self._do_audio,
        )
        _b_title(x_offs4, v, abtn, bui.Lstr(resource=f'{self._r}.audioText'))
        imgw = imgh = 120
        bui.imagewidget(
            parent=self._root_widget,
            position=(x_offs4 + basew * 0.49 - imgw * 0.5 + 5, v + 35),
            size=(imgw, imgh),
            color=(1, 1, 0),
            texture=bui.gettexture('audioIcon'),
            draw_controller=abtn,
        )

        v -= baseh - 5

        avb = self._advanced_button = bui.buttonwidget(
            parent=self._root_widget,
            autoselect=True,
            position=(x_offs5, v),
            size=(basew, baseh),
            button_type='square',
            label='',
            on_activate_call=self._do_advanced,
        )
        _b_title(x_offs5, v, avb, bui.Lstr(resource=f'{self._r}.advancedText'))
        imgw = imgh = 120
        bui.imagewidget(
            parent=self._root_widget,
            position=(x_offs5 + basew * 0.49 - imgw * 0.5 + 5, v + 35),
            size=(imgw, imgh),
            color=(0.8, 0.95, 1),
            texture=bui.gettexture('advancedIcon'),
            draw_controller=avb,
        )

        self._plugman_button = pmb = bui.buttonwidget(
            parent=self._root_widget,
            autoselect=True,
            position=(x_offs6, v),
            size=(basew, baseh),
            button_type='square',
            label='',
            on_activate_call=self._do_plugman,
        )
        _b_title(x_offs6, v, pmb, bui.Lstr(value="Plugin Manager"))
        imgw = imgh = 120
        bui.imagewidget(
            parent=self._root_widget,
            position=(x_offs6 + basew * 0.49 - imgw * 0.5 + 5, v + 35),
            size=(imgw, imgh),
            color=(0.8, 0.95, 1),
            texture=bui.gettexture('storeIcon'),
            draw_controller=pmb,
        )
        self._restore_state()

    def _do_plugman(self) -> None:
        # no-op if we're not in control.
        if not self.main_window_has_control():
            return

        self.main_window_replace(
            PluginManagerWindow(origin_widget=self._plugman_button)
        )

    def _save_state(self) -> None:
        try:
            sel = self._root_widget.get_selected_child()
            if sel == self._controllers_button:
                sel_name = 'Controllers'
            elif sel == self._graphics_button:
                sel_name = 'Graphics'
            elif sel == self._audio_button:
                sel_name = 'Audio'
            elif sel == self._advanced_button:
                sel_name = 'Advanced'
            elif sel == self._plugman_button:
                sel_name = 'PlugMan'
            elif sel == self._back_button:
                sel_name = 'Back'
            else:
                raise ValueError(f'unrecognized selection \'{sel}\'')
            assert bui.app.classic is not None
            bui.app.ui_v1.window_states[type(self)] = {'sel_name': sel_name}
        except Exception:
            logging.exception('Error saving state for %s.', self)

    def _restore_state(self) -> None:
        try:
            assert bui.app.classic is not None
            sel_name = bui.app.ui_v1.window_states.get(type(self), {}).get(
                'sel_name'
            )
            sel: bui.Widget | None
            if sel_name == 'Controllers':
                sel = self._controllers_button
            elif sel_name == 'Graphics':
                sel = self._graphics_button
            elif sel_name == 'Audio':
                sel = self._audio_button
            elif sel_name == 'Advanced':
                sel = self._advanced_button
            elif sel_name == "PlugMan":
                sel = self._plugman_button
            elif sel_name == 'Back':
                sel = self._back_button
            else:
                sel = self._controllers_button
            if sel is not None:
                bui.containerwidget(edit=self._root_widget, selected_child=sel)
        except Exception:
            logging.exception('Error restoring state for %s.', self)


# ba_meta export babase.Plugin
class EntryPoint(babase.Plugin):
    def on_app_running(self) -> None:
        """Called when the app is being launched."""
        from bauiv1lib.settings import allsettings
        allsettings.AllSettingsWindow = NewAllSettingsWindow
        DNSBlockWorkaround.apply()
        asyncio.set_event_loop(babase._asyncio._asyncio_event_loop)
        startup_tasks = StartupTasks()

        loop.create_task(startup_tasks.execute())