X-Git-Url: https://jasonwoof.com/gitweb/?p=wfpl.git;a=blobdiff_plain;f=template.php;h=077aa8daf4547b33693af1df1f008811e41862db;hp=43cceae9aa420938498602d32a01cd8f61b094ab;hb=HEAD;hpb=848c8a4d215f9cce1db0a7d37e733b5959b8210f diff --git a/template.php b/template.php index 43cceae..077aa8d 100644 --- a/template.php +++ b/template.php @@ -1,221 +1,607 @@ 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(); + $matches = preg_split('/()/', preg_replace('//', '$1', $string), -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY); + 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(count($args) && $args[count($args)-1] == '{') { # 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(count($args) && $args[count($args)-1] == '}') { # 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); + } + } else { # 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; + $output = ''; + + foreach($template['pieces'] as $tem) { + if(is_string($tem)) $output .= $tem; + elseif(isset($tem['pieces'])) { # sub-template + $rows =& tem_row_data($tem, $context); + $context['rows'] =& $rows; + foreach($rows as $key => &$row) { + $context['cur'] = $key; + $output .= tem_apply_encodings($tem['name'], fill_template($tem, $row, $context), $tem['args']); + } + } 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]); - } - # grab a value you stuck in earlier with set() - function get($key) { - return $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, $key) { + if(is_array($value)) { + # numeric keys + if(array_key_exists(0, $value)) { + if(is_array($value[0])) return $value; # already array of hashes. + else return columnize($value, $key); + # key/value pairs -- expand sub-template once. + } else return array($value); + } elseif($value || $value === 0 || $value === '0' || $value === '') { + # value -- expand sub-template once using only parent values + return array(array()); + } else { + # empty value -- don't expand sub-template + return array(); } +} + +# 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 = isset($scope['parent']) ? $scope['parent'] : null); + + # not found; return empty scope. + $refs[] = array(); + $ret = array(); + $ret['parent'] =& $context; + $ret['data'] =& $refs[count($refs) - 1]; + return $ret; +} - # 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); +function tem_get_data($key, $context) { + $scope = tem_data_scope($key, $context); + if($scope) return isset($scope['data'][$key]) ? $scope['data'][$key] : null; +} - # 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 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); + $auto_func = false; + + if(count($tem['args'])) { + $auto_func = "tem_auto_" . $tem['args'][0]; + if (!function_exists($auto_func)) { + if (function_exists("enc_" . $tem['args'][0])) { + $auto_func = false; + } else { + die("ERROR: template auto function '$auto_func' not found.
\n"); } } + # NAMESPACIFY $auto_func + } + $value = isset($scope['data'][$key]) ? $scope['data'][$key] : null; + if ($auto_func) { + $value = $auto_func($value, $key, $scope, $tem['args']); } - # 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, '', substr($in, 0, 12)) == 0) { - $in = substr($in, 12); - $parent = array_pop($parents); - return; - } +function tem_apply_encodings ($key, $value, $encodings) { + if ($encodings) foreach($encodings as $encoding) { + $func = "enc_$encoding"; + if (function_exists($func)) { + # NAMESPACIFY $func + $value = $func($value, $key); + } elseif (!function_exists("tem_auto_$encoding")) { + die("ERROR: encoder function '$func' not found.
\n"); + } + } + return $value; +} - $matches = array(); - # this limits sub_template names to 50 chars - if(ereg('^', substr($in, 0, 65), $matches)) { - list($start_tag, $tag_name) = $matches; +# 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); + return tem_apply_encodings($key, $value, $tag['args']); +} - # keep track of the tree - if(!isset($this->sub_subs[$parent])) { - $this->sub_subs[$parent] = array(); - } - 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); + +function is_sub_template(&$piece) { + return is_array($piece) && isset($piece['pieces']); +} + +function is_value_slot(&$piece) { + return is_array($piece) && !isset($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; +} + +# merge $subs (sub_templates) into variables in $main (template) +function merge_sub_templates(&$main, &$subs) { + foreach($main['pieces'] as &$piece) { + if(is_array($piece)) { # not just text + if(isset($piece['pieces']) && $piece['pieces']) { + # a sub-template in main + merge_sub_templates($piece, $subs); } 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); + # a value-slot in main + $sub = isset($subs[$piece['name']]) ? $subs[$piece['name']] : null; + $arg0 = isset($sub['args'][0]) ? $sub['args'][0] : null; + if($sub && $arg0 != 'hide') { + $piece = $subs[$piece['name']]; + $piece['parent'] =& $main; + } } - } #repeat + } } +} - # 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); +# Replace values in $main with top-level templates from $tem. +function merge_templates(&$main, &$tem) { + $subs = top_sub_templates($tem); + + merge_sub_templates($main, $subs); +} + + + +# 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: +# +# +# row content... +#
+# +# +# +function tem_auto_sep(&$value, $key, $context) { + $rows =& $context['parent']['parent']; + if($rows['cur'] != count($rows['rows'])-1) # last row? + return true; # show once +} + +# auto-show once, only when this is the first row of the parent +function tem_auto_last(&$value, $key, $context) { + $rows =& $context['parent']['parent']; + if($rows['cur'] == count($rows['rows'])-1) # last row? + return true; # show once +} + +# auto-show once, only when this is the last row of the parent +function tem_auto_first(&$value, $key, $context) { + $rows =& $context['parent']['parent']; + if($rows['cur'] == 0) # first row? + return true; # show once +} + +# 'show' sections will be shown unless the corresponding data +# value === false +function tem_auto_show(&$value) { + if($value === null) return true; + return $value; +} + +# 'empty' sections will be shown only if the corresponding data value is the +# empty string +function tem_auto_empty(&$value) { + if($value === '') return true; + return null; +} + +# 'nonempty' sections will not be shown if the corresponding data +# value is the empty string +function tem_auto_nonempty(&$value) { + if($value === '') return null; + return $value; +} + +# 'unset' sections will not be shown if the corresponding data +# value is not set (opposite of default) +function tem_auto_unset(&$value) { + if($value === null) { + return ''; + } else { + return null; } - - # Run the template. Pass a filename, or a string, unless you've already - # specified a template with load() - function run($templ = false) { - if($templ !== false) { - if(strlen($templ) < 150 && file_exists($templ)) { - $this->filename = $templ; - unset($this->template); - } else { - $this->template = $templ; +} + +# 'evenodd' sections are given an 'evenodd' attribute whose value +# alternates between 'even' and 'odd'. +function tem_auto_evenodd(&$values) { + $even = true; + if($values) foreach($values as &$value) { + $value['evenodd'] = $even ? 'even' : 'odd'; + $even = !$even; + } + return $values; +} + +# 'once' sections are shown exactly once if the value is set (and not at all +# otherwise.) This is useful when an array value would otherwise cause the +# section to be displayed multiple times. +function tem_auto_once(&$value) { + if($value === null) return null; + return true; +} + +function tem_auto_once_if(&$value) { + if($value) return true; + return null; +} + +# 'once' sections are shown exactly once if php evaluates the value to false +# (and not at all otherwise.) This is useful when an array value would +# otherwise cause the section to be displayed multiple times. +function tem_auto_once_else(&$value) { + if($value) return null; + return true;; +} + + + + + +# Backward Compatibility +# ---------------------- + +function is_shown($piece) { + return isset($piece['args'][0]) && $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)); + } + return $piece; } + $tem = tem_is_old_sub($name, $piece); + if($tem) return $tem; + } + } + $false = false; + return $false; +} + +class tem { + var $template; + var $data; + + function tem() { + $this->template = array('pieces' => array()); + $this->data = array(); + } + + function set($key, $value = true) { + $this->data[$key] = $value; + } + + function sets($hash) { + foreach($hash as $key => $value) { + $this->set($key, $value); + } + } + + function append($key, $value) { + if (!isset($this->data[$key])) { + $this->data[$key] = ''; } + $this->data[$key] .= $value; + } - if(!$this->template) { - if(!$this->filename) { - print "sorry, no template to run\n"; - exit(1); + function prepend($key, $value) { + $this->data[$key] = $value . $this->data[$key]; + } + + function clear($key) { + unset($this->data[$key]); + } + + function get($key) { + if (isset($this->data[$key])) { + return $this->data[$key]; + } else { + return; + } + } + + function show($name) { + $tem = tem_is_old_sub($name, $this->template); + if($tem) { + if (!isset($this->data[$name])) { + $this->data[$name] = ''; } + $this->data[$name] .= fill_template($tem, $this->data); + } + } - $this->template = read_whole_file($this->filename); + function show_separated($name) { + if($this->get($name)) { + $this->show($name . '_sep'); } - - return template_run($this->template, $this->keyval); - } + $this->show($name); + } - # same as run() except the output is print()ed - function output($templ = false) { - print($this->run($templ)); + function load_str($str) { + $this->template =& parse_template($str); } - # 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 load($filename) { + $this->template =& parse_template_file($filename); + } + + function run($tem = false) { + if($tem) { + if(strlen($tem < 150 && file_exists($tem))) $this->load($tem); + else $this->load_str($tem); + } + + return fill_template($this->template, $this->data); + } + + 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 + } + + # merge the data arrays and template trees (new style) + $this->data = array_merge($this->data, $tem->data); + merge_templates($this->template, $tem->template); + } + + # see merge() above + function merge_file($filename) { + $other_tem = new tem(); + $other_tem->load($filename); + $this->merge($other_tem); + } + + function top_sub_names($is_sub = 'is_sub_template') { + return array_keys(top_sub_templates($this->template, $is_sub)); + } + + 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() { - if(!$GLOBALS['wfpl_template']) { +function tem_init() { + if(!isset($GLOBALS['wfpl_template']) || !$GLOBALS['wfpl_template']) { $GLOBALS['wfpl_template'] = new tem(); } } - -function tem_set($key, $value) { + +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 = true) { tem_init(); $GLOBALS['wfpl_template']->set($key, $value); } - + +function tem_sets($hash) { + tem_init(); + $GLOBALS['wfpl_template']->sets($hash); +} + 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($tem); +} + +function tem_show($name) { tem_init(); - return $GLOBALS['wfpl_template']->run($templ); + return $GLOBALS['wfpl_template']->show($name); } -function tem_sub($sub_template_name) { +function tem_show_separated($name) { tem_init(); - $GLOBALS['wfpl_template']->sub($sub_template_name); + $GLOBALS['wfpl_template']->show_separated($name); } function tem_load($filename) { @@ -223,38 +609,19 @@ function tem_load($filename) { $GLOBALS['wfpl_template']->load($filename); } -function tem_output($filename = false) { +function tem_merge($tem) { tem_init(); - $GLOBALS['wfpl_template']->output($filename); + $GLOBALS['wfpl_template']->merge($tem); } - - -# 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.
\n"; - exit(1); - } - } - } - return $value; +function tem_merge_file($filename) { + tem_init(); + $GLOBALS['wfpl_template']->merge_file($filename); } - -# 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('||', '|~([^~]*)~|', '|([^<]*)|', '|

([^<]*)

|'), 'template_filler', $template); +function tem_output($filename = false) { + tem_init(); + $GLOBALS['wfpl_template']->output($filename); } function tem_top_subs() { @@ -262,4 +629,19 @@ function tem_top_subs() { return $GLOBALS['wfpl_template']->top_subs(); } -?> +function tem_top_sub_names() { + tem_init(); + return $GLOBALS['wfpl_template']->top_sub_names(); +} + +function tem_load_new($filename) { + $old = isset($GLOBALS['wfpl_template']) ? $GLOBALS['wfpl_template'] : null; + $GLOBALS['wfpl_template'] = new tem(); + $GLOBALS['wfpl_template']->load($filename); + return $old; +} + +# deprecated (old name for show) +function tem_sub($name) { + tem_show($name); +}