formatting, globals

This commit is contained in:
Miles Lott 2001-10-17 18:15:04 +00:00
parent d2cc52c47d
commit e6e3e567bc
3 changed files with 440 additions and 374 deletions

View File

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

View File

@ -27,19 +27,18 @@
{ {
var $enabled = False; var $enabled = False;
var $mcrypt_version = ''; var $mcrypt_version = '';
var $td = False; // Handle for mcrypt var $td = False; // Handle for mcrypt
var $iv = ''; var $iv = '';
var $key = ''; var $key = '';
function crypto($vars) function crypto($vars)
{ {
global $phpgw, $phpgw_info;
$key = $vars[0]; $key = $vars[0];
$iv = $vars[1]; $iv = $vars[1];
if ($phpgw_info['server']['mcrypt_enabled'] && extension_loaded('mcrypt')) if ($GLOBALS['phpgw_info']['server']['mcrypt_enabled'] && extension_loaded('mcrypt'))
{ {
$this->enabled = True; $this->enabled = True;
$this->mcrypt_version = $phpgw_info['server']['versions']['mcrypt']; $this->mcrypt_version = $GLOBALS['phpgw_info']['server']['versions']['mcrypt'];
if ($this->mcrypt_version == 'old') if ($this->mcrypt_version == 'old')
{ {
$this->td = false; $this->td = false;
@ -51,7 +50,7 @@
else else
{ {
$keysize = 8; $keysize = 8;
$ivsize = 8; $ivsize = 8;
} }
} }
else else
@ -83,8 +82,6 @@
function cleanup() function cleanup()
{ {
global $phpgw_info;
if ($this->enabled) if ($this->enabled)
{ {
if ($this->mcrypt_version != 'old') if ($this->mcrypt_version != 'old')
@ -102,8 +99,6 @@
function encrypt($data) function encrypt($data)
{ {
global $phpgw_info;
$data = serialize($data); $data = serialize($data);
$data = addslashes($data); $data = addslashes($data);
@ -129,15 +124,13 @@
return $encrypteddata; return $encrypteddata;
} }
else else
{ // No mcrypt == insecure ! { // No mcrypt == insecure !
return $data; return $data;
} }
} }
function decrypt($encrypteddata) function decrypt($encrypteddata)
{ {
global $phpgw_info;
// Disable all encryption if the admin didn't set it up // Disable all encryption if the admin didn't set it up
if ($this->enabled) if ($this->enabled)
{ {
@ -170,5 +163,5 @@
return $data; return $data;
} }
} }
} // class crypto } // class crypto
?> ?>

View File

@ -100,7 +100,7 @@
*/ */
function link($url = '', $extravars = '') function link($url = '', $extravars = '')
{ {
global $phpgw, $phpgw_info, $usercookie, $kp3, $PHP_SELF; /* global $phpgw, $phpgw_info, $usercookie, $kp3, $PHP_SELF; */
return $this->session->link($url, $extravars); return $this->session->link($url, $extravars);
} }
@ -116,9 +116,9 @@
*/ */
function redirect($url = '') function redirect($url = '')
{ {
global $HTTP_ENV_VARS; /* global $HTTP_ENV_VARS; */
$iis = @strpos($HTTP_ENV_VARS['SERVER_SOFTWARE'], 'IIS', 0); $iis = @strpos($GLOBALS['HTTP_ENV_VARS']['SERVER_SOFTWARE'], 'IIS', 0);
if ( !$url ) if ( !$url )
{ {
@ -142,7 +142,7 @@
} }
/** /**
* Shortcut to tranlation class * Shortcut to translation class
* *
* This function is a basic wrapper to translation->translate() * This function is a basic wrapper to translation->translate()
* *
@ -156,9 +156,8 @@
*/ */
function lang($key, $m1 = '', $m2 = '', $m3 = '', $m4 = '') function lang($key, $m1 = '', $m2 = '', $m3 = '', $m4 = '')
{ {
global $phpgw; /* global $phpgw; */
return $this->translation->translate($key); return $this->translation->translate($key);
} }
/* end of class */ } /* end of class */
}
?> ?>