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.

Originally Posted by Totti

thanks alot hellcat ... uninstalled the old one, using yours ...
but the sourcecode is really messed up now (when you try to bugfix wth), great work

Haha, I kind of like the compressed source output. Makes it harder for people to swipe your ideas, and you can just disable the plugin if you need to debug something.

[GrendelKhan{TSU]

awesome!!

[high]* GrendelKhan{TSU exciting installs.
[/high]


post install:

getting 24-31% compression !! woot!


awesome!! great job!

[DementedMindz]

[Page Compression: 40.41 k/46.45 k (12.99%)] thank you

[FleaBag]

Great work! Glad to have this running... I had to uninstall the other hack due to the editing of posts issue.

[Tefra]

thank you

[page compression: 77.86 k/92.31 k (15.66%)]

[Paul M]

Originally Posted by Hellcat

HAAA HAAA
I think I found the reason for the slight drop....
During my last experiments I hit F5 a thousand times (OK, a few times less than 1000 ) and with the same page reloading (and no changes to the code in the meantime) the ratio went a bit down and up again.

vB seems to put the one or the other linebreak or comment more into the page's source from time to time.

So, nothin' to worry about a percent drop, it'll come back soon

That's probably the cronimage (link) in the footer rather than an extra comment somewhere.

[Hellcat]

Already puzzling on the 1.20 update.
The AdminCP option for only showing the stats to admins is already in and the uncached template is also already chached

Originally Posted by Paul M

That's probably the cronimage (link) in the footer rather than an extra comment somewhere.

Yap, that could be it!
Because it sometimes adds an additional line in my (rendered) page - right there where the cronimage is
Mystery solved

[bashy]

Well done m8 great hack, averaging about 10.5%

[Gizmo5h1t3]

[page compression: 30.12 k/34.29 k (12.17%)]

workin a treat mate...nice 1!!

[Red Blaze]

Mine is between 7% to 15%. Thanks alot, forums are performing alot better.
[high]* Red Blaze clicks install[/high]