index-wp-redis.php 12.3 KB
Newer Older
Benjamin Adams's avatar
Benjamin Adams committed
1
<?php
2 3 4 5 6 7 8
/**
 * WP REDIS CACHE
 */

/**
 * GLOBAL CONFIGURATION
 */
9 10 11
global $wp_redis_cache_config;

$wp_redis_cache_config = array(
12 13
	'debug'          => false,
	'debug_messages' => '',
14
	'stats'          => false,
15 16 17 18 19 20
	'cache'          => false,
	'server_ip'      => '127.0.0.1',
	'redis_server'   => '127.0.0.1',
	'redis_port'     => 6379,
	'redis_db'       => 0,
	'secret_string'  => 'changeme',
21 22
);

23
// Uncomment either option below to fix the values here and disable the admin UI
24 25
// $wp_redis_cache_config['cache_duration'] = 43200;
// $wp_redis_cache_config['unlimited']      = false;
26

27 28 29 30 31
// Modify this function to introduce custom handling when exceptions occur
function wp_redis_cache_exception_handler( $exception ) {
	return;
}

32
/**
33 34
 * END GLOBAL CONFIGURATION
 *
35 36
 * DO NOT EDIT BELOW THIS LINE!
 */
Erick Hitter's avatar
Erick Hitter committed
37
$wp_redis_cache_config['current_url'] = wp_redis_cache_get_clean_url();
38
$wp_redis_cache_config['redis_key']   = md5( $wp_redis_cache_config['current_url'] );
Benjamin Adams's avatar
Benjamin Adams committed
39

Ulrich Block's avatar
Ulrich Block committed
40
// Start the timer so we can track the page load time
41
if ( $wp_redis_cache_config['debug'] || $wp_redis_cache_config['stats'] ) {
42 43
	$start = microtime();
}
Ulrich Block's avatar
Ulrich Block committed
44

45
/**
46
 * SET SEPARATE CACHES FOR BROAD DEVICE TYPES
47
 */
48
$wp_redis_cache_config['redis_key'] = wp_redis_cache_set_device_key( $wp_redis_cache_config['redis_key'] );
49

50 51 52 53 54 55 56 57 58
/**
 * UTILITY FUNCTIONS
 */

/**
 * Compute microtime from a timestamp
 *
 * @return float
 */
Erick Hitter's avatar
Erick Hitter committed
59
function wp_redis_cache_get_micro_time( $time ) {
Erick Hitter's avatar
Erick Hitter committed
60 61
	list( $usec, $sec ) = explode( " ", $time );
	return ( (float) $usec + (float) $sec );
Ulrich Block's avatar
Ulrich Block committed
62 63
}

64 65 66 67 68 69 70 71 72 73 74 75
/**
 * Count seconds elapsed between two microtime() timestampes
 *
 * @param string $start
 * @param string $end
 * @param int $precision
 * @return float
 */
function wp_redis_cache_time_elapsed( $start, $end ) {
	return round( @wp_redis_cache_get_micro_time( $end ) - @wp_redis_cache_get_micro_time( $start ), 5 );
}

76 77 78 79 80
/**
 * Is the current request a refresh request with the correct secret key?
 *
 * @return bool
 */
Erick Hitter's avatar
Erick Hitter committed
81
function wp_redis_cache_refresh_has_secret( $secret ) {
Erick Hitter's avatar
Erick Hitter committed
82
	return isset( $_GET['refresh'] ) && $secret == $_GET['refresh'];
Benjamin Adams's avatar
merged  
Benjamin Adams committed
83
}
Ulrich Block's avatar
Ulrich Block committed
84

85 86 87 88 89
/**
 * Does current request include a refresh request?
 *
 * @return bool
 */
Erick Hitter's avatar
Erick Hitter committed
90
function wp_redis_cache_request_has_secret( $secret ) {
Erick Hitter's avatar
Erick Hitter committed
91
	return false !== strpos( $_SERVER['REQUEST_URI'], "refresh=${secret}" );
Benjamin Adams's avatar
merged  
Benjamin Adams committed
92
}
Hendrik Klemp's avatar
Hendrik Klemp committed
93

94 95 96 97 98
/**
 * Determine if request is from a server other than the one running this code
 *
 * @return bool
 */
Erick Hitter's avatar
Erick Hitter committed
99
function wp_redis_cache_is_remote_page_load( $current_url, $server_ip ) {
Erick Hitter's avatar
Erick Hitter committed
100
	return ( isset( $_SERVER['HTTP_REFERER'] )
101
			&& $_SERVER['HTTP_REFERER'] == $current_url
Erick Hitter's avatar
Erick Hitter committed
102
			&& $_SERVER['REQUEST_URI'] != '/'
103
			&& $_SERVER['REMOTE_ADDR'] != $server_ip );
Benjamin Adams's avatar
merged  
Benjamin Adams committed
104
}
Hendrik Klemp's avatar
Hendrik Klemp committed
105

106 107 108 109 110
/**
 * Set proper IP address for proxied requests
 *
 * @return null
 */
Erick Hitter's avatar
Erick Hitter committed
111
function wp_redis_cache_handle_cdn_remote_addressing() {
Erick Hitter's avatar
Erick Hitter committed
112
	// so we don't confuse the cloudflare server
Erick Hitter's avatar
Erick Hitter committed
113
	if ( isset( $_SERVER['HTTP_CF_CONNECTING_IP'] ) ) {
Erick Hitter's avatar
Erick Hitter committed
114 115
		$_SERVER['REMOTE_ADDR'] = $_SERVER['HTTP_CF_CONNECTING_IP'];
	}
Benjamin Adams's avatar
merged  
Benjamin Adams committed
116
}
117

118 119 120
/**
 * Prepare a URL for use as a cache key
 *
Erick Hitter's avatar
Erick Hitter committed
121
 * If the URL is too malformed to parse, a one-time cache is set using microtime().
122 123 124
 *
 * @return string
 */
Erick Hitter's avatar
Erick Hitter committed
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140
function wp_redis_cache_get_clean_url() {
	$proto = 'http';
	if ( isset( $_SERVER['HTTPS'] ) && ( 'on' === strtolower( $_SERVER['HTTPS'] ) || '1' === $_SERVER['HTTPS'] ) ) {
		$proto .= 's';
	} elseif ( isset( $_SERVER['SERVER_PORT'] ) && ( '443' == $_SERVER['SERVER_PORT'] ) ) {
		$proto .= 's';
	}

	$url = parse_url( $proto . '://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] );
	if ( $url ) {
		$url = $url['scheme'] . '://' . $url['host'] . $url['path'];
	} else {
		$url = microtime();
	}

	return $url;
Benjamin Adams's avatar
Benjamin Adams committed
141
}
Benjamin Adams's avatar
merged  
Benjamin Adams committed
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
 * Prefix cache key if device calls for separate caching
 *
 * @param string $key
 * @return $string
 */
function wp_redis_cache_set_device_key( $key ) {
	switch ( wp_redis_cache_get_device_type() ) {
		case 'tablet' :
			$prefix = 'T-';
			break;
		case 'mobile' :
			$prefix = 'M-';
			break;
		default :
		case 'desktop' :
			$prefix = '';
			break;
	}

	return $prefix . $key;
}

/**
 * Determine the current device type from its user agent
 * Allows for separate caches for tablet, mobile, and desktop visitors
169
 *
170
 * @return string
171
 */
172
function wp_redis_cache_get_device_type() {
Erick Hitter's avatar
Erick Hitter committed
173
	$ua = isset( $_SERVER['HTTP_USER_AGENT'] ) ? $_SERVER['HTTP_USER_AGENT'] : '';
174 175 176 177 178 179 180 181 182 183 184 185 186

	if ( empty( $ua ) ) {
		return 'desktop';
	}

	// Tablet user agents
	if (
		false !== stripos( $ua, 'ipad'       ) ||
		( false !== stripos( $ua, 'Android'  ) && false === stripos( $ua, 'mobile' ) ) ||
		false !== stripos( $ua, 'tablet '    ) ||
		false !== stripos( $ua, 'Silk/'      ) ||
		false !== stripos( $ua, 'Kindle'     ) ||
		false !== stripos( $ua, 'PlayBook'   ) ||
187
		false !== stripos( $ua, 'RIM Tablet' )
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
	) {
		return 'tablet';
	}

	// Mobile user agents
	if (
		false !== stripos( $ua, 'Mobile'     ) || // many mobile devices (all iPhone, iPad, etc.)
		false !== stripos( $ua, 'Android'    ) ||
		false !== stripos( $ua, 'BlackBerry' ) ||
		false !== stripos( $ua, 'Opera Mini' ) ||
		false !== stripos( $ua, 'Opera Mobi' )
	) {
		return 'mobile';
	}

	return 'desktop';
204 205
}

206
/**
207 208 209 210 211
 * Establish a connection to the Redis server
 *
 * Will try the PECL module first, then fall back to PRedis
 *
 * @return object
212
 */
213
function wp_redis_cache_connect_redis() {
214 215
	global $wp_redis_cache_config;

Erick Hitter's avatar
Erick Hitter committed
216
	// check if PECL Extension is available
Erick Hitter's avatar
Erick Hitter committed
217
	if ( class_exists( 'Redis' ) ) {
218 219
		if ( $wp_redis_cache_config['debug'] ) {
			$wp_redis_cache_config['debug_messages'] .= "<!-- Redis PECL module found -->\n";
Erick Hitter's avatar
Erick Hitter committed
220
		}
Erick Hitter's avatar
Erick Hitter committed
221

Erick Hitter's avatar
Erick Hitter committed
222
		$redis = new Redis();
223
		$redis->connect( $wp_redis_cache_config['redis_server'], $wp_redis_cache_config['redis_port'] );
224 225 226 227 228

		// Default DB is 0, so only need to SELECT if other
		if ( $wp_redis_cache_config['redis_db'] ) {
			$redis->select( $wp_redis_cache_config['redis_db'] );
		}
229 230
	// Fallback to predis5.2.php
	} else {
231 232
		if ( $wp_redis_cache_config['debug'] ) {
			$wp_redis_cache_config['debug_messages'] .= "<!-- using predis as a backup -->\n";
Erick Hitter's avatar
Erick Hitter committed
233
		}
Erick Hitter's avatar
Erick Hitter committed
234

235
		include_once dirname( __FILE__ ) . '/wp-content/plugins/wp-redis-cache/predis5.2.php'; //we need this to use Redis inside of PHP
236 237 238 239 240 241 242 243 244 245 246
		$redis = array(
			'host' => $wp_redis_cache_config['redis_server'],
			'port' => $wp_redis_cache_config['redis_port'],
		);

		// Default DB is 0, so only need to SELECT if other
		if ( $wp_redis_cache_config['redis_db'] ) {
			$redis['database'] = $wp_redis_cache_config['redis_db'];
		}

		$redis = new Predis_Client( $redis );
Erick Hitter's avatar
Erick Hitter committed
247 248
	}

249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267
	return $redis;
}

/**
 * BEGIN CACHING LOGIC
 */

// Set proper IP for proxied requests
wp_redis_cache_handle_cdn_remote_addressing();

// Ensure WP uses a theme (this is normally set in index.php)
if ( ! defined( 'WP_USE_THEMES' ) ) {
	define( 'WP_USE_THEMES', true );
}

try {
	// Establish connection with Redis server
	$redis = wp_redis_cache_connect_redis();

268 269 270
	// Whether we need to load WP
	$load_wp = true;

271 272 273 274
	// Relevant details on the current request
	$is_post   = (bool) 'POST' === $_SERVER['REQUEST_METHOD'];
	$logged_in = (bool) preg_match( "#(wordpress_(logged|sec)|comment_author)#", var_export( $_COOKIE, true ) );

275
	if ( $wp_redis_cache_config['debug'] ) {
276 277
		$wp_redis_cache_config['debug_messages'] .= "<!-- POST request: " . ( $is_post ? 'yes' : 'no' ) . "-->\n";
		$wp_redis_cache_config['debug_messages'] .= "<!-- Logged in: " . ( $logged_in ? 'yes' : 'no' ) . "-->\n";
278 279 280
	}

	// Refresh request, deletes cache: either manual refresh cache by adding ?refresh=secret_string after the URL or somebody posting a comment
281 282 283
	if ( wp_redis_cache_refresh_has_secret( $wp_redis_cache_config['secret_string'] ) || wp_redis_cache_request_has_secret( $wp_redis_cache_config['secret_string'] ) || wp_redis_cache_is_remote_page_load( $wp_redis_cache_config['current_url'], $wp_redis_cache_config['server_ip'] ) ) {
		if ( $wp_redis_cache_config['debug'] ) {
			$wp_redis_cache_config['debug_messages'] .= "<!-- manual refresh was required -->\n";
Erick Hitter's avatar
Erick Hitter committed
284
		}
Erick Hitter's avatar
Erick Hitter committed
285

286
		$redis->del( $wp_redis_cache_config['redis_key'] );
287
	// This page is cached, the user isn't logged in, and it isn't a POST request, so let's use the cache
288 289 290
	} elseif ( ! $is_post && ! $logged_in && $redis->exists( $wp_redis_cache_config['redis_key'] ) ) {
		if ( $wp_redis_cache_config['debug'] ) {
			$wp_redis_cache_config['debug_messages'] .= "<!-- serving page from cache: key: " . $wp_redis_cache_config['redis_key'] . " -->\n";
291 292
		}

293 294
		// Page is served from cache, so we don't need WP
		$load_wp = false;
295
		$wp_redis_cache_config['cached'] = true;
296

297
		echo trim( $redis->get( $wp_redis_cache_config['redis_key'] ) );
298 299 300 301 302 303

		// Display generation stats if requested
		if ( $wp_redis_cache_config['stats'] ) {
			echo "\n<!-- Page cached via Redis using the WP Redis Cache plugin. -->";
			echo "\n<!-- Retrieved from cache in " . wp_redis_cache_time_elapsed( $start, microtime() ) . " seconds. -->";
		}
Erick Hitter's avatar
Erick Hitter committed
304
	// If the cache does not exist lets display the user the normal page without cache, and then fetch a new cache page
305 306 307 308
	} elseif ( $_SERVER['REMOTE_ADDR'] != $wp_redis_cache_config['server_ip'] ) {
		if ( false === strstr( $wp_redis_cache_config['current_url'], 'preview=true' ) ) {
			if ( $wp_redis_cache_config['debug'] ) {
				$wp_redis_cache_config['debug_messages'] .= "<!-- displaying page without cache -->\n";
309
			}
310

311 312 313 314 315 316 317
			// If user isn't logged in and this isn't a post request, render the requested page and cache if appropriate.
			if ( ! $is_post && ! $logged_in ) {
				// We load WP to generate the cached output, so no need to load again
				$load_wp = false;

				// Render page into an output buffer and display
				ob_start();
318
				require_once dirname( __FILE__ ) . '/wp-blog-header.php';
319 320 321
				$markup_to_cache = trim( ob_get_clean() );
				echo $markup_to_cache;

322 323 324 325 326 327
				// Display generation stats if requested
				if ( $wp_redis_cache_config['stats'] ) {
					echo "\n<!-- Page NOT cached via Redis using the WP Redis Cache plugin. -->";
					echo "\n<!-- Generated and cached in " . wp_redis_cache_time_elapsed( $start, microtime() ) . " seconds. -->";
				}

328 329 330
				// Cache rendered page if appropriate
				if ( ! is_404() && ! is_search() ) {
					// Is unlimited cache life requested?
331 332
					if ( isset( $wp_redis_cache_config['unlimited'] ) ) {
						$unlimited = $wp_redis_cache_config['unlimited'];
333
					} else {
334
						$unlimited = (bool) get_option( 'wp-redis-cache-debug', false );
335
						$wp_redis_cache_config['unlimited'] = $unlimited;
336 337
					}

338 339
					// Cache the page for the chosen duration
					if ( $unlimited ) {
340
						$redis->set( $wp_redis_cache_config['redis_key'], $markup_to_cache );
341
					} else {
342 343
						if ( isset( $wp_redis_cache_config['cache_duration'] ) ) {
							$cache_duration = $wp_redis_cache_config['cache_duration'];
344 345
						} else {
							$cache_duration = (int) get_option( 'wp-redis-cache-seconds', 43200 );
346
							$wp_redis_cache_config['cache_duration'] = $cache_duration;
347 348 349
						}

						if ( ! is_numeric( $cache_duration ) ) {
350
							$cache_duration = $wp_redis_cache_config['cache_duration'] = 43200;
351 352
						}

353
						$redis->setex( $wp_redis_cache_config['redis_key'], $cache_duration, $markup_to_cache );
354
					}
Erick Hitter's avatar
Erick Hitter committed
355
				}
356 357 358
			}
		}
	}
359 360 361

	// The current request wasn't served from cache or isn't cacheable, so we pass off to WP
	if ( $load_wp ) {
362
		require_once dirname( __FILE__ ) . '/wp-blog-header.php';
Erick Hitter's avatar
Erick Hitter committed
363
	}
Erick Hitter's avatar
Erick Hitter committed
364
} catch ( Exception $e ) {
365
	require_once dirname( __FILE__ ) . '/wp-blog-header.php';
366
	wp_redis_cache_exception_handler( $e );
Benjamin Adams's avatar
Benjamin Adams committed
367 368
}

369 370 371
/**
 * DEBUGGING OUTPUT
 */
372
if ( $wp_redis_cache_config['debug'] ) {
373
	$end  = microtime();
374 375
	$time = wp_redis_cache_time_elapsed( $start, $end );
	$wp_redis_cache_config['debug_messages'] .= "<!-- WP Redis Cache by Erick Hitter. Page generated in " . $time . " seconds. -->\n";
376
	$wp_redis_cache_config['debug_messages'] .= "<!-- Site was cached = " . $wp_redis_cache_config['cached'] . " -->\n";
377
	$wp_redis_cache_config['debug_messages'] .= "<!-- wp-redis-cache-key = " . $wp_redis_cache_config['redis_key'] . "-->\n";
378 379
	if ( isset( $wp_redis_cache_config['cache_duration'] ) ) {
		$wp_redis_cache_config['debug_messages'] .= "<!-- wp-redis-cache-seconds = " . $wp_redis_cache_config['cache_duration'] . " -->\n";
Erick Hitter's avatar
Erick Hitter committed
380
	}
381 382 383
	$wp_redis_cache_config['debug_messages'] .= "<!-- wp-redis-cache-ip = " . $wp_redis_cache_config['server_ip'] . "-->\n";
	if ( isset( $wp_redis_cache_config['unlimited'] ) ) {
		$wp_redis_cache_config['debug_messages'] .= "<!-- wp-redis-cache-unlimited = " . $wp_redis_cache_config['unlimited'] . "-->\n";
Erick Hitter's avatar
Erick Hitter committed
384
	}
385
	$wp_redis_cache_config['debug_messages'] .= "<!-- wp-redis-cache-debug = " . $wp_redis_cache_config['debug'] . "-->\n";
386

387
	echo $wp_redis_cache_config['debug_messages'];
Benjamin Adams's avatar
Benjamin Adams committed
388
}