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

Revision 8506, 37.6 KB checked in by rvelices, 8 years ago (diff)

added some comments

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