Gzip::clearUrl() - Code Metrics - Inspection of "Quick cleanup and inject File class into Optimizat..." - pH7Software/pH7-Social-Dating-CMS - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Branch — master (35850d)

by Pierre-Henry
created 2017-06-15 19:45 UTC
Gzip::clearUrl() A

↳ Parent: Gzip
Complexity

Conditions	1
Paths	1
Size

Total Lines	4
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	2
nc	1
nop	1
dl	0
loc	4
rs	10
c	0
b	0
f	0
<?php

/**
 * @title            Gzip Class
 * @desc             Compression and optimization of static files.
 *
 * @author           Pierre-Henry Soria <[email protected]>
 * @copyright        (c) 2012-2017, Pierre-Henry Soria. All Rights Reserved.
 * @license          GNU General Public License; See PH7.LICENSE.txt and PH7.COPYRIGHT.txt in the root directory.
 * @package          PH7 / Framework / Layout / Gzip
 * @version          1.7
 */

namespace PH7\Framework\Layout\Gzip;

defined('PH7') or exit('Restricted access');

use PH7\Framework\File\File;
use PH7\Framework\Config\Config;
use PH7\Framework\Compress\Compress;
use PH7\Framework\Layout\Optimization;
use PH7\Framework\Navigation\Browser;
use PH7\Framework\Http\Http;
use PH7\Framework\Mvc\Request\Http as HttpRequest;
use PH7\Framework\Error\CException\PH7InvalidArgumentException;

class Gzip
{
    const REGEX_IMAGE_FORMAT = '/url\([\'"]*(.+?\.)(gif|png|jpg|jpeg|otf|eot|ttf|woff|svg)[\'"]*\)*/msi';
    const CACHE_DIR = 'pH7_static/';
    const MAX_IMG_SIZE_BASE64_CONVERTOR = 24000; // 24KB

    /** @var File */
    private $oFile;

    /** @var HttpRequest */
    private $oHttpRequest;

    /** @var string */
    private $sBase;

    /** @var string */
    private $sBaseUrl;

    /** @var string */
    private $sType;

    /** @var string */
    private $sDir;

    /** @var string */
    private $sFiles;

    /** @var string */
    private $sContents;

    /** @var string */
    private $sCacheDir;

    /** @var array */
    private $aElements;

    /** @var integer */
    private $iIfModified;

    /** @var boolean */
    private $bCaching;

    /** @var boolean */
    private $bCompressor;

    /** @var boolean */
    private $bDataUri;

    /** @var boolean */
    private $bGzipContent;

    /** @var boolean */
    private $bIsGzip;

    /** @var string|boolean */
    private $mEncoding;

    public function __construct()
    {
        $this->oFile = new File;
        $this->oHttpRequest = new HttpRequest;

        $this->bCaching = (bool) Config::getInstance()->values['cache']['enable.static.cache'];
        $this->bCompressor = (bool) Config::getInstance()->values['cache']['enable.static.minify'];
        $this->bGzipContent = (bool) Config::getInstance()->values['cache']['enable.static.gzip_compress'];
        $this->bDataUri = (bool) Config::getInstance()->values['cache']['enable.static.data_uri'];

        $this->bIsGzip = $this->isGzip();
    }

    /**
     * Set cache directory.
     * If the directory is not correct, the method will cause an exception.
     * If you do not use this method, a default directory will be created.
     *
     * @param string $sCacheDir
     *
     * @return void
     *
     * @throws PH7InvalidArgumentException If the cache directory does not exist.
     */
    public function setCacheDir($sCacheDir)
    {
        if (is_dir($sCacheDir))
            $this->sCacheDir = $sCacheDir;
        else
            throw new PH7InvalidArgumentException('"' . $sCacheDir . '" cache directory cannot be found!');
    }

    /**
     * Displays compressed files.
     *
     * @return void
     *
     * @throws Exception If the cache file couldn't be written.
     *
     * @throws \PH7\Framework\File\Exception
     */
    public function run()
    {
        // Determine the directory and type we should use
        if (!$this->oHttpRequest->getExists('t') || ($this->oHttpRequest->get('t') !==
            'html' && $this->oHttpRequest->get('t') !== 'css' && $this->oHttpRequest->get('t') !== 'js'))
        {
            Http::setHeadersByCode(503);
            exit('Invalid type file!');

        }
        $this->sType = ($this->oHttpRequest->get('t') === 'js') ? 'javascript' : $this->oHttpRequest->get('t');

        // Directory
        if (!$this->oHttpRequest->getExists('d'))
        {
            Http::setHeadersByCode(503);
            exit('No directory specified!');

        }

        $this->sDir = $this->oHttpRequest->get('d');
        $this->sBase = $this->oFile->checkExtDir(realpath($this->sDir));
        $this->sBaseUrl = $this->clearUrl($this->oFile->checkExtDir($this->sDir));

        // The Files
        if (!$this->oHttpRequest->getExists('f'))
        {
            Http::setHeadersByCode(503);
            exit('No file specified!');

        }

        $this->sFiles = $this->oHttpRequest->get('f');
        $this->aElements = explode(',', $this->sFiles);

        foreach ($this->aElements as $sElement)
        {
            $sPath = realpath($this->sBase . $sElement);

            if (($this->sType == 'html' && substr($sPath, -5) != '.html') || ($this->

                _sType == 'javascript' && substr($sPath, -3) != '.js') || ($this->sType == 'css' && substr($sPath, -4) != '.css'))
            {
                Http::setHeadersByCode(403);
                exit('Error file extension.');

            }

            if (substr($sPath, 0, strlen($this->sBase)) != $this->sBase || !is_file($sPath)) {
                Http::setHeadersByCode(404);
                exit('The file not found!');

            }
        }

        $this->setHeaders();

        // If the cache is enabled, reads cache and displays, otherwise reads and displays the contents.
        $this->bCaching ? $this->cache() : $this->getContents();

        echo $this->sContents;
    }

    /**
     * Set Caching.
     *
     * @return string The cached contents.
     *
     * @throws Exception If the cache file couldn't be written.
     *
     * @throws \PH7\Framework\File\Exception If the file cannot be created.
     */
    public function cache()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        $this->checkCacheDir();

        /**
         * Try the cache first to see if the combined files were already generated.
         */

        $oBrowser = new Browser;

        $this->iIfModified = (!empty($_SERVER['HTTP_IF_MODIFIED_SINCE'])) ? substr($_SERVER['HTTP_IF_MODIFIED_SINCE'], 0, 29) : null;
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}

        $this->sCacheDir .= $this->oHttpRequest->get('t') . PH7_DS;
        $this->oFile->createDir($this->sCacheDir);
        $sExt = ($this->bIsGzip) ? 'gz' : 'cache';
        $sCacheFile = md5($this->sType . $this->sDir . $this->sFiles) . PH7_DOT . $sExt;

        foreach ($this->aElements as $sElement)
        {
            $sPath = realpath($this->sBase . $sElement);

            if ($this->oFile->getModifTime($sPath) > $this->oFile->getModifTime($this->sCacheDir . $sCacheFile))
            {
                if (!empty($this->iIfModified) && $this->oFile->getModifTime($sPath) > $this->oFile->getModifTime($this->iIfModified))
                    $oBrowser->noCache();

                // Get contents of the files
                $this->getContents();

                // Store the file in the cache
                if (!$this->oFile->putFile($this->sCacheDir . $sCacheFile, $this->sContents))
                    throw new Exception('Couldn\'t write cache file: \'' . $this->sCacheDir . $sCacheFile . '\'');
            }
        }

        if ($this->oHttpRequest->getMethod() != 'HEAD')
        {
            $oBrowser->cache();
            //header('Not Modified', true, 304); // Warning: It can causes problems (ERR_FILE_NOT_FOUND)

        }

        unset($oBrowser);

        if (!$this->sContents = $this->oFile->getFile($this->sCacheDir . $sCacheFile))
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
            throw new Exception('Couldn\'t read cache file: \'' . $this->sCacheDir . $sCacheFile . '\'');
    }

    /**
     * Routing for files compressing.
     *
     * @return void
     */
    protected function makeCompress()
    {
        $oCompress = new Compress;

        switch ($this->sType)
        {
            case 'html':
                $this->sContents = $oCompress->parseHtml($this->sContents);
            break;

            case 'css':
                $this->sContents = $oCompress->parseCss($this->sContents);
            break;

            case 'javascript':
                $this->sContents = $oCompress->parseJs($this->sContents);
            break;

            default:
                Http::setHeadersByCode(503);
                exit('Invalid type file!');

        }

        unset($oCompress);
    }

    /**
     * Transform the contents into a gzip compressed string.
     *
     * @return void
     */
    protected function gzipContent()
    {
        $this->sContents = gzencode($this->sContents, 9, FORCE_GZIP);
    }

    /**
     * Get contents of the files.
     *
     * @return void
     */
    protected function getContents()
    {
        $this->sContents = '';
        foreach ($this->aElements as $sElement) {
            $this->sContents .= File::EOL . $this->oFile->getUrlContents(PH7_URL_ROOT . $this->sBaseUrl . $sElement);
        }

        if ($this->sType == 'css')
        {
            $this->parseVariable();
            $this->getSubCssFile();
            $this->getImageIntoCss();
        }

        if ($this->sType == 'javascript')
        {
            $this->parseVariable();
            $this->getSubJsFile();
        }

        if ($this->bCompressor) $this->makeCompress();

        if ($this->bCaching) $this->sContents = '/*Cached on ' . gmdate('d M Y H:i:s') . '*/' . File::EOL . $this->sContents;

        if ($this->bIsGzip) $this->gzipContent();
    }

    /**
     * @return void
     */
     protected function setHeaders()
     {
        // Send Content-Type
        header('Content-Type: text/' . $this->sType);
        header('Vary: Accept-Encoding');
        header('Expires: ' . gmdate('D, d M Y H:i:s', time() + 3600*24*10) . ' GMT'); // 10 days

        // Send compressed contents
        if ($this->bIsGzip) header('Content-Encoding: ' . $this->mEncoding);
    }

    /**
     * Check if gzip is activate.
     *
     * @return boolean Returns FALSE if compression is disabled or is not valid, otherwise returns TRUE
     */
    protected function isGzip()
    {
        $this->mEncoding = (new Browser)->encoding();
        return (!$this->bGzipContent ? false : ($this->mEncoding !== false ? true : false));
    }

    /**
     * Parser the CSS/JS variables in cascading style sheets and JavaScript files.
     *
     * @return void
     */
    protected function parseVariable()
    {
        $sBaseUrl = $this->sBaseUrl;

        /**
         * $getCurrentTplName is used in "variables.inc.php" file
         */
        $getCurrentTplName = function () use ($sBaseUrl) {
            $aDirs = explode('/', $sBaseUrl);
            return !empty($aDirs[2]) ? $aDirs[2] : PH7_DEFAULT_THEME;
        };

        $this->setVariables( include('variables.inc.php') );
    }

    /**
     * @return void
     */
    protected function getSubCssFile()
    {
        // We also collect the files included in the CSS files. So we can also cache and compressed.
        preg_match_all('/@import\s+url\([\'"]*(.+?\.)(css)[\'"]*\)\s{0,};/msi', $this->sContents, $aHit, PREG_PATTERN_ORDER);

        for ($i = 0, $iCountHit = count($aHit[0]); $i < $iCountHit; $i++) {
            $this->sContents = str_replace($aHit[0][$i], '', $this->sContents);
            $this->sContents .= File::EOL . $this->oFile->getUrlContents($aHit[1][$i] . $aHit[2][$i]);
        }
    }

    /**
     * @return void
     */
    protected function getSubJsFile()
    {
        // We also collect the files included in the JavaScript files. So we can also cache and compressed.
        preg_match_all('/include\([\'"]*(.+?\.)(js)[\'"]*\)\s{0,};/msi', $this->sContents, $aHit, PREG_PATTERN_ORDER);

        for ($i = 0, $iCountHit = count($aHit[0]); $i < $iCountHit; $i++)
        {
            $this->sContents = str_replace($aHit[0][$i], '', $this->sContents);
            $this->sContents .= File::EOL . $this->oFile->getUrlContents($aHit[1][$i] . $aHit[2][$i]);
        }
    }

    /**
     * Get the images into the CSS files.
     *
     * @return void
     */
    private function getImageIntoCss()
    {
        preg_match_all(self::REGEX_IMAGE_FORMAT, $this->sContents, $aHit, PREG_PATTERN_ORDER);

        for ($i = 0, $iCountHit = count($aHit[0]); $i < $iCountHit; $i++) {
            $sImgPath = PH7_PATH_ROOT . $this->sBaseUrl . $aHit[1][$i] . $aHit[2][$i];
            $sImgUrl = PH7_URL_ROOT . $this->sBaseUrl . $aHit[1][$i] . $aHit[2][$i];

            // If the image-file exists and if file-size is lower than 24 KB, we convert it into base64 data URI
            if ($this->bDataUri && is_file($sImgPath) && $this->oFile->size($sImgPath) < self::MAX_IMG_SIZE_BASE64_CONVERTOR) {
                $this->sContents =  str_replace($aHit[0][$i], 'url(' . Optimization::dataUri($sImgPath, $this->oFile) . ')', $this->sContents);
            } else {
                $this->sContents = str_replace($aHit[0][$i], 'url(' . $sImgUrl . ')', $this->sContents);
            }
        }
    }

    /**
     * Set CSS/JS variables.
     *
     * @param array $aVars Variable names containing the values.
     *
     * @return void
     */
    private function setVariables(array $aVars)
    {
        // Replace the variable name by the content
        foreach ($aVars as $sKey => $sVal)
            $this->sContents = str_replace('[$' . $sKey . ']', $sVal, $this->sContents);
    }

    /**
     * Checks if the cache directory has been defined otherwise we create a default directory.
     * If the directory cache does not exist, it creates a directory.
     *
     * @return void
     */
    private function checkCacheDir()
    {
        $this->sCacheDir = (empty($this->sCacheDir)) ? PH7_PATH_CACHE . static::CACHE_DIR : $this->sCacheDir;
    }

    /**
     * Remove backslashes on Windows.
     *
     * @param string $sPath
     *
     * @return string The path without backslashes and/or double slashes.
     */
    private function clearUrl($sPath)
    {
        return str_replace(array('\\', '//'), '/', $sPath);
    }
}

pH7Software / pH7-Social-Dating-CMS

Branch — master (35850d)

Gzip::clearUrl() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
