Helper.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Extensionmanager\Utility\Repository;

use TYPO3\CMS\Extensionmanager\Exception\ExtensionManagerException;

class Helper implements \TYPO3\CMS\Core\SingletonInterface {

    const PROBLEM_EXTENSION_FILE_NOT_EXISTING = 1;
    const PROBLEM_EXTENSION_HASH_CHANGED = 2;
    const PROBLEM_NO_VERSIONS_IN_DATABASE = 4;
    protected $repository = NULL;

    protected $repositoryRepository;

    protected $extensionRepository;

    public function __construct() {
        $this->objectManager = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Extbase\\Object\\ObjectManager');
        $repositoryRepository = $this->objectManager->get('TYPO3\\CMS\\Extensionmanager\\Domain\\Repository\\RepositoryRepository');
        $this->extensionRepository = $this->objectManager->get('TYPO3\\CMS\\Extensionmanager\\Domain\\Repository\\ExtensionRepository');
        $repository = $repositoryRepository->findByUid(1);
        if (is_object($repository)) {
            $this->setRepository($repository);
        }
    }

    public function setRepository(\TYPO3\CMS\Extensionmanager\Domain\Model\Repository $repository) {
        $this->repository = $repository;
    }

    public function fetchExtListFile() {
        $this->fetchFile($this->getRemoteExtListFile(), $this->getLocalExtListFile());
    }

    public function fetchMirrorListFile() {
        $this->fetchFile($this->getRemoteMirrorListFile(), $this->getLocalMirrorListFile());
    }

    protected function fetchFile($remoteResource, $localResource) {
        if (is_string($remoteResource) && is_string($localResource) && !empty($remoteResource) && !empty($localResource)) {
            $fileContent = \TYPO3\CMS\Core\Utility\GeneralUtility::getUrl($remoteResource, 0, array(TYPO3_user_agent));
            if ($fileContent !== FALSE) {
                if (\TYPO3\CMS\Core\Utility\GeneralUtility::writeFile($localResource, $fileContent) === FALSE) {
                    throw new ExtensionManagerException(sprintf('Could not write to file %s.', htmlspecialchars($localResource)), 1342635378);
                }
            } else {
                throw new ExtensionManagerException(sprintf('Could not access remote resource %s.', htmlspecialchars($remoteResource)), 1342635425);
            }
        }
    }

    public function getLocalExtListFile() {
        $absFilePath = PATH_site . 'typo3temp/' . (int)$this->repository->getUid() . '.extensions.xml.gz';
        return $absFilePath;
    }

    public function getRemoteExtListFile() {
        $mirror = $this->getMirrors(TRUE)->getMirror();
        $filePath = 'https://' . $mirror['host'] . $mirror['path'] . 'extensions.xml.gz';
        return $filePath;
    }

    public function getRemoteExtHashFile() {
        $mirror = $this->getMirrors(TRUE)->getMirror();
        $filePath = 'https://' . $mirror['host'] . $mirror['path'] . 'extensions.md5';
        return $filePath;
    }

    public function getLocalMirrorListFile() {
        $absFilePath = PATH_site . 'typo3temp/' . (int)$this->repository->getUid() . '.mirrors.xml.gz';
        return $absFilePath;
    }

    public function getRemoteMirrorListFile() {
        $filePath = $this->repository->getMirrorListUrl();
        return $filePath;
    }

    public function getMirrors($forcedUpdateFromRemote = TRUE) {
        $assignedMirror = $this->repository->getMirrors();
        if ($forcedUpdateFromRemote || is_null($assignedMirror) || !is_object($assignedMirror)) {
            if ($forcedUpdateFromRemote || !is_file($this->getLocalMirrorListFile())) {
                $this->fetchMirrorListFile();
            }
            $objMirrorListImporter = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Extensionmanager\\Utility\\Importer\\MirrorListUtility');
            $this->repository->addMirrors($objMirrorListImporter->getMirrors($this->getLocalMirrorListFile()));
        }
        return $this->repository->getMirrors();
    }

    public function isExtListUpdateNecessary() {
        $updateNecessity = 0;
        if ($this->extensionRepository->countByRepository($this->repository->getUid()) <= 0) {
            $updateNecessity |= self::PROBLEM_NO_VERSIONS_IN_DATABASE;
        }
        if (!is_file($this->getLocalExtListFile())) {
            $updateNecessity |= self::PROBLEM_EXTENSION_FILE_NOT_EXISTING;
        } else {
            $remotemd5 = \TYPO3\CMS\Core\Utility\GeneralUtility::getUrl($this->getRemoteExtHashFile(), 0, array(TYPO3_user_agent));
            if ($remotemd5 !== FALSE) {
                $localmd5 = md5_file($this->getLocalExtListFile());
                if ($remotemd5 !== $localmd5) {
                    $updateNecessity |= self::PROBLEM_EXTENSION_HASH_CHANGED;
                }
            } else {
                throw new ExtensionManagerException('Could not retrieve extension hash file from remote server.', 1342635016);
            }
        }
        return $updateNecessity;
    }

    public function updateExtList() {
        $updated = FALSE;
        $updateNecessity = $this->isExtListUpdateNecessary();
        if ($updateNecessity !== 0) {
            // retrieval of file necessary
            $tmpBitmask = self::PROBLEM_EXTENSION_FILE_NOT_EXISTING | self::PROBLEM_EXTENSION_HASH_CHANGED;
            if (($tmpBitmask & $updateNecessity) > 0) {
                $this->fetchExtListFile();
                $updateNecessity &= ~$tmpBitmask;
            }
            // database table cleanup
            if ($updateNecessity & self::PROBLEM_NO_VERSIONS_IN_DATABASE) {
                $updateNecessity &= ~self::PROBLEM_NO_VERSIONS_IN_DATABASE;
            } else {
                // Use straight query as extbase "remove" is too slow here
                // This truncates the whole table. It would be more correct to remove only rows of a specific
                // repository, but multiple repository handling is not implemented, and truncate is quicker.
                $this->getDatabaseConnection()->exec_TRUNCATEquery('tx_extensionmanager_domain_model_extension');
            }
            // no further problems - start of import process
            if ($updateNecessity === 0) {
                $uid = $this->repository->getUid();
                /* @var $objExtListImporter \TYPO3\CMS\Extensionmanager\Utility\Importer\ExtensionListUtility */
                $objExtListImporter = $this->objectManager->get('TYPO3\\CMS\\Extensionmanager\\Utility\\Importer\\ExtensionListUtility');
                $objExtListImporter->import($this->getLocalExtListFile(), $uid);
                $updated = TRUE;
            }
        }
        return $updated;
    }

    protected function getDatabaseConnection() {
        return $GLOBALS['TYPO3_DB'];
    }

}