Template Cache

[lendy]

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.

[thincom2000]

So how is this copy & paste thread an improvement over orban's Plugin Based Template Cache?

Looking at the code, this seems to have more direct play with the opcode cache. What does this do and what are the advantages?

[lendy]

Cache Not with file,It use:
one of:
1. APC
2. eAccelerator
3. Turck MMCache
4. Xcache

put/get template with memory,Reduce MYSQL query and DISK IO.

[Snake]

Thanks for this! :)

[Zia]

wel....
whats the diff. between urs & orbans hack?
orbans one template cacher ..work with or w/p apc/ea/......
but with any opcode cacher it works fine....

what does ur hack will do?
cached in memory or accelerated php? or cache data store ?

Version 0.0.3:
12th Feb 2007, add Compress Template.

umm that means this hack will compress templates too? in the screen shot there are no option are shown for compress.

kinda 2-in-1 ?

[lendy]

wel....
whats the diff. between urs & orbans hack?
orbans one template cacher ..work with or w/p apc/ea/......
but with any opcode cacher it works fine....

what does ur hack will do?
cached in memory or accelerated php? or cache data store ?



umm that means this hack will compress templates too? in the screen shot there are no option are shown for compress.

kinda 2-in-1 ?
1.work good ea(mmcache)>xcache>apc

2.cached in memory with ea/apc/...

3.compress: you can enable/disable,suggest:enable;not 2-in-1,addition function.

[thincom2000]

I see. It uses less disk space when combined with a cache than orban's.

Sadly, I am not running a cache on my site, and I'm not on a dedicated so I can't just go ahead and install one. :(

[bollie]

Fatal error: APC not installed in /admincp/options.php(1027) : eval()'d code on line 13

[Zia]

Thnx for ur reply.
umm we are on a vps with 256Mb of guaranteed ram(+ 1gb Burst ram)

atm eAcclerteator installed with 32mb of Ram. No other compressor & cacheing hack (orban) installed.But its been written at vb.com any of php cacher(eA/APC/Xcache) with orbans hack..more script will be cached in memory.
(Orban using Xcache) .
i said 2-in-1 means cache + compress.Previous Hellcat & Trigunflame relased 2 compressor .Thats why i said 2 hacks in 1.

Reduce MYSQL query and DISK IO.
Orbans one : save 1 query in every page .If "cache template separately" enabled n it demand any opcode cacher.

what about its query saving status?

in fact last few weeks im just passing my time with this shit cache & data store cache.
(lot to be learn).Lots of option.lots of opinion.

So im just trying to figure which one i will use with XCache (will move to Xcache.)

2. There is an option to have certain templates saved seperatly to memory.
Built in option ? or custom?
Thanx in Advance.

[Zia]

Fatal error: APC not installed in /admincp/options.php(1027) : eval()'d code on line 13


yes...it will not work..unless u got any opcode cache installed
like : Apc or Xcache or eAcclereator or MMcache.
or maybe u dont have APC. But others

if ur on a shard host..request ur host provider to install any of them (maybe cant)
if ur on dedicated or vps u can install them...

or u can go for orbans one.

[treasureman]

Fatal error: Call to undefined function: eaccelerator_get() in /home/forum/public_html/includes/template_cache.php on line 65

I have eaccelerator installed and I am on a dedicated server.

[Zia]

Fatal error: Call to undefined function: eaccelerator_get() in /home/forum/public_html/includes/template_cache.php on line 65

I have eaccelerator installed and I am on a dedicated server.


ahha....its a real probs then...

lets wait for his reply

[projectego]

Awesome! Thanks! ;)

[Sofia]

Thanks, Lendy :)

[lendy]

Fatal error: APC not installed in /admincp/options.php(1027) : eval()'d code on line 13

APC not installed
Please install APC or select other

[lendy]

Fatal error: Call to undefined function: eaccelerator_get() in /home/forum/public_html/includes/template_cache.php on line 65

I have eaccelerator installed and I am on a dedicated server.
eaccelerator installed wrong.
i meet this.

resolvent:
not use Release-0.9.5 (http://eaccelerator.net/wiki/Release-0.9.5) - 2006/10/11
use You can download a snapshot of the latest SVN repository revision here (http://snapshots.eaccelerator.net/)

[lendy]

Thnx for ur reply.
umm we are on a vps with 256Mb of guaranteed ram(+ 1gb Burst ram)

atm eAcclerteator installed with 32mb of Ram. No other compressor & cacheing hack (orban) installed.But its been written at vb.com any of php cacher(eA/APC/Xcache) with orbans hack..more script will be cached in memory.
(Orban using Xcache) .
i said 2-in-1 means cache + compress.Previous Hellcat & Trigunflame relased 2 compressor .Thats why i said 2 hacks in 1.


Orbans one : save 1 query in every page .If "cache template separately" enabled n it demand any opcode cacher.

what about its query saving status?

in fact last few weeks im just passing my time with this shit cache & data store cache.
(lot to be learn).Lots of option.lots of opinion.

So im just trying to figure which one i will use with XCache (will move to Xcache.)


Built in option ? or custom?
Thanx in Advance.


this one : save 1 query in every page yet.

i use APC
stats:
2007-2-12 13:16:21 -- 2007-2-13 9:48:25
total cache template:196
total use memory:444760
total hits:1293294
particular see attach file.


about apc ea xcache
apc:stably, PECL,will build in php6
ea:not stably,but capability.
xcache:neonatal,future,lighttpd project
i just ea move to apc,but use both two now.

[Zia]

Hi lendy
Thnx.

Atm we r on eAcc

with out any other hack..its working fine...
atm cached 151 scripts... (in vbPlaza enabled it cache upto 260+ scripts)
using this it will cache more cacheable script ? right ?
ummm regarding ur opinion about APC/eAcc/XCache..
thread by jason|xoxide (http://www.vbulletin.com/forum/showthread.php?t=213267&page=5) at vbulletin.com . there found few review.
Xcache > Apc >eAcc.

i think it depends on person 2 person.



by enabling the compressor..it will stripe white spaces ?
previously faced problem using the another compressor...


------------
Any one have any practical review on it?

[treasureman]

eaccelerator installed wrong.
i meet this.

resolvent:
not use Release-0.9.5 (http://eaccelerator.net/wiki/Release-0.9.5) - 2006/10/11
use You can download a snapshot of the latest SVN repository revision here (http://snapshots.eaccelerator.net/)

I just upgraded to latest release of eaccelerator 0.9.5. Restarted mysql and apache.

When I activate the plug in from the Admin CP I get this error:
Fatal error: Call to undefined function: eaccelerator_rm() in /home/forum/public_html/includes/template_cache.php on line 75

Although the forums work, I do get that error in the Admin CP. So I am assuming that the plug in isn't working for me, so I have uninstalled.

[Zia]

I just upgraded to latest release of eaccelerator 0.9.5. Restarted mysql and apache.

When I activate the plug in from the Admin CP I get this error:
Fatal error: Call to undefined function: eaccelerator_rm() in /home/forum/public_html/includes/template_cache.php on line 75

Although the forums work, I do get that error in the Admin CP. So I am assuming that the plug in isn't working for me, so I have uninstalled.

hi...

ur eAcc is working ? did u check ur eAcc ACP ?

[treasureman]

hi...

ur eAcc is working ? did u check ur eAcc ACP ?

Yes my Eaccelerator is working. I checked it, I have used it for a long time, I just updated the version today. The new version is working also, just this mod gives an error.

No problem, I don't need this mod.

[lendy]

Fatal error: Call to undefined function: eaccelerator_rm()
i think it is not mod error!
must ea install problem.

You should have read the documentation and release-notes. The shm functions have been disabled by default. Take a look at configure --help for more information.

see: http://eaccelerator.net/ticket/95

[treasureman]

Fatal error: Call to undefined function: eaccelerator_rm()
i think it is not mod error!
must ea install problem.

You should have read the documentation and release-notes. The shm functions have been disabled by default. Take a look at configure --help for more information.

see: http://eaccelerator.net/ticket/95

for your info eaccelerator is installed properly and working properly. I view it in PHP info and it shows it working properly.

How do you know that I didn't read the docs and release notes?

No problem, I have uninstalled and do not need this mod.

No need to reply.

[lendy]

https://vborg.vbsupport.ru/attachment.php?attachmentid=60534&stc=1&d=1171420699

Cached Files 623 ( 27.7 MBytes)
Cached Variables 1808 ( 1.8 MBytes)

vb use:
Cached Files 101 ( 15275636 Bytes)
Cached Variables 196 ( 444760 Bytes)

Cached Files <> Cached Variables
this mod use Cached Variables, Cached Files is PHP Opcode Caching auto cache.

[LamBras]

Very nice, a saved query is always welcome.
Thank you!

[Zia]

just now finished move to Xcache by Icy
gonna install it

EDIT:

istalling it..just makes my forum page blank

[Zia]

helo...still no solution yet ????

[Zia]

any one alive here ?

[lendy]

hi,
sorry,i have 8 day's holiday.
i use it good in xcache,check php.ini
set xcache.var_size not 0,same as xcache.size
then var will work,not work in default.

you can see attachs

[Zia]

hmm

my xcache.size is
xcache.size = 64M

and var size
xcache.var_size = 0M

hence vb dont work with varcache..so engage 64MB of ram is kinda meaningless..

is there any way? to do it

edit: ur var cache is working?

[Zia]

http://img405.imageshack.us/img405/3767/sckk4.jpg

i used 96MB for Xcache
and 16 MB for var.cache

but i will make xcche to 64MB
and var cache 0 . Coz afaik var cache wont work with vb.
but ur screenshot ..seems ur var cache is working ?
How?

[lendy]

xcache.var_size = 64M

few day ago,you see
https://vborg.vbsupport.ru/attachment.php?attachmentid=61053&d=1172467912

then change to use
xcache.size
xcache.var_size

enough memory for xcache ,not waste.

[lendy]

see list var data as
https://vborg.vbsupport.ru/attachment.php?attachmentid=61054&d=1172467912

[Zia]

is the var.cache is working only for ur hack?
really strange....no other changes are needed?
how much
gc_varcache_interval = how many second did u put?

caching var its also saving query? save (1~2 ) query in every page?

[lendy]

is the var.cache is working only for ur hack?
really strange....no other changes are needed?
how much
gc_varcache_interval = how many second did u put?

caching var its also saving query? save (1~2 ) query in every page?

gc_varcache_interval :
i set default
it is not import.
it is cron job every gc_varcache_interval seconds scanning expired items.
if server cpu is good,or Load Average is low.you can set small.i thank 1 day is good.

save 1 query in every page.

[goyo]

Great work lendy! :up:

Works as described with xcache.

[Zia]

Great work lendy! :up:

Works as described with xcache.

do u mind post ur screen shot of Xcache status?

[lendy]

61099
Variable Cache is disabled.

if set Variable Cache value
this value same as Opcode Cache.
61100

[Zia]

61099
Variable Cache is disabled.

if set Variable Cache value
this value same as Opcode Cache.
61100

:) bro thnx .
actually i asked goyo to give his one.

Thnx

[Zia]

Helo Lendy,
Using Xcache + this hack. its caching var. (shown as var.cache)
actually its caching var?

what is the difference between urs & THis One (https://vborg.vbsupport.ru/showthread.php?t=141005)

Thanks.

[lendy]

yes them also use caching var,you must enabled var cache.
it save datastore with var.cache,not mysql.
this is template with var.cache,not mysql.

[Zia]

http://img295.imageshack.us/img295/5008/varhh9.jpg

seems working

[lendy]

yes,congratulate you

[Zia]

thnx man :)
i love Xcache..
do u have any more idea for caching?

[Zia]

i gez it has a conflict with
"user visited today" block..frequently the block just got disapperad..
i have added FORUMHOME in exclude both compress & cache..

Current Setting:
http://img84.imageshack.us/img84/2167/uvted6.jpg

what to do now?
i gez the probs around compress...

any one can post a screen shot of List PHP from xcache admin ?
would be gratefull.
Thnaks

[Zia]

Lendy..
for xcache. i put 64MB .in fact i dont need 64MB at all/48MB is pretty much perfect for me.
but to using this hack...really do i need to use 64mb for var.cache ??
as i found ur hack + THIS by phpxcache (https://vborg.vbsupport.ru/showthread.php?t=141005) ,varcache only cache upto +/-7 MB. hence i put 64MB for var.cache.

so can u tell me..if i put 48Mb for xcache & 16MB for var.cache
will this hack stop working ?
other wise is there anything u can do for it?
and one thing i have noticed..using this one..thing are being cached at var.cache portion not php portion ?

[MThornback]

This was a help to me, thanks :D

[lendy]

Lendy..
for xcache. i put 64MB .in fact i dont need 64MB at all/48MB is pretty much perfect for me.
but to using this hack...really do i need to use 64mb for var.cache ??
as i found ur hack + THIS by phpxcache (https://vborg.vbsupport.ru/showthread.php?t=141005) ,varcache only cache upto +/-7 MB. hence i put 64MB for var.cache.

so can u tell me..if i put 48Mb for xcache & 16MB for var.cache
will this hack stop working ?
other wise is there anything u can do for it?
and one thing i have noticed..using this one..thing are being cached at var.cache portion not php portion ?

so can u tell me..if i put 48Mb for xcache & 16MB for var.cache
will this hack stop working ?
no ,if you set var.cache,it will work.if use eA,cached at memory,then full,cached at disk.
if cache upto +/-7 MB,you can set 8M or 16M to var.cache.

[Zia]

thanks Lendy....i gonna cutdown the ramsize soon.

Im on xcache..
one point..i have noticed..using this one..thing are being cached at var.cache portion not php portion ?

but as a phpcacher - php suppose to cache at php block ?

[lendy]

about this,you can see xcache code.

[gabrielt]

Worked really fine here, thanks for this mod my man! That was exactly what I was looking for...

[BamaStangGuy]

Is there anyway you could add Memcached Support to this?

[BamaStangGuy]

Figured out the query issue.

New problem is that when I update a template the change isn't updated in xcache and continues to show the old template to visitors instead of the updated one.

[Hoffi]

Ist there a solution that this works with Andrea's TMS? (https://vborg.vbsupport.ru/showthread.php?t=152931)

Or is it possible to tell the System to Cache on or more Templates new?

[Adam21]

Figured out the query issue.

New problem is that when I update a template the change isn't updated in xcache and continues to show the old template to visitors instead of the updated one.


Some problem.The plug-in does not update XCache and continues to show the old template.:rolleyes:

[Hoffi]

Just go to the XCache Admin-Panel and delete the Cached Templates so that XCache must reCache the Templates.

[GoHa]

1
I have wierd effect. Once I enabed the product, my supermoderators lost some rights in some forums. Not all rights and not in all forums. In some forums theykeep all rights, in another forums theu only kept right to delete thread, and lost right to move, copy, rename, edit etc...

2
Another problem that I noticed, is that "compress teamplte" damaged forum appearance.
https://vborg.vbsupport.ru/ Desk (http://forums.goha.ru/) was turned to https://vborg.vbsupport.ru/Desk (http://forums.goha.ru/)
Its removed the space between the icon and forum name

Once I disabled the product - everything returned back to normal....

Please advise.

VB 3.6.7
XCache 1.2.1

[Zia]

Helo GoHa..
As my past experience- Compress template barely bring good result- SO we never used any compressor-

- Disable Compressor
- FORUMHOME - add to ignore list
(U can add add some template and .js files to IGNORE list to get rid of some problem...)

[dtv100]

ok after try a few times with no go I got it working on my forum.
my problem was I installed xcache but will still get error tha was not install.
solution for me was unistall zend ,restore old php.ini ,install xcache the reinstall zend .

now work well thanks for this nice addon .

one question where I can find the XCache Admin-Panel?

[Zia]

one question where I can find the XCache Admin-Panel?



just copy ur xcache admin folder to ur doc.root (http://forum.lighttpd.net/topic/24749#new)

just dont forget to generate user i/p to MD5.

[dtv100]

I use a script to automatic install xcache for me .
now I don't have any idea where the admin link is .

Using CentOS 4 with DirectAdmin 1.31.1
Apache 2.2.6 - PHP 5.2.5 - MySQL 5.0.45.

[Zia]

seemed u've used this one (http://www.vbulletin.com/forum/showthread.php?t=213267&highlight=xcache)

u can ask for help over there

[JohnBee]

Page generated in 0.0307 seconds.
My previous load times(no template caching) were aprox. .0650 seconds so I'm liking what I see here so far. Hope it holds up :)

[yahoooh]

not showing @who user read the thread @ hack
it has conflict with it

[JohnBee]

not showing @who user read the thread @ hack
it has conflict with it
I second that, product will not even enable with this MOD installed.

[SeV3n]

Works fine but sometimes it got an error:

Warning: array_flip() [function.array-flip]: The argument should be an array in /includes/template_cache.php on line 237

I'm using the latest 1.2.2 xcache

[dtv100]

seemed u've used this one (http://www.vbulletin.com/forum/showthread.php?t=213267&highlight=xcache)

u can ask for help over there
no I use this one (http://www.directadmin.com/forum/showthread.php?t=17070)


any way this is the setting I using :


[xcache]
xcache.shm_scheme = "mmap"
xcache.size = 64M
xcache.count = 1
xcache.slots = 8K
xcache.ttl = 0
xcache.gc_interval = 0
xcache.var_size = 16M
xcache.var_count = 1
xcache.var_slots = 8K
xcache.var_ttl = 0
xcache.var_maxttl = 0
xcache.var_gc_interval = 300
xcache.test = Off
xcache.readonly_protection = Off
xcache.mmap_path = "/dev/zero"
xcache.coredump_directory = "/tmp/xcache"
xcache.cacher = On
xcache.stat = On
xcache.optimizer = On

[xcache.coverager]
xcache.coverager = Off
xcache.coveragedump_directory = ""

anything I should change .

update find control panel thanks.

[lazytown]

Does anyone know if this works properly with VBSEO 3.1? I've read that orban's cache conflicted somewhat with it (some unpredictable behavior). If so, is there any way to fix it or disable portions?

Thanks
-vissa

[dtv100]

I using this hack and vbseo no problem so far.

[Zia]

never had any probs with vbseo along with Xcache.

[Andreas]

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

$vbulletin->resettplcache = true;


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

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/showthread.php?t=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]

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?

[Qleb]

same to me ,,,HEllo

[tintin74]

Does anyone knows, if this mod works with vb 4 version?