# Copyright 2003-2022 Gentoo Authors
# Distributed under the terms of the GNU General Public License v2

import codecs
import operator
import portage
import re
import sys
import xml.dom.minidom

from functools import reduce

from io import StringIO

from portage import _encodings, _unicode_decode, _unicode_encode
from portage import os
from portage.const import PRIVATE_PATH
from portage.dep import _slot_separator
from portage.localization import _
from portage.util import grabfile
from portage.versions import pkgsplit, vercmp

from urllib.request import urlopen as urllib_request_urlopen

# Note: the space for rgt and rlt is important !!
# FIXME: use slot deps instead, requires GLSA format versioning
opMapping = {
    "le": "<=",
    "lt": "<",
    "eq": "=",
    "gt": ">",
    "ge": ">=",
    "rge": ">=~",
    "rle": "<=~",
    "rgt": " >~",
    "rlt": " <~",
}
NEWLINE_ESCAPE = "!;\\n"  # some random string to mark newlines that should be preserved
SPACE_ESCAPE = "!;_"  # some random string to mark spaces that should be preserved
# See PMS 3.1.7 "Keyword names"
ARCH_REGEX = re.compile(r"^\*$|^[-_a-z0-9 ]+$")


def get_applied_glsas(settings):
    """
    Return a list of applied or injected GLSA IDs

    @type	settings: portage.config
    @param	settings: portage config instance
    @rtype:		list
    @return:	list of glsa IDs
    """
    return grabfile(os.path.join(settings["EROOT"], PRIVATE_PATH, "glsa_injected"))


# TODO: use the textwrap module instead
def wrap(text, width, caption=""):
    """
    Wraps the given text at column I{width}, optionally indenting
    it so that no text is under I{caption}. It's possible to encode
    hard linebreaks in I{text} with L{NEWLINE_ESCAPE}.

    @type	text: String
    @param	text: the text to be wrapped
    @type	width: Integer
    @param	width: the column at which the text should be wrapped
    @type	caption: String
    @param	caption: this string is inserted at the beginning of the
                                     return value and the paragraph is indented up to
                                     C{len(caption)}.
    @rtype:		String
    @return:	the wrapped and indented paragraph
    """
    rValue = ""
    line = caption
    text = text.replace(2 * NEWLINE_ESCAPE, NEWLINE_ESCAPE + " " + NEWLINE_ESCAPE)
    words = text.split()
    indentLevel = len(caption) + 1

    for word in words:
        if line and line[-1] == "\n":
            rValue = f"{rValue}{line}"
            line = " " * indentLevel
        if len(line) + len(word.replace(NEWLINE_ESCAPE, "")) + 1 > width:
            rValue = f"{rValue}{line}\n"
            escaped_word = word.replace(NEWLINE_ESCAPE, "\n")
            line = f"{' ' * indentLevel}{escaped_word}"
        elif word.find(NEWLINE_ESCAPE) >= 0:
            escaped_word = word.replace(NEWLINE_ESCAPE, "\n")
            whitespace = ""
            if len(line.strip()) > 0:
                whitespace = " "
            rValue = f"{rValue}{line}{whitespace}{escaped_word}"
            line = " " * indentLevel
        else:
            whitespace = ""
            if len(line.strip()) > 0:
                whitespace = " "
            line = f"{line}{whitespace}{word}"
    if len(line) > 0:
        escaped_line = line.replace(NEWLINE_ESCAPE, "\n")
        rValue = f"{rValue}{escaped_line}"
    rValue = rValue.replace(SPACE_ESCAPE, " ")
    return rValue


def get_glsa_list(myconfig):
    """
    Returns a list of all available GLSAs in the given repository
    by comparing the filelist there with the pattern described in
    the config.

    @type	myconfig: portage.config
    @param	myconfig: Portage settings instance

    @rtype:		List of Strings
    @return:	a list of GLSA IDs in this repository
    """

    repository = os.path.join(myconfig["PORTDIR"], "metadata", "glsa")
    if "GLSA_DIR" in myconfig:
        repository = myconfig["GLSA_DIR"]

    if not os.access(repository, os.R_OK):
        return []
    dirlist = os.listdir(repository)
    prefix = "glsa-"
    prefix_size = len(prefix)
    suffix = ".xml"
    suffix_size = len(suffix)

    def check(value):
        try:
            if value[:prefix_size] == prefix and value[-suffix_size:] == suffix:
                return value[prefix_size:-suffix_size]
        except IndexError:
            return None
        return None

    checked_dirlist = (check(f) for f in dirlist)
    rValue = [f for f in checked_dirlist if f]
    return rValue


def getListElements(listnode):
    """
    Get all <li> elements for a given <ol> or <ul> node.

    @type	listnode: xml.dom.Node
    @param	listnode: <ul> or <ol> list to get the elements for
    @rtype:		List of Strings
    @return:	a list that contains the value of the <li> elements
    """
    if not listnode.nodeName in ("ul", "ol"):
        raise GlsaFormatException("Invalid function call: listnode is not <ul> or <ol>")
    rValue = [
        getText(li, format="strip")
        for li in listnode.childNodes
        if li.nodeType == xml.dom.Node.ELEMENT_NODE
    ]
    return rValue


def getText(node, format, textfd=None):  # pylint: disable=redefined-builtin
    """
    This is the main parser function. It takes a node and traverses
    recursive over the subnodes, getting the text of each (and the
    I{link} attribute for <uri> and <mail>). Depending on the I{format}
    parameter the text might be formatted by adding/removing newlines,
    tabs and spaces. This function is only useful for the GLSA DTD,
    it's not applicable for other DTDs.

    @type	node: xml.dom.Node
    @param	node: the root node to start with the parsing
    @type	format: String
    @param	format: this should be either I{strip}, I{keep} or I{xml}
                                    I{keep} just gets the text and does no formatting.
                                    I{strip} replaces newlines and tabs with spaces and
                                    replaces multiple spaces with one space.
                                    I{xml} does some more formatting, depending on the
                                    type of the encountered nodes.
    @type	textfd: writable file-like object
    @param	textfd: the file-like object to write the output to
    @rtype:		String
    @return:	the (formatted) content of the node and its subnodes
                    except if textfd was not none
    """
    if not textfd:
        textfd = StringIO()
        returnNone = False
    else:
        returnNone = True
    if format in ("strip", "keep"):
        if node.nodeName in ("uri", "mail"):
            textfd.write(f"{node.childNodes[0].data}:{node.getAttribute('link')}")
        else:
            for subnode in node.childNodes:
                if subnode.nodeName == "#text":
                    textfd.write(subnode.data)
                else:
                    getText(subnode, format, textfd)
    else:  # format = "xml"
        for subnode in node.childNodes:
            if subnode.nodeName == "p":
                for p_subnode in subnode.childNodes:
                    if p_subnode.nodeName == "#text":
                        textfd.write(p_subnode.data.strip())
                    elif p_subnode.nodeName in ("uri", "mail"):
                        textfd.write(p_subnode.childNodes[0].data)
                        textfd.write(" ( " + p_subnode.getAttribute("link") + " )")
                textfd.write(NEWLINE_ESCAPE)
            elif subnode.nodeName == "ul":
                for li in getListElements(subnode):
                    textfd.write(f"-{SPACE_ESCAPE}{li}{NEWLINE_ESCAPE} ")
            elif subnode.nodeName == "ol":
                i = 0
                for li in getListElements(subnode):
                    i = i + 1
                    textfd.write(f"{i}.{SPACE_ESCAPE}{li}{NEWLINE_ESCAPE} ")
            elif subnode.nodeName == "code":
                textfd.write(
                    getText(subnode, format="keep")
                    .lstrip()
                    .replace("\n", NEWLINE_ESCAPE)
                )
                textfd.write(NEWLINE_ESCAPE)
            elif subnode.nodeName == "#text":
                textfd.write(subnode.data)
            else:
                raise GlsaFormatException(_("Invalid Tag found: "), subnode.nodeName)
    if returnNone:
        return None
    rValue = textfd.getvalue()
    if format == "strip":
        rValue = rValue.strip(" \n\t")
        rValue = re.sub(r"[\s]{2,}", " ", rValue)
    return rValue


def getMultiTagsText(rootnode, tagname, format):  # pylint: disable=redefined-builtin
    """
    Returns a list with the text of all subnodes of type I{tagname}
    under I{rootnode} (which itself is not parsed) using the given I{format}.

    @type	rootnode: xml.dom.Node
    @param	rootnode: the node to search for I{tagname}
    @type	tagname: String
    @param	tagname: the name of the tags to search for
    @type	format: String
    @param	format: see L{getText}
    @rtype:		List of Strings
    @return:	a list containing the text of all I{tagname} childnodes
    """
    rValue = [getText(e, format) for e in rootnode.getElementsByTagName(tagname)]
    return rValue


def makeAtom(pkgname, versionNode):
    """
    creates from the given package name and information in the
    I{versionNode} a (syntactical) valid portage atom.

    @type	pkgname: String
    @param	pkgname: the name of the package for this atom
    @type	versionNode: xml.dom.Node
    @param	versionNode: a <vulnerable> or <unaffected> Node that
                                             contains the version information for this atom
    @rtype:		String
    @return:	the portage atom
    """
    rangetype = versionNode.getAttribute("range")
    if rangetype in opMapping:
        op = opMapping[rangetype]
    else:
        raise GlsaFormatException(
            _(f"Invalid range found for '{pkgname}': {rangetype}")
        )
    version = getText(versionNode, format="strip")
    rValue = f"{op}{pkgname}-{version}"
    try:
        slot = versionNode.getAttribute("slot").strip()
    except KeyError:
        pass
    else:
        if slot and slot != "*":
            rValue = f"{rValue}{_slot_separator}{slot}"
    return str(rValue)


def makeVersion(versionNode):
    """
    creates from the information in the I{versionNode} a
    version string (format <op><version>).

    @type	versionNode: xml.dom.Node
    @param	versionNode: a <vulnerable> or <unaffected> Node that
                                             contains the version information for this atom
    @rtype:		String
    @return:	the version string
    """
    rangetype = versionNode.getAttribute("range")
    if rangetype in opMapping:
        op = opMapping[rangetype]
    else:
        raise GlsaFormatException(_(f"Invalid range found: {rangetype}"))
    version = getText(versionNode, format="strip")
    rValue = f"{op}{version}"
    try:
        slot = versionNode.getAttribute("slot").strip()
    except KeyError:
        pass
    else:
        if slot and slot != "*":
            rValue = f"{rValue}{_slot_separator}{slot}"
    return rValue


def match(atom, dbapi, match_type="default"):
    """
    wrapper that calls revisionMatch() or portage.dbapi.dbapi.match() depending on
    the given atom.

    @type	atom: string
    @param	atom: a <~ or >~ atom or a normal portage atom that contains the atom to match against
    @type	dbapi: portage.dbapi.dbapi
    @param	dbapi: one of the portage databases to use as information source
    @type	match_type: string
    @param	match_type: if != "default" passed as first argument to dbapi.xmatch
                            to apply the wanted visibility filters

    @rtype:		list of strings
    @return:	a list with the matching versions
    """
    if atom[2] == "~":
        return revisionMatch(atom, dbapi, match_type=match_type)
    if match_type == "default" or not hasattr(dbapi, "xmatch"):
        return dbapi.match(atom)
    return dbapi.xmatch(match_type, atom)


def revisionMatch(revisionAtom, dbapi, match_type="default"):
    """
    handler for the special >~, >=~, <=~ and <~ atoms that are supposed to behave
    as > and < except that they are limited to the same version, the range only
    applies to the revision part.

    @type	revisionAtom: string
    @param	revisionAtom: a <~ or >~ atom that contains the atom to match against
    @type	dbapi: portage.dbapi.dbapi
    @param	dbapi: one of the portage databases to use as information source
    @type	match_type: string
    @param	match_type: if != "default" passed as first argument to portdb.xmatch
                            to apply the wanted visibility filters

    @rtype:		list of strings
    @return:	a list with the matching versions
    """
    if match_type == "default" or not hasattr(dbapi, "xmatch"):
        if ":" in revisionAtom:
            mylist = dbapi.match(re.sub(r"-r[0-9]+(:[^ ]+)?$", r"\1", revisionAtom[2:]))
        else:
            mylist = dbapi.match(re.sub("-r[0-9]+$", "", revisionAtom[2:]))
    else:
        if ":" in revisionAtom:
            mylist = dbapi.xmatch(
                match_type, re.sub(r"-r[0-9]+(:[^ ]+)?$", r"\1", revisionAtom[2:])
            )
        else:
            mylist = dbapi.xmatch(match_type, re.sub("-r[0-9]+$", "", revisionAtom[2:]))
    rValue = []
    for v in mylist:
        r1 = pkgsplit(v)[-1][1:]
        r2 = pkgsplit(revisionAtom[3:])[-1][1:]
        if eval(r1 + " " + revisionAtom[0:2] + " " + r2):
            rValue.append(v)
    return rValue


def getMinUpgrade(vulnerableList, unaffectedList, portdbapi, vardbapi, minimize=True):
    """
    Checks if the systemstate is matching an atom in
    I{vulnerableList} and returns string describing
    the lowest version for the package that matches an atom in
    I{unaffectedList} and is greater than the currently installed
    version. It will return an empty list if the system is affected,
    and no upgrade is possible or None if the system is not affected.
    Both I{vulnerableList} and I{unaffectedList} should have the
    same base package.

    @type	vulnerableList: List of Strings
    @param	vulnerableList: atoms matching vulnerable package versions
    @type	unaffectedList: List of Strings
    @param	unaffectedList: atoms matching unaffected package versions
    @type	portdbapi:	portage.dbapi.porttree.portdbapi
    @param	portdbapi:	Ebuild repository
    @type	vardbapi:	portage.dbapi.vartree.vardbapi
    @param	vardbapi:	Installed package repository
    @type	minimize:	Boolean
    @param	minimize:	True for a least-change upgrade, False for emerge-like algorithm

    @rtype:		String | None
    @return:	the lowest unaffected version that is greater than
                            the installed version.
    """
    rValue = ""
    v_installed = reduce(operator.add, [match(v, vardbapi) for v in vulnerableList], [])
    u_installed = reduce(operator.add, [match(u, vardbapi) for u in unaffectedList], [])

    # remove all unaffected atoms from vulnerable list
    v_installed = list(set(v_installed).difference(set(u_installed)))

    if not v_installed:
        return None

    # this tuple holds all vulnerable atoms, and the related upgrade atom
    vuln_update = []
    avail_updates = set()
    for u in unaffectedList:
        # TODO: This had match_type="match-all" before. I don't think it should
        # since we disregarded masked items later anyway (match(=rValue, "porttree"))
        avail_updates.update(match(u, portdbapi))
    # if an atom is already installed, we should not consider it for upgrades
    avail_updates.difference_update(u_installed)

    for vuln in v_installed:
        update = ""
        for c in avail_updates:
            c_pv = portage.catpkgsplit(c)
            if (
                vercmp(c.version, vuln.version) > 0
                and (
                    update == "" or (minimize ^ (vercmp(c.version, update.version) > 0))
                )
                and portdbapi._pkg_str(c, None).slot
                == vardbapi._pkg_str(vuln, None).slot
            ):
                update = f"{c_pv[0]}/{c_pv[1]}-{c_pv[2]}"
                if c_pv[3] != "r0":  # we don't like -r0 for display
                    update = f"{update}-{c_pv[3]}"
                update = portdbapi._pkg_str(update, None)
        vuln_update.append([vuln, update])

    return vuln_update


def format_date(datestr):
    """
    Takes a date (announced, revised) date from a GLSA and formats
    it as readable text (i.e. "January 1, 2008").

    @type	date: String
    @param	date: the date string to reformat
    @rtype:		String
    @return:	a reformatted string, or the original string
                            if it cannot be reformatted.
    """
    splitdate = datestr.split("-", 2)
    if len(splitdate) != 3:
        return datestr

    # This cannot raise an error as we use () instead of []
    splitdate = (int(x) for x in splitdate)

    from datetime import date

    try:
        d = date(*splitdate)
    except ValueError:
        return datestr

    # TODO We could format to local date format '%x' here?
    return _unicode_decode(
        d.strftime("%B %d, %Y"), encoding=_encodings["content"], errors="replace"
    )


# simple Exception classes to catch specific errors


class GlsaTypeException(Exception):
    def __init__(self, doctype):
        Exception.__init__(self, f"wrong DOCTYPE: {doctype}")


class GlsaFormatException(Exception):
    pass


class GlsaArgumentException(Exception):
    pass


# GLSA xml data wrapper class


class Glsa:
    """
    This class is a wrapper for the XML data and provides methods to access
    and display the contained data.
    """

    def __init__(self, myid, myconfig, vardbapi, portdbapi):
        """
        Simple constructor to set the ID, store the config and gets the
        XML data by calling C{self.read()}.

        @type	myid: String
        @param	myid: String describing the id for the GLSA object (standard
                                  GLSAs have an ID of the form YYYYMM-nn) or an existing
                                  filename containing a GLSA.
        @type	myconfig: portage.config
        @param	myconfig: the config that should be used for this object.
        @type	vardbapi: portage.dbapi.vartree.vardbapi
        @param	vardbapi: installed package repository
        @type	portdbapi: portage.dbapi.porttree.portdbapi
        @param	portdbapi: ebuild repository
        """
        myid = _unicode_decode(myid, encoding=_encodings["content"], errors="strict")
        if re.match(r"\d{6}-\d{2}", myid):
            self.type = "id"
        elif os.path.exists(myid):
            self.type = "file"
        else:
            raise GlsaArgumentException(
                _(f"Given ID {myid} isn't a valid GLSA ID or filename.")
            )
        self.nr = myid
        self.config = myconfig
        self.vardbapi = vardbapi
        self.portdbapi = portdbapi
        self.read()

    def read(self):
        """
        Here we build the filename from the config and the ID and pass
        it to urllib to fetch it from the filesystem or a remote server.

        @rtype:		None
        @return:	None
        """
        if "GLSA_DIR" in self.config:
            repository = f"file://{self.config['GLSA_DIR']}/"
        else:
            repository = f"file://{self.config['PORTDIR']}/metadata/glsa/"
        if self.type == "file":
            myurl = f"file://{self.nr}"
        else:
            myurl = f"{repository}glsa-{self.nr}.xml"

        f = urllib_request_urlopen(myurl)
        try:
            self.parse(f)
        finally:
            f.close()

    def parse(self, myfile):
        """
        This method parses the XML file and sets up the internal data
        structures by calling the different helper functions in this
        module.

        @type	myfile: String
        @param	myfile: Filename to grab the XML data from
        @rtype:		None
        @return:	None
        """
        self.DOM = xml.dom.minidom.parse(myfile)
        if not self.DOM.doctype:
            raise GlsaTypeException(None)
        elif self.DOM.doctype.systemId == "http://www.gentoo.org/dtd/glsa.dtd":
            self.dtdversion = 0
        elif self.DOM.doctype.systemId == "http://www.gentoo.org/dtd/glsa-2.dtd":
            self.dtdversion = 2
        else:
            raise GlsaTypeException(self.DOM.doctype.systemId)
        myroot = self.DOM.getElementsByTagName("glsa")[0]
        if self.type == "id" and myroot.getAttribute("id") != self.nr:
            raise GlsaFormatException(
                _(
                    f"filename and internal id don't match: {myroot.getAttribute('id')} != {self.nr}"
                )
            )

        # the simple (single, required, top-level, #PCDATA) tags first
        self.title = getText(myroot.getElementsByTagName("title")[0], format="strip")
        self.synopsis = getText(
            myroot.getElementsByTagName("synopsis")[0], format="strip"
        )
        self.announced = format_date(
            getText(myroot.getElementsByTagName("announced")[0], format="strip")
        )

        # Support only format defined in GLSA DTD
        # <revised count="2">2007-12-30</revised>
        revisedEl = myroot.getElementsByTagName("revised")[0]
        self.revised = getText(revisedEl, format="strip")
        count = revisedEl.getAttribute("count")
        if not count:
            raise GlsaFormatException(
                f"Count attribute is missing or blank in GLSA: {myroot.getAttribute('id')}"
            )

        try:
            self.count = int(count)
        except ValueError:
            raise GlsaFormatException(
                f"Revision attribute in GLSA: {myroot.getAttribute('id')} is not an integer"
            )

        self.revised = format_date(self.revised)

        # now the optional and 0-n toplevel, #PCDATA tags and references
        try:
            self.access = getText(
                myroot.getElementsByTagName("access")[0], format="strip"
            )
        except IndexError:
            self.access = ""
        self.bugs = getMultiTagsText(myroot, "bug", format="strip")
        self.references = getMultiTagsText(
            myroot.getElementsByTagName("references")[0], "uri", format="keep"
        )

        # and now the formatted text elements
        self.description = getText(
            myroot.getElementsByTagName("description")[0], format="xml"
        )
        self.workaround = getText(
            myroot.getElementsByTagName("workaround")[0], format="xml"
        )
        self.resolution = getText(
            myroot.getElementsByTagName("resolution")[0], format="xml"
        )
        self.impact_text = getText(
            myroot.getElementsByTagName("impact")[0], format="xml"
        )
        self.impact_type = myroot.getElementsByTagName("impact")[0].getAttribute("type")
        try:
            self.background = getText(
                myroot.getElementsByTagName("background")[0], format="xml"
            )
        except IndexError:
            self.background = ""

        # finally the interesting tags (product, affected, package)
        self.glsatype = myroot.getElementsByTagName("product")[0].getAttribute("type")
        self.product = getText(
            myroot.getElementsByTagName("product")[0], format="strip"
        )
        self.affected = myroot.getElementsByTagName("affected")[0]
        self.packages = {}
        for p in self.affected.getElementsByTagName("package"):
            name = p.getAttribute("name")
            try:
                name = portage.dep.Atom(name)
            except portage.exception.InvalidAtom:
                raise GlsaFormatException(_(f"invalid package name: {name}"))
            if name != name.cp:
                raise GlsaFormatException(_(f"invalid package name: {name}"))
            name = name.cp
            if name not in self.packages:
                self.packages[name] = []
            tmp = {}
            tmp["arch"] = p.getAttribute("arch")
            tmp["auto"] = p.getAttribute("auto") == "yes"
            tmp["vul_vers"] = [
                makeVersion(v) for v in p.getElementsByTagName("vulnerable")
            ]
            tmp["unaff_vers"] = [
                makeVersion(v) for v in p.getElementsByTagName("unaffected")
            ]
            tmp["vul_atoms"] = [
                makeAtom(name, v) for v in p.getElementsByTagName("vulnerable")
            ]
            tmp["unaff_atoms"] = [
                makeAtom(name, v) for v in p.getElementsByTagName("unaffected")
            ]
            self.packages[name].append(tmp)
        # TODO: services aren't really used yet
        self.services = self.affected.getElementsByTagName("service")

    def dump(self, outstream=sys.stdout, encoding="utf-8"):
        """
        Dumps a plaintext representation of this GLSA to I{outfile} or
        B{stdout} if it is ommitted. You can specify an alternate
        I{encoding} if needed (default is utf-8).

        @type	outstream: File
        @param	outfile: Stream that should be used for writing
                                         (defaults to sys.stdout)
        """
        outstream = getattr(outstream, "buffer", outstream)
        outstream = codecs.getwriter(encoding)(outstream)
        width = 76
        buffer = "\n".join(
            (
                f"GLSA {self.nr}: ",
                f"{self.title}".center(width),
                "=" * width,
                wrap(self.synopsis, width, caption=_("Synopsis:         ")),
                _(f"Announced on:      {self.announced}"),
                _(f"Last revised on:   {self.revised} : %{self.count}\n"),
            )
        )
        outstream.write(buffer)
        if self.glsatype == "ebuild":
            for k in self.packages:
                pkg = self.packages[k]
                for path in pkg:
                    vul_vers = ", ".join(path["vul_vers"])
                    unaff_vers = ", ".join(path["unaff_vers"])
                    outstream.write(_(f"Affected package:  {k}\n"))
                    outstream.write(_("Affected archs:    "))
                    if path["arch"] == "*":
                        outstream.write(_("All\n"))
                    else:
                        outstream.write(f"{path['arch']}\n")
                    outstream.write(_(f"Vulnerable:        {vul_vers}\n"))
                    outstream.write(_(f"Unaffected:        {unaff_vers}\n\n"))
        elif self.glsatype == "infrastructure":
            pass
        if len(self.bugs) > 0:
            outstream.write(_(f"\nRelated bugs:      {', '.join(self.bugs)}\n"))
        if self.background:
            bg = wrap(self.background, width, caption=_("Background:       "))
            outstream.write(f"\n{bg}")
        myreferences = " ".join(
            r.replace(" ", SPACE_ESCAPE) + NEWLINE_ESCAPE for r in self.references
        )
        buffer = "\n".join(
            (
                wrap(self.description, width, caption=_("Description:      ")),
                wrap(self.impact_text, width, caption=_("Impact:           ")),
                wrap(self.workaround, width, caption=_("Workaround:       ")),
                wrap(self.resolution, width, caption=_("Resolution:       ")),
                wrap(myreferences, width, caption=_("References:       ")),
            )
        )
        outstream.write(f"\n{buffer}\n")

    def isVulnerable(self):
        """
        Tests if the system is affected by this GLSA by checking if any
        vulnerable package versions are installed. Also checks for affected
        architectures.

        @rtype:		Boolean
        @return:	True if the system is affected, False if not
        """
        rValue = False
        for k in self.packages:
            pkg = self.packages[k]
            for path in pkg:
                if not ARCH_REGEX.match(path["arch"]):
                    raise GlsaFormatException(
                        f"Unrecognized arch list in {self.nr} (wrong delimiter?): {path['arch']}"
                    )

                arches = path["arch"].split()
                if path["arch"] == "*" or self.config["ARCH"] in arches:
                    for v in path["vul_atoms"]:
                        rValue = rValue or (
                            len(match(v, self.vardbapi)) > 0
                            and None
                            != getMinUpgrade(
                                path["vul_atoms"],
                                path["unaff_atoms"],
                                self.portdbapi,
                                self.vardbapi,
                            )
                        )
        return rValue

    def isInjected(self):
        """
        Looks if the GLSA ID is in the GLSA checkfile to check if this
        GLSA should be marked as applied.

        @rtype:		Boolean
        @returns:	True if the GLSA is in the inject file, False if not
        """
        if not os.access(
            os.path.join(self.config["EROOT"], PRIVATE_PATH, "glsa_injected"), os.R_OK
        ):
            return False
        return self.nr in get_applied_glsas(self.config)

    def inject(self):
        """
        Puts the ID of this GLSA into the GLSA checkfile, so it won't
        show up on future checks. Should be called after a GLSA is
        applied or on explicit user request.

        @rtype:		None
        @return:	None
        """
        if not self.isInjected():
            checkfile = open(
                _unicode_encode(
                    os.path.join(self.config["EROOT"], PRIVATE_PATH, "glsa_injected"),
                    encoding=_encodings["fs"],
                    errors="strict",
                ),
                mode="a+",
                encoding=_encodings["content"],
                errors="strict",
            )
            checkfile.write(_unicode_decode(self.nr + "\n"))
            checkfile.close()

    def getMergeList(self, least_change=True):
        """
        Returns the list of package-versions that have to be merged to
        apply this GLSA properly. The versions are as low as possible
        while avoiding downgrades (see L{getMinUpgrade}).

        @type	least_change: Boolean
        @param	least_change: True if the smallest possible upgrade should be selected,
                                False for an emerge-like algorithm
        @rtype:		List of Strings
        @return:	list of package-versions that have to be merged
        """
        return list(
            {
                update
                for (vuln, update) in self.getAffectionTable(least_change)
                if update
            }
        )

    def getAffectionTable(self, least_change=True):
        """
        Will initialize the self.systemAffection list of
        atoms installed on the system that are affected
        by this GLSA, and the atoms that are minimal upgrades.
        """
        systemAffection = []
        for pkg in self.packages.keys():
            for path in self.packages[pkg]:
                update = getMinUpgrade(
                    path["vul_atoms"],
                    path["unaff_atoms"],
                    self.portdbapi,
                    self.vardbapi,
                    minimize=least_change,
                )
                if update:
                    systemAffection.extend(update)
        return systemAffection
