source: trunk/include/template.php @ 922

Last change on this file since 922 was 858, checked in by plg, 19 years ago
  • modification : less configuration parameters in administration screen. These parameters are move to include/config_default.inc.php.
  • new : ability to add a single picture to caddie from picture.php
  • new : contextual help, only a few pages are available.
  • new : ability to delete users from admin/user_list
  • modification : reorganization of configuration file
  • new : configuration parameter use_exif_mapping
  • improvement : MOD hidemail added to standard
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 17.6 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-09-03 16:36:05 +0000 (Sat, 03 Sep 2005) $
10// | last modifier : $Author: plg $
11// | revision      : $Revision: 858 $
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      eval($this->compiled_code[$handle]);
160      $this->output.= $_str;
161
162      return true;
163    }
164
165  /**
166   * prints $output template var
167   */
168  function p()
169    {
170      echo $this->output;
171    }
172 
173  /**
174   * Inserts the uncompiled code for $handle as the value of $varname in the
175   * root-level. This can be used to effectively include a template in the
176   * middle of another template.
177   *
178   * Note that all desired assignments to the variables in $handle should be
179   * done BEFORE calling this function.
180   */
181  function assign_var_from_handle($varname, $handle)
182    {
183      if (!$this->loadfile($handle))
184      {
185        die("Template->assign_var_from_handle(): Couldn't load template file for handle $handle");
186      }
187     
188      // Compile it, with the "no echo statements" option on.
189      $_str = "";
190      $code = $this->compile($this->uncompiled_code[$handle], true, '_str');
191     
192      // evaluate the variable assignment.
193      eval($code);
194      // assign the value of the generated variable to the given varname.
195      $this->assign_var($varname, $_str);
196     
197      return true;
198    }
199 
200  /**
201   * Block-level variable assignment. Adds a new block iteration with the
202   * given variable assignments. Note that this should only be called once
203   * per block iteration.
204   */
205  function assign_block_vars($blockname, $vararray)
206    {
207      if (strstr($blockname, '.'))
208      {
209        // Nested block.
210        $blocks = explode('.', $blockname);
211        $blockcount = sizeof($blocks) - 1;
212        $str = '$this->_tpldata';
213        for ($i = 0; $i < $blockcount; $i++)
214        {
215          $str .= '[\'' . $blocks[$i] . '.\']';
216          eval('$lastiteration = sizeof(' . $str . ') - 1;');
217          $str .= '[' . $lastiteration . ']';
218        }
219        // Now we add the block that we're actually assigning to.
220        // We're adding a new iteration to this block with the given
221        // variable assignments.
222        $str .= '[\'' . $blocks[$blockcount] . '.\'][] = $vararray;';
223       
224        // Now we evaluate this assignment we've built up.
225        eval($str);
226      }
227      else
228      {
229        // Top-level block. Add a new iteration to this block with the
230        // variable assignments we were given.
231        $this->_tpldata[$blockname . '.'][] = $vararray;
232      }
233     
234      return true;
235    }
236 
237  /**
238   * Root-level variable assignment. Adds to current assignments, overriding
239   * any existing variable assignment with the same name.
240   */
241  function assign_vars($vararray)
242    {
243      reset ($vararray);
244      while (list($key, $val) = each($vararray))
245      {
246        $this->_tpldata['.'][0][$key] = $val;
247      }
248     
249      return true;
250    }
251 
252  /**
253   * Root-level variable assignment. Adds to current assignments, overriding
254   * any existing variable assignment with the same name.
255   */
256  function assign_var($varname, $varval)
257    {
258      $this->_tpldata['.'][0][$varname] = $varval;
259     
260      return true;
261    }
262 
263 
264  /**
265   * Generates a full path+filename for the given filename, which can either
266   * be an absolute name, or a name relative to the rootdir for this
267   * Template object.
268   */
269  function make_filename($filename)
270    {
271      // Check if it's an absolute or relative path.
272      // if (substr($filename, 0, 1) != '/')
273      if (preg_match('/^[a-z_]/i', $filename))
274      {
275        $filename = $this->root.'/'.$filename;
276      }
277     
278      if (!file_exists($filename))
279      {
280        die("Template->make_filename(): Error - file $filename does not exist");
281      }
282
283      return $filename;
284    }
285 
286 
287  /**
288   * If not already done, load the file for the given handle and populate
289   * the uncompiled_code[] hash with its code. Do not compile.
290   */
291  function loadfile($handle)
292    {
293      // If the file for this handle is already loaded and compiled, do
294      // nothing.
295      if (isset($this->uncompiled_code[$handle])
296          and !empty($this->uncompiled_code[$handle]))
297      {
298        return true;
299      }
300     
301      // If we don't have a file assigned to this handle, die.
302      if (!isset($this->files[$handle]))
303      {
304        die("Template->loadfile(): No file specified for handle $handle");
305      }
306     
307      $filename = $this->files[$handle];
308     
309      $str = implode("", @file($filename));
310      if (empty($str))
311      {
312        die("Template->loadfile(): File $filename for handle $handle is empty");
313      }
314     
315      $this->uncompiled_code[$handle] = $str;
316     
317      return true;
318    }
319 
320 
321 
322  /**
323   * Compiles the given string of code, and returns the result in a string.
324   *
325   * If "do_not_echo" is true, the returned code will not be directly
326   * executable, but can be used as part of a variable assignment for use in
327   * assign_code_from_handle().
328   */
329  function compile($code, $do_not_echo = false, $retvar = '')
330    {
331      // PWG specific : communication between template and $lang
332      $code = preg_replace('/\{lang:([^}]+)\}/e', "l10n('$1')", $code);
333           
334      // replace \ with \\ and then ' with \'.
335      $code = str_replace('\\', '\\\\', $code);
336      $code = str_replace('\'', '\\\'', $code);
337     
338      // change template varrefs into PHP varrefs
339     
340      // This one will handle varrefs WITH namespaces
341      $varrefs = array();
342      preg_match_all('#\{(([a-z0-9\-_]+?\.)+?)([a-z0-9\-_]+?)\}#is', $code, $varrefs);
343      $varcount = sizeof($varrefs[1]);
344      for ($i = 0; $i < $varcount; $i++)
345      {
346        $namespace = $varrefs[1][$i];
347        $varname = $varrefs[3][$i];
348        $new = $this->generate_block_varref($namespace, $varname);
349       
350        $code = str_replace($varrefs[0][$i], $new, $code);
351      }
352     
353      // This will handle the remaining root-level varrefs
354      $code = preg_replace('#\{([a-z0-9\-_]*?)\}#is', '\' . ( ( isset($this->_tpldata[\'.\'][0][\'\1\']) ) ? $this->_tpldata[\'.\'][0][\'\1\'] : \'\' ) . \'', $code);
355     
356      // Break it up into lines.
357      $code_lines = explode("\n", $code);
358     
359      $block_nesting_level = 0;
360      $block_names = array();
361      $block_names[0] = ".";
362     
363      // Second: prepend echo ', append ' . "\n"; to each line.
364      $line_count = sizeof($code_lines);
365      for ($i = 0; $i < $line_count; $i++)
366      {
367        $code_lines[$i] = chop($code_lines[$i]);
368        if (preg_match('#<!-- BEGIN (.*?) -->#', $code_lines[$i], $m))
369        {
370          $n[0] = $m[0];
371          $n[1] = $m[1];
372         
373          // Added: dougk_ff7-Keeps templates from bombing if begin is on
374          // the same line as end.. I think. :)
375          if ( preg_match('#<!-- END (.*?) -->#', $code_lines[$i], $n) )
376          {
377            $block_nesting_level++;
378            $block_names[$block_nesting_level] = $m[1];
379            if ($block_nesting_level < 2)
380            {
381              // Block is not nested.
382              $code_lines[$i] = '$_' . $n[1] . '_count = ( isset($this->_tpldata[\'' . $n[1] . '.\']) ) ?  sizeof($this->_tpldata[\'' . $n[1] . '.\']) : 0;';
383              $code_lines[$i] .= "\n" . 'for ($_' . $n[1] . '_i = 0; $_' . $n[1] . '_i < $_' . $n[1] . '_count; $_' . $n[1] . '_i++)';
384              $code_lines[$i] .= "\n" . '{';
385            }
386            else
387            {
388              // This block is nested.
389             
390              // Generate a namespace string for this block.
391              $namespace = implode('.', $block_names);
392              // strip leading period from root level..
393              $namespace = substr($namespace, 2);
394              // Get a reference to the data array for this block that depends on the
395              // current indices of all parent blocks.
396              $varref = $this->generate_block_data_ref($namespace, false);
397              // Create the for loop code to iterate over this block.
398              $code_lines[$i] = '$_' . $n[1] . '_count = ( isset(' . $varref . ') ) ? sizeof(' . $varref . ') : 0;';
399              $code_lines[$i] .= "\n" . 'for ($_' . $n[1] . '_i = 0; $_' . $n[1] . '_i < $_' . $n[1] . '_count; $_' . $n[1] . '_i++)';
400              $code_lines[$i] .= "\n" . '{';
401            }
402           
403            // We have the end of a block.
404            unset($block_names[$block_nesting_level]);
405            $block_nesting_level--;
406            $code_lines[$i] .= '} // END ' . $n[1];
407            $m[0] = $n[0];
408            $m[1] = $n[1];
409          }
410          else
411          {
412            // We have the start of a block.
413            $block_nesting_level++;
414            $block_names[$block_nesting_level] = $m[1];
415            if ($block_nesting_level < 2)
416            {
417              // Block is not nested.
418              $code_lines[$i] = '$_' . $m[1] . '_count = ( isset($this->_tpldata[\'' . $m[1] . '.\']) ) ? sizeof($this->_tpldata[\'' . $m[1] . '.\']) : 0;';
419              $code_lines[$i] .= "\n" . 'for ($_' . $m[1] . '_i = 0; $_' . $m[1] . '_i < $_' . $m[1] . '_count; $_' . $m[1] . '_i++)';
420              $code_lines[$i] .= "\n" . '{';
421            }
422            else
423            {
424              // This block is nested.
425             
426              // Generate a namespace string for this block.
427              $namespace = implode('.', $block_names);
428              // strip leading period from root level..
429              $namespace = substr($namespace, 2);
430              // Get a reference to the data array for this block that
431              // depends on the current indices of all parent blocks.
432              $varref = $this->generate_block_data_ref($namespace, false);
433              // Create the for loop code to iterate over this block.
434              $code_lines[$i] = '$_' . $m[1] . '_count = ( isset(' . $varref . ') ) ? sizeof(' . $varref . ') : 0;';
435              $code_lines[$i] .= "\n" . 'for ($_' . $m[1] . '_i = 0; $_' . $m[1] . '_i < $_' . $m[1] . '_count; $_' . $m[1] . '_i++)';
436              $code_lines[$i] .= "\n" . '{';
437            }
438          }
439        }
440        else if (preg_match('#<!-- END (.*?) -->#', $code_lines[$i], $m))
441        {
442          // We have the end of a block.
443          unset($block_names[$block_nesting_level]);
444          $block_nesting_level--;
445          $code_lines[$i] = '} // END ' . $m[1];
446        }
447        else
448        {
449          // We have an ordinary line of code.
450          if (!$do_not_echo)
451          {
452            $code_lines[$i] = 'echo \'' . $code_lines[$i] . '\' . "\\n";';
453          }
454          else
455          {
456            $code_lines[$i] = '$' . $retvar . '.= \'' . $code_lines[$i] . '\' . "\\n";'; 
457          }
458        }
459      }
460     
461      // Bring it back into a single string of lines of code.
462      $code = implode("\n", $code_lines);
463      return $code      ;
464     
465    }
466 
467 
468  /**
469   * Generates a reference to the given variable inside the given (possibly
470   * nested) block namespace. This is a string of the form: '
471   * . $this->_tpldata['parent'][$_parent_i]['$child1'][$_child1_i]['$child2'][$_child2_i]...['varname']
472   * . ' It's ready to be inserted into an "echo" line in one of the
473   * templates.  NOTE: expects a trailing "." on the namespace.
474   */
475  function generate_block_varref($namespace, $varname)
476    {
477      // Strip the trailing period.
478      $namespace = substr($namespace, 0, strlen($namespace) - 1);
479     
480      // Get a reference to the data block for this namespace.
481      $varref = $this->generate_block_data_ref($namespace, true);
482      // Prepend the necessary code to stick this in an echo line.
483     
484      // Append the variable reference.
485      $varref .= '[\'' . $varname . '\']';
486     
487      $varref = '\' . ( ( isset(' . $varref . ') ) ? ' . $varref . ' : \'\' ) . \'';
488     
489      return $varref;
490     
491    }
492 
493 
494  /**
495   * Generates a reference to the array of data values for the given
496   * (possibly nested) block namespace. This is a string of the form:
497   * $this->_tpldata['parent'][$_parent_i]['$child1'][$_child1_i]['$child2'][$_child2_i]...['$childN']
498   *
499   * If $include_last_iterator is true, then [$_childN_i] will be appended
500   * to the form shown above.  NOTE: does not expect a trailing "." on the
501   * blockname.
502   */
503  function generate_block_data_ref($blockname, $include_last_iterator)
504    {
505      // Get an array of the blocks involved.
506      $blocks = explode(".", $blockname);
507      $blockcount = sizeof($blocks) - 1;
508      $varref = '$this->_tpldata';
509      // Build up the string with everything but the last child.
510      for ($i = 0; $i < $blockcount; $i++)
511      {
512        $varref .= '[\'' . $blocks[$i] . '.\'][$_' . $blocks[$i] . '_i]';
513      }
514      // Add the block reference for the last child.
515      $varref .= '[\'' . $blocks[$blockcount] . '.\']';
516      // Add the iterator for the last child if requried.
517      if ($include_last_iterator)
518      {
519              $varref .= '[$_' . $blocks[$blockcount] . '_i]';
520      }
521     
522      return $varref;
523    }
524 
525}
526
527?>
Note: See TracBrowser for help on using the repository browser.