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

Last change on this file since 13021 was 13021, checked in by rvelices, 9 years ago

feature 2548 multisize - custom sizes restricted to those requested by theme/plugin
code refacto

  • Property svn:eol-style set to LF
File size: 41.1 KB
Line 
1<?php
2// +-----------------------------------------------------------------------+
3// | Piwigo - a PHP based photo gallery                                    |
4// +-----------------------------------------------------------------------+
5// | Copyright(C) 2008-2012 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
25class Template {
26
27  var $smarty;
28
29  var $output = '';
30
31  // Hash of filenames for each template handle.
32  var $files = array();
33
34  // Template extents filenames for each template handle.
35  var $extents = array();
36
37  // Templates prefilter from external sources (plugins)
38  var $external_filters = array();
39
40  // used by html_head smarty block to add content before </head>
41  var $html_head_elements = array();
42  private $html_style = '';
43
44  const COMBINED_SCRIPTS_TAG = '<!-- COMBINED_SCRIPTS -->';
45  var $scriptLoader;
46
47  const COMBINED_CSS_TAG = '<!-- COMBINED_CSS -->';
48  var $css_by_priority = array();
49
50  function Template($root = ".", $theme= "", $path = "template")
51  {
52    global $conf, $lang_info;
53
54    $this->scriptLoader = new ScriptLoader;
55    $this->smarty = new Smarty;
56    $this->smarty->debugging = $conf['debug_template'];
57    $this->smarty->compile_check = $conf['template_compile_check'];
58    $this->smarty->force_compile = $conf['template_force_compile'];
59
60    if (!isset($conf['data_dir_checked']))
61    {
62      $dir = PHPWG_ROOT_PATH.$conf['data_location'];
63      mkgetdir($dir, MKGETDIR_DEFAULT&~MKGETDIR_DIE_ON_ERROR);
64      if (!is_writable($dir))
65      {
66        load_language('admin.lang');
67        fatal_error(
68          sprintf(
69            l10n('Give write access (chmod 777) to "%s" directory at the root of your Piwigo installation'),
70            $conf['data_location']
71            ),
72          l10n('an error happened'),
73          false // show trace
74          );
75      }
76      if (function_exists('pwg_query')) {
77        conf_update_param('data_dir_checked', 1);
78      }
79    }
80
81    if (!isset($conf['combined_dir_checked']))
82    {
83      $dir = PHPWG_ROOT_PATH.PWG_COMBINED_DIR;
84      mkgetdir($dir, MKGETDIR_DEFAULT&~MKGETDIR_DIE_ON_ERROR);
85      if (!is_writable($dir))
86      {
87        load_language('admin.lang');
88        fatal_error(
89          sprintf(
90            l10n('Give write access (chmod 777) to "%s" directory at the root of your Piwigo installation'),
91            PWG_COMBINED_DIR
92            ),
93          l10n('an error happened'),
94          false // show trace
95          );
96      }
97      if (function_exists('pwg_query')) {
98        conf_update_param('combined_dir_checked', 1);
99      }
100    }
101
102
103    $compile_dir = PHPWG_ROOT_PATH.$conf['data_location'].'templates_c';
104    mkgetdir( $compile_dir );
105
106    $this->smarty->compile_dir = $compile_dir;
107
108    $this->smarty->assign_by_ref( 'pwg', new PwgTemplateAdapter() );
109    $this->smarty->register_modifier( 'translate', array('Template', 'mod_translate') );
110    $this->smarty->register_modifier( 'explode', array('Template', 'mod_explode') );
111    $this->smarty->register_modifier( 'get_extent', array(&$this, 'get_extent') );
112    $this->smarty->register_block('html_head', array(&$this, 'block_html_head') );
113    $this->smarty->register_block('html_style', array(&$this, 'block_html_style') );
114    $this->smarty->register_function('combine_script', array(&$this, 'func_combine_script') );
115    $this->smarty->register_function('get_combined_scripts', array(&$this, 'func_get_combined_scripts') );
116    $this->smarty->register_function('combine_css', array(&$this, 'func_combine_css') );
117    $this->smarty->register_function('define_derivative', array(&$this, 'func_define_derivative') );
118    $this->smarty->register_compiler_function('get_combined_css', array(&$this, 'func_get_combined_css') );
119    $this->smarty->register_block('footer_script', array(&$this, 'block_footer_script') );
120    $this->smarty->register_prefilter( array('Template', 'prefilter_white_space') );
121    if ( $conf['compiled_template_cache_language'] )
122    {
123      $this->smarty->register_prefilter( array('Template', 'prefilter_language') );
124    }
125
126    $this->smarty->template_dir = array();
127    if ( !empty($theme) )
128    {
129      $this->set_theme($root, $theme, $path);
130      $this->set_prefilter( 'header', array('Template', 'prefilter_local_css') );
131    }
132    else
133      $this->set_template_dir($root);
134
135    $this->smarty->assign('lang_info', $lang_info);
136
137    if (!defined('IN_ADMIN') and isset($conf['extents_for_templates']))
138    {
139      $tpl_extents = unserialize($conf['extents_for_templates']);
140      $this->set_extents($tpl_extents, './template-extension/', true, $theme);
141    }
142  }
143
144  /**
145   * Load theme's parameters.
146   */
147  function set_theme($root, $theme, $path, $load_css=true, $load_local_head=true)
148  {
149    $this->set_template_dir($root.'/'.$theme.'/'.$path);
150
151    $themeconf = $this->load_themeconf($root.'/'.$theme);
152
153    if (isset($themeconf['parent']) and $themeconf['parent'] != $theme)
154    {
155      $this->set_theme(
156        $root,
157        $themeconf['parent'],
158        $path,
159        isset($themeconf['load_parent_css']) ? $themeconf['load_parent_css'] : $load_css,
160        isset($themeconf['load_parent_local_head']) ? $themeconf['load_parent_local_head'] : $load_local_head
161      );
162    }
163
164    $tpl_var = array(
165      'id' => $theme,
166      'load_css' => $load_css,
167    );
168    if (!empty($themeconf['local_head']) and $load_local_head)
169    {
170      $tpl_var['local_head'] = realpath($root.'/'.$theme.'/'.$themeconf['local_head'] );
171    }
172    $themeconf['id'] = $theme;
173    $this->smarty->append('themes', $tpl_var);
174    $this->smarty->append('themeconf', $themeconf, true);
175  }
176
177  /**
178   * Add template directory for this Template object.
179   * Set compile id if not exists.
180   */
181  function set_template_dir($dir)
182  {
183    $this->smarty->template_dir[] = $dir;
184
185    if (!isset($this->smarty->compile_id))
186    {
187      $real_dir = realpath($dir);
188      $compile_id = crc32( $real_dir===false ? $dir : $real_dir);
189      $this->smarty->compile_id = base_convert($compile_id, 10, 36 );
190    }
191  }
192
193  /**
194   * Gets the template root directory for this Template object.
195   */
196  function get_template_dir()
197  {
198    return $this->smarty->template_dir;
199  }
200
201  /**
202   * Deletes all compiled templates.
203   */
204  function delete_compiled_templates()
205  {
206      $save_compile_id = $this->smarty->compile_id;
207      $this->smarty->compile_id = null;
208      $this->smarty->clear_compiled_tpl();
209      $this->smarty->compile_id = $save_compile_id;
210      file_put_contents($this->smarty->compile_dir.'/index.htm', 'Not allowed!');
211  }
212
213  function get_themeconf($val)
214  {
215    $tc = $this->smarty->get_template_vars('themeconf');
216    return isset($tc[$val]) ? $tc[$val] : '';
217  }
218
219  /**
220   * Sets the template filename for handle.
221   */
222  function set_filename($handle, $filename)
223  {
224    return $this->set_filenames( array($handle=>$filename) );
225  }
226
227  /**
228   * Sets the template filenames for handles. $filename_array should be a
229   * hash of handle => filename pairs.
230   */
231  function set_filenames($filename_array)
232  {
233    if (!is_array($filename_array))
234    {
235      return false;
236    }
237    reset($filename_array);
238    while(list($handle, $filename) = each($filename_array))
239    {
240      if (is_null($filename))
241      {
242        unset($this->files[$handle]);
243      }
244      else
245      {
246        $this->files[$handle] = $this->get_extent($filename, $handle);
247      }
248    }
249    return true;
250  }
251
252  /**
253   * Sets template extention filename for handles.
254   */
255  function set_extent($filename, $param, $dir='', $overwrite=true, $theme='N/A')
256  {
257    return $this->set_extents(array($filename => $param), $dir, $overwrite);
258  }
259
260  /**
261   * Sets template extentions filenames for handles.
262   * $filename_array should be an hash of filename => array( handle, param) or filename => handle
263   */
264  function set_extents($filename_array, $dir='', $overwrite=true, $theme='N/A')
265  {
266    if (!is_array($filename_array))
267    {
268      return false;
269    }
270    foreach ($filename_array as $filename => $value)
271    {
272      if (is_array($value))
273      {
274        $handle = $value[0];
275        $param = $value[1];
276        $thm = $value[2];
277      }
278      elseif (is_string($value))
279      {
280        $handle = $value;
281        $param = 'N/A';
282        $thm = 'N/A';
283      }
284      else
285      {
286        return false;
287      }
288
289      if ((stripos(implode('',array_keys($_GET)), '/'.$param) !== false or $param == 'N/A')
290        and ($thm == $theme or $thm == 'N/A')
291        and (!isset($this->extents[$handle]) or $overwrite)
292        and file_exists($dir . $filename))
293      {
294        $this->extents[$handle] = realpath($dir . $filename);
295      }
296    }
297    return true;
298  }
299
300  /** return template extension if exists  */
301  function get_extent($filename='', $handle='')
302  {
303    if (isset($this->extents[$handle]))
304    {
305      $filename = $this->extents[$handle];
306    }
307    return $filename;
308  }
309
310  /** see smarty assign http://www.smarty.net/manual/en/api.assign.php */
311  function assign($tpl_var, $value = null)
312  {
313    $this->smarty->assign( $tpl_var, $value );
314  }
315
316  /**
317   * Inserts the uncompiled code for $handle as the value of $varname in the
318   * root-level. This can be used to effectively include a template in the
319   * middle of another template.
320   * This is equivalent to assign($varname, $this->parse($handle, true))
321   */
322  function assign_var_from_handle($varname, $handle)
323  {
324    $this->assign($varname, $this->parse($handle, true));
325    return true;
326  }
327
328  /** see smarty append http://www.smarty.net/manual/en/api.append.php */
329  function append($tpl_var, $value=null, $merge=false)
330  {
331    $this->smarty->append( $tpl_var, $value, $merge );
332  }
333
334  /**
335   * Root-level variable concatenation. Appends a  string to an existing
336   * variable assignment with the same name.
337   */
338  function concat($tpl_var, $value)
339  {
340    $old_val = & $this->smarty->get_template_vars($tpl_var);
341    if ( isset($old_val) )
342    {
343      $old_val .= $value;
344    }
345    else
346    {
347      $this->assign($tpl_var, $value);
348    }
349  }
350
351  /** see smarty append http://www.smarty.net/manual/en/api.clear_assign.php */
352  function clear_assign($tpl_var)
353  {
354    $this->smarty->clear_assign( $tpl_var );
355  }
356
357  /** see smarty get_template_vars http://www.smarty.net/manual/en/api.get_template_vars.php */
358  function &get_template_vars($name=null)
359  {
360    return $this->smarty->get_template_vars( $name );
361  }
362
363
364  /**
365   * Load the file for the handle, eventually compile the file and run the compiled
366   * code. This will add the output to the results or return the result if $return
367   * is true.
368   */
369  function parse($handle, $return=false)
370  {
371    if ( !isset($this->files[$handle]) )
372    {
373      fatal_error("Template->parse(): Couldn't load template file for handle $handle");
374    }
375
376    $this->smarty->assign( 'ROOT_URL', get_root_url() );
377
378    $save_compile_id = $this->smarty->compile_id;
379    $this->load_external_filters($handle);
380
381    global $conf, $lang_info;
382    if ( $conf['compiled_template_cache_language'] and isset($lang_info['code']) )
383    {
384      $this->smarty->compile_id .= '.'.$lang_info['code'];
385    }
386
387    $v = $this->smarty->fetch($this->files[$handle], null, null, false);
388
389    $this->smarty->compile_id = $save_compile_id;
390    $this->unload_external_filters($handle);
391
392    if ($return)
393    {
394      return $v;
395    }
396    $this->output .= $v;
397  }
398
399  /**
400   * Load the file for the handle, eventually compile the file and run the compiled
401   * code. This will print out the results of executing the template.
402   */
403  function pparse($handle)
404  {
405    $this->parse($handle, false);
406    $this->flush();
407  }
408
409  function flush()
410  {
411    if (!$this->scriptLoader->did_head())
412    {
413      $pos = strpos( $this->output, self::COMBINED_SCRIPTS_TAG );
414      if ($pos !== false)
415      {
416          $scripts = $this->scriptLoader->get_head_scripts();
417          $content = array();
418          foreach ($scripts as $script)
419          {
420              $content[]=
421                  '<script type="text/javascript" src="'
422                  . self::make_script_src($script)
423                  .'"></script>';
424          }
425
426          $this->output = substr_replace( $this->output, "\n".implode( "\n", $content ), $pos, strlen(self::COMBINED_SCRIPTS_TAG) );
427      } //else maybe error or warning ?
428    }
429
430    if(!empty($this->css_by_priority))
431    {
432      ksort($this->css_by_priority);
433
434      global $conf;
435      $css = array();
436      if ($conf['template_combine_files'])
437      {
438        $combiner = new FileCombiner('css');
439        foreach ($this->css_by_priority as $files)
440        {
441          foreach ($files as $file_ver)
442            $combiner->add( $file_ver[0], $file_ver[1] );
443        }
444        if ( $combiner->combine( $out_file, $out_version) )
445          $css[] = array($out_file, $out_version);
446      }
447      else
448      {
449        foreach ($this->css_by_priority as $files)
450          $css = array_merge($css, $files);
451      }
452
453      $content = array();
454      foreach( $css as $file_ver )
455      {
456        $href = get_root_url() . $file_ver[0];
457        if ($file_ver[1] !== false)
458          $href .= '?v' . ($file_ver[1] ? $file_ver[1] : PHPWG_VERSION);
459        // trigger the event for eventual use of a cdn
460        $href = trigger_event('combined_css', $href, $file_ver[0], $file_ver[1]);
461        $content[] = '<link rel="stylesheet" type="text/css" href="'.$href.'">';
462      }
463      $this->output = str_replace(self::COMBINED_CSS_TAG,
464          implode( "\n", $content ),
465          $this->output );
466                        $this->css_by_priority = array();
467    }
468
469    if ( count($this->html_head_elements) || strlen($this->html_style) )
470    {
471      $search = "\n</head>";
472      $pos = strpos( $this->output, $search );
473      if ($pos !== false)
474      {
475        $rep = "\n".implode( "\n", $this->html_head_elements );
476        if (strlen($this->html_style))
477        {
478          $rep.='<style type="text/css">'.$this->html_style.'</style>';
479        }
480        $this->output = substr_replace( $this->output, $rep, $pos, 0 );
481      } //else maybe error or warning ?
482      $this->html_head_elements = array();
483      $this->html_style = '';
484    }
485
486    echo $this->output;
487    $this->output='';
488  }
489
490  /** flushes the output */
491  function p()
492  {
493    $this->flush();
494
495    if ($this->smarty->debugging)
496    {
497      global $t2;
498      $this->smarty->assign(
499        array(
500        'AAAA_DEBUG_TOTAL_TIME__' => get_elapsed_time($t2, get_moment())
501        )
502        );
503      require_once(SMARTY_CORE_DIR . 'core.display_debug_console.php');
504      echo smarty_core_display_debug_console(null, $this->smarty);
505    }
506  }
507
508  /**
509   * translate variable modifier - translates a text to the currently loaded
510   * language
511   */
512  static function mod_translate($text)
513  {
514    return l10n($text);
515  }
516
517  /**
518   * explode variable modifier - similar to php explode
519   * 'Yes;No'|@explode:';' -> array('Yes', 'No')
520   */
521  static function mod_explode($text, $delimiter=',')
522  {
523    return explode($delimiter, $text);
524  }
525
526  /**
527   * This smarty "html_head" block allows to add content just before
528   * </head> element in the output after the head has been parsed. This is
529   * handy in order to respect strict standards when <style> and <link>
530   * html elements must appear in the <head> element
531   */
532  function block_html_head($params, $content, &$smarty, &$repeat)
533  {
534    $content = trim($content);
535    if ( !empty($content) )
536    { // second call
537      $this->html_head_elements[] = $content;
538    }
539  }
540
541  function block_html_style($params, $content, &$smarty, &$repeat)
542  {
543    $content = trim($content);
544    if ( !empty($content) )
545    { // second call
546      $this->html_style .= $content;
547    }
548  }
549
550  function func_define_derivative($params, &$smarty)
551  {
552    !empty($params['name']) or fatal_error('define_derviative missing name');
553    if (isset($params['type']))
554    {
555      $derivative = ImageStdParams::get_by_type($params['type']);
556      $smarty->assign( $params['name'], $derivative);
557      return;
558    }
559    !empty($params['width']) or fatal_error('define_derviative missing width');
560    !empty($params['height']) or fatal_error('define_derviative missing height');
561
562    $w = intval($params['width']);
563    $h = intval($params['height']);
564    $crop = 0;
565    $minw=null;
566    $minh=null;
567   
568    if (isset($params['crop']))
569    {
570      if (is_bool($params['crop']))
571      {
572        $crop = $params['crop'] ? 1:0;
573      }
574      else
575      {
576        $crop = round($params['crop']/100, 2);
577      }
578
579      if ($crop)
580      {
581        $minw = empty($params['min_width']) ? $w : intval($params['min_width']);
582        $minw <= $w or fatal_error('define_derviative invalid min_width');
583        $minh = empty($params['min_height']) ? $h : intval($params['min_height']);
584        $minh <= $h or fatal_error('define_derviative invalid min_height');
585      }
586    }
587
588    $smarty->assign( $params['name'], ImageStdParams::get_custom($w, $h, $crop, $minw, $minh) );
589  }
590
591   /**
592    * combine_script smarty function allows inclusion of a javascript file in the current page.
593    * The engine will combine several js files into a single one in order to reduce the number of
594    * required http requests.
595    * param id - required
596    * param path - required - the path to js file RELATIVE to piwigo root dir
597    * param load - optional - header|footer|async, default header
598    * param require - optional - comma separated list of script ids required to be loaded and executed
599        before this one
600    * param version - optional - plugins could use this and change it in order to force a
601        browser refresh
602    */
603  function func_combine_script($params, &$smarty)
604  {
605    if (!isset($params['id']))
606    {
607      $smarty->trigger_error("combine_script: missing 'id' parameter", E_USER_ERROR);
608    }
609    $load = 0;
610    if (isset($params['load']))
611    {
612      switch ($params['load'])
613      {
614        case 'header': break;
615        case 'footer': $load=1; break;
616        case 'async': $load=2; break;
617        default: $smarty->trigger_error("combine_script: invalid 'load' parameter", E_USER_ERROR);
618      }
619    }
620    $this->scriptLoader->add( $params['id'], $load,
621      empty($params['require']) ? array() : explode( ',', $params['require'] ),
622      @$params['path'],
623      isset($params['version']) ? $params['version'] : 0 );
624  }
625
626
627  function func_get_combined_scripts($params, &$smarty)
628  {
629    if (!isset($params['load']))
630    {
631      $smarty->trigger_error("get_combined_scripts: missing 'load' parameter", E_USER_ERROR);
632    }
633    $load = $params['load']=='header' ? 0 : 1;
634    $content = array();
635
636    if ($load==0)
637    {
638      return self::COMBINED_SCRIPTS_TAG;
639    }
640    else
641    {
642      $scripts = $this->scriptLoader->get_footer_scripts();
643      foreach ($scripts[0] as $script)
644      {
645        $content[]=
646          '<script type="text/javascript" src="'
647          . self::make_script_src($script)
648          .'"></script>';
649      }
650      if (count($this->scriptLoader->inline_scripts))
651      {
652        $content[]= '<script type="text/javascript">//<![CDATA[
653';
654        $content = array_merge($content, $this->scriptLoader->inline_scripts);
655        $content[]= '//]]></script>';
656      }
657
658      if (count($scripts[1]))
659      {
660        $content[]= '<script type="text/javascript">';
661        $content[]= '(function() {
662var s,after = document.getElementsByTagName(\'script\')[document.getElementsByTagName(\'script\').length-1];';
663        foreach ($scripts[1] as $id => $script)
664        {
665          $content[]=
666            's=document.createElement(\'script\'); s.type=\'text/javascript\'; s.async=true; s.src=\''
667            . self::make_script_src($script)
668            .'\';';
669          $content[]= 'after = after.parentNode.insertBefore(s, after);';
670        }
671        $content[]= '})();';
672        $content[]= '</script>';
673      }
674    }
675    return implode("\n", $content);
676  }
677
678
679  private static function make_script_src( $script )
680  {
681    $ret = '';
682    if ( $script->is_remote() )
683      $ret = $script->path;
684    else
685    {
686      $ret = get_root_url().$script->path;
687      if ($script->version!==false)
688      {
689        $ret.= '?v'. ($script->version ? $script->version : PHPWG_VERSION);
690      }
691    }
692    // trigger the event for eventual use of a cdn
693    $ret = trigger_event('combined_script', $ret, $script);
694    return $ret;
695  }
696
697  function block_footer_script($params, $content, &$smarty, &$repeat)
698  {
699    $content = trim($content);
700    if ( !empty($content) )
701    { // second call
702      $this->scriptLoader->add_inline(
703        $content,
704        empty($params['require']) ? array() : explode(',', $params['require'])
705      );
706    }
707  }
708
709  /**
710    * combine_css smarty function allows inclusion of a css stylesheet file in the current page.
711    * The engine will combine several css files into a single one in order to reduce the number of
712    * required http requests.
713    * param path - required - the path to css file RELATIVE to piwigo root dir
714    * param version - optional - plugins could use this and change it in order to force a
715        browser refresh
716    */
717  function func_combine_css($params, &$smarty)
718  {
719    !empty($params['path']) || fatal_error('combine_css missing path');
720    $order = (int)@$params['order'];
721    $version = isset($params['version']) ? $params['version'] : 0;
722    $this->css_by_priority[$order][] = array( $params['path'], $version);
723  }
724
725  function func_get_combined_css($params, &$smarty)
726  {
727    return 'echo '.var_export(self::COMBINED_CSS_TAG,true);
728  }
729
730
731 /**
732   * This function allows to declare a Smarty prefilter from a plugin, thus allowing
733   * it to modify template source before compilation and without changing core files
734   * They will be processed by weight ascending.
735   * http://www.smarty.net/manual/en/advanced.features.prefilters.php
736   */
737  function set_prefilter($handle, $callback, $weight=50)
738  {
739    $this->external_filters[$handle][$weight][] = array('prefilter', $callback);
740    ksort($this->external_filters[$handle]);
741  }
742
743  function set_postfilter($handle, $callback, $weight=50)
744  {
745    $this->external_filters[$handle][$weight][] = array('postfilter', $callback);
746    ksort($this->external_filters[$handle]);
747  }
748
749  function set_outputfilter($handle, $callback, $weight=50)
750  {
751    $this->external_filters[$handle][$weight][] = array('outputfilter', $callback);
752    ksort($this->external_filters[$handle]);
753  }
754
755 /**
756   * This function actually triggers the filters on the tpl files.
757   * Called in the parse method.
758   * http://www.smarty.net/manual/en/advanced.features.prefilters.php
759   */
760  function load_external_filters($handle)
761  {
762    if (isset($this->external_filters[$handle]))
763    {
764      $compile_id = '';
765      foreach ($this->external_filters[$handle] as $filters)
766      {
767        foreach ($filters as $filter)
768        {
769          list($type, $callback) = $filter;
770          $compile_id .= $type.( is_array($callback) ? implode('', $callback) : $callback );
771          call_user_func(array($this->smarty, 'register_'.$type), $callback);
772        }
773      }
774      $this->smarty->compile_id .= '.'.base_convert(crc32($compile_id), 10, 36);
775    }
776  }
777
778  function unload_external_filters($handle)
779  {
780    if (isset($this->external_filters[$handle]))
781    {
782      foreach ($this->external_filters[$handle] as $filters)
783      {
784        foreach ($filters as $filter)
785        {
786          list($type, $callback) = $filter;
787          call_user_func(array($this->smarty, 'unregister_'.$type), $callback);
788        }
789      }
790    }
791  }
792
793  static function prefilter_white_space($source, &$smarty)
794  {
795    $ld = $smarty->left_delimiter;
796    $rd = $smarty->right_delimiter;
797    $ldq = preg_quote($ld, '#');
798    $rdq = preg_quote($rd, '#');
799
800    $regex = array();
801    $tags = array('if','foreach','section','footer_script');
802    foreach($tags as $tag)
803    {
804      array_push($regex, "#^[ \t]+($ldq$tag"."[^$ld$rd]*$rdq)\s*$#m");
805      array_push($regex, "#^[ \t]+($ldq/$tag$rdq)\s*$#m");
806    }
807    $tags = array('include','else','combine_script','html_head');
808    foreach($tags as $tag)
809    {
810      array_push($regex, "#^[ \t]+($ldq$tag"."[^$ld$rd]*$rdq)\s*$#m");
811    }
812    $source = preg_replace( $regex, "$1", $source);
813    return $source;
814  }
815
816  /**
817   * Smarty prefilter to allow caching (whenever possible) language strings
818   * from templates.
819   */
820  static function prefilter_language($source, &$smarty)
821  {
822    global $lang;
823    $ldq = preg_quote($smarty->left_delimiter, '~');
824    $rdq = preg_quote($smarty->right_delimiter, '~');
825
826    $regex = "~$ldq *\'([^'$]+)\'\|@translate *$rdq~";
827    $source = preg_replace_callback( $regex, create_function('$m', 'global $lang; return isset($lang[$m[1]]) ? $lang[$m[1]] : $m[0];'), $source);
828
829    $regex = "~$ldq *\'([^'$]+)\'\|@translate\|~";
830    $source = preg_replace_callback( $regex, create_function('$m', 'global $lang; return isset($lang[$m[1]]) ? \'{\'.var_export($lang[$m[1]],true).\'|\' : $m[0];'), $source);
831
832    $regex = "~($ldq *assign +var=.+ +value=)\'([^'$]+)\'\|@translate~";
833    $source = preg_replace_callback( $regex, create_function('$m', 'global $lang; return isset($lang[$m[2]]) ? $m[1].var_export($lang[$m[2]],true) : $m[0];'), $source);
834
835    return $source;
836  }
837
838  static function prefilter_local_css($source, &$smarty)
839  {
840    $css = array();
841    foreach ($smarty->get_template_vars('themes') as $theme)
842    {
843      $f = PWG_LOCAL_DIR.'css/'.$theme['id'].'-rules.css';
844      if (file_exists(PHPWG_ROOT_PATH.$f))
845      {
846        array_push($css, "{combine_css path='$f' order=10}");
847      }
848    }
849    $f = PWG_LOCAL_DIR.'css/rules.css';
850    if (file_exists(PHPWG_ROOT_PATH.$f))
851    {
852      array_push($css, "{combine_css path='$f' order=10}");
853    }
854
855    if (!empty($css))
856    {
857      $source = str_replace("\n{get_combined_css}", "\n".implode( "\n", $css )."\n{get_combined_css}", $source);
858    }
859
860    return $source;
861  }
862
863  function load_themeconf($dir)
864  {
865    global $themeconfs, $conf;
866
867    $dir = realpath($dir);
868    if (!isset($themeconfs[$dir]))
869    {
870      $themeconf = array();
871      include($dir.'/themeconf.inc.php');
872      // Put themeconf in cache
873      $themeconfs[$dir] = $themeconf;
874    }
875    return $themeconfs[$dir];
876  }
877}
878
879
880/**
881 * This class contains basic functions that can be called directly from the
882 * templates in the form $pwg->l10n('edit')
883 */
884class PwgTemplateAdapter
885{
886  function l10n($text)
887  {
888    return l10n($text);
889  }
890
891  function l10n_dec($s, $p, $v)
892  {
893    return l10n_dec($s, $p, $v);
894  }
895
896  function sprintf()
897  {
898    $args = func_get_args();
899    return call_user_func_array('sprintf',  $args );
900  }
901
902  function derivative_url($type, $img)
903  {
904    return DerivativeImage::url($type, $img);
905  }
906}
907
908
909final class Script
910{
911  public $id;
912  public $load_mode;
913  public $precedents = array();
914  public $path;
915  public $version;
916  public $extra = array();
917
918  function Script($load_mode, $id, $path, $version, $precedents)
919  {
920    $this->id = $id;
921    $this->load_mode = $load_mode;
922    $this->id = $id;
923    $this->set_path($path);
924    $this->version = $version;
925    $this->precedents = $precedents;
926  }
927
928  function set_path($path)
929  {
930    if (!empty($path))
931      $this->path = $path;
932  }
933
934  function is_remote()
935  {
936    return url_is_remote( $this->path );
937  }
938}
939
940
941/** Manage a list of required scripts for a page, by optimizing their loading location (head, bottom, async)
942and later on by combining them in a unique file respecting at the same time dependencies.*/
943class ScriptLoader
944{
945  private $registered_scripts;
946  public $inline_scripts;
947
948  private $did_head;
949  private $head_done_scripts;
950  private $did_footer;
951
952  private static $known_paths = array(
953      'core.scripts' => 'themes/default/js/scripts.js',
954      'jquery' => 'themes/default/js/jquery.min.js',
955      'jquery.ui' => 'themes/default/js/ui/minified/jquery.ui.core.min.js',
956      'jquery.effects' => 'themes/default/js/ui/minified/jquery.effects.core.min.js',
957    );
958
959  private static $ui_core_dependencies = array(
960      'jquery.ui.widget' => array('jquery'),
961      'jquery.ui.position' => array('jquery'),
962      'jquery.ui.mouse' => array('jquery', 'jquery.ui', 'jquery.ui.widget'),
963    );
964
965  function __construct()
966  {
967    $this->clear();
968  }
969
970  function clear()
971  {
972    $this->registered_scripts = array();
973    $this->inline_scripts = array();
974    $this->head_done_scripts = array();
975    $this->did_head = $this->did_footer = false;
976  }
977
978  function get_all()
979  {
980    return $this->registered_scripts;
981  }
982
983  function add_inline($code, $require)
984  {
985    !$this->did_footer || trigger_error("Attempt to add inline script but the footer has been written", E_USER_WARNING);
986    if(!empty($require))
987    {
988      foreach ($require as $id)
989      {
990        if(!isset($this->registered_scripts[$id]))
991          $this->load_known_required_script($id, 1) or fatal_error("inline script not found require $id");
992        $s = $this->registered_scripts[$id];
993        if($s->load_mode==2)
994          $s->load_mode=1; // until now the implementation does not allow executing inline script depending on another async script
995      }
996    }
997    $this->inline_scripts[] = $code;
998  }
999
1000  function add($id, $load_mode, $require, $path, $version=0)
1001  {
1002    if ($this->did_head && $load_mode==0)
1003    {
1004      trigger_error("Attempt to add script $id but the head has been written", E_USER_WARNING);
1005    }
1006    elseif ($this->did_footer)
1007    {
1008      trigger_error("Attempt to add script $id but the footer has been written", E_USER_WARNING);
1009    }
1010    if (! isset( $this->registered_scripts[$id] ) )
1011    {
1012      $script = new Script($load_mode, $id, $path, $version, $require);
1013      self::fill_well_known($id, $script);
1014      $this->registered_scripts[$id] = $script;
1015
1016      // Load or modify all UI core files
1017      if ($id == 'jquery.ui' and $script->path == self::$known_paths['jquery.ui'])
1018      {
1019        foreach (self::$ui_core_dependencies as $script_id => $required_ids)
1020          $this->add($script_id, $load_mode, $required_ids, null, $version);
1021      }
1022
1023      // Try to load undefined required script
1024      foreach ($script->precedents as $script_id)
1025      {
1026        if (! isset( $this->registered_scripts[$script_id] ) )
1027          $this->load_known_required_script($script_id, $load_mode);
1028      }
1029    }
1030    else
1031    {
1032      $script = $this->registered_scripts[$id];
1033      if (count($require))
1034      {
1035        $script->precedents = array_unique( array_merge($script->precedents, $require) );
1036      }
1037      $script->set_path($path);
1038      if ($version && version_compare($script->version, $version)<0 )
1039        $script->version = $version;
1040      if ($load_mode < $script->load_mode)
1041        $script->load_mode = $load_mode;
1042    }
1043
1044  }
1045
1046  function did_head()
1047  {
1048    return $this->did_head;
1049  }
1050
1051  function get_head_scripts()
1052  {
1053    self::check_load_dep($this->registered_scripts);
1054    foreach( array_keys($this->registered_scripts) as $id )
1055    {
1056      $this->compute_script_topological_order($id);
1057    }
1058
1059    uasort($this->registered_scripts, array('ScriptLoader', 'cmp_by_mode_and_order'));
1060
1061    foreach( $this->registered_scripts as $id => $script)
1062    {
1063      if ($script->load_mode > 0)
1064        break;
1065      if ( !empty($script->path) )
1066        $this->head_done_scripts[$id] = $script;
1067      else
1068        trigger_error("Script $id has an undefined path", E_USER_WARNING);
1069    }
1070    $this->did_head = true;
1071    return self::do_combine($this->head_done_scripts, 0);
1072  }
1073
1074  function get_footer_scripts()
1075  {
1076    if (!$this->did_head)
1077    {
1078      self::check_load_dep($this->registered_scripts);
1079    }
1080    $this->did_footer = true;
1081    $todo = array();
1082    foreach( $this->registered_scripts as $id => $script)
1083    {
1084      if (!isset($this->head_done_scripts[$id]))
1085      {
1086        $todo[$id] = $script;
1087      }
1088    }
1089
1090    foreach( array_keys($todo) as $id )
1091    {
1092      $this->compute_script_topological_order($id);
1093    }
1094
1095    uasort($todo, array('ScriptLoader', 'cmp_by_mode_and_order'));
1096
1097    $result = array( array(), array() );
1098    foreach( $todo as $id => $script)
1099    {
1100      $result[$script->load_mode-1][$id] = $script;
1101    }
1102    return array( self::do_combine($result[0],1), self::do_combine($result[1],2) );
1103  }
1104
1105  private static function do_combine($scripts, $load_mode)
1106  {
1107    global $conf;
1108    if (count($scripts)<2 or !$conf['template_combine_files'])
1109      return $scripts;
1110    $combiner = new FileCombiner('js');
1111    $result = array();
1112    foreach ($scripts as $script)
1113    {
1114      if ($script->is_remote())
1115      {
1116        if ( $combiner->combine( $out_file, $out_version) )
1117        {
1118          $results[] = new Script($load_mode, 'combi', $out_file, $out_version, array() );
1119        }
1120        $results[] = $script;
1121      }
1122      else
1123        $combiner->add( $script->path, $script->version );
1124    }
1125    if ( $combiner->combine( $out_file, $out_version) )
1126    {
1127      $results[] = new Script($load_mode, 'combi', $out_file, $out_version, array() );
1128    }
1129    return $results;
1130  }
1131
1132  // checks that if B depends on A, then B->load_mode >= A->load_mode in order to respect execution order
1133  private static function check_load_dep($scripts)
1134  {
1135    global $conf;
1136    do
1137    {
1138      $changed = false;
1139      foreach( $scripts as $id => $script)
1140      {
1141        $load = $script->load_mode;
1142        foreach( $script->precedents as $precedent)
1143        {
1144          if ( !isset($scripts[$precedent] ) )
1145            continue;
1146          if ( $scripts[$precedent]->load_mode > $load )
1147          {
1148            $scripts[$precedent]->load_mode = $load;
1149            $changed = true;
1150          }
1151          if ($load==2 && $scripts[$precedent]->load_mode==2 && ($scripts[$precedent]->is_remote() or !$conf['template_combine_files']) )
1152          {// we are async -> a predecessor cannot be async unlesss it can be merged; otherwise script execution order is not guaranteed
1153            $scripts[$precedent]->load_mode = 1;
1154            $changed = true;
1155          }
1156        }
1157      }
1158    }
1159    while ($changed);
1160  }
1161
1162
1163  private static function fill_well_known($id, $script)
1164  {
1165    if ( empty($script->path) && isset(self::$known_paths[$id]))
1166    {
1167      $script->path = self::$known_paths[$id];
1168    }
1169    if ( strncmp($id, 'jquery.', 7)==0 )
1170    {
1171      $required_ids = array('jquery');
1172
1173      if ( strncmp($id, 'jquery.ui.', 10)==0 )
1174      {
1175        if ( !isset(self::$ui_core_dependencies[$id]) )
1176          $required_ids = array_merge(array('jquery', 'jquery.ui'), array_keys(self::$ui_core_dependencies));
1177
1178        if ( empty($script->path) )
1179          $script->path = dirname(self::$known_paths['jquery.ui'])."/$id.min.js";
1180      }
1181      elseif ( strncmp($id, 'jquery.effects.', 15)==0 )
1182      {
1183        $required_ids = array('jquery', 'jquery.effects');
1184
1185        if ( empty($script->path) )
1186          $script->path = dirname(self::$known_paths['jquery.effects'])."/$id.min.js";
1187      }
1188
1189      foreach ($required_ids as $required_id)
1190      {
1191        if ( !in_array($required_id, $script->precedents ) )
1192          $script->precedents[] = $required_id;
1193      }
1194    }
1195  }
1196
1197  private function load_known_required_script($id, $load_mode)
1198  {
1199    if ( isset(self::$known_paths[$id]) or strncmp($id, 'jquery.ui.', 10)==0 or strncmp($id, 'jquery.effects.', 15)==0 )
1200    {
1201      $this->add($id, $load_mode, array(), null);
1202      return true;
1203    }
1204    return false;
1205  }
1206
1207  private function compute_script_topological_order($script_id, $recursion_limiter=0)
1208  {
1209    if (!isset($this->registered_scripts[$script_id]))
1210    {
1211      trigger_error("Undefined script $script_id is required by someone", E_USER_WARNING);
1212      return 0;
1213    }
1214    $recursion_limiter<5 or fatal_error("combined script circular dependency");
1215    $script = $this->registered_scripts[$script_id];
1216    if (isset($script->extra['order']))
1217      return $script->extra['order'];
1218    if (count($script->precedents) == 0)
1219      return ($script->extra['order'] = 0);
1220    $max = 0;
1221    foreach( $script->precedents as $precedent)
1222      $max = max($max, $this->compute_script_topological_order($precedent, $recursion_limiter+1) );
1223    $max++;
1224    return ($script->extra['order'] = $max);
1225  }
1226
1227  private static function cmp_by_mode_and_order($s1, $s2)
1228  {
1229    $ret = $s1->load_mode - $s2->load_mode;
1230    if ($ret) return $ret;
1231
1232    $ret = $s1->extra['order'] - $s2->extra['order'];
1233    if ($ret) return $ret;
1234
1235    if ($s1->extra['order']==0 and ($s1->is_remote() xor $s2->is_remote()) )
1236    {
1237      return $s1->is_remote() ? -1 : 1;
1238    }
1239    return strcmp($s1->id,$s2->id);
1240  }
1241}
1242
1243
1244/*Allows merging of javascript and css files into a single one.*/
1245final class FileCombiner
1246{
1247  private $type; // js or css
1248  private $files = array();
1249  private $versions = array();
1250
1251  function FileCombiner($type)
1252  {
1253    $this->type = $type;
1254  }
1255
1256  static function clear_combined_files()
1257  {
1258    $dir = opendir(PHPWG_ROOT_PATH.PWG_COMBINED_DIR);
1259    while ($file = readdir($dir))
1260    {
1261      if ( get_extension($file)=='js' || get_extension($file)=='css')
1262        unlink(PHPWG_ROOT_PATH.PWG_COMBINED_DIR.$file);
1263    }
1264    closedir($dir);
1265  }
1266
1267  function add($file, $version)
1268  {
1269    $this->files[] = $file;
1270    $this->versions[] = $version;
1271  }
1272
1273  function clear()
1274  {
1275    $this->files = array();
1276    $this->versions = array();
1277  }
1278
1279  function combine(&$out_file, &$out_version)
1280  {
1281    if (count($this->files) == 0)
1282    {
1283      return false;
1284    }
1285    if (count($this->files) == 1)
1286    {
1287      $out_file = $this->files[0];
1288      $out_version = $this->versions[0];
1289      $this->clear();
1290      return 1;
1291    }
1292
1293    $is_css = $this->type == "css";
1294    global $conf;
1295    $key = array();
1296    if ($is_css)
1297      $key[] = get_absolute_root_url(false);//because we modify bg url
1298    for ($i=0; $i<count($this->files); $i++)
1299    {
1300      $key[] = $this->files[$i];
1301      $key[] = $this->versions[$i];
1302      if ($conf['template_compile_check']) $key[] = filemtime( PHPWG_ROOT_PATH . $this->files[$i] );
1303    }
1304    $key = join('>', $key);
1305
1306    $file = base_convert(crc32($key),10,36);
1307    $file = PWG_COMBINED_DIR . $file . '.' . $this->type;
1308
1309    $exists = file_exists( PHPWG_ROOT_PATH . $file );
1310    if ($exists)
1311    {
1312      $is_reload =
1313        (isset($_SERVER['HTTP_CACHE_CONTROL']) && strpos($_SERVER['HTTP_CACHE_CONTROL'], 'max-age=0') !== false)
1314        || (isset($_SERVER['HTTP_PRAGMA']) && strpos($_SERVER['HTTP_PRAGMA'], 'no-cache'));
1315      if (is_admin() && $is_reload)
1316      {// the user pressed F5 in the browser
1317        if ($is_css || $conf['template_compile_check']==false)
1318          $exists = false; // we foce regeneration of css because @import sub-files are never checked for modification
1319      }
1320    }
1321
1322    if ($exists)
1323    {
1324      $out_file = $file;
1325      $out_version = false;
1326      $this->clear();
1327      return 2;
1328    }
1329
1330    $output = '';
1331    foreach ($this->files as $input_file)
1332    {
1333      $output .= "/*BEGIN $input_file */\n";
1334      if ($is_css)
1335        $output .= self::process_css($input_file);
1336      else
1337        $output .= self::process_js($input_file);
1338      $output .= "\n";
1339    }
1340
1341    file_put_contents( PHPWG_ROOT_PATH . $file,  $output );
1342    $out_file = $file;
1343    $out_version = false;
1344    $this->clear();
1345    return 2;
1346  }
1347
1348  private static function process_js($file)
1349  {
1350    $js = file_get_contents(PHPWG_ROOT_PATH . $file);
1351    if (strpos($file, '.min')===false and strpos($file, '.packed')===false )
1352    {
1353      require_once(PHPWG_ROOT_PATH.'include/jsmin.class.php');
1354      try { $js = JSMin::minify($js); } catch(Exception $e) {}
1355    }
1356    return trim($js, " \t\r\n;").";\n";
1357  }
1358
1359  private static function process_css($file)
1360  {
1361    $css = self::process_css_rec($file);
1362    require_once(PHPWG_ROOT_PATH.'include/cssmin.class.php');
1363    $css = CssMin::minify($css, array('Variables'=>false));
1364    $css = trigger_event('combined_css_postfilter', $css);
1365    return $css;
1366  }
1367
1368  private static function process_css_rec($file)
1369  {
1370    static $PATTERN = "#url\(\s*['|\"]{0,1}(.*?)['|\"]{0,1}\s*\)#";
1371    $css = file_get_contents(PHPWG_ROOT_PATH . $file);
1372    if (preg_match_all($PATTERN, $css, $matches, PREG_SET_ORDER))
1373    {
1374      $search = $replace = array();
1375      foreach ($matches as $match)
1376      {
1377        if ( !url_is_remote($match[1]) && $match[1][0] != '/')
1378        {
1379          $relative = dirname($file) . "/$match[1]";
1380          $search[] = $match[0];
1381          $replace[] = 'url('.embellish_url(get_absolute_root_url(false).$relative).')';
1382        }
1383      }
1384      $css = str_replace($search, $replace, $css);
1385    }
1386
1387    $imports = preg_match_all("#@import\s*['|\"]{0,1}(.*?)['|\"]{0,1};#", $css, $matches, PREG_SET_ORDER);
1388    if ($imports)
1389    {
1390      $search = $replace = array();
1391      foreach ($matches as $match)
1392      {
1393        $search[] = $match[0];
1394        $replace[] = self::process_css_rec(dirname($file) . "/$match[1]");
1395      }
1396      $css = str_replace($search, $replace, $css);
1397    }
1398    return $css;
1399  }
1400}
1401
1402?>
Note: See TracBrowser for help on using the repository browser.