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\ExtensionManagementUtility;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext;
use TYPO3\CMS\Extbase\Object\ObjectManager;
use TYPO3\CMS\Fluid\Compatibility\TemplateParserBuilder;
use TYPO3\CMS\Fluid\Core\Rendering\RenderingContextInterface;
use TYPO3\CMS\Fluid\Fluid;

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 = TemplateParserBuilder::build();
        $this->objectManager = GeneralUtility::makeInstance(ObjectManager::class);
        $this->setRenderingContext($this->objectManager->get(RenderingContextInterface::class));
    }

    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([$templateRootPath]);
    }

    public function getTemplateRootPaths()
    {
        if ($this->templateRootPaths !== null) {
            return $this->templateRootPaths;
        }
        $actionRequest = $this->controllerContext->getRequest();
        return [str_replace('@packageResourcesPath', ExtensionManagementUtility::extPath($actionRequest->getControllerExtensionKey()) . 'Resources/', $this->templateRootPathPattern)];
    }

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

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

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

    protected function getPartialRootPaths()
    {
        if ($this->partialRootPaths !== null) {
            return $this->partialRootPaths;
        }
        $actionRequest = $this->controllerContext->getRequest();
        return [str_replace('@packageResourcesPath', ExtensionManagementUtility::extPath($actionRequest->getControllerExtensionKey()) . 'Resources/', $this->partialRootPathPattern)];
    }

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

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

    protected function getLayoutRootPaths()
    {
        if ($this->layoutRootPaths !== null) {
            return $this->layoutRootPaths;
        }
        $actionRequest = $this->controllerContext->getRequest();
        return [str_replace('@packageResourcesPath', 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->resolveFileNamePath($this->templatePathAndFilename);
        }
        if ($actionName === null) {
            $actionRequest = $this->controllerContext->getRequest();
            $actionName = $actionRequest->getControllerActionName();
        }

        $paths = $this->expandGenericPathPattern($this->templatePathAndFilenamePattern, false, false);
        $possibleFileNames = $this->buildListOfTemplateCandidates($actionName, $paths, '@action');
        foreach ($possibleFileNames as $templatePathAndFilename) {
            if ($this->testFileExistence($templatePathAndFilename)) {
                return $templatePathAndFilename;
            }
        }
        throw new Exception\InvalidTemplateResourceException('Template could not be loaded. I tried "' . implode('", "', $possibleFileNames) . '"', 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->resolveFileNamePath($this->layoutPathAndFilename);
        }
        $paths = $this->expandGenericPathPattern($this->layoutPathAndFilenamePattern, true, true);
        $possibleFileNames = $this->buildListOfTemplateCandidates($layoutName, $paths, '@layout');
        foreach ($possibleFileNames as $layoutPathAndFilename) {
            if ($this->testFileExistence($layoutPathAndFilename)) {
                return $layoutPathAndFilename;
            }
        }
        throw new Exception\InvalidTemplateResourceException('The layout files "' . implode('", "', $possibleFileNames) . '" 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);
        $possibleFileNames = $this->buildListOfTemplateCandidates($partialName, $paths, '@partial');
        foreach ($possibleFileNames as $partialPathAndFilename) {
            if ($this->testFileExistence($partialPathAndFilename)) {
                return $partialPathAndFilename;
            }
        }
        throw new Exception\InvalidTemplateResourceException('The partial files "' . implode('", "', $possibleFileNames) . '" could not be loaded.', 1225709597);
    }

    protected function buildListOfTemplateCandidates($templateName, $paths, $marker)
    {
        $upperCasedTemplateName = $this->ucFileNameInPath($templateName);
        $possibleFileNames = [];
        foreach ($paths as $partialPathAndFilename) {
            $possibleFileNames[] = $this->resolveFileNamePath(str_replace($marker, $upperCasedTemplateName, $partialPathAndFilename));
            if ($templateName !== $upperCasedTemplateName) {
                $possibleFileNames[] = $this->resolveFileNamePath(str_replace($marker, $templateName, $partialPathAndFilename));
            }
        }
        return $possibleFileNames;
    }

    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 = [$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, Fluid::NAMESPACE_SEPARATOR) !== false) {
                $namespaceSeparator = Fluid::NAMESPACE_SEPARATOR;
            } else {
                $namespaceSeparator = Fluid::LEGACY_NAMESPACE_SEPARATOR;
            }
            $subpackageKeyParts = explode($namespaceSeparator, $subpackageKey);
        } else {
            $subpackageKeyParts = [];
        }
        if ($bubbleControllerAndSubpackage) {
            $numberOfPathsBeforeSubpackageExpansion = count($paths);
            $numberOfSubpackageParts = count($subpackageKeyParts);
            $subpackageReplacements = [];
            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', ['']);
        } else {
            $i = $controllerName === null ? 0 : -1;
            $this->expandPatterns($paths, '@subpackage', [implode('/', $i < 0 ? $subpackageKeyParts :
                array_slice($subpackageKeyParts, $i))]);
            $this->expandPatterns($paths, '@controller', [$controllerName]);
        }

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

    protected function expandPatterns(array &$patterns, $search, array $replacements)
    {
        $patternsWithReplacements = [];
        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(GeneralUtility::fixWindowsFilePath($pathAndFilename), true);
    }
}