Index: branches/2.8.x/CHANGELOG =================================================================== --- branches/2.8.x/CHANGELOG (revision 1165) +++ branches/2.8.x/CHANGELOG (revision 1166) @@ -12,6 +12,8 @@ ------------------------------------- 2.8.1 ------------------------------------- 12-Oct-2009 Dietmar Woellbrink +# fixes Bugs headersend errors in some core files +12-Oct-2009 Dietmar Woellbrink ! update function show_bread_crumb in framework/frontend.functions.php ! replace separator with entities char, add title for multilingual ! set breakcrumb in div container class="breadcrumb" Index: branches/2.8.x/wb/include/phplib/template.inc =================================================================== --- branches/2.8.x/wb/include/phplib/template.inc (revision 1165) +++ branches/2.8.x/wb/include/phplib/template.inc (revision 1166) @@ -1,1026 +1,1026 @@ -: - * (credits given to first person to post a diff to phplib mailing list) - * - * Normalised all comments and whitespace (rha) - * replaced "$handle" with "$varname" and "$h" with "$v" throughout (from phplib-devel) - * added braces around all one-line if statements in: get_undefined, loadfile and halt (rha) - * set_var was missing two sets of braces (rha) - * added a couple of "return true" statements (rha) - * set_unknowns had "keep" as default instead of "remove" (from phplib-devel) - * set_file failed to check for empty strings if passed an array of filenames (phplib-devel) - * remove @ from call to preg_replace in subst -- report errors if there are any (NickM) - * set_block unnecessarily required a newline in the template file (Marc Tardif) - * pparse now calls this->finish to replace undefined vars (Layne Weathers) - * get_var now checks for unset varnames (NickM & rha) - * get_var when passed an array used the array key instead of the value (rha) - * get_vars now uses a call to get_var rather than this->varvals to prevent undefined var warning (rha) - * in finish, the replacement string referenced an unset variable (rha) - * loadfile would try to load a file if the varval had been set to "" (rha) - * in get_undefined, only match non-whitespace in variable tags as in finish (Layne Weathers & rha) - * more elegant fix to the problem of subst stripping '$n', '\n' and '\\' strings (rha) - * parse uses get_var to obtain return value (Jordi via SF) - * set_block reports an error if the block could not be extracted (rha) - * filename is now windows-pathname aware (krabu @ SF) - * - * - * Changes in functionality which go beyond bug fixes: - * - * added ability for filename comments to be output (from phplib-users layne) - * changed debug handling so set, get and internals can be tracked separately (rha) - * added debug statements throughout to track most function calls (rha) - * debug output contained raw HTML -- is now escaped with htmlentities (rha) - * Alter regex in set_block to remove more whitespace around BEGIN/END tags to improve HTML layout (rha) - * Add "append" option to set_var, works just like append in parse (dale at linuxwebpro.com, rha) - * Altered parse so that append is honored if passed an array (Brian) - * Converted comments and documentation to phpdoc style (rha) - * Added clear_var to set the value of variables to "" (rha) - * Added unset_var to usset variables (rha) - * - */ - -/** - * The template class allows you to keep your HTML code in some external files - * which are completely free of PHP code, but contain replacement fields. - * The class provides you with functions which can fill in the replacement fields - * with arbitrary strings. These strings can become very large, e.g. entire tables. - * - * Note: If you think that this is like FastTemplates, read carefully. It isn't. - * - */ - -class Template -{ - /** - * Serialization helper, the name of this class. - * - * @var string - * @access public - */ - var $classname = "Template"; - - /** - * Determines how much debugging output Template will produce. - * This is a bitwise mask of available debug levels: - * 0 = no debugging - * 1 = debug variable assignments - * 2 = debug calls to get variable - * 4 = debug internals (outputs all function calls with parameters). - * - * Note: setting $this->debug = true will enable debugging of variable - * assignments only which is the same behaviour as versions up to release 7.2d. - * - * @var int - * @access public - */ - var $debug = false; - - /** - * Determines whether Template outputs filename comments. - * false = no filename outputs - * true = HTML comments (e.g. ) placed in output - * - * @var int - * @access public - */ - var $filename_comments = false; - - /** - * Determines the regular expression used to find unknown variable tags. - * "loose" = traditional match all curly braces with no whitespace between - * "strict" = adopts PHP's variable naming rules - * ("loose" has a nasty habit of deleting JavaScript RegEx components) - * (should future major version releases of PHPLib default this "strict"?) - * - * @var string - * @access public - */ - var $unknown_regexp = "loose"; - - /** - * The base directory from which template files are loaded. - * - * @var string - * @access private - * @see set_root - */ - var $root = "."; - - /** - * A hash of strings forming a translation table which translates variable names - * into names of files containing the variable content. - * $file[varname] = "filename"; - * - * @var array - * @access private - * @see set_file - */ - var $file = array(); - - /** - * A hash of strings forming a translation table which translates variable names - * into regular expressions for themselves. - * $varkeys[varname] = "/varname/" - * - * @var array - * @access private - * @see set_var - */ - var $varkeys = array(); - - /** - * A hash of strings forming a translation table which translates variable names - * into values for their respective varkeys. - * $varvals[varname] = "value" - * - * @var array - * @access private - * @see set_var - */ - var $varvals = array(); - - /** - * Determines how to output variable tags with no assigned value in templates. - * - * @var string - * @access private - * @see set_unknowns - */ - var $unknowns = "remove"; - - /** - * Determines how Template handles error conditions. - * "yes" = the error is reported, then execution is halted - * "report" = the error is reported, then execution continues by returning "false" - * "no" = errors are silently ignored, and execution resumes reporting "false" - * - * @var string - * @access public - * @see halt - */ - var $halt_on_error = "yes"; - - /** - * The last error message is retained in this variable. - * - * @var string - * @access public - * @see halt - */ - var $last_error = ""; - - /****************************************************************************** - * Class constructor. May be called with two optional parameters. - * The first parameter sets the template directory the second parameter - * sets the policy regarding handling of unknown variables. - * - * usage: Template([string $root = "."], [string $unknowns = "remove"]) - * - * @param $root path to template directory - * @param $string what to do with undefined variables - * @see set_root - * @see set_unknowns - * @access public - * @return void - */ - function Template($root = ".", $unknowns = "remove") { - if ($this->debug & 4) { - echo "

Template: root = $root, unknowns = $unknowns

\n"; - } - $this->set_root($root); - $this->set_unknowns($unknowns); - } - - - /****************************************************************************** - * Checks that $root is a valid directory and if so sets this directory as the - * base directory from which templates are loaded by storing the value in - * $this->root. Relative filenames are prepended with the path in $this->root. - * - * Returns true on success, false on error. - * - * usage: set_root(string $root) - * - * @param $root string containing new template directory - * @see root - * @access public - * @return boolean - */ - function set_root($root) { - if(ereg('/$', $root)) { - $root = substr($root, 0, -1); - } - if ($this->debug & 4) { - echo "

set_root: root = $root

\n"; - } - if (!is_dir($root)) { - $this->halt("set_root: $root is not a directory."); - return false; - } - - $this->root = $root; - return true; - } - - - /****************************************************************************** - * Sets the policy for dealing with unresolved variable names. - * - * unknowns defines what to do with undefined template variables - * "remove" = remove undefined variables - * "comment" = replace undefined variables with comments - * "keep" = keep undefined variables - * - * Note: "comment" can cause unexpected results when the variable tag is embedded - * inside an HTML tag, for example a tag which is expected to be replaced with a URL. - * - * usage: set_unknowns(string $unknowns) - * - * @param $unknowns new value for unknowns - * @see unknowns - * @access public - * @return void - */ - function set_unknowns($unknowns = "remove") { - if ($this->debug & 4) { - echo "

unknowns: unknowns = $unknowns

\n"; - } - $this->unknowns = $unknowns; - } - - - /****************************************************************************** - * Defines a filename for the initial value of a variable. - * - * It may be passed either a varname and a file name as two strings or - * a hash of strings with the key being the varname and the value - * being the file name. - * - * The new mappings are stored in the array $this->file. - * The files are not loaded yet, but only when needed. - * - * Returns true on success, false on error. - * - * usage: set_file(array $filelist = (string $varname => string $filename)) - * or - * usage: set_file(string $varname, string $filename) - * - * @param $varname either a string containing a varname or a hash of varname/file name pairs. - * @param $filename if varname is a string this is the filename otherwise filename is not required - * @access public - * @return boolean - */ - function set_file($varname, $filename = "") { - if (!is_array($varname)) { - if ($this->debug & 4) { - echo "

set_file: (with scalar) varname = $varname, filename = $filename

\n"; - } - if ($filename == "") { - $this->halt("set_file: For varname $varname filename is empty."); - return false; - } - $this->file[$varname] = $this->filename($filename); - } else { - reset($varname); - while (list($v, $f) = each($varname)) { - if ($this->debug & 4) { - echo "

set_file: (with array) varname = $v, filename = $f

\n"; - } - if ($f == "") { - $this->halt("set_file: For varname $v filename is empty."); - return false; - } - $this->file[$v] = $this->filename($f); - } - } - return true; - } - - - /****************************************************************************** - * A variable $parent may contain a variable block defined by: - * <!-- BEGIN $varname --> content <!-- END $varname -->. This function removes - * that block from $parent and replaces it with a variable reference named $name. - * The block is inserted into the varkeys and varvals hashes. If $name is - * omitted, it is assumed to be the same as $varname. - * - * Blocks may be nested but care must be taken to extract the blocks in order - * from the innermost block to the outermost block. - * - * Returns true on success, false on error. - * - * usage: set_block(string $parent, string $varname, [string $name = ""]) - * - * @param $parent a string containing the name of the parent variable - * @param $varname a string containing the name of the block to be extracted - * @param $name the name of the variable in which to store the block - * @access public - * @return boolean - */ - function set_block($parent, $varname, $name = "") { - if ($this->debug & 4) { - echo "

set_block: parent = $parent, varname = $varname, name = $name

\n"; - } - if (!$this->loadfile($parent)) { - $this->halt("set_block: unable to load $parent."); - return false; - } - if ($name == "") { - $name = $varname; - } - - $str = $this->get_var($parent); - $reg = "/[ \t]*\s*?\n?(\s*.*?\n?)\s*\s*?\n?/sm"; - preg_match_all($reg, $str, $m); -/* workaround to avoid problems with some WB files/modules (e.g. massmail) - if (!isset($m[1][0])) { - $this->halt("set_block: unable to set block $varname."); - return false; - } -*/ - $str = preg_replace($reg, "{" . $name . "}", $str); - @$this->set_var($varname, $m[1][0]); - $this->set_var($parent, $str); - return true; - } - - - /****************************************************************************** - * This functions sets the value of a variable. - * - * It may be called with either a varname and a value as two strings or an - * an associative array with the key being the varname and the value being - * the new variable value. - * - * The function inserts the new value of the variable into the $varkeys and - * $varvals hashes. It is not necessary for a variable to exist in these hashes - * before calling this function. - * - * An optional third parameter allows the value for each varname to be appended - * to the existing variable instead of replacing it. The default is to replace. - * This feature was introduced after the 7.2d release. - * - * - * usage: set_var(string $varname, [string $value = ""], [boolean $append = false]) - * or - * usage: set_var(array $varname = (string $varname => string $value), [mixed $dummy_var], [boolean $append = false]) - * - * @param $varname either a string containing a varname or a hash of varname/value pairs. - * @param $value if $varname is a string this contains the new value for the variable otherwise this parameter is ignored - * @param $append if true, the value is appended to the variable's existing value - * @access public - * @return void - */ - function set_var($varname, $value = "", $append = false) { - if (!is_array($varname)) { - if (!empty($varname)) { - if ($this->debug & 1) { - printf("set_var: (with scalar) %s = '%s'
\n", $varname, htmlentities($value)); - } - $this->varkeys[$varname] = "/".$this->varname($varname)."/"; - if ($append && isset($this->varvals[$varname])) { - $this->varvals[$varname] .= $value; - } else { - $this->varvals[$varname] = $value; - } - } - } else { - reset($varname); - while (list($k, $v) = each($varname)) { - if (!empty($k)) { - if ($this->debug & 1) { - printf("set_var: (with array) %s = '%s'
\n", $k, htmlentities($v)); - } - $this->varkeys[$k] = "/".$this->varname($k)."/"; - if ($append && isset($this->varvals[$k])) { - $this->varvals[$k] .= $v; - } else { - $this->varvals[$k] = $v; - } - } - } - } - } - - - /****************************************************************************** - * This functions clears the value of a variable. - * - * It may be called with either a varname as a string or an array with the - * values being the varnames to be cleared. - * - * The function sets the value of the variable in the $varkeys and $varvals - * hashes to "". It is not necessary for a variable to exist in these hashes - * before calling this function. - * - * - * usage: clear_var(string $varname) - * or - * usage: clear_var(array $varname = (string $varname)) - * - * @param $varname either a string containing a varname or an array of varnames. - * @access public - * @return void - */ - function clear_var($varname) { - if (!is_array($varname)) { - if (!empty($varname)) { - if ($this->debug & 1) { - printf("clear_var: (with scalar) %s
\n", $varname); - } - $this->set_var($varname, ""); - } - } else { - reset($varname); - while (list($k, $v) = each($varname)) { - if (!empty($v)) { - if ($this->debug & 1) { - printf("clear_var: (with array) %s
\n", $v); - } - $this->set_var($v, ""); - } - } - } - } - - - /****************************************************************************** - * This functions unsets a variable completely. - * - * It may be called with either a varname as a string or an array with the - * values being the varnames to be cleared. - * - * The function removes the variable from the $varkeys and $varvals hashes. - * It is not necessary for a variable to exist in these hashes before calling - * this function. - * - * - * usage: unset_var(string $varname) - * or - * usage: unset_var(array $varname = (string $varname)) - * - * @param $varname either a string containing a varname or an array of varnames. - * @access public - * @return void - */ - function unset_var($varname) { - if (!is_array($varname)) { - if (!empty($varname)) { - if ($this->debug & 1) { - printf("unset_var: (with scalar) %s
\n", $varname); - } - unset($this->varkeys[$varname]); - unset($this->varvals[$varname]); - } - } else { - reset($varname); - while (list($k, $v) = each($varname)) { - if (!empty($v)) { - if ($this->debug & 1) { - printf("unset_var: (with array) %s
\n", $v); - } - unset($this->varkeys[$v]); - unset($this->varvals[$v]); - } - } - } - } - - - /****************************************************************************** - * This function fills in all the variables contained within the variable named - * $varname. The resulting value is returned as the function result and the - * original value of the variable varname is not changed. The resulting string - * is not "finished", that is, the unresolved variable name policy has not been - * applied yet. - * - * Returns: the value of the variable $varname with all variables substituted. - * - * usage: subst(string $varname) - * - * @param $varname the name of the variable within which variables are to be substituted - * @access public - * @return string - */ - function subst($varname) { - $varvals_quoted = array(); - if ($this->debug & 4) { - echo "

subst: varname = $varname

\n"; - } - if (!$this->loadfile($varname)) { - $this->halt("subst: unable to load $varname."); - return false; - } - - // quote the replacement strings to prevent bogus stripping of special chars - reset($this->varvals); - while (list($k, $v) = each($this->varvals)) { - $varvals_quoted[$k] = preg_replace(array('/\\\\/', '/\$/'), array('\\\\\\\\', '\\\\$'), $v); - } - - $str = $this->get_var($varname); - $str = preg_replace($this->varkeys, $varvals_quoted, $str); - return $str; - } - - - /****************************************************************************** - * This is shorthand for print $this->subst($varname). See subst for further - * details. - * - * Returns: always returns false. - * - * usage: psubst(string $varname) - * - * @param $varname the name of the variable within which variables are to be substituted - * @access public - * @return false - * @see subst - */ - function psubst($varname) { - if ($this->debug & 4) { - echo "

psubst: varname = $varname

\n"; - } - print $this->subst($varname); - - return false; - } - - - /****************************************************************************** - * The function substitutes the values of all defined variables in the variable - * named $varname and stores or appends the result in the variable named $target. - * - * It may be called with either a target and a varname as two strings or a - * target as a string and an array of variable names in varname. - * - * The function inserts the new value of the variable into the $varkeys and - * $varvals hashes. It is not necessary for a variable to exist in these hashes - * before calling this function. - * - * An optional third parameter allows the value for each varname to be appended - * to the existing target variable instead of replacing it. The default is to - * replace. - * - * If $target and $varname are both strings, the substituted value of the - * variable $varname is inserted into or appended to $target. - * - * If $handle is an array of variable names the variables named by $handle are - * sequentially substituted and the result of each substitution step is - * inserted into or appended to in $target. The resulting substitution is - * available in the variable named by $target, as is each intermediate step - * for the next $varname in sequence. Note that while it is possible, it - * is only rarely desirable to call this function with an array of varnames - * and with $append = true. This append feature was introduced after the 7.2d - * release. - * - * Returns: the last value assigned to $target. - * - * usage: parse(string $target, string $varname, [boolean $append]) - * or - * usage: parse(string $target, array $varname = (string $varname), [boolean $append]) - * - * @param $target a string containing the name of the variable into which substituted $varnames are to be stored - * @param $varname if a string, the name the name of the variable to substitute or if an array a list of variables to be substituted - * @param $append if true, the substituted variables are appended to $target otherwise the existing value of $target is replaced - * @access public - * @return string - * @see subst - */ - function parse($target, $varname, $append = false) { - if (!is_array($varname)) { - if ($this->debug & 4) { - echo "

parse: (with scalar) target = $target, varname = $varname, append = $append

\n"; - } - $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, $v) = each($varname)) { - if ($this->debug & 4) { - echo "

parse: (with array) target = $target, i = $i, varname = $v, append = $append

\n"; - } - $str = $this->subst($v); - if ($append) { - $this->set_var($target, $this->get_var($target) . $str); - } else { - $this->set_var($target, $str); - } - } - } - - if ($this->debug & 4) { - echo "

parse: completed

\n"; - } - return $this->get_var($target); - } - - - /****************************************************************************** - * This is shorthand for print $this->parse(...) and is functionally identical. - * See parse for further details. - * - * Returns: always returns false. - * - * usage: pparse(string $target, string $varname, [boolean $append]) - * or - * usage: pparse(string $target, array $varname = (string $varname), [boolean $append]) - * - * @param $target a string containing the name of the variable into which substituted $varnames are to be stored - * @param $varname if a string, the name the name of the variable to substitute or if an array a list of variables to be substituted - * @param $append if true, the substituted variables are appended to $target otherwise the existing value of $target is replaced - * @access public - * @return false - * @see parse - */ - function pparse($target, $varname, $append = false, $clear = true) { // added $clear: whether to delete undefined vars or not (needed for wb-module code) - thorn - if ($this->debug & 4) { - echo "

pparse: passing parameters to parse...

\n"; - } - if(!$clear) { - $unknowns = $this->unknowns; - $this->set_unknowns('keep'); - print $this->finish($this->parse($target, $varname, $append)); - $this->set_unknowns($unknowns); - } else { - print $this->finish($this->parse($target, $varname, $append)); - } - return false; - } - - - /****************************************************************************** - * This function returns an associative array of all defined variables with the - * name as the key and the value of the variable as the value. - * - * This is mostly useful for debugging. Also note that $this->debug can be used - * to echo all variable assignments as they occur and to trace execution. - * - * Returns: a hash of all defined variable values keyed by their names. - * - * usage: get_vars() - * - * @access public - * @return array - * @see $debug - */ - function get_vars() { - if ($this->debug & 4) { - echo "

get_vars: constructing array of vars...

\n"; - } - reset($this->varkeys); - while (list($k, $v) = each($this->varkeys)) { - $result[$k] = $this->get_var($k); - } - return $result; - } - - - /****************************************************************************** - * This function returns the value of the variable named by $varname. - * If $varname references a file and that file has not been loaded yet, the - * variable will be reported as empty. - * - * When called with an array of variable names this function will return a a - * hash of variable values keyed by their names. - * - * Returns: a string or an array containing the value of $varname. - * - * usage: get_var(string $varname) - * or - * usage: get_var(array $varname) - * - * @param $varname if a string, the name the name of the variable to get the value of, or if an array a list of variables to return the value of - * @access public - * @return string or array - */ - function get_var($varname) { - if (!is_array($varname)) { - if (isset($this->varvals[$varname])) { - $str = $this->varvals[$varname]; - } else { - $str = ""; - } - if ($this->debug & 2) { - printf ("get_var (with scalar) %s = '%s'
\n", $varname, htmlentities($str)); - } - return $str; - } else { - reset($varname); - while (list($k, $v) = each($varname)) { - if (isset($this->varvals[$v])) { - $str = $this->varvals[$v]; - } else { - $str = ""; - } - if ($this->debug & 2) { - printf ("get_var: (with array) %s = '%s'
\n", $v, htmlentities($str)); - } - $result[$v] = $str; - } - return $result; - } - } - - - /****************************************************************************** - * This function returns a hash of unresolved variable names in $varname, keyed - * by their names (that is, the hash has the form $a[$name] = $name). - * - * Returns: a hash of varname/varname pairs or false on error. - * - * usage: get_undefined(string $varname) - * - * @param $varname a string containing the name the name of the variable to scan for unresolved variables - * @access public - * @return array - */ - function get_undefined($varname) { - if ($this->debug & 4) { - echo "

get_undefined: varname = $varname

\n"; - } - if (!$this->loadfile($varname)) { - $this->halt("get_undefined: unable to load $varname."); - return false; - } - - preg_match_all( - (("loose" == $this->unknown_regexp) ? "/{([^ \t\r\n}]+)}/" : "/{([_a-zA-Z]\\w+)}/"), - $this->get_var($varname), - $m); - $m = $m[1]; - if (!is_array($m)) { - return false; - } - - reset($m); - while (list($k, $v) = each($m)) { - if (!isset($this->varkeys[$v])) { - if ($this->debug & 4) { - echo "

get_undefined: undefined: $v

\n"; - } - $result[$v] = $v; - } - } - - if (count($result)) { - return $result; - } else { - return false; - } - } - - - /****************************************************************************** - * This function returns the finished version of $str. That is, the policy - * regarding unresolved variable names will be applied to $str. - * - * Returns: a finished string derived from $str and $this->unknowns. - * - * usage: finish(string $str) - * - * @param $str a string to which to apply the unresolved variable policy - * @access public - * @return string - * @see set_unknowns - */ - function finish($str) { - switch ($this->unknowns) { - case "keep": - break; - - case "remove": - $str = preg_replace( - (("loose" == $this->unknown_regexp) ? "/{([^ \t\r\n}]+)}/" : "/{([_a-zA-Z]\\w+)}/"), - "", - $str); - break; - - case "comment": - $str = preg_replace( - (("loose" == $this->unknown_regexp) ? "/{([^ \t\r\n}]+)}/" : "/{([_a-zA-Z]\\w+)}/"), - "", - $str); - break; - } - - return $str; - } - - - /****************************************************************************** - * This function prints the finished version of the value of the variable named - * by $varname. That is, the policy regarding unresolved variable names will be - * applied to the variable $varname then it will be printed. - * - * usage: p(string $varname) - * - * @param $varname a string containing the name of the variable to finish and print - * @access public - * @return void - * @see set_unknowns - * @see finish - */ - function p($varname) { - print $this->finish($this->get_var($varname)); - } - - - /****************************************************************************** - * This function returns the finished version of the value of the variable named - * by $varname. That is, the policy regarding unresolved variable names will be - * applied to the variable $varname and the result returned. - * - * Returns: a finished string derived from the variable $varname. - * - * usage: get(string $varname) - * - * @param $varname a string containing the name of the variable to finish - * @access public - * @return void - * @see set_unknowns - * @see finish - */ - function get($varname) { - return $this->finish($this->get_var($varname)); - } - - - /****************************************************************************** - * When called with a relative pathname, this function will return the pathname - * with $this->root prepended. Absolute pathnames are returned unchanged. - * - * Returns: a string containing an absolute pathname. - * - * usage: filename(string $filename) - * - * @param $filename a string containing a filename - * @access private - * @return string - * @see set_root - */ - function filename($filename) { - if ($this->debug & 4) { - echo "

filename: filename = $filename

\n"; - } - if (substr($filename, 0, 1) != "/" - && substr($filename, 0, 1) != "\\" - && substr($filename, 1, 2) != ":\\" - && substr($filename, 1, 2) != ":/" - ) { - $filename = $this->root."/".$filename; - } - - if (!file_exists($filename)) { - $this->halt("filename: file $filename does not exist."); - } - return $filename; - } - - - /****************************************************************************** - * This function will construct a regexp for a given variable name with any - * special chars quoted. - * - * Returns: a string containing an escaped variable name. - * - * usage: varname(string $varname) - * - * @param $varname a string containing a variable name - * @access private - * @return string - */ - function varname($varname) { - return preg_quote("{" . $varname . "}"); - } - - - /****************************************************************************** - * If a variable's value is undefined and the variable has a filename stored in - * $this->file[$varname] then the backing file will be loaded and the file's - * contents will be assigned as the variable's value. - * - * Note that the behaviour of this function changed slightly after the 7.2d - * release. Where previously a variable was reloaded from file if the value - * was empty, now this is not done. This allows a variable to be loaded then - * set to "", and also prevents attempts to load empty variables. Files are - * now only loaded if $this->varvals[$varname] is unset. - * - * Returns: true on success, false on error. - * - * usage: loadfile(string $varname) - * - * @param $varname a string containing the name of a variable to load - * @access private - * @return boolean - * @see set_file - */ - function loadfile($varname) { - if ($this->debug & 4) { - echo "

loadfile: varname = $varname

\n"; - } - - if (!isset($this->file[$varname])) { - // $varname does not reference a file so return - if ($this->debug & 4) { - echo "

loadfile: varname $varname does not reference a file

\n"; - } - return true; - } - - if (isset($this->varvals[$varname])) { - // will only be unset if varname was created with set_file and has never been loaded - // $varname has already been loaded so return - if ($this->debug & 4) { - echo "

loadfile: varname $varname is already loaded

\n"; - } - return true; - } - $filename = $this->file[$varname]; - - /* use @file here to avoid leaking filesystem information if there is an error */ - $str = implode("", @file($filename)); - if (empty($str)) { - $this->halt("loadfile: While loading $varname, $filename does not exist or is empty."); - return false; - } - - if ($this->filename_comments) { - $str = "\n$str\n"; - } - if ($this->debug & 4) { - printf("loadfile: loaded $filename into $varname
\n"); - } - $this->set_var($varname, $str); - - return true; - } - - - /****************************************************************************** - * This function is called whenever an error occurs and will handle the error - * according to the policy defined in $this->halt_on_error. Additionally the - * error message will be saved in $this->last_error. - * - * Returns: always returns false. - * - * usage: halt(string $msg) - * - * @param $msg a string containing an error message - * @access private - * @return void - * @see $halt_on_error - */ - function halt($msg) { - $this->last_error = $msg; - - if ($this->halt_on_error != "no") { - $this->haltmsg($msg); - } - - if ($this->halt_on_error == "yes") { - die("Halted."); - } - - return false; - } - - - /****************************************************************************** - * This function prints an error message. - * It can be overridden by your subclass of Template. It will be called with an - * error message to display. - * - * usage: haltmsg(string $msg) - * - * @param $msg a string containing the error message to display - * @access public - * @return void - * @see halt - */ - function haltmsg($msg) { - printf("Template Error: %s
\n", $msg); - } - -} -?> +: + * (credits given to first person to post a diff to phplib mailing list) + * + * Normalised all comments and whitespace (rha) + * replaced "$handle" with "$varname" and "$h" with "$v" throughout (from phplib-devel) + * added braces around all one-line if statements in: get_undefined, loadfile and halt (rha) + * set_var was missing two sets of braces (rha) + * added a couple of "return true" statements (rha) + * set_unknowns had "keep" as default instead of "remove" (from phplib-devel) + * set_file failed to check for empty strings if passed an array of filenames (phplib-devel) + * remove @ from call to preg_replace in subst -- report errors if there are any (NickM) + * set_block unnecessarily required a newline in the template file (Marc Tardif) + * pparse now calls this->finish to replace undefined vars (Layne Weathers) + * get_var now checks for unset varnames (NickM & rha) + * get_var when passed an array used the array key instead of the value (rha) + * get_vars now uses a call to get_var rather than this->varvals to prevent undefined var warning (rha) + * in finish, the replacement string referenced an unset variable (rha) + * loadfile would try to load a file if the varval had been set to "" (rha) + * in get_undefined, only match non-whitespace in variable tags as in finish (Layne Weathers & rha) + * more elegant fix to the problem of subst stripping '$n', '\n' and '\\' strings (rha) + * parse uses get_var to obtain return value (Jordi via SF) + * set_block reports an error if the block could not be extracted (rha) + * filename is now windows-pathname aware (krabu @ SF) + * + * + * Changes in functionality which go beyond bug fixes: + * + * added ability for filename comments to be output (from phplib-users layne) + * changed debug handling so set, get and internals can be tracked separately (rha) + * added debug statements throughout to track most function calls (rha) + * debug output contained raw HTML -- is now escaped with htmlentities (rha) + * Alter regex in set_block to remove more whitespace around BEGIN/END tags to improve HTML layout (rha) + * Add "append" option to set_var, works just like append in parse (dale at linuxwebpro.com, rha) + * Altered parse so that append is honored if passed an array (Brian) + * Converted comments and documentation to phpdoc style (rha) + * Added clear_var to set the value of variables to "" (rha) + * Added unset_var to usset variables (rha) + * + */ + +/** + * The template class allows you to keep your HTML code in some external files + * which are completely free of PHP code, but contain replacement fields. + * The class provides you with functions which can fill in the replacement fields + * with arbitrary strings. These strings can become very large, e.g. entire tables. + * + * Note: If you think that this is like FastTemplates, read carefully. It isn't. + * + */ + +class Template +{ + /** + * Serialization helper, the name of this class. + * + * @var string + * @access public + */ + var $classname = "Template"; + + /** + * Determines how much debugging output Template will produce. + * This is a bitwise mask of available debug levels: + * 0 = no debugging + * 1 = debug variable assignments + * 2 = debug calls to get variable + * 4 = debug internals (outputs all function calls with parameters). + * + * Note: setting $this->debug = true will enable debugging of variable + * assignments only which is the same behaviour as versions up to release 7.2d. + * + * @var int + * @access public + */ + var $debug = false; + + /** + * Determines whether Template outputs filename comments. + * false = no filename outputs + * true = HTML comments (e.g. ) placed in output + * + * @var int + * @access public + */ + var $filename_comments = false; + + /** + * Determines the regular expression used to find unknown variable tags. + * "loose" = traditional match all curly braces with no whitespace between + * "strict" = adopts PHP's variable naming rules + * ("loose" has a nasty habit of deleting JavaScript RegEx components) + * (should future major version releases of PHPLib default this "strict"?) + * + * @var string + * @access public + */ + var $unknown_regexp = "loose"; + + /** + * The base directory from which template files are loaded. + * + * @var string + * @access private + * @see set_root + */ + var $root = "."; + + /** + * A hash of strings forming a translation table which translates variable names + * into names of files containing the variable content. + * $file[varname] = "filename"; + * + * @var array + * @access private + * @see set_file + */ + var $file = array(); + + /** + * A hash of strings forming a translation table which translates variable names + * into regular expressions for themselves. + * $varkeys[varname] = "/varname/" + * + * @var array + * @access private + * @see set_var + */ + var $varkeys = array(); + + /** + * A hash of strings forming a translation table which translates variable names + * into values for their respective varkeys. + * $varvals[varname] = "value" + * + * @var array + * @access private + * @see set_var + */ + var $varvals = array(); + + /** + * Determines how to output variable tags with no assigned value in templates. + * + * @var string + * @access private + * @see set_unknowns + */ + var $unknowns = "remove"; + + /** + * Determines how Template handles error conditions. + * "yes" = the error is reported, then execution is halted + * "report" = the error is reported, then execution continues by returning "false" + * "no" = errors are silently ignored, and execution resumes reporting "false" + * + * @var string + * @access public + * @see halt + */ + var $halt_on_error = "yes"; + + /** + * The last error message is retained in this variable. + * + * @var string + * @access public + * @see halt + */ + var $last_error = ""; + + /****************************************************************************** + * Class constructor. May be called with two optional parameters. + * The first parameter sets the template directory the second parameter + * sets the policy regarding handling of unknown variables. + * + * usage: Template([string $root = "."], [string $unknowns = "remove"]) + * + * @param $root path to template directory + * @param $string what to do with undefined variables + * @see set_root + * @see set_unknowns + * @access public + * @return void + */ + function Template($root = ".", $unknowns = "remove") { + if ($this->debug & 4) { + echo "

Template: root = $root, unknowns = $unknowns

\n"; + } + $this->set_root($root); + $this->set_unknowns($unknowns); + } + + + /****************************************************************************** + * Checks that $root is a valid directory and if so sets this directory as the + * base directory from which templates are loaded by storing the value in + * $this->root. Relative filenames are prepended with the path in $this->root. + * + * Returns true on success, false on error. + * + * usage: set_root(string $root) + * + * @param $root string containing new template directory + * @see root + * @access public + * @return boolean + */ + function set_root($root) { + if(ereg('/$', $root)) { + $root = substr($root, 0, -1); + } + if ($this->debug & 4) { + echo "

set_root: root = $root

\n"; + } + if (!is_dir($root)) { + $this->halt("set_root: $root is not a directory."); + return false; + } + + $this->root = $root; + return true; + } + + + /****************************************************************************** + * Sets the policy for dealing with unresolved variable names. + * + * unknowns defines what to do with undefined template variables + * "remove" = remove undefined variables + * "comment" = replace undefined variables with comments + * "keep" = keep undefined variables + * + * Note: "comment" can cause unexpected results when the variable tag is embedded + * inside an HTML tag, for example a tag which is expected to be replaced with a URL. + * + * usage: set_unknowns(string $unknowns) + * + * @param $unknowns new value for unknowns + * @see unknowns + * @access public + * @return void + */ + function set_unknowns($unknowns = "remove") { + if ($this->debug & 4) { + echo "

unknowns: unknowns = $unknowns

\n"; + } + $this->unknowns = $unknowns; + } + + + /****************************************************************************** + * Defines a filename for the initial value of a variable. + * + * It may be passed either a varname and a file name as two strings or + * a hash of strings with the key being the varname and the value + * being the file name. + * + * The new mappings are stored in the array $this->file. + * The files are not loaded yet, but only when needed. + * + * Returns true on success, false on error. + * + * usage: set_file(array $filelist = (string $varname => string $filename)) + * or + * usage: set_file(string $varname, string $filename) + * + * @param $varname either a string containing a varname or a hash of varname/file name pairs. + * @param $filename if varname is a string this is the filename otherwise filename is not required + * @access public + * @return boolean + */ + function set_file($varname, $filename = "") { + if (!is_array($varname)) { + if ($this->debug & 4) { + echo "

set_file: (with scalar) varname = $varname, filename = $filename

\n"; + } + if ($filename == "") { + $this->halt("set_file: For varname $varname filename is empty."); + return false; + } + $this->file[$varname] = $this->filename($filename); + } else { + reset($varname); + while (list($v, $f) = each($varname)) { + if ($this->debug & 4) { + echo "

set_file: (with array) varname = $v, filename = $f

\n"; + } + if ($f == "") { + $this->halt("set_file: For varname $v filename is empty."); + return false; + } + $this->file[$v] = $this->filename($f); + } + } + return true; + } + + + /****************************************************************************** + * A variable $parent may contain a variable block defined by: + * <!-- BEGIN $varname --> content <!-- END $varname -->. This function removes + * that block from $parent and replaces it with a variable reference named $name. + * The block is inserted into the varkeys and varvals hashes. If $name is + * omitted, it is assumed to be the same as $varname. + * + * Blocks may be nested but care must be taken to extract the blocks in order + * from the innermost block to the outermost block. + * + * Returns true on success, false on error. + * + * usage: set_block(string $parent, string $varname, [string $name = ""]) + * + * @param $parent a string containing the name of the parent variable + * @param $varname a string containing the name of the block to be extracted + * @param $name the name of the variable in which to store the block + * @access public + * @return boolean + */ + function set_block($parent, $varname, $name = "") { + if ($this->debug & 4) { + echo "

set_block: parent = $parent, varname = $varname, name = $name

\n"; + } + if (!$this->loadfile($parent)) { + $this->halt("set_block: unable to load $parent."); + return false; + } + if ($name == "") { + $name = $varname; + } + + $str = $this->get_var($parent); + $reg = "/[ \t]*\s*?\n?(\s*.*?\n?)\s*\s*?\n?/sm"; + preg_match_all($reg, $str, $m); +/* workaround to avoid problems with some WB files/modules (e.g. massmail) + if (!isset($m[1][0])) { + $this->halt("set_block: unable to set block $varname."); + return false; + } +*/ + $str = preg_replace($reg, "{" . $name . "}", $str); + @$this->set_var($varname, $m[1][0]); + $this->set_var($parent, $str); + return true; + } + + + /****************************************************************************** + * This functions sets the value of a variable. + * + * It may be called with either a varname and a value as two strings or an + * an associative array with the key being the varname and the value being + * the new variable value. + * + * The function inserts the new value of the variable into the $varkeys and + * $varvals hashes. It is not necessary for a variable to exist in these hashes + * before calling this function. + * + * An optional third parameter allows the value for each varname to be appended + * to the existing variable instead of replacing it. The default is to replace. + * This feature was introduced after the 7.2d release. + * + * + * usage: set_var(string $varname, [string $value = ""], [boolean $append = false]) + * or + * usage: set_var(array $varname = (string $varname => string $value), [mixed $dummy_var], [boolean $append = false]) + * + * @param $varname either a string containing a varname or a hash of varname/value pairs. + * @param $value if $varname is a string this contains the new value for the variable otherwise this parameter is ignored + * @param $append if true, the value is appended to the variable's existing value + * @access public + * @return void + */ + function set_var($varname, $value = "", $append = false) { + if (!is_array($varname)) { + if (!empty($varname)) { + if ($this->debug & 1) { + printf("set_var: (with scalar) %s = '%s'
\n", $varname, htmlentities($value)); + } + $this->varkeys[$varname] = "/".$this->varname($varname)."/"; + if ($append && isset($this->varvals[$varname])) { + $this->varvals[$varname] .= $value; + } else { + $this->varvals[$varname] = $value; + } + } + } else { + reset($varname); + while (list($k, $v) = each($varname)) { + if (!empty($k)) { + if ($this->debug & 1) { + printf("set_var: (with array) %s = '%s'
\n", $k, htmlentities($v)); + } + $this->varkeys[$k] = "/".$this->varname($k)."/"; + if ($append && isset($this->varvals[$k])) { + $this->varvals[$k] .= $v; + } else { + $this->varvals[$k] = $v; + } + } + } + } + } + + + /****************************************************************************** + * This functions clears the value of a variable. + * + * It may be called with either a varname as a string or an array with the + * values being the varnames to be cleared. + * + * The function sets the value of the variable in the $varkeys and $varvals + * hashes to "". It is not necessary for a variable to exist in these hashes + * before calling this function. + * + * + * usage: clear_var(string $varname) + * or + * usage: clear_var(array $varname = (string $varname)) + * + * @param $varname either a string containing a varname or an array of varnames. + * @access public + * @return void + */ + function clear_var($varname) { + if (!is_array($varname)) { + if (!empty($varname)) { + if ($this->debug & 1) { + printf("clear_var: (with scalar) %s
\n", $varname); + } + $this->set_var($varname, ""); + } + } else { + reset($varname); + while (list($k, $v) = each($varname)) { + if (!empty($v)) { + if ($this->debug & 1) { + printf("clear_var: (with array) %s
\n", $v); + } + $this->set_var($v, ""); + } + } + } + } + + + /****************************************************************************** + * This functions unsets a variable completely. + * + * It may be called with either a varname as a string or an array with the + * values being the varnames to be cleared. + * + * The function removes the variable from the $varkeys and $varvals hashes. + * It is not necessary for a variable to exist in these hashes before calling + * this function. + * + * + * usage: unset_var(string $varname) + * or + * usage: unset_var(array $varname = (string $varname)) + * + * @param $varname either a string containing a varname or an array of varnames. + * @access public + * @return void + */ + function unset_var($varname) { + if (!is_array($varname)) { + if (!empty($varname)) { + if ($this->debug & 1) { + printf("unset_var: (with scalar) %s
\n", $varname); + } + unset($this->varkeys[$varname]); + unset($this->varvals[$varname]); + } + } else { + reset($varname); + while (list($k, $v) = each($varname)) { + if (!empty($v)) { + if ($this->debug & 1) { + printf("unset_var: (with array) %s
\n", $v); + } + unset($this->varkeys[$v]); + unset($this->varvals[$v]); + } + } + } + } + + + /****************************************************************************** + * This function fills in all the variables contained within the variable named + * $varname. The resulting value is returned as the function result and the + * original value of the variable varname is not changed. The resulting string + * is not "finished", that is, the unresolved variable name policy has not been + * applied yet. + * + * Returns: the value of the variable $varname with all variables substituted. + * + * usage: subst(string $varname) + * + * @param $varname the name of the variable within which variables are to be substituted + * @access public + * @return string + */ + function subst($varname) { + $varvals_quoted = array(); + if ($this->debug & 4) { + echo "

subst: varname = $varname

\n"; + } + if (!$this->loadfile($varname)) { + $this->halt("subst: unable to load $varname."); + return false; + } + + // quote the replacement strings to prevent bogus stripping of special chars + reset($this->varvals); + while (list($k, $v) = each($this->varvals)) { + $varvals_quoted[$k] = preg_replace(array('/\\\\/', '/\$/'), array('\\\\\\\\', '\\\\$'), $v); + } + + $str = $this->get_var($varname); + $str = preg_replace($this->varkeys, $varvals_quoted, $str); + return $str; + } + + + /****************************************************************************** + * This is shorthand for print $this->subst($varname). See subst for further + * details. + * + * Returns: always returns false. + * + * usage: psubst(string $varname) + * + * @param $varname the name of the variable within which variables are to be substituted + * @access public + * @return false + * @see subst + */ + function psubst($varname) { + if ($this->debug & 4) { + echo "

psubst: varname = $varname

\n"; + } + print $this->subst($varname); + + return false; + } + + + /****************************************************************************** + * The function substitutes the values of all defined variables in the variable + * named $varname and stores or appends the result in the variable named $target. + * + * It may be called with either a target and a varname as two strings or a + * target as a string and an array of variable names in varname. + * + * The function inserts the new value of the variable into the $varkeys and + * $varvals hashes. It is not necessary for a variable to exist in these hashes + * before calling this function. + * + * An optional third parameter allows the value for each varname to be appended + * to the existing target variable instead of replacing it. The default is to + * replace. + * + * If $target and $varname are both strings, the substituted value of the + * variable $varname is inserted into or appended to $target. + * + * If $handle is an array of variable names the variables named by $handle are + * sequentially substituted and the result of each substitution step is + * inserted into or appended to in $target. The resulting substitution is + * available in the variable named by $target, as is each intermediate step + * for the next $varname in sequence. Note that while it is possible, it + * is only rarely desirable to call this function with an array of varnames + * and with $append = true. This append feature was introduced after the 7.2d + * release. + * + * Returns: the last value assigned to $target. + * + * usage: parse(string $target, string $varname, [boolean $append]) + * or + * usage: parse(string $target, array $varname = (string $varname), [boolean $append]) + * + * @param $target a string containing the name of the variable into which substituted $varnames are to be stored + * @param $varname if a string, the name the name of the variable to substitute or if an array a list of variables to be substituted + * @param $append if true, the substituted variables are appended to $target otherwise the existing value of $target is replaced + * @access public + * @return string + * @see subst + */ + function parse($target, $varname, $append = false) { + if (!is_array($varname)) { + if ($this->debug & 4) { + echo "

parse: (with scalar) target = $target, varname = $varname, append = $append

\n"; + } + $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, $v) = each($varname)) { + if ($this->debug & 4) { + echo "

parse: (with array) target = $target, i = $i, varname = $v, append = $append

\n"; + } + $str = $this->subst($v); + if ($append) { + $this->set_var($target, $this->get_var($target) . $str); + } else { + $this->set_var($target, $str); + } + } + } + + if ($this->debug & 4) { + echo "

parse: completed

\n"; + } + return $this->get_var($target); + } + + + /****************************************************************************** + * This is shorthand for print $this->parse(...) and is functionally identical. + * See parse for further details. + * + * Returns: always returns false. + * + * usage: pparse(string $target, string $varname, [boolean $append]) + * or + * usage: pparse(string $target, array $varname = (string $varname), [boolean $append]) + * + * @param $target a string containing the name of the variable into which substituted $varnames are to be stored + * @param $varname if a string, the name the name of the variable to substitute or if an array a list of variables to be substituted + * @param $append if true, the substituted variables are appended to $target otherwise the existing value of $target is replaced + * @access public + * @return false + * @see parse + */ + function pparse($target, $varname, $append = false, $clear = true) { // added $clear: whether to delete undefined vars or not (needed for wb-module code) - thorn + if ($this->debug & 4) { + echo "

pparse: passing parameters to parse...

\n"; + } + if(!$clear) { + $unknowns = $this->unknowns; + $this->set_unknowns('keep'); + print $this->finish($this->parse($target, $varname, $append)); + $this->set_unknowns($unknowns); + } else { + print $this->finish($this->parse($target, $varname, $append)); + } + return false; + } + + + /****************************************************************************** + * This function returns an associative array of all defined variables with the + * name as the key and the value of the variable as the value. + * + * This is mostly useful for debugging. Also note that $this->debug can be used + * to echo all variable assignments as they occur and to trace execution. + * + * Returns: a hash of all defined variable values keyed by their names. + * + * usage: get_vars() + * + * @access public + * @return array + * @see $debug + */ + function get_vars() { + if ($this->debug & 4) { + echo "

get_vars: constructing array of vars...

\n"; + } + reset($this->varkeys); + while (list($k, $v) = each($this->varkeys)) { + $result[$k] = $this->get_var($k); + } + return $result; + } + + + /****************************************************************************** + * This function returns the value of the variable named by $varname. + * If $varname references a file and that file has not been loaded yet, the + * variable will be reported as empty. + * + * When called with an array of variable names this function will return a a + * hash of variable values keyed by their names. + * + * Returns: a string or an array containing the value of $varname. + * + * usage: get_var(string $varname) + * or + * usage: get_var(array $varname) + * + * @param $varname if a string, the name the name of the variable to get the value of, or if an array a list of variables to return the value of + * @access public + * @return string or array + */ + function get_var($varname) { + if (!is_array($varname)) { + if (isset($this->varvals[$varname])) { + $str = $this->varvals[$varname]; + } else { + $str = ""; + } + if ($this->debug & 2) { + printf ("get_var (with scalar) %s = '%s'
\n", $varname, htmlentities($str)); + } + return $str; + } else { + reset($varname); + while (list($k, $v) = each($varname)) { + if (isset($this->varvals[$v])) { + $str = $this->varvals[$v]; + } else { + $str = ""; + } + if ($this->debug & 2) { + printf ("get_var: (with array) %s = '%s'
\n", $v, htmlentities($str)); + } + $result[$v] = $str; + } + return $result; + } + } + + + /****************************************************************************** + * This function returns a hash of unresolved variable names in $varname, keyed + * by their names (that is, the hash has the form $a[$name] = $name). + * + * Returns: a hash of varname/varname pairs or false on error. + * + * usage: get_undefined(string $varname) + * + * @param $varname a string containing the name the name of the variable to scan for unresolved variables + * @access public + * @return array + */ + function get_undefined($varname) { + if ($this->debug & 4) { + echo "

get_undefined: varname = $varname

\n"; + } + if (!$this->loadfile($varname)) { + $this->halt("get_undefined: unable to load $varname."); + return false; + } + + preg_match_all( + (("loose" == $this->unknown_regexp) ? "/{([^ \t\r\n}]+)}/" : "/{([_a-zA-Z]\\w+)}/"), + $this->get_var($varname), + $m); + $m = $m[1]; + if (!is_array($m)) { + return false; + } + + reset($m); + while (list($k, $v) = each($m)) { + if (!isset($this->varkeys[$v])) { + if ($this->debug & 4) { + echo "

get_undefined: undefined: $v

\n"; + } + $result[$v] = $v; + } + } + + if (count($result)) { + return $result; + } else { + return false; + } + } + + + /****************************************************************************** + * This function returns the finished version of $str. That is, the policy + * regarding unresolved variable names will be applied to $str. + * + * Returns: a finished string derived from $str and $this->unknowns. + * + * usage: finish(string $str) + * + * @param $str a string to which to apply the unresolved variable policy + * @access public + * @return string + * @see set_unknowns + */ + function finish($str) { + switch ($this->unknowns) { + case "keep": + break; + + case "remove": + $str = preg_replace( + (("loose" == $this->unknown_regexp) ? "/{([^ \t\r\n}]+)}/" : "/{([_a-zA-Z]\\w+)}/"), + "", + $str); + break; + + case "comment": + $str = preg_replace( + (("loose" == $this->unknown_regexp) ? "/{([^ \t\r\n}]+)}/" : "/{([_a-zA-Z]\\w+)}/"), + "", + $str); + break; + } + + return $str; + } + + + /****************************************************************************** + * This function prints the finished version of the value of the variable named + * by $varname. That is, the policy regarding unresolved variable names will be + * applied to the variable $varname then it will be printed. + * + * usage: p(string $varname) + * + * @param $varname a string containing the name of the variable to finish and print + * @access public + * @return void + * @see set_unknowns + * @see finish + */ + function p($varname) { + print $this->finish($this->get_var($varname)); + } + + + /****************************************************************************** + * This function returns the finished version of the value of the variable named + * by $varname. That is, the policy regarding unresolved variable names will be + * applied to the variable $varname and the result returned. + * + * Returns: a finished string derived from the variable $varname. + * + * usage: get(string $varname) + * + * @param $varname a string containing the name of the variable to finish + * @access public + * @return void + * @see set_unknowns + * @see finish + */ + function get($varname) { + return $this->finish($this->get_var($varname)); + } + + + /****************************************************************************** + * When called with a relative pathname, this function will return the pathname + * with $this->root prepended. Absolute pathnames are returned unchanged. + * + * Returns: a string containing an absolute pathname. + * + * usage: filename(string $filename) + * + * @param $filename a string containing a filename + * @access private + * @return string + * @see set_root + */ + function filename($filename) { + if ($this->debug & 4) { + echo "

filename: filename = $filename

\n"; + } + if (substr($filename, 0, 1) != "/" + && substr($filename, 0, 1) != "\\" + && substr($filename, 1, 2) != ":\\" + && substr($filename, 1, 2) != ":/" + ) { + $filename = $this->root."/".$filename; + } + + if (!file_exists($filename)) { + $this->halt("filename: file $filename does not exist."); + } + return $filename; + } + + + /****************************************************************************** + * This function will construct a regexp for a given variable name with any + * special chars quoted. + * + * Returns: a string containing an escaped variable name. + * + * usage: varname(string $varname) + * + * @param $varname a string containing a variable name + * @access private + * @return string + */ + function varname($varname) { + return preg_quote("{" . $varname . "}"); + } + + + /****************************************************************************** + * If a variable's value is undefined and the variable has a filename stored in + * $this->file[$varname] then the backing file will be loaded and the file's + * contents will be assigned as the variable's value. + * + * Note that the behaviour of this function changed slightly after the 7.2d + * release. Where previously a variable was reloaded from file if the value + * was empty, now this is not done. This allows a variable to be loaded then + * set to "", and also prevents attempts to load empty variables. Files are + * now only loaded if $this->varvals[$varname] is unset. + * + * Returns: true on success, false on error. + * + * usage: loadfile(string $varname) + * + * @param $varname a string containing the name of a variable to load + * @access private + * @return boolean + * @see set_file + */ + function loadfile($varname) { + if ($this->debug & 4) { + echo "

loadfile: varname = $varname

\n"; + } + + if (!isset($this->file[$varname])) { + // $varname does not reference a file so return + if ($this->debug & 4) { + echo "

loadfile: varname $varname does not reference a file

\n"; + } + return true; + } + + if (isset($this->varvals[$varname])) { + // will only be unset if varname was created with set_file and has never been loaded + // $varname has already been loaded so return + if ($this->debug & 4) { + echo "

loadfile: varname $varname is already loaded

\n"; + } + return true; + } + $filename = $this->file[$varname]; + + /* use @file here to avoid leaking filesystem information if there is an error */ + $str = implode("", @file($filename)); + if (empty($str)) { + $this->halt("loadfile: While loading $varname, $filename does not exist or is empty."); + return false; + } + + if ($this->filename_comments) { + $str = "\n$str\n"; + } + if ($this->debug & 4) { + printf("loadfile: loaded $filename into $varname
\n"); + } + $this->set_var($varname, $str); + + return true; + } + + + /****************************************************************************** + * This function is called whenever an error occurs and will handle the error + * according to the policy defined in $this->halt_on_error. Additionally the + * error message will be saved in $this->last_error. + * + * Returns: always returns false. + * + * usage: halt(string $msg) + * + * @param $msg a string containing an error message + * @access private + * @return void + * @see $halt_on_error + */ + function halt($msg) { + $this->last_error = $msg; + + if ($this->halt_on_error != "no") { + $this->haltmsg($msg); + } + + if ($this->halt_on_error == "yes") { + die("Halted."); + } + + return false; + } + + + /****************************************************************************** + * This function prints an error message. + * It can be overridden by your subclass of Template. It will be called with an + * error message to display. + * + * usage: haltmsg(string $msg) + * + * @param $msg a string containing the error message to display + * @access public + * @return void + * @see halt + */ + function haltmsg($msg) { + printf("Template Error: %s
\n", $msg); + } + +} +?> \ No newline at end of file Index: branches/2.8.x/wb/admin/templates/details.php =================================================================== --- branches/2.8.x/wb/admin/templates/details.php (revision 1165) +++ branches/2.8.x/wb/admin/templates/details.php (revision 1166) @@ -1,110 +1,111 @@ - - Copyright (C) 2004-2009, Ryan Djurovich - - Website Baker 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 2 of the License, or - (at your option) any later version. - - Website Baker 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 Website Baker; if not, write to the Free Software - Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - -*/ - -// Include the config file -require('../../config.php'); -require_once(WB_PATH .'/framework/functions.php'); - -// Get template name -if(!isset($_POST['file']) OR $_POST['file'] == "") { - header("Location: index.php"); - exit(0); -} else { - $file = $_POST['file']; -} - -// Check if the template exists -if(!file_exists(WB_PATH.'/templates/'.$file)) { - header("Location: index.php"); - exit(0); -} - -// Print admin header -require_once(WB_PATH.'/framework/class.admin.php'); -$admin = new admin('Addons', 'templates_view'); - -// Setup template object -$template = new Template(THEME_PATH.'/templates'); -$template->set_file('page', 'templates_details.htt'); -$template->set_block('page', 'main_block', 'main'); - -// Insert values -$result = $database->query("SELECT * FROM ".TABLE_PREFIX."addons WHERE type = 'template' AND directory = '$file'"); -if($result->numRows() > 0) { - $row = $result->fetchRow(); -} - -// check if a template description exists for the displayed backend language -$tool_description = false; -if(function_exists('file_get_contents') && file_exists(WB_PATH.'/templates/'.$file.'/languages/'.LANGUAGE .'.php')) { - // read contents of the template language file into string - $data = @file_get_contents(WB_PATH .'/templates/' .$file .'/languages/' .LANGUAGE .'.php'); - // use regular expressions to fetch the content of the variable from the string - $tool_description = get_variable_content('template_description', $data, false, false); - // replace optional placeholder {WB_URL} with value stored in config.php - if($tool_description !== false && strlen(trim($tool_description)) != 0) { - $tool_description = str_replace('{WB_URL}', WB_URL, $tool_description); - } else { - $tool_description = false; - } -} -if($tool_description !== false) { - // Override the template-description with correct desription in users language - $row['description'] = $tool_description; -} - -$template->set_var(array( - 'NAME' => $row['name'], - 'AUTHOR' => $row['author'], - 'DESCRIPTION' => $row['description'], - 'VERSION' => $row['version'], - 'DESIGNED_FOR' => $row['platform'] - ) - ); - -// Insert language headings -$template->set_var(array( - 'HEADING_TEMPLATE_DETAILS' => $HEADING['TEMPLATE_DETAILS'] - ) - ); -// Insert language text and messages -$template->set_var(array( - 'TEXT_NAME' => $TEXT['NAME'], - 'TEXT_AUTHOR' => $TEXT['AUTHOR'], - 'TEXT_VERSION' => $TEXT['VERSION'], - 'TEXT_DESIGNED_FOR' => $TEXT['DESIGNED_FOR'], - 'TEXT_DESCRIPTION' => $TEXT['DESCRIPTION'], - 'TEXT_BACK' => $TEXT['BACK'] - ) - ); - -// Parse template object -$template->parse('main', 'main_block', false); -$template->pparse('output', 'page'); - -// Print admin footer -$admin->print_footer(); - + + Copyright (C) 2004-2009, Ryan Djurovich + + Website Baker 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 2 of the License, or + (at your option) any later version. + + Website Baker 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 Website Baker; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + +*/ + +// Include the config file +require('../../config.php'); +require_once(WB_PATH .'/framework/functions.php'); +require_once(WB_PATH.'/framework/class.admin.php'); +$admin = new admin('Addons', 'templates_view',false); + +// Get template name +if(!isset($_POST['file']) OR $_POST['file'] == "") { + header("Location: index.php"); + exit(0); +} else { + $file = $admin->add_slashes($_POST['file']); +} + +// Check if the template exists +if(!file_exists(WB_PATH.'/templates/'.$file)) { + header("Location: index.php"); + exit(0); +} + +// Print admin header +$admin = new admin('Addons', 'templates_view'); + +// Setup template object +$template = new Template(THEME_PATH.'/templates'); +$template->set_file('page', 'templates_details.htt'); +$template->set_block('page', 'main_block', 'main'); + +// Insert values +$result = $database->query("SELECT * FROM ".TABLE_PREFIX."addons WHERE type = 'template' AND directory = '$file'"); +if($result->numRows() > 0) { + $row = $result->fetchRow(); +} + +// check if a template description exists for the displayed backend language +$tool_description = false; +if(function_exists('file_get_contents') && file_exists(WB_PATH.'/templates/'.$file.'/languages/'.LANGUAGE .'.php')) { + // read contents of the template language file into string + $data = @file_get_contents(WB_PATH .'/templates/' .$file .'/languages/' .LANGUAGE .'.php'); + // use regular expressions to fetch the content of the variable from the string + $tool_description = get_variable_content('template_description', $data, false, false); + // replace optional placeholder {WB_URL} with value stored in config.php + if($tool_description !== false && strlen(trim($tool_description)) != 0) { + $tool_description = str_replace('{WB_URL}', WB_URL, $tool_description); + } else { + $tool_description = false; + } +} +if($tool_description !== false) { + // Override the template-description with correct desription in users language + $row['description'] = $tool_description; +} + +$template->set_var(array( + 'NAME' => $row['name'], + 'AUTHOR' => $row['author'], + 'DESCRIPTION' => $row['description'], + 'VERSION' => $row['version'], + 'DESIGNED_FOR' => $row['platform'] + ) + ); + +// Insert language headings +$template->set_var(array( + 'HEADING_TEMPLATE_DETAILS' => $HEADING['TEMPLATE_DETAILS'] + ) + ); +// Insert language text and messages +$template->set_var(array( + 'TEXT_NAME' => $TEXT['NAME'], + 'TEXT_AUTHOR' => $TEXT['AUTHOR'], + 'TEXT_VERSION' => $TEXT['VERSION'], + 'TEXT_DESIGNED_FOR' => $TEXT['DESIGNED_FOR'], + 'TEXT_DESCRIPTION' => $TEXT['DESCRIPTION'], + 'TEXT_BACK' => $TEXT['BACK'] + ) + ); + +// Parse template object +$template->parse('main', 'main_block', false); +$template->pparse('output', 'page'); + +// Print admin footer +$admin->print_footer(); + ?> \ No newline at end of file Index: branches/2.8.x/wb/admin/modules/details.php =================================================================== --- branches/2.8.x/wb/admin/modules/details.php (revision 1165) +++ branches/2.8.x/wb/admin/modules/details.php (revision 1166) @@ -1,142 +1,147 @@ - - Copyright (C) 2004-2009, Ryan Djurovich - - Website Baker 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 2 of the License, or - (at your option) any later version. - - Website Baker 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 Website Baker; if not, write to the Free Software - Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - -*/ - -// Include the config file -require('../../config.php'); -require_once(WB_PATH .'/framework/functions.php'); - -// Print admin header -require_once(WB_PATH.'/framework/class.admin.php'); -$admin = new admin('Addons', 'modules_view'); - -// Get module name -if(!isset($_POST['file']) OR $_POST['file'] == "") { - header("Location: index.php"); - exit(0); -} else { - $file = $admin->add_slashes($_POST['file']); -} - -// Check if the module exists -if(!file_exists(WB_PATH.'/modules/'.$file)) { - header("Location: index.php"); - exit(0); -} - -// Setup module object -$template = new Template(THEME_PATH.'/templates'); -$template->set_file('page', 'modules_details.htt'); -$template->set_block('page', 'main_block', 'main'); - -// Insert values -$result = $database->query("SELECT * FROM ".TABLE_PREFIX."addons WHERE type = 'module' AND directory = '$file'"); -if($result->numRows() > 0) { - $module = $result->fetchRow(); -} - -// check if a module description exists for the displayed backend language -$tool_description = false; -if(function_exists('file_get_contents') && file_exists(WB_PATH.'/modules/'.$file.'/languages/'.LANGUAGE .'.php')) { - // read contents of the module language file into string - $data = @file_get_contents(WB_PATH .'/modules/' .$file .'/languages/' .LANGUAGE .'.php'); - // use regular expressions to fetch the content of the variable from the string - $tool_description = get_variable_content('module_description', $data, false, false); - // replace optional placeholder {WB_URL} with value stored in config.php - if($tool_description !== false && strlen(trim($tool_description)) != 0) { - $tool_description = str_replace('{WB_URL}', WB_URL, $tool_description); - } else { - $tool_description = false; - } -} -if($tool_description !== false) { - // Override the module-description with correct desription in users language - $module['description'] = $tool_description; -} - -$template->set_var(array( - 'NAME' => $module['name'], - 'AUTHOR' => $module['author'], - 'DESCRIPTION' => $module['description'], - 'VERSION' => $module['version'], - 'DESIGNED_FOR' => $module['platform'], - 'ADMIN_URL' => ADMIN_URL, - 'WB_URL' => WB_URL, - 'WB_PATH' => WB_PATH, - 'THEME_URL' => THEME_URL - ) - ); - -switch ($module['function']) { - case NULL: - $type_name = $TEXT['UNKNOWN']; - break; - case 'page': - $type_name = $TEXT['PAGE']; - break; - case 'wysiwyg': - $type_name = $TEXT['WYSIWYG_EDITOR']; - break; - case 'tool': - $type_name = $TEXT['ADMINISTRATION_TOOL']; - break; - case 'admin': - $type_name = $TEXT['ADMIN']; - break; - case 'administration': - $type_name = $TEXT['ADMINISTRATION']; - break; - case 'snippet': - $type_name = $TEXT['CODE_SNIPPET']; - break; - default: - $type_name = $TEXT['UNKNOWN']; -} -$template->set_var('TYPE', $type_name); - -// Insert language headings -$template->set_var(array( - 'HEADING_MODULE_DETAILS' => $HEADING['MODULE_DETAILS'] - ) - ); -// Insert language text and messages -$template->set_var(array( - 'TEXT_NAME' => $TEXT['NAME'], - 'TEXT_TYPE' => $TEXT['TYPE'], - 'TEXT_AUTHOR' => $TEXT['AUTHOR'], - 'TEXT_VERSION' => $TEXT['VERSION'], - 'TEXT_DESIGNED_FOR' => $TEXT['DESIGNED_FOR'], - 'TEXT_DESCRIPTION' => $TEXT['DESCRIPTION'], - 'TEXT_BACK' => $TEXT['BACK'] - ) - ); - -// Parse module object -$template->parse('main', 'main_block', false); -$template->pparse('output', 'page'); - -// Print admin footer -$admin->print_footer(); - + + Copyright (C) 2004-2009, Ryan Djurovich + + Website Baker 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 2 of the License, or + (at your option) any later version. + + Website Baker 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 Website Baker; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + +*/ + +// Include the config file +require('../../config.php'); +require_once(WB_PATH .'/framework/functions.php'); +require_once(WB_PATH.'/framework/class.admin.php'); +// No print admin header +$admin = new admin('Addons', 'modules_view', false); + +// Get module name +if(!isset($_POST['file']) OR $_POST['file'] == "") +{ + header("Location: index.php"); + exit(0); +} +else +{ + $file = $admin->add_slashes($_POST['file']); +} + +// Check if the module exists +if(!file_exists(WB_PATH.'/modules/'.$file)) { + header("Location: index.php"); + exit(0); +} + +// Print admin header +$admin = new admin('Addons', 'modules_view'); + +// Setup module object +$template = new Template(THEME_PATH.'/templates'); +$template->set_file('page', 'modules_details.htt'); +$template->set_block('page', 'main_block', 'main'); + +// Insert values +$result = $database->query("SELECT * FROM ".TABLE_PREFIX."addons WHERE type = 'module' AND directory = '$file'"); +if($result->numRows() > 0) { + $module = $result->fetchRow(); +} + +// check if a module description exists for the displayed backend language +$tool_description = false; +if(function_exists('file_get_contents') && file_exists(WB_PATH.'/modules/'.$file.'/languages/'.LANGUAGE .'.php')) { + // read contents of the module language file into string + $data = @file_get_contents(WB_PATH .'/modules/' .$file .'/languages/' .LANGUAGE .'.php'); + // use regular expressions to fetch the content of the variable from the string + $tool_description = get_variable_content('module_description', $data, false, false); + // replace optional placeholder {WB_URL} with value stored in config.php + if($tool_description !== false && strlen(trim($tool_description)) != 0) { + $tool_description = str_replace('{WB_URL}', WB_URL, $tool_description); + } else { + $tool_description = false; + } +} +if($tool_description !== false) { + // Override the module-description with correct desription in users language + $module['description'] = $tool_description; +} + +$template->set_var(array( + 'NAME' => $module['name'], + 'AUTHOR' => $module['author'], + 'DESCRIPTION' => $module['description'], + 'VERSION' => $module['version'], + 'DESIGNED_FOR' => $module['platform'], + 'ADMIN_URL' => ADMIN_URL, + 'WB_URL' => WB_URL, + 'WB_PATH' => WB_PATH, + 'THEME_URL' => THEME_URL + ) + ); + +switch ($module['function']) { + case NULL: + $type_name = $TEXT['UNKNOWN']; + break; + case 'page': + $type_name = $TEXT['PAGE']; + break; + case 'wysiwyg': + $type_name = $TEXT['WYSIWYG_EDITOR']; + break; + case 'tool': + $type_name = $TEXT['ADMINISTRATION_TOOL']; + break; + case 'admin': + $type_name = $TEXT['ADMIN']; + break; + case 'administration': + $type_name = $TEXT['ADMINISTRATION']; + break; + case 'snippet': + $type_name = $TEXT['CODE_SNIPPET']; + break; + default: + $type_name = $TEXT['UNKNOWN']; +} +$template->set_var('TYPE', $type_name); + +// Insert language headings +$template->set_var(array( + 'HEADING_MODULE_DETAILS' => $HEADING['MODULE_DETAILS'] + ) + ); +// Insert language text and messages +$template->set_var(array( + 'TEXT_NAME' => $TEXT['NAME'], + 'TEXT_TYPE' => $TEXT['TYPE'], + 'TEXT_AUTHOR' => $TEXT['AUTHOR'], + 'TEXT_VERSION' => $TEXT['VERSION'], + 'TEXT_DESIGNED_FOR' => $TEXT['DESIGNED_FOR'], + 'TEXT_DESCRIPTION' => $TEXT['DESCRIPTION'], + 'TEXT_BACK' => $TEXT['BACK'] + ) + ); + +// Parse module object +$template->parse('main', 'main_block', false); +$template->pparse('output', 'page'); + +// Print admin footer +$admin->print_footer(); + ?> \ No newline at end of file Index: branches/2.8.x/wb/framework/class.admin.php =================================================================== --- branches/2.8.x/wb/framework/class.admin.php (revision 1165) +++ branches/2.8.x/wb/framework/class.admin.php (revision 1166) @@ -447,4 +447,4 @@ } } -?> +?> \ No newline at end of file Index: branches/2.8.x/wb/framework/class.wb.php =================================================================== --- branches/2.8.x/wb/framework/class.wb.php (revision 1165) +++ branches/2.8.x/wb/framework/class.wb.php (revision 1166) @@ -1,353 +1,353 @@ - - Copyright (C) 2004-2009, Ryan Djurovich - - Website Baker 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 2 of the License, or - (at your option) any later version. - - Website Baker 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 Website Baker; if not, write to the Free Software - Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - -*/ - -/* - -wb class - -This class is the basis for admin and frontend classes. - -*/ - -// Include PHPLIB template class -require_once(WB_PATH."/include/phplib/template.inc"); - -require_once(WB_PATH.'/framework/class.database.php'); - -// Include new wbmailer class (subclass of PHPmailer) -require_once(WB_PATH."/framework/class.wbmailer.php"); - -class wb -{ - // General initialization function - // performed when frontend or backend is loaded. - function wb() { - } - - // Check whether a page is visible or not. - // This will check page-visibility and user- and group-rights. - /* page_is_visible() returns - false: if page-visibility is 'none' or 'deleted', or page-vis. is 'registered' or 'private' and user isn't allowed to see the page. - true: if page-visibility is 'public' or 'hidden', or page-vis. is 'registered' or 'private' and user _is_ allowed to see the page. - */ - function page_is_visible($page) { - $show_it = false; // shall we show the page? - $page_id = $page['page_id']; - $visibility = $page['visibility']; - $viewing_groups = $page['viewing_groups']; - $viewing_users = $page['viewing_users']; - // First check if visibility is 'none', 'deleted' - if($visibility == 'none') { - return(false); - } elseif($visibility == 'deleted') { - return(false); - } - // Now check if visibility is 'hidden', 'private' or 'registered' - if($visibility == 'hidden') { // hidden: hide the menu-link, but show the page - $show_it = true; - } elseif($visibility == 'private' || $visibility == 'registered') { - // Check if the user is logged in - if($this->is_authenticated() == true) { - // Now check if the user has perms to view the page - $in_group = false; - foreach($this->get_groups_id() as $cur_gid){ - if(in_array($cur_gid, explode(',', $viewing_groups))) { - $in_group = true; - } - } - if($in_group || in_array($this->get_user_id(), explode(',', $viewing_users))) { - $show_it = true; - } else { - $show_it = false; - } - } else { - $show_it = false; - } - } elseif($visibility == 'public') { - $show_it = true; - } else { - $show_it = false; - } - return($show_it); - } - // Check if there is at least one active section on this page - function page_is_active($page) { - global $database; - $has_active_sections = false; - $page_id = $page['page_id']; - $now = time(); - $query_sections = $database->query("SELECT publ_start,publ_end FROM ".TABLE_PREFIX."sections WHERE page_id = '$page_id'"); - if($query_sections->numRows() != 0) { - while($section = $query_sections->fetchRow()) { - if($now<$section['publ_end'] && ($now>$section['publ_start'] || $section['publ_start']==0) || $now>$section['publ_start'] && $section['publ_end']==0) { - $has_active_sections = true; - break; - } - } - } - return($has_active_sections); - } - - // Check whether we should show a page or not (for front-end) - function show_page($page) { - if($this->page_is_visible($page) && $this->page_is_active($page)) { - return true; - } else { - return false; - } - } - - // Check if the user is already authenticated or not - function is_authenticated() { - if(isset($_SESSION['USER_ID']) AND $_SESSION['USER_ID'] != "" AND is_numeric($_SESSION['USER_ID'])) { - return true; - } else { - return false; - } - } - // Modified addslashes function which takes into account magic_quotes - function add_slashes($input) { - if ( get_magic_quotes_gpc() || ( !is_string($input) ) ) { - return $input; - } - $output = addslashes($input); - return $output; - } - - // Ditto for stripslashes - // Attn: this is _not_ the counterpart to $this->add_slashes() ! - // Use stripslashes() to undo a preliminarily done $this->add_slashes() - // The purpose of $this->strip_slashes() is to undo the effects of magic_quotes_gpc==On - function strip_slashes($input) { - if ( !get_magic_quotes_gpc() || ( !is_string($input) ) ) { - return $input; - } - $output = stripslashes($input); - return $output; - } - - // Escape backslashes for use with mySQL LIKE strings - function escape_backslashes($input) { - return str_replace("\\","\\\\",$input); - } - - function page_link($link){ - // Check for :// in the link (used in URL's) as well as mailto: - if(strstr($link, '://') == '' AND substr($link, 0, 7) != 'mailto:') { - return WB_URL.PAGES_DIRECTORY.$link.PAGE_EXTENSION; - } else { - return $link; - } - } - - // Get POST data - function get_post($field) { - if(isset($_POST[$field])) { - return $_POST[$field]; - } else { - return null; - } - } - - // Get POST data and escape it - function get_post_escaped($field) { - $result = $this->get_post($field); - return (is_null($result)) ? null : $this->add_slashes($result); - } - - // Get GET data - function get_get($field) { - if(isset($_GET[$field])) { - return $_GET[$field]; - } else { - return null; - } - } - - // Get SESSION data - function get_session($field) { - if(isset($_SESSION[$field])) { - return $_SESSION[$field]; - } else { - return null; - } - } - - // Get SERVER data - function get_server($field) { - if(isset($_SERVER[$field])) { - return $_SERVER[$field]; - } else { - return null; - } - } - - // Get the current users id - function get_user_id() { - return $_SESSION['USER_ID']; - } - - // Get the current users group id - function get_group_id() { - return $_SESSION['GROUP_ID']; - } - - // Get the current users group ids - function get_groups_id() { - return explode(",", $_SESSION['GROUPS_ID']); - } - - // Get the current users group name - function get_group_name() { - return implode(",", $_SESSION['GROUP_NAME']); - } - - // Get the current users group name - function get_groups_name() { - return $_SESSION['GROUP_NAME']; - } - - // Get the current users username - function get_username() { - return $_SESSION['USERNAME']; - } - - // Get the current users display name - function get_display_name() { - return ($_SESSION['DISPLAY_NAME']); - } - - // Get the current users email address - function get_email() { - return $_SESSION['EMAIL']; - } - - // Get the current users home folder - function get_home_folder() { - return $_SESSION['HOME_FOLDER']; - } - - // Get the current users timezone - function get_timezone() { - if(!isset($_SESSION['USE_DEFAULT_TIMEZONE'])) { - return $_SESSION['TIMEZONE']; - } else { - return '-72000'; - } - } - - // Validate supplied email address - function validate_email($email) { - if(eregi("^([0-9a-zA-Z]+[-._+&])*[0-9a-zA-Z]+@([-0-9a-zA-Z]+[.])+[a-zA-Z]{2,6}$", $email)) { - return true; - } else { - return false; - } - } - - // Print a success message which then automatically redirects the user to another page - function print_success($message, $redirect = 'index.php') { - global $TEXT, $database; - - // fetch redirect timer for sucess messages from settings table - $table = TABLE_PREFIX . 'settings'; - $results = @$database->get_one("SELECT `value` FROM `$table` WHERE `name` = 'redirect_timer'"); - $redirect_timer = ($results) ? $results : '1500'; - - // add template variables - $success_template = new Template(THEME_PATH.'/templates'); - $success_template->set_file('page', 'success.htt'); - $success_template->set_block('page', 'main_block', 'main'); - $success_template->set_var('MESSAGE', $message); - $success_template->set_var('REDIRECT', $redirect); - $success_template->set_var('REDIRECT_TIMER', $redirect_timer); - $success_template->set_var('NEXT', $TEXT['NEXT']); - $success_template->parse('main', 'main_block', false); - $success_template->pparse('output', 'page'); - } - - // Print an error message - function print_error($message, $link = 'index.php', $auto_footer = true) { - global $TEXT; - $success_template = new Template(THEME_PATH.'/templates'); - $success_template->set_file('page', 'error.htt'); - $success_template->set_block('page', 'main_block', 'main'); - $success_template->set_var('MESSAGE', $message); - $success_template->set_var('LINK', $link); - $success_template->set_var('BACK', $TEXT['BACK']); - $success_template->parse('main', 'main_block', false); - $success_template->pparse('output', 'page'); - if ( $auto_footer == true ) { - if ( method_exists($this, "print_footer") ) { - $this->print_footer(); - } - } - exit(); - } - - // Validate send email - function mail($fromaddress, $toaddress, $subject, $message, $fromname='') { - /* - INTEGRATED OPEN SOURCE PHPMAILER CLASS FOR SMTP SUPPORT AND MORE - SOME SERVICE PROVIDERS DO NOT SUPPORT SENDING MAIL VIA PHP AS IT DOES NOT PROVIDE SMTP AUTHENTICATION - NEW WBMAILER CLASS IS ABLE TO SEND OUT MESSAGES USING SMTP WHICH RESOLVE THESE ISSUE (C. Sommer) - - NOTE: - To use SMTP for sending out mails, you have to specify the SMTP host of your domain - via the Settings panel in the backend of Website Baker - */ - - $fromaddress = preg_replace('/[\r\n]/', '', $fromaddress); - $toaddress = preg_replace('/[\r\n]/', '', $toaddress); - $subject = preg_replace('/[\r\n]/', '', $subject); - $message_alt = $message; - $message = preg_replace('/[\r\n]/', '
', $message); - - // create PHPMailer object and define default settings - $myMail = new wbmailer(); - - // set user defined from address - if ($fromaddress!='') { - if($fromname!='') $myMail->FromName = $fromname; // FROM-NAME - $myMail->From = $fromaddress; // FROM: - $myMail->AddReplyTo($fromaddress); // REPLY TO: - } - - // define recepient and information to send out - $myMail->AddAddress($toaddress); // TO: - $myMail->Subject = $subject; // SUBJECT - $myMail->Body = $message; // CONTENT (HTML) - $myMail->AltBody = strip_tags($message_alt); // CONTENT (TEXT) - - // check if there are any send mail errors, otherwise say successful - if (!$myMail->Send()) { - return false; - } else { - return true; - } - } - -} -?> + + Copyright (C) 2004-2009, Ryan Djurovich + + Website Baker 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 2 of the License, or + (at your option) any later version. + + Website Baker 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 Website Baker; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + +*/ + +/* + +wb class + +This class is the basis for admin and frontend classes. + +*/ + +// Include PHPLIB template class +require_once(WB_PATH."/include/phplib/template.inc"); + +require_once(WB_PATH.'/framework/class.database.php'); + +// Include new wbmailer class (subclass of PHPmailer) +require_once(WB_PATH."/framework/class.wbmailer.php"); + +class wb +{ + // General initialization function + // performed when frontend or backend is loaded. + function wb() { + } + + // Check whether a page is visible or not. + // This will check page-visibility and user- and group-rights. + /* page_is_visible() returns + false: if page-visibility is 'none' or 'deleted', or page-vis. is 'registered' or 'private' and user isn't allowed to see the page. + true: if page-visibility is 'public' or 'hidden', or page-vis. is 'registered' or 'private' and user _is_ allowed to see the page. + */ + function page_is_visible($page) { + $show_it = false; // shall we show the page? + $page_id = $page['page_id']; + $visibility = $page['visibility']; + $viewing_groups = $page['viewing_groups']; + $viewing_users = $page['viewing_users']; + // First check if visibility is 'none', 'deleted' + if($visibility == 'none') { + return(false); + } elseif($visibility == 'deleted') { + return(false); + } + // Now check if visibility is 'hidden', 'private' or 'registered' + if($visibility == 'hidden') { // hidden: hide the menu-link, but show the page + $show_it = true; + } elseif($visibility == 'private' || $visibility == 'registered') { + // Check if the user is logged in + if($this->is_authenticated() == true) { + // Now check if the user has perms to view the page + $in_group = false; + foreach($this->get_groups_id() as $cur_gid){ + if(in_array($cur_gid, explode(',', $viewing_groups))) { + $in_group = true; + } + } + if($in_group || in_array($this->get_user_id(), explode(',', $viewing_users))) { + $show_it = true; + } else { + $show_it = false; + } + } else { + $show_it = false; + } + } elseif($visibility == 'public') { + $show_it = true; + } else { + $show_it = false; + } + return($show_it); + } + // Check if there is at least one active section on this page + function page_is_active($page) { + global $database; + $has_active_sections = false; + $page_id = $page['page_id']; + $now = time(); + $query_sections = $database->query("SELECT publ_start,publ_end FROM ".TABLE_PREFIX."sections WHERE page_id = '$page_id'"); + if($query_sections->numRows() != 0) { + while($section = $query_sections->fetchRow()) { + if($now<$section['publ_end'] && ($now>$section['publ_start'] || $section['publ_start']==0) || $now>$section['publ_start'] && $section['publ_end']==0) { + $has_active_sections = true; + break; + } + } + } + return($has_active_sections); + } + + // Check whether we should show a page or not (for front-end) + function show_page($page) { + if($this->page_is_visible($page) && $this->page_is_active($page)) { + return true; + } else { + return false; + } + } + + // Check if the user is already authenticated or not + function is_authenticated() { + if(isset($_SESSION['USER_ID']) AND $_SESSION['USER_ID'] != "" AND is_numeric($_SESSION['USER_ID'])) { + return true; + } else { + return false; + } + } + // Modified addslashes function which takes into account magic_quotes + function add_slashes($input) { + if ( get_magic_quotes_gpc() || ( !is_string($input) ) ) { + return $input; + } + $output = addslashes($input); + return $output; + } + + // Ditto for stripslashes + // Attn: this is _not_ the counterpart to $this->add_slashes() ! + // Use stripslashes() to undo a preliminarily done $this->add_slashes() + // The purpose of $this->strip_slashes() is to undo the effects of magic_quotes_gpc==On + function strip_slashes($input) { + if ( !get_magic_quotes_gpc() || ( !is_string($input) ) ) { + return $input; + } + $output = stripslashes($input); + return $output; + } + + // Escape backslashes for use with mySQL LIKE strings + function escape_backslashes($input) { + return str_replace("\\","\\\\",$input); + } + + function page_link($link){ + // Check for :// in the link (used in URL's) as well as mailto: + if(strstr($link, '://') == '' AND substr($link, 0, 7) != 'mailto:') { + return WB_URL.PAGES_DIRECTORY.$link.PAGE_EXTENSION; + } else { + return $link; + } + } + + // Get POST data + function get_post($field) { + if(isset($_POST[$field])) { + return $_POST[$field]; + } else { + return null; + } + } + + // Get POST data and escape it + function get_post_escaped($field) { + $result = $this->get_post($field); + return (is_null($result)) ? null : $this->add_slashes($result); + } + + // Get GET data + function get_get($field) { + if(isset($_GET[$field])) { + return $_GET[$field]; + } else { + return null; + } + } + + // Get SESSION data + function get_session($field) { + if(isset($_SESSION[$field])) { + return $_SESSION[$field]; + } else { + return null; + } + } + + // Get SERVER data + function get_server($field) { + if(isset($_SERVER[$field])) { + return $_SERVER[$field]; + } else { + return null; + } + } + + // Get the current users id + function get_user_id() { + return $_SESSION['USER_ID']; + } + + // Get the current users group id + function get_group_id() { + return $_SESSION['GROUP_ID']; + } + + // Get the current users group ids + function get_groups_id() { + return explode(",", $_SESSION['GROUPS_ID']); + } + + // Get the current users group name + function get_group_name() { + return implode(",", $_SESSION['GROUP_NAME']); + } + + // Get the current users group name + function get_groups_name() { + return $_SESSION['GROUP_NAME']; + } + + // Get the current users username + function get_username() { + return $_SESSION['USERNAME']; + } + + // Get the current users display name + function get_display_name() { + return ($_SESSION['DISPLAY_NAME']); + } + + // Get the current users email address + function get_email() { + return $_SESSION['EMAIL']; + } + + // Get the current users home folder + function get_home_folder() { + return $_SESSION['HOME_FOLDER']; + } + + // Get the current users timezone + function get_timezone() { + if(!isset($_SESSION['USE_DEFAULT_TIMEZONE'])) { + return $_SESSION['TIMEZONE']; + } else { + return '-72000'; + } + } + + // Validate supplied email address + function validate_email($email) { + if(eregi("^([0-9a-zA-Z]+[-._+&])*[0-9a-zA-Z]+@([-0-9a-zA-Z]+[.])+[a-zA-Z]{2,6}$", $email)) { + return true; + } else { + return false; + } + } + + // Print a success message which then automatically redirects the user to another page + function print_success($message, $redirect = 'index.php') { + global $TEXT, $database; + + // fetch redirect timer for sucess messages from settings table + $table = TABLE_PREFIX . 'settings'; + $results = @$database->get_one("SELECT `value` FROM `$table` WHERE `name` = 'redirect_timer'"); + $redirect_timer = ($results) ? $results : '1500'; + + // add template variables + $success_template = new Template(THEME_PATH.'/templates'); + $success_template->set_file('page', 'success.htt'); + $success_template->set_block('page', 'main_block', 'main'); + $success_template->set_var('MESSAGE', $message); + $success_template->set_var('REDIRECT', $redirect); + $success_template->set_var('REDIRECT_TIMER', $redirect_timer); + $success_template->set_var('NEXT', $TEXT['NEXT']); + $success_template->parse('main', 'main_block', false); + $success_template->pparse('output', 'page'); + } + + // Print an error message + function print_error($message, $link = 'index.php', $auto_footer = true) { + global $TEXT; + $success_template = new Template(THEME_PATH.'/templates'); + $success_template->set_file('page', 'error.htt'); + $success_template->set_block('page', 'main_block', 'main'); + $success_template->set_var('MESSAGE', $message); + $success_template->set_var('LINK', $link); + $success_template->set_var('BACK', $TEXT['BACK']); + $success_template->parse('main', 'main_block', false); + $success_template->pparse('output', 'page'); + if ( $auto_footer == true ) { + if ( method_exists($this, "print_footer") ) { + $this->print_footer(); + } + } + exit(); + } + + // Validate send email + function mail($fromaddress, $toaddress, $subject, $message, $fromname='') { + /* + INTEGRATED OPEN SOURCE PHPMAILER CLASS FOR SMTP SUPPORT AND MORE + SOME SERVICE PROVIDERS DO NOT SUPPORT SENDING MAIL VIA PHP AS IT DOES NOT PROVIDE SMTP AUTHENTICATION + NEW WBMAILER CLASS IS ABLE TO SEND OUT MESSAGES USING SMTP WHICH RESOLVE THESE ISSUE (C. Sommer) + + NOTE: + To use SMTP for sending out mails, you have to specify the SMTP host of your domain + via the Settings panel in the backend of Website Baker + */ + + $fromaddress = preg_replace('/[\r\n]/', '', $fromaddress); + $toaddress = preg_replace('/[\r\n]/', '', $toaddress); + $subject = preg_replace('/[\r\n]/', '', $subject); + $message_alt = $message; + $message = preg_replace('/[\r\n]/', '
', $message); + + // create PHPMailer object and define default settings + $myMail = new wbmailer(); + + // set user defined from address + if ($fromaddress!='') { + if($fromname!='') $myMail->FromName = $fromname; // FROM-NAME + $myMail->From = $fromaddress; // FROM: + $myMail->AddReplyTo($fromaddress); // REPLY TO: + } + + // define recepient and information to send out + $myMail->AddAddress($toaddress); // TO: + $myMail->Subject = $subject; // SUBJECT + $myMail->Body = $message; // CONTENT (HTML) + $myMail->AltBody = strip_tags($message_alt); // CONTENT (TEXT) + + // check if there are any send mail errors, otherwise say successful + if (!$myMail->Send()) { + return false; + } else { + return true; + } + } + +} +?> \ No newline at end of file Index: branches/2.8.x/wb/framework/frontend.functions.php =================================================================== --- branches/2.8.x/wb/framework/frontend.functions.php (revision 1165) +++ branches/2.8.x/wb/framework/frontend.functions.php (revision 1166) @@ -497,4 +497,4 @@ // Include template file -?> +?> \ No newline at end of file Index: branches/2.8.x/wb/framework/functions.php =================================================================== --- branches/2.8.x/wb/framework/functions.php (revision 1165) +++ branches/2.8.x/wb/framework/functions.php (revision 1166) @@ -776,9 +776,9 @@ // Load module into DB function load_module($directory, $install = false) { global $database,$admin,$MESSAGE; - if(is_dir($directory) AND file_exists($directory.'/info.php')) - { - require($directory.'/info.php'); + if(is_dir($directory) AND file_exists($directory.'/info.php')) + { + require($directory.'/info.php'); if(isset($module_name)) { if(!isset($module_license)) { $module_license = 'GNU General Public License'; } @@ -905,4 +905,4 @@ } } -?> +?> \ No newline at end of file