mirror of
https://github.com/e107inc/e107.git
synced 2025-01-17 20:58:30 +01:00
464 lines
9.7 KiB
PHP
464 lines
9.7 KiB
PHP
<?php
|
|
/*
|
|
* e107 website system
|
|
*
|
|
* Copyright (C) 2008-2013 e107 Inc (e107.org)
|
|
* Released under the terms and conditions of the
|
|
* GNU General Public License (http://www.gnu.org/licenses/gpl.txt)
|
|
*
|
|
* e107 Menu Class
|
|
*
|
|
*/
|
|
|
|
if(!defined('e107_INIT'))
|
|
{
|
|
exit();
|
|
}
|
|
|
|
/**
|
|
* Retrieve and render site menus
|
|
*
|
|
* @package e107
|
|
* @category e107_handlers
|
|
* @version 1.0
|
|
* @author Cameron
|
|
* @copyright Copyright (c) 2009, e107 Inc.
|
|
*
|
|
*/
|
|
class e_menu
|
|
{
|
|
/**
|
|
* Runtime cached menu data
|
|
*
|
|
* @var array
|
|
*/
|
|
public $eMenuActive = array();
|
|
|
|
/**
|
|
* Visibility check cache
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $_visibility_cache = array();
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
*/
|
|
function __construct()
|
|
{
|
|
}
|
|
|
|
/**
|
|
* Retrieve menus, check visibility against
|
|
* current user classes and current page url
|
|
*
|
|
*/
|
|
public function init()
|
|
{
|
|
global $_E107;
|
|
|
|
if(vartrue($_E107['cli']))
|
|
{
|
|
return;
|
|
}
|
|
|
|
// print_a($eMenuArea);
|
|
if(varset($_SERVER['E_DEV_MENU']) == 'true') // New in v2.x
|
|
{
|
|
$layouts = e107::getPref('menu_layouts');
|
|
if(!is_array($layouts))
|
|
{
|
|
$converted = $this->convertMenuTable();
|
|
e107::getConfig('core')->set('menu_layouts', $converted)->save();
|
|
}
|
|
|
|
$eMenuArea = $this->getData(THEME_LAYOUT);
|
|
//print_a($eMenuArea);
|
|
}
|
|
else // the old v1.x way.
|
|
{
|
|
$eMenuArea = $this->getDataLegacy();
|
|
}
|
|
|
|
|
|
|
|
$total = array();
|
|
foreach($eMenuArea as $area => $val)
|
|
{
|
|
foreach($val as $row)
|
|
{
|
|
if($this->isVisible($row))
|
|
{
|
|
$path = str_replace("/", "", $row['menu_path']);
|
|
if(!isset($total[$area]))
|
|
{
|
|
$total[$area] = 0;
|
|
}
|
|
$this->eMenuActive[$area][] = $row;
|
|
$total[$area]++;
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
e107::getRender()->eMenuTotal = $total;
|
|
}
|
|
|
|
/**
|
|
* Convert from v1.x e107_menu table to v2.x $pref format.
|
|
*/
|
|
function convertMenuTable()
|
|
{
|
|
$sql = e107::getDb();
|
|
|
|
$sql->select('menus','*','menu_location !=0 ORDER BY menu_location,menu_order');
|
|
$data = array();
|
|
|
|
while($row = $sql->fetch())
|
|
{
|
|
$layout = vartrue($row['menu_layout'],'default');
|
|
$location = $row['menu_location'];
|
|
$data[$layout][$location][] = array('name'=>$row['menu_name'],'class'=> intval($row['menu_class']),'path'=>$row['menu_path'],'pages'=>$row['menu_pages'],'parms'=>$row['menu_parms']);
|
|
}
|
|
|
|
return $data;
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
* V2 Menu Re-Write - retrieve Menu data from $pref['menu_layouts']
|
|
*/
|
|
protected function getData($layout)
|
|
{
|
|
$mpref = e107::getPref('menu_layouts');
|
|
|
|
if(!varset($mpref[$layout]))
|
|
{
|
|
return array();
|
|
}
|
|
|
|
foreach($mpref[$layout] as $area=>$v)
|
|
{
|
|
$c = 1;
|
|
|
|
foreach($v as $val)
|
|
{
|
|
$class = intval($val['class']);
|
|
|
|
if(!check_class($class))
|
|
{
|
|
continue;
|
|
}
|
|
|
|
$ret[$area][] = array(
|
|
'menu_id' => $c,
|
|
'menu_name' => $val['name'],
|
|
'menu_location' => $area,
|
|
'menu_class' => $class,
|
|
'menu_order' => $c,
|
|
'menu_pages' => $val['pages'],
|
|
'menu_path' => $val['path'],
|
|
'menu_layout' => '',
|
|
'menu_parms' => $val['parms']
|
|
|
|
);
|
|
|
|
$c++;
|
|
}
|
|
|
|
|
|
}
|
|
|
|
|
|
// print_a($ret);
|
|
|
|
return $ret;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
* @DEPRECATED
|
|
* Legacy Function to retrieve Menu data from tables. - ie. the old v1.x method.
|
|
*/
|
|
private function getDataLegacy()
|
|
{
|
|
$sql = e107::getDb();
|
|
$menu_layout_field = THEME_LAYOUT!=e107::getPref('sitetheme_deflayout') ? THEME_LAYOUT : "";
|
|
|
|
// e107::getCache()->CachePageMD5 = md5(e_LANGUAGE.$menu_layout_field); // Disabled by line 93 of Cache class.
|
|
//FIXME add a function to the cache class for this.
|
|
|
|
$menu_data = e107::getCache()->retrieve_sys("menus_".USERCLASS_LIST."_".md5(e_LANGUAGE.$menu_layout_field));
|
|
// $menu_data = e107::getCache()->retrieve_sys("menus_".USERCLASS_LIST);
|
|
$menu_data = e107::getArrayStorage()->ReadArray($menu_data);
|
|
|
|
$eMenuArea = array();
|
|
// $eMenuList = array();
|
|
// $eMenuActive = array(); // DEPRECATED
|
|
|
|
|
|
if(!is_array($menu_data))
|
|
{
|
|
$menu_qry = 'SELECT * FROM #menus WHERE menu_location > 0 AND menu_class IN ('.USERCLASS_LIST.') AND menu_layout = "'.$menu_layout_field.'" ORDER BY menu_location,menu_order';
|
|
|
|
if($sql->gen($menu_qry))
|
|
{
|
|
while($row = $sql->fetch())
|
|
{
|
|
$eMenuArea[$row['menu_location']][] = $row;
|
|
}
|
|
}
|
|
|
|
$menu_data['menu_area'] = $eMenuArea;
|
|
|
|
$menuData = e107::getArrayStorage()->WriteArray($menu_data, false);
|
|
|
|
// e107::getCache()->set_sys('menus_'.USERCLASS_LIST, $menuData);
|
|
e107::getCache()->set_sys('menus_'.USERCLASS_LIST.'_'.md5(e_LANGUAGE.$menu_layout_field), $menuData);
|
|
|
|
}
|
|
else
|
|
{
|
|
$eMenuArea = $menu_data['menu_area'];
|
|
}
|
|
|
|
|
|
|
|
return $eMenuArea;
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
* Check visibility of a menu against URL
|
|
*
|
|
* @param array $row menu data
|
|
* @return boolean
|
|
*/
|
|
protected function isVisible($row, $url = '')
|
|
{
|
|
$iD = varset($row['menu_id']);
|
|
|
|
if(isset($this->_visibility_cache[$iD]))
|
|
{
|
|
return $this->_visibility_cache[$iD];
|
|
}
|
|
|
|
$show_menu = TRUE;
|
|
$tp = e107::getParser();
|
|
if($row['menu_pages'])
|
|
{
|
|
list ($listtype, $listpages) = explode("-", $row['menu_pages'], 2);
|
|
$pagelist = explode("|", $listpages);
|
|
// TODO - check against REQUEST_URI, see what would get broken
|
|
$check_url = $url ? $url : ($_SERVER['REQUEST_URI'] ? SITEURLBASE.$_SERVER['REQUEST_URI'] : e_SELF.(e_QUERY ? "?".e_QUERY : ''));
|
|
|
|
switch($listtype)
|
|
{
|
|
case '1': //show menu
|
|
$show_menu = false;
|
|
|
|
foreach($pagelist as $p)
|
|
{
|
|
$p = $tp->replaceConstants($p, 'full');
|
|
if(substr($p, -1)==='!')
|
|
{
|
|
$p = substr($p, 0, -1);
|
|
if(substr($check_url, strlen($p)*-1) == $p)
|
|
{
|
|
$show_menu = true;
|
|
break 2;
|
|
}
|
|
}
|
|
elseif(strpos($check_url, $p) !== false)
|
|
{
|
|
$show_menu = true;
|
|
break 2;
|
|
}
|
|
}
|
|
break;
|
|
case '2': //hide menu
|
|
$show_menu = true;
|
|
foreach($pagelist as $p)
|
|
{
|
|
$p = $tp->replaceConstants($p, 'full');
|
|
if(substr($p, -1)=='!')
|
|
{
|
|
$p = substr($p, 0, -1);
|
|
if(substr($check_url, strlen($p)*-1) == $p)
|
|
{
|
|
$show_menu = false;
|
|
break 2;
|
|
}
|
|
}
|
|
elseif(strpos($check_url, $p) !== false)
|
|
{
|
|
$show_menu = false;
|
|
break 2;
|
|
}
|
|
}
|
|
break;
|
|
} //end switch
|
|
} //endif menu_pages
|
|
|
|
$this->_visibility_cache[$iD] = $show_menu;
|
|
return $show_menu;
|
|
}
|
|
|
|
/**
|
|
* Render menu area
|
|
*
|
|
* @param string $parm
|
|
* @return string
|
|
*/
|
|
public function renderArea($parm = '')
|
|
{
|
|
global $sql, $ns, $tp, $sc_style;
|
|
global $error_handler;
|
|
|
|
$e107 = e107::getInstance();
|
|
|
|
$tmp = explode(':', $parm);
|
|
|
|
|
|
$buffer_output = (E107_DBG_INCLUDES) ? false : true; // Turn off when trouble-shooting includes. Default - return all output.
|
|
|
|
|
|
if(isset($tmp[1])&&$tmp[1]=='echo')
|
|
{
|
|
$buffer_output = false;
|
|
}
|
|
if(!array_key_exists($tmp[0], $this->eMenuActive))
|
|
{
|
|
return;
|
|
}
|
|
if($buffer_output)
|
|
{
|
|
ob_start();
|
|
}
|
|
|
|
e107::getRender()->eMenuArea = $tmp[0];
|
|
foreach($this->eMenuActive[$tmp[0]] as $row)
|
|
{
|
|
$this->renderMenu($row['menu_path'], $row['menu_name'], $row['menu_parms']);
|
|
}
|
|
e107::getRender()->eMenuCount = 0;
|
|
e107::getRender()->eMenuArea = null;
|
|
if($buffer_output)
|
|
{
|
|
$ret = ob_get_contents();
|
|
ob_end_clean();
|
|
return $ret;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Render menu
|
|
*
|
|
* @param string $mpath menu path
|
|
* @param string $mname menu name
|
|
* @param string $parm menu parameters
|
|
* @param boolean $return
|
|
* return string if required
|
|
*/
|
|
public function renderMenu($mpath, $mname='', $parm = '', $return = false)
|
|
{
|
|
// global $sql; // required at the moment.
|
|
global $sc_style, $e107_debug;
|
|
|
|
$e107 = e107::getInstance();
|
|
$sql = e107::getDb();
|
|
$ns = e107::getRender();
|
|
$tp = e107::getParser();
|
|
|
|
if($return)
|
|
{
|
|
ob_start();
|
|
}
|
|
|
|
if(vartrue($error_handler->debug))
|
|
{
|
|
echo "\n<!-- Menu Start: ".$mname." -->\n";
|
|
}
|
|
e107::getDB()->db_Mark_Time($mname);
|
|
|
|
if(is_numeric($mpath) || ($mname === false)) // Custom Page/Menu
|
|
{
|
|
$query = ($mname === false) ? "menu_name = '".$mpath."' " : "page_id=".intval($mpath)." "; // load by ID or load by menu-name (menu_name)
|
|
|
|
$sql->select("page", "*", $query);
|
|
$page = $sql->fetch();
|
|
|
|
$caption = $tp->toHTML($page['menu_title'], true, 'parse_sc, constants');
|
|
|
|
if(vartrue($page['menu_template'])) // New v2.x templates. see core/menu_template.php
|
|
{
|
|
$template = e107::getCoreTemplate('menu',$page['menu_template']);
|
|
$page_shortcodes = e107::getScBatch('page',null,'cpage');
|
|
$page_shortcodes->page = $page;
|
|
|
|
// print_a($template['body']);
|
|
$text = $tp->parseTemplate($template['body'], true, $page_shortcodes);
|
|
// echo "TEMPLATE= ($mpath)".$page['menu_template'];
|
|
|
|
// if($template['noTableRender'] !==true) // XXX Deprecated - causes confusion while themeing.
|
|
// {
|
|
$ns->tablerender($caption, $text, 'cmenu-'.$page['menu_template']);
|
|
// }
|
|
// else
|
|
// {
|
|
// echo $text;
|
|
// }
|
|
|
|
}
|
|
else
|
|
{
|
|
$text = $tp->toHTML($page['menu_text'], true, 'parse_sc, constants');
|
|
$ns->tablerender($caption, $text, 'cmenu');
|
|
}
|
|
|
|
}
|
|
else
|
|
{
|
|
// not sure what would break this, but it's good idea to go away
|
|
e107::loadLanFiles($mpath);
|
|
|
|
//include once is not an option anymore
|
|
//e107_include will break many old menus (evil globals), so we'll wait for a while...
|
|
//e107_include(e_PLUGIN.$mpath."/".$mname.".php");
|
|
//if(substr($mpath,-1)!='/')
|
|
//{
|
|
// $mpath .= '/';
|
|
//}
|
|
|
|
$mpath = trim($mpath, '/').'/'; // faster...
|
|
$e107_debug ? include(e_PLUGIN.$mpath.$mname.'.php') : @include(e_PLUGIN.$mpath.$mname.'.php');
|
|
}
|
|
e107::getDB()->db_Mark_Time("(After ".$mname.")");
|
|
if($error_handler->debug==true)
|
|
{
|
|
echo "\n<!-- Menu End: ".$mname." -->\n";
|
|
}
|
|
|
|
if($return)
|
|
{
|
|
$ret = ob_get_contents();
|
|
ob_end_clean();
|
|
return $ret;
|
|
}
|
|
}
|
|
}
|