Textpattern Support Forum

Update: This should be ready for prime-time now.

Current Version: 0.9.8

Download:

asy_jpcache0-9-8.zip w/ fixes by net-carver.

Version History

• 0.9.8
  • - updated installation instructions
  • - minor fixes
  • - removed statistics on read-write ratio
• 0.9.5
  • - added option to enable txp’s logging (defaults to off)
  • - clean cache on editing links
  • - extended help section in admin-plugin
  • - added statistics on read-write-ratio in admin-plugin
  • (only if logging is enabled in jpcache and set to ‘all’ in Textpattern)
• 0.9 (non-public release)
  • - added option to skip caching for feeds (defaults to off)
  • - skip caching of feeds if the request can result in partial content (A-IM/feed, RFC3229)
  • - skip caching when there is too little content (for example when doing redirects)
  • - added some code & explanation to hack in application/xhtml+xml support
  • - added Content-Length header
• 0.8
  • - don’t clean cache when merely viewing or previewing articles in article-event
  • - add statistic in admin-side plugin over number and total size of the cache-files
  • - sniff content and guess Content-Type on PHP4 (see Known Issues)
  • - finally, completely fix garbled feeds. (strncmp returns 0 for a match, go figure…)
• 0.7.1 repackaged 0.7. The admin-side plugin was corrupted and could not be installed.
• 0.7 fixed garbled output of feeds (they were compressed twice), added a missed article hook.
• 0.6 used headers_list (only PHP5) if apache_get_headers (only SAPI) not available
• 0.5 initial release

Information

asy_jpcache is based on zem_cache, jpcache and some ideas from WP-Cache.

asy_jpcache will only cache complete pages (including your feeds). If you want to cache partial pages to retain some dynamic parts take a look at zem_cache which is perfect for that kind of thing.

Installation

• 0. Use Textpattern 4.5+
• 1. Copy the directory jpcache and its contents into your main directory. It should be right next to your images and your textpattern directory (on a default install).
• Make sure that the jpcache/cache directory can be written to. Usually chmod 777 jpcache/cache/ will do the trick.
• 2. Edit your config.php in the textpattern directory and before the closing ?> insert the following line: $txpcfg['pre_publish_script'] = './jpcache/jpcache.php';
• 3. Don’t forget to activate this Admin-plugin.
• 4. Optional: Look inside jpcache/jpcache-config.php to change a few settings, like enabling Debugging, permanently turning off gzip-encoding, change timout etc.

If you are experiencing problems (or want to deactivate jpcache), comment out the line in your config.php that you added: //$txpcfg['pre_publish_script'] = './jpcache/jpcache.php';

Details about how JPCache works

Note: The files you received are a modified version of the original jpcache available at jpcache.com. Do NOT use this modified version for other stuff, please use the original jpcache version, because this here was hacked to serve textpattern.

After a user requests a page, JPCache will save the result-page in compressed format in the cache-directory. For subsequent requests, JPCache will

• not serve a cached page, if the latest cached file is older than X seconds (default 900)
• send a 304 header it ETag-headers are set
• otherwise send the compressed page if gzip is supported
• or sent the uncompressed page if gzip is not supported
• delete a cached page, if a comment is posted at that URL

asy_jpcache will also automatically clean the cache when

• comments are edited, deleted, moderated (for this and the following activate this plugin)
• articles are edited, posted, deleted
• forms or pages are edited.

asy_jpcache will not cache requests made via POST (like comment previews).
asy_jpcache will not cache file-downloads.
FAQ

I have Problems with my Feeds
There have been reports that some people have occasionally problems with the RSS/Atom-Feeds. I was not able to reliable reproduce them to find a fix. I have implemented a few things in 0.9 that should solve those problems. If you do however have problems with Feeds, please report so in the Forum. In the meanwhile you can easily turn of caching of the Feeds in jpcache-config.php by setting $JPCACHE_SKIP_FEEDS to 1.

My Textpatterns access logs keep getting shorter
That’s a good thing, because when cached files are served it is usually not recorded in the db. However if you wish to keep recording hits in the db set $JPCACHE_TXPLOG_DO to 1. Now when cache-reads are recorded to the db, jpcache will add “#cachehit” to the url. (Default is off, because cache-reads require no access to the db. Enabling this will lower performance a bit.)

I am using the XRT-Plugin
If you are using the XRT-Plugin (XML-RPC for Textpattern) by pixelmeadow, you are basically posting content to your blog without going through the Admin-Interface. Therefore the cache will not be cleaned right away. Due to the fact, that cache is periodically regenerated (default time 900 seconds), your changes may appear up to 900 seconds later on the actual site. You can shorten the default caching time in jpcache-config.php.

What happens with CSS-Requests
The stylesheets are not affected by jpcache, because they are served from a different file (not index.php). Since stylesheets usually do not change, my advice would be to put them in a regular (static) file and let the Webserver handle it (it’s more efficient).

Content-Type on PHP4
If you are using PHP4, asy_jpcache cannot get and cache the proper Content-Type of the generated page. The current workaround to this, is to take a look at the first 50 characters of the content and decide wether it’s a rss-feed, xml-feed, or text/html. This is fine for most Textpattern users. If for some reason you want to change those hardcoded headers or add more, take a look at $JPCACHE_DEFAULT_MIMETYPE in jpcache/jpcache-config.php and maybe the code in jpcache/file.php below the Line saying:
//Content-Sniffing to set correct Content-Type, because headers were not available

I am serving application/xhtml+xml sometimes
(This assumes you already have a plugin that handles this like phw_DTD )
If performance is really, really important, then don’t, because it complicates caching and lessens its benefits (at least the way it is implemented here). Otherwise:
If you are using PHP 5 simply open jpcache/jpcache-config.php and set $JPCACHE_XHTML_XML to 1. This will add the Accept-Header to the caching-key, meaning that for each URI one cache-file for every different Accept-Header will be written. Done.
If you are using PHP 4 in addition to the above you will also have to change the code that decides which Content-Type Header to send. There must be a line that is similar to header(“Content-Type: application/xhtml+xml; charset=utf-8”);. Add another line right there that sets the variable
$GLOBALS[‘JPCACHE_DEFAULT_MIMETYPE’] to something like “application/xhtml+xml; charset=utf-8”. That way, JPCache will know which Content-Type to associate with the request.

Original downloads: asy_jpcache0-9-8.tar.gz and asy_jpcache0-9-8.zip

Last edited by wet (2012-10-06 06:58:43)