TemplateView.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Fluid\View;

/*                                                                        *
 * This script is backported from the TYPO3 Flow package "TYPO3.Fluid".   *
 *                                                                        *
 * It is free software; you can redistribute it and/or modify it under    *
 * the terms of the GNU Lesser General Public License, either version 3   *
 * of the License, or (at your option) any later version.                 *
 *                                                                        *
 * The TYPO3 project - inspiring people to share!                         *
 *                                                                        */

use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext;

class TemplateView extends AbstractTemplateView {

    protected $templateRootPathPattern = '@packageResourcesPath/Private/Templates';

    protected $partialRootPathPattern = '@packageResourcesPath/Private/Partials';

    protected $layoutRootPathPattern = '@packageResourcesPath/Private/Layouts';

    protected $templateRootPaths = NULL;

    protected $partialRootPaths = NULL;

    protected $layoutRootPaths = NULL;

    protected $templatePathAndFilenamePattern = '@templateRoot/@subpackage/@controller/@action.@format';

    private $partialPathAndFilenamePattern = '@partialRoot/@subpackage/@partial.@format';

    protected $layoutPathAndFilenamePattern = '@layoutRoot/@layout.@format';

    protected $templatePathAndFilename = NULL;

    protected $layoutPathAndFilename = NULL;

    public function __construct() {
        $this->templateParser = \TYPO3\CMS\Fluid\Compatibility\TemplateParserBuilder::build();
        $this->objectManager = GeneralUtility::makeInstance('TYPO3\\CMS\\Extbase\\Object\\ObjectManager');
        $this->setRenderingContext($this->objectManager->get('TYPO3\\CMS\\Fluid\\Core\\Rendering\\RenderingContextInterface'));
    }

    public function initializeView() {
    }
    // Here, the backporter can insert a constructor method, which is needed for the TYPO3 CMS extension

    public function setTemplatePathAndFilename($templatePathAndFilename) {
        $this->templatePathAndFilename = $templatePathAndFilename;
    }

    public function setLayoutPathAndFilename($layoutPathAndFilename) {
        $this->layoutPathAndFilename = $layoutPathAndFilename;
    }

    public function setTemplateRootPath($templateRootPath) {
        $this->setTemplateRootPaths(array($templateRootPath));
    }

    protected function getTemplateRootPath() {
        GeneralUtility::logDeprecatedFunction();
        $templateRootPaths = $this->getTemplateRootPaths();
        return array_shift($templateRootPaths);
    }

    public function getTemplateRootPaths() {
        if ($this->templateRootPaths !== NULL) {
            return $this->templateRootPaths;
        }
        $actionRequest = $this->controllerContext->getRequest();
        return array(str_replace('@packageResourcesPath', \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extPath($actionRequest->getControllerExtensionKey()) . 'Resources/', $this->templateRootPathPattern));
    }

    public function setTemplateRootPaths(array $templateRootPaths) {
        $this->templateRootPaths = $templateRootPaths;
    }

    public function setPartialRootPath($partialRootPath) {
        $this->setPartialRootPaths(array($partialRootPath));
    }

    protected function getPartialRootPath() {
        GeneralUtility::logDeprecatedFunction();
        $partialRootPaths = $this->getPartialRootPaths();
        return array_shift($partialRootPaths);
    }

    public function setPartialRootPaths(array $partialRootPaths) {
        $this->partialRootPaths = $partialRootPaths;
    }

    protected function getPartialRootPaths() {
        if ($this->partialRootPaths !== NULL) {
            return $this->partialRootPaths;
        }
        $actionRequest = $this->controllerContext->getRequest();
        return array(str_replace('@packageResourcesPath', \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extPath($actionRequest->getControllerExtensionKey()) . 'Resources/', $this->partialRootPathPattern));
    }

    public function setLayoutRootPath($layoutRootPath) {
        $this->setLayoutRootPaths(array($layoutRootPath));
    }

    public function setLayoutRootPaths(array $layoutRootPaths) {
        $this->layoutRootPaths = $layoutRootPaths;
    }

    protected function getLayoutRootPath() {
        GeneralUtility::logDeprecatedFunction();
        $layoutRootPaths = $this->getLayoutRootPaths();
        return array_shift($layoutRootPaths);
    }

    protected function getLayoutRootPaths() {
        if ($this->layoutRootPaths !== NULL) {
            return $this->layoutRootPaths;
        }
        $actionRequest = $this->controllerContext->getRequest();
        return array(str_replace('@packageResourcesPath', \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extPath($actionRequest->getControllerExtensionKey()) . 'Resources/', $this->layoutRootPathPattern));
    }

    protected function getTemplateIdentifier($actionName = NULL) {
        $templatePathAndFilename = $this->getTemplatePathAndFilename($actionName);
        if ($actionName === NULL) {
            $actionRequest = $this->controllerContext->getRequest();
            $actionName = $actionRequest->getControllerActionName();
        }
        $prefix = 'action_' . $actionName;
        return $this->createIdentifierForFile($templatePathAndFilename, $prefix);
    }

    protected function getTemplateSource($actionName = NULL) {
        $templatePathAndFilename = $this->getTemplatePathAndFilename($actionName);
        $templateSource = file_get_contents($templatePathAndFilename);
        if ($templateSource === FALSE) {
            throw new Exception\InvalidTemplateResourceException('"' . $templatePathAndFilename . '" is not a valid template resource URI.', 1257246929);
        }
        return $templateSource;
    }

    protected function getTemplatePathAndFilename($actionName = NULL) {
        if ($this->templatePathAndFilename !== NULL) {
            return $this->templatePathAndFilename;
        }
        if ($actionName === NULL) {
            $actionRequest = $this->controllerContext->getRequest();
            $actionName = $actionRequest->getControllerActionName();
        }
        $actionName = ucfirst($actionName);

        $paths = $this->expandGenericPathPattern($this->templatePathAndFilenamePattern, FALSE, FALSE);
        foreach ($paths as &$templatePathAndFilename) {
            $templatePathAndFilename = $this->resolveFileNamePath(str_replace('@action', $actionName, $templatePathAndFilename));
            if (is_file($templatePathAndFilename)) {
                return $templatePathAndFilename;
            }
        }
        throw new Exception\InvalidTemplateResourceException('Template could not be loaded. I tried "' . implode('", "', $paths) . '"', 1225709595);
    }

    protected function getLayoutIdentifier($layoutName = 'Default') {
        $layoutPathAndFilename = $this->getLayoutPathAndFilename($layoutName);
        $prefix = 'layout_' . $layoutName;
        return $this->createIdentifierForFile($layoutPathAndFilename, $prefix);
    }

    protected function getLayoutSource($layoutName = 'Default') {
        $layoutPathAndFilename = $this->getLayoutPathAndFilename($layoutName);
        $layoutSource = file_get_contents($layoutPathAndFilename);
        if ($layoutSource === FALSE) {
            throw new Exception\InvalidTemplateResourceException('"' . $layoutPathAndFilename . '" is not a valid template resource URI.', 1257246930);
        }
        return $layoutSource;
    }

    protected function getLayoutPathAndFilename($layoutName = 'Default') {
        if ($this->layoutPathAndFilename !== NULL) {
            return $this->layoutPathAndFilename;
        }
        $paths = $this->expandGenericPathPattern($this->layoutPathAndFilenamePattern, TRUE, TRUE);
        $layoutName = ucfirst($layoutName);
        foreach ($paths as &$layoutPathAndFilename) {
            $layoutPathAndFilename = $this->resolveFileNamePath(str_replace('@layout', $layoutName, $layoutPathAndFilename));
            if (is_file($layoutPathAndFilename)) {
                return $layoutPathAndFilename;
            }
        }
        throw new Exception\InvalidTemplateResourceException('The template files "' . implode('", "', $paths) . '" could not be loaded.', 1225709596);
    }

    protected function getPartialIdentifier($partialName) {
        $partialPathAndFilename = $this->getPartialPathAndFilename($partialName);
        $prefix = 'partial_' . $partialName;
        return $this->createIdentifierForFile($partialPathAndFilename, $prefix);
    }

    protected function getPartialSource($partialName) {
        $partialPathAndFilename = $this->getPartialPathAndFilename($partialName);
        $partialSource = file_get_contents($partialPathAndFilename);
        if ($partialSource === FALSE) {
            throw new Exception\InvalidTemplateResourceException('"' . $partialPathAndFilename . '" is not a valid template resource URI.', 1257246931);
        }
        return $partialSource;
    }

    protected function getPartialPathAndFilename($partialName) {
        $paths = $this->expandGenericPathPattern($this->partialPathAndFilenamePattern, TRUE, TRUE);
        foreach ($paths as &$partialPathAndFilename) {
            $partialPathAndFilename = $this->resolveFileNamePath(str_replace('@partial', $partialName, $partialPathAndFilename));
            if (is_file($partialPathAndFilename)) {
                return $partialPathAndFilename;
            }
        }
        throw new Exception\InvalidTemplateResourceException('The template files "' . implode('", "', $paths) . '" could not be loaded.', 1225709597);
    }

    public function canRender(ControllerContext $controllerContext) {
        $this->setControllerContext($controllerContext);
        try {
            $this->getTemplateSource();
            return TRUE;
        } catch (Exception\InvalidTemplateResourceException $e) {
            return FALSE;
        }
    }

    protected function expandGenericPathPattern($pattern, $bubbleControllerAndSubpackage, $formatIsOptional) {
        $paths = array($pattern);
        $this->expandPatterns($paths, '@templateRoot', $this->getTemplateRootPaths());
        $this->expandPatterns($paths, '@partialRoot', $this->getPartialRootPaths());
        $this->expandPatterns($paths, '@layoutRoot', $this->getLayoutRootPaths());

        $actionRequest = $this->controllerContext->getRequest();
        $subpackageKey = $actionRequest->getControllerSubpackageKey();
        $controllerName = $actionRequest->getControllerName();
        if ($subpackageKey !== NULL) {
            if (strpos($subpackageKey, \TYPO3\CMS\Fluid\Fluid::NAMESPACE_SEPARATOR) !== FALSE) {
                $namespaceSeparator = \TYPO3\CMS\Fluid\Fluid::NAMESPACE_SEPARATOR;
            } else {
                $namespaceSeparator = \TYPO3\CMS\Fluid\Fluid::LEGACY_NAMESPACE_SEPARATOR;
            }
            $subpackageKeyParts = explode($namespaceSeparator, $subpackageKey);
        } else {
            $subpackageKeyParts = array();
        }
        if ($bubbleControllerAndSubpackage) {
            $numberOfPathsBeforeSubpackageExpansion = count($paths);
            $numberOfSubpackageParts = count($subpackageKeyParts);
            $subpackageReplacements = array();
            for ($i = 0; $i <= $numberOfSubpackageParts; $i++) {
                $subpackageReplacements[] = implode('/', ($i < 0 ? $subpackageKeyParts : array_slice($subpackageKeyParts, $i)));
            }
            $this->expandPatterns($paths, '@subpackage', $subpackageReplacements);

            for ($i = ($numberOfPathsBeforeSubpackageExpansion - 1) * ($numberOfSubpackageParts + 1); $i >= 0; $i -= ($numberOfSubpackageParts + 1)) {
                array_splice($paths, $i, 0, str_replace('@controller', $controllerName, $paths[$i]));
            }
            $this->expandPatterns($paths, '@controller', array(''));
        } else {
            $i = $controllerName === NULL ? 0 : -1;
            $this->expandPatterns($paths, '@subpackage', array(implode('/', $i < 0 ? $subpackageKeyParts :
                array_slice($subpackageKeyParts, $i))));
            $this->expandPatterns($paths, '@controller', array($controllerName));
        }

        if ($formatIsOptional) {
            $this->expandPatterns($paths, '.@format', array('.' . $actionRequest->getFormat(), ''));
            $this->expandPatterns($paths, '@format', array($actionRequest->getFormat(), ''));
        } else {
            $this->expandPatterns($paths, '.@format', array('.' . $actionRequest->getFormat()));
            $this->expandPatterns($paths, '@format', array($actionRequest->getFormat()));
        }
        return array_values(array_unique($paths));
    }

    protected function expandPatterns(array &$patterns, $search, array $replacements) {
        $patternsWithReplacements = array();
        foreach ($patterns as $pattern) {
            foreach ($replacements as $replacement) {
                $patternsWithReplacements[] = GeneralUtility::fixWindowsFilePath(str_replace($search, $replacement, $pattern));
            }
        }
        $patterns = $patternsWithReplacements;
    }

    protected function createIdentifierForFile($pathAndFilename, $prefix) {
        $actionRequest = $this->controllerContext->getRequest();
        $extensionName = $actionRequest->getControllerExtensionName();
        $subPackageKey = $actionRequest->getControllerSubpackageKey();
        if ($subPackageKey !== NULL) {
            $extensionName .= '_' . $subPackageKey;
        }
        $controllerName = $actionRequest->getControllerName();
        $templateModifiedTimestamp = filemtime($pathAndFilename);
        $templateIdentifier = sprintf('%s_%s_%s_%s', $extensionName, $controllerName, $prefix, sha1($pathAndFilename . '|' . $templateModifiedTimestamp));
        return $templateIdentifier;
    }

    protected function resolveFileNamePath($pathAndFilename) {
        return GeneralUtility::getFileAbsFileName($pathAndFilename);
    }
}