├── _config.yml
├── .gitchange
├── .gitmodules
├── src
    ├── includes
    │   ├── stub.php
    │   ├── phar-stub.php
    │   └── classes
    │   │   ├── Benchmark.php
    │   │   └── HookApi.php
    └── .htaccess
├── tests
    ├── .htaccess
    └── test.php
├── .build.props
├── .github
    ├── CONTRIBUTING.md
    └── ISSUE_TEMPLATE.md
├── composer.json
├── .gitignore
├── CHANGELOG.md
├── composer.lock
├── .gitattributes
├── README.md
└── LICENSE.txt


/_config.yml:
--------------------------------------------------------------------------------
1 | theme: jekyll-theme-cayman


--------------------------------------------------------------------------------
/.gitchange:
--------------------------------------------------------------------------------
1 | 1440139757
2 | 853d9120b42cf4f2eabe2f35ea18a6ace7170ea6:58482bb88a66f5.16980470
3 | 


--------------------------------------------------------------------------------
/.gitmodules:
--------------------------------------------------------------------------------
1 | [submodule "phings"]
2 | 	path = phings
3 | 	url = https://github.com/websharks/phings.git
4 | 


--------------------------------------------------------------------------------
/src/includes/stub.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Stub.
 4 |  *
 5 |  * @since 150421 Improving PHAR support.
 6 |  */
 7 | namespace WebSharks\HtmlCompressor;
 8 | 
 9 | require_once dirname(dirname(__FILE__)).'/vendor/autoload.php';
10 | 


--------------------------------------------------------------------------------
/src/includes/phar-stub.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | // @codingStandardsIgnoreFile
 3 | /**
 4 |  * PHAR Stub.
 5 |  *
 6 |  * @since 150421 Improving PHAR support.
 7 |  */
 8 | namespace WebSharks\HtmlCompressor;
 9 | 
10 | \Phar::mapPhar('websharks-html-compressor.phar');
11 | require_once 'phar://websharks-html-compressor.phar/src/includes/stub.php';
12 | __HALT_COMPILER();
13 | 


--------------------------------------------------------------------------------
/src/.htaccess:
--------------------------------------------------------------------------------
 1 | <IfModule authz_core_module>
 2 | 	Require all denied
 3 | </IfModule>
 4 | <IfModule !authz_core_module>
 5 | 	deny from all
 6 | </IfModule>
 7 | 
 8 | <FilesMatch "\.(js|css|gif|jpg|png|svg|eot|woff|ttf|html|txt|md)$">
 9 | 	<IfModule authz_core_module>
10 | 		Require all granted
11 | 	</IfModule>
12 | 	<IfModule !authz_core_module>
13 | 		allow from all
14 | 	</IfModule>
15 | </FilesMatch>
16 | 


--------------------------------------------------------------------------------
/tests/.htaccess:
--------------------------------------------------------------------------------
 1 | <IfModule authz_core_module>
 2 | 	Require all denied
 3 | </IfModule>
 4 | <IfModule !authz_core_module>
 5 | 	deny from all
 6 | </IfModule>
 7 | 
 8 | <FilesMatch "\.(js|css|gif|jpg|png|svg|eot|woff|ttf|html|txt|md)$">
 9 | 	<IfModule authz_core_module>
10 | 		Require all granted
11 | 	</IfModule>
12 | 	<IfModule !authz_core_module>
13 | 		allow from all
14 | 	</IfModule>
15 | </FilesMatch>
16 | 


--------------------------------------------------------------------------------
/.build.props:
--------------------------------------------------------------------------------
 1 | project_title                    = WebSharks HTML Compressor
 2 | 
 3 | project_owner                    = websharks
 4 | project_slug                     = html-compressor
 5 | 
 6 | project_text_domain              = html-compressor
 7 | project_slack_channel            = html-compressor
 8 | 
 9 | project_namespace                = WebSharks\\HtmlCompressor
10 | project_sub_namespace            = HtmlCompressor
11 | 
12 | project_version                  = %y%m%d.%now
13 | 
14 | project_php_required_version     = 5.4
15 | project_php_tested_up_to_version = ${php.version}
16 | 


--------------------------------------------------------------------------------
/.github/CONTRIBUTING.md:
--------------------------------------------------------------------------------
 1 | ## Before Posting an Issue
 2 | 
 3 | - Try to add as much detail as possible. Be specific!
 4 | - If you're requesting a new feature, explain why you'd like it to be added.
 5 | - Search this repository (top of the page) to be sure it has not been fixed or reported already.
 6 | - GitHub issues ARE NOT FOR SUPPORT! If you have questions, please visit the website
 7 |   where you downloaded the software and use an official support channel for customers.
 8 | 
 9 | ## Before You Report a Bug
10 | 
11 | - Use the latest stable release of the software.
12 | - Disable all other components to ensure it's a real bug and not a conflict.
13 | 


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE.md:
--------------------------------------------------------------------------------
 1 | ## EXPLANATION OF THE ISSUE
 2 | 
 3 | <!-- What happens, under which versions, and under what conditions? -->
 4 | 
 5 | ## STEPS TO REPRODUCE THE ISSUE
 6 | 
 7 | <!-- List steps to reproduce the issue so we can replicate. -->
 8 | 
 9 | ## BEHAVIOR THAT I EXPECTED
10 | 
11 | <!-- Following the above steps, what was the behavior you'd expect? -->
12 | 
13 | ## BEHAVIOR THAT I OBSERVED
14 | 
15 | <!-- Following the above steps, what was the observed behavior you did not expect? -->
16 | 
17 | <!-- ---------------
18 | 
19 | BEFORE POSTING AN ISSUE:
20 | 
21 | - These comments won't show up when you submit the issue.
22 | - Try to add as much detail as possible. Be specific!
23 | - If you're requesting a new feature, explain why you'd like it to be added.
24 | - Search this repository (top of the page) to be sure it has not been fixed or reported already.
25 | - GitHub issues ARE NOT FOR SUPPORT! If you have questions, please visit the website
26 |   where you downloaded the software and use an official support channel for customers.
27 | 
28 | BEFORE YOU REPORT A BUG:
29 | 
30 | - Use the latest stable release of the software.
31 | - Disable all other components to ensure it's a real bug and not a conflict.
32 | -------------------------------------------------- -->
33 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "websharks/html-compressor",
 3 |   "homepage": "https://github.com/websharks/html-compressor",
 4 |   "description": "Combines & compresses CSS/JS/HTML code.",
 5 |   "keywords": [
 6 |     "websharks",
 7 |     "html",
 8 |     "compressor"
 9 |   ],
10 |   "type": "library",
11 |   "license": "GPL-3.0+",
12 |   "authors": [{
13 |     "name": "websharks",
14 |     "homepage": "http://websharks-inc.com/",
15 |     "role": "company"
16 |   }, {
17 |     "name": "jaswsinc",
18 |     "homepage": "http://jaswsinc.com/",
19 |     "role": "developer"
20 |   }, {
21 |     "name": "raamdev",
22 |     "homepage": "http://raam.org/",
23 |     "role": "developer"
24 |   }],
25 |   "support": {
26 |     "source": "https://github.com/websharks/html-compressor",
27 |     "issues": "https://github.com/websharks/html-compressor/issues"
28 |   },
29 | 
30 |   "require": {
31 |     "php": ">=5.4",
32 |     "ext-openssl": "*",
33 |     "ext-curl": "*",
34 |     "ext-mbstring": "*",
35 |     "websharks/js-minifier": "dev-master",
36 |     "websharks/css-minifier": "dev-master"
37 |   },
38 |   "minimum-stability": "dev",
39 |   "prefer-stable": true,
40 | 
41 |   "autoload": {
42 |     "psr-4": {
43 |       "WebSharks\\HtmlCompressor\\": "src/includes/classes"
44 |     }
45 |   },
46 | 
47 |   "config": {
48 |     "vendor-dir": "src/vendor",
49 |     "preferred-install": "dist"
50 |   }
51 | }
52 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
  1 | # Ignore ---------------------------------------------------------------------------------------------------------------
  2 | 
  3 | # Local
  4 | 
  5 | .~*
  6 | 
  7 | # Logs
  8 | 
  9 | *.log
 10 | 
 11 | # Backups
 12 | 
 13 | *~
 14 | *.bak
 15 | 
 16 | # Vagrant
 17 | 
 18 | .vagrant/
 19 | 
 20 | # TypeScript
 21 | 
 22 | typings/
 23 | 
 24 | # IntelliJ
 25 | 
 26 | .idea/
 27 | 
 28 | # Sublime
 29 | 
 30 | *.sublime-project
 31 | *.sublime-workspace
 32 | 
 33 | # Vendor
 34 | 
 35 | vendor/
 36 | 
 37 | # NodeJS
 38 | 
 39 | node_modules/
 40 | 
 41 | # SASS
 42 | 
 43 | .sass-cache/
 44 | 
 45 | # Elastic Beanstalk
 46 | 
 47 | .elasticbeanstalk/
 48 | 
 49 | # CTAGs
 50 | 
 51 | *.ctags
 52 | *.tags
 53 | 
 54 | # VCS
 55 | 
 56 | .git/
 57 | 
 58 | .svn/
 59 | _svn/
 60 | 
 61 | CVS/
 62 | .cvsignore
 63 | 
 64 | .bzr/
 65 | .bzrignore
 66 | 
 67 | .hg/
 68 | .hgignore
 69 | 
 70 | SCCS/
 71 | RCS/
 72 | 
 73 | # PC Files
 74 | 
 75 | $RECYCLE.BIN/
 76 | Desktop.ini
 77 | Thumbs.db
 78 | ehthumbs.db
 79 | 
 80 | # Mac Files
 81 | 
 82 | .AppleDB
 83 | .AppleDouble
 84 | .AppleDesktop
 85 | .com.apple.timemachine.donotpresent
 86 | Network Trash Folder
 87 | Temporary Items
 88 | .LSOverride
 89 | .Spotlight-V100
 90 | .VolumeIcon.icns
 91 | .TemporaryItems
 92 | .fseventsd
 93 | .DS_Store
 94 | .Trashes
 95 | .apdisk
 96 | Icon?
 97 | !Icons
 98 | ._*
 99 | 
100 | # ----------------------------------------------------------------------------------------------------------------------
101 | 
102 | # <custom>
103 | #   Put your rules in custom comment markers.
104 | # </custom>
105 | 


--------------------------------------------------------------------------------
/tests/test.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | error_reporting(-1);
 3 | ini_set('display_errors', 'yes');
 4 | 
 5 | $html = <<<HTML
 6 | <html>
 7 |     <head>
 8 |         <title>Test</title>
 9 |         <script type="text/javascript">
10 |             var test = {
11 |                 hello: 'hello',
12 |                 world: 'world'
13 |             };
14 |         </script>
15 |         <script type="application/ld+json">
16 |             {
17 |               "@context": "http://schema.org",
18 |               "@type": "Person",
19 |               "name": "John Doe",
20 |               "jobTitle": "Graduate research assistant",
21 |               "affiliation": "University of Dreams",
22 |               "additionalName": "Johnny",
23 |               "url": "http://www.example.com",
24 |               "address": {
25 |                 "@type": "PostalAddress",
26 |                 "streetAddress": "1234 Peach Drive",
27 |                 "addressLocality": "Wonderland",
28 |                 "addressRegion": "Georgia"
29 |               }
30 |             }
31 |         </script>
32 |         <style type="text/css">
33 |             #test > .test {
34 |                 font-size: 100%;
35 |                 color: #FFFFFF;
36 |             }
37 |         </style>
38 |     </head>
39 |     <body>
40 |         Testing one, two, three.
41 |     </body>
42 | </html>
43 | HTML;
44 | 
45 | $html_compressor_options = array(
46 |     'css_exclusions' => array(),
47 |     'js_exclusions'  => array('.php?'),
48 |     'uri_exclusions' => array(),
49 | 
50 |     'cache_dir_url_public' => 'http://example.com/cache/public',
51 |     'cache_dir_public'     => dirname(__FILE__).'/.~cache/public',
52 |     'cache_dir_private'    => dirname(__FILE__).'/.~cache/private',
53 | 
54 |     'current_url_scheme' => 'http',
55 |     'current_url_host'   => 'www.example.com',
56 |     'current_url_uri'    => '/test.php?one=1&two=2',
57 | 
58 |     'compress_combine_head_body_css' => true,
59 |     'compress_combine_head_js'       => true,
60 |     'compress_combine_footer_js'     => true,
61 |     'compress_inline_js_code'        => true,
62 |     'compress_css_code'              => true,
63 |     'compress_js_code'               => true,
64 |     'compress_html_code'             => true,
65 | 
66 |     'benchmark' => true,
67 | );
68 | require_once dirname(dirname(__FILE__)).'/src/includes/stub.php';
69 | # require_once dirname(dirname(__FILE__)).'/.~build/websharks-html-compressor.phar';
70 | $html_compressor = new WebSharks\HtmlCompressor\Core($html_compressor_options);
71 | $html            = $html_compressor->compress($html);
72 | 
73 | echo $html;
74 | 


--------------------------------------------------------------------------------
/src/includes/classes/Benchmark.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | namespace WebSharks\HtmlCompressor;
  3 | 
  4 | /**
  5 |  * HTML Compressor (benchmark).
  6 |  *
  7 |  * @since 150315 Enhancing debugger.
  8 |  *
  9 |  * @property-read $times Read-only access to times.
 10 |  * @property-read $data Read-only access to data.
 11 |  */
 12 | class Benchmark // For debugging.
 13 | {
 14 |     /*
 15 |      * Protected Properties
 16 |      */
 17 | 
 18 |     /**
 19 |      * @var array An array of times.
 20 |      *
 21 |      * @since 150315 Enhancing debugger.
 22 |      */
 23 |     protected $times = [];
 24 | 
 25 |     /**
 26 |      * @var array An array of data.
 27 |      *
 28 |      * @since 150315 Enhancing debugger.
 29 |      */
 30 |     protected $data = [];
 31 | 
 32 |     /*
 33 |      * Public API Methods
 34 |      */
 35 | 
 36 |     /**
 37 |      * Class Constructor.
 38 |      *
 39 |      * @since 150315 Enhancing debugger.
 40 |      *
 41 |      * @api Constructor is available for public use.
 42 |      */
 43 |     public function __construct()
 44 |     {
 45 |     }
 46 | 
 47 |     /**
 48 |      * Magic method for access to read-only properties.
 49 |      *
 50 |      * @since 150315 Enhancing debugger.
 51 |      *
 52 |      * @param string $property Propery by name.
 53 |      *
 54 |      * @throws \exception If `$property` does not exist for any reason.
 55 |      *
 56 |      * @return mixed Property value.
 57 |      *
 58 |      * @internal For internal magic use only.
 59 |      */
 60 |     public function __get($property)
 61 |     {
 62 |         $property = (string) $property;
 63 | 
 64 |         if (property_exists($this, $property)) {
 65 |             return $this->{$property};
 66 |         }
 67 |         throw new \Exception(sprintf('Undefined property: `%1$s`.', $property));
 68 |     }
 69 | 
 70 |     /**
 71 |      * Logs a new time entry.
 72 |      *
 73 |      * @since 150315 Enhancing debugger.
 74 |      *
 75 |      * @api This method is available for public use.
 76 |      *
 77 |      * @param string $function   Caller.
 78 |      * @param float  $start_time Start time; via `microtime(TRUE)`.
 79 |      * @param string $task       Description of the task(s) performed.
 80 |      */
 81 |     public function addTime($function, $start_time, $task)
 82 |     {
 83 |         if (!($function = trim((string) $function))) {
 84 |             return; // Not possible.
 85 |         }
 86 |         if (($start_time = (float) $start_time) <= 0) {
 87 |             return; // Not possible.
 88 |         }
 89 |         if (($end_time = (float) microtime(true)) <= 0) {
 90 |             return; // Not possible.
 91 |         }
 92 |         if (!($task = trim((string) $task))) {
 93 |             return; // Not possible.
 94 |         }
 95 |         $time                   = number_format($end_time - $start_time, 5, '.', '');
 96 |         $this->times[$function] = compact('function', 'time', 'task');
 97 |     }
 98 | 
 99 |     /**
100 |      * Logs a new set of data.
101 |      *
102 |      * @since 150315 Enhancing debugger.
103 |      *
104 |      * @api This method is available for public use.
105 |      *
106 |      * @param string $function Caller.
107 |      * @param array  $data     Associative array.
108 |      */
109 |     public function addData($function, array $data)
110 |     {
111 |         if (!($function = trim((string) $function))) {
112 |             return; // Not possible.
113 |         }
114 |         if (!$data) {
115 |             return; // Not possible.
116 |         }
117 |         $this->data[$function] = compact('function', 'data');
118 |     }
119 | }
120 | 


--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
 1 | ## v170420.24924
 2 | 
 3 | - **Bug Fix:** The HTML Compressor was returning an empty string upon encountering an invalid UTF-8 sequence. See [Issue #871](https://github.com/websharks/comet-cache/issues/871) reported by a Comet Cache user.
 4 | 
 5 | ## v161208
 6 | 
 7 | - **Bug Fix:** Undefined variable `$caSe_insensitive`, corrected in this release.
 8 | 
 9 | ## v161207
10 | 
11 | - Adding new config option: `amp_exclusions_enable` (default is enabled). This improves compatibility with [Accelerated Mobile Pages](https://www.ampproject.org/). When this option is enabled and the URI being compressed ends with `/amp/`, or the document contains a top-level `<html ⚡>` tag (`<html amp>` is accepted as well), then features which are incompatible with [Accelerated Mobile Pages](https://www.ampproject.org/) will be disabled accordingly, regardless of your other settings. See [Issue #695](https://github.com/websharks/comet-cache/issues/695) in the Comet Cache repo.
12 | - Adding `isDocAmpd()` conditional check against current URI & document.
13 | - Adding automatic AMP feature exclusions for improved AMP compatibility.
14 | - Optimizing for speed by removing unnecessary calls to `unset()`.
15 | - Enhancing unicode compatibility by taking full advantage of all `mb_*()` functions.
16 | - Adding multibyte compatible `pregQuote()`.
17 | - Adding multibyte compatible `replaceOnce()`.
18 | - Adding multibyte compatible `substrReplace()`.
19 | - Updating all regex patterns to add the `/u` flag for unicode compatibility.
20 | - Updating minimum PHP requirement. Now requires PHP v5.4+ in support of short array syntax `[]`.
21 | 
22 | ## v161108
23 | 
24 | - **Enhancing Exclusion Tests:** Now testing exclusion rules against full open tag instead of only the CSS or JS URL and content. This allows for exclusion rules that exclude CSS or JS based on an opening tag attribute; e.g., `<style id='rs-plugin-settings-inline-css'`. See also: [this Comet Cache issue](https://github.com/websharks/comet-cache/issues/614).
25 | 
26 | ## v160118
27 | 
28 | - Adding support for URI exclusions. See: https://github.com/websharks/zencache/issues/651
29 | - Updating to latest version of websharks/phings.
30 | - Updating test file; i.e., adding test for URI exclusions.
31 | - Updated README.md to mention URI exclusions.
32 | 
33 | ## v150923
34 | 
35 | - Resolved a bug related to `$_SERVER['REQUEST_SCHEME']`. See: https://github.com/websharks/html-compressor/issues/73
36 | 
37 | ## v150821
38 | 
39 | - Improved HTTP connection handling, timeouts, protocol, BOM markers, exceptions, `Referer:` and `User-Agent:` headers. See: websharks/html-compressor#69 for details. See also: https://github.com/websharks/zencache/issues/391
40 | 
41 | - Resolves a bug related to CSS pseudo selectors `:` and whitespace. See [this GitHub issue](https://github.com/websharks/html-compressor/issues/66) if you'd like additional details.
42 | 
43 | - `<noscript>` bug fix; i.e., these should be excluded automatically in order to preserve their intended purpose. The HTML Compressor now makes no adjustments to anything inside `<noscript>` tags, and the same has always been true for IE conditional comments as well. See also: https://github.com/websharks/html-compressor/issues/65
44 | 
45 | - Adding `css_url()` filter support for plugins like ZenCache that need to filter the URLs used in CSS whenever Static CDN Filters are applied. See: https://github.com/websharks/html-compressor/issues/62 See also: https://github.com/websharks/zencache/issues/427#issuecomment-121777746
46 | 
47 | ## v150820
48 | 
49 | - Updating to latest release of CSS Minifier to resolve a bug related to spaces around `:` colons.
50 | 
51 | ## v150819
52 | 
53 | - **Bug Fix:** The HTML Compressor now strips UTF-8  Byte Order Markers (BOMs) from CSS files generated by preprocessors such as Sass. Files consolidated by the HTML Compressor include an `@charset` rule already, making a BOM unnecessary. In fact, if BOMs are not stripped, some browsers will choke on portions of a consolidated CSS file, because a BOM could potentially appear in the middle of the file; i.e., at the _wrong_ place.
54 | 
55 |   _**Symptoms included:** mysterious missing styles in portions of the site, fonts not loading at all times, or font-based icons (e.g., FontAwesome) to render mystery glyphs instead of the icons._
56 | - **Bug Fix:** Improved strict data type comparison when analyzing `$_SERVER` environment variables to detect an `https://` connection URL. We now detect `(integer)443` and `(string)443`. In addition, we can now pick up `$_SERVER['HTTPS']` being any of `1|on|yes|true` (caSe insensitive).
57 | 
58 | ## v150424
59 | 
60 | - PSR 1, 2, 4 conformity.
61 | - Composer dependency compat.
62 | - Major restructuring and namespace changes.
63 | - Adding support for JSON compression.
64 | - Bringing back the PHAR file in each release.
65 | - Adding `build.xml` and `composer.json`.
66 | 
67 | ## v14xxxx
68 | 
69 | - Initial release.
70 | 


--------------------------------------------------------------------------------
/composer.lock:
--------------------------------------------------------------------------------
  1 | {
  2 |     "_readme": [
  3 |         "This file locks the dependencies of your project to a known state",
  4 |         "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file",
  5 |         "This file is @generated automatically"
  6 |     ],
  7 |     "hash": "066672948827bc16629b0b0d20ff827d",
  8 |     "content-hash": "72becf61f95e6d919847ed68ac78e8cc",
  9 |     "packages": [
 10 |         {
 11 |             "name": "websharks/css-minifier",
 12 |             "version": "dev-master",
 13 |             "source": {
 14 |                 "type": "git",
 15 |                 "url": "https://github.com/websharks/css-minifier.git",
 16 |                 "reference": "da1d0254c41e1f59c7337aa444d743e6056046ff"
 17 |             },
 18 |             "dist": {
 19 |                 "type": "zip",
 20 |                 "url": "https://api.github.com/repos/websharks/css-minifier/zipball/da1d0254c41e1f59c7337aa444d743e6056046ff",
 21 |                 "reference": "da1d0254c41e1f59c7337aa444d743e6056046ff",
 22 |                 "shasum": ""
 23 |             },
 24 |             "require": {
 25 |                 "ext-mbstring": "*",
 26 |                 "php": ">=5.3"
 27 |             },
 28 |             "type": "library",
 29 |             "autoload": {
 30 |                 "psr-4": {
 31 |                     "WebSharks\\CssMinifier\\": "src/includes/classes"
 32 |                 }
 33 |             },
 34 |             "notification-url": "https://packagist.org/downloads/",
 35 |             "license": [
 36 |                 "GPL-3.0+"
 37 |             ],
 38 |             "authors": [
 39 |                 {
 40 |                     "name": "websharks",
 41 |                     "homepage": "http://websharks-inc.com/",
 42 |                     "role": "company"
 43 |                 },
 44 |                 {
 45 |                     "name": "jaswsinc",
 46 |                     "homepage": "http://jaswsinc.com/",
 47 |                     "role": "developer"
 48 |                 },
 49 |                 {
 50 |                     "name": "raamdev",
 51 |                     "homepage": "http://raam.org/",
 52 |                     "role": "developer"
 53 |                 }
 54 |             ],
 55 |             "description": "Compresses CSS.",
 56 |             "homepage": "https://github.com/websharks/css-minifier",
 57 |             "keywords": [
 58 |                 "compressor",
 59 |                 "css",
 60 |                 "websharks"
 61 |             ],
 62 |             "time": "2015-08-21 03:19:25"
 63 |         },
 64 |         {
 65 |             "name": "websharks/js-minifier",
 66 |             "version": "dev-master",
 67 |             "source": {
 68 |                 "type": "git",
 69 |                 "url": "https://github.com/websharks/js-minifier.git",
 70 |                 "reference": "3c1e99af6df9df8f691642fbb769a10e49bfba23"
 71 |             },
 72 |             "dist": {
 73 |                 "type": "zip",
 74 |                 "url": "https://api.github.com/repos/websharks/js-minifier/zipball/3c1e99af6df9df8f691642fbb769a10e49bfba23",
 75 |                 "reference": "3c1e99af6df9df8f691642fbb769a10e49bfba23",
 76 |                 "shasum": ""
 77 |             },
 78 |             "require": {
 79 |                 "ext-mbstring": "*",
 80 |                 "php": ">=5.3"
 81 |             },
 82 |             "type": "library",
 83 |             "autoload": {
 84 |                 "psr-4": {
 85 |                     "WebSharks\\JsMinifier\\": "src/includes/classes"
 86 |                 }
 87 |             },
 88 |             "notification-url": "https://packagist.org/downloads/",
 89 |             "license": [
 90 |                 "GPL-3.0+"
 91 |             ],
 92 |             "authors": [
 93 |                 {
 94 |                     "name": "websharks",
 95 |                     "homepage": "http://websharks-inc.com/",
 96 |                     "role": "company"
 97 |                 },
 98 |                 {
 99 |                     "name": "jaswsinc",
100 |                     "homepage": "http://jaswsinc.com/",
101 |                     "role": "developer"
102 |                 },
103 |                 {
104 |                     "name": "raamdev",
105 |                     "homepage": "http://raam.org/",
106 |                     "role": "developer"
107 |                 }
108 |             ],
109 |             "description": "Compresses JavaScript code.",
110 |             "homepage": "https://github.com/websharks/js-minifier",
111 |             "keywords": [
112 |                 "JS",
113 |                 "compressor",
114 |                 "javascript",
115 |                 "websharks"
116 |             ],
117 |             "time": "2015-05-11 20:53:04"
118 |         }
119 |     ],
120 |     "packages-dev": [],
121 |     "aliases": [],
122 |     "minimum-stability": "dev",
123 |     "stability-flags": {
124 |         "websharks/js-minifier": 20,
125 |         "websharks/css-minifier": 20
126 |     },
127 |     "prefer-stable": true,
128 |     "prefer-lowest": false,
129 |     "platform": {
130 |         "php": ">=5.3",
131 |         "ext-openssl": "*",
132 |         "ext-curl": "*",
133 |         "ext-mbstring": "*"
134 |     },
135 |     "platform-dev": []
136 | }
137 | 


--------------------------------------------------------------------------------
/.gitattributes:
--------------------------------------------------------------------------------
  1 | # Text/Binary ----------------------------------------------------------------------------------------------------------
  2 | 
  3 | # Default
  4 | 
  5 | * text=auto
  6 | 
  7 | # Text
  8 | 
  9 | *.md text
 10 | *.txt text
 11 | 
 12 | # Logs
 13 | 
 14 | *.log text
 15 | 
 16 | # YAML
 17 | 
 18 | *.yml
 19 | 
 20 | # Properties.
 21 | 
 22 | *.properties text
 23 | 
 24 | # Translations
 25 | 
 26 | *.pot text
 27 | 
 28 | # SQL
 29 | 
 30 | *.sql text
 31 | *.sqlite text
 32 | 
 33 | # Templates
 34 | 
 35 | *.tmpl text
 36 | *.tpl text
 37 | 
 38 | # Config
 39 | 
 40 | *.admins text
 41 | *.cfg text
 42 | *.cnf text
 43 | *.conf text
 44 | *.htaccess text
 45 | *.htaccess-apache text
 46 | *.htpasswd text
 47 | *.ini text
 48 | 
 49 | # CSS
 50 | 
 51 | *.css text
 52 | *.sass text
 53 | *.scss text
 54 | *.less text
 55 | *.css.map text
 56 | 
 57 | # JavaScript
 58 | 
 59 | *.js text
 60 | *.ts text
 61 | *.jsx text
 62 | *.tsx text
 63 | *.json text
 64 | *.js.map text
 65 | 
 66 | # Applescript
 67 | 
 68 | *.applescript text
 69 | *.scpt binary
 70 | 
 71 | # PHP
 72 | 
 73 | *.inc text
 74 | *.php text
 75 | *.php4 text
 76 | *.php5 text
 77 | *.php6 text
 78 | *.phps text
 79 | *.x-php text
 80 | 
 81 | # ASP
 82 | 
 83 | *.asp text
 84 | *.aspx text
 85 | 
 86 | # Perl
 87 | 
 88 | *.cgi text
 89 | *.pl text
 90 | 
 91 | # HTML/XML
 92 | 
 93 | *.dtd text
 94 | *.hta text
 95 | *.htc text
 96 | *.htm text
 97 | *.html text
 98 | *.shtml text
 99 | *.xhtml text
100 | *.xml text
101 | *.xsl text
102 | *.xslt text
103 | *.xsd text
104 | 
105 | # Documents
106 | 
107 | *.csv text
108 | *.doc binary
109 | *.docx binary
110 | *.odt binary
111 | *.pdf binary
112 | *.rtf binary
113 | *.xls binary
114 | 
115 | # Images
116 | 
117 | *.ai binary
118 | *.bmp binary
119 | *.eps binary
120 | *.gif binary
121 | *.ico binary
122 | *.jpe binary
123 | *.jpeg binary
124 | *.jpg binary
125 | *.png binary
126 | *.webp binary
127 | *.psd binary
128 | *.svg text
129 | *.tif binary
130 | *.tiff binary
131 | *.pspimage binary
132 | 
133 | # Audio
134 | 
135 | *.mid binary
136 | *.midi binary
137 | *.mp3 binary
138 | *.wav binary
139 | *.wma binary
140 | 
141 | # Video
142 | 
143 | *.avi binary
144 | *.flv binary
145 | *.ogg binary
146 | *.ogv binary
147 | *.mp4 binary
148 | *.mov binary
149 | *.mpg binary
150 | *.mpeg binary
151 | *.qt binary
152 | *.webm binary
153 | *.wmv binary
154 | *.fla binary
155 | *.swf binary
156 | *.blend binary
157 | 
158 | # Fonts
159 | 
160 | *.eot binary
161 | *.otf binary
162 | *.ttf binary
163 | *.woff binary
164 | 
165 | # Archives
166 | 
167 | *.7z binary
168 | *.dmg binary
169 | *.gtar binary
170 | *.gz binary
171 | *.iso binary
172 | *.jar binary
173 | *.phar binary
174 | *.rar binary
175 | *.tar binary
176 | *.tgz binary
177 | *.zip binary
178 | 
179 | # Other
180 | 
181 | *.bat text
182 | *.bash text
183 | *.bin binary
184 | *.class binary
185 | *.com binary
186 | *.dll binary
187 | *.exe binary
188 | *.sh text
189 | *.so binary
190 | 
191 | # Export Ignore — this follows `.gitignore` almost exactly. ------------------------------------------------------------
192 | # The only exceptions are that we don't ignore `node_modules/` or `vendor/`.
193 | 
194 | # Local
195 | 
196 | .~* export-ignore
197 | 
198 | # Logs
199 | 
200 | *.log export-ignore
201 | 
202 | # Backups
203 | 
204 | *~ export-ignore
205 | *.bak export-ignore
206 | 
207 | # Vagrant
208 | 
209 | .vagrant/ export-ignore
210 | 
211 | # TypeScript
212 | 
213 | typings/ export-ignore
214 | 
215 | # IntelliJ
216 | 
217 | .idea/ export-ignore
218 | 
219 | # Sublime
220 | 
221 | *.sublime-project export-ignore
222 | *.sublime-workspace export-ignore
223 | 
224 | # SASS
225 | 
226 | .sass-cache/ export-ignore
227 | 
228 | # Elastic Beanstalk
229 | 
230 | .elasticbeanstalk/ export-ignore
231 | 
232 | # CTAGs
233 | 
234 | *.ctags export-ignore
235 | *.tags export-ignore
236 | 
237 | # VCS
238 | 
239 | .git/ export-ignore
240 | 
241 | .svn/ export-ignore
242 | _svn/ export-ignore
243 | 
244 | CVS/ export-ignore
245 | .cvsignore export-ignore
246 | 
247 | .bzr/ export-ignore
248 | .bzrignore export-ignore
249 | 
250 | .hg/ export-ignore
251 | .hgignore export-ignore
252 | 
253 | SCCS/ export-ignore
254 | RCS/ export-ignore
255 | 
256 | # PC Files
257 | 
258 | $RECYCLE.BIN/ export-ignore
259 | Desktop.ini export-ignore
260 | Thumbs.db export-ignore
261 | ehthumbs.db export-ignore
262 | 
263 | # Mac Files
264 | 
265 | .AppleDB export-ignore
266 | .AppleDouble export-ignore
267 | .AppleDesktop export-ignore
268 | .com.apple.timemachine.donotpresent export-ignore
269 | Network Trash Folder export-ignore
270 | Temporary Items export-ignore
271 | .LSOverride export-ignore
272 | .Spotlight-V100 export-ignore
273 | .VolumeIcon.icns export-ignore
274 | .TemporaryItems export-ignore
275 | .fseventsd export-ignore
276 | .DS_Store export-ignore
277 | .Trashes export-ignore
278 | .apdisk export-ignore
279 | Icon? export-ignore
280 | Icons -export-ignore
281 | ._* export-ignore
282 | 
283 | # Export Ignore — in addition to what we have in `.gitignore`. ---------------------------------------------------------
284 | 
285 | # Assets
286 | 
287 | /assets/ export-ignore
288 | 
289 | # LFS Storage (Assets) -------------------------------------------------------------------------------------------------
290 | 
291 | /assets/** filter=lfs diff=lfs merge=lfs -text
292 | 
293 | # ----------------------------------------------------------------------------------------------------------------------
294 | 
295 | # <custom>
296 | #   Put your rules in custom comment markers.
297 | # </custom>
298 | 


--------------------------------------------------------------------------------
/src/includes/classes/HookApi.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | namespace WebSharks\HtmlCompressor;
  3 | 
  4 | /**
  5 |  * HTML Compressor (hook API).
  6 |  *
  7 |  * @since 150321 Adding hook API for plugins.
  8 |  *
  9 |  * @property-read $times Read-only access to times.
 10 |  * @property-read $data Read-only access to data.
 11 |  */
 12 | class HookApi // For plugins.
 13 | {
 14 |     /*
 15 |      * Protected Properties
 16 |      */
 17 | 
 18 |     /**
 19 |      * @var array An array of hooks.
 20 |      *
 21 |      * @since 150321 Adding hook API for plugins.
 22 |      */
 23 |     protected $hooks = [];
 24 | 
 25 |     /*
 26 |      * Public API Methods
 27 |      */
 28 | 
 29 |     /**
 30 |      * Class Constructor.
 31 |      *
 32 |      * @since 150321 Adding hook API for plugins.
 33 |      *
 34 |      * @api Constructor is available for public use.
 35 |      */
 36 |     public function __construct()
 37 |     {
 38 |         if (empty($GLOBALS[__NAMESPACE__.'_early_hooks'])) {
 39 |             return; // Nothing more to do here.
 40 |         }
 41 |         $GLOBALS[__NAMESPACE__.'_early_hooks'] = (array) $GLOBALS[__NAMESPACE__.'_early_hooks'];
 42 |         $early_hooks                           = &$GLOBALS[__NAMESPACE__.'_early_hooks'];
 43 | 
 44 |         foreach ($early_hooks as $_early_hook) {
 45 |             if (empty($_early_hook['hook'])) {
 46 |                 continue; // Empty; bypass.
 47 |             }
 48 |             if (empty($_early_hook['function'])) {
 49 |                 continue; // Empty; bypass.
 50 |             }
 51 |             if (!isset($_early_hook['priority'])) {
 52 |                 $_early_hook['priority'] = 10;
 53 |             }
 54 |             if (!isset($_early_hook['accepted_args'])) {
 55 |                 $_early_hook['accepted_args'] = 1;
 56 |             }
 57 |             $this->addHook(
 58 |                 $_early_hook['hook'],
 59 |                 $_early_hook['function'],
 60 |                 $_early_hook['priority'],
 61 |                 $_early_hook['accepted_args']
 62 |             );
 63 |         }
 64 |         unset($_early_hook); // Just a little housekeeping.
 65 | 
 66 |         $early_hooks = []; // Empty; i.e., reset early hooks.
 67 |     }
 68 | 
 69 |     /**
 70 |      * Magic method for access to read-only properties.
 71 |      *
 72 |      * @since 150321 Adding hook API for plugins.
 73 |      *
 74 |      * @param string $property Propery by name.
 75 |      *
 76 |      * @throws \exception If `$property` does not exist for any reason.
 77 |      *
 78 |      * @return mixed Property value.
 79 |      *
 80 |      * @internal For internal magic use only.
 81 |      */
 82 |     public function __get($property)
 83 |     {
 84 |         $property = (string) $property;
 85 | 
 86 |         if (property_exists($this, $property)) {
 87 |             return $this->{$property};
 88 |         }
 89 |         throw new \Exception(sprintf('Undefined property: `%1$s`.', $property));
 90 |     }
 91 | 
 92 |     /**
 93 |      * Assigns an ID to each callable attached to a hook/filter.
 94 |      *
 95 |      * @since 150321 Adding hook API for plugins.
 96 |      *
 97 |      * @param string|callable|mixed $function A string or a callable.
 98 |      *
 99 |      * @throws \exception If the hook/function is invalid (i.e. it's not possible to generate an ID).
100 |      *
101 |      * @return string Hook ID for the given `$function`.
102 |      */
103 |     public function hookId($function)
104 |     {
105 |         if (is_string($function)) {
106 |             return $function;
107 |         }
108 |         if (is_object($function)) {
109 |             $function = [$function, ''];
110 |         } else {
111 |             $function = (array) $function;
112 |         }
113 |         if (isset($function[0], $function[1])) {
114 |             if (is_object($function[0])) {
115 |                 return spl_object_hash($function[0]).$function[1];
116 |             } elseif (is_string($function[0])) {
117 |                 return $function[0].'::'.$function[1];
118 |             }
119 |         }
120 |         throw new \Exception('Invalid hook.');
121 |     }
122 | 
123 |     /**
124 |      * Do we have a specific hook?
125 |      *
126 |      * @since 150821 Enhancing hook support.
127 |      *
128 |      * @param string $hook The name of a filter hook.
129 |      *
130 |      * @return bool True if actions/filters exist on this hook.
131 |      */
132 |     public function hasHook($hook)
133 |     {
134 |         $hook = (string) $hook;
135 | 
136 |         return $hook && !empty($this->hooks[$hook]);
137 |     }
138 | 
139 |     /**
140 |      * Do we have a specific action?
141 |      *
142 |      * @since 150821 Enhancing hook support.
143 |      *
144 |      * @return bool True if hook exists for this action.
145 |      *
146 |      * @see hasHook()
147 |      */
148 |     public function hasAction() // Simple `hasHook()` alias.
149 |     {
150 |         return call_user_func_array([$this, 'hasHook'], func_get_args());
151 |     }
152 | 
153 |     /**
154 |      * Do we have a specific filter?
155 |      *
156 |      * @since 150821 Enhancing hook support.
157 |      *
158 |      * @return bool True if hook exists for this filter.
159 |      *
160 |      * @see hasHook()
161 |      */
162 |     public function hasFilter() // Simple `hasHook()` alias.
163 |     {
164 |         return call_user_func_array([$this, 'hasHook'], func_get_args());
165 |     }
166 | 
167 |     /**
168 |      * Adds a new hook (works with both actions & filters).
169 |      *
170 |      * @since 150321 Adding hook API for plugins.
171 |      *
172 |      * @param string                $hook          The name of a hook to attach to.
173 |      * @param string|callable|mixed $function      A string or a callable.
174 |      * @param int                   $priority      Hook priority; defaults to `10`.
175 |      * @param int                   $accepted_args Max number of args that should be passed to the `$function`.
176 |      *
177 |      * @return bool This always returns a `TRUE` value.
178 |      */
179 |     public function addHook($hook, $function, $priority = 10, $accepted_args = 1)
180 |     {
181 |         $hook          = (string) $hook;
182 |         $priority      = (int) $priority;
183 |         $accepted_args = max(0, (int) $accepted_args);
184 |         $hook_id       = $this->hookId($function);
185 | 
186 |         $this->hooks[$hook][$priority][$hook_id] = [
187 |             'function'      => $function,
188 |             'accepted_args' => (int) $accepted_args,
189 |         ];
190 |         return true; // Always returns true.
191 |     }
192 | 
193 |     /**
194 |      * Adds a new action hook.
195 |      *
196 |      * @since 150321 Adding hook API for plugins.
197 |      *
198 |      * @return bool This always returns a `TRUE` value.
199 |      *
200 |      * @see addHook()
201 |      */
202 |     public function addAction() // Simple `addHook()` alias.
203 |     {
204 |         return call_user_func_array([$this, 'addHook'], func_get_args());
205 |     }
206 | 
207 |     /**
208 |      * Adds a new filter.
209 |      *
210 |      * @since 150321 Adding hook API for plugins.
211 |      *
212 |      * @return bool This always returns a `TRUE` value.
213 |      *
214 |      * @see addHook()
215 |      */
216 |     public function addFilter() // Simple `addHook()` alias.
217 |     {
218 |         return call_user_func_array([$this, 'addHook'], func_get_args());
219 |     }
220 | 
221 |     /**
222 |      * Removes a hook (works with both actions & filters).
223 |      *
224 |      * @since 150321 Adding hook API for plugins.
225 |      *
226 |      * @param string                $hook     The name of a hook to remove.
227 |      * @param string|callable|mixed $function A string or a callable.
228 |      * @param int                   $priority Hook priority; defaults to `10`.
229 |      *
230 |      * @return bool `TRUE` if removed; else `FALSE` if not removed for any reason.
231 |      */
232 |     public function removeHook($hook, $function, $priority = 10)
233 |     {
234 |         $hook     = (string) $hook;
235 |         $priority = (int) $priority;
236 |         $hook_id  = $this->hookId($function);
237 | 
238 |         if (!isset($this->hooks[$hook][$priority][$hook_id])) {
239 |             return false; // Nothing to remove.
240 |         }
241 |         unset($this->hooks[$hook][$priority][$hook_id]);
242 |         if (!$this->hooks[$hook][$priority]) {
243 |             unset($this->hooks[$hook][$priority]);
244 |         }
245 |         return true; // Existed before it was removed.
246 |     }
247 | 
248 |     /**
249 |      * Removes an action.
250 |      *
251 |      * @since 150321 Adding hook API for plugins.
252 |      *
253 |      * @return bool `TRUE` if removed; else `FALSE` if not removed for any reason.
254 |      *
255 |      * @see removeHook()
256 |      */
257 |     public function removeAction() // Simple `removeHook()` alias.
258 |     {
259 |         return call_user_func_array([$this, 'removeHook'], func_get_args());
260 |     }
261 | 
262 |     /**
263 |      * Removes a filter.
264 |      *
265 |      * @since 150321 Adding hook API for plugins.
266 |      *
267 |      * @return bool `TRUE` if removed; else `FALSE` if not removed for any reason.
268 |      *
269 |      * @see removeHook()
270 |      */
271 |     public function removeFilter() // Simple `removeHook()` alias.
272 |     {
273 |         return call_user_func_array([$this, 'removeHook'], func_get_args());
274 |     }
275 | 
276 |     /**
277 |      * Runs any callables attached to an action.
278 |      *
279 |      * @since 150321 Adding hook API for plugins.
280 |      *
281 |      * @param string $hook The name of an action hook.
282 |      */
283 |     public function doAction($hook)
284 |     {
285 |         $hook = (string) $hook;
286 |         if (empty($this->hooks[$hook])) {
287 |             return; // No hooks.
288 |         }
289 |         $hook_actions = $this->hooks[$hook];
290 |         $args         = func_get_args();
291 |         ksort($hook_actions);
292 | 
293 |         foreach ($hook_actions as $_hook_action) {
294 |             foreach ($_hook_action as $_action) {
295 |                 if (!isset($_action['function'], $_action['accepted_args'])) {
296 |                     continue; // Not a valid filter in this case.
297 |                 }
298 |                 call_user_func_array($_action['function'], array_slice($args, 1, $_action['accepted_args']));
299 |             }
300 |         }
301 |         unset($_hook_action, $_action); // Housekeeping.
302 |     }
303 | 
304 |     /**
305 |      * Runs any callables attached to a filter.
306 |      *
307 |      * @since 150321 Adding hook API for plugins.
308 |      *
309 |      * @param string $hook  The name of a filter hook.
310 |      * @param mixed  $value The value to filter.
311 |      *
312 |      * @return mixed The filtered `$value`.
313 |      */
314 |     public function applyFilters($hook, $value)
315 |     {
316 |         $hook = (string) $hook;
317 |         if (empty($this->hooks[$hook])) {
318 |             return $value; // No hooks.
319 |         }
320 |         $hook_filters = $this->hooks[$hook];
321 |         $args         = func_get_args();
322 |         ksort($hook_filters);
323 | 
324 |         foreach ($hook_filters as $_hook_filter) {
325 |             foreach ($_hook_filter as $_filter) {
326 |                 if (!isset($_filter['function'], $_filter['accepted_args'])) {
327 |                     continue; // Not a valid filter in this case.
328 |                 }
329 |                 $args[1] = $value; // Continously update the argument `$value`.
330 |                 $value   = call_user_func_array($_filter['function'], array_slice($args, 1, $_filter['accepted_args']));
331 |             }
332 |         }
333 |         unset($_hook_filter, $_filter); // Housekeeping.
334 | 
335 |         return $value; // With applied filters.
336 |     }
337 | }
338 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | # HTML-Compressor
  2 | 
  3 | <img src="assets/html-compressor-logo.png" width="300px" align="right" />
  4 | 
  5 | Combines & compresses CSS/JS/HTML code.
  6 | 
  7 | [![](https://img.shields.io/github/license/websharks/html-compressor.svg)](https://github.com/websharks/html-compressor/blob/HEAD/LICENSE.txt)
  8 | 
  9 | [![](https://img.shields.io/badge/made-w%2F_100%25_pure_awesome_sauce-AB815F.svg?label=made)](http://websharks-inc.com/)
 10 | [![](https://img.shields.io/badge/by-WebSharks_Inc.-656598.svg?label=by)](http://www.websharks-inc.com/team/)
 11 | [![](https://img.shields.io/github/release/websharks/html-compressor.svg?label=latest)](https://github.com/websharks/html-compressor/releases)
 12 | [![](https://img.shields.io/packagist/v/websharks/html-compressor.svg?label=packagist)](https://packagist.org/packages/websharks/html-compressor)
 13 | [![](https://img.shields.io/github/issues/websharks/html-compressor.svg?label=issues)](https://github.com/websharks/html-compressor/issues)
 14 | [![](https://img.shields.io/github/forks/websharks/html-compressor.svg?label=forks)](https://github.com/websharks/html-compressor/network)
 15 | [![](https://img.shields.io/github/stars/websharks/html-compressor.svg?label=stars)](https://github.com/websharks/html-compressor/stargazers)
 16 | [![](https://img.shields.io/github/downloads/websharks/html-compressor/latest/total.svg?label=downloads)](https://github.com/websharks/html-compressor/releases)
 17 | [![](https://img.shields.io/packagist/dt/websharks/html-compressor.svg?label=packagist)](https://packagist.org/packages/websharks/html-compressor)
 18 | 
 19 | ```php
 20 | <?php
 21 | require_once 'html-compressor.phar';
 22 | $html_compressor = new WebSharks\HtmlCompressor\Core();
 23 | ob_start(array($html_compressor, 'compress'));
 24 | ```
 25 | 
 26 | ----
 27 | 
 28 | ## Installation Instructions (Two Options)
 29 | 
 30 | 1. As a [Composer](https://packagist.org/packages/websharks/html-compressor) Dependency
 31 | 
 32 |   ```json
 33 |   {
 34 |       "require": {
 35 |           "websharks/html-compressor": "dev-master"
 36 |       }
 37 |   }
 38 |   ```
 39 | 
 40 | 2. Or, Download the PHAR Binary
 41 |   See: https://github.com/websharks/html-compressor/releases
 42 | 
 43 | ## Where do I get the PHAR file?
 44 | 
 45 | A PHAR binary is made available for each official release. See: [releases](https://github.com/websharks/html-compressor/releases).
 46 | 
 47 | ## Why did we create the HTML Compressor?
 48 | 
 49 | The HTML Compressor class was developed because all of us here at WebSharks™ are growing tired of seeing WordPress installations out-in-the-wild that are running many different plugins; where each plugin may add a new set of CSS/JS files. This creates a slow-loading site, even if a page caching plugin is active.
 50 | 
 51 | **For example**, if you look at the HTML source code for most sites powered by a publishing platform such as WordPress (or audit one in a web developer console), you will find **a complete mess like this**...
 52 | 
 53 |     <link rel="stylesheet" href="theme.css" type="text/css" />
 54 |     <link rel="stylesheet" href="child-theme.css" type="text/css" />
 55 |     <link rel="stylesheet" href="theme-variation.css" type="text/css" />
 56 |     <link rel="stylesheet" href="plugin1.css" type="text/css" />
 57 |     <link rel="stylesheet" href="plugin2.css" type="text/css" />
 58 |     <link rel="stylesheet" href="plugin3.css" type="text/css" />
 59 |     <link rel="stylesheet" href="plugin4.css" type="text/css" />
 60 |     <link rel="stylesheet" href="plugin5.css" type="text/css" />
 61 |     ... and on, and on, and on ...
 62 | 
 63 |     <script type="text/javascript" src="jquery.js"></script>
 64 |     <script type="text/javascript" src="jquery-migrate.min.js"></script>
 65 |     <script type="text/javascript" src="tabs.min.js"></script>
 66 |     <script type="text/javascript" src="custom.js"></script>
 67 |     <script type="text/javascript" src="plugin1.js"></script>
 68 |     <script type="text/javascript" src="plugin2.js"></script>
 69 |     <script type="text/javascript" src="plugin3.js"></script>
 70 |     <script type="text/javascript" src="plugin4.js"></script>
 71 |     <script type="text/javascript" src="plugin5.js"></script>
 72 |     ... and on, and on, and on ...
 73 | 
 74 | #### ↑ The Problem Here?
 75 | 
 76 | Instead of a single CSS and/or JS file (i.e., one or two HTTP connections); the browser needs to make *several* requests; and it needs to download each of these resources separately. This is not a problem that impacts WordPress alone, we see this issue across many publishing platforms where plugins are brought into the mix.
 77 | 
 78 | Ideally, your publishing platform (or theme) would minimize the number of external resources that it depends on by consolidating those external resources (i.e., CSS/JS files) into just one or two files; and then compress them too. However, not all themes do this. In fact, this is not always possible (even when a theme/plugin developer is aware of the issue).
 79 | 
 80 | For instance, if a theme/plugin developer is working within a set of PHP framework standards (e.g., doing things "the WordPress way"), the end result may not always be optimized in an ideal fashion. We know first-hand that this really bugs developers. Experienced developers don't create a mess by choice, it's just how the framework pulls everything together that can sometimes produce a mess. Also, when a site owner adds plugins to the mix later; where the publishing platform (or theme) is being supplemented by CSS/JS files that are plugin-specific—this is where things can really get crazy; e.g., a new CSS and/or JS file for each plugin.
 81 | 
 82 | ## Solution, the WebSharks™ HTML Compressor!
 83 | 
 84 | **The WebSharks™ HTML Compressor works as an additional layer of functionality that can come in after your publishing platform pieces everything together.** The WebSharks™ HTML Compressor analyzes each page of your site in real-time; i.e., as it's being loaded; inspecting each line of HTML code.
 85 | 
 86 | CSS/JS files are combined (where possible) and compressed (where possible); then it can optimize the HTML code and any inline JavaScript/CSS too. The goal is to speed things up for your visitors and to reduce the number of HTTP connections that your server processes.
 87 | 
 88 | #### Step-by-Step (Detailed Explanation)
 89 | 
 90 | All of these compression options are enabled by default, but you can modify this behavior as you see fit. Toward the bottom of this file you will find a list of all possible configuration options.
 91 | 
 92 | **1.** The HTML Compressor starts by inspecting the `<head>` and `<body>` of the HTML document. An attempt is made to recursively combine all CSS resources (including inline styles, and all remote resources too) into a single CSS file. If `compress_css_code` is enabled (on by default), the code in this single file is also compressed (i.e., extra whitespace is removed, hex color codes are optimized, etc, etc).
 93 | 
 94 |    *A few NOTES regarding step `1`.*
 95 | 
 96 |    - **NOTE:** The HTML Compressor does its best to remain standards-compliant during this process; thereby reducing the chance of a conflict to an absolute minimum.
 97 | 
 98 |    - **NOTE:** An attempt is made to fetch remote resources (e.g., externally hosted resources) or `@import` rules. Any remote resources are simply added to the single CSS file to eliminate any possibility of more than one HTTP connection being required to load the consolidated CSS. The HTML Compressor is also capable of resolving file paths and `url()` references to the proper location during this process.
 99 | 
100 |    - **NOTE:** The HTML Compressor avoids cascading conflicts by intelligently skipping over any exclusions that you define and/or anything that is impossible to consolidate. In some cases 10 files might become 1; in other cases 10 files might become 2 or 3. This could vary from site to site—or from page-to-page even. If 1 file is possible, that's what you'll get. Otherwise, you will get whatever compression is possible.
101 | 
102 |    - **NOTE:** Under no circumstance will the HTML Compression alter the loading order of the underlying CSS resources. Even when files are combined in multiple sets (or certain exclusions are skipped over), the loading order is always preserved so that CSS conflicts are not introduced by this process.
103 | 
104 |    - **NOTE:** All CSS `@` rules are preserved by the HTML Compressor too. This includes `@media` specifications (whether they be defined in an `@import` or `<link media="">` tag; or with an embedded `@media` rule). There is only one exception. The `@charset` rule is always forced to a value of `@charset "UTF-8";` (recommended anyway).
105 | 
106 |    - **NOTE:** Conditional CSS (e.g., `<!--if[]` tags) are always excluded from consolidation so their behavior is not altered. Cascading order is preserved when exclusions are encountered; this goes for `<!--if[]` tags too of course.
107 | 
108 | **2.** Next, we inspect the `<head>` of the HTML document. An attempt is made to combine all JS resources in the `<head>` into a single JS file. If `compress_js_code` is enabled (on by default), the code in this single file is also compressed (i.e., extra whitespace is removed, variable names are optimized, etc, etc).
109 | 
110 | **3.** Next, we inspect a special area of the source code that can be flagged for compression by wrapping a section with `<!--footer-scripts--><!--footer-scripts-->`. This flagging is only necessary if you have scripts that you intentionally place in the footer. If the HTML Compressor finds a `<!--footer-scripts--><!--footer-scripts-->` section; an attempt is made to combine all JS resources into a single JS file. If `compress_js_code` is enabled (on by default), the code in this single file is also compressed (i.e., extra whitespace is removed, variable names are optimized, etc, etc).
111 | 
112 |    *A few NOTES regarding steps `2` and `3`.*
113 | 
114 |    - **NOTE:** The HTML Compressor does its best to remain standards-compliant during this process; thereby reducing the chance of a conflict to an absolute minimum.
115 | 
116 |    - **NOTE:** An attempt is made to fetch remote resources (e.g., externally hosted JavaScript resources). Any remote resources are simply added to the single JS file to eliminate any possibility of more than one HTTP connection being required to load the consolidated JS. The HTML Compressor is also capable of resolving file paths and references to the proper location during this process.
117 | 
118 |    - **NOTE:** The HTML Compressor avoids loading order conflicts by intelligently skipping over any exclusions that you define and/or anything that is impossible to consolidate. In some cases 10 files might become 1; in other cases 10 files might become 2 or 3. This could vary from site to site; or from page-to-page even. If 1 file is possible, that's what you'll get. Otherwise, you will get whatever compression is possible.
119 | 
120 |    - **NOTE:** Under no circumstance will the HTML Compression alter the loading order of the underlying JS resources. Even when files are combined in multiple sets (or certain exclusions are skipped over), the loading order is always preserved so that JS conflicts are not introduced by this process.
121 | 
122 |    - **NOTE:** All JavaScript `async` indicators are preserved during this process. Asynchronous loading is detected by the `async` and/or `defer` attribute in a `<script>` tag.
123 | 
124 |    - **NOTE:** Conditional JS (e.g., `<!--if[]` tags) are always excluded from consolidation so their behavior is not altered. Loading order is preserved when exclusions are encountered; this goes for `<!--if[]` tags too of course.
125 | 
126 | **4.** Next, we look at the `<body>` for any inline `<script>` tags. While it is not possible  to consolidate inline JS; if `compress_inline_js_code` is enabled (on by default) an attempt is made to compress the JavaScript code in these inline code snippets to reduce the amount of overhead they might add.
127 | 
128 | **5.** Last, we compress the HTML code itself (i.e., extra whitespace is removed). Care is taken to preserve special tags where raw formatting is important; but you should end up with a much smaller HTML file; and the external resources it depends on will have certainly be reduced to a bare minimum.
129 | 
130 | ----
131 | 
132 | ## Some Usage Examples
133 | 
134 | ### 1. HTML Compressor As An Output Buffer
135 | *This code snippet should be processed BEFORE any other output occurs.*
136 | 
137 | ```php
138 | <?php
139 | require_once 'html-compressor.phar';
140 | $html_compressor = new WebSharks\HtmlCompressor\Core();
141 | ob_start(array($html_compressor, 'compress'));
142 | ```
143 | 
144 | **TIP:** The `php.ini` directive [auto_prepend_file](http://www.php.net/manual/en/ini.core.php#ini.auto-prepend-file) is a nice/clean way to integrate the HTML Compressor. You could create a file as seen in this example and specify that as the `auto_prepend_file` to enable compression of every HTML file that you serve; noting that the HTML Compressor will simply pass any non-HTML code through it's buffer without compressing it. The HTML Compressor only attempts to compress data which contains a closing `</html>` tag.
145 | 
146 | **IMPORTANT NOTE:** One thing to keep in mind is that the WebSharks™ HTML Compressor works best when it's integrated together with a page caching plugin like ZenCache for WordPress; or another page caching plugin that you might prefer. **Why use a page caching plugin?** The HTML Compressor can be used on any site powered by PHP; but ideally you would cache the optimized HTML that it outputs, thereby removing the need for the HTML Compressor to analyze every single request. Of course, you *can* analyze every single request if you want to *(and the HTML Compressor has a cache of it's own to help keep things sane)*, but it's always better to store (cache) the compressed HTML output by this class. This will reduce server load and make your site even faster.
147 | 
148 | **FAQ:** Is `html-compressor.phar` the only file that I need? Yes. The other files that you see in the GitHub repo are already compressed into the PHAR file. The only file you need is the `html-compressor.phar`. A PHAR binary is made available for each official release. See: [releases](https://github.com/websharks/html-compressor/releases).
149 | 
150 | ### 2. HTML Compressor as an Output Buffer (w/ Options)
151 | *This just demonstrates how to specify an array of options.*
152 | 
153 | ```php
154 | <?php
155 | require_once 'html-compressor.phar';
156 | $html_compressor_options = array(
157 | 
158 |     'css_exclusions' => array(),
159 |     'js_exclusions' => array('.php?'),
160 |     'uri_exclusions' => array(),
161 | 
162 |     'cache_expiration_time' => '14 days',
163 |     'cache_dir_public' => '/var/www/public_html/htmlc/cache/public',
164 |     'cache_dir_url_public' => 'http://example.com/htmlc/cache/public',
165 |     'cache_dir_private' => '/var/www/public_html/htmlc/cache/private',
166 | 
167 |     'compress_combine_head_body_css' => TRUE,
168 |     'compress_combine_head_js' => TRUE,
169 |     'compress_combine_footer_js' => TRUE,
170 |     'compress_inline_js_code' => TRUE,
171 |     'compress_css_code' => TRUE,
172 |     'compress_js_code' => TRUE,
173 |     'compress_html_code' => TRUE,
174 | 
175 |     'benchmark' => FALSE,
176 |     'product_title' => 'HTML Compressor',
177 |     'vendor_css_prefixes' => array('moz','webkit','khtml','ms','o')
178 | );
179 | $html_compressor = new WebSharks\HtmlCompressor\Core($html_compressor_options);
180 | ob_start(array($html_compressor, 'compress'));
181 | ```
182 | 
183 | ### 3. HTML Compressor on raw HTML Code
184 | *This demonstrates how to run the compressor against arbitrary HTML code.*
185 | 
186 | ```php
187 | <?php
188 | require_once 'html-compressor.phar';
189 | $html_compressor_options = array(
190 | 
191 |     'css_exclusions' => array(),
192 |     'js_exclusions' => array('.php?'),
193 |     'uri_exclusions' => array(),
194 | 
195 |     'cache_expiration_time' => '14 days',
196 |     'cache_dir_public' => '/var/www/public_html/htmlc/cache/public',
197 |     'cache_dir_url_public' => 'http://example.com/htmlc/cache/public',
198 |     'cache_dir_private' => '/var/www/public_html/htmlc/cache/private',
199 | 
200 |     'current_url_scheme' => 'http',
201 |     'current_url_host' => 'www.example.com',
202 |     'current_url_uri' => '/raw/file/test.html?one=1&two=2',
203 | 
204 |     'compress_combine_head_body_css' => TRUE,
205 |     'compress_combine_head_js' => TRUE,
206 |     'compress_combine_footer_js' => TRUE,
207 |     'compress_inline_js_code' => TRUE,
208 |     'compress_css_code' => TRUE,
209 |     'compress_js_code' => TRUE,
210 |     'compress_html_code' => TRUE,
211 | 
212 |     'benchmark' => FALSE,
213 |     'product_title' => 'HTML Compressor',
214 |     'vendor_css_prefixes' => array('moz','webkit','khtml','ms','o')
215 | );
216 | $html = '<html> ... </html>';
217 | $html_compressor = new WebSharks\HtmlCompressor\Core($html_compressor_options);
218 | $html = $html_compressor->compress($html);
219 | ```
220 | 
221 | ----
222 | 
223 | ## Class Constructor Options
224 | 
225 | e.g., `new WebSharks\HtmlCompressor\Core($options);`
226 | 
227 | *where `$options` is an associative array with one or more keys listed below.*
228 | 
229 | #### Current List of All Possible Options
230 | 
231 | ##### The following options allow you to exclude certain CSS/JS files and/or inline snippets.
232 | 
233 |   **NOTE:** these options only apply if compression is enabled for CSS/JS files.*
234 | 
235 | - (array)`css_exclusions` Defaults to `array()`. If you have some CSS files (or inline styles) that should NOT be included by compression routines, please specify an array of search tokens to exclude. Search tokens are compared to external CSS file `href` values (i.e., URLs or paths). Search tokens are also compared to the contents of any inline `<style></style>` tags.
236 | 
237 | - (array)`js_exclusions` Defaults to `array()`. If you have some JS files (or inline scripts) that should NOT be included by compression routines, please specify an array of search tokens to exclude. Search tokens are compared to external JS file `src` values (i.e., URLs or paths). Search tokens are also compared to the contents of any inline `<script></script>` tags in cases where compression is possible.
238 | 
239 | - (array)`uri_exclusions` Defaults to `array()`. If you have some URLs that should NOT be included by compression routines, please specify an array of search tokens to exclude. Search tokens are compared to the current URI (i.e., everything after the domain name).
240 | 
241 |   **NOTE:** Search tokens should be string literals. The HTML Compressor currently does NOT support wildcards or regex in search tokens. If you need to use regex patterns instead of search tokens, please use a `regex_` prefix when you define the option key; e.g., `'regex_js_exclusions' => '/\special\-script\.js/i'`. This works for `regex_css_exclusions` and `regex_uri_exclusions` too.
242 | 
243 | ----
244 | 
245 | - (boolean)`disable_built_in_css_exclusions` Defaults to `FALSE`. There are a few built-in exclusion patterns that are updated (improved) with each new release of the HTML Compressor. It is recommended that you leave these enabled at all times. However, if you prefer to turn them off (i.e., to *only* exclude the patterns you specify), you can set this to a `TRUE` value to disable all of those which are built-in. Built-in exclusions deal with things that should almost always be excluded; for any site. If you'd like to see the list of built-in patterns you can read the `$built_in_regex_css_exclusion_patterns` class property. It's an array of regular expressions that are compared to external CSS file `href` values (i.e., URLs or paths); and they are also compared to the contents of any inline `<style></style>` tags.
246 | 
247 | - (boolean)`disable_built_in_js_exclusions` Defaults to `FALSE`. There are a few built-in exclusion patterns that are updated (improved) with each new release of the HTML Compressor. It is recommended that you leave these enabled at all times. However, if you prefer to turn them off (i.e., to *only* exclude the patterns you specify), you can set this to a `TRUE` value to disable all of those which are built-in. Built-in exclusions deal with things that should almost always be excluded; for any site. If you'd like to see the list of built-in patterns you can read the `$built_in_regex_js_exclusion_patterns` class property. It's an array of regular expressions that are compared to external JS file `src` values (i.e., URLs or paths); and they are also compared to the contents of any inline `<script></script>` tags.
248 | 
249 | - (boolean)`disable_built_in_uri_exclusions` Defaults to `FALSE`. There are a few built-in exclusion patterns that are updated (improved) with each new release of the HTML Compressor. It is recommended that you leave these enabled at all times. However, if you prefer to turn them off (i.e., to *only* exclude the patterns you specify), you can set this to a `TRUE` value to disable all of those which are built-in. Built-in exclusions deal with things that should almost always be excluded; for any site. If you'd like to see the list of built-in patterns you can read the `$built_in_regex_uri_exclusion_patterns` class property. It's an array of regular expressions that are compared to URIs (i.e., everything after the domain).
250 | 
251 | ----
252 | 
253 | ##### The following options can be used to setup custom cache directories/URLs.
254 | 
255 | *NOTE: under most circumstances, the built-in default values will do just fine.*
256 | 
257 | - (string)`cache_expiration_time` Defaults to a value of `14 days`. You can use anything compatible with PHP's `strtotime()` function.
258 |  NOTE: This expiration time is mostly irrelevant, because the HTML Compressor uses an internal checksum, and it also checks `filemtime()` before
259 |  using an existing cache file. The HTML Compressor class also handles the automatic cleanup of your cache directories to keep it from growing too large over time.
260 |  Therefore, unless you have VERY little disk space there is no reason to set this to a lower value (even if your site changes dynamically quite often).
261 |  If anything, you might like to increase this value which could help to further reduce server load.
262 | 
263 |   **There are two scenarios where a cache regeneration occurs.**
264 | 
265 |   1. When a cache file expires (based on your expiration time).
266 |   2. A cache file MUST be regenerated because there is a checksum mis-match (e.g., the content changed dynamically).
267 | 
268 |   In short, `cache_expiration_time` controls the first scenario; i.e., the absolute maximum amount of time that a cache file can ever live (or be used); and this will impact the automatic cleanup routine too of course.
269 | 
270 | - (string)`cache_dir_public` Absolute server path to a local cache directory that is available over HTTP (i.e., publicly accessible).
271 |  If you exclude this, there are two default handlers. If `WP_CONTENT_DIR` is defined (i.e., you are running this within WordPress),
272 |  then your public cache directory will be located under: `wp-content/htmlc/cache/public`. Otherwise, this will default to
273 |  a value of `$_SERVER['DOCUMENT_ROOT']/htmlc/cache/public`.
274 | 
275 | - (string)`cache_dir_url_public` A publicly available URL which leads to your `cache_dir_public`.
276 |  If you exclude this option, an automatic detection is used (i.e., a best guess based on `cache_dir_public`).
277 | 
278 | - (string)`cache_dir_private` Absolute server path to a local cache directory that is NOT available over HTTP (i.e., private/hidden).
279 |  If you exclude this, there are two default handlers. If `WP_CONTENT_DIR` is defined (i.e., you are running this within WordPress),
280 |  then your private cache directory will be located under: `wp-content/htmlc/cache/private`. Otherwise, this will default to
281 |  a value of `$_SERVER['DOCUMENT_ROOT']/htmlc/cache/private`.
282 | 
283 | - (string)`cache_dir_url_private` Not applicable. This option exists internally but URLs to the private cache directory
284 |  are never generated. Therefore, under normal circumstances you can ignore this option value all together.
285 | 
286 | - (boolean)`cleanup_cache_dirs` Defaults to TRUE. By default, cache directories are cleaned up automatically
287 |  over time; i.e., at semi-random intervals and also based on your `cache_expiration_time`. If you would prefer to cleanup
288 |  the cache on your own, you can set this to a FALSE value.
289 | 
290 | ----
291 | 
292 | ##### The following options can be used to specify the current URL.
293 | 
294 | *NOTE: it is normally NOT necessary to supply any of these values.*
295 | 
296 | - (string)`current_url_scheme` When this class is running as a web application, we can detect this value automatically.
297 |  That said, if you intend to run this class outside of a web server environment you will need to tell the compressor
298 |  what the current URL scheme would be if the file you are compressing was being served as a web page.
299 |  This should be set to one of `https` or `http`.
300 | 
301 | - (string)`current_url_host` When this class is running as a web application, we can detect this value automatically.
302 |  That said, if you intend to run this class outside of a web server environment you will need to tell the compressor
303 |  what the current URL host would be if the file you are compressing was being served as a web page.
304 |  This should be set to something like `www.example.com`.
305 | 
306 | - (string)`current_url_uri` When this class is running as a web application, we can detect this value automatically.
307 |  That said, if you intend to run this class outside of a web server environment you will need to tell the compressor
308 |  what the current URI (i.e., path and query string) would be if the file you are compressing was being served as a web page.
309 |  This should be set to something like `/path/to/page/?one=1&two=2`.
310 | 
311 | ----
312 | 
313 | ##### The following options control compression behavior.
314 | 
315 | *NOTE: compression routines are applied in the same order as these options are listed below.*
316 | 
317 | - (boolean)`compress_combine_head_body_css` TRUE by default. If you prefer NOT to combine CSS files into a single HTTP connection,
318 |  please set this to a FALSE value. This can be helpful if your site (for whatever reason) is incompatible with the CSS compress-combine routines.
319 |  NOTE: if you disable this due to an incompatibility, please report it via GitHub so the issue can be resolved for everyone.
320 | 
321 | - (boolean)`compress_combine_head_js` TRUE by default. If you prefer NOT to combine JS files into a single HTTP connection,
322 |  please set this to a FALSE value. This can be helpful if your site (for whatever reason) is incompatible with the JS compress-combine routines.
323 |  NOTE: if you disable this due to an incompatibility, please report it via GitHub so the issue can be resolved for everyone.
324 | 
325 | - (boolean)`compress_combine_footer_js` TRUE by default. If you prefer NOT to combine JS files in the footer into a single HTTP connection,
326 |  please set this to a FALSE value. This can be helpful if your site (for whatever reason) is incompatible with the JS compress-combine routines.
327 |  NOTE: if you disable this due to an incompatibility, please report it via GitHub so the issue can be resolved for everyone.
328 | 
329 | - (boolean)`compress_combine_remote_css_js` TRUE by default. If you prefer NOT to combine CSS/JS files from remote resource locations
330 |  please set this to a FALSE value. By default, the options: `compress_combine_head_body_css`, `compress_combine_head_js`, `compress_combine_footer_js` will recursively combine all resources (including those from remote locations).
331 |  If you set this to a FALSE value, all remote (externally hosted resources; e.g., those from CDNs or other remote URLs) will be excluded automatically to prevent remote off-site connections from taking place.
332 | 
333 | - (boolean)`compress_inline_js_code` TRUE by default. If you prefer NOT to compress inline JS code (i.e., minify the contents of inline `<script>` tags),
334 |  please set this to a FALSE value. This can be helpful if your site (for whatever reason) is incompatible with the inline JS compression routines.
335 |  NOTE: if you disable this due to an incompatibility, please report it via GitHub so the issue can be resolved for everyone.
336 | 
337 | - (boolean)`compress_css_code` TRUE by default. If you prefer NOT to compress CSS files (i.e., minify the underlying CSS code),
338 |  please set this to a FALSE value. This can be helpful if your site (for whatever reason) is incompatible with the CSS compression routines.
339 |  NOTE: if you disable this due to an incompatibility, please report it via GitHub so the issue can be resolved for everyone.
340 | 
341 | - (boolean)`compress_js_code` TRUE by default. If you prefer NOT to compress JS files (i.e., minify the underlying JS code),
342 |  please set this to a FALSE value. This can be helpful if your site (for whatever reason) is incompatible with the JS compression routines.
343 |  NOTE: if you disable this due to an incompatibility, please report it via GitHub so the issue can be resolved for everyone.
344 | 
345 | - (boolean)`compress_html_code` TRUE by default. If you prefer NOT to compress HTML markup (i.e., the removal of extra whitespace, etc),
346 |  please set this to a FALSE value. This can be helpful if your site (for whatever reason) is incompatible with the HTML compression routines.
347 |  NOTE: if you disable this due to an incompatibility, please report it via GitHub so the issue can be resolved for everyone.
348 | 
349 | - (boolean)`amp_exclusions_enable` TRUE by default. This improves compatibility with [Accelerated Mobile Pages](https://www.ampproject.org/). When this option is enabled and the URI being compressed ends with `/amp/`, or the document contains a top-level `<html ⚡>` tag (`<html amp>` is accepted as well), then features which are incompatible with [Accelerated Mobile Pages](https://www.ampproject.org/) will be disabled accordingly, regardless of your other settings.
350 | 
351 | ----
352 | 
353 | ##### Other misc. options. These don't really fall into any specific category yet.
354 | 
355 | - (boolean) or (string)`benchmark` Off by default. If enabled, HTML comments are added to the final output with some useful information. If you set this to a `TRUE` value, it simply enables an overall time calculation. If you're debugging, and you need to see many other details too; you can set this to the string: `details` (not recommended in a production environment).
356 | 
357 | - (string)`product_title` Define this if you'd like to change the title of a particular HTML Compressor instance (i.e., to change the name from the default "HTML Compressor" to something else you like better). If undefined, this defaults to `HTML Compressor`. Note: this impacts the title of the product displayed in the HTML comments; assuming that `benchmark` is enabled where comments are included in the final output.
358 | 
359 | - (array)`vendor_css_prefixes` An array of known vendor-specific CSS prefixes. Defaults to `array('moz','webkit','khtml','ms','o')`.
360 | 


--------------------------------------------------------------------------------
/LICENSE.txt:
--------------------------------------------------------------------------------
  1 |                     GNU GENERAL PUBLIC LICENSE
  2 |                        Version 3, 29 June 2007
  3 | 
  4 |  Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
  5 |  Everyone is permitted to copy and distribute verbatim copies
  6 |  of this license document, but changing it is not allowed.
  7 | 
  8 |                             Preamble
  9 | 
 10 |   The GNU General Public License is a free, copyleft license for
 11 | software and other kinds of works.
 12 | 
 13 |   The licenses for most software and other practical works are designed
 14 | to take away your freedom to share and change the works.  By contrast,
 15 | the GNU General Public License is intended to guarantee your freedom to
 16 | share and change all versions of a program--to make sure it remains free
 17 | software for all its users.  We, the Free Software Foundation, use the
 18 | GNU General Public License for most of our software; it applies also to
 19 | any other work released this way by its authors.  You can apply it to
 20 | your programs, too.
 21 | 
 22 |   When we speak of free software, we are referring to freedom, not
 23 | price.  Our General Public Licenses are designed to make sure that you
 24 | have the freedom to distribute copies of free software (and charge for
 25 | them if you wish), that you receive source code or can get it if you
 26 | want it, that you can change the software or use pieces of it in new
 27 | free programs, and that you know you can do these things.
 28 | 
 29 |   To protect your rights, we need to prevent others from denying you
 30 | these rights or asking you to surrender the rights.  Therefore, you have
 31 | certain responsibilities if you distribute copies of the software, or if
 32 | you modify it: responsibilities to respect the freedom of others.
 33 | 
 34 |   For example, if you distribute copies of such a program, whether
 35 | gratis or for a fee, you must pass on to the recipients the same
 36 | freedoms that you received.  You must make sure that they, too, receive
 37 | or can get the source code.  And you must show them these terms so they
 38 | know their rights.
 39 | 
 40 |   Developers that use the GNU GPL protect your rights with two steps:
 41 | (1) assert copyright on the software, and (2) offer you this License
 42 | giving you legal permission to copy, distribute and/or modify it.
 43 | 
 44 |   For the developers' and authors' protection, the GPL clearly explains
 45 | that there is no warranty for this free software.  For both users' and
 46 | authors' sake, the GPL requires that modified versions be marked as
 47 | changed, so that their problems will not be attributed erroneously to
 48 | authors of previous versions.
 49 | 
 50 |   Some devices are designed to deny users access to install or run
 51 | modified versions of the software inside them, although the manufacturer
 52 | can do so.  This is fundamentally incompatible with the aim of
 53 | protecting users' freedom to change the software.  The systematic
 54 | pattern of such abuse occurs in the area of products for individuals to
 55 | use, which is precisely where it is most unacceptable.  Therefore, we
 56 | have designed this version of the GPL to prohibit the practice for those
 57 | products.  If such problems arise substantially in other domains, we
 58 | stand ready to extend this provision to those domains in future versions
 59 | of the GPL, as needed to protect the freedom of users.
 60 | 
 61 |   Finally, every program is threatened constantly by software patents.
 62 | States should not allow patents to restrict development and use of
 63 | software on general-purpose computers, but in those that do, we wish to
 64 | avoid the special danger that patents applied to a free program could
 65 | make it effectively proprietary.  To prevent this, the GPL assures that
 66 | patents cannot be used to render the program non-free.
 67 | 
 68 |   The precise terms and conditions for copying, distribution and
 69 | modification follow.
 70 | 
 71 |                        TERMS AND CONDITIONS
 72 | 
 73 |   0. Definitions.
 74 | 
 75 |   "This License" refers to version 3 of the GNU General Public License.
 76 | 
 77 |   "Copyright" also means copyright-like laws that apply to other kinds of
 78 | works, such as semiconductor masks.
 79 | 
 80 |   "The Program" refers to any copyrightable work licensed under this
 81 | License.  Each licensee is addressed as "you".  "Licensees" and
 82 | "recipients" may be individuals or organizations.
 83 | 
 84 |   To "modify" a work means to copy from or adapt all or part of the work
 85 | in a fashion requiring copyright permission, other than the making of an
 86 | exact copy.  The resulting work is called a "modified version" of the
 87 | earlier work or a work "based on" the earlier work.
 88 | 
 89 |   A "covered work" means either the unmodified Program or a work based
 90 | on the Program.
 91 | 
 92 |   To "propagate" a work means to do anything with it that, without
 93 | permission, would make you directly or secondarily liable for
 94 | infringement under applicable copyright law, except executing it on a
 95 | computer or modifying a private copy.  Propagation includes copying,
 96 | distribution (with or without modification), making available to the
 97 | public, and in some countries other activities as well.
 98 | 
 99 |   To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies.  Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 | 
103 |   An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License.  If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 | 
112 |   1. Source Code.
113 | 
114 |   The "source code" for a work means the preferred form of the work
115 | for making modifications to it.  "Object code" means any non-source
116 | form of a work.
117 | 
118 |   A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 | 
123 |   The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form.  A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 | 
134 |   The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities.  However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work.  For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 | 
147 |   The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 | 
151 |   The Corresponding Source for a work in source code form is that
152 | same work.
153 | 
154 |   2. Basic Permissions.
155 | 
156 |   All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met.  This License explicitly affirms your unlimited
159 | permission to run the unmodified Program.  The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work.  This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 | 
164 |   You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force.  You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright.  Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 | 
175 |   Conveying under any other circumstances is permitted solely under
176 | the conditions stated below.  Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 | 
179 |   3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 | 
181 |   No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 | 
187 |   When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 | 
195 |   4. Conveying Verbatim Copies.
196 | 
197 |   You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 | 
205 |   You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 | 
208 |   5. Conveying Modified Source Versions.
209 | 
210 |   You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 | 
214 |     a) The work must carry prominent notices stating that you modified
215 |     it, and giving a relevant date.
216 | 
217 |     b) The work must carry prominent notices stating that it is
218 |     released under this License and any conditions added under section
219 |     7.  This requirement modifies the requirement in section 4 to
220 |     "keep intact all notices".
221 | 
222 |     c) You must license the entire work, as a whole, under this
223 |     License to anyone who comes into possession of a copy.  This
224 |     License will therefore apply, along with any applicable section 7
225 |     additional terms, to the whole of the work, and all its parts,
226 |     regardless of how they are packaged.  This License gives no
227 |     permission to license the work in any other way, but it does not
228 |     invalidate such permission if you have separately received it.
229 | 
230 |     d) If the work has interactive user interfaces, each must display
231 |     Appropriate Legal Notices; however, if the Program has interactive
232 |     interfaces that do not display Appropriate Legal Notices, your
233 |     work need not make them do so.
234 | 
235 |   A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit.  Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 | 
245 |   6. Conveying Non-Source Forms.
246 | 
247 |   You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 | 
252 |     a) Convey the object code in, or embodied in, a physical product
253 |     (including a physical distribution medium), accompanied by the
254 |     Corresponding Source fixed on a durable physical medium
255 |     customarily used for software interchange.
256 | 
257 |     b) Convey the object code in, or embodied in, a physical product
258 |     (including a physical distribution medium), accompanied by a
259 |     written offer, valid for at least three years and valid for as
260 |     long as you offer spare parts or customer support for that product
261 |     model, to give anyone who possesses the object code either (1) a
262 |     copy of the Corresponding Source for all the software in the
263 |     product that is covered by this License, on a durable physical
264 |     medium customarily used for software interchange, for a price no
265 |     more than your reasonable cost of physically performing this
266 |     conveying of source, or (2) access to copy the
267 |     Corresponding Source from a network server at no charge.
268 | 
269 |     c) Convey individual copies of the object code with a copy of the
270 |     written offer to provide the Corresponding Source.  This
271 |     alternative is allowed only occasionally and noncommercially, and
272 |     only if you received the object code with such an offer, in accord
273 |     with subsection 6b.
274 | 
275 |     d) Convey the object code by offering access from a designated
276 |     place (gratis or for a charge), and offer equivalent access to the
277 |     Corresponding Source in the same way through the same place at no
278 |     further charge.  You need not require recipients to copy the
279 |     Corresponding Source along with the object code.  If the place to
280 |     copy the object code is a network server, the Corresponding Source
281 |     may be on a different server (operated by you or a third party)
282 |     that supports equivalent copying facilities, provided you maintain
283 |     clear directions next to the object code saying where to find the
284 |     Corresponding Source.  Regardless of what server hosts the
285 |     Corresponding Source, you remain obligated to ensure that it is
286 |     available for as long as needed to satisfy these requirements.
287 | 
288 |     e) Convey the object code using peer-to-peer transmission, provided
289 |     you inform other peers where the object code and Corresponding
290 |     Source of the work are being offered to the general public at no
291 |     charge under subsection 6d.
292 | 
293 |   A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 | 
297 |   A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling.  In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage.  For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product.  A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 | 
310 |   "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source.  The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 | 
318 |   If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information.  But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 | 
329 |   The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed.  Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 | 
337 |   Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 | 
343 |   7. Additional Terms.
344 | 
345 |   "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law.  If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 | 
354 |   When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it.  (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.)  You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 | 
361 |   Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 | 
365 |     a) Disclaiming warranty or limiting liability differently from the
366 |     terms of sections 15 and 16 of this License; or
367 | 
368 |     b) Requiring preservation of specified reasonable legal notices or
369 |     author attributions in that material or in the Appropriate Legal
370 |     Notices displayed by works containing it; or
371 | 
372 |     c) Prohibiting misrepresentation of the origin of that material, or
373 |     requiring that modified versions of such material be marked in
374 |     reasonable ways as different from the original version; or
375 | 
376 |     d) Limiting the use for publicity purposes of names of licensors or
377 |     authors of the material; or
378 | 
379 |     e) Declining to grant rights under trademark law for use of some
380 |     trade names, trademarks, or service marks; or
381 | 
382 |     f) Requiring indemnification of licensors and authors of that
383 |     material by anyone who conveys the material (or modified versions of
384 |     it) with contractual assumptions of liability to the recipient, for
385 |     any liability that these contractual assumptions directly impose on
386 |     those licensors and authors.
387 | 
388 |   All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10.  If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term.  If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 | 
398 |   If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 | 
403 |   Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 | 
407 |   8. Termination.
408 | 
409 |   You may not propagate or modify a covered work except as expressly
410 | provided under this License.  Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 | 
415 |   However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 | 
422 |   Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 | 
429 |   Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License.  If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 | 
435 |   9. Acceptance Not Required for Having Copies.
436 | 
437 |   You are not required to accept this License in order to receive or
438 | run a copy of the Program.  Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance.  However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work.  These actions infringe copyright if you do
443 | not accept this License.  Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 | 
446 |   10. Automatic Licensing of Downstream Recipients.
447 | 
448 |   Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License.  You are not responsible
451 | for enforcing compliance by third parties with this License.
452 | 
453 |   An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations.  If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 | 
463 |   You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License.  For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 | 
471 |   11. Patents.
472 | 
473 |   A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based.  The
475 | work thus licensed is called the contributor's "contributor version".
476 | 
477 |   A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version.  For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 | 
487 |   Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 | 
492 |   In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement).  To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 | 
499 |   If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients.  "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 | 
513 |   If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 | 
521 |   A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License.  You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 | 
536 |   Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 | 
540 |   12. No Surrender of Others' Freedom.
541 | 
542 |   If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License.  If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all.  For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 | 
552 |   13. Use with the GNU Affero General Public License.
553 | 
554 |   Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work.  The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 | 
563 |   14. Revised Versions of this License.
564 | 
565 |   The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time.  Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 | 
570 |   Each version is given a distinguishing version number.  If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation.  If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 | 
579 |   If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 | 
584 |   Later license versions may give you additional or different
585 | permissions.  However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 | 
589 |   15. Disclaimer of Warranty.
590 | 
591 |   THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 | 
600 |   16. Limitation of Liability.
601 | 
602 |   IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 | 
612 |   17. Interpretation of Sections 15 and 16.
613 | 
614 |   If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 | 
621 |                      END OF TERMS AND CONDITIONS
622 | 
623 |             How to Apply These Terms to Your New Programs
624 | 
625 |   If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 | 
629 |   To do so, attach the following notices to the program.  It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 | 
634 |     <one line to give the program's name and a brief idea of what it does.>
635 |     Copyright (C) <year>  <name of author>
636 | 
637 |     This program is free software: you can redistribute it and/or modify
638 |     it under the terms of the GNU General Public License as published by
639 |     the Free Software Foundation, either version 3 of the License, or
640 |     (at your option) any later version.
641 | 
642 |     This program is distributed in the hope that it will be useful,
643 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
644 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
645 |     GNU General Public License for more details.
646 | 
647 |     You should have received a copy of the GNU General Public License
648 |     along with this program.  If not, see <http://www.gnu.org/licenses/>.
649 | 
650 | Also add information on how to contact you by electronic and paper mail.
651 | 
652 |   If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 | 
655 |     <program>  Copyright (C) <year>  <name of author>
656 |     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 |     This is free software, and you are welcome to redistribute it
658 |     under certain conditions; type `show c' for details.
659 | 
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License.  Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 | 
664 |   You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | <http://www.gnu.org/licenses/>.
668 | 
669 |   The GNU General Public License does not permit incorporating your program
670 | into proprietary programs.  If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library.  If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License.  But first, please read
674 | <http://www.gnu.org/philosophy/why-not-lgpl.html>.
675 | 


--------------------------------------------------------------------------------