getting rid of Template_new which no one seems to care for, and adding my own experimental class which should have a little better performance.

This commit is contained in:
seek3r 2002-01-02 14:37:15 +00:00
parent 32306abaf6
commit e9688a73ea
2 changed files with 487 additions and 471 deletions

View File

@ -0,0 +1,487 @@
<?php
/**************************************************************************\
* phpGroupWare API - Template class *
* (C) Copyright 1999-2000 NetUSE GmbH Kristian Koehntopp *
* ------------------------------------------------------------------------ *
* This is not part of phpGroupWare, but is used by phpGroupWare. *
* http://www.phpgroupware.org/ *
* ------------------------------------------------------------------------ *
* This program 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 *
* any later version. *
\**************************************************************************/
/* $Id$ */
class Template
{
var $classname = 'Template';
/* if set, echo assignments */
var $debug = False;
/* $file[handle] = 'filename'; */
var $file = array();
/* relative filenames are relative to this pathname */
var $root = '';
/* $varkeys[key] = 'key'; $varvals[key] = 'value'; */
var $varkeys = array();
var $varvals = array();
/* 'remove' => remove undefined variables
* 'comment' => replace undefined variables with comments
* 'keep' => keep undefined variables
*/
var $unknowns = 'remove';
/* 'yes' => halt, 'report' => report error, continue, 'no' => ignore error quietly */
var $halt_on_error = 'yes';
/* last error message is retained here */
var $last_error = '';
/* Used to cut down performance problems with so many file_exists */
var $found_files;
/***************************************************************************/
/* public: Constructor.
* root: template directory.
* unknowns: how to handle unknown variables.
*/
function Template($root = '.', $unknowns = 'remove')
{
$this->set_root($root);
$this->set_unknowns($unknowns);
}
/* public: setroot(pathname $root)
* root: new template directory.
*/
function set_root($root)
{
if (!is_dir($root))
{
$this->halt("set_root: $root is not a directory.");
return false;
}
$this->root = $root;
return true;
}
/* public: set_unknowns(enum $unknowns)
* unknowns: 'remove', 'comment', 'keep'
*
*/
function set_unknowns($unknowns = 'keep')
{
$this->unknowns = $unknowns;
}
/* public: set_file(array $filelist)
* filelist: array of handle, filename pairs.
*
* public: set_file(string $handle, string $filename)
* handle: handle for a filename,
* filename: name of template file
*/
function set_file($handle, $filename = '')
{
if (!is_array($handle))
{
if ($filename == '')
{
$this->halt("set_file: For handle $handle filename is empty.");
return false;
}
$this->file[$handle] = $this->filename($filename);
}
else
{
reset($handle);
while(list($h, $f) = each($handle))
{
$this->file[$h] = $this->filename($f);
}
}
}
/* public: set_block(string $parent, string $handle, string $name = '')
* extract the template $handle from $parent,
* place variable {$name} instead.
*/
function set_block($parent, $handle, $name = '')
{
if (!$this->loadfile($parent))
{
$this->halt("subst: unable to load $parent.");
return false;
}
if ($name == '')
{
$name = $handle;
}
$str = $this->get_var($parent);
$reg = "/<!--\s+BEGIN $handle\s+-->(.*)\n\s*<!--\s+END $handle\s+-->/sm";
preg_match_all($reg, $str, $m);
$str = preg_replace($reg, '{' . "$name}", $str);
$this->set_var($handle, $m[1][0]);
$this->set_var($parent, $str);
}
/* public: set_var(array $values)
* values: array of variable name, value pairs.
*
* public: set_var(string $varname, string $value)
* varname: name of a variable that is to be defined
* value: value of that variable
*/
function set_var($varname, $value = '')
{
if (!is_array($varname))
{
if (!empty($varname))
{
if ($this->debug)
{
print "scalar: set *$varname* to *$value*<br>\n";
}
$this->varkeys[$varname] = $this->varname($varname);
$this->varvals[$varname] = $value;
}
}
else
{
reset($varname);
while(list($k, $v) = each($varname))
{
if (!empty($k))
{
if ($this->debug)
{
print "array: set *$k* to *$v*<br>\n";
}
$this->varkeys[$k] = $this->varname($k);
$this->varvals[$k] = $v;
}
}
}
}
/* public: subst(string $handle)
* handle: handle of template where variables are to be substituted.
*/
function subst($handle)
{
if (!$this->loadfile($handle))
{
$this->halt("subst: unable to load $handle.");
return false;
}
$str = $this->get_var($handle);
reset($this->varkeys);
while (list($k, $v) = each($this->varkeys))
{
$str = str_replace($v, $this->varvals[$k], $str);
}
return $str;
}
/* public: psubst(string $handle)
* handle: handle of template where variables are to be substituted.
*/
function psubst($handle)
{
print $this->subst($handle);
return false;
}
/* public: parse(string $target, string $handle, boolean append)
* public: parse(string $target, array $handle, boolean append)
* target: handle of variable to generate
* handle: handle of template to substitute
* append: append to target handle
*/
function parse($target, $handle, $append = false)
{
if (!is_array($handle))
{
$str = $this->subst($handle);
if ($append)
{
$this->set_var($target, $this->get_var($target) . $str);
}
else
{
$this->set_var($target, $str);
}
}
else
{
reset($handle);
while(list($i, $h) = each($handle))
{
$str = $this->subst($h);
$this->set_var($target, $str);
}
}
return $str;
}
function pparse($target, $handle, $append = false)
{
print $this->parse($target, $handle, $append);
return false;
}
/* This is short for finish parse */
function fp($target, $handle, $append = False)
{
return $this->finish($this->parse($target, $handle, $append));
}
/* This is a short cut for print finish parse */
function pfp($target, $handle, $append = False)
{
echo $this->finish($this->parse($target, $handle, $append));
}
/* public: get_vars()
*/
function get_vars()
{
reset($this->varkeys);
while(list($k, $v) = each($this->varkeys))
{
$result[$k] = $this->varvals[$k];
}
return $result;
}
/* public: get_var(string varname)
* varname: name of variable.
*
* public: get_var(array varname)
* varname: array of variable names
*/
function get_var($varname)
{
if (!is_array($varname))
{
return $this->varvals[$varname];
}
else
{
reset($varname);
while(list($k, $v) = each($varname))
{
$result[$k] = $this->varvals[$k];
}
return $result;
}
}
/* public: get_undefined($handle)
* handle: handle of a template.
*/
function get_undefined($handle)
{
if (!$this->loadfile($handle))
{
$this->halt("get_undefined: unable to load $handle.");
return false;
}
preg_match_all("/\{([^}]+)\}/", $this->get_var($handle), $m);
$m = $m[1];
if (!is_array($m))
{
return false;
}
reset($m);
while(list($k, $v) = each($m))
{
if (!isset($this->varkeys[$v]))
{
$result[$v] = $v;
}
}
if (count($result))
{
return $result;
}
else
{
return false;
}
}
/* public: finish(string $str)
* str: string to finish.
*/
function finish($str)
{
switch ($this->unknowns)
{
case 'keep':
break;
case 'remove':
$str = preg_replace('/{[^ \t\r\n}]+}/', '', $str);
break;
case 'comment':
$str = preg_replace('/{([^ \t\r\n}]+)}/', "<!-- Template $handle: Variable \\1 undefined -->", $str);
break;
}
return $str;
}
/* public: p(string $varname)
* varname: name of variable to print.
*/
function p($varname)
{
print $this->finish($this->get_var($varname));
}
function get($varname)
{
return $this->finish($this->get_var($varname));
}
/***************************************************************************/
/* private: filename($filename)
* filename: name to be completed.
*/
function filename($filename,$root='',$time=1)
{
if($root=='')
{
$root=$this->root;
}
$default_root = str_replace($GLOBALS['phpgw_info']['server']['template_set'],'default',$root);
if (substr($filename, 0, 1) != '/')
{
$new_filename = $root.'/'.$filename;
}
else
{
$new_filename = $filename;
}
$default_filename = str_replace($root,$default_root,$new_filename);
$app = str_replace('/templates/'.$GLOBALS['phpgw_info']['server']['template_set'],'',$root);
$app = str_replace('/templates/default','',$app);
$app = str_replace(PHPGW_SERVER_ROOT.'/','',$app);
if (!is_array($this->found_files[$app]))
{
if (@is_dir($default_root))
{
$d = dir($default_root);
while (false !== ($entry = $d->read()))
{
if ($entry != '.' && $entry != '..')
{
$this->found_files[$app][$entry] = $default_filename;
}
}
$d->close();
}
if (@is_dir($root))
{
$d = dir($root);
while (false !== ($entry = $d->read()))
{
if ($entry != '.' && $entry != '..')
{
$this->found_files[$app][$entry] = $new_filename;
}
}
$d->close();
}
}
//echo '<pre>';
//print_r($this->found_files);
//echo '</pre>';
if(isset($this->found_files[$app][$filename]))
{
return $this->found_files[$app][$filename];
}
else
{
$this->halt("filename: file $new_filename does not exist.");
}
}
/* private: varname($varname)
* varname: name of a replacement variable to be protected.
*/
function varname($varname)
{
return '{'.$varname.'}';
}
/* private: loadfile(string $handle)
* handle: load file defined by handle, if it is not loaded yet.
*/
function loadfile($handle)
{
if (isset($this->varkeys[$handle]) and !empty($this->varvals[$handle]))
{
return true;
}
if (!isset($this->file[$handle]))
{
$this->halt("loadfile: $handle is not a valid handle.");
return false;
}
$filename = $this->file[$handle];
$str = implode('', @file($filename));
if (empty($str))
{
$this->halt("loadfile: While loading $handle, $filename does not exist or is empty.");
return false;
}
$this->set_var($handle, $str);
return true;
}
/***************************************************************************/
/* public: halt(string $msg)
* msg: error message to show.
*/
function halt($msg)
{
$this->last_error = $msg;
if ($this->halt_on_error != 'no')
{
$this->haltmsg($msg);
}
if ($this->halt_on_error == 'yes')
{
echo('<b>Halted.</b>');
}
$GLOBALS['phpgw']->common->phpgw_exit(True);
}
/* public, override: haltmsg($msg)
* msg: error message to show.
*/
function haltmsg($msg)
{
printf("<b>Template Error:</b> %s<br>\n", $msg);
}
}

View File

@ -1,471 +0,0 @@
<?php
/**************************************************************************\
* phpGroupWare API - Template class *
* (C) Copyright 2001 Ben Woodhead ben@echo-chn.net *
* ------------------------------------------------------------------------ *
* This is not part of phpGroupWare, but is used by phpGroupWare. *
* http://www.phpgroupware.org/ *
* ------------------------------------------------------------------------ *
* This program 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 *
* any later version. *
\**************************************************************************/
/*
* HTML template parser
* Ben Woodhead
* ben@echo-chn.net
* LGPL
* @package phpgwapi
*/
class Template
{
/** Internal Use - Array of file names */
var $m_file = array();
/** Internal Use - Array of block names*/
var $m_block = array();
/** Internal Use */
var $m_varkeys = array();
/** Internal Use */
var $m_varvals = array();
/** Internal Use - Path definition */
var $m_root = array();
/** Internal Use - Defines what to do with unknown tags
* @param keep, remove, or comment
*/
var $m_unknowns = '';
/** Internal Use - class error instance */
var $c_error = '';
/** Default constructor
* @param path - Path to were templates are located (default in preferences)
* @param unknown - Defines what to do with unknown tags (default in preferences)
*/
function Template($root='', $unknowns='')
{
global $preferences;
$this->c_error = createObject('cError','1');
$this->c_error->set_file(__FILE__);
if (!empty($root))
{
$this->set_root($root);
}
else
{
$this->set_root($preferences['template']['path']);
}
if (!empty($unknowns))
{
$this->set_unknowns($unknowns);
}
else
{
$this->set_unknowns($preferences['template']['unknowns']);
}
}
/** Set the path to templates
* @param path - Path to were templates are located
* @returns returns false if an error has occured
*/
function set_root($root)
{
if (!is_array($root))
{
if (!is_dir($root))
{
$this->c_error->halt("set_root (scalar): $root is not a directory.",0,__LINE__);
return false;
}
$this->m_root[] = $root;
}
else
{
reset($root);
while(list($k, $v) = each($root))
{
if (!is_dir($v))
{
$this->c_error->halt("set_root (array): $v (entry $k of root) is not a directory.",0,__LINE__);
return false;
}
$this->m_root[] = $v;
}
}
return true;
}
/** Sets what to do with unknown tags
* @param unknown - Path to were templates are located
* @notes keep - displays the unknown tags
* @notes remove - removes unknown tags
* @returns returns false if an error has occured
*/
function set_unknowns($unknowns='')
{
$this->m_unknowns = $unknowns;
}
/** Sets name of template file
* @blockname - alias for the block
* @filename - filename of block
* @notes Must be passed in as array
* @returns returns false if an error has occured
*/
function set_file($varname, $filename='')
{
if (!is_array($varname))
{
if ($filename == '')
{
$c_error->halt("set_file: For varname $varname filename is empty.",0,__LINE__);
return false;
}
$this->m_file[$varname] = $this->filename($filename);
}
else
{
reset($varname);
while(list($h, $f) = each($varname))
{
if ($f == '')
{
$this->c_error->halt("set_file: For varname $h filename is empty.",0,__LINE__);
return false;
}
$this->m_file[$h] = $this->filename($f);
}
}
return true;
}
/** Defines what block to use in template
* @param parent - is the block alias
* @param block - will look for this name in template file
* @param name - alias for block (defaults to block name)
* @notes Also can be used to define nested blocks
* @returns Currently returns true
*/
function set_block($parent, $varname, $name='')
{
if ($name == '')
{
$name = $varname;
}
$this->m_block[$varname]['parent'] = $parent;
$this->m_block[$varname]['alias'] = $name;
return true;
}
/** Sets the tags in template
* @param Tag name found in template file
* @param Value that will be included when parsing complete
* @return No return
*/
function set_var($varname, $value='')
{
if (!is_array($varname))
{
if (!empty($varname))
{
$this->m_varkeys[$varname] = '/' . $this->varname($varname) . '/';
$this->m_varvals[$varname] = $value;
}
}
else
{
reset($varname);
while(list($k, $v) = each($varname))
{
if (!empty($k))
{
$this->m_varkeys[$k] = '/' . $this->varname($k) . '/';
$this->m_varvals[$k] = $v;
}
}
}
}
/** Substitute text in templates
* @param Tag name found in template file
* @return processed string
* @notes Internal Use
*/
function subst($varname)
{
$str = $this->get_var($varname);
$str = @preg_replace($this->m_varkeys, $this->m_varvals, $str);
return $str;
}
/** Substitute text in templates and prints
* @param Tag name found in template file
* @notes Internal Use
*/
function psubst($varname)
{
print $this->subst($varname);
return false;
}
/** Parse complete template
* @param Target - Alias for processed text
* @param Block - Name of block to process
* @param Append - Should text be append to file (defaults no false)
* @return processed string
*/
function parse($target, $varname, $append = false)
{
if (!is_array($varname))
{
$str = $this->subst($varname);
if ($append)
{
$this->set_var($target, $this->get_var($target) . $str);
}
else
{
$this->set_var($target, $str);
}
}
else
{
reset($varname);
while(list($i, $h) = each($varname))
{
$str = $this->subst($h);
$this->set_var($target, $str);
}
}
return $str;
}
/** Parse complete template and print results
* @param Target - Alias for processed text
* @param Block - Name of block to process
* @param Append - Should text be append to file (defaults no false)
*/
function pparse($target, $varname, $append = false)
{
print $this->parse($target, $varname, $append);
return false;
}
/** Gets the tags from the array
* @notes Internal use
*/
function get_vars()
{
reset($this->m_varkeys);
while(list($k, $v) = each($this->m_varkeys))
{
$result[$k] = $this->get_var($k);
}
return $result;
}
/** Gets the tags from the single input
* @notes Internal use
* @returns Result array
*/
function get_var($varname)
{
if (!is_array($varname))
{
if (!isset($this->m_varkeys[$varname]) or empty($this->m_varvals[$varname]))
{
if (isset($this->m_file[$varname]))
{
$this->loadfile($varname);
}
if (isset($this->m_block[$varname]))
{
$this->implodeBlock($varname);
}
}
return(isset($this->m_varvals[$varname]) ? $this->m_varvals[$varname] : '');
}
else
{
reset($varname);
while(list($k, $v) = each($varname))
{
if (!isset($this->m_varkeys[$varname]) or empty($this->m_varvals[$varname]))
{
if ($this->m_file[$v])
{
$this->loadfile($v);
}
if ($this->m_block[$v])
{
$this->implodeBlock($v);
}
}
$result[$v] = $this->m_varvals[$v];
}
return $result;
}
}
/** Gets undefined
* @notes Internal Use
*/
function get_undefined($varname)
{
$str = $this->get_var($varname);
preg_match_all("/\\{([a-zA-Z0-9_]+)\\}/", $str, $m);
$m = $m[1];
if (!is_array($m))
{
return false;
}
reset($m);
while(list($k, $v) = each($m))
{
if (!isset($this->m_varkeys[$v]))
{
$result[$v] = $v;
}
}
if (count($result))
{
return $result;
}
else
{
return false;
}
}
/** Decided what to do with unknown tags
* @notes Internal use
* @returns Processed string
*/
function finish($str)
{
switch ($this->m_unknowns)
{
case 'keep':
break;
case 'remove':
$str = preg_replace("/{[^ \t\r\n}]+}/", '', $str);
break;
case 'comment':
$str = preg_replace("/{[^ \t\r\n}]+}/", "<!-- Template $varname: Variable \\1 undefined -->", $str);
break;
}
return $str;
}
/** Print out template
* @param Alias to processed template
*/
function p($varname)
{
print $this->finish($this->get_var($varname));
}
/** Gets results for finished
* @notes Internal use
* @returns processed tabs from finished
*/
function get($varname)
{
return $this->finish($this->get_var($varname));
}
/** Remove unwanted characters from filename
* @notes Internal use
* @returns Returns file name if not error has occured
*/
function filename($filename)
{
if (substr($filename, 0, 1) == "/" || preg_match("/[a-z]{1}:/i",$filename) )
{
if (file_exists($filename))
{
return $filename;
}
else
{
$this->c_error->halt("filename (absolute): $filename does not exist.",0,__LINE__);
return false;
}
}
reset($this->m_root);
while(list($k, $v) = each($this->m_root))
{
$f = "$v/$filename";
if (file_exists($f))
{
return $f;
}
}
$this->c_error->halt("filename (relative): file $filename does not exist.",0,__LINE__);
return false;
}
/** Removed unwanted characters for block name
* @notes Internal use
* @returns Block name
*/
function varname($m_varname)
{
return preg_quote("{".$m_varname."}");
}
/** Open the files
* @notes Internal use
* @returns Processed string
*/
function loadfile($varname)
{
if (!isset($this->m_file[$varname]))
{
$this->c_error->halt("loadfile: $varname is not a valid varname.",0,__LINE__);
return false;
}
$filename = $this->filename($this->m_file[$varname]);
$str = implode('', @file($filename));
if (empty($str))
{
$this->c_error->halt("loadfile: While loading $varname, $filename does not exist or is empty.",0,__LINE__);
return false;
}
$this->set_var($varname, $str);
return true;
}
/** Implode Blocks
* @notes Internal use
*/
function implodeBlock($varname)
{
$parent = $this->m_block[$varname]['parent'];
$alias = $this->m_block[$varname]['alias'];
$str = $this->get_var($parent);
$reg = "/<!--\\s+BEGIN $varname\\s+-->(.*)\n\s*<!--\\s+END $varname\\s+-->/sm";
if (!preg_match_all($reg, $str, $m))
{
$this->c_error->halt("implodeBlock - no match for $varname variable",0,__LINE__);
}
else
{
$str = preg_replace($reg, "{"."$alias}", $str);
$this->set_var($varname, $m[1][0]);
$this->set_var($parent, $str);
}
}
}
?>