File Source for pnTheme.class.php

<?php
/**
* Zikula Application Framework
*
* @copyright (c) 2001, Zikula Development Team
* @link http://www.zikula.org
* @version $Id: pnTheme.class.php 24433 2008-07-03 12:06:19Z markwest $
* @license GNU/GPL - http://www.gnu.org/copyleft/gpl.html
* @author Mark West
* @package Zikula_Core
* @subpackage pnAPI
*/
/**
* pnTheme
*
* @package Zikula_Core
* @subpackage pnAPI
*/
if (class_exists('pnRender')) {
class Theme extends pnRender {
// base theme info
var $id; // id
var $name; // name
var $displayname; // display name
var $description; // description
var $regid; // registration id
var $type; // type
var $directory; // directory
var $version; // version
var $official; // official
var $author; // author(s)
var $contact; // contact(s)
var $admin; // admin capable
var $user; // user capable
var $system; // system capable
var $state; // state
var $credits; // credits
var $changelog; // changelog
var $help; // help
var $license; // license
var $xhtml; // xhtml capable
// base theme vars
var $themepath; // Theme base path
var $imagepath; // Theme image path
var $imagelangpath; // Theme image path
var $stylepath; // Theme stylesheet path
var $scriptpath; // Theme stylesheet path
// vars to identify our page
var $componentid;
var $pageid;
var $pagetype;
var $qstring;
var $requesturi;
var $permlevel;
var $isloggedin;
/**
* Initialize our class
* @return none
*/
function Theme($theme, $usefilters = true)
{
// first, get a native pnRender object object
$this->pnRender();
// store our theme directory
$themeinfo = ThemeUtil::getInfo(ThemeUtil::getIDFromName($theme));
foreach ($themeinfo as $key => $value) {
$this->$key = $value;
}
// change some base settings from our parent class
// template compilation
$this->compile_dir = pnConfigGetVar('temp') . '/Xanthia_compiled';
$this->compile_check = pnModGetVar('Theme', 'compile_check');
$this->force_compile = pnModGetVar('Theme', 'force_compile');
$this->compile_id = $theme;
// template caching
$this->cache_dir = pnConfigGetVar('temp') . '/Xanthia_cache';
$this->caching = pnModGetVar('Theme', 'enablecache');
$type = FormUtil::getPassedValue('type', null, 'GETPOST');
if ($this->caching && strtolower($type) != 'admin') {
$modulesnocache = explode(',',pnModGetVar('Theme', 'modulesnocache'));
if (in_array($this->toplevelmodule, $modulesnocache)) {
$this->caching = false;
}
} else {
$this->caching = false;
}
$this->cache_lifetime = pnModGetVar('Theme', 'cache_lifetime');
// assign all our base template variables
$this->_base_vars();
// define the plugin directories
$this->_plugin_dirs();
// load the theme configuration
$this->_load_config();
// check for cached output
// turn on caching, check for cached output and then disable caching
// to prevent blocks from being cached
if ($this->caching && $this->is_cached($this->themeconfig['page'], $this->pageid)) {
$this->display($this->themeconfig['page'], $this->pageid);
pnShutDown();
}
// Assign all theme variables
$this->assign($this->get_config_vars());
if ($usefilters) {
// register page vars output filter
$this->load_filter('output', 'pagevars');
// register short urls output filter
if (pnConfigGetVar('shorturls')) {
$this->load_filter('output', 'shorturls');
}
// register trim whitespace output filter if requried
if (pnModGetVar('Theme', 'trimwhitespace')) {
$this->load_filter('output', 'trimwhitespace');
}
// register output filter to make urls clickable if requried
if (pnModGetVar('Theme', 'makelinks')) {
$this->load_filter('output', 'makelinks');
}
// register output filter to add MultiHook environment if requried
if (pnModAvailable('MultiHook')) {
$modinfo = pnModGetInfo(pnModGetIDFromName('MultiHook'));
if (version_compare($modinfo['version'], '5.0', '>=') == 1) {
$this->load_filter('output', 'multihook');
pnModAPIFunc('MultiHook', 'theme', 'preparetheme');
}
}
}
// Start the output buffering to capture module output
ob_start();
}
/**
* display the page output
* @access private
* @return none
*/
function themefooter()
{
// end output buffering and get module output
$maincontent = ob_get_contents();
ob_end_clean();
// add the module wrapper
if (!$this->system && (!isset($this->themeconfig['modulewrapper']) || $this->themeconfig['modulewrapper'])) {
$maincontent = '<div id="pn-maincontent" class="pn-module-'.DataUtil::formatForDisplay($this->toplevelmodule).'">'.$maincontent.'</div>';
}
// Assign the main content area to the template engine
$this->assign_by_ref('maincontent', $maincontent);
// render the page using the correct template
$this->display($this->themeconfig['page'], $this->pageid);
}
/**
* display a block
*
* @param postion
*/
function themesidebox($block)
{
// assign the block information
$this->assign($block);
$bid = $block['bid'];
$bkey = $block['bkey'];
$position = $block['position'];
// fix block positions - for now....
if ($position == 'l') $position = 'left';
if ($position == 'c') $position = 'center';
if ($position == 'r') $position = 'right';
// HACK: Save/restore output filters - we don't want to output-filter blocks
$outputfilters = $this->_plugins['outputfilter'];
$this->_plugins['outputfilter'] = array();
// HACK: Save/restore cache settings
$caching = $this->caching;
$this->caching = false;
// determine the correct template and construct the output
$return = '';
if (isset($this->themeconfig['blockinstances'][$bid]) && !empty($this->themeconfig['blockinstances'][$bid])) {
$return .= $this->fetch($this->themeconfig['blockinstances'][$bid]);
} elseif (isset($this->themeconfig['blocktypes'][$bkey]) && !empty($this->themeconfig['blocktypes'][$bkey])) {
$return .= $this->fetch($this->themeconfig['blocktypes'][$bkey]);
} else if (isset($this->themeconfig['blockpositions'][$position]) && !empty($this->themeconfig['blockpositions'][$position])) {
$return .= $this->fetch($this->themeconfig['blockpositions'][$position]);
} else if (isset($this->themeconfig['block']) && !empty($this->themeconfig['block'])) {
$return .= $this->fetch($this->themeconfig['block']);
} else {
if (!empty($block['title'])) {
$return .= '<h4>'. pnML($block['title'], array(), true) . ' ' .$block['minbox'].'</h4>';
}
$return .= $block['content'];
}
// HACK: Save/restore output filters
$this->_plugins['outputfilter'] = $outputfilters;
// HACK: Save/restore cache settings
$this->caching = $caching;
if (!isset($this->themeconfig['blockwrapper']) || $this->themeconfig['blockwrapper']) {
$return = '<div class="pn-block pn-blockposition-'.DataUtil::formatForDisplay($block['position'])
.' pn-bkey-'.DataUtil::formatForDisplay($block['bkey'])
.' pn-bid-'.DataUtil::formatForDisplay($block['bid']).'">'."\n"
. $return . "</div>\n";
}
return $return;
}
/**
* render the legacy open/close table functions
*
* @param string $template
* @deprecated
*/
function themetable($open = true, $tablenum = 1)
{
$return = '';
if ($open) {
// Start the output buffer
ob_start();
} else {
// Get the buffer contents and end buffering
$tablecontent = ob_get_contents();
ob_end_clean();
if (isset($this->themeconfig['table'.(int)$tablenum])) {
// assign the table content
$this->assign('tablecontent', $tablecontent);
$return = $this->fetch($this->themeconfig['table'.(int)$tablenum]);
} else {
$return = '<div class="pn-box'.(int)$tablenum.'">'.$tablecontent.'</div>';
}
}
return $return;
}
/**
* Checks which path to use for required template
*
* @param string $template
*/
function get_template_path($template)
{
static $cache = array();
if (isset($cache[$template])) {
return $cache[$template];
}
// get the theme path to templates
$os_theme = DataUtil::formatForOS($this->directory);
// Define the locations in which we will look for templates
// (in this order)
// 1. Master template path
$masterpath = "themes/$os_theme/templates";
// 2. The module template path
$modulepath = "themes/$os_theme/templates/modules";
// 4. The block template path
$blockpath = "themes/$os_theme/templates/blocks";
$ostemplate = DataUtil::formatForOS($template);
$search_path = array($masterpath,
$modulepath,
$blockpath);
foreach ($search_path as $path) {
if (file_exists("$path/$ostemplate") && is_readable("$path/$ostemplate")) {
$cache[$template] = $path;
return $path;
}
}
// when we arrive here, no path was found
return false;
}
/**
* define all our plugin directories
*
* @access private
*/
function _plugin_dirs()
{
// add our basic engine plugin path
if (file_exists('system/Theme/plugins')) {
array_push($this->plugins_dir, 'system/Theme/plugins');
}
if (file_exists('system/pnRender/plugins')) {
array_push($this->plugins_dir, 'system/pnRender/plugins');
}
// add theme specific plugins directories, if they exist
$themepath = 'themes/'.$this->directory.'/plugins';
if (file_exists($themepath)) {
array_push($this->plugins_dir, $themepath);
}
}
/**
* assign template vars for base theme paths and other useful variables
*
* @access private
*/
function _base_vars()
{
// get variables from input
$name = FormUtil::getPassedValue('name', null, 'GETPOST');
$module = FormUtil::getPassedValue('module', null, 'GETPOST');
$type = FormUtil::getPassedValue('type', null, 'GETPOST');
$func = FormUtil::getPassedValue('func', null, 'GETPOST');
// set some basic class variables from the PN environemnt
$this->isloggedin = pnUserLoggedIn();
$this->uid = pnUserGetVar('uid');
// Assign the query string
$this->qstring = isset($_SERVER['QUERY_STRING']) ? $_SERVER['QUERY_STRING'] : '';
// Assign the current script
$this->requesturi = pnGetCurrentURI();
// assign some basic paths for the engine
$this->template_dir = $this->themepath.'/templates'; // default directory for templates
// define the cache id
if ($this->isloggedin) {
$this->pageid = $this->name.$this->requesturi.$this->qstring.$this->language.$this->uid;
} else {
$this->pageid = $this->name.$this->requesturi.$this->qstring.$this->language;
}
// now strip any non-ascii characters from the page id
$this->pageid = md5($this->pageid);
$this->themepath = 'themes/'.$this->directory;
$this->imagepath = $this->baseurl.$this->themepath.'/images';
$this->imagelangpath = $this->baseurl.$this->themepath.'/images'.$this->language;
$this->stylepath = $this->baseurl.$this->themepath.'/style';
$this->scriptpath = $this->baseurl.$this->themepath.'/javascript';
// set vars based on the module structures
$this->type = !empty($type) ? $type : 'user';
$this->func = !empty($func) ? $func : 'main';
$this->home = (empty($module) && empty($name)) ? true : false;
// identify and assign the page type
$this->pagetype = 'module';
if ((stristr($_SERVER['PHP_SELF'], 'admin.php') || strtolower($this->type) == 'admin')) {
$this->pagetype = 'admin';
} else if (empty($name) && empty($module)) {
$this->pagetype = 'home';
}
$this->assign('pagetype', $this->pagetype);
// make the base vars available to all templates
$this->assign('lang', $this->language);
$this->assign('loggedin', $this->isloggedin);
$this->assign('uid', $this->uid);
$this->assign('themepath', $this->themepath);
$this->assign('imagepath', $this->imagepath);
$this->assign('imagelangpath', $this->imagelangpath);
$this->assign('stylepath', $this->stylepath);
$this->assign('scriptpath', $this->scriptpath);
$this->assign('module', $this->toplevelmodule);
$this->assign('type', $this->type);
$this->assign('func', $this->func);
}
/**
* load the base theme configuration
*
* @access private
*/
function _load_config()
{
// set the config directory
$this->_set_configdir();
// load the page configurations
$pageconfigurations = pnModAPIFunc('Theme', 'user', 'getpageconfigurations', array('theme' => $this->name));
// parse the query string into individual arguments discarding common arguments
// common arguments are ones that we don't want affecting our url matching or ones that are
// already considered; These are same args defined as reserved by the MDG.
if (pnConfigGetVar('shorturls')) {
if (pnConfigGetVar('shorturlstype') == 0) {
// remove the base uri, entrypoint, module name and, if it exists, the function name from the string
$customargs = str_replace(pnGetBaseURI(), '', $this->requesturi);
$entrypoint = pnConfigGetVar('entrypoint');
$customargs = str_replace("/{$entrypoint}/", '/', $customargs);
} else {
$extension = pnConfigGetVar('shorturlsext');
$qstring = str_replace(array(pnGetBaseURI().'/', ".{$extension}", "module-{$this->toplevelmodule}", $this->type, $this->func),
'',
$this->requesturi);
$qstring = trim($qstring, '-');
$argsarray = explode('-', $qstring);
$argsarray = array_chunk($argsarray, 2);
foreach ($argsarray as $argarray) {
$customargs[] = implode('=', $argarray);
}
$customargs = '/' . implode('/', $customargs);
}
} else {
$queryparts = explode('&', $this->qstring);
$customargs = '';
foreach ($queryparts as $querypart) {
if (!stristr($querypart, 'module=') && !stristr($querypart, 'name=') && !stristr($querypart, 'type=') &&
!stristr($querypart, 'func=') && !stristr($querypart, 'theme=') && !stristr($querypart, 'authid=')) {
$customargs .= '/'.$querypart;
}
}
}
// identify and load the correct module configuration
$this->cachepage = true;
if (stristr($_SERVER['PHP_SELF'], 'user') && isset($pageconfigurations['*user'])) {
$file = $pageconfigurations['*user']['file'];
} else if (!stristr($_SERVER['PHP_SELF'], 'user') && !stristr($_SERVER['PHP_SELF'], 'admin.php') && $this->home && isset($pageconfigurations['*home'])) {
$file = $pageconfigurations['*home']['file'];
} else if (stristr($_SERVER['PHP_SELF'], 'admin.php') && isset($pageconfigurations['*admin'])) {
$this->cachepage = false;
$file = $pageconfigurations['*admin']['file'];
} else {
$customargs = $this->toplevelmodule.'/'.$this->type.'/'.$this->func.$customargs;
// find any page configurations that match in a sub string comparison
$match = '';
$matchlength = 0;
foreach ($pageconfigurations as $pageconfiguration => $pageconfigurationarray) {
if (stristr($customargs, $pageconfiguration) && $matchlength < strlen($pageconfiguration)) {
$match = $pageconfiguration;
$matchlength = strlen($match);
}
}
if((strtolower($this->type) == 'admin') && isset($pageconfigurations['*admin'])&&(!stristr($match,'admin'))) {
$match = '*admin';
}
if(strtolower($this->type) == 'admin') {
$this->cachepage = false;
}
if (!empty($match)) {
$file = $pageconfigurations[$match]['file'];
}
}
if (!isset($file)) {
$file = $pageconfigurations['master']['file'];
}
// load the page configuration
$this->themeconfig = pnModAPIFunc('Theme', 'user', 'getpageconfiguration', array('theme' => $this->name, 'filename' => $file));
// check if we've not got a valid theme configation
if (!$this->themeconfig) {
$this->themeconfig = pnModAPIFunc('Theme', 'user', 'getpageconfiguration', array('theme' => $this->name, 'filename' => 'master.ini'));
}
// register any filters
if (isset($this->themeconfig['filters']) && !empty($this->themeconfig['filters'])) {
if (isset($this->themeconfig['filters']['outputfilters']) && !empty($this->themeconfig['filters']['outputfilters'])) {
$this->themeconfig['filters']['outputfilters'] = explode(',', $this->themeconfig['filters']['outputfilters']);
foreach ($this->themeconfig['filters']['outputfilters'] as $filter) {
$this->load_filter('output', $filter);
}
}
if (isset($this->themeconfig['filters']['prefilters']) && !empty($this->themeconfig['filters']['prefilters'])) {
$this->themeconfig['filters']['prefilters'] = explode(',', $this->themeconfig['filters']['prefilters']);
foreach ($this->themeconfig['filters']['prefilters'] as $filter) {
$this->load_filter('pre', $filter);
}
}
if (isset($this->themeconfig['filters']['postfilters']) && !empty($this->themeconfig['filters']['postfilters'])) {
$this->themeconfig['filters']['postfilters'] = explode(',', $this->themeconfig['filters']['postfilters']);
foreach ($this->themeconfig['filters']['postfilters'] as $filter) {
$this->load_filter('post', $filter);
}
}
}
// load the theme settings
$this->config_load('file:themevariables.ini', 'variables');
// load the palette
if (isset($this->themeconfig['palette'])) {
$this->config_load('file:themepalettes.ini', $this->themeconfig['palette']);
}
// assign the palette
$this->assign('palette', isset($this->themeconfig['palette']) ? $this->themeconfig['palette'] : null);
}
/**
* set the config directory for this theme
*
* @access private
*/
function _set_configdir()
{
// check for a running configuration in the pnTemp/Xanthia_Config directory
if (is_dir($dir = pnConfigGetVar('temp').'/Xanthia_Config/'.DataUtil::formatForOS($this->name))) {
$this->config_dir = $dir;
} else {
$this->config_dir = $this->themepath.'/templates/config';
}
}
}
}

Source for file pnTheme.class.php