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.

Paul M · #92 04-17-2005, 05:47 PM

Quote:

Originally Posted by msimplay

i updated but my emails are still compressed
Lol no wonder you haven't replaced the code with 2.5 version yet :P

You could restore the phrases from a backup.

Personally I would not touch the phrase compression - too easy to break something - and then hard to restore it, unlike the templates where you just uncompress (restore) them.

Trigunflame · #93 04-17-2005, 05:50 PM

Update:

Its fine paul. It won't happen anymore with the newest version.

--------

Phrase Info:

There was a bug in a version that removed the ASCII \r\n, \r, \n from phrases, and many of these had to do with email.
I have fixed the bug so it won't happen anymore, but for people that were affected I suggest you restore from a backup, or download the
restorePhrases.zip file which will restore your Default English Phrases back to normal; then you can re-run the compression on the phrases.

Step 1. Download restorePhrases.zip
Step 2. Unzip restorePhrases.zip, and place both files in your forum directory
Step 3. Run restorephrases.php from the web like any other php file.
Step 4. You should now have restored the default english phrases, now you can re-compress the phrases again,
(Make absolute sure you are using the latest code, I patched it to not remove \r\n, \r, \n from phrases.)

The Realist · #94 04-17-2005, 05:59 PM

But these restorePhrases.zip file is to restore the whole phrases, what about the phrases needed for install hacks?

The Realist · #95 04-17-2005, 06:03 PM

I Would Recommend To Anyone Not To Compress Your Phrases Like I Did And Buggered Then Up With This Extra Code. Just Keep To The Templates.

A Little Tip.

not a happy chappy but for god sake who ever uses this phrase hack to do a phrase backup first.

msimplay · #96 04-17-2005, 06:19 PM

Quote:

Originally Posted by The Realist

I Would Recommend To Anyone Not To Compress Your Phrases Like I Did And Buggered Then Up With This Extra Code. Just Keep To The Templates.

A Little Tip.

not a happy chappy but for god sake who ever uses this phrase hack to do a phrase backup first.

Yep i lost a lot of my phrases because of this the phrase portion isn't worth doing unless theres some way to decompress them

Also my my queries have seemed to gone up by 4 queries
my forumhome was 13 queries its now 17
This was due to the phrases portion

Trigunflame · #97 04-17-2005, 06:23 PM

Quote:

Originally Posted by msimplay

Yep i lost a lot of my phrases because of this the phrase portion isn't worth doing unless theres some way to decompress them

Also my my queries have seemed to gone up by 4 queries
my forumhome was 13 queries its now 17
This was due to the phrases portion

Ya I was iffy about even doing this, but someone contacted me requesting it. It's marked as optional now for future reference.

Edit:

Updated Hack Documentation, Phrase Compression is Purely Optional.

msimplay · #98 04-17-2005, 06:43 PM

Quote:

Originally Posted by Trigunflame

Ya I was iffy about even doing this, but someone contacted me requesting it. It's marked as optional now for future reference.

Edit:

Updated Hack Documentation, Phrase Compression is Purely Optional.

Can u please help me decompress the phrases as my queries have gone up and some of my phrases won't show up even though they are there

Trigunflame · #99 04-17-2005, 06:46 PM

Quote:

Originally Posted by msimplay

Can u please help me decompress the phrases as my queries have gone up and some of my phrases won't show up even though they are there

Use the instructions at the bottom of the main post. It will restore all of your default templates.

Oblivion Knight · #**100** 04-17-2005, 07:24 PM

Thank god I had recent-ish database backups.. Just used the phrase table.

Trigunflame · #**101** 04-17-2005, 07:32 PM

Quote:

Originally Posted by Oblivion Knight

Thank god I had recent-ish database backups.. Just used the phrase table.

Ya I removed phrase compression altogether now, I don't want to risk other people messing their forums up.

X vBulletin 3.8.12 by vBS Debug Information
Page Generation 0.06891 seconds Memory Usage 2,366KB 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 (3)bbcode_php (6)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 (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!