The Arcive of Official vBulletin Modifications Site.

About Developer · **Released**: 04-13-2005

Compress Forum Templates & Phrases

Speed up your Forums & Save Bandwidth

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.

mutus123 · #**172** 10-15-2005, 04:18 PM

Piecing together instructions of both buro9 and hidjra, I was able to install this for 3.5.

I hope it's not wrong of me to do this but I went ahead and updated the text file instructions for 3.5.

This is a great hack, again many thanks.

Edit: Text file removed, as I discovered what I did is frowned upon here.

buro9 · #**173** 10-15-2005, 06:28 PM

Quote:

Originally Posted by mutus123

Piecing together instructions of both buro9 and hidjra, I was able to install this for 3.5.

I hope it's not wrong of me to do this but I went ahead and updated the text file instructions for 3.5, as the current installation file is obsolete. I'm posting it here to maybe help some others.

This is a great hack, again many thanks.

To be fair, the 3.5 install is virtually identical to the 3.0 install

The only real difference is adding the elements to the admincp.

I'm sure most of us simply upgraded manually

Though I'm also sure that your file will be very appreciated by those who would prefer a fuller set of instructions

mutus123 · #**174** 10-15-2005, 08:14 PM

Quote:

Originally Posted by buro9

To be fair, the 3.5 install is virtually identical to the 3.0 install

The only real difference is adding the elements to the admincp.

I'm sure most of us simply upgraded manually

Though I'm also sure that your file will be very appreciated by those who would prefer a fuller set of instructions

Understood. I realize this particular hack is for 3.0.x, therefor the install file is perfectly fine. I meant no offense.

But it won't work for 3.5, so I just thought it may help a few people to outline the process of making this work in 3.5. It's not a big deal, but like you said, many prefer a full set of instructions, and are not always confident in manipulating code, nor able to solve a problem when an error occurs. So I just combined yours and hidjra's instructions.

Cheers and thank you again for this wonderful hack

buro9 · #**175** 10-16-2005, 08:22 AM

Quote:

Originally Posted by mutus123

Cheers and thank you again for this wonderful hack

Oh, it's not mine, it's Trigunflames. Next time I see him on messenger I'm gonna bug him to re-package for 3.5. The live compress hack out there needs to be taken down by this one... this one is just so much more efficient (less overhead as you only do when you change things, not on every page hit).

stan111 · #**176** 10-16-2005, 11:04 PM

thanks a lot , buro9
i have template mod like background picture in the quick reply text message area
https://vborg.vbsupport.ru/showthrea...und+quickreply

i dont know if this would make it disappear

buro9 · #**177** 10-17-2005, 07:10 AM

Quote:

Originally Posted by stan111

thanks a lot , buro9
i have template mod like background picture in the quick reply text message area
https://vborg.vbsupport.ru/showthrea...und+quickreply

i dont know if this would make it disappear

It's very likely.

I can't see the source code of the template to be able to see what it might do. The hack you linked to is very old and the original zip file attached to that thread is no longer there.

I would suggest that you either add this template to the array of bad_templates so that it doesn't get compressed (everything else still will), or that you uninstall that hack or revert the template.

stan111 · #**178** 10-17-2005, 07:56 AM

thanks again for a fast reply, buro9
i added too many hacks and now i have no idea how to uninstall that
so would you please show me how to add that template to array of bad_templates ?

buro9 · #**179** 10-17-2005, 08:01 AM

Quote:

Originally Posted by stan111

thanks again for a fast reply, buro9
i added too many hacks and now i have no idea how to uninstall that
so would you please show me how to add that template to array of bad_templates ?

Just take the name of the template that is breaking, and find this piece of code in the compression hack above:

PHP Code:


			
    $badTemplates = array(

        'editor_jsoptions_font',

        'editor_jsoptions_size',

        'phpinclude_start',

        'phpinclude_end'

    );

Simply add the name of the template that is causing problems to that array... which means adding a line like this at the end of the array (but within the brackets):

PHP Code:


			
,'templateName'

And then upload and re-run the admincp thingy and it will skip compressing that template.

Oh, one more thing... if you have already applied the hack and it is still broken, uncompress the templates, apply this change, and the re-compress the templates

stan111 · #**180** 10-17-2005, 08:03 AM

omg, u r so fast, man
you rock
thanks a ton
let me go try that now

stan111 · #**181** 10-17-2005, 08:15 AM

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

X vBulletin 3.8.12 by vBS Debug Information
Page Generation 0.05245 seconds Memory Usage 2,368KB Queries Executed 26 (?)
More Information
Template Usage: (1)SHOWTHREAD (1)ad_footer_end (1)ad_footer_start (1)ad_header_end (1)ad_header_logo (1)ad_navbar_below (1)ad_showthread_beforeqr (5)bbcode_php (5)bbcode_quote (1)footer (1)forumjump (1)forumrules (1)gobutton (1)header (1)headinclude (1)modsystem_post (1)navbar (6)navbar_link (120)option (1)pagenav (1)pagenav_curpage (3)pagenav_pagelink (1)pagenav_pagelinkrel (11)post_thanks_box (11)post_thanks_button (1)post_thanks_javascript (1)post_thanks_navbar_search (11)post_thanks_postbit_info (10)postbit (11)postbit_onlinestatus (11)postbit_wrapper (1)spacer_close (1)spacer_open (1)tagbit_wrapper Phrase Groups Available: global inlinemod postbit posting reputationlevel showthread	Included Files: ./showthread.php ./global.php ./includes/init.php ./includes/class_core.php ./includes/config.php ./includes/functions.php ./includes/class_hook.php ./includes/modsystem_functions.php ./includes/functions_bigthree.php ./includes/class_postbit.php ./includes/class_bbcode.php ./includes/functions_reputation.php ./includes/functions_post_thanks.php Hooks Called: init_startup init_startup_session_setup_start init_startup_session_setup_complete cache_permissions fetch_threadinfo_query fetch_threadinfo fetch_foruminfo style_fetch cache_templates global_start parse_templates global_setup_complete showthread_start showthread_getinfo forumjump showthread_post_start showthread_query_postids showthread_query bbcode_fetch_tags bbcode_create showthread_postbit_create postbit_factory postbit_display_start post_thanks_function_post_thanks_off_start post_thanks_function_post_thanks_off_end post_thanks_function_fetch_thanks_start post_thanks_function_fetch_thanks_end post_thanks_function_thanked_already_start post_thanks_function_thanked_already_end fetch_musername postbit_imicons bbcode_parse_start bbcode_parse_complete_precache bbcode_parse_complete postbit_display_complete post_thanks_function_can_thank_this_post_start pagenav_page pagenav_complete tag_fetchbit_complete forumrules navbits navbits_complete showthread_complete
Messages:

The Arcive of Official vBulletin Modifications Site.

It is not a VB3 engine, just a parsed copy!