Add-On Releases - Template Cache

This mod is for larger vBulletin installations that have problems with server load (to be run together with an opcode cache). Smaller installations will usually see no performance improvement.Speed up your Forums & Save Bandwidth

Reference

Plugin Based Template Cache
https://vborg.vbsupport.ru/showthread.php?t=121876

Compress Forum Templates
https://vborg.vbsupport.ru/showthread.php?t=107615

Require

Must install one of
1. APC,PECL,Visit:http://pecl.php.net/apc
2. eAccelerator,fork of the Turck MMCache,Visit:http://eaccelerator.net/
3. Turck MMCache,Visit:http://sourceforge.net/projects/turck-mmcache
4. Xcache,Lighttpd,Visit:http://trac.lighttpd.net/xcache/



Upgrade

1. Disable the product (Plugin System -> Manage Products -> Template Cache Options -> Disable)
2. Upload the new includes/template_cache.php
3. Import the new product-template_cache.xml (Allow Overwrite: YES)
4. Enable the product

Installation

1. Upload includes/template_cache.php to your forum
2. Install the product-template_cache.xml
3. Check and select which cache type? APC,eAccelerator,Turck MMCache,Xcache
4. Enable the product
5. vBulletin Options -> vBulletin Options -> Template Cache Options -> Modify the settings (especially enabling it).

Deinstallation

1. Disable the product
2. Remove the product
3. Check the 4 plugins of this product are gone
4. Delete includes/template_cache.php
5. Clear your PHP cache if you are using any.

Common Templates That May Need To Be Added to Ignore Settings:
phpinclude_start phpinclude_end editor_jsoptions_font editor_jsoptions_size forumhome navbar forumhome_vbshout forumhome_vbshout_shout


What it does:

1. hook "cache_templates",get $globaltemplates from cache,if not(Exclude Templates),get template from cache_templates();the cache use one of APC,eAccelerator,Turck MMCache,Xcache.Reduce MYSQL query and DISK IO.

2. There is an option to have certain templates saved seperatly to memory.

3. Automatically clears the cache when modifying or inserting templates, done using the hook admin_global and a check of $_GET, and also clearing when modifying the options.


The cache memory only get created when they are needed the first time. The memory can get one megabytes in size, mine is 0.5mb (default installation, no plugins/hacks). If you have new templates/styles and several plugins it can get 1-2mb no problem.if you use compress template,it will smaller.

notice
eAccelerator:
The shm functionshave been disabled by default;Take a look at configure --help for more information. see: http://eaccelerator.net/ticket/95
Xcache:
in php.ini or xcache.ini
set xcache.var_size not 0,same as xcache.size

Updates

Version 0.0.4:
26th Feb 2007, Change check if install shm,function_exists(info to put);The shm functionshave been disabled by default in eAccelerator.
Version 0.0.3:
12th Feb 2007, add Compress Template.
Version 0.0.2:
11th Feb 2007, add cache Xcache,delete cache File.
Version 0.0.1:
10th Feb 2007, work with APC,eAccelerator,Turck MMCache,File in 3.6.4.

[Andreas]

@Hoffi
template_compile
----------------

PHP Code:

$vbulletin->resettplcache = true; 


admin_complete
--------------

PHP Code:

if ($vbulletin->resettplcache AND function_exists('template_cache_clear'))
{
    template_cache_clear(1);
} 


@lendy
You might want to use the template_compile hook as a trigger for updates.

[thanh]

Hello,

here is my php.ini setting for php eaccelerator

extension="eaccelerator.so"
eaccelerator.shm_size="400"
eaccelerator.cache_dir="/var/cache/eaccelerator"
eaccelerator.enable="1"
eaccelerator.optimizer="1"
eaccelerator.check_mtime="1"
eaccelerator.debug="0"
eaccelerator.filter=""
eaccelerator.shm_max="1M"
eaccelerator.shm_ttl="1"
eaccelerator.shm_prune_period="0"
eaccelerator.shm_only="1"
eaccelerator.compress="1"
eaccelerator.compress_level="9"

Does the SHM ebable as you needed?

I'm still got the error that say my server does not have eaccelerator enable

[eido]

its not working with the hack : Top 10 Stats

[MissKalunji]

i always wondered if those kind of hack were really usefull ?

[F0xy]

can i use this allow with the mod in this link
https://vborg.vbsupport.ru/showthrea...107615&page=12

[gabrielt]

It seems that Template Cache isn't working with vBulletin 3.7...

Getting this message:

"Warning: in_array() [function.in-array]: Wrong datatype for second argument in [path]/includes/template_cache.php on line 299"

Studying this at this moment...

[gabrielt]

Just a follow up, Template Cache works fine with 3.7. In my case it wasn't working because I upgraded to the latest version but forgot to upload the new template_cache.php file... duh! :erm:

Working fine now as I can see the templates being cached thru Xcache's control panel...

[Mecho]

Originally Posted by gabrielt

Working fine now as I can see the templates being cached thru Xcache's control panel...

can u also see the effect of it to ur server loading ? is ur forum loading faster now before that u are using this addon ??

[Mecho]

installed and when i turned it on i got this error in admin panel :

Warning: in_array() [function.in-array]: Wrong datatype for second argument in [path]/includes/template_cache.php on line 298

any idea ??

also how can i make sure that it is working ??

[Fenriz]

Yes, exactly the same error. I can't recognize if it is working or not after this error. Any idea?