Просмотр архива Contao (бывшая TYPOlight)


<?php

/**
 * Contao Open Source CMS
 *
 * Copyright (c) 2005-2016 Leo Feyer
 *
 * @license LGPL-3.0+
 */

namespace Contao;

use LeafoScssPhpCompiler;


/**
 * Combines .css or .js files into one single file
 *
 * Usage:
 *
 *     $combiner = new Combiner();
 *
 *     $combiner->add('css/style.css');
 *     $combiner->add('css/fonts.scss');
 *     $combiner->add('css/print.less');
 *
 *     echo $combiner->getCombinedFile();
 *
 * @author Leo Feyer <https://github.com/leofeyer>
 */
class Combiner extends System
{

    /**
     * The .css file extension
     * @var string
     */
    const CSS = '.css';

    /**
     * The .js file extension
     * @var string
     */
    const JS = '.js';

    /**
     * The .scss file extension
     * @var string
     */
    const SCSS = '.scss';

    /**
     * The .less file extension
     * @var string
     */
    const LESS = '.less';

    /**
     * Unique file key
     * @var string
     */
    protected $strKey = '';

    /**
     * Operation mode
     * @var string
     */
    protected $strMode;

    /**
     * Files
     * @var array
     */
    protected $arrFiles = array();


    /**
     * Public constructor required
     */
    public function __construct()
    {
        parent::__construct();
    }


    /**
     * Add a file to the combined file
     *
     * @param string $strFile    The file to be added
     * @param string $strVersion An optional version number
     * @param string $strMedia   The media type of the file (.css only)
     *
     * @throws Exception If $strFile is invalid
     */
    public function add($strFile, $strVersion=null, $strMedia='all')
    {
        $strType = strrchr($strFile, '.');

        // Check the file type
        if ($strType != self::CSS && $strType != self::JS && $strType != self::SCSS && $strType != self::LESS)
        {
            throw new Exception("Invalid file $strFile");
        }

        $strMode = ($strType == self::JS) ? self::JS : self::CSS;

        // Set the operation mode
        if ($this->strMode === null)
        {
            $this->strMode = $strMode;
        }
        elseif ($this->strMode != $strMode)
        {
            throw new Exception('You cannot mix different file types. Create another Combiner object instead.');
        }

        // Prevent duplicates
        if (isset($this->arrFiles[$strFile]))
        {
            return;
        }

        // Check the source file
        if (!file_exists(TL_ROOT . '/' . $strFile))
        {
            // Create the style sheets and retry
            if ($strType == self::CSS)
            {
                $this->import('StyleSheets');
                $this->StyleSheets->updateStyleSheets();

                if (!file_exists(TL_ROOT . '/' . $strFile))
                {
                    throw new Exception("File $strFile does not exist");
                }
            }
            else
            {
                throw new Exception("File $strFile does not exist");
            }

        }

        // Default version
        if ($strVersion === null)
        {
            $strVersion = VERSION .'.'. BUILD;
        }

        // Store the file
        $arrFile = array
        (
            'name' => $strFile,
            'version' => $strVersion,
            'media' => $strMedia,
            'extension' => $strType
        );

        $this->arrFiles[$strFile] = $arrFile;
        $this->strKey .= '-f' . $strFile . '-v' . $strVersion . '-m' . $strMedia;
    }


    /**
     * Add multiple files from an array
     *
     * @param array  $arrFiles   An array of files to be added
     * @param string $strVersion An optional version number
     * @param string $strMedia   The media type of the file (.css only)
     */
    public function addMultiple(array $arrFiles, $strVersion=null, $strMedia='screen')
    {
        foreach ($arrFiles as $strFile)
        {
            $this->add($strFile, $strVersion, $strMedia);
        }
    }


    /**
     * Check whether files have been added
     *
     * @return boolean True if there are files
     */
    public function hasEntries()
    {
        return !empty($this->arrFiles);
    }


    /**
     * Generate the combined file and return its path
     *
     * @param string $strUrl An optional URL to prepend
     *
     * @return string The path to the combined file
     */
    public function getCombinedFile($strUrl=null)
    {
        if ($strUrl === null)
        {
            $strUrl = TL_ASSETS_URL;
        }

        $strTarget = substr($this->strMode, 1);
        $strKey = substr(md5($this->strKey), 0, 12);

        // Do not combine the files in debug mode (see #6450)
        if (Config::get('debugMode'))
        {
            $return = array();

            foreach ($this->arrFiles as $arrFile)
            {
                $content = file_get_contents(TL_ROOT . '/' . $arrFile['name']);

                // Compile SCSS/LESS files into temporary files
                if ($arrFile['extension'] == self::SCSS || $arrFile['extension'] == self::LESS)
                {
                    $strPath = 'assets/' . $strTarget . '/' . str_replace('/', '_', $arrFile['name']) . $this->strMode;

                    $objFile = new File($strPath, true);
                    $objFile->write($this->handleScssLess($content, $arrFile));
                    $objFile->close();

                    $return[] = $strPath;
                }
                else
                {
                    $name = $arrFile['name'];

                    // Add the media query (see #7070)
                    if ($arrFile['media'] != '' && $arrFile['media'] != 'all' && strpos($content, '@media') === false)
                    {
                        $name .= '" media="' . $arrFile['media'];
                    }

                    $return[] = $name;
                }
            }

            if ($this->strMode == self::JS)
            {
                return implode('"></script><script src="', $return);
            }
            else
            {
                return implode('"><link rel="stylesheet" href="', $return);
            }
        }

        // Load the existing file
        if (file_exists(TL_ROOT . '/assets/' . $strTarget . '/' . $strKey . $this->strMode))
        {
            return $strUrl . 'assets/' . $strTarget . '/' . $strKey . $this->strMode;
        }

        // Create the file
        $objFile = new File('assets/' . $strTarget . '/' . $strKey . $this->strMode, true);
        $objFile->truncate();

        foreach ($this->arrFiles as $arrFile)
        {
            $content = file_get_contents(TL_ROOT . '/' . $arrFile['name']);

            // HOOK: modify the file content
            if (isset($GLOBALS['TL_HOOKS']['getCombinedFile']) && is_array($GLOBALS['TL_HOOKS']['getCombinedFile']))
            {
                foreach ($GLOBALS['TL_HOOKS']['getCombinedFile'] as $callback)
                {
                    $this->import($callback[0]);
                    $content = $this->{$callback[0]}->{$callback[1]}($content, $strKey, $this->strMode, $arrFile);
                }
            }

            if ($arrFile['extension'] == self::CSS)
            {
                $content = $this->handleCss($content, $arrFile);
            }
            elseif ($arrFile['extension'] == self::SCSS || $arrFile['extension'] == self::LESS)
            {
                $content = $this->handleScssLess($content, $arrFile);
            }

            $objFile->append($content);
        }

        unset($content);
        $objFile->close();

        // Create a gzipped version
        if (Config::get('gzipScripts') && function_exists('gzencode'))
        {
            File::putContent('assets/' . $strTarget . '/' . $strKey . $this->strMode . '.gz', gzencode(file_get_contents(TL_ROOT . '/assets/' . $strTarget . '/' . $strKey . $this->strMode), 9));
        }

        return $strUrl . 'assets/' . $strTarget . '/' . $strKey . $this->strMode;
    }


    /**
     * Handle CSS files
     *
     * @param string $content The file content
     * @param array  $arrFile The file array
     *
     * @return string The modified file content
     */
    protected function handleCss($content, $arrFile)
    {
        $content = $this->fixPaths($content, $arrFile);

        // Add the media type if there is no @media command in the code
        if ($arrFile['media'] != '' && $arrFile['media'] != 'all' && strpos($content, '@media') === false)
        {
            $content = '@media ' . $arrFile['media'] . "{n" . $content . "n}";
        }

        return $content;
    }


    /**
     * Handle SCSS/LESS files
     *
     * @param string $content The file content
     * @param array  $arrFile The file array
     *
     * @return string The modified file content
     */
    protected function handleScssLess($content, $arrFile)
    {
        if ($arrFile['extension'] == self::SCSS)
        {
            $objCompiler = new Compiler();

            $objCompiler->setImportPaths(array
            (
                TL_ROOT . '/' . dirname($arrFile['name']),
                TL_ROOT . '/vendor/contao-components/compass/css'
            ));

            $objCompiler->setFormatter((Config::get('debugMode') ? 'LeafoScssPhpFormatterExpanded' : 'LeafoScssPhpFormatterCompressed'));

            return $this->fixPaths($objCompiler->compile($content), $arrFile);
        }
        else
        {
            $strPath = dirname($arrFile['name']);

            $arrOptions = array
            (
                'strictMath' => true,
                'compress' => !Config::get('debugMode'),
                'import_dirs' => array(TL_ROOT . '/' . $strPath => $strPath)
            );

            $objParser = new Less_Parser();
            $objParser->SetOptions($arrOptions);
            $objParser->parse($content);

            return $this->fixPaths($objParser->getCss(), $arrFile);
        }
    }


    /**
     * Fix the paths
     *
     * @param string $content The file content
     * @param array  $arrFile The file array
     *
     * @return string The modified file content
     */
    protected function fixPaths($content, $arrFile)
    {
        $strDirname = dirname($arrFile['name']);
        $strGlue = ($strDirname != '.') ? $strDirname . '/' : '';

        $strBuffer = '';
        $chunks = preg_split('/url(["']??(.+)["']??)/U', $content, -1, PREG_SPLIT_DELIM_CAPTURE);

        // Check the URLs
        for ($i=0, $c=count($chunks); $i<$c; $i=$i+2)
        {
            $strBuffer .= $chunks[$i];

            if (!isset($chunks[$i+1]))
            {
                break;
            }

            $strData = $chunks[$i+1];

            // Skip absolute links and embedded images (see #5082)
            if (strncmp($strData, 'data:', 5) !== 0 && strncmp($strData, 'http://', 7) !== 0 && strncmp($strData, 'https://', 8) !== 0 && strncmp($strData, '/', 1) !== 0 && strncmp($strData, 'assets/css3pie/', 15) !== 0)
            {
                // Make the paths relative to the root (see #4161)
                if (strncmp($strData, '../', 3) !== 0)
                {
                    $strData = '../../' . $strGlue . $strData;
                }
                else
                {
                    $dir = $strDirname;

                    // Remove relative paths
                    while (strncmp($strData, '../', 3) === 0)
                    {
                        $dir = dirname($dir);
                        $strData = substr($strData, 3);
                    }

                    $glue = ($dir != '.') ? $dir . '/' : '';
                    $strData = '../../' . $glue . $strData;
                }
            }

            $strBuffer .= 'url("' . $strData . '")';
        }

        return $strBuffer;
    }
}