You are here

class JavaScriptPacker in Advanced CSS/JS Aggregation 6

Same name and namespace in other branches
  1. 8.4 advagg_js_minify/jspacker.inc \JavaScriptPacker
  2. 8.2 advagg_js_minify/jspacker.inc \JavaScriptPacker
  3. 8.3 advagg_js_minify/jspacker.inc \JavaScriptPacker
  4. 7.2 advagg_js_compress/jspacker.inc \JavaScriptPacker
  5. 7 advagg_js_compress/jspacker.inc \JavaScriptPacker

Hierarchy

Expanded class hierarchy of JavaScriptPacker

File

advagg_js_compress/jspacker.inc, line 69

View source
class JavaScriptPacker {

  // constants
  const IGNORE = '$1';

  // validate parameters
  private $_script = '';
  private $_encoding = 62;
  private $_fastDecode = true;
  private $_specialChars = false;
  private $LITERAL_ENCODING = array(
    'None' => 0,
    'Numeric' => 10,
    'Normal' => 62,
    'High ASCII' => 95,
  );
  public function __construct($_script, $_encoding = 62, $_fastDecode = true, $_specialChars = false) {
    $this->_script = $_script . "\n";
    if (array_key_exists($_encoding, $this->LITERAL_ENCODING)) {
      $_encoding = $this->LITERAL_ENCODING[$_encoding];
    }
    $this->_encoding = min((int) $_encoding, 95);
    $this->_fastDecode = $_fastDecode;
    $this->_specialChars = $_specialChars;
  }
  public function pack() {
    $this
      ->_addParser('_basicCompression');
    if ($this->_specialChars) {
      $this
        ->_addParser('_encodeSpecialChars');
    }
    if ($this->_encoding) {
      $this
        ->_addParser('_encodeKeywords');
    }

    // go!
    return $this
      ->_pack($this->_script);
  }

  // apply all parsing routines
  private function _pack($script) {
    for ($i = 0; isset($this->_parsers[$i]); $i++) {
      $script = call_user_func(array(
        &$this,
        $this->_parsers[$i],
      ), $script);
    }
    return $script;
  }

  // keep a list of parsing functions, they'll be executed all at once
  private $_parsers = array();
  private function _addParser($parser) {
    $this->_parsers[] = $parser;
  }

  // zero encoding - just removal of white space and comments
  private function _basicCompression($script) {
    $parser = new ParseMaster();

    // make safe
    $parser->escapeChar = '\\';

    // protect strings
    $parser
      ->add('/\'[^\'\\n\\r]*\'/', self::IGNORE);
    $parser
      ->add('/"[^"\\n\\r]*"/', self::IGNORE);

    // remove comments
    $parser
      ->add('/\\/\\/[^\\n\\r]*[\\n\\r]/', ' ');
    $parser
      ->add('/\\/\\*[^*]*\\*+([^\\/][^*]*\\*+)*\\//', ' ');

    // protect regular expressions
    $parser
      ->add('/\\s+(\\/[^\\/\\n\\r\\*][^\\/\\n\\r]*\\/g?i?)/', '$2');

    // IGNORE
    $parser
      ->add('/[^\\w\\x24\\/\'"*)\\?:]\\/[^\\/\\n\\r\\*][^\\/\\n\\r]*\\/g?i?/', self::IGNORE);

    // remove: ;;; doSomething();
    if ($this->_specialChars) {
      $parser
        ->add('/;;;[^\\n\\r]+[\\n\\r]/');
    }

    // remove redundant semi-colons
    $parser
      ->add('/\\(;;\\)/', self::IGNORE);

    // protect for (;;) loops
    $parser
      ->add('/;+\\s*([};])/', '$2');

    // apply the above
    $script = $parser
      ->exec($script);

    // remove white-space
    $parser
      ->add('/(\\b|\\x24)\\s+(\\b|\\x24)/', '$2 $3');
    $parser
      ->add('/([+\\-])\\s+([+\\-])/', '$2 $3');
    $parser
      ->add('/\\s+/', '');

    // done
    return $parser
      ->exec($script);
  }
  private function _encodeSpecialChars($script) {
    $parser = new ParseMaster();

    // replace: $name -> n, $$name -> na
    $parser
      ->add('/((\\x24+)([a-zA-Z$_]+))(\\d*)/', array(
      'fn' => '_replace_name',
    ));

    // replace: _name -> _0, double-underscore (__name) is ignored
    $regexp = '/\\b_[A-Za-z\\d]\\w*/';

    // build the word list
    $keywords = $this
      ->_analyze($script, $regexp, '_encodePrivate');

    // quick ref
    $encoded = $keywords['encoded'];
    $parser
      ->add($regexp, array(
      'fn' => '_replace_encoded',
      'data' => $encoded,
    ));
    return $parser
      ->exec($script);
  }
  private function _encodeKeywords($script) {

    // escape high-ascii values already in the script (i.e. in strings)
    if ($this->_encoding > 62) {
      $script = $this
        ->_escape95($script);
    }

    // create the parser
    $parser = new ParseMaster();
    $encode = $this
      ->_getEncoder($this->_encoding);

    // for high-ascii, don't encode single character low-ascii
    $regexp = $this->_encoding > 62 ? '/\\w\\w+/' : '/\\w+/';

    // build the word list
    $keywords = $this
      ->_analyze($script, $regexp, $encode);
    $encoded = $keywords['encoded'];

    // encode
    $parser
      ->add($regexp, array(
      'fn' => '_replace_encoded',
      'data' => $encoded,
    ));
    if (empty($script)) {
      return $script;
    }
    else {

      //$res = $parser->exec($script);

      //$res = $this->_bootStrap($res, $keywords);

      //return $res;
      return $this
        ->_bootStrap($parser
        ->exec($script), $keywords);
    }
  }
  private function _analyze($script, $regexp, $encode) {

    // analyse
    // retreive all words in the script
    $all = array();
    preg_match_all($regexp, $script, $all);
    $_sorted = array();

    // list of words sorted by frequency
    $_encoded = array();

    // dictionary of word->encoding
    $_protected = array();

    // instances of "protected" words
    $all = $all[0];

    // simulate the javascript comportement of global match
    if (!empty($all)) {
      $unsorted = array();

      // same list, not sorted
      $protected = array();

      // "protected" words (dictionary of word->"word")
      $value = array();

      // dictionary of charCode->encoding (eg. 256->ff)
      $this->_count = array();

      // word->count
      $i = count($all);
      $j = 0;

      //$word = null;

      // count the occurrences - used for sorting later
      do {
        --$i;
        $word = '$' . $all[$i];
        if (!isset($this->_count[$word])) {
          $this->_count[$word] = 0;
          $unsorted[$j] = $word;

          // make a dictionary of all of the protected words in this script
          //  these are words that might be mistaken for encoding

          //if (is_string($encode) && method_exists($this, $encode))
          $values[$j] = call_user_func(array(
            &$this,
            $encode,
          ), $j);
          $protected['$' . $values[$j]] = $j++;
        }

        // increment the word counter
        $this->_count[$word]++;
      } while ($i > 0);

      // prepare to sort the word list, first we must protect
      //  words that are also used as codes. we assign them a code
      //  equivalent to the word itself.
      // e.g. if "do" falls within our encoding range
      //      then we store keywords["do"] = "do";
      // this avoids problems when decoding
      $i = count($unsorted);
      do {
        $word = $unsorted[--$i];
        if (isset($protected[$word])) {
          $_sorted[$protected[$word]] = substr($word, 1);
          $_protected[$protected[$word]] = true;
          $this->_count[$word] = 0;
        }
      } while ($i);

      // sort the words by frequency
      // Note: the javascript and php version of sort can be different :
      // in php manual, usort :
      // " If two members compare as equal,
      // their order in the sorted array is undefined."
      // so the final packed script is different of the Dean's javascript version
      // but equivalent.
      // the ECMAscript standard does not guarantee this behaviour,
      // and thus not all browsers (e.g. Mozilla versions dating back to at
      // least 2003) respect this.
      usort($unsorted, array(
        &$this,
        '_sortWords',
      ));
      $j = 0;

      // because there are "protected" words in the list
      //  we must add the sorted words around them
      do {
        if (!isset($_sorted[$i])) {
          $_sorted[$i] = substr($unsorted[$j++], 1);
        }
        $_encoded[$_sorted[$i]] = $values[$i];
      } while (++$i < count($unsorted));
    }
    return array(
      'sorted' => $_sorted,
      'encoded' => $_encoded,
      'protected' => $_protected,
    );
  }
  private $_count = array();
  private function _sortWords($match1, $match2) {
    return $this->_count[$match2] - $this->_count[$match1];
  }

  // build the boot function used for loading and decoding
  private function _bootStrap($packed, $keywords) {
    $ENCODE = $this
      ->_safeRegExp('$encode\\($count\\)');

    // $packed: the packed script
    $packed = "'" . $this
      ->_escape($packed) . "'";

    // $ascii: base for encoding
    $ascii = min(count($keywords['sorted']), $this->_encoding);
    if ($ascii == 0) {
      $ascii = 1;
    }

    // $count: number of words contained in the script
    $count = count($keywords['sorted']);

    // $keywords: list of words contained in the script
    foreach ($keywords['protected'] as $i => $value) {
      $keywords['sorted'][$i] = '';
    }

    // convert from a string to an array
    ksort($keywords['sorted']);
    $keywords = "'" . implode('|', $keywords['sorted']) . "'.split('|')";
    $encode = $this->_encoding > 62 ? '_encode95' : $this
      ->_getEncoder($ascii);
    $encode = $this
      ->_getJSFunction($encode);
    $encode = preg_replace('/_encoding/', '$ascii', $encode);
    $encode = preg_replace('/arguments\\.callee/', '$encode', $encode);
    $inline = '\\$count' . ($ascii > 10 ? '.toString(\\$ascii)' : '');

    // $decode: code snippet to speed up decoding
    if ($this->_fastDecode) {

      // create the decoder
      $decode = $this
        ->_getJSFunction('_decodeBody');
      if ($this->_encoding > 62) {
        $decode = preg_replace('/\\\\w/', '[\\xa1-\\xff]', $decode);
      }
      elseif ($ascii < 36) {
        $decode = preg_replace($ENCODE, $inline, $decode);
      }

      // special case: when $count==0 there are no keywords. I want to keep
      //  the basic shape of the unpacking funcion so i'll frig the code...
      if ($count == 0) {
        $decode = preg_replace($this
          ->_safeRegExp('($count)\\s*=\\s*1'), '$1=0', $decode, 1);
      }
    }

    // boot function
    $unpack = $this
      ->_getJSFunction('_unpack');
    if ($this->_fastDecode) {

      // insert the decoder
      $this->buffer = $decode;
      $unpack = preg_replace_callback('/\\{/', array(
        &$this,
        '_insertFastDecode',
      ), $unpack, 1);
    }
    $unpack = preg_replace('/"/', "'", $unpack);
    if ($this->_encoding > 62) {

      // high-ascii
      // get rid of the word-boundaries for regexp matches
      $unpack = preg_replace('/\'\\\\\\\\b\'\\s*\\+|\\+\\s*\'\\\\\\\\b\'/', '', $unpack);
    }
    if ($ascii > 36 || $this->_encoding > 62 || $this->_fastDecode) {

      // insert the encode function
      $this->buffer = $encode;
      $unpack = preg_replace_callback('/\\{/', array(
        &$this,
        '_insertFastEncode',
      ), $unpack, 1);
    }
    else {

      // perform the encoding inline
      $unpack = preg_replace($ENCODE, $inline, $unpack);
    }

    // pack the boot function too
    $unpackPacker = new JavaScriptPacker($unpack, 0, false, true);
    $unpack = $unpackPacker
      ->pack();

    // arguments
    $params = array(
      $packed,
      $ascii,
      $count,
      $keywords,
    );
    if ($this->_fastDecode) {
      $params[] = 0;
      $params[] = '{}';
    }
    $params = implode(',', $params);

    // the whole thing
    return 'eval(' . $unpack . '(' . $params . "))\n";
  }
  private $buffer;
  private function _insertFastDecode($match) {
    return '{' . $this->buffer . ';';
  }
  private function _insertFastEncode($match) {
    return '{$encode=' . $this->buffer . ';';
  }

  // mmm.. ..which one do i need ??
  private function _getEncoder($ascii) {
    return $ascii > 10 ? $ascii > 36 ? $ascii > 62 ? '_encode95' : '_encode62' : '_encode36' : '_encode10';
  }

  // zero encoding
  // characters: 0123456789
  private function _encode10($charCode) {
    return $charCode;
  }

  // inherent base36 support
  // characters: 0123456789abcdefghijklmnopqrstuvwxyz
  private function _encode36($charCode) {
    return base_convert($charCode, 10, 36);
  }

  // hitch a ride on base36 and add the upper case alpha characters
  // characters: 0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ
  private function _encode62($charCode) {
    $res = '';
    if ($charCode >= $this->_encoding) {
      $res = $this
        ->_encode62((int) ($charCode / $this->_encoding));
    }
    $charCode = $charCode % $this->_encoding;
    if ($charCode > 35) {
      return $res . chr($charCode + 29);
    }
    else {
      return $res . base_convert($charCode, 10, 36);
    }
  }

  // use high-ascii values
  // characters: ¡¢£¤¥¦§¨©ª«¬­®¯°±²³´µ¶·¸¹º»¼½¾¿ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖ×ØÙÚÛÜÝÞßàáâãäåæçèéêëìíîïðñòóôõö÷øùúûüýþ
  private function _encode95($charCode) {
    $res = '';
    if ($charCode >= $this->_encoding) {
      $res = $this
        ->_encode95($charCode / $this->_encoding);
    }
    return $res . chr($charCode % $this->_encoding + 161);
  }
  private function _safeRegExp($string) {
    return '/' . preg_replace('/\\$/', '\\\\$', $string) . '/';
  }
  private function _encodePrivate($charCode) {
    return "_" . $charCode;
  }

  // protect characters used by the parser
  private function _escape($script) {
    return preg_replace('/([\\\\\'])/', '\\\\$1', $script);
  }

  // protect high-ascii characters already in the script
  private function _escape95($script) {
    return preg_replace_callback('/[\\xa1-\\xff]/', array(
      &$this,
      '_escape95Bis',
    ), $script);
  }
  private function _escape95Bis($match) {
    return '\\x' . (string) dechex(ord($match));
  }
  private function _getJSFunction($aName) {
    if (defined('self::JSFUNCTION' . $aName)) {
      return constant('self::JSFUNCTION' . $aName);
    }
    else {
      return '';
    }
  }

  // JavaScript Functions used.
  // Note : In Dean's version, these functions are converted
  // with 'String(aFunctionName);'.
  // This internal conversion complete the original code, ex :
  // 'while (aBool) anAction();' is converted to
  // 'while (aBool) { anAction(); }'.
  // The JavaScript functions below are corrected.
  // unpacking function - this is the boot strap function
  //  data extracted from this packing routine is passed to
  //  this function when decoded in the target
  // NOTE ! : without the ';' final.
  const JSFUNCTION_unpack = 'function($packed, $ascii, $count, $keywords, $encode, $decode) {
    while ($count--) {
        if ($keywords[$count]) {
            $packed = $packed.replace(new RegExp(\'\\\\b\' + $encode($count) + \'\\\\b\', \'g\'), $keywords[$count]);
        }
    }
    return $packed;
}';

  /*
  'function($packed, $ascii, $count, $keywords, $encode, $decode) {
  while ($count--)
  if ($keywords[$count])
  $packed = $packed.replace(new RegExp(\'\\\\b\' + $encode($count) + \'\\\\b\', \'g\'), $keywords[$count]);
  return $packed;
  }';
  */

  // code-snippet inserted into the unpacker to speed up decoding
  const JSFUNCTION_decodeBody = '    if (!\'\'.replace(/^/, String)) {
        // decode all the values we need
        while ($count--) {
            $decode[$encode($count)] = $keywords[$count] || $encode($count);
        }
        // global replacement function
        $keywords = [function ($encoded) {return $decode[$encoded]}];
        // generic match
        $encode = function () {return \'\\\\w+\'};
        // reset the loop counter -  we are now doing a global replace
        $count = 1;
    }
';

  //};

  /*
  '	if (!\'\'.replace(/^/, String)) {
  // decode all the values we need
  while ($count--) $decode[$encode($count)] = $keywords[$count] || $encode($count);
  // global replacement function
  $keywords = [function ($encoded) {return $decode[$encoded]}];
  // generic match
  $encode = function () {return\'\\\\w+\'};
  // reset the loop counter -  we are now doing a global replace
  $count = 1;
  }';
  */

  // zero encoding
  // characters: 0123456789
  const JSFUNCTION_encode10 = 'function($charCode) {
    return $charCode;
}';

  //;';

  // inherent base36 support
  // characters: 0123456789abcdefghijklmnopqrstuvwxyz
  const JSFUNCTION_encode36 = 'function($charCode) {
    return $charCode.toString(36);
}';

  //;';

  // hitch a ride on base36 and add the upper case alpha characters
  // characters: 0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ
  const JSFUNCTION_encode62 = 'function($charCode) {
    return ($charCode < _encoding ? \'\' : arguments.callee(parseInt($charCode / _encoding))) +
    (($charCode = $charCode % _encoding) > 35 ? String.fromCharCode($charCode + 29) : $charCode.toString(36));
}';

  // use high-ascii values
  // characters: ¡¢£¤¥¦§¨©ª«¬­®¯°±²³´µ¶·¸¹º»¼½¾¿ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖ×ØÙÚÛÜÝÞßàáâãäåæçèéêëìíîïðñòóôõö÷øùúûüýþ
  const JSFUNCTION_encode95 = 'function($charCode) {
    return ($charCode < _encoding ? \'\' : arguments.callee($charCode / _encoding)) +
        String.fromCharCode($charCode % _encoding + 161);
}';

}

Members

Namesort descending Modifiers Type Description Overrides
JavaScriptPacker::$buffer private property
JavaScriptPacker::$LITERAL_ENCODING private property
JavaScriptPacker::$_count private property
JavaScriptPacker::$_encoding private property
JavaScriptPacker::$_fastDecode private property
JavaScriptPacker::$_parsers private property
JavaScriptPacker::$_script private property
JavaScriptPacker::$_specialChars private property
JavaScriptPacker::IGNORE constant
JavaScriptPacker::JSFUNCTION_decodeBody constant
JavaScriptPacker::JSFUNCTION_encode10 constant
JavaScriptPacker::JSFUNCTION_encode36 constant
JavaScriptPacker::JSFUNCTION_encode62 constant
JavaScriptPacker::JSFUNCTION_encode95 constant
JavaScriptPacker::JSFUNCTION_unpack constant
JavaScriptPacker::pack public function
JavaScriptPacker::_addParser private function
JavaScriptPacker::_analyze private function
JavaScriptPacker::_basicCompression private function
JavaScriptPacker::_bootStrap private function
JavaScriptPacker::_encode10 private function
JavaScriptPacker::_encode36 private function
JavaScriptPacker::_encode62 private function
JavaScriptPacker::_encode95 private function
JavaScriptPacker::_encodeKeywords private function
JavaScriptPacker::_encodePrivate private function
JavaScriptPacker::_encodeSpecialChars private function
JavaScriptPacker::_escape private function
JavaScriptPacker::_escape95 private function
JavaScriptPacker::_escape95Bis private function
JavaScriptPacker::_getEncoder private function
JavaScriptPacker::_getJSFunction private function
JavaScriptPacker::_insertFastDecode private function
JavaScriptPacker::_insertFastEncode private function
JavaScriptPacker::_pack private function
JavaScriptPacker::_safeRegExp private function
JavaScriptPacker::_sortWords private function
JavaScriptPacker::__construct public function