Source for file pnRender.class.php

 

    /**

    define('SMARTY_DIR', 'includes/classes/Smarty/');

    Loader::requireOnce(SMARTY_DIR . 'Smarty.class.php');

 

class pnRender extends Smarty {

    /**

    var $module;

 

    /**

    var $toplevelmodule;

 

    /**

    var $modinfo;

 

    /**

    var $theme;

 

    /**

    var $themeinfo;

 

    /**

    var $language;

 

    /**

    var $baseurl;

 

    /**

    var $baseuri;

 

    /**

    var $cache_id;

 

    /**

    var $userdb;

 

    /**

    var $expose_template;

 

    /**

    function pnRender($module = '', $caching = null)

    {

        // first, get a native Smarty object

        $this->Smarty();

 

        // set the error reporting level

        $this->error_reporting = isset($GLOBALS['PNConfig']['Debug']['error_reporting']) ? $GLOBALS['PNConfig']['Debug']['error_reporting'] : E_ALL;

 

        // Initialize the module property with the name of

        // the topmost module. Foor Hooks, Blocks, API Functions and others

        // you need to set this property to the name of the respective module!

        $this->toplevelmodule = pnModGetName();

        if (!$module) {

            $module = $this->toplevelmodule;

        }

        $this->module = array($module => pnModGetInfo(pnModGetIDFromName($module)));

 

        // initialise other PN environment vars

        $this->language = pnUserGetLang();

        $this->baseurl = pnGetBaseURL();

        $this->baseuri = pnGetBaseURI();

 

        // begin holder tag (be nice to others)

        $this->left_delimiter = '<!--[';

        // end holder tag

        $this->right_delimiter = ']-->';

 

        //---- Plugins handling -----------------------------------------------

        // add plugin paths

        $this->themeinfo = ThemeUtil::getInfo(ThemeUtil::getIDFromName(pnUserGetTheme()));

        $this->theme = $theme = $this->themeinfo['directory'];

 

        //$this->modinfo = $modinfo = pnModGetInfo(pnModGetIDFromName($module));

        $modpath = ($this->module[$module]['type'] == 3) ? 'system' : 'modules';

        // plugin paths are ordered so that we find the vast majority of plugins with as few path

        // searches as possible

        $pluginpaths = array('system/pnRender/plugins',

                             'system/Theme/plugins',

                             'config/plugins',

                             "themes/$theme/templates/modules/$module/plugins",

                             "themes/$theme/plugins",

                             "$modpath/" . $this->module[$module]['directory'] ."/pntemplates/plugins");

        foreach ($pluginpaths as $pluginpath) {

            if (file_exists($pluginpath)) {

                array_push($this->plugins_dir, $pluginpath);

            }

        }

 

        // check if the recent 'type' parameter in the URL is admin and if yes,

        // include (modules|system)/Admin/pntemplates/plugins to the plugins_dir array

        $type = FormUtil::getPassedValue('type', null, 'GETPOST');

        if ($type==='admin') {

            array_push($this->plugins_dir, 'system/Admin/pntemplates/plugins');

            $this->load_filter('output', 'admintitle');

        }

 

        /* // add the plugin directory for all available modules

        // build the path to the config file for usemodules needed later

        $usemod_conf = "$modpath/".$this->module[$module]['directory']."/pntemplates/config/usemodules";

        // load the config file

        if (file_exists($usemod_conf) && is_readable($usemod_conf)) {

            $additionalmodules = file($usemod_conf);

            if (is_array($additionalmodules)) {

                foreach ($additionalmodules as $addmod) {

                    $this->_add_plugins_dir(trim($addmod));

                }

            }

        }

 

        //---- Cache handling -------------------------------------------------

        // use HTML cache system?

        if (isset($caching) && is_bool($caching)) {

            $this->caching = $caching;

        } else {

            $this->caching = pnModGetVar('pnRender', 'cache');

        }

        $this->cache_lifetime = pnModGetVar('pnRender', 'lifetime');

 

        // HTML cache directory

        $this->cache_dir = pnConfigGetVar('temp') . '/pnRender_cache';

 

        //---- Compilation handling -------------------------------------------

        // check for updated templates?

        $this->compile_check = pnModGetVar('pnRender', 'compile_check');

 

        // force compile template always?

        $this->force_compile = pnModGetVar('pnRender', 'force_compile');

 

        // don't use subdirectories when creating compiled/cached templates

        // this works better in a hosted environment

        $this->use_sub_dirs = false;

 

        // cache directory (compiled templates)

        $this->compile_dir = pnConfigGetVar('temp') . '/pnRender_compiled';

 

        // compile id

        $this->compile_id = $this->toplevelmodule . '|' . $theme . '|' . pnUserGetLang();

 

        // initialize the cache ID

        $this->cache_id = '';

 

        // expose templates

        $this->expose_template = (pnModGetVar('pnRender', 'expose_template') == true) ? true : false;

 

        $this->register_block('nocache', 'pnRender_block_nocache', false);

 

        // register resource type 'pn'

        // this defines the way templates are searched during

        // <!--[ include file='my_template.html' ]-->

        // this enables us to store selected module templates in the

        // theme while others can be kept in the module itself.

        $this->register_resource('pn', array('pn_get_template',

                                             'pn_get_timestamp',

                                             'pn_get_secure',

                                             'pn_get_trusted'));

 

        // set 'pn' as default resource type

        $this->default_resource_type = 'pn';

 

        // For ajax requests we use the short urls filter to 'fix' relative paths

        if (($GLOBALS['loadstages'] & PN_CORE_AJAX) && pnConfigGetVar('shorturls')) {

            $this->load_filter('output', 'shorturls');

        }

 

        // Assign some useful theme settings

        // firstly all theme variables

        $this->assign(ThemeUtil::getVar());

        // secondly the base paths

        $this->assign('baseurl', $this->baseurl);

        $this->assign('baseuri', $this->baseuri);

        // lastly the theme paths

        $this->assign('themepath',     $this->baseurl . 'themes/' . $theme);

        $this->assign('stylepath',     $this->baseurl . 'themes/' . $theme . '/style');

        $this->assign('scriptpath',    $this->baseurl . 'themes/' . $theme . '/javascript');

        $this->assign('imagepath',     $this->baseurl . 'themes/' . $theme . '/images');

        $this->assign('imagelangpath', $this->baseurl . 'themes/' . $theme . '/images/' . $this->language);

    }

 

    /**

     function getInstance($module = null, $caching = null, $cache_id = null, $add_core_data = false)

    {

        /**

        * static variable to hold the instance of this object when called in a singleton pattern

        */

        static $instance;

        if (!isset($instance)) {

            $instance = new pnRender($module, $caching);

        }

        if (!is_null($caching)) {

            $instance->caching = $caching;

        }

        if (!is_null($cache_id)) {

            $instance->cache_id = $cache_id;

        }

        if ($module === null) {

            $module = $instance->toplevelmodule;

        }

        if (!array_key_exists($module, $instance->module)) {

            $instance->module[$module] = pnModGetInfo(pnModGetIDFromName($module));

            //$instance->modinfo = pnModGetInfo(pnModGetIDFromName($module));

            $instance->_add_plugins_dir($module);

        }

        if ($add_core_data) {

            $instance->add_core_data();

        }

        return $instance;

    }

 

    /**

    function template_exists($template)

    {

        return (bool)$this->get_template_path($template);

    }

 

    /**

    function get_template_path($template)

    {

        static $cache = array();

 

        if (isset($cache[$template])) {

            return $cache[$template];

        }

 

        // the current module

        $pnmodgetname = pnModGetName();

        

        foreach ($this->module as $module => $modinfo) {

            // prepare the values for OS

            $os_pnmodgetname = DataUtil::formatForOS($pnmodgetname);

            $os_module       = DataUtil::formatForOS($module);

            $os_modpath      = DataUtil::formatForOS($modinfo['directory']);

            $os_theme        = DataUtil::formatForOS($this->theme);

    

            // Define the locations in which we will look for templates

            // (in this order)

            // Note: Paths 1, 3, 5 and 7 - This allows for the hook or block functions

            // (such as ratings and comments) to use different templates depending

            // on the top level module. e.g. the comments dialog can be different

            // for news  and polls...

            // They are only evaluated when the calling module is not the current one.

            //

            // 1. The top level module directory in the requested module folder

            // in the theme directory.

            $themehookpath = "themes/$os_theme/templates/modules/$os_module/$os_pnmodgetname";

            // 2. The module directory in the current theme.

            $themepath = "themes/$os_theme/templates/modules/$os_module";

            // 3. The global template directory for the current top level module

            $globalhookpath = "config/templates/$os_module/$os_pnmodgetname";

            // 4. The global template directory

            $globalpath = "config/templates/$os_module";

            // 5. The top level module directory in the requested module folder

            // in the modules sub folder.

            $modhookpath = "modules/$os_module/pntemplates/$os_pnmodgetname";

            // 6. The module directory in the modules sub folder.

            $modpath = "modules/$os_module/pntemplates";

            // 7. The top level module directory in the requested module folder

            // in the system sub folder.

            $syshookpath = "system/$os_module/pntemplates/$os_pnmodgetname";

            // 8. The module directory in the system sub folder.

            $syspath = "system/$os_module/pntemplates";

    

            $ostemplate = DataUtil::formatForOS($template); //.'.htm';

    

            // check the module for which we're looking for a template is the

            // same as the top level mods. This limits the places to look for

            // templates.

            if ($module == $pnmodgetname) {

                $search_path = array($themepath,

                                     $globalpath,

                                     $modpath,

                                     $syspath);

            } else {

                $search_path = array($themehookpath,

                                     $themepath,

                                     $globalhookpath,

                                     $globalpath,

                                     $modhookpath,

                                     $modpath,

                                     $syshookpath,

                                     $syspath);

            }

    

            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;

    }

 

    /**

    function fetch($template, $cache_id=null, $compile_id=null, $display = false, $reset = true)

    {

        $this->_setup_template($template);

 

        if (!is_null($cache_id)) {

            $cache_id = $this->baseurl . '|' . $this->toplevelmodule . '|' . $cache_id;

        } else {

            $cache_id = $this->baseurl . '|' . $this->toplevelmodule . '|' . $this->cache_id;

        }

 

        $output = parent::fetch($template, $cache_id, $compile_id, $display);

 

        if ($this->expose_template == true) {

            $template = DataUtil::formatForDisplay($template);

            $output = "\n<!-- Start ".$this->template_dir."/$template -->\n"

                      . $output

                      . "\n<!-- End ".$this->template_dir."/$template -->\n";

        }

 

        // now we've got our output from this module reset our instance

        if ($reset) {

        }

 

        return $output;

    }

 

    /**

    function display($template, $cache_id=null, $compile_id=null)

    {

        echo $this->fetch($template, $cache_id, $compile_id);

    }

 

    /**

    function is_cached($template, $cache_id=null, $compile_id=null)

    {

        // insert the condition to check the cache here!

        // if (functioncheckdb($this -> module)) {

        //        return parent :: clear_cache($template, $this -> cache_id);

        //}

        $this->_setup_template($template);

 

        if ($cache_id) {

            $cache_id = $this->baseurl . '|' . $this->toplevelmodule . '|' . $cache_id;

        } else {

            $cache_id = $this->baseurl . '|' . $this->toplevelmodule . '|' . $this->cache_id;

        }

 

        if (!isset($compile_id)) {

            $compile_id = $this->compile_id;

        }

 

        return parent::is_cached($template, $cache_id, $compile_id);

    }

 

    /**

    function clear_cache($template=null, $cache_id=null, $compile_id=null, $expire=null)

    {

        if ($cache_id) {

            $cache_id = $this->baseurl . '|' . $this->toplevelmodule . '|' . $cache_id;

        } else {

            $cache_id = $this->baseurl . '|' . $this->toplevelmodule . '|' . $this->cache_id;

        }

 

        return parent::clear_cache($template, $cache_id, $compile_id, $expire);

    }

 

    /**

    function clear_all_cache($exp_time = null)

    {

        $res = parent::clear_cache(null, null, null, $exp_time);

        // recreate index.html file

        fclose(fopen($this->cache_dir . '/index.html', 'w'));

        return $res;

    }

 

    /**

    function _setup_template($template)

    {

        // default directory for templates

        $this->template_dir = $this->get_template_path($template);

        //echo $this->template_dir . '<br>';

        $this->config_dir   = $this->template_dir . '/config';

    }

 

    /**

    function _add_plugins_dir($module)

    {

        $modinfo = pnModGetInfo(pnModGetIDFromName($module));

        $modpath = ($modinfo['type'] == 3) ? 'system' : 'modules';

        $mod_plugs = "$modpath/$modinfo[directory]/pntemplates/plugins";

        if (file_exists($mod_plugs)) {

            array_push($this->plugins_dir, $mod_plugs);

        }

    }

 

    /**

    function add_core_data()

    {

        $pncore = array();

        $pncore['version_num'] = PN_VERSION_NUM;

        $pncore['version_id'] = PN_VERSION_ID;

        $pncore['version_sub'] = PN_VERSION_SUB;

        $pncore['logged_in'] = pnUserLoggedIn();

        $pncore['language'] = $this->language;

        $pncore['themeinfo'] = $this->themeinfo;

 

        // add userdata

        $pncore['user'] = pnUserGetVars(SessionUtil::getVar('uid'));

 

        // add modvars of current modules

        foreach ($this->module as $module => $dummy) {

            $pncore[$module] = pnModGetVar($module);

        }

 

        // add mod vars of all modules supplied as parameter

        $modulenames = func_get_args();

        foreach ($modulenames as $modulename) {

            // if the modulename is empty do nothing

            if (!empty($modulename) && !is_array($modulename) && !array_key_exists($modulename, $this->module)) {

                // check if user wants to have /PNConfig

                if ($modulename==PN_CONFIG_MODULE) {

                    $pnconfig = pnModGetVar(PN_CONFIG_MODULE);

                    foreach($pnconfig as $key => $value) {

                        // gather all config vars

                        $pncore['pnconfig'][$key] = $value;

                    }

                } else {

                    $pncore[$modulename] = pnModGetVar($modulename);

                }

            }

        }

 

        // Module vars

        $this->assign('pncore', $pncore);

        return true;

    }

 

    return $content;

 

    // determine the template path and store the template source

    // in $tpl_source

 

    // get path, checks also if tpl_name file_exists and is_readable

    $tpl_path = $smarty->get_template_path($tpl_name);

 

    if ($tpl_path !== false) {

        $tpl_source = file_get_contents(DataUtil::formatForOS($tpl_path . '/' . $tpl_name));

        if ($tpl_source !== false ) {

            return true;

        }

    }

    LogUtil::registerError(pnML('_TEMPLATENOTAVAILABLE', array('m' => $smarty->module, 't' => $tpl_name), true));

    return false;

 

    // get the timestamp of the last change of the $tpl_name file

 

    // get path, checks also if tpl_name file_exists and is_readable

    $tpl_path = $smarty->get_template_path($tpl_name);

 

    if ($tpl_path !== false) {

        $tpl_timestamp = filemtime(DataUtil::formatForOS($tpl_path . '/' . $tpl_name));

        if ($tpl_timestamp !== false) {

            return true;

        }

    }

    return false;

 

    // assume all templates are secure

    return true;

 

    // not used for templates

    return;