-* @copyright (c) 2005 phpBB Group, sections (c) 2001 ispi of Lincoln Inc

-/**

-* @todo

-* IMG_ for image substitution?

-* {IMG_[key]:[alt]:[type]}

-* {IMG_ICON_CONTACT:CONTACT:full} -> $user->img('icon_contact', 'CONTACT', 'full');

-*

-* More in-depth...

-* yadayada

-*/

-

-/**

-* Base Template class.

-* @package phpBB3

-*/

-class phpbb_template

- /**

- * Template context.

- * Stores template data used during template rendering.

- * @var phpbb_template_context

- */

- private $context;

-

- /**

- * Path of the cache directory for the template

- * @var string

- */

- public $cachepath = '';

-

- /**

- * phpBB root path

- * @var string

- */

- private $phpbb_root_path;

-

- /**

- * PHP file extension

- * @var string

- */

- private $php_ext;

-

- /**

- * phpBB config instance

- * @var phpbb_config

- */

- private $config;

-

- /**

- * Current user

- * @var phpbb_user

- */

- private $user;

-

- /**

- * Template locator

- * @var phpbb_template_locator

- */

- private $locator;

-

- /**

- * Extension manager.

- *

- * @var phpbb_extension_manager

- */

- private $extension_manager;

-

- /**

- * Name of the style that the template being compiled and/or rendered

- * belongs to, and its parents, in inheritance tree order.

- *

- * Used to invoke style-specific template events.

- *

- * @var array

- */

- private $style_names;

- * Constructor.

- * @param string $phpbb_root_path phpBB root path

- * @param user $user current user

- * @param phpbb_template_locator $locator template locator

- * @param phpbb_template_context $context template context

- * @param phpbb_extension_manager $extension_manager extension manager, if null then template events will not be invoked

- public function __construct($phpbb_root_path, $php_ext, $config, $user, phpbb_template_locator $locator, phpbb_template_context $context, phpbb_extension_manager $extension_manager = null)

- {

- $this->phpbb_root_path = $phpbb_root_path;

- $this->php_ext = $php_ext;

- $this->config = $config;

- $this->user = $user;

- $this->locator = $locator;

- $this->context = $context;

- $this->extension_manager = $extension_manager;

- }

- public function set_filenames(array $filename_array)

- {

- $this->locator->set_filenames($filename_array);

-

- return true;

- }

- * Sets the style names corresponding to style hierarchy being compiled

- * @return null

- public function set_style_names(array $style_names)

- {

- $this->style_names = $style_names;

- }

- public function destroy()

- {

- $this->context->clear();

- }

- public function destroy_block_vars($blockname)

- {

- $this->context->destroy_block_vars($blockname);

- }

- * @return bool True on success, false on failure

- */

- public function display($handle)

- {

- $result = $this->call_hook($handle, __FUNCTION__);

- if ($result !== false)

- {

- return $result[0];

- }

-

- return $this->load_and_render($handle);

- }

-

- /**

- * Loads a template for $handle, compiling it if necessary, and

- * renders the template.

- *

- * @param string $handle Template handle to render

- * @return bool True on success, false on failure

- */

- private function load_and_render($handle)

- {

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

-

- if ($renderer)

- {

- $renderer->render($this->context, $this->get_lang());

- return true;

- }

- else

- {

- return false;

- }

- }

-

- /**

- * Calls hook if any is defined.

- *

- * @param string $handle Template handle being displayed.

- * @param string $method Method name of the caller.

- private function call_hook($handle, $method)

- {

- global $phpbb_hook;

-

- if (!empty($phpbb_hook) && $phpbb_hook->call_hook(array(__CLASS__, $method), $handle, $this))

- {

- if ($phpbb_hook->hook_return(array(__CLASS__, $method)))

- {

- $result = $phpbb_hook->hook_return_result(array(__CLASS__, $method));

- return array($result);

- }

- }

-

- return false;

- }

-

- /**

- * Obtains language array.

- * This is either lang property of $user property, or if

- * it is not set an empty array.

- * @return array language entries

- */

- public function get_lang()

- {

- if (isset($this->user->lang))

- {

- $lang = $this->user->lang;

- }

- else

- {

- $lang = array();

- }

- return $lang;

- }

- * @return bool|string false on failure, otherwise if $return_content is true return string of the compiled handle, otherwise return true

- */

- public function assign_display($handle, $template_var = '', $return_content = true)

- {

- ob_start();

- $result = $this->display($handle);

- $contents = ob_get_clean();

- if ($result === false)

- {

- return false;

- }

-

- if ($return_content)

- {

- return $contents;

- }

-

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

-

- return true;

- }

-

- /**

- * Obtains a template renderer for a template identified by specified

- * handle. The template renderer can display the template later.

- *

- * Template source will first be compiled into php code.

- * If template cache is writable the compiled php code will be stored

- * on filesystem and template will not be subsequently recompiled.

- * If template cache is not writable template source will be recompiled

- * every time it is needed. DEBUG define and load_tplcompile

- * configuration setting may be used to force templates to be always

- * recompiled.

- *

- * Returns an object implementing phpbb_template_renderer, or null

- * if template loading or compilation failed. Call render() on the

- * renderer to display the template. This will result in template

- * contents sent to the output stream (unless, of course, output

- * buffering is in effect).

- *

- * @param string $handle Handle of the template to load

- * @return phpbb_template_renderer Template renderer object, or null on failure

- * @uses phpbb_template_compile is used to compile template source

- */

- private function _tpl_load($handle)

- {

- $output_file = $this->_compiled_file_for_handle($handle);

-

- $recompile = defined('DEBUG') ||

- !file_exists($output_file) ||

- @filesize($output_file) === 0;

-

- if ($recompile || $this->config['load_tplcompile'])

- {

- // Set only if a recompile or an mtime check are required.

- $source_file = $this->locator->get_source_file_for_handle($handle);

-

- if (!$recompile && @filemtime($output_file) < @filemtime($source_file))

- {

- $recompile = true;

- }

- }

-

- // Recompile page if the original template is newer, otherwise load the compiled version

- if (!$recompile)

- {

- return new phpbb_template_renderer_include($output_file, $this);

- }

-

- $compile = new phpbb_template_compile($this->config['tpl_allow_php'], $this->style_names, $this->locator, $this->phpbb_root_path, $this->extension_manager, $this->user);

-

- if ($compile->compile_file_to_file($source_file, $output_file) !== false)

- {

- $renderer = new phpbb_template_renderer_include($output_file, $this);

- }

- else if (($code = $compile->compile_file($source_file)) !== false)

- {

- $renderer = new phpbb_template_renderer_eval($code, $this);

- }

- else

- {

- $renderer = null;

- }

-

- return $renderer;

- }

-

- /**

- * Determines compiled file path for handle $handle.

- *

- * @param string $handle Template handle (i.e. "friendly" template name)

- * @return string Compiled file path

- private function _compiled_file_for_handle($handle)

- {

- $source_file = $this->locator->get_filename_for_handle($handle);

- $compiled_file = $this->cachepath . str_replace('/', '.', $source_file) . '.' . $this->php_ext;

- return $compiled_file;

- }

- public function assign_vars(array $vararray)

- {

- foreach ($vararray as $key => $val)

- {

- $this->assign_var($key, $val);

- }

- }

- public function assign_var($varname, $varval)

- {

- $this->context->assign_var($varname, $varval);

- }

- public function append_var($varname, $varval)

- {

- $this->context->append_var($varname, $varval);

- }

- // Docstring is copied from phpbb_template_context method with the same name.

- public function assign_block_vars($blockname, array $vararray)

- {

- return $this->context->assign_block_vars($blockname, $vararray);

- }

- // Docstring is copied from phpbb_template_context method with the same name.

- public function alter_block_array($blockname, array $vararray, $key = false, $mode = 'insert')

- {

- return $this->context->alter_block_array($blockname, $vararray, $key, $mode);

- }

-

- /**

- * Include a separate template.

- *

- * This function is marked public due to the way the template

- * implementation uses it. It is actually an implementation function

- * and should not be considered part of template class's public API.

- *

- * @param string $filename Template filename to include

- * @param bool $include True to include the file, false to just load it

- * @uses template_compile is used to compile uncached templates

- */

- public function _tpl_include($filename, $include = true)

- {

- $this->locator->set_filenames(array($filename => $filename));

-

- if (!$this->load_and_render($filename))

- {

- // trigger_error cannot be used here, as the output already started

- echo 'template->_tpl_include(): Failed including ' . htmlspecialchars($handle) . "\n";

- }

- }

- * Include a PHP file.

- *

- * If a relative path is passed in $filename, it is considered to be

- * relative to board root ($phpbb_root_path). Absolute paths are

- * also allowed.

- * This function is marked public due to the way the template

- * implementation uses it. It is actually an implementation function

- * and should not be considered part of template class's public API.

- *

- * @param string $filename Path to PHP file to include

- public function _php_include($filename)

- {

- if (phpbb_is_absolute($filename))

- {

- $file = $filename;

- }

- else

- {

- $file = $this->phpbb_root_path . $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\n";

- return;

- }

- include($file);

- }

-

- /**

- * Include JS file

- *

- * @param string $file file name

- * @param bool $locate True if file needs to be located

- * @param bool $relative True if path is relative to phpBB root directory. Ignored if $locate == true

- */

- public function _js_include($file, $locate = false, $relative = false)

- {

- // Locate file

- if ($locate)

- {

- $located = $this->locator->get_first_file_location(array($file), false, true);

- if ($located)

- {

- $file = $located;

- }

- }

- else if ($relative)

- {

- $file = $this->phpbb_root_path . $file;

- }

-

- $file .= (strpos($file, '?') === false) ? '?' : '&';

- $file .= 'assets_version=' . $this->config['assets_version'];

-

- // Add HTML code

- $code = '<script src="' . htmlspecialchars($file) . '"></script>';

- $this->context->append_var('SCRIPTS', $code);

- }