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.

[snakes1100]

Just a little report for anyone wondering as i was, this is running on www.stuntlife.com/forums/index.php and here are the results.

Currently zlib compression is on in the admincp at lvl 1, plugin off, results:
Original Size: 99 K
Gzipped Size: 16 K
Data Savings: 83.84%

Zlib and Plugin active:
Original Size: 91 K
Gzipped Size: 15 K
Data Savings: 83.52%

Average of 10% saving with plugin active on the main index page of the forums.

I wanted to report as this is a very effective addon, this is a very active site, some stats Threads: 140,204, Posts: 1,807,586, Members: 38,525 so if anyone is wondering about its effectiveness, they shouldn't have to, great job HellCat, thanx very much, the owner of stuntlife appreciates it very much.

Added Note: Page laod times have NOT changed, still between 1.5 - 2.5 after adding the plugin.

[dethfire]

Originally Posted by snakes1100

Just a little report for anyone wondering as i was, this is running on www.stuntlife.com/forums/index.php and here are the results.

Currently zlib compression is on in the admincp at lvl 1, plugin off, results:
Original Size: 99 K
Gzipped Size: 16 K
Data Savings: 83.84%

Zlib and Plugin active:
Original Size: 91 K
Gzipped Size: 15 K
Data Savings: 83.52%

Average of 10% saving with plugin active on the main index page of the forums.

I wanted to report as this is a very effective addon, this is a very active site, some stats Threads: 140,204, Posts: 1,807,586, Members: 38,525 so if anyone is wondering about its effectiveness, they shouldn't have to, great job HellCat, thanx very much, the owner of stuntlife appreciates it very much.

Added Note: Page laod times have NOT changed, still between 1.5 - 2.5 after adding the plugin.

how do you figure out the gzip savings?

[Zia]

Originally Posted by snakes1100

Just a little report for anyone wondering as i was, this is running on www.stuntlife.com/forums/index.php and here are the results.

Currently zlib compression is on in the admincp at lvl 1, plugin off, results:
Original Size: 99 K
Gzipped Size: 16 K
Data Savings: 83.84%

Zlib and Plugin active:
Original Size: 91 K
Gzipped Size: 15 K
Data Savings: 83.52%

Average of 10% saving with plugin active on the main index page of the forums.

I wanted to report as this is a very effective addon, this is a very active site, some stats Threads: 140,204, Posts: 1,807,586, Members: 38,525 so if anyone is wondering about its effectiveness, they shouldn't have to, great job HellCat, thanx very much, the owner of stuntlife appreciates it very much.

Added Note: Page laod times have NOT changed, still between 1.5 - 2.5 after adding the plugin.

Yeap me too wondering....how u defined Zlib & Gzip ststuas?

[Smiry Kin's]

dude nice lil html function, im just getting into editing vbulletin forums.. damn its addtive!

[dethfire]

Fatal error: Cannot redeclare cb_script() (previously declared in /home/musicban/public_html/includes/functions.php(4320) : eval()'d code:114) in /home/musicban/public_html/includes/functions.php(4320) : eval()'d code on line 7

[Hellcat]

Originally Posted by dethfire

Fatal error: Cannot redeclare cb_script() (previously declared in /home/musicban/public_html/includes/functions.php(4320) : eval()'d code:114) in /home/musicban/public_html/includes/functions.php(4320) : eval()'d code on line 7

Are you using it together with Trigunflame's template compressor?

[Gripemaster]

Very nice!!! *Clicks Install*

[Borimikan]

great job i got 9.60%!!

[dbembibre]

Originally Posted by Lizard King

Working pretty good but you have an uncached template "pagecompressor_stats".

Edit : I cache this template as i always did to other templates but it didn't work. I forget the "s" in the end Perfect hack

Hey Lizard, this plugin work well with the geek auto link ?

[BillP]

I'm testing this compressor, and I'm having a very hard time reconciling the statistics generated by the compressor (as shown to me on the bottom of every page) to the real size of the page.

I am using FireFox with the Web Developer Toolbar, which offers a quick summary of the space used on a page.

The document itself (the HTML for that page, less all external data such as images, CSS, etc.) is the only thing that gets compressed, and that's correct, but I am seeing around 10% savings, but the stats consistently say 22% or so savings.

I'll keep staring at the calculations, but I think the stats are not accurate.

I wonder if Firefox is measuring the GZipped output? My server uses gzip everywhere, and the stats are definitely calculated pre-gzip, the difference could be in the exploded/deflated sizes.

I don't see that I'll be able to measure the true bandwidth savings, as 10% on a page is meaningless compared to the images and CSS that go along with it. For example, my forums home page has 9K of data, 46K of images, 1K of style sheets, and 13K of scripts (vbulletin_global.js, for example). The stats say that my page compression was: [page compression: 65.53 k/84.13 k (22.11%)]

If I turn off the page compression, the document increases from 9K to 10K, all other stuff remains the same, so Firefox reports a 71K page.

I just can't reconcile this. Can anyone else see similar results?