puli / twig-extension

src/NodeVisitor/TemplatePathResolver.php

<?php

/*
 * This file is part of the puli/twig-puli-extension package.
 *
 * (c) Bernhard Schussek <bschussek@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Puli\TwigExtension\NodeVisitor;

use Puli\Repository\Api\ResourceRepository;
use Puli\TwigExtension\PuliExtension;
use Puli\UrlGenerator\Api\UrlGenerator;
use RuntimeException;
use Twig_Node;
use Twig_Node_Expression_Constant;
use Twig_Node_Expression_Function;
use Twig_Node_Import;
use Twig_Node_Include;
use Twig_Node_Module;

/**
 * @since  1.0
 *
 * @author Bernhard Schussek <bschussek@gmail.com>
 */
class TemplatePathResolver extends AbstractPathResolver
{
    /**
     * @var UrlGenerator
     */
    private $urlGenerator;

    /**
     * @var bool
     */
    private $checkPaths;

    public function __construct(ResourceRepository $repo, UrlGenerator $urlGenerator = null, $checkPaths = false)
    {
        parent::__construct($repo);

        $this->urlGenerator = $urlGenerator;
        $this->checkPaths = $checkPaths;
    }

    /**
     * Returns the priority for this visitor.
     *
     * Priority should be between -10 and 10 (0 is the default).
     *
     * @return int The priority level
     */
    public function getPriority()
    {
        return PuliExtension::RESOLVE_PATHS;
    }

    /**
     * {@inheritdoc}
     */
    protected function processNode(Twig_Node $node)
    {
        if ($node instanceof Twig_Node_Module) {
            return $this->processModuleNode($node);
        }

        if ($node instanceof Twig_Node_Include) {
            return $this->processIncludeNode($node);
        }

        if ($node instanceof Twig_Node_Import) {
            return $this->processImportNode($node);
        }

        if ($node instanceof Twig_Node_Expression_Function && 'resource_url' === $node->getAttribute('name')) {
            return $this->processResourceUrlFunction($node);
        }

        return null;
    }

    private function processModuleNode(Twig_Node_Module $node)
    {
        // Resolve relative parent template paths to absolute paths
        $parentNode = $node->hasNode('parent') ? $node->getNode('parent') : null;
        $traitsNode = $node->getNode('traits');

        // If the template extends another template, resolve the path
        if ($parentNode instanceof Twig_Node_Expression_Constant) {
            $this->processConstantNode($parentNode, $this->checkPaths);
        }

        // Resolve paths of embedded templates
        foreach ($node->getAttribute('embedded_templates') as $embeddedNode) {
            $this->processEmbeddedTemplateNode($embeddedNode);
        }

        // Resolve paths of used templates
        foreach ($traitsNode as $traitNode) {
            $this->processTraitNode($traitNode);
        }

        return null;
    }

    private function processEmbeddedTemplateNode(Twig_Node_Module $embeddedNode)
    {
        $embedParent = $embeddedNode->hasNode('parent') ? $embeddedNode->getNode('parent') : null;

        // If the template extends another template, resolve the path
        if ($embedParent instanceof Twig_Node_Expression_Constant) {
            $this->processConstantNode($embedParent, $this->checkPaths);
        }
    }

    private function processTraitNode(Twig_Node $traitNode)
    {
        $usedTemplate = $traitNode->getNode('template');

        // If the template extends another template, resolve the path
        if ($usedTemplate instanceof Twig_Node_Expression_Constant) {
            $this->processConstantNode($usedTemplate, $this->checkPaths);
        }
    }

    private function processIncludeNode(Twig_Node_Include $node)

This method seems to be duplicated in your project.

    {
        $exprNode = $node->getNode('expr');

        if ($exprNode instanceof Twig_Node_Expression_Constant) {
            $this->processConstantNode($exprNode, $this->checkPaths);
        }

        return null;
    }

    private function processImportNode(Twig_Node_Import $node)

This method seems to be duplicated in your project.

    {
        $exprNode = $node->getNode('expr');

        if ($exprNode instanceof Twig_Node_Expression_Constant) {
            $this->processConstantNode($exprNode, $this->checkPaths);
        }

        return null;
    }

    protected function processResourceUrlFunction(Twig_Node $node)
    {
        if (!$this->urlGenerator) {
            throw new RuntimeException(
                'The resource_url() function is only available if puli/url-generator is installed and an instance of'.
                '"Puli\UrlGenerator\Api\UrlGenerator" is passed to the TemplatePathResolver.'
            );
        }

        $argsNode = $node->getNode('arguments');

        if (!$argsNode->hasNode(0)) {
            return null;
        }

        $exprNode = $argsNode->getNode(0);

        if (!$exprNode instanceof Twig_Node_Expression_Constant) {
            return null;
        }

        // The paths passed to the resource_url() function must always be Puli
        // paths, so disable path checking
        $this->processConstantNode($exprNode, false);

        // Optimize away function call
        $exprNode->setAttribute('value', $this->urlGenerator->generateUrl($exprNode->getAttribute('value')));

        return $exprNode;
    }

    private function processConstantNode(Twig_Node_Expression_Constant $node, $checkPath)
    {
        $node->setAttribute('value', $this->resolvePath($node->getAttribute('value'), $checkPath));
    }
}