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.

[jw00dy]

working on 3.6.0 here as well.

*clicks install*

[mIRCnet]

Does this work for vB 3.6.0 Gold?
I have mod_gzip installed in my server, and its enabled in vBulletin Optins using level 9, more over i am using this hack Plugin Based Template Cache
so does it work with it?

[Robru]

Work good with 3.6.2

[JMH11788]

Originally Posted by Robru

Work good with 3.6.2

Same here :up:

[The Chief]

Originally Posted by JMH11788

Same here :up:

Good to know

[flindersredclaw]

No issues on 3.6.1 and gaining 8 to 15% saving.

Thank you.

[Zachery]

Honestly, apologies to Hellcat, but this is a useless modification, any compression that is done by php should be done in the template conviersion, also anyone using gzip will already be getting these benifits and all this does is increase the load of the server. Gzip/mod_deflate would be prefered over this method.

[Augustino]

How can I include this product, using it in my own templates, What should I include?

Originally Posted by Zachery

Honestly, apologies to Hellcat, but this is a useless modification, any compression that is done by php should be done in the template conviersion, also anyone using gzip will already be getting these benifits and all this does is increase the load of the server. Gzip/mod_deflate would be prefered over this method.

How can I implement Gzip/mod_deflate?

[BobbyBig]

People Take Care.

This Modification has destroyed my Style + some Functions of the Forum. I had to replace the whole Style from a Backup.

What happend: In the AdminCP on the Style Edit Page (Header, Footer , etc) Changes hadnt been done for like 30min. After pressing the Save Button to save the Style Edit Page, the Login Window appeared because no changes for a long time (autologout).

After logined the Page gets redirected to save the Style -> Here the Error happens with this Modification: The Whole Style data gets changed to non Line Breaks etc = unreadable.

But: it also saves the eval Data to the Fields. For example if you have a Style Replacement Variable defined, its saves the new Style Data with the Variabels REPLACED.

After this also my PM's only got send with empty Text. New Threads also couldnt be created because vBulletin said they are empty..

So ppl take care of that modification, it could destroy your whole Style + More.

regards

[rjmjr69]

Originally Posted by Dave-ahfb

It alters the output, it does not touch pre-rendered templates.

Dave

Nice works great in 3.6.4 Average is roughly 8% Thank you