Merge pull request #543 from fabrixxm/master

template_processor: add filter support to variables
This commit is contained in:
friendica 2012-12-16 14:52:40 -08:00
commit ca16302111

View file

@ -1,7 +1,9 @@
<?php <?php
define("KEY_NOT_EXISTS", '^R_key_not_Exists^'); define("KEY_NOT_EXISTS", '^R_key_not_Exists^');
class Template { class Template {
var $r; var $r;
var $search; var $search;
var $replace; var $replace;
@ -15,10 +17,14 @@
private function _preg_error() { private function _preg_error() {
switch (preg_last_error()) { switch (preg_last_error()) {
case PREG_INTERNAL_ERROR: echo('PREG_INTERNAL_ERROR'); break; case PREG_INTERNAL_ERROR: echo('PREG_INTERNAL_ERROR');
case PREG_BACKTRACK_LIMIT_ERROR: echo('PREG_BACKTRACK_LIMIT_ERROR'); break; break;
case PREG_RECURSION_LIMIT_ERROR: echo('PREG_RECURSION_LIMIT_ERROR'); break; case PREG_BACKTRACK_LIMIT_ERROR: echo('PREG_BACKTRACK_LIMIT_ERROR');
case PREG_BAD_UTF8_ERROR: echo('PREG_BAD_UTF8_ERROR'); break; break;
case PREG_RECURSION_LIMIT_ERROR: echo('PREG_RECURSION_LIMIT_ERROR');
break;
case PREG_BAD_UTF8_ERROR: echo('PREG_BAD_UTF8_ERROR');
break;
// This is only valid for php > 5.3, not certain how to code around it for unit tests // This is only valid for php > 5.3, not certain how to code around it for unit tests
// case PREG_BAD_UTF8_OFFSET_ERROR: echo('PREG_BAD_UTF8_OFFSET_ERROR'); break; // case PREG_BAD_UTF8_OFFSET_ERROR: echo('PREG_BAD_UTF8_OFFSET_ERROR'); break;
default: default:
@ -30,18 +36,18 @@
die(); die();
} }
private function _push_stack() { private function _push_stack() {
$this->stack[] = array($this->r, $this->nodes); $this->stack[] = array($this->r, $this->nodes);
} }
private function _pop_stack() { private function _pop_stack() {
list($this->r, $this->nodes) = array_pop($this->stack); list($this->r, $this->nodes) = array_pop($this->stack);
} }
private function _get_var($name, $retNoKey = false) { private function _get_var($name, $retNoKey = false) {
$keys = array_map('trim', explode(".", $name)); $keys = array_map('trim', explode(".", $name));
if ($retNoKey && !array_key_exists($keys[0], $this->r)) return KEY_NOT_EXISTS; if ($retNoKey && !array_key_exists($keys[0], $this->r))
return KEY_NOT_EXISTS;
$val = $this->r; $val = $this->r;
foreach ($keys as $k) { foreach ($keys as $k) {
$val = (isset($val[$k]) ? $val[$k] : null); $val = (isset($val[$k]) ? $val[$k] : null);
@ -60,12 +66,14 @@
if (strpos($args[2], "==") > 0) { if (strpos($args[2], "==") > 0) {
list($a, $b) = array_map("trim", explode("==", $args[2])); list($a, $b) = array_map("trim", explode("==", $args[2]));
$a = $this->_get_var($a); $a = $this->_get_var($a);
if ($b[0]=="$") $b = $this->_get_var($b); if ($b[0] == "$")
$b = $this->_get_var($b);
$val = ($a == $b); $val = ($a == $b);
} else if (strpos($args[2], "!=") > 0) { } else if (strpos($args[2], "!=") > 0) {
list($a, $b) = array_map("trim", explode("!=", $args[2])); list($a, $b) = array_map("trim", explode("!=", $args[2]));
$a = $this->_get_var($a); $a = $this->_get_var($a);
if ($b[0]=="$") $b = $this->_get_var($b); if ($b[0] == "$")
$b = $this->_get_var($b);
$val = ($a != $b); $val = ($a != $b);
} else { } else {
$val = $this->_get_var($args[2]); $val = $this->_get_var($args[2]);
@ -89,16 +97,19 @@
} else { } else {
list($keyname, $varname) = $x; list($keyname, $varname) = $x;
} }
if ($m[0]=="" || $varname=="" || is_null($varname)) die("template error: 'for ".$m[0]." as ".$varname."'") ; if ($m[0] == "" || $varname == "" || is_null($varname))
die("template error: 'for " . $m[0] . " as " . $varname . "'");
//$vals = $this->r[$m[0]]; //$vals = $this->r[$m[0]];
$vals = $this->_get_var($m[0]); $vals = $this->_get_var($m[0]);
$ret = ""; $ret = "";
if (!is_array($vals)) return $ret; if (!is_array($vals))
return $ret;
foreach ($vals as $k => $v) { foreach ($vals as $k => $v) {
$this->_push_stack(); $this->_push_stack();
$r = $this->r; $r = $this->r;
$r[$varname] = $v; $r[$varname] = $v;
if ($keyname!='') $r[$keyname] = (($k === 0) ? '0' : $k); if ($keyname != '')
$r[$keyname] = (($k === 0) ? '0' : $k);
$ret .= $this->replace($args[3], $r); $ret .= $this->replace($args[3], $r);
$this->_pop_stack(); $this->_pop_stack();
} }
@ -118,7 +129,8 @@
$newctx = null; $newctx = null;
} }
if ($tplfile[0]=="$") $tplfile = $this->_get_var($tplfile); if ($tplfile[0] == "$")
$tplfile = $this->_get_var($tplfile);
$this->_push_stack(); $this->_push_stack();
$r = $this->r; $r = $this->r;
@ -131,7 +143,6 @@
$ret = $this->replace($tpl, $r); $ret = $this->replace($tpl, $r);
$this->_pop_stack(); $this->_pop_stack();
return $ret; return $ret;
} }
/** /**
@ -177,14 +188,14 @@
while (!$this->done) { while (!$this->done) {
$this->done = true; $this->done = true;
$s = preg_replace_callback('|{{ *([a-z]*) *([^}]*)}}([^{]*({{ *else *}}[^{]*)?){{ *end\1 *}}|', array($this, "_replcb"), $s); $s = preg_replace_callback('|{{ *([a-z]*) *([^}]*)}}([^{]*({{ *else *}}[^{]*)?){{ *end\1 *}}|', array($this, "_replcb"), $s);
if ($s==Null) $this->_preg_error(); if ($s == Null)
$this->_preg_error();
} }
//({{ *else *}}[^{]*)? //({{ *else *}}[^{]*)?
krsort($this->nodes); krsort($this->nodes);
return $s; return $s;
} }
private function var_replace($s) { private function var_replace($s) {
$m = array(); $m = array();
/** regexp: /** regexp:
@ -192,18 +203,55 @@
* (\[)? optional open square bracket * (\[)? optional open square bracket
* ([a-zA-Z0-9-_]+\.?)+ var name, followed by optional * ([a-zA-Z0-9-_]+\.?)+ var name, followed by optional
* dot, repeated at least 1 time * dot, repeated at least 1 time
* (|[a-zA-Z0-9-_:]+)* pipe followed by filter name and args, zero or many
* (?(1)\]) if there was opened square bracket * (?(1)\]) if there was opened square bracket
* (subgrup 1), match close bracket * (subgrup 1), match close bracket
*/ */
if (preg_match_all('/\$(\[)?([a-zA-Z0-9-_]+\.?)+(?(1)\])/', $s,$m)){ if (preg_match_all('/\$(\[)?([a-zA-Z0-9-_]+\.?)+(\|[a-zA-Z0-9-_:]+)*(?(1)\])/', $s, $m)) {
foreach ($m[0] as $var) { foreach ($m[0] as $var) {
$varn = str_replace(array("[","]"), array("",""), $var);
$exp = str_replace(array("[", "]"), array("", ""), $var);
$exptks = explode("|", $exp);
$varn = $exptks[0];
unset($exptks[0]);
$val = $this->_get_var($varn, true); $val = $this->_get_var($varn, true);
if ($val!=KEY_NOT_EXISTS) if ($val != KEY_NOT_EXISTS) {
/* run filters */
/*
* Filter are in form of:
* filtername:arg:arg:arg
*
* "filtername" is function name
* "arg"s are optional, var value is appended to the end
* if one "arg"==='x' , is replaced with var value
*
* examples:
* $item.body|htmlspecialchars // escape html chars
* $item.body|htmlspecialchars|strtoupper // escape html and uppercase result
* $item.created|date:%Y %M %j // format date (created is a timestamp)
* $item.body|str_replace:cat:dog // replace all "cat" with "dog"
* $item.body|str_replace:cat:dog:x:1 // replace one "cat" with "dog"
*/
foreach ($exptks as $filterstr) {
$filter = explode(":", $filterstr);
$filtername = $filter[0];
unset($filter[0]);
$valkey = array_search("x", $filter);
if ($valkey === false) {
$filter[] = $val;
} else {
$filter[$valkey] = $val;
}
if (function_exists($filtername)) {
$val = call_user_func_array($filtername, $filter);
}
}
$s = str_replace($var, $val, $s); $s = str_replace($var, $val, $s);
} }
} }
}
return $s; return $s;
} }
@ -214,37 +262,34 @@
$s = $this->_build_nodes($s); $s = $this->_build_nodes($s);
$s = preg_replace_callback('/\|\|([0-9]+)\|\|/', array($this, "_replcb_node"), $s); $s = preg_replace_callback('/\|\|([0-9]+)\|\|/', array($this, "_replcb_node"), $s);
if ($s==Null) $this->_preg_error(); if ($s == Null)
$this->_preg_error();
// remove comments block // remove comments block
$s = preg_replace('/{#[^#]*#}/', "", $s); $s = preg_replace('/{#[^#]*#}/', "", $s);
// replace strings recursively (limit to 10 loops) // replace strings recursively (limit to 10 loops)
$os = ""; $count=0; $os = "";
$count = 0;
while ($os != $s && $count < 10) { while ($os != $s && $count < 10) {
$os=$s; $count++; $os = $s;
$count++;
$s = $this->var_replace($s); $s = $this->var_replace($s);
} }
return $s; return $s;
} }
} }
$t = new Template; $t = new Template;
function template_escape($s) { function template_escape($s) {
return str_replace(array('$', '{{'), array('!_Doll^Ars1Az_!', '!_DoubLe^BraceS4Rw_!'), $s); return str_replace(array('$', '{{'), array('!_Doll^Ars1Az_!', '!_DoubLe^BraceS4Rw_!'), $s);
} }
function template_unescape($s) { function template_unescape($s) {
return str_replace(array('!_Doll^Ars1Az_!', '!_DoubLe^BraceS4Rw_!'), array('$', '{{'), $s); return str_replace(array('!_Doll^Ars1Az_!', '!_DoubLe^BraceS4Rw_!'), array('$', '{{'), $s);
} }