aviat/Easy-Min
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Convert to a more modern class-based setup

Browse Source
This commit is contained in:
Timothy Warren 2016-02-08 14:49:30 -05:00
parent d056f7fac5
commit 51a118edf6
6 changed files with 562 additions and 308 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
config/config.php
View File

@ -5,13 +5,14 @@
* Simple minification for better website performance * Simple minification for better website performance
* *
* @author Timothy J. Warren * @author Timothy J. Warren
* @copyright Copyright (c) 2012 * @copyright Copyright (c) 2012-2016
* @link https://github.com/aviat4ion/Easy-Min * @link https://git.timshomepage.net/aviat4ion/Easy-Min
* @license http://philsturgeon.co.uk/code/dbad-license * @license http://philsturgeon.co.uk/code/dbad-license
*/ */
// -------------------------------------------------------------------------- // --------------------------------------------------------------------------
return [
/* /*
|-------------------------------------------------------------------------- |--------------------------------------------------------------------------
| Document Root | Document Root
@ -25,7 +26,7 @@
| you will need to add that folder to the document root. | you will need to add that folder to the document root.
| |
*/ */
$document_root = $_SERVER['DOCUMENT_ROOT']; 'document_root' => $_SERVER['DOCUMENT_ROOT'],
/* /*
|-------------------------------------------------------------------------- |--------------------------------------------------------------------------
@ -35,7 +36,7 @@ $document_root = $_SERVER['DOCUMENT_ROOT'];
| The folder where css files exist, in relation to the document root | The folder where css files exist, in relation to the document root
| |
*/ */
$css_root = $document_root. '/css/'; 'css_root' => $document_root. '/css/',
/* /*
|-------------------------------------------------------------------------- |--------------------------------------------------------------------------
@ -45,7 +46,7 @@ $css_root = $document_root. '/css/';
| Path fragment to rewrite in css files | Path fragment to rewrite in css files
| |
*/ */
$path_from = ''; 'path_from' => '',
/* /*
|-------------------------------------------------------------------------- |--------------------------------------------------------------------------
@ -55,7 +56,17 @@ $path_from = '';
| The path fragment replacement for the css files | The path fragment replacement for the css files
| |
*/ */
$path_to = ''; 'path_to' => '',
/*
|--------------------------------------------------------------------------
| CSS Groups file
|--------------------------------------------------------------------------
|
| The file where the css groups are configured
|
*/
'css_groups_file' => realpath(__DIR__ . '/css_groups.php'),
/* /*
|-------------------------------------------------------------------------- |--------------------------------------------------------------------------
@ -65,4 +76,16 @@ $path_to = '';
| The folder where javascript files exist, in relation to the document root | The folder where javascript files exist, in relation to the document root
| |
*/ */
$js_root = $document_root. '/js/'; 'js_root' => $document_root. '/js/',
/*
|--------------------------------------------------------------------------
| JS Groups file
|--------------------------------------------------------------------------
|
| The file where the javascript groups are configured
|
*/
'js_groups_file' => realpath(__DIR__ . '/js_groups.php'),
];

8
config/css_groups.php
View File

@ -15,7 +15,7 @@
/** /**
* This is the config array for css files to concatenate and minify * This is the config array for css files to concatenate and minify
*/ */
return array( return [
/*----- /*-----
Css Css
-----*/ -----*/
@ -23,10 +23,10 @@ return array(
/* /*
For each group create an array like so For each group create an array like so
'my_group' => array( 'my_group' => [
'path/to/css/file1.css', 'path/to/css/file1.css',
'path/to/css/file2.css' 'path/to/css/file2.css'
), ],
*/ */
); ];
// End of css_groups.php // End of css_groups.php

8
config/js_groups.php
View File

@ -15,15 +15,15 @@
/** /**
* This is the config array for javascript files to concatenate and minify * This is the config array for javascript files to concatenate and minify
*/ */
return array( return [
/* /*
For each group create an array like so For each group create an array like so
'my_group' => array( 'my_group' => [
'path/to/js/file1.js', 'path/to/js/file1.js',
'path/to/js/file2.js' 'path/to/js/file2.js'
), ],
*/ */
); ];
// End of js_groups.php // End of js_groups.php

167
css.php
View File

@ -5,26 +5,67 @@
* Simple minification for better website performance * Simple minification for better website performance
* *
* @author Timothy J. Warren * @author Timothy J. Warren
* @copyright Copyright (c) 2012 * @copyright Copyright (c) 2012-2016
* @link https://github.com/aviat4ion/Easy-Min * @link https://git.timshomepage.net/aviat4ion/Easy-Min
* @license http://philsturgeon.co.uk/code/dbad-license * @license http://philsturgeon.co.uk/code/dbad-license
*/ */
// -------------------------------------------------------------------------- // --------------------------------------------------------------------------
namespace Aviat\EasyMin;
//Get config files require_once('./min.php');
require('./config/config.php');
//Include the css groups /**
$groups = require("./config/css_groups.php"); * Simple CSS Minifier
*/
class CSSMin extends BaseMin {
//The name of this file protected $css_root;
$this_file = 'css.php'; protected $path_from;
protected $path_to;
protected $group;
protected $last_modified;
protected $requested_time;
public function __construct(array $config, array $groups)
{
$group = $_GET['g'];
$this->css_root = $config['css_root'];
$this->path_from = $config['path_from'];
$this->path_to = $config['path_to'];
$this->group = $groups[$group];
$this->last_modified = $this->get_last_modified();
//Function for compressing the CSS as tightly as possible $this->send();
function compress($buffer) { }
/**
* Send the CSS
*
* @return void
*/
protected function send()
{
if($this->last_modified >= $this->get_if_modified() && $this->is_not_debug())
{
throw new FileNotChangedException();
}
$css = ( ! array_key_exists('debug', $_GET))
? $this->compress($this->get_css())
: $this->get_css();
$this->output($css);
}
/**
* Function for compressing the CSS as tightly as possible
*
* @param string $buffer
* @return string
*/
protected function compress($buffer)
{
//Remove CSS comments //Remove CSS comments
$buffer = preg_replace('!/\*[^*]*\*+([^/][^*]*\*+)*/!', '', $buffer); $buffer = preg_replace('!/\*[^*]*\*+([^/][^*]*\*+)*/!', '', $buffer);
@ -50,79 +91,87 @@ function compress($buffer) {
return $buffer; return $buffer;
} }
// -------------------------------------------------------------------------- /**
* Get the most recent file modification date
//Creative rewriting *
$pi = $_SERVER['PATH_INFO']; * @return int
$pia = explode('/', $pi); */
protected function get_last_modified()
$pia_len = count($pia);
$i = 1;
while($i < $pia_len)
{ {
$j = $i+1;
$j = (isset($pia[$j])) ? $j : $i;
$_GET[$pia[$i]] = $pia[$j];
$i = $j + 1;
};
// --------------------------------------------------------------------------
$css = '';
$modified = array(); $modified = array();
// Get all the css files, and concatenate them together // Get all the css files, and concatenate them together
if(isset($groups[$_GET['g']])) if(isset($this->group))
{ {
foreach($groups[$_GET['g']] as $file) foreach($this->group as $file)
{ {
$new_file = realpath($css_root.$file); $new_file = realpath("{$this->css_root}{$file}");
$css .= file_get_contents($new_file);
$modified[] = filemtime($new_file); $modified[] = filemtime($new_file);
} }
} }
//Add this page for last modified check //Add this page for last modified check
$modified[] = filemtime($this_file); $modified[] = filemtime(__FILE__);
//Get the latest modified date //Get the latest modified date
rsort($modified); rsort($modified);
$last_modified = $modified[0];
// If not in debug mode, minify the css return array_shift($modified);
if( ! isset($_GET['debug'])) }
/**
* Get the css to display
*
* @return string
*/
protected function get_css()
{ {
$css = compress($css); $css = '';
foreach($this->group as $file)
{
$new_file = realpath("{$this->css_root}{$file}");
$css .= file_get_contents($new_file);
} }
// Correct paths that have changed due to concatenation // Correct paths that have changed due to concatenation
// based on rules in the config file // based on rules in the config file
$css = strtr($css, $path_from, $path_to); $css = str_replace($this->path_from, $this->path_to, $css);
$requested_time=(isset($_SERVER['HTTP_IF_MODIFIED_SINCE'])) return $css;
? strtotime($_SERVER['HTTP_IF_MODIFIED_SINCE'])
: time();
// Send 304 when not modified for faster response
if($last_modified === $requested_time)
{
header("HTTP/1.1 304 Not Modified");
exit();
} }
//This GZIPs the CSS for transmission to the user /**
//making file size smaller and transfer rate quicker * Output the CSS
ob_start("ob_gzhandler"); *
* @return void
*/
protected function output($css)
{
$this->send_final_output($css, 'text/css', $this->last_modified);
}
}
header("Content-Type: text/css; charset=utf8"); // --------------------------------------------------------------------------
header("Cache-control: public, max-age=691200, must-revalidate"); // ! Start Minifying
header("Last-Modified: ".gmdate('D, d M Y H:i:s', $last_modified)." GMT"); // --------------------------------------------------------------------------
header("Expires: ".gmdate('D, d M Y H:i:s', (filemtime($this_file) + 691200))." GMT");
echo $css; //Get config files
$config = require('config/config.php');
$groups = require($config['css_groups_file']);
if ( ! array_key_exists($_GET['g'], $groups))
{
throw new InvalidArgumentException('You must specify a css group that exists');
}
try
{
new CSSMin($config, $groups);
}
catch (FileNotChangedException $e)
{
BaseMin::send304();
}
ob_end_flush();
//End of css.php //End of css.php

313
js.php
View File

@ -5,178 +5,243 @@
* Simple minification for better website performance * Simple minification for better website performance
* *
* @author Timothy J. Warren * @author Timothy J. Warren
* @copyright Copyright (c) 2012 * @copyright Copyright (c) 2012-2016
* @link https://github.com/aviat4ion/Easy-Min * @link https://git.timshomepage.net/aviat4ion/Easy-Min
* @license http://philsturgeon.co.uk/code/dbad-license * @license http://philsturgeon.co.uk/code/dbad-license
*/ */
// -------------------------------------------------------------------------- // --------------------------------------------------------------------------
//Get config files namespace Aviat\EasyMin;
require('./config/config.php');
//Include the js groups use GuzzleHttp\Client;
$groups_file = "./config/js_groups.php"; use GuzzleHttp\Psr7\Request;
$groups = require($groups_file);
//The name of this file // Include guzzle
$this_file = 'js.php'; require_once('../vendor/autoload.php');
require_once('./min.php');
// -------------------------------------------------------------------------- /**
* Simple Javascript minfier, using google closure compiler
*/
class JSMin extends BaseMin {
protected $js_root;
protected $js_group;
protected $js_groups_file;
protected $cache_file;
protected $last_modified;
protected $requested_time;
protected $cache_modified;
public function __construct(array $config, array $groups)
{
$group = $_GET['g'];
$this->js_root = $config['js_root'];
$this->js_group = $groups[$group];
$this->js_groups_file = $config['js_groups_file'];
$this->cache_file = "{$this->js_root}cache/{$group}";
$this->last_modified = $this->get_last_modified();
$this->cache_modified = (is_file($this->cache_file))
? filemtime($this->cache_file)
: 0;
// Output some JS!
$this->send();
}
protected function send()
{
// Override caching if debug key is set
if($this->is_debug_call())
{
return $this->output($this->get_files());
}
// If the browser's cached version is up to date,
// don't resend the file
if($this->last_modified == $this->get_if_modified() && $this->is_not_debug())
{
throw new FileNotChangedException();
}
if($this->cache_modified < $this->last_modified)
{
$js = $this->minify($this->get_files());
//Make sure cache file gets created/updated
if (file_put_contents($this->cache_file, $js) === FALSE)
{
echo 'Cache file was not created. Make sure you have the correct folder permissions.';
return;
}
return $this->output($js);
}
else
{
return $this->output(file_get_contents($this->cache_file));
}
}
/**
* Makes a call to google closure compiler service
*
* @param array $options - Form parameters
* @return object
*/
protected function closure_call(array $options)
{
$client = new Client();
$response = $client->post('http://closure-compiler.appspot.com/compile', [
'headers' => [
'Accept-Encoding' => 'gzip',
'Content-type' => 'application/x-www-form-urlencoded'
],
'form_params' => $options
]);
return $response;
}
/**
* Do a call to the closure compiler to check for compilation errors
*
* @param array $options
* @return void
*/
protected function check_minify_errors($options)
{
$error_res = $this->closure_call($options);
$error_json = $error_res->getBody();
$error_obj = json_decode($error_json) ?: (object)[];
// Show error if exists
if ( ! empty($error_obj->errors) || ! empty($error_obj->serverErrors))
{
$error_json = json_encode($error_obj, JSON_PRETTY_PRINT);
header('Content-type: application/javascript');
echo "console.error(${error_json});";
die();
}
}
/** /**
* Get Files * Get Files
* *
* Concatenates the javascript files for the current * Concatenates the javascript files for the current
* group as a string * group as a string
*
* @return string * @return string
*/ */
function get_files() protected function get_files()
{ {
global $groups, $js_root;
$js = ''; $js = '';
foreach($groups[$_GET['g']] as $file) foreach($this->js_group as $file)
{ {
$new_file = realpath($js_root.$file); $new_file = realpath("{$this->js_root}{$file}");
$js .= file_get_contents($new_file); $js .= file_get_contents($new_file) . "\n\n";
} }
return $js; return $js;
} }
// --------------------------------------------------------------------------
/** /**
* Google Min * Get the most recent modified date
* *
* Minifies javascript using google's closure compiler * @return int
* @param string $new_file
* @return string
*/ */
function google_min($new_file) protected function get_last_modified()
{ {
//Get a much-minified version from Google's closure compiler
$ch = curl_init('http://closure-compiler.appspot.com/compile');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'output_info=compiled_code&output_format=text&compilation_level=SIMPLE_OPTIMIZATIONS&js_code=' . urlencode($new_file));
$output = curl_exec($ch);
curl_close($ch);
return $output;
}
// --------------------------------------------------------------------------
//Creative rewriting of /g/groupname to ?g=groupname
$pi = $_SERVER['PATH_INFO'];
$pia = explode('/', $pi);
$pia_len = count($pia);
$i = 1;
while($i < $pia_len)
{
$j = $i+1;
$j = (isset($pia[$j])) ? $j : $i;
$_GET[$pia[$i]] = $pia[$j];
$i = $j + 1;
};
// --------------------------------------------------------------------------
$js = '';
$modified = array(); $modified = array();
// -------------------------------------------------------------------------- foreach($this->js_group as $file)
//Aggregate the last modified times of the files
if(isset($groups[$_GET['g']]))
{ {
$cache_file = $js_root.'cache/'.$_GET['g']; $new_file = realpath("{$this->js_root}{$file}");
foreach($groups[$_GET['g']] as $file)
{
$new_file = realpath($js_root.$file);
$modified[] = filemtime($new_file); $modified[] = filemtime($new_file);
} }
//Add this page too, as well as the groups file //Add this page too, as well as the groups file
$modified[] = filemtime($this_file); $modified[] = filemtime(__FILE__);
$modified[] = filemtime($groups_file); $modified[] = filemtime($this->js_groups_file);
$cache_modified = 0;
//Add the cache file
if(is_file($cache_file))
{
$cache_modified = filemtime($cache_file);
}
}
else //Nothing to display? Just exit
{
die("You must specify a group that exists");
}
// --------------------------------------------------------------------------
//Get the latest modified date
rsort($modified); rsort($modified);
$last_modified = $modified[0]; $last_modified = $modified[0];
$requested_time=(isset($_SERVER['HTTP_IF_MODIFIED_SINCE'])) return $last_modified;
? strtotime($_SERVER['HTTP_IF_MODIFIED_SINCE']) }
: time();
// If the browser's cached version is up to date, /**
// don't resend the file * Minifies javascript using google's closure compiler
if($last_modified === $requested_time) *
* @param string $js
* @return string
*/
protected function minify($js)
{ {
header("HTTP/1.1 304 Not Modified"); $options = [
exit(); 'output_info' => 'errors',
'output_format' => 'json',
'compilation_level' => 'SIMPLE_OPTIMIZATIONS',
//'compilation_level' => 'ADVANCED_OPTIMIZATIONS',
'js_code' => $js,
'language' => 'ECMASCRIPT6_STRICT',
'language_out' => 'ECMASCRIPT5_STRICT'
];
// Check for errors
$this->check_minify_errors($options);
// Now actually retrieve the compiled code
$options['output_info'] = 'compiled_code';
$res = $this->closure_call($options);
$json = $res->getBody();
$obj = json_decode($json);
return $obj->compiledCode;
}
/**
* Output the minified javascript
*
* @param string $js
* @return void
*/
protected function output($js)
{
$this->send_final_output($js, 'application/javascript', $this->last_modified);
}
} }
// -------------------------------------------------------------------------- // --------------------------------------------------------------------------
// ! Start Minifying
//Determine what to do: rebuild cache, send files as is, or send cache.
if($cache_modified < $last_modified)
{
$js = google_min(get_files());
$cs = file_put_contents($cache_file, $js);
//Make sure cache file gets created/updated
if($cs === FALSE)
{
die("Cache file was not created. Make sure you have the correct folder permissions.");
}
}
// If debug is set, just concatenate
else if(isset($_GET['debug']))
{
$js = get_files();
}
// Otherwise, send the cached file
else
{
$js = file_get_contents($cache_file);
}
// -------------------------------------------------------------------------- // --------------------------------------------------------------------------
//This GZIPs the js for transmission to the user $config = require_once('config/config.php');
//making file size smaller and transfer rate quicker $groups = require_once($config['js_groups_file']);
ob_start("ob_gzhandler"); $cache_dir = "{$config['js_root']}cache";
// Set important caching headers if ( ! is_dir($cache_dir))
header("Content-Type: application/javascript; charset=utf8"); {
header("Cache-control: public, max-age=691200, must-revalidate"); mkdir($cache_dir);
header("Last-Modified: ".gmdate('D, d M Y H:i:s', $last_modified)." GMT"); }
header("Expires: ".gmdate('D, d M Y H:i:s', (filemtime($this_file) + 691200))." GMT");
echo $js; if ( ! array_key_exists($_GET['g'], $groups))
{
throw new InvalidArgumentException('You must specify a js group that exists');
}
try
{
new JSMin($config, $groups);
}
catch (FileNotChangedException $e)
{
BaseMin::send304();
}
ob_end_flush();
//end of js.php //end of js.php

117
min.php Normal file
View File

@ -0,0 +1,117 @@
<?php
/**
* Easy Min
*
* Simple minification for better website performance
*
* @author Timothy J. Warren
* @copyright Copyright (c) 2012-2016
* @link https://git.timshomepage.net/aviat4ion/Easy-Min
* @license http://philsturgeon.co.uk/code/dbad-license
*/
// --------------------------------------------------------------------------
namespace Aviat\EasyMin;
//Creative rewriting of /g/groupname to ?g=groupname
$pi = $_SERVER['PATH_INFO'];
$pia = explode('/', $pi);
$pia_len = count($pia);
$i = 1;
while($i < $pia_len)
{
$j = $i+1;
$j = (isset($pia[$j])) ? $j : $i;
$_GET[$pia[$i]] = $pia[$j];
$i = $j + 1;
};
class FileNotChangedException extends \Exception {}
class BaseMin {
/**
* Get value of the if-modified-since header
*
* @return int - timestamp to compare for cache control
*/
protected function get_if_modified()
{
return (array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER))
? strtotime($_SERVER['HTTP_IF_MODIFIED_SINCE'])
: time();
}
/**
* Get value of etag to compare to hash of output
*
* @return string - the etag to compare
*/
protected function get_if_none_match()
{
return (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER))
? $_SERVER['HTTP_IF_NONE_MATCH']
: '';
}
/**
* Determine whether or not to send debug version
*
* @return boolean
*/
protected function is_not_debug()
{
return ! $this->is_debug_call();
}
/**
* Determine whether or not to send debug version
*
* @return boolean
*/
protected function is_debug_call()
{
return array_key_exists('debug', $_GET);
}
/**
* Send actual output to browser
*
* @param string $content - the body of the response
* @param string $mime_type - the content type
* @param int $last_modified - the last modified date
* @return void
*/
protected function send_final_output($content, $mime_type, $last_modified)
{
//This GZIPs the CSS for transmission to the user
//making file size smaller and transfer rate quicker
ob_start("ob_gzhandler");
$expires = $last_modified + 691200;
$last_modified_date = gmdate('D, d M Y H:i:s', $last_modified);
$expires_date = gmdate('D, d M Y H:i:s', $expires);
header("Content-Type: {$mime_type}; charset=utf8");
header("Cache-control: public, max-age=691200, must-revalidate");
header("Last-Modified: {$last_modified_date} GMT");
header("Expires: {$expires_date} GMT");
echo $content;
ob_end_flush();
}
/**
* Send a 304 Not Modified header
*
* @return void
*/
public static function send304()
{
header("status: 304 Not Modified", true, 304);
}
}