Extension_Genesis_Plugin.php 10.8 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
<?php
namespace W3TC;

class Extension_Genesis_Plugin {
	/**
	 * Request URI
	 *
	 * @var string
	 */
	private $_request_uri = '';
	private $_config;

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

	function run() {
		add_filter( 'w3tc_config_default_values', array(
				$this, 'w3tc_config_default_values' ) );

		add_action( 'w3tc_register_fragment_groups', array( $this, 'register_groups' ) );

		$this->_config = Dispatcher::config();

		if ( Util_Environment::is_w3tc_pro( $this->_config ) ) {
			if ( !is_admin() ) {
				/**
				 * Register the caching of content to specific hooks
				 */
				foreach ( array( 'genesis_header', 'genesis_footer', 'genesis_sidebar', 'genesis_loop', 'wp_head', 'wp_footer', 'genesis_comments', 'genesis_pings' ) as $hook ) {
					add_action( $hook, array( $this, 'cache_genesis_start' ), -999999999 );
					add_action( $hook, array( $this, 'cache_genesis_end' ), 999999999 );
				}
				foreach ( array( 'genesis_do_subnav', 'genesis_do_nav' ) as $filter ) {
					add_filter( $filter, array( $this, 'cache_genesis_filter_start' ), -999999999 );
					add_filter( $filter, array( $this, 'cache_genesis_filter_end' ), 999999999 );
				}
			}

			/**
			 * Since posts pages etc are cached individually need to be able to flush just those and not all fragment
			 */
			add_action( 'clean_post_cache', array( $this, 'flush_post_fragment' ) );
			add_action( 'clean_post_cache', array( $this, 'flush_terms_fragment' ), 0, 0 );

			$this->_request_uri = $_SERVER['REQUEST_URI'];
		}
	}

	public function w3tc_config_default_values( $default_values ) {
		$default_values['genesis.theme'] = array(
			'wp_head' => '0',
			'genesis_header' => '1',
			'genesis_do_nav' => '0',
			'genesis_do_subnav' => '0',
			'loop_front_page' => '1',
			'loop_terms' => '1',
			'flush_terms' => '1',
			'loop_single' => '1',
			'loop_single_excluded' => '',
			'loop_single_genesis_comments' => '0',
			'loop_single_genesis_pings' => '0',
			'sidebar' => '0',
			'sidebar_excluded' => '',
			'genesis_footer' => '1',
			'wp_footer' => '0',
			'reject_logged_roles' => '1',
			'reject_logged_roles_on_actions' => array(
				'genesis_loop',
				'wp_head',
				'wp_footer',
			),
			'reject_roles' => array( 'administrator' )
		);

		return $default_values;
	}

	/**
	 * Start outputbuffering or return fragment on a per page/hook basis
	 */
	function cache_genesis_start() {
		$hook = current_filter();
		$keys = $this->_get_id_group( $hook );
		if ( is_null( $keys ) )
			return;
		list( $id, $group ) = $keys;
		w3tc_fragmentcache_start( $id, $group, $hook );
	}

	/**
	 * Store the output buffer per page/post hook basis.
	 */
	function cache_genesis_end() {
		$keys = $this->_get_id_group( current_filter() );
		if ( is_null( $keys ) )
			return;
		list( $id, $group ) = $keys;
		w3tc_fragmentcache_end( $id, $group, $this->_config->get_boolean( array( 'fragmentcache', 'debug' ) ) );
	}

	/**
	 * Start filter buffering and return filter result
	 */
	function cache_genesis_filter_start( $data ) {
		$hook = current_filter();
		$keys = $this->_get_id_group( $hook, strpos( $data, 'current' )!==false );
		if ( is_null( $keys ) )
			return $data;
		list( $id, $group ) = $keys;
		return w3tc_fragmentcache_filter_start( $id, $group, $hook, $data );
	}

	/**
	 * Store the filter result and return filter result.
	 */
	function cache_genesis_filter_end( $data ) {
		$keys = $this->_get_id_group( current_filter(), strpos( $data, 'current' )!==false );
		if ( is_null( $keys ) )
			return $data;
		list( $id, $group ) = $keys;
		return w3tc_fragmentcache_filter_end( $id, $group, $data );
	}

	/**
	 * Constructs the fragment grouping for a subgroup
	 *
	 * @param unknown $subgroup
	 * @param unknown $state
	 * @return string
	 */
	private function _genesis_group( $subgroup, $state = false ) {
		$postfix = '';
		if ( $state && is_user_logged_in() )
			$postfix = 'logged_in_';
		return ( $subgroup ? "genesis_fragment_{$subgroup}_" : 'genesis_fragment_' ) . $postfix;
	}

	/**
	 * Constructs the correct fragment group and id for the hook
	 *
	 * @param unknown $hook
	 * @param bool    $current_menu
	 * @return array|null
	 */
	private function _get_id_group( $hook, $current_menu = false ) {
		if ( $this->cannot_cache_current_hook() ) {
			return null;
		}
		switch ( true ) {
		case $keys = $this->generate_sidebar_keys():
			list( $group, $genesis_id ) = $keys;
			break;
		case $keys = $this->generate_genesis_loop_keys():
			list( $group, $genesis_id ) = $keys;
			break;
		case $keys = $this->generate_genesis_comments_pings_keys():
			list( $group, $genesis_id ) = $keys;
			break;
		case $keys = $this->generate_genesis_navigation_keys( $current_menu ):
			list( $group, $genesis_id ) = $keys;
			break;
		default:
			$group = $hook;
			$genesis_id = $this->get_page_slug();
			if ( is_paged() )
				$genesis_id .= $this->get_paged_page_key();
			break;
		}

		if ( $this->_cache_group( $group ) && !$this->_exclude_page( $group ) ) {
			return array( $genesis_id, $this->_genesis_group( $group, true ) );
		}

		return null;
	}

	/**
	 * Checks if the fragment group should be cached
	 *
	 * @param unknown $group
	 * @return array|bool|int|null|string
	 */
	private function _cache_group( $group ) {
		return $this->_config->get_string( array( 'genesis.theme', $group ) );
	}

	/**
	 * Checks if current page is excluded from caching
	 *
	 * @param unknown $group
	 * @return bool
	 */
	private function _exclude_page( $group ) {
		$reject_uri = $this->_config->get_array( array( 'genesis.theme', "{$group}_excluded" ) );

		if ( is_null( $reject_uri ) || !is_array( $reject_uri ) || empty( $reject_uri ) ) {
			return false;
		}

		$auto_reject_uri = array(
			'wp-login',
			'wp-register'
		);
		foreach ( $auto_reject_uri as $uri ) {
			if ( strstr( $this->_request_uri, $uri ) !== false ) {
				return true;
			}
		}

		$reject_uri = array_map( array( '\W3TC\Util_Environment', 'parse_path' ), $reject_uri );

		foreach ( $reject_uri as $expr ) {
			$expr = trim( $expr );
			if ( $expr != '' && preg_match( '~' . $expr . '~i', $this->_request_uri ) ) {
				return true;
			}
		}

		return false;
	}

	/**
	 * Register the various fragments groups to be used. no_action is used since fragments requires actions.
	 */
	function register_groups() {
		//blog specific group and an array of actions that will trigger a flush of the group
		$groups = array (
			$this->_genesis_group( '' ) => array(
				'clean_post_cache',
				'update_option_sidebars_widgets',
				'wp_update_nav_menu_item' ),
			$this->_genesis_group( 'sidebar' ) => array(
				'update_option_sidebars_widgets' ),
			$this->_genesis_group( 'loop_single' ) => array(
				'no_action' ),
			$this->_genesis_group( 'loop_front_page' ) => array(
				'clean_post_cache' ),
			$this->_genesis_group( 'loop_terms' ) => array(
				'no_action' )
		);
		foreach ( $groups as $group => $actions )
			w3tc_register_fragment_group( $group, $actions, 3600 );
	}

	/**
	 * Flush the fragments connected to a post id
	 *
	 * @param unknown $post_ID
	 */
	function flush_post_fragment( $post_ID ) {
		$page_slug = $this->get_page_slug( $post_ID );
		$urls = Util_PageUrls::get_post_urls( $post_ID );
		$hooks = array( 'genesis_loop', 'genesis_comments', 'genesis_pings' );
		foreach ( $hooks as $hook ) {
			$genesis_id = $page_slug;
			$genesis_id = "{$hook}_{$genesis_id}";

			w3tc_fragmentcache_flush_fragment( $genesis_id, $this->_genesis_group( 'loop_single_logged_in' ) );
			w3tc_fragmentcache_flush_fragment( $genesis_id, $this->_genesis_group( 'loop_single' ) );
			for ( $page = 0; $page<=sizeof( $urls ); $page++ ) {
				$genesis_id = $page_slug;
				$genesis_id .= $this->get_paged_page_key( $page );
				$genesis_id = "{$hook}_{$genesis_id}";

				w3tc_fragmentcache_flush_fragment( $genesis_id, $this->_genesis_group( 'loop_single_logged_in' ) );
				w3tc_fragmentcache_flush_fragment( $genesis_id, $this->_genesis_group( 'loop_single' ) );
			}
		}
	}

	public function flush_terms_fragment() {
		if ( $this->_config->get_boolean( array( 'genesis.theme', 'flush_terms' ) ) ) {
			w3tc_fragmentcache_flush_group( 'loop_terms' );
		}
	}

	/**
	 *
	 *
	 * @return bool
	 */
	private function cannot_cache_current_hook() {
		if ( is_user_logged_in() && $this->_config->get_boolean( array( 'genesis.theme', 'reject_logged_roles' ) ) ) {
			$roles = $this->_config->get_array( array( 'genesis.theme', 'reject_roles' ) );
			if ( $roles ) {
				$hooks = $this->_config->get_array( array( 'genesis.theme', 'reject_logged_roles_on_actions' ) );
				$hook = current_filter();
				foreach ( $roles as $role ) {
					if ( $hooks && current_user_can( $role ) && in_array( $hook, $hooks ) ) {
						return true;
					}
				}
			}
		}
		return false;
	}

	/**
	 *
	 *
	 * @return array
	 */
	private function generate_genesis_loop_keys() {
		if ( ( $hook = current_filter() ) != 'genesis_loop' )
			return null;

		if ( is_front_page() ) {
			$group = 'loop_front_page';
		} elseif ( is_single() ) {
			$group = 'loop_single';
		} else {
			$group = 'loop_terms';
		}
		$genesis_id = $this->get_page_slug();
		if ( is_paged() )
			$genesis_id .= $this->get_paged_page_key();
		$genesis_id = "{$hook}_{$genesis_id}";

		return array( $group, $genesis_id );
	}

	/**
	 *
	 *
	 * @return array
	 */
	private function generate_sidebar_keys() {
		if ( strpos( $hook = current_filter(), 'sidebar' ) !== true )
			return null;

		$genesis_id = $hook;
		$group = 'sidebar';
		return array( $group, $genesis_id );
	}

	/**
	 *
	 *
	 * @return array|null
	 */
	private function generate_genesis_comments_pings_keys() {
		if ( ( $hook = current_filter() ) != 'genesis_comments' )
			return null;
		$group = 'loop_single';

		$genesis_id = $this->get_page_slug();
		if ( is_paged() )
			$genesis_id .= $this->get_paged_page_key();
		$genesis_id = "{$hook}_{$genesis_id}";

		return array( $group, $genesis_id );
	}

	/**
	 *
	 *
	 * @param string  $current_menu
	 * @return array|null
	 */
	private function generate_genesis_navigation_keys( $current_menu ) {
		if ( !( strpos( ( $hook = current_filter() ), '_nav' ) && $current_menu ) )
			return null;

		$genesis_id = $this->get_page_slug();
		if ( is_paged() )
			$genesis_id .= $this->get_paged_page_key();
		return array( $hook, $genesis_id );
	}

	private function get_page_slug( $post_ID = null ) {
		if ( $post_ID ) {
			$purl = get_permalink( $post_ID );
			return str_replace( '/', '-', trim( str_replace( home_url(), '', $purl ), "/" ) );
		}
		if ( is_front_page() )
			return 'front_page';
		return str_replace( '/', '-', trim( $_SERVER['REQUEST_URI'], "/" ) );
	}

	/**
	 *
	 *
	 * @param int|null $page
	 * @return string _pagenumber_
	 */
	private function get_paged_page_key( $page=null ) {
		if ( is_null( $page ) ) {
			global $wp_query;
			return '_' . $wp_query->query_vars['paged'] . '_';
		}

		return '_' . $page . '_';
	}
}

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

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