source: trunk/include/template.php @ 2218

Last change on this file since 2218 was 2216, checked in by rvelices, 16 years ago
  • first smarty use ... (in admin.php and admin plugins page)
  • Property svn:eol-style set to LF
  • Property svn:keywords set to Author Date Id Revision
File size: 21.1 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 2216 2008-02-27 02:31:51Z rvelices $
9// | last update   : $Date: 2008-02-27 02:31:51 +0000 (Wed, 27 Feb 2008) $
10// | last modifier : $Author: rvelices $
11// | revision      : $Revision: 2216 $
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 TemplateOld {
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 TemplateOld($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   * Block-level variable deletion. Deletes the last block iteration.
300   * if all is true - all blocks are removed
301   * return true if a deletion occured
302   */
303  function delete_block_vars($blockname, $all=false)
304    {
305      $blocks = explode('.', $blockname);
306      $blockcount = count($blocks);
307      $str = '$this->_tpldata';
308      for ($i = 0; $i < $blockcount; $i++)
309      {
310        $str .= '[\'' . $blocks[$i] . '.\']';
311        eval('$lastiteration = isset('.$str.') ? sizeof('.$str.')-1:-1;');
312        if ($lastiteration==-1)
313        {
314          return false;
315        }
316        if ($i==$blockcount-1)
317        {
318          break;
319        }
320        $str .= '[' . $lastiteration . ']';
321      }
322
323      if ($all==true or $lastiteration==0)
324      {
325        $str ='unset('.$str.');';
326      }
327      else
328      {
329        $str ='unset('.$str.'['.$lastiteration.']);';
330      }
331      eval($str);
332      return true;
333    }
334
335  /**
336   * Root-level variable assignment. Adds to current assignments, overriding
337   * any existing variable assignment with the same name.
338   */
339  function assign_vars($vararray)
340    {
341      reset ($vararray);
342      while (list($key, $val) = each($vararray))
343      {
344        $this->_tpldata['.'][0][$key] = $val;
345      }
346
347      return true;
348    }
349
350  /**
351   * Root-level variable assignment. Adds to current assignments, overriding
352   * any existing variable assignment with the same name.
353   */
354  function assign_var($varname, $varval)
355    {
356      $this->_tpldata['.'][0][$varname] = $varval;
357      return true;
358    }
359
360  /**
361   * Root-level variable concatenation. Appends a  string to an existing
362   * variable assignment with the same name.
363   */
364  function concat_var($varname, $varval)
365    {
366      if ( isset($this->_tpldata['.'][0][$varname]) )
367      {
368        $this->_tpldata['.'][0][$varname] .= $varval;
369      }
370      else
371      {
372        $this->_tpldata['.'][0][$varname] = $varval;
373      }
374      return true;
375    }
376
377  /**
378   * Returns a root-level variable value
379   */
380  function get_var($varname, $default=null)
381    {
382      if ( isset($this->_tpldata['.'][0][$varname]) )
383      {
384        return $this->_tpldata['.'][0][$varname];
385      }
386      return $default;
387    }
388
389  /**
390   * Generates a full path+filename for the given filename, which can either
391   * be an absolute name, or a name relative to the rootdir for this
392   * Template object.
393   */
394  function make_filename($filename)
395    {
396      // Check if it's an absolute or relative path.
397      // if (substr($filename, 0, 1) != '/')
398      if (preg_match('/^[a-z_][^:]/i', $filename) )
399      {
400        $filename = $this->root.'/'.$filename;
401      }
402
403      if (!file_exists($filename))
404      {
405        die("Template->make_filename(): Error - file $filename does not exist");
406      }
407
408      return $filename;
409    }
410
411
412  /**
413   * If not already done, load the file for the given handle and populate
414   * the uncompiled_code[] hash with its code. Do not compile.
415   */
416  function loadfile($handle)
417    {
418      // If the file for this handle is already loaded and compiled, do
419      // nothing.
420      if (isset($this->uncompiled_code[$handle])
421          and !empty($this->uncompiled_code[$handle]))
422      {
423        return true;
424      }
425
426      // If we don't have a file assigned to this handle, die.
427      if (!isset($this->files[$handle]))
428      {
429        die("Template->loadfile(): No file specified for handle $handle");
430      }
431
432      $filename = $this->files[$handle];
433
434      $str = implode("", @file($filename));
435
436      if (empty($str))
437      {
438        die("Template->loadfile(): File $filename for handle $handle is empty");
439      }
440
441      $this->uncompiled_code[$handle] = trigger_event('tpl_load_file', $str, $handle, array(&$this));
442
443      return true;
444    }
445
446
447
448  /**
449   * Compiles the given string of code, and returns the result in a string.
450   *
451   * If "do_not_echo" is true, the returned code will not be directly
452   * executable, but can be used as part of a variable assignment for use in
453   * assign_code_from_handle().
454   */
455  function compile($code, $do_not_echo = false, $retvar = '')
456    {
457      // PWG specific : communication between template and $lang
458      $code = preg_replace('/\{lang:([^}]+)\}/e', "l10n('$1')", $code);
459      // PWG specific : expand themeconf.inc.php variables
460      $code = preg_replace('/\{themeconf:([^}]+)\}/e', '$this->get_themeconf(\'$1\')', $code);
461      $code = preg_replace('/\{pwg_root\}/e', "get_root_url()", $code);
462
463      // replace \ with \\ and then ' with \'.
464      $code = str_replace('\\', '\\\\', $code);
465      $code = str_replace('\'', '\\\'', $code);
466
467      // change template varrefs into PHP varrefs
468
469      // This one will handle varrefs WITH namespaces
470      $varrefs = array();
471      preg_match_all('#\{(([a-z0-9\-_]+?\.)+?)([a-z0-9\-_]+?)\}#is', $code, $varrefs);
472      $varcount = sizeof($varrefs[1]);
473      for ($i = 0; $i < $varcount; $i++)
474      {
475        $namespace = $varrefs[1][$i];
476        $varname = $varrefs[3][$i];
477        $new = $this->generate_block_varref($namespace, $varname);
478
479        $code = str_replace($varrefs[0][$i], $new, $code);
480      }
481
482      // This will handle the remaining root-level varrefs
483      $code = preg_replace('#\{([a-z0-9\-_]*?)\}#is', '\' . ( ( isset($this->_tpldata[\'.\'][0][\'\1\']) ) ? $this->_tpldata[\'.\'][0][\'\1\'] : \'\' ) . \'', $code);
484
485      // Break it up into lines.
486      $code_lines = explode("\n", $code);
487
488      $block_nesting_level = 0;
489      $block_names = array();
490      $block_names[0] = ".";
491
492      // Second: prepend echo ', append ' . "\n"; to each line.
493      $line_count = sizeof($code_lines);
494      for ($i = 0; $i < $line_count; $i++)
495      {
496        $code_lines[$i] = chop($code_lines[$i]);
497        if (preg_match('#<!-- BEGIN (.*?) -->#', $code_lines[$i], $m))
498        {
499          $n[0] = $m[0];
500          $n[1] = $m[1];
501
502          // Added: dougk_ff7-Keeps templates from bombing if begin is on
503          // the same line as end.. I think. :)
504          if ( preg_match('#<!-- END (.*?) -->#', $code_lines[$i], $n) )
505          {
506            $block_nesting_level++;
507            $block_names[$block_nesting_level] = $m[1];
508            if ($block_nesting_level < 2)
509            {
510              // Block is not nested.
511              $code_lines[$i] = '$_' . $n[1] . '_count = ( isset($this->_tpldata[\'' . $n[1] . '.\']) ) ?  sizeof($this->_tpldata[\'' . $n[1] . '.\']) : 0;';
512              $code_lines[$i] .= "\n" . 'for ($_' . $n[1] . '_i = 0; $_' . $n[1] . '_i < $_' . $n[1] . '_count; $_' . $n[1] . '_i++)';
513              $code_lines[$i] .= "\n" . '{';
514            }
515            else
516            {
517              // This block is nested.
518
519              // Generate a namespace string for this block.
520              $namespace = implode('.', $block_names);
521              // strip leading period from root level..
522              $namespace = substr($namespace, 2);
523              // Get a reference to the data array for this block that depends on the
524              // current indices of all parent blocks.
525              $varref = $this->generate_block_data_ref($namespace, false);
526              // Create the for loop code to iterate over this block.
527              $code_lines[$i] = '$_' . $n[1] . '_count = ( isset(' . $varref . ') ) ? sizeof(' . $varref . ') : 0;';
528              $code_lines[$i] .= "\n" . 'for ($_' . $n[1] . '_i = 0; $_' . $n[1] . '_i < $_' . $n[1] . '_count; $_' . $n[1] . '_i++)';
529              $code_lines[$i] .= "\n" . '{';
530            }
531
532            // We have the end of a block.
533            unset($block_names[$block_nesting_level]);
534            $block_nesting_level--;
535            $code_lines[$i] .= '} // END ' . $n[1];
536            $m[0] = $n[0];
537            $m[1] = $n[1];
538          }
539          else
540          {
541            // We have the start of a block.
542            $block_nesting_level++;
543            $block_names[$block_nesting_level] = $m[1];
544            if ($block_nesting_level < 2)
545            {
546              // Block is not nested.
547              $code_lines[$i] = '$_' . $m[1] . '_count = ( isset($this->_tpldata[\'' . $m[1] . '.\']) ) ? sizeof($this->_tpldata[\'' . $m[1] . '.\']) : 0;';
548              $code_lines[$i] .= "\n" . 'for ($_' . $m[1] . '_i = 0; $_' . $m[1] . '_i < $_' . $m[1] . '_count; $_' . $m[1] . '_i++)';
549              $code_lines[$i] .= "\n" . '{';
550            }
551            else
552            {
553              // This block is nested.
554
555              // Generate a namespace string for this block.
556              $namespace = implode('.', $block_names);
557              // strip leading period from root level..
558              $namespace = substr($namespace, 2);
559              // Get a reference to the data array for this block that
560              // depends on the current indices of all parent blocks.
561              $varref = $this->generate_block_data_ref($namespace, false);
562              // Create the for loop code to iterate over this block.
563              $code_lines[$i] = '$_' . $m[1] . '_count = ( isset(' . $varref . ') ) ? sizeof(' . $varref . ') : 0;';
564              $code_lines[$i] .= "\n" . 'for ($_' . $m[1] . '_i = 0; $_' . $m[1] . '_i < $_' . $m[1] . '_count; $_' . $m[1] . '_i++)';
565              $code_lines[$i] .= "\n" . '{';
566            }
567          }
568        }
569        else if (preg_match('#<!-- END (.*?) -->#', $code_lines[$i], $m))
570        {
571          // We have the end of a block.
572          unset($block_names[$block_nesting_level]);
573          $block_nesting_level--;
574          $code_lines[$i] = '} // END ' . $m[1];
575        }
576        else
577        {
578          // We have an ordinary line of code.
579          if (!$do_not_echo)
580          {
581            $code_lines[$i] = 'echo \'' . $code_lines[$i] . '\' . "\\n";';
582          }
583          else
584          {
585            $code_lines[$i] = '$' . $retvar . '.= \'' . $code_lines[$i] . '\' . "\\n";';
586          }
587        }
588      }
589
590      // Bring it back into a single string of lines of code.
591      $code = implode("\n", $code_lines);
592      return $code      ;
593
594    }
595
596
597  /**
598   * Generates a reference to the given variable inside the given (possibly
599   * nested) block namespace. This is a string of the form: '
600   * . $this->_tpldata['parent'][$_parent_i]['$child1'][$_child1_i]['$child2'][$_child2_i]...['varname']
601   * . ' It's ready to be inserted into an "echo" line in one of the
602   * templates.  NOTE: expects a trailing "." on the namespace.
603   */
604  function generate_block_varref($namespace, $varname)
605    {
606      // Strip the trailing period.
607      $namespace = substr($namespace, 0, strlen($namespace) - 1);
608
609      // Get a reference to the data block for this namespace.
610      $varref = $this->generate_block_data_ref($namespace, true);
611      // Prepend the necessary code to stick this in an echo line.
612
613      // Append the variable reference.
614      $varref .= '[\'' . $varname . '\']';
615
616      $varref = '\' . ( ( isset(' . $varref . ') ) ? ' . $varref . ' : \'\' ) . \'';
617
618      return $varref;
619
620    }
621
622
623  /**
624   * Generates a reference to the array of data values for the given
625   * (possibly nested) block namespace. This is a string of the form:
626   * $this->_tpldata['parent'][$_parent_i]['$child1'][$_child1_i]['$child2'][$_child2_i]...['$childN']
627   *
628   * If $include_last_iterator is true, then [$_childN_i] will be appended
629   * to the form shown above.  NOTE: does not expect a trailing "." on the
630   * blockname.
631   */
632  function generate_block_data_ref($blockname, $include_last_iterator)
633    {
634      // Get an array of the blocks involved.
635      $blocks = explode(".", $blockname);
636      $blockcount = sizeof($blocks) - 1;
637      $varref = '$this->_tpldata';
638      // Build up the string with everything but the last child.
639      for ($i = 0; $i < $blockcount; $i++)
640      {
641        $varref .= '[\'' . $blocks[$i] . '.\'][$_' . $blocks[$i] . '_i]';
642      }
643      // Add the block reference for the last child.
644      $varref .= '[\'' . $blocks[$blockcount] . '.\']';
645      // Add the iterator for the last child if requried.
646      if ($include_last_iterator)
647      {
648              $varref .= '[$_' . $blocks[$blockcount] . '_i]';
649      }
650
651      return $varref;
652    }
653
654    function get_themeconf($key)
655    {
656      return isset($this->themeconf[$key]) ? $this->themeconf[$key] : '';
657    }
658}
659
660include_once(PHPWG_ROOT_PATH.'include/template.class.php');
661?>
Note: See TracBrowser for help on using the repository browser.