enable the cache. Based on WP-Cache by Ricardo Galli Granada. Version: 0.4 Author: Donncha O Caoimh Author URI: http://ocaoimh.ie/ */ /* Copyright 2005-2006 Ricardo Galli Granada (email : gallir@uib.es) Some code copyright 2007 Donncha O Caoimh (http://ocaoimh.ie/) This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ $wp_cache_config_file = ABSPATH . 'wp-content/wp-cache-config.php'; if( !@include($wp_cache_config_file) ) { get_wpcachehome(); $wp_cache_config_file_sample = WPCACHEHOME . 'wp-cache-config-sample.php'; @include($wp_cache_config_file_sample); } else { get_wpcachehome(); } $wp_cache_config_file_sample = WPCACHEHOME . 'wp-cache-config-sample.php'; $wp_cache_link = ABSPATH . 'wp-content/advanced-cache.php'; $wp_cache_file = WPCACHEHOME . 'wp-cache-phase1.php'; include(WPCACHEHOME . 'wp-cache-base.php'); function get_wpcachehome() { if( defined( 'WPCACHEHOME' ) == false ) { if( is_file( dirname(__FILE__) . '/wp-cache-config-sample.php' ) ) { define( 'WPCACHEHOME', trailingslashit( dirname(__FILE__) ) ); } elseif( is_file( dirname(__FILE__) . '/wp-super-cache/wp-cache-config-sample.php' ) ) { define( 'WPCACHEHOME', dirname(__FILE__) . '/wp-super-cache/' ); } else { die( 'Please create wp-content/wp-cache-config.php from wp-super-cache/wp-cache-config-sample.php' ); } } } function wp_cache_add_pages() { if( function_exists( 'is_site_admin' ) ) { if( is_site_admin() ) { add_submenu_page('wpmu-admin.php', __('WP Super Cache'), __('WP Super Cache'), 'manage_options', __FILE__, 'wp_cache_manager'); add_options_page('WP Super Cache', 'WP Super Cache', 'manage_options', __FILE__, 'wp_cache_manager'); } } else { add_options_page('WP Super Cache', 'WP Super Cache', 'manage_options', __FILE__, 'wp_cache_manager'); } } function wp_cache_manager() { global $wp_cache_config_file, $valid_nonce, $supercachedir, $cache_path, $cache_enabled, $cache_compression, $super_cache_enabled; if( function_exists( 'is_site_admin' ) ) if( !is_site_admin() ) return; $supercachedir = $cache_path . 'supercache/' . preg_replace('/:.*$/', '', $_SERVER["HTTP_HOST"]); if( get_option( 'gzipcompression' ) == 1 ) update_option( 'gzipcompression', 0 ); $valid_nonce = wp_verify_nonce($_REQUEST['_wpnonce'], 'wp-cache'); echo '
'; echo "

WP Super Cache Manager

\n"; if(isset($_REQUEST['wp_restore_config']) && $valid_nonce) { unlink($wp_cache_config_file); echo 'Configuration file changed, some values might be wrong. Load the page again from the "Options" menu to reset them.'; } if ( !wp_cache_check_link() || !wp_cache_verify_config_file() || !wp_cache_verify_cache_dir() ) { echo "
Cannot continue... fix previous problems and retry.
"; echo "
\n"; return; } if (!wp_cache_check_global_config()) { echo "\n"; return; } if( !got_mod_rewrite() ) { ?>

Mod rewrite is not installed! Super Cache will not fully work!

mod_rewrite is required for serving Super Cache static files. You will still be able to use WP-Cache.

WP Super Cache Status'; ?>


Super Cache Compression

Compression is disabled by default because some hosts have problems with compressed files. Switching this on and off clears the cache.

\n"; $rules .= "RewriteEngine On\n"; $rules .= "RewriteBase $home_root\n"; // props Chris Messina $rules .= "RewriteCond %{QUERY_STRING} !.*s=.*\n"; $rules .= "RewriteCond %{HTTP_COOKIE} !^.*comment_author_.*$\n"; $rules .= "RewriteCond %{HTTP_COOKIE} !^.*wordpressuser.*$\n"; $rules .= "RewriteCond %{HTTP_COOKIE} !^.*wp-postpass_.*$\n"; $rules .= "RewriteCond %{HTTP:Accept-Encoding} gzip\n"; $rules .= "RewriteCond %{DOCUMENT_ROOT}/wp-content/cache/supercache/%{HTTP_HOST}/$1index.html.gz -f\n"; $rules .= "RewriteRule ^(.*) /wp-content/cache/supercache/%{HTTP_HOST}/$1index.html.gz [L]\n\n"; $rules .= "RewriteCond %{QUERY_STRING} !.*s=.*\n"; $rules .= "RewriteCond %{HTTP_COOKIE} !^.*comment_author_.*$\n"; $rules .= "RewriteCond %{HTTP_COOKIE} !^.*wordpressuser.*$\n"; $rules .= "RewriteCond %{HTTP_COOKIE} !^.*wp-postpass_.*$\n"; $rules .= "RewriteCond %{DOCUMENT_ROOT}/wp-content/cache/supercache/%{HTTP_HOST}/$1index.html -f\n"; $rules .= "RewriteRule ^(.*) /wp-content/cache/supercache/%{HTTP_HOST}/$1index.html [L]\n"; $rules .= $wprules . "\n"; $rules .= ""; if( insert_with_markers( $home_path.'.htaccess', 'WordPress', explode( "\n", $rules ) ) ) { echo "

Mod Rewrite rules updated!

"; echo "

" . ABSPATH . ".htaccess has been updated with the necessary mod_rewrite rules. Please verify they are correct. The file should look like this:

\n"; } else { echo "

Mod Rewrite rules must be updated!

"; echo "

Your " . ABSPATH . ".htaccess is not writable by the webserver and must be updated with the necessary mod_rewrite rules. The new rules go above the regular WordPress rules as shown in the code below:

\n"; } echo "

# BEGIN WordPress\n{$rules}# END WordPress

\n"; } // http://allmybrain.com/2007/11/08/making-wp-super-cache-gzip-compression-work/ $gziprules = "AddEncoding x-gzip .gz\n"; $gziprules .= "AddType text/html .gz"; $gziprules = insert_with_markers( $cache_path . '.htaccess', 'supercache', explode( "\n", $gziprules ) ); if( isset( $cache_compression_changed ) && isset( $_POST[ 'cache_compression' ] ) && !$cache_compression ) { ?>

Super Cache compression is now disabled.

Super Cache compression is now enabled.

'; wp_nonce_field('wp-cache'); echo "\n"; ?>
Accepted filenames, rejected URIs'; wp_cache_edit_rejected(); echo "
\n"; wp_cache_edit_accepted(); echo '
'; wp_cache_edit_rejected_ua(); wp_cache_files(); wp_cache_restore(); ob_start(); if( defined( 'WP_CACHE' ) ) { if( !function_exists( 'do_cacheaction' ) ) { die( 'Install is not complete. Please verify that:' ); } else { do_cacheaction( 'cache_admin_page' ); } } $out = ob_get_contents(); ob_end_clean(); if( $out != '' ) { echo '
Cache Plugins'; echo $out; echo '
'; } echo "\n"; } function wp_cache_restore() { echo '
Configuration messed up?'; echo '
'; echo ''; echo '
'; wp_nonce_field('wp-cache'); echo "
\n"; echo '
'; } function comment_form_lockdown_message() { ?>

Lock Down:

Prepare your server for an expected spike in traffic by enabling the lock down. When this is enabled, new comments on a post will not refresh the cached static files.

WordPress is locked down. Super Cache static files will not be deleted when new comments are made.WordPress is not locked down. New comments will refresh Super Cache static files as normal.'; echo ""; echo "
"; wp_nonce_field('wp-cache'); echo "\n"; ?>
0) { $cache_max_time = $max_time; wp_cache_replace_line('^ *\$cache_max_time', "\$cache_max_time = $cache_max_time;", $wp_cache_config_file); } } if(isset($_POST['super_cache_max_time']) && $valid_nonce) { $max_time = (int)$_POST['super_cache_max_time']; if ($max_time > 0) { $super_cache_max_time = $max_time; wp_cache_replace_line('^ *\$super_cache_max_time', "\$super_cache_max_time = $super_cache_max_time;", $wp_cache_config_file); } } ?>
Expiry Time'; echo ' '; echo " seconds
"; echo ' '; echo " seconds"; echo '
'; wp_nonce_field('wp-cache'); echo "\n"; ?>
Rejected User Agents'; echo "

Strings in the HTTP 'User Agent' header that prevent WP-Cache from caching bot, spiders, and crawlers' requests. Note that cached files are still sent to these request if they already exists.

\n"; echo '
'; echo ''; echo ' '; echo '
'; wp_nonce_field('wp-cache'); echo '
'; echo "
\n"; } function wp_cache_edit_rejected() { global $cache_acceptable_files, $cache_rejected_uri, $wp_cache_config_file, $valid_nonce; if(isset($_REQUEST['wp_rejected_uri']) && $valid_nonce) { $text = wp_cache_sanitize_value($_REQUEST['wp_rejected_uri'], $cache_rejected_uri); wp_cache_replace_line('^ *\$cache_rejected_uri', "\$cache_rejected_uri = $text;", $wp_cache_config_file); } echo "

Add here strings (not a filename) that forces a page not to be cached. For example, if your URLs include year and you dont want to cache last year posts, it's enough to specify the year, i.e. '/2004/'. WP-Cache will search if that string is part of the URI and if so, it will no cache that page.

\n"; echo '
'; echo ''; echo ' '; echo '
'; wp_nonce_field('wp-cache'); echo "
\n"; } function wp_cache_edit_accepted() { global $cache_acceptable_files, $cache_rejected_uri, $wp_cache_config_file, $valid_nonce; if(isset($_REQUEST['wp_accepted_files']) && $valid_nonce) { $text = wp_cache_sanitize_value($_REQUEST['wp_accepted_files'], $cache_acceptable_files); wp_cache_replace_line('^ *\$cache_acceptable_files', "\$cache_acceptable_files = $text;", $wp_cache_config_file); } echo "

Add here those filenames that can be cached, even if they match one of the rejected substring specified above.

\n"; echo '
'; echo ''; echo ' '; echo '
'; wp_nonce_field('wp-cache'); echo "
\n"; } function wp_cache_enable() { global $wp_cache_config_file, $cache_enabled, $supercachedir; if(get_option('gzipcompression')) { echo "Error: GZIP compression is enabled, disable it if you want to enable wp-cache.

"; return false; } if( wp_cache_replace_line('^ *\$cache_enabled', '$cache_enabled = true;', $wp_cache_config_file) ) { $cache_enabled = true; } wp_super_cache_enable(); } function wp_cache_disable() { global $wp_cache_config_file, $cache_enabled, $supercachedir, $cache_path; if (wp_cache_replace_line('^ *\$cache_enabled', '$cache_enabled = false;', $wp_cache_config_file)) { $cache_enabled = false; } wp_super_cache_disable(); } function wp_super_cache_enable() { global $supercachedir, $wp_cache_config_file, $super_cache_enabled; if( is_dir( $supercachedir . ".disabled" ) ) rename( $supercachedir . ".disabled", $supercachedir ); wp_cache_replace_line('^ *\$super_cache_enabled', '$super_cache_enabled = true;', $wp_cache_config_file); $super_cache_enabled = true; } function wp_super_cache_disable() { global $supercachedir, $wp_cache_config_file, $super_cache_enabled; wp_cache_replace_line('^ *\$super_cache_enabled', '$super_cache_enabled = false;', $wp_cache_config_file); if( is_dir( $supercachedir ) ) rename( $supercachedir, $supercachedir . ".disabled" ); $super_cache_enabled = false; sleep( 1 ); // allow existing processes to write to the supercachedir and then delete it if (function_exists ('prune_super_cache') && is_dir( $supercachedir ) ) { prune_super_cache( $supercachedir, true ); } } function wp_cache_is_enabled() { global $wp_cache_config_file; if(get_option('gzipcompression')) { echo "Warning: GZIP compression is enabled in Wordpress, wp-cache will be bypassed until you disable gzip compression.
"; return false; } $lines = file($wp_cache_config_file); foreach($lines as $line) { if (preg_match('/^ *\$cache_enabled *= *true *;/', $line)) return true; } return false; } function wp_cache_replace_line($old, $new, $my_file) { if (!is_writable($my_file)) { echo "Error: file $my_file is not writable.
\n"; return false; } $found = false; $lines = file($my_file); foreach($lines as $line) { if ( preg_match("/$old/", $line)) { $found = true; break; } } if ($found) { $fd = fopen($my_file, 'w'); foreach($lines as $line) { if ( !preg_match("/$old/", $line)) fputs($fd, $line); else { fputs($fd, "$new //Added by WP-Cache Manager\n"); } } fclose($fd); return true; } $fd = fopen($my_file, 'w'); $done = false; foreach($lines as $line) { if ( $done || !preg_match('/^define|\$|\?>/', $line)) fputs($fd, $line); else { fputs($fd, "$new //Added by WP-Cache Manager\n"); fputs($fd, $line); $done = true; } } fclose($fd); return true; /* copy($my_file, $my_file . "-prev"); rename($my_file . '-new', $my_file); */ } function wp_cache_verify_cache_dir() { global $cache_path; $dir = dirname($cache_path); if ( !file_exists($cache_path) ) { if ( !is_writable( $dir ) || !($dir = mkdir( $cache_path ) ) ) { echo "Error: Your cache directory ($cache_path) did not exist and couldn't be created by the web server.
Check $dir permissions."; return false; } } if ( !is_writable($cache_path)) { echo "Error: Your cache directory ($cache_path) or $dir need to be writable for this plugin to work.
Double-check it."; return false; } if ( '/' != substr($cache_path, -1)) { $cache_path .= '/'; } @mkdir( $cache_path . 'meta/' ); return true; } function wp_cache_verify_config_file() { global $wp_cache_config_file, $wp_cache_config_file_sample; $new = false; $dir = dirname($wp_cache_config_file); if ( !is_writable($dir)) { echo "Error: wp-content directory ($dir) is not writable by the Web server.
Check its permissions."; return false; } if ( file_exists($wp_cache_config_file) ) { $lines = join( ' ', file( $wp_cache_config_file ) ); if( strpos( $lines, 'WPCACHEHOME' ) === false ) { if( is_writable( $wp_cache_config_file ) ) { @unlink( $wp_cache_config_file ); } else { echo "Error: Your WP-Cache config file ($wp_cache_config_file) is out of date and not writable by the Web server.
Please delete it and refresh this page."; return false; } } } if ( !file_exists($wp_cache_config_file) ) { if ( !file_exists($wp_cache_config_file_sample) ) { echo "Error: Sample WP-Cache config file ($wp_cache_config_file_sample) does not exist.
Verify you installation."; return false; } copy($wp_cache_config_file_sample, $wp_cache_config_file); if( is_file( dirname(__FILE__) . '/wp-cache-config-sample.php' ) ) { wp_cache_replace_line('WPCACHEHOME', "define( 'WPCACHEHOME', ABSPATH . " . str_replace( '\\', '/', str_replace( ABSPATH, ' "', dirname(__FILE__) ) ) . "/\" );", $wp_cache_config_file); } elseif( is_file( dirname(__FILE__) . '/wp-super-cache/wp-cache-config-sample.php' ) ) { wp_cache_replace_line('WPCACHEHOME', "define( 'WPCACHEHOME', ABSPATH . " . str_replace( '\\', '/', str_replace( ABSPATH, ' "', dirname(__FILE__) ) ) . "/wp-super-cache/\" );", $wp_cache_config_file); } $new = true; } if ( !is_writable($wp_cache_config_file)) { echo "Error: Your WP-Cache config file ($wp_cache_config_file) is not writable by the Web server.
Check its permissions."; return false; } require($wp_cache_config_file); return true; } function wp_cache_check_link() { global $wp_cache_link, $wp_cache_file; if( file_exists($wp_cache_link) ) { if( strpos( join( "\n", file( $wp_cache_link ) ), 'WPCACHEHOME' ) ) { // read the file and verify it's a super-cache file and not the wp-cache one. return true; } else { // remove the old version @unlink($wp_cache_link); } } $ret = true; if ( basename(@readlink($wp_cache_link)) != basename($wp_cache_file)) { @unlink($wp_cache_link); if( function_exists( 'symlink' ) ) { if( !@symlink ($wp_cache_file, $wp_cache_link) ) { $ret = false; } } elseif( !@copy( $wp_cache_file, $wp_cache_link ) ) { $ret = false; } if( !$ret ) { echo "advanced-cache.php does not exist
"; echo "Create it by executing:
ln -s $wp_cache_file $wp_cache_link
in your server
"; echo "Or by copying $wp_cache_file to $wp_cache_link.
"; return false; } } return true; } function wp_cache_check_global_config() { $global = ABSPATH . 'wp-config.php'; $lines = file($global); foreach($lines as $line) { if (preg_match('/^ *define *\( *\'WP_CACHE\' *, *true *\) *;/', $line)) { return true; } } $line = 'define(\'WP_CACHE\', true);'; if (!is_writable($global) || !wp_cache_replace_line('define *\( *\'WP_CACHE\'', $line, $global) ) { echo "Error: WP_CACHE is not enabled in your wp-config.php file and I couldn't modified it.
"; echo "Edit $global and add the following line:
define('WP_CACHE', true);
Otherwise, WP-Cache will not be executed by Wordpress core.
"; return false; } return true; } function wp_cache_files() { global $cache_path, $file_prefix, $cache_max_time, $super_cache_max_time, $valid_nonce, $supercachedir; if ( '/' != substr($cache_path, -1)) { $cache_path .= '/'; } if ( $valid_nonce ) { if(isset($_REQUEST['wp_delete_cache'])) { wp_cache_clean_cache($file_prefix); } if(isset($_REQUEST['wp_delete_cache_file'])) { wp_cache_clean_cache($_REQUEST['wp_delete_cache_file']); } if(isset($_REQUEST['wp_delete_expired'])) { wp_cache_clean_expired($file_prefix); } } if(isset($_REQUEST['wp_list_cache'])) { $list_files = true; $list_mess = "Update list"; } else $list_mess = "List files"; echo '
Cache contents'; echo '
'; echo ''; echo '
'; echo "
\n"; $count = 0; $expired = 0; $now = time(); if ( ($handle = @opendir( $cache_path . 'meta/' )) ) { if ($list_files) echo ""; while ( false !== ($file = readdir($handle))) { if ( preg_match("/^$file_prefix.*\.meta/", $file) ) { $this_expired = false; $content_file = preg_replace("/meta$/", "html", $file); $mtime = filemtime($cache_path . 'meta/' . $file); if ( ! ($fsize = @filesize($cache_path.$content_file)) ) continue; // .meta does not exists $fsize = intval($fsize/1024); $age = $now - $mtime; if ( $age > $cache_max_time) { $expired++; $this_expired = true; } $count++; if ($list_files) { $meta = new CacheMeta; $meta = unserialize(file_get_contents($cache_path . 'meta/' . $file)); echo $flip ? '' : ''; $flip = !$flip; echo '"; if ($this_expired) echo ""; else echo ""; echo ""; echo '\n"; } } } closedir($handle); if ($list_files) echo "
'; echo $meta->uri . "$age secs$age secs$fsize KB
'; echo ''; echo ''; echo '
'; wp_nonce_field('wp-cache'); echo "
"; } $sizes = get_option( 'super_cache_meta' ); if( !$sizes ) $sizes = array( 'expired' => 0, 'cached' => 0, 'ts' => 0 ); $now = time(); if( $_POST[ 'super_cache_stats' ] == 1 || $sizes[ 'cached' ] == 0 || $sizes[ 'ts' ] + 3600 <= $now ) { $sizes = array( 'expired' => 0, 'cached' => 0, 'ts' => 0 ); if (is_dir($supercachedir)) { $entries = glob($supercachedir. '/*'); foreach ($entries as $entry) { if ($entry != '.' && $entry != '..') { $sizes = wpsc_dirsize( $entry, $sizes ); } } } else { if(is_file($supercachedir) && filemtime( $supercachedir ) + $super_cache_max_time <= $now ) $sizes[ 'expired' ] ++; } $sizes[ 'ts' ] = time(); update_option( 'super_cache_meta', $sizes ); } echo "

WP-Cache

"; echo ""; echo "

WP-Super-Cache

"; echo ""; echo '
'; echo ''; echo '
'; wp_nonce_field('wp-cache'); echo "
\n"; echo '
'; echo ''; echo '
'; wp_nonce_field('wp-cache'); echo "
\n"; echo '
'; echo ''; echo '
'; wp_nonce_field('wp-cache'); echo "
\n"; echo '
'; } function wpsc_dirsize($directory, $sizes) { global $super_cache_max_time; $now = time(); if (is_dir($directory)) { $entries = glob($directory. '/*'); foreach ($entries as $entry) { if ($entry != '.' && $entry != '..') { $sizes = wpsc_dirsize($entry, $sizes); } } } else { if(is_file($directory) ) { if( filemtime( $directory ) + $super_cache_max_time <= $now ) { $sizes[ 'expired' ]+=1; } else { $sizes[ 'cached' ]+=1; } } } return $sizes; } function wp_cache_clean_cache($file_prefix) { global $cache_path, $supercachedir; // If phase2 was compiled, use its function to avoid race-conditions if(function_exists('wp_cache_phase2_clean_cache')) { if (function_exists ('prune_super_cache')) { if( is_dir( $supercachedir ) ) { prune_super_cache( $supercachedir, true ); } elseif( is_dir( $supercachedir . '.disabled' ) ) { prune_super_cache( $supercachedir . '.disabled', true ); } prune_super_cache( $cache_path, true ); $_POST[ 'super_cache_stats' ] = 1; // regenerate super cache stats; } return wp_cache_phase2_clean_cache($file_prefix); } $expr = "/^$file_prefix/"; if ( ($handle = opendir( $cache_path )) ) { while ( false !== ($file = readdir($handle))) { if ( preg_match($expr, $file) ) { unlink($cache_path . $file); unlink($cache_path . 'meta/' . str_replace( '.html', '.term', $file ) ); } } closedir($handle); } } function wp_cache_clean_expired($file_prefix) { global $cache_path, $cache_max_time; // If phase2 was compiled, use its function to avoid race-conditions if(function_exists('wp_cache_phase2_clean_expired')) { if (function_exists ('prune_super_cache')) { $dir = $cache_path . 'supercache/' . preg_replace('/:.*$/', '', $_SERVER["HTTP_HOST"]); if( is_dir( $dir ) ) { prune_super_cache( $dir ); } elseif( is_dir( $dir . '.disabled' ) ) { prune_super_cache( $dir . '.disabled' ); } $_POST[ 'super_cache_stats' ] = 1; // regenerate super cache stats; } return wp_cache_phase2_clean_expired($file_prefix); } $expr = "/^$file_prefix/"; $now = time(); if ( ($handle = opendir( $cache_path )) ) { while ( false !== ($file = readdir($handle))) { if ( preg_match($expr, $file) && (filemtime($cache_path . $file) + $cache_max_time) <= $now) { unlink($cache_path . $file); unlink($cache_path . 'meta/' . str_replace( '.html', '.term', $file ) ); } } closedir($handle); } } add_action('admin_menu', 'wp_cache_add_pages'); if( get_option( 'gzipcompression' ) ) update_option( 'gzipcompression', 0 ); ?>