X-Git-Url: https://jasonwoof.com/gitweb/?a=blobdiff_plain;f=template.php;h=1667cdead3e1c59287a0f422311b3c5b748e406e;hb=dfd0f158f89020b3142e41127d21e48c8512aa1e;hp=ffc83e7c1164d5ed9d72dabf76d949c8867945c8;hpb=0cbe95a89dd1a22bea47fdb602bd401d8386e1b9;p=wfpl.git

diff --git a/template.php b/template.php
index ffc83e7..1667cde 100644
--- a/template.php
+++ b/template.php
@@ -1,224 +1,495 @@
 <?php
 
-#  Copyright (C) 2005 Jason Woofenden
+#  Copyright (C) 2008,2009 Joshua Grams <josh@qualdan.com>
 #
-#  This file is part of wfpl.
+#  This program is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#  
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#  
+#  You should have received a copy of the GNU General Public License
+#  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+
+# This is a simple template-handling system.  You pass it a big data 
+# structure with key/value pairs, and a template string to fill out.
 #
-#  wfpl is free software; you can redistribute it and/or modify it under the
-#  terms of the GNU Lesser General Public License as published by the Free
-#  Software Foundation; either version 2.1 of the License, or (at your option)
-#  any later version.
+# Within a template, it recognizes tags of the form ~name [arg...]~, 
+# optionally wrapped in HTML comments (which will be removed along with 
+# the tag markers when the template is filled out).
 #
-#  wfpl is distributed in the hope that it will be useful, but WITHOUT ANY
-#  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-#  FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for
-#  more details.
+# { and } as the final argument mark those tags as being the start and 
+# end of a sub-template (for optional or repeated sections).  All other 
+# tags represent slots to be directly filled by data values.  On a } 
+# tag, the name is optional, but must match the corresponding { tag if 
+# present.
 #
-#  You should have received a copy of the GNU Lesser General Public License
-#  along with wfpl; if not, write to the Free Software Foundation, Inc., 51
-#  Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+# For a value tag, arguments represent encodings to be applied 
+# successively.  For instance, ~foo html~ will encode it to be safe in 
+# HTML ('&' to '&amp;', '<' to '&lt;', and so on).
+#
+# { tags can take one argument, which will call the corresponding 
+# tem_auto_* function to munge the data, automating certain common use 
+# cases.  See the comments on the tem_auto functions for more details.
 
+require_once('code/wfpl/encode.php');
+require_once('code/wfpl/file.php');
+require_once('code/wfpl/misc.php');
 
-# This file contains generally useful template handling code. It is wrapped in
-# an object so that if you want/need to you can make more than one instance of
-# it and they won't step on each other's toes. Also there are a set of global
-# functions at the bottom so you don't have to mess around with objects if you
-# don't want to. The documentation will be on the object methods, but just know
-# that each has a straight function wrapper at the bottom with 'tem_' prepended
-# to the name.
 
-# This is designed to be as simple as it can be for your project. The simple
-# way to use it is to set some key/value pairs with tem_set() then call
-# tem_output('filename.html') to output the page. A more complex example
-# including the use of sub-templates can be found in tem_test.php
+# Top-Level Functions
+# -------------------
 
-# FIXME: sub-sub templates need to be cleared when the sub template containing
-# them is run
+function template($template, $data) {
+	return fill_template(parse_template($template), $data);
+}
 
-require_once('code/wfpl/encode.php');
-require_once('code/wfpl/misc.php');
-require_once('code/wfpl/file.php');
+function template_file($filename, $data) {
+	return fill_template(parse_template_file($filename), $data);
+}
 
-class tem {
-	var $keyval;        # an array containing key/value pairs 
-	var $filename;      # template filename (sometimes not set)
-	var $template;      # contents of template
-	var $sub_templates; # tag-name/template-string pairs
-	var $sub_subs;      # key: sub-template name  value: array of names of the sub-templates of this one
+function parse_template_file($filename) {
+	return parse_template(file_get_contents($filename));
+}
 
-	# initialize variables
-	function tem() {
-		$this->keyval = array('' => '~'); # so that ~~ in the template creates a single ~
-		$this->sub_templates = array();
+# We parse the template string into a tree of strings and sub-templates.  
+# A template is a hash with a name string, a pieces array, and possibly 
+# an args array.
+
+function parse_template($string) {
+	$tem =& tem_push();
+	$tem['pieces'] = array();
+	# note: for some reason this captures '<!--' but not '-->'.
+	$matches = preg_split("/(<!--)?(~[^~]*~)(?(1)-->)/", $string, -1, PREG_SPLIT_DELIM_CAPTURE);
+	foreach($matches as $match) {
+		if($match == '~~') $match = '~';
+		if(substr($match,0,1) == '~' and strlen($match) > 2) {
+			$args = explode(' ', substr($match,1,-1));
+
+			if(count($args) == 1 and $args[0] == '}') $name = '';
+			else $name = array_shift($args);
+
+			if(last($args) == '{') {  # open block
+				array_pop($args);  # drop '{'
+				$tem =& tem_push($tem);              # create a new sub-template
+				$tem['parent']['pieces'][] =& $tem;  # as a piece of the parent
+				$tem['name'] = $name;
+				$tem['pieces'] = array();
+				$tem['args'] = $args;
+			} elseif(last($args) == '}') {  # close block
+				array_pop($args);  # drop '}'
+				$cur = $tem['name'];
+				if($name && $name != $cur) {
+				   	die("Invalid template: tried to close '$name', but '$cur' is current.");
+				}
+				$tem =& $tem['parent'];
+			} else {  # value slot
+				$tem['pieces'][] = array('name' => $name, 'args' => $args);
+			}
+		} elseif($match and $match != '<!--') {  # static string
+			$tem['pieces'][] = $match;
+		}
 	}
+	return $tem;
+}
 
-	# set a key/value pair. if a ~tag~ in the template matches key it will be replaced by value
-	function set($key, $value) {
-		$this->keyval[$key] = $value;
+function fill_template($template, &$data, &$context = NULL) {
+	$context =& tem_push($context);
+	$context['data'] =& $data;
+
+	foreach($template['pieces'] as $tem) {
+		if(is_string($tem)) $output .= $tem;
+		elseif($tem['pieces']) {  # sub-template
+			$rows =& tem_row_data($tem, $context);
+			$context['rows'] =& $rows;
+			foreach($rows as $key => &$row) {
+				$context['cur'] = $key;
+				$output .= fill_template($tem, $row, $context);
+			}
+		} else {  # variable
+			$output .= tem_encoded_data($tem, $context);
+		}
 	}
+	$context =& $context['parent'];
+	return $output;
+}
 
-	# clear a value. Functionally equivalent to set($key, '') but cleaner and more efficient
-	function clear($key) {
-		unset($this->keyval[$key]);
+
+# Implementation
+# --------------
+
+
+# To track our position in the template and in the data, we use a linked 
+# stack structure.  Each node is a hash with a reference to the parent 
+# node along with whatever other data you want to add.  For each stack, 
+# you simply keep a variable with a reference to the top element.  Then 
+# the push and pop operations are:
+
+# $top =& tem_push($top);
+# $top =& $top['parent'];
+
+function &tem_push(&$stack = NULL) {
+	static $refs = array();
+
+	# Since a PHP reference is *not* a pointer to data, but a pointer to 
+	# a variable (or array slot), we *have* to first put the new node in
+	# $refs, and then reference it from $new.
+
+	$refs[] = array();
+	$new =& $refs[count($refs)-1];
+	if($stack) $new['parent'] =& $stack;
+	return $new;
+}
+
+# To fill out a template, we do a depth-first traversal of the template 
+# tree, replacing all tags with the data values.
+
+# The data starts out as a nested set of key/value pairs, where the 
+# values can be:
+
+	# a string to fill a value slot
+	# a hash to fill one instance of a sub-template
+	# an array of hashes to fill multiple instances of a sub-template
+
+# The middle form will be converted to the last form as we use it.
+
+function tem_data_as_rows($value) {
+	if(is_array($value)) {
+		# numeric keys, is already array of arrays -- expand sub-template for each.
+		if(array_key_exists(0, $value)) return $value;
+		# key/value pairs -- expand sub-template once.
+		else return array($value);
+	} elseif($value) {
+		# value -- expand sub-template once using only parent values
+		return array(array());
+	} else {
+		# empty value -- don't expand sub-template
+		return array();
 	}
+}
 
-	# grab a value you stuck in earlier with set()
-	function get($key) {
-		return $this->keyval[$key];
+# To look up a key, we check each namespace (starting with the
+# innermost one) until a value is found.
+
+function tem_data_scope($key, $context) {
+	static $refs = array();
+
+	$scope = $context;
+	do{
+		if(array_key_exists($key, $scope['data'])) {
+			return $scope;
+		}
+	} while($scope = $scope['parent']);
+
+	# not found; return empty scope.
+	$refs[] = array();
+	$ret = array();
+	$ret['parent'] =& $context;
+	$ret['data'] =& last($refs);
+	return $ret;
+}
+
+function tem_get_data($key, $context) {
+	$scope = tem_data_scope($key, $context);
+	if($scope) return $scope['data'][$key];
+}
+
+# Return the value for a tag as a set of rows to fill a sub-template.
+# If $tag has an arg, call the tem_auto function to munge the data.
+function &tem_row_data($tem, $context)
+{
+	$key = $tem['name'];
+	$scope = tem_data_scope($key, $context);
+
+	if(count($tem['args'])) {
+		$auto_func = "tem_auto_" . $tem['args'][0];
+		function_exists($auto_func)
+		   	or die("ERROR: template auto function '$auto_func' not found.<br>\n");
 	}
+	if($auto_func) $value = $auto_func($scope['data'][$key], $key, $scope);
+	else $value = $scope['data'][$key];
 
-	# run the template engine on one of the sub-templates and append the result
-	# to the keyval in the main array. See tem_test.php for an example of how
-	# this can be used.
-	function sub($sub_template_name) {
-		$this->keyval[$sub_template_name] .= template_run($this->sub_templates[$sub_template_name], $this->keyval);
+	$rows = tem_data_as_rows($value);
+	if(is_array($value)) $scope['data'][$key] = $rows;
 
-		# after running a sub-template, clear its sub-templates
-		if(isset($this->sub_subs[$sub_template_name])) {
-			foreach($this->sub_subs[$sub_template_name] as $sub_sub) {
-				$this->clear($sub_sub);
-			}
+	return $rows;
+}
+
+# Return the value for a tag as an encoded string.
+function tem_encoded_data($tag, $context)
+{
+	$key = $tag['name'];
+	$value = tem_get_data($key, $context);
+	foreach($tag['args'] as $encoding) {
+		$func = "enc_$encoding";
+		if(function_exists($func)) $value = $func($value, $key);
+		else die("ERROR: encoder function '$func' not found.<br>\n");
+	}
+	return $value;
+}
+
+
+function is_sub_template($piece) {
+	return is_array($piece) and $piece['pieces'];
+}
+
+# Return a hash containing the top-level sub-templates of tem.
+function top_sub_templates($tem, $is_sub = 'is_sub_template') {
+	function_exists($is_sub) or die("no such function '$is_sub'.");
+	$subs = array();
+	foreach($tem['pieces'] as $piece) {
+		if($is_sub($piece)) {
+		   	$subs[$piece['name']] = $piece;
 		}
 	}
+	return $subs;
+}
+
+# Replace top-level values in $main with top-level templates from $tem.
+function merge_templates($main, $tem) {
+	$out = array('name' => $main['name'], 'pieces' => array());
+
+	$subs = top_sub_templates($tem);
+
+	foreach($main['pieces'] as $piece) {
+		$sub = $subs[$piece['name']];
+		if(is_array($piece) and !$piece['pieces'] and $sub and $sub['args'][0] != 'hide') {
+			$piece = $subs[$piece['name']];
+		}
+		$out['pieces'][] = $piece;
+	}
+	return $out;
+}
+
+
+
+# tem_auto functions
+# ------------------
+#
+# If a { tag has an argument, the corresponding tem_auto function is called.
+# This allows it to mangle the data to automate some common cases.
+
+# 'sep' (separator) sections will be shown for all but the last parent row.
+# Sample usage:
+# 	<!--~rows {~-->
+# 		<!--~row {~-->
+# 			row content...
+# 			<!--~separator sep {~--><hr><!--~}"-->
+# 		<!--~}~-->
+# 	<!--~}~-->
+#
+function tem_auto_sep(&$value, $key, $context) {
+	$rows =& $context['parent']['parent'];
+	if($rows['cur'] != count($rows['rows'])-1)  # last row?
+	   	return $value = true;  # show once
+}
+
+# 'show' sections will be shown unless the corresponding data value
+# is false.  We check only for false; 0 or '' will not work.
+
+function tem_auto_show(&$value) {
+	if($value !== false) $value = array(array());
+	return $value;
+}
+
+# 'evenodd' sections are given an 'evenodd' attribute whose value
+# alternates between 'even' and 'odd'.
+
+function tem_auto_evenodd(&$values) {
+	$even = false;
+	foreach($values as &$value) {
+		$value['evenodd'] = $even ? 'even' : 'odd';
+		$even = !$even;
+	}
+	return $values;
+}
+
 
-	# this is used by tem::load() and should be otherwise useless
-	function _load(&$in, &$out, &$parents, &$parent) {
-		while($in) {
-			# scan for one of: 1) the begining of a sub-template 2) the end of this one 3) the end of the file
-			$n = strpos($in, '<!--~');
-			if($n === false) { # not found
-				# we hit the end of the file
-				$out .= $in;
-				$in = '';
-				return;
-			}
 
-			# move everything up to (but not including) <!-- to the output
-			$out .= substr($in, 0, $n);
-			$in = substr($in, $n);
 
-			# we found something.
-			# is it an end tag?
-			if(strcmp('<!--~end~-->', substr($in, 0, 12)) == 0) {
-				$in = substr($in, 12);
-				$parent = array_pop($parents);
-				return;
-			}
 
-			$matches = array();
-			# this limits sub_template names to 50 chars
-			if(ereg('^<!--~([^~]*) start~-->', substr($in, 0, 65), $matches)) {
-				list($start_tag, $tag_name) = $matches;
+# Backward Compatibility
+# ----------------------
 
-				# keep track of the tree
-				if(!isset($this->sub_subs[$parent])) {
-					$this->sub_subs[$parent] = array();
+function is_shown($piece) {
+	return $piece['args'][0] == 'hide';
+}
+
+function is_shown_sub_template($piece) {
+	return is_sub_template($piece) and is_shown($piece);
+}
+
+# Old-style templates don't show unless explicitly requested.
+function tem_auto_hide(&$value, $key, $context) {
+	unset($context['data'][$key]);
+	return false;
+}
+
+# The old API is being used with the named sub-template,
+# so hide it and insert a value slot for its expansion(s).
+function &tem_is_old_sub($name, &$template) {
+	foreach($template['pieces'] as $key => &$piece) {
+		if(is_sub_template($piece)) {
+			if($piece['name'] == $name) {
+				if(!is_shown($piece)) {
+					# hide template unless explicitly show()n.
+					$piece['args'] = array('hide');
+					# insert a value slot with the same name (for the expansion).
+					$var = array('name' => $name, 'args' => array());
+					array_splice($template['pieces'], $key, 0, array($var));
 				}
-				array_push($this->sub_subs[$parent], $tag_name);
-				array_push($parents, $parent);
-				$parent = $tag_name;
-
-				$out .= '~' . $tag_name . '~';
-				$in = substr($in, strlen($start_tag));
-				$this->sub_templates[$tag_name] = '';
-				$this->_load($in, $this->sub_templates[$tag_name], $parents, $parent);
-			} else {
-				# it's not a start tag or end tag, so let's pass it through:
-				$out .= substr($in, 0, 5);
-				$in = substr($in, 5);
+				return $piece;
 			}
-		} #repeat
+			$tem = tem_is_old_sub($name, $piece);
+			if($tem) return $tem;
+		}
+	}
+	return false;
+}
+
+class tem {
+	var $template;
+	var $data; 
+
+	function tem() {
+		$this->template = array('pieces' => array());
+		$this->data = array();
+   	}
+	
+	function set($key, $value) {
+		$this->data[$key] = $value;
+	}
+
+	function append($key, $value) {
+		$this->data[$key] .= $value;
+	}
+
+	function prepend($key, $value) {
+		$this->data[$key] = $value . $this->data[$key];
+	}
+
+	function clear($key) {
+		unset($this->data[$key]);
+	}
+
+	function get($key) {
+		return $this->data[$key];
+	}
+
+	function show($name) {
+		$tem = tem_is_old_sub($name, $this->template);
+		if($tem) {
+			$this->data[$name] .= fill_template($tem, $this->data);
+		}
+	}
+
+	function show_separated($name) {
+		if($this->get($name)) {
+			$this->show($name . '_sep');
+		}
+		$this->show($name);
+	}
+
+	function load_str($str) {
+		$this->template = parse_template($str);
 	}
 
-	# This is useful when you have sub-templates that you want to mess with
-	# before the main template is run. But can also be used to simply specify
-	# the filename ahead of time.
 	function load($filename) {
-		$this->filename = $filename;
-		$tmp = read_whole_file($filename);
-		$this->template = '';
-		$parents = array('top_level_subs' => array());
-		$parent = 'top_level_subs';
-		$this->_load($tmp, $this->template, $parents, $parent);
+		$this->template = parse_template_file($filename);
 	}
-		
-	# Run the template. Pass a filename, or a string, unless you've already
-	# specified a template with load()
-	function run($templ = false) {
-		$template_string = $this->template;
-		$template_file = $this->file;
-		if($templ !== false) {
-			if(strlen($templ) < 150 && file_exists($templ)) {
-				$template_file = $templ;
-				unset($template_string);
-			} else {
-				$template_string = $templ;
-			}
+
+	function run($tem = false) {
+		if($tem) {
+			if(strlen($tem < 150 && file_exists($tem))) $this->load($tem);
+			else $this->load_str($tem);
 		}
 
-		if(!$template_string) {
-			if(!$template_file) {
-				print "sorry, no template to run\n";
-				exit(1);
-			}
+		return fill_template($this->template, $this->data);
+	}
 
-			$template_string = read_whole_file($template_file);
+	function output($tem = false) {
+		print($this->run($tem));
+	}
+
+	# merge top-level sub-templates of $tem (object) into $this,
+	# supporting both new and old semantics.
+	function merge($tem) {
+		# append expansions to $this->data (old style)
+
+		$subs = $tem->top_subs('is_shown_sub_template');
+		if($subs) foreach($subs as $name => $val) {
+			$this->append($name, $val);
+			unset($tem->data[$name]);  # so array_merge() won't overwrite things
 		}
-		
-		return template_run($this->template, $this->keyval);
-	}	
 
-	# same as run() except the output is print()ed
-	function output($templ = false) {
-		print($this->run($templ));
+		# merge the data arrays and template trees (new style)
+		$this->data = array_merge($this->data, $tem->data);
+		$this->template = merge_templates($this->template, $tem->template);
+	}
+
+	function top_sub_names($is_sub = 'is_sub_template') {
+		return array_keys(top_sub_templates($this->template, $is_sub));
 	}
 
-	# return the contents of the top-level sub-templates
-	#
-	# this does not run the sub-templates, so if you've not called tem_sub() on them, they will be blank.
-	#
-	# Return a hash.
-	#     keys: name of top level sub-template.
-	#     values: contents of said sub-template.
-	function top_subs() {
+	function top_subs($is_sub = 'is_sub_template') {
 		$ret = array();
-		if(isset($this->sub_subs['top_level_subs'])) {
-			foreach($this->sub_subs['top_level_subs'] as $name) {
-				$ret[$name] = $this->get($name);
-			}
+		$names = $this->top_sub_names($is_sub);
+		foreach($names as $name) {
+			$ret[$name] = $this->get($name);
 		}
 		return $ret;
 	}
-}
 
-# Below are functions so you can use the above class without allocating or
-# keeping track of it.
+	# old name for show (deprecated)
+	function sub($name) {
+		$this->show($name);
+	}
+}
 
-# get a reference to the current template object
-function tem_init() { 
+function tem_init() {
 	if(!$GLOBALS['wfpl_template']) {
 		$GLOBALS['wfpl_template'] = new tem();
 	}
 }
-		
+
+function tem_append($key, $value) {
+	tem_init();
+	$GLOBALS['wfpl_template']->append($key, $value);
+}
+
+function tem_prepend($key, $value) {
+	tem_init();
+	$GLOBALS['wfpl_template']->prepend($key, $value);
+}
+
 function tem_set($key, $value) {
 	tem_init();
 	$GLOBALS['wfpl_template']->set($key, $value);
 }
-	
+
 function tem_get($key) {
 	tem_init();
 	return $GLOBALS['wfpl_template']->get($key);
 }
 
-function tem_run($templ = false) {
+function tem_run($tem = false) {
 	tem_init();
-	return $GLOBALS['wfpl_template']->run($templ);
+	return $GLOBALS['wfpl_template']->run($tem);
 }
 
-function tem_sub($sub_template_name) {
+function tem_show($name) {
 	tem_init();
-	$GLOBALS['wfpl_template']->sub($sub_template_name);
+	return $GLOBALS['wfpl_template']->show($name);
+}
+
+function tem_show_separated($name) {
+	tem_init();
+	$GLOBALS['wfpl_template']->show_separated($name);
 }
 
 function tem_load($filename) {
@@ -231,38 +502,26 @@ function tem_output($filename = false) {
 	$GLOBALS['wfpl_template']->output($filename);
 }
 
-
-
-# this is used in template_run() and should be of no other use
-function template_filler($matches) {
-	list($tag, $enc) = explode('.', $matches[1], 2);
-	$value = $GLOBALS['wfpl_template_keyval'][$tag];
-	if($enc) {
-		$encs = explode('.', $enc);
-		foreach($encs as $enc) {
-			$enc = "enc_$enc";
-			if(function_exists($enc)) {
-				$value = $enc($value);
-			} else {
-				print "ERROR: encoder function '$enc' not found.<br>\n";
-				exit(1);
-			}
-		}
-	}
-	return $value;
+function tem_top_subs() {
+	tem_init();
+	return $GLOBALS['wfpl_template']->top_subs();
 }
 
+function tem_top_sub_names() {
+	tem_init();
+	return $GLOBALS['wfpl_template']->top_sub_names();
+}
 
-# pass a template string and an associative array of the key/values and it
-# returns the result.
-function template_run($template, &$keyval) {
-	$GLOBALS['wfpl_template_keyval'] =& $keyval;
-	return preg_replace_callback(array('|<!--~([^~]*)~-->|', '|~([^~]*)~|', '|<span class="template">([^<]*)</span>|', '|<p class="template">([^<]*)</p>|'), 'template_filler', $template);
+function tem_load_new($filename) {
+	$old = $GLOBALS['wfpl_template'];
+	$GLOBALS['wfpl_template'] = new tem();
+	$GLOBALS['wfpl_template']->load($filename);
+	return $old;
 }
 
-function tem_top_subs() {
-	tem_init();
-	return $GLOBALS['wfpl_template']->top_subs();
+# deprecated (old name for show)
+function tem_sub($name) {
+	tem_show($name);
 }
 
 ?>