Added Canvas 1.1.0, originally not under SCM so no historical development records...
[canvas.git] / library / smarty / Smarty_Compiler.class.php
blob1af1e573cfe7eb9e5e1c58e5c8eedb9cd539ea21
1 <?php
3 /**
4 * Project: Smarty: the PHP compiling template engine
5 * File: Smarty_Compiler.class.php
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 * @link http://smarty.php.net/
22 * @author Monte Ohrt <monte at ohrt dot com>
23 * @author Andrei Zmievski <andrei@php.net>
24 * @version 2.6.11
25 * @copyright 2001-2005 New Digital Group, Inc.
26 * @package Smarty
29 /* $Id: Smarty_Compiler.class.php,v 1.1.1.1 2006/04/26 20:43:08 bsimpson Exp $ */
31 /**
32 * Template compiling class
33 * @package Smarty
35 class Smarty_Compiler extends Smarty {
37 // internal vars
38 /**#@+
39 * @access private
41 var $_folded_blocks = array(); // keeps folded template blocks
42 var $_current_file = null; // the current template being compiled
43 var $_current_line_no = 1; // line number for error messages
44 var $_capture_stack = array(); // keeps track of nested capture buffers
45 var $_plugin_info = array(); // keeps track of plugins to load
46 var $_init_smarty_vars = false;
47 var $_permitted_tokens = array('true','false','yes','no','on','off','null');
48 var $_db_qstr_regexp = null; // regexps are setup in the constructor
49 var $_si_qstr_regexp = null;
50 var $_qstr_regexp = null;
51 var $_func_regexp = null;
52 var $_reg_obj_regexp = null;
53 var $_var_bracket_regexp = null;
54 var $_num_const_regexp = null;
55 var $_dvar_guts_regexp = null;
56 var $_dvar_regexp = null;
57 var $_cvar_regexp = null;
58 var $_svar_regexp = null;
59 var $_avar_regexp = null;
60 var $_mod_regexp = null;
61 var $_var_regexp = null;
62 var $_parenth_param_regexp = null;
63 var $_func_call_regexp = null;
64 var $_obj_ext_regexp = null;
65 var $_obj_start_regexp = null;
66 var $_obj_params_regexp = null;
67 var $_obj_call_regexp = null;
68 var $_cacheable_state = 0;
69 var $_cache_attrs_count = 0;
70 var $_nocache_count = 0;
71 var $_cache_serial = null;
72 var $_cache_include = null;
74 var $_strip_depth = 0;
75 var $_additional_newline = "\n";
77 /**#@-*/
78 /**
79 * The class constructor.
81 function Smarty_Compiler()
83 // matches double quoted strings:
84 // "foobar"
85 // "foo\"bar"
86 $this->_db_qstr_regexp = '"[^"\\\\]*(?:\\\\.[^"\\\\]*)*"';
88 // matches single quoted strings:
89 // 'foobar'
90 // 'foo\'bar'
91 $this->_si_qstr_regexp = '\'[^\'\\\\]*(?:\\\\.[^\'\\\\]*)*\'';
93 // matches single or double quoted strings
94 $this->_qstr_regexp = '(?:' . $this->_db_qstr_regexp . '|' . $this->_si_qstr_regexp . ')';
96 // matches bracket portion of vars
97 // [0]
98 // [foo]
99 // [$bar]
100 $this->_var_bracket_regexp = '\[\$?[\w\.]+\]';
102 // matches numerical constants
103 // 30
104 // -12
105 // 13.22
106 $this->_num_const_regexp = '(?:\-?\d+(?:\.\d+)?)';
108 // matches $ vars (not objects):
109 // $foo
110 // $foo.bar
111 // $foo.bar.foobar
112 // $foo[0]
113 // $foo[$bar]
114 // $foo[5][blah]
115 // $foo[5].bar[$foobar][4]
116 $this->_dvar_math_regexp = '(?:[\+\*\/\%]|(?:-(?!>)))';
117 $this->_dvar_math_var_regexp = '[\$\w\.\+\-\*\/\%\d\>\[\]]';
118 $this->_dvar_guts_regexp = '\w+(?:' . $this->_var_bracket_regexp
119 . ')*(?:\.\$?\w+(?:' . $this->_var_bracket_regexp . ')*)*(?:' . $this->_dvar_math_regexp . '(?:' . $this->_num_const_regexp . '|' . $this->_dvar_math_var_regexp . ')*)?';
120 $this->_dvar_regexp = '\$' . $this->_dvar_guts_regexp;
122 // matches config vars:
123 // #foo#
124 // #foobar123_foo#
125 $this->_cvar_regexp = '\#\w+\#';
127 // matches section vars:
128 // %foo.bar%
129 $this->_svar_regexp = '\%\w+\.\w+\%';
131 // matches all valid variables (no quotes, no modifiers)
132 $this->_avar_regexp = '(?:' . $this->_dvar_regexp . '|'
133 . $this->_cvar_regexp . '|' . $this->_svar_regexp . ')';
135 // matches valid variable syntax:
136 // $foo
137 // $foo
138 // #foo#
139 // #foo#
140 // "text"
141 // "text"
142 $this->_var_regexp = '(?:' . $this->_avar_regexp . '|' . $this->_qstr_regexp . ')';
144 // matches valid object call (one level of object nesting allowed in parameters):
145 // $foo->bar
146 // $foo->bar()
147 // $foo->bar("text")
148 // $foo->bar($foo, $bar, "text")
149 // $foo->bar($foo, "foo")
150 // $foo->bar->foo()
151 // $foo->bar->foo->bar()
152 // $foo->bar($foo->bar)
153 // $foo->bar($foo->bar())
154 // $foo->bar($foo->bar($blah,$foo,44,"foo",$foo[0].bar))
155 $this->_obj_ext_regexp = '\->(?:\$?' . $this->_dvar_guts_regexp . ')';
156 $this->_obj_restricted_param_regexp = '(?:'
157 . '(?:' . $this->_var_regexp . '|' . $this->_num_const_regexp . ')(?:' . $this->_obj_ext_regexp . '(?:\((?:(?:' . $this->_var_regexp . '|' . $this->_num_const_regexp . ')'
158 . '(?:\s*,\s*(?:' . $this->_var_regexp . '|' . $this->_num_const_regexp . '))*)?\))?)*)';
159 $this->_obj_single_param_regexp = '(?:\w+|' . $this->_obj_restricted_param_regexp . '(?:\s*,\s*(?:(?:\w+|'
160 . $this->_var_regexp . $this->_obj_restricted_param_regexp . ')))*)';
161 $this->_obj_params_regexp = '\((?:' . $this->_obj_single_param_regexp
162 . '(?:\s*,\s*' . $this->_obj_single_param_regexp . ')*)?\)';
163 $this->_obj_start_regexp = '(?:' . $this->_dvar_regexp . '(?:' . $this->_obj_ext_regexp . ')+)';
164 $this->_obj_call_regexp = '(?:' . $this->_obj_start_regexp . '(?:' . $this->_obj_params_regexp . ')?(?:' . $this->_dvar_math_regexp . '(?:' . $this->_num_const_regexp . '|' . $this->_dvar_math_var_regexp . ')*)?)';
166 // matches valid modifier syntax:
167 // |foo
168 // |@foo
169 // |foo:"bar"
170 // |foo:$bar
171 // |foo:"bar":$foobar
172 // |foo|bar
173 // |foo:$foo->bar
174 $this->_mod_regexp = '(?:\|@?\w+(?::(?:\w+|' . $this->_num_const_regexp . '|'
175 . $this->_obj_call_regexp . '|' . $this->_avar_regexp . '|' . $this->_qstr_regexp .'))*)';
177 // matches valid function name:
178 // foo123
179 // _foo_bar
180 $this->_func_regexp = '[a-zA-Z_]\w*';
182 // matches valid registered object:
183 // foo->bar
184 $this->_reg_obj_regexp = '[a-zA-Z_]\w*->[a-zA-Z_]\w*';
186 // matches valid parameter values:
187 // true
188 // $foo
189 // $foo|bar
190 // #foo#
191 // #foo#|bar
192 // "text"
193 // "text"|bar
194 // $foo->bar
195 $this->_param_regexp = '(?:\s*(?:' . $this->_obj_call_regexp . '|'
196 . $this->_var_regexp . '|' . $this->_num_const_regexp . '|\w+)(?>' . $this->_mod_regexp . '*)\s*)';
198 // matches valid parenthesised function parameters:
200 // "text"
201 // $foo, $bar, "text"
202 // $foo|bar, "foo"|bar, $foo->bar($foo)|bar
203 $this->_parenth_param_regexp = '(?:\((?:\w+|'
204 . $this->_param_regexp . '(?:\s*,\s*(?:(?:\w+|'
205 . $this->_param_regexp . ')))*)?\))';
207 // matches valid function call:
208 // foo()
209 // foo_bar($foo)
210 // _foo_bar($foo,"bar")
211 // foo123($foo,$foo->bar(),"foo")
212 $this->_func_call_regexp = '(?:' . $this->_func_regexp . '\s*(?:'
213 . $this->_parenth_param_regexp . '))';
217 * compile a resource
219 * sets $compiled_content to the compiled source
220 * @param string $resource_name
221 * @param string $source_content
222 * @param string $compiled_content
223 * @return true
225 function _compile_file($resource_name, $source_content, &$compiled_content)
228 if ($this->security) {
229 // do not allow php syntax to be executed unless specified
230 if ($this->php_handling == SMARTY_PHP_ALLOW &&
231 !$this->security_settings['PHP_HANDLING']) {
232 $this->php_handling = SMARTY_PHP_PASSTHRU;
236 $this->_load_filters();
238 $this->_current_file = $resource_name;
239 $this->_current_line_no = 1;
240 $ldq = preg_quote($this->left_delimiter, '~');
241 $rdq = preg_quote($this->right_delimiter, '~');
243 // run template source through prefilter functions
244 if (count($this->_plugins['prefilter']) > 0) {
245 foreach ($this->_plugins['prefilter'] as $filter_name => $prefilter) {
246 if ($prefilter === false) continue;
247 if ($prefilter[3] || is_callable($prefilter[0])) {
248 $source_content = call_user_func_array($prefilter[0],
249 array($source_content, &$this));
250 $this->_plugins['prefilter'][$filter_name][3] = true;
251 } else {
252 $this->_trigger_fatal_error("[plugin] prefilter '$filter_name' is not implemented");
257 /* fetch all special blocks */
258 $search = "~{$ldq}\*(.*?)\*{$rdq}|{$ldq}\s*literal\s*{$rdq}(.*?){$ldq}\s*/literal\s*{$rdq}|{$ldq}\s*php\s*{$rdq}(.*?){$ldq}\s*/php\s*{$rdq}~s";
260 preg_match_all($search, $source_content, $match, PREG_SET_ORDER);
261 $this->_folded_blocks = $match;
262 reset($this->_folded_blocks);
264 /* replace special blocks by "{php}" */
265 $source_content = preg_replace($search.'e', "'"
266 . $this->_quote_replace($this->left_delimiter) . 'php'
267 . "' . str_repeat(\"\n\", substr_count('\\0', \"\n\")) .'"
268 . $this->_quote_replace($this->right_delimiter)
269 . "'"
270 , $source_content);
272 /* Gather all template tags. */
273 preg_match_all("~{$ldq}\s*(.*?)\s*{$rdq}~s", $source_content, $_match);
274 $template_tags = $_match[1];
275 /* Split content by template tags to obtain non-template content. */
276 $text_blocks = preg_split("~{$ldq}.*?{$rdq}~s", $source_content);
278 /* loop through text blocks */
279 for ($curr_tb = 0, $for_max = count($text_blocks); $curr_tb < $for_max; $curr_tb++) {
280 /* match anything resembling php tags */
281 if (preg_match_all('~(<\?(?:\w+|=)?|\?>|language\s*=\s*[\"\']?php[\"\']?)~is', $text_blocks[$curr_tb], $sp_match)) {
282 /* replace tags with placeholders to prevent recursive replacements */
283 $sp_match[1] = array_unique($sp_match[1]);
284 usort($sp_match[1], '_smarty_sort_length');
285 for ($curr_sp = 0, $for_max2 = count($sp_match[1]); $curr_sp < $for_max2; $curr_sp++) {
286 $text_blocks[$curr_tb] = str_replace($sp_match[1][$curr_sp],'%%%SMARTYSP'.$curr_sp.'%%%',$text_blocks[$curr_tb]);
288 /* process each one */
289 for ($curr_sp = 0, $for_max2 = count($sp_match[1]); $curr_sp < $for_max2; $curr_sp++) {
290 if ($this->php_handling == SMARTY_PHP_PASSTHRU) {
291 /* echo php contents */
292 $text_blocks[$curr_tb] = str_replace('%%%SMARTYSP'.$curr_sp.'%%%', '<?php echo \''.str_replace("'", "\'", $sp_match[1][$curr_sp]).'\'; ?>'."\n", $text_blocks[$curr_tb]);
293 } else if ($this->php_handling == SMARTY_PHP_QUOTE) {
294 /* quote php tags */
295 $text_blocks[$curr_tb] = str_replace('%%%SMARTYSP'.$curr_sp.'%%%', htmlspecialchars($sp_match[1][$curr_sp]), $text_blocks[$curr_tb]);
296 } else if ($this->php_handling == SMARTY_PHP_REMOVE) {
297 /* remove php tags */
298 $text_blocks[$curr_tb] = str_replace('%%%SMARTYSP'.$curr_sp.'%%%', '', $text_blocks[$curr_tb]);
299 } else {
300 /* SMARTY_PHP_ALLOW, but echo non php starting tags */
301 $sp_match[1][$curr_sp] = preg_replace('~(<\?(?!php|=|$))~i', '<?php echo \'\\1\'?>'."\n", $sp_match[1][$curr_sp]);
302 $text_blocks[$curr_tb] = str_replace('%%%SMARTYSP'.$curr_sp.'%%%', $sp_match[1][$curr_sp], $text_blocks[$curr_tb]);
308 /* Compile the template tags into PHP code. */
309 $compiled_tags = array();
310 for ($i = 0, $for_max = count($template_tags); $i < $for_max; $i++) {
311 $this->_current_line_no += substr_count($text_blocks[$i], "\n");
312 $compiled_tags[] = $this->_compile_tag($template_tags[$i]);
313 $this->_current_line_no += substr_count($template_tags[$i], "\n");
315 if (count($this->_tag_stack)>0) {
316 list($_open_tag, $_line_no) = end($this->_tag_stack);
317 $this->_syntax_error("unclosed tag \{$_open_tag} (opened line $_line_no).", E_USER_ERROR, __FILE__, __LINE__);
318 return;
321 /* Reformat $text_blocks between 'strip' and '/strip' tags,
322 removing spaces, tabs and newlines. */
323 $strip = false;
324 for ($i = 0, $for_max = count($compiled_tags); $i < $for_max; $i++) {
325 if ($compiled_tags[$i] == '{strip}') {
326 $compiled_tags[$i] = '';
327 $strip = true;
328 /* remove leading whitespaces */
329 $text_blocks[$i + 1] = ltrim($text_blocks[$i + 1]);
331 if ($strip) {
332 /* strip all $text_blocks before the next '/strip' */
333 for ($j = $i + 1; $j < $for_max; $j++) {
334 /* remove leading and trailing whitespaces of each line */
335 $text_blocks[$j] = preg_replace('![\t ]*[\r\n]+[\t ]*!', '', $text_blocks[$j]);
336 if ($compiled_tags[$j] == '{/strip}') {
337 /* remove trailing whitespaces from the last text_block */
338 $text_blocks[$j] = rtrim($text_blocks[$j]);
340 $text_blocks[$j] = "<?php echo '" . strtr($text_blocks[$j], array("'"=>"\'", "\\"=>"\\\\")) . "'; ?>";
341 if ($compiled_tags[$j] == '{/strip}') {
342 $compiled_tags[$j] = "\n"; /* slurped by php, but necessary
343 if a newline is following the closing strip-tag */
344 $strip = false;
345 $i = $j;
346 break;
351 $compiled_content = '';
353 /* Interleave the compiled contents and text blocks to get the final result. */
354 for ($i = 0, $for_max = count($compiled_tags); $i < $for_max; $i++) {
355 if ($compiled_tags[$i] == '') {
356 // tag result empty, remove first newline from following text block
357 $text_blocks[$i+1] = preg_replace('~^(\r\n|\r|\n)~', '', $text_blocks[$i+1]);
359 $compiled_content .= $text_blocks[$i].$compiled_tags[$i];
361 $compiled_content .= $text_blocks[$i];
363 // remove \n from the end of the file, if any
364 if (strlen($compiled_content) && (substr($compiled_content, -1) == "\n") ) {
365 $compiled_content = substr($compiled_content, 0, -1);
368 if (!empty($this->_cache_serial)) {
369 $compiled_content = "<?php \$this->_cache_serials['".$this->_cache_include."'] = '".$this->_cache_serial."'; ?>" . $compiled_content;
372 // remove unnecessary close/open tags
373 $compiled_content = preg_replace('~\?>\n?<\?php~', '', $compiled_content);
375 // run compiled template through postfilter functions
376 if (count($this->_plugins['postfilter']) > 0) {
377 foreach ($this->_plugins['postfilter'] as $filter_name => $postfilter) {
378 if ($postfilter === false) continue;
379 if ($postfilter[3] || is_callable($postfilter[0])) {
380 $compiled_content = call_user_func_array($postfilter[0],
381 array($compiled_content, &$this));
382 $this->_plugins['postfilter'][$filter_name][3] = true;
383 } else {
384 $this->_trigger_fatal_error("Smarty plugin error: postfilter '$filter_name' is not implemented");
389 // put header at the top of the compiled template
390 $template_header = "<?php /* Smarty version ".$this->_version.", created on ".strftime("%Y-%m-%d %H:%M:%S")."\n";
391 $template_header .= " compiled from ".strtr(urlencode($resource_name), array('%2F'=>'/', '%3A'=>':'))." */ ?>\n";
393 /* Emit code to load needed plugins. */
394 $this->_plugins_code = '';
395 if (count($this->_plugin_info)) {
396 $_plugins_params = "array('plugins' => array(";
397 foreach ($this->_plugin_info as $plugin_type => $plugins) {
398 foreach ($plugins as $plugin_name => $plugin_info) {
399 $_plugins_params .= "array('$plugin_type', '$plugin_name', '" . strtr($plugin_info[0], array("'" => "\\'", "\\" => "\\\\")) . "', $plugin_info[1], ";
400 $_plugins_params .= $plugin_info[2] ? 'true),' : 'false),';
403 $_plugins_params .= '))';
404 $plugins_code = "<?php require_once(SMARTY_CORE_DIR . 'core.load_plugins.php');\nsmarty_core_load_plugins($_plugins_params, \$this); ?>\n";
405 $template_header .= $plugins_code;
406 $this->_plugin_info = array();
407 $this->_plugins_code = $plugins_code;
410 if ($this->_init_smarty_vars) {
411 $template_header .= "<?php require_once(SMARTY_CORE_DIR . 'core.assign_smarty_interface.php');\nsmarty_core_assign_smarty_interface(null, \$this); ?>\n";
412 $this->_init_smarty_vars = false;
415 $compiled_content = $template_header . $compiled_content;
416 return true;
420 * Compile a template tag
422 * @param string $template_tag
423 * @return string
425 function _compile_tag($template_tag)
427 /* Matched comment. */
428 if (substr($template_tag, 0, 1) == '*' && substr($template_tag, -1) == '*')
429 return '';
431 /* Split tag into two three parts: command, command modifiers and the arguments. */
432 if(! preg_match('~^(?:(' . $this->_num_const_regexp . '|' . $this->_obj_call_regexp . '|' . $this->_var_regexp
433 . '|\/?' . $this->_reg_obj_regexp . '|\/?' . $this->_func_regexp . ')(' . $this->_mod_regexp . '*))
434 (?:\s+(.*))?$
435 ~xs', $template_tag, $match)) {
436 $this->_syntax_error("unrecognized tag: $template_tag", E_USER_ERROR, __FILE__, __LINE__);
439 $tag_command = $match[1];
440 $tag_modifier = isset($match[2]) ? $match[2] : null;
441 $tag_args = isset($match[3]) ? $match[3] : null;
443 if (preg_match('~^' . $this->_num_const_regexp . '|' . $this->_obj_call_regexp . '|' . $this->_var_regexp . '$~', $tag_command)) {
444 /* tag name is a variable or object */
445 $_return = $this->_parse_var_props($tag_command . $tag_modifier);
446 return "<?php echo $_return; ?>" . $this->_additional_newline;
449 /* If the tag name is a registered object, we process it. */
450 if (preg_match('~^\/?' . $this->_reg_obj_regexp . '$~', $tag_command)) {
451 return $this->_compile_registered_object_tag($tag_command, $this->_parse_attrs($tag_args), $tag_modifier);
454 switch ($tag_command) {
455 case 'include':
456 return $this->_compile_include_tag($tag_args);
458 case 'include_php':
459 return $this->_compile_include_php_tag($tag_args);
461 case 'if':
462 $this->_push_tag('if');
463 return $this->_compile_if_tag($tag_args);
465 case 'else':
466 list($_open_tag) = end($this->_tag_stack);
467 if ($_open_tag != 'if' && $_open_tag != 'elseif')
468 $this->_syntax_error('unexpected {else}', E_USER_ERROR, __FILE__, __LINE__);
469 else
470 $this->_push_tag('else');
471 return '<?php else: ?>';
473 case 'elseif':
474 list($_open_tag) = end($this->_tag_stack);
475 if ($_open_tag != 'if' && $_open_tag != 'elseif')
476 $this->_syntax_error('unexpected {elseif}', E_USER_ERROR, __FILE__, __LINE__);
477 if ($_open_tag == 'if')
478 $this->_push_tag('elseif');
479 return $this->_compile_if_tag($tag_args, true);
481 case '/if':
482 $this->_pop_tag('if');
483 return '<?php endif; ?>';
485 case 'capture':
486 return $this->_compile_capture_tag(true, $tag_args);
488 case '/capture':
489 return $this->_compile_capture_tag(false);
491 case 'ldelim':
492 return $this->left_delimiter;
494 case 'rdelim':
495 return $this->right_delimiter;
497 case 'section':
498 $this->_push_tag('section');
499 return $this->_compile_section_start($tag_args);
501 case 'sectionelse':
502 $this->_push_tag('sectionelse');
503 return "<?php endfor; else: ?>";
504 break;
506 case '/section':
507 $_open_tag = $this->_pop_tag('section');
508 if ($_open_tag == 'sectionelse')
509 return "<?php endif; ?>";
510 else
511 return "<?php endfor; endif; ?>";
513 case 'foreach':
514 $this->_push_tag('foreach');
515 return $this->_compile_foreach_start($tag_args);
516 break;
518 case 'foreachelse':
519 $this->_push_tag('foreachelse');
520 return "<?php endforeach; else: ?>";
522 case '/foreach':
523 $_open_tag = $this->_pop_tag('foreach');
524 if ($_open_tag == 'foreachelse')
525 return "<?php endif; unset(\$_from); ?>";
526 else
527 return "<?php endforeach; endif; unset(\$_from); ?>";
528 break;
530 case 'strip':
531 case '/strip':
532 if (substr($tag_command, 0, 1)=='/') {
533 $this->_pop_tag('strip');
534 if (--$this->_strip_depth==0) { /* outermost closing {/strip} */
535 $this->_additional_newline = "\n";
536 return '{' . $tag_command . '}';
538 } else {
539 $this->_push_tag('strip');
540 if ($this->_strip_depth++==0) { /* outermost opening {strip} */
541 $this->_additional_newline = "";
542 return '{' . $tag_command . '}';
545 return '';
547 case 'php':
548 /* handle folded tags replaced by {php} */
549 list(, $block) = each($this->_folded_blocks);
550 $this->_current_line_no += substr_count($block[0], "\n");
551 /* the number of matched elements in the regexp in _compile_file()
552 determins the type of folded tag that was found */
553 switch (count($block)) {
554 case 2: /* comment */
555 return '';
557 case 3: /* literal */
558 return "<?php echo '" . strtr($block[2], array("'"=>"\'", "\\"=>"\\\\")) . "'; ?>" . $this->_additional_newline;
560 case 4: /* php */
561 if ($this->security && !$this->security_settings['PHP_TAGS']) {
562 $this->_syntax_error("(secure mode) php tags not permitted", E_USER_WARNING, __FILE__, __LINE__);
563 return;
565 return '<?php ' . $block[3] .' ?>';
567 break;
569 case 'insert':
570 return $this->_compile_insert_tag($tag_args);
572 default:
573 if ($this->_compile_compiler_tag($tag_command, $tag_args, $output)) {
574 return $output;
575 } else if ($this->_compile_block_tag($tag_command, $tag_args, $tag_modifier, $output)) {
576 return $output;
577 } else if ($this->_compile_custom_tag($tag_command, $tag_args, $tag_modifier, $output)) {
578 return $output;
579 } else {
580 $this->_syntax_error("unrecognized tag '$tag_command'", E_USER_ERROR, __FILE__, __LINE__);
588 * compile the custom compiler tag
590 * sets $output to the compiled custom compiler tag
591 * @param string $tag_command
592 * @param string $tag_args
593 * @param string $output
594 * @return boolean
596 function _compile_compiler_tag($tag_command, $tag_args, &$output)
598 $found = false;
599 $have_function = true;
602 * First we check if the compiler function has already been registered
603 * or loaded from a plugin file.
605 if (isset($this->_plugins['compiler'][$tag_command])) {
606 $found = true;
607 $plugin_func = $this->_plugins['compiler'][$tag_command][0];
608 if (!is_callable($plugin_func)) {
609 $message = "compiler function '$tag_command' is not implemented";
610 $have_function = false;
614 * Otherwise we need to load plugin file and look for the function
615 * inside it.
617 else if ($plugin_file = $this->_get_plugin_filepath('compiler', $tag_command)) {
618 $found = true;
620 include_once $plugin_file;
622 $plugin_func = 'smarty_compiler_' . $tag_command;
623 if (!is_callable($plugin_func)) {
624 $message = "plugin function $plugin_func() not found in $plugin_file\n";
625 $have_function = false;
626 } else {
627 $this->_plugins['compiler'][$tag_command] = array($plugin_func, null, null, null, true);
632 * True return value means that we either found a plugin or a
633 * dynamically registered function. False means that we didn't and the
634 * compiler should now emit code to load custom function plugin for this
635 * tag.
637 if ($found) {
638 if ($have_function) {
639 $output = call_user_func_array($plugin_func, array($tag_args, &$this));
640 if($output != '') {
641 $output = '<?php ' . $this->_push_cacheable_state('compiler', $tag_command)
642 . $output
643 . $this->_pop_cacheable_state('compiler', $tag_command) . ' ?>';
645 } else {
646 $this->_syntax_error($message, E_USER_WARNING, __FILE__, __LINE__);
648 return true;
649 } else {
650 return false;
656 * compile block function tag
658 * sets $output to compiled block function tag
659 * @param string $tag_command
660 * @param string $tag_args
661 * @param string $tag_modifier
662 * @param string $output
663 * @return boolean
665 function _compile_block_tag($tag_command, $tag_args, $tag_modifier, &$output)
667 if (substr($tag_command, 0, 1) == '/') {
668 $start_tag = false;
669 $tag_command = substr($tag_command, 1);
670 } else
671 $start_tag = true;
673 $found = false;
674 $have_function = true;
677 * First we check if the block function has already been registered
678 * or loaded from a plugin file.
680 if (isset($this->_plugins['block'][$tag_command])) {
681 $found = true;
682 $plugin_func = $this->_plugins['block'][$tag_command][0];
683 if (!is_callable($plugin_func)) {
684 $message = "block function '$tag_command' is not implemented";
685 $have_function = false;
689 * Otherwise we need to load plugin file and look for the function
690 * inside it.
692 else if ($plugin_file = $this->_get_plugin_filepath('block', $tag_command)) {
693 $found = true;
695 include_once $plugin_file;
697 $plugin_func = 'smarty_block_' . $tag_command;
698 if (!function_exists($plugin_func)) {
699 $message = "plugin function $plugin_func() not found in $plugin_file\n";
700 $have_function = false;
701 } else {
702 $this->_plugins['block'][$tag_command] = array($plugin_func, null, null, null, true);
707 if (!$found) {
708 return false;
709 } else if (!$have_function) {
710 $this->_syntax_error($message, E_USER_WARNING, __FILE__, __LINE__);
711 return true;
715 * Even though we've located the plugin function, compilation
716 * happens only once, so the plugin will still need to be loaded
717 * at runtime for future requests.
719 $this->_add_plugin('block', $tag_command);
721 if ($start_tag)
722 $this->_push_tag($tag_command);
723 else
724 $this->_pop_tag($tag_command);
726 if ($start_tag) {
727 $output = '<?php ' . $this->_push_cacheable_state('block', $tag_command);
728 $attrs = $this->_parse_attrs($tag_args);
729 $arg_list = $this->_compile_arg_list('block', $tag_command, $attrs, $_cache_attrs='');
730 $output .= "$_cache_attrs\$this->_tag_stack[] = array('$tag_command', array(".implode(',', $arg_list).')); ';
731 $output .= $this->_compile_plugin_call('block', $tag_command).'($this->_tag_stack[count($this->_tag_stack)-1][1], null, $this, $_block_repeat=true);';
732 $output .= 'while ($_block_repeat) { ob_start(); ?>';
733 } else {
734 $output = '<?php $_block_content = ob_get_contents(); ob_end_clean(); ';
735 $_out_tag_text = $this->_compile_plugin_call('block', $tag_command).'($this->_tag_stack[count($this->_tag_stack)-1][1], $_block_content, $this, $_block_repeat=false)';
736 if ($tag_modifier != '') {
737 $this->_parse_modifiers($_out_tag_text, $tag_modifier);
739 $output .= 'echo '.$_out_tag_text.'; } ';
740 $output .= " array_pop(\$this->_tag_stack); " . $this->_pop_cacheable_state('block', $tag_command) . '?>';
743 return true;
748 * compile custom function tag
750 * @param string $tag_command
751 * @param string $tag_args
752 * @param string $tag_modifier
753 * @return string
755 function _compile_custom_tag($tag_command, $tag_args, $tag_modifier, &$output)
757 $found = false;
758 $have_function = true;
761 * First we check if the custom function has already been registered
762 * or loaded from a plugin file.
764 if (isset($this->_plugins['function'][$tag_command])) {
765 $found = true;
766 $plugin_func = $this->_plugins['function'][$tag_command][0];
767 if (!is_callable($plugin_func)) {
768 $message = "custom function '$tag_command' is not implemented";
769 $have_function = false;
773 * Otherwise we need to load plugin file and look for the function
774 * inside it.
776 else if ($plugin_file = $this->_get_plugin_filepath('function', $tag_command)) {
777 $found = true;
779 include_once $plugin_file;
781 $plugin_func = 'smarty_function_' . $tag_command;
782 if (!function_exists($plugin_func)) {
783 $message = "plugin function $plugin_func() not found in $plugin_file\n";
784 $have_function = false;
785 } else {
786 $this->_plugins['function'][$tag_command] = array($plugin_func, null, null, null, true);
791 if (!$found) {
792 return false;
793 } else if (!$have_function) {
794 $this->_syntax_error($message, E_USER_WARNING, __FILE__, __LINE__);
795 return true;
798 /* declare plugin to be loaded on display of the template that
799 we compile right now */
800 $this->_add_plugin('function', $tag_command);
802 $_cacheable_state = $this->_push_cacheable_state('function', $tag_command);
803 $attrs = $this->_parse_attrs($tag_args);
804 $arg_list = $this->_compile_arg_list('function', $tag_command, $attrs, $_cache_attrs='');
806 $output = $this->_compile_plugin_call('function', $tag_command).'(array('.implode(',', $arg_list)."), \$this)";
807 if($tag_modifier != '') {
808 $this->_parse_modifiers($output, $tag_modifier);
811 if($output != '') {
812 $output = '<?php ' . $_cacheable_state . $_cache_attrs . 'echo ' . $output . ';'
813 . $this->_pop_cacheable_state('function', $tag_command) . "?>" . $this->_additional_newline;
816 return true;
820 * compile a registered object tag
822 * @param string $tag_command
823 * @param array $attrs
824 * @param string $tag_modifier
825 * @return string
827 function _compile_registered_object_tag($tag_command, $attrs, $tag_modifier)
829 if (substr($tag_command, 0, 1) == '/') {
830 $start_tag = false;
831 $tag_command = substr($tag_command, 1);
832 } else {
833 $start_tag = true;
836 list($object, $obj_comp) = explode('->', $tag_command);
838 $arg_list = array();
839 if(count($attrs)) {
840 $_assign_var = false;
841 foreach ($attrs as $arg_name => $arg_value) {
842 if($arg_name == 'assign') {
843 $_assign_var = $arg_value;
844 unset($attrs['assign']);
845 continue;
847 if (is_bool($arg_value))
848 $arg_value = $arg_value ? 'true' : 'false';
849 $arg_list[] = "'$arg_name' => $arg_value";
853 if($this->_reg_objects[$object][2]) {
854 // smarty object argument format
855 $args = "array(".implode(',', (array)$arg_list)."), \$this";
856 } else {
857 // traditional argument format
858 $args = implode(',', array_values($attrs));
859 if (empty($args)) {
860 $args = 'null';
864 $prefix = '';
865 $postfix = '';
866 $newline = '';
867 if(!is_object($this->_reg_objects[$object][0])) {
868 $this->_trigger_fatal_error("registered '$object' is not an object" , $this->_current_file, $this->_current_line_no, __FILE__, __LINE__);
869 } elseif(!empty($this->_reg_objects[$object][1]) && !in_array($obj_comp, $this->_reg_objects[$object][1])) {
870 $this->_trigger_fatal_error("'$obj_comp' is not a registered component of object '$object'", $this->_current_file, $this->_current_line_no, __FILE__, __LINE__);
871 } elseif(method_exists($this->_reg_objects[$object][0], $obj_comp)) {
872 // method
873 if(in_array($obj_comp, $this->_reg_objects[$object][3])) {
874 // block method
875 if ($start_tag) {
876 $prefix = "\$this->_tag_stack[] = array('$obj_comp', $args); ";
877 $prefix .= "\$this->_reg_objects['$object'][0]->$obj_comp(\$this->_tag_stack[count(\$this->_tag_stack)-1][1], null, \$this, \$_block_repeat=true); ";
878 $prefix .= "while (\$_block_repeat) { ob_start();";
879 $return = null;
880 $postfix = '';
881 } else {
882 $prefix = "\$_obj_block_content = ob_get_contents(); ob_end_clean(); ";
883 $return = "\$this->_reg_objects['$object'][0]->$obj_comp(\$this->_tag_stack[count(\$this->_tag_stack)-1][1], \$_obj_block_content, \$this, \$_block_repeat=false)";
884 $postfix = "} array_pop(\$this->_tag_stack);";
886 } else {
887 // non-block method
888 $return = "\$this->_reg_objects['$object'][0]->$obj_comp($args)";
890 } else {
891 // property
892 $return = "\$this->_reg_objects['$object'][0]->$obj_comp";
895 if($return != null) {
896 if($tag_modifier != '') {
897 $this->_parse_modifiers($return, $tag_modifier);
900 if(!empty($_assign_var)) {
901 $output = "\$this->assign('" . $this->_dequote($_assign_var) ."', $return);";
902 } else {
903 $output = 'echo ' . $return . ';';
904 $newline = $this->_additional_newline;
906 } else {
907 $output = '';
910 return '<?php ' . $prefix . $output . $postfix . "?>" . $newline;
914 * Compile {insert ...} tag
916 * @param string $tag_args
917 * @return string
919 function _compile_insert_tag($tag_args)
921 $attrs = $this->_parse_attrs($tag_args);
922 $name = $this->_dequote($attrs['name']);
924 if (empty($name)) {
925 $this->_syntax_error("missing insert name", E_USER_ERROR, __FILE__, __LINE__);
928 if (!empty($attrs['script'])) {
929 $delayed_loading = true;
930 } else {
931 $delayed_loading = false;
934 foreach ($attrs as $arg_name => $arg_value) {
935 if (is_bool($arg_value))
936 $arg_value = $arg_value ? 'true' : 'false';
937 $arg_list[] = "'$arg_name' => $arg_value";
940 $this->_add_plugin('insert', $name, $delayed_loading);
942 $_params = "array('args' => array(".implode(', ', (array)$arg_list)."))";
944 return "<?php require_once(SMARTY_CORE_DIR . 'core.run_insert_handler.php');\necho smarty_core_run_insert_handler($_params, \$this); ?>" . $this->_additional_newline;
948 * Compile {include ...} tag
950 * @param string $tag_args
951 * @return string
953 function _compile_include_tag($tag_args)
955 $attrs = $this->_parse_attrs($tag_args);
956 $arg_list = array();
958 if (empty($attrs['file'])) {
959 $this->_syntax_error("missing 'file' attribute in include tag", E_USER_ERROR, __FILE__, __LINE__);
962 foreach ($attrs as $arg_name => $arg_value) {
963 if ($arg_name == 'file') {
964 $include_file = $arg_value;
965 continue;
966 } else if ($arg_name == 'assign') {
967 $assign_var = $arg_value;
968 continue;
970 if (is_bool($arg_value))
971 $arg_value = $arg_value ? 'true' : 'false';
972 $arg_list[] = "'$arg_name' => $arg_value";
975 $output = '<?php ';
977 if (isset($assign_var)) {
978 $output .= "ob_start();\n";
981 $output .=
982 "\$_smarty_tpl_vars = \$this->_tpl_vars;\n";
985 $_params = "array('smarty_include_tpl_file' => " . $include_file . ", 'smarty_include_vars' => array(".implode(',', (array)$arg_list)."))";
986 $output .= "\$this->_smarty_include($_params);\n" .
987 "\$this->_tpl_vars = \$_smarty_tpl_vars;\n" .
988 "unset(\$_smarty_tpl_vars);\n";
990 if (isset($assign_var)) {
991 $output .= "\$this->assign(" . $assign_var . ", ob_get_contents()); ob_end_clean();\n";
994 $output .= ' ?>';
996 return $output;
1001 * Compile {include ...} tag
1003 * @param string $tag_args
1004 * @return string
1006 function _compile_include_php_tag($tag_args)
1008 $attrs = $this->_parse_attrs($tag_args);
1010 if (empty($attrs['file'])) {
1011 $this->_syntax_error("missing 'file' attribute in include_php tag", E_USER_ERROR, __FILE__, __LINE__);
1014 $assign_var = (empty($attrs['assign'])) ? '' : $this->_dequote($attrs['assign']);
1015 $once_var = (empty($attrs['once']) || $attrs['once']=='false') ? 'false' : 'true';
1017 $arg_list = array();
1018 foreach($attrs as $arg_name => $arg_value) {
1019 if($arg_name != 'file' AND $arg_name != 'once' AND $arg_name != 'assign') {
1020 if(is_bool($arg_value))
1021 $arg_value = $arg_value ? 'true' : 'false';
1022 $arg_list[] = "'$arg_name' => $arg_value";
1026 $_params = "array('smarty_file' => " . $attrs['file'] . ", 'smarty_assign' => '$assign_var', 'smarty_once' => $once_var, 'smarty_include_vars' => array(".implode(',', $arg_list)."))";
1028 return "<?php require_once(SMARTY_CORE_DIR . 'core.smarty_include_php.php');\nsmarty_core_smarty_include_php($_params, \$this); ?>" . $this->_additional_newline;
1033 * Compile {section ...} tag
1035 * @param string $tag_args
1036 * @return string
1038 function _compile_section_start($tag_args)
1040 $attrs = $this->_parse_attrs($tag_args);
1041 $arg_list = array();
1043 $output = '<?php ';
1044 $section_name = $attrs['name'];
1045 if (empty($section_name)) {
1046 $this->_syntax_error("missing section name", E_USER_ERROR, __FILE__, __LINE__);
1049 $output .= "unset(\$this->_sections[$section_name]);\n";
1050 $section_props = "\$this->_sections[$section_name]";
1052 foreach ($attrs as $attr_name => $attr_value) {
1053 switch ($attr_name) {
1054 case 'loop':
1055 $output .= "{$section_props}['loop'] = is_array(\$_loop=$attr_value) ? count(\$_loop) : max(0, (int)\$_loop); unset(\$_loop);\n";
1056 break;
1058 case 'show':
1059 if (is_bool($attr_value))
1060 $show_attr_value = $attr_value ? 'true' : 'false';
1061 else
1062 $show_attr_value = "(bool)$attr_value";
1063 $output .= "{$section_props}['show'] = $show_attr_value;\n";
1064 break;
1066 case 'name':
1067 $output .= "{$section_props}['$attr_name'] = $attr_value;\n";
1068 break;
1070 case 'max':
1071 case 'start':
1072 $output .= "{$section_props}['$attr_name'] = (int)$attr_value;\n";
1073 break;
1075 case 'step':
1076 $output .= "{$section_props}['$attr_name'] = ((int)$attr_value) == 0 ? 1 : (int)$attr_value;\n";
1077 break;
1079 default:
1080 $this->_syntax_error("unknown section attribute - '$attr_name'", E_USER_ERROR, __FILE__, __LINE__);
1081 break;
1085 if (!isset($attrs['show']))
1086 $output .= "{$section_props}['show'] = true;\n";
1088 if (!isset($attrs['loop']))
1089 $output .= "{$section_props}['loop'] = 1;\n";
1091 if (!isset($attrs['max']))
1092 $output .= "{$section_props}['max'] = {$section_props}['loop'];\n";
1093 else
1094 $output .= "if ({$section_props}['max'] < 0)\n" .
1095 " {$section_props}['max'] = {$section_props}['loop'];\n";
1097 if (!isset($attrs['step']))
1098 $output .= "{$section_props}['step'] = 1;\n";
1100 if (!isset($attrs['start']))
1101 $output .= "{$section_props}['start'] = {$section_props}['step'] > 0 ? 0 : {$section_props}['loop']-1;\n";
1102 else {
1103 $output .= "if ({$section_props}['start'] < 0)\n" .
1104 " {$section_props}['start'] = max({$section_props}['step'] > 0 ? 0 : -1, {$section_props}['loop'] + {$section_props}['start']);\n" .
1105 "else\n" .
1106 " {$section_props}['start'] = min({$section_props}['start'], {$section_props}['step'] > 0 ? {$section_props}['loop'] : {$section_props}['loop']-1);\n";
1109 $output .= "if ({$section_props}['show']) {\n";
1110 if (!isset($attrs['start']) && !isset($attrs['step']) && !isset($attrs['max'])) {
1111 $output .= " {$section_props}['total'] = {$section_props}['loop'];\n";
1112 } else {
1113 $output .= " {$section_props}['total'] = min(ceil(({$section_props}['step'] > 0 ? {$section_props}['loop'] - {$section_props}['start'] : {$section_props}['start']+1)/abs({$section_props}['step'])), {$section_props}['max']);\n";
1115 $output .= " if ({$section_props}['total'] == 0)\n" .
1116 " {$section_props}['show'] = false;\n" .
1117 "} else\n" .
1118 " {$section_props}['total'] = 0;\n";
1120 $output .= "if ({$section_props}['show']):\n";
1121 $output .= "
1122 for ({$section_props}['index'] = {$section_props}['start'], {$section_props}['iteration'] = 1;
1123 {$section_props}['iteration'] <= {$section_props}['total'];
1124 {$section_props}['index'] += {$section_props}['step'], {$section_props}['iteration']++):\n";
1125 $output .= "{$section_props}['rownum'] = {$section_props}['iteration'];\n";
1126 $output .= "{$section_props}['index_prev'] = {$section_props}['index'] - {$section_props}['step'];\n";
1127 $output .= "{$section_props}['index_next'] = {$section_props}['index'] + {$section_props}['step'];\n";
1128 $output .= "{$section_props}['first'] = ({$section_props}['iteration'] == 1);\n";
1129 $output .= "{$section_props}['last'] = ({$section_props}['iteration'] == {$section_props}['total']);\n";
1131 $output .= "?>";
1133 return $output;
1138 * Compile {foreach ...} tag.
1140 * @param string $tag_args
1141 * @return string
1143 function _compile_foreach_start($tag_args)
1145 $attrs = $this->_parse_attrs($tag_args);
1146 $arg_list = array();
1148 if (empty($attrs['from'])) {
1149 return $this->_syntax_error("foreach: missing 'from' attribute", E_USER_ERROR, __FILE__, __LINE__);
1151 $from = $attrs['from'];
1153 if (empty($attrs['item'])) {
1154 return $this->_syntax_error("foreach: missing 'item' attribute", E_USER_ERROR, __FILE__, __LINE__);
1156 $item = $this->_dequote($attrs['item']);
1157 if (!preg_match('~^\w+$~', $item)) {
1158 return $this->_syntax_error("'foreach: item' must be a variable name (literal string)", E_USER_ERROR, __FILE__, __LINE__);
1161 if (isset($attrs['key'])) {
1162 $key = $this->_dequote($attrs['key']);
1163 if (!preg_match('~^\w+$~', $key)) {
1164 return $this->_syntax_error("foreach: 'key' must to be a variable name (literal string)", E_USER_ERROR, __FILE__, __LINE__);
1166 $key_part = "\$this->_tpl_vars['$key'] => ";
1167 } else {
1168 $key = null;
1169 $key_part = '';
1172 if (isset($attrs['name'])) {
1173 $name = $attrs['name'];
1174 } else {
1175 $name = null;
1178 $output = '<?php ';
1179 $output .= "\$_from = $from; if (!is_array(\$_from) && !is_object(\$_from)) { settype(\$_from, 'array'); }";
1180 if (isset($name)) {
1181 $foreach_props = "\$this->_foreach[$name]";
1182 $output .= "{$foreach_props} = array('total' => count(\$_from), 'iteration' => 0);\n";
1183 $output .= "if ({$foreach_props}['total'] > 0):\n";
1184 $output .= " foreach (\$_from as $key_part\$this->_tpl_vars['$item']):\n";
1185 $output .= " {$foreach_props}['iteration']++;\n";
1186 } else {
1187 $output .= "if (count(\$_from)):\n";
1188 $output .= " foreach (\$_from as $key_part\$this->_tpl_vars['$item']):\n";
1190 $output .= '?>';
1192 return $output;
1197 * Compile {capture} .. {/capture} tags
1199 * @param boolean $start true if this is the {capture} tag
1200 * @param string $tag_args
1201 * @return string
1204 function _compile_capture_tag($start, $tag_args = '')
1206 $attrs = $this->_parse_attrs($tag_args);
1208 if ($start) {
1209 if (isset($attrs['name']))
1210 $buffer = $attrs['name'];
1211 else
1212 $buffer = "'default'";
1214 if (isset($attrs['assign']))
1215 $assign = $attrs['assign'];
1216 else
1217 $assign = null;
1218 $output = "<?php ob_start(); ?>";
1219 $this->_capture_stack[] = array($buffer, $assign);
1220 } else {
1221 list($buffer, $assign) = array_pop($this->_capture_stack);
1222 $output = "<?php \$this->_smarty_vars['capture'][$buffer] = ob_get_contents(); ";
1223 if (isset($assign)) {
1224 $output .= " \$this->assign($assign, ob_get_contents());";
1226 $output .= "ob_end_clean(); ?>";
1229 return $output;
1233 * Compile {if ...} tag
1235 * @param string $tag_args
1236 * @param boolean $elseif if true, uses elseif instead of if
1237 * @return string
1239 function _compile_if_tag($tag_args, $elseif = false)
1242 /* Tokenize args for 'if' tag. */
1243 preg_match_all('~(?>
1244 ' . $this->_obj_call_regexp . '(?:' . $this->_mod_regexp . '*)? | # valid object call
1245 ' . $this->_var_regexp . '(?:' . $this->_mod_regexp . '*)? | # var or quoted string
1246 \-?0[xX][0-9a-fA-F]+|\-?\d+(?:\.\d+)?|\.\d+|!==|===|==|!=|<>|<<|>>|<=|>=|\&\&|\|\||\(|\)|,|\!|\^|=|\&|\~|<|>|\||\%|\+|\-|\/|\*|\@ | # valid non-word token
1247 \b\w+\b | # valid word token
1248 \S+ # anything else
1249 )~x', $tag_args, $match);
1251 $tokens = $match[0];
1253 if(empty($tokens)) {
1254 $_error_msg .= $elseif ? "'elseif'" : "'if'";
1255 $_error_msg .= ' statement requires arguments';
1256 $this->_syntax_error($_error_msg, E_USER_ERROR, __FILE__, __LINE__);
1260 // make sure we have balanced parenthesis
1261 $token_count = array_count_values($tokens);
1262 if(isset($token_count['(']) && $token_count['('] != $token_count[')']) {
1263 $this->_syntax_error("unbalanced parenthesis in if statement", E_USER_ERROR, __FILE__, __LINE__);
1266 $is_arg_stack = array();
1268 for ($i = 0; $i < count($tokens); $i++) {
1270 $token = &$tokens[$i];
1272 switch (strtolower($token)) {
1273 case '!':
1274 case '%':
1275 case '!==':
1276 case '==':
1277 case '===':
1278 case '>':
1279 case '<':
1280 case '!=':
1281 case '<>':
1282 case '<<':
1283 case '>>':
1284 case '<=':
1285 case '>=':
1286 case '&&':
1287 case '||':
1288 case '|':
1289 case '^':
1290 case '&':
1291 case '~':
1292 case ')':
1293 case ',':
1294 case '+':
1295 case '-':
1296 case '*':
1297 case '/':
1298 case '@':
1299 break;
1301 case 'eq':
1302 $token = '==';
1303 break;
1305 case 'ne':
1306 case 'neq':
1307 $token = '!=';
1308 break;
1310 case 'lt':
1311 $token = '<';
1312 break;
1314 case 'le':
1315 case 'lte':
1316 $token = '<=';
1317 break;
1319 case 'gt':
1320 $token = '>';
1321 break;
1323 case 'ge':
1324 case 'gte':
1325 $token = '>=';
1326 break;
1328 case 'and':
1329 $token = '&&';
1330 break;
1332 case 'or':
1333 $token = '||';
1334 break;
1336 case 'not':
1337 $token = '!';
1338 break;
1340 case 'mod':
1341 $token = '%';
1342 break;
1344 case '(':
1345 array_push($is_arg_stack, $i);
1346 break;
1348 case 'is':
1349 /* If last token was a ')', we operate on the parenthesized
1350 expression. The start of the expression is on the stack.
1351 Otherwise, we operate on the last encountered token. */
1352 if ($tokens[$i-1] == ')')
1353 $is_arg_start = array_pop($is_arg_stack);
1354 else
1355 $is_arg_start = $i-1;
1356 /* Construct the argument for 'is' expression, so it knows
1357 what to operate on. */
1358 $is_arg = implode(' ', array_slice($tokens, $is_arg_start, $i - $is_arg_start));
1360 /* Pass all tokens from next one until the end to the
1361 'is' expression parsing function. The function will
1362 return modified tokens, where the first one is the result
1363 of the 'is' expression and the rest are the tokens it
1364 didn't touch. */
1365 $new_tokens = $this->_parse_is_expr($is_arg, array_slice($tokens, $i+1));
1367 /* Replace the old tokens with the new ones. */
1368 array_splice($tokens, $is_arg_start, count($tokens), $new_tokens);
1370 /* Adjust argument start so that it won't change from the
1371 current position for the next iteration. */
1372 $i = $is_arg_start;
1373 break;
1375 default:
1376 if(preg_match('~^' . $this->_func_regexp . '$~', $token) ) {
1377 // function call
1378 if($this->security &&
1379 !in_array($token, $this->security_settings['IF_FUNCS'])) {
1380 $this->_syntax_error("(secure mode) '$token' not allowed in if statement", E_USER_ERROR, __FILE__, __LINE__);
1382 } elseif(preg_match('~^' . $this->_var_regexp . '$~', $token) && isset($tokens[$i+1]) && $tokens[$i+1] == '(') {
1383 // variable function call
1384 $this->_syntax_error("variable function call '$token' not allowed in if statement", E_USER_ERROR, __FILE__, __LINE__);
1385 } elseif(preg_match('~^' . $this->_obj_call_regexp . '|' . $this->_var_regexp . '(?:' . $this->_mod_regexp . '*)$~', $token)) {
1386 // object or variable
1387 $token = $this->_parse_var_props($token);
1388 } elseif(is_numeric($token)) {
1389 // number, skip it
1390 } else {
1391 $this->_syntax_error("unidentified token '$token'", E_USER_ERROR, __FILE__, __LINE__);
1393 break;
1397 if ($elseif)
1398 return '<?php elseif ('.implode(' ', $tokens).'): ?>';
1399 else
1400 return '<?php if ('.implode(' ', $tokens).'): ?>';
1404 function _compile_arg_list($type, $name, $attrs, &$cache_code) {
1405 $arg_list = array();
1407 if (isset($type) && isset($name)
1408 && isset($this->_plugins[$type])
1409 && isset($this->_plugins[$type][$name])
1410 && empty($this->_plugins[$type][$name][4])
1411 && is_array($this->_plugins[$type][$name][5])
1413 /* we have a list of parameters that should be cached */
1414 $_cache_attrs = $this->_plugins[$type][$name][5];
1415 $_count = $this->_cache_attrs_count++;
1416 $cache_code = "\$_cache_attrs =& \$this->_smarty_cache_attrs('$this->_cache_serial','$_count');";
1418 } else {
1419 /* no parameters are cached */
1420 $_cache_attrs = null;
1423 foreach ($attrs as $arg_name => $arg_value) {
1424 if (is_bool($arg_value))
1425 $arg_value = $arg_value ? 'true' : 'false';
1426 if (is_null($arg_value))
1427 $arg_value = 'null';
1428 if ($_cache_attrs && in_array($arg_name, $_cache_attrs)) {
1429 $arg_list[] = "'$arg_name' => (\$this->_cache_including) ? \$_cache_attrs['$arg_name'] : (\$_cache_attrs['$arg_name']=$arg_value)";
1430 } else {
1431 $arg_list[] = "'$arg_name' => $arg_value";
1434 return $arg_list;
1438 * Parse is expression
1440 * @param string $is_arg
1441 * @param array $tokens
1442 * @return array
1444 function _parse_is_expr($is_arg, $tokens)
1446 $expr_end = 0;
1447 $negate_expr = false;
1449 if (($first_token = array_shift($tokens)) == 'not') {
1450 $negate_expr = true;
1451 $expr_type = array_shift($tokens);
1452 } else
1453 $expr_type = $first_token;
1455 switch ($expr_type) {
1456 case 'even':
1457 if (isset($tokens[$expr_end]) && $tokens[$expr_end] == 'by') {
1458 $expr_end++;
1459 $expr_arg = $tokens[$expr_end++];
1460 $expr = "!(1 & ($is_arg / " . $this->_parse_var_props($expr_arg) . "))";
1461 } else
1462 $expr = "!(1 & $is_arg)";
1463 break;
1465 case 'odd':
1466 if (isset($tokens[$expr_end]) && $tokens[$expr_end] == 'by') {
1467 $expr_end++;
1468 $expr_arg = $tokens[$expr_end++];
1469 $expr = "(1 & ($is_arg / " . $this->_parse_var_props($expr_arg) . "))";
1470 } else
1471 $expr = "(1 & $is_arg)";
1472 break;
1474 case 'div':
1475 if (@$tokens[$expr_end] == 'by') {
1476 $expr_end++;
1477 $expr_arg = $tokens[$expr_end++];
1478 $expr = "!($is_arg % " . $this->_parse_var_props($expr_arg) . ")";
1479 } else {
1480 $this->_syntax_error("expecting 'by' after 'div'", E_USER_ERROR, __FILE__, __LINE__);
1482 break;
1484 default:
1485 $this->_syntax_error("unknown 'is' expression - '$expr_type'", E_USER_ERROR, __FILE__, __LINE__);
1486 break;
1489 if ($negate_expr) {
1490 $expr = "!($expr)";
1493 array_splice($tokens, 0, $expr_end, $expr);
1495 return $tokens;
1500 * Parse attribute string
1502 * @param string $tag_args
1503 * @return array
1505 function _parse_attrs($tag_args)
1508 /* Tokenize tag attributes. */
1509 preg_match_all('~(?:' . $this->_obj_call_regexp . '|' . $this->_qstr_regexp . ' | (?>[^"\'=\s]+)
1510 )+ |
1512 ~x', $tag_args, $match);
1513 $tokens = $match[0];
1515 $attrs = array();
1516 /* Parse state:
1517 0 - expecting attribute name
1518 1 - expecting '='
1519 2 - expecting attribute value (not '=') */
1520 $state = 0;
1522 foreach ($tokens as $token) {
1523 switch ($state) {
1524 case 0:
1525 /* If the token is a valid identifier, we set attribute name
1526 and go to state 1. */
1527 if (preg_match('~^\w+$~', $token)) {
1528 $attr_name = $token;
1529 $state = 1;
1530 } else
1531 $this->_syntax_error("invalid attribute name: '$token'", E_USER_ERROR, __FILE__, __LINE__);
1532 break;
1534 case 1:
1535 /* If the token is '=', then we go to state 2. */
1536 if ($token == '=') {
1537 $state = 2;
1538 } else
1539 $this->_syntax_error("expecting '=' after attribute name '$last_token'", E_USER_ERROR, __FILE__, __LINE__);
1540 break;
1542 case 2:
1543 /* If token is not '=', we set the attribute value and go to
1544 state 0. */
1545 if ($token != '=') {
1546 /* We booleanize the token if it's a non-quoted possible
1547 boolean value. */
1548 if (preg_match('~^(on|yes|true)$~', $token)) {
1549 $token = 'true';
1550 } else if (preg_match('~^(off|no|false)$~', $token)) {
1551 $token = 'false';
1552 } else if ($token == 'null') {
1553 $token = 'null';
1554 } else if (preg_match('~^' . $this->_num_const_regexp . '|0[xX][0-9a-fA-F]+$~', $token)) {
1555 /* treat integer literally */
1556 } else if (!preg_match('~^' . $this->_obj_call_regexp . '|' . $this->_var_regexp . '(?:' . $this->_mod_regexp . ')*$~', $token)) {
1557 /* treat as a string, double-quote it escaping quotes */
1558 $token = '"'.addslashes($token).'"';
1561 $attrs[$attr_name] = $token;
1562 $state = 0;
1563 } else
1564 $this->_syntax_error("'=' cannot be an attribute value", E_USER_ERROR, __FILE__, __LINE__);
1565 break;
1567 $last_token = $token;
1570 if($state != 0) {
1571 if($state == 1) {
1572 $this->_syntax_error("expecting '=' after attribute name '$last_token'", E_USER_ERROR, __FILE__, __LINE__);
1573 } else {
1574 $this->_syntax_error("missing attribute value", E_USER_ERROR, __FILE__, __LINE__);
1578 $this->_parse_vars_props($attrs);
1580 return $attrs;
1584 * compile multiple variables and section properties tokens into
1585 * PHP code
1587 * @param array $tokens
1589 function _parse_vars_props(&$tokens)
1591 foreach($tokens as $key => $val) {
1592 $tokens[$key] = $this->_parse_var_props($val);
1597 * compile single variable and section properties token into
1598 * PHP code
1600 * @param string $val
1601 * @param string $tag_attrs
1602 * @return string
1604 function _parse_var_props($val)
1606 $val = trim($val);
1608 if(preg_match('~^(' . $this->_obj_call_regexp . '|' . $this->_dvar_regexp . ')(' . $this->_mod_regexp . '*)$~', $val, $match)) {
1609 // $ variable or object
1610 $return = $this->_parse_var($match[1]);
1611 $modifiers = $match[2];
1612 if (!empty($this->default_modifiers) && !preg_match('~(^|\|)smarty:nodefaults($|\|)~',$modifiers)) {
1613 $_default_mod_string = implode('|',(array)$this->default_modifiers);
1614 $modifiers = empty($modifiers) ? $_default_mod_string : $_default_mod_string . '|' . $modifiers;
1616 $this->_parse_modifiers($return, $modifiers);
1617 return $return;
1618 } elseif (preg_match('~^' . $this->_db_qstr_regexp . '(?:' . $this->_mod_regexp . '*)$~', $val)) {
1619 // double quoted text
1620 preg_match('~^(' . $this->_db_qstr_regexp . ')('. $this->_mod_regexp . '*)$~', $val, $match);
1621 $return = $this->_expand_quoted_text($match[1]);
1622 if($match[2] != '') {
1623 $this->_parse_modifiers($return, $match[2]);
1625 return $return;
1627 elseif(preg_match('~^' . $this->_num_const_regexp . '(?:' . $this->_mod_regexp . '*)$~', $val)) {
1628 // numerical constant
1629 preg_match('~^(' . $this->_num_const_regexp . ')('. $this->_mod_regexp . '*)$~', $val, $match);
1630 if($match[2] != '') {
1631 $this->_parse_modifiers($match[1], $match[2]);
1632 return $match[1];
1635 elseif(preg_match('~^' . $this->_si_qstr_regexp . '(?:' . $this->_mod_regexp . '*)$~', $val)) {
1636 // single quoted text
1637 preg_match('~^(' . $this->_si_qstr_regexp . ')('. $this->_mod_regexp . '*)$~', $val, $match);
1638 if($match[2] != '') {
1639 $this->_parse_modifiers($match[1], $match[2]);
1640 return $match[1];
1643 elseif(preg_match('~^' . $this->_cvar_regexp . '(?:' . $this->_mod_regexp . '*)$~', $val)) {
1644 // config var
1645 return $this->_parse_conf_var($val);
1647 elseif(preg_match('~^' . $this->_svar_regexp . '(?:' . $this->_mod_regexp . '*)$~', $val)) {
1648 // section var
1649 return $this->_parse_section_prop($val);
1651 elseif(!in_array($val, $this->_permitted_tokens) && !is_numeric($val)) {
1652 // literal string
1653 return $this->_expand_quoted_text('"' . strtr($val, array('\\' => '\\\\', '"' => '\\"')) .'"');
1655 return $val;
1659 * expand quoted text with embedded variables
1661 * @param string $var_expr
1662 * @return string
1664 function _expand_quoted_text($var_expr)
1666 // if contains unescaped $, expand it
1667 if(preg_match_all('~(?:\`(?<!\\\\)\$' . $this->_dvar_guts_regexp . '(?:' . $this->_obj_ext_regexp . ')*\`)|(?:(?<!\\\\)\$\w+(\[[a-zA-Z0-9]+\])*)~', $var_expr, $_match)) {
1668 $_match = $_match[0];
1669 rsort($_match);
1670 reset($_match);
1671 foreach($_match as $_var) {
1672 $var_expr = str_replace ($_var, '".(' . $this->_parse_var(str_replace('`','',$_var)) . ')."', $var_expr);
1674 $_return = preg_replace('~\.""|(?<!\\\\)""\.~', '', $var_expr);
1675 } else {
1676 $_return = $var_expr;
1678 // replace double quoted literal string with single quotes
1679 $_return = preg_replace('~^"([\s\w]+)"$~',"'\\1'",$_return);
1680 return $_return;
1684 * parse variable expression into PHP code
1686 * @param string $var_expr
1687 * @param string $output
1688 * @return string
1690 function _parse_var($var_expr)
1692 $_has_math = false;
1693 $_math_vars = preg_split('~('.$this->_dvar_math_regexp.'|'.$this->_qstr_regexp.')~', $var_expr, -1, PREG_SPLIT_DELIM_CAPTURE);
1695 if(count($_math_vars) > 1) {
1696 $_first_var = "";
1697 $_complete_var = "";
1698 $_output = "";
1699 // simple check if there is any math, to stop recursion (due to modifiers with "xx % yy" as parameter)
1700 foreach($_math_vars as $_k => $_math_var) {
1701 $_math_var = $_math_vars[$_k];
1703 if(!empty($_math_var) || is_numeric($_math_var)) {
1704 // hit a math operator, so process the stuff which came before it
1705 if(preg_match('~^' . $this->_dvar_math_regexp . '$~', $_math_var)) {
1706 $_has_math = true;
1707 if(!empty($_complete_var) || is_numeric($_complete_var)) {
1708 $_output .= $this->_parse_var($_complete_var);
1711 // just output the math operator to php
1712 $_output .= $_math_var;
1714 if(empty($_first_var))
1715 $_first_var = $_complete_var;
1717 $_complete_var = "";
1718 } else {
1719 $_complete_var .= $_math_var;
1723 if($_has_math) {
1724 if(!empty($_complete_var) || is_numeric($_complete_var))
1725 $_output .= $this->_parse_var($_complete_var);
1727 // get the modifiers working (only the last var from math + modifier is left)
1728 $var_expr = $_complete_var;
1732 // prevent cutting of first digit in the number (we _definitly_ got a number if the first char is a digit)
1733 if(is_numeric(substr($var_expr, 0, 1)))
1734 $_var_ref = $var_expr;
1735 else
1736 $_var_ref = substr($var_expr, 1);
1738 if(!$_has_math) {
1740 // get [foo] and .foo and ->foo and (...) pieces
1741 preg_match_all('~(?:^\w+)|' . $this->_obj_params_regexp . '|(?:' . $this->_var_bracket_regexp . ')|->\$?\w+|\.\$?\w+|\S+~', $_var_ref, $match);
1743 $_indexes = $match[0];
1744 $_var_name = array_shift($_indexes);
1746 /* Handle $smarty.* variable references as a special case. */
1747 if ($_var_name == 'smarty') {
1749 * If the reference could be compiled, use the compiled output;
1750 * otherwise, fall back on the $smarty variable generated at
1751 * run-time.
1753 if (($smarty_ref = $this->_compile_smarty_ref($_indexes)) !== null) {
1754 $_output = $smarty_ref;
1755 } else {
1756 $_var_name = substr(array_shift($_indexes), 1);
1757 $_output = "\$this->_smarty_vars['$_var_name']";
1759 } elseif(is_numeric($_var_name) && is_numeric(substr($var_expr, 0, 1))) {
1760 // because . is the operator for accessing arrays thru inidizes we need to put it together again for floating point numbers
1761 if(count($_indexes) > 0)
1763 $_var_name .= implode("", $_indexes);
1764 $_indexes = array();
1766 $_output = $_var_name;
1767 } else {
1768 $_output = "\$this->_tpl_vars['$_var_name']";
1771 foreach ($_indexes as $_index) {
1772 if (substr($_index, 0, 1) == '[') {
1773 $_index = substr($_index, 1, -1);
1774 if (is_numeric($_index)) {
1775 $_output .= "[$_index]";
1776 } elseif (substr($_index, 0, 1) == '$') {
1777 if (strpos($_index, '.') !== false) {
1778 $_output .= '[' . $this->_parse_var($_index) . ']';
1779 } else {
1780 $_output .= "[\$this->_tpl_vars['" . substr($_index, 1) . "']]";
1782 } else {
1783 $_var_parts = explode('.', $_index);
1784 $_var_section = $_var_parts[0];
1785 $_var_section_prop = isset($_var_parts[1]) ? $_var_parts[1] : 'index';
1786 $_output .= "[\$this->_sections['$_var_section']['$_var_section_prop']]";
1788 } else if (substr($_index, 0, 1) == '.') {
1789 if (substr($_index, 1, 1) == '$')
1790 $_output .= "[\$this->_tpl_vars['" . substr($_index, 2) . "']]";
1791 else
1792 $_output .= "['" . substr($_index, 1) . "']";
1793 } else if (substr($_index,0,2) == '->') {
1794 if(substr($_index,2,2) == '__') {
1795 $this->_syntax_error('call to internal object members is not allowed', E_USER_ERROR, __FILE__, __LINE__);
1796 } elseif($this->security && substr($_index, 2, 1) == '_') {
1797 $this->_syntax_error('(secure) call to private object member is not allowed', E_USER_ERROR, __FILE__, __LINE__);
1798 } elseif (substr($_index, 2, 1) == '$') {
1799 if ($this->security) {
1800 $this->_syntax_error('(secure) call to dynamic object member is not allowed', E_USER_ERROR, __FILE__, __LINE__);
1801 } else {
1802 $_output .= '->{(($_var=$this->_tpl_vars[\''.substr($_index,3).'\']) && substr($_var,0,2)!=\'__\') ? $_var : $this->trigger_error("cannot access property \\"$_var\\"")}';
1804 } else {
1805 $_output .= $_index;
1807 } elseif (substr($_index, 0, 1) == '(') {
1808 $_index = $this->_parse_parenth_args($_index);
1809 $_output .= $_index;
1810 } else {
1811 $_output .= $_index;
1816 return $_output;
1820 * parse arguments in function call parenthesis
1822 * @param string $parenth_args
1823 * @return string
1825 function _parse_parenth_args($parenth_args)
1827 preg_match_all('~' . $this->_param_regexp . '~',$parenth_args, $match);
1828 $orig_vals = $match = $match[0];
1829 $this->_parse_vars_props($match);
1830 $replace = array();
1831 for ($i = 0, $count = count($match); $i < $count; $i++) {
1832 $replace[$orig_vals[$i]] = $match[$i];
1834 return strtr($parenth_args, $replace);
1838 * parse configuration variable expression into PHP code
1840 * @param string $conf_var_expr
1842 function _parse_conf_var($conf_var_expr)
1844 $parts = explode('|', $conf_var_expr, 2);
1845 $var_ref = $parts[0];
1846 $modifiers = isset($parts[1]) ? $parts[1] : '';
1848 $var_name = substr($var_ref, 1, -1);
1850 $output = "\$this->_config[0]['vars']['$var_name']";
1852 $this->_parse_modifiers($output, $modifiers);
1854 return $output;
1858 * parse section property expression into PHP code
1860 * @param string $section_prop_expr
1861 * @return string
1863 function _parse_section_prop($section_prop_expr)
1865 $parts = explode('|', $section_prop_expr, 2);
1866 $var_ref = $parts[0];
1867 $modifiers = isset($parts[1]) ? $parts[1] : '';
1869 preg_match('!%(\w+)\.(\w+)%!', $var_ref, $match);
1870 $section_name = $match[1];
1871 $prop_name = $match[2];
1873 $output = "\$this->_sections['$section_name']['$prop_name']";
1875 $this->_parse_modifiers($output, $modifiers);
1877 return $output;
1882 * parse modifier chain into PHP code
1884 * sets $output to parsed modified chain
1885 * @param string $output
1886 * @param string $modifier_string
1888 function _parse_modifiers(&$output, $modifier_string)
1890 preg_match_all('~\|(@?\w+)((?>:(?:'. $this->_qstr_regexp . '|[^|]+))*)~', '|' . $modifier_string, $_match);
1891 list(, $_modifiers, $modifier_arg_strings) = $_match;
1893 for ($_i = 0, $_for_max = count($_modifiers); $_i < $_for_max; $_i++) {
1894 $_modifier_name = $_modifiers[$_i];
1896 if($_modifier_name == 'smarty') {
1897 // skip smarty modifier
1898 continue;
1901 preg_match_all('~:(' . $this->_qstr_regexp . '|[^:]+)~', $modifier_arg_strings[$_i], $_match);
1902 $_modifier_args = $_match[1];
1904 if (substr($_modifier_name, 0, 1) == '@') {
1905 $_map_array = false;
1906 $_modifier_name = substr($_modifier_name, 1);
1907 } else {
1908 $_map_array = true;
1911 if (empty($this->_plugins['modifier'][$_modifier_name])
1912 && !$this->_get_plugin_filepath('modifier', $_modifier_name)
1913 && function_exists($_modifier_name)) {
1914 if ($this->security && !in_array($_modifier_name, $this->security_settings['MODIFIER_FUNCS'])) {
1915 $this->_trigger_fatal_error("[plugin] (secure mode) modifier '$_modifier_name' is not allowed" , $this->_current_file, $this->_current_line_no, __FILE__, __LINE__);
1916 } else {
1917 $this->_plugins['modifier'][$_modifier_name] = array($_modifier_name, null, null, false);
1920 $this->_add_plugin('modifier', $_modifier_name);
1922 $this->_parse_vars_props($_modifier_args);
1924 if($_modifier_name == 'default') {
1925 // supress notifications of default modifier vars and args
1926 if(substr($output, 0, 1) == '$') {
1927 $output = '@' . $output;
1929 if(isset($_modifier_args[0]) && substr($_modifier_args[0], 0, 1) == '$') {
1930 $_modifier_args[0] = '@' . $_modifier_args[0];
1933 if (count($_modifier_args) > 0)
1934 $_modifier_args = ', '.implode(', ', $_modifier_args);
1935 else
1936 $_modifier_args = '';
1938 if ($_map_array) {
1939 $output = "((is_array(\$_tmp=$output)) ? \$this->_run_mod_handler('$_modifier_name', true, \$_tmp$_modifier_args) : " . $this->_compile_plugin_call('modifier', $_modifier_name) . "(\$_tmp$_modifier_args))";
1941 } else {
1943 $output = $this->_compile_plugin_call('modifier', $_modifier_name)."($output$_modifier_args)";
1951 * add plugin
1953 * @param string $type
1954 * @param string $name
1955 * @param boolean? $delayed_loading
1957 function _add_plugin($type, $name, $delayed_loading = null)
1959 if (!isset($this->_plugin_info[$type])) {
1960 $this->_plugin_info[$type] = array();
1962 if (!isset($this->_plugin_info[$type][$name])) {
1963 $this->_plugin_info[$type][$name] = array($this->_current_file,
1964 $this->_current_line_no,
1965 $delayed_loading);
1971 * Compiles references of type $smarty.foo
1973 * @param string $indexes
1974 * @return string
1976 function _compile_smarty_ref(&$indexes)
1978 /* Extract the reference name. */
1979 $_ref = substr($indexes[0], 1);
1980 foreach($indexes as $_index_no=>$_index) {
1981 if (substr($_index, 0, 1) != '.' && $_index_no<2 || !preg_match('~^(\.|\[|->)~', $_index)) {
1982 $this->_syntax_error('$smarty' . implode('', array_slice($indexes, 0, 2)) . ' is an invalid reference', E_USER_ERROR, __FILE__, __LINE__);
1986 switch ($_ref) {
1987 case 'now':
1988 $compiled_ref = 'time()';
1989 $_max_index = 1;
1990 break;
1992 case 'foreach':
1993 array_shift($indexes);
1994 $_var = $this->_parse_var_props(substr($indexes[0], 1));
1995 $_propname = substr($indexes[1], 1);
1996 $_max_index = 1;
1997 switch ($_propname) {
1998 case 'index':
1999 array_shift($indexes);
2000 $compiled_ref = "(\$this->_foreach[$_var]['iteration']-1)";
2001 break;
2003 case 'first':
2004 array_shift($indexes);
2005 $compiled_ref = "(\$this->_foreach[$_var]['iteration'] <= 1)";
2006 break;
2008 case 'last':
2009 array_shift($indexes);
2010 $compiled_ref = "(\$this->_foreach[$_var]['iteration'] == \$this->_foreach[$_var]['total'])";
2011 break;
2013 case 'show':
2014 array_shift($indexes);
2015 $compiled_ref = "(\$this->_foreach[$_var]['total'] > 0)";
2016 break;
2018 default:
2019 unset($_max_index);
2020 $compiled_ref = "\$this->_foreach[$_var]";
2022 break;
2024 case 'section':
2025 array_shift($indexes);
2026 $_var = $this->_parse_var_props(substr($indexes[0], 1));
2027 $compiled_ref = "\$this->_sections[$_var]";
2028 break;
2030 case 'get':
2031 $compiled_ref = ($this->request_use_auto_globals) ? '$_GET' : "\$GLOBALS['HTTP_GET_VARS']";
2032 break;
2034 case 'post':
2035 $compiled_ref = ($this->request_use_auto_globals) ? '$_POST' : "\$GLOBALS['HTTP_POST_VARS']";
2036 break;
2038 case 'cookies':
2039 $compiled_ref = ($this->request_use_auto_globals) ? '$_COOKIE' : "\$GLOBALS['HTTP_COOKIE_VARS']";
2040 break;
2042 case 'env':
2043 $compiled_ref = ($this->request_use_auto_globals) ? '$_ENV' : "\$GLOBALS['HTTP_ENV_VARS']";
2044 break;
2046 case 'server':
2047 $compiled_ref = ($this->request_use_auto_globals) ? '$_SERVER' : "\$GLOBALS['HTTP_SERVER_VARS']";
2048 break;
2050 case 'session':
2051 $compiled_ref = ($this->request_use_auto_globals) ? '$_SESSION' : "\$GLOBALS['HTTP_SESSION_VARS']";
2052 break;
2055 * These cases are handled either at run-time or elsewhere in the
2056 * compiler.
2058 case 'request':
2059 if ($this->request_use_auto_globals) {
2060 $compiled_ref = '$_REQUEST';
2061 break;
2062 } else {
2063 $this->_init_smarty_vars = true;
2065 return null;
2067 case 'capture':
2068 return null;
2070 case 'template':
2071 $compiled_ref = "'$this->_current_file'";
2072 $_max_index = 1;
2073 break;
2075 case 'version':
2076 $compiled_ref = "'$this->_version'";
2077 $_max_index = 1;
2078 break;
2080 case 'const':
2081 if ($this->security && !$this->security_settings['ALLOW_CONSTANTS']) {
2082 $this->_syntax_error("(secure mode) constants not permitted",
2083 E_USER_WARNING, __FILE__, __LINE__);
2084 return;
2086 array_shift($indexes);
2087 if (preg_match('!^\.\w+$!', $indexes[0])) {
2088 $compiled_ref = '@' . substr($indexes[0], 1);
2089 } else {
2090 $_val = $this->_parse_var_props(substr($indexes[0], 1));
2091 $compiled_ref = '@constant(' . $_val . ')';
2093 $_max_index = 1;
2094 break;
2096 case 'config':
2097 $compiled_ref = "\$this->_config[0]['vars']";
2098 $_max_index = 3;
2099 break;
2101 case 'ldelim':
2102 $compiled_ref = "'$this->left_delimiter'";
2103 break;
2105 case 'rdelim':
2106 $compiled_ref = "'$this->right_delimiter'";
2107 break;
2109 default:
2110 $this->_syntax_error('$smarty.' . $_ref . ' is an unknown reference', E_USER_ERROR, __FILE__, __LINE__);
2111 break;
2114 if (isset($_max_index) && count($indexes) > $_max_index) {
2115 $this->_syntax_error('$smarty' . implode('', $indexes) .' is an invalid reference', E_USER_ERROR, __FILE__, __LINE__);
2118 array_shift($indexes);
2119 return $compiled_ref;
2123 * compiles call to plugin of type $type with name $name
2124 * returns a string containing the function-name or method call
2125 * without the paramter-list that would have follow to make the
2126 * call valid php-syntax
2128 * @param string $type
2129 * @param string $name
2130 * @return string
2132 function _compile_plugin_call($type, $name) {
2133 if (isset($this->_plugins[$type][$name])) {
2134 /* plugin loaded */
2135 if (is_array($this->_plugins[$type][$name][0])) {
2136 return ((is_object($this->_plugins[$type][$name][0][0])) ?
2137 "\$this->_plugins['$type']['$name'][0][0]->" /* method callback */
2138 : (string)($this->_plugins[$type][$name][0][0]).'::' /* class callback */
2139 ). $this->_plugins[$type][$name][0][1];
2141 } else {
2142 /* function callback */
2143 return $this->_plugins[$type][$name][0];
2146 } else {
2147 /* plugin not loaded -> auto-loadable-plugin */
2148 return 'smarty_'.$type.'_'.$name;
2154 * load pre- and post-filters
2156 function _load_filters()
2158 if (count($this->_plugins['prefilter']) > 0) {
2159 foreach ($this->_plugins['prefilter'] as $filter_name => $prefilter) {
2160 if ($prefilter === false) {
2161 unset($this->_plugins['prefilter'][$filter_name]);
2162 $_params = array('plugins' => array(array('prefilter', $filter_name, null, null, false)));
2163 require_once(SMARTY_CORE_DIR . 'core.load_plugins.php');
2164 smarty_core_load_plugins($_params, $this);
2168 if (count($this->_plugins['postfilter']) > 0) {
2169 foreach ($this->_plugins['postfilter'] as $filter_name => $postfilter) {
2170 if ($postfilter === false) {
2171 unset($this->_plugins['postfilter'][$filter_name]);
2172 $_params = array('plugins' => array(array('postfilter', $filter_name, null, null, false)));
2173 require_once(SMARTY_CORE_DIR . 'core.load_plugins.php');
2174 smarty_core_load_plugins($_params, $this);
2182 * Quote subpattern references
2184 * @param string $string
2185 * @return string
2187 function _quote_replace($string)
2189 return strtr($string, array('\\' => '\\\\', '$' => '\\$'));
2193 * display Smarty syntax error
2195 * @param string $error_msg
2196 * @param integer $error_type
2197 * @param string $file
2198 * @param integer $line
2200 function _syntax_error($error_msg, $error_type = E_USER_ERROR, $file=null, $line=null)
2202 $this->_trigger_fatal_error("syntax error: $error_msg", $this->_current_file, $this->_current_line_no, $file, $line, $error_type);
2207 * check if the compilation changes from cacheable to
2208 * non-cacheable state with the beginning of the current
2209 * plugin. return php-code to reflect the transition.
2210 * @return string
2212 function _push_cacheable_state($type, $name) {
2213 $_cacheable = !isset($this->_plugins[$type][$name]) || $this->_plugins[$type][$name][4];
2214 if ($_cacheable
2215 || 0<$this->_cacheable_state++) return '';
2216 if (!isset($this->_cache_serial)) $this->_cache_serial = md5(uniqid('Smarty'));
2217 $_ret = 'if ($this->caching && !$this->_cache_including) { echo \'{nocache:'
2218 . $this->_cache_serial . '#' . $this->_nocache_count
2219 . '}\'; };';
2220 return $_ret;
2225 * check if the compilation changes from non-cacheable to
2226 * cacheable state with the end of the current plugin return
2227 * php-code to reflect the transition.
2228 * @return string
2230 function _pop_cacheable_state($type, $name) {
2231 $_cacheable = !isset($this->_plugins[$type][$name]) || $this->_plugins[$type][$name][4];
2232 if ($_cacheable
2233 || --$this->_cacheable_state>0) return '';
2234 return 'if ($this->caching && !$this->_cache_including) { echo \'{/nocache:'
2235 . $this->_cache_serial . '#' . ($this->_nocache_count++)
2236 . '}\'; };';
2241 * push opening tag-name, file-name and line-number on the tag-stack
2242 * @param string the opening tag's name
2244 function _push_tag($open_tag)
2246 array_push($this->_tag_stack, array($open_tag, $this->_current_line_no));
2250 * pop closing tag-name
2251 * raise an error if this stack-top doesn't match with the closing tag
2252 * @param string the closing tag's name
2253 * @return string the opening tag's name
2255 function _pop_tag($close_tag)
2257 $message = '';
2258 if (count($this->_tag_stack)>0) {
2259 list($_open_tag, $_line_no) = array_pop($this->_tag_stack);
2260 if ($close_tag == $_open_tag) {
2261 return $_open_tag;
2263 if ($close_tag == 'if' && ($_open_tag == 'else' || $_open_tag == 'elseif' )) {
2264 return $this->_pop_tag($close_tag);
2266 if ($close_tag == 'section' && $_open_tag == 'sectionelse') {
2267 $this->_pop_tag($close_tag);
2268 return $_open_tag;
2270 if ($close_tag == 'foreach' && $_open_tag == 'foreachelse') {
2271 $this->_pop_tag($close_tag);
2272 return $_open_tag;
2274 if ($_open_tag == 'else' || $_open_tag == 'elseif') {
2275 $_open_tag = 'if';
2276 } elseif ($_open_tag == 'sectionelse') {
2277 $_open_tag = 'section';
2278 } elseif ($_open_tag == 'foreachelse') {
2279 $_open_tag = 'foreach';
2281 $message = " expected {/$_open_tag} (opened line $_line_no).";
2283 $this->_syntax_error("mismatched tag {/$close_tag}.$message",
2284 E_USER_ERROR, __FILE__, __LINE__);
2290 * compare to values by their string length
2292 * @access private
2293 * @param string $a
2294 * @param string $b
2295 * @return 0|-1|1
2297 function _smarty_sort_length($a, $b)
2299 if($a == $b)
2300 return 0;
2302 if(strlen($a) == strlen($b))
2303 return ($a > $b) ? -1 : 1;
2305 return (strlen($a) > strlen($b)) ? -1 : 1;
2309 /* vim: set et: */