IT.php

Go to the documentation of this file.

<?php
//
// +----------------------------------------------------------------------+
// | Copyright (c) 1997-2005 Ulf Wendel, Pierre-Alain Joye                |
// +----------------------------------------------------------------------+
// | This source file is subject to the New BSD license, That is bundled  |
// | with this package in the file LICENSE, and is available through      |
// | the world-wide-web at                                                |
// | http://www.opensource.org/licenses/bsd-license.php                   |
// | If you did not receive a copy of the new BSDlicense and are unable   |
// | to obtain it through the world-wide-web, please send a note to       |
// | pajoye@php.net so we can mail you a copy immediately.                |
// +----------------------------------------------------------------------+
// | Author: Ulf Wendel <ulf.wendel@phpdoc.de>                            |
// |         Pierre-Alain Joye <pajoye@php.net>                           |
// +----------------------------------------------------------------------+
//
// $Id: IT.php,v 1.20 2006/08/17 15:47:22 dsp Exp $
//

include_once("./Services/UICore/lib/html-it/exceptions/class.ilTemplateException.php");

define('IT_OK', 1);
define('IT_ERROR', -1);
define('IT_TPL_NOT_FOUND', -2);
define('IT_BLOCK_NOT_FOUND', -3);
define('IT_BLOCK_DUPLICATE', -4);
define('IT_UNKNOWN_OPTION', -6);
class HTML_Template_IT
{
    public $err = array();

    public $clearCache = false;

    public $openingDelimiter = '{';

    public $closingDelimiter = '}';

    public $blocknameRegExp = '[\.0-9A-Za-z_-]+';

    public $variablenameRegExp = '[\.0-9A-Za-z_-]+';

    public $variablesRegExp = '';

    public $removeVariablesRegExp = '';

    public $removeUnknownVariables = true;

    public $removeEmptyBlocks = true;

    public $blockRegExp = '';

    public $currentBlock = '__global__';

    public $template = '';

    public $blocklist = array();

    public $blockdata = array();

    public $blockvariables = array();

    public $blockparents = array();

    public $blockinner = array();

    public $touchedBlocks = array();

    public $_hiddenBlocks = array();

    public $variableCache = array();

    public $clearCacheOnParse = false;

    public $fileRoot = '';

    public $flagBlocktrouble = false;

    public $flagGlobalParsed = false;

    public $flagCacheTemplatefile = true;

    public $lastTemplatefile = '';

    public $_options = array(
        'preserve_data' => false,
        'use_preg' => true
    );

    public function __construct($root = '', $options = null)
    {
        if (!is_null($options)) {
            $this->setOptions($options);
        }
        $this->variablesRegExp = '@' . $this->openingDelimiter .
                                 '(' . $this->variablenameRegExp . ')' .
                                 $this->closingDelimiter . '@sm';
        $this->removeVariablesRegExp = '@' . $this->openingDelimiter .
                                       "\s*(" . $this->variablenameRegExp .
                                       ")\s*" . $this->closingDelimiter . '@sm';

        $this->blockRegExp = '@<!--\s+BEGIN\s+(' . $this->blocknameRegExp .
                             ')\s+-->(.*)<!--\s+END\s+\1\s+-->@sm';

        $this->setRoot($root);
    } // end constructor


    public function setOption($option, $value)
    {
        if (array_key_exists($option, $this->_options)) {
            $this->_options[$option] = $value;
            return IT_OK;
        }
        throw (new ilTemplateException($this->errorMessage(IT_UNKNOWN_OPTION) . ": '{$option}'"));
    }

    public function setOptions($options)
    {
        if (is_array($options)) {
            foreach ($options as $option => $value) {
                $error = $this->setOption($option, $value);
            }
        }

        return IT_OK;
    }

    public function show($block = '__global__')
    {
        print $this->get($block);
    } // end func show

    public function get($block = '__global__')
    {
        if ($block == '__global__' && !$this->flagGlobalParsed) {
            $this->parse('__global__');
        }

        if (!isset($this->blocklist[$block])) {
            throw (new ilTemplateException($this->errorMessage(IT_BLOCK_NOT_FOUND) .
                '"' . $block . "'"));
        }

        if (isset($this->blockdata[$block])) {
            $ret = $this->blockdata[$block];
            if ($this->clearCache) {
                unset($this->blockdata[$block]);
            }
            if ($this->_options['preserve_data']) {
                $ret = str_replace(
                    $this->openingDelimiter .
                        '%preserved%' . $this->closingDelimiter,
                    $this->openingDelimiter,
                    $ret
                    );
            }
            return $ret;
        }

        return '';
    } // end func get()

    public function parse($block = '__global__', $flag_recursion = false)
    {
        static $regs, $values;

        if (!isset($this->blocklist[$block])) {
            throw (new ilTemplateException($this->errorMessage(IT_BLOCK_NOT_FOUND) .
                '"' . $block . "'"));
        }

        if ($block == '__global__') {
            $this->flagGlobalParsed = true;
        }

        if (!$flag_recursion) {
            $regs = array();
            $values = array();
        }
        $outer = $this->blocklist[$block];
        $empty = true;

        if ($this->clearCacheOnParse) {
            foreach ($this->variableCache as $name => $value) {
                $regs[] = $this->openingDelimiter .
                          $name . $this->closingDelimiter;
                $values[] = $value;
                $empty = false;
            }
            $this->variableCache = array();
        } else {
            foreach ($this->blockvariables[$block] as $allowedvar => $v) {
                if (isset($this->variableCache[$allowedvar])) {
                    $regs[] = $this->openingDelimiter .
                               $allowedvar . $this->closingDelimiter;
                    $values[] = $this->variableCache[$allowedvar];
                    unset($this->variableCache[$allowedvar]);
                    $empty = false;
                }
            }
        }

        if (isset($this->blockinner[$block])) {
            foreach ($this->blockinner[$block] as $k => $innerblock) {
                $this->parse($innerblock, true);
                if ($this->blockdata[$innerblock] != '') {
                    $empty = false;
                }

                $placeholder = $this->openingDelimiter . "__" .
                                $innerblock . "__" . $this->closingDelimiter;
                $outer = str_replace(
                    $placeholder,
                    $this->blockdata[$innerblock],
                    $outer
                        );
                $this->blockdata[$innerblock] = "";
            }
        }

        if (!$flag_recursion && 0 != count($values)) {
            if ($this->_options['use_preg']) {
                $regs = array_map(
                    array(
                                    &$this, '_addPregDelimiters'),
                    $regs
                                );
                $funcReplace = 'preg_replace';
            } else {
                $funcReplace = 'str_replace';
            }

            if ($this->_options['preserve_data']) {
                $values = array_map(
                    array(&$this, '_preserveOpeningDelimiter'),
                    $values
                        );
            }

            $outer = $funcReplace($regs, $values, $outer);

            if ($this->removeUnknownVariables) {
                $outer = preg_replace($this->removeVariablesRegExp, "", $outer);
            }
        }

        if ($empty) {
            if (!$this->removeEmptyBlocks) {
                $this->blockdata[$block ] .= $outer;
            } else {
                if (isset($this->touchedBlocks[$block])) {
                    $this->blockdata[$block] .= $outer;
                    unset($this->touchedBlocks[$block]);
                }
            }
        } else {
            if (empty($this->blockdata[$block])) {
                $this->blockdata[$block] = $outer;
            } else {
                $this->blockdata[$block] .= $outer;
            }
        }

        return $empty;
    } // end func parse

    public function parseCurrentBlock()
    {
        return $this->parse($this->currentBlock);
    } // end func parseCurrentBlock

    public function setVariable($variable, $value = '')
    {
        if (is_array($variable)) {
            $this->variableCache = array_merge(
                $this->variableCache,
                $variable
                                    );
        } else {
            $this->variableCache[$variable] = $value;
        }
    } // end func setVariable

    public function setCurrentBlock($block = '__global__')
    {
        if (!isset($this->blocklist[$block])) {
            throw (new ilTemplateException($this->errorMessage(IT_BLOCK_NOT_FOUND) .
                '"' . $block . "'"));
        }

        $this->currentBlock = $block;

        return true;
    } // end func setCurrentBlock

    public function touchBlock($block)
    {
        if (!isset($this->blocklist[$block])) {
            throw (new ilTemplateException($this->errorMessage(IT_BLOCK_NOT_FOUND) .
                '"' . $block . "'"));
        }

        $this->touchedBlocks[$block] = true;

        return true;
    } // end func touchBlock

    protected function init()
    {
        $this->free();
        require_once('./Services/GlobalCache/classes/class.ilGlobalCache.php');
        $blocks = ilGlobalCache::getInstance(ilGlobalCache::COMP_TPL_BLOCKS);

        if ($blockdata = $blocks->get($this->real_filename)) {
            $this->blockdata = $blockdata['blockdata'];
            $this->blocklist = $blockdata['blocklist'];
        } else {
            ilGlobalCache::log('have to build blocks...', ilGlobalCacheSettings::LOG_LEVEL_FORCED);
            $this->findBlocks($this->template);
            $blockdata['blockdata'] = $this->blockdata;
            $blockdata['blocklist'] = $this->blocklist;
            $blocks->set($this->real_filename, $blockdata, 60);
        }

        // we don't need it any more
        $this->template = '';

        $variables = ilGlobalCache::getInstance(ilGlobalCache::COMP_TPL_VARIABLES);
        if ($blockvariables = $variables->get($this->real_filename)) {
            $this->blockvariables = $blockvariables;
        } else {
            $this->buildBlockvariablelist();
            $variables->set($this->real_filename, $this->blockvariables, 60);
        }
    } // end func init

    public function free()
    {
        $this->err = array();

        $this->currentBlock = '__global__';

        $this->variableCache = array();
        $this->blocklist = array();
        $this->touchedBlocks = array();

        $this->flagBlocktrouble = false;
        $this->flagGlobalParsed = false;
    } // end func free

    public function setTemplate(
        $template,
        $removeUnknownVariables = true,
        $removeEmptyBlocks = true
    ) {
        $this->removeUnknownVariables = $removeUnknownVariables;
        $this->removeEmptyBlocks = $removeEmptyBlocks;

        if ($template == '' && $this->flagCacheTemplatefile) {
            $this->variableCache = array();
            $this->blockdata = array();
            $this->touchedBlocks = array();
            $this->currentBlock = '__global__';
        } else {
            $this->template = '<!-- BEGIN __global__ -->' . $template .
                              '<!-- END __global__ -->';
            $this->init();
        }

        if ($this->flagBlocktrouble) {
            return false;
        }

        return true;
    } // end func setTemplate

    public function loadTemplatefile(
        $filename,
        $removeUnknownVariables = true,
        $removeEmptyBlocks = true
    ) {
        $template = '';
        if (!$this->flagCacheTemplatefile ||
            $this->lastTemplatefile != $filename
        ) {
            $template = $this->getFile($filename);
        }
        $this->lastTemplatefile = $filename;

        return $template != '' ?
                $this->setTemplate(
                    $template,
                    $removeUnknownVariables,
                    $removeEmptyBlocks
                    ) : false;
    } // end func LoadTemplatefile

    public function setRoot($root)
    {
        if ($root != '' && substr($root, -1) != '/') {
            $root .= '/';
        }

        $this->fileRoot = $root;
    } // end func setRoot

    public function buildBlockvariablelist()
    {
        foreach ($this->blocklist as $name => $content) {
            preg_match_all($this->variablesRegExp, $content, $regs);

            if (count($regs[1]) != 0) {
                foreach ($regs[1] as $k => $var) {
                    $this->blockvariables[$name][$var] = true;
                }
            } else {
                $this->blockvariables[$name] = array();
            }
        }
    } // end func buildBlockvariablelist

    public function getGlobalvariables()
    {
        $regs = array();
        $values = array();

        foreach ($this->blockvariables['__global__'] as $allowedvar => $v) {
            if (isset($this->variableCache[$allowedvar])) {
                $regs[] = '@' . $this->openingDelimiter .
                            $allowedvar . $this->closingDelimiter . '@';
                $values[] = $this->variableCache[$allowedvar];
                unset($this->variableCache[$allowedvar]);
            }
        }

        return array($regs, $values);
    } // end func getGlobalvariables

    public function findBlocks($string)
    {
        $blocklist = array();
        if (preg_match_all($this->blockRegExp, $string, $regs, PREG_SET_ORDER)) {
            foreach ($regs as $k => $match) {
                $blockname = $match[1];
                $blockcontent = $match[2];

                if (isset($this->blocklist[$blockname])) {
                    throw (new ilTemplateException($this->errorMessage(
                        IT_BLOCK_DUPLICATE,
                        $blockname
                    )));
                }

                $this->blocklist[$blockname] = $blockcontent;
                $this->blockdata[$blockname] = "";

                $blocklist[] = $blockname;

                $inner = $this->findBlocks($blockcontent);
                foreach ($inner as $k => $name) {
                    $pattern = sprintf(
                        '@<!--\s+BEGIN\s+%s\s+-->(.*)<!--\s+END\s+%s\s+-->@sm',
                        $name,
                        $name
                    );

                    $this->blocklist[$blockname] = preg_replace(
                        $pattern,
                        $this->openingDelimiter .
                                        '__' . $name . '__' .
                                        $this->closingDelimiter,
                        $this->blocklist[$blockname]
                               );
                    $this->blockinner[$blockname][] = $name;
                    $this->blockparents[$name] = $blockname;
                }
            }
        }

        return $blocklist;
    } // end func findBlocks

    public function getFile($filename)
    {
        if ($filename[0] == '/' && substr($this->fileRoot, -1) == '/') {
            $filename = substr($filename, 1);
        }

        $filename = $this->fileRoot . $filename;

        require_once('./Services/GlobalCache/classes/class.ilGlobalCache.php');
        $this->real_filename = $filename;
        $ilGlobalCache = ilGlobalCache::getInstance(ilGlobalCache::COMP_TEMPLATE);
        if (!$content = $ilGlobalCache->get($filename)) {
            if (!($fh = @fopen($filename, 'r'))) {
                throw (new ilTemplateException($this->errorMessage(IT_TPL_NOT_FOUND) .
                    ': "' . $filename . '"'));
            }

            $fsize = filesize($filename);
            if ($fsize < 1) {
                fclose($fh);
                return '';
            }

            $content = fread($fh, $fsize);
            $ilGlobalCache->set($filename, $content, 60);
            fclose($fh);
        }


        /* performance patch, 6.4.2017
        return preg_replace_callback(
            "#<!-- INCLUDE (.*) -->#im",
            function ($hit) {
                return $this->getFile($hit[1]);
            },
            $content
        );*/

        return $content;
    } // end func getFile

    public function _addPregDelimiters($str)
    {
        return '@' . $str . '@';
    }

    public function _preserveOpeningDelimiter($str)
    {
        return (false === strpos($str, $this->openingDelimiter))?
                $str:
                str_replace(
                    $this->openingDelimiter,
                    $this->openingDelimiter .
                    '%preserved%' . $this->closingDelimiter,
                    $str
                );
    }

    public function errorMessage($value, $blockname = '')
    {
        static $errorMessages;
        if (!isset($errorMessages)) {
            $errorMessages = array(
                IT_OK => '',
                IT_ERROR => 'unknown error',
                IT_TPL_NOT_FOUND => 'Cannot read the template file',
                IT_BLOCK_NOT_FOUND => 'Cannot find this block',
                IT_BLOCK_DUPLICATE => 'The name of a block must be' .
                                               ' uniquewithin a template.' .
                                               ' Found "' . $blockname . '" twice.' .
                                               'Unpredictable results ' .
                                               'may appear.',
                IT_UNKNOWN_OPTION => 'Unknown option'
            );
        }

        return isset($errorMessages[$value]) ?
                $errorMessages[$value] : $errorMessages[IT_ERROR];
    }
} // end class IntegratedTemplate