supernova-ws / SuperNova

classes/template.php

<?php
/**
*
* @package phpBB3
* @version $Id$
* @copyright (c) 2005 phpBB Group, sections (c) 2001 ispi of Lincoln Inc
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
*
* Modified by Gorlum to work within http://supernova.ws
*
*/

/**
* @ignore
*/
if (!defined('INSIDE'))
{
  exit;
}

/**
* Base Template class.
* @package phpBB3
*/
class template
{
  /** variable that holds all the data we'll be substituting into
  * the compiled templates. Takes form:
  * --> $this->_tpldata[block][iteration#][child][iteration#][child2][iteration#][variablename] == value
  * if it's a root-level variable, it'll be like this:
  * --> $this->_tpldata[.][0][varname] == value
  */
  var $_tpldata = array('.' => array(0 => array()));
  var $_rootref;
//  var $_block_counter = array();
  var $_block_value = array();

  // Root dir and hash of filenames for each template handle.
  var $root = '';
  var $cachepath = '';
  var $files = array();
  var $filename = array();
  var $files_inherit = array();
  var $files_template = array();
  var $inherit_root = '';
  var $orig_tpl_storedb;
  var $orig_tpl_inherits_id;

  // this will hash handle names to the compiled/uncompiled code for that handle.
  var $compiled_code = array();

  /**
   * Is template already parsed with SN code?
   *
   * @var bool $parsed
   */
  var $parsed = false;

  /**
   * @var template_compile|null $compiler
   */
  var $compiler = null;

  /**
   * Physical root for template search
   *
   * @var string $rootPhysical
   */
  public $rootPhysical = '';

  /**
   * template constructor.
   *
   * @param string $rootPhysical - physical location of game root
   */
  public function __construct($rootPhysical = SN_ROOT_PHYSICAL) {
    $this->rootPhysical = $rootPhysical;
    $this->compiler = new template_compile($this);
  }

  /**
  * Set template location
  * @access public
  */
  function set_template()
  {
    global $user;

    if (file_exists($this->rootPhysical. 'styles/' . $user->theme['template_path'] . '/template'))
    {
      $this->root = $this->rootPhysical . 'styles/' . $user->theme['template_path'] . '/template';
      $this->cachepath = $this->rootPhysical . 'cache/tpl_' . str_replace('_', '-', $user->theme['template_path']) . '_';

      if ($this->orig_tpl_storedb === null)
      {
        $this->orig_tpl_storedb = $user->theme['template_storedb'];
      }

      if ($this->orig_tpl_inherits_id === null)
      {
        $this->orig_tpl_inherits_id = $user->theme['template_inherits_id'];
      }

      $user->theme['template_storedb'] = $this->orig_tpl_storedb;
      $user->theme['template_inherits_id'] = $this->orig_tpl_inherits_id;

      if ($user->theme['template_inherits_id'])
      {
        $this->inherit_root = $this->rootPhysical . 'styles/' . $user->theme['template_inherit_path'] . '/template';
      }
    }
    else
    {
      trigger_error('Template path could not be found: styles/' . $user->theme['template_path'] . '/template', E_USER_ERROR);
    }

    $this->_rootref = &$this->_tpldata['.'][0];

    return true;
  }

  /**
  * Set custom template location (able to use directory outside of phpBB)
  * @access public
  */
  function set_custom_template($template_path, $template_name, $fallback_template_path = false)
  {
    global $user;

    // Make sure $template_path has no ending slash
    if (substr($template_path, -1) == '/')
    {
      $template_path = substr($template_path, 0, -1);
    }

    $this->root = $template_path;
    $this->cachepath = $this->rootPhysical . 'cache/ctpl_' . str_replace('_', '-', $template_name) . '_';

    if ($fallback_template_path !== false)
    {
      if (substr($fallback_template_path, -1) == '/')
      {
        $fallback_template_path = substr($fallback_template_path, 0, -1);
      }

      $this->inherit_root = $fallback_template_path;
      $this->orig_tpl_inherits_id = true;
    }
    else
    {
      $this->orig_tpl_inherits_id = false;
    }

    // the database does not store the path or name of a custom template
    // so there is no way we can properly store custom templates there
    $this->orig_tpl_storedb = false;

    $this->_rootref = &$this->_tpldata['.'][0];

    return true;
  }

  /**
  * Sets the template filenames for handles. $filename_array
  * should be a hash of handle => filename pairs.
  * @access public
  */
  function set_filenames($filename_array)
  {
    if (!is_array($filename_array))
    {
      return false;
    }
    foreach ($filename_array as $handle => $filename)
    {
      if (empty($filename))
      {
        trigger_error("template->set_filenames: Empty filename specified for $handle", E_USER_ERROR);
      }

      $this->filename[$handle] = $filename;
      $this->files[$handle] = $this->root . '/' . $filename;

      if ($this->inherit_root)
      {
        $this->files_inherit[$handle] = $this->inherit_root . '/' . $filename;
      }
    }

    return true;
  }

  /**
  * Destroy template data set
  * @access public
  */
  function destroy()
  {
    $this->_tpldata = array('.' => array(0 => array()));
    $this->_rootref = &$this->_tpldata['.'][0];
  }

  /**
  * Reset/empty complete block
  * @access public
  */
  function destroy_block_vars($blockname)
  {
    if (strpos($blockname, '.') !== false)
    {
      // Nested block.
      $blocks = explode('.', $blockname);
      $blockcount = sizeof($blocks) - 1;

      $str = &$this->_tpldata;
      for ($i = 0; $i < $blockcount; $i++)
      {
        $str = &$str[$blocks[$i]];
        $str = &$str[sizeof($str) - 1];
      }

      unset($str[$blocks[$blockcount]]);
    }
    else
    {
      // Top-level block.
      unset($this->_tpldata[$blockname]);
    }

    return true;
  }

  /**
  * Display handle
  * @access public
  */
  function display($handle, $include_once = true)
  {
    if (defined('IN_ERROR_HANDLER'))
    {
      $is_enotice = error_reporting();
      if ((E_NOTICE & $is_enotice) == E_NOTICE)
      {
        error_reporting(error_reporting() ^ E_NOTICE);
      }
    }

    if ($filename = $this->_tpl_load($handle))
    {
      ($include_once) ? include_once($filename) : include($filename);
    }
    else
    {
      $this->evaluate($this->compiled_code[$handle]);
    }

    return true;
  }

  /**
  * Display the handle and assign the output to a template variable or return the compiled result.
  * @access public
  */
  function assign_display($handle, $template_var = '', $return_content = true, $include_once = false)
  {
    ob_start();
    $this->display($handle, $include_once);
    $contents = ob_get_clean();

    if ($return_content)
    {
      return $contents;
    }

    $this->assign_var($template_var, $contents);

    return true;
  }

  /**
  * Load a compiled template if possible, if not, recompile it
  * @access private
  */
  function _tpl_load(&$handle)
  {
    global $user, $config;

    if (!isset($this->filename[$handle]))
    {
      trigger_error("template->_tpl_load(): No file specified for handle $handle", E_USER_ERROR);
    }

    // reload these settings to have the values they had when this object was initialised
    // using set_template or set_custom_template, they might otherwise have been overwritten
    // by other template class instances in between.
    //$user->theme['template_storedb'] = $this->orig_tpl_storedb;
    //$user->theme['template_inherits_id'] = $this->orig_tpl_inherits_id;

    $filename = $this->cachepath . str_replace('/', '.', $this->filename[$handle]) . DOT_PHP_EX;
    //$this->files_template[$handle] = (isset($user->theme['template_id'])) ? $user->theme['template_id'] : 0;

    $recompile = false;
    if (!file_exists($filename) || @filesize($filename) === 0)
    {
      $recompile = true;
    }
    else if ($config->load_tplcompile)
    {
      // No way around it: we need to check inheritance here
      if ($user->theme['template_inherits_id'] && !file_exists($this->files[$handle]))
      {
        $this->files[$handle] = $this->files_inherit[$handle];
        $this->files_template[$handle] = $user->theme['template_inherits_id'];
      }
      $recompile = (@filemtime($filename) < filemtime($this->files[$handle])) ? true : false;
    }

    // Recompile page if the original template is newer, otherwise load the compiled version
    if (!$recompile)
    {
      return $filename;
    }

    global $db;

    // Inheritance - we point to another template file for this one. Equality is also used for store_db
    if (isset($user->theme['template_inherits_id']) && $user->theme['template_inherits_id'] && !file_exists($this->files[$handle]))
    {
      $this->files[$handle] = $this->files_inherit[$handle];
      $this->files_template[$handle] = $user->theme['template_inherits_id'];
    }

    $compile = $this->compiler;

    // If we don't have a file assigned to this handle, die.
    if (!isset($this->files[$handle]))
    {
      trigger_error("template->_tpl_load(): No file specified for handle $handle", E_USER_ERROR);
    }

    // Just compile if no user object is present (happens within the installer)
    if (!$user)
    {
      $compile->_tpl_load_file($handle);

The method _tpl_load_file() does not exist on null.

      return false;
    }

    if (isset($user->theme['template_storedb']) && $user->theme['template_storedb'])
    {
      $rows = array();
      $ids = array();
      // Inheritance
      if (isset($user->theme['template_inherits_id']) && $user->theme['template_inherits_id'])
      {
        $ids[] = $user->theme['template_inherits_id'];
      }
      $ids[] = $user->theme['template_id'];

      foreach ($ids as $id)
      {
        $sql = 'SELECT *
        FROM ' . STYLES_TEMPLATE_DATA_TABLE . '

The constant STYLES_TEMPLATE_DATA_TABLE was not found. Maybe you did not declare it correctly or list all dependencies?

        WHERE template_id = ' . $id . "
          AND (template_filename = '" . $db->sql_escape($this->filename[$handle]) . "'
            OR template_included " . $db->sql_like_expression($db->any_char . $this->filename[$handle] . ':' . $db->any_char) . ')';

        $result = $db->sql_query($sql);
        while ($row = $db->sql_fetchrow($result))
        {
          $rows[$row['template_filename']] = $row;
        }
        $db->sql_freeresult($result);
      }

      if (sizeof($rows))
      {
        foreach ($rows as $row)
        {
          $file = $this->root . '/' . $row['template_filename'];
          $force_reload = false;
          if ($row['template_id'] != $user->theme['template_id'])
          {
            // make sure that we are not overlooking a file not in the db yet
            if (isset($user->theme['template_inherits_id']) && $user->theme['template_inherits_id'] && !file_exists($file))
            {
              $file = $this->inherit_root . '/' . $row['template_filename'];
              $this->files[$row['template_filename']] = $file;
              $this->files_inherit[$row['template_filename']] = $file;
              $this->files_template[$row['template_filename']] = $user->theme['template_inherits_id'];
            }
            else if (isset($user->theme['template_inherits_id']) && $user->theme['template_inherits_id'])
            {
              // Ok, we have a situation. There is a file in the subtemplate, but nothing in the DB. We have to fix that.
              $force_reload = true;
              $this->files_template[$row['template_filename']] = $user->theme['template_inherits_id'];
            }
          }
          else
          {
            $this->files_template[$row['template_filename']] = $user->theme['template_id'];
          }

          if ($force_reload || $row['template_mtime'] < filemtime($file))
          {
            if ($row['template_filename'] == $this->filename[$handle])
            {
              $compile->_tpl_load_file($handle, true);
            }
            else
            {
              $this->files[$row['template_filename']] = $file;
              $this->filename[$row['template_filename']] = $row['template_filename'];
              $compile->_tpl_load_file($row['template_filename'], true);
              unset($this->compiled_code[$row['template_filename']]);
              unset($this->files[$row['template_filename']]);
              unset($this->filename[$row['template_filename']]);
            }
          }

          if ($row['template_filename'] == $this->filename[$handle])
          {
            $this->compiled_code[$handle] = $compile->compile(trim($row['template_data']));
            $compile->compile_write($handle, $this->compiled_code[$handle]);
          }
          else
          {
            // Only bother compiling if it doesn't already exist
            if (!file_exists($this->cachepath . str_replace('/', '.', $row['template_filename']) . DOT_PHP_EX))
            {
              $this->filename[$row['template_filename']] = $row['template_filename'];
              $compile->compile_write($row['template_filename'], $compile->compile(trim($row['template_data'])));
              unset($this->filename[$row['template_filename']]);
            }
          }
        }
      }
      else
      {
        $file = $this->root . '/' . $row['template_filename'];

        if (isset($user->theme['template_inherits_id']) && $user->theme['template_inherits_id'] && !file_exists($file))
        {
          $file = $this->inherit_root . '/' . $row['template_filename'];
          $this->files[$row['template_filename']] = $file;
          $this->files_inherit[$row['template_filename']] = $file;
          $this->files_template[$row['template_filename']] = $user->theme['template_inherits_id'];
        }
        // Try to load from filesystem and instruct to insert into the styles table...
        $compile->_tpl_load_file($handle, true);
        return false;
      }

      return false;
    }

    $compile->_tpl_load_file($handle);
    return false;
  }

  /**
  * Assign key variable pairs from an array
  * @access public
  */
  function assign_vars($vararray)
  {
    foreach ($vararray as $key => $val)
    {
      $this->_rootref[$key] = $val;
    }

    return true;
  }

  /**
  * Assign a single variable to a single key
  * @access public
  */
  function assign_var($varname, $varval)
  {
    $this->_rootref[$varname] = $varval;

    return true;
  }

  /**
  * Assign key variable pairs from an array to a specified block
  * @access public
  */
  function assign_block_vars($blockname, $vararray)
  {
    if (strpos($blockname, '.') !== false)
    {
      // Nested block.
      $blocks = explode('.', $blockname);
      $blockcount = sizeof($blocks) - 1;

      $str = &$this->_tpldata;
      for ($i = 0; $i < $blockcount; $i++)
      {
        $str = &$str[$blocks[$i]];
        $str = &$str[sizeof($str) - 1];
      }

      $s_row_count = isset($str[$blocks[$blockcount]]) ? sizeof($str[$blocks[$blockcount]]) : 0;
      $vararray['S_ROW_COUNT'] = $s_row_count;

      // Assign S_FIRST_ROW
      if (!$s_row_count)
      {
        $vararray['S_FIRST_ROW'] = true;
      }

      // Now the tricky part, we always assign S_LAST_ROW and remove the entry before
      // This is much more clever than going through the complete template data on display (phew)
      $vararray['S_LAST_ROW'] = true;
      if ($s_row_count > 0)
      {
        unset($str[$blocks[$blockcount]][($s_row_count - 1)]['S_LAST_ROW']);
      }

      // Now we add the block that we're actually assigning to.
      // We're adding a new iteration to this block with the given
      // variable assignments.
      $str[$blocks[$blockcount]][] = $vararray;
    }
    else
    {
      // Top-level block.
      $s_row_count = (isset($this->_tpldata[$blockname])) ? sizeof($this->_tpldata[$blockname]) : 0;
      $vararray['S_ROW_COUNT'] = $s_row_count;

      // Assign S_FIRST_ROW
      if (!$s_row_count)
      {
        $vararray['S_FIRST_ROW'] = true;
      }

      // We always assign S_LAST_ROW and remove the entry before
      $vararray['S_LAST_ROW'] = true;
      if ($s_row_count > 0)
      {
        unset($this->_tpldata[$blockname][($s_row_count - 1)]['S_LAST_ROW']);
      }

      // Add a new iteration to this block with the variable assignments we were given.
      $this->_tpldata[$blockname][] = $vararray;
    }

    return true;
  }

  /**
  * Change already assigned key variable pair (one-dimensional - single loop entry)
  *
  * An example of how to use this function:
  * {@example alter_block_array.php}
  *
  * @param  string  $blockname  the blockname, for example 'loop'
  * @param  array $vararray the var array to insert/add or merge
  * @param  mixed $key    Key to search for
  *
  * array: KEY => VALUE [the key/value pair to search for within the loop to determine the correct position]
  *
  * int: Position [the position to change or insert at directly given]
  *
  * If key is false the position is set to 0
  * If key is true the position is set to the last entry
  *
  * @param  string  $mode   Mode to execute (valid modes are 'insert' and 'change')
  *
  * If insert, the vararray is inserted at the given position (position counting from zero).
  * If change, the current block gets merged with the vararray (resulting in new key/value pairs be added and existing keys be replaced by the new value).
  *
  * Since counting begins by zero, inserting at the last position will result in this array: array(vararray, last positioned array)
  * and inserting at position 1 will result in this array: array(first positioned array, vararray, following vars)
  *
  * @return bool false on error, true on success
  * @access public
  */
  function alter_block_array($blockname, $vararray, $key = false, $mode = 'insert')
  {
    if (strpos($blockname, '.') !== false)
    {
      // Nested blocks are not supported
      return false;
    }

    // Change key to zero (change first position) if false and to last position if true
    if ($key === false || $key === true)
    {
      $key = ($key === false) ? 0 : sizeof($this->_tpldata[$blockname]);
    }

    // Get correct position if array given
    if (is_array($key))
    {
      // Search array to get correct position
      list($search_key, $search_value) = @each($key);

      $key = NULL;
      foreach ($this->_tpldata[$blockname] as $i => $val_ary)
      {
        if ($val_ary[$search_key] === $search_value)
        {
          $key = $i;
          break;
        }
      }

      // key/value pair not found
      if ($key === NULL)
      {
        return false;
      }
    }

    // Insert Block
    if ($mode == 'insert')
    {
      // Make sure we are not exceeding the last iteration
      if ($key >= sizeof($this->_tpldata[$blockname]))
      {
        $key = sizeof($this->_tpldata[$blockname]);
        unset($this->_tpldata[$blockname][($key - 1)]['S_LAST_ROW']);
        $vararray['S_LAST_ROW'] = true;
      }
      else if ($key === 0)
      {
        unset($this->_tpldata[$blockname][0]['S_FIRST_ROW']);
        $vararray['S_FIRST_ROW'] = true;
      }

      // Re-position template blocks
      for ($i = sizeof($this->_tpldata[$blockname]); $i > $key; $i--)
      {
        $this->_tpldata[$blockname][$i] = $this->_tpldata[$blockname][$i-1];
        $this->_tpldata[$blockname][$i]['S_ROW_COUNT'] = $i;
      }

      // Insert vararray at given position
      $vararray['S_ROW_COUNT'] = $key;
      $this->_tpldata[$blockname][$key] = $vararray;

      return true;
    }

    // Which block to change?
    if ($mode == 'change')
    {
      if ($key == sizeof($this->_tpldata[$blockname]))
      {
        $key--;
      }

      $this->_tpldata[$blockname][$key] = array_merge($this->_tpldata[$blockname][$key], $vararray);
      return true;
    }

    return false;
  }

  /**
  * Include a separate template
  * @access private
  */
  function _tpl_include($filename, $include = true)
  {
    // This is used to access global vars
    // global $lang, $config, $user; // Not needed!

    $handle = $filename;
    $this->filename[$handle] = $filename;
    $this->files[$handle] = $this->root . '/' . $filename;
    if ($this->inherit_root)
    {
      $this->files_inherit[$handle] = $this->inherit_root . '/' . $filename;
    }

    $filename = $this->_tpl_load($handle);

    if ($include)
    {

      if ($filename)
      {
        include($filename);
        return;
      }
      $this->evaluate($this->compiled_code[$handle]);
    }
  }

  /**
  * Include a php-file
  * @access private
  */
  function _php_include($filename)
  {
    $file = $this->rootPhysical . $filename;

    if (!file_exists($file))
    {
      // trigger_error cannot be used here, as the output already started
      echo 'template->_php_include(): File ' . htmlspecialchars($file) . ' does not exist or is empty';
      return;
    }
    include($file);
  }

  /**
  * Assign key variable pairs from an array with block support
  * @access public
  */
  function assign_recursive($values, $name = '')
  {
    if(isset($values['.']))
    {
      $values_extra = $values['.'];
      unset($values['.']);
    }

    if(!$name)
    {
      $this->assign_vars($values);
    }
    else
    {
      $this->assign_block_vars($name, $values);
    }

    if(isset($values_extra))
    {
      foreach($values_extra as $sub_array_name => $sub_array)
      {
        $new_name = $name . ($name ? '.' : '') . $sub_array_name;
        foreach($sub_array as $sub_element)
        {
          $this->assign_recursive($sub_element, $new_name);
        }
      }
    }
  }

  /**
   * This function will be called from compiled template to re-render variables - i.e. allow late binding of values aka accessing variable value by it's name in template var
   *
   * @param string $stringTag
   *
   * @return mixed|string
   */
  public function reRender($stringTag) {
    $tplTag = new PTLTag($stringTag, $this);
    $result = $tplTag->resolved;
    $this->compiler->compile_var_tags($result);

The method compile_var_tags() does not exist on null.

    $this->evaluate($result);

    return $result;
  }

  protected function evaluate($code) {
    // This is used to access global vars
    // global $lang, $config, $user; // Not needed

    eval(' ?>' . $code . '<?php ');
  }

}