AbstractXmlParser.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Core\Localization\Parser;

abstract class AbstractXmlParser implements \TYPO3\CMS\Core\Localization\Parser\LocalizationParserInterface {

    protected $sourcePath;

    protected $languageKey;

    protected $charset;

    public function getParsedData($sourcePath, $languageKey, $charset = '') {
        $this->sourcePath = $sourcePath;
        $this->languageKey = $languageKey;
        $this->charset = $this->getCharset($languageKey, $charset);
        if ($this->languageKey !== 'default') {
            $this->sourcePath = \TYPO3\CMS\Core\Utility\GeneralUtility::getFileAbsFileName(\TYPO3\CMS\Core\Utility\GeneralUtility::llXmlAutoFileName($this->sourcePath, $this->languageKey));
            if (!@is_file($this->sourcePath)) {
                // Global localization is not available, try split localization file
                $this->sourcePath = \TYPO3\CMS\Core\Utility\GeneralUtility::getFileAbsFileName(\TYPO3\CMS\Core\Utility\GeneralUtility::llXmlAutoFileName($sourcePath, $languageKey, TRUE));
            }
            if (!@is_file($this->sourcePath)) {
                throw new \TYPO3\CMS\Core\Localization\Exception\FileNotFoundException('Localization file does not exist', 1306332397);
            }
        }
        $LOCAL_LANG = array();
        $LOCAL_LANG[$languageKey] = $this->parseXmlFile();
        return $LOCAL_LANG;
    }

    protected function getCharset($languageKey, $charset = '') {
        if (is_object($GLOBALS['LANG'])) {
            $csConvObj = $GLOBALS['LANG']->csConvObj;
        } elseif (is_object($GLOBALS['TSFE'])) {
            $csConvObj = $GLOBALS['TSFE']->csConvObj;
        } else {
            $csConvObj = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Charset\\CharsetConverter');
        }
        if ($charset !== '') {
            $targetCharset = $csConvObj->parse_charset($charset);
        } else {
            $targetCharset = 'utf-8';
        }
        return $targetCharset;
    }

    protected function parseXmlFile() {
        $xmlContent = file_get_contents($this->sourcePath);
        // Disables the functionality to allow external entities to be loaded when parsing the XML, must be kept
        $previousValueOfEntityLoader = libxml_disable_entity_loader(TRUE);
        $rootXmlNode = simplexml_load_string($xmlContent, 'SimpleXmlElement', \LIBXML_NOWARNING);
        libxml_disable_entity_loader($previousValueOfEntityLoader);
        if (!isset($rootXmlNode) || $rootXmlNode === FALSE) {
            throw new \TYPO3\CMS\Core\Localization\Exception\InvalidXmlFileException('The path provided does not point to existing and accessible well-formed XML file.', 1278155988);
        }
        return $this->doParsingFromRoot($rootXmlNode);
    }

    abstract protected function doParsingFromRoot(\SimpleXMLElement $root);

}