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

Last change on this file since 8075 was 8075, checked in by rvelices, 13 years ago

combine css small fixes

  • Property svn:eol-style set to LF
File size: 35.7 KB
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_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    $this->smarty->assign( 'TAG_INPUT_ENABLED',
357      ((is_adviser()) ? 'disabled="disabled" onclick="return false;"' : ''));
358
359    $save_compile_id = $this->smarty->compile_id;
360    $this->load_external_filters($handle);
361
362    global $conf, $lang_info;
363    if ( $conf['compiled_template_cache_language'] and isset($lang_info['code']) )
364    {
365      $this->smarty->compile_id .= '.'.$lang_info['code'];
366    }
367
368    $v = $this->smarty->fetch($this->files[$handle], null, null, false);
369
370    $this->smarty->compile_id = $save_compile_id;
371    $this->unload_external_filters($handle);
372
373    if ($return)
374    {
375      return $v;
376    }
377    $this->output .= $v;
378  }
379
380  /**
381   * Load the file for the handle, eventually compile the file and run the compiled
382   * code. This will print out the results of executing the template.
383   */
384  function pparse($handle)
385  {
386    $this->parse($handle, false);
387    $this->flush();
388  }
389
390  function flush()
391  {
392    if (!$this->scriptLoader->did_head())
393    {
394      $pos = strpos( $this->output, self::COMBINED_SCRIPTS_TAG );
395      if ($pos !== false)
396      {
397          $scripts = $this->scriptLoader->get_head_scripts();
398          $content = array();
399          foreach ($scripts as $script)
400          {
401              $content[]=
402                  '<script type="text/javascript" src="'
403                  . Template::make_script_src($script)
404                  .'"></script>';
405          }
406
407          $this->output = substr_replace( $this->output, "\n".implode( "\n", $content ), $pos, strlen(self::COMBINED_SCRIPTS_TAG) );
408      } //else maybe error or warning ?
409    }
410
411    if(!empty($this->css_by_priority))
412    {
413      ksort($this->css_by_priority);
414
415                        global $conf;
416                        $css = array();
417                        if ($conf['template_combine_files'])
418                        {
419                                $combiner = new FileCombiner('css');
420                                foreach ($this->css_by_priority as $files)
421                                {
422                                        foreach ($files as $file_ver)
423                                                $combiner->add( $file_ver[0], $file_ver[1] );
424                                }
425                                if ( $combiner->combine( $out_file, $out_version) )
426                                        $css[] = array($out_file, $out_version);
427                        }
428                        else
429                        {
430                                foreach ($this->css_by_priority as $files)
431                                        $css = array_merge($css, $files);
432                        }
433                       
434                        $content = array();
435      foreach( $css as $file_ver )
436      {
437        $href = get_root_url() . $file_ver[0];
438        if ($file_ver[1] !== false)
439          $href .= '?v' . ($file_ver[1] ? $file_ver[1] : PHPWG_VERSION);
440        // trigger the event for eventual use of a cdn
441        $href = trigger_event('combined_css', $href, $file_ver[0], $file_ver[1]);
442                                $content[] = '<link rel="stylesheet" type="text/css" href="'.$href.'">';
443      }
444      $this->output = str_replace(self::COMBINED_CSS_TAG,
445          implode( "\n", $content ),
446          $this->output );
447    }
448
449    if ( count($this->html_head_elements) )
450    {
451      $search = "\n</head>";
452      $pos = strpos( $this->output, $search );
453      if ($pos !== false)
454      {
455        $this->output = substr_replace( $this->output, "\n".implode( "\n", $this->html_head_elements ), $pos, 0 );
456      } //else maybe error or warning ?
457      $this->html_head_elements = array();
458    }
459
460    echo $this->output;
461    $this->output='';
462  }
463
464  /** flushes the output */
465  function p()
466  {
467    $this->flush();
468
469    if ($this->smarty->debugging)
470    {
471      global $t2;
472      $this->smarty->assign(
473        array(
474        'AAAA_DEBUG_TOTAL_TIME__' => get_elapsed_time($t2, get_moment())
475        )
476        );
477      require_once(SMARTY_CORE_DIR . 'core.display_debug_console.php');
478      echo smarty_core_display_debug_console(null, $this->smarty);
479    }
480  }
481
482  /**
483   * translate variable modifier - translates a text to the currently loaded
484   * language
485   */
486  static function mod_translate($text)
487  {
488    return l10n($text);
489  }
490
491  /**
492   * explode variable modifier - similar to php explode
493   * 'Yes;No'|@explode:';' -> array('Yes', 'No')
494   */
495  static function mod_explode($text, $delimiter=',')
496  {
497    return explode($delimiter, $text);
498  }
499
500  /**
501   * This smarty "html_head" block allows to add content just before
502   * </head> element in the output after the head has been parsed. This is
503   * handy in order to respect strict standards when <style> and <link>
504   * html elements must appear in the <head> element
505   */
506  function block_html_head($params, $content, &$smarty, &$repeat)
507  {
508    $content = trim($content);
509    if ( !empty($content) )
510    { // second call
511      $this->html_head_elements[] = $content;
512    }
513  }
514
515 /**
516   * This smarty "known_script" functions allows to insert well known java scripts
517   * such as prototype, jquery, etc... only once. Examples:
518   * {known_script id="jquery" src="{$ROOT_URL}template-common/lib/jquery.packed.js"}
519   */
520  function func_known_script($params, &$smarty )
521  {
522    if (!isset($params['id']))
523    {
524        $smarty->trigger_error("known_script: missing 'id' parameter");
525        return;
526    }
527    $id = $params['id'];
528    if (! isset( $this->known_scripts[$id] ) )
529    {
530      if (!isset($params['src']))
531      {
532          $smarty->trigger_error("known_script: missing 'src' parameter");
533          return;
534      }
535      $this->known_scripts[$id] = $params['src'];
536      $content = '<script type="text/javascript" src="'.$params['src'].'"></script>';
537      if (isset($params['now']) and $params['now'] and empty($this->output) )
538      {
539        return $content;
540      }
541      $repeat = false;
542      $this->block_html_head(null, $content, $smarty, $repeat);
543    }
544  }
545
546  function func_combine_script($params, &$smarty)
547  {
548    if (!isset($params['id']))
549    {
550      $smarty->trigger_error("combine_script: missing 'id' parameter", E_USER_ERROR);
551    }
552    $load = 0;
553    if (isset($params['load']))
554    {
555      switch ($params['load'])
556      {
557        case 'header': break;
558        case 'footer': $load=1; break;
559        case 'async': $load=2; break;
560        default: $smarty->trigger_error("combine_script: invalid 'load' parameter", E_USER_ERROR);
561      }
562    }
563    $this->scriptLoader->add( $params['id'], $load,
564      empty($params['require']) ? array() : explode( ',', $params['require'] ),
565      @$params['path'],
566      isset($params['version']) ? $params['version'] : 0 );
567  }
568
569
570  function func_get_combined_scripts($params, &$smarty)
571  {
572    if (!isset($params['load']))
573    {
574      $smarty->trigger_error("get_combined_scripts: missing 'load' parameter", E_USER_ERROR);
575    }
576    $load = $params['load']=='header' ? 0 : 1;
577    $content = array();
578
579    if ($load==0)
580    {
581      return self::COMBINED_SCRIPTS_TAG;
582    }
583    else
584    {
585      $scripts = $this->scriptLoader->get_footer_scripts();
586      foreach ($scripts[0] as $script)
587      {
588        $content[]=
589          '<script type="text/javascript" src="'
590          . self::make_script_src($script)
591          .'"></script>';
592      }
593      if (count($this->scriptLoader->inline_scripts))
594      {
595        $content[]= '<script type="text/javascript">';
596        $content = array_merge($content, $this->scriptLoader->inline_scripts);
597        $content[]= '</script>';
598      }
599
600      if (count($scripts[1]))
601      {
602        $content[]= '<script type="text/javascript">';
603        $content[]= '(function() {
604  var after = document.getElementsByTagName(\'script\')[document.getElementsByTagName(\'script\').length-1];
605  var s;';
606        foreach ($scripts[1] as $id => $script)
607        {
608          $content[]=
609            's=document.createElement(\'script\'); s.type = \'text/javascript\'; s.async = true; s.src = \''
610            . self::make_script_src($script)
611            .'\';';
612          $content[]= 'after = after.parentNode.insertBefore(s, after);';
613        }
614        $content[]= '})();';
615        $content[]= '</script>';
616      }
617    }
618    return implode("\n", $content);
619  }
620
621
622  private static function make_script_src( $script )
623  {
624    $ret = '';
625    if ( $script->is_remote() )
626      $ret = $script->path;
627    else
628    {
629      $ret = get_root_url().$script->path;
630      if ($script->version!==false)
631      {
632        $ret.= '?v'. ($script->version ? $script->version : PHPWG_VERSION);
633      }
634    }
635    // trigger the event for eventual use of a cdn
636    $ret = trigger_event('combined_script', $ret, $script);
637    return $ret;
638  }
639
640  function block_footer_script($params, $content, &$smarty, &$repeat)
641  {
642    $content = trim($content);
643    if ( !empty($content) )
644    { // second call
645      $this->scriptLoader->add_inline( $content, @$params['require'] );
646    }
647  }
648
649  function func_combine_css($params, &$smarty)
650  {
651    !empty($params['path']) || fatal_error('combine_css missing path');
652    $order = (int)@$params['order'];
653    $version = isset($params['version']) ? $params['version'] : 0;
654    $this->css_by_priority[$order][] = array( $params['path'], $version);
655  }
656
657  function func_get_combined_css($params, &$smarty)
658  {
659    return self::COMBINED_CSS_TAG;
660  }
661
662
663 /**
664   * This function allows to declare a Smarty prefilter from a plugin, thus allowing
665   * it to modify template source before compilation and without changing core files
666   * They will be processed by weight ascending.
667   * http://www.smarty.net/manual/en/advanced.features.prefilters.php
668   */
669  function set_prefilter($handle, $callback, $weight=50)
670  {
671    $this->external_filters[$handle][$weight][] = array('prefilter', $callback);
672    ksort($this->external_filters[$handle]);
673  }
674
675  function set_postfilter($handle, $callback, $weight=50)
676  {
677    $this->external_filters[$handle][$weight][] = array('postfilter', $callback);
678    ksort($this->external_filters[$handle]);
679  }
680
681  function set_outputfilter($handle, $callback, $weight=50)
682  {
683    $this->external_filters[$handle][$weight][] = array('outputfilter', $callback);
684    ksort($this->external_filters[$handle]);
685  }
686
687 /**
688   * This function actually triggers the filters on the tpl files.
689   * Called in the parse method.
690   * http://www.smarty.net/manual/en/advanced.features.prefilters.php
691   */
692  function load_external_filters($handle)
693  {
694    if (isset($this->external_filters[$handle]))
695    {
696      $compile_id = '';
697      foreach ($this->external_filters[$handle] as $filters)
698      {
699        foreach ($filters as $filter)
700        {
701          list($type, $callback) = $filter;
702          $compile_id .= $type.( is_array($callback) ? implode('', $callback) : $callback );
703          call_user_func(array($this->smarty, 'register_'.$type), $callback);
704        }
705      }
706      $this->smarty->compile_id .= '.'.base_convert(crc32($compile_id), 10, 36);
707    }
708  }
709
710  function unload_external_filters($handle)
711  {
712    if (isset($this->external_filters[$handle]))
713    {
714      foreach ($this->external_filters[$handle] as $filters)
715      {
716        foreach ($filters as $filter)
717        {
718          list($type, $callback) = $filter;
719          call_user_func(array($this->smarty, 'unregister_'.$type), $callback);
720        }
721      }
722    }
723  }
724
725  static function prefilter_white_space($source, &$smarty)
726  {
727    $ld = $smarty->left_delimiter;
728    $rd = $smarty->right_delimiter;
729    $ldq = preg_quote($ld, '#');
730    $rdq = preg_quote($rd, '#');
731
732    $regex = array();
733    $tags = array('if', 'foreach', 'section');
734    foreach($tags as $tag)
735    {
736      array_push($regex, "#^[ \t]+($ldq$tag"."[^$ld$rd]*$rdq)\s*$#m");
737      array_push($regex, "#^[ \t]+($ldq/$tag$rdq)\s*$#m");
738    }
739    $tags = array('include', 'else', 'html_head');
740    foreach($tags as $tag)
741    {
742      array_push($regex, "#^[ \t]+($ldq$tag"."[^$ld$rd]*$rdq)\s*$#m");
743    }
744    $source = preg_replace( $regex, "$1", $source);
745    return $source;
746  }
747
748  /**
749   * Smarty prefilter to allow caching (whenever possible) language strings
750   * from templates.
751   */
752  static function prefilter_language($source, &$smarty)
753  {
754    global $lang;
755    $ldq = preg_quote($smarty->left_delimiter, '~');
756    $rdq = preg_quote($smarty->right_delimiter, '~');
757
758    $regex = "~$ldq *\'([^'$]+)\'\|@translate *$rdq~";
759    $source = preg_replace( $regex.'e', 'isset($lang[\'$1\']) ? $lang[\'$1\'] : \'$0\'', $source);
760
761    $regex = "~$ldq *\'([^'$]+)\'\|@translate\|~";
762    $source = preg_replace( $regex.'e', 'isset($lang[\'$1\']) ? \'{\'.var_export($lang[\'$1\'],true).\'|\' : \'$0\'', $source);
763
764    $regex = "~($ldq *assign +var=.+ +value=)\'([^'$]+)\'\|@translate~e";
765    $source = preg_replace( $regex, 'isset($lang[\'$2\']) ? \'$1\'.var_export($lang[\'$2\'],true) : \'$0\'', $source);
766
767    return $source;
768  }
769
770  static function prefilter_local_css($source, &$smarty)
771  {
772    $css = array();
773    foreach ($smarty->get_template_vars('themes') as $theme)
774    {
775      $f = 'local/css/'.$theme['id'].'-rules.css';
776      if (file_exists(PHPWG_ROOT_PATH.$f))
777      {
778        array_push($css, "{combine_css path='$f' order=10}");
779      }
780    }
781    $f = 'local/css/rules.css';
782    if (file_exists(PHPWG_ROOT_PATH.$f))
783    {
784      array_push($css, "{combine_css path='$f' order=10}");
785    }
786
787    if (!empty($css))
788    {
789      $source = str_replace("\n{get_combined_css}", "\n".implode( "\n", $css )."\n{get_combined_css}", $source);
790    }
791
792    return $source;
793  }
794
795  function load_themeconf($dir)
796  {
797    global $themeconfs, $conf;
798
799    $dir = realpath($dir);
800    if (!isset($themeconfs[$dir]))
801    {
802      $themeconf = array();
803      include($dir.'/themeconf.inc.php');
804      // Put themeconf in cache
805      $themeconfs[$dir] = $themeconf;
806    }
807    return $themeconfs[$dir];
808  }
809}
810
811
812/**
813 * This class contains basic functions that can be called directly from the
814 * templates in the form $pwg->l10n('edit')
815 */
816class PwgTemplateAdapter
817{
818  function l10n($text)
819  {
820    return l10n($text);
821  }
822
823  function l10n_dec($s, $p, $v)
824  {
825    return l10n_dec($s, $p, $v);
826  }
827
828  function sprintf()
829  {
830    $args = func_get_args();
831    return call_user_func_array('sprintf',  $args );
832  }
833}
834
835
836final class Script
837{
838  public $id;
839  public $load_mode;
840  public $precedents = array();
841  public $path;
842  public $version;
843  public $extra = array();
844
845  function Script($load_mode, $id, $path, $version, $precedents)
846  {
847    $this->id = $id;
848    $this->load_mode = $load_mode;
849    $this->id = $id;
850    $this->set_path($path);
851    $this->version = $version;
852    $this->precedents = $precedents;
853  }
854
855  function set_path($path)
856  {
857    if (!empty($path))
858      $this->path = $path;
859  }
860
861  function is_remote()
862  {
863    return url_is_remote( $this->path );
864  }
865}
866
867
868/** Manage a list of required scripts for a page, by optimizing their loading location (head, bottom, async)
869and later on by combining them in a unique file respecting at the same time dependencies.*/
870class ScriptLoader
871{
872  private $registered_scripts;
873  public $inline_scripts;
874
875  private $did_head;
876  private $head_done_scripts;
877
878  private static $known_paths = array(
879      'core.scripts' => 'themes/default/js/scripts.js',
880      'jquery' => 'themes/default/js/jquery.min.js',
881      'jquery.ui' => 'themes/default/js/ui/packed/ui.core.packed.js'
882    );
883
884  function __construct()
885  {
886    $this->clear();
887  }
888
889  function clear()
890  {
891    $this->registered_scripts = array();
892    $this->inline_scripts = array();
893    $this->head_done_scripts = array();
894    $this->did_head = false;
895  }
896
897  function add_inline($code, $require)
898  {
899    if(!empty($require))
900    {
901      if(!isset($this->registered_scripts[$require]))
902        fatal_error("inline script not found require $require");
903      $s = $this->registered_scripts[$require];
904      if($s->load_mode==2)
905        $s->load_mode=1; // until now the implementation does not allow executing inline script depending on another async script
906    }
907    $this->inline_scripts[] = $code;
908  }
909
910  function add($id, $load_mode, $require, $path, $version=0)
911  {
912    if ($this->did_head && $load_mode==0 )
913    {
914      trigger_error("Attempt to add a new script $id but the head has been written", E_USER_WARNING);
915    }
916    if (! isset( $this->registered_scripts[$id] ) )
917    {
918      $script = new Script($load_mode, $id, $path, $version, $require);
919      self::fill_well_known($id, $script);
920      $this->registered_scripts[$id] = $script;
921    }
922    else
923    {
924      $script = & $this->registered_scripts[$id];
925      if (count($require))
926      {
927        $script->precedents = array_unique( array_merge($script->precedents, $require) );
928      }
929      $script->set_path($path);
930      if ($version && version_compare($script->version, $version)<0 )
931        $script->version = $version;
932      if ($load_mode < $script->load_mode)
933        $script->load_mode = $load_mode;
934    }
935  }
936
937  function did_head()
938  {
939    return $this->did_head;
940  }
941
942  function get_head_scripts()
943  {
944    self::check_load_dep($this->registered_scripts);
945    foreach( array_keys($this->registered_scripts) as $id )
946    {
947      $this->compute_script_topological_order($id);
948    }
949
950    uasort($this->registered_scripts, array('ScriptLoader', 'cmp_by_mode_and_order'));
951
952    foreach( $this->registered_scripts as $id => $script)
953    {
954      if ($script->load_mode > 0)
955        break;
956      if ( !empty($script->path) )
957        $this->head_done_scripts[$id] = $script;
958      else
959        trigger_error("Script $id has an undefined path", E_USER_WARNING);
960    }
961    $this->did_head = true;
962    return self::do_combine($this->head_done_scripts, 0);
963  }
964
965  function get_footer_scripts()
966  {
967    /*if (!$this->did_head)
968    {
969      trigger_error("Attempt to write footer scripts without header scripts", E_USER_ERROR );
970    }*/
971    $todo = array();
972    foreach( $this->registered_scripts as $id => $script)
973    {
974      if (!isset($this->head_done_scripts[$id]))
975      {
976        $todo[$id] = $script;
977      }
978    }
979    foreach( array_keys($todo) as $id )
980    {
981      $this->compute_script_topological_order($id);
982    }
983
984    uasort($todo, array('ScriptLoader', 'cmp_by_mode_and_order'));
985
986    $result = array( array(), array() );
987    foreach( $todo as $id => $script)
988    {
989      $result[$script->load_mode-1][$id] = $script;
990    }
991    return array( self::do_combine($result[0],1), self::do_combine($result[1],2) );
992  }
993
994        private static function do_combine($scripts, $load_mode)
995        {
996                global $conf;
997                if (count($scripts)<2 or !$conf['template_combine_files'])
998                        return $scripts;
999                $combiner = new FileCombiner('js');
1000                foreach ($scripts as $script)
1001                {
1002                        if ($script->is_remote()) fatal_error("NOT IMPLEMENTED");// TODO - we cannot combine remote scripts
1003                        $combiner->add( $script->path, $script->version );
1004                }
1005                if ( $combiner->combine( $out_file, $out_version) )
1006                {
1007                        return array( 'combi' => new Script($load_mode, 'combi', $out_file, $out_version, array() ) );
1008                }
1009                return null;
1010        }
1011       
1012        // checks that if B depends on A, then B->load_mode >= A->load_mode in order to respect execution order
1013  private static function check_load_dep($scripts)
1014  {
1015                global $conf;
1016    do
1017    {
1018      $changed = false;
1019      foreach( $scripts as $id => $script)
1020      {
1021        $load = $script->load_mode;
1022        if ($load==0)
1023          continue;
1024        foreach( $script->precedents as $precedent)
1025        {
1026          if ( !isset($scripts[$precedent] ) )
1027            continue;
1028          if ( $scripts[$precedent]->load_mode > $load )
1029          {
1030            $scripts[$precedent]->load_mode = $load;
1031            $changed = true;
1032          }
1033          if ($load==2 && $scripts[$precedent]->load_mode==2 && ($script->is_remote() or !$conf['template_combine_files']) )
1034          {// we are async -> a predecessor cannot be async unlesss it can be merged; otherwise script execution order is not guaranteed
1035            $scripts[$precedent]->load_mode = 1;
1036            $changed = true;
1037          }
1038        }
1039      }
1040    }
1041    while ($changed);
1042  }
1043
1044
1045  private static function fill_well_known($id, $script)
1046  {
1047    if ( empty($script->path) && isset(self::$known_paths[$id]))
1048    {
1049      $script->path = self::$known_paths[$id];
1050    }
1051    if ( strncmp($id, 'jquery.', 7)==0 )
1052    {
1053      if ( !in_array('jquery', $script->precedents ) )
1054        $script->precedents[] = 'jquery';
1055      if ( strncmp($id, 'jquery.ui.', 10)==0 && !in_array('jquery.ui', $script->precedents ) )
1056        $script->precedents[] = 'jquery.ui';
1057    }
1058  }
1059
1060  private function compute_script_topological_order($script_id)
1061  {
1062    if (!isset($this->registered_scripts[$script_id]))
1063    {
1064      trigger_error("Undefined script $script_id is required by someone", E_USER_WARNING);
1065      return 0;
1066    }
1067    $script = & $this->registered_scripts[$script_id];
1068    if (isset($script->extra['order']))
1069      return $script->extra['order'];
1070    if (count($script->precedents) == 0)
1071      return ($script->extra['order'] = 0);
1072    $max = 0;
1073    foreach( $script->precedents as $precedent)
1074      $max = max($max, $this->compute_script_topological_order($precedent) );
1075    $max++;
1076    return ($script->extra['order'] = $max);
1077  }
1078
1079  private static function cmp_by_mode_and_order($s1, $s2)
1080  {
1081    $ret = $s1->load_mode - $s2->load_mode;
1082    if ($ret) return $ret;
1083
1084    $ret = $s1->extra['order'] - $s2->extra['order'];
1085    if ($ret) return $ret;
1086
1087    if ($s1->extra['order']==0 and ($s1->is_remote() xor $s2->is_remote()) )
1088    {
1089      return $s1->is_remote() ? -1 : 1;
1090    }
1091    return strcmp($s1->id,$s2->id);
1092  }
1093}
1094
1095
1096/*Allows merging of javascript and css files into a single one.*/
1097final class FileCombiner
1098{
1099  const OUT_SUB_DIR = 'local/combined/';
1100  private $type; // js or css
1101  private $files = array();
1102  private $versions = array();
1103
1104  function FileCombiner($type)
1105  {
1106    $this->type = $type;
1107  }
1108
1109  static function clear_combined_files()
1110  {
1111    $dir = opendir(PHPWG_ROOT_PATH.self::OUT_SUB_DIR);
1112    while ($file = readdir($dir))
1113    {
1114      if ( get_extension($file)=='js' || get_extension($file)=='css')
1115        unlink(PHPWG_ROOT_PATH.self::OUT_SUB_DIR.$file);
1116    }
1117    closedir($dir);
1118  }
1119
1120  function add($file, $version)
1121  {
1122    $this->files[] = $file;
1123    $this->versions[] = $version;
1124  }
1125
1126  function clear()
1127  {
1128    $this->files = array();
1129    $this->versions = array();
1130  }
1131
1132  function combine(&$out_file, &$out_version)
1133  {
1134    if (count($this->files) == 0)
1135    {
1136      return false;
1137    }
1138    if (count($this->files) == 1)
1139    {
1140      $out_file = $this->files[0];
1141      $out_version = $this->versions[0];
1142      $this->clear();
1143      return 1;
1144    }
1145
1146    $is_css = $this->type == "css";
1147    global $conf;
1148    $key = array();
1149    if ($is_css) 
1150      $key[] = get_absolute_root_url(false);//because we modify bg url
1151    for ($i=0; $i<count($this->files); $i++)
1152    {
1153      $key[] = $this->files[$i];
1154      $key[] = $this->versions[$i];
1155      if ($conf['template_compile_check']) $key[] = filemtime( PHPWG_ROOT_PATH . $this->files[$i] );
1156    }
1157    $key = join('>', $key);
1158
1159    $file = base_convert(crc32($key),10,36);
1160    $file = self::OUT_SUB_DIR . $file . '.' . $this->type;
1161   
1162    $exists = file_exists( PHPWG_ROOT_PATH . $file );
1163    if ($exists)
1164    {
1165      $is_reload =
1166        (isset($_SERVER['HTTP_CACHE_CONTROL']) && strpos($_SERVER['HTTP_CACHE_CONTROL'], 'max-age=0') !== false)
1167        || (isset($_SERVER['HTTP_PRAGMA']) && strpos($_SERVER['HTTP_PRAGMA'], 'no-cache'));
1168      if ($is_reload)
1169      {// the user pressed F5 in the browser
1170        if ($is_css || $conf['template_compile_check']==false)
1171          $exists = false; // we foce regeneration of css because @import sub-files are never checked for modification
1172      }
1173    }
1174
1175    if ($exists)
1176    {
1177      $out_file = $file;
1178      $out_version = false;
1179      $this->clear();
1180      return 2;
1181    }
1182
1183    $output = '';
1184    $output .= "/* ".count($this->files)."\n".join("\n", $this->files)."*/\n";
1185    foreach ($this->files as $input_file)
1186    {
1187      $output .= "/* BEGIN $input_file */\n";
1188      if ($is_css)
1189        $output .= self::process_css($input_file);
1190      else
1191        $output .= self::process_js($input_file);
1192      $output .= "\n";
1193    }
1194
1195    file_put_contents( PHPWG_ROOT_PATH . $file,  $output );
1196    $out_file = $file;
1197    $out_version = false;
1198    $this->clear();
1199    return 2;
1200  }
1201
1202  private static function process_js($file)
1203  {
1204    $js = file_get_contents(PHPWG_ROOT_PATH . $file);
1205    if (strpos($file, '.min')===false and strpos($file, '.packed')===false )
1206    {
1207      //TODO minify javascript with some php lib from www...
1208    }
1209    return $js;
1210  }
1211 
1212  private static function process_css($file)
1213  {
1214    static $PATTERN = "#url\(\s*['|\"]{0,1}(.*?)['|\"]{0,1}\s*\)#";
1215    $css = file_get_contents(PHPWG_ROOT_PATH . $file);
1216    if (preg_match_all($PATTERN, $css, $matches, PREG_SET_ORDER))
1217    {
1218      $search = $replace = array();
1219      foreach ($matches as $match)
1220      {
1221        if ( !url_is_remote($match[1]) || $match[1][0] != '/')
1222        {
1223          $relative = dirname($file) . "/$match[1]";
1224          $search[] = $match[0];
1225          $replace[] = "url('" . get_absolute_root_url(false) . $relative . "')";
1226        }
1227      }
1228      $css = str_replace($search, $replace, $css);
1229    }
1230
1231    $imports = preg_match_all("#@import\s*['|\"]{0,1}(.*?)['|\"]{0,1};#", $css, $matches, PREG_SET_ORDER);
1232    if ($imports)
1233    {
1234      $search = $replace = array();
1235      foreach ($matches as $match)
1236      {
1237        $search[] = $match[0];
1238        $replace[] = self::process_css(dirname($file) . "/$match[1]");
1239      }
1240      $css = str_replace($search, $replace, $css);
1241    }
1242    return $css;
1243  }
1244}
1245
1246?>
Note: See TracBrowser for help on using the repository browser.