wp-ffpc-acache.php (view raw)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 |
<?php
/**
* advanced cache worker of WordPress plugin WP-FFPC
*/
if ( !function_exists ('__debug__') ) {
/* __ only availabe if we're running from the inside of wordpress, not in advanced-cache.php phase */
function __debug__ ( $text ) {
if ( defined('WP_FFPC__DEBUG_MODE') && WP_FFPC__DEBUG_MODE == true)
error_log ( __FILE__ . ': ' . $text );
}
}
/* check for WP cache enabled*/
if ( !WP_CACHE )
return false;
/* no cache for post request (comments, plugins and so on) */
if ($_SERVER["REQUEST_METHOD"] == 'POST')
return false;
/**
* Try to avoid enabling the cache if sessions are managed
* with request parameters and a session is active
*/
if (defined('SID') && SID != '')
return false;
/* check for config */
if (!isset($wp_ffpc_config))
return false;
/* request uri */
$wp_ffpc_uri = $_SERVER['REQUEST_URI'];
/* no cache for robots.txt */
if ( stripos($wp_ffpc_uri, 'robots.txt') ) {
__debug__ ( 'Skippings robots.txt hit');
return false;
}
/* multisite files can be too large for memcached */
if ( function_exists('is_multisite') && stripos($wp_ffpc_uri, '/files/') && is_multisite() ) {
__debug__ ( 'Skippings multisite /files/ hit');
return false;
}
/* check if config is network active: use network config */
if (!empty ( $wp_ffpc_config['network'] ) )
$wp_ffpc_config = $wp_ffpc_config['network'];
/* check if config is active for site : use site config */
elseif ( !empty ( $wp_ffpc_config[ $_SERVER['HTTP_HOST'] ] ) )
$wp_ffpc_config = $wp_ffpc_config[ $_SERVER['HTTP_HOST'] ];
/* plugin config not found :( */
else
return false;
/* no cache for uri with query strings, things usually go bad that way */
if ( isset($wp_ffpc_config['nocache_dyn']) && !empty($wp_ffpc_config['nocache_dyn']) && stripos($wp_ffpc_uri, '?') !== false ) {
__debug__ ( 'Dynamic url cache is disabled ( url with "?" ), skipping');
return false;
}
/* check for cookies that will make us not cache the content, like logged in WordPress cookie */
if ( isset($wp_ffpc_config['nocache_cookies']) && !empty($wp_ffpc_config['nocache_cookies']) ) {
$nocache_cookies = array_map('trim',explode(",", $wp_ffpc_config['nocache_cookies'] ) );
if ( !empty( $nocache_cookies ) ) {
foreach ($_COOKIE as $n=>$v) {
/* check for any matches to user-added cookies to no-cache */
foreach ( $nocache_cookies as $nocache_cookie ) {
if( strpos( $n, $nocache_cookie ) === 0 ) {
__debug__ ( "Cookie exception matched: $n, skipping");
return false;
}
}
}
}
}
/* no cache for excluded URL patterns */
if ( isset($wp_ffpc_config['nocache_url']) && trim($wp_ffpc_config['nocache_url']) ) {
$pattern = sprintf('#%s#', trim($wp_ffpc_config['nocache_url']));
if ( preg_match($pattern, $wp_ffpc_uri) ) {
__debug__ ( "Cache exception based on URL regex pattern matched, skipping");
return false;
}
}
/* canonical redirect storage */
$wp_ffpc_redirect = null;
/* fires up the backend storage array with current config */
include_once ('wp-ffpc-backend.php');
$backend_class = 'WP_FFPC_Backend_' . $wp_ffpc_config['cache_type'];
$wp_ffpc_backend = new $backend_class ( $wp_ffpc_config );
//$wp_ffpc_backend = new WP_FFPC_Backend( $wp_ffpc_config );
/* no cache for for logged in users unless it's set
identifier cookies are listed in backend as var for easier usage
*/
if ( !isset($wp_ffpc_config['cache_loggedin']) || $wp_ffpc_config['cache_loggedin'] == 0 || empty($wp_ffpc_config['cache_loggedin']) ) {
foreach ($_COOKIE as $n=>$v) {
foreach ( $wp_ffpc_backend->cookies as $nocache_cookie ) {
if( strpos( $n, $nocache_cookie ) === 0 ) {
__debug__ ( "No cache for cookie: $n, skipping");
return false;
}
}
}
}
/* will store time of page generation */
$wp_ffpc_gentime = 0;
/* backend connection failed, no caching :( */
if ( $wp_ffpc_backend->status() === false ) {
__debug__ ( "Backend offline, skipping");
return false;
}
/* try to get data & meta keys for current page */
$wp_ffpc_keys = array ( 'meta' => $wp_ffpc_config['prefix_meta'], 'data' => $wp_ffpc_config['prefix_data'] );
$wp_ffpc_values = array();
__debug__ ( "Trying to fetch entries");
foreach ( $wp_ffpc_keys as $internal => $key ) {
$key = $wp_ffpc_backend->key ( $key );
$value = $wp_ffpc_backend->get ( $key );
if ( ! $value ) {
/* does not matter which is missing, we need both, if one fails, no caching */
wp_ffpc_start();
return;
}
else {
/* store results */
$wp_ffpc_values[ $internal ] = $value;
__debug__('Got value for ' . $internal);
}
}
/* serve cache 404 status */
if ( isset( $wp_ffpc_values['meta']['status'] ) && $wp_ffpc_values['meta']['status'] == 404 ) {
header("HTTP/1.1 404 Not Found");
/* if I kill the page serving here, the 404 page will not be showed at all, so we do not do that
* flush();
* die();
*/
}
/* server redirect cache */
if ( isset( $wp_ffpc_values['meta']['redirect'] ) && $wp_ffpc_values['meta']['redirect'] ) {
header('Location: ' . $wp_ffpc_values['meta']['redirect'] );
/* cut the connection as fast as possible */
flush();
die();
}
/* page is already cached on client side (chrome likes to do this, anyway, it's quite efficient) */
if ( array_key_exists( "HTTP_IF_MODIFIED_SINCE" , $_SERVER ) && !empty( $wp_ffpc_values['meta']['lastmodified'] ) ) {
$if_modified_since = strtotime(preg_replace('/;.*$/', '', $_SERVER["HTTP_IF_MODIFIED_SINCE"]));
/* check is cache is still valid */
if ( $if_modified_since >= $wp_ffpc_values['meta']['lastmodified'] ) {
header("HTTP/1.0 304 Not Modified");
/* connection cut for faster serving */
flush();
die();
}
}
/*** SERVING CACHED PAGE ***/
/* if we reach this point it means data was found & correct, serve it */
if (!empty ( $wp_ffpc_values['meta']['mime'] ) )
header('Content-Type: ' . $wp_ffpc_values['meta']['mime']);
/* set expiry date */
if (isset($wp_ffpc_values['meta']['expire']) && !empty ( $wp_ffpc_values['meta']['expire'] ) ) {
$hash = md5 ( $wp_ffpc_uri . $wp_ffpc_values['meta']['expire'] );
switch ($wp_ffpc_values['meta']['type']) {
case 'home':
case 'feed':
$expire = $wp_ffpc_config['browsercache_home'];
break;
case 'archive':
$expire = $wp_ffpc_config['browsercache_taxonomy'];
break;
case 'single':
$expire = $wp_ffpc_config['browsercache'];
break;
default:
$expire = 0;
}
header('Cache-Control: public,max-age='.$expire.',s-maxage='.$expire.',must-revalidate');
header('Expires: ' . gmdate("D, d M Y H:i:s", $wp_ffpc_values['meta']['expire'] ) . " GMT");
header('ETag: '. $hash);
unset($expire, $hash);
}
else {
/* in case there is no expiry set, expire immediately and don't serve Etag; browser cache is disabled */
header('Expires: ' . gmdate("D, d M Y H:i:s", time() ) . " GMT");
/* if I set these, the 304 not modified will never, ever kick in, so not setting these
* leaving here as a reminder why it should not be set */
//header('Cache-Control: no-store, no-cache, must-revalidate, max-age=0, s-maxage=0, post-check=0, pre-check=0');
//header('Pragma: no-cache');
}
/* if shortlinks were set */
if (isset($wp_ffpc_values['meta']['shortlink']) && !empty ( $wp_ffpc_values['meta']['shortlink'] ) )
header( 'Link:<'. $wp_ffpc_values['meta']['shortlink'] .'>; rel=shortlink' );
/* if last modifications were set (for posts & pages) */
if (isset($wp_ffpc_values['meta']['lastmodified']) && !empty($wp_ffpc_values['meta']['lastmodified']) )
header( 'Last-Modified: ' . gmdate("D, d M Y H:i:s", $wp_ffpc_values['meta']['lastmodified'] ). " GMT" );
/* pingback urls, if existx */
if ( isset($wp_ffpc_values['meta']['pingback']) && !empty( $wp_ffpc_values['meta']['pingback'] ) && isset($wp_ffpc_config['pingback_header']) && $wp_ffpc_config['pingback_header'] )
header( 'X-Pingback: ' . $wp_ffpc_values['meta']['pingback'] );
/* for debugging */
if ( isset($wp_ffpc_config['response_header']) && $wp_ffpc_config['response_header'] )
header( 'X-Cache-Engine: WP-FFPC with ' . $wp_ffpc_config['cache_type'] .' via PHP');
/* HTML data */
if ( isset($wp_ffpc_config['generate_time']) && $wp_ffpc_config['generate_time'] == '1' && stripos($wp_ffpc_values['data'], '</body>') ) {
$mtime = explode ( " ", microtime() );
$wp_ffpc_gentime = ( $mtime[1] + $mtime[0] ) - $wp_ffpc_gentime;
$insertion = "\n<!-- WP-FFPC cache output stats\n\tcache engine: ". $wp_ffpc_config['cache_type'] ."\n\tUNIX timestamp: ". time() . "\n\tdate: ". date( 'c' ) . "\n\tfrom server: ". $_SERVER['SERVER_ADDR'] . " -->\n";
$index = stripos( $wp_ffpc_values['data'] , '</body>' );
$wp_ffpc_values['data'] = substr_replace( $wp_ffpc_values['data'], $insertion, $index, 0);
}
echo trim($wp_ffpc_values['data']);
flush();
die();
/*** END SERVING CACHED PAGE ***/
/*** GENERATING CACHE ENTRY ***/
/**
* starts caching function
*
*/
function wp_ffpc_start( ) {
/* set start time */
global $wp_ffpc_gentime;
$mtime = explode ( " ", microtime() );
$wp_ffpc_gentime = $mtime[1] + $mtime[0];
/* start object "colleting" and pass it the the actual storer function */
ob_start('wp_ffpc_callback');
}
/**
* callback function for WordPress redirect urls
*
*/
function wp_ffpc_redirect_callback ($redirect_url, $requested_url) {
global $wp_ffpc_redirect;
$wp_ffpc_redirect = $redirect_url;
return $redirect_url;
}
/**
* write cache function, called when page generation ended
*/
function wp_ffpc_callback( $buffer ) {
/* use global config */
global $wp_ffpc_config;
/* backend was already set up, try to use it */
global $wp_ffpc_backend;
/* check is it's a redirect */
global $wp_ffpc_redirect;
/* no is_home = error, WordPress functions are not availabe */
if (!function_exists('is_home'))
return $buffer;
/* no <body> close tag = not HTML, also no <rss>, not feed, don't cache */
if ( stripos($buffer, '</body>') === false && stripos($buffer, '</rss>') === false )
return $buffer;
/* reset meta to solve conflicts */
$meta = array();
/* trim unneeded whitespace from beginning / ending of buffer */
$buffer = trim( $buffer );
/* Can be a trackback or other things without a body.
We do not cache them, WP needs to get those calls. */
if (strlen($buffer) == 0)
return '';
if ( isset($wp_ffpc_config[ 'nocache_comment' ]) && !empty($wp_ffpc_config[ 'nocache_comment' ]) && trim($wp_ffpc_config[ 'nocache_comment' ])) {
$pattern = sprintf('#%s#', trim($wp_ffpc_config['nocache_comment']));
__debug__ ( sprintf("Testing comment with pattern: %s", $pattern));
if ( preg_match($pattern, $buffer) ) {
__debug__ ( "Cache exception based on content regex pattern matched, skipping");
return $buffer;
}
}
if ( is_home() || is_feed() ) {
if (is_home())
$meta['type'] = 'home';
elseif(is_feed())
$meta['type'] = 'feed';
if (isset($wp_ffpc_config['browsercache_home']) && !empty($wp_ffpc_config['browsercache_home']) && $wp_ffpc_config['browsercache_home'] > 0) {
$meta['expire'] = time() + $wp_ffpc_config['browsercache_home'];
}
__debug__( 'Getting latest post for for home & feed');
/* get newest post and set last modified accordingly */
$args = array(
'numberposts' => 1,
'orderby' => 'modified',
'order' => 'DESC',
'post_status' => 'publish',
);
$recent_post = wp_get_recent_posts( $args, OBJECT );
if ( !empty($recent_post)) {
$recent_post = array_pop($recent_post);
if (!empty ( $recent_post->post_modified_gmt ) ) {
$meta['lastmodified'] = strtotime ( $recent_post->post_modified_gmt );
}
}
}
elseif ( is_archive() ) {
$meta['type'] = 'archive';
if (isset($wp_ffpc_config['browsercache_taxonomy']) && !empty($wp_ffpc_config['browsercache_taxonomy']) && $wp_ffpc_config['browsercache_taxonomy'] > 0) {
$meta['expire'] = time() + $wp_ffpc_config['browsercache_taxonomy'];
}
global $wp_query;
if ( null != $wp_query->tax_query && !empty($wp_query->tax_query)) {
__debug__( 'Getting latest post for taxonomy: ' . json_encode($wp_query->tax_query));
$args = array(
'numberposts' => 1,
'orderby' => 'modified',
'order' => 'DESC',
'post_status' => 'publish',
'tax_query' => $wp_query->tax_query,
);
$recent_post = get_posts( $args, OBJECT );
if ( !empty($recent_post)) {
$recent_post = array_pop($recent_post);
if (!empty ( $recent_post->post_modified_gmt ) ) {
$meta['lastmodified'] = strtotime ( $recent_post->post_modified_gmt );
}
}
}
}
elseif ( is_single() || is_page() ) {
$meta['type'] = 'single';
if (isset($wp_ffpc_config['browsercache']) && !empty($wp_ffpc_config['browsercache']) && $wp_ffpc_config['browsercache'] > 0) {
$meta['expire'] = time() + $wp_ffpc_config['browsercache'];
}
/* try if post is available
if made with archieve, last listed post can make this go bad
*/
global $post;
if ( !empty($post) && !empty ( $post->post_modified_gmt ) ) {
/* get last modification data */
$meta['lastmodified'] = strtotime ( $post->post_modified_gmt );
/* get shortlink, if possible */
if (function_exists('wp_get_shortlink')) {
$shortlink = wp_get_shortlink( );
if (!empty ( $shortlink ) )
$meta['shortlink'] = $shortlink;
}
}
}
else {
$meta['type'] = 'unknown';
}
if ( $meta['type'] != 'unknown' ) {
/* check if caching is disabled for page type */
$nocache_key = 'nocache_'. $meta['type'];
/* don't cache if prevented by rule */
if ( $wp_ffpc_config[ $nocache_key ] == 1 ) {
return $buffer;
}
}
if ( is_404() )
$meta['status'] = 404;
/* redirect page */
if ( $wp_ffpc_redirect != null)
$meta['redirect'] = $wp_ffpc_redirect;
/* feed is xml, all others forced to be HTML */
if ( is_feed() )
$meta['mime'] = 'text/xml;charset=';
else
$meta['mime'] = 'text/html;charset=';
/* set mimetype */
$meta['mime'] = $meta['mime'] . $wp_ffpc_config['charset'];
/* store pingback url if pingbacks are enabled */
if ( get_option ( 'default_ping_status' ) == 'open' )
$meta['pingback'] = get_bloginfo('pingback_url');
$to_store = $buffer;
/* add generation info is option is set, but only to HTML */
if ( $wp_ffpc_config['generate_time'] == '1' && stripos($buffer, '</body>') ) {
global $wp_ffpc_gentime;
$mtime = explode ( " ", microtime() );
$wp_ffpc_gentime = ( $mtime[1] + $mtime[0] )- $wp_ffpc_gentime;
$insertion = "\n<!-- WP-FFPC cache generation stats" . "\n\tgeneration time: ". round( $wp_ffpc_gentime, 3 ) ." seconds\n\tgeneraton UNIX timestamp: ". time() . "\n\tgeneraton date: ". date( 'c' ) . "\n\tgenerator server: ". $_SERVER['SERVER_ADDR'] . " -->\n";
$index = stripos( $buffer , '</body>' );
$to_store = substr_replace( $buffer, $insertion, $index, 0);
}
$prefix_meta = $wp_ffpc_backend->key ( $wp_ffpc_config['prefix_meta'] );
$wp_ffpc_backend->set ( $prefix_meta, $meta );
$prefix_data = $wp_ffpc_backend->key ( $wp_ffpc_config['prefix_data'] );
$wp_ffpc_backend->set ( $prefix_data , $to_store );
if ( !empty( $meta['status'] ) && $meta['status'] == 404 ) {
header("HTTP/1.1 404 Not Found");
}
else {
/* vital for nginx, make no problem at other places */
header("HTTP/1.1 200 OK");
}
/* echoes HTML out */
return trim($buffer);
}
/*** END GENERATING CACHE ENTRY ***/
|