src/eric7/PluginManager/PluginRepositoryReader.py

# -*- coding: utf-8 -*-

# Copyright (c) 2010 - 2024 Detlev Offenbach <detlev@die-offenbachs.de>
#

"""
Module to read the plug-in repository contents file.
"""

from eric7 import Preferences
from eric7.XML.XMLStreamReaderBase import XMLStreamReaderBase

# version number of the plugin repository file
pluginRepositoryFileFormatVersion = "4.2"


class PluginRepositoryReader(XMLStreamReaderBase):
    """
    Class to read the plug-in repository contents file.
    """

    supportedVersions = ["4.1", "4.2"]

    def __init__(self, device, entryCallback):
        """
        Constructor

        @param device reference to the I/O device to read from
        @type QIODevice
        @param entryCallback reference to a function to be called once the
            data for a plug-in has been read
        @type function
        """
        XMLStreamReaderBase.__init__(self, device)

        self.__entryCallback = entryCallback

        self.version = ""

    def readXML(self):
        """
        Public method to read and parse the XML document.
        """
        while not self.atEnd():
            self.readNext()
            if self.isStartElement():
                if self.name() == "Plugins":
                    self.version = self.attribute(
                        "version", pluginRepositoryFileFormatVersion
                    )
                    if self.version not in self.supportedVersions:
                        self.raiseUnsupportedFormatVersion(self.version)
                elif self.name() == "RepositoryUrl":
                    url = self.readElementText()
                    Preferences.setUI("PluginRepositoryUrl7", url)
                elif self.name() == "Plugin":
                    self.__readPlugin()
                else:
                    self._skipUnknownElement()

        self.showErrorMessage()

    def __readPlugin(self):
        """
        Private method to read the plug-in info.
        """
        pluginInfo = {
            "name": "",
            "short": "",
            "description": "",
            "url": "",
            "author": "",
            "version": "",
            "filename": "",
            "status": self.attribute("status", "unknown"),
            "category": self.attribute("category", "not categorized"),
        }

        while not self.atEnd():
            self.readNext()
            if self.isEndElement() and self.name() == "Plugin":
                self.__entryCallback(
                    pluginInfo["name"],
                    pluginInfo["short"],
                    pluginInfo["description"],
                    pluginInfo["url"],
                    pluginInfo["author"],
                    pluginInfo["version"],
                    pluginInfo["filename"],
                    pluginInfo["status"],
                    pluginInfo["category"],
                )
                break

            if self.isStartElement():
                if self.name() == "Name":
                    pluginInfo["name"] = self.readElementText()
                elif self.name() == "Short":
                    pluginInfo["short"] = self.readElementText()
                elif self.name() == "Description":
                    txt = self.readElementText()
                    pluginInfo["description"] = [
                        line.strip() for line in txt.splitlines()
                    ]
                elif self.name() == "Url":
                    pluginInfo["url"] = self.readElementText()
                elif self.name() == "Author":
                    pluginInfo["author"] = self.readElementText()
                elif self.name() == "Version":
                    pluginInfo["version"] = self.readElementText()
                elif self.name() == "Filename":
                    pluginInfo["filename"] = self.readElementText()
                else:
                    self.raiseUnexpectedStartTag(self.name())