Varnish_Flush.php 12.2 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 427 428 429 430 431 432
<?php
namespace W3TC;

/**
 * Class Varnish_Flush
 */
class Varnish_Flush {
	/**
	 * Debug flag
	 *
	 * @var bool
	 */
	var $_debug = false;

	/**
	 * Varnish servers
	 *
	 * @var array
	 */
	var $_servers = array();

	/**
	 * Operation timeout
	 *
	 * @var int
	 */
	var $_timeout = 30;

	/**
	 * Advanced cache config
	 */
	var $_config = null;

	/**
	 * Array of already flushed urls
	 *
	 * @var array
	 */
	private $queued_urls = array();
	private $flush_operation_requested = false;

	/**
	 * PHP5-style constructor
	 */
	function __construct() {
		$this->_config = Dispatcher::config();

		$this->_debug = $this->_config->get_boolean( 'varnish.debug' );
		$this->_servers = $this->_config->get_array( 'varnish.servers' );
		$this->_timeout = $this->_config->get_integer( 'timelimit.varnish_purge' );
	}

	/**
	 * Purge URI
	 *
	 * @param string  $url
	 * @return boolean
	 */
	protected function _purge( $url ) {
		@set_time_limit( $this->_timeout );
		$return = true;

		foreach ( (array) $this->_servers as $server ) {
			$response = $this->_request( $server, $url );

			if ( is_wp_error( $response ) ) {
				$this->_log( $url, sprintf( 'Unable to send request: %s.', implode( '; ', $response->get_error_messages() ) ) );
				$return = false;
			} elseif ( $response['response']['code'] !== 200 ) {
				$this->_log( $url, 'Bad response: ' . $response['response']['status'] );
				$return = false;
			} else {
				$this->_log( $url, 'PURGE OK' );
			}
		}

		return $return;
	}

	/*
     * Sends purge request. Cannt use default wp HTTP implementation
     * if we send request to different host than specified in $url
     *
     * @param $url string
     */
	function _request( $varnish_server, $url ) {
		$parse_url = @parse_url( $url );

		if ( !$parse_url || !isset( $parse_url['host'] ) )
			return new \WP_Error( 'http_request_failed', 'Unrecognized URL format ' . $url );

		$host = $parse_url['host'];
		$port = ( isset( $parse_url['port'] ) ? (int) $parse_url['port'] : 80 );
		$path = ( !empty( $parse_url['path'] ) ? $parse_url['path'] : '/' );
		$query = ( isset( $parse_url['query'] ) ? $parse_url['query'] : '' );
		$request_uri = $path . ( $query != '' ? '?' . $query : '' );

		if ( strpos( $varnish_server, ':' ) )
			list( $varnish_host, $varnish_port ) = explode( ':', $varnish_server );
		else {
			$varnish_host = $varnish_server;
			$varnish_port = 80;
		}

		// if url host is the same as varnish server - we can use regular
		// wordpress http infrastructure, otherwise custom request should be
		// sent using fsockopen, since we send request to other server than
		// specified by $url
		if ( $host == $varnish_host && $port == $varnish_port )
			return Util_Http::request( $url, array( 'method' => 'PURGE' ) );

		$request_headers_array = array(
			sprintf( 'PURGE %s HTTP/1.1', $request_uri ),
			sprintf( 'Host: %s', $host ),
			sprintf( 'User-Agent: %s', W3TC_POWERED_BY ),
			'Connection: close'
		);

		$request_headers = implode( "\r\n", $request_headers_array );
		$request = $request_headers . "\r\n\r\n";

		// log what we are about to do
		$this->_log( $url, sprintf( 'Connecting to %s ...', $varnish_host ) );
		$this->_log( $url, sprintf( 'PURGE %s HTTP/1.1', $request_uri ) );
		$this->_log( $url, sprintf( 'Host: %s', $host ) );

		$errno = null;
		$errstr = null;
		$fp = @fsockopen( $varnish_host, $varnish_port, $errno, $errstr, 10 );
		if ( !$fp )
			return new \WP_Error( 'http_request_failed', $errno . ': ' . $errstr );

		@stream_set_timeout( $fp, 60 );

		@fputs( $fp, $request );

		$response = '';
		while ( !@feof( $fp ) )
			$response .= @fgets( $fp, 4096 );

		@fclose( $fp );

		list( $response_headers, $contents ) = explode( "\r\n\r\n", $response, 2 );
		$matches = null;
		if ( preg_match( '~^HTTP/1.[01] (\d+)~', $response_headers, $matches ) ) {
			$code = (int)$matches[1];
			$a = explode( "\n", $response_headers );
			$status = ( count( $a ) >= 1 ? $a[0] : '' );
			$return = array(
				'response' => array(
					'code' => $code,
					'status' => $status
				)
			);
			return $return;
		}

		return new \WP_Error( 'http_request_failed',
			'Unrecognized response header' . $response_headers );
	}

	/**
	 * Write log entry
	 *
	 * @param string  $url
	 * @param string  $msg
	 * @return bool|int
	 */
	function _log( $url, $msg ) {
		if ( $this->_debug ) {
			$data = sprintf( "[%s] [%s] %s\n", date( 'r' ), $url, $msg );
			$data = strtr( $data, '<>', '' );

			$filename = Util_Debug::log_filename( 'varnish' );

			return @file_put_contents( $filename, $data, FILE_APPEND );
		}

		return true;
	}



	/**
	 * Flush varnish cache
	 */
	function flush() {
		$this->flush_operation_requested = true;
		return true;
	}

	private function do_flush() {
		if ( !is_network_admin() ) {
			$queued_urls[ get_home_url() . '/.*' ] = '*';

			// add mirror urls
			$queued_urls = Util_PageUrls::complement_with_mirror_urls(
				$queued_urls );

			foreach ( $queued_urls as $url => $nothing )
				$this->_purge( $url );
		} else {
			// todo: remove. doesnt work for all caches.
			// replace with tool to flush network
			global $wpdb;
			$protocall = Util_Environment::is_https() ? 'https://' : 'http://';

			// If WPMU Domain Mapping plugin is installed and active
			if ( defined( 'SUNRISE_LOADED' ) && SUNRISE_LOADED && isset( $wpdb->dmtable ) && !empty( $wpdb->dmtable ) ) {
				$blogs = $wpdb->get_results( "SELECT {$wpdb->blogs}.domain, {$wpdb->blogs}.path, {$wpdb->dmtable}.domain AS mapped_domain
                                    FROM {$wpdb->dmtable}
                                    RIGHT JOIN {$wpdb->blogs} ON {$wpdb->dmtable}.blog_id = {$wpdb->blogs}.blog_id
                                    WHERE site_id = {$wpdb->siteid}
                                    AND spam = 0
                                    AND deleted = 0
                                    AND archived = '0'
                                   " );
				foreach ( $blogs as $blog ) {
					if ( !isset( $blog->mapped_domain ) )
						$url = $protocall . $blog->domain . ( strlen( $blog->path )>1? '/' . trim( $blog->path, '/' ) : '' ) . '/.*';
					else
						$url = $protocall . $blog->mapped_domain . '/.*';
					$this->_purge( $url );
				}

			}else {
				if ( !Util_Environment::is_wpmu_subdomain() ) {
					$this->_purge( get_home_url().'/.*' );
				} else {
					$blogs = $wpdb->get_results( "
                                        SELECT domain, path
                                        FROM {$wpdb->blogs}
                                        WHERE site_id = '{$wpdb->siteid}'
                                        AND spam = 0
                                        AND deleted = 0
                                        AND archived = '0'
                                    " );

					foreach ( $blogs as $blog ) {
						$url = $protocall . $blog->domain . ( strlen( $blog->path )>1? '/' . trim( $blog->path, '/' ) : '' ) . '/.*';
						$this->_purge( $url );
					}
				}
			}
		}
	}

	/**
	 * Flushes varnish post cache
	 *
	 * @param integer $post_id
	 * @return boolean
	 */
	function flush_post( $post_id ) {
		if ( !$post_id ) {
			$post_id = Util_Environment::detect_post_id();
		}

		if ( $post_id ) {
			$full_urls = array();

			$post = null;
			$terms = array();

			$feeds = $this->_config->get_array( 'pgcache.purge.feed.types' );
			$limit_post_pages = $this->_config->get_integer( 'pgcache.purge.postpages_limit' );

			if ( $this->_config->get_boolean( 'pgcache.purge.terms' ) || $this->_config->get_boolean( 'varnish.pgcache.feed.terms' ) ) {
				$taxonomies = get_post_taxonomies( $post_id );
				$terms = wp_get_post_terms( $post_id, $taxonomies );
			}

			switch ( true ) {
			case $this->_config->get_boolean( 'pgcache.purge.author' ):
			case $this->_config->get_boolean( 'pgcache.purge.archive.daily' ):
			case $this->_config->get_boolean( 'pgcache.purge.archive.monthly' ):
			case $this->_config->get_boolean( 'pgcache.purge.archive.yearly' ):
			case $this->_config->get_boolean( 'pgcache.purge.feed.author' ):
				$post = get_post( $post_id );
			}

			$front_page = get_option( 'show_on_front' );

			/**
			 * Home (Frontpage) URL
			 */
			if ( ( $this->_config->get_boolean( 'pgcache.purge.home' ) && $front_page == 'posts' )||
				$this->_config->get_boolean( 'pgcache.purge.front_page' ) ) {
				$full_urls = array_merge( $full_urls,
					Util_PageUrls::get_frontpage_urls( $limit_post_pages ) );
			}

			/**
			 * Home (Post page) URL
			 */
			if ( $this->_config->get_boolean( 'pgcache.purge.home' ) && $front_page != 'posts' ) {
				$full_urls = array_merge( $full_urls,
					Util_PageUrls::get_postpage_urls( $limit_post_pages ) );
			}

			/**
			 * Post URL
			 */
			if ( $this->_config->get_boolean( 'pgcache.purge.post' ) ) {
				$full_urls = array_merge( $full_urls, Util_PageUrls::get_post_urls( $post_id ) );
			}

			/**
			 * Post comments URLs
			 */
			if ( $this->_config->get_boolean( 'pgcache.purge.comments' ) && function_exists( 'get_comments_pagenum_link' ) ) {
				$full_urls = array_merge( $full_urls, Util_PageUrls::get_post_comments_urls( $post_id ) );
			}

			/**
			 * Post author URLs
			 */
			if ( $this->_config->get_boolean( 'pgcache.purge.author' ) && $post ) {
				$full_urls = array_merge( $full_urls, Util_PageUrls::get_post_author_urls( $post->post_author, $limit_post_pages ) );
			}

			/**
			 * Post terms URLs
			 */
			if ( $this->_config->get_boolean( 'pgcache.purge.terms' ) ) {
				$full_urls = array_merge( $full_urls, Util_PageUrls::get_post_terms_urls( $terms, $limit_post_pages ) );
			}

			/**
			 * Daily archive URLs
			 */
			if ( $this->_config->get_boolean( 'pgcache.purge.archive.daily' ) && $post ) {
				$full_urls = array_merge( $full_urls, Util_PageUrls::get_daily_archive_urls( $post, $limit_post_pages ) );
			}

			/**
			 * Monthly archive URLs
			 */
			if ( $this->_config->get_boolean( 'pgcache.purge.archive.monthly' ) && $post ) {
				$full_urls = array_merge( $full_urls, Util_PageUrls::get_monthly_archive_urls( $post, $limit_post_pages ) );
			}

			/**
			 * Yearly archive URLs
			 */
			if ( $this->_config->get_boolean( 'pgcache.purge.archive.yearly' ) && $post ) {
				$full_urls = array_merge( $full_urls, Util_PageUrls::get_yearly_archive_urls( $post, $limit_post_pages ) );
			}

			/**
			 * Feed URLs
			 */
			if ( $this->_config->get_boolean( 'pgcache.purge.feed.blog' ) ) {
				$full_urls = array_merge( $full_urls,
					Util_PageUrls::get_feed_urls( $feeds ) );
			}

			if ( $this->_config->get_boolean( 'pgcache.purge.feed.comments' ) ) {
				$full_urls = array_merge( $full_urls, Util_PageUrls::get_feed_comments_urls( $post_id, $feeds ) );
			}

			if ( $this->_config->get_boolean( 'pgcache.purge.feed.author' ) && $post ) {
				$full_urls = array_merge( $full_urls, Util_PageUrls::get_feed_author_urls( $post->post_author, $feeds ) );
			}

			if ( $this->_config->get_boolean( 'pgcache.purge.feed.terms' ) ) {
				$full_urls = array_merge( $full_urls, Util_PageUrls::get_feed_terms_urls( $terms, $feeds ) );
			}

			/**
			 * Purge selected pages
			 */
			if ( $this->_config->get_array( 'pgcache.purge.pages' ) ) {
				$pages = $this->_config->get_array( 'pgcache.purge.pages' );
				$full_urls = array_merge( $full_urls, Util_PageUrls::get_pages_urls( $pages ) );
			}

			if ( $this->_config->get_string( 'pgcache.purge.sitemap_regex' ) ) {
				$sitemap_regex = $this->_config->get_string( 'pgcache.purge.sitemap_regex' );
				$full_urls[] = Util_Environment::home_domain_root_url() . '/' . trim( $sitemap_regex, "^$" );
			}

			/**
			 * Queue flush
			 */
			if ( count( $full_urls ) ) {
				foreach ( $full_urls as $url )
					$this->queued_urls[$url] = '*';

				// add mirror urls
				$this->queued_urls = Util_PageUrls::complement_with_mirror_urls(
					$this->queued_urls );
			}

			return true;
		}

		return false;
	}

	/**
	 * Flush a single url
	 *
	 * @param unknown $url
	 */
	function flush_url( $url ) {
		$this->_purge( $url );
	}

	/**
	 * Flushes global and repeated urls
	 */
	function flush_post_cleanup() {
		if ( $this->flush_operation_requested ) {
			$this->do_flush();
			$count = 999;

			$this->flush_operation_requested = false;
			$this->queued_urls = array();
		} else {
			$count = count( $this->queued_urls );
			if ( $count > 0 ) {
				foreach ( $this->queued_urls as $url => $nothing )
					$this->flush_url( $url );

				$this->queued_urls = array();
			}
		}

		return $count;
	}
}