Browse Source

optimize startup, minify JS files, etc

Andrew Dolgov 7 years ago
parent
commit
3dd99a4383
8 changed files with 614 additions and 65 deletions
  1. 1 0
      .gitignore
  2. 0 0
      cache/js/.empty
  3. 75 0
      include/functions.php
  4. 23 18
      index.php
  5. 24 0
      lib/jshrink/LICENSE
  6. 470 0
      lib/jshrink/Minifier.php
  7. 21 0
      lib/jshrink/README.md
  8. 0 47
      localized_js.php

+ 1 - 0
.gitignore

@@ -1,3 +1,4 @@
+cache/js/*
 config.php
 messages.pot
 messages.mo

+ 0 - 0
cache/js/.empty


+ 75 - 0
include/functions.php

@@ -1086,4 +1086,79 @@
 		return $line;
 	}
 
+	function stylesheet_tag($filename) {
+		$timestamp = filemtime($filename);
+
+		echo "<link rel=\"stylesheet\" type=\"text/css\" href=\"$filename?$timestamp\"/>\n";
+	}
+
+	function javascript_tag($filename) {
+		$query = "";
+
+		if (!(strpos($filename, "?") === FALSE)) {
+			$query = substr($filename, strpos($filename, "?")+1);
+			$filename = substr($filename, 0, strpos($filename, "?"));
+		}
+
+		$timestamp = filemtime($filename);
+
+		if ($query) $timestamp .= "&$query";
+
+		echo "<script type=\"text/javascript\" charset=\"utf-8\" src=\"$filename?$timestamp\"></script>\n";
+	}
+
+	function get_minified_js($files) {
+		require_once 'lib/jshrink/Minifier.php';
+
+		$rv = '';
+
+		foreach ($files as $js) {
+			if (!isset($_GET['debug'])) {
+				$cached_file = "cache/js/$js.js";
+
+				if (file_exists($cached_file) &&
+						is_readable($cached_file) &&
+						filemtime($cached_file) >= filemtime("js/$js.js")) {
+
+					$rv .= file_get_contents($cached_file);
+
+				} else {
+					$minified = JShrink\Minifier::minify(file_get_contents("js/$js.js"));
+					file_put_contents($cached_file, $minified);
+					$rv .= $minified;
+				}
+			} else {
+				$rv .= file_get_contents("js/$js.js");
+			}
+		}
+
+		return $rv;
+	}
+
+	function init_js_translations() {
+
+	print 'var T_messages = new Object();
+
+		function __(msg) {
+			if (T_messages[msg]) {
+				return T_messages[msg];
+			} else {
+				return msg;
+			}
+		}
+
+		function ngettext(msg1, msg2, n) {
+			return (parseInt(n) > 1) ? msg2 : msg1;
+		}';
+
+		$l10n = _get_reader();
+
+		for ($i = 0; $i < $l10n->total; $i++) {
+			$orig = $l10n->get_original_string($i);
+			$translation = __($orig);
+
+			print T_js_decl($orig, $translation);
+		}
+	}
+
 ?>

+ 23 - 18
index.php

@@ -12,38 +12,43 @@
 
 	login_sequence($link);
 
-	$dt_add = get_script_dt_add();
-
 	header('Content-Type: text/html; charset=utf-8');
 
 ?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html>
+<!DOCTYPE html>
 <head>
 	<title>Tiny Tiny IRC</title>
 
-	<link rel="stylesheet" type="text/css" href="tt-irc.css?<?php echo $dt_add ?>"/>
+	<?php stylesheet_tag("tt-irc.css") ?>
 
 	<link id="favicon" rel="shortcut icon" type="image/png" href="images/favicon.png" />
 
 	<link rel="icon" type="image/png" sizes="72x72"
 		href="images/icon-hires.png" />
 
-	<script type="text/javascript" charset="utf-8" src="localized_js.php?<?php echo $dt_add ?>"></script>
-	<script type="text/javascript" src="lib/prototype.js"></script>
-	<script type="text/javascript" src="lib/scriptaculous/scriptaculous.js?load=effects,dragdrop,controls"></script>
-	<script type="text/javascript" src="lib/knockout.js"></script>
+	<?php
+	foreach (array("lib/prototype.js",
+				"lib/scriptaculous/scriptaculous.js?load=effects,dragdrop,controls",
+				"lib/knockout.js") as $jsfile) {
 
-		<script type="text/javascript" charset="utf-8" src="js/tt-irc.js?<?php echo $dt_add ?>"></script>
-		<script type="text/javascript" charset="utf-8" src="js/prefs.js?<?php echo $dt_add ?>"></script>
-	<script type="text/javascript" charset="utf-8" src="js/users.js?<?php echo $dt_add ?>"></script>
-	<script type="text/javascript" charset="utf-8" src="js/functions.js?<?php echo $dt_add ?>"></script>
+		javascript_tag($jsfile);
+	} ?>
 
-	<?php	$user_theme = get_user_theme_path($link);
-		if ($user_theme) { ?>
-			<link rel="stylesheet" type="text/css" href="<?php echo $user_theme ?>/theme.css?<?php echo $dt_add ?>">
-	<?php } ?>
+	<script type="text/javascript">
+	<?php
+		init_js_translations();
+
+		print get_minified_js(array("tt-irc",
+			"functions", "prefs", "users"));
+	?>
+	</script>
+
+	<?php
+	$user_theme = get_user_theme_path($link);
+		if ($user_theme) {
+			stylesheet_tag("$user_theme/theme.css");
+		}
+	?>
 
 	<?php print_user_css($link); ?>
 

+ 24 - 0
lib/jshrink/LICENSE

@@ -0,0 +1,24 @@
+Copyright (c) 2009, Robert Hafner
+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 the Stash Project nor the
+      names of its 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 Robert Hafner 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.

+ 470 - 0
lib/jshrink/Minifier.php

@@ -0,0 +1,470 @@
+<?php
+/**
+ * JShrink
+ *
+ * Copyright (c) 2009-2012, Robert Hafner <[email protected]>.
+ * 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
+ * @author     Robert Hafner <[email protected]>
+ * @copyright  2009-2012 Robert Hafner <[email protected]>
+ * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
+ * @link       https://github.com/tedivm/JShrink
+ * @version    Release: 0.5.1
+ */
+
+ namespace JShrink;
+
+/**
+ * Minifier
+ *
+ * Usage - Minifier::minify($js);
+ * Usage - Minifier::minify($js, $options);
+ * Usage - Minifier::minify($js, array('flaggedComments' => false));
+ *
+ * @package	JShrink
+ * @author	Robert Hafner <[email protected]>
+ * @license	http://www.opensource.org/licenses/bsd-license.php  BSD License
+ */
+class Minifier
+{
+	/**
+	 * The input javascript to be minified.
+	 *
+	 * @var string
+	 */
+	protected $input;
+
+	/**
+	 * The location of the character (in the input string) that is next to be
+     * processed.
+	 *
+	 * @var int
+	 */
+	protected $index = 0;
+
+	/**
+	 * The first of the characters currently being looked at.
+	 *
+	 * @var string
+	 */
+	protected $a = '';
+
+
+	/**
+	 * The next character being looked at (after a);
+	 *
+	 * @var string
+	 */
+	protected $b = '';
+
+	/**
+	 * This character is only active when certain look ahead actions take place.
+	 *
+	 *  @var string
+	 */
+	protected $c;
+
+	/**
+	 * Contains the options for the current minification process.
+	 *
+	 * @var array
+	 */
+	protected $options;
+
+	/**
+	 * Contains the default options for minification. This array is merged with
+     * the one passed in by the user to create the request specific set of
+     * options (stored in the $options attribute).
+	 *
+	 * @var array
+	 */
+	static protected $defaultOptions = array('flaggedComments' => true);
+
+	/**
+	 * Contains a copy of the JShrink object used to run minification. This is
+     * only used internally, and is only stored for performance reasons. There
+     * is no internal data shared between minification requests.
+	 */
+	static protected $jshrink;
+
+	/**
+	 * Minifier::minify takes a string containing javascript and removes
+     * unneeded characters in order to shrink the code without altering it's
+     * functionality.
+	 */
+	static public function minify($js, $options = array())
+	{
+		try{
+			ob_start();
+			$currentOptions = array_merge(self::$defaultOptions, $options);
+
+			if(!isset(self::$jshrink))
+				self::$jshrink = new Minifier();
+
+			self::$jshrink->breakdownScript($js, $currentOptions);
+			return ob_get_clean();
+
+		}catch(Exception $e){
+			if(isset(self::$jshrink))
+				self::$jshrink->clean();
+
+			ob_end_clean();
+			throw $e;
+		}
+	}
+
+	/**
+	 * Processes a javascript string and outputs only the required characters,
+     * stripping out all unneeded characters.
+	 *
+	 * @param string $js The raw javascript to be minified
+	 * @param array $currentOptions Various runtime options in an associative array
+	 */
+	protected function breakdownScript($js, $currentOptions)
+	{
+		// reset work attributes in case this isn't the first run.
+		$this->clean();
+
+		$this->options = $currentOptions;
+
+		$js = str_replace("\r\n", "\n", $js);
+		$this->input = str_replace("\r", "\n", $js);
+
+
+		$this->a = $this->getReal();
+
+		// the only time the length can be higher than 1 is if a conditional
+        // comment needs to be displayed and the only time that can happen for
+        // $a is on the very first run
+		while(strlen($this->a) > 1)
+		{
+			echo $this->a;
+			$this->a = $this->getReal();
+		}
+
+		$this->b = $this->getReal();
+
+		while($this->a !== false && !is_null($this->a) && $this->a !== '')
+		{
+
+			// now we give $b the same check for conditional comments we gave $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
+				case "\n":
+					// if the next line is something that can't stand alone
+                    // preserve the newline
+					if(strpos('(-+{[@', $this->b) !== false)
+					{
+						echo $this->a;
+						$this->saveString();
+						break;
+					}
+
+					// if its a space we move down to the string test below
+					if($this->b === ' ')
+						break;
+
+					// otherwise we treat the newline like a space
+
+				case ' ':
+					if(self::isAlphaNumeric($this->b))
+						echo $this->a;
+
+					$this->saveString();
+					break;
+
+				default:
+					switch($this->b)
+					{
+						case "\n":
+							if(strpos('}])+-"\'', $this->a) !== false)
+							{
+								echo $this->a;
+								$this->saveString();
+								break;
+							}else{
+								if(self::isAlphaNumeric($this->a))
+								{
+									echo $this->a;
+									$this->saveString();
+								}
+							}
+							break;
+
+						case ' ':
+							if(!self::isAlphaNumeric($this->a))
+								break;
+
+						default:
+							// check for some regex that breaks stuff
+							if($this->a == '/' && ($this->b == '\'' || $this->b == '"'))
+							{
+								$this->saveRegex();
+								continue;
+							}
+
+							echo $this->a;
+							$this->saveString();
+							break;
+					}
+			}
+
+			// do reg check of doom
+			$this->b = $this->getReal();
+
+			if(($this->b == '/' && strpos('(,=:[!&|?', $this->a) !== false))
+				$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
+     * the next request is ready to go.
+	 */
+	protected function clean()
+	{
+		unset($this->input);
+		$this->index = 0;
+		$this->a = $this->b = '';
+		unset($this->c);
+		unset($this->options);
+	}
+
+	/**
+	 * Checks to see if a character is alphanumeric.
+	 *
+	 * @return bool
+	 */
+	static protected function isAlphaNumeric($char)
+	{
+		return preg_match('/^[\w\$]$/', $char) === 1 || $char == '/';
+	}
+
+}

+ 21 - 0
lib/jshrink/README.md

@@ -0,0 +1,21 @@
+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-
+
+````
+<?php
+// Basic (default) usage.
+$minifiedCode = JShrink\Minifier::minify($js);
+
+// Disable YUI style comment preservation.
+$minifiedCode = JShrink\Minifier::minify($js, array('flaggedComments' => false));
+````
+
+### Results
+
+* Raw - 586,990
+* Gzip - 151,301
+* JShrink - 371,982
+* JShrink and Gzip - 93,507

+ 0 - 47
localized_js.php

@@ -1,47 +0,0 @@
-<?php
-	define('DISABLE_SESSIONS', true);
-
-	set_include_path(get_include_path() . PATH_SEPARATOR .
-		dirname(__FILE__) ."/include");
-
-	require "functions.php";
-	header("Content-Type: text/plain; charset=UTF-8");
-
-	function T_js_decl($s1, $s2) {
-		if ($s1 && $s2) {
-			$s1 = preg_replace("/\n/", "", $s1);
-			$s2 = preg_replace("/\n/", "", $s2);
-
-			$s1 = preg_replace("/\"/", "\\\"", $s1);
-			$s2 = preg_replace("/\"/", "\\\"", $s2);
-
-			return "T_messages[\"$s1\"] = \"$s2\";\n";
-		}
-	}
-?>
-
-var T_messages = new Object();
-
-function __(msg) {
-	if (T_messages[msg]) {
-		return T_messages[msg];
-	} else {
-		return msg;
-	}
-}
-
-<?php
-
-	if (ENABLE_TRANSLATIONS) {
-
-		$l10n = _get_reader();
-
-		for ($i = 0; $i < $l10n->total; $i++) {
-			$orig = $l10n->get_original_string($i);
-			$translation = __($orig);
-
-			print T_js_decl($orig, $translation);
-		}
-	}
-
-?>