lib: Upgrade JShrink from 0.5.1 to 1.1.0

https://github.com/tedivm/JShrink

Signed-off-by: Anders Kaseorg <andersk@mit.edu>
This commit is contained in:
Anders Kaseorg 2017-01-20 15:18:46 -05:00
parent 8eaad18b8c
commit 22f5fdf810
2 changed files with 538 additions and 381 deletions

View File

@ -1,45 +1,19 @@
<?php <?php
/*
* This file is part of the JShrink package.
*
* (c) Robert Hafner <tedivm@tedivm.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
/** /**
* JShrink * JShrink
* *
* Copyright (c) 2009-2012, Robert Hafner <tedivm@tedivm.com>.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* * Neither the name of Robert Hafner nor the names of his
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
* *
* @package JShrink * @package JShrink
* @author Robert Hafner <tedivm@tedivm.com> * @author Robert Hafner <tedivm@tedivm.com>
* @copyright 2009-2012 Robert Hafner <tedivm@tedivm.com>
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
* @link https://github.com/tedivm/JShrink
* @version Release: 0.5.1
*/ */
namespace JShrink; namespace JShrink;
@ -79,7 +53,6 @@ class Minifier
*/ */
protected $a = ''; protected $a = '';
/** /**
* The next character being looked at (after a); * The next character being looked at (after a);
* *
@ -108,36 +81,51 @@ class Minifier
* *
* @var array * @var array
*/ */
static protected $defaultOptions = array('flaggedComments' => true); protected static $defaultOptions = array('flaggedComments' => true);
/** /**
* Contains a copy of the JShrink object used to run minification. This is * Contains lock ids which are used to replace certain code patterns and
* only used internally, and is only stored for performance reasons. There * prevent them from being minified
* is no internal data shared between minification requests. *
* @var array
*/ */
static protected $jshrink; protected $locks = array();
/** /**
* Minifier::minify takes a string containing javascript and removes * Takes a string containing javascript and removes unneeded characters in
* unneeded characters in order to shrink the code without altering it's * order to shrink the code without altering it's functionality.
* functionality. *
* @param string $js The raw javascript to be minified
* @param array $options Various runtime options in an associative array
* @throws \Exception
* @return bool|string
*/ */
static public function minify($js, $options = array()) public static function minify($js, $options = array())
{ {
try { try {
ob_start(); ob_start();
$currentOptions = array_merge(self::$defaultOptions, $options);
if(!isset(self::$jshrink)) $jshrink = new Minifier();
self::$jshrink = new Minifier(); $js = $jshrink->lock($js);
$jshrink->minifyDirectToOutput($js, $options);
self::$jshrink->breakdownScript($js, $currentOptions); // Sometimes there's a leading new line, so we trim that out here.
return ob_get_clean(); $js = ltrim(ob_get_clean());
$js = $jshrink->unlock($js);
unset($jshrink);
}catch(Exception $e){ return $js;
if(isset(self::$jshrink))
self::$jshrink->clean();
} catch (\Exception $e) {
if (isset($jshrink)) {
// Since the breakdownScript function probably wasn't finished
// we clean it out before discarding it.
$jshrink->clean();
unset($jshrink);
}
// without this call things get weird, with partially outputted js.
ob_end_clean(); ob_end_clean();
throw $e; throw $e;
} }
@ -148,83 +136,80 @@ class Minifier
* stripping out all unneeded characters. * stripping out all unneeded characters.
* *
* @param string $js The raw javascript to be minified * @param string $js The raw javascript to be minified
* @param array $currentOptions Various runtime options in an associative array * @param array $options Various runtime options in an associative array
*/ */
protected function breakdownScript($js, $currentOptions) protected function minifyDirectToOutput($js, $options)
{ {
// reset work attributes in case this isn't the first run. $this->initialize($js, $options);
$this->loop();
$this->clean(); $this->clean();
}
$this->options = $currentOptions; /**
* Initializes internal variables, normalizes new lines,
*
* @param string $js The raw javascript to be minified
* @param array $options Various runtime options in an associative array
*/
protected function initialize($js, $options)
{
$this->options = array_merge(static::$defaultOptions, $options);
$js = str_replace("\r\n", "\n", $js); $js = str_replace("\r\n", "\n", $js);
$js = str_replace('/**/', '', $js);
$this->input = str_replace("\r", "\n", $js); $this->input = str_replace("\r", "\n", $js);
// We add a newline to the end of the script to make it easier to deal
// with comments at the bottom of the script- this prevents the unclosed
// comment error that can otherwise occur.
$this->input .= PHP_EOL;
$this->a = $this->getReal(); // Populate "a" with a new line, "b" with the first character, before
// entering the loop
// the only time the length can be higher than 1 is if a conditional $this->a = "\n";
// comment needs to be displayed and the only time that can happen for $this->b = $this->getReal();
// $a is on the very first run
while(strlen($this->a) > 1)
{
echo $this->a;
$this->a = $this->getReal();
} }
$this->b = $this->getReal(); /**
* The primary action occurs here. This function loops through the input string,
while($this->a !== false && !is_null($this->a) && $this->a !== '') * outputting anything that's relevant and discarding anything that is not.
*/
protected function loop()
{ {
while ($this->a !== false && !is_null($this->a) && $this->a !== '') {
// now we give $b the same check for conditional comments we gave $a switch ($this->a) {
// before we began looping
if(strlen($this->b) > 1)
{
echo $this->a . $this->b;
$this->a = $this->getReal();
$this->b = $this->getReal();
continue;
}
switch($this->a)
{
// new lines // new lines
case "\n": case "\n":
// if the next line is something that can't stand alone // if the next line is something that can't stand alone preserve the newline
// preserve the newline if (strpos('(-+{[@', $this->b) !== false) {
if(strpos('(-+{[@', $this->b) !== false)
{
echo $this->a; echo $this->a;
$this->saveString(); $this->saveString();
break; break;
} }
// if its a space we move down to the string test below // if B is a space we skip the rest of the switch block and go down to the
// string/regex check below, resetting $this->b with getReal
if($this->b === ' ') if($this->b === ' ')
break; break;
// otherwise we treat the newline like a space // otherwise we treat the newline like a space
case ' ': case ' ':
if(self::isAlphaNumeric($this->b)) if(static::isAlphaNumeric($this->b))
echo $this->a; echo $this->a;
$this->saveString(); $this->saveString();
break; break;
default: default:
switch($this->b) switch ($this->b) {
{
case "\n": case "\n":
if(strpos('}])+-"\'', $this->a) !== false) if (strpos('}])+-"\'', $this->a) !== false) {
{
echo $this->a; echo $this->a;
$this->saveString(); $this->saveString();
break; break;
} else { } else {
if(self::isAlphaNumeric($this->a)) if (static::isAlphaNumeric($this->a)) {
{
echo $this->a; echo $this->a;
$this->saveString(); $this->saveString();
} }
@ -232,13 +217,12 @@ class Minifier
break; break;
case ' ': case ' ':
if(!self::isAlphaNumeric($this->a)) if(!static::isAlphaNumeric($this->a))
break; break;
default: default:
// check for some regex that breaks stuff // check for some regex that breaks stuff
if($this->a == '/' && ($this->b == '\'' || $this->b == '"')) if ($this->a === '/' && ($this->b === '\'' || $this->b === '"')) {
{
$this->saveRegex(); $this->saveRegex();
continue; continue;
} }
@ -255,198 +239,12 @@ class Minifier
if(($this->b == '/' && strpos('(,=:[!&|?', $this->a) !== false)) if(($this->b == '/' && strpos('(,=:[!&|?', $this->a) !== false))
$this->saveRegex(); $this->saveRegex();
} }
$this->clean();
}
/**
* Returns the next string for processing based off of the current index.
*
* @return string
*/
protected function getChar()
{
if(isset($this->c))
{
$char = $this->c;
unset($this->c);
}else{
$tchar = substr($this->input, $this->index, 1);
if(isset($tchar) && $tchar !== false)
{
$char = $tchar;
$this->index++;
}else{
return false;
}
}
if($char !== "\n" && ord($char) < 32)
return ' ';
return $char;
}
/**
* This function gets the next "real" character. It is essentially a wrapper
* around the getChar function that skips comments. This has significant
* performance benefits as the skipping is done using native functions (ie,
* c code) rather than in script php.
*
* @return string Next 'real' character to be processed.
*/
protected function getReal()
{
$startIndex = $this->index;
$char = $this->getChar();
if($char == '/')
{
$this->c = $this->getChar();
if($this->c == '/')
{
$thirdCommentString = substr($this->input, $this->index, 1);
// kill rest of line
$char = $this->getNext("\n");
if($thirdCommentString == '@')
{
$endPoint = ($this->index) - $startIndex;
unset($this->c);
$char = "\n" . substr($this->input, $startIndex, $endPoint);
}else{
$char = $this->getChar();
$char = $this->getChar();
}
}elseif($this->c == '*'){
$this->getChar(); // current C
$thirdCommentString = $this->getChar();
if($thirdCommentString == '@')
{
// conditional comment
// we're gonna back up a bit and and send the comment back,
// where the first char will be echoed and the rest will be
// treated like a string
$this->index = $this->index-2;
return '/';
}elseif($this->getNext('*/')){
// kill everything up to the next */
$this->getChar(); // get *
$this->getChar(); // get /
$char = $this->getChar(); // get next real character
// if YUI-style comments are enabled we reinsert it into the stream
if($this->options['flaggedComments'] && $thirdCommentString == '!')
{
$endPoint = ($this->index - 1) - $startIndex;
echo "\n" . substr($this->input, $startIndex, $endPoint) . "\n";
}
}else{
$char = false;
}
if($char === false)
throw new \RuntimeException('Stray comment. ' . $this->index);
// if we're here c is part of the comment and therefore tossed
if(isset($this->c))
unset($this->c);
}
}
return $char;
}
/**
* Pushes the index ahead to the next instance of the supplied string. If it
* is found the first character of the string is returned.
*
* @return string|false Returns the first character of the string or false.
*/
protected function getNext($string)
{
$pos = strpos($this->input, $string, $this->index);
if($pos === false)
return false;
$this->index = $pos;
return substr($this->input, $this->index, 1);
}
/**
* When a javascript string is detected this function crawls for the end of
* it and saves the whole string.
*
*/
protected function saveString()
{
$this->a = $this->b;
if($this->a == "'" || $this->a == '"') // is the character a quote
{
// save literal string
$stringType = $this->a;
while(1)
{
echo $this->a;
$this->a = $this->getChar();
switch($this->a)
{
case $stringType:
break 2;
case "\n":
throw new \RuntimeException('Unclosed string. ' . $this->index);
break;
case '\\':
echo $this->a;
$this->a = $this->getChar();
}
}
}
}
/**
* When a regular expression is detected this funcion crawls for the end of
* it and saves the whole regex.
*/
protected function saveRegex()
{
echo $this->a . $this->b;
while(($this->a = $this->getChar()) !== false)
{
if($this->a == '/')
break;
if($this->a == '\\')
{
echo $this->a;
$this->a = $this->getChar();
}
if($this->a == "\n")
throw new \RuntimeException('Stray regex pattern. ' . $this->index);
echo $this->a;
}
$this->b = $this->getReal();
} }
/** /**
* Resets attributes that do not need to be stored between requests so that * Resets attributes that do not need to be stored between requests so that
* the next request is ready to go. * the next request is ready to go. Another reason for this is to make sure
* the variables are cleared and are not taking up memory.
*/ */
protected function clean() protected function clean()
{ {
@ -457,14 +255,333 @@ class Minifier
unset($this->options); unset($this->options);
} }
/**
* Returns the next string for processing based off of the current index.
*
* @return string
*/
protected function getChar()
{
// Check to see if we had anything in the look ahead buffer and use that.
if (isset($this->c)) {
$char = $this->c;
unset($this->c);
// Otherwise we start pulling from the input.
} else {
$char = substr($this->input, $this->index, 1);
// If the next character doesn't exist return false.
if (isset($char) && $char === false) {
return false;
}
// Otherwise increment the pointer and use this char.
$this->index++;
}
// Normalize all whitespace except for the newline character into a
// standard space.
if($char !== "\n" && ord($char) < 32)
return ' ';
return $char;
}
/**
* This function gets the next "real" character. It is essentially a wrapper
* around the getChar function that skips comments. This has significant
* performance benefits as the skipping is done using native functions (ie,
* c code) rather than in script php.
*
*
* @return string Next 'real' character to be processed.
* @throws \RuntimeException
*/
protected function getReal()
{
$startIndex = $this->index;
$char = $this->getChar();
// Check to see if we're potentially in a comment
if ($char !== '/') {
return $char;
}
$this->c = $this->getChar();
if ($this->c === '/') {
return $this->processOneLineComments($startIndex);
} elseif ($this->c === '*') {
return $this->processMultiLineComments($startIndex);
}
return $char;
}
/**
* Removed one line comments, with the exception of some very specific types of
* conditional comments.
*
* @param int $startIndex The index point where "getReal" function started
* @return string
*/
protected function processOneLineComments($startIndex)
{
$thirdCommentString = substr($this->input, $this->index, 1);
// kill rest of line
$this->getNext("\n");
if ($thirdCommentString == '@') {
$endPoint = $this->index - $startIndex;
unset($this->c);
$char = "\n" . substr($this->input, $startIndex, $endPoint);
} else {
// first one is contents of $this->c
$this->getChar();
$char = $this->getChar();
}
return $char;
}
/**
* Skips multiline comments where appropriate, and includes them where needed.
* Conditional comments and "license" style blocks are preserved.
*
* @param int $startIndex The index point where "getReal" function started
* @return bool|string False if there's no character
* @throws \RuntimeException Unclosed comments will throw an error
*/
protected function processMultiLineComments($startIndex)
{
$this->getChar(); // current C
$thirdCommentString = $this->getChar();
// kill everything up to the next */ if it's there
if ($this->getNext('*/')) {
$this->getChar(); // get *
$this->getChar(); // get /
$char = $this->getChar(); // get next real character
// Now we reinsert conditional comments and YUI-style licensing comments
if (($this->options['flaggedComments'] && $thirdCommentString === '!')
|| ($thirdCommentString === '@') ) {
// If conditional comments or flagged comments are not the first thing in the script
// we need to echo a and fill it with a space before moving on.
if ($startIndex > 0) {
echo $this->a;
$this->a = " ";
// If the comment started on a new line we let it stay on the new line
if ($this->input[($startIndex - 1)] === "\n") {
echo "\n";
}
}
$endPoint = ($this->index - 1) - $startIndex;
echo substr($this->input, $startIndex, $endPoint);
return $char;
}
} else {
$char = false;
}
if($char === false)
throw new \RuntimeException('Unclosed multiline comment at position: ' . ($this->index - 2));
// if we're here c is part of the comment and therefore tossed
if(isset($this->c))
unset($this->c);
return $char;
}
/**
* Pushes the index ahead to the next instance of the supplied string. If it
* is found the first character of the string is returned and the index is set
* to it's position.
*
* @param string $string
* @return string|false Returns the first character of the string or false.
*/
protected function getNext($string)
{
// Find the next occurrence of "string" after the current position.
$pos = strpos($this->input, $string, $this->index);
// If it's not there return false.
if($pos === false)
return false;
// Adjust position of index to jump ahead to the asked for string
$this->index = $pos;
// Return the first character of that string.
return substr($this->input, $this->index, 1);
}
/**
* When a javascript string is detected this function crawls for the end of
* it and saves the whole string.
*
* @throws \RuntimeException Unclosed strings will throw an error
*/
protected function saveString()
{
$startpos = $this->index;
// saveString is always called after a gets cleared, so we push b into
// that spot.
$this->a = $this->b;
// If this isn't a string we don't need to do anything.
if ($this->a !== "'" && $this->a !== '"') {
return;
}
// String type is the quote used, " or '
$stringType = $this->a;
// Echo out that starting quote
echo $this->a;
// Loop until the string is done
while (true) {
// Grab the very next character and load it into a
$this->a = $this->getChar();
switch ($this->a) {
// If the string opener (single or double quote) is used
// output it and break out of the while loop-
// The string is finished!
case $stringType:
break 2;
// New lines in strings without line delimiters are bad- actual
// new lines will be represented by the string \n and not the actual
// character, so those will be treated just fine using the switch
// block below.
case "\n":
throw new \RuntimeException('Unclosed string at position: ' . $startpos );
break;
// Escaped characters get picked up here. If it's an escaped new line it's not really needed
case '\\':
// a is a slash. We want to keep it, and the next character,
// unless it's a new line. New lines as actual strings will be
// preserved, but escaped new lines should be reduced.
$this->b = $this->getChar();
// If b is a new line we discard a and b and restart the loop.
if ($this->b === "\n") {
break;
}
// echo out the escaped character and restart the loop.
echo $this->a . $this->b;
break;
// Since we're not dealing with any special cases we simply
// output the character and continue our loop.
default:
echo $this->a;
}
}
}
/**
* When a regular expression is detected this function crawls for the end of
* it and saves the whole regex.
*
* @throws \RuntimeException Unclosed regex will throw an error
*/
protected function saveRegex()
{
echo $this->a . $this->b;
while (($this->a = $this->getChar()) !== false) {
if($this->a === '/')
break;
if ($this->a === '\\') {
echo $this->a;
$this->a = $this->getChar();
}
if($this->a === "\n")
throw new \RuntimeException('Unclosed regex pattern at position: ' . $this->index);
echo $this->a;
}
$this->b = $this->getReal();
}
/** /**
* Checks to see if a character is alphanumeric. * Checks to see if a character is alphanumeric.
* *
* @param string $char Just one character
* @return bool * @return bool
*/ */
static protected function isAlphaNumeric($char) protected static function isAlphaNumeric($char)
{ {
return preg_match('/^[\w\$]$/', $char) === 1 || $char == '/'; return preg_match('/^[\w\$\pL]$/', $char) === 1 || $char == '/';
}
/**
* Replace patterns in the given string and store the replacement
*
* @param string $js The string to lock
* @return bool
*/
protected function lock($js)
{
/* lock things like <code>"asd" + ++x;</code> */
$lock = '"LOCK---' . crc32(time()) . '"';
$matches = array();
preg_match('/([+-])(\s+)([+-])/S', $js, $matches);
if (empty($matches)) {
return $js;
}
$this->locks[$lock] = $matches[2];
$js = preg_replace('/([+-])\s+([+-])/S', "$1{$lock}$2", $js);
/* -- */
return $js;
}
/**
* Replace "locks" with the original characters
*
* @param string $js The string to unlock
* @return bool
*/
protected function unlock($js)
{
if (empty($this->locks)) {
return $js;
}
foreach ($this->locks as $lock => $replacement) {
$js = str_replace($lock, $replacement, $js);
}
return $js;
} }
} }

View File

@ -1,21 +1,61 @@
JShrink is a php class that minifies javascript so that it can be delivered to the client quicker. This code can be used by any product looking to minify their javascript on the fly (although caching the results is suggested for performance reasons). Unlike many other products this is not a port into php but a native application, resulting in better performance. # JShrink [![Build Status](https://travis-ci.org/tedious/JShrink.svg?branch=master)](https://travis-ci.org/tedivm/JShrink)
### Usage [![License](http://img.shields.io/packagist/l/tedivm/JShrink.svg)](https://github.com/tedivm/JShrink/blob/master/LICENSE)
[![Latest Stable Version](http://img.shields.io/github/release/tedious/JShrink.svg)](https://packagist.org/packages/tedivm/JShrink)
[![Coverage Status](https://coveralls.io/repos/tedious/JShrink/badge.png?branch=master)](https://coveralls.io/r/tedivm/JShrink?branch=master)
[![Total Downloads](http://img.shields.io/packagist/dt/tedivm/jshrink.svg)](https://packagist.org/packages/tedivm/JShrink)
JShrink is a php class that minifies javascript so that it can be delivered to the client quicker. This code can be used
by any product looking to minify their javascript on the fly (although caching the results is suggested for performance
reasons). Unlike many other products this is not a port into php but a native application, resulting in better
performance.
## Usage
Minifying your code is simple call to a static function- Minifying your code is simple call to a static function-
```` ```php
<?php <?php
include('vendor/autoload.php');
// Basic (default) usage. // Basic (default) usage.
$minifiedCode = JShrink\Minifier::minify($js); $minifiedCode = \JShrink\Minifier::minify($js);
// Disable YUI style comment preservation. // Disable YUI style comment preservation.
$minifiedCode = JShrink\Minifier::minify($js, array('flaggedComments' => false)); $minifiedCode = \JShrink\Minifier::minify($js, array('flaggedComments' => false));
```` ```
### Results
## Results
* Raw - 586,990 * Raw - 586,990
* Gzip - 151,301 * Gzip - 151,301
* JShrink - 371,982 * JShrink - 371,982
* JShrink and Gzip - 93,507 * JShrink and Gzip - 93,507
## Installing
### Composer
Installing JShrink can be done through a variety of methods, although Composer is
recommended.
```yaml
"require": {
"tedivm/jshrink": "~1.0"
}
```
### Github
Releases of JShrink are available on [Github](https://github.com/tedious/JShrink/releases).
## License
JShrink is licensed under the BSD License. See the LICENSE file for details.
In the spirit of open source, use of this library for evil is discouraged but not prohibited.