<?php
/**
* @version $ Id; blocks-coupling.php 21-03-2012 03:22:10 Ahmed Said $
*/

// Disallow direct access.
defined('ABSPATH') or die("Access denied");

/**
* Applying Code blocks for the curren request.
*
* This controller is always loaded.
*
* The class resposibility is to output the code blocks
* tha associated with current request.
*
* @author Ahmed Said
* @version 6
*/
class CJTBlocksCouplingController extends CJTController {

	/**
	* put your comment there...
	*
	* @var mixed
	*/
	protected $blocks = array(
		'code' => array('header' => '', 'footer' => ''),
		'scripts' => array('header' => array(), 'footer' => array()),
	);

	/**
	* put your comment there...
	*
	* @var mixed
	*/
	protected $controllerInfo = array('model' => 'coupling');

	/**
	* put your comment there...
	*
	* @var mixed
	*/
	protected $filters = null;

	/**
	* put your comment there...
	*
	* @var mixed
	*/
	protected static $instance = null;

	/**
	* put your comment there...
	*
	* @var mixed
	*/
	private $onActionIds = array();

	/**
	* put your comment there...
	*
	* @var mixed
	*/
	protected $onassigncouplingcallback = array('parameters' => array('callback'));

	/**
	* put your comment there...
	*
	* @var mixed
	*/
	protected $onappendcode = array('parameters' => array('code'));

	/**
	* put your comment there...
	*
	* @var mixed
	*/
	protected $onblockmatched = array('parameters' => array('block'));

	/**
	* put your comment there...
	*
	* @var mixed
	*/
	protected $oncancelmatching  = array('parameters' => array('matched'));

	/**
	* put your comment there...
	*
	* @var mixed
	*/
	protected $ondefaultfilters = array('parameters' => array('filters'));

	/**
	* put your comment there...
	*
	* @var mixed
	*/
	protected $ondo = array('parameters' => array('data', 'method', 'condition'));

	/**
	* put your comment there...
	*
	* @var mixed
	*/
	protected $onblocksorder = array('parameters' => array('order'));

	/**
	* put your comment there...
	*
	* @var mixed
	*/
	protected $onevalcodeblock = array( 'parameters' => array( 'keep', 'block' ) );

	/**
	* put your comment there...
	*
	* @var mixed
	*/
	protected $ongetblocks = array('parameters' => array('blocks'));

	/**
	* put your comment there...
	*
	* @var mixed
	*/
	protected $ongetcache = array('parameters' => array('cache'));

	/**
	* put your comment there...
	*
	* @var mixed
	*/
	protected $ongetfilters = array('parameters' => array('filters'));

	/**
	* put your comment there...
	*
	* @var mixed
	*/
	protected $onlinkedtemplates = array('parameters' => array('templates'));

	/**
	* put your comment there...
	*
	* @var mixed
	*/
	protected $onlinkscripts = array('parameters' => array('templates'));

	/**
	* put your comment there...
	*
	* @var mixed
	*/
	protected $onlinkstyles = array('parameters' => array('templates'));

	/**
	* put your comment there...
	*
	* @var mixed
	*/
	protected $onlinktemplate = array('parameters' => array('template'));

	/**
	* put your comment there...
	*
	* @var mixed
	*/
	protected $onmatchingurls  = array('parameters' => array('urls'));

	/**
	* put your comment there...
	*
	* @var mixed
	*/
	protected $onnoblocks  = array('hookType' => CJTWordpressEvents::HOOK_ACTION);

	/**
	* put your comment there...
	*
	* @var mixed
	*/
	protected $onoutput = array('parameters' => array('code', 'location'));

	/**
	* put your comment there...
	*
	* @var mixed
	*/
	protected $onprocess  = array('hookType' => CJTWordpressEvents::HOOK_ACTION);

	/**
	* put your comment there...
	*
	* @var mixed
	*/
	protected $onprocessblock  = array('parameters' => array('block'));

	/**
	* put your comment there...
	*
	* @var mixed
	*/
	protected $onqueuecss = array('parameters' => array('style'));

	/**
	* put your comment there...
	*
	* @var mixed
	*/
	protected $onqueuejavascript = array('parameters' => array('script'));

	/**
	* put your comment there...
	*
	* @var mixed
	*/
	protected $onsetfilters = array('parameters' => array('filters'));

	/**
	* put your comment there...
	*
	* @var mixed
	*/
	protected $templates = array();

	/**
	* Initialize controller object.
	*
	* @see CJTController for more details
	* @return void
	*/
	public function __construct() {
		// Only one instance is allowed.
		if (self::$instance) {
			throw new Exception('Trying to instantiate multiple coupling instances!!');
		}
		// Hold the single instance we've!
		self::$instance = $this;
		$siteHook = cssJSToolbox::$config->core->siteHook;
		// Initialize controller.
		parent::__construct(false);
		// Import related libraries
		CJTModel::import('block');
		// Not default action needed.
		$this->defaultAction = null;
		// Initialize controller.
		$initCouplingCallback = $this->onassigncouplingcallback(array(&$this, 'initCoupling'));
		add_action('admin_init', $initCouplingCallback);
		add_action($siteHook->tag, $initCouplingCallback, $siteHook->priority);
		// Add Shortcode callbacks.
		add_shortcode('cjtoolbox', array(&$this, 'shortcode'));
	}

	/**
	* put your comment there...
	*
	* @param mixed $id
	*/
	public function addOnActionIds($id) {
		// Add ID is not exists.
		if (!in_array($id, $this->onActionIds)) {
			$this->onActionIds[] = $id;
		}
		// Chaining.
		return $this;
	}

	/**
	* put your comment there...
	*
	*/
	public function getBlocks()
	{
		// Set request view filters used for querying database.
		$this->setRequestFilters();

		// Get blocks order. NOTE: This is all blocks order not only the queried/target blocks.
		$blocksOrder = array();
		$metaBoxesOrder = $this->onblocksorder( $this->model->getOrder() );

		// Get ORDER-INDEX <TO> BLOCK-ID mapping.
		preg_match_all( '/cjtoolbox-(\d+)/', $metaBoxesOrder[ 'normal' ], $blocksOrder, PREG_SET_ORDER );

		/**
		* append more to orders produced by CJTBlocksCouplingController::setRequestFilter().
		* More to orders may allow other blocks to bein the output (e.g metaboxe blocks).
		*/
		$blocksOrder = array_merge( $blocksOrder, $this->getFilters()->moreToOrder );

		// Prepare request URL to match against Links & Expressions.
		$linksRequestURL = self::getRequestURL();
		$expressionsRequestURL = "{$linksRequestURL}?{$_SERVER['QUERY_STRING']}";

		extract( $this->onmatchingurls( compact( 'linksRequestURL', 'expressionsRequestURL' ) ) );

		// Get all blocks including (Links & Expressions Blocks).
		$blocks = $this->ongetblocks(

			$this->model->getPinsBlocks(

				CJTBlockModel::PINS_LINK_EXPRESSION,

				$this->getFilters()->pinPoint,

				$this->getFilters()->customPins,

				$this->getFilters()

				)

			);


		if ( empty( $blocks ) )
		{
			$this->onnoblocks();

		  return false;

		}

		// Import related libraries.
		cssJSToolbox::import( 'framework:php:evaluator:evaluator.inc.php' );

		/**
		* Iterator over all blocks by using they order.
		* For each block get code and scripts.
		*/
		$this->onprocess();

		foreach ( $blocksOrder as $blockOrder )
		{
			$blockId = (int) $blockOrder[1];

			// As mentioned above. Orders is for all blocks not just those queried from db.
			if ( isset($blocks[ $blockId ] ) )
			{

				$block = $this->onprocessblock( $blocks[ $blockId ] );

				/**
				* Process Links & Expressions blocks.
				* For better performace check only those with links and expressions flags.
				*/
				if ( $block->blocksGroup & CJTBlockModel::PINS_LINK_EXPRESSION )
				{
					/**
					* Initiliaze $matchedLink and $matchedExpression inside IF statment.
					* Those variables need to refresh state at each block.
					* If there is no link or expression flags, they will be FALSE.
					* Otherwise they'll get the correct value inside each statement.
					*/
					/// Check if there is a matched link.
					if ( $matchedLink = ( $block->blocksGroup & CJTBlockModel::PINS_LINKS ) )
					{
						$links = explode( "\n", trim( $block->links ) );
						$matchedLink = in_array( $linksRequestURL, $links );
					}

					/// Check if there is a matched expression.
					if ( $matchedExpression = ( $block->blocksGroup & CJTBlockModel::PINS_EXPRESSIONS ) )
					{
						$expressions = explode("\n", $block->expressions);

						foreach ( $expressions as $expression )
						{
							/// @TODO: Matches may be used later to evaulate variables inside code block.
							if( $matchedExpression = @ preg_match( "/{$expression}/", $expressionsRequestURL ) )
							{
							  break;
							}

						}

					}

					/**
					* Exclude Links & Expressions Blocks that doesn't has a match.
					* If there is no matched link or expression then exclude block.
					*/
					if ( $this->oncancelmatching( ! ( $matchedExpression || $matchedLink ) ) )
					{
						continue;
					}

				}
				// Allow extensions to control to prevent block from being in the output
				if ( $block = $this->onblockmatched( $block ) )
				{
					// Retrieve block code-files.
					$block->code = $this->model->getBlockCode( $block->id );

					// Import Executable (PHP and HTML) templates.
					$block->code = $block->code . $this->model->getExecTemplatesCode( $block->id );

					// For every location store blocks code into single string

					if ( ! $evaluatedCode = $this->onevalcodeblock( false, $block ) )
					{
						$evaluatedCode = CJTPHPCodeEvaluator::getInstance( $block )->exec()->getOutput();
					}

					/** @todo Include Debuging info only if we're in debuging mode! */
					if ( 1 ) {
						// CODE UPDATED BY RBJ -- START
                        if (trim($evaluatedCode) != ''):
                            global $post;
                            $checkMetaBlock = get_post_meta($post->ID, '__CJT-BLOCK-ID', true);

                            if (!empty($checkMetaBlock) && $checkMetaBlock == $blockId):
                                $evaluatedCode = "\n\n<!-- CJT Meta Block ({$blockId}) - {$block->name} - START -->\n{$evaluatedCode}\n<!-- CJT Meta Block ({$blockId}) - {$block->name} - END -->\n\n";
                            else:
                                $evaluatedCode = "\n\n<!-- CJT Global Block ({$blockId}) - {$block->name} - START -->\n{$evaluatedCode}\n<!-- CJT Global Block ({$blockId}) - {$block->name} - END -->\n\n";
                            endif;
                        endif;
                        // CODE UPDATED BY RBJ -- END
					}

					$this->blocks[ 'code' ][ $block->location ] .= $this->onappendcode( $evaluatedCode );

					// Store all used Ids in the CORRECT ORDER.
					$this->addOnActionIds( $blockId );
				}

			}

		}

		$templates = 	$this->onActionIds ?
									$this->model->getLinkedTemplates( $this->onActionIds ) :
									array();

		// Classisfy as we process Scripts and Styles separatly (different hooks!).
		foreach ( $this->onlinkedtemplates( $templates ) as $id => $template )
		{
			// Filer template!
			extract( $this->onlinktemplate( compact( 'template', 'id' ) ) );

			$this->templates[ $template->type ][ $id ] = $template;
		}


		return true;
	}

	/**
	* put your comment there...
	*
	*/
	public function getCached() {
		// Cache is not implemented yet might be supported by extenal Extensions!
		return $this->ongetcache(false);
	}

	/**
	* put your comment there...
	*
	*/
	public function getFilters() {
		return $this->ongetfilters($this->filters);
	}

	/**
	* put your comment there...
	*
	*/
	public function getOnActionIds() {
		return $this->onActionIds;
	}

	/**
	* put your comment there...
	*
	*/
	public static function getRequestURL() {
		// URL Protocol.
		$protocol = 'http' . ((isset($_SERVER["HTTPS"]) && ($_SERVER["HTTPS"] == "on")) ? 's' : '') . '://';
		// Host name & port.
		$host = $_SERVER['HTTP_HOST'];
		$port = ($_SERVER["SERVER_PORT"] != "80") ? ":{$_SERVER["SERVER_PORT"]}" : '';
		// Request URI.
		$requestURI = $_SERVER['REQUEST_URI'];
		// Final URL.
		$url = "{$protocol}{$host}{$port}{$requestURI}";
		return $url;
	}

	/**
	* put your comment there...
	*
	*/
	public function hasOnActionIds() {
		return !empty($this->onActionIds);
	}

	/**
	* put your comment there...
	*
	*/
	public function initCoupling() {
		// For some reasons wp action is fired twice.
		// The wrong call won't has $wp_query object set,
		// but this is only valid at Front end.
		if (!is_admin() && !$GLOBALS['wp_query']) {
		  return;
		}
		// Get current application hook prefix.
		$actionsPrefix = is_admin() ? 'admin'	: 'wp';
		// Get cache or get blocks if not cached.
		// If there is no cache or no blocks for output
		// do nothing.
		if ($this->getCached() || $this->getBlocks()) {
			// Output blocks on various locations!
			add_action("{$actionsPrefix}_head", array(&$this, 'outputBlocks'), 30);
		  add_action("{$actionsPrefix}_footer", array(&$this, 'outputBlocks'), 30);
		  // Links templates & styloes!
		  add_action("{$actionsPrefix}_enqueue_scripts", array(&$this, 'linkTemplates'), 30);
		  add_action("{$actionsPrefix}_print_styles", array(&$this, 'linkTemplates'), 30);
		}
		// Link style sheet in footer required custom implementation.
		add_action("{$actionsPrefix}_print_footer_scripts", array(&$this, 'linkFooterStyleSheets'), 9);
		// Make sure this is executed only once.
		// Sometimes wp hook run on backend and sometimes its not.
		// This method handle both front and backend requests.
		// Simply remove all hooks to ensure its run only one time.
		remove_action('wp', array(&$this, 'initCoupling'));
		remove_action('admin_init', array(&$this, 'initCoupling'));
	}

	/**
	* put your comment there...
	*
	*/
	public function linkFooterStyleSheets() {
		// Initialize.
		$styles = array();
		// Get queued style sheets!
		global $wp_styles;
		$queuedStyles =& $wp_styles->queue;
		// Process only 'cjt' templates,
		foreach ($queuedStyles as $index => $styleName) {
			if (strpos($styleName, 'cjt-css-template-') === 0) {
				// Get style name src file, prepend to Wordpress absolute path.
				$style = $wp_styles->registered[$styleName];
				$styles[] = home_url($style->src);
				// Stop Wordpress from output <link> tag outside head tag
				// as it has no effect.
				unset($queuedStyles[$index]);
			}
		}
		// Enqueue Style Sheet loader javascript if there is any
		// styles need to be loaded.
		if (!empty($styles)) {
			// jQuery is dpendency object required by the loader.
			wp_enqueue_script('jquery');
			// Enqueue footer style sheet loader.
			wp_enqueue_script('cjt-coupling-footer-css-loader', cssJSToolbox::getURI('controllers:coupling:js:footer-stylesheet-loader.js'));
			// Output JavaScript array to be filled with the styles!
			$jsStyleSheetsList = json_encode($styles);
			require cssJSToolbox::resolvePath('controllers:coupling:html:load-footer-style.html.php');
		}
	}

	/**
	* put your comment there...
	*
	*/
	public function linkTemplates() {
		$currentFilter = current_filter();
		// Derived template Type from Wordpress filter.
		$filterFor = explode('_', $currentFilter); $filterFor = array_pop($filterFor);
		$type = CJTCouplingModel::$templateTypes[$filterFor];
		// Following vars are referenced based on the current type.
		$templates = isset($this->templates[$type]) ? $this->templates[$type] : array();
		// Filering!
		$templates = $this->{"onlink{$filterFor}"}($templates);
		/**
		* @var WP_Dependencies
		*/
		$queue = $this->model->getQueueObject($filterFor);
		// Add templates to the queye.
		foreach ($templates as $template) {
		 // Registery only if not yet registered.
		 $template = $this->{"onqueue{$type}"}($template);
		 if (!isset($queue->registered[$template->queueName])) {
			 $queue->add($template->queueName, "/{$template->file}", null, $template->version);
		 }
		 // Always make sure the template is queued.
		 $queue->enqueue($template->queueName);
		}
	}

	/**
	* put your comment there...
	*
	*/
	public function outputBlocks() {
		// Derived location name from wordpress filter name.
		$currentFilter = current_filter();
		// Map "wp hook location" to "block hook location".
		$locationsMap = array('head' => 'header', 'footer' => 'footer');
		// This hook is used across both ends, front and back ends.
		// Remove application prefix (wp_ or admin_).
		// Remining is head or footer.
		$location = str_replace(array('wp_', 'admin_'), '', $currentFilter);
		// Map to block location.
		$location = $locationsMap[$location];
		echo $this->onoutput($this->blocks['code'][$location], $location);
	}

	/**
	* put your comment there...
	*
	*/
	protected function setRequestFilters()
	{
		// Get request blocks.
		$filters = $this->ondefaultfilters( ( object ) array
		(

			'pinPoint' => 0x00000000,

			'customPins' => array(),

			'moreToOrder' => array(),

			'currentObject' => null,

			'currentCustomPin' => 0,

			'params' => array(),

		) );

		if ( is_admin() )
		{
			// Include all backend blocks.
		  $filters->pinPoint |= CJTBlockModel::PINS_BACKEND;
		}
		else
		{
			$filters->pinPoint |= CJTBlockModel::PINS_FRONTEND;

			// Pages.
			if ( is_page() )
			{
				// Blocks with ALL PAGES selected.
				$filters->pinPoint |= CJTBlockModel::PINS_PAGES_ALL_PAGES;

				$filters->currentObject = $GLOBALS[ 'post' ];
				$filters->currentCustomPin = CJTBlockModel::PINS_PAGES_CUSTOM_PAGE;

				// Blocks with PAGE-ID selected.
				$filters->customPins[ ] = array
				(
					'pin' => 'pages',

					'pins' => array( $filters->currentObject->ID ),

					'flag' => CJTBlockModel::PINS_PAGES_CUSTOM_PAGE,

				);

				// Blocks with FRONT-PAGE selected.
				if ( is_front_page() )
				{
					$filters->pinPoint |= CJTBlockModel::PINS_PAGES_FRONT_PAGE;
				}

				/**
				* In order for metabox block to get in the output we need
				* to add metabox order for it.
				* @see CJTBlocksCouplingController::getBlocks.
				*/
				$metabox = CJTModel::create( 'metabox', array( $filters->currentObject->ID ) );

				$filters->moreToOrder[ ][ 1 ] = $metabox->getMetaboxId();

			} // End is_page()

			else if ( is_attachment() )
			{
				$filters->pinPoint |= CJTBlockModel::PINS_ATTACHMENT;
			}
			// Posts.
			else if ( is_single() )
			{
				// Blocks with ALL POSTS & ALL CATEGORIES selected.
				$filters->pinPoint |= CJTBlockModel::PINS_POSTS_ALL_POSTS | CJTBlockModel::PINS_CATEGORIES_ALL_CATEGORIES;

				$filters->currentObject = $GLOBALS[ 'post' ];
				$filters->currentCustomPin = CJTBlockModel::PINS_POSTS_CUSTOM_POST;

				// Blocks with POST-ID selected.

				$filters->customPins[ ] = array
				(

					'pin' => 'posts',

					'pins' => array( $filters->currentObject->ID ),

					'flag' => CJTBlockModel::PINS_POSTS_CUSTOM_POST,

				);

				// Include POST PARENT CATRGORIES blocks.
				$parentCategoriesIds = wp_get_post_categories( $filters->currentObject->ID, array( 'fields' => 'ids' ) );

				/**
				* Custom-Posts just added "ON THE RUN/FLY"
				* Need simple fix by confirming that the post is belong to
				* specific category or not.
				* Custom posts NOW unlike Posts, it doesn't inherit parent
				* taxonomis Code Blocks!!
				*/
				if ( ! empty( $parentCategoriesIds ) )
				{

					$filters->params[ 'hasCategories' ] = true;
					$filters->params[ 'parentCategories' ] = $parentCategoriesIds;

					$filters->customPins[ ] = array
					(

						'pin' => 'categories',

						'pins' => $parentCategoriesIds,

						'flag' => CJTBlockModel::PINS_CATEGORIES_CUSTOM_CATEGORY,

					);

				}

				/**
				* In order for metabox block to get in the output we need
				* to add metabox order for it.
				* @see CJTBlocksCouplingController::getBlocks.
				*/
				$metabox = CJTModel::create( 'metabox', array( $filters->currentObject->ID ) );

				$filters->moreToOrder[][ 1 ] = $metabox->getMetaboxId();

				/**
				* @TODO check for recent posts Based on user configuration.
				* Recent posts should be detcted by comparing
				* user condifguration with post date.
				*/
				if ( 0 ) {

				}
			} // End is_single()

			// Categories.
			else if( is_category() )
			{
				// Blocks with ALL CATEGORIES selected.
				$filters->pinPoint |= CJTBlockModel::PINS_CATEGORIES_ALL_CATEGORIES;

				$filters->currentObject = get_queried_object();
				$filters->currentCustomPin = CJTBlockModel::PINS_CATEGORIES_CUSTOM_CATEGORY;

				// Blocks with CATEGORY-ID selected.
				$filters->customPins[] = array
				(
					'pin' => 'categories',

					'pins' => array( $filters->currentObject->term_id ),

					'flag' => CJTBlockModel::PINS_CATEGORIES_CUSTOM_CATEGORY,

				);

			} // End is_category()

			// Blocks with BLOG-INDEX selected.
			else if ( is_home() )
			{
				$filters->pinPoint |= CJTBlockModel::PINS_POSTS_BLOG_INDEX;
			}
			else if ( is_search() )
			{
				$filters->pinPoint |= CJTBlockModel::PINS_SEARCH;
			}
			else if ( is_tag() )
			{
				$filters->pinPoint |= CJTBlockModel::PINS_TAG;
			}
			else if ( is_author() )
			{
				$filters->pinPoint |= CJTBlockModel::PINS_AUTHOR;
			}
			else if ( is_archive() )
			{
				$filters->pinPoint |= CJTBlockModel::PINS_ARCHIVE;
			}
			else if ( is_404() )
			{
				$filters->pinPoint |= CJTBlockModel::PINS_404_ERROR;
			}

		}

		$this->filters = $this->onsetfilters( $filters );

	}

	/**
	* Wordpress do shortcode callback for
	* CJT Shortcodes ([cjtoolbox ....])!
	*
	* This method role is to load the shortcode routines
	* in order to handle the request.
	*
	* It doesn't do anything except deferring the shortcode
	* codes from loaded until shortcode is really used!
	*
	* @param mixed $attributes
	*/
	public function shortcode($attributes, $content) {
		// Instantiate Shortcode handler class.
		cssJSToolbox::import('controllers:coupling:shortcode:shortcode.php');
		$shortcode = new CJT_Controllers_Coupling_Shortcode($attributes, $content);
		// Return Shortcode replacement!
		return ((string) $shortcode);
	}

	/**
	* put your comment there...
	*
	*/
	public static function & theInstance() {
		return self::$instance;
	}

} // End class.

// Hookable!
CJTBlocksCouplingController::define('CJTBlocksCouplingController', array('hookType' => CJTWordpressEvents::HOOK_FILTER));