<?php

// When developing uncomment the line below, re-comment before making public
//error_reporting(E_ALL);

/**
 * XTemplate PHP templating engine
 *
 * @package XTemplate
 * @author Barnabas Debreceni [cranx@users.sourceforge.net]
 * @copyright Barnabas Debreceni 2000-2001
 * @author Jeremy Coates [cocomp@users.sourceforge.net]
 * @copyright Jeremy Coates 2002-2007
 * @see license.txt LGPL / BSD license
 * @since PHP 5
 * @link $HeadURL: https://xtpl.svn.sourceforge.net/svnroot/xtpl/trunk/xtemplate.class.php $
 * @version $Id: xtemplate.class.php 24 2007-08-16 20:00:18Z cocomp $
 *
 *
 * XTemplate class - http://www.phpxtemplate.org/ (x)html / xml generation with templates - fast & easy
 * Latest stable & Subversion versions available @ http://sourceforge.net/projects/xtpl/
 * License: LGPL / BSD - see license.txt
 * Changelog: see changelog.txt
 */
class XTemplate {

    /**
     * Properties
     */

    /**
     * Raw contents of the template file
     *
     * @access public
     * @var string
     */
    public $filecontents = '';

    /**
     * Unparsed blocks
     *
     * @access public
     * @var array
     */
    public $blocks = array();

    /**
     * Parsed blocks
     *
     * @var unknown_type
     */
    public $parsed_blocks = array();

    /**
     * Preparsed blocks (for file includes)
     *
     * @access public
     * @var array
     */
    public $preparsed_blocks = array();

    /**
     * Block parsing order for recursive parsing
     * (Sometimes reverse :)
     *
     * @access public
     * @var array
     */
    public $block_parse_order = array();

    /**
     * Store sub-block names
     * (For fast resetting)
     *
     * @access public
     * @var array
     */
    public $sub_blocks = array();

    /**
     * Variables array
     *
     * @access public
     * @var array
     */
    public $vars = array();

    /**
     * File variables array
     *
     * @access public
     * @var array
     */
    public $filevars = array();

    /**
     * Filevars' parent block
     *
     * @access public
     * @var array
     */
    public $filevar_parent = array();

    /**
     * File caching during duration of script
     * e.g. files only cached to speed {FILE "filename"} repeats
     *
     * @access public
     * @var array
     */
    public $filecache = array();

    /**
     * Location of template files
     *
     * @access public
     * @var string
     */
    public $tpldir = '';

    /**
     * Filenames lookup table
     *
     * @access public
     * @var null
     */
    public $files = null;

    /**
     * Template filename
     *
     * @access public
     * @var string
     */
    public $filename = '';

    /**
     * Delimiter character used for preg_* function calls
     *
     * @access public
     * @var string
     */
    public $preg_delimiter = '`';

    // moved to setup method so uses the tag_start & end_delims
    /**
     * RegEx for file includes
     *
     * "/\{FILE\s*\"([^\"]+)\"\s*\}/m";
     *
     * @access public
     * @var string
     */
    public $file_delim = '';

    /**
     * RegEx for file include variable
     *
     * "/\{FILE\s*\{([A-Za-z0-9\._\x7f-\xff]+?)\}\s*\}/m";
     *
     * @access public
     * @var string
     */
    public $filevar_delim = '';

    /**
     * RegEx for file includes with newlines
     *
     * "/^\s*\{FILE\s*\{([A-Za-z0-9\._\x7f-\xff]+?)\}\s*\}\s*\n/m";
     *
     * @access public
     * @var string
     */
    public $filevar_delim_nl = '';

    /**
     * Template block start delimiter
     *
     * @access public
     * @var string
     */
    public $block_start_delim = '<!-- ';

    /**
     * Template block end delimiter
     *
     * @access public
     * @var string
     */
    public $block_end_delim = '-->';

    /**
     * Template block start word
     *
     * @access public
     * @var string
     */
    public $block_start_word = 'BEGIN:';

    /**
     * Template block end word
     *
     * The last 3 properties and this make the delimiters look like:
     * @example <!-- BEGIN: block_name -->
     * if you use the default syntax.
     *
     * @access public
     * @var string
     */
    public $block_end_word = 'END:';

    /**
     * Template tag start delimiter
     *
     * This makes the delimiters look like:
     * @example {tagname}
     * if you use the default syntax.
     *
     * @access public
     * @var string
     */
    public $tag_start_delim = '{';

    /**
     * Template tag end delimiter
     *
     * This makes the delimiters look like:
     * @example {tagname}
     * if you use the default syntax.
     *
     * @access public
     * @var string
     */
    public $tag_end_delim = '}';

    /**
     * Delimeter character for comments withing tags and blocks
     * Should also be in XTemplate::$comment_preg
     *
     * @var string
     */
    public $comment_delim = '#';

    /**
     * Regular expression element for comments within tags and blocks
     *
     * @example {tagname#My Comment}
     * @example {tagname #My Comment}
     * @example <!-- BEGIN: blockname#My Comment -->
     * @example <!-- BEGIN: blockname #My Comment -->
     *
     * @access public
     * @var string
     */
    public $comment_preg = '( ?#.*?)?';

    /**
     * Delimiter character for callbacks within tags
     * Should also be in XTemplate::$callback_preg
     *
     * @var string
     */
    public $callback_delim = '|';

    /**
     * Regular expression elements for callback functions within tags
     *
     * @example {tagname|my_callback_func(true, %s)} - tagname contents passed at %s point
     * @example {tagname|my_callback_func} - tagname contents passed as single argument
     * @example {tagname|first_callback|second_callback('#value', true, %s)|third_callback #Comment}
     *
     * @access public
     * @var string
     */
    public $callback_preg = '(\|[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*(\(.*?%s.*?\))?)*';

    /**
     * Whether to enable callback feature or not
     *
     * @access public
     * @var boolean
     */
    public $allow_callbacks = true;

    /**
     * Allowed callback functions
     *
     * Small security limiter - stops everything being available
     * For reference, all methods in sub-classes are available, this only applies to function calls
     *
     * @access public
     * @var array
     */
    public $allowed_callbacks = array(
    // Simple string modifiers
    'strtoupper', 'strtolower', 'ucwords', 'ucfirst', 'strrev', 'str_word_count', 'strlen',
    // String replacement modifiers
    'str_replace', 'str_ireplace', 'preg_replace', 'strip_tags', 'stripcslashes', 'stripslashes',
    'str_pad', 'str_repeat', 'strtr', 'trim', 'ltrim', 'rtrim', 'nl2br', 'wordwrap', 'printf', 'sprintf',
    // Encoding / decoding modifiers
    'htmlentities', 'html_entity_decode', 'htmlspecialchars', 'htmlspecialchars_decode',
    'urlencode', 'urldecode',
    // Date / time modifiers
    'date', 'idate', 'strtotime', 'strftime', 'getdate', 'gettimeofday',
    // Number modifiers
    'number_format', 'money_format',
    // Miscellaneous modifiers
    'var_dump', 'print_r'
    );

    /**
     * Default main template block name
     *
     * @access public
     * @var string
     */
    public $mainblock = 'main';

    /**
     * Script output type
     *
     * @access public
     * @var string
     */
    public $output_type = 'HTML';

    /**
     * Debug mode
     *
     * @access public
     * @var boolean
     */
    public $debug = false;

    /**
     * Null string for unassigned vars
     *
     * @access protected
     * @var array
     */
    protected $_null_string = array('' => '');

    /**
     * Null string for unassigned blocks
     *
     * @access protected
     * @var array
     */
    protected $_null_block = array('' => '');

    /**
     * Errors
     *
     * @access protected
     * @var string
     */
    protected $_error = '';

    /**
     * Auto-reset sub blocks
     *
     * @access protected
     * @var boolean
     */
    protected $_autoreset = true;

    /**
     * Set to FALSE to generate errors if a non-existant blocks is referenced
     *
     * @author NW
     * @since 2002/10/17
     * @access protected
     * @var boolean
     */
    protected $_ignore_missing_blocks = true;

    /**
     * PHP 5 Constructor - Instantiate the object
     *
     * @param string $file Template file to work on
     * @param string/array $tpldir Location of template files (useful for keeping files outside web server root)
     * @param array $files Filenames lookup
     * @param string $mainblock Name of main block in the template
     * @param boolean $autosetup If true, run setup() as part of constuctor
     * @return XTemplate
     */
    public function __construct($file, $tpldir = '', $files = null, $mainblock = 'main', $autosetup = true) {

        $this->restart($file, $tpldir, $files, $mainblock, $autosetup, $this->tag_start_delim, $this->tag_end_delim);
    }


    /***************************************************************************/
    /***[ public stuff ]********************************************************/
    /***************************************************************************/

    /**
     * Restart the class - allows one instantiation with several files processed by restarting
     * e.g. $xtpl = new XTemplate('file1.xtpl');
     * $xtpl->parse('main');
     * $xtpl->out('main');
     * $xtpl->restart('file2.xtpl');
     * $xtpl->parse('main');
     * $xtpl->out('main');
     * (Added in response to sf:641407 feature request)
     *
     * @param string $file Template file to work on
     * @param string/array $tpldir Location of template files
     * @param array $files Filenames lookup
     * @param string $mainblock Name of main block in the template
     * @param boolean $autosetup If true, run setup() as part of restarting
     * @param string $tag_start {
     * @param string $tag_end }
     */
    public function restart ($file, $tpldir = '', $files = null, $mainblock = 'main', $autosetup = true, $tag_start = '{', $tag_end = '}') {

        $this->filename = $file;

        // From SF Feature request 1202027
        // Kenneth Kalmer
        $this->tpldir = $tpldir;
        if (defined('XTPL_DIR') && empty($this->tpldir)) {
            $this->tpldir = XTPL_DIR;
        }

        if (is_array($files)) {
            $this->files = $files;
        }

        $this->mainblock = $mainblock;

        $this->tag_start_delim = $tag_start;
        $this->tag_end_delim = $tag_end;

        // Start with fresh file contents
        $this->filecontents = '';

        // Reset the template arrays
        $this->blocks = array();
        $this->parsed_blocks = array();
        $this->preparsed_blocks = array();
        $this->block_parse_order = array();
        $this->sub_blocks = array();
        $this->vars = array();
        $this->filevars = array();
        $this->filevar_parent = array();
        $this->filecache = array();

        if ($autosetup) {
            $this->setup();
        }
    }

    /**
     * setup - the elements that were previously in the constructor
     *
     * @access public
     * @param boolean $add_outer If true is passed when called, it adds an outer main block to the file
     */
    public function setup ($add_outer = false) {

        $this->tag_start_delim = preg_quote($this->tag_start_delim);
        $this->tag_end_delim = preg_quote($this->tag_end_delim);

        // Setup the file delimiters

        // regexp for file includes
        $this->file_delim = $this->preg_delimiter . $this->tag_start_delim . "FILE\s*\"([^\"]+)\"" . $this->comment_preg . $this->tag_end_delim . $this->preg_delimiter . 'm';

        // regexp for file includes
        $this->filevar_delim = $this->preg_delimiter . $this->tag_start_delim . "FILE\s*" . $this->tag_start_delim . "([A-Za-z0-9\._\x7f-\xff]+?)" . $this->comment_preg . $this->tag_end_delim . $this->comment_preg . $this->tag_end_delim . $this->preg_delimiter . 'm';

        // regexp for file includes w/ newlines
        $this->filevar_delim_nl = $this->preg_delimiter . "^\s*" . $this->tag_start_delim . "FILE\s*" . $this->tag_start_delim . "([A-Za-z0-9\._\x7f-\xff]+?)" . $this->comment_preg . $this->tag_end_delim . $this->comment_preg . $this->tag_end_delim . "\s*\n" . $this->preg_delimiter . 'm';

        if (empty($this->filecontents)) {
            // read in template file
            $this->filecontents = $this->_r_getfile($this->filename);
        }

        if ($add_outer) {
            $this->_add_outer_block();
        }

        // preprocess some stuff
        $this->blocks = $this->_maketree($this->filecontents, '');
        $this->filevar_parent = $this->_store_filevar_parents($this->blocks);
        $this->scan_globals();
    }

    /**
     * assign a variable
     *
     * @example Simplest case:
     * @example $xtpl->assign('name', 'value');
     * @example {name} in template
     *
     * @example Array assign:
     * @example $xtpl->assign(array('name' => 'value', 'name2' => 'value2'));
     * @example {name} {name2} in template
     *
     * @example Value as array assign:
     * @example $xtpl->assign('name', array('key' => 'value', 'key2' => 'value2'));
     * @example {name.key} {name.key2} in template
     *
     * @example Reset array:
     * @example $xtpl->assign('name', array('key' => 'value', 'key2' => 'value2'));
     * @example // Other code then:
     * @example $xtpl->assign('name', array('key3' => 'value3'), false);
     * @example {name.key} {name.key2} {name.key3} in template
     *
     * @access public
     * @param string $name Variable to assign $val to
     * @param string / array $val Value to assign to $name
     * @param boolean $reset_array Reset the variable array if $val is an array
     */
    public function assign ($name, $val = '', $reset_array = true) {

        if (is_array($name)) {

            foreach ($name as $k => $v) {

                $this->vars[$k] = $v;
            }
        } elseif (is_array($val)) {

            // Clear the existing values
            if ($reset_array) {
                $this->vars[$name] = array();
            }

            foreach ($val as $k => $v) {

                $this->vars[$name][$k] = $v;
            }

        } else {

            $this->vars[$name] = $val;
        }
    }

    /**
     * assign a file variable
     *
     * @access public
     * @param string $name Variable to assign $val to
     * @param string / array $val Values to assign to $name
     */
    public function assign_file ($name, $val = '') {

        if (is_array($name)) {

            foreach ($name as $k => $v) {

                $this->_assign_file_sub($k, $v);
            }
        } else {

            $this->_assign_file_sub($name, $val);
        }
    }

    /**
     * parse a block
     *
     * @access public
     * @param string $bname Block name to parse
     */
    public function parse ($bname) {

        if (isset($this->preparsed_blocks[$bname])) {

            $copy = $this->preparsed_blocks[$bname];

        } elseif (isset($this->blocks[$bname])) {

            $copy = $this->blocks[$bname];

        } elseif ($this->_ignore_missing_blocks) {
            // ------------------------------------------------------
            // NW : 17 Oct 2002. Added default of ignore_missing_blocks
            //      to allow for generalised processing where some
            //      blocks may be removed from the HTML without the
            //      processing code needing to be altered.
            // ------------------------------------------------------
            // JRC: 3/1/2003 added set error to ignore missing functionality
            $this->_set_error("parse: blockname [$bname] does not exist");
            return;

        } else {

            $this->_set_error("parse: blockname [$bname] does not exist");
        }

        /* from there we should have no more {FILE } directives */
        if (!isset($copy)) {
            die('Block: ' . $bname);
        }

        $copy = preg_replace($this->filevar_delim_nl, '', $copy);

        $var_array = array();

        /* find & replace variables+blocks */
        preg_match_all($this->preg_delimiter . $this->tag_start_delim . '([A-Za-z0-9\._\x7f-\xff]+?' . $this->callback_preg . $this->comment_preg . ')' . $this->tag_end_delim . $this->preg_delimiter, $copy, $var_array);

        $var_array = $var_array[1];

        foreach ($var_array as $k => $v) {

            // Are there any comments in the tags {tag#a comment for documenting the template}
            $comment = '';
            $any_comments = explode($this->comment_delim, $v);
            if (count($any_comments) > 1) {
                $comment = array_pop($any_comments);
            }
            $v = rtrim(implode($this->comment_delim, $any_comments));

            if ($this->allow_callbacks) {
                // Callback function modifiers {tag|callback}
                $callback_funcs = explode($this->callback_delim, $v);
                $v = rtrim($callback_funcs[0]);
                unset($callback_funcs[0]);
            }

            $sub = explode('.', $v);

            if ($sub[0] == '_BLOCK_') {
                // BLOCKS

                unset($sub[0]);

                $bname2 = implode('.', $sub);

                // trinary operator eliminates assign error in E_ALL reporting
                $var = isset($this->parsed_blocks[$bname2]) ? $this->parsed_blocks[$bname2] : null;
                $nul = (!isset($this->_null_block[$bname2])) ? $this->_null_block[''] : $this->_null_block[$bname2];

                if ($var === '') {

                    if ($nul == '') {
                        // -----------------------------------------------------------
                        // Removed requirement for blocks to be at the start of string
                        // -----------------------------------------------------------
                        //                      $copy=preg_replace("/^\s*\{".$v."\}\s*\n*/m","",$copy);
                        // Now blocks don't need to be at the beginning of a line,
                        //$copy=preg_replace("/\s*" . $this->tag_start_delim . $v . $this->tag_end_delim . "\s*\n*/m","",$copy);
                        $copy = preg_replace($this->preg_delimiter . $this->tag_start_delim . $v . $this->tag_end_delim . $this->preg_delimiter . 'm', '', $copy);

                    } else {

                        $copy = preg_replace($this->preg_delimiter . $this->tag_start_delim . $v . $this->tag_end_delim . $this->preg_delimiter . 'm', "$nul", $copy);
                    }
                } else {

                    //$var = trim($var);
                    switch (true) {
                        case preg_match($this->preg_delimiter . "^\n" . $this->preg_delimiter, $var) && preg_match($this->preg_delimiter . "\n$" .$this->preg_delimiter, $var):
                            $var = substr($var, 1, -1);
                            break;

                        case preg_match($this->preg_delimiter . "^\n" . $this->preg_delimiter, $var):
                            $var = substr($var, 1);
                            break;

                        case preg_match($this->preg_delimiter . "\n$" . $this->preg_delimiter, $var):
                            $var = substr($var, 0, -1);
                            break;
                    }

                    // SF Bug no. 810773 - thanks anonymous
                    $var = str_replace('\\', '\\\\', $var);
                    // Ensure dollars in strings are not evaluated reported by SadGeezer 31/3/04
                    $var = str_replace('$', '\\$', $var);
                    // Replaced str_replaces with preg_quote
                    //$var = preg_quote($var);
                    $var = str_replace('\\|', '|', $var);
                    $copy = preg_replace($this->preg_delimiter . $this->tag_start_delim . $v . $this->tag_end_delim . $this->preg_delimiter . 'm', "$var", $copy);

                    if (preg_match($this->preg_delimiter . "^\n" . $this->preg_delimiter, $copy) && preg_match($this->preg_delimiter . "\n$" . $this->preg_delimiter, $copy)) {
                        $copy = substr($copy, 1, -1);
                    }
                }
            } else {
                // TAGS

                $var = $this->vars;

                foreach ($sub as $v1) {

                    // NW 4 Oct 2002 - Added isset and is_array check to avoid NOTICE messages
                    // JC 17 Oct 2002 - Changed EMPTY to strlen=0
                    //                if (empty($var[$v1])) { // this line would think that zeros(0) were empty - which is not true
                    if (!isset($var[$v1]) || (!is_array($var[$v1]) && strlen($var[$v1]) == 0)) {

                        // Check for constant, when variable not assigned
                        if (defined($v1)) {

                            $var[$v1] = constant($v1);

                        } else {

                            $var[$v1] = null;
                        }
                    }

                    $var = $var[$v1];
                }

                $nul = (!isset($this->_null_string[$v])) ? ($this->_null_string[""]) : ($this->_null_string[$v]);
                $var = (!isset($var)) ? $nul : $var;

                if ($var === '') {
                    $copy = preg_replace($this->preg_delimiter . $this->tag_start_delim . $v . $this->callback_preg . $this->comment_preg . $this->tag_end_delim . $this->preg_delimiter . 'm', '', $copy);
                }

                // Prevent cast to strings when arrays passed in
                if (is_string($var)) {
                    $var = trim($var);
                    // SF Bug no. 810773 - thanks anonymous
                    $var = str_replace('\\', '\\\\', $var);
                    // Ensure dollars in strings are not evaluated reported by SadGeezer 31/3/04
                    $var = str_replace('$', '\\$', $var);
                    // Replace str_replaces with preg_quote
                    //$var = preg_quote($var);
                    $var = str_replace('\\|', '|', $var);
                }

                /**
                 * Callback function handling
                 * Inspired by sf feature request #1756946 christophe_lu
                 *
                 * @author JRCoates (cocomp)
                 * @since 03/08/2007
                 */
                if (is_array($callback_funcs) && !empty($callback_funcs)) {
                    foreach ($callback_funcs as $callback) {
                        // See if we've got parameters being used e.g. |str_replace('A', 'B', %s)
                        if (preg_match($this->preg_delimiter . '\((.*%s.*)\)' . $this->preg_delimiter, $callback, $matches)) {
                            $parameters = explode(',', $matches[1]);
                            if (count($parameters) > 1) {
                                array_walk($parameters, array($this, 'trim_callback'));
                                $key = array_search('%s', $parameters);
                                $parameters[$key] = $var;
                            } else {
                                unset($parameters);
                            }
                        }

                        // Remove the parameters
                        $callback = preg_replace($this->preg_delimiter . '\(.*\)' . $this->preg_delimiter, '', $callback);

                        // Allow callback of methods in a sub-class of XTemplate
                        // e.g. you must my_class extends XTemplate {} if you want to use this feature
                        if (is_subclass_of($this, 'XTemplate') && method_exists($this, $callback) && is_callable(array($this, $callback))) {
                            if (isset($parameters)) {
                                $var = call_user_func_array(array($this, $callback), $parameters);
                                unset($parameters);
                            } else {
                                // Standard form e.g. {tag|callback}
                                $var = call_user_func(array($this, $callback), $var);
                            }
                        } elseif (in_array($callback, $this->allowed_callbacks) && function_exists($callback) && is_callable($callback)) {
                            if (isset($parameters)) {
                                $var = call_user_func_array($callback, $parameters);
                                unset($parameters);
                            } else {
                                // Standard form e.g. {tag|callback}
                                $var = call_user_func($callback, $var);
                            }
                        }
                    }

                    $copy = preg_replace($this->preg_delimiter . $this->tag_start_delim . $v . preg_quote($this->callback_delim . implode($this->callback_delim, $callback_funcs)) . '( )?(' . $this->comment_delim . ')?' . $comment . $this->tag_end_delim . $this->preg_delimiter . 'm', "$var", $copy);

                } else {

                    $copy = preg_replace($this->preg_delimiter . $this->tag_start_delim . $v . '( )?(' . $this->comment_delim . ')?' . $comment . $this->tag_end_delim . $this->preg_delimiter . 'm', "$var", $copy