phpBB/includes/template.php

   1 <?php
   2 /**
   3 *
   4 * @package phpBB3
   5 * @version $Id$
   6 * @copyright (c) 2005 phpBB Group, sections (c) 2001 ispi of Lincoln Inc
   7 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
   8 *
   9 */
  10
  11 /**
  12 * @ignore
  13 */
  14 if (!defined('IN_PHPBB'))
  15 {
  16         exit;
  17 }
  18
  19 /**
  20 * Base Template class.
  21 * @package phpBB3
  22 */
  23 class template
  24 {
  25         /** variable that holds all the data we'll be substituting into
  26         * the compiled templates. Takes form:
  27         * --> $this->_tpldata[block][iteration#][child][iteration#][child2][iteration#][variablename] == value
  28         * if it's a root-level variable, it'll be like this:
  29         * --> $this->_tpldata[.][0][varname] == value
  30         */
  31         private $_tpldata = array('.' => array(0 => array()));
  32         private $_rootref;
  33
  34         // Root dir and hash of filenames for each template handle.
  35         private $root = '';
  36         public $cachepath = '';
  37         public $files = array();
  38         public $filename = array();
  39
  40         /**
  41         * Set template location
  42         * @access public
  43         */
  44         public function set_template()
  45         {
  46                 global $user;
  47
  48                 if (file_exists(PHPBB_ROOT_PATH . 'styles/' . $user->theme['template_path'] . '/template'))
  49                 {
  50                         $this->root = PHPBB_ROOT_PATH . 'styles/' . $user->theme['template_path'] . '/template';
  51                         $this->cachepath = PHPBB_ROOT_PATH . 'cache/tpl_' . $user->theme['template_path'] . '_';
  52                 }
  53                 else
  54                 {
  55                         trigger_error('Template path could not be found: styles/' . $user->theme['template_path'] . '/template', E_USER_ERROR);
  56                 }
  57
  58                 $this->_rootref = &$this->_tpldata['.'][0];
  59
  60                 return true;
  61         }
  62
  63         /**
  64         * Set custom template location (able to use directory outside of phpBB)
  65         * @access public
  66         */
  67         public function set_custom_template($template_path, $template_name)
  68         {
  69                 $this->root = $template_path;
  70                 $this->cachepath = PHPBB_ROOT_PATH . 'cache/ctpl_' . str_replace('_', '-', $template_name) . '_';
  71
  72                 return true;
  73         }
  74
  75         /**
  76         * Sets the template filenames for handles. $filename_array
  77         * should be a hash of handle => filename pairs.
  78         * @access public
  79         */
  80         public function set_filenames(array $filename_array)
  81         {
  82                 foreach ($filename_array as $handle => $filename)
  83                 {
  84                         if (empty($filename))
  85                         {
  86                                 trigger_error("template->set_filenames: Empty filename specified for $handle", E_USER_ERROR);
  87                         }
  88
  89                         $this->filename[$handle] = $filename;
  90                         $this->files[$handle] = $this->root . '/' . $filename;
  91                 }
  92
  93                 return true;
  94         }
  95
  96         /**
  97         * Destroy template data set
  98         * @access public
  99         */
 100         function __destruct()
 101         {
 102                 $this->_tpldata = array('.' => array(0 => array()));
 103         }
 104
 105         /**
 106         * Reset/empty complete block
 107         * @access public
 108         */
 109         public function destroy_block_vars($blockname)
 110         {
 111                 if (strpos($blockname, '.') !== false)
 112                 {
 113                         // Nested block.
 114                         $blocks = explode('.', $blockname);
 115                         $blockcount = sizeof($blocks) - 1;
 116
 117                         $str = &$this->_tpldata;
 118                         for ($i = 0; $i < $blockcount; $i++)
 119                         {
 120                                 $str = &$str[$blocks[$i]];
 121                                 $str = &$str[sizeof($str) - 1];
 122                         }
 123
 124                         unset($str[$blocks[$blockcount]]);
 125                 }
 126                 else
 127                 {
 128                         // Top-level block.
 129                         unset($this->_tpldata[$blockname]);
 130                 }
 131
 132                 return true;
 133         }
 134
 135         /**
 136         * Display handle
 137         * @access public
 138         */
 139         public function display($handle, $include_once = true)
 140         {
 141                 global $user, $phpbb_hook;
 142
 143                 if (!empty($phpbb_hook) && $phpbb_hook->call_hook(array(__CLASS__, __FUNCTION__), $handle, $include_once))
 144                 {
 145                         if ($phpbb_hook->hook_return(array(__CLASS__, __FUNCTION__)))
 146                         {
 147                                 return $phpbb_hook->hook_return_result(array(__CLASS__, __FUNCTION__));
 148                         }
 149                 }
 150
 151 /*              if (defined('IN_ERROR_HANDLER'))
 152                 {
 153                         if ((E_NOTICE & error_reporting()) == E_NOTICE)
 154                         {
 155                                 //error_reporting(error_reporting() ^ E_NOTICE);
 156                         }
 157                 }*/
 158
 159                 $_tpldata       = &$this->_tpldata;
 160                 $_rootref       = &$this->_rootref;
 161                 $_lang          = &$user->lang;
 162
 163                 // These _are_ used the included files.
 164                 $_tpldata; $_rootref; $_lang;
 165
 166                 if (($filename = $this->_tpl_load($handle)) !== false)
 167                 {
 168                         ($include_once) ? include_once($filename) : include($filename);
 169                 }
 170                 else if (($code = $this->_tpl_eval($handle)) !== false)
 171                 {
 172                         $code = ' ?> ' . $code . ' <?php ';
 173                         eval($code);
 174                 }
 175                 else
 176                 {
 177                         // if we could not eval AND the file exists, something horrific has occured
 178                         return false;
 179                 }
 180
 181                 return true;
 182         }
 183
 184         /**
 185         * Display the handle and assign the output to a template variable or return the compiled result.
 186         * @access public
 187         */
 188         public function assign_display($handle, $template_var = '', $return_content = true, $include_once = false)
 189         {
 190                 ob_start();
 191                 $this->display($handle, $include_once);
 192                 $contents = ob_get_clean();
 193
 194                 if ($return_content)
 195                 {
 196                         return $contents;
 197                 }
 198
 199                 $this->assign_var($template_var, $contents);
 200
 201                 return true;
 202         }
 203
 204         /**
 205         * Load a compiled template if possible, if not, recompile it
 206         * @access private
 207         */
 208         private function _tpl_load(&$handle)
 209         {
 210                 global $config;
 211
 212                 $filename = $this->cachepath . str_replace('/', '.', $this->filename[$handle]) . '.' . PHP_EXT;
 213
 214                 $recompile = (($config['load_tplcompile'] && @filemtime($filename) < filemtime($this->files[$handle])) || !file_exists($filename) || @filesize($filename) === 0) ? true : false;
 215
 216                 // Recompile page if the original template is newer, otherwise load the compiled version
 217                 if ($recompile)
 218                 {
 219                         if (!class_exists('template_compile'))
 220                         {
 221                                 include(PHPBB_ROOT_PATH . 'includes/functions_template.' . PHP_EXT);
 222                         }
 223
 224                         $compile = new template_compile($this);
 225
 226                         // If we don't have a file assigned to this handle, die.
 227                         if (!isset($this->files[$handle]))
 228                         {
 229                                 trigger_error("template->_tpl_load(): No file specified for handle $handle", E_USER_ERROR);
 230                         }
 231
 232                         if ($compile->_tpl_load_file($handle) === false)
 233                         {
 234                                 return false;
 235                         }
 236                 }
 237
 238                 return $filename;
 239         }
 240
 241         /**
 242         * This code should only run when some high level error prevents us from writing to the cache.
 243         * @access private
 244         */
 245         private function _tpl_eval(&$handle)
 246         {
 247 //              global $user, $config;
 248
 249                 if (!class_exists('template_compile'))
 250                 {
 251                         include(PHPBB_ROOT_PATH . 'includes/functions_template.' . PHP_EXT);
 252                 }
 253
 254                 $compile = new template_compile($this);
 255
 256                 // If we don't have a file assigned to this handle, die.
 257                 if (!isset($this->files[$handle]))
 258                 {
 259                         trigger_error("template->_tpl_eval(): No file specified for handle $handle", E_USER_ERROR);
 260                 }
 261
 262                 if (($code = $compile->_tpl_gen_src($handle)) === false)
 263                 {
 264                         return false;
 265                 }
 266
 267                 return $code;
 268         }
 269
 270         /**
 271         * Assign key variable pairs from an array
 272         * @access public
 273         */
 274         public function assign_vars(array $vararray)
 275         {
 276                 foreach ($vararray as $key => $val)
 277                 {
 278                         $this->_rootref[$key] = $val;
 279                 }
 280
 281                 return true;
 282         }
 283
 284         /**
 285         * Assign a single variable to a single key
 286         * @access public
 287         */
 288         public function assign_var($varname, $varval)
 289         {
 290                 $this->_rootref[$varname] = $varval;
 291
 292                 return true;
 293         }
 294
 295         /**
 296         * Assign key variable pairs from an array to a specified block
 297         * @access public
 298         */
 299         public function assign_block_vars($blockname, array $vararray)
 300         {
 301                 if (strpos($blockname, '.') !== false)
 302                 {
 303                         // Nested block.
 304                         $blocks = explode('.', $blockname);
 305                         $blockcount = sizeof($blocks) - 1;
 306
 307                         $str = &$this->_tpldata;
 308                         for ($i = 0; $i < $blockcount; $i++)
 309                         {
 310                                 $str = &$str[$blocks[$i]];
 311                                 $str = &$str[sizeof($str) - 1];
 312                         }
 313
 314                         $s_row_count = isset($str[$blocks[$blockcount]]) ? sizeof($str[$blocks[$blockcount]]) : 0;
 315                         $vararray['S_ROW_COUNT'] = $s_row_count;
 316
 317                         // Assign S_FIRST_ROW
 318                         if (!$s_row_count)
 319                         {
 320                                 $vararray['S_FIRST_ROW'] = true;
 321                         }
 322
 323                         // Now the tricky part, we always assign S_LAST_ROW and remove the entry before
 324                         // This is much more clever than going through the complete template data on display (phew)
 325                         $vararray['S_LAST_ROW'] = true;
 326                         if ($s_row_count > 0)
 327                         {
 328                                 unset($str[$blocks[$blockcount]][($s_row_count - 1)]['S_LAST_ROW']);
 329                         }
 330
 331                         // Now we add the block that we're actually assigning to.
 332                         // We're adding a new iteration to this block with the given
 333                         // variable assignments.
 334                         $str[$blocks[$blockcount]][] = $vararray;
 335                 }
 336                 else
 337                 {
 338                         // Top-level block.
 339                         $s_row_count = (isset($this->_tpldata[$blockname])) ? sizeof($this->_tpldata[$blockname]) : 0;
 340                         $vararray['S_ROW_COUNT'] = $s_row_count;
 341
 342                         // Assign S_FIRST_ROW
 343                         if (!$s_row_count)
 344                         {
 345                                 $vararray['S_FIRST_ROW'] = true;
 346                         }
 347
 348                         // We always assign S_LAST_ROW and remove the entry before
 349                         $vararray['S_LAST_ROW'] = true;
 350                         if ($s_row_count > 0)
 351                         {
 352                                 unset($this->_tpldata[$blockname][($s_row_count - 1)]['S_LAST_ROW']);
 353                         }
 354
 355                         // Add a new iteration to this block with the variable assignments we were given.
 356                         $this->_tpldata[$blockname][] = $vararray;
 357                 }
 358
 359                 return true;
 360         }
 361
 362         /**
 363         * Change already assigned key variable pair (one-dimensional - single loop entry)
 364         *
 365         * An example of how to use this function:
 366         * {@example alter_block_array.php}
 367         *
 368         * @param        string  $blockname      the blockname, for example 'loop'
 369         * @param        array   $vararray       the var array to insert/add or merge
 370         * @param        mixed   $key            Key to search for
 371         *
 372         * array: KEY => VALUE [the key/value pair to search for within the loop to determine the correct position]
 373         *
 374         * int: Position [the position to change or insert at directly given]
 375         *
 376         * If key is false the position is set to 0
 377         * If key is true the position is set to the last entry
 378         *
 379         * @param        string  $mode           Mode to execute (valid modes are 'insert' and 'change')
 380         *
 381         *       If insert, the vararray is inserted at the given position (position counting from zero).
 382         *       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).
 383         *
 384         * Since counting begins by zero, inserting at the last position will result in this array: array(vararray, last positioned array)
 385         * and inserting at position 1 will result in this array: array(first positioned array, vararray, following vars)
 386         *
 387         * @return bool false on error, true on success
 388         * @access public
 389         */
 390         public function alter_block_array($blockname, array $vararray, $key = false, $mode = 'insert')
 391         {
 392                 if (strpos($blockname, '.') !== false)
 393                 {
 394                         // Nested blocks are not supported
 395                         return false;
 396                 }
 397
 398                 // Change key to zero (change first position) if false and to last position if true
 399                 if ($key === false || $key === true)
 400                 {
 401                         $key = ($key === false) ? 0 : sizeof($this->_tpldata[$blockname]);
 402                 }
 403
 404                 // Get correct position if array given
 405                 if (is_array($key))
 406                 {
 407                         // Search array to get correct position
 408                         list($search_key, $search_value) = @each($key);
 409
 410                         $key = NULL;
 411                         foreach ($this->_tpldata[$blockname] as $i => $val_ary)
 412                         {
 413                                 if ($val_ary[$search_key] === $search_value)
 414                                 {
 415                                         $key = $i;
 416                                         break;
 417                                 }
 418                         }
 419
 420                         // key/value pair not found
 421                         if ($key === NULL)
 422                         {
 423                                 return false;
 424                         }
 425                 }
 426
 427                 // Insert Block
 428                 if ($mode == 'insert')
 429                 {
 430                         // Make sure we are not exceeding the last iteration
 431                         if ($key >= sizeof($this->_tpldata[$blockname]))
 432                         {
 433                                 $key = sizeof($this->_tpldata[$blockname]);
 434                                 unset($this->_tpldata[$blockname][($key - 1)]['S_LAST_ROW']);
 435                                 $vararray['S_LAST_ROW'] = true;
 436                         }
 437                         else if ($key === 0)
 438                         {
 439                                 unset($this->_tpldata[$blockname][0]['S_FIRST_ROW']);
 440                                 $vararray['S_FIRST_ROW'] = true;
 441                         }
 442
 443                         // Re-position template blocks
 444                         for ($i = sizeof($this->_tpldata[$blockname]); $i > $key; $i--)
 445                         {
 446                                 $this->_tpldata[$blockname][$i] = $this->_tpldata[$blockname][$i-1];
 447                                 $this->_tpldata[$blockname][$i]['S_ROW_COUNT'] = $i;
 448                         }
 449
 450                         // Insert vararray at given position
 451                         $vararray['S_ROW_COUNT'] = $key;
 452                         $this->_tpldata[$blockname][$key] = $vararray;
 453
 454                         return true;
 455                 }
 456
 457                 // Which block to change?
 458                 if ($mode == 'change')
 459                 {
 460                         if ($key == sizeof($this->_tpldata[$blockname]))
 461                         {
 462                                 $key--;
 463                         }
 464
 465                         $this->_tpldata[$blockname][$key] = array_merge($this->_tpldata[$blockname][$key], $vararray);
 466                         return true;
 467                 }
 468
 469                 return false;
 470         }
 471
 472         /**
 473         * Include a separate template
 474         * @access private
 475         */
 476         public function _tpl_include($filename, $include = true)
 477         {
 478                 $handle = $filename;
 479                 $this->filename[$handle] = $filename;
 480                 $this->files[$handle] = $this->root . '/' . $filename;
 481
 482                 $filename = $this->_tpl_load($handle);
 483
 484                 if ($include)
 485                 {
 486                         global $user;
 487
 488                         $_tpldata       = &$this->_tpldata;
 489                         $_rootref       = &$this->_rootref;
 490                         $_lang          = &$user->lang;
 491
 492                         // These _are_ used the included files.
 493                         $_tpldata; $_rootref; $_lang;
 494
 495                         if ($filename)
 496                         {
 497                                 include($filename);
 498                                 return;
 499                         }
 500                         else
 501                         {
 502                                 if (!class_exists('template_compile'))
 503                                 {
 504                                         include(PHPBB_ROOT_PATH . 'includes/functions_template.' . PHP_EXT);
 505                                 }
 506
 507                                 $compile = new template_compile($this);
 508
 509                                 if (($code = $compile->_tpl_gen_src($handle)) !== false)
 510                                 {
 511                                         $code = ' ?> ' . $code . ' <?php ';
 512                                         eval($code);
 513                                 }
 514                         }
 515                 }
 516         }
 517 }
 518
 519 ?>