HELLCAT's Realtime Page Compressor

This is my version of a realtime page compressor.
The idea is based on ShiningArcanine's port of the "Realtime Template Compressor", that is also based on the original concept by Logician, and can be found in this thread:
https://vborg.vbsupport.ru/showthread.php?t=83248

But since my version doesn't contain any of his original code anymore (even the regular expressions have been rewritten) and I added a bunch of new features I finally decided to release this one as a speperate thing.

Features:

• Copmresses the final HTML output sent to the browser by ~10% to ~15%
  (see bellow for how this is achived)
• Full controll via AdminCP options
  (you can turn it ON/OFF and choose if, and how the stats should be displayed - see screenshot)
• Stats display can be fully customized via template edit
• Areaes with intentional/wanted whitespace are left untouched
  (So this does not mess up user inputted text, text in [code] blocks and the such....)
• JavaScript blocks are kept intact and functional

What does this exately do?
This plugin strips all unneccesary whitespace, linebreaks and HTML comments out of the final HTML code that vBulletin sends to the browser.
This way the pages get a bit smaller (saving bandwidth) and the browser often renders the pages faster since there's no whitespace it must skip.

Passages that are enclosed by <pre> and <textarea> tags are left untouched completely so text posted in [code], [php] and other bb-tags of that sort are not affected and kept like the user intended them to be.
Passages enclosed in <script> tags are only striped from leading whitspace but not of linebreaks - this way JavaScript (and other) code will remain functional and does not get messed up.


How to install
Couldn't be more easy.
If you have any other page/template complression tool installed -> uninstall it first.

Then go to "AdminCP -> Product Manager -> Add/Import product" and import the .XML you downloaded here.

Now go to the "vBulletin Options" in the AdminCP, under "Help Server Settings and Optimization Options" you will find the "Realtime Page Compressor Options" settings group.
Open the settings, change them to what you want and hit "SAVE"
(It's important that you SAVE the options even when you want to use the defaults! For vB to actually create theese settings in the DB they have to be saved at least once!!!)

Done

More details are in the README.


Have fun!


UPDATE 1.10
Not a day old and here comes the first update

• Added compatibility for the "Any Media BB Code"
  Before the Any Media BB Code was screwed up in IE when the compressor was active -> FIXED
• Raised compresseion ratio another 1 to 3 percent
  "Code comments" (stuff between "/*" and "*/" - used in CSS and JS for example) are now striped as well.

Update 1.20

• Added the option to show the stats display to admins only.
  Go to "AdminCP -> vBulletin Options -> Real Time Compressor Settings" and you will find the new option there.
• Fixed the "uncached template" issue
• Tweaked the RegEx' a bit more
  But they still need quite some optimization/tweaking

Update 1.21

• Added HTML tag to exclude blocks from compression
  Put blocks of HTML source between <nocompress>Your Source</nocompress> tags to have it untouched by the page compression.

[BillP]

OK, to be fair, I loaded some larger pages and the size difference is higher, ~25% I am seeing now.

This has got to be a gzip issue, as the page size changed from 19K down to 6K, but the stats from this product said it was from 162K to 125K.

Hmmmmm.....

[BillP]

Well, it's gotta be something to do with the gzip capabilities of Apache. Firefoxs numbers are way too low. I did a "wget" of the page with HELLCAT's compressor turned off and on, and the real data is 5x what firefox reports.

If you are using Gzip, the real difference is not going to be as big as you would think from looking at these numbers. And you are just trading off CPU utilization in mod_gzip for cpu utilization in Hellcat's compressor.

BUT, the resulting file is smaller at browswer, which is still a good thing.

[Akagi]

clicks install.. installation couldnt be easier!

[armagan]

[page compression: 23.05 k/27.93 k (17.48%)]
[page compression: 120.00 k/140.53 k (14.61%)]

[Smiry Kin's]

Originally Posted by tgreer

Installed. One minor glitch:

See the little "-->" HTML close comment thingie? Is that a problem in your code, or perhaps mine?

ermm looks like yours dude?

uninstall it, is it still there?

[emin3m]

thanx GOD ur removing comments on global_complete, cz i replace stuff in parse_template
AWESOME MOD

[emin3m]

replace

$output = preg_replace('/>[\s]+</', "> <" ,$output );

with

$output = preg_replace('/>[\s]+</', "><" ,$output );

save more
1%-3%

[Hellcat]

Originally Posted by tgreer

Yep, the problem is with nested HTML comments.

Evidently, you capture the first "-->" to end the comment, so anything else, including the real final "-->" is html-encoded and added to the response stream.

Deleting the internal comment-blocks solved the issue, but it might be something you look at.

I will look at this and make an update! :up:

Originally Posted by emin3m

replace

$output = preg_replace('/>[\s]+</', "> <" ,$output );

with

$output = preg_replace('/>[\s]+</', "><" ,$output );

save more
1%-3%

Only problem here is this WILL break certain spots of your style since intentional spaces are cut out as well!
That's why I added the space, see a few pages earlier.

[MR-2ZZ]

Installed...

14% average!

[Sculli]

Excellent product, sorry you got bunched into a HotM competition with eBux/eStore, if it weren't for those you'd be taking the crown this month!