ExtensionXmlParser.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Extensionmanager\Parser;
 
use ‪TYPO3\CMS\Extensionmanager\Exception\ExtensionManagerException;
 
class ‪ExtensionXmlParser implements \SplSubject
{
    protected array ‪$observers = [];
 
    protected string ‪$elementData = '';
 
    protected string ‪$authorcompany = '';
    protected string ‪$authoremail = '';
    protected string ‪$authorname = '';
    protected string ‪$category = '';
    protected string ‪$dependencies = '';
    protected string ‪$description = '';
    protected int ‪$extensionDownloadCounter = 0;
    protected string ‪$extensionKey = '';
    protected int ‪$lastuploaddate = 0;
    protected string ‪$ownerusername = '';
    protected int ‪$reviewstate = 0;
    protected string ‪$state = '';
    protected string ‪$t3xfilemd5 = '';
    protected string ‪$title = '';
    protected string ‪$uploadcomment = '';
    protected string ‪$version = '';
    protected int ‪$versionDownloadCounter = 0;
    protected string ‪$documentationLink = '';
    protected string ‪$distributionImage = '';
    protected string ‪$distributionWelcomeImage = '';
 
    public function ‪__construct()
    {
        if (!extension_loaded('xml')) {
            throw new \RuntimeException('PHP extension "xml" not loaded', 1622148496);
        }
    }
 
    public function ‪parseXml($file): void
    {
        ‪$parser = xml_parser_create();
        xml_set_object(‪$parser, $this);
 
        // keep original character case of XML document
        xml_parser_set_option(‪$parser, XML_OPTION_CASE_FOLDING, 0);
        xml_parser_set_option(‪$parser, XML_OPTION_SKIP_WHITE, 0);
        xml_parser_set_option(‪$parser, XML_OPTION_TARGET_ENCODING, 'utf-8');
        xml_set_element_handler(‪$parser, [$this, 'startElement'], [$this, 'endElement']);
        xml_set_character_data_handler(‪$parser, [$this, 'characterData']);
        if (!($fp = fopen($file, 'r'))) {
            throw $this->‪createUnableToOpenFileResourceException($file);
        }
        while ($data = fread($fp, 4096)) {
            if (!xml_parse(‪$parser, $data, feof($fp))) {
                throw $this->‪createXmlErrorException(‪$parser, $file);
            }
        }
        xml_parser_free(‪$parser);
    }
 
    private function ‪createUnableToOpenFileResourceException(string $file): ‪ExtensionManagerException
    {
        return new ‪ExtensionManagerException(sprintf('Unable to open file resource %s.', $file), 1342640689);
    }
 
    private function ‪createXmlErrorException(‪$parser, string $file): ‪ExtensionManagerException
    {
        return new ‪ExtensionManagerException(
            sprintf(
                'XML error %s in line %u of file resource %s.',
                xml_error_string(xml_get_error_code(‪$parser)),
                xml_get_current_line_number(‪$parser),
                $file
            ),
            1342640703
        );
    }
 
    protected function ‪startElement(‪$parser, $elementName, $attrs)
    {
        switch ($elementName) {
            case 'extension':
                $this->extensionKey = $attrs['extensionkey'];
                break;
            case 'version':
                $this->version = $attrs['version'];
                break;
            default:
                $this->elementData = '';
        }
    }
 
    protected function ‪endElement(‪$parser, $elementName)
    {
        switch ($elementName) {
            case 'extension':
                $this->‪resetProperties(true);
                break;
            case 'version':
                $this->‪notify();
                $this->‪resetProperties();
                break;
            case 'downloadcounter':
                // downloadcounter can be a child node of extension or version
                if ($this->version === '') {
                    $this->extensionDownloadCounter = (int)$this->elementData;
                } else {
                    $this->versionDownloadCounter = (int)$this->elementData;
                }
                break;
            case 'title':
                $this->title = ‪$this->elementData;
                break;
            case 'description':
                $this->‪description = ‪$this->elementData;
                break;
            case 'state':
                $this->state = ‪$this->elementData;
                break;
            case 'reviewstate':
                $this->reviewstate = (int)$this->elementData;
                break;
            case 'category':
                $this->category = ‪$this->elementData;
                break;
            case 'lastuploaddate':
                $this->lastuploaddate = (int)$this->elementData;
                break;
            case 'uploadcomment':
                $this->uploadcomment = ‪$this->elementData;
                break;
            case 'dependencies':
                $newDependencies = [];
                $dependenciesArray = unserialize($this->elementData, ['allowed_classes' => false]);
                if (is_array($dependenciesArray)) {
                    foreach ($dependenciesArray as ‪$version) {
                        if (!empty(‪$version['kind']) && !empty(‪$version['extensionKey'])) {
                            $newDependencies[‪$version['kind']][‪$version['extensionKey']] = ‪$version['versionRange'];
                        }
                    }
                }
                $this->dependencies = serialize($newDependencies);
                break;
            case 'authorname':
                $this->authorname = ‪$this->elementData;
                break;
            case 'authoremail':
                $this->authoremail = ‪$this->elementData;
                break;
            case 'authorcompany':
                $this->authorcompany = ‪$this->elementData;
                break;
            case 'ownerusername':
                $this->ownerusername = ‪$this->elementData;
                break;
            case 't3xfilemd5':
                $this->t3xfilemd5 = ‪$this->elementData;
                break;
            case 'documentation_link':
                $this->documentationLink = ‪$this->elementData;
                break;
            case 'distributionImage':
                if (preg_match('/^https:\/\/extensions\.typo3\.org[a-zA-Z0-9._\/]+Distribution\.png$/', $this->elementData)) {
                    $this->distributionImage = ‪$this->elementData;
                }
                break;
            case 'distributionImageWelcome':
                if (preg_match('/^https:\/\/extensions\.typo3\.org[a-zA-Z0-9._\/]+DistributionWelcome\.png$/', $this->elementData)) {
                    $this->distributionWelcomeImage = ‪$this->elementData;
                }
                break;
        }
    }
 
    protected function ‪resetProperties($resetAll = false): void
    {
        // Resetting at least class property "version" is mandatory as we need to do some magic in
        // regards to an extension's and version's child node "downloadcounter"
        $this->version = $this->authorcompany = $this->authorname = $this->authoremail = $this->category = $this->dependencies = $this->state = '';
        $this->‪description = $this->ownerusername = $this->t3xfilemd5 = $this->title = $this->uploadcomment = $this->documentationLink = $this->distributionImage = $this->distributionWelcomeImage = '';
        $this->lastuploaddate = $this->reviewstate = $this->versionDownloadCounter = 0;
        if ($resetAll) {
            $this->extensionKey = '';
            $this->extensionDownloadCounter = 0;
        }
    }
 
    protected function ‪characterData(‪$parser, string $data)
    {
        $this->elementData .= $data;
    }
 
    public function ‪attach(\SplObserver $observer): void
    {
        $this->observers[] = $observer;
    }
 
    public function ‪detach(\SplObserver $observer): void
    {
        $key = array_search($observer, $this->observers, true);
        if ($key !== false) {
            unset($this->observers[$key]);
        }
    }
 
    public function ‪notify(): void
    {
        foreach ($this->observers as $observer) {
            $observer->update($this);
        }
    }
 
    public function ‪getAlldownloadcounter(): int
    {
        return ‪$this->extensionDownloadCounter;
    }
 
    public function ‪getAuthorcompany(): string
    {
        return ‪$this->authorcompany;
    }
 
    public function ‪getAuthoremail(): string
    {
        return ‪$this->authoremail;
    }
 
    public function ‪getAuthorname(): string
    {
        return ‪$this->authorname;
    }
 
    public function ‪getCategory(): string
    {
        return ‪$this->category;
    }
 
    public function ‪getDependencies(): string
    {
        return ‪$this->dependencies;
    }
 
    public function ‪getDescription(): string
    {
        return ‪$this->description;
    }
 
    public function ‪getDownloadcounter(): int
    {
        return ‪$this->versionDownloadCounter;
    }
 
    public function ‪getExtkey(): string
    {
        return ‪$this->extensionKey;
    }
 
    public function ‪getLastuploaddate(): int
    {
        return ‪$this->lastuploaddate;
    }
 
    public function ‪getOwnerusername(): string
    {
        return ‪$this->ownerusername;
    }
 
    public function ‪getReviewstate(): int
    {
        return ‪$this->reviewstate;
    }
 
    public function ‪getState(): string
    {
        return ‪$this->state;
    }
 
    public function ‪getT3xfilemd5(): string
    {
        return ‪$this->t3xfilemd5;
    }
 
    public function ‪getTitle(): string
    {
        return ‪$this->title;
    }
 
    public function ‪getUploadcomment(): string
    {
        return ‪$this->uploadcomment;
    }
 
    public function ‪getVersion(): string
    {
        return ‪$this->version;
    }
 
    public function ‪isValidVersionNumber(): bool
    {
        // Validate the version number, see `isValidVersionNumber` in TER API
        return (bool)preg_match('/^(0|[1-9]\d{0,2})\.(0|[1-9]\d{0,2})\.(0|[1-9]\d{0,2})$/', $this->version);
    }
 
    public function ‪getDocumentationLink(): string
    {
        return ‪$this->documentationLink;
    }
 
    public function ‪getDistributionImage(): string
    {
        return ‪$this->distributionImage;
    }
 
    public function ‪getDistributionWelcomeImage(): string
    {
        return ‪$this->distributionWelcomeImage;
    }
}