Extension_CloudFlare_Plugin.php 12.1 KB
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
<?php
namespace W3TC;

/**
 * W3 ObjectCache plugin
 */
define( 'W3TC_MARKER_BEGIN_CLOUDFLARE', '# BEGIN W3TC CloudFlare' );
define( 'W3TC_MARKER_END_CLOUDFLARE', '# END W3TC CloudFlare' );

/**
 * Class W3_Plugin_CloudFlare
 */
class Extension_CloudFlare_Plugin {
	private $_config;
	private $flush_operation_requested = false;



	function __construct() {
		$this->_config = Dispatcher::config();
	}



	/**
	 * Runs plugin
	 */
	function run() {
		add_filter( 'w3tc_config_default_values', array(
				$this, 'w3tc_config_default_values' ) );

		add_action( 'wp_set_comment_status',
			array( $this, 'set_comment_status' ), 1, 2 );

		// priority is important, see do_action call of that action
		add_action( 'w3tc_flush_all', array( $this, 'w3tc_flush_all' ), 3000, 1 );

		add_filter( 'w3tc_flush_execute_delayed_operations',
			array( $this, 'w3tc_flush_execute_delayed_operations' ), 3000, 1 );

		$this->fix_remote_addr();

		// if page caching is enabled on CF - attach to post modifications
		// and flush it
		if ( $this->_config->get_boolean( array( 'cloudflare', 'pagecache' ) ) ) {
			Util_AttachToActions::flush_posts_on_actions();

			add_action( 'w3tc_flush_post',
				array( $this, 'w3tc_flush_xxx' ), 3000 );
			add_action( 'w3tc_flushable_posts', '__return_true', 3000 );
			add_action( 'w3tc_flush_posts',
				array( $this, 'w3tc_flush_xxx' ), 3000 );
		}
	}



	public function w3tc_config_default_values( $default_values ) {
		$default_values['cloudflare'] = array(
			'widget_interval' => 30,
			'widget_cache_mins' => 5,
			'timelimit.api_request' => 180
		);

		return $default_values;
	}



	public function w3tc_flush_all( $extras ) {
		if ( is_array( $extras ) && isset( $extras['cloudflare'] ) &&
			$extras['cloudflare'] == 'skip' )
			return;

		$this->flush_operation_requested = true;
	}



	public function w3tc_flush_xxx() {
		$this->flush_operation_requested = true;
	}



	public function w3tc_flush_execute_delayed_operations( $actions_made ) {
		if ( $this->flush_operation_requested ) {
			$c = Dispatcher::config();
			$api = new Extension_CloudFlare_Api( array(
					'email' => $c->get_string( array( 'cloudflare', 'email' ) ),
					'key' => $c->get_string( array( 'cloudflare', 'key' ) ),
					'zone_id' => $c->get_string( array( 'cloudflare', 'zone_id' ) ),
					'timelimit_api_request' => $c->get_integer(
						array( 'cloudflare', 'timelimit.api_request' ) )
				)
			);

			$action_made = array(
				'module' => 'cloudflare'
			);

			try {
				$api->purge();
			} catch ( \Exception $ex ) {
				$action_made['error'] =
					'Failed to purge CloudFlare cache: ' . $ex->getMessage();
			}

			$this->flush_operation_requested = false;

			$actions_made[] = $action_made;
		}

		return $actions_made;
	}



	function set_comment_status( $id, $status ) {
		if ( $status == "spam" ) {
			$comment = get_comment( $id );
			$value = array(
				'a' => $comment->comment_author,
				'am' => $comment->comment_author_email,
				'ip' => $comment->comment_author_IP,
				'con' => substr( $comment->comment_content, 0, 100 ) );

			$c = Dispatcher::config();
			$api = new Extension_CloudFlare_Api( array(
					'email' => $c->get_string( array( 'cloudflare', 'email' ) ),
					'key' => $c->get_string( array( 'cloudflare', 'key' ) ),
					'zone_id' => $c->get_string( array( 'cloudflare', 'zone_id' ) ),
					'timelimit_api_request' => $c->get_integer(
						array( 'cloudflare', 'timelimit.api_request' ) )
				)
			);
			
			try {
				$api->external_event( 'WP_SPAM', json_encode( $value ) );
			} catch ( \Exception $ex ) {
			}
		}
	}



	public function menu_bar( $menu_items ) {
		$menu_items = array_merge( $menu_items, array(
				array(
					'id' => 'cloudflare',
					'title' => __( 'CloudFlare', 'w3-total-cache' ),
					'href' => 'https://www.cloudflare.com'
				),
				array(
					'id' => 'cloudflare-my-websites',
					'parent' => 'cloudflare',
					'title' => __( 'My Websites', 'w3-total-cache' ),
					'href' => 'https://www.cloudflare.com/my-websites.html'
				),
				array(
					'id' => 'cloudflare-analytics',
					'parent' => 'cloudflare',
					'title' => __( 'Analytics', 'w3-total-cache' ),
					'href' => 'https://www.cloudflare.com/analytics.html'
				),
				array(
					'id' => 'cloudflare-account',
					'parent' => 'cloudflare',
					'title' => __( 'Account', 'w3-total-cache' ),
					'href' => 'https://www.cloudflare.com/my-account.html'
				)
			) );
		return $menu_items;
	}


	/**
	 * Fix client's IP-address
	 */
	private function fix_remote_addr() {
		if ( empty( $_SERVER['HTTP_CF_CONNECTING_IP'] ) )
			return;

		if ( strpos( $_SERVER["REMOTE_ADDR"], ":" ) === FALSE ) {
			$ip4_ranges = $this->_config->get_array( array(
					'cloudflare', 'ips.ip4' ) );
			foreach ( $ip4_ranges as $range ) {
				if ( $this->ipv4_in_range( $_SERVER['REMOTE_ADDR'], $range ) ) {
					$_SERVER['REMOTE_ADDR'] = $_SERVER['HTTP_CF_CONNECTING_IP'];
					break;
				}
			}
		} else {
			$ip6_ranges = $this->_config->get_array( array(
					'cloudflare', 'ips.ip6' ) );
			$ip6 = $this->get_ipv6_full( $_SERVER["REMOTE_ADDR"] );
			foreach ( $ip6_ranges as $range ) {
				if ( $this->ipv6_in_range( $ip6, $range ) ) {
					$_SERVER['REMOTE_ADDR'] = $_SERVER['HTTP_CF_CONNECTING_IP'];
					break;
				}
			}
		}
	}



	/*
	 * ip_in_range.php - Function to determine if an IP is located in a
	 *                   specific range as specified via several alternative
	 *                   formats.
	 *
	 * Network ranges can be specified as:
	 * 1. Wildcard format:     1.2.3.*
	 * 2. CIDR format:         1.2.3/24  OR  1.2.3.4/255.255.255.0
	 * 3. Start-End IP format: 1.2.3.0-1.2.3.255
	 *
	 * Return value BOOLEAN : ip_in_range($ip, $range);
	 *
	 * Copyright 2008: Paul Gregg <pgregg@pgregg.com>
	 * 10 January 2008
	 * Version: 1.2
	 *
	 * Source website: http://www.pgregg.com/projects/php/ip_in_range/
	 * Version 1.2
	 *
	 * This software is Donationware - if you feel you have benefited from
	 * the use of this tool then please consider a donation. The value of
	 * which is entirely left up to your discretion.
	 * http://www.pgregg.com/donate/
	 *
	 * Please do not remove this header, or source attibution from this file.
	 * Modified by James Greene <james@cloudflare.com> to include IPV6 support
	 * (original version only supported IPV4).
	 * 21 May 2012
	*/
	/**
	 * ipv4_in_range
	 * This function takes 2 arguments, an IP address and a "range" in several
	 * different formats.
	 * Network ranges can be specified as:
	 * 1. Wildcard format:     1.2.3.*
	 * 2. CIDR format:         1.2.3/24  OR  1.2.3.4/255.255.255.0
	 * 3. Start-End IP format: 1.2.3.0-1.2.3.255
	 * The function will return true if the supplied IP is within the range.
	 * Note little validation is done on the range inputs - it expects you to
	 * use one of the above 3 formats.
	 */
	private function ipv4_in_range( $ip, $range ) {
		if ( strpos( $range, '/' ) !== false ) {
			// $range is in IP/NETMASK format
			list( $range, $netmask ) = explode( '/', $range, 2 );
			if ( strpos( $netmask, '.' ) !== false ) {
				// $netmask is a 255.255.0.0 format
				$netmask = str_replace( '*', '0', $netmask );
				$netmask_dec = ip2long( $netmask );
				return ( ip2long( $ip ) & $netmask_dec ) == ( ip2long( $range ) & $netmask_dec );
			} else {
				// $netmask is a CIDR size block
				// fix the range argument
				$x = explode( '.', $range );
				while ( count( $x )<4 ) $x[] = '0';
				list( $a, $b, $c, $d ) = $x;
				$range = sprintf( "%u.%u.%u.%u", empty( $a )?'0':$a, empty( $b )?'0':$b, empty( $c )?'0':$c, empty( $d )?'0':$d );
				$range_dec = ip2long( $range );
				$ip_dec = ip2long( $ip );

				// Strategy 1 - Create the netmask with 'netmask' 1s and then fill it to 32 with 0s
				//$netmask_dec = bindec(str_pad('', $netmask, '1') . str_pad('', 32-$netmask, '0'));

				// Strategy 2 - Use math to create it
				$wildcard_dec = pow( 2, ( 32-$netmask ) ) - 1;
				$netmask_dec = ~ $wildcard_dec;

				return ( $ip_dec & $netmask_dec ) == ( $range_dec & $netmask_dec );
			}
		} else {
			// range might be 255.255.*.* or 1.2.3.0-1.2.3.255
			if ( strpos( $range, '*' ) !==false ) { // a.b.*.* format
				// Just convert to A-B format by setting * to 0 for A and 255 for B
				$lower = str_replace( '*', '0', $range );
				$upper = str_replace( '*', '255', $range );
				$range = "$lower-$upper";
			}

			if ( strpos( $range, '-' )!==false ) { // A-B format
				list( $lower, $upper ) = explode( '-', $range, 2 );
				$lower_dec = (float)sprintf( "%u", ip2long( $lower ) );
				$upper_dec = (float)sprintf( "%u", ip2long( $upper ) );
				$ip_dec = (float)sprintf( "%u", ip2long( $ip ) );
				return ( $ip_dec>=$lower_dec ) && ( $ip_dec<=$upper_dec );
			}
			return false;
		}
	}



	private function ip2long6( $ip ) {
		if ( substr_count( $ip, '::' ) ) {
			$ip = str_replace( '::', str_repeat( ':0000', 8 - substr_count( $ip, ':' ) ) . ':', $ip );
		}

		$ip = explode( ':', $ip );
		$r_ip = '';
		foreach ( $ip as $v ) {
			$r_ip .= str_pad( base_convert( $v, 16, 2 ), 16, 0, STR_PAD_LEFT );
		}

		return base_convert( $r_ip, 2, 10 );
	}



	/**
	 * Get the ipv6 full format and return it as a decimal value.
	 */
	private function get_ipv6_full( $ip ) {
		$pieces = explode( "/", $ip, 2 );
		$left_piece = $pieces[0];
		$right_piece = $pieces[1];

		// Extract out the main IP pieces
		$ip_pieces = explode( "::", $left_piece, 2 );
		$main_ip_piece = $ip_pieces[0];
		$last_ip_piece = $ip_pieces[1];

		// Pad out the shorthand entries.
		$main_ip_pieces = explode( ":", $main_ip_piece );
		foreach ( $main_ip_pieces as $key=>$val ) {
			$main_ip_pieces[$key] = str_pad( $main_ip_pieces[$key], 4, "0", STR_PAD_LEFT );
		}

		// Check to see if the last IP block (part after ::) is set
		$last_piece = "";
		$size = count( $main_ip_pieces );
		if ( trim( $last_ip_piece ) != "" ) {
			$last_piece = str_pad( $last_ip_piece, 4, "0", STR_PAD_LEFT );

			// Build the full form of the IPV6 address considering the last IP block set
			for ( $i = $size; $i < 7; $i++ ) {
				$main_ip_pieces[$i] = "0000";
			}
			$main_ip_pieces[7] = $last_piece;
		}
		else {
			// Build the full form of the IPV6 address
			for ( $i = $size; $i < 8; $i++ ) {
				$main_ip_pieces[$i] = "0000";
			}
		}

		// Rebuild the final long form IPV6 address
		$final_ip = implode( ":", $main_ip_pieces );

		return $this->ip2long6( $final_ip );
	}



	/**
	 * Determine whether the IPV6 address is within range.
	 * $ip is the IPV6 address in decimal format to check if its within the IP range created by the cloudflare IPV6 address, $range_ip.
	 * $ip and $range_ip are converted to full IPV6 format.
	 * Returns true if the IPV6 address, $ip,  is within the range from $range_ip.  False otherwise.
	 */
	private function ipv6_in_range( $ip, $range_ip ) {
		$pieces = explode( "/", $range_ip, 2 );
		$left_piece = $pieces[0];
		$right_piece = $pieces[1];

		// Extract out the main IP pieces
		$ip_pieces = explode( "::", $left_piece, 2 );
		$main_ip_piece = $ip_pieces[0];
		$last_ip_piece = $ip_pieces[1];

		// Pad out the shorthand entries.
		$main_ip_pieces = explode( ":", $main_ip_piece );
		foreach ( $main_ip_pieces as $key=>$val ) {
			$main_ip_pieces[$key] = str_pad( $main_ip_pieces[$key], 4, "0", STR_PAD_LEFT );
		}

		// Create the first and last pieces that will denote the IPV6 range.
		$first = $main_ip_pieces;
		$last = $main_ip_pieces;

		// Check to see if the last IP block (part after ::) is set
		$last_piece = "";
		$size = count( $main_ip_pieces );
		if ( trim( $last_ip_piece ) != "" ) {
			$last_piece = str_pad( $last_ip_piece, 4, "0", STR_PAD_LEFT );

			// Build the full form of the IPV6 address considering the last IP block set
			for ( $i = $size; $i < 7; $i++ ) {
				$first[$i] = "0000";
				$last[$i] = "ffff";
			}
			$main_ip_pieces[7] = $last_piece;
		}
		else {
			// Build the full form of the IPV6 address
			for ( $i = $size; $i < 8; $i++ ) {
				$first[$i] = "0000";
				$last[$i] = "ffff";
			}
		}

		// Rebuild the final long form IPV6 address
		$first = $this->ip2long6( implode( ":", $first ) );
		$last = $this->ip2long6( implode( ":", $last ) );
		$in_range = ( $ip >= $first && $ip <= $last );

		return $in_range;
	}

}



$p = new Extension_CloudFlare_Plugin();
$p->run();

if ( is_admin() ) {
	$p = new Extension_CloudFlare_Plugin_Admin();
	$p->run();
}