Fix themes not working with includes

This was due to the switch to ThemeAwareTwigEngine, which is only used
when calling the template engine. It basically occurs when rendering
templates from controllers (or services), but not when doing includes as
Twig calls its inner functions.

Author: lolautruche

Resources/config/services.yml

@@ -7,10 +7,13 @@ services:
         tags:
             - { name: kernel.event_subscriber }
 
-    ez_core_extra.twig_engine:
-        class: Lolautruche\EzCoreExtraBundle\Templating\ThemeAwareTwigEngine
+    ez_core_extra.template_name_resolver:
+        class: Lolautruche\EzCoreExtraBundle\Templating\ThemeTemplateNameResolver
+        arguments: ["$design;ez_core_extra$"]
+        lazy: true
+
+    ez_core_extra.twig_theme_loader:
+        class: Lolautruche\EzCoreExtraBundle\Templating\TwigThemeLoader
         public: false
-        decorates: templating.engine.twig
-        arguments: ["@ez_core_extra.twig_engine.inner"]
-        calls:
-            - [setCurrentDesign, ["$design;ez_core_extra$"]]
+        decorates: twig.loader.filesystem
+        arguments: ["@ez_core_extra.template_name_resolver", "@ez_core_extra.twig_theme_loader.inner"]

Templating/TemplateNameResolverInterface.php

@@ -0,0 +1,30 @@
+<?php
+
+/*
+ * This file is part of the EzCoreExtraBundle package.
+ *
+ * (c) Jérôme Vieilledent <jerome@vieilledent.fr>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Lolautruche\EzCoreExtraBundle\Templating;
+
+/**
+ * Interface for template name resolvers.
+ * A template name resolver will check provided template name and resolve it for current design.
+ */
+interface TemplateNameResolverInterface
+{
+    const EZ_DESIGN_NAMESPACE = 'ezdesign';
+
+    /**
+     * Resolves provided template name within current design and returns properly namespaced template name.
+     *
+     * @param string $name Template name to resolve.
+     *
+     * @return string
+     */
+    public function resolveTemplateName($name);
+}

Templating/ThemeAwareTwigEngine.php

@@ -0,0 +1,43 @@
+<?php
+
+/*
+ * This file is part of the EzCoreExtraBundle package.
+ *
+ * (c) Jérôme Vieilledent <jerome@vieilledent.fr>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Lolautruche\EzCoreExtraBundle\Templating;
+
+class ThemeTemplateNameResolver implements TemplateNameResolverInterface
+{
+    /**
+     * @var string Name of the current design, in the current context (e.g. SiteAccess).
+     */
+    private $currentDesign;
+
+    /**
+     * Collection of already resolved template names.
+     *
+     * @var array
+     */
+    private $resolvedTemplateNames = [];
+
+    public function __construct($currentDesign)
+    {
+        $this->currentDesign = $currentDesign;
+    }
+
+    public function resolveTemplateName($name)
+    {
+        if (strpos($name, '@'.self::EZ_DESIGN_NAMESPACE) === false) {
+            return $name;
+        } elseif (isset($this->resolvedTemplateNames[$name])) {
+            return $this->resolvedTemplateNames[$name];
+        }
+
+        return $this->resolvedTemplateNames[$name] = str_replace('@'.self::EZ_DESIGN_NAMESPACE, '@'.$this->currentDesign, $name);
+    }
+}

Templating/ThemeTemplateNameResolver.php

@@ -0,0 +1,87 @@
+<?php
+
+/*
+ * This file is part of the EzCoreExtraBundle package.
+ *
+ * (c) Jérôme Vieilledent <jerome@vieilledent.fr>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Lolautruche\EzCoreExtraBundle\Templating;
+
+use Symfony\Bundle\TwigBundle\Loader\FilesystemLoader;
+use Twig_ExistsLoaderInterface;
+use Twig_LoaderInterface;
+
+/**
+ * Proxy to regular Twig FilesystemLoader.
+ * It resolves generic @ezdesign namespace to the actual current namespace.
+ *
+ * @note It extends \Symfony\Bundle\TwigBundle\Loader\FilesystemLoader because methods specific to this loader
+ * (e.g. related to paths and namespaces) are not part of an interface.
+ */
+class TwigThemeLoader extends FilesystemLoader implements Twig_LoaderInterface, Twig_ExistsLoaderInterface
+{
+    /**
+     * @var TemplateNameResolverInterface
+     */
+    private $nameResolver;
+    
+    /**
+     * @var Twig_LoaderInterface|Twig_ExistsLoaderInterface|\Twig_Loader_Filesystem
+     */
+    private $innerFilesystemLoader;
+
+    public function __construct(TemplateNameResolverInterface $templateNameResolver, Twig_LoaderInterface $innerFilesystemLoader)
+    {
+        $this->innerFilesystemLoader = $innerFilesystemLoader;
+        $this->nameResolver = $templateNameResolver;
+    }
+
+    public function exists($name)
+    {
+        return $this->innerFilesystemLoader->exists($this->nameResolver->resolveTemplateName($name));
+    }
+
+    public function getSource($name)
+    {
+        return $this->innerFilesystemLoader->getSource($this->nameResolver->resolveTemplateName($name));
+    }
+
+    public function getCacheKey($name)
+    {
+        return $this->innerFilesystemLoader->getCacheKey($this->nameResolver->resolveTemplateName($name));
+    }
+
+    public function isFresh($name, $time)
+    {
+        return $this->innerFilesystemLoader->isFresh($this->nameResolver->resolveTemplateName($name), $time);
+    }
+
+    public function getPaths($namespace = self::MAIN_NAMESPACE)
+    {
+        return $this->innerFilesystemLoader->getPaths($namespace);
+    }
+
+    public function getNamespaces()
+    {
+        return $this->innerFilesystemLoader->getNamespaces();
+    }
+
+    public function setPaths($paths, $namespace = self::MAIN_NAMESPACE)
+    {
+        $this->innerFilesystemLoader->setPaths($paths, $namespace);
+    }
+
+    public function addPath($path, $namespace = self::MAIN_NAMESPACE)
+    {
+        $this->innerFilesystemLoader->addPath($path, $namespace);
+    }
+
+    public function prependPath($path, $namespace = self::MAIN_NAMESPACE)
+    {
+        $this->innerFilesystemLoader->prependPath($path, $namespace);
+    }
+}