_config = & W3_Config::instance(); $this->_debug = $this->_config->get_boolean('pgcache.debug'); $this->_request_uri = $_SERVER['REQUEST_URI']; $this->_lifetime = $this->_config->get_integer('browsercache.html.lifetime'); $this->_enhanced_mode = ($this->_config->get_string('pgcache.engine') == 'file_pgcache'); if ($this->_config->get_boolean('mobile.enabled')) { require_once W3TC_LIB_W3_DIR . '/Mobile.php'; $this->_mobile = & W3_Mobile::instance(); } } /** * PHP4 Constructor */ function W3_PgCache() { $this->__construct(); } /** * Do cache logic */ function process() { if ($this->_config->get_boolean('pgcache.enabled')) { /** * Skip caching for some pages */ switch (true) { case defined('DOING_AJAX'): case defined('DOING_CRON'): case defined('APP_REQUEST'): case defined('XMLRPC_REQUEST'): case defined('WP_ADMIN'): case (defined('SHORTINIT') && SHORTINIT): return; } /** * Handle mobile redirects */ if ($this->_mobile) { $mobile_redirect = $this->_mobile->get_redirect(); if ($mobile_redirect) { w3_redirect($mobile_redirect); exit(); } } /** * Do page cache logic */ if ($this->_debug) { $this->_time_start = w3_microtime(); } $this->_caching = $this->_can_cache(); if ($this->_caching) { $cache = & $this->_get_cache(); $compression = $this->_get_compression(); $raw = !$compression; $page_key = $this->_get_page_key($this->_request_uri, $compression); /** * Check if page is cached */ $data = $cache->get($page_key); /** * Try to get uncompressed version of cache */ if ($compression && !$data) { $raw = true; $page_key = $this->_get_page_key($this->_request_uri, false); $data = $cache->get($page_key); } /** * If cache exists */ if ($data) { /** * Do Bad Behavior check */ $this->_bad_behavior(); if ($this->_enhanced_mode) { $is_404 = false; $headers = array(); $time = $cache->mtime($page_key); $content = & $data; } else { $is_404 = $data['404']; $headers = $data['headers']; $time = $data['time']; $content = & $data['content']; } /** * Calculate content etag */ $etag = md5($content); /** * Send headers */ $this->_send_headers($is_404, $time, $etag, $compression, $headers); /** * Do manual compression for uncompressed page */ if ($raw) { /** * Append debug info */ if ($this->_debug) { $time_total = w3_microtime() - $this->_time_start; $debug_info = $this->_get_debug_info(true, '', true, $time_total); $content .= "\r\n\r\n" . $debug_info; } /** * Parse dynamic tags */ $this->_parse_dynamic($content); /** * Compress content */ $this->_compress($content, $compression); } echo $content; exit(); } } /** * Start output buffering */ ob_start(array( &$this, 'ob_callback' )); } } /** * Output buffering callback * * @param string $buffer * @return string */ function ob_callback(&$buffer) { if ($buffer != '' && w3_is_xml($buffer)) { $compression = false; $has_dynamic = $this->_has_dynamic($buffer); $can_cache = $this->_can_cache2($buffer); if ($can_cache) { $compression = $this->_get_compression(); /** * Don't use compression for debug mode or dynamic tags * because we need to modify buffer before send it to client */ $raw = ($this->_debug || $has_dynamic); if ($raw) { $compressions = array( false ); } else { $compressions = $this->_get_compressions(); } if ($this->_enhanced_mode) { $is_404 = false; $headers = array(); } else { $is_404 = (function_exists('is_404') ? is_404() : false); $headers = $this->_get_cached_headers(); } $time = time(); $cache = & $this->_get_cache(); /** * Store different versions of cache */ $buffers = array(); foreach ($compressions as $_compression) { $_page_key = $this->_get_page_key($this->_request_uri, $_compression); /** * Compress content */ $buffers[$_compression] = $buffer; $this->_compress($buffers[$_compression], $_compression); /** * Store cache data */ if ($this->_enhanced_mode) { $cache->set($_page_key, $buffers[$_compression]); } else { $_data = array( '404' => $is_404, 'headers' => $headers, 'time' => $time, 'content' => &$buffers[$_compression] ); $cache->set($_page_key, $_data, $this->_lifetime); } } /** * Change buffer if using compression */ if ($compression && isset($buffers[$compression])) { $buffer = & $buffers[$compression]; } /** * Calculate content etag */ $etag = md5($buffer); /** * Send headers */ $this->_send_headers($is_404, $time, $etag, $compression, $headers); if ($raw) { /** * Append debug info */ if ($this->_debug) { $time_total = w3_microtime() - $this->_time_start; $debug_info = $this->_get_debug_info(true, '', false, $time_total); $buffer .= "\r\n\r\n" . $debug_info; } /** * Don't use shutdown function below */ if (!$has_dynamic) { $this->_compress($buffer, $compression); } } } elseif ($this->_debug) { /** * Append debug info */ $time_total = w3_microtime() - $this->_time_start; $debug_info = $this->_get_debug_info(false, $this->cache_reject_reason, false, $time_total); $buffer .= "\r\n\r\n" . $debug_info; } /** * We can't capture output in ob_callback * so we use shutdown function */ if ($has_dynamic) { $this->_shutdown_buffer = $buffer; $this->_shutdown_compression = $compression; $buffer = ''; register_shutdown_function(array( &$this, 'shutdown' )); } } return $buffer; } /** * Shutdown callback * @return void */ function shutdown() { /** * Parse dynamic content */ $this->_parse_dynamic($this->_shutdown_buffer); /** * Compress page */ $this->_compress($this->_shutdown_buffer, $this->_shutdown_compression); echo $this->_shutdown_buffer; } /** * Flushes all caches * * @return boolean */ function flush() { $cache = & $this->_get_cache(); return $cache->flush(); } /** * Flushes post cache * * @param integer $post_id * @return boolean */ function flush_post($post_id) { if (!$post_id) { $post_id = $this->_detect_post_id(); } if ($post_id) { $home_path = w3_get_home_path(); $site_path = w3_get_site_path(); $domain_url = w3_get_domain_url(); $post_uri = str_replace($domain_url, '', post_permalink($post_id)); $uris = array( $home_path, $site_path, $post_uri ); $comments_number = get_comments_number($post_id); $comments_per_page = get_option('comments_per_page'); $comments_pages_number = ceil($comments_number / $comments_per_page); if (function_exists('get_comments_pagenum_link')) { for ($pagenum = 1; $pagenum <= $comments_pages_number; $pagenum++) { $comment_uri = str_replace($domain_url, '', $this->_get_comments_pagenum_link($post_id, $pagenum)); $uris[] = $comment_uri; } } $cache = & $this->_get_cache(); $compressions = $this->_get_compressions(); foreach ($uris as $uri) { foreach ($compressions as $compression) { $page_key = $this->_get_page_key($uri, $compression); $cache->delete($page_key); } } /** * Purge varnish servers */ if ($this->_config->get_boolean('pgcache.varnish.enabled')) { @set_time_limit(300); $servers = $this->_config->get_array('pgcache.varnish.servers'); foreach ($servers as $server) { foreach ($uris as $uri) { $url = sprintf('http://%s%s', $server, $uri); w3_http_purge($url); } } } return true; } return false; } /** * Returns object instance * * @return W3_PgCache */ function &instance() { static $instances = array(); if (!isset($instances[0])) { $class = __CLASS__; $instances[0] = & new $class(); } return $instances[0]; } /** * Checks if can we do cache logic * * @return boolean */ function _can_cache() { /** * Don't cache in console mode */ if (PHP_SAPI === 'cli') { $this->cache_reject_reason = 'console mode'; return false; } /** * Skip if posting */ if ($_SERVER['REQUEST_METHOD'] == 'POST') { $this->cache_reject_reason = 'request method is POST'; return false; } /** * Skip if session defined */ if (defined('SID') && SID != '') { $this->cache_reject_reason = 'session is started'; return false; } /** * Skip if there is query in the request uri */ if (!$this->_config->get_boolean('pgcache.cache.query') && strstr($this->_request_uri, '?') !== false) { $this->cache_reject_reason = 'request URI contains query'; return false; } /** * Check request URI */ if (!in_array($_SERVER['PHP_SELF'], $this->_config->get_array('pgcache.accept.files')) && !$this->_check_request_uri()) { $this->cache_reject_reason = 'request URI is rejected'; return false; } /** * Check User Agent */ if (!$this->_check_ua()) { $this->cache_reject_reason = 'user agent is rejected'; return false; } /** * Check WordPress cookies */ if (!$this->_check_cookies()) { $this->cache_reject_reason = 'cookie is rejected'; return false; } /** * Skip if user is logged in */ if ($this->_config->get_boolean('pgcache.reject.logged') && !$this->_check_logged_in()) { $this->cache_reject_reason = 'user is logged in'; return false; } return true; } /** * Checks if can we do cache logic * * @param string $buffer * @return boolean */ function _can_cache2(&$buffer) { /** * Skip if caching is disabled */ if (!$this->_caching) { return false; } /** * Check for database error */ if (w3_is_database_error($buffer)) { $this->cache_reject_reason = 'Database Error occurred'; return false; } /** * Check for DONOTCACHEPAGE constant */ if (defined('DONOTCACHEPAGE') && DONOTCACHEPAGE) { $this->cache_reject_reason = 'DONOTCACHEPAGE constant is defined'; return false; } /** * Don't cache 404 pages */ if (!$this->_config->get_boolean('pgcache.cache.404') && function_exists('is_404') && is_404()) { $this->cache_reject_reason = 'page is 404'; return false; } /** * Don't cache homepage */ if (!$this->_config->get_boolean('pgcache.cache.home') && function_exists('is_home') && is_home()) { $this->cache_reject_reason = 'page is home'; return false; } /** * Don't cache feed */ if (!$this->_config->get_boolean('pgcache.cache.feed') && function_exists('is_feed') && is_feed()) { $this->cache_reject_reason = 'page is feed'; return false; } /** * Check if page contains dynamic tags */ if ($this->_enhanced_mode && $this->_has_dynamic($buffer)) { $this->cache_reject_reason = 'page that contains dynamic tags (mfunc or mclude) can not be cached in enhanced mode'; return false; } return true; } /** * Returns cache object * * @return W3_Cache_Base */ function &_get_cache() { static $cache = array(); if (!isset($cache[0])) { $engine = $this->_config->get_string('pgcache.engine'); switch ($engine) { case 'memcached': $engineConfig = array( 'servers' => $this->_config->get_array('pgcache.memcached.servers'), 'persistant' => $this->_config->get_boolean('pgcache.memcached.persistant') ); break; case 'file': $engineConfig = array( 'cache_dir' => W3TC_CACHE_FILE_PGCACHE_DIR, 'locking' => $this->_config->get_boolean('pgcache.file.locking') ); break; case 'file_pgcache': $engineConfig = array( 'cache_dir' => W3TC_CACHE_FILE_PGCACHE_DIR, 'locking' => $this->_config->get_boolean('pgcache.file.locking'), 'expire' => $this->_lifetime ); break; default: $engineConfig = array(); } require_once W3TC_LIB_W3_DIR . '/Cache.php'; $cache[0] = & W3_Cache::instance($engine, $engineConfig); } return $cache[0]; } /** * Checks request URI * * @return boolean */ function _check_request_uri() { $auto_reject_uri = array( 'wp-login', 'wp-register' ); foreach ($auto_reject_uri as $uri) { if (strstr($this->_request_uri, $uri) !== false) { return false; } } foreach ($this->_config->get_array('pgcache.reject.uri') as $expr) { $expr = trim($expr); if ($expr != '' && preg_match('~' . $expr . '~i', $this->_request_uri)) { return false; } } return true; } /** * Checks User Agent * * @return boolean */ function _check_ua() { foreach ($this->_config->get_array('pgcache.reject.ua') as $ua) { if (isset($_SERVER['HTTP_USER_AGENT']) && stristr($_SERVER['HTTP_USER_AGENT'], $ua) !== false) { return false; } } return true; } /** * Checks WordPress cookies * * @return boolean */ function _check_cookies() { foreach (array_keys($_COOKIE) as $cookie_name) { if ($cookie_name == 'wordpress_test_cookie') { continue; } if (preg_match('/^(wp-postpass|comment_author)/', $cookie_name)) { return false; } } foreach ($this->_config->get_array('pgcache.reject.cookie') as $reject_cookie) { foreach (array_keys($_COOKIE) as $cookie_name) { if (strstr($cookie_name, $reject_cookie) !== false) { return false; } } } return true; } /** * Check if user is logged in * * @return boolean */ function _check_logged_in() { foreach (array_keys($_COOKIE) as $cookie_name) { if ($cookie_name == 'wordpress_test_cookie') { continue; } if (strpos($cookie_name, 'wordpress') === 0) { return false; } } return true; } /** * Compress data * * @param string $data * @param string $compression * @return string */ function _compress(&$data, $compression) { switch ($compression) { case 'gzip': $data = gzencode($data); break; case 'deflate': $data = gzdeflate($data); break; } } /** * Checks gzip availability * * @return boolean */ function _get_compression() { if (!w3_zlib_output_compression() && !headers_sent() && !$this->_is_buggy_ie()) { $compressions = $this->_get_compressions(); foreach ($compressions as $compression) { if (isset($_SERVER['HTTP_ACCEPT_ENCODING']) && stristr($_SERVER['HTTP_ACCEPT_ENCODING'], $compression) !== false) { return $compression; } } } return false; } /** * Returns array of supported compressions * * @return array */ function _get_compressions() { $compressions = array( false ); if ($this->_config->get_boolean('browsercache.enabled') && $this->_config->get_boolean('browsercache.html.compression') && function_exists('gzencode')) { $compressions[] = 'gzip'; } return $compressions; } /** * Returns array of response headers * * @return array */ function _get_response_headers() { $headers = array(); if (function_exists('headers_list')) { $headers_list = headers_list(); if ($headers_list) { foreach ($headers_list as $header) { list($header_name, $header_value) = explode(': ', $header, 2); $headers[$header_name] = $header_value; } } } return $headers; } /** * Checks for buggy IE6 that doesn't support compression * * @return boolean */ function _is_buggy_ie() { if (isset($_SERVER['HTTP_USER_AGENT'])) { $ua = $_SERVER['HTTP_USER_AGENT']; if (strpos($ua, 'Mozilla/4.0 (compatible; MSIE ') === 0 && strpos($ua, 'Opera') === false) { $version = (float) substr($ua, 30); return ($version < 6 || ($version == 6 && strpos($ua, 'SV1') === false)); } } return false; } /** * Returns array of data headers * * @return array */ function _get_cached_headers() { $data_headers = array(); $cache_headers = $this->_config->get_array('pgcache.cache.headers'); $response_headers = $this->_get_response_headers(); foreach ($response_headers as $header_name => $header_value) { foreach ($cache_headers as $cache_header_name) { if (strcasecmp($header_name, $cache_header_name) == 0) { $data_headers[$header_name] = $header_value; } } } return $data_headers; } /** * Returns page key * * @param string $request_uri * @param string $compression * @return string */ function _get_page_key($request_uri, $compression) { // replace fragment $key = preg_replace('~#.*$~', '', $request_uri); if ($this->_enhanced_mode) { // URL decode $key = urldecode($key); // replace double slashes $key = preg_replace('~[/\\\]+~', '/', $key); // replace query string $key = preg_replace('~\?.*$~', '', $key); // replace index.php $key = str_replace('/index.php', '/', $key); // trim slash $key = ltrim($key, '/'); if ($key && substr($key, -1) != '/') { $key .= '/'; } $key .= '_index'; } else { $blogname = w3_get_blogname(); if (!$blogname) { $blogname = w3_get_host(); } $key = sprintf('w3tc_%s_page_%s', md5($blogname), md5($key)); } /** * Append mobile group */ $mobile_group = ($this->_mobile ? $this->_mobile->get_group() : ''); if ($mobile_group) { $key .= '_' . $mobile_group; } /** * Append SSL */ if (w3_is_https()) { $key .= '_ssl'; } if ($this->_enhanced_mode) { /** * Append HTML extension */ $key .= '.html'; /** * Append compression extension */ if ($compression) { $key .= '.' . $compression; } } else { /** * Append compression */ if ($compression) { $key .= '_' . $compression; } } /** * Allow to modify page key by W3TC plugins */ $key = w3tc_do_action('w3tc_pgcache_cache_key', $key); return $key; } /** * Detects post ID * * @return integer */ function _detect_post_id() { global $posts, $comment_post_ID, $post_ID; if ($post_ID) { return $post_ID; } elseif ($comment_post_ID) { return $comment_post_ID; } elseif (is_single() || is_page() && count($posts)) { return $posts[0]->ID; } elseif (isset($_REQUEST['p'])) { return (integer) $_REQUEST['p']; } return 0; } /** * Returns debug info * * @param boolean $cache * @param string $reason * @param boolean $status * @param double $time * @return string */ function _get_debug_info($cache, $reason, $status, $time) { $debug_info = "'; return $debug_info; } /** * Sends headers * * @param array $headers * @return boolean */ function _headers($headers) { if (!headers_sent()) { foreach ($headers as $name => $value) { $header = ($name == 'Status' ? $value : $name . ': ' . $value); @header($header); } return true; } return false; } /** * Sends headers * @param boolean $is_404 * @param string $etag * @param integer $time * @param string $compression * @param array $custom_headers * @return boolean */ function _send_headers($is_404, $time, $etag, $compression, $custom_headers = array()) { $exit = false; $headers = array(); $curr_time = time(); $expires = $time + $this->_lifetime; $max_age = ($expires > $curr_time ? $expires - $curr_time : 0); if ($is_404) { /** * Add 404 header */ $headers = array_merge($headers, array( 'Status' => 'HTTP/1.1 404 Not Found' )); } elseif ($this->_check_modified_since($time) || $this->_check_match($etag)) { /** * Add 304 header */ $headers = array_merge($headers, array( 'Status' => 'HTTP/1.1 304 Not Modified' )); /** * Don't send content if it isn't modified */ $exit = true; } /** * Add default headers */ $headers = array_merge($headers, array( 'Last-Modified' => w3_http_date($time), 'Vary' => 'Cookie' )); if ($this->_config->get_boolean('browsercache.enabled')) { if ($this->_config->get_boolean('browsercache.html.expires')) { $headers = array_merge($headers, array( 'Expires' => w3_http_date($expires) )); } if ($this->_config->get_boolean('browsercache.html.cache.control')) { switch ($this->_config->get_string('browsercache.html.cache.policy')) { case 'cache': $headers = array_merge($headers, array( 'Pragma' => 'public', 'Cache-Control' => 'public' )); break; case 'cache_validation': $headers = array_merge($headers, array( 'Pragma' => 'public', 'Cache-Control' => 'public, must-revalidate, proxy-revalidate' )); break; case 'cache_noproxy': $headers = array_merge($headers, array( 'Pragma' => 'public', 'Cache-Control' => 'public, must-revalidate' )); break; case 'cache_maxage': $headers = array_merge($headers, array( 'Pragma' => 'public', 'Cache-Control' => sprintf('max-age=%d, public, must-revalidate, proxy-revalidate', $max_age) )); break; case 'no_cache': $headers = array_merge($headers, array( 'Pragma' => 'no-cache', 'Cache-Control' => 'max-age=0, private, no-store, no-cache, must-revalidate' )); break; } } if ($this->_config->get_boolean('browsercache.html.etag')) { $headers = array_merge($headers, array( 'Etag' => $etag )); } } if ($compression) { /** * Add Content-Encoding header */ $headers = array_merge($headers, array( 'Vary' => 'Accept-Encoding, Cookie', 'Content-Encoding' => $compression )); } /** * Add custom headers */ $headers = array_merge($headers, $custom_headers); /** * Disable caching for preview mode */ if (w3_is_preview_mode()) { $headers = array_merge($headers, array( 'Pragma' => 'private', 'Cache-Control' => 'private' )); } /** * Send headers to client */ $result = $this->_headers($headers); if ($exit) { exit(); } return $result; } /** * Check if content was modified by time * @param integer $time * @return boolean */ function _check_modified_since($time) { if (!empty($_SERVER['HTTP_IF_MODIFIED_SINCE'])) { $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE']; // IE has tacked on extra data to this header, strip it if (($semicolon = strrpos($if_modified_since, ';')) !== false) { $if_modified_since = substr($if_modified_since, 0, $semicolon); } return ($time == strtotime($if_modified_since)); } return false; } /** * Check if content was modified by etag * @param string $etag * @return boolean */ function _check_match($etag) { if (!empty($_SERVER['HTTP_IF_NONE_MATCH'])) { $if_none_match = (get_magic_quotes_gpc() ? stripslashes($_SERVER['HTTP_IF_NONE_MATCH']) : $_SERVER['HTTP_IF_NONE_MATCH']); $client_etags = explode(',', $if_none_match); foreach ($client_etags as $client_etag) { $client_etag = trim($client_etag); if ($etag == $client_etag) { return true; } } } return false; } /** * Bad Behavior support * @return void */ function _bad_behavior() { if (file_exists(WP_CONTENT_DIR . '/plugins/bad-behavior/bad-behavior-generic.php')) { $bb_file = WP_CONTENT_DIR . '/plugins/bad-behavior/bad-behavior-generic.php'; } elseif (file_exists(WP_CONTENT_DIR . '/plugins/Bad-Behavior/bad-behavior-generic.php')) { $bb_file = WP_CONTENT_DIR . '/plugins/Bad-Behavior/bad-behavior-generic.php'; } else { $bb_file = false; } if ($bb_file) { require_once $bb_file; } } /** * Workaround for get_comments_pagenum_link function * @param integer $post_id * @return string */ function _get_comments_pagenum_link($post_id, $pagenum = 1, $max_page = 0) { if (function_exists('get_comments_pagenum_link')) { if (isset($GLOBALS['post']) && is_object($GLOBALS['post'])) { $old_post = &$GLOBALS['post']; } else { $GLOBALS['post'] = & new stdClass(); $old_post = null; } $GLOBALS['post']->ID = $post_id; $link = get_comments_pagenum_link($pagenum, $max_page); if ($old_post) { $GLOBALS['post'] = &$old_post; } return $link; } return false; } /** * Parses dynamic tags * @return string */ function _parse_dynamic(&$buffer) { $buffer = preg_replace_callback('~(.*)~Uis', array( &$this, '_parse_dynamic_mfunc' ), $buffer); $buffer = preg_replace_callback('~(.*)~Uis', array( &$this, '_parse_dynamic_mclude' ), $buffer); } /** * Parse dynamic mfunc callback * @param array $matches * @return string */ function _parse_dynamic_mfunc($matches) { $code1 = trim($matches[1]); $code2 = trim($matches[2]); $code = ($code1 ? $code1 : $code2); if ($code) { $code = trim($code, ';') . ';'; ob_start(); $result = eval($code); $output = ob_get_contents(); ob_end_clean(); if ($result === false) { $output = sprintf('Unable to execute code: %s', htmlspecialchars($code)); } } else { $output = htmlspecialchars('Inavalid mfunc tag syntax. Correct: or PHP code.'); } return $output; } /** * Parse dynamic mclude callback * @param array $matches * @return string */ function _parse_dynamic_mclude($matches) { $file1 = trim($matches[1]); $file2 = trim($matches[2]); $file = ($file1 ? $file1 : $file2); if ($file) { $file = ABSPATH . $file; if (file_exists($file) && is_readable($file)) { ob_start(); include $file; $output = ob_get_contents(); ob_end_clean(); } else { $output = sprintf('Unable to open file: %s', htmlspecialchars($file)); } } else { $output = htmlspecialchars('Incorrect mclude tag syntax. Correct: or path/to/file.php.'); } return $output; } /** * Checks if buffer has dynamic tags * * @param string $buffer * @return boolean */ function _has_dynamic(&$buffer) { return preg_match('~(.*)~Uis', $buffer); } } /** * Alias for page cache flush cached * * @return boolean */ function w3tc_pgcache_flush() { require_once W3TC_DIR . '/lib/W3/PgCache.php'; $w3_pgcache = & W3_PgCache::instance(); return $w3_pgcache->flush(); } /** * Alias for page cache flush post by ID * * @param integer $post_id * @return boolean */ function w3tc_pgcache_flush_post($post_id) { require_once W3TC_DIR . '/lib/W3/PgCache.php'; $w3_pgcache = & W3_PgCache::instance(); return $w3_pgcache->flush_post($post_id); }