source: trunk/include/template.php @ 2058

Last change on this file since 2058 was 2058, checked in by rub, 17 years ago

Resolved issue 0000718: Add method "concat_var_from_handle" in template class

Rename trigger name loc_before_* by loc_begin_*

Merge branch-1_7 2048:2050 into BSF

  • Property svn:eol-style set to LF
  • Property svn:keywords set to Author Date Id Revision
File size: 20.2 KB
Line 
1<?php
2// +-----------------------------------------------------------------------+
3// | PhpWebGallery - a PHP based picture gallery                           |
4// | Copyright (C) 2002-2003 Pierrick LE GALL - pierrick@phpwebgallery.net |
5// | Copyright (C) 2003-2007 PhpWebGallery Team - http://phpwebgallery.net |
6// +-----------------------------------------------------------------------+
7// | branch        : BSF (Best So Far)
8// | file          : $Id: template.php 2058 2007-07-10 05:09:05Z rub $
9// | last update   : $Date: 2007-07-10 05:09:05 +0000 (Tue, 10 Jul 2007) $
10// | last modifier : $Author: rub $
11// | revision      : $Revision: 2058 $
12// +-----------------------------------------------------------------------+
13// | This program is free software; you can redistribute it and/or modify  |
14// | it under the terms of the GNU General Public License as published by  |
15// | the Free Software Foundation                                          |
16// |                                                                       |
17// | This program is distributed in the hope that it will be useful, but   |
18// | WITHOUT ANY WARRANTY; without even the implied warranty of            |
19// | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU      |
20// | General Public License for more details.                              |
21// |                                                                       |
22// | You should have received a copy of the GNU General Public License     |
23// | along with this program; if not, write to the Free Software           |
24// | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, |
25// | USA.                                                                  |
26// +-----------------------------------------------------------------------+
27
28/**
29 * Template class. By Nathan Codding of the phpBB group. The interface was
30 * originally inspired by PHPLib templates, and the template file formats
31 * are quite similar.
32 */
33
34class Template {
35
36  var $classname = "Template";
37
38  // variable that holds all the data we'll be substituting into
39  // the compiled templates.
40  // ...
41  // This will end up being a multi-dimensional array like this :
42  // $this->_tpldata[block.][iteration#][child.][iteration#][child2.][iteration#][variablename] == value
43  // if it's a root-level variable, it'll be like this:
44  // $this->_tpldata[.][0][varname] == value
45  var $_tpldata = array();
46
47  // Hash of filenames for each template handle.
48  var $files = array();
49
50  // Root template directory.
51  var $root = "";
52
53  // this will hash handle names to the compiled code for that handle.
54  var $compiled_code = array();
55
56  // This will hold the uncompiled code for that handle.
57  var $uncompiled_code = array();
58
59  // output
60  var $output = '';
61
62  var $themeconf = array();
63
64  /**
65   * Constructor. Simply sets the root dir.
66   *
67   */
68  function Template($root = ".", $theme= "")
69    {
70      if ( $this->set_rootdir($root) )
71      {
72        if ( !empty( $theme ) )
73        {
74          include($root.'/theme/'.$theme.'/themeconf.inc.php');
75          $this->themeconf = $themeconf;
76        }
77      }
78    }
79
80  /**
81   * Destroys this template object. Should be called when you're done with
82   * it, in order to clear out the template data so you can load/parse a new
83   * template set.
84   */
85  function destroy()
86    {
87      $this->_tpldata = array();
88    }
89
90  /**
91   * Sets the template root directory for this Template object.
92   */
93  function set_rootdir($dir)
94    {
95      if (!is_dir($dir))
96      {
97        return false;
98      }
99
100      $this->root = $dir;
101      return true;
102    }
103
104  /**
105   * Sets the template filename for handle.
106   */
107  function set_filename($handle, $filename)
108    {
109      return $this->set_filenames( array($handle=>$filename) );
110    }
111
112  /**
113   * Sets the template filenames for handles. $filename_array should be a
114   * hash of handle => filename pairs.
115   */
116  function set_filenames($filename_array)
117    {
118      $filename_array = trigger_event('loc_tpl_set_filenames', $filename_array, array(&$this));
119
120      if (!is_array($filename_array))
121      {
122        return false;
123      }
124
125      reset($filename_array);
126      while(list($handle, $filename) = each($filename_array))
127      {
128        if (is_null($filename))
129        {
130          unset( $this->files[$handle] );
131        }
132        else
133        {
134          $this->files[$handle] = $this->make_filename($filename);
135        }
136        unset($this->compiled_code[$handle]);
137        unset($this->uncompiled_code[$handle]);
138      }
139
140      return true;
141    }
142
143
144  /**
145   * Load the file for the handle, compile the file, and run the compiled
146   * code. This will print out the results of executing the template.
147   */
148  function pparse($handle)
149    {
150      if (!$this->loadfile($handle))
151      {
152        die("Template->pparse(): Couldn't load template file for handle $handle");
153      }
154
155      // actually compile the template now.
156      if (!isset($this->compiled_code[$handle]) || empty($this->compiled_code[$handle]))
157      {
158        trigger_action('loc_begin_tpl_pparse', $handle, array(&$this));
159        // Actually compile the code now.
160        $this->compiled_code[$handle] = $this->compile($this->uncompiled_code[$handle]);
161      }
162
163      // Run the compiled code.
164      //echo ("<!-- ".$this->compiled_code[$handle]." -->");
165      eval($this->compiled_code[$handle]);
166      return true;
167    }
168
169  /**
170   * fills $output template var by default or returns the content
171   */
172  function parse($handle, $return=false)
173    {
174      if (!$this->loadfile($handle))
175      {
176        die("Template->pparse(): Couldn't load template file for handle $handle");
177      }
178
179      // actually compile the template now.
180      if (!isset($this->compiled_code[$handle]) || empty($this->compiled_code[$handle]))
181      {
182        trigger_action('loc_begin_tpl_parse', $handle, array(&$this));
183        // Actually compile the code now.
184        $this->compiled_code[$handle] = $this->compile($this->uncompiled_code[$handle], true, '_str');
185      }
186
187      // Run the compiled code.
188      $_str = '';
189      eval($this->compiled_code[$handle]);
190      if ($return)
191      {
192        return $_str;
193      }
194      $this->output.= $_str;
195
196      return true;
197    }
198
199  /**
200   * prints $output template var
201   */
202  function p()
203    {
204      echo $this->output;
205    }
206
207  /**
208   * Inserts the uncompiled code for $handle as the value of $varname in the
209   * root-level. This can be used to effectively include a template in the
210   * middle of another template.
211   *
212   * Note that all desired assignments to the variables in $handle should be
213   * done BEFORE calling this function.
214   */
215  function assign_var_from_handle($varname, $handle)
216    {
217      trigger_action('loc_begin_tpl_assign_var_from_handle', $varname, $handle, array(&$this));
218      $this->assign_var($varname, $this->parse($handle, true));
219      return true;
220    }
221
222  /**
223   * Concat the uncompiled code for $handle as the value of $varname in the
224   * root-level. This can be used to effectively include a template in the
225   * middle of another template.
226   *
227   * Note that all desired assignments to the variables in $handle should be
228   * done BEFORE calling this function.
229   */
230  function concat_var_from_handle($varname, $handle)
231    {
232      trigger_action('loc_begin_tpl_concat_var_from_handle', $varname, $handle, array(&$this));
233      $this->concat_var($varname, $this->parse($handle, true));
234      return true;
235    }
236
237  /**
238   * Block-level variable assignment. Adds a new block iteration with the
239   * given variable assignments. Note that this should only be called once
240   * per block iteration.
241   */
242  function assign_block_vars($blockname, $vararray)
243    {
244      if (strstr($blockname, '.'))
245      {
246        // Nested block.
247        $blocks = explode('.', $blockname);
248        $blockcount = sizeof($blocks) - 1;
249        $str = '$this->_tpldata';
250        for ($i = 0; $i < $blockcount; $i++)
251        {
252          $str .= '[\'' . $blocks[$i] . '.\']';
253          eval('$lastiteration = isset('.$str.') ? sizeof('.$str.')-1:0;');
254          $str .= '[' . $lastiteration . ']';
255        }
256        // Now we add the block that we're actually assigning to.
257        // We're adding a new iteration to this block with the given
258        // variable assignments.
259        $str .= '[\'' . $blocks[$blockcount] . '.\'][] = $vararray;';
260
261        // Now we evaluate this assignment we've built up.
262        eval($str);
263      }
264      else
265      {
266        // Top-level block. Add a new iteration to this block with the
267        // variable assignments we were given.
268        $this->_tpldata[$blockname . '.'][] = $vararray;
269      }
270
271      return true;
272    }
273
274  /**
275   * Block-level variable merge. Merge given variables to the last block
276   * iteration. This can be called several times per block iteration.
277   */
278  function merge_block_vars($blockname, $vararray)
279    {
280      $blocks = explode('.', $blockname);
281      $blockcount = count($blocks);
282      $str = '$this->_tpldata';
283      for ($i = 0; $i < $blockcount; $i++)
284      {
285        $str .= '[\'' . $blocks[$i] . '.\']';
286        eval('$lastiteration = isset('.$str.') ? sizeof('.$str.')-1:-1;');
287        if ($lastiteration==-1)
288        {
289          return false;
290        }
291        $str .= '[' . $lastiteration . ']';
292      }
293      $str = $str.'=array_merge('.$str.', $vararray);';
294      eval($str);
295      return true;
296    }
297
298  /**
299   * Root-level variable assignment. Adds to current assignments, overriding
300   * any existing variable assignment with the same name.
301   */
302  function assign_vars($vararray)
303    {
304      reset ($vararray);
305      while (list($key, $val) = each($vararray))
306      {
307        $this->_tpldata['.'][0][$key] = $val;
308      }
309
310      return true;
311    }
312
313  /**
314   * Root-level variable assignment. Adds to current assignments, overriding
315   * any existing variable assignment with the same name.
316   */
317  function assign_var($varname, $varval)
318    {
319      $this->_tpldata['.'][0][$varname] = $varval;
320      return true;
321    }
322
323  /**
324   * Root-level variable concatenation. Appends a  string to an existing
325   * variable assignment with the same name.
326   */
327  function concat_var($varname, $varval)
328    {
329      if ( isset($this->_tpldata['.'][0][$varname]) )
330      {
331        $this->_tpldata['.'][0][$varname] .= $varval;
332      }
333      else
334      {
335        $this->_tpldata['.'][0][$varname] = $varval;
336      }
337      return true;
338    }
339
340  /**
341   * Returns a root-level variable value
342   */
343  function get_var($varname, $default=null)
344    {
345      if ( isset($this->_tpldata['.'][0][$varname]) )
346      {
347        return $this->_tpldata['.'][0][$varname];
348      }
349      return $default;
350    }
351
352  /**
353   * Generates a full path+filename for the given filename, which can either
354   * be an absolute name, or a name relative to the rootdir for this
355   * Template object.
356   */
357  function make_filename($filename)
358    {
359      // Check if it's an absolute or relative path.
360      // if (substr($filename, 0, 1) != '/')
361      if (preg_match('/^[a-z_][^:]/i', $filename) )
362      {
363        $filename = $this->root.'/'.$filename;
364      }
365
366      if (!file_exists($filename))
367      {
368        die("Template->make_filename(): Error - file $filename does not exist");
369      }
370
371      return $filename;
372    }
373
374
375  /**
376   * If not already done, load the file for the given handle and populate
377   * the uncompiled_code[] hash with its code. Do not compile.
378   */
379  function loadfile($handle)
380    {
381      // If the file for this handle is already loaded and compiled, do
382      // nothing.
383      if (isset($this->uncompiled_code[$handle])
384          and !empty($this->uncompiled_code[$handle]))
385      {
386        return true;
387      }
388
389      // If we don't have a file assigned to this handle, die.
390      if (!isset($this->files[$handle]))
391      {
392        die("Template->loadfile(): No file specified for handle $handle");
393      }
394
395      $filename = $this->files[$handle];
396
397      $str = implode("", @file($filename));
398
399      if (empty($str))
400      {
401        die("Template->loadfile(): File $filename for handle $handle is empty");
402      }
403
404      $this->uncompiled_code[$handle] = trigger_event('tpl_load_file', $str, $handle, array(&$this));
405
406      return true;
407    }
408
409
410
411  /**
412   * Compiles the given string of code, and returns the result in a string.
413   *
414   * If "do_not_echo" is true, the returned code will not be directly
415   * executable, but can be used as part of a variable assignment for use in
416   * assign_code_from_handle().
417   */
418  function compile($code, $do_not_echo = false, $retvar = '')
419    {
420      // PWG specific : communication between template and $lang
421      $code = preg_replace('/\{lang:([^}]+)\}/e', "l10n('$1')", $code);
422      // PWG specific : expand themeconf.inc.php variables
423      $code = preg_replace('/\{themeconf:([^}]+)\}/e', '$this->get_themeconf(\'$1\')', $code);
424      $code = preg_replace('/\{pwg_root\}/e', "get_root_url()", $code);
425
426      // replace \ with \\ and then ' with \'.
427      $code = str_replace('\\', '\\\\', $code);
428      $code = str_replace('\'', '\\\'', $code);
429
430      // change template varrefs into PHP varrefs
431
432      // This one will handle varrefs WITH namespaces
433      $varrefs = array();
434      preg_match_all('#\{(([a-z0-9\-_]+?\.)+?)([a-z0-9\-_]+?)\}#is', $code, $varrefs);
435      $varcount = sizeof($varrefs[1]);
436      for ($i = 0; $i < $varcount; $i++)
437      {
438        $namespace = $varrefs[1][$i];
439        $varname = $varrefs[3][$i];
440        $new = $this->generate_block_varref($namespace, $varname);
441
442        $code = str_replace($varrefs[0][$i], $new, $code);
443      }
444
445      // This will handle the remaining root-level varrefs
446      $code = preg_replace('#\{([a-z0-9\-_]*?)\}#is', '\' . ( ( isset($this->_tpldata[\'.\'][0][\'\1\']) ) ? $this->_tpldata[\'.\'][0][\'\1\'] : \'\' ) . \'', $code);
447
448      // Break it up into lines.
449      $code_lines = explode("\n", $code);
450
451      $block_nesting_level = 0;
452      $block_names = array();
453      $block_names[0] = ".";
454
455      // Second: prepend echo ', append ' . "\n"; to each line.
456      $line_count = sizeof($code_lines);
457      for ($i = 0; $i < $line_count; $i++)
458      {
459        $code_lines[$i] = chop($code_lines[$i]);
460        if (preg_match('#<!-- BEGIN (.*?) -->#', $code_lines[$i], $m))
461        {
462          $n[0] = $m[0];
463          $n[1] = $m[1];
464
465          // Added: dougk_ff7-Keeps templates from bombing if begin is on
466          // the same line as end.. I think. :)
467          if ( preg_match('#<!-- END (.*?) -->#', $code_lines[$i], $n) )
468          {
469            $block_nesting_level++;
470            $block_names[$block_nesting_level] = $m[1];
471            if ($block_nesting_level < 2)
472            {
473              // Block is not nested.
474              $code_lines[$i] = '$_' . $n[1] . '_count = ( isset($this->_tpldata[\'' . $n[1] . '.\']) ) ?  sizeof($this->_tpldata[\'' . $n[1] . '.\']) : 0;';
475              $code_lines[$i] .= "\n" . 'for ($_' . $n[1] . '_i = 0; $_' . $n[1] . '_i < $_' . $n[1] . '_count; $_' . $n[1] . '_i++)';
476              $code_lines[$i] .= "\n" . '{';
477            }
478            else
479            {
480              // This block is nested.
481
482              // Generate a namespace string for this block.
483              $namespace = implode('.', $block_names);
484              // strip leading period from root level..
485              $namespace = substr($namespace, 2);
486              // Get a reference to the data array for this block that depends on the
487              // current indices of all parent blocks.
488              $varref = $this->generate_block_data_ref($namespace, false);
489              // Create the for loop code to iterate over this block.
490              $code_lines[$i] = '$_' . $n[1] . '_count = ( isset(' . $varref . ') ) ? sizeof(' . $varref . ') : 0;';
491              $code_lines[$i] .= "\n" . 'for ($_' . $n[1] . '_i = 0; $_' . $n[1] . '_i < $_' . $n[1] . '_count; $_' . $n[1] . '_i++)';
492              $code_lines[$i] .= "\n" . '{';
493            }
494
495            // We have the end of a block.
496            unset($block_names[$block_nesting_level]);
497            $block_nesting_level--;
498            $code_lines[$i] .= '} // END ' . $n[1];
499            $m[0] = $n[0];
500            $m[1] = $n[1];
501          }
502          else
503          {
504            // We have the start of a block.
505            $block_nesting_level++;
506            $block_names[$block_nesting_level] = $m[1];
507            if ($block_nesting_level < 2)
508            {
509              // Block is not nested.
510              $code_lines[$i] = '$_' . $m[1] . '_count = ( isset($this->_tpldata[\'' . $m[1] . '.\']) ) ? sizeof($this->_tpldata[\'' . $m[1] . '.\']) : 0;';
511              $code_lines[$i] .= "\n" . 'for ($_' . $m[1] . '_i = 0; $_' . $m[1] . '_i < $_' . $m[1] . '_count; $_' . $m[1] . '_i++)';
512              $code_lines[$i] .= "\n" . '{';
513            }
514            else
515            {
516              // This block is nested.
517
518              // Generate a namespace string for this block.
519              $namespace = implode('.', $block_names);
520              // strip leading period from root level..
521              $namespace = substr($namespace, 2);
522              // Get a reference to the data array for this block that
523              // depends on the current indices of all parent blocks.
524              $varref = $this->generate_block_data_ref($namespace, false);
525              // Create the for loop code to iterate over this block.
526              $code_lines[$i] = '$_' . $m[1] . '_count = ( isset(' . $varref . ') ) ? sizeof(' . $varref . ') : 0;';
527              $code_lines[$i] .= "\n" . 'for ($_' . $m[1] . '_i = 0; $_' . $m[1] . '_i < $_' . $m[1] . '_count; $_' . $m[1] . '_i++)';
528              $code_lines[$i] .= "\n" . '{';
529            }
530          }
531        }
532        else if (preg_match('#<!-- END (.*?) -->#', $code_lines[$i], $m))
533        {
534          // We have the end of a block.
535          unset($block_names[$block_nesting_level]);
536          $block_nesting_level--;
537          $code_lines[$i] = '} // END ' . $m[1];
538        }
539        else
540        {
541          // We have an ordinary line of code.
542          if (!$do_not_echo)
543          {
544            $code_lines[$i] = 'echo \'' . $code_lines[$i] . '\' . "\\n";';
545          }
546          else
547          {
548            $code_lines[$i] = '$' . $retvar . '.= \'' . $code_lines[$i] . '\' . "\\n";';
549          }
550        }
551      }
552
553      // Bring it back into a single string of lines of code.
554      $code = implode("\n", $code_lines);
555      return $code      ;
556
557    }
558
559
560  /**
561   * Generates a reference to the given variable inside the given (possibly
562   * nested) block namespace. This is a string of the form: '
563   * . $this->_tpldata['parent'][$_parent_i]['$child1'][$_child1_i]['$child2'][$_child2_i]...['varname']
564   * . ' It's ready to be inserted into an "echo" line in one of the
565   * templates.  NOTE: expects a trailing "." on the namespace.
566   */
567  function generate_block_varref($namespace, $varname)
568    {
569      // Strip the trailing period.
570      $namespace = substr($namespace, 0, strlen($namespace) - 1);
571
572      // Get a reference to the data block for this namespace.
573      $varref = $this->generate_block_data_ref($namespace, true);
574      // Prepend the necessary code to stick this in an echo line.
575
576      // Append the variable reference.
577      $varref .= '[\'' . $varname . '\']';
578
579      $varref = '\' . ( ( isset(' . $varref . ') ) ? ' . $varref . ' : \'\' ) . \'';
580
581      return $varref;
582
583    }
584
585
586  /**
587   * Generates a reference to the array of data values for the given
588   * (possibly nested) block namespace. This is a string of the form:
589   * $this->_tpldata['parent'][$_parent_i]['$child1'][$_child1_i]['$child2'][$_child2_i]...['$childN']
590   *
591   * If $include_last_iterator is true, then [$_childN_i] will be appended
592   * to the form shown above.  NOTE: does not expect a trailing "." on the
593   * blockname.
594   */
595  function generate_block_data_ref($blockname, $include_last_iterator)
596    {
597      // Get an array of the blocks involved.
598      $blocks = explode(".", $blockname);
599      $blockcount = sizeof($blocks) - 1;
600      $varref = '$this->_tpldata';
601      // Build up the string with everything but the last child.
602      for ($i = 0; $i < $blockcount; $i++)
603      {
604        $varref .= '[\'' . $blocks[$i] . '.\'][$_' . $blocks[$i] . '_i]';
605      }
606      // Add the block reference for the last child.
607      $varref .= '[\'' . $blocks[$blockcount] . '.\']';
608      // Add the iterator for the last child if requried.
609      if ($include_last_iterator)
610      {
611              $varref .= '[$_' . $blocks[$blockcount] . '_i]';
612      }
613
614      return $varref;
615    }
616
617    function get_themeconf($key)
618    {
619      return isset($this->themeconf[$key]) ? $this->themeconf[$key] : '';
620    }
621}
622
623?>
Note: See TracBrowser for help on using the repository browser.