Compress Forum Templates (Speed up your Forums & Save Bandwidth)

Compress Forum Templates & Phrases

Speed up your Forums & Save Bandwidth

Vote Compress Forum Templates for HOTM

Description:

Hi, this is a pretty simple hack that involves compressing the 'compiled' version of your templates, this way it only compresses the part thats to be shown on the forum and not the actual template data you edit.

Background:

Got the idea from Zero Tolerance in buro9's thread:
https://vborg.vbsupport.ru/showthread.php?t=69787

The above hack compresses the page at parse time, while it provides some speed enhancement, on large pages you can actually "negate" the point of using the hack in the first place, because of the overhead in compression.

Thus, the creation of this hack is to provide similiar functionality, but done in the adminCP; and without the overhead of constant compression.

Info:

No Queries. Only query is used when compressing your templates, the rest of the time its just pulling the templates straight out of the database like normal.

Updates:

Version 2.8 - Added Strip Whitespace from Start of JS Line by buro9
Version 2.7 - Option to strip HTML Comments from Compressed Output
Version 2.6 - Removed Phrase Compression altogether, Too Iffy
Version 2.5 - Removed the ASCII \n removal, emails should work now.
Version 2.4 - Had to add editor_jsoptions_size to the Bad Templates array, it also was causing a font selection error.
Version 2.3 - Added Phrase compression support, should help further increase page compression.
Version 2.2 - Slightly Recoded Template compression for faster results.
Version 2.1 - Added php_include templates to bad templates, will not compress these.
Version 2.0 - Recoded Script, added support for certain templates to not compress
Version 1.9 - Re-Added support for InLine Styles.
Version 1.8 - Removed support for InLine Styles, all Style data is left with Linebreaks.
Version 1.7 - Removed support for InLine Javascript, all JavaScript is left with Linebreaks.
Version 1.6 - Fixed Tab problem, tabs are replaced with a single space
Version 1.5 - Removed a part of the SQL.
Version 1.4 - TOTALLY Remade, Works perfect now; Ultimate Compression
Version 1.3 - Adjusted Again
Version 1.2 - Adjusted Stripping regex
Version 1.1 - Added Uncompress Support
Version 1.0 - Release

Install:

Step 1. [ Open admincp/template.php ]
Step 2. [ Go to about line: 1278, or just look for $_REQUEST['do'] == 'edit' ]
Step 3. [ Above Step 2, add the below code ]

PHP Code:

// #############################################################################
// Rebuild Templates Compressed
if ($_REQUEST['do'] == 'compressall')
{
    /**
     * Compress Templates Mod
     *
     * Thanks for Idea From Zero Tolerance.
     * Thanks for Help & Support From buro9
     *
     * @author Trigunflame
     * @version 2.8
     * @copyright Dusty Burns, 2005-2006
     */

    // Strip Comments?
    // Use true or false
    $stripComments = true;

    // Search & Replace
    $search  = array('/\s+/', '/\t+/'); 
    $replace = ' '; 
    $jsearch  = array('/^\s+/', '/\t+/');
    $jreplace = array('', ' ');
    
    // Strip Comments
    if ($stripComments) { $search[] = '/<!--.*?-->/'; }
    
    // List of Templates to NOT Compress
    $badTemplates = array(
        'editor_jsoptions_font',
        'editor_jsoptions_size',
        'phpinclude_start',
        'phpinclude_end'
    );
            
    // Get Modified Templates
    $templates = $DB_site->query(
        "SELECT templateid, title, template_un " . 
        "FROM " . TABLE_PREFIX . "template " .
        "WHERE template_un <> '' "
    );
    
    // Selectively Compress
    while ($template = $DB_site->fetch_array($templates))
    {
        // Compile Template
        $compiledTemplate = compile_template($template['template_un']);
        
        // Bad Template
        if (in_array(strtolower($template['title']), $badTemplates))
        {
            // Ignoring Template
            echo "Bad Template [" . $template['templateid'] . "] " . $template['title'] . "<br />\n";
            
            $compressedTemplate = $compiledTemplate;
        }
        
        // Reverting Template
        else if ($_REQUEST['revert'])
        {
            // Uncompressing
            echo "Uncompressing [" . $template['templateid'] . "] " . $template['title'] . "<br />\n";
            
            $compressedTemplate = $compiledTemplate;
        }
        
        // Good Template
        else
        {
            // Compressing
            echo "Compressing [" . $template['templateid'] . "] " . $template['title'] . "<br />\n";
            
            // Get All Lines
            $compiledTemplate = preg_split('(\r\n|\r|\n)', $compiledTemplate);
            
            // Javascript Status
            $js = false;

            // Compressed Output
            $compressedTemplate = '';
            
            // Loop Lines
            foreach ($compiledTemplate AS $line)
            {
                // LowerCase Line
                $lowerLine = strtolower($line);
                
                // Look For Start of JavaScript
                if (strpos($lowerLine, '<script') !== false) { $js = true; }
                
                // Check For Null
                if (trim($line) == '') continue;
    
                // Check JS Status
                if (!$js && !$st)
                {
                    // Full WhiteSpace Strip
                    $line = preg_replace($search, $replace, $line);
                }
                else
                {
                    // Straight Output
                    $line = preg_replace($jsearch, $jreplace, $line) . "\r\n";
                }

                // Look For End of JavaScript
                if (strpos($lowerLine, '</script>') !== false) { $js = false; }
                
                // Check For Null
                if (trim($line) == '') continue;
                
                // Append Line
                $compressedTemplate .= $line;
            }
        }
        
        // Update Template
        $DB_site->query(
            "UPDATE " . TABLE_PREFIX . "template " . 
            "SET template = '" . addslashes($compressedTemplate) . "' " . 
            "WHERE templateid = '" . $template['templateid'] . "'"
        );
    }
    
    // Redirect
    print_cp_redirect('index.php?do=home', 1);
    
    /**
     * End Compress Templates Mod
     */
} 


Step 4. [ close admincp/template.php and open admincp/index.php ]
Step 5. [ look for ]

PHP Code:

construct_nav_option($vbphrase['find_updated_templates'], 'template.php?do=findupdates', '<br />'); 


Step 6. [ below this, add the code ]

PHP Code:

construct_nav_option("Compress Templates", 'template.php?do=compressall', '<br />');
construct_nav_option("Uncompress Templates", 'template.php?do=compressall&revert=1', '<br />'); 


How-To Run

1. Install
2. In the admincp left navigation, select "Compress Templates".
3. Repeat Step 2 after each modification of your Templates whenever you decide to change something.
4. If you want to uncompress all Templates, select "Uncompress Templates"
5. IF Any Templates Come Out Weird, add the template Name to the Bad Templates Array and Re-Run the Compress Templates.

[buro9]

Originally Posted by stan111

yeah, it works like a champ
it skips that template, now my forum going way faster
thanks a million for all your help, buro9

It could go even faster if you did two things:

1. Move your stylesheets to files. The option for this is in the AdminCP.
2. Much more time consuming... validate your pages with the W3C Validation service: http://validator.w3.org/check?uri=ht...elyviet.com%2F

Currently your pages are not coming back XHTML Transitional compliant, in fact on your home page there were 653 errors (probably only 20 or 30 things in actual templates). The cleaner your HTML is, the faster a browser will render it. Force the browser to have to deal with your errors, and it will slow down as it has to spend time trying to guess what you want.

vBulletin ships valid XHTML Transitional code... so it's just up to you to make sure when you hack it that things are still cool.

Examples:
Close your tags: <p> should always have an end </p>, <img> should always have a self-closing slash <img />.

Include required attributes: <script> has to have a type: <script type="text/javascript">

Comment out your JavaScript for non-capable browsers: <script type="text/javascript"><!--
function boo() {alert('boo');}
// --></script>

Lots of TR tags are missing.

Etc, etc.

If your HTML is clean, it will render much faster as the browsers job is much easier.

[stan111]

i didn't know that i got that many errors on my page. i keep wondering why my homepage load so damn slow
thanks a lot for showing me all of those stuffs, buro9
that will be my next project
:up: buro9

[Wisch]

Awesome, optimized my forums, no errors, very smooth and efficient as always but with a noticable loading speed increase.
Thanks / *INSTALLED*

[kzap]

can anyone convert this into a xml plugin for 3.5?

Anyway just to add to the others who posted instructions to install on vb3.5

1.) https://vborg.vbsupport.ru/showpost....&postcount=165

2.) https://vborg.vbsupport.ru/showpost....&postcount=167

3.) add the code above

// #############################################################################
// form to edit a style
if ($_REQUEST['do'] == 'editstyle')

4.) Replace $DB_site->fetch_array with $db->fetch_array

That should do it, works like a charm

[mutus123]

Originally Posted by kzap

can anyone convert this into a xml plugin for 3.5?

I have it installed on my 3.5.1 as a stand-alone product (no file edits).

I offered to either release it or give it to the original author to release, but got no response.

[buro9]

Originally Posted by mutus123

I offered to either release it or give it to the original author to release, but got no response.

I have him in trillian, I'll ask for you

[noj75]

Hi all,

I have 3.5.2 but the area thats requires this edit:

PHP Code:

construct_nav_option($vbphrase['find_updated_templates'], 'template.php?do=findupdates', '<br />'); 


actually reads like this in my admincp/index.php

PHP Code:

construct_nav_option($navoption['text'], $navoption['link']); 


Any ideas where i have to place this addition of code?

PHP Code:

  construct_nav_option("Compress Templates", 'template.php?do=compressall', '<br />'); 
construct_nav_option("Uncompress Templates", 'template.php?do=compressall&revert=1', '<br />'); 


Best regards

[T3MEDIA]

wow this really really works. Nice. Real nice.

[Trigunflame]

Originally Posted by mutus123

I have it installed on my 3.5.1 as a stand-alone product (no file edits).

I offered to either release it or give it to the original author to release, but got no response.

Im finally back from my hiatus and play to fix a lot of the bugs and release some stuff again.

Ill try to wokr on whatever I can today and tomorrow; im working on the backup system right now.

[Trigunflame]

Originally Posted by T3MEDIA

wow this really really works. Nice. Real nice.

You just now tried it ......... lol :ninja: think i made this many months ago