123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473 |
- <?php
- /**
- * Project: Smarty: the PHP compiling template engine
- * File: Smarty.class.php
- * SVN: $Id: Smarty.class.php 2504 2011-12-28 07:35:29Z liu21st $
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; either
- * version 2.1 of the License, or (at your option) any later version.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
- *
- * For questions, help, comments, discussion, etc., please join the
- * Smarty mailing list. Send a blank e-mail to
- * smarty-discussion-subscribe@googlegroups.com
- *
- * @link http://www.smarty.net/
- * @copyright 2008 New Digital Group, Inc.
- * @author Monte Ohrt <monte at ohrt dot com>
- * @author Uwe Tews
- * @author Rodney Rehm
- * @package Smarty
- * @version 3.1.6
- */
- /**
- * 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_MBSTRING')) {
- define('SMARTY_MBSTRING', function_exists('mb_strlen'));
- }
- if (!defined('SMARTY_RESOURCE_CHAR_SET')) {
- // UTF-8 can only be done properly when mbstring is available!
- define('SMARTY_RESOURCE_CHAR_SET', SMARTY_MBSTRING ? 'UTF-8' : 'ISO-8859-1');
- }
- 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');
- }
- /**
- * Load always needed external class files
- */
- include_once SMARTY_SYSPLUGINS_DIR.'smarty_internal_data.php';
- include_once SMARTY_SYSPLUGINS_DIR.'smarty_internal_templatebase.php';
- include_once SMARTY_SYSPLUGINS_DIR.'smarty_internal_template.php';
- include_once SMARTY_SYSPLUGINS_DIR.'smarty_resource.php';
- include_once SMARTY_SYSPLUGINS_DIR.'smarty_internal_resource_file.php';
- include_once SMARTY_SYSPLUGINS_DIR.'smarty_cacheresource.php';
- include_once SMARTY_SYSPLUGINS_DIR.'smarty_internal_cacheresource_file.php';
- /**
- * This is the main Smarty class
- * @package Smarty
- */
- class Smarty extends Smarty_Internal_TemplateBase {
- /**#@+
- * constant definitions
- */
- /**
- * smarty version
- */
- const SMARTY_VERSION = 'Smarty-3.1.6';
- /**
- * 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;
- /**
- * define compile check modes
- */
- const COMPILECHECK_OFF = 0;
- const COMPILECHECK_ON = 1;
- const COMPILECHECK_CACHEMISS = 2;
- /**
- * modes for handling of "<?php ... ?>" 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';
- const PLUGIN_MODIFIERCOMPILER = 'modifiercompiler';
- /**#@-*/
- /**
- * assigned global tpl vars
- */
- public static $global_tpl_vars = array();
- /**
- * error handler returned by set_error_hanlder() in Smarty::muteExpectedErrors()
- */
- public static $_previous_error_handler = null;
- /**
- * contains directories outside of SMARTY_DIR that are to be muted by muteExpectedErrors()
- */
- public static $_muted_directories = array();
- /**#@+
- * variables
- */
- /**
- * auto literal on delimiters with whitspace
- * @var boolean
- */
- public $auto_literal = true;
- /**
- * display error on not assigned variables
- * @var boolean
- */
- public $error_unassigned = false;
- /**
- * look up relative filepaths in include_path
- * @var boolean
- */
- public $use_include_path = false;
- /**
- * template directory
- * @var array
- */
- private $template_dir = array();
- /**
- * joined template directory string used in cache keys
- * @var string
- */
- public $joined_template_dir = null;
- /**
- * joined config directory string used in cache keys
- * @var string
- */
- public $joined_config_dir = null;
- /**
- * default template handler
- * @var callable
- */
- public $default_template_handler_func = null;
- /**
- * default config handler
- * @var callable
- */
- public $default_config_handler_func = null;
- /**
- * default plugin handler
- * @var callable
- */
- public $default_plugin_handler_func = null;
- /**
- * compile directory
- * @var string
- */
- private $compile_dir = null;
- /**
- * plugins directory
- * @var array
- */
- private $plugins_dir = array();
- /**
- * cache directory
- * @var string
- */
- private $cache_dir = null;
- /**
- * config directory
- * @var array
- */
- private $config_dir = array();
- /**
- * force template compiling?
- * @var boolean
- */
- public $force_compile = false;
- /**
- * check template for modifications?
- * @var boolean
- */
- public $compile_check = true;
- /**
- * use sub dirs for compiled/cached files?
- * @var boolean
- */
- public $use_sub_dirs = false;
- /**
- * allow ambiguous resources (that are made unique by the resource handler)
- * @var boolean
- */
- public $allow_ambiguous_resources = false;
- /**
- * caching enabled
- * @var boolean
- */
- public $caching = false;
- /**
- * merge compiled includes
- * @var boolean
- */
- public $merge_compiled_includes = false;
- /**
- * cache lifetime in seconds
- * @var integer
- */
- public $cache_lifetime = 3600;
- /**
- * force cache file creation
- * @var boolean
- */
- public $force_cache = false;
- /**
- * Set this if you want different sets of cache files for the same
- * templates.
- *
- * @var string
- */
- public $cache_id = null;
- /**
- * Set this if you want different sets of compiled files for the same
- * templates.
- *
- * @var string
- */
- public $compile_id = null;
- /**
- * template left-delimiter
- * @var string
- */
- public $left_delimiter = "{";
- /**
- * template right-delimiter
- * @var string
- */
- public $right_delimiter = "}";
- /**#@+
- * security
- */
- /**
- * class name
- *
- * This should be instance of Smarty_Security.
- *
- * @var string
- * @see Smarty_Security
- */
- public $security_class = 'Smarty_Security';
- /**
- * implementation of security class
- *
- * @var Smarty_Security
- */
- public $security_policy = null;
- /**
- * controls handling of PHP-blocks
- *
- * @var integer
- */
- public $php_handling = self::PHP_PASSTHRU;
- /**
- * controls if the php template file resource is allowed
- *
- * @var bool
- */
- public $allow_php_templates = false;
- /**
- * Should compiled-templates be prevented from being called directly?
- *
- * {@internal
- * Currently used by Smarty_Internal_Template only.
- * }}
- *
- * @var boolean
- */
- public $direct_access_security = true;
- /**#@-*/
- /**
- * debug mode
- *
- * Setting this to true enables the debug-console.
- *
- * @var boolean
- */
- public $debugging = false;
- /**
- * This determines if debugging is enable-able from the browser.
- * <ul>
- * <li>NONE => no debugging control allowed</li>
- * <li>URL => enable debugging when SMARTY_DEBUG is found in the URL.</li>
- * </ul>
- * @var string
- */
- public $debugging_ctrl = 'NONE';
- /**
- * Name of debugging URL-param.
- *
- * Only used when $debugging_ctrl is set to 'URL'.
- * The name of the URL-parameter that activates debugging.
- *
- * @var type
- */
- public $smarty_debug_id = 'SMARTY_DEBUG';
- /**
- * Path of debug template.
- * @var string
- */
- public $debug_tpl = null;
- /**
- * When set, smarty uses this value as error_reporting-level.
- * @var int
- */
- public $error_reporting = null;
- /**
- * Internal flag for getTags()
- * @var boolean
- */
- public $get_used_tags = false;
- /**#@+
- * config var settings
- */
- /**
- * Controls whether variables with the same name overwrite each other.
- * @var boolean
- */
- public $config_overwrite = true;
- /**
- * Controls whether config values of on/true/yes and off/false/no get converted to boolean.
- * @var boolean
- */
- public $config_booleanize = true;
- /**
- * Controls whether hidden config sections/vars are read from the file.
- * @var boolean
- */
- public $config_read_hidden = false;
- /**#@-*/
- /**#@+
- * resource locking
- */
- /**
- * locking concurrent compiles
- * @var boolean
- */
- public $compile_locking = true;
- /**
- * Controls whether cache resources should emply locking mechanism
- * @var boolean
- */
- public $cache_locking = false;
- /**
- * seconds to wait for acquiring a lock before ignoring the write lock
- * @var float
- */
- public $locking_timeout = 10;
- /**#@-*/
- /**
- * global template functions
- * @var array
- */
- public $template_functions = array();
- /**
- * resource type used if none given
- *
- * Must be an valid key of $registered_resources.
- * @var string
- */
- public $default_resource_type = 'file';
- /**
- * caching type
- *
- * Must be an element of $cache_resource_types.
- *
- * @var string
- */
- public $caching_type = 'file';
- /**
- * internal config properties
- * @var array
- */
- public $properties = array();
- /**
- * config type
- * @var string
- */
- public $default_config_type = 'file';
- /**
- * cached template objects
- * @var array
- */
- public $template_objects = array();
- /**
- * check If-Modified-Since headers
- * @var boolean
- */
- public $cache_modified_check = false;
- /**
- * registered plugins
- * @var array
- */
- public $registered_plugins = array();
- /**
- * plugin search order
- * @var array
- */
- public $plugin_search_order = array('function', 'block', 'compiler', 'class');
- /**
- * registered objects
- * @var array
- */
- public $registered_objects = array();
- /**
- * registered classes
- * @var array
- */
- public $registered_classes = array();
- /**
- * registered filters
- * @var array
- */
- public $registered_filters = array();
- /**
- * registered resources
- * @var array
- */
- public $registered_resources = array();
- /**
- * resource handler cache
- * @var array
- */
- public $_resource_handlers = array();
- /**
- * registered cache resources
- * @var array
- */
- public $registered_cache_resources = array();
- /**
- * cache resource handler cache
- * @var array
- */
- public $_cacheresource_handlers = array();
- /**
- * autoload filter
- * @var array
- */
- public $autoload_filters = array();
- /**
- * default modifier
- * @var array
- */
- public $default_modifiers = array();
- /**
- * autoescape variable output
- * @var boolean
- */
- public $escape_html = false;
- /**
- * global internal smarty vars
- * @var array
- */
- public static $_smarty_vars = array();
- /**
- * start time for execution time calculation
- * @var int
- */
- public $start_time = 0;
- /**
- * default file permissions
- * @var int
- */
- public $_file_perms = 0644;
- /**
- * default dir permissions
- * @var int
- */
- public $_dir_perms = 0771;
- /**
- * block tag hierarchy
- * @var array
- */
- public $_tag_stack = array();
- /**
- * self pointer to Smarty object
- * @var Smarty
- */
- public $smarty;
- /**
- * required by the compiler for BC
- * @var string
- */
- public $_current_file = null;
- /**
- * internal flag to enable parser debugging
- * @var bool
- */
- public $_parserdebug = false;
- /**
- * Saved parameter of merged templates during compilation
- *
- * @var array
- */
- public $merged_templates_func = array();
- /**#@-*/
- /**
- * Initialize new Smarty object
- *
- */
- public function __construct()
- {
- // selfpointer needed 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->setTemplateDir('.' . DS . 'templates' . DS)
- ->setCompileDir('.' . DS . 'templates_c' . DS)
- ->setPluginsDir(SMARTY_PLUGINS_DIR)
- ->setCacheDir('.' . DS . 'cache' . DS)
- ->setConfigDir('.' . DS . 'configs' . DS);
- $this->debug_tpl = 'file:' . dirname(__FILE__) . '/debug.tpl';
- if (isset($_SERVER['SCRIPT_NAME'])) {
- $this->assignGlobal('SCRIPT_NAME', $_SERVER['SCRIPT_NAME']);
- }
- }
- /**
- * Class destructor
- */
- public function __destruct()
- {
- // intentionally left blank
- }
- /**
- * <<magic>> set selfpointer on cloned object
- */
- public function __clone()
- {
- $this->smarty = $this;
- }
- /**
- * <<magic>> Generic getter.
- *
- * Calls the appropriate getter function.
- * Issues an E_USER_NOTICE if no valid getter is found.
- *
- * @param string $name property name
- * @return mixed
- */
- public function __get($name)
- {
- $allowed = array(
- 'template_dir' => 'getTemplateDir',
- 'config_dir' => 'getConfigDir',
- 'plugins_dir' => 'getPluginsDir',
- 'compile_dir' => 'getCompileDir',
- 'cache_dir' => 'getCacheDir',
- );
- if (isset($allowed[$name])) {
- return $this->{$allowed[$name]}();
- } else {
- trigger_error('Undefined property: '. get_class($this) .'::$'. $name, E_USER_NOTICE);
- }
- }
- /**
- * <<magic>> Generic setter.
- *
- * Calls the appropriate setter function.
- * Issues an E_USER_NOTICE if no valid setter is found.
- *
- * @param string $name property name
- * @param mixed $value parameter passed to setter
- */
- public function __set($name, $value)
- {
- $allowed = array(
- 'template_dir' => 'setTemplateDir',
- 'config_dir' => 'setConfigDir',
- 'plugins_dir' => 'setPluginsDir',
- 'compile_dir' => 'setCompileDir',
- 'cache_dir' => 'setCacheDir',
- );
- if (isset($allowed[$name])) {
- $this->{$allowed[$name]}($value);
- } else {
- trigger_error('Undefined property: ' . get_class($this) . '::$' . $name, E_USER_NOTICE);
- }
- }
- /**
- * Check if a template resource exists
- *
- * @param string $resource_name template name
- * @return boolean status
- */
- public 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->source->exists;
- $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
- */
- public 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
- $_cache_resource = Smarty_CacheResource::load($this, $type);
- Smarty_CacheResource::invalidLoadedCache($this);
- return $_cache_resource->clearAll($this, $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
- */
- public function clearCache($template_name, $cache_id = null, $compile_id = null, $exp_time = null, $type = null)
- {
- // load cache resource and call clear
- $_cache_resource = Smarty_CacheResource::load($this, $type);
- Smarty_CacheResource::invalidLoadedCache($this);
- return $_cache_resource->clear($this, $template_name, $cache_id, $compile_id, $exp_time);
- }
- /**
- * Loads security class and enables security
- *
- * @param string|Smarty_Security $security_class if a string is used, it must be class-name
- * @return Smarty current Smarty instance for chaining
- * @throws SmartyException when an invalid class name is provided
- */
- public function enableSecurity($security_class = null)
- {
- if ($security_class instanceof Smarty_Security) {
- $this->security_policy = $security_class;
- return $this;
- } elseif (is_object($security_class)) {
- throw new SmartyException("Class '" . get_class($security_class) . "' must extend Smarty_Security.");
- }
- if ($security_class == null) {
- $security_class = $this->security_class;
- }
- if (!class_exists($security_class)) {
- throw new SmartyException("Security class '$security_class' is not defined");
- } elseif ($security_class !== 'Smarty_Security' && !is_subclass_of($security_class, 'Smarty_Security')) {
- throw new SmartyException("Class '$security_class' must extend Smarty_Security.");
- } else {
- $this->security_policy = new $security_class($this);
- }
- return $this;
- }
- /**
- * Disable security
- * @return Smarty current Smarty instance for chaining
- */
- public function disableSecurity()
- {
- $this->security_policy = null;
- return $this;
- }
- /**
- * Set template directory
- *
- * @param string|array $template_dir directory(s) of template sources
- * @return Smarty current Smarty instance for chaining
- */
- public function setTemplateDir($template_dir)
- {
- $this->template_dir = array();
- foreach ((array) $template_dir as $k => $v) {
- $this->template_dir[$k] = rtrim($v, '/\\') . DS;
- }
- $this->joined_template_dir = join(DIRECTORY_SEPARATOR, $this->template_dir);
- return $this;
- }
- /**
- * Add template directory(s)
- *
- * @param string|array $template_dir directory(s) of template sources
- * @param string $key of the array element to assign the template dir to
- * @return Smarty current Smarty instance for chaining
- * @throws SmartyException when the given template directory is not valid
- */
- public function addTemplateDir($template_dir, $key=null)
- {
- // make sure we're dealing with an array
- $this->template_dir = (array) $this->template_dir;
- if (is_array($template_dir)) {
- foreach ($template_dir as $k => $v) {
- if (is_int($k)) {
- // indexes are not merged but appended
- $this->template_dir[] = rtrim($v, '/\\') . DS;
- } else {
- // string indexes are overridden
- $this->template_dir[$k] = rtrim($v, '/\\') . DS;
- }
- }
- } elseif ($key !== null) {
- // override directory at specified index
- $this->template_dir[$key] = rtrim($template_dir, '/\\') . DS;
- } else {
- // append new directory
- $this->template_dir[] = rtrim($template_dir, '/\\') . DS;
- }
- $this->joined_template_dir = join(DIRECTORY_SEPARATOR, $this->template_dir);
- return $this;
- }
- /**
- * Get template directories
- *
- * @param mixed index of directory to get, null to get all
- * @return array|string list of template directories, or directory of $index
- */
- public function getTemplateDir($index=null)
- {
- if ($index !== null) {
- return isset($this->template_dir[$index]) ? $this->template_dir[$index] : null;
- }
- return (array)$this->template_dir;
- }
- /**
- * Set config directory
- *
- * @param string|array $template_dir directory(s) of configuration sources
- * @return Smarty current Smarty instance for chaining
- */
- public function setConfigDir($config_dir)
- {
- $this->config_dir = array();
- foreach ((array) $config_dir as $k => $v) {
- $this->config_dir[$k] = rtrim($v, '/\\') . DS;
- }
- $this->joined_config_dir = join(DIRECTORY_SEPARATOR, $this->config_dir);
- return $this;
- }
- /**
- * Add config directory(s)
- *
- * @param string|array $config_dir directory(s) of config sources
- * @param string key of the array element to assign the config dir to
- * @return Smarty current Smarty instance for chaining
- */
- public function addConfigDir($config_dir, $key=null)
- {
- // make sure we're dealing with an array
- $this->config_dir = (array) $this->config_dir;
- if (is_array($config_dir)) {
- foreach ($config_dir as $k => $v) {
- if (is_int($k)) {
- // indexes are not merged but appended
- $this->config_dir[] = rtrim($v, '/\\') . DS;
- } else {
- // string indexes are overridden
- $this->config_dir[$k] = rtrim($v, '/\\') . DS;
- }
- }
- } elseif( $key !== null ) {
- // override directory at specified index
- $this->config_dir[$key] = rtrim($config_dir, '/\\') . DS;
- } else {
- // append new directory
- $this->config_dir[] = rtrim($config_dir, '/\\') . DS;
- }
- $this->joined_config_dir = join(DIRECTORY_SEPARATOR, $this->config_dir);
- return $this;
- }
- /**
- * Get config directory
- *
- * @param mixed index of directory to get, null to get all
- * @return array|string configuration directory
- */
- public function getConfigDir($index=null)
- {
- if ($index !== null) {
- return isset($this->config_dir[$index]) ? $this->config_dir[$index] : null;
- }
- return (array)$this->config_dir;
- }
- /**
- * Set plugins directory
- *
- * @param string|array $plugins_dir directory(s) of plugins
- * @return Smarty current Smarty instance for chaining
- */
- public function setPluginsDir($plugins_dir)
- {
- $this->plugins_dir = array();
- foreach ((array)$plugins_dir as $k => $v) {
- $this->plugins_dir[$k] = rtrim($v, '/\\') . DS;
- }
- return $this;
- }
- /**
- * Adds directory of plugin files
- *
- * @param object $smarty
- * @param string $ |array $ plugins folder
- * @return Smarty current Smarty instance for chaining
- */
- public function addPluginsDir($plugins_dir)
- {
- // make sure we're dealing with an array
- $this->plugins_dir = (array) $this->plugins_dir;
- if (is_array($plugins_dir)) {
- foreach ($plugins_dir as $k => $v) {
- if (is_int($k)) {
- // indexes are not merged but appended
- $this->plugins_dir[] = rtrim($v, '/\\') . DS;
- } else {
- // string indexes are overridden
- $this->plugins_dir[$k] = rtrim($v, '/\\') . DS;
- }
- }
- } else {
- // append new directory
- $this->plugins_dir[] = rtrim($plugins_dir, '/\\') . DS;
- }
- $this->plugins_dir = array_unique($this->plugins_dir);
- return $this;
- }
- /**
- * Get plugin directories
- *
- * @return array list of plugin directories
- */
- public function getPluginsDir()
- {
- return (array)$this->plugins_dir;
- }
- /**
- * Set compile directory
- *
- * @param string $compile_dir directory to store compiled templates in
- * @return Smarty current Smarty instance for chaining
- */
- public function setCompileDir($compile_dir)
- {
- $this->compile_dir = rtrim($compile_dir, '/\\') . DS;
- if (!isset(Smarty::$_muted_directories[$this->compile_dir])) {
- Smarty::$_muted_directories[$this->compile_dir] = null;
- }
- return $this;
- }
- /**
- * Get compiled directory
- *
- * @return string path to compiled templates
- */
- public function getCompileDir()
- {
- return $this->compile_dir;
- }
- /**
- * Set cache directory
- *
- * @param string $cache_dir directory to store cached templates in
- * @return Smarty current Smarty instance for chaining
- */
- public function setCacheDir($cache_dir)
- {
- $this->cache_dir = rtrim($cache_dir, '/\\') . DS;
- if (!isset(Smarty::$_muted_directories[$this->cache_dir])) {
- Smarty::$_muted_directories[$this->cache_dir] = null;
- }
- return $this;
- }
- /**
- * Get cache directory
- *
- * @return string path of cache directory
- */
- public function getCacheDir()
- {
- return $this->cache_dir;
- }
- /**
- * Set default modifiers
- *
- * @param array|string $modifiers modifier or list of modifiers to set
- * @return Smarty current Smarty instance for chaining
- */
- public function setDefaultModifiers($modifiers)
- {
- $this->default_modifiers = (array) $modifiers;
- return $this;
- }
- /**
- * Add default modifiers
- *
- * @param array|string $modifiers modifier or list of modifiers to add
- * @return Smarty current Smarty instance for chaining
- */
- public function addDefaultModifiers($modifiers)
- {
- if (is_array($modifiers)) {
- $this->default_modifiers = array_merge($this->default_modifiers, $modifiers);
- } else {
- $this->default_modifiers[] = $modifiers;
- }
- return $this;
- }
- /**
- * Get default modifiers
- *
- * @return array list of default modifiers
- */
- public function getDefaultModifiers()
- {
- return $this->default_modifiers;
- }
- /**
- * Set autoload filters
- *
- * @param array $filters filters to load automatically
- * @param string $type "pre", "output", … specify the filter type to set. Defaults to none treating $filters' keys as the appropriate types
- * @return Smarty current Smarty instance for chaining
- */
- public function setAutoloadFilters($filters, $type=null)
- {
- if ($type !== null) {
- $this->autoload_filters[$type] = (array) $filters;
- } else {
- $this->autoload_filters = (array) $filters;
- }
- return $this;
- }
- /**
- * Add autoload filters
- *
- * @param array $filters filters to load automatically
- * @param string $type "pre", "output", … specify the filter type to set. Defaults to none treating $filters' keys as the appropriate types
- * @return Smarty current Smarty instance for chaining
- */
- public function addAutoloadFilters($filters, $type=null)
- {
- if ($type !== null) {
- if (!empty($this->autoload_filters[$type])) {
- $this->autoload_filters[$type] = array_merge($this->autoload_filters[$type], (array) $filters);
- } else {
- $this->autoload_filters[$type] = (array) $filters;
- }
- } else {
- foreach ((array) $filters as $key => $value) {
- if (!empty($this->autoload_filters[$key])) {
- $this->autoload_filters[$key] = array_merge($this->autoload_filters[$key], (array) $value);
- } else {
- $this->autoload_filters[$key] = (array) $value;
- }
- }
- }
- return $this;
- }
- /**
- * Get autoload filters
- *
- * @param string $type type of filter to get autoloads for. Defaults to all autoload filters
- * @return array array( 'type1' => array( 'filter1', 'filter2', … ) ) or array( 'filter1', 'filter2', …) if $type was specified
- */
- public function getAutoloadFilters($type=null)
- {
- if ($type !== null) {
- return isset($this->autoload_filters[$type]) ? $this->autoload_filters[$type] : array();
- }
- return $this->autoload_filters;
- }
- /**
- * return name of debugging template
- *
- * @return string
- */
- public function getDebugTemplate()
- {
- return $this->debug_tpl;
- }
- /**
- * set the debug template
- *
- * @param string $tpl_name
- * @return Smarty current Smarty instance for chaining
- * @throws SmartyException if file is not readable
- */
- public function setDebugTemplate($tpl_name)
- {
- if (!is_readable($tpl_name)) {
- throw new SmartyException("Unknown file '{$tpl_name}'");
- }
- $this->debug_tpl = $tpl_name;
- return $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
- * @return 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;
- }
- // default to cache_id and compile_id of Smarty object
- $cache_id = $cache_id === null ? $this->cache_id : $cache_id;
- $compile_id = $compile_id === null ? $this->compile_id : $compile_id;
- // already in template cache?
- if ($this->allow_ambiguous_resources) {
- $_templateId = Smarty_Resource::getUniqueTemplateName($this, $template) . $cache_id . $compile_id;
- } else {
- $_templateId = $this->joined_template_dir . '#' . $template . $cache_id . $compile_id;
- }
- if (isset($_templateId[150])) {
- $_templateId = sha1($_templateId);
- }
- if ($do_clone) {
- if (isset($this->template_objects[$_templateId])) {
- // return cached template object
- $tpl = clone $this->template_objects[$_templateId];
- $tpl->smarty = clone $tpl->smarty;
- $tpl->parent = $parent;
- $tpl->tpl_vars = array();
- $tpl->config_vars = array();
- } else {
- $tpl = new $this->template_class($template, clone $this, $parent, $cache_id, $compile_id);
- }
- } else {
- if (isset($this->template_objects[$_templateId])) {
- // return cached template object
- $tpl = $this->template_objects[$_templateId];
- $tpl->parent = $parent;
- $tpl->tpl_vars = array();
- $tpl->config_vars = array();
- } else {
- $tpl = new $this->template_class($template, $this, $parent, $cache_id, $compile_id);
- }
- }
- // 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;
- }
- /**
- * 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
- * @param bool $check check if already loaded
- * @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]
- $_name_parts = explode('_', $plugin_name, 3);
- // class name must have three parts to be valid plugin
- // count($_name_parts) < 3 === !isset($_name_parts[2])
- if (!isset($_name_parts[2]) || strtolower($_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 (strtolower($_name_parts[1]) == 'internal') {
- $file = SMARTY_SYSPLUGINS_DIR . strtolower($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($this->getPluginsDir() as $_plugin_dir) {
- $names = array(
- $_plugin_dir . $_plugin_filename,
- $_plugin_dir . strtolower($_plugin_filename),
- );
- foreach ($names as $file) {
- if (file_exists($file)) {
- require_once($file);
- return $file;
- }
- if ($this->use_include_path && !preg_match('/^([\/\\\\]|[a-zA-Z]:[\/\\\\])/', $_plugin_dir)) {
- // try PHP include_path
- if (($file = Smarty_Internal_Get_Include_Path::getIncludePath($file)) !== false) {
- require_once($file);
- return $file;
- }
- }
- }
- }
- // no plugin loaded
- return false;
- }
- /**
- * Compile all template files
- *
- * @param string $extension file extension
- * @param bool $force_compile force all to recompile
- * @param int $time_limit
- * @param int $max_errors
- * @return integer number of template files recompiled
- */
- public function compileAllTemplates($extention = '.tpl', $force_compile = false, $time_limit = 0, $max_errors = null)
- {
- return Smarty_Internal_Utility::compileAllTemplates($extention, $force_compile, $time_limit, $max_errors, $this);
- }
- /**
- * Compile all config files
- *
- * @param string $extension file extension
- * @param bool $force_compile force all to recompile
- * @param int $time_limit
- * @param int $max_errors
- * @return integer number of template files recompiled
- */
- public function compileAllConfig($extention = '.conf', $force_compile = false, $time_limit = 0, $max_errors = null)
- {
- return Smarty_Internal_Utility::compileAllConfig($extention, $force_compile, $time_limit, $max_errors, $this);
- }
- /**
- * Delete compiled template file
- *
- * @param string $resource_name template name
- * @param string $compile_id compile id
- * @param integer $exp_time expiration time
- * @return integer number of template files deleted
- */
- public function clearCompiledTemplate($resource_name = null, $compile_id = null, $exp_time = null)
- {
- return Smarty_Internal_Utility::clearCompiledTemplate($resource_name, $compile_id, $exp_time, $this);
- }
- /**
- * Return array of tag/attributes of all tags used by an template
- *
- * @param object $templae template object
- * @return array of tag/attributes
- */
- public function getTags(Smarty_Internal_Template $template)
- {
- return Smarty_Internal_Utility::getTags($template);
- }
- /**
- * Run installation test
- *
- * @param array $errors Array to write errors into, rather than outputting them
- * @return boolean true if setup is fine, false if something is wrong
- */
- public function testInstall(&$errors=null)
- {
- return Smarty_Internal_Utility::testInstall($this, $errors);
- }
- /**
- * Error Handler to mute expected messages
- *
- * @link http://php.net/set_error_handler
- * @param integer $errno Error level
- * @return boolean
- */
- public static function mutingErrorHandler($errno, $errstr, $errfile, $errline, $errcontext)
- {
- $_is_muted_directory = false;
- // add the SMARTY_DIR to the list of muted directories
- if (!isset(Smarty::$_muted_directories[SMARTY_DIR])) {
- $smarty_dir = realpath(SMARTY_DIR);
- Smarty::$_muted_directories[SMARTY_DIR] = array(
- 'file' => $smarty_dir,
- 'length' => strlen($smarty_dir),
- );
- }
- // walk the muted directories and test against $errfile
- foreach (Smarty::$_muted_directories as $key => &$dir) {
- if (!$dir) {
- // resolve directory and length for speedy comparisons
- $file = realpath($key);
- $dir = array(
- 'file' => $file,
- 'length' => strlen($file),
- );
- }
- if (!strncmp($errfile, $dir['file'], $dir['length'])) {
- $_is_muted_directory = true;
- break;
- }
- }
- // pass to next error handler if this error did not occur inside SMARTY_DIR
- // or the error was within smarty but masked to be ignored
- if (!$_is_muted_directory || ($errno && $errno & error_reporting())) {
- if (Smarty::$_previous_error_handler) {
- return call_user_func(Smarty::$_previous_error_handler, $errno, $errstr, $errfile, $errline, $errcontext);
- } else {
- return false;
- }
- }
- }
- /**
- * Enable error handler to mute expected messages
- *
- * @return void
- */
- public static function muteExpectedErrors()
- {
- /*
- error muting is done because some people implemented custom error_handlers using
- http://php.net/set_error_handler and for some reason did not understand the following paragraph:
- It is important to remember that the standard PHP error handler is completely bypassed for the
- error types specified by error_types unless the callback function returns FALSE.
- error_reporting() settings will have no effect and your error handler will be called regardless -
- however you are still able to read the current value of error_reporting and act appropriately.
- Of particular note is that this value will be 0 if the statement that caused the error was
- prepended by the @ error-control operator.
- Smarty deliberately uses @filemtime() over file_exists() and filemtime() in some places. Reasons include
- - @filemtime() is almost twice as fast as using an additional file_exists()
- - between file_exists() and filemtime() a possible race condition is opened,
- which does not exist using the simple @filemtime() approach.
- */
- $error_handler = array('Smarty', 'mutingErrorHandler');
- $previous = set_error_handler($error_handler);
- // avoid dead loops
- if ($previous !== $error_handler) {
- Smarty::$_previous_error_handler = $previous;
- }
- }
- /**
- * Disable error handler muting expected messages
- *
- * @return void
- */
- public static function unmuteExpectedErrors()
- {
- restore_error_handler();
- }
- }
- /**
- * Smarty exception class
- * @package Smarty
- */
- class SmartyException extends Exception {
- }
- /**
- * Smarty compiler exception class
- * @package Smarty
- */
- class SmartyCompilerException extends SmartyException {
- }
- /**
- * Autoloader
- */
- function smartyAutoload($class)
- {
- $_class = strtolower($class);
- $_classes = array(
- 'smarty_config_source' => true,
- 'smarty_config_compiled' => true,
- 'smarty_security' => true,
- 'smarty_cacheresource' => true,
- 'smarty_cacheresource_custom' => true,
- 'smarty_cacheresource_keyvaluestore' => true,
- 'smarty_resource' => true,
- 'smarty_resource_custom' => true,
- 'smarty_resource_uncompiled' => true,
- 'smarty_resource_recompiled' => true,
- );
- if (!strncmp($_class, 'smarty_internal_', 16) || isset($_classes[$_class])) {
- include SMARTY_SYSPLUGINS_DIR . $_class . '.php';
- }
- }
- ?>
|