3 # Copyright (C) 2008,2009 Joshua Grams <josh@qualdan.com>
5 # This program is free software: you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation, either version 3 of the License, or
8 # (at your option) any later version.
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with this program. If not, see <http://www.gnu.org/licenses/>.
19 # This is a simple template-handling system. You pass it a big data
20 # structure with key/value pairs, and a template string to fill out.
22 # Within a template, it recognizes tags of the form ~name [arg...]~,
23 # optionally wrapped in HTML comments (which will be removed along with
24 # the tag markers when the template is filled out).
26 # { and } as the final argument mark those tags as being the start and
27 # end of a sub-template (for optional or repeated sections). All other
28 # tags represent slots to be directly filled by data values. On a }
29 # tag, the name is optional, but must match the corresponding { tag if
32 # For a value tag, arguments represent encodings to be applied
33 # successively. For instance, ~foo html~ will encode it to be safe in
34 # HTML ('&' to '&', '<' to '<', and so on).
36 # { tags can take one argument, which will call the corresponding
37 # tem_auto_* function to munge the data, automating certain common use
38 # cases. See the comments on the tem_auto functions for more details.
40 require_once('code/wfpl/encode.php');
41 require_once('code/wfpl/file.php');
42 require_once('code/wfpl/misc.php');
48 function template($template, $data) {
49 return fill_template(parse_template($template), $data);
52 function template_file($filename, $data) {
53 return fill_template(parse_template_file($filename), $data);
56 function &parse_template_file($filename) {
57 return parse_template(file_get_contents($filename));
60 # We parse the template string into a tree of strings and sub-templates.
61 # A template is a hash with a name string, a pieces array, and possibly
64 function &parse_template($string) {
66 $tem['pieces'] = array();
67 $matches = preg_split('/(<!--)?(~[^~]*~)(?(1)-->)/', preg_replace('/<!--(~[^~]*~)-->/', '$1', $string), -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY);
68 foreach($matches as $match) {
69 if($match == '~~') $match = '~';
70 if(substr($match,0,1) == '~' and strlen($match) > 2) {
71 $args = explode(' ', substr($match,1,-1));
73 if(count($args) == 1 and $args[0] == '}') $name = '';
74 else $name = array_shift($args);
76 if(last($args) == '{') { # open block
77 array_pop($args); # drop '{'
78 $tem =& tem_push($tem); # create a new sub-template
79 $tem['parent']['pieces'][] =& $tem; # as a piece of the parent
81 $tem['pieces'] = array();
83 } elseif(last($args) == '}') { # close block
84 array_pop($args); # drop '}'
86 if($name && $name != $cur) {
87 die("Invalid template: tried to close '$name', but '$cur' is current.");
89 $tem =& $tem['parent'];
91 $tem['pieces'][] = array('name' => $name, 'args' => $args);
93 } else { # static string
94 $tem['pieces'][] = $match;
100 function fill_template($template, &$data, &$context = NULL) {
101 $context =& tem_push($context);
102 $context['data'] =& $data;
104 foreach($template['pieces'] as $tem) {
105 if(is_string($tem)) $output .= $tem;
106 elseif($tem['pieces']) { # sub-template
107 $rows =& tem_row_data($tem, $context);
108 $context['rows'] =& $rows;
109 foreach($rows as $key => &$row) {
110 $context['cur'] = $key;
111 $output .= fill_template($tem, $row, $context);
114 $output .= tem_encoded_data($tem, $context);
117 $context =& $context['parent'];
126 # To track our position in the template and in the data, we use a linked
127 # stack structure. Each node is a hash with a reference to the parent
128 # node along with whatever other data you want to add. For each stack,
129 # you simply keep a variable with a reference to the top element. Then
130 # the push and pop operations are:
132 # $top =& tem_push($top);
133 # $top =& $top['parent'];
135 function &tem_push(&$stack = NULL) {
136 static $refs = array();
138 # Since a PHP reference is *not* a pointer to data, but a pointer to
139 # a variable (or array slot), we *have* to first put the new node in
140 # $refs, and then reference it from $new.
143 $new =& $refs[count($refs)-1];
144 if($stack) $new['parent'] =& $stack;
148 # To fill out a template, we do a depth-first traversal of the template
149 # tree, replacing all tags with the data values.
151 # The data starts out as a nested set of key/value pairs, where the
154 # a string to fill a value slot
155 # a hash to fill one instance of a sub-template
156 # an array of hashes to fill multiple instances of a sub-template
158 # The middle form will be converted to the last form as we use it.
160 function tem_data_as_rows($value) {
161 if(is_array($value)) {
162 # numeric keys, is already array of arrays -- expand sub-template for each.
163 if(array_key_exists(0, $value)) return $value;
164 # key/value pairs -- expand sub-template once.
165 else return array($value);
166 } elseif($value || $value === 0 || $value === '0' || $value === '') {
167 # value -- expand sub-template once using only parent values
168 return array(array());
170 # empty value -- don't expand sub-template
175 # To look up a key, we check each namespace (starting with the
176 # innermost one) until a value is found.
178 function tem_data_scope($key, $context) {
179 static $refs = array();
183 if(array_key_exists($key, $scope['data'])) {
186 } while($scope = $scope['parent']);
188 # not found; return empty scope.
191 $ret['parent'] =& $context;
192 $ret['data'] =& last($refs);
196 function tem_get_data($key, $context) {
197 $scope = tem_data_scope($key, $context);
198 if($scope) return $scope['data'][$key];
201 # Return the value for a tag as a set of rows to fill a sub-template.
202 # If $tag has an arg, call the tem_auto function to munge the data.
203 function &tem_row_data($tem, $context)
206 $scope = tem_data_scope($key, $context);
208 if(count($tem['args'])) {
209 $auto_func = "tem_auto_" . $tem['args'][0];
210 function_exists($auto_func)
211 or die("ERROR: template auto function '$auto_func' not found.<br>\n");
213 if($auto_func) $value = $auto_func($scope['data'][$key], $key, $scope);
214 else $value = $scope['data'][$key];
216 $rows = tem_data_as_rows($value);
217 if(is_array($value)) $scope['data'][$key] = $rows;
222 # Return the value for a tag as an encoded string.
223 function tem_encoded_data($tag, $context)
226 $value = tem_get_data($key, $context);
227 foreach($tag['args'] as $encoding) {
228 $func = "enc_$encoding";
229 if(function_exists($func)) $value = $func($value, $key);
230 else die("ERROR: encoder function '$func' not found.<br>\n");
236 function is_sub_template(&$piece) {
237 return is_array($piece) and $piece['pieces'];
240 function is_value_slot(&$piece) {
241 return is_array($piece) and !$piece['pieces'];
244 # Return a hash containing the top-level sub-templates of tem.
245 function top_sub_templates($tem, $is_sub = 'is_sub_template') {
246 function_exists($is_sub) or die("no such function '$is_sub'.");
248 foreach($tem['pieces'] as $piece) {
249 if($is_sub($piece)) {
250 $subs[$piece['name']] = $piece;
256 # merge $subs (sub_templates) into variables in $main (template)
257 function merge_sub_templates(&$main, &$subs) {
258 foreach($main['pieces'] as &$piece) {
259 if(is_array($piece)) { # not just text
260 if($piece['pieces']) {
261 # a sub-template in main
262 merge_sub_templates($piece, $subs);
264 # a value-slot in main
265 $sub = $subs[$piece['name']];
266 if($sub and $sub['args'][0] != 'hide') {
267 $piece = $subs[$piece['name']];
268 $piece['parent'] =& $main;
276 # Replace values in $main with top-level templates from $tem.
277 function merge_templates(&$main, &$tem) {
278 $subs = top_sub_templates($tem);
280 merge_sub_templates($main, $subs);
288 # If a { tag has an argument, the corresponding tem_auto function is called.
289 # This allows it to mangle the data to automate some common cases.
291 # 'sep' (separator) sections will be shown for all but the last parent row.
296 # <!--~separator sep {~--><hr><!--~}~-->
300 function tem_auto_sep(&$value, $key, $context) {
301 $rows =& $context['parent']['parent'];
302 if($rows['cur'] != count($rows['rows'])-1) # last row?
303 return true; # show once
306 # auto-show once, only when this is the first row of the parent
307 function tem_auto_last(&$value, $key, $context) {
308 $rows =& $context['parent']['parent'];
309 if($rows['cur'] == count($rows['rows'])-1) # last row?
310 return true; # show once
313 # auto-show once, only when this is the last row of the parent
314 function tem_auto_first(&$value, $key, $context) {
315 $rows =& $context['parent']['parent'];
316 if($rows['cur'] == 0) # first row?
317 return true; # show once
320 # 'show' sections will be shown unless the corresponding data
322 function tem_auto_show(&$value) {
323 if($value === null) return true;
327 # 'nonempty' sections will not be shown if the corresponding data
328 # value is the empty string
329 function tem_auto_nonempty(&$value) {
330 if($value === '') return null;
334 # 'not' sections will not be shown if the corresponding data
335 # value is not set (opposite of default)
336 function tem_auto_unset(&$value) {
337 if($value === null) {
344 # 'evenodd' sections are given an 'evenodd' attribute whose value
345 # alternates between 'even' and 'odd'.
346 function tem_auto_evenodd(&$values) {
348 if($values) foreach($values as &$value) {
349 $value['evenodd'] = $even ? 'even' : 'odd';
359 # Backward Compatibility
360 # ----------------------
362 function is_shown($piece) {
363 return $piece['args'][0] == 'hide';
366 function is_shown_sub_template($piece) {
367 return is_sub_template($piece) and is_shown($piece);
370 # Old-style templates don't show unless explicitly requested.
371 function tem_auto_hide(&$value, $key, $context) {
372 unset($context['data'][$key]);
376 # The old API is being used with the named sub-template,
377 # so hide it and insert a value slot for its expansion(s).
378 function &tem_is_old_sub($name, &$template) {
379 foreach($template['pieces'] as $key => &$piece) {
380 if(is_sub_template($piece)) {
381 if($piece['name'] == $name) {
382 if(!is_shown($piece)) {
383 # hide template unless explicitly show()n.
384 $piece['args'] = array('hide');
385 # insert a value slot with the same name (for the expansion).
386 $var = array('name' => $name, 'args' => array());
387 array_splice($template['pieces'], $key, 0, array($var));
391 $tem = tem_is_old_sub($name, $piece);
392 if($tem) return $tem;
403 $this->template = array('pieces' => array());
404 $this->data = array();
407 function set($key, $value = true) {
408 $this->data[$key] = $value;
411 function sets($hash) {
412 foreach($hash as $key => $value) {
413 $this->set($key, $value);
417 function append($key, $value) {
418 $this->data[$key] .= $value;
421 function prepend($key, $value) {
422 $this->data[$key] = $value . $this->data[$key];
425 function clear($key) {
426 unset($this->data[$key]);
430 return $this->data[$key];
433 function show($name) {
434 $tem = tem_is_old_sub($name, $this->template);
436 $this->data[$name] .= fill_template($tem, $this->data);
440 function show_separated($name) {
441 if($this->get($name)) {
442 $this->show($name . '_sep');
447 function load_str($str) {
448 $this->template =& parse_template($str);
451 function load($filename) {
452 $this->template =& parse_template_file($filename);
455 function run($tem = false) {
457 if(strlen($tem < 150 && file_exists($tem))) $this->load($tem);
458 else $this->load_str($tem);
461 return fill_template($this->template, $this->data);
464 function output($tem = false) {
465 print($this->run($tem));
468 # merge top-level sub-templates of $tem (object) into $this,
469 # supporting both new and old semantics.
470 function merge($tem) {
471 # append expansions to $this->data (old style)
473 $subs = $tem->top_subs('is_shown_sub_template');
474 if($subs) foreach($subs as $name => $val) {
475 $this->append($name, $val);
476 unset($tem->data[$name]); # so array_merge() won't overwrite things
479 # merge the data arrays and template trees (new style)
480 $this->data = array_merge($this->data, $tem->data);
481 merge_templates($this->template, $tem->template);
485 function merge_file($filename) {
486 $other_tem = new tem();
487 $other_tem->load($filename);
488 $this->merge($other_tem);
491 function top_sub_names($is_sub = 'is_sub_template') {
492 return array_keys(top_sub_templates($this->template, $is_sub));
495 function top_subs($is_sub = 'is_sub_template') {
497 $names = $this->top_sub_names($is_sub);
498 foreach($names as $name) {
499 $ret[$name] = $this->get($name);
504 # old name for show (deprecated)
505 function sub($name) {
510 function tem_init() {
511 if(!$GLOBALS['wfpl_template']) {
512 $GLOBALS['wfpl_template'] = new tem();
516 function tem_append($key, $value) {
518 $GLOBALS['wfpl_template']->append($key, $value);
521 function tem_prepend($key, $value) {
523 $GLOBALS['wfpl_template']->prepend($key, $value);
526 function tem_set($key, $value = true) {
528 $GLOBALS['wfpl_template']->set($key, $value);
531 function tem_sets($hash) {
533 $GLOBALS['wfpl_template']->sets($hash);
536 function tem_get($key) {
538 return $GLOBALS['wfpl_template']->get($key);
541 function tem_run($tem = false) {
543 return $GLOBALS['wfpl_template']->run($tem);
546 function tem_show($name) {
548 return $GLOBALS['wfpl_template']->show($name);
551 function tem_show_separated($name) {
553 $GLOBALS['wfpl_template']->show_separated($name);
556 function tem_load($filename) {
558 $GLOBALS['wfpl_template']->load($filename);
561 function tem_merge($tem) {
563 $GLOBALS['wfpl_template']->merge($tem);
566 function tem_merge_file($filename) {
568 $GLOBALS['wfpl_template']->merge_file($filename);
571 function tem_output($filename = false) {
573 $GLOBALS['wfpl_template']->output($filename);
576 function tem_top_subs() {
578 return $GLOBALS['wfpl_template']->top_subs();
581 function tem_top_sub_names() {
583 return $GLOBALS['wfpl_template']->top_sub_names();
586 function tem_load_new($filename) {
587 $old = $GLOBALS['wfpl_template'];
588 $GLOBALS['wfpl_template'] = new tem();
589 $GLOBALS['wfpl_template']->load($filename);
593 # deprecated (old name for show)
594 function tem_sub($name) {