euscan-ng/src/euscan/out.py

# Copyright 2011 Corentin Chary <corentin.chary@gmail.com>
# Copyright 2020-2023 src_prepare group
# Distributed under the terms of the GNU General Public License v2

import json
import re
import signal
import sys
import time
from collections import defaultdict
from io import StringIO

import portage
from gentoolkit import pprinter as pp
from portage.output import EOutput, TermProgressBar

from euscan.helpers import dict_to_xml

mirrors_ = None


class ProgressHandler(object):
    def __init__(self, progress_bar):
        self.curval = 0
        self.maxval = 0
        self.last_update = 0
        self.min_display_latency = 0.2
        self.progress_bar = progress_bar

    def on_progress(self, maxval=None, increment=1, label=None):
        self.maxval = maxval or self.maxval
        self.curval += increment

        if label:
            self.progress_bar.label(label)

        cur_time = time.time()
        if cur_time - self.last_update >= self.min_display_latency:
            self.last_update = cur_time
            self.display()

    def display(self):
        raise NotImplementedError(self)


def progress_bar():
    on_progress = None
    try:
        progress_bar = TermProgressBar(fd=sys.stderr, title="euscan")
    except TypeError:
        progress_bar = TermProgressBar(title="euscan")

    progress_handler = ProgressHandler(progress_bar)
    on_progress = progress_handler.on_progress

    def display():
        progress_bar.set(progress_handler.curval, progress_handler.maxval)

    progress_handler.display = display

    def sigwinch_handler(signum, frame):
        lines, progress_bar.term_columns = portage.output.get_term_size()

    signal.signal(signal.SIGWINCH, sigwinch_handler)

    yield on_progress

    # make sure the final progress is displayed
    progress_handler.display()
    signal.signal(signal.SIGWINCH, signal.SIG_DFL)

    yield None


def clean_colors(string):
    if isinstance(string, str):
        string = re.sub("\033\[[0-9;]+m", "", string)
        string = re.sub(r"\\u001b\[[0-9;]+m", "", string)
        string = re.sub(r"\x1b\[[0-9;]+m", "", string)
    return string


def transform_url(config, cpv, url):
    if config["mirror"]:
        url = to_mirror(url)
    if config["ebuild-uri"]:
        url = to_ebuild_uri(cpv, url)
    return url


def to_ebuild_uri(cpv, url):
    cat, pkg, ver, rev = portage.catpkgsplit(cpv)
    p = "%s-%s" % (pkg, ver)
    pvr = "%s%s" % (ver, "-%s" % rev if rev != "r0" else "")
    pf = "%s-%s" % (pkg, pvr)
    evars = (
        (p, "P"),
        (pkg, "PN"),
        (ver, "PV"),
        (rev, "PR"),
        (pvr, "PVR"),
        (pf, "PF"),
        (cat, "CATEGORY"),
    )
    for src, dst in evars:
        url = url.replace(src, "${%s}" % dst)
    return url


def load_mirrors():
    import random

    global mirrors_
    if mirrors_ is None:
        mirrors_ = portage.settings.thirdpartymirrors()
    for mirror_name in mirrors_:
        random.shuffle(mirrors_[mirror_name])


def from_mirror(url):
    if not url.startswith("mirror://"):
        return url

    if not mirrors_:
        load_mirrors()

    for mirror_name in mirrors_:
        prefix = "mirror://" + mirror_name
        if url.startswith(prefix):
            return url.replace(prefix, mirrors_[mirror_name][0])

    return url


def to_mirror(url):
    if not mirrors_:
        load_mirrors()

    for mirror_name in mirrors_:
        for mirror_url in mirrors_[mirror_name]:
            if url.startswith(mirror_url):
                url_part = url.split(mirror_url)[1]
                return "mirror://%s%s%s" % (
                    mirror_name,
                    "" if url_part.startswith("/") else "/",
                    url_part,
                )
    return url


class EOutputMem(EOutput):
    """
    Override of EOutput, allows to specify an output file for writes
    """

    def __init__(self, *args, **kwargs):
        super(EOutputMem, self).__init__(*args, **kwargs)
        self.out = StringIO()

    def getvalue(self):
        return self.out.getvalue()

    def _write(self, f, msg):
        super(EOutputMem, self)._write(self.out, msg)


class EuscanOutput(object):
    """
    Class that handles output for euscan
    """

    def __init__(self, config):
        self.config = config
        self.queries = defaultdict(dict)
        self.current_query = None

    def clean(self):
        self.queries = defaultdict(dict)
        self.current_query = None

    def set_query(self, query):
        self.current_query = query
        if query is None:
            return

        if query in self.queries:
            return

        if self.config["format"]:
            output = EOutputMem()
        else:
            output = EOutput()

        self.queries[query] = {
            "output": output,
            "result": [],
            "metadata": {},
        }

    def get_formatted_output(self, format_=None):
        data = {}

        for query in self.queries:
            data[query] = {
                "result": self.queries[query]["result"],
                "metadata": self.queries[query]["metadata"],
                "messages": self.queries[query]["output"].getvalue(),
            }

        format_ = format_ or self.config["format"]
        if format_.lower() == "json":
            return json.dumps(data, indent=self.config["indent"])
        elif format_.lower() == "xml":
            return dict_to_xml(data, indent=self.config["indent"])
        elif format_.lower() == "dict":
            return data
        else:
            raise TypeError("Invalid output format")

    def result(self, cp, version, urls, handler, confidence):
        from euscan.version import get_version_type

        cpv = "%s-%s" % (cp, version)
        urls = " ".join(transform_url(self.config, cpv, url) for url in urls.split())

        if self.config["format"] in ["json", "dict"]:
            _curr = self.queries[self.current_query]
            _curr["result"].append(
                {
                    "version": version,
                    "urls": urls.split(),
                    "handler": handler,
                    "confidence": confidence,
                    "type": get_version_type(version),
                }
            )
        else:
            if not self.config["quiet"]:
                print("Upstream Version:", pp.number("%s" % version), end=" ")
                print(pp.path(" %s" % urls))
            else:
                print(pp.cpv("%s-%s" % (cp, version)) + ":", pp.path(urls))

    def metadata(self, key, value, show=True):
        if self.config["format"]:
            self.queries[self.current_query]["metadata"][key] = value
        elif show:
            print("%s: %s" % (key.capitalize(), value))

    def __getattr__(self, key):
        if not self.config["quiet"] and self.current_query is not None:
            output = self.queries[self.current_query]["output"]
            return getattr(output, key)
        else:
            return lambda *x: None