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.

[Hellcat]

Originally Posted by Chris-777

One thing that'd be nice to add is a switch in the ACP for "show to admins only" that would toggle the conditional. I'm a total geek about this stuff and I like to see it all, but my members are mostly saying "What the heck is that stuff down below?"

That could be done.
Noted for the next update

Originally Posted by Zia

but asking... this one remove white spcace....
& realtime temp. compressor...compress maybe not remove white space...
can u modify it...bit more........
something similliar two in one....

Not sure if I'm getting you there....
What do you want to be able to turn ON/OFF?
Making striping leading whitespace as option?

Originally Posted by XtAzY

nice but i like the compression for the first release, the new update one decreases very slightly

its prob because my css is used externally

That's weird.
Shouldn't have any effect if the CSS are external....
Do you have comments with "[" in it? 'cause those are left allone now to asure AnyMedia will not screwed up.
(I'm trying to do a better RegEx for that anyway....)

[Lizard King]

Originally Posted by Hellcat

That could be done.
Noted for the next update



Not sure if I'm getting you there....
What do you want to be able to turn ON/OFF?
Making striping leading whitespace as option?



That's weird.
Shouldn't have any effect if the CSS are external....
Do you have comments with "[" in it? 'cause those are left allone now to asure AnyMedia will not screwed up.
(I'm trying to do a better RegEx for that anyway....)

I also have my CSS external so i think currently there is a problem.

[99SIVTEC]

the css is posted when the headinclude variable is parsed which should be before this outputs?

[Hellcat]

Originally Posted by 99SIVTEC

the css is posted when the headinclude variable is parsed which should be before this outputs?

Yep.
The compressor kicks in when all parsing and HTML building is done, just before the actual output is send to the browser.

I also put the CSS on my test system into external files -> no problem there.
Still getting good results. (around ~13%).

Originally Posted by XtAzY

nice but i like the compression for the first release, the new update one decreases very slightly

By looking at the code changes the only explanation I have for this is the comments containing "[" - I'd guess you have some of those.... have you?


@Lizard King
By looking at the source of your pages it looks like they ARE propperly compressed.
There's no whitespace, linebreaks or comments left that are supposed to go.

Maybe only the DISPLAY is of....

Could that be caused by vbSEO???
With the 1.00 everthing was fine?

It's getting more and more weird....
But I'm still on it!

[Lizard King]

Originally Posted by Hellcat

Yep.
The compressor kicks in when all parsing and HTML building is done, just before the actual output is send to the browser.

I also put the CSS on my test system into external files -> no problem there.
Still getting good results. (around ~13%).



By looking at the code changes the only explanation I have for this is the comments containing "[" - I'd guess you have some of those.... have you?


@Lizard King
By looking at the source of your pages it looks like they ARE propperly compressed.
There's no whitespace, linebreaks or comments left that are supposed to go.

Maybe only the DISPLAY is of....

Could that be caused by vbSEO???
With the 1.00 everthing was fine?

It's getting more and more weird....
But I'm still on it!

I will probably upgrade vbseo today. While the upgrade process , i will disable vbseo and check if the problem is about vbseo but the first version worked pretty good with me. If you still have the first version i may try with it also.

[Hellcat]

Attached is the previous version:

[Martin]

7-19%

excellent job

[Snatch]

Great Job 7-17%

[Hellcat]

Originally Posted by Hellcat

By looking at the code changes the only explanation I have for this is the comments containing "[" - I'd guess you have some of those.... have you?

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

[klaush]

Great, great, great!!!

Thanks a lot!