/public/shop/core/engine/layout.php

<?php
/*------------------------------------------------------------------------------
  $Id$

  Shopping Cart
  http://dev.club4causes.com/shop

  Copyright © 2011, 2012 Club4Causes

  This source file is subject to Open Software License (OSL 3.0)
  License details is bundled with this package in the file LICENSE.txt.
  It is also available at this URL:
  <http://www.opensource.org/licenses/OSL-3.0>
  
 UPGRADE NOTE: 
   Do not edit or add to this file if you wish to upgrade Shopping Cart to newer
   versions in the future. If you wish to customize Shopping Cart for your
   needs please refer to http://dev.club4causes.com/shop for more information.  
------------------------------------------------------------------------------*/
if (! defined ( 'DIR_CORE' )) {
	header ( 'Location: static_pages/' );
}
class ALayout {
	protected $registry;
	private $page = array();
	private $layout = array();
	public $blocks = array();
	private $tmpl_id;
	private $layout_id;
	public $page_id;
	

	public function __construct($registry, $template_id) {
		$this->registry = $registry;
		$this->tmpl_id = $template_id;
		$this->page_id = '';
	}	

	public function __get($key) {
		return $this->registry->get($key);
	}
	
	public function __set($key, $value) {
		$this->registry->set($key, $value);
	}

	public function buildPageData($controller) {
		// Locate and set page information. This needs to be called once per page 
		$unique_page = array();
		$layouts = array();
		// find page records for given controller
		$key_param = $this->getKeyParamByController($controller);
		$key_value = $key_param ? $this->request->get[$key_param] : null;
		// for nested categories
		if($key_param=='path' && $key_value && is_int(strpos($key_value,'_'))){
			$key_value = (int)substr($key_value,strrpos($key_value,'_')+1);
		}

		$key_param = is_null($key_value) ? null : $key_param;

		$pages = $this->getPages($controller, $key_param,$key_value);
        if ( empty($pages) ) {
            //if no specific page found try to get page for group    
            $new_path = preg_replace('/\/\w*$/', '', $controller);        
            $pages = $this->getPages($new_path);
        }

        if ( empty($pages) ) {
            //if no specific page found load generic            
            $pages = $this->getPages('generic');

        }else{
            /* if specific pages with key_param presents...
	         in any case first row will be that what we need (see sql "order by" in getPages method) */
	        $unique_page = $pages[0];
        }
		// look for key_param and key_value in the request
		//!!!!! NEW Discovery 
		/*
		Steps to perform
		1. Based on rt (controller) select all rows from pages table where controller = "$controller"  
		2. Based on $key_param = key_param from pages table for given $controller locate this $key_param value from CGI input. 
		You will have $key_param and $key_value pair. 
		NOTE: key_param will be unique per controller. More optimized select can be used to get key_param from pages table.
		3. Locate id from pages table based on $key_param and $key_value pair
		 where controller = "$controller" and key_param = $key_param and key_value = $this->request->get[$key_param];
		NOTE: Do select only if value present.
		4. If locate page id use the layout.
		
		*/
		
        $this->page = !empty($unique_page) ? $unique_page : $pages[0];
		$this->page_id = $this->page['page_id'];
		//if no page found set default page id 1
		if (empty($this->page_id)) {
			$this->page_id = 1;
		}

		//Get the page layout
		$layouts =  $this->getLayouts(1);
		if (sizeof($layouts) == 0) {
			//No page specific layout, load default layout
			$layouts =  $this->getDefaultLayout();
			if (sizeof($layouts) == 0) {
				// ????? How to terminate ????
                throw new AException(AC_ERR_LOAD_LAYOUT, 'No layout found for page_id/controller '.$this->page_id.'::'.$this->page['controller'].'!');
			}
		}

		$this->layout = $layouts[0];
		$this->layout_id = $this->layout['layout_id'];	

		// Get all blacks for the page;
		$blocks = $this->getlayoutBlocks($this->layout_id);
		$this->blocks = $blocks;
		return $this->page_id;
	}

	public function getPages($controller = '', $key_param = '', $key_value = '') {
        $cache_name = 'layout.pages'
                      .( !empty($controller) ? '.'.$controller : ''  )
                      .( !empty($key_param) ? '.'. $key_param : ''  )
                      .( !empty($key_value) ? '.'.$key_value : ''  );
        $cache_name = preg_replace('/[^a-zA-Z0-9\.]/', '', $cache_name);
        $pages = $this->cache->get( $cache_name, '', (int)$this->config->get('config_store_id') );
        if (isset($pages)) {
            // return cached pages
            return $pages;
        }

		$where = '';
		if (! empty ( $controller ) ){
			$where = "WHERE controller = '" . $this->db->escape ( $controller ) . "' ";
			if( ! empty ( $key_param ) ) {
				if( ! empty ( $key_value ) ){
					// so if we have key_param key_value pair we select pages with controller and with or without key_param
					$where .= " AND ( COALESCE( key_param, '' ) = ''
										OR
										( key_param = '" . $this->db->escape ( $key_param ) . "'
											AND key_value = '" . $this->db->escape ( $key_value ) . "' ) )";

				} else { //write to log this stuff. it's abnormal situation
					$message = "Error: Error in data of page with controller: '".$controller."'. Please check for key_value present where key_param was set";
					$this->messages->saveError('Error',$message);
					$error = new AError ( $message );
					$error->toLog ()->toDebug ();
				}
			}
		}
		
		$sql = "SELECT page_id, controller, key_param, key_value, created, updated "
			 . "FROM ".DB_PREFIX . "pages "
			 . $where
			 . "ORDER BY key_param DESC, key_value DESC, page_id ASC";
		$query = $this->db->query($sql);
		
		$pages = $query->rows;

        $this->cache->set($cache_name, $pages, '', (int)$this->config->get('config_store_id'));
		
		return $pages;
	}

	public function getKeyParamByController($controller = ''){
		$key = null;
		switch($controller){
			case 'pages/product/product':
				$key = 'product_id';
				break;
			case 'pages/product/manufacturer':
				$key = 'manufacturer_id';
				break;
			case 'pages/product/category':
				$key = 'path';
				break;
			case 'pages/content/content':
				$key = 'content_id';
				break;
			default:
				$key = null;
			break;
		}

	return $key;
	}

	public function getDefaultLayout() {
		$cache_name = 'layout.default.'. $this->tmpl_id;
        $cache_name = preg_replace('/[^a-zA-Z0-9\.]/', '', $cache_name);
        $layouts = $this->cache->get($cache_name,'', (int)$this->config->get('config_store_id'));
        if (isset($layouts)) {
            // return cached layouts
            return $layouts;
        }

		$where = 'WHERE template_id = "' . $this->db->escape($this->tmpl_id) . '" ';
		$where .= "AND layout_type = '0'";	
		
		$sql = "SELECT "
			 . "layout_id, "
			 . "layout_type, "
			 . "layout_name, "
			 . "created, "
			 . "updated "
			 . "FROM "
			 . DB_PREFIX . "layouts "
			 . $where
			 . " ORDER BY "
			 . "layout_id Asc";
			 		
		$query = $this->db->query($sql);
		
		$layouts = $query->rows;

        $this->cache->set($cache_name, $layouts,'', (int)$this->config->get('config_store_id'));

		return $layouts;
	}

	public function getLayouts($layout_type = '') {
		//No page id, not need to be here
		if (empty($this->page_id)) { 
			return; 
		}
        $cache_name = 'layout.layouts.' . $this->tmpl_id . '.' . $this->page_id
                      .( !empty($layout_type) ? '.'.$layout_type : ''  );
        $cache_name = preg_replace('/[^a-zA-Z0-9\.]/', '', $cache_name);
        $layouts = $this->cache->get($cache_name,'', (int)$this->config->get('config_store_id'));
        if (isset($layouts)) {
            // return cached layouts
            return $layouts;
        }

		$where = 'WHERE template_id = "' . $this->db->escape($this->tmpl_id) . '" ';
		$join = ", " . DB_PREFIX . "pages_layouts as pl ";
		$where .= "AND pl.page_id = '" . (int)$this->page_id . "' AND l.layout_id = pl.layout_id ";
		
		if ( !empty($layout_type) ) {
			$where .= empty($layout_type) ? "" : "AND layout_type = '" . (int)$layout_type . "' ";		
		}
		
		$sql = "SELECT "
			 . "l.layout_id as layout_id, "
			 . "l.layout_type as layout_type, "
			 . "l.layout_name as layout_name, "
			 . "l.created as created, "
			 . "l.updated as updated "
			 . "FROM "
			 . DB_PREFIX . "layouts as l "
			 . $join
			 . $where
			 . " ORDER BY "
			 . "l.layout_id Asc";

		$query = $this->db->query($sql);
		
		$layouts = $query->rows;

        $this->cache->set($cache_name, $layouts,'', (int)$this->config->get('config_store_id'));

        return $layouts;
	}
	
	public function getlayoutBlocks($layout_id) {
		if ( empty($layout_id) ){
			throw new AException(AC_ERR_LOAD_LAYOUT, 'No layout specified for getlayoutBlocks!');
		}

		$cache_name = 'layout.blocks.' . $layout_id;
        $cache_name = preg_replace('/[^a-zA-Z0-9\.]/', '', $cache_name);
        $blocks = $this->cache->get($cache_name, '', (int)$this->config->get('config_store_id'));
        if (isset($blocks)) {
            // return cached blocks
            return $blocks;
        }
		
		$where = "WHERE bl.layout_id = '" . $layout_id . "' ";
		$where .= "AND bl.block_id = b.block_id AND bl.status = 1 ";
		
		$sql = "SELECT "
			 . "bl.instance_id as instance_id, "
			 . "b.block_id as block_id, "
			 . "bl.custom_block_id, "
			 . "bl.parent_instance_id as parent_instance_id, "
			 . "bl.position as position, "
			 . "b.block_txt_id as block_txt_id, "
			 . "b.controller as controller "
			 . "FROM "
			 . DB_PREFIX . "blocks as b, "
			 . DB_PREFIX . "block_layouts as bl "
			 . $where
			 . "ORDER BY "
			 . "bl.parent_instance_id Asc, bl.position Asc";
		
		$query = $this->db->query($sql);
		$blocks = $query->rows;

        $this->cache->set($cache_name, $blocks,'', (int)$this->config->get('config_store_id'));
		
		return $blocks;
	}
	
	public function getChildren($instance_id = 0) {
		$children = array();
		// Look into all blocks and locate all children
		foreach ($this->blocks as $block) {
			if ( (string)$block['parent_instance_id'] == (string)$instance_id ){
				array_push( $children, $block );
			}
		}		
		return $children;
	}

    public function getBlockDetails( $child_instance_id ) {
		//Select block details by controller
		foreach ($this->blocks as $block) {
			if ($block['instance_id'] == $child_instance_id ){
				return $block;
			}
		}    
 	}
		
	public function addChildFirst($instance_id, $newchild, $block_txt_id, $template) {
		$new_block = array();
		$new_block['parent_instance_id'] = $instance_id;
		$new_block['instance_id'] = $block_txt_id.$instance_id;
		$new_block['block_id'] = $block_txt_id;
		$new_block['controller'] = $newchild;
		$new_block['block_txt_id'] = $block_txt_id;
		$new_block['template'] = $template;
		array_unshift($this->blocks, $new_block );		
	}	
	
	public function addChild($instance_id, $newchild, $block_txt_id, $template) {
		$new_block = array();
		$new_block['parent_instance_id'] = $instance_id;
		$new_block['instance_id'] = $block_txt_id.$instance_id;
		$new_block['block_id'] = $block_txt_id;
		$new_block['controller'] = $newchild;
		$new_block['block_txt_id'] = $block_txt_id;
		$new_block['template'] = $template;
		array_push($this->blocks, $new_block );		
	}


	public function getBlockTemplate ( $instance_id ) {
		//Select block and parent id by controller
		$block_id = '';
		$parent_block_id = '';
		$parent_instance_id = '';
		$template = '';
		//locate block id

		foreach ($this->blocks as $block) {
			if ($block['instance_id'] == $instance_id ){
				$block_id = $block['block_id'];
				$parent_instance_id = $block['parent_instance_id'];
				$template = !empty($block['template']) ? $block['template'] : '';
				break;
			}
		}	
		$where = '';
		//Check if we do not have template set yet in the code
		if ($template) {
			return $template;
		}
		//locate true parent_block id. Not to confuse with parent_instance_id
		foreach ($this->blocks as $block) {
			if ($block['instance_id'] == $parent_instance_id ){
				$parent_block_id = $block['block_id'];
				break;
			}
		}	
		if ( !empty($block_id) && !empty($parent_block_id) ) {

            $cache_name = 'layout.block.template.' . $block_id . '.' . $parent_block_id;
            $cache_name = preg_replace('/[^a-zA-Z0-9\.]/', '', $cache_name);
            $template = $this->cache->get($cache_name,'', (int)$this->config->get('config_store_id'));
            if (isset($template)) {
                // return cached $template
                return $template;
            }

			$where = 'WHERE bt.block_id = "' . (int)($block_id) . '" ';
			$where .= 'AND bt.parent_block_id = "' . (int)$parent_block_id . '" ';
		
			$sql = "SELECT "
			 . "bt.template as template, "
			 . "bt.created as created, "
			 . "bt.updated as updated "
			 . "FROM "
			 . DB_PREFIX . "block_templates as bt "
			 . $where
			 . "ORDER BY "
			 . "bt.block_id Asc";

			$query = $this->db->query($sql);
            if ( $query->num_rows ) {
                $this->cache->set($cache_name, $query->rows[0]['template'],'', (int)$this->config->get('config_store_id'));
                return $query->rows[0]['template'];
            } else
                return '';
		}		
				
	}

	public function getBlockDescriptions($custom_block_id=0){
		if(!(int)$custom_block_id){
			return array();
		}
		$cache_name = 'layout.a.block.descriptions.' . $custom_block_id;
		$output = $this->cache->get ( $cache_name );
		if (isset( $output )) {
			// return cached blocks
			return $output;
		}

		$output = array();
		$result = $this->db->query ( "SELECT bd.*, COALESCE(bl.status,0) as status
										FROM " . DB_PREFIX . "block_descriptions bd
										LEFT JOIN " . DB_PREFIX . "block_layouts bl ON bl.custom_block_id = bd.custom_block_id
										WHERE bd.custom_block_id = '" . ( int ) $custom_block_id . "'");
		if($result->num_rows){
			foreach($result->rows as $row){
				$output[$row['language_id']] = $row;
			}
		}
		$this->cache->set ( $cache_name, $output );
		return $output;
	}

}