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.

stan111 · #**162** 09-14-2005, 06:59 AM

damn, this works like a champ
my board is heavily modified and i dont have any experience in coding or anything
i mod it and it works at the first time. my board load so fast now

thanks a million for writting this code

edit: i just check my board again, and somehow, my quickreply text box disappeared :nervous:
anyone know wat happen ?

stan111 · #**163** 09-14-2005, 07:13 AM

above it, i did that and it works

HTML Code:

//#############################################################################
// edit form for an existing template
if ($_REQUEST['do'] == 'edit')

Andreas · #**164** 09-14-2005, 07:31 AM

Any chance for a 3.5 Version?

stan111 · #**165** 09-15-2005, 06:20 AM

Quote:

Originally Posted by stan111

edit: i just check my board again, and somehow, my quickreply text box disappeared :nervous:
anyone know wat happen ?

anyone ?

buro9 · #**166** 09-15-2005, 07:10 AM

Quote:

Originally Posted by KirbyDE

Any chance for a 3.5 Version?

It's really simple to migrate.

Just copy the block of code into the foot of admincp/template.php

And then add this XML to includes/xml/cpnav_vbulletin.xml

Code:

		<navoption comment="HACK : COMPRESS TEMPLATES" displayorder="51">
			<phrase>compressall</phrase>
			<link>template.php?do=compressall</link>
		</navoption>

    <navoption link="template.php?do=compressall&amp;revert=1" comment="HACK : COMPRESS TEMPLATES" displayorder="52">
			<phrase>uncompressall</phrase>
		</navoption>

That needs to go ABOVE this piece:

Code:

	</navgroup>

	<navgroup phrase="languages_and_phrases" permissions="canadminlanguages" displayorder="30">

Which places it in the styles_and_templates group.

The hack continues to work perfectly in vb3.5

buro9 · #**167** 09-15-2005, 07:11 AM

Oh, and I added the 'comment' attribute as I like being able to search the whole code base and see instantly what modifications I need to migrate at update time by simply looking for the word HACK.

hidjra · #**168** 10-05-2005, 04:42 PM

Quote:

Originally Posted by buro9

It's really simple to migrate.

Just copy the block of code into the foot of admincp/template.php

And then add this XML to includes/xml/cpnav_vbulletin.xml

Code:

		<navoption comment="HACK : COMPRESS TEMPLATES" displayorder="51">
			<phrase>compressall</phrase>
			<link>template.php?do=compressall</link>
		</navoption>

    <navoption link="template.php?do=compressall&amp;revert=1" comment="HACK : COMPRESS TEMPLATES" displayorder="52">
			<phrase>uncompressall</phrase>
		</navoption>

That needs to go ABOVE this piece:

Code:

	</navgroup>

	<navgroup phrase="languages_and_phrases" permissions="canadminlanguages" displayorder="30">

Which places it in the styles_and_templates group.

The hack continues to work perfectly in vb3.5

This won't work. You'll need to change the queries to:
if it's a select/read querie:
from '$DB_site->query' to '$db->query_read'

if it's a update/write querie:
from '$DB_site->query' to '$db->query_write'

You also need to add the phrases 'compressall' and 'uncompressall'. otherwise they won't show up in de navigation-menu of your adminCP.

You can also remove the badtemplates 'phpinclude_start' and 'phpinclude_end'. They don't exist in vb3.5 gold

Hidjra

stan111 · #**169** 10-13-2005, 10:05 AM

this mod rocks, i luv it so much, it speeds up the forum like crazy
but does anyone here have the same problem like me after you compress the template, your text message box disappears. Here is a pic of my quick reply after the template compression

buro9 · #**170** 10-13-2005, 10:15 AM

Quote:

Originally Posted by stan111

this mod rocks, i luv it so much, it speeds up the forum like crazy
but does anyone here have the same problem like me after you compress the template, your text message box disappears. Here is a pic of my quick reply after the template compression

Nope... don't have that at all.

Have you hacked that template though? Put anything in there that might make it less than rock solid (stacks of JavaScript and weird HTML for example?).

You can just figure out what the template name for that is and add it to the array of templates to skip. However it shouldn't be an issue, figure out where you've broken it and fix that would be the better solution

buro9 · #**171** 10-13-2005, 10:16 AM

Oh... and an example of the before and after HTML would be appreciated... at least we'd be able to understand what went wrong then.

X vBulletin 3.8.12 by vBS Debug Information
Page Generation 0.05066 seconds Memory Usage 2,370KB 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 (4)bbcode_code (1)bbcode_html (3)bbcode_php (4)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 (4)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!