source: branches/1.6/include/template.php @ 22506

Last change on this file since 22506 was 1572, checked in by rvelices, 18 years ago

merge -r1568 from trunk to branch-1_6 (auto_login/redirect corrections)

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