ComboLoader.php

<?php
/**
 * File containing the ComboLoader class.
 *
 * @copyright Copyright (C) eZ Systems AS. All rights reserved.
 * @license For full copyright and license information view LICENSE file distributed with this source code.
 */
namespace EzSystems\PlatformUIBundle\Loader;

use eZ\Publish\Core\Base\Exceptions\InvalidArgumentException;
use eZ\Publish\Core\Base\Exceptions\NotFoundException;
use eZ\Publish\Core\MVC\ConfigResolverInterface;
use Symfony\Component\Templating\EngineInterface;

/**
 * ComboLoader combines JS or CSS files.
 */
class ComboLoader implements Loader
{
    /**
     * @var string Path to YUI build directory.
     */
    private $yuiBuildDirectory;

    /**
     * @var string Path to web directory.
     */
    private $webDirectory;

    /** @var \eZ\Publish\Core\MVC\ConfigResolverInterface */
    private $configResolver;

    /** @var \Symfony\Component\Templating\EngineInterface */
    private $templating;

    /**
     * @param \eZ\Publish\Core\MVC\ConfigResolverInterface $configResolver
     * @param \Symfony\Component\Templating\EngineInterface $templating
     * @param string $yuiBuildDirectory
     * @param string $webDirectory
     */
    public function __construct(ConfigResolverInterface $configResolver, EngineInterface $templating, $yuiBuildDirectory, $webDirectory)
    {
        $this->configResolver = $configResolver;
        $this->templating = $templating;
        $this->yuiBuildDirectory = $yuiBuildDirectory;
        $this->webDirectory = $webDirectory;
    }

    public function combineFilesContent(array $files, $version = '')
    {
        $content = '';

        $files = $this->sanitizeFilenames($files, $version);

        foreach ($files as $file) {
            $ext = $this->findFileExtension($file);

            if ($ext === Loader::EXT_JS) {
                if ($this->isTemplateFile($file)) {
                    $content .= $this->renderTemplate($file);
                } else {
                    if ($this->isYuiFile($file)) {
                        $file = $this->fixUnresolvedPath($file);
                    }

                    $content .= $this->loadFile($file, $ext);
                }
            } elseif ($ext === Loader::EXT_CSS) {
                $file = $this->fixUnresolvedPath($file);
                $content .= $this->loadFile($file, $ext);
            } else {
                throw new NotFoundException('file type', $file);
            }
        }

        return $content;
    }

    public function getCombinedFilesContentType(array $files, $version = '')
    {
        $files = $this->sanitizeFilenames($files, $version);

        $this->assertAtLeastOneFile($files);

        $file = $files[0];

        $ext = $this->findFileExtension($file);

        if ($ext === Loader::EXT_JS) {
            $type = 'application/javascript';
        } elseif ($ext === Loader::EXT_CSS) {
            $type = 'text/css';
        } else {
            throw new NotFoundException('file type', $file);
        }

        return $type;
    }

    /**
     * Asserts that files array is not empty.
     *
     * @param array $files
     *
     * @throws \eZ\Publish\Core\Base\Exceptions\InvalidArgumentException
     */
    private function assertAtLeastOneFile(array $files)
    {
        if (empty($files)) {
            throw new InvalidArgumentException('files', 'can not be empty');
        }
    }

    /**
     * Returns true if JS file is YUI file.
     *
     * @param $filename
     *
     * @return bool
     */
    private function isYuiFile($filename)
    {
        return $filename[0] !== '/';
    }

    /**
     * Fixes unresolved path.
     *
     * @param $filename
     *
     * @return string
     */
    private function fixUnresolvedPath($filename)
    {
        return $this->yuiBuildDirectory . $filename;
    }

    /**
     * Fixes filename for JS and CSS files.
     *
     * Replace underscores by dots.
     *
     * @param $filename
     * @param $ext
     *
     * @return string
     */
    private function fixFilename($filename, $ext)
    {
        return $this->webDirectory . str_replace('_' . $ext, '.' . $ext, $filename);
    }

    /**
     * Reads file from disk.
     *
     * @param $file
     * @param $ext
     *
     * @return string
     * @throws \eZ\Publish\Core\Base\Exceptions\NotFoundException
     */
    private function loadFile($file, $ext)
    {
        $filename = $this->fixFilename($file, $ext);

        if (!is_readable($filename)) {
            throw new NotFoundException('file', $file);
        }

        return file_get_contents($filename);
    }

    /**
     * Returns file extension.
     *
     * @param $file
     *
     * @return string
     */
    private function findFileExtension($file)
    {
        return substr(strrchr($file, '_'), 1);
    }

    private function isTemplateFile($file)
    {
        return preg_match('#/tpl/handlebars/.*_js#', $file) === 1;
    }

    private function renderTemplate($file)
    {
        preg_match('#/tpl/handlebars/(.*)_js#', $file, $matches);
        $module = $matches[1];

        $path = $this->getModuleSetting($module, 'path');

        return $this->templating->render(
            'eZPlatformUIBundle:Template:wraptemplate.js.twig',
            [
                'path' => $path,
                'module' => $module,
                'templateCode' => file_get_contents($path),
            ]
        );
    }

    private function getModuleSetting($module, $setting)
    {
        return $this->configResolver->getParameter("yui.modules.$module.$setting", 'ez_platformui');
    }

    /**
     * Removes version string (if any) from file paths.
     *
     * @param array $files
     * @param string $version
     *
     * @return array
     */
    private function sanitizeFilenames(array $files, $version)
    {
        $filesWithoutVersion = array_map(function ($file) use ($version) {
            if (preg_match('/\?' . preg_quote($version, '/') . '$/', $file)) {
                return substr($file, 0, -(strlen($version) + 1));
            }

            return $file;
        }, $files);

        return $filesWithoutVersion;
    }
}