JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
* template.php: compatibility API, mods to auto functions.
[wfpl.git] / template.php
1 <?php
2
3 #  Copyright (C) 2008,2009 Joshua Grams <josh@qualdan.com>
4 #
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.
9 #  
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.
14 #  
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/>.
17
18
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.
21 #
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).
25 #
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 
30 # present.
31 #
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 '&amp;', '<' to '&lt;', and so on).
35 #
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.
39
40 require_once('code/wfpl/encode.php');
41 require_once('code/wfpl/file.php');
42 require_once('code/wfpl/misc.php');
43
44
45 # Top-Level Functions
46 # -------------------
47
48 function template($template, $data) {
49         return fill_template(parse_template($template), $data);
50 }
51
52 function template_file($filename, $data) {
53         return fill_template(parse_template_file($filename), $data);
54 }
55
56 function parse_template_file($filename) {
57         return parse_template(file_get_contents($filename));
58 }
59
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 
62 # an args array.
63
64 function parse_template($string) {
65         $tem =& tem_push();
66         $tem['pieces'] = array();
67         # note: for some reason this captures '<!--' but not '-->'.
68         $matches = preg_split("/(<!--)?(~[^~]*~)(?(1)-->)/", $string, -1, PREG_SPLIT_DELIM_CAPTURE);
69         foreach($matches as $match) {
70                 if($match == '~~') $match = '~';
71                 if(substr($match,0,1) == '~' and strlen($match) > 2) {
72                         $args = explode(' ', substr($match,1,-1));
73
74                         if(count($args) == 1 and $args[0] == '}') $name = '';
75                         else $name = array_shift($args);
76
77                         if(last($args) == '{') {  # open block
78                                 array_pop($args);  # drop '{'
79                                 $tem =& tem_push($tem);              # create a new sub-template
80                                 $tem['parent']['pieces'][] =& $tem;  # as a piece of the parent
81                                 $tem['name'] = $name;
82                                 $tem['pieces'] = array();
83                                 $tem['args'] = $args;
84                         } elseif(last($args) == '}') {  # close block
85                                 array_pop($args);  # drop '}'
86                                 $cur = $tem['name'];
87                                 if($name && $name != $cur) {
88                                         die("Invalid template: tried to close '$name', but '$cur' is current.");
89                                 }
90                                 $tem =& $tem['parent'];
91                         } else {  # value slot
92                                 $tem['pieces'][] = array('name' => $name, 'args' => $args);
93                         }
94                 } elseif($match and $match != '<!--') {  # static string
95                         $tem['pieces'][] = $match;
96                 }
97         }
98         return $tem;
99 }
100
101 function fill_template($template, &$data, &$context = NULL) {
102         $context =& tem_push($context);
103         $context['data'] =& $data;
104
105         foreach($template['pieces'] as $tem) {
106                 if(is_string($tem)) $output .= $tem;
107                 elseif($tem['pieces']) {  # sub-template
108                         $rows =& tem_row_data($tem, $context);
109                         $context['rows'] =& $rows;
110                         foreach($rows as $key => &$row) {
111                                 $context['cur'] = $key;
112                                 $output .= fill_template($tem, $row, $context);
113                         }
114                 } else {  # variable
115                         $output .= tem_encoded_data($tem, $context);
116                 }
117         }
118         $context =& $context['parent'];
119         return $output;
120 }
121
122
123 # Implementation
124 # --------------
125
126
127 # To track our position in the template and in the data, we use a linked 
128 # stack structure.  Each node is a hash with a reference to the parent 
129 # node along with whatever other data you want to add.  For each stack, 
130 # you simply keep a variable with a reference to the top element.  Then 
131 # the push and pop operations are:
132
133 # $top =& tem_push($top);
134 # $top =& $top['parent'];
135
136 function &tem_push(&$stack = NULL) {
137         static $refs = array();
138
139         # Since a PHP reference is *not* a pointer to data, but a pointer to 
140         # a variable (or array slot), we *have* to first put the new node in
141         # $refs, and then reference it from $new.
142
143         $refs[] = array();
144         $new =& $refs[count($refs)-1];
145         if($stack) $new['parent'] =& $stack;
146         return $new;
147 }
148
149 # To fill out a template, we do a depth-first traversal of the template 
150 # tree, replacing all tags with the data values.
151
152 # The data starts out as a nested set of key/value pairs, where the 
153 # values can be:
154
155         # a string to fill a value slot
156         # a hash to fill one instance of a sub-template
157         # an array of hashes to fill multiple instances of a sub-template
158
159 # The middle form will be converted to the last form as we use it.
160
161 function tem_data_as_rows($value) {
162         if(is_array($value)) {
163                 # numeric keys, is already array of arrays -- expand sub-template for each.
164                 if(array_key_exists(0, $value)) return $value;
165                 # key/value pairs -- expand sub-template once.
166                 else return array($value);
167         } elseif($value) {
168                 # value -- expand sub-template once using only parent values
169                 return array(array());
170         } else {
171                 # empty value -- don't expand sub-template
172                 return array();
173         }
174 }
175
176 # To look up a key, we check each namespace (starting with the
177 # innermost one) until a value is found.
178
179 function tem_data_scope($key, $context) {
180         static $refs = array();
181
182         $scope = $context;
183         do{
184                 if(array_key_exists($key, $scope['data'])) {
185                         return $scope;
186                 }
187         } while($scope = $scope['parent']);
188
189         # not found; return empty scope.
190         $refs[] = array();
191         $ret = array();
192         $ret['parent'] =& $context;
193         $ret['data'] =& last($refs);
194         return $ret;
195 }
196
197 function tem_get_data($key, $context) {
198         $scope = tem_data_scope($key, $context);
199         if($scope) return $scope['data'][$key];
200 }
201
202 # Return the value for a tag as a set of rows to fill a sub-template.
203 # If $tag has an arg, call the tem_auto function to munge the data.
204 function &tem_row_data($tem, $context)
205 {
206         $key = $tem['name'];
207         $scope = tem_data_scope($key, $context);
208
209         if(count($tem['args'])) {
210                 $auto_func = "tem_auto_" . $tem['args'][0];
211                 function_exists($auto_func)
212                         or die("ERROR: template auto function '$auto_func' not found.<br>\n");
213         }
214         if($auto_func) $value = $auto_func($scope['data'][$key], $key, $scope);
215         else $value = $scope['data'][$key];
216
217         $rows = tem_data_as_rows($value);
218         if(is_array($value)) $scope['data'][$key] = $rows;
219
220         return $rows;
221 }
222
223 # Return the value for a tag as an encoded string.
224 function tem_encoded_data($tag, $context)
225 {
226         $key = $tag['name'];
227         $value = tem_get_data($key, $context);
228         foreach($tag['args'] as $encoding) {
229                 $func = "enc_$encoding";
230                 if(function_exists($func)) $value = $func($value, $key);
231                 else die("ERROR: encoder function '$func' not found.<br>\n");
232         }
233         return $value;
234 }
235
236
237
238 # Return a hash containing the top-level sub-templates of tem.
239 function top_sub_templates($tem) {
240         $subs = array();
241         foreach($tem['pieces'] as $piece) {
242                 if(is_array($piece) and $piece['pieces']) {
243                         $subs[$piece['name']] = $piece;
244                 }
245         }
246         return $subs;
247 }
248
249 # Replace top-level values in $main with top-level templates from $tem.
250 function merge_templates($main, $tem) {
251         $out = array('name' => $main['name'], 'pieces' => array());
252
253         $subs = top_sub_templates($tem);
254
255         foreach($main['pieces'] as $piece) {
256                 if(is_array($piece) and !$piece['pieces'] and $subs[$piece['name']]) {
257                         $piece = $subs[$piece['name']];
258                 }
259                 $out['pieces'][] = $piece;
260         }
261         return $out;
262 }
263
264
265
266 # tem_auto functions
267 # ------------------
268 #
269 # If a { tag has an argument, the corresponding tem_auto function is called.
270 # This allows it to mangle the data to automate some common cases.
271
272 # 'sep' (separator) sections will be shown for all but the last parent row.
273 # Sample usage:
274 #       <!--~rows {~-->
275 #               <!--~row {~-->
276 #                       row content...
277 #                       <!--~separator sep {~--><hr><!--~}"-->
278 #               <!--~}~-->
279 #       <!--~}~-->
280 #
281 function tem_auto_sep(&$value, $key, $context) {
282         $rows =& $context['parent']['parent'];
283         if($rows['cur'] != count($rows['rows'])-1)  # last row?
284                 return $value = true;  # show once
285 }
286
287 # 'show' sections will be shown unless the corresponding data value
288 # is false.  We check only for false; 0 or '' will not work.
289
290 function tem_auto_show(&$value) {
291         if($value !== false) $value = array(array());
292         return $value;
293 }
294
295 # 'evenodd' sections are given an 'evenodd' attribute whose value
296 # alternates between 'even' and 'odd'.
297
298 function tem_auto_evenodd(&$values) {
299         $even = false;
300         foreach($values as &$value) {
301                 $value['evenodd'] = $even ? 'even' : 'odd';
302                 $even = !$even;
303         }
304         return $values;
305 }
306
307
308
309
310
311 # Backward Compatibility
312 # ----------------------
313
314 # Old-style templates don't show unless explicitly requested.
315 function tem_auto_hide(&$value, $key, $context) {
316         unset($context['data'][$key]);
317         return false;
318 }
319
320 # The old API is being used with the named sub-template,
321 # so hide it and insert a value slot for its expansion(s).
322 function &tem_is_old_sub($name, &$template) {
323         foreach($template['pieces'] as $key => &$piece) {
324                 if(is_array($piece) and $piece['pieces']) {
325                         if($piece['name'] == $name) {
326                                 if($piece['args'][0] != 'hide') {  # if we haven't already
327                                         $piece['args'] = array('hide');
328                                         $var = array('name' => $name, 'args' => array());
329                                         array_splice($template['pieces'], $key, 0, array($var));
330                                 }
331                                 return $piece;
332                         }
333                         $tem = tem_old_sub($name, $piece);
334                         if($tem) return $tem;
335                 }
336         }
337 }
338
339 class tem {
340         var $template;
341         var $data; 
342
343         function tem() {
344                 $this->template = array();
345                 $this->data = array();
346         }
347         
348         function set($key, $value) {
349                 $this->data[$key] = $value;
350         }
351
352         function append($key, $value) {
353                 $this->data[$key] .= $value;
354         }
355
356         function prepend($key, $value) {
357                 $this->data[$key] = $value . $this->data[$key];
358         }
359
360         function clear($key) {
361                 unset($this->data[$key]);
362         }
363
364         function get($key) {
365                 return $this->data[$key];
366         }
367
368         function show($name) {
369                 $tem = tem_is_old_sub($name, $this->template);
370                 $this->data[$name] .= fill_template($tem, $this->data);
371         }
372
373         function show_separated($name) {
374                 if($this->get($name)) {
375                         $this->show($name . '_sep');
376                 }
377                 $this->show($name);
378         }
379
380         function load_str($str) {
381                 $this->template = parse_template($str);
382         }
383
384         function load($filename) {
385                 $this->template = parse_template_file($filename);
386         }
387
388         function run($tem = false) {
389                 if($tem) {
390                         if(strlen($tem < 150 && file_exists($tem))) $this->load($tem);
391                         else $this->load_str($tem);
392                 }
393
394                 return fill_template($this->template, $this->data);
395         }
396
397         function output($tem = false) {
398                 print($this->run($tem));
399         }
400
401         function top_sub_names() {
402                 return array_keys(top_sub_templates($this->template));
403         }
404
405         function top_subs() {
406                 $ret = array();
407                 $names = $this->top_sub_names();
408                 foreach($names as $name) {
409                         $ret[$name] = $this->get($name);
410                 }
411                 return $ret;
412         }
413
414         # old name for show (deprecated)
415         function sub($name) {
416                 $this->show($name);
417         }
418 }
419
420 function tem_init() {
421         if(!$GLOBALS['wfpl_template']) {
422                 $GLOBALS['wfpl_template'] = new tem();
423         }
424 }
425
426 function tem_append($key, $value) {
427         tem_init();
428         $GLOBALS['wfpl_template']->append($key, $value);
429 }
430
431 function tem_prepend($key, $value) {
432         tem_init();
433         $GLOBALS['wfpl_template']->prepend($key, $value);
434 }
435
436 function tem_set($key, $value) {
437         tem_init();
438         $GLOBALS['wfpl_template']->set($key, $value);
439 }
440
441 function tem_get($key) {
442         tem_init();
443         return $GLOBALS['wfpl_template']->get($key);
444 }
445
446 function tem_run($tem = false) {
447         tem_init();
448         return $GLOBALS['wfpl_template']->run($tem);
449 }
450
451 function tem_show($name) {
452         tem_init();
453         return $GLOBALS['wfpl_template']->show($name);
454 }
455
456 function tem_show_separated($name) {
457         tem_init();
458         $GLOBALS['wfpl_template']->show_separated($name);
459 }
460
461 function tem_load($filename) {
462         tem_init();
463         $GLOBALS['wfpl_template']->load($filename);
464 }
465
466 function tem_output($filename = false) {
467         tem_init();
468         $GLOBALS['wfpl_template']->output($filename);
469 }
470
471 function tem_top_subs() {
472         tem_init();
473         return $GLOBALS['wfpl_template']->top_subs();
474 }
475
476 function tem_top_sub_names() {
477         tem_init();
478         return $GLOBALS['wfpl_template']->top_sub_names();
479 }
480
481 function tem_load_new($filename) {
482         $old = $GLOBALS['wfpl_template'];
483         $GLOBALS['wfpl_template'] = new tem();
484         $GLOBALS['wfpl_template']->load($filename);
485         return $old;
486 }
487
488 # deprecated (old name for show)
489 function tem_sub($name) {
490         tem_show($name);
491 }
492
493 ?>