TypoScriptView.php

<?php
namespace TYPO3\Neos\View;

/*
 * This file is part of the TYPO3.Neos package.
 *
 * (c) Contributors of the Neos Project - www.neos.io
 *
 * This package is Open Source Software. For the full copyright and license
 * information, please view the LICENSE file which was distributed with this
 * source code.
 */

use TYPO3\Flow\Annotations as Flow;
use TYPO3\Flow\Http\Response;
use TYPO3\Flow\I18n\Locale;
use TYPO3\Flow\Mvc\View\AbstractView;
use TYPO3\Flow\Security\Context;
use TYPO3\TYPO3CR\Domain\Model\Node;
use TYPO3\TYPO3CR\Domain\Model\NodeInterface;
use TYPO3\TypoScript\Core\Runtime;
use TYPO3\TypoScript\Exception\RuntimeException;

/**
 * A TypoScript view for Neos
 */
class TypoScriptView extends AbstractView
{
    /**
     * @Flow\Inject
     * @var \TYPO3\Flow\I18n\Service
     */
    protected $i18nService;

    /**
     * This contains the supported options, their default values, descriptions and types.
     *
     * @var array
     */
    protected $supportedOptions = array(
        'enableContentCache' => array(null, 'Flag to enable content caching inside TypoScript (overriding the global setting).', 'boolean')
    );

    /**
     * @Flow\Inject
     * @var \TYPO3\Neos\Domain\Service\TypoScriptService
     */
    protected $typoScriptService;

    /**
     * The TypoScript path to use for rendering the node given in "value", defaults to "page".
     *
     * @var string
     */
    protected $typoScriptPath = 'root';

    /**
     * @var \TYPO3\TypoScript\Core\Runtime
     */
    protected $typoScriptRuntime;

    /**
     * @Flow\Inject
     * @var Context
     */
    protected $securityContext;

    /**
     * Renders the view
     *
     * @return string The rendered view
     * @throws \Exception if no node is given
     * @api
     */
    public function render()
    {
        $currentNode = $this->getCurrentNode();
        $currentSiteNode = $currentNode->getContext()->getCurrentSiteNode();
        $typoScriptRuntime = $this->getTypoScriptRuntime($currentSiteNode);

        $dimensions = $currentNode->getContext()->getDimensions();
        if (array_key_exists('language', $dimensions) && $dimensions['language'] !== array()) {
            $currentLocale = new Locale($dimensions['language'][0]);
            $this->i18nService->getConfiguration()->setCurrentLocale($currentLocale);
            $this->i18nService->getConfiguration()->setFallbackRule(array('strict' => false, 'order' => array_reverse($dimensions['language'])));
        }

        $contextArray = [
            'node' => $currentNode,
            'documentNode' => $this->getClosestDocumentNode($currentNode) ?: $currentNode,
            'site' => $currentSiteNode,
            'editPreviewMode' => isset($this->variables['editPreviewMode']) ? $this->variables['editPreviewMode'] : null
        ];

        $this->emitContextArrayInitialized($contextArray);

        $typoScriptRuntime->pushContextArray($contextArray);

        try {
            $output = $typoScriptRuntime->render($this->typoScriptPath);
            $output = $this->mergeHttpResponseFromOutput($output, $typoScriptRuntime);
        } catch (RuntimeException $exception) {
            throw $exception->getPrevious();
        }
        $typoScriptRuntime->popContext();

        return $output;
    }

    /**
     * @param string $output
     * @param Runtime $typoScriptRuntime
     * @return string The message body without the message head
     */
    protected function mergeHttpResponseFromOutput($output, Runtime $typoScriptRuntime)
    {
        if (substr($output, 0, 5) === 'HTTP/') {
            $endOfHeader = strpos($output, "\r\n\r\n");
            if ($endOfHeader !== false) {
                $header = substr($output, 0, $endOfHeader + 4);
                try {
                    $renderedResponse = Response::createFromRaw($header);

                    /** @var Response $response */
                    $response = $typoScriptRuntime->getControllerContext()->getResponse();
                    $response->setStatus($renderedResponse->getStatusCode());
                    foreach ($renderedResponse->getHeaders()->getAll() as $headerName => $headerValues) {
                        $response->setHeader($headerName, $headerValues[0]);
                    }

                    $output = substr($output, strlen($header));
                } catch (\InvalidArgumentException $exception) {
                }
            }
        }

        return $output;
    }

    /**
     * Is it possible to render $node with $his->typoScriptPath?
     *
     * @return boolean TRUE if $node can be rendered at $typoScriptPath
     *
     * @throws \TYPO3\Neos\Exception
     */
    public function canRenderWithNodeAndPath()
    {
        $currentNode = $this->getCurrentNode();
        $currentSiteNode = $currentNode->getContext()->getCurrentSiteNode();
        $typoScriptRuntime = $this->getTypoScriptRuntime($currentSiteNode);

        return $typoScriptRuntime->canRender($this->typoScriptPath);
    }

    /**
     * Set the TypoScript path to use for rendering the node given in "value"
     *
     * @param string $typoScriptPath
     * @return void
     */
    public function setTypoScriptPath($typoScriptPath)
    {
        $this->typoScriptPath = $typoScriptPath;
    }

    /**
     * @return string
     */
    public function getTypoScriptPath()
    {
        return $this->typoScriptPath;
    }

    /**
     * @param NodeInterface $node
     * @return NodeInterface
     */
    protected function getClosestDocumentNode(NodeInterface $node)
    {
        while ($node !== null && !$node->getNodeType()->isOfType('TYPO3.Neos:Document')) {
            $node = $node->getParent();
        }
        return $node;
    }

    /**
     * @return NodeInterface
     * @throws \TYPO3\Neos\Exception
     */
    protected function getCurrentNode()
    {
        $currentNode = isset($this->variables['value']) ? $this->variables['value'] : null;
        if (!$currentNode instanceof Node) {
            throw new \TYPO3\Neos\Exception('TypoScriptView needs a variable \'value\' set with a Node object.', 1329736456);
        }
        return $currentNode;
    }

    /**
     * @param NodeInterface $currentSiteNode
     * @return \TYPO3\TypoScript\Core\Runtime
     */
    protected function getTypoScriptRuntime(NodeInterface $currentSiteNode)
    {
        if ($this->typoScriptRuntime === null) {
            $this->typoScriptRuntime = $this->typoScriptService->createRuntime($currentSiteNode, $this->controllerContext);

            if (isset($this->options['enableContentCache']) && $this->options['enableContentCache'] !== null) {
                $this->typoScriptRuntime->setEnableContentCache($this->options['enableContentCache']);
            }
        }
        return $this->typoScriptRuntime;
    }

    /**
     * Clear the cached runtime instance on assignment of variables
     *
     * @param string $key
     * @param mixed $value
     * @return TypoScriptView
     */
    public function assign($key, $value)
    {
        $this->typoScriptRuntime = null;
        return parent::assign($key, $value);
    }

    /**
     * Emits a signal when the context array has been initialized
     *
     * @param array $contextArray Initialized context array
     * @return void
     * @Flow\Signal
     */
    protected function emitContextArrayInitialized(array &$contextArray)
    {
    }
}