uninstall_command.py

from .exceptions import ArgumentError, FilesInUseError
from .fsutils import rmtree, unlink
from .installs import get_matching_install_tags
from .install_command import SHORTCUT_HANDLERS, update_all_shortcuts
from .logging import LOGGER
from .pathutils import Path, PurePath
from .tagutils import tag_or_range


def _iterdir(p, only_files=False):
    try:
        if only_files:
            return [f for f in Path(p).iterdir() if f.is_file()]
        return list(Path(p).iterdir())
    except FileNotFoundError:
        LOGGER.debug("Skipping %s because it does not exist", p)
        return []


def _do_purge_global_dir(global_dir, warn_msg, *, hive=None, subkey="Environment"):
    import winreg

    if hive is None:
        hive = winreg.HKEY_CURRENT_USER
    try:
        with winreg.OpenKeyEx(hive, subkey) as key:
            path, kind = winreg.QueryValueEx(key, "Path")
        if kind not in (winreg.REG_SZ, winreg.REG_EXPAND_SZ):
            raise ValueError("Value kind is not a string")
    except (OSError, ValueError):
        LOGGER.debug("Not removing global commands directory from PATH", exc_info=True)
    else:
        LOGGER.debug("Current PATH contains %s", path)
        paths = path.split(";")
        newpaths = []
        for p in paths:
            # We should expand entries here, but we only want to remove those
            # that we added ourselves (during firstrun), and we never use
            # environment variables. So even if the kind is REG_EXPAND_SZ, we
            # don't need to expand to find our own entry.
            #ep = os.path.expandvars(p) if kind == winreg.REG_EXPAND_SZ else p
            ep = p
            if PurePath(ep).match(global_dir):
                LOGGER.debug("Removing from PATH: %s", p)
            else:
                newpaths.append(p)
        if len(newpaths) < len(paths):
            newpath = ";".join(newpaths)
            with winreg.CreateKeyEx(hive, subkey, access=winreg.KEY_READ|winreg.KEY_WRITE) as key:
                path2, kind2 = winreg.QueryValueEx(key, "Path")
                if path2 == path and kind2 == kind:
                    LOGGER.info("Removing global commands directory from PATH")
                    LOGGER.debug("New PATH contains %s", newpath)
                    winreg.SetValueEx(key, "Path", 0, kind, newpath)
                else:
                    LOGGER.debug("Not removing global commands directory from PATH "
                                 "because the registry changed while processing.")

            try:
                from _native import broadcast_settings_change
                broadcast_settings_change()
            except (ImportError, OSError):
                LOGGER.debug("Did not broadcast settings change notification",
                             exc_info=True)

    if not global_dir.is_dir():
        return
    LOGGER.info("Purging global commands from %s", global_dir)
    rmtree(global_dir, after_5s_warning=warn_msg)


def execute(cmd):
    LOGGER.debug("BEGIN uninstall_command.execute: %r", cmd.args)

    warn_msg = ("Attempting to remove {} is taking longer than expected. " +
        "Ensure no Python interpreters are running, and continue to wait " +
        "or press Ctrl+C to abort.")

    # Clear any active venv so we don't try to delete it
    cmd.virtual_env = None
    installed = list(cmd.get_installs())

    cmd.tags = []

    if cmd.purge:
        if not cmd.ask_yn("Uninstall all runtimes?"):
            LOGGER.debug("END uninstall_command.execute")
            return
        for i in installed:
            LOGGER.info("Purging %s from %s", i["display-name"], i["prefix"])
            try:
                rmtree(
                    i["prefix"],
                    after_5s_warning=warn_msg.format(i["display-name"]),
                    remove_ext_first=("exe", "dll", "json")
                )
            except FilesInUseError:
                LOGGER.warn("Unable to purge %s because it is still in use.",
                            i["display-name"])
                continue
        LOGGER.info("Purging saved downloads from %s", cmd.download_dir)
        rmtree(cmd.download_dir, after_5s_warning=warn_msg.format("cached downloads"))
        # Purge global commands directory
        _do_purge_global_dir(cmd.global_dir, warn_msg.format("global commands"))
        LOGGER.info("Purging all shortcuts")
        for _, cleanup in SHORTCUT_HANDLERS.values():
            if cleanup:
                cleanup(cmd, [])
        LOGGER.debug("END uninstall_command.execute")
        return

    if not cmd.args:
        raise ArgumentError("Please specify one or more runtimes to uninstall.")

    to_uninstall = []
    if not cmd.by_id:
        for tag in cmd.args:
            try:
                if tag.casefold() == "default".casefold():
                    cmd.tags.append(tag_or_range(cmd.default_tag))
                else:
                    cmd.tags.append(tag_or_range(tag))
            except ValueError as ex:
                LOGGER.warn("%s", ex)

        for tag in cmd.tags:
            candidates = get_matching_install_tags(
                installed,
                tag,
                default_platform=cmd.default_platform,
            )
            if not candidates:
                LOGGER.warn("No install found matching '%s'", tag)
                continue
            i, _ = candidates[0]
            LOGGER.debug("Selected %s (%s) to uninstall", i["display-name"], i["id"])
            to_uninstall.append(i)
            installed.remove(i)
    else:
        ids = {tag.casefold() for tag in cmd.args}
        for i in installed:
            if i["id"].casefold() in ids:
                LOGGER.debug("Selected %s (%s) to uninstall", i["display-name"], i["id"])
                to_uninstall.append(i)
        for i in to_uninstall:
            installed.remove(i)

    if not to_uninstall:
        LOGGER.info("No runtimes selected to uninstall.")
        return
    elif cmd.confirm:
        if len(to_uninstall) == 1:
            if not cmd.ask_yn("Uninstall %s?", to_uninstall[0]["display-name"]):
                return
        else:
            msg = ", ".join(i["display-name"] for i in to_uninstall)
            if not cmd.ask_yn("Uninstall these runtimes: %s?", msg):
                return

    for i in to_uninstall:
        LOGGER.debug("Uninstalling %s from %s", i["display-name"], i["prefix"])
        try:
            rmtree(
                i["prefix"],
                after_5s_warning=warn_msg.format(i["display-name"]),
                remove_ext_first=("exe", "dll", "json"),
            )
        except FilesInUseError as ex:
            LOGGER.error("Could not uninstall %s because it is still in use.",
                         i["display-name"])
            raise SystemExit(1) from ex
        LOGGER.info("Removed %s", i["display-name"])
        try:
            for target in cmd.global_dir.glob("*.__target__"):
                alias = target.with_suffix("")
                entry = target.read_text(encoding="utf-8-sig", errors="strict")
                if PurePath(entry).match(i["executable"]):
                    LOGGER.debug("Unlink %s", alias)
                    unlink(alias, after_5s_warning=warn_msg.format(alias))
                    unlink(target, after_5s_warning=warn_msg.format(target))
        except OSError as ex:
            LOGGER.warn("Failed to remove alias: %s", ex)
            LOGGER.debug("TRACEBACK:", exc_info=True)

    if to_uninstall:
        update_all_shortcuts(cmd)

    LOGGER.debug("END uninstall_command.execute")