Files
sysPass/lib/SP/Html/Minify.php
Rubén D 41703b50f9 * [MOD] Strict type checking (WIP)
Signed-off-by: Rubén D <nuxsmin@syspass.org>
2020-12-20 14:24:42 +01:00

349 lines
8.9 KiB
PHP

<?php
/*
* sysPass
*
* @author nuxsmin
* @link https://syspass.org
* @copyright 2012-2020, Rubén Domínguez nuxsmin@$syspass.org
*
* This file is part of sysPass.
*
* sysPass is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* sysPass is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with sysPass. If not, see <http://www.gnu.org/licenses/>.
*/
namespace SP\Html;
use Klein\Klein;
use Psr\Container\ContainerExceptionInterface;
use Psr\Container\NotFoundExceptionInterface;
use SP\Http\Request;
defined('APP_ROOT') || die();
/**
* Class Minify para la gestión de archivos JS y CSS
*
* @package SP
*/
final class Minify
{
/**
* Constantes para tipos de archivos
*/
const FILETYPE_JS = 1;
const FILETYPE_CSS = 2;
const OFFSET = 3600 * 24 * 30;
/**
* @var Klein
*/
protected $router;
/**
* Array con los archivos a procesar
*
* @var array
*/
private $files = [];
/**
* Tipos de archivos a procesar
*
* @var int
*/
private $type = 0;
/**
* Base relativa de búsqueda de los archivos
*
* @var string
*/
private $base = '';
/**
* Minify constructor.
*
* @param Klein $router
*/
public function __construct(Klein $router)
{
$this->router = $router;
}
/**
* @param string $path
* @param bool $checkPath
*
* @return $this
*/
public function setBase(string $path, $checkPath = false): Minify
{
$this->base = $checkPath === true ? Request::getSecureAppPath($path) : $path;
return $this;
}
/**
* Devolver al navegador archivos CSS y JS comprimidos
* Método que devuelve un recurso CSS o JS comprimido. Si coincide el ETAG se
* devuelve el código HTTP/304
*
* @param bool $disableMinify Deshabilitar minimizar
*
* @throws ContainerExceptionInterface
* @throws NotFoundExceptionInterface
*/
public function getMinified($disableMinify = false)
{
if (count($this->files) === 0) {
return;
}
$this->setHeaders();
$data = '';
foreach ($this->files as $file) {
$filePath = $file['base'] . DIRECTORY_SEPARATOR . $file['name'];
// Obtener el recurso desde una URL
if ($file['type'] === 'url') {
logger('URL:' . $file['name']);
// $data .= '/* URL: ' . $file['name'] . ' */' . PHP_EOL . Util::getDataFromUrl($file['name']);
} else {
if ($file['min'] === true && $disableMinify === false) {
$data .= '/* MINIFIED FILE: ' . $file['name'] . ' */' . PHP_EOL;
if ($this->type === self::FILETYPE_JS) {
$data .= $this->jsCompress(file_get_contents($filePath));
}
} else {
$data .= PHP_EOL . '/* FILE: ' . $file['name'] . ' */' . PHP_EOL . file_get_contents($filePath);
}
}
}
$this->router->response()->body($data);
}
/**
* Sets HTTP headers
*/
protected function setHeaders()
{
$response = $this->router->response();
$headers = $this->router->request()->headers();
$etag = $this->getEtag();
// Devolver código 304 si la versión es la misma y no se solicita refrescar
if ($etag === $headers->get('If-None-Match')
&& !($headers->get('Cache-Control') === 'no-cache'
|| $headers->get('Cache-Control') === 'max-age=0'
|| $headers->get('Pragma') === 'no-cache')
) {
$response->header($_SERVER['SERVER_PROTOCOL'], '304 Not Modified');
$response->send();
exit();
}
$response->header('Etag', $etag);
$response->header('Cache-Control', 'public, max-age={' . self::OFFSET . '}, must-revalidate');
$response->header('Pragma', 'public; maxage={' . self::OFFSET . '}');
$response->header('Expires', gmdate('D, d M Y H:i:s \G\M\T', time() + self::OFFSET));
switch ($this->type) {
case self::FILETYPE_JS;
$response->header('Content-type', 'application/javascript; charset: UTF-8');
break;
case self::FILETYPE_CSS:
$response->header('Content-type', 'text/css; charset: UTF-8');
break;
}
}
/**
* Calcular el hash MD5 de varios archivos.
*
* @return string Con el hash
*/
private function getEtag(): string
{
$md5Sum = '';
foreach ($this->files as $file) {
$md5Sum .= $file['md5'];
}
return md5($md5Sum);
}
/**
* Comprimir código javascript.
*
* @param string $buffer código a comprimir
*
* @return string
*/
private function jsCompress(string $buffer): string
{
$regexReplace = [
'#/\*[^*]*\*+([^/][^*]*\*+)*/#',
'#^[\s\t]*//.*$#m',
'#[\s\t]+$#m',
'#^[\s\t]+#m',
'#\s*//\s.*$#m'
];
return str_replace(["\r\n", "\r", "\n", "\t"], '', preg_replace($regexReplace, '', $buffer));
}
/**
* @param string $files
* @param bool $minify
*
* @return Minify
*/
public function addFilesFromString(string $files, bool $minify = true): Minify
{
if (strrpos($files, ',')) {
$files = explode(',', $files);
foreach ($files as $filename) {
$this->addFile($filename, $minify);
}
} else {
$this->addFile($files, $minify);
}
return $this;
}
/**
* Añadir un archivo
*
* @param string $file
* @param bool $minify Si es necesario reducir
* @param string|null $base
*
* @return $this
*/
public function addFile(
string $file,
bool $minify = true,
?string $base = null
): Minify
{
if ($base === null) {
$base = $this->base;
$filePath = $this->base . DIRECTORY_SEPARATOR . $file;
} else {
$filePath = $base . DIRECTORY_SEPARATOR . $file;
}
if (file_exists($filePath)) {
$this->files[] = [
'type' => 'file',
'base' => $base,
'name' => Request::getSecureAppFile($file, $base),
'min' => $minify === true && $this->needsMinify($file),
'md5' => md5_file($filePath)
];
} else {
logger('File not found: ' . $filePath);
}
return $this;
}
/**
* Comprobar si es necesario reducir
*
* @param string $file El nombre del archivo
*
* @return bool
*/
private function needsMinify(string $file): bool
{
return !preg_match('/\.min|pack\.css|js/', $file);
}
/**
* @param array $files
* @param bool $minify
*
* @return Minify
*/
public function addFiles(array $files, bool $minify = true): Minify
{
foreach ($files as $filename) {
$this->processFile($filename, $minify);
}
return $this;
}
/**
* @param string $file
* @param bool $minify
*/
protected function processFile(string $file, bool $minify = true)
{
$filePath = $this->base . DIRECTORY_SEPARATOR . $file;
if (file_exists($filePath)) {
$this->files[] = array(
'type' => 'file',
'base' => $this->base,
'name' => Request::getSecureAppFile($file, $this->base),
'min' => $minify === true && $this->needsMinify($file),
'md5' => md5_file($filePath)
);
} else {
logger('File not found: ' . $filePath);
}
}
/**
* Añadir un recurso desde URL
*
* @param string $url
*
* @return $this
*/
public function addUrl(string $url): Minify
{
$this->files[] = array(
'type' => 'url',
'base' => $this->base,
'name' => $url,
'min' => false,
'md5' => ''
);
return $this;
}
/**
* Establecer el tipo de recurso a procesar
*
* @param int $type
*
* @return $this
*/
public function setType(int $type): Minify
{
$this->type = (int)$type;
return $this;
}
}