source: trunk/include/template.php @ 795

Last change on this file since 795 was 795, checked in by plg, 19 years ago
  • bug fixed when a language value contains a simple quote
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 17.7 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-2005 PhpWebGallery Team - http://phpwebgallery.net |
6// +-----------------------------------------------------------------------+
7// | branch        : BSF (Best So Far)
8// | file          : $RCSfile$
9// | last update   : $Date: 2005-06-21 20:39:29 +0000 (Tue, 21 Jun 2005) $
10// | last modifier : $Author: plg $
11// | revision      : $Revision: 795 $
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  /**
63   * Constructor. Simply sets the root dir.
64   *
65   */
66  function Template($root = ".")
67    {
68      $this->set_rootdir($root);
69    }
70 
71  /**
72   * Destroys this template object. Should be called when you're done with
73   * it, in order to clear out the template data so you can load/parse a new
74   * template set.
75   */
76  function destroy()
77    {
78      $this->_tpldata = array();
79    }
80
81  /**
82   * Sets the template root directory for this Template object.
83   */
84  function set_rootdir($dir)
85    {
86      if (!is_dir($dir))
87      {
88        return false;
89      }
90     
91      $this->root = $dir;
92      return true;
93    }
94 
95  /**
96   * Sets the template filenames for handles. $filename_array should be a
97   * hash of handle => filename pairs.
98   */
99  function set_filenames($filename_array)
100    {
101      if (!is_array($filename_array))
102      {
103        return false;
104      }
105     
106      reset($filename_array);
107      while(list($handle, $filename) = each($filename_array))
108      {
109        $this->files[$handle] = $this->make_filename($filename);
110      }
111     
112      return true;
113    }
114 
115 
116  /**
117   * Load the file for the handle, compile the file, and run the compiled
118   * code. This will print out the results of executing the template.
119   */
120  function pparse($handle)
121    {
122      if (!$this->loadfile($handle))
123      {
124        die("Template->pparse(): Couldn't load template file for handle $handle");
125      }
126     
127      // actually compile the template now.
128      if (!isset($this->compiled_code[$handle]) || empty($this->compiled_code[$handle]))
129      {
130        // Actually compile the code now.
131        $this->compiled_code[$handle] = $this->compile($this->uncompiled_code[$handle]);
132      }
133
134      // Run the compiled code.
135      //echo ("<!-- ".$this->compiled_code[$handle]." -->");
136      eval($this->compiled_code[$handle]);
137      return true;
138    }
139
140  /**
141   * fills $output template var
142   */
143  function parse($handle)
144    {
145      if (!$this->loadfile($handle))
146      {
147        die("Template->pparse(): Couldn't load template file for handle $handle");
148      }
149     
150      // actually compile the template now.
151      if (!isset($this->compiled_code[$handle]) || empty($this->compiled_code[$handle]))
152      {
153        // Actually compile the code now.
154        $this->compiled_code[$handle] = $this->compile($this->uncompiled_code[$handle], true, '_str');
155      }
156
157      // Run the compiled code.
158      $_str = '';
159//      echo '<pre>'.($this->compiled_code[$handle]).'</pre>';
160      $fp = @fopen( './log/debug.log', 'a+' );
161      fwrite( $fp, "\n\n" );
162      fwrite( $fp, $this->compiled_code[$handle] );
163      fclose( $fp );
164      eval($this->compiled_code[$handle]);
165      $this->output.= $_str;
166
167      return true;
168    }
169
170  /**
171   * prints $output template var
172   */
173  function p()
174    {
175      echo $this->output;
176    }
177 
178  /**
179   * Inserts the uncompiled code for $handle as the value of $varname in the
180   * root-level. This can be used to effectively include a template in the
181   * middle of another template.
182   *
183   * Note that all desired assignments to the variables in $handle should be
184   * done BEFORE calling this function.
185   */
186  function assign_var_from_handle($varname, $handle)
187    {
188      if (!$this->loadfile($handle))
189      {
190        die("Template->assign_var_from_handle(): Couldn't load template file for handle $handle");
191      }
192     
193      // Compile it, with the "no echo statements" option on.
194      $_str = "";
195      $code = $this->compile($this->uncompiled_code[$handle], true, '_str');
196     
197      // evaluate the variable assignment.
198      eval($code);
199      // assign the value of the generated variable to the given varname.
200      $this->assign_var($varname, $_str);
201     
202      return true;
203    }
204 
205  /**
206   * Block-level variable assignment. Adds a new block iteration with the
207   * given variable assignments. Note that this should only be called once
208   * per block iteration.
209   */
210  function assign_block_vars($blockname, $vararray)
211    {
212      if (strstr($blockname, '.'))
213      {
214        // Nested block.
215        $blocks = explode('.', $blockname);
216        $blockcount = sizeof($blocks) - 1;
217        $str = '$this->_tpldata';
218        for ($i = 0; $i < $blockcount; $i++)
219        {
220          $str .= '[\'' . $blocks[$i] . '.\']';
221          eval('$lastiteration = sizeof(' . $str . ') - 1;');
222          $str .= '[' . $lastiteration . ']';
223        }
224        // Now we add the block that we're actually assigning to.
225        // We're adding a new iteration to this block with the given
226        // variable assignments.
227        $str .= '[\'' . $blocks[$blockcount] . '.\'][] = $vararray;';
228       
229        // Now we evaluate this assignment we've built up.
230        eval($str);
231      }
232      else
233      {
234        // Top-level block. Add a new iteration to this block with the
235        // variable assignments we were given.
236        $this->_tpldata[$blockname . '.'][] = $vararray;
237      }
238     
239      return true;
240    }
241 
242  /**
243   * Root-level variable assignment. Adds to current assignments, overriding
244   * any existing variable assignment with the same name.
245   */
246  function assign_vars($vararray)
247    {
248      reset ($vararray);
249      while (list($key, $val) = each($vararray))
250      {
251        $this->_tpldata['.'][0][$key] = $val;
252      }
253     
254      return true;
255    }
256 
257  /**
258   * Root-level variable assignment. Adds to current assignments, overriding
259   * any existing variable assignment with the same name.
260   */
261  function assign_var($varname, $varval)
262    {
263      $this->_tpldata['.'][0][$varname] = $varval;
264     
265      return true;
266    }
267 
268 
269  /**
270   * Generates a full path+filename for the given filename, which can either
271   * be an absolute name, or a name relative to the rootdir for this
272   * Template object.
273   */
274  function make_filename($filename)
275    {
276      // Check if it's an absolute or relative path.
277      if (substr($filename, 0, 1) != '/')
278      {
279        $filename = $this->root.'/'.$filename;
280      }
281     
282      if (!file_exists($filename))
283      {
284        die("Template->make_filename(): Error - file $filename does not exist");
285      }
286
287      return $filename;
288    }
289 
290 
291  /**
292   * If not already done, load the file for the given handle and populate
293   * the uncompiled_code[] hash with its code. Do not compile.
294   */
295  function loadfile($handle)
296    {
297      // If the file for this handle is already loaded and compiled, do
298      // nothing.
299      if (isset($this->uncompiled_code[$handle])
300          and !empty($this->uncompiled_code[$handle]))
301      {
302        return true;
303      }
304     
305      // If we don't have a file assigned to this handle, die.
306      if (!isset($this->files[$handle]))
307      {
308        die("Template->loadfile(): No file specified for handle $handle");
309      }
310     
311      $filename = $this->files[$handle];
312     
313      $str = implode("", @file($filename));
314      if (empty($str))
315      {
316        die("Template->loadfile(): File $filename for handle $handle is empty");
317      }
318     
319      $this->uncompiled_code[$handle] = $str;
320     
321      return true;
322    }
323 
324 
325 
326  /**
327   * Compiles the given string of code, and returns the result in a string.
328   *
329   * If "do_not_echo" is true, the returned code will not be directly
330   * executable, but can be used as part of a variable assignment for use in
331   * assign_code_from_handle().
332   */
333  function compile($code, $do_not_echo = false, $retvar = '')
334    {
335      // PWG specific : communication between template and $lang
336      $code = preg_replace('/\{lang:([^}]+)\}/e', "l10n('$1')", $code);
337           
338      // replace \ with \\ and then ' with \'.
339      $code = str_replace('\\', '\\\\', $code);
340      $code = str_replace('\'', '\\\'', $code);
341     
342      // change template varrefs into PHP varrefs
343     
344      // This one will handle varrefs WITH namespaces
345      $varrefs = array();
346      preg_match_all('#\{(([a-z0-9\-_]+?\.)+?)([a-z0-9\-_]+?)\}#is', $code, $varrefs);
347      $varcount = sizeof($varrefs[1]);
348      for ($i = 0; $i < $varcount; $i++)
349      {
350        $namespace = $varrefs[1][$i];
351        $varname = $varrefs[3][$i];
352        $new = $this->generate_block_varref($namespace, $varname);
353       
354        $code = str_replace($varrefs[0][$i], $new, $code);
355      }
356     
357      // This will handle the remaining root-level varrefs
358      $code = preg_replace('#\{([a-z0-9\-_]*?)\}#is', '\' . ( ( isset($this->_tpldata[\'.\'][0][\'\1\']) ) ? $this->_tpldata[\'.\'][0][\'\1\'] : \'\' ) . \'', $code);
359     
360      // Break it up into lines.
361      $code_lines = explode("\n", $code);
362     
363      $block_nesting_level = 0;
364      $block_names = array();
365      $block_names[0] = ".";
366     
367      // Second: prepend echo ', append ' . "\n"; to each line.
368      $line_count = sizeof($code_lines);
369      for ($i = 0; $i < $line_count; $i++)
370      {
371        $code_lines[$i] = chop($code_lines[$i]);
372        if (preg_match('#<!-- BEGIN (.*?) -->#', $code_lines[$i], $m))
373        {
374          $n[0] = $m[0];
375          $n[1] = $m[1];
376         
377          // Added: dougk_ff7-Keeps templates from bombing if begin is on
378          // the same line as end.. I think. :)
379          if ( preg_match('#<!-- END (.*?) -->#', $code_lines[$i], $n) )
380          {
381            $block_nesting_level++;
382            $block_names[$block_nesting_level] = $m[1];
383            if ($block_nesting_level < 2)
384            {
385              // Block is not nested.
386              $code_lines[$i] = '$_' . $n[1] . '_count = ( isset($this->_tpldata[\'' . $n[1] . '.\']) ) ?  sizeof($this->_tpldata[\'' . $n[1] . '.\']) : 0;';
387              $code_lines[$i] .= "\n" . 'for ($_' . $n[1] . '_i = 0; $_' . $n[1] . '_i < $_' . $n[1] . '_count; $_' . $n[1] . '_i++)';
388              $code_lines[$i] .= "\n" . '{';
389            }
390            else
391            {
392              // This block is nested.
393             
394              // Generate a namespace string for this block.
395              $namespace = implode('.', $block_names);
396              // strip leading period from root level..
397              $namespace = substr($namespace, 2);
398              // Get a reference to the data array for this block that depends on the
399              // current indices of all parent blocks.
400              $varref = $this->generate_block_data_ref($namespace, false);
401              // Create the for loop code to iterate over this block.
402              $code_lines[$i] = '$_' . $n[1] . '_count = ( isset(' . $varref . ') ) ? sizeof(' . $varref . ') : 0;';
403              $code_lines[$i] .= "\n" . 'for ($_' . $n[1] . '_i = 0; $_' . $n[1] . '_i < $_' . $n[1] . '_count; $_' . $n[1] . '_i++)';
404              $code_lines[$i] .= "\n" . '{';
405            }
406           
407            // We have the end of a block.
408            unset($block_names[$block_nesting_level]);
409            $block_nesting_level--;
410            $code_lines[$i] .= '} // END ' . $n[1];
411            $m[0] = $n[0];
412            $m[1] = $n[1];
413          }
414          else
415          {
416            // We have the start of a block.
417            $block_nesting_level++;
418            $block_names[$block_nesting_level] = $m[1];
419            if ($block_nesting_level < 2)
420            {
421              // Block is not nested.
422              $code_lines[$i] = '$_' . $m[1] . '_count = ( isset($this->_tpldata[\'' . $m[1] . '.\']) ) ? sizeof($this->_tpldata[\'' . $m[1] . '.\']) : 0;';
423              $code_lines[$i] .= "\n" . 'for ($_' . $m[1] . '_i = 0; $_' . $m[1] . '_i < $_' . $m[1] . '_count; $_' . $m[1] . '_i++)';
424              $code_lines[$i] .= "\n" . '{';
425            }
426            else
427            {
428              // This block is nested.
429             
430              // Generate a namespace string for this block.
431              $namespace = implode('.', $block_names);
432              // strip leading period from root level..
433              $namespace = substr($namespace, 2);
434              // Get a reference to the data array for this block that
435              // depends on the current indices of all parent blocks.
436              $varref = $this->generate_block_data_ref($namespace, false);
437              // Create the for loop code to iterate over this block.
438              $code_lines[$i] = '$_' . $m[1] . '_count = ( isset(' . $varref . ') ) ? sizeof(' . $varref . ') : 0;';
439              $code_lines[$i] .= "\n" . 'for ($_' . $m[1] . '_i = 0; $_' . $m[1] . '_i < $_' . $m[1] . '_count; $_' . $m[1] . '_i++)';
440              $code_lines[$i] .= "\n" . '{';
441            }
442          }
443        }
444        else if (preg_match('#<!-- END (.*?) -->#', $code_lines[$i], $m))
445        {
446          // We have the end of a block.
447          unset($block_names[$block_nesting_level]);
448          $block_nesting_level--;
449          $code_lines[$i] = '} // END ' . $m[1];
450        }
451        else
452        {
453          // We have an ordinary line of code.
454          if (!$do_not_echo)
455          {
456            $code_lines[$i] = 'echo \'' . $code_lines[$i] . '\' . "\\n";';
457          }
458          else
459          {
460            $code_lines[$i] = '$' . $retvar . '.= \'' . $code_lines[$i] . '\' . "\\n";'; 
461          }
462        }
463      }
464     
465      // Bring it back into a single string of lines of code.
466      $code = implode("\n", $code_lines);
467      return $code      ;
468     
469    }
470 
471 
472  /**
473   * Generates a reference to the given variable inside the given (possibly
474   * nested) block namespace. This is a string of the form: '
475   * . $this->_tpldata['parent'][$_parent_i]['$child1'][$_child1_i]['$child2'][$_child2_i]...['varname']
476   * . ' It's ready to be inserted into an "echo" line in one of the
477   * templates.  NOTE: expects a trailing "." on the namespace.
478   */
479  function generate_block_varref($namespace, $varname)
480    {
481      // Strip the trailing period.
482      $namespace = substr($namespace, 0, strlen($namespace) - 1);
483     
484      // Get a reference to the data block for this namespace.
485      $varref = $this->generate_block_data_ref($namespace, true);
486      // Prepend the necessary code to stick this in an echo line.
487     
488      // Append the variable reference.
489      $varref .= '[\'' . $varname . '\']';
490     
491      $varref = '\' . ( ( isset(' . $varref . ') ) ? ' . $varref . ' : \'\' ) . \'';
492     
493      return $varref;
494     
495    }
496 
497 
498  /**
499   * Generates a reference to the array of data values for the given
500   * (possibly nested) block namespace. This is a string of the form:
501   * $this->_tpldata['parent'][$_parent_i]['$child1'][$_child1_i]['$child2'][$_child2_i]...['$childN']
502   *
503   * If $include_last_iterator is true, then [$_childN_i] will be appended
504   * to the form shown above.  NOTE: does not expect a trailing "." on the
505   * blockname.
506   */
507  function generate_block_data_ref($blockname, $include_last_iterator)
508    {
509      // Get an array of the blocks involved.
510      $blocks = explode(".", $blockname);
511      $blockcount = sizeof($blocks) - 1;
512      $varref = '$this->_tpldata';
513      // Build up the string with everything but the last child.
514      for ($i = 0; $i < $blockcount; $i++)
515      {
516        $varref .= '[\'' . $blocks[$i] . '.\'][$_' . $blocks[$i] . '_i]';
517      }
518      // Add the block reference for the last child.
519      $varref .= '[\'' . $blocks[$blockcount] . '.\']';
520      // Add the iterator for the last child if requried.
521      if ($include_last_iterator)
522      {
523              $varref .= '[$_' . $blocks[$blockcount] . '_i]';
524      }
525     
526      return $varref;
527    }
528 
529}
530
531?>
Note: See TracBrowser for help on using the repository browser.