source: trunk/include/template.class.php @ 3927

Revision 3927, 15.5 KB checked in by mathiasm, 10 years ago (diff)

Add Smarty's prefilter capability. see topic:16219 (FR).

  • Property svn:eol-style set to LF
Line 
1<?php
2// +-----------------------------------------------------------------------+
3// | Piwigo - a PHP based picture gallery                                  |
4// +-----------------------------------------------------------------------+
5// | Copyright(C) 2008-2009 Piwigo Team                  http://piwigo.org |
6// | Copyright(C) 2003-2008 PhpWebGallery Team    http://phpwebgallery.net |
7// | Copyright(C) 2002-2003 Pierrick LE GALL   http://le-gall.net/pierrick |
8// +-----------------------------------------------------------------------+
9// | This program is free software; you can redistribute it and/or modify  |
10// | it under the terms of the GNU General Public License as published by  |
11// | the Free Software Foundation                                          |
12// |                                                                       |
13// | This program is distributed in the hope that it will be useful, but   |
14// | WITHOUT ANY WARRANTY; without even the implied warranty of            |
15// | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU      |
16// | General Public License for more details.                              |
17// |                                                                       |
18// | You should have received a copy of the GNU General Public License     |
19// | along with this program; if not, write to the Free Software           |
20// | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, |
21// | USA.                                                                  |
22// +-----------------------------------------------------------------------+
23
24
25require_once(PHPWG_ROOT_PATH.'include/smarty/libs/Smarty.class.php');
26
27// migrate lang:XXX
28//    sed "s/{lang:\([^}]\+\)}/{\'\1\'|@translate}/g" my_template.tpl
29// migrate change root level vars {XXX}
30//    sed "s/{pwg_root}/{ROOT_URL}/g" my_template.tpl
31// migrate change root level vars {XXX}
32//    sed "s/{\([a-zA-Z_]\+\)}/{$\1}/g" my_template.tpl
33// migrate all
34//    cat my_template.tpl | sed "s/{lang:\([^}]\+\)}/{\'\1\'|@translate}/g" | sed "s/{pwg_root}/{ROOT_URL}/g" | sed "s/{\([a-zA-Z_]\+\)}/{$\1}/g"
35
36
37class Template {
38
39  var $smarty;
40
41  var $output = '';
42
43  // Hash of filenames for each template handle.
44  var $files = array();
45
46  // Template extents filenames for each template handle.
47  var $extents = array();
48
49  // Templates prefilter from external sources (plugins)
50  var $external_filters = array();
51 
52  // used by html_head smarty block to add content before </head>
53  var $html_head_elements = array();
54
55  function Template($root = ".", $theme= "")
56  {
57    global $conf, $lang_info;
58
59    $this->smarty = new Smarty;
60    $this->smarty->debugging = $conf['debug_template'];
61    $this->smarty->compile_check=$conf['template_compile_check'];
62
63    $compile_dir = $conf['local_data_dir'].'/templates_c';
64    mkgetdir( $compile_dir );
65
66    $this->smarty->compile_dir = $compile_dir;
67
68    $this->smarty->assign_by_ref( 'pwg', new PwgTemplateAdapter() );
69    $this->smarty->register_modifier( 'translate', array('Template', 'mod_translate') );
70    $this->smarty->register_modifier( 'explode', array('Template', 'mod_explode') );
71    $this->smarty->register_modifier( 'get_extent', array(&$this, 'get_extent') );
72    $this->smarty->register_block('html_head', array(&$this, 'block_html_head') );
73    $this->smarty->register_function('known_script', array(&$this, 'func_known_script') );
74    $this->smarty->register_prefilter( array('Template', 'prefilter_white_space') );
75    if ( $conf['compiled_template_cache_language'] )
76    {
77      $this->smarty->register_prefilter( array('Template', 'prefilter_language') );
78    }
79
80    if ( !empty($theme) )
81    {
82      include($root.'/theme/'.$theme.'/themeconf.inc.php');
83      $this->smarty->assign('themeconf', $themeconf);
84    }
85
86    $this->smarty->assign('lang_info', $lang_info);
87
88    $this->set_template_dir($root);
89
90    if (!defined('IN_ADMIN') and isset($conf['extents_for_templates']))
91    {
92      $tpl_extents = unserialize($conf['extents_for_templates']);
93      $this->set_extents($tpl_extents, './template-extension/', true);
94    }
95  }
96
97  /**
98   * Sets the template root directory for this Template object.
99   */
100  function set_template_dir($dir)
101  {
102    $this->smarty->template_dir = $dir;
103
104    $real_dir = realpath($dir);
105    $compile_id = crc32( $real_dir===false ? $dir : $real_dir);
106    $this->smarty->compile_id = base_convert($compile_id, 10, 36 );
107  }
108
109  /**
110   * Gets the template root directory for this Template object.
111   */
112  function get_template_dir()
113  {
114    return $this->smarty->template_dir;
115  }
116
117  /**
118   * Deletes all compiled templates.
119   */
120  function delete_compiled_templates()
121  {
122      $save_compile_id = $this->smarty->compile_id;
123      $this->smarty->compile_id = null;
124      $this->smarty->clear_compiled_tpl();
125      $this->smarty->compile_id = $save_compile_id;
126      file_put_contents($this->smarty->compile_dir.'/index.htm', 'Not allowed!');
127  }
128
129  function get_themeconf($val)
130  {
131    $tc = $this->smarty->get_template_vars('themeconf');
132    return isset($tc[$val]) ? $tc[$val] : '';
133  }
134
135  /**
136   * Sets the template filename for handle.
137   */
138  function set_filename($handle, $filename)
139  {
140    return $this->set_filenames( array($handle=>$filename) );
141  }
142
143  /**
144   * Sets the template filenames for handles. $filename_array should be a
145   * hash of handle => filename pairs.
146   */
147  function set_filenames($filename_array)
148  {
149    if (!is_array($filename_array))
150    {
151      return false;
152    }
153    reset($filename_array);
154    while(list($handle, $filename) = each($filename_array))
155    {
156      if (is_null($filename))
157      {
158        unset($this->files[$handle]);
159      }
160      else
161      {
162        $this->files[$handle] = $this->get_extent($filename, $handle);
163      }
164    }
165    return true;
166  }
167
168  /**
169   * Sets template extention filename for handles.
170   */
171  function set_extent($filename, $param, $dir='', $overwrite=true)
172  {
173    return $this->set_extents(array($filename => $param), $dir, $overwrite);
174  }
175
176  /**
177   * Sets template extentions filenames for handles.
178   * $filename_array should be an hash of filename => array( handle, param) or filename => handle
179   */
180  function set_extents($filename_array, $dir='', $overwrite=true)
181  {
182    if (!is_array($filename_array))
183    {
184      return false;
185    }
186    foreach ($filename_array as $filename => $value)
187    {
188      if (is_array($value))
189      {
190        $handle = $value[0];
191        $param = $value[1];
192        $tpl = $value[2];
193      }
194      elseif (is_string($value))
195      {
196        $handle = $value;
197        $param = 'N/A';
198        $tpl = 'N/A';
199      }
200      else
201      {
202        return false;
203      }
204
205      if ((stripos(implode('',array_keys($_GET)), '/'.$param) !== false or $param == 'N/A')
206        and (preg_match('/'.preg_quote($tpl,'/').'$/', $this->get_template_dir()) or $tpl == 'N/A')
207        and (!isset($this->extents[$handle]) or $overwrite)
208        and file_exists($dir . $filename))
209      {
210        $this->extents[$handle] = realpath($dir . $filename);
211      }
212    }
213    return true;
214  }
215
216  /** return template extension if exists  */
217  function get_extent($filename='', $handle='')
218  {
219    if (isset($this->extents[$handle]))
220    {
221      $filename = $this->extents[$handle];
222    }
223    return $filename;
224  }
225
226  /** see smarty assign http://www.smarty.net/manual/en/api.assign.php */
227  function assign($tpl_var, $value = null)
228  {
229    $this->smarty->assign( $tpl_var, $value );
230  }
231
232  /**
233   * Inserts the uncompiled code for $handle as the value of $varname in the
234   * root-level. This can be used to effectively include a template in the
235   * middle of another template.
236   * This is equivalent to assign($varname, $this->parse($handle, true))
237   */
238  function assign_var_from_handle($varname, $handle)
239  {
240    $this->assign($varname, $this->parse($handle, true));
241    return true;
242  }
243
244  /** see smarty append http://www.smarty.net/manual/en/api.append.php */
245  function append($tpl_var, $value=null, $merge=false)
246  {
247    $this->smarty->append( $tpl_var, $value, $merge );
248  }
249
250  /**
251   * Root-level variable concatenation. Appends a  string to an existing
252   * variable assignment with the same name.
253   */
254  function concat($tpl_var, $value)
255  {
256    $old_val = & $this->smarty->get_template_vars($tpl_var);
257    if ( isset($old_val) )
258    {
259      $old_val .= $value;
260    }
261    else
262    {
263      $this->assign($tpl_var, $value);
264    }
265  }
266
267  /** see smarty append http://www.smarty.net/manual/en/api.clear_assign.php */
268  function clear_assign($tpl_var)
269  {
270    $this->smarty->clear_assign( $tpl_var );
271  }
272
273  /** see smarty get_template_vars http://www.smarty.net/manual/en/api.get_template_vars.php */
274  function &get_template_vars($name=null)
275  {
276    return $this->smarty->get_template_vars( $name );
277  }
278
279
280  /**
281   * Load the file for the handle, eventually compile the file and run the compiled
282   * code. This will add the output to the results or return the result if $return
283   * is true.
284   */
285  function parse($handle, $return=false)
286  {
287    if ( !isset($this->files[$handle]) )
288    {
289      fatal_error("Template->parse(): Couldn't load template file for handle $handle");
290    }
291
292    $this->smarty->assign( 'ROOT_URL', get_root_url() );
293    $this->smarty->assign( 'TAG_INPUT_ENABLED',
294      ((is_adviser()) ? 'disabled="disabled" onclick="return false;"' : ''));
295
296    $this->load_external_filters();
297
298    global $conf, $lang_info;
299    if ( $conf['compiled_template_cache_language'] and isset($lang_info['code']) )
300    {
301      $save_compile_id = $this->smarty->compile_id;
302      $this->smarty->compile_id .= '.'.$lang_info['code'];
303    }
304
305    $v = $this->smarty->fetch($this->files[$handle], null, null, false);
306
307    if (isset ($save_compile_id) )
308    {
309      $this->smarty->compile_id = $save_compile_id;
310    }
311
312    if ($return)
313    {
314      return $v;
315    }
316    $this->output .= $v;
317  }
318
319  /**
320   * Load the file for the handle, eventually compile the file and run the compiled
321   * code. This will print out the results of executing the template.
322   */
323  function pparse($handle)
324  {
325    $this->parse($handle, false);
326    $this->flush();
327  }
328
329  function flush()
330  {
331    if ( count($this->html_head_elements) )
332    {
333      $search = "\n</head>";
334      $pos = strpos( $this->output, $search );
335      if ($pos !== false)
336      {
337        $this->output = substr_replace( $this->output, "\n".implode( "\n", $this->html_head_elements ), $pos, 0 );
338      } //else maybe error or warning ?
339      $this->html_head_elements = array();
340    }
341
342    echo $this->output;
343    $this->output='';
344  }
345
346  /** flushes the output */
347  function p()
348  {
349    $this->flush();
350
351    if ($this->smarty->debugging)
352    {
353      global $t2;
354      $this->smarty->assign(
355        array(
356        'AAAA_DEBUG_TOTAL_TIME__' => get_elapsed_time($t2, get_moment())
357        )
358        );
359      require_once(SMARTY_CORE_DIR . 'core.display_debug_console.php');
360      echo smarty_core_display_debug_console(null, $this->smarty);
361    }
362  }
363
364  /**
365   * translate variable modifier - translates a text to the currently loaded
366   * language
367   */
368  static function mod_translate($text)
369  {
370    return l10n($text);
371  }
372
373  /**
374   * explode variable modifier - similar to php explode
375   * 'Yes;No'|@explode:';' -> array('Yes', 'No')
376   */
377  static function mod_explode($text, $delimiter=',')
378  {
379    return explode($delimiter, $text);
380  }
381
382  /**
383   * This smarty "html_head" block allows to add content just before
384   * </head> element in the output after the head has been parsed. This is
385   * handy in order to respect strict standards when <style> and <link>
386   * html elements must appear in the <head> element
387   */
388  function block_html_head($params, $content, &$smarty, &$repeat)
389  {
390    $content = trim($content);
391    if ( !empty($content) )
392    { // second call
393      $this->html_head_elements[] = $content;
394    }
395  }
396
397 /**
398   * This smarty "known_script" functions allows to insert well known java scripts
399   * such as prototype, jquery, etc... only once. Examples:
400   * {known_script id="jquery" src="{$ROOT_URL}template-common/lib/jquery.packed.js"}
401   */
402  function func_known_script($params, &$smarty )
403  {
404    if (!isset($params['id']))
405    {
406        $smarty->trigger_error("known_script: missing 'id' parameter");
407        return;
408    }
409    $id = $params['id'];
410    if (! isset( $this->known_scripts[$id] ) )
411    {
412      if (!isset($params['src']))
413      {
414          $smarty->trigger_error("known_script: missing 'src' parameter");
415          return;
416      }
417      $this->known_scripts[$id] = $params['src'];
418      $content = '<script type="text/javascript" src="'.$params['src'].'"></script>';
419      if (isset($params['now']) and $params['now'] and empty($this->output) )
420      {
421        return $content;
422      }
423      $repeat = false;
424      $this->block_html_head(null, $content, $smarty, $repeat);
425    }
426  }
427
428 /**
429   * This function allows to declare a Smarty prefilter from a plugin, thus allowing
430   * it to modify template source before compilation and without changing core files
431   * They will be processed by weight ascending.
432   * http://www.smarty.net/manual/en/advanced.features.prefilters.php
433   */
434  function set_external_filter($weight, $callback) 
435  {
436 
437    if (! is_integer($weight)) return false;
438    $this->external_filters[$weight] = $callback;
439    return ksort($this->external_filters);
440  }
441 
442 /**
443   * This function actually triggers the filters on the tpl files.
444   * Called in the parse method.
445   * http://www.smarty.net/manual/en/advanced.features.prefilters.php
446   */
447  function load_external_filters() 
448  {
449    if (! isset($this->external_filters) || ! count($this->external_filters)) return; 
450    print_r($this->external_filters );
451    $test= array(1,2,3);
452    print_r($test);
453    foreach ($this->external_filters as $filter) 
454    {
455      $this->smarty->register_prefilter( $filter );     
456    }
457  }
458 
459  static function prefilter_white_space($source, &$smarty)
460  {
461    $ld = $smarty->left_delimiter;
462    $rd = $smarty->right_delimiter;
463    $ldq = preg_quote($ld, '#');
464    $rdq = preg_quote($rd, '#');
465
466    $regex = array();
467    $tags = array('if', 'foreach', 'section');
468    foreach($tags as $tag)
469    {
470      array_push($regex, "#^[ \t]+($ldq$tag"."[^$ld$rd]*$rdq)\s*$#m");
471      array_push($regex, "#^[ \t]+($ldq/$tag$rdq)\s*$#m");
472    }
473    $tags = array('include', 'else', 'html_head');
474    foreach($tags as $tag)
475    {
476      array_push($regex, "#^[ \t]+($ldq$tag"."[^$ld$rd]*$rdq)\s*$#m");
477    }
478    $source = preg_replace( $regex, "$1", $source);
479    return $source;
480  }
481
482  /**
483   * Smarty prefilter to allow caching (whenever possible) language strings
484   * from templates.
485   */
486  static function prefilter_language($source, &$smarty)
487  {
488    global $lang;
489    $ldq = preg_quote($smarty->left_delimiter, '~');
490    $rdq = preg_quote($smarty->right_delimiter, '~');
491
492    $regex = "~$ldq *\'([^'$]+)\'\|@translate *$rdq~";
493    $source = preg_replace( $regex.'e', 'isset($lang[\'$1\']) ? $lang[\'$1\'] : \'$0\'', $source);
494
495    $regex = "~$ldq *\'([^'$]+)\'\|@translate\|~";
496    $source = preg_replace( $regex.'e', 'isset($lang[\'$1\']) ? \'{\'.var_export($lang[\'$1\'],true).\'|\' : \'$0\'', $source);
497
498    $regex = "~($ldq *assign +var=.+ +value=)\'([^'$]+)\'\|@translate~e";
499    $source = preg_replace( $regex, 'isset($lang[\'$2\']) ? \'$1\'.var_export($lang[\'$2\'],true) : \'$0\'', $source);
500
501    return $source;
502  }
503}
504
505
506/**
507 * This class contains basic functions that can be called directly from the
508 * templates in the form $pwg->l10n('edit')
509 */
510class PwgTemplateAdapter
511{
512  function l10n($text)
513  {
514    return l10n($text);
515  }
516
517  function l10n_dec($s, $p, $v)
518  {
519    return l10n_dec($s, $p, $v);
520  }
521
522  function sprintf()
523  {
524    $args = func_get_args();
525    return call_user_func_array('sprintf',  $args );
526  }
527}
528
529?>
Note: See TracBrowser for help on using the repository browser.