* @author Uwe Tews * @package Smarty * @version 3.0.7 */ /** * define shorthand directory separator constant */ if (!defined('DS')) { define('DS', DIRECTORY_SEPARATOR); } /** * set SMARTY_DIR to absolute path to Smarty library files. * Sets SMARTY_DIR only if user application has not already defined it. */ if (!defined('SMARTY_DIR')) { define('SMARTY_DIR', dirname(__FILE__) . DS); } /** * set SMARTY_SYSPLUGINS_DIR to absolute path to Smarty internal plugins. * Sets SMARTY_SYSPLUGINS_DIR only if user application has not already defined it. */ if (!defined('SMARTY_SYSPLUGINS_DIR')) { define('SMARTY_SYSPLUGINS_DIR', SMARTY_DIR . 'sysplugins' . DS); } if (!defined('SMARTY_PLUGINS_DIR')) { define('SMARTY_PLUGINS_DIR', SMARTY_DIR . 'plugins' . DS); } if (!defined('SMARTY_RESOURCE_CHAR_SET')) { define('SMARTY_RESOURCE_CHAR_SET', 'UTF-8'); } if (!defined('SMARTY_RESOURCE_DATE_FORMAT')) { define('SMARTY_RESOURCE_DATE_FORMAT', '%b %e, %Y'); } /** * register the class autoloader */ if (!defined('SMARTY_SPL_AUTOLOAD')) { define('SMARTY_SPL_AUTOLOAD', 0); } if (SMARTY_SPL_AUTOLOAD && set_include_path(get_include_path() . PATH_SEPARATOR . SMARTY_SYSPLUGINS_DIR) !== false) { $registeredAutoLoadFunctions = spl_autoload_functions(); if (!isset($registeredAutoLoadFunctions['spl_autoload'])) { spl_autoload_register(); } } else { spl_autoload_register('smartyAutoload'); } /** * This is the main Smarty class */ class Smarty extends Smarty_Internal_Data { /** * constant definitions */ // smarty version const SMARTY_VERSION = 'Smarty-3.0.7'; //define variable scopes const SCOPE_LOCAL = 0; const SCOPE_PARENT = 1; const SCOPE_ROOT = 2; const SCOPE_GLOBAL = 3; // define caching modes const CACHING_OFF = 0; const CACHING_LIFETIME_CURRENT = 1; const CACHING_LIFETIME_SAVED = 2; /** modes for handling of "" tags in templates. **/ const PHP_PASSTHRU = 0; //-> print tags as plain text const PHP_QUOTE = 1; //-> escape tags as entities const PHP_REMOVE = 2; //-> escape tags as entities const PHP_ALLOW = 3; //-> escape tags as entities // filter types const FILTER_POST = 'post'; const FILTER_PRE = 'pre'; const FILTER_OUTPUT = 'output'; const FILTER_VARIABLE = 'variable'; // plugin types const PLUGIN_FUNCTION = 'function'; const PLUGIN_BLOCK = 'block'; const PLUGIN_COMPILER = 'compiler'; const PLUGIN_MODIFIER = 'modifier'; /** * static variables */ // assigned global tpl vars static $global_tpl_vars = array(); /** * variables */ // auto literal on delimiters with whitspace public $auto_literal = true; // display error on not assigned variables public $error_unassigned = false; // template directory public $template_dir = null; // default template handler public $default_template_handler_func = null; // compile directory public $compile_dir = null; // plugins directory public $plugins_dir = null; // cache directory public $cache_dir = null; // config directory public $config_dir = null; // force template compiling? public $force_compile = false; // check template for modifications? public $compile_check = true; // locking concurrent compiles public $compile_locking = true; // use sub dirs for compiled/cached files? public $use_sub_dirs = false; // compile_error? public $compile_error = false; // caching enabled public $caching = false; // merge compiled includes public $merge_compiled_includes = false; // cache lifetime public $cache_lifetime = 3600; // force cache file creation public $force_cache = false; // cache_id public $cache_id = null; // compile_id public $compile_id = null; // template delimiters public $left_delimiter = "{"; public $right_delimiter = "}"; // security public $security_class = 'Smarty_Security'; public $security_policy = null; public $php_handling = self::PHP_PASSTHRU; public $allow_php_tag = true; public $allow_php_templates = false; public $direct_access_security = true; public $trusted_dir = array(); // debug mode public $debugging = false; public $debugging_ctrl = 'NONE'; public $smarty_debug_id = 'SMARTY_DEBUG'; public $debug_tpl = null; // When set, smarty does uses this value as error_reporting-level. public $error_reporting = null; // config var settings public $config_overwrite = true; //Controls whether variables with the same name overwrite each other. public $config_booleanize = true; //Controls whether config values of on/true/yes and off/false/no get converted to boolean public $config_read_hidden = false; //Controls whether hidden config sections/vars are read from the file. // config vars public $config_vars = array(); // assigned tpl vars public $tpl_vars = array(); // dummy parent object public $parent = null; // global template functions public $template_functions = array(); // resource type used if none given public $default_resource_type = 'file'; // caching type public $caching_type = 'file'; // internal cache resource types public $cache_resource_types = array('file'); // internal config properties public $properties = array(); // config type public $default_config_type = 'file'; // cached template objects public $template_objects = null; // check If-Modified-Since headers public $cache_modified_check = false; // registered plugins public $registered_plugins = array(); // plugin search order public $plugin_search_order = array('function', 'block', 'compiler', 'class'); // registered objects public $registered_objects = array(); // registered classes public $registered_classes = array(); // registered filters public $registered_filters = array(); // registered resources public $registered_resources = array(); // autoload filter public $autoload_filters = array(); // status of filter on variable output public $variable_filter = true; // default modifier public $default_modifiers = array(); // global internal smarty vars static $_smarty_vars = array(); // start time for execution time calculation public $start_time = 0; // default file permissions public $_file_perms = 0644; // default dir permissions public $_dir_perms = 0771; // block tag hierarchy public $_tag_stack = array(); // flag if {block} tag is compiled for template inheritance public $inheritance = false; // generate deprecated function call notices? public $deprecation_notices = true; // Smarty 2 BC public $_version = self::SMARTY_VERSION; // self pointer to Smarty object public $smarty; /** * Class constructor, initializes basic smarty properties */ public function __construct() { // selfpointer need by some other class methods $this->smarty = $this; if (is_callable('mb_internal_encoding')) { mb_internal_encoding(SMARTY_RESOURCE_CHAR_SET); } $this->start_time = microtime(true); // set default dirs $this->template_dir = array('.' . DS . 'templates' . DS); $this->compile_dir = '.' . DS . 'templates_c' . DS; $this->plugins_dir = array(SMARTY_PLUGINS_DIR); $this->cache_dir = '.' . DS . 'cache' . DS; $this->config_dir = '.' . DS . 'configs' . DS; $this->debug_tpl = SMARTY_DIR . 'debug.tpl'; if (isset($_SERVER['SCRIPT_NAME'])) { $this->assignGlobal('SCRIPT_NAME', $_SERVER['SCRIPT_NAME']); } } /** * Class destructor */ public function __destruct() { } /** * fetches a rendered Smarty template * * @param string $template the resource handle of the template file or template object * @param mixed $cache_id cache id to be used with this template * @param mixed $compile_id compile id to be used with this template * @param object $ |null $parent next higher level of Smarty variables * @return string rendered template output */ public function fetch($template, $cache_id = null, $compile_id = null, $parent = null, $display = false) { if (!empty($cache_id) && is_object($cache_id)) { $parent = $cache_id; $cache_id = null; } if ($parent === null) { // get default Smarty data object $parent = $this; } // create template object if necessary ($template instanceof $this->template_class)? $_template = $template : $_template = $this->createTemplate ($template, $cache_id, $compile_id, $parent, false); if (isset($this->error_reporting)) { $_smarty_old_error_level = error_reporting($this->error_reporting); } // check URL debugging control if (!$this->debugging && $this->debugging_ctrl == 'URL') { if (isset($_SERVER['QUERY_STRING'])) { $_query_string = $_SERVER['QUERY_STRING']; } else { $_query_string = ''; } if (false !== strpos($_query_string, $this->smarty_debug_id)) { if (false !== strpos($_query_string, $this->smarty_debug_id . '=on')) { // enable debugging for this browser session setcookie('SMARTY_DEBUG', true); $this->debugging = true; } elseif (false !== strpos($_query_string, $this->smarty_debug_id . '=off')) { // disable debugging for this browser session setcookie('SMARTY_DEBUG', false); $this->debugging = false; } else { // enable debugging for this page $this->debugging = true; } } else { if (isset($_COOKIE['SMARTY_DEBUG'])) { $this->debugging = true; } } } // obtain data for cache modified check if ($this->cache_modified_check && $this->caching && $display) { $_isCached = $_template->isCached() && !$_template->has_nocache_code; if ($_isCached) { $_gmt_mtime = gmdate('D, d M Y H:i:s', $_template->getCachedTimestamp()) . ' GMT'; } else { $_gmt_mtime = ''; } } // return rendered template if ((!$this->caching || $_template->resource_object->isEvaluated) && (isset($this->autoload_filters['output']) || isset($this->registered_filters['output']))) { $_output = Smarty_Internal_Filter_Handler::runFilter('output', $_template->getRenderedTemplate(), $_template); } else { $_output = $_template->getRenderedTemplate(); } $_template->rendered_content = null; if (isset($this->error_reporting)) { error_reporting($_smarty_old_error_level); } // display or fetch if ($display) { if ($this->caching && $this->cache_modified_check) { $_last_modified_date = @substr($_SERVER['HTTP_IF_MODIFIED_SINCE'], 0, strpos($_SERVER['HTTP_IF_MODIFIED_SINCE'], 'GMT') + 3); if ($_isCached && $_gmt_mtime == $_last_modified_date) { if (php_sapi_name() == 'cgi') header('Status: 304 Not Modified'); else header('HTTP/1.1 304 Not Modified'); } else { header('Last-Modified: ' . gmdate('D, d M Y H:i:s', $_template->getCachedTimestamp()) . ' GMT'); echo $_output; } } else { echo $_output; } // debug output if ($this->debugging) { Smarty_Internal_Debug::display_debug($this); } return; } else { // return fetched content return $_output; } } /** * displays a Smarty template * * @param string $ |object $template the resource handle of the template file or template object * @param mixed $cache_id cache id to be used with this template * @param mixed $compile_id compile id to be used with this template * @param object $parent next higher level of Smarty variables */ public function display($template, $cache_id = null, $compile_id = null, $parent = null) { // display template $this->fetch ($template, $cache_id, $compile_id, $parent, true); } /** * test if cache i valid * * @param string $ |object $template the resource handle of the template file or template object * @param mixed $cache_id cache id to be used with this template * @param mixed $compile_id compile id to be used with this template * @param object $parent next higher level of Smarty variables * @return boolean cache status */ public function isCached($template, $cache_id = null, $compile_id = null, $parent = null) { if ($parent === null) { $parent = $this; } if (!($template instanceof $this->template_class)) { $template = $this->createTemplate ($template, $cache_id, $compile_id, $parent, false); } // return cache status of template return $template->isCached(); } /** * creates a data object * * @param object $parent next higher level of Smarty variables * @returns object data object */ public function createData($parent = null) { return new Smarty_Data($parent, $this); } /** * creates a template object * * @param string $template the resource handle of the template file * @param mixed $cache_id cache id to be used with this template * @param mixed $compile_id compile id to be used with this template * @param object $parent next higher level of Smarty variables * @param boolean $do_clone flag is Smarty object shall be cloned * @returns object template object */ public function createTemplate($template, $cache_id = null, $compile_id = null, $parent = null, $do_clone = true) { if (!empty($cache_id) && (is_object($cache_id) || is_array($cache_id))) { $parent = $cache_id; $cache_id = null; } if (!empty($parent) && is_array($parent)) { $data = $parent; $parent = null; } else { $data = null; } if (!is_object($template)) { // we got a template resource // already in template cache? $_templateId = sha1($template . $cache_id . $compile_id); if (isset($this->template_objects[$_templateId]) && $this->caching) { // return cached template object $tpl = $this->template_objects[$_templateId]; } else { // create new template object if ($do_clone) { $tpl = new $this->template_class($template, clone $this, $parent, $cache_id, $compile_id); } else { $tpl = new $this->template_class($template, $this, $parent, $cache_id, $compile_id); } } } else { // just return a copy of template class $tpl = $template; } // fill data if present if (!empty($data) && is_array($data)) { // set up variable values foreach ($data as $_key => $_val) { $tpl->tpl_vars[$_key] = new Smarty_variable($_val); } } return $tpl; } /** * Check if a template resource exists * * @param string $resource_name template name * @return boolean status */ function templateExists($resource_name) { // create template object $save = $this->template_objects; $tpl = new $this->template_class($resource_name, $this); // check if it does exists $result = $tpl->isExisting(); $this->template_objects = $save; return $result; } /** * Returns a single or all global variables * * @param object $smarty * @param string $varname variable name or null * @return string variable value or or array of variables */ function getGlobal($varname = null) { if (isset($varname)) { if (isset(self::$global_tpl_vars[$varname])) { return self::$global_tpl_vars[$varname]->value; } else { return ''; } } else { $_result = array(); foreach (self::$global_tpl_vars AS $key => $var) { $_result[$key] = $var->value; } return $_result; } } /** * Empty cache folder * * @param integer $exp_time expiration time * @param string $type resource type * @return integer number of cache files deleted */ function clearAllCache($exp_time = null, $type = null) { // load cache resource and call clearAll return $this->loadCacheResource($type)->clearAll($exp_time); } /** * Empty cache for a specific template * * @param string $template_name template name * @param string $cache_id cache id * @param string $compile_id compile id * @param integer $exp_time expiration time * @param string $type resource type * @return integer number of cache files deleted */ function clearCache($template_name, $cache_id = null, $compile_id = null, $exp_time = null, $type = null) { // load cache resource and call clear return $this->loadCacheResource($type)->clear($template_name, $cache_id, $compile_id, $exp_time); } /** * Loads security class and enables security */ public function enableSecurity($security_class = null) { if ($security_class instanceof Smarty_Security) { $this->security_policy = $security_class; return; } if ($security_class == null) { $security_class = $this->security_class; } if (class_exists($security_class)) { $this->security_policy = new $security_class($this); } else { throw new SmartyException("Security class '$security_class' is not defined"); } } /** * Disable security */ public function disableSecurity() { $this->security_policy = null; } /** * Loads cache resource. * * @param string $type cache resource type * @return object of cache resource */ public function loadCacheResource($type = null) { if (!isset($type)) { $type = $this->caching_type; } if (in_array($type, $this->cache_resource_types)) { $cache_resource_class = 'Smarty_Internal_CacheResource_' . ucfirst($type); return new $cache_resource_class($this); } else { // try plugins dir $cache_resource_class = 'Smarty_CacheResource_' . ucfirst($type); if ($this->loadPlugin($cache_resource_class)) { return new $cache_resource_class($this); } else { throw new SmartyException("Unable to load cache resource '{$type}'"); } } } /** * Set template directory * * @param string $ |array $template_dir folder(s) of template sorces */ public function setTemplateDir($template_dir) { $this->template_dir = (array)$template_dir; return; } /** * Adds template directory(s) to existing ones * * @param string $ |array $template_dir folder(s) of template sources */ public function addTemplateDir($template_dir) { $this->template_dir = array_unique(array_merge((array)$this->template_dir, (array)$template_dir)); return; } /** * Adds directory of plugin files * * @param object $smarty * @param string $ |array $ plugins folder * @return */ function addPluginsDir($plugins_dir) { $this->plugins_dir = array_unique(array_merge((array)$this->plugins_dir, (array)$plugins_dir)); return; } /** * return a reference to a registered object * * @param string $name object name * @return object */ function getRegisteredObject($name) { if (!isset($this->registered_objects[$name])) throw new SmartyException("'$name' is not a registered object"); if (!is_object($this->registered_objects[$name][0])) throw new SmartyException("registered '$name' is not an object"); return $this->registered_objects[$name][0]; } /** * return name of debugging template * * @return string */ function getDebugTemplate() { return $this->debug_tpl; } /** * set the debug template * * @param string $tpl_name * @return bool */ function setDebugTemplate($tpl_name) { return $this->debug_tpl = $tpl_name; } /** * Takes unknown classes and loads plugin files for them * class name format: Smarty_PluginType_PluginName * plugin filename format: plugintype.pluginname.php * * @param string $plugin_name class plugin name to load * @return string |boolean filepath of loaded file or false */ public function loadPlugin($plugin_name, $check = true) { // if function or class exists, exit silently (already loaded) if ($check && (is_callable($plugin_name) || class_exists($plugin_name, false))) return true; // Plugin name is expected to be: Smarty_[Type]_[Name] $_plugin_name = strtolower($plugin_name); $_name_parts = explode('_', $_plugin_name, 3); // class name must have three parts to be valid plugin if (count($_name_parts) < 3 || $_name_parts[0] !== 'smarty') { throw new SmartyException("plugin {$plugin_name} is not a valid name format"); return false; } // if type is "internal", get plugin from sysplugins if ($_name_parts[1] == 'internal') { $file = SMARTY_SYSPLUGINS_DIR . $_plugin_name . '.php'; if (file_exists($file)) { require_once($file); return $file; } else { return false; } } // plugin filename is expected to be: [type].[name].php $_plugin_filename = "{$_name_parts[1]}.{$_name_parts[2]}.php"; // loop through plugin dirs and find the plugin foreach((array)$this->plugins_dir as $_plugin_dir) { if (strpos('/\\', substr($_plugin_dir, -1)) === false) { $_plugin_dir .= DS; } $file = $_plugin_dir . $_plugin_filename; if (file_exists($file)) { require_once($file); return $file; } } // no plugin loaded return false; } /** * clean up properties on cloned object */ public function __clone() { // clear config vars $this->config_vars = array(); // clear assigned tpl vars $this->tpl_vars = array(); // clear objects for external methods unset($this->register); unset($this->filter); } /** * Handle unknown class methods * * @param string $name unknown methode name * @param array $args aurgument array */ public function __call($name, $args) { static $camel_func; if (!isset($camel_func)) $camel_func = create_function('$c', 'return "_" . strtolower($c[1]);'); // see if this is a set/get for a property $first3 = strtolower(substr($name, 0, 3)); if (in_array($first3, array('set', 'get')) && substr($name, 3, 1) !== '_') { // try to keep case correct for future PHP 6.0 case-sensitive class methods // lcfirst() not available < PHP 5.3.0, so improvise $property_name = strtolower(substr($name, 3, 1)) . substr($name, 4); // convert camel case to underscored name $property_name = preg_replace_callback('/([A-Z])/', $camel_func, $property_name); if (!property_exists($this, $property_name)) { throw new SmartyException("property '$property_name' does not exist."); return false; } if ($first3 == 'get') return $this->$property_name; else return $this->$property_name = $args[0]; } // Smarty Backward Compatible wrapper if (strpos($name,'_') !== false) { if (!isset($this->wrapper)) { $this->wrapper = new Smarty_Internal_Wrapper($this); } return $this->wrapper->convert($name, $args); } // external Smarty methods ? foreach(array('filter','register') as $external) { if (method_exists("Smarty_Internal_{$external}",$name)) { if (!isset($this->$external)) { $class = "Smarty_Internal_{$external}"; $this->$external = new $class($this); } return call_user_func_array(array($this->$external,$name), $args); } } if (in_array($name,array('clearCompiledTemplate','compileAllTemplates','compileAllConfig','testInstall','getTags'))) { if (!isset($this->utility)) { $this->utility = new Smarty_Internal_Utility($this); } return call_user_func_array(array($this->utility,$name), $args); } // PHP4 call to constructor? if (strtolower($name) == 'smarty') { throw new SmartyException('Please use parent::__construct() to call parent constuctor'); return false; } throw new SmartyException("Call of unknown function '$name'."); } } /** * Autoloader */ function smartyAutoload($class) { $_class = strtolower($class); if (substr($_class, 0, 16) === 'smarty_internal_' || $_class == 'smarty_security') { include SMARTY_SYSPLUGINS_DIR . $_class . '.php'; } } /** * Smarty exception class */ Class SmartyException extends Exception { } /** * Smarty compiler exception class */ Class SmartyCompilerException extends SmartyException { } ?>