chamilo / chamilo-lms

main/inc/lib/kses-0.2.2/oop/php5.class.kses.php

Indentation +1140 added lines, -1140 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 
-	/*
+    /*
 	 * ==========================================================================================
 	 *
 	 * This program is free software and open source software; you can redistribute
@@ -21,1146 +21,1146 @@ 
 	 * ==========================================================================================
 	 */
 
-	/**
-	*	Class file for PHP5 OOP version of kses
-	*
-	*	This is an updated version of kses to work with PHP5 that works under E_STRICT.
-	*
-	*	This version is a bit of a rewrite to match my own coding style and use some of the
-	*	capabilities allowed in PHP5.  Since this was a significant rewrite, but it still
-	*	maintains backward compatibility syntax-wise, the version number is now 1.0.0.  Any
-	*	minor changes that do not break compatibility will be indicated in the second or third
-	*	digits.  Anything that breaks compatibility will change the major version number.
-	*
-	*	PHP5 specific changes:
-	*	+ Private methods are now in place
-	*	+ __construct() is now used rather then the standard class name 'kses()'
-	*	+ Kses will not load in any version less that PHP5
-	*	Other modifications:
-	*	+ PHPdoc style documentation has been added to the class.  See http://www.phpdoc.org/ for more info.
-	*	+ Method names have been changed to reflect status as verbs
-	*	+ One line methods have been folded into the code
-	*	+ Some methods are now deprecated due to nomenclature style change.  See method documentation for specifics.
-	*	+ Kses5 now works in E_STRICT
-	*	+ Version number is 1.0.0 to reflect serious code changes
-	*	+ Addition of methods AddProtocols(), filterKsestextHook(), RemoveProtocol(), RemoveProtocols() and SetProtocols()
-	*	+ Deprecated _hook(), Protocols()
-	*
-	*	@package    kses
-	*	@subpackage kses5
-	*/
-
-	if(substr(phpversion(), 0, 1) < 5)
-	{
-		die("Class kses requires PHP 5 or higher.");
-	}
-
-	/**
-	*	Only install KSES5 once
-	*/
-	if(!defined('KSES_CLASS_PHP5'))
-	{
-		define('KSES_CLASS_PHP5', true);
-
-	/**
-	*	Kses strips evil scripts!
-	*
-	*	This class provides the capability for removing unwanted HTML/XHTML, attributes from
-	*	tags, and protocols contained in links.  The net result is a much more powerful tool
-	*	than the PHP internal strip_tags()
-	*
-	*	This is a fork of a slick piece of procedural code called 'kses' written by Ulf Harnhammar.
-	*
-	*	The original class for PHP4 was basically a wrapper around all of the functions in
-	*	the procedural code written by Ulf, and was released 7/25/2003.
-	*
-	*	This version is a bit of a rewrite to match my own coding style and use some of the
-	*	capabilities allowed in PHP5.  Since this was a significant rewrite, but it still
-	*	maintains backward compatibility syntax-wise, the version number is now 1.0.0.  Any
-	*	minor changes that do not break compatibility will be indicated in the second or third
-	*	digits.  Anything that breaks compatibility will change the major version number.
-	*
-	*	PHP5 specific changes:
-	*	+ Private methods are now in place
-	*	+ __construct() is now used rather then the standard class name 'kses()'
-	*	+ Kses5 will not load in any version less that PHP5
-	*	Other modifications:
-	*	+ PHPdoc style documentation has been added to the class.  See http://www.phpdoc.org/ for more info.
-	*	+ Method names have been changed to reflect status as verbs
-	*	+ One line methods have been folded into the code
-	*	+ Some methods are now deprecated due to nomenclature style change.  See method documentation for specifics.
-	*	+ Kses now works in E_STRICT
-	*	+ Initial Version number set to 1.0.0 to reflect serious code changes
-	*	+ Addition of methods AddProtocols(), filterKsestextHook(), RemoveProtocol(), RemoveProtocols() and SetProtocols()
-	*	+ Deprecated _hook(), Protocols()
-	*	+ Integrated code from kses 0.2.2 into class.
-	*	+ Added methods DumpProtocols(), DumpMethods()
-	*
-	*	@author     Richard R. V�squez, Jr. (Original procedural code by Ulf H�rnhammar)
-	*	@link       http://sourceforge.net/projects/kses/ Home Page for Kses
-	*	@link       http://chaos.org/contact/ Contact page with current email address for Richard Vasquez
-	*	@copyright  Richard R. V�squez, Jr. 2005
-	*	@version    PHP5 OOP 1.0.2
-	*	@license    http://www.gnu.org/licenses/gpl.html GNU Public License
-	*	@package    kses
-	*/
-		class kses5
-		{
-			/**#@+
+    /**
+     *	Class file for PHP5 OOP version of kses
+     *
+     *	This is an updated version of kses to work with PHP5 that works under E_STRICT.
+     *
+     *	This version is a bit of a rewrite to match my own coding style and use some of the
+     *	capabilities allowed in PHP5.  Since this was a significant rewrite, but it still
+     *	maintains backward compatibility syntax-wise, the version number is now 1.0.0.  Any
+     *	minor changes that do not break compatibility will be indicated in the second or third
+     *	digits.  Anything that breaks compatibility will change the major version number.
+     *
+     *	PHP5 specific changes:
+     *	+ Private methods are now in place
+     *	+ __construct() is now used rather then the standard class name 'kses()'
+     *	+ Kses will not load in any version less that PHP5
+     *	Other modifications:
+     *	+ PHPdoc style documentation has been added to the class.  See http://www.phpdoc.org/ for more info.
+     *	+ Method names have been changed to reflect status as verbs
+     *	+ One line methods have been folded into the code
+     *	+ Some methods are now deprecated due to nomenclature style change.  See method documentation for specifics.
+     *	+ Kses5 now works in E_STRICT
+     *	+ Version number is 1.0.0 to reflect serious code changes
+     *	+ Addition of methods AddProtocols(), filterKsestextHook(), RemoveProtocol(), RemoveProtocols() and SetProtocols()
+     *	+ Deprecated _hook(), Protocols()
+     *
+     *	@package    kses
+     *	@subpackage kses5
+     */
+
+    if(substr(phpversion(), 0, 1) < 5)
+    {
+        die("Class kses requires PHP 5 or higher.");
+    }
+
+    /**
+     *	Only install KSES5 once
+     */
+    if(!defined('KSES_CLASS_PHP5'))
+    {
+        define('KSES_CLASS_PHP5', true);
+
+    /**
+     *	Kses strips evil scripts!
+     *
+     *	This class provides the capability for removing unwanted HTML/XHTML, attributes from
+     *	tags, and protocols contained in links.  The net result is a much more powerful tool
+     *	than the PHP internal strip_tags()
+     *
+     *	This is a fork of a slick piece of procedural code called 'kses' written by Ulf Harnhammar.
+     *
+     *	The original class for PHP4 was basically a wrapper around all of the functions in
+     *	the procedural code written by Ulf, and was released 7/25/2003.
+     *
+     *	This version is a bit of a rewrite to match my own coding style and use some of the
+     *	capabilities allowed in PHP5.  Since this was a significant rewrite, but it still
+     *	maintains backward compatibility syntax-wise, the version number is now 1.0.0.  Any
+     *	minor changes that do not break compatibility will be indicated in the second or third
+     *	digits.  Anything that breaks compatibility will change the major version number.
+     *
+     *	PHP5 specific changes:
+     *	+ Private methods are now in place
+     *	+ __construct() is now used rather then the standard class name 'kses()'
+     *	+ Kses5 will not load in any version less that PHP5
+     *	Other modifications:
+     *	+ PHPdoc style documentation has been added to the class.  See http://www.phpdoc.org/ for more info.
+     *	+ Method names have been changed to reflect status as verbs
+     *	+ One line methods have been folded into the code
+     *	+ Some methods are now deprecated due to nomenclature style change.  See method documentation for specifics.
+     *	+ Kses now works in E_STRICT
+     *	+ Initial Version number set to 1.0.0 to reflect serious code changes
+     *	+ Addition of methods AddProtocols(), filterKsestextHook(), RemoveProtocol(), RemoveProtocols() and SetProtocols()
+     *	+ Deprecated _hook(), Protocols()
+     *	+ Integrated code from kses 0.2.2 into class.
+     *	+ Added methods DumpProtocols(), DumpMethods()
+     *
+     *	@author     Richard R. V�squez, Jr. (Original procedural code by Ulf H�rnhammar)
+     *	@link       http://sourceforge.net/projects/kses/ Home Page for Kses
+     *	@link       http://chaos.org/contact/ Contact page with current email address for Richard Vasquez
+     *	@copyright  Richard R. V�squez, Jr. 2005
+     *	@version    PHP5 OOP 1.0.2
+     *	@license    http://www.gnu.org/licenses/gpl.html GNU Public License
+     *	@package    kses
+     */
+        class kses5
+        {
+            /**#@+
 			 *	@access private
 			 *	@var array
 			 */
-			private $allowed_protocols;
-			private $allowed_html;
-			/**#@-*/
-
-			/**
-			 *	Constructor for kses.
-			 *
-			 *	This sets a default collection of protocols allowed in links, and creates an
-			 *	empty set of allowed HTML tags.
-			 *	@since PHP5 OOP 1.0.0
-			 */
-			public function __construct()
-			{
-				/**
-				 *	You could add protocols such as ftp, new, gopher, mailto, irc, etc.
-				 *
-				 *	The base values the original kses provided were:
-				 *		'http', 'https', 'ftp', 'news', 'nntp', 'telnet', 'gopher', 'mailto'
-				 */
-				$this->allowed_protocols = array('http', 'ftp', 'mailto');
-				$this->allowed_html      = array();
-			}
-
-			/**
-			 *	Basic task of kses - parses $string and strips it as required.
-			 *
-			 *	This method strips all the disallowed (X)HTML tags, attributes
-			 *	and protocols from the input $string.
-			 *
-			 *	@access public
-			 *	@param string $string String to be stripped of 'evil scripts'
-			 *	@return string The stripped string
-			 *	@since PHP4 OOP 0.0.1
-			 */
-			public function Parse($string = "")
-			{
-				if (get_magic_quotes_gpc())
-				{
-					$string = stripslashes($string);
-				}
-				$string = $this->removeNulls($string);
-				//	Remove JavaScript entities from early Netscape 4 versions
-				$string = preg_replace('%&\s*\{[^}]*(\}\s*;?|$)%', '', $string);
-				$string = $this->normalizeEntities($string);
-				$string = $this->filterKsesTextHook($string);
-				$string = preg_replace('%(<' . '[^>]*' . '(>|$)' . '|>)%e', "\$this->stripTags('\\1')", $string);
-				return $string;
-			}
-
-			/**
-			 *	Allows for single/batch addition of protocols
-			 *
-			 *	This method accepts one argument that can be either a string
-			 *	or an array of strings.  Invalid data will be ignored.
-			 *
-			 *	The argument will be processed, and each string will be added
-			 *	via AddProtocol().
-			 *
-			 *	@access public
-			 *	@param mixed , A string or array of protocols that will be added to the internal list of allowed protocols.
-			 *	@return bool Status of adding valid protocols.
-			 *	@see AddProtocol()
-			 *	@since PHP5 OOP 1.0.0
-			 */
-			public function AddProtocols()
-			{
-				$c_args = func_num_args();
-				if($c_args != 1)
-				{
-					trigger_error("kses5::AddProtocols() did not receive an argument.", E_USER_WARNING);
-					return false;
-				}
-
-				$protocol_data = func_get_arg(0);
-
-				if(is_array($protocol_data) && count($protocol_data) > 0)
-				{
-					foreach($protocol_data as $protocol)
-					{
-						$this->AddProtocol($protocol);
-					}
-					return true;
-				}
-				elseif(is_string($protocol_data))
-				{
-					$this->AddProtocol($protocol_data);
-					return true;
-				}
-				else
-				{
-					trigger_error("kses5::AddProtocols() did not receive a string or an array.", E_USER_WARNING);
-					return false;
-				}
-			}
-
-			/**
-			 *	Allows for single/batch addition of protocols
-			 *
-			 *	@deprecated Use AddProtocols()
-			 *	@see AddProtocols()
-			 *	@return bool
-			 *	@since PHP4 OOP 0.0.1
-			 */
-			public function Protocols()
-			{
-				$c_args = func_num_args();
-				if($c_args != 1)
-				{
-					trigger_error("kses5::Protocols() did not receive an argument.", E_USER_WARNING);
-					return false;
-				}
-
-				return $this->AddProtocols(func_get_arg(0));
-			}
-
-			/**
-			 *	Adds a single protocol to $this->allowed_protocols.
-			 *
-			 *	This method accepts a string argument and adds it to
-			 *	the list of allowed protocols to keep when performing
-			 *	Parse().
-			 *
-			 *	@access public
-			 *	@param string $protocol The name of the protocol to be added.
-			 *	@return bool Status of adding valid protocol.
-			 *	@since PHP4 OOP 0.0.1
-			 */
-			public function AddProtocol($protocol = "")
-			{
-				if(!is_string($protocol))
-				{
-					trigger_error("kses5::AddProtocol() requires a string.", E_USER_WARNING);
-					return false;
-				}
-
-				// Remove any inadvertent ':' at the end of the protocol.
-				if(substr($protocol, strlen($protocol) - 1, 1) == ":")
-				{
-					$protocol = substr($protocol, 0, strlen($protocol) - 1);
-				}
-
-				$protocol = strtolower(trim($protocol));
-				if($protocol == "")
-				{
-					trigger_error("kses5::AddProtocol() tried to add an empty/NULL protocol.", E_USER_WARNING);
-					return false;
-				}
-
-				//	prevent duplicate protocols from being added.
-				if(!in_array($protocol, $this->allowed_protocols))
-				{
-					array_push($this->allowed_protocols, $protocol);
-					sort($this->allowed_protocols);
-				}
-				return true;
-			}
-
-			/**
-			 *	Removes a single protocol from $this->allowed_protocols.
-			 *
-			 *	This method accepts a string argument and removes it from
-			 *	the list of allowed protocols to keep when performing
-			 *	Parse().
-			 *
-			 *	@access public
-			 *	@param string $protocol The name of the protocol to be removed.
-			 *	@return bool Status of removing valid protocol.
-			 *	@since PHP5 OOP 1.0.0
-			 */
-			public function RemoveProtocol($protocol = "")
-			{
-				if(!is_string($protocol))
-				{
-					trigger_error("kses5::RemoveProtocol() requires a string.", E_USER_WARNING);
-					return false;
-				}
-
-				// Remove any inadvertent ':' at the end of the protocol.
-				if(substr($protocol, strlen($protocol) - 1, 1) == ":")
-				{
-					$protocol = substr($protocol, 0, strlen($protocol) - 1);
-				}
-
-				$protocol = strtolower(trim($protocol));
-				if($protocol == "")
-				{
-					trigger_error("kses5::RemoveProtocol() tried to remove an empty/NULL protocol.", E_USER_WARNING);
-					return false;
-				}
-
-				//	Ensures that the protocol exists before removing it.
-				if(in_array($protocol, $this->allowed_protocols))
-				{
-					$this->allowed_protocols = array_diff($this->allowed_protocols, array($protocol));
-					sort($this->allowed_protocols);
-				}
-
-				return true;
-			}
-
-			/**
-			 *	Allows for single/batch removal of protocols
-			 *
-			 *	This method accepts one argument that can be either a string
-			 *	or an array of strings.  Invalid data will be ignored.
-			 *
-			 *	The argument will be processed, and each string will be removed
-			 *	via RemoveProtocol().
-			 *
-			 *	@access public
-			 *	@param mixed , A string or array of protocols that will be removed from the internal list of allowed protocols.
-			 *	@return bool Status of removing valid protocols.
-			 *	@see RemoveProtocol()
-			 *	@since PHP5 OOP 1.0.0
-			 */
-			public function RemoveProtocols()
-			{
-				$c_args = func_num_args();
-				if($c_args != 1)
-				{
-					return false;
-				}
-
-				$protocol_data = func_get_arg(0);
-
-				if(is_array($protocol_data) && count($protocol_data) > 0)
-				{
-					foreach($protocol_data as $protocol)
-					{
-						$this->RemoveProtocol($protocol);
-					}
-				}
-				elseif(is_string($protocol_data))
-				{
-					$this->RemoveProtocol($protocol_data);
-					return true;
-				}
-				else
-				{
-					trigger_error("kses5::RemoveProtocols() did not receive a string or an array.", E_USER_WARNING);
-					return false;
-				}
-			}
-
-			/**
-			 *	Allows for single/batch replacement of protocols
-			 *
-			 *	This method accepts one argument that can be either a string
-			 *	or an array of strings.  Invalid data will be ignored.
-			 *
-			 *	Existing protocols will be removed, then the argument will be
-			 *	processed, and each string will be added via AddProtocol().
-			 *
-			 *	@access public
-			 *	@param mixed , A string or array of protocols that will be the new internal list of allowed protocols.
-			 *	@return bool Status of replacing valid protocols.
-			 *	@since PHP5 OOP 1.0.1
-			 *	@see AddProtocol()
-			 */
-			public function SetProtocols()
-			{
-				$c_args = func_num_args();
-				if($c_args != 1)
-				{
-					trigger_error("kses5::SetProtocols() did not receive an argument.", E_USER_WARNING);
-					return false;
-				}
-
-				$protocol_data = func_get_arg(0);
-
-				if(is_array($protocol_data) && count($protocol_data) > 0)
-				{
-					$this->allowed_protocols = array();
-					foreach($protocol_data as $protocol)
-					{
-						$this->AddProtocol($protocol);
-					}
-					return true;
-				}
-				elseif(is_string($protocol_data))
-				{
-					$this->allowed_protocols = array();
-					$this->AddProtocol($protocol_data);
-					return true;
-				}
-				else
-				{
-					trigger_error("kses5::SetProtocols() did not receive a string or an array.", E_USER_WARNING);
-					return false;
-				}
-			}
-
-			/**
-			 *	Raw dump of allowed protocols
-			 *
-			 *	This returns an indexed array of allowed protocols for a particular KSES
-			 *	instantiation.
-			 *
-			 *	@access public
-			 *	@return array The list of allowed protocols.
-			 *	@since PHP5 OOP 1.0.2
-			 */
-			public function DumpProtocols()
-			{
-				return $this->allowed_protocols;
-			}
-
-			/**
-			 *	Raw dump of allowed (X)HTML elements
-			 *
-			 *	This returns an indexed array of allowed (X)HTML elements and attributes
-			 *	for a particular KSES instantiation.
-			 *
-			 *	@access public
-			 *	@return array The list of allowed elements.
-			 *	@since PHP5 OOP 1.0.2
-			 */
-			public function DumpElements()
-			{
-				return $this->allowed_html;
-			}
-
-
-			/**
-			 *	Adds valid (X)HTML with corresponding attributes that will be kept when stripping 'evil scripts'.
-			 *
-			 *	This method accepts one argument that can be either a string
-			 *	or an array of strings.  Invalid data will be ignored.
-			 *
-			 *	@access public
-			 *	@param string $tag (X)HTML tag that will be allowed after stripping text.
-			 *	@param array $attribs Associative array of allowed attributes - key => attribute name - value => attribute parameter
-			 *	@return bool Status of Adding (X)HTML and attributes.
-			 *	@since PHP4 OOP 0.0.1
-			 */
-			public function AddHTML($tag = "", $attribs = array())
-			{
-				if(!is_string($tag))
-				{
-					trigger_error("kses5::AddHTML() requires the tag to be a string", E_USER_WARNING);
-					return false;
-				}
-
-				$tag = strtolower(trim($tag));
-				if($tag == "")
-				{
-					trigger_error("kses5::AddHTML() tried to add an empty/NULL tag", E_USER_WARNING);
-					return false;
-				}
-
-				if(!is_array($attribs))
-				{
-					trigger_error("kses5::AddHTML() requires an array (even an empty one) of attributes for '$tag'", E_USER_WARNING);
-					return false;
-				}
-
-				$new_attribs = array();
-				if(is_array($attribs) && count($attribs) > 0)
-				{
-					foreach($attribs as $idx1 => $val1)
-					{
-						$new_idx1 = strtolower($idx1);
-						$new_val1 = $attribs[$idx1];
-
-						if(is_array($new_val1) && count($attribs) > 0)
-						{
-							$tmp_val = array();
-							foreach($new_val1 as $idx2 => $val2)
-							{
-								$new_idx2 = strtolower($idx2);
-								$tmp_val[$new_idx2] = $val2;
-							}
-							$new_val1 = $tmp_val;
-						}
-
-						$new_attribs[$new_idx1] = $new_val1;
-					}
-				}
-
-				$this->allowed_html[$tag] = $new_attribs;
-				return true;
-			}
-
-			/**
-			 *	This method removes any NULL characters in $string.
-			 *
-			 *	@access private
-			 *	@param string $string
-			 *	@return string String without any NULL/chr(173)
-			 *	@since PHP4 OOP 0.0.1
-			 */
-			private function removeNulls($string)
-			{
-				$string = preg_replace('/\0+/', '', $string);
-				$string = preg_replace('/(\\\\0)+/', '', $string);
-				return $string;
-			}
-
-			/**
-			 *	Normalizes HTML entities
-			 *
-			 *	This function normalizes HTML entities. It will convert "AT&T" to the correct
-			 *	"AT&amp;T", "&#00058;" to "&#58;", "&#XYZZY;" to "&amp;#XYZZY;" and so on.
-			 *
-			 *	@access private
-			 *	@param string $string
-			 *	@return string String with normalized entities
-			 *	@since PHP4 OOP 0.0.1
-			 */
-			private function normalizeEntities($string)
-			{
-				# Disarm all entities by converting & to &amp;
-				$string = str_replace('&', '&amp;', $string);
-
-				#	TODO: Change back (Keep?) the allowed entities in our entity white list
-
-				#	Keeps entities that start with [A-Za-z]
-				$string = preg_replace(
-					'/&amp;([A-Za-z][A-Za-z0-9]{0,19});/',
-					'&\\1;',
-					$string
-				);
-
-				#	Change numeric entities to valid 16 bit values
-
-				$string = preg_replace(
-					'/&amp;#0*([0-9]{1,5});/e',
-					'\$this->normalizeEntities16bit("\\1")',
-					$string
-				);
-
-				#	Change &XHHHHHHH (Hex digits) to 16 bit hex values
-				$string = preg_replace(
-					'/&amp;#([Xx])0*(([0-9A-Fa-f]{2}){1,2});/',
-					'&#\\1\\2;',
-					$string
-				);
-
-				return $string;
-			}
-
-			/**
-			 *	Helper method used by normalizeEntites()
-			 *
-			 *	This method helps normalizeEntities() to only accept 16 bit values
-			 *	and nothing more for &#number; entities.
-			 *
-			 *	This method helps normalize_entities() during a preg_replace()
-			 *	where a &#(0)*XXXXX; occurs.  The '(0)*XXXXXX' value is converted to
-			 *	a number and the result is returned as a numeric entity if the number
-			 *	is less than 65536.  Otherwise, the value is returned 'as is'.
-			 *
-			 *	@access private
-			 *	@param string $i
-			 *	@return string Normalized numeric entity
-			 *	@see normalizeEntities()
-			 *	@since PHP4 OOP 0.0.1
-			 */
-			private function normalizeEntities16bit($i)
-			{
-			  return (($i > 65535) ? "&amp;#$i;" : "&#$i;");
-			}
-
-			/**
-			 *	Allows for additional user defined modifications to text.
-			 *
-			 *	This method allows for additional modifications to be performed on
-			 *	a string that's being run through Parse().  Currently, it returns the
-			 *	input string 'as is'.
-			 *
-			 *	This method is provided for users to extend the kses class for their own
-			 *	requirements.
-			 *
-			 *	@access public
-			 *	@param string $string String to perfrom additional modifications on.
-			 *	@return string User modified string.
-			 *	@see Parse()
-			 *	@since PHP5 OOP 1.0.0
-			 */
-			private function filterKsesTextHook($string)
-			{
-			  return $string;
-			}
-
-			/**
-			 *	Allows for additional user defined modifications to text.
-			 *
-			 *	@deprecated use filterKsesTextHook()
-			 *	@param string $string
-			 *	@return string
-			 *	@see filterKsesTextHook()
-			 *	@since PHP4 OOP 0.0.1
-			 */
-			private function _hook($string)
-			{
-				return $this->filterKsesTextHook($string);
-			}
-
-			/**
-			 *	This method goes through an array, and changes the keys to all lower case.
-			 *
-			 *	@access private
-			 *	@param array $in_array Associative array
-			 *	@return array Modified array
-			 *	@since PHP4 OOP 0.0.1
-			 */
-			private function makeArrayKeysLowerCase($in_array)
-			{
-				$out_array = array();
-
-				if(is_array($in_array) && count($in_array) > 0)
-				{
-					foreach ($in_array as $in_key => $in_val)
-					{
-						$out_key = strtolower($in_key);
-						$out_array[$out_key] = array();
-
-						if(is_array($in_val) && count($in_val) > 0)
-						{
-							foreach ($in_val as $in_key2 => $in_val2)
-							{
-								$out_key2 = strtolower($in_key2);
-								$out_array[$out_key][$out_key2] = $in_val2;
-							}
-						}
-					}
-				}
-
-				return $out_array;
-			}
-
-			/**
-			 *	This method strips out disallowed and/or mangled (X)HTML tags along with assigned attributes.
-			 *
-			 *	This method does a lot of work. It rejects some very malformed things
-			 *	like <:::>. It returns an empty string if the element isn't allowed (look
-			 *	ma, no strip_tags()!). Otherwise it splits the tag into an element and an
-			 *	allowed attribute list.
-			 *
-			 *	@access private
-			 *	@param string $string
-			 *	@return string Modified string minus disallowed/mangled (X)HTML and attributes
-			 *	@since PHP4 OOP 0.0.1
-			 */
-			private function stripTags($string)
-			{
-				$string = preg_replace('%\\\\"%', '"', $string);
-
-				if (substr($string, 0, 1) != '<')
-				{
-					# It matched a ">" character
-					return '&gt;';
-				}
-
-				if (!preg_match('%^<\s*(/\s*)?([a-zA-Z0-9]+)([^>]*)>?$%', $string, $matches))
-				{
-					# It's seriously malformed
-					return '';
-				}
-
-				$slash    = trim($matches[1]);
-				$elem     = $matches[2];
-				$attrlist = $matches[3];
-
-				if (
-					!isset($this->allowed_html[strtolower($elem)]) ||
-					!is_array($this->allowed_html[strtolower($elem)]))
-				{
-					#	Found an HTML element not in the white list
-					return '';
-				}
-
-				if ($slash != '')
-				{
-					return "<$slash$elem>";
-				}
-				# No attributes are allowed for closing elements
-
-				return $this->stripAttributes("$slash$elem", $attrlist);
-			}
-
-			/**
-			 *	This method strips out disallowed attributes for (X)HTML tags.
-			 *
-			 *	This method removes all attributes if none are allowed for this element.
-			 *	If some are allowed it calls combAttributes() to split them further, and then it
-			 *	builds up new HTML code from the data that combAttributes() returns. It also
-			 *	removes "<" and ">" characters, if there are any left. One more thing it
-			 *	does is to check if the tag has a closing XHTML slash, and if it does,
-			 *	it puts one in the returned code as well.
-			 *
-			 *	@access private
-			 *	@param string $element (X)HTML tag to check
-			 *	@param string $attr Text containing attributes to check for validity.
-			 *	@return string Resulting valid (X)HTML or ''
-			 *	@see combAttributes()
-			 *	@since PHP4 OOP 0.0.1
-			 */
-			private function stripAttributes($element, $attr)
-			{
-				# Is there a closing XHTML slash at the end of the attributes?
-				$xhtml_slash = '';
-				if (preg_match('%\s/\s*$%', $attr))
-				{
-					$xhtml_slash = ' /';
-				}
-
-				# Are any attributes allowed at all for this element?
-				if (
-					!isset($this->allowed_html[strtolower($element)]) ||
-					count($this->allowed_html[strtolower($element)]) == 0
-				)
-				{
-					return "<$element$xhtml_slash>";
-				}
-
-				# Split it
-				$attrarr = $this->combAttributes($attr);
-
-				# Go through $attrarr, and save the allowed attributes for this element
-				# in $attr2
-				$attr2 = '';
-				if(is_array($attrarr) && count($attrarr) > 0)
-				{
-					foreach ($attrarr as $arreach)
-					{
-						if(!isset($this->allowed_html[strtolower($element)][strtolower($arreach['name'])]))
-						{
-							continue;
-						}
-
-						$current = $this->allowed_html[strtolower($element)][strtolower($arreach['name'])];
-
-						if (!is_array($current))
-						{
-							# there are no checks
-							$attr2 .= ' '.$arreach['whole'];
-						}
-						else
-						{
-							# there are some checks
-							$ok = true;
-							if(is_array($current) && count($current) > 0)
-							{
-								foreach ($current as $currkey => $currval)
-								{
-									if (!$this->checkAttributeValue($arreach['value'], $arreach['vless'], $currkey, $currval))
-									{
-										$ok = false;
-										break;
-									}
-								}
-							}
-
-							if ($ok)
-							{
-								# it passed them
-								$attr2 .= ' '.$arreach['whole'];
-							}
-						}
-					}
-				}
-
-				# Remove any "<" or ">" characters
-				$attr2 = preg_replace('/[<>]/', '', $attr2);
-				return "<$element$attr2$xhtml_slash>";
-			}
-
-			/**
-			 *	This method combs through an attribute list string and returns an associative array of attributes and values.
-			 *
-			 *	This method does a lot of work. It parses an attribute list into an array
-			 *	with attribute data, and tries to do the right thing even if it gets weird
-			 *	input. It will add quotes around attribute values that don't have any quotes
-			 *	or apostrophes around them, to make it easier to produce HTML code that will
-			 *	conform to W3C's HTML specification. It will also remove bad URL protocols
-			 *	from attribute values.
-			 *
-			 *	@access private
-			 *	@param string $attr Text containing tag attributes for parsing
-			 *	@return array Associative array containing data on attribute and value
-			 *	@since PHP4 OOP 0.0.1
-			 */
-			private function combAttributes($attr)
-			{
-				$attrarr  = array();
-				$mode     = 0;
-				$attrname = '';
-
-				# Loop through the whole attribute list
-
-				while (strlen($attr) != 0)
-				{
-					# Was the last operation successful?
-					$working = 0;
-
-					switch ($mode)
-					{
-						case 0:	# attribute name, href for instance
-							if (preg_match('/^([-a-zA-Z]+)/', $attr, $match))
-							{
-								$attrname = $match[1];
-								$working = $mode = 1;
-								$attr = preg_replace('/^[-a-zA-Z]+/', '', $attr);
-							}
-							break;
-						case 1:	# equals sign or valueless ("selected")
-							if (preg_match('/^\s*=\s*/', $attr)) # equals sign
-							{
-								$working = 1;
-								$mode    = 2;
-								$attr    = preg_replace('/^\s*=\s*/', '', $attr);
-								break;
-							}
-							if (preg_match('/^\s+/', $attr)) # valueless
-							{
-								$working   = 1;
-								$mode      = 0;
-								$attrarr[] = array(
-									'name'  => $attrname,
-									'value' => '',
-									'whole' => $attrname,
-									'vless' => 'y'
-								);
-								$attr      = preg_replace('/^\s+/', '', $attr);
-							}
-							break;
-						case 2: # attribute value, a URL after href= for instance
-							if (preg_match('/^"([^"]*)"(\s+|$)/', $attr, $match)) # "value"
-							{
-								$thisval   = $this->removeBadProtocols($match[1]);
-								$attrarr[] = array(
-									'name'  => $attrname,
-									'value' => $thisval,
-									'whole' => $attrname . '="' . $thisval . '"',
-									'vless' => 'n'
-								);
-								$working   = 1;
-								$mode      = 0;
-								$attr      = preg_replace('/^"[^"]*"(\s+|$)/', '', $attr);
-								break;
-							}
-							if (preg_match("/^'([^']*)'(\s+|$)/", $attr, $match)) # 'value'
-							{
-								$thisval   = $this->removeBadProtocols($match[1]);
-								$attrarr[] = array(
-									'name'  => $attrname,
-									'value' => $thisval,
-									'whole' => "$attrname='$thisval'",
-									'vless' => 'n'
-								);
-								$working   = 1;
-								$mode      = 0;
-								$attr      = preg_replace("/^'[^']*'(\s+|$)/", '', $attr);
-								break;
-							}
-							if (preg_match("%^([^\s\"']+)(\s+|$)%", $attr, $match)) # value
-							{
-								$thisval   = $this->removeBadProtocols($match[1]);
-								$attrarr[] = array(
-									'name'  => $attrname,
-									'value' => $thisval,
-									'whole' => $attrname . '="' . $thisval . '"',
-									'vless' => 'n'
-								);
-								# We add quotes to conform to W3C's HTML spec.
-								$working   = 1;
-								$mode      = 0;
-								$attr      = preg_replace("%^[^\s\"']+(\s+|$)%", '', $attr);
-							}
-							break;
-					}
-
-					if ($working == 0) # not well formed, remove and try again
-					{
-						$attr = preg_replace('/^("[^"]*("|$)|\'[^\']*(\'|$)|\S)*\s*/', '', $attr);
-						$mode = 0;
-					}
-				}
-
-				# special case, for when the attribute list ends with a valueless
-				# attribute like "selected"
-				if ($mode == 1)
-				{
-					$attrarr[] = array(
-						'name'  => $attrname,
-						'value' => '',
-						'whole' => $attrname,
-						'vless' => 'y'
-					);
-				}
-
-				return $attrarr;
-			}
-
-			/**
-			 *	This method removes disallowed protocols.
-			 *
-			 *	This method removes all non-allowed protocols from the beginning of
-			 *	$string. It ignores whitespace and the case of the letters, and it does
-			 *	understand HTML entities. It does its work in a while loop, so it won't be
-			 *	fooled by a string like "javascript:javascript:alert(57)".
-			 *
-			 *	@access private
-			 *	@param string $string String to check for protocols
-			 *	@return string String with removed protocols
-			 *	@since PHP4 OOP 0.0.1
-			 */
-			private function removeBadProtocols($string)
-			{
-				$string  = $this->RemoveNulls($string);
-				$string = preg_replace('/\xad+/', '', $string); # deals with Opera "feature"
-				$string2 = $string . 'a';
-
-				$string2 = preg_split('/:|&#58;|&#x3a;/i', $string, 2);
-				if(isset($string2[1]) && !preg_match('%/\?%',$string2[0]))
-				{
-					$string = $this->filterProtocols($string2[0]).trim($string2[1]);
-				}
-				return $string;
-			}
-
-			/**
-			 *	Helper method used by removeBadProtocols()
-			 *
-			 *	This function processes URL protocols, checks to see if they're in the white-
-			 *	list or not, and returns different data depending on the answer.
-			 *
-			 *	@access private
-			 *	@param string $string String to check for protocols
-			 *	@return string String with removed protocols
-			 *	@see removeBadProtocols()
-			 *	@since PHP4 OOP 0.0.1
-			 */
-			private function filterProtocols($string)
-			{
-				$string = $this->decodeEntities($string);
-				$string = preg_replace('/\s/', '', $string);
-				$string = $this->removeNulls($string);
-				$string = preg_replace('/\xad+/', '', $string2); # deals with Opera "feature"
-				$string = strtolower($string);
-
-				if(is_array($this->allowed_protocols) && count($this->allowed_protocols) > 0)
-				{
-					foreach ($this->allowed_protocols as $one_protocol)
-					{
-						if (strtolower($one_protocol) == $string)
-						{
-							return "$string:";
-						}
-					}
-				}
-
-				return '';
-			}
-
-			/**
-			 *	Controller method for performing checks on attribute values.
-			 *
-			 *	This method calls the appropriate method as specified by $checkname with
-			 *	the parameters $value, $vless, and $checkvalue, and returns the result
-			 *	of the call.
-			 *
-			 *	This method's functionality can be expanded by creating new methods
-			 *	that would match checkAttributeValue[$checkname].
-			 *
-			 *	Current checks implemented are: "maxlen", "minlen", "maxval", "minval" and "valueless"
-			 *
-			 *	@access private
-			 *	@param string $value The value of the attribute to be checked.
-			 *	@param string $vless Indicates whether the the value is supposed to be valueless
-			 *	@param string $checkname The check to be performed
-			 *	@param string $checkvalue The value that is to be checked against
-			 *	@return bool Indicates whether the check passed or not
-			 *	@since PHP5 OOP 1.0.0
-			 */
-			private function checkAttributeValue($value, $vless, $checkname, $checkvalue)
-			{
-				$ok = true;
-				$check_attribute_method_name  = 'checkAttributeValue' . ucfirst(strtolower($checkname));
-				if(method_exists($this, $check_attribute_method_name))
-				{
-					$ok = $this->$check_attribute_method_name($value, $checkvalue, $vless);
-				}
-
-				return $ok;
-			}
-
-			/**
-			 *	Helper method invoked by checkAttributeValue().
-			 *
-			 *	The maxlen check makes sure that the attribute value has a length not
-			 *	greater than the given value. This can be used to avoid Buffer Overflows
-			 *	in WWW clients and various Internet servers.
-			 *
-			 *	@access private
-			 *	@param string $value The value of the attribute to be checked.
-			 *	@param int $checkvalue The maximum value allowed
-			 *	@return bool Indicates whether the check passed or not
-			 *	@see checkAttributeValue()
-			 *	@since PHP5 OOP 1.0.0
-			 */
-			private function checkAttributeValueMaxlen($value, $checkvalue)
-			{
-				if (strlen($value) > intval($checkvalue))
-				{
-					return false;
-				}
-				return true;
-			}
-
-			/**
-			 *	Helper method invoked by checkAttributeValue().
-			 *
-			 *	The minlen check makes sure that the attribute value has a length not
-			 *	smaller than the given value.
-			 *
-			 *	@access private
-			 *	@param string $value The value of the attribute to be checked.
-			 *	@param int $checkvalue The minimum value allowed
-			 *	@return bool Indicates whether the check passed or not
-			 *	@see checkAttributeValue()
-			 *	@since PHP5 OOP 1.0.0
-			 */
-			private function checkAttributeValueMinlen($value, $checkvalue)
-			{
-				if (strlen($value) < intval($checkvalue))
-				{
-					return false;
-				}
-				return true;
-			}
-
-			/**
-			 *	Helper method invoked by checkAttributeValue().
-			 *
-			 *	The maxval check does two things: it checks that the attribute value is
-			 *	an integer from 0 and up, without an excessive amount of zeroes or
-			 *	whitespace (to avoid Buffer Overflows). It also checks that the attribute
-			 *	value is not greater than the given value.
-			 *
-			 *	This check can be used to avoid Denial of Service attacks.
-			 *
-			 *	@access private
-			 *	@param int $value The value of the attribute to be checked.
-			 *	@param int $checkvalue The maximum numeric value allowed
-			 *	@return bool Indicates whether the check passed or not
-			 *	@see checkAttributeValue()
-			 *	@since PHP5 OOP 1.0.0
-			 */
-			private function checkAttributeValueMaxval($value, $checkvalue)
-			{
-				if (!preg_match('/^\s{0,6}[0-9]{1,6}\s{0,6}$/', $value))
-				{
-					return false;
-				}
-				if (intval($value) > intval($checkvalue))
-				{
-					return false;
-				}
-				return true;
-			}
-
-			/**
-			 *	Helper method invoked by checkAttributeValue().
-			 *
-			 *	The minval check checks that the attribute value is a positive integer,
-			 *	and that it is not smaller than the given value.
-			 *
-			 *	@access private
-			 *	@param int $value The value of the attribute to be checked.
-			 *	@param int $checkvalue The minimum numeric value allowed
-			 *	@return bool Indicates whether the check passed or not
-			 *	@see checkAttributeValue()
-			 *	@since PHP5 OOP 1.0.0
-			 */
-			private function checkAttributeValueMinval($value, $checkvalue)
-			{
-				if (!preg_match('/^\s{0,6}[0-9]{1,6}\s{0,6}$/', $value))
-				{
-					return false;
-				}
-				if (intval($value) < ($checkvalue))
-				{
-					return false;
-				}
-				return true;
-			}
-
-			/**
-			 *	Helper method invoked by checkAttributeValue().
-			 *
-			 *	The valueless check checks if the attribute has a value
-			 *	(like <a href="blah">) or not (<option selected>). If the given value
-			 *	is a "y" or a "Y", the attribute must not have a value.
-			 *
-			 *	If the given value is an "n" or an "N", the attribute must have one.
-			 *
-			 *	@access private
-			 *	@param int $value The value of the attribute to be checked.
-			 *	@param mixed $checkvalue This variable is ignored for this test
-			 *	@param string $vless Flag indicating if this attribute is not supposed to have an attribute
-			 *	@return bool Indicates whether the check passed or not
-			 *	@see checkAttributeValue()
-			 *	@since PHP5 OOP 1.0.0
-			 */
-			private function checkAttributeValueValueless($value, $checkvalue, $vless)
-			{
-				if (strtolower($checkvalue) != $vless)
-				{
-					return false;
-				}
-				return true;
-			}
-
-			/**
-			 *	Decodes numeric HTML entities
-			 *
-			 *	This method decodes numeric HTML entities (&#65; and &#x41;). It doesn't
-			 *	do anything with other entities like &auml;, but we don't need them in the
-			 *	URL protocol white listing system anyway.
-			 *
-			 *	@access private
-			 *	@param string $value The entitiy to be decoded.
-			 *	@return string Decoded entity
-			 *	@since PHP4 OOP 0.0.1
-			 */
-			private function decodeEntities($string)
-			{
-				$string = preg_replace('/&#([0-9]+);/e', 'chr("\\1")', $string);
-				$string = preg_replace('/&#[Xx]([0-9A-Fa-f]+);/e', 'chr(hexdec("\\1"))', $string);
-				return $string;
-			}
-
-			/**
-			 *	Returns PHP5 OOP version # of kses.
-			 *
-			 *	Since this class has been refactored and documented and proven to work,
-			 *	I'm fixing the version number at 1.0.0.
-			 *
-			 *	This version is syntax compatible with the PHP4 OOP version 0.0.2.  Future
-			 *	versions may not be syntax compatible.
-			 *
-			 *	@access public
-			 *	@return string Version number
-			 *	@since PHP4 OOP 0.0.1
-			 */
-			public function Version()
-			{
-				return 'PHP5 OOP 1.0.2';
-			}
-		}
-	}
+            private $allowed_protocols;
+            private $allowed_html;
+            /**#@-*/
+
+            /**
+             *	Constructor for kses.
+             *
+             *	This sets a default collection of protocols allowed in links, and creates an
+             *	empty set of allowed HTML tags.
+             *	@since PHP5 OOP 1.0.0
+             */
+            public function __construct()
+            {
+                /**
+                 *	You could add protocols such as ftp, new, gopher, mailto, irc, etc.
+                 *
+                 *	The base values the original kses provided were:
+                 *		'http', 'https', 'ftp', 'news', 'nntp', 'telnet', 'gopher', 'mailto'
+                 */
+                $this->allowed_protocols = array('http', 'ftp', 'mailto');
+                $this->allowed_html      = array();
+            }
+
+            /**
+             *	Basic task of kses - parses $string and strips it as required.
+             *
+             *	This method strips all the disallowed (X)HTML tags, attributes
+             *	and protocols from the input $string.
+             *
+             *	@access public
+             *	@param string $string String to be stripped of 'evil scripts'
+             *	@return string The stripped string
+             *	@since PHP4 OOP 0.0.1
+             */
+            public function Parse($string = "")
+            {
+                if (get_magic_quotes_gpc())
+                {
+                    $string = stripslashes($string);
+                }
+                $string = $this->removeNulls($string);
+                //	Remove JavaScript entities from early Netscape 4 versions
+                $string = preg_replace('%&\s*\{[^}]*(\}\s*;?|$)%', '', $string);
+                $string = $this->normalizeEntities($string);
+                $string = $this->filterKsesTextHook($string);
+                $string = preg_replace('%(<' . '[^>]*' . '(>|$)' . '|>)%e', "\$this->stripTags('\\1')", $string);
+                return $string;
+            }
+
+            /**
+             *	Allows for single/batch addition of protocols
+             *
+             *	This method accepts one argument that can be either a string
+             *	or an array of strings.  Invalid data will be ignored.
+             *
+             *	The argument will be processed, and each string will be added
+             *	via AddProtocol().
+             *
+             *	@access public
+             *	@param mixed , A string or array of protocols that will be added to the internal list of allowed protocols.
+             *	@return bool Status of adding valid protocols.
+             *	@see AddProtocol()
+             *	@since PHP5 OOP 1.0.0
+             */
+            public function AddProtocols()
+            {
+                $c_args = func_num_args();
+                if($c_args != 1)
+                {
+                    trigger_error("kses5::AddProtocols() did not receive an argument.", E_USER_WARNING);
+                    return false;
+                }
+
+                $protocol_data = func_get_arg(0);
+
+                if(is_array($protocol_data) && count($protocol_data) > 0)
+                {
+                    foreach($protocol_data as $protocol)
+                    {
+                        $this->AddProtocol($protocol);
+                    }
+                    return true;
+                }
+                elseif(is_string($protocol_data))
+                {
+                    $this->AddProtocol($protocol_data);
+                    return true;
+                }
+                else
+                {
+                    trigger_error("kses5::AddProtocols() did not receive a string or an array.", E_USER_WARNING);
+                    return false;
+                }
+            }
+
+            /**
+             *	Allows for single/batch addition of protocols
+             *
+             *	@deprecated Use AddProtocols()
+             *	@see AddProtocols()
+             *	@return bool
+             *	@since PHP4 OOP 0.0.1
+             */
+            public function Protocols()
+            {
+                $c_args = func_num_args();
+                if($c_args != 1)
+                {
+                    trigger_error("kses5::Protocols() did not receive an argument.", E_USER_WARNING);
+                    return false;
+                }
+
+                return $this->AddProtocols(func_get_arg(0));
+            }
+
+            /**
+             *	Adds a single protocol to $this->allowed_protocols.
+             *
+             *	This method accepts a string argument and adds it to
+             *	the list of allowed protocols to keep when performing
+             *	Parse().
+             *
+             *	@access public
+             *	@param string $protocol The name of the protocol to be added.
+             *	@return bool Status of adding valid protocol.
+             *	@since PHP4 OOP 0.0.1
+             */
+            public function AddProtocol($protocol = "")
+            {
+                if(!is_string($protocol))
+                {
+                    trigger_error("kses5::AddProtocol() requires a string.", E_USER_WARNING);
+                    return false;
+                }
+
+                // Remove any inadvertent ':' at the end of the protocol.
+                if(substr($protocol, strlen($protocol) - 1, 1) == ":")
+                {
+                    $protocol = substr($protocol, 0, strlen($protocol) - 1);
+                }
+
+                $protocol = strtolower(trim($protocol));
+                if($protocol == "")
+                {
+                    trigger_error("kses5::AddProtocol() tried to add an empty/NULL protocol.", E_USER_WARNING);
+                    return false;
+                }
+
+                //	prevent duplicate protocols from being added.
+                if(!in_array($protocol, $this->allowed_protocols))
+                {
+                    array_push($this->allowed_protocols, $protocol);
+                    sort($this->allowed_protocols);
+                }
+                return true;
+            }
+
+            /**
+             *	Removes a single protocol from $this->allowed_protocols.
+             *
+             *	This method accepts a string argument and removes it from
+             *	the list of allowed protocols to keep when performing
+             *	Parse().
+             *
+             *	@access public
+             *	@param string $protocol The name of the protocol to be removed.
+             *	@return bool Status of removing valid protocol.
+             *	@since PHP5 OOP 1.0.0
+             */
+            public function RemoveProtocol($protocol = "")
+            {
+                if(!is_string($protocol))
+                {
+                    trigger_error("kses5::RemoveProtocol() requires a string.", E_USER_WARNING);
+                    return false;
+                }
+
+                // Remove any inadvertent ':' at the end of the protocol.
+                if(substr($protocol, strlen($protocol) - 1, 1) == ":")
+                {
+                    $protocol = substr($protocol, 0, strlen($protocol) - 1);
+                }
+
+                $protocol = strtolower(trim($protocol));
+                if($protocol == "")
+                {
+                    trigger_error("kses5::RemoveProtocol() tried to remove an empty/NULL protocol.", E_USER_WARNING);
+                    return false;
+                }
+
+                //	Ensures that the protocol exists before removing it.
+                if(in_array($protocol, $this->allowed_protocols))
+                {
+                    $this->allowed_protocols = array_diff($this->allowed_protocols, array($protocol));
+                    sort($this->allowed_protocols);
+                }
+
+                return true;
+            }
+
+            /**
+             *	Allows for single/batch removal of protocols
+             *
+             *	This method accepts one argument that can be either a string
+             *	or an array of strings.  Invalid data will be ignored.
+             *
+             *	The argument will be processed, and each string will be removed
+             *	via RemoveProtocol().
+             *
+             *	@access public
+             *	@param mixed , A string or array of protocols that will be removed from the internal list of allowed protocols.
+             *	@return bool Status of removing valid protocols.
+             *	@see RemoveProtocol()
+             *	@since PHP5 OOP 1.0.0
+             */
+            public function RemoveProtocols()
+            {
+                $c_args = func_num_args();
+                if($c_args != 1)
+                {
+                    return false;
+                }
+
+                $protocol_data = func_get_arg(0);
+
+                if(is_array($protocol_data) && count($protocol_data) > 0)
+                {
+                    foreach($protocol_data as $protocol)
+                    {
+                        $this->RemoveProtocol($protocol);
+                    }
+                }
+                elseif(is_string($protocol_data))
+                {
+                    $this->RemoveProtocol($protocol_data);
+                    return true;
+                }
+                else
+                {
+                    trigger_error("kses5::RemoveProtocols() did not receive a string or an array.", E_USER_WARNING);
+                    return false;
+                }
+            }
+
+            /**
+             *	Allows for single/batch replacement of protocols
+             *
+             *	This method accepts one argument that can be either a string
+             *	or an array of strings.  Invalid data will be ignored.
+             *
+             *	Existing protocols will be removed, then the argument will be
+             *	processed, and each string will be added via AddProtocol().
+             *
+             *	@access public
+             *	@param mixed , A string or array of protocols that will be the new internal list of allowed protocols.
+             *	@return bool Status of replacing valid protocols.
+             *	@since PHP5 OOP 1.0.1
+             *	@see AddProtocol()
+             */
+            public function SetProtocols()
+            {
+                $c_args = func_num_args();
+                if($c_args != 1)
+                {
+                    trigger_error("kses5::SetProtocols() did not receive an argument.", E_USER_WARNING);
+                    return false;
+                }
+
+                $protocol_data = func_get_arg(0);
+
+                if(is_array($protocol_data) && count($protocol_data) > 0)
+                {
+                    $this->allowed_protocols = array();
+                    foreach($protocol_data as $protocol)
+                    {
+                        $this->AddProtocol($protocol);
+                    }
+                    return true;
+                }
+                elseif(is_string($protocol_data))
+                {
+                    $this->allowed_protocols = array();
+                    $this->AddProtocol($protocol_data);
+                    return true;
+                }
+                else
+                {
+                    trigger_error("kses5::SetProtocols() did not receive a string or an array.", E_USER_WARNING);
+                    return false;
+                }
+            }
+
+            /**
+             *	Raw dump of allowed protocols
+             *
+             *	This returns an indexed array of allowed protocols for a particular KSES
+             *	instantiation.
+             *
+             *	@access public
+             *	@return array The list of allowed protocols.
+             *	@since PHP5 OOP 1.0.2
+             */
+            public function DumpProtocols()
+            {
+                return $this->allowed_protocols;
+            }
+
+            /**
+             *	Raw dump of allowed (X)HTML elements
+             *
+             *	This returns an indexed array of allowed (X)HTML elements and attributes
+             *	for a particular KSES instantiation.
+             *
+             *	@access public
+             *	@return array The list of allowed elements.
+             *	@since PHP5 OOP 1.0.2
+             */
+            public function DumpElements()
+            {
+                return $this->allowed_html;
+            }
+
+
+            /**
+             *	Adds valid (X)HTML with corresponding attributes that will be kept when stripping 'evil scripts'.
+             *
+             *	This method accepts one argument that can be either a string
+             *	or an array of strings.  Invalid data will be ignored.
+             *
+             *	@access public
+             *	@param string $tag (X)HTML tag that will be allowed after stripping text.
+             *	@param array $attribs Associative array of allowed attributes - key => attribute name - value => attribute parameter
+             *	@return bool Status of Adding (X)HTML and attributes.
+             *	@since PHP4 OOP 0.0.1
+             */
+            public function AddHTML($tag = "", $attribs = array())
+            {
+                if(!is_string($tag))
+                {
+                    trigger_error("kses5::AddHTML() requires the tag to be a string", E_USER_WARNING);
+                    return false;
+                }
+
+                $tag = strtolower(trim($tag));
+                if($tag == "")
+                {
+                    trigger_error("kses5::AddHTML() tried to add an empty/NULL tag", E_USER_WARNING);
+                    return false;
+                }
+
+                if(!is_array($attribs))
+                {
+                    trigger_error("kses5::AddHTML() requires an array (even an empty one) of attributes for '$tag'", E_USER_WARNING);
+                    return false;
+                }
+
+                $new_attribs = array();
+                if(is_array($attribs) && count($attribs) > 0)
+                {
+                    foreach($attribs as $idx1 => $val1)
+                    {
+                        $new_idx1 = strtolower($idx1);
+                        $new_val1 = $attribs[$idx1];
+
+                        if(is_array($new_val1) && count($attribs) > 0)
+                        {
+                            $tmp_val = array();
+                            foreach($new_val1 as $idx2 => $val2)
+                            {
+                                $new_idx2 = strtolower($idx2);
+                                $tmp_val[$new_idx2] = $val2;
+                            }
+                            $new_val1 = $tmp_val;
+                        }
+
+                        $new_attribs[$new_idx1] = $new_val1;
+                    }
+                }
+
+                $this->allowed_html[$tag] = $new_attribs;
+                return true;
+            }
+
+            /**
+             *	This method removes any NULL characters in $string.
+             *
+             *	@access private
+             *	@param string $string
+             *	@return string String without any NULL/chr(173)
+             *	@since PHP4 OOP 0.0.1
+             */
+            private function removeNulls($string)
+            {
+                $string = preg_replace('/\0+/', '', $string);
+                $string = preg_replace('/(\\\\0)+/', '', $string);
+                return $string;
+            }
+
+            /**
+             *	Normalizes HTML entities
+             *
+             *	This function normalizes HTML entities. It will convert "AT&T" to the correct
+             *	"AT&amp;T", "&#00058;" to "&#58;", "&#XYZZY;" to "&amp;#XYZZY;" and so on.
+             *
+             *	@access private
+             *	@param string $string
+             *	@return string String with normalized entities
+             *	@since PHP4 OOP 0.0.1
+             */
+            private function normalizeEntities($string)
+            {
+                # Disarm all entities by converting & to &amp;
+                $string = str_replace('&', '&amp;', $string);
+
+                #	TODO: Change back (Keep?) the allowed entities in our entity white list
+
+                #	Keeps entities that start with [A-Za-z]
+                $string = preg_replace(
+                    '/&amp;([A-Za-z][A-Za-z0-9]{0,19});/',
+                    '&\\1;',
+                    $string
+                );
+
+                #	Change numeric entities to valid 16 bit values
+
+                $string = preg_replace(
+                    '/&amp;#0*([0-9]{1,5});/e',
+                    '\$this->normalizeEntities16bit("\\1")',
+                    $string
+                );
+
+                #	Change &XHHHHHHH (Hex digits) to 16 bit hex values
+                $string = preg_replace(
+                    '/&amp;#([Xx])0*(([0-9A-Fa-f]{2}){1,2});/',
+                    '&#\\1\\2;',
+                    $string
+                );
+
+                return $string;
+            }
+
+            /**
+             *	Helper method used by normalizeEntites()
+             *
+             *	This method helps normalizeEntities() to only accept 16 bit values
+             *	and nothing more for &#number; entities.
+             *
+             *	This method helps normalize_entities() during a preg_replace()
+             *	where a &#(0)*XXXXX; occurs.  The '(0)*XXXXXX' value is converted to
+             *	a number and the result is returned as a numeric entity if the number
+             *	is less than 65536.  Otherwise, the value is returned 'as is'.
+             *
+             *	@access private
+             *	@param string $i
+             *	@return string Normalized numeric entity
+             *	@see normalizeEntities()
+             *	@since PHP4 OOP 0.0.1
+             */
+            private function normalizeEntities16bit($i)
+            {
+                return (($i > 65535) ? "&amp;#$i;" : "&#$i;");
+            }
+
+            /**
+             *	Allows for additional user defined modifications to text.
+             *
+             *	This method allows for additional modifications to be performed on
+             *	a string that's being run through Parse().  Currently, it returns the
+             *	input string 'as is'.
+             *
+             *	This method is provided for users to extend the kses class for their own
+             *	requirements.
+             *
+             *	@access public
+             *	@param string $string String to perfrom additional modifications on.
+             *	@return string User modified string.
+             *	@see Parse()
+             *	@since PHP5 OOP 1.0.0
+             */
+            private function filterKsesTextHook($string)
+            {
+                return $string;
+            }
+
+            /**
+             *	Allows for additional user defined modifications to text.
+             *
+             *	@deprecated use filterKsesTextHook()
+             *	@param string $string
+             *	@return string
+             *	@see filterKsesTextHook()
+             *	@since PHP4 OOP 0.0.1
+             */
+            private function _hook($string)
+            {
+                return $this->filterKsesTextHook($string);
+            }
+
+            /**
+             *	This method goes through an array, and changes the keys to all lower case.
+             *
+             *	@access private
+             *	@param array $in_array Associative array
+             *	@return array Modified array
+             *	@since PHP4 OOP 0.0.1
+             */
+            private function makeArrayKeysLowerCase($in_array)
+            {
+                $out_array = array();
+
+                if(is_array($in_array) && count($in_array) > 0)
+                {
+                    foreach ($in_array as $in_key => $in_val)
+                    {
+                        $out_key = strtolower($in_key);
+                        $out_array[$out_key] = array();
+
+                        if(is_array($in_val) && count($in_val) > 0)
+                        {
+                            foreach ($in_val as $in_key2 => $in_val2)
+                            {
+                                $out_key2 = strtolower($in_key2);
+                                $out_array[$out_key][$out_key2] = $in_val2;
+                            }
+                        }
+                    }
+                }
+
+                return $out_array;
+            }
+
+            /**
+             *	This method strips out disallowed and/or mangled (X)HTML tags along with assigned attributes.
+             *
+             *	This method does a lot of work. It rejects some very malformed things
+             *	like <:::>. It returns an empty string if the element isn't allowed (look
+             *	ma, no strip_tags()!). Otherwise it splits the tag into an element and an
+             *	allowed attribute list.
+             *
+             *	@access private
+             *	@param string $string
+             *	@return string Modified string minus disallowed/mangled (X)HTML and attributes
+             *	@since PHP4 OOP 0.0.1
+             */
+            private function stripTags($string)
+            {
+                $string = preg_replace('%\\\\"%', '"', $string);
+
+                if (substr($string, 0, 1) != '<')
+                {
+                    # It matched a ">" character
+                    return '&gt;';
+                }
+
+                if (!preg_match('%^<\s*(/\s*)?([a-zA-Z0-9]+)([^>]*)>?$%', $string, $matches))
+                {
+                    # It's seriously malformed
+                    return '';
+                }
+
+                $slash    = trim($matches[1]);
+                $elem     = $matches[2];
+                $attrlist = $matches[3];
+
+                if (
+                    !isset($this->allowed_html[strtolower($elem)]) ||
+                    !is_array($this->allowed_html[strtolower($elem)]))
+                {
+                    #	Found an HTML element not in the white list
+                    return '';
+                }
+
+                if ($slash != '')
+                {
+                    return "<$slash$elem>";
+                }
+                # No attributes are allowed for closing elements
+
+                return $this->stripAttributes("$slash$elem", $attrlist);
+            }
+
+            /**
+             *	This method strips out disallowed attributes for (X)HTML tags.
+             *
+             *	This method removes all attributes if none are allowed for this element.
+             *	If some are allowed it calls combAttributes() to split them further, and then it
+             *	builds up new HTML code from the data that combAttributes() returns. It also
+             *	removes "<" and ">" characters, if there are any left. One more thing it
+             *	does is to check if the tag has a closing XHTML slash, and if it does,
+             *	it puts one in the returned code as well.
+             *
+             *	@access private
+             *	@param string $element (X)HTML tag to check
+             *	@param string $attr Text containing attributes to check for validity.
+             *	@return string Resulting valid (X)HTML or ''
+             *	@see combAttributes()
+             *	@since PHP4 OOP 0.0.1
+             */
+            private function stripAttributes($element, $attr)
+            {
+                # Is there a closing XHTML slash at the end of the attributes?
+                $xhtml_slash = '';
+                if (preg_match('%\s/\s*$%', $attr))
+                {
+                    $xhtml_slash = ' /';
+                }
+
+                # Are any attributes allowed at all for this element?
+                if (
+                    !isset($this->allowed_html[strtolower($element)]) ||
+                    count($this->allowed_html[strtolower($element)]) == 0
+                )
+                {
+                    return "<$element$xhtml_slash>";
+                }
+
+                # Split it
+                $attrarr = $this->combAttributes($attr);
+
+                # Go through $attrarr, and save the allowed attributes for this element
+                # in $attr2
+                $attr2 = '';
+                if(is_array($attrarr) && count($attrarr) > 0)
+                {
+                    foreach ($attrarr as $arreach)
+                    {
+                        if(!isset($this->allowed_html[strtolower($element)][strtolower($arreach['name'])]))
+                        {
+                            continue;
+                        }
+
+                        $current = $this->allowed_html[strtolower($element)][strtolower($arreach['name'])];
+
+                        if (!is_array($current))
+                        {
+                            # there are no checks
+                            $attr2 .= ' '.$arreach['whole'];
+                        }
+                        else
+                        {
+                            # there are some checks
+                            $ok = true;
+                            if(is_array($current) && count($current) > 0)
+                            {
+                                foreach ($current as $currkey => $currval)
+                                {
+                                    if (!$this->checkAttributeValue($arreach['value'], $arreach['vless'], $currkey, $currval))
+                                    {
+                                        $ok = false;
+                                        break;
+                                    }
+                                }
+                            }
+
+                            if ($ok)
+                            {
+                                # it passed them
+                                $attr2 .= ' '.$arreach['whole'];
+                            }
+                        }
+                    }
+                }
+
+                # Remove any "<" or ">" characters
+                $attr2 = preg_replace('/[<>]/', '', $attr2);
+                return "<$element$attr2$xhtml_slash>";
+            }
+
+            /**
+             *	This method combs through an attribute list string and returns an associative array of attributes and values.
+             *
+             *	This method does a lot of work. It parses an attribute list into an array
+             *	with attribute data, and tries to do the right thing even if it gets weird
+             *	input. It will add quotes around attribute values that don't have any quotes
+             *	or apostrophes around them, to make it easier to produce HTML code that will
+             *	conform to W3C's HTML specification. It will also remove bad URL protocols
+             *	from attribute values.
+             *
+             *	@access private
+             *	@param string $attr Text containing tag attributes for parsing
+             *	@return array Associative array containing data on attribute and value
+             *	@since PHP4 OOP 0.0.1
+             */
+            private function combAttributes($attr)
+            {
+                $attrarr  = array();
+                $mode     = 0;
+                $attrname = '';
+
+                # Loop through the whole attribute list
+
+                while (strlen($attr) != 0)
+                {
+                    # Was the last operation successful?
+                    $working = 0;
+
+                    switch ($mode)
+                    {
+                        case 0:	# attribute name, href for instance
+                            if (preg_match('/^([-a-zA-Z]+)/', $attr, $match))
+                            {
+                                $attrname = $match[1];
+                                $working = $mode = 1;
+                                $attr = preg_replace('/^[-a-zA-Z]+/', '', $attr);
+                            }
+                            break;
+                        case 1:	# equals sign or valueless ("selected")
+                            if (preg_match('/^\s*=\s*/', $attr)) # equals sign
+                            {
+                                $working = 1;
+                                $mode    = 2;
+                                $attr    = preg_replace('/^\s*=\s*/', '', $attr);
+                                break;
+                            }
+                            if (preg_match('/^\s+/', $attr)) # valueless
+                            {
+                                $working   = 1;
+                                $mode      = 0;
+                                $attrarr[] = array(
+                                    'name'  => $attrname,
+                                    'value' => '',
+                                    'whole' => $attrname,
+                                    'vless' => 'y'
+                                );
+                                $attr      = preg_replace('/^\s+/', '', $attr);
+                            }
+                            break;
+                        case 2: # attribute value, a URL after href= for instance
+                            if (preg_match('/^"([^"]*)"(\s+|$)/', $attr, $match)) # "value"
+                            {
+                                $thisval   = $this->removeBadProtocols($match[1]);
+                                $attrarr[] = array(
+                                    'name'  => $attrname,
+                                    'value' => $thisval,
+                                    'whole' => $attrname . '="' . $thisval . '"',
+                                    'vless' => 'n'
+                                );
+                                $working   = 1;
+                                $mode      = 0;
+                                $attr      = preg_replace('/^"[^"]*"(\s+|$)/', '', $attr);
+                                break;
+                            }
+                            if (preg_match("/^'([^']*)'(\s+|$)/", $attr, $match)) # 'value'
+                            {
+                                $thisval   = $this->removeBadProtocols($match[1]);
+                                $attrarr[] = array(
+                                    'name'  => $attrname,
+                                    'value' => $thisval,
+                                    'whole' => "$attrname='$thisval'",
+                                    'vless' => 'n'
+                                );
+                                $working   = 1;
+                                $mode      = 0;
+                                $attr      = preg_replace("/^'[^']*'(\s+|$)/", '', $attr);
+                                break;
+                            }
+                            if (preg_match("%^([^\s\"']+)(\s+|$)%", $attr, $match)) # value
+                            {
+                                $thisval   = $this->removeBadProtocols($match[1]);
+                                $attrarr[] = array(
+                                    'name'  => $attrname,
+                                    'value' => $thisval,
+                                    'whole' => $attrname . '="' . $thisval . '"',
+                                    'vless' => 'n'
+                                );
+                                # We add quotes to conform to W3C's HTML spec.
+                                $working   = 1;
+                                $mode      = 0;
+                                $attr      = preg_replace("%^[^\s\"']+(\s+|$)%", '', $attr);
+                            }
+                            break;
+                    }
+
+                    if ($working == 0) # not well formed, remove and try again
+                    {
+                        $attr = preg_replace('/^("[^"]*("|$)|\'[^\']*(\'|$)|\S)*\s*/', '', $attr);
+                        $mode = 0;
+                    }
+                }
+
+                # special case, for when the attribute list ends with a valueless
+                # attribute like "selected"
+                if ($mode == 1)
+                {
+                    $attrarr[] = array(
+                        'name'  => $attrname,
+                        'value' => '',
+                        'whole' => $attrname,
+                        'vless' => 'y'
+                    );
+                }
+
+                return $attrarr;
+            }
+
+            /**
+             *	This method removes disallowed protocols.
+             *
+             *	This method removes all non-allowed protocols from the beginning of
+             *	$string. It ignores whitespace and the case of the letters, and it does
+             *	understand HTML entities. It does its work in a while loop, so it won't be
+             *	fooled by a string like "javascript:javascript:alert(57)".
+             *
+             *	@access private
+             *	@param string $string String to check for protocols
+             *	@return string String with removed protocols
+             *	@since PHP4 OOP 0.0.1
+             */
+            private function removeBadProtocols($string)
+            {
+                $string  = $this->RemoveNulls($string);
+                $string = preg_replace('/\xad+/', '', $string); # deals with Opera "feature"
+                $string2 = $string . 'a';
+
+                $string2 = preg_split('/:|&#58;|&#x3a;/i', $string, 2);
+                if(isset($string2[1]) && !preg_match('%/\?%',$string2[0]))
+                {
+                    $string = $this->filterProtocols($string2[0]).trim($string2[1]);
+                }
+                return $string;
+            }
+
+            /**
+             *	Helper method used by removeBadProtocols()
+             *
+             *	This function processes URL protocols, checks to see if they're in the white-
+             *	list or not, and returns different data depending on the answer.
+             *
+             *	@access private
+             *	@param string $string String to check for protocols
+             *	@return string String with removed protocols
+             *	@see removeBadProtocols()
+             *	@since PHP4 OOP 0.0.1
+             */
+            private function filterProtocols($string)
+            {
+                $string = $this->decodeEntities($string);
+                $string = preg_replace('/\s/', '', $string);
+                $string = $this->removeNulls($string);
+                $string = preg_replace('/\xad+/', '', $string2); # deals with Opera "feature"
+                $string = strtolower($string);
+
+                if(is_array($this->allowed_protocols) && count($this->allowed_protocols) > 0)
+                {
+                    foreach ($this->allowed_protocols as $one_protocol)
+                    {
+                        if (strtolower($one_protocol) == $string)
+                        {
+                            return "$string:";
+                        }
+                    }
+                }
+
+                return '';
+            }
+
+            /**
+             *	Controller method for performing checks on attribute values.
+             *
+             *	This method calls the appropriate method as specified by $checkname with
+             *	the parameters $value, $vless, and $checkvalue, and returns the result
+             *	of the call.
+             *
+             *	This method's functionality can be expanded by creating new methods
+             *	that would match checkAttributeValue[$checkname].
+             *
+             *	Current checks implemented are: "maxlen", "minlen", "maxval", "minval" and "valueless"
+             *
+             *	@access private
+             *	@param string $value The value of the attribute to be checked.
+             *	@param string $vless Indicates whether the the value is supposed to be valueless
+             *	@param string $checkname The check to be performed
+             *	@param string $checkvalue The value that is to be checked against
+             *	@return bool Indicates whether the check passed or not
+             *	@since PHP5 OOP 1.0.0
+             */
+            private function checkAttributeValue($value, $vless, $checkname, $checkvalue)
+            {
+                $ok = true;
+                $check_attribute_method_name  = 'checkAttributeValue' . ucfirst(strtolower($checkname));
+                if(method_exists($this, $check_attribute_method_name))
+                {
+                    $ok = $this->$check_attribute_method_name($value, $checkvalue, $vless);
+                }
+
+                return $ok;
+            }
+
+            /**
+             *	Helper method invoked by checkAttributeValue().
+             *
+             *	The maxlen check makes sure that the attribute value has a length not
+             *	greater than the given value. This can be used to avoid Buffer Overflows
+             *	in WWW clients and various Internet servers.
+             *
+             *	@access private
+             *	@param string $value The value of the attribute to be checked.
+             *	@param int $checkvalue The maximum value allowed
+             *	@return bool Indicates whether the check passed or not
+             *	@see checkAttributeValue()
+             *	@since PHP5 OOP 1.0.0
+             */
+            private function checkAttributeValueMaxlen($value, $checkvalue)
+            {
+                if (strlen($value) > intval($checkvalue))
+                {
+                    return false;
+                }
+                return true;
+            }
+
+            /**
+             *	Helper method invoked by checkAttributeValue().
+             *
+             *	The minlen check makes sure that the attribute value has a length not
+             *	smaller than the given value.
+             *
+             *	@access private
+             *	@param string $value The value of the attribute to be checked.
+             *	@param int $checkvalue The minimum value allowed
+             *	@return bool Indicates whether the check passed or not
+             *	@see checkAttributeValue()
+             *	@since PHP5 OOP 1.0.0
+             */
+            private function checkAttributeValueMinlen($value, $checkvalue)
+            {
+                if (strlen($value) < intval($checkvalue))
+                {
+                    return false;
+                }
+                return true;
+            }
+
+            /**
+             *	Helper method invoked by checkAttributeValue().
+             *
+             *	The maxval check does two things: it checks that the attribute value is
+             *	an integer from 0 and up, without an excessive amount of zeroes or
+             *	whitespace (to avoid Buffer Overflows). It also checks that the attribute
+             *	value is not greater than the given value.
+             *
+             *	This check can be used to avoid Denial of Service attacks.
+             *
+             *	@access private
+             *	@param int $value The value of the attribute to be checked.
+             *	@param int $checkvalue The maximum numeric value allowed
+             *	@return bool Indicates whether the check passed or not
+             *	@see checkAttributeValue()
+             *	@since PHP5 OOP 1.0.0
+             */
+            private function checkAttributeValueMaxval($value, $checkvalue)
+            {
+                if (!preg_match('/^\s{0,6}[0-9]{1,6}\s{0,6}$/', $value))
+                {
+                    return false;
+                }
+                if (intval($value) > intval($checkvalue))
+                {
+                    return false;
+                }
+                return true;
+            }
+
+            /**
+             *	Helper method invoked by checkAttributeValue().
+             *
+             *	The minval check checks that the attribute value is a positive integer,
+             *	and that it is not smaller than the given value.
+             *
+             *	@access private
+             *	@param int $value The value of the attribute to be checked.
+             *	@param int $checkvalue The minimum numeric value allowed
+             *	@return bool Indicates whether the check passed or not
+             *	@see checkAttributeValue()
+             *	@since PHP5 OOP 1.0.0
+             */
+            private function checkAttributeValueMinval($value, $checkvalue)
+            {
+                if (!preg_match('/^\s{0,6}[0-9]{1,6}\s{0,6}$/', $value))
+                {
+                    return false;
+                }
+                if (intval($value) < ($checkvalue))
+                {
+                    return false;
+                }
+                return true;
+            }
+
+            /**
+             *	Helper method invoked by checkAttributeValue().
+             *
+             *	The valueless check checks if the attribute has a value
+             *	(like <a href="blah">) or not (<option selected>). If the given value
+             *	is a "y" or a "Y", the attribute must not have a value.
+             *
+             *	If the given value is an "n" or an "N", the attribute must have one.
+             *
+             *	@access private
+             *	@param int $value The value of the attribute to be checked.
+             *	@param mixed $checkvalue This variable is ignored for this test
+             *	@param string $vless Flag indicating if this attribute is not supposed to have an attribute
+             *	@return bool Indicates whether the check passed or not
+             *	@see checkAttributeValue()
+             *	@since PHP5 OOP 1.0.0
+             */
+            private function checkAttributeValueValueless($value, $checkvalue, $vless)
+            {
+                if (strtolower($checkvalue) != $vless)
+                {
+                    return false;
+                }
+                return true;
+            }
+
+            /**
+             *	Decodes numeric HTML entities
+             *
+             *	This method decodes numeric HTML entities (&#65; and &#x41;). It doesn't
+             *	do anything with other entities like &auml;, but we don't need them in the
+             *	URL protocol white listing system anyway.
+             *
+             *	@access private
+             *	@param string $value The entitiy to be decoded.
+             *	@return string Decoded entity
+             *	@since PHP4 OOP 0.0.1
+             */
+            private function decodeEntities($string)
+            {
+                $string = preg_replace('/&#([0-9]+);/e', 'chr("\\1")', $string);
+                $string = preg_replace('/&#[Xx]([0-9A-Fa-f]+);/e', 'chr(hexdec("\\1"))', $string);
+                return $string;
+            }
+
+            /**
+             *	Returns PHP5 OOP version # of kses.
+             *
+             *	Since this class has been refactored and documented and proven to work,
+             *	I'm fixing the version number at 1.0.0.
+             *
+             *	This version is syntax compatible with the PHP4 OOP version 0.0.2.  Future
+             *	versions may not be syntax compatible.
+             *
+             *	@access public
+             *	@return string Version number
+             *	@since PHP4 OOP 0.0.1
+             */
+            public function Version()
+            {
+                return 'PHP5 OOP 1.0.2';
+            }
+        }
+    }
 ?>
\ No newline at end of file

main/inc/lib/kses-0.2.2/oop/test.oop.kses.php

Indentation +503 added lines, -503 removed lines

@@ -1,507 +1,507 @@
 <?php
 
-	//	This is a q&d program that shows some of the results of
-	//	running KSES.  If you have further questions, check the
-	//	current valid email address at http://chaos.org/contact/
-
-	//	Make sure we're in a usable PHP environment
-	if(substr(phpversion(), 0, 1) < 4)
-	{
-		define('KSESTEST_VER', 0);
-	}
-	elseif(substr(phpversion(), 0, 1) >= 5)
-	{
-		define('KSESTEST_VER', 5);
-	}
-	else
-	{
-		define('KSESTEST_VER', 4);
-	}
-
-	//	See if we're in command line or web
-	if($_SERVER["DOCUMENT_ROOT"] == "")
-	{
-		define('KSESTEST_ENV', 'CLI');
-	}
-	else
-	{
-		define('KSESTEST_ENV', 'WEB');
-	}
-
-	if(KSESTEST_VER == 0)
-	{
-		$message = array(
-			"Error: Not using a current version of PHP!",
-			"You are using PHP version " . phpversion() . ".",
-			"KSES Class version requires PHP4 or better.",
-			"KSES test program ending."
-			);
-
-		displayPage(
-			array("title" => "Error running KSES test", "message" => $message)
-		);
-
-		exit();
-	}
-
-	$include_file = "php" . KSESTEST_VER . ".class.kses.php";
-	if(file_exists($include_file) && is_readable($include_file))
-	{
-		include_once($include_file);
-	}
-	else
-	{
-		$message = array(
-			"Error:  Unable to find '" . $include_file . "'.",
-			"Please check your include path and make sure the file is available.",
-			"Path: " . ini_get('include_path')
-		);
-
-		displayPage(
-			array('title' => 'Unable to include ' . $include_file, 'message' => $message)
-		);
-
-		exit();
-	}
-
-	$kses_type = "kses" . KSESTEST_VER;
-	$myKses = new $kses_type;
-
-	$test_text = array();
-	$test_text = test1_protocols($myKses);
-	$test_text = array_merge($test_text, test1_html($myKses));
-	$test_text = array_merge($test_text, test1_kses($myKses));
-
-	displayPage(
-		array('title' => 'New Test', 'message' => $test_text)
-	);
-
-	function test1_kses(&$myKses)
-	{
-		$out = array(output_hr(), "Testing current configuration");
-
-		$test_tags = array(
-			'<a href="http://www.chaos.org/">www.chaos.org</a>',
-			'<a name="X">Short \'a name\' tag</a>',
-			'<td colspan="3" rowspan="5">Foo</td>',
-			'<td rowspan="2" class="mugwump" style="background-color: rgb(255, 204 204);">Bar</td>',
-			'<td nowrap>Very Long String running to 1000 characters...</td>',
-			'<td bgcolor="#00ff00" nowrap>Very Long String with a blue background</td>',
-			'<a href="proto1://www.foo.com">New protocol test</a>',
-			'<img src="proto2://www.foo.com" />',
-			'<a href="javascript:javascript:javascript:javascript:javascript:alert(\'Boo!\');">bleep</a>',
-			'<a href="proto4://abc.xyz.foo.com">Another new protocol</a>',
-			'<a href="proto9://foo.foo.foo.foo.foo.org/">Test of "proto9"</a>',
-			'<td width="75">Bar!</td>',
-			'<td width="200">Long Cell</td>'
-		);
-
-		$out_li = array();
-		// Keep only allowed HTML from the presumed 'form'.
-		foreach($test_tags as $tag)
-		{
-			$temp  = $myKses->Parse($tag);
-			$check = ($temp == $tag) ? true : false;
-			$text  = ($temp == $tag) ? 'pass' : 'fail';
-
-			$li_text  = output_testresult($check, $text) . output_newline();
-			$li_text .= "Input: &nbsp;" . output_translate($tag) . output_newline();
-			$li_text .= "Output: " . output_translate($temp);
-			if(KSESTEST_ENV == 'CLI')
-			{
-				$li_text .= output_newline();
-			}
-
-			array_push($out_li, output_code_wrap($li_text));
-		}
-
-		$out = array_merge($out, array(output_ul($out_li)));
-		array_push($out, output_hr());
-		array_push($out, "Testing is now finished.");
-		return $out;
-	}
-
-	function output_code_wrap($text)
-	{
-		if(KSESTEST_ENV == 'CLI')
-		{
-			return $text;
-		}
-		else
-		{
-			return "<code>\n$text<code>\n";
-		}
-	}
-
-	function output_translate($text)
-	{
-		if(KSESTEST_ENV == 'CLI')
-		{
-			return $text;
-		}
-		else
-		{
-			return htmlentities($text);
-		}
-	}
-
-	function output_testresult($pass = false, $text = "")
-	{
-		if(KSESTEST_ENV == 'CLI')
-		{
-			return '[' . $text . ']';
-		}
-		else
-		{
-			if($pass == true)
-			{
-				return '<span style="color: green;">[' . $text . ']</span>';
-			}
-			else
-			{
-				return '<span style="color: red;">[' . $text . ']</span>';
-			}
-		}
-	}
-
-	function output_spaces()
-	{
-		if(KSESTEST_ENV == 'WEB')
-		{
-			$out = "&nbsp;&nbsp;&nbsp;";
-		}
-		else
-		{
-			$out = "   ";
-		}
-
-		return $out;
-	}
-
-	function output_newline()
-	{
-		if(KSESTEST_ENV == 'WEB')
-		{
-			$out = "<br />\n";
-		}
-		else
-		{
-			$out = "\n";
-		}
-
-		return $out;
-	}
-
-	function displayPage($data = array())
-	{
-		$title   = ($data['title'] == '') ? 'No title' : $data['title'];
-		$message = ($data['message'] == '') ? array('No message') : $data['message'];
-
-		$out = "";
-
-		foreach($message as $text)
-		{
-			if(KSESTEST_ENV == 'WEB')
-			{
-				$header = "\t\t<h1>$title</h1>\n\t\t<hr />\n";
-				$out .= "\t\t<p>\n";
-				$out .= "\t\t\t$text\n";
-				$out .= "\t\t</p>\n";
-			}
-			else
-			{
-				$header = "$title\n" . str_repeat('-', 60) . "\n\n";
-				$out .= "\t$text\n\n";
-			}
-		}
-
-		if(KSESTEST_ENV == 'WEB')
-		{
-			echo "<html>\n";
-			echo "\t<head>\n";
-			echo "\t\t<title>$title</title>\n";
-			echo "\t</head>\n";
-			echo "\t<body>\n";
-			echo $header;
-			echo $out;
-			echo "\t</body>\n";
-			echo "</html>\n";
-		}
-		else
-		{
-			echo $header;
-			echo $out;
-		}
-	}
-
-	function output_hr()
-	{
-		if(KSESTEST_ENV == 'WEB')
-		{
-			return "\t\t\t<hr />\n";
-		}
-		else
-		{
-			return str_repeat(60, '-') . "\n";
-		}
-	}
-
-	function output_ul($data = array(), $padding = "")
-	{
-		if(!is_array($data) || count($data) < 1)
-		{
-			return "";
-		}
-
-		$text = "";
-		if(KSESTEST_ENV == 'WEB')
-		{
-			$text = "\t\t\t<ul>\n";
-			foreach($data as $li)
-			{
-				$text .= "\t\t\t\t<li>$li</li>\n";
-			}
-			$text .= "\t\t\t</ul>\n";
-		}
-		else
-		{
-			foreach($data as $li)
-			{
-				$text .= $padding . "   * $li\n";
-			}
-		}
-
-		return $text;
-	}
-
-	function test1_protocols(&$myKses)
-	{
-		$default_prots = $myKses->dumpProtocols();
-		$out_text = array();
-		if(count($default_prots) > 0)
-		{
-			array_push($out_text, "Initial protocols from KSES" . KSESTEST_VER . ":");
-			array_push($out_text, output_ul($default_prots));
-			array_push($out_text, output_hr());
-		}
-
-		$myKses->AddProtocols(array("proto1", "proto2:", "proto3"));   // Add a list of protocols
-		$myKses->AddProtocols("proto4:");  // Add a single protocol (Note ':' is optional at end)
-		$myKses->AddProtocol("proto9", "mystery:", "anarchy");
-		$myKses->AddProtocol("alpha", "beta", "gamma:");
-
-		$add_protocol  = "\t\t\t<ol>\n";
-		$add_protocol .= "\t\t\t\t" . '<li>$myKses->AddProtocols(array("proto1", "proto2:", "proto3"));</li>' . "\n";
-		$add_protocol .= "\t\t\t\t" . '<li>$myKses->AddProtocols("proto4:");</li>' . "\n";
-		$add_protocol .= "\t\t\t\t" . '<li>$myKses->AddProtocols("proto4:");</li>' . "\n";
-		$add_protocol .= "\t\t\t\t" . '<li>$myKses->AddProtocol("proto9", "mystery:", "anarchy");</li>' . "\n";
-		$add_protocol .= "\t\t\t\t" . '<li>$myKses->AddProtocol("alpha", "beta", "gamma:");</li>' . "\n";
-		$add_protocol .= "\t\t\t</ol>\n";
-
-		array_push($out_text, $add_protocol);
-
-		$new_prots = $myKses->dumpProtocols();
-		if(count($new_prots) > 0)
-		{
-			array_push($out_text, "New protocols from KSES" . KSESTEST_VER . " after using AddProtocol(s):");
-			array_push($out_text, output_ul($new_prots));
-			array_push($out_text, output_hr());
-		}
-
-		$myKses->RemoveProtocols(array("mystery", "anarchy:"));
-		$myKses->RemoveProtocols("alpha:");
-		$myKses->RemoveProtocol("beta:");
-		$myKses->RemoveProtocol("gamma");
-
-		$remove_protocol  = "\t\t\t<ol>\n";
-		$remove_protocol .= "\t\t\t\t" . '<li>$myKses->RemoveProtocols(array("mystery", "anarchy:"));</li>' . "\n";
-		$remove_protocol .= "\t\t\t\t" . '<li>$myKses->RemoveProtocols("alpha:");</li>' . "\n";
-		$remove_protocol .= "\t\t\t\t" . '<li>$myKses->RemoveProtocol("beta:");</li>' . "\n";
-		$remove_protocol .= "\t\t\t\t" . '<li>$myKses->RemoveProtocol("gamma");</li>' . "\n";
-		$remove_protocol .= "\t\t\t</ol>\n";
-		array_push($out_text, $remove_protocol);
-
-		$new_prots = $myKses->dumpProtocols();
-		if(count($new_prots) > 0)
-		{
-			array_push($out_text, "Resulting protocols from KSES" . KSESTEST_VER . " after using RemoveProtocol(s):");
-			array_push($out_text, output_ul($new_prots));
-			array_push($out_text, output_hr());
-		}
-
-		$myKses->SetProtocols(array("https", "gopher", "news"));
-		$set_protocol  = "\t\t\t<ol>\n";
-		$set_protocol .= "\t\t\t\t" . '<li>$myKses->SetProtocols(array("https", "gopher", "news"));</li>' . "\n";
-		$set_protocol .= "\t\t\t</ol>\n";
-		array_push($out_text, $set_protocol);
-
-		$new_prots = $myKses->dumpProtocols();
-		if(count($new_prots) > 0)
-		{
-			array_push($out_text, "Resulting protocols from KSES" . KSESTEST_VER . " after using SetProtocols:");
-			array_push($out_text, output_ul($new_prots));
-			array_push($out_text, output_hr());
-		}
-
-		//	Invisible reset
-		$myKses->SetProtocols(array("http", "proto1", "proto2", "proto9"));
-
-		return $out_text;
-	}
-
-	function test1_html(&$myKses)
-	{
-		$out = array();
-
-		//	Allows <p>|</p> tag
-		$myKses->AddHTML("p");
-
-		//	Allows 'a' tag with href|name attributes,
-		//	href has minlen of 10 chars, and maxlen of 25 chars
-		//	name has minlen of  2 chars
-		$myKses->AddHTML(
-			"a",
-			array(
-				"href" => array('maxlen' => 25, 'minlen' => 10),
-				"name" => array('minlen' => 2)
-			)
-		);
-
-		//	Allows 'td' tag with colspan|rowspan|class|style|width|nowrap attributes,
-		//		colspan has minval of   2       and maxval of 5
-		//		rowspan has minval of   3       and maxval of 6
-		//		class   has minlen of   1 char  and maxlen of   10 chars
-		//		style   has minlen of  10 chars and maxlen of 100 chars
-		//		width   has maxval of 100
-		//		nowrap  is valueless
-		$myKses->AddHTML(
-			"td",
-			array(
-				"colspan" => array('minval' =>   2, 'maxval' =>   5),
-				"rowspan" => array('minval' =>   3, 'maxval' =>   6),
-				"class"   => array("minlen" =>   1, 'maxlen' =>  10),
-				"width"   => array("maxval" => 100),
-				"style"   => array('minlen' =>  10, 'maxlen' => 100),
-				"nowrap"  => array('valueless' => 'y')
-			)
-		);
-
-		array_push($out, "Modifying HTML Tests:");
-		$code_text  = "<pre>\n";
-		$code_text .= "      //   Allows &lt;p&gt;|&lt;/p&gt; tag\n";
-		$code_text .= "      \$myKses-&gt;AddHTML(\"p\");\n";
-		$code_text .= "\n";
-		$code_text .= "      //   Allows 'a' tag with href|name attributes,\n";
-		$code_text .= "      //   href has minlen of 10 chars, and maxlen of 25 chars\n";
-		$code_text .= "      //   name has minlen of  2 chars\n";
-		$code_text .= "      \$myKses-&gt;AddHTML(\n";
-		$code_text .= "         \"a\",\n";
-		$code_text .= "         array(\n";
-		$code_text .= "            \"href\" =&gt; array('maxlen' =&gt; 25, 'minlen' =&gt; 10),\n";
-		$code_text .= "            \"name\" =&gt; array('minlen' =&gt; 2)\n";
-		$code_text .= "         )\n";
-		$code_text .= "      );\n";
-		$code_text .= "\n";
-		$code_text .= "      //   Allows 'td' tag with colspan|rowspan|class|style|width|nowrap attributes,\n";
-		$code_text .= "      //      colspan has minval of   2       and maxval of 5\n";
-		$code_text .= "      //      rowspan has minval of   3       and maxval of 6\n";
-		$code_text .= "      //      class   has minlen of   1 char  and maxlen of   10 chars\n";
-		$code_text .= "      //      style   has minlen of  10 chars and maxlen of 100 chars\n";
-		$code_text .= "      //      width   has maxval of 100\n";
-		$code_text .= "      //      nowrap  is valueless\n";
-		$code_text .= "      \$myKses-&gt;AddHTML(\n";
-		$code_text .= "         \"td\",\n";
-		$code_text .= "         array(\n";
-		$code_text .= "            \"colspan\" =&gt; array('minval' =&gt;   2, 'maxval' =&gt;   5),\n";
-		$code_text .= "            \"rowspan\" =&gt; array('minval' =&gt;   3, 'maxval' =&gt;   6),\n";
-		$code_text .= "            \"class\"   =&gt; array(\"minlen\" =&gt;   1, 'maxlen' =&gt;  10),\n";
-		$code_text .= "            \"width\"   =&gt; array(\"maxval\" =&gt; 100),\n";
-		$code_text .= "            \"style\"   =&gt; array('minlen' =&gt;  10, 'maxlen' =&gt; 100),\n";
-		$code_text .= "            \"nowrap\"  =&gt; array('valueless' =&gt; 'y')\n";
-		$code_text .= "         )\n";
-		$code_text .= "      );\n";
-		$code_text .= "</pre>\n";
-
-		array_push($out, $code_text);
-		array_push($out, output_hr());
-		array_push($out, "Net results:");
-
-		$out_elems = $myKses->DumpElements();
-		if(count($out_elems) > 0)
-		{
-			//array_push($out, "\t\t\t<ul>\n");
-			foreach($out_elems as $tag => $attr_data)
-			{
-				$out_li_elems = array();
-				$elem_text = "(X)HTML element $tag";
-				$allow = "";
-				if(isset($attr_data) && is_array($attr_data) && count($attr_data) > 0)
-				{
-					$allow = " allows attribute";
-					if(count($attr_data) > 1)
-					{
-						$allow .= "s";
-					}
-					$allow .= ":\n";
-				}
-
-				array_push($out_li_elems, "$elem_text$allow");
-
-				$attr_test_li = array();
-				if(isset($attr_data) && is_array($attr_data) && count($attr_data) > 0)
-				{
-					foreach($attr_data as $attr_name => $attr_tests)
-					{
-						$li_text = $attr_name;
-						if(isset($attr_tests) && count($attr_tests) > 0)
-						{
-							foreach($attr_tests as $test_name => $test_val)
-							{
-								switch($test_name)
-								{
-									case "maxlen":
-										$li_text .= " - maximum length of '" . $test_val . "' characters";
-										break;
-									case "minlen":
-										$li_text .= " - minimum length of '" . $test_val . "' characters";
-										break;
-									case "minval":
-										$li_text .= " - minimum value of '" . $test_val . "'";
-										break;
-									case "maxval":
-										$li_text .= " - maximum value of '" . $test_val . "'";
-										break;
-									case "valueless":
-										switch(strtolower($test_val))
-										{
-											case 'n':
-												$li_text .= " - must not be valueless";
-												break;
-											case 'y':
-												$li_text .= " - must be valueless";
-												break;
-											default:
-												break;
-										}
-										break;
-									default:
-										break;
-								}
-							}
-						}
-						array_push($attr_test_li, $li_text);
-					}
-					if(count($attr_test_li) > 0)
-					{
-						$attr_test_li = output_ul($attr_test_li, "   ");
-						$out_li_elems = array("$elem_text$allow$attr_test_li");
-					}
-				}
-				$out = array_merge($out, $out_li_elems);
-			}
-		}
-
-		return $out;
-	}
+    //	This is a q&d program that shows some of the results of
+    //	running KSES.  If you have further questions, check the
+    //	current valid email address at http://chaos.org/contact/
+
+    //	Make sure we're in a usable PHP environment
+    if(substr(phpversion(), 0, 1) < 4)
+    {
+        define('KSESTEST_VER', 0);
+    }
+    elseif(substr(phpversion(), 0, 1) >= 5)
+    {
+        define('KSESTEST_VER', 5);
+    }
+    else
+    {
+        define('KSESTEST_VER', 4);
+    }
+
+    //	See if we're in command line or web
+    if($_SERVER["DOCUMENT_ROOT"] == "")
+    {
+        define('KSESTEST_ENV', 'CLI');
+    }
+    else
+    {
+        define('KSESTEST_ENV', 'WEB');
+    }
+
+    if(KSESTEST_VER == 0)
+    {
+        $message = array(
+            "Error: Not using a current version of PHP!",
+            "You are using PHP version " . phpversion() . ".",
+            "KSES Class version requires PHP4 or better.",
+            "KSES test program ending."
+            );
+
+        displayPage(
+            array("title" => "Error running KSES test", "message" => $message)
+        );
+
+        exit();
+    }
+
+    $include_file = "php" . KSESTEST_VER . ".class.kses.php";
+    if(file_exists($include_file) && is_readable($include_file))
+    {
+        include_once($include_file);
+    }
+    else
+    {
+        $message = array(
+            "Error:  Unable to find '" . $include_file . "'.",
+            "Please check your include path and make sure the file is available.",
+            "Path: " . ini_get('include_path')
+        );
+
+        displayPage(
+            array('title' => 'Unable to include ' . $include_file, 'message' => $message)
+        );
+
+        exit();
+    }
+
+    $kses_type = "kses" . KSESTEST_VER;
+    $myKses = new $kses_type;
+
+    $test_text = array();
+    $test_text = test1_protocols($myKses);
+    $test_text = array_merge($test_text, test1_html($myKses));
+    $test_text = array_merge($test_text, test1_kses($myKses));
+
+    displayPage(
+        array('title' => 'New Test', 'message' => $test_text)
+    );
+
+    function test1_kses(&$myKses)
+    {
+        $out = array(output_hr(), "Testing current configuration");
+
+        $test_tags = array(
+            '<a href="http://www.chaos.org/">www.chaos.org</a>',
+            '<a name="X">Short \'a name\' tag</a>',
+            '<td colspan="3" rowspan="5">Foo</td>',
+            '<td rowspan="2" class="mugwump" style="background-color: rgb(255, 204 204);">Bar</td>',
+            '<td nowrap>Very Long String running to 1000 characters...</td>',
+            '<td bgcolor="#00ff00" nowrap>Very Long String with a blue background</td>',
+            '<a href="proto1://www.foo.com">New protocol test</a>',
+            '<img src="proto2://www.foo.com" />',
+            '<a href="javascript:javascript:javascript:javascript:javascript:alert(\'Boo!\');">bleep</a>',
+            '<a href="proto4://abc.xyz.foo.com">Another new protocol</a>',
+            '<a href="proto9://foo.foo.foo.foo.foo.org/">Test of "proto9"</a>',
+            '<td width="75">Bar!</td>',
+            '<td width="200">Long Cell</td>'
+        );
+
+        $out_li = array();
+        // Keep only allowed HTML from the presumed 'form'.
+        foreach($test_tags as $tag)
+        {
+            $temp  = $myKses->Parse($tag);
+            $check = ($temp == $tag) ? true : false;
+            $text  = ($temp == $tag) ? 'pass' : 'fail';
+
+            $li_text  = output_testresult($check, $text) . output_newline();
+            $li_text .= "Input: &nbsp;" . output_translate($tag) . output_newline();
+            $li_text .= "Output: " . output_translate($temp);
+            if(KSESTEST_ENV == 'CLI')
+            {
+                $li_text .= output_newline();
+            }
+
+            array_push($out_li, output_code_wrap($li_text));
+        }
+
+        $out = array_merge($out, array(output_ul($out_li)));
+        array_push($out, output_hr());
+        array_push($out, "Testing is now finished.");
+        return $out;
+    }
+
+    function output_code_wrap($text)
+    {
+        if(KSESTEST_ENV == 'CLI')
+        {
+            return $text;
+        }
+        else
+        {
+            return "<code>\n$text<code>\n";
+        }
+    }
+
+    function output_translate($text)
+    {
+        if(KSESTEST_ENV == 'CLI')
+        {
+            return $text;
+        }
+        else
+        {
+            return htmlentities($text);
+        }
+    }
+
+    function output_testresult($pass = false, $text = "")
+    {
+        if(KSESTEST_ENV == 'CLI')
+        {
+            return '[' . $text . ']';
+        }
+        else
+        {
+            if($pass == true)
+            {
+                return '<span style="color: green;">[' . $text . ']</span>';
+            }
+            else
+            {
+                return '<span style="color: red;">[' . $text . ']</span>';
+            }
+        }
+    }
+
+    function output_spaces()
+    {
+        if(KSESTEST_ENV == 'WEB')
+        {
+            $out = "&nbsp;&nbsp;&nbsp;";
+        }
+        else
+        {
+            $out = "   ";
+        }
+
+        return $out;
+    }
+
+    function output_newline()
+    {
+        if(KSESTEST_ENV == 'WEB')
+        {
+            $out = "<br />\n";
+        }
+        else
+        {
+            $out = "\n";
+        }
+
+        return $out;
+    }
+
+    function displayPage($data = array())
+    {
+        $title   = ($data['title'] == '') ? 'No title' : $data['title'];
+        $message = ($data['message'] == '') ? array('No message') : $data['message'];
+
+        $out = "";
+
+        foreach($message as $text)
+        {
+            if(KSESTEST_ENV == 'WEB')
+            {
+                $header = "\t\t<h1>$title</h1>\n\t\t<hr />\n";
+                $out .= "\t\t<p>\n";
+                $out .= "\t\t\t$text\n";
+                $out .= "\t\t</p>\n";
+            }
+            else
+            {
+                $header = "$title\n" . str_repeat('-', 60) . "\n\n";
+                $out .= "\t$text\n\n";
+            }
+        }
+
+        if(KSESTEST_ENV == 'WEB')
+        {
+            echo "<html>\n";
+            echo "\t<head>\n";
+            echo "\t\t<title>$title</title>\n";
+            echo "\t</head>\n";
+            echo "\t<body>\n";
+            echo $header;
+            echo $out;
+            echo "\t</body>\n";
+            echo "</html>\n";
+        }
+        else
+        {
+            echo $header;
+            echo $out;
+        }
+    }
+
+    function output_hr()
+    {
+        if(KSESTEST_ENV == 'WEB')
+        {
+            return "\t\t\t<hr />\n";
+        }
+        else
+        {
+            return str_repeat(60, '-') . "\n";
+        }
+    }
+
+    function output_ul($data = array(), $padding = "")
+    {
+        if(!is_array($data) || count($data) < 1)
+        {
+            return "";
+        }
+
+        $text = "";
+        if(KSESTEST_ENV == 'WEB')
+        {
+            $text = "\t\t\t<ul>\n";
+            foreach($data as $li)
+            {
+                $text .= "\t\t\t\t<li>$li</li>\n";
+            }
+            $text .= "\t\t\t</ul>\n";
+        }
+        else
+        {
+            foreach($data as $li)
+            {
+                $text .= $padding . "   * $li\n";
+            }
+        }
+
+        return $text;
+    }
+
+    function test1_protocols(&$myKses)
+    {
+        $default_prots = $myKses->dumpProtocols();
+        $out_text = array();
+        if(count($default_prots) > 0)
+        {
+            array_push($out_text, "Initial protocols from KSES" . KSESTEST_VER . ":");
+            array_push($out_text, output_ul($default_prots));
+            array_push($out_text, output_hr());
+        }
+
+        $myKses->AddProtocols(array("proto1", "proto2:", "proto3"));   // Add a list of protocols
+        $myKses->AddProtocols("proto4:");  // Add a single protocol (Note ':' is optional at end)
+        $myKses->AddProtocol("proto9", "mystery:", "anarchy");
+        $myKses->AddProtocol("alpha", "beta", "gamma:");
+
+        $add_protocol  = "\t\t\t<ol>\n";
+        $add_protocol .= "\t\t\t\t" . '<li>$myKses->AddProtocols(array("proto1", "proto2:", "proto3"));</li>' . "\n";
+        $add_protocol .= "\t\t\t\t" . '<li>$myKses->AddProtocols("proto4:");</li>' . "\n";
+        $add_protocol .= "\t\t\t\t" . '<li>$myKses->AddProtocols("proto4:");</li>' . "\n";
+        $add_protocol .= "\t\t\t\t" . '<li>$myKses->AddProtocol("proto9", "mystery:", "anarchy");</li>' . "\n";
+        $add_protocol .= "\t\t\t\t" . '<li>$myKses->AddProtocol("alpha", "beta", "gamma:");</li>' . "\n";
+        $add_protocol .= "\t\t\t</ol>\n";
+
+        array_push($out_text, $add_protocol);
+
+        $new_prots = $myKses->dumpProtocols();
+        if(count($new_prots) > 0)
+        {
+            array_push($out_text, "New protocols from KSES" . KSESTEST_VER . " after using AddProtocol(s):");
+            array_push($out_text, output_ul($new_prots));
+            array_push($out_text, output_hr());
+        }
+
+        $myKses->RemoveProtocols(array("mystery", "anarchy:"));
+        $myKses->RemoveProtocols("alpha:");
+        $myKses->RemoveProtocol("beta:");
+        $myKses->RemoveProtocol("gamma");
+
+        $remove_protocol  = "\t\t\t<ol>\n";
+        $remove_protocol .= "\t\t\t\t" . '<li>$myKses->RemoveProtocols(array("mystery", "anarchy:"));</li>' . "\n";
+        $remove_protocol .= "\t\t\t\t" . '<li>$myKses->RemoveProtocols("alpha:");</li>' . "\n";
+        $remove_protocol .= "\t\t\t\t" . '<li>$myKses->RemoveProtocol("beta:");</li>' . "\n";
+        $remove_protocol .= "\t\t\t\t" . '<li>$myKses->RemoveProtocol("gamma");</li>' . "\n";
+        $remove_protocol .= "\t\t\t</ol>\n";
+        array_push($out_text, $remove_protocol);
+
+        $new_prots = $myKses->dumpProtocols();
+        if(count($new_prots) > 0)
+        {
+            array_push($out_text, "Resulting protocols from KSES" . KSESTEST_VER . " after using RemoveProtocol(s):");
+            array_push($out_text, output_ul($new_prots));
+            array_push($out_text, output_hr());
+        }
+
+        $myKses->SetProtocols(array("https", "gopher", "news"));
+        $set_protocol  = "\t\t\t<ol>\n";
+        $set_protocol .= "\t\t\t\t" . '<li>$myKses->SetProtocols(array("https", "gopher", "news"));</li>' . "\n";
+        $set_protocol .= "\t\t\t</ol>\n";
+        array_push($out_text, $set_protocol);
+
+        $new_prots = $myKses->dumpProtocols();
+        if(count($new_prots) > 0)
+        {
+            array_push($out_text, "Resulting protocols from KSES" . KSESTEST_VER . " after using SetProtocols:");
+            array_push($out_text, output_ul($new_prots));
+            array_push($out_text, output_hr());
+        }
+
+        //	Invisible reset
+        $myKses->SetProtocols(array("http", "proto1", "proto2", "proto9"));
+
+        return $out_text;
+    }
+
+    function test1_html(&$myKses)
+    {
+        $out = array();
+
+        //	Allows <p>|</p> tag
+        $myKses->AddHTML("p");
+
+        //	Allows 'a' tag with href|name attributes,
+        //	href has minlen of 10 chars, and maxlen of 25 chars
+        //	name has minlen of  2 chars
+        $myKses->AddHTML(
+            "a",
+            array(
+                "href" => array('maxlen' => 25, 'minlen' => 10),
+                "name" => array('minlen' => 2)
+            )
+        );
+
+        //	Allows 'td' tag with colspan|rowspan|class|style|width|nowrap attributes,
+        //		colspan has minval of   2       and maxval of 5
+        //		rowspan has minval of   3       and maxval of 6
+        //		class   has minlen of   1 char  and maxlen of   10 chars
+        //		style   has minlen of  10 chars and maxlen of 100 chars
+        //		width   has maxval of 100
+        //		nowrap  is valueless
+        $myKses->AddHTML(
+            "td",
+            array(
+                "colspan" => array('minval' =>   2, 'maxval' =>   5),
+                "rowspan" => array('minval' =>   3, 'maxval' =>   6),
+                "class"   => array("minlen" =>   1, 'maxlen' =>  10),
+                "width"   => array("maxval" => 100),
+                "style"   => array('minlen' =>  10, 'maxlen' => 100),
+                "nowrap"  => array('valueless' => 'y')
+            )
+        );
+
+        array_push($out, "Modifying HTML Tests:");
+        $code_text  = "<pre>\n";
+        $code_text .= "      //   Allows &lt;p&gt;|&lt;/p&gt; tag\n";
+        $code_text .= "      \$myKses-&gt;AddHTML(\"p\");\n";
+        $code_text .= "\n";
+        $code_text .= "      //   Allows 'a' tag with href|name attributes,\n";
+        $code_text .= "      //   href has minlen of 10 chars, and maxlen of 25 chars\n";
+        $code_text .= "      //   name has minlen of  2 chars\n";
+        $code_text .= "      \$myKses-&gt;AddHTML(\n";
+        $code_text .= "         \"a\",\n";
+        $code_text .= "         array(\n";
+        $code_text .= "            \"href\" =&gt; array('maxlen' =&gt; 25, 'minlen' =&gt; 10),\n";
+        $code_text .= "            \"name\" =&gt; array('minlen' =&gt; 2)\n";
+        $code_text .= "         )\n";
+        $code_text .= "      );\n";
+        $code_text .= "\n";
+        $code_text .= "      //   Allows 'td' tag with colspan|rowspan|class|style|width|nowrap attributes,\n";
+        $code_text .= "      //      colspan has minval of   2       and maxval of 5\n";
+        $code_text .= "      //      rowspan has minval of   3       and maxval of 6\n";
+        $code_text .= "      //      class   has minlen of   1 char  and maxlen of   10 chars\n";
+        $code_text .= "      //      style   has minlen of  10 chars and maxlen of 100 chars\n";
+        $code_text .= "      //      width   has maxval of 100\n";
+        $code_text .= "      //      nowrap  is valueless\n";
+        $code_text .= "      \$myKses-&gt;AddHTML(\n";
+        $code_text .= "         \"td\",\n";
+        $code_text .= "         array(\n";
+        $code_text .= "            \"colspan\" =&gt; array('minval' =&gt;   2, 'maxval' =&gt;   5),\n";
+        $code_text .= "            \"rowspan\" =&gt; array('minval' =&gt;   3, 'maxval' =&gt;   6),\n";
+        $code_text .= "            \"class\"   =&gt; array(\"minlen\" =&gt;   1, 'maxlen' =&gt;  10),\n";
+        $code_text .= "            \"width\"   =&gt; array(\"maxval\" =&gt; 100),\n";
+        $code_text .= "            \"style\"   =&gt; array('minlen' =&gt;  10, 'maxlen' =&gt; 100),\n";
+        $code_text .= "            \"nowrap\"  =&gt; array('valueless' =&gt; 'y')\n";
+        $code_text .= "         )\n";
+        $code_text .= "      );\n";
+        $code_text .= "</pre>\n";
+
+        array_push($out, $code_text);
+        array_push($out, output_hr());
+        array_push($out, "Net results:");
+
+        $out_elems = $myKses->DumpElements();
+        if(count($out_elems) > 0)
+        {
+            //array_push($out, "\t\t\t<ul>\n");
+            foreach($out_elems as $tag => $attr_data)
+            {
+                $out_li_elems = array();
+                $elem_text = "(X)HTML element $tag";
+                $allow = "";
+                if(isset($attr_data) && is_array($attr_data) && count($attr_data) > 0)
+                {
+                    $allow = " allows attribute";
+                    if(count($attr_data) > 1)
+                    {
+                        $allow .= "s";
+                    }
+                    $allow .= ":\n";
+                }
+
+                array_push($out_li_elems, "$elem_text$allow");
+
+                $attr_test_li = array();
+                if(isset($attr_data) && is_array($attr_data) && count($attr_data) > 0)
+                {
+                    foreach($attr_data as $attr_name => $attr_tests)
+                    {
+                        $li_text = $attr_name;
+                        if(isset($attr_tests) && count($attr_tests) > 0)
+                        {
+                            foreach($attr_tests as $test_name => $test_val)
+                            {
+                                switch($test_name)
+                                {
+                                    case "maxlen":
+                                        $li_text .= " - maximum length of '" . $test_val . "' characters";
+                                        break;
+                                    case "minlen":
+                                        $li_text .= " - minimum length of '" . $test_val . "' characters";
+                                        break;
+                                    case "minval":
+                                        $li_text .= " - minimum value of '" . $test_val . "'";
+                                        break;
+                                    case "maxval":
+                                        $li_text .= " - maximum value of '" . $test_val . "'";
+                                        break;
+                                    case "valueless":
+                                        switch(strtolower($test_val))
+                                        {
+                                            case 'n':
+                                                $li_text .= " - must not be valueless";
+                                                break;
+                                            case 'y':
+                                                $li_text .= " - must be valueless";
+                                                break;
+                                            default:
+                                                break;
+                                        }
+                                        break;
+                                    default:
+                                        break;
+                                }
+                            }
+                        }
+                        array_push($attr_test_li, $li_text);
+                    }
+                    if(count($attr_test_li) > 0)
+                    {
+                        $attr_test_li = output_ul($attr_test_li, "   ");
+                        $out_li_elems = array("$elem_text$allow$attr_test_li");
+                    }
+                }
+                $out = array_merge($out, $out_li_elems);
+            }
+        }
+
+        return $out;
+    }
 
 ?>
\ No newline at end of file

main/inc/lib/kses-0.2.2/oop/php4.class.kses.php

Indentation +1137 added lines, -1137 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-	/*
+    /*
 	 * ==========================================================================================
 	 *
 	 * This program is free software and open source software; you can redistribute
@@ -20,1143 +20,1143 @@ 
 	 * ==========================================================================================
 	 */
 
-	/**
-	*	Class file for PHP4 OOP version of kses
-	*
-	*	This is an updated version of kses to work with PHP4 that works under E_STRICT.
-	*
-	*	This upgrade provides the following:
-	*	+ Version number synced to procedural version number
-	*	+ PHPdoc style documentation has been added to the class.  See http://www.phpdoc.org/ for more info.
-	*	+ Some methods are now deprecated due to nomenclature style change.  See method documentation for specifics.
-	*	+ Kses4 now works in E_STRICT
-	*	+ Addition of methods AddProtocols(), filterKsestextHook(), RemoveProtocol() and RemoveProtocols()
-	*	+ Deprecated _hook(), Protocols()
-	*	+ Integrated code from kses 0.2.2 into class.
-	*	+ Added methods DumpProtocols(), DumpMethods()
-	*
-	*	@package    kses
-	*	@subpackage kses4
-	*/
-
-	if(substr(phpversion(), 0, 1) < 4)
-	{
-		die("Class kses requires PHP 4 or higher.");
-	}
-
-	/**
-	*	Only install KSES4 once
-	*/
-	if(!defined('KSES_CLASS_PHP4'))
-	{
-		define('KSES_CLASS_PHP4', true);
-
-	/**
-	*	Kses strips evil scripts!
-	*
-	*	This class provides the capability for removing unwanted HTML/XHTML, attributes from
-	*	tags, and protocols contained in links.  The net result is a much more powerful tool
-	*	than the PHP internal strip_tags()
-	*
-	*	This is a fork of a slick piece of procedural code called 'kses' written by Ulf Harnhammar
-	*	The entire set of functions was wrapped in a PHP object with some internal modifications
-	*	by Richard Vasquez (http://www.chaos.org/) 7/25/2003
-	*
-	*	This upgrade provides the following:
-	*	+ Version number synced to procedural version number
-	*	+ PHPdoc style documentation has been added to the class.  See http://www.phpdoc.org/ for more info.
-	*	+ Some methods are now deprecated due to nomenclature style change.  See method documentation for specifics.
-	*	+ Kses4 now works in E_STRICT
-	*	+ Addition of methods AddProtocols(), filterKsestextHook(), RemoveProtocol(), RemoveProtocols() and SetProtocols()
-	*	+ Deprecated _hook(), Protocols()
-	*	+ Integrated code from kses 0.2.2 into class.
-	*
-	*	@author     Richard R. V�squez, Jr. (Original procedural code by Ulf H�rnhammar)
-	*	@link       http://sourceforge.net/projects/kses/ Home Page for Kses
-	*	@link       http://chaos.org/contact/ Contact page with current email address for Richard Vasquez
-	*	@copyright  Richard R. V�squez, Jr. 2003-2005
-	*	@version    PHP4 OOP 0.2.2
-	*	@license    http://www.gnu.org/licenses/gpl.html GNU Public License
-	*	@package    kses
-	*/
-		class kses4
-		{
-			/**#@+
+    /**
+     *	Class file for PHP4 OOP version of kses
+     *
+     *	This is an updated version of kses to work with PHP4 that works under E_STRICT.
+     *
+     *	This upgrade provides the following:
+     *	+ Version number synced to procedural version number
+     *	+ PHPdoc style documentation has been added to the class.  See http://www.phpdoc.org/ for more info.
+     *	+ Some methods are now deprecated due to nomenclature style change.  See method documentation for specifics.
+     *	+ Kses4 now works in E_STRICT
+     *	+ Addition of methods AddProtocols(), filterKsestextHook(), RemoveProtocol() and RemoveProtocols()
+     *	+ Deprecated _hook(), Protocols()
+     *	+ Integrated code from kses 0.2.2 into class.
+     *	+ Added methods DumpProtocols(), DumpMethods()
+     *
+     *	@package    kses
+     *	@subpackage kses4
+     */
+
+    if(substr(phpversion(), 0, 1) < 4)
+    {
+        die("Class kses requires PHP 4 or higher.");
+    }
+
+    /**
+     *	Only install KSES4 once
+     */
+    if(!defined('KSES_CLASS_PHP4'))
+    {
+        define('KSES_CLASS_PHP4', true);
+
+    /**
+     *	Kses strips evil scripts!
+     *
+     *	This class provides the capability for removing unwanted HTML/XHTML, attributes from
+     *	tags, and protocols contained in links.  The net result is a much more powerful tool
+     *	than the PHP internal strip_tags()
+     *
+     *	This is a fork of a slick piece of procedural code called 'kses' written by Ulf Harnhammar
+     *	The entire set of functions was wrapped in a PHP object with some internal modifications
+     *	by Richard Vasquez (http://www.chaos.org/) 7/25/2003
+     *
+     *	This upgrade provides the following:
+     *	+ Version number synced to procedural version number
+     *	+ PHPdoc style documentation has been added to the class.  See http://www.phpdoc.org/ for more info.
+     *	+ Some methods are now deprecated due to nomenclature style change.  See method documentation for specifics.
+     *	+ Kses4 now works in E_STRICT
+     *	+ Addition of methods AddProtocols(), filterKsestextHook(), RemoveProtocol(), RemoveProtocols() and SetProtocols()
+     *	+ Deprecated _hook(), Protocols()
+     *	+ Integrated code from kses 0.2.2 into class.
+     *
+     *	@author     Richard R. V�squez, Jr. (Original procedural code by Ulf H�rnhammar)
+     *	@link       http://sourceforge.net/projects/kses/ Home Page for Kses
+     *	@link       http://chaos.org/contact/ Contact page with current email address for Richard Vasquez
+     *	@copyright  Richard R. V�squez, Jr. 2003-2005
+     *	@version    PHP4 OOP 0.2.2
+     *	@license    http://www.gnu.org/licenses/gpl.html GNU Public License
+     *	@package    kses
+     */
+        class kses4
+        {
+            /**#@+
 			 *	@access private
 			 *	@var array
 			 */
-			var $allowed_protocols = array();
-			var $allowed_html      = array();
-			/**#@-*/
-
-			/**
-			 *	Constructor for kses.
-			 *
-			 *	This sets a default collection of protocols allowed in links, and creates an
-			 *	empty set of allowed HTML tags.
-			 *	@since PHP4 OOP 0.0.1
-			 */
-			function kses4()
-			{
-				/**
-				 *	You could add protocols such as ftp, new, gopher, mailto, irc, etc.
-				 *
-				 *	The base values the original kses provided were:
-				 *		'http', 'https', 'ftp', 'news', 'nntp', 'telnet', 'gopher', 'mailto'
-				 */
-				$this->allowed_protocols = array('http', 'ftp', 'mailto');
-				$this->allowed_html      = array();
-			}
-
-			/**
-			 *	Basic task of kses - parses $string and strips it as required.
-			 *
-			 *	This method strips all the disallowed (X)HTML tags, attributes
-			 *	and protocols from the input $string.
-			 *
-			 *	@access public
-			 *	@param string $string String to be stripped of 'evil scripts'
-			 *	@return string The stripped string
-			 *	@since PHP4 OOP 0.2.1
-			 */
-			function Parse($string = "")
-			{
-				if (get_magic_quotes_gpc())
-				{
-					$string = stripslashes($string);
-				}
-				$string = $this->_no_null($string);
-				$string = $this->_js_entities($string);
-				$string = $this->_normalize_entities($string);
-				$string = $this->filterKsesTextHook($string);
-				return    $this->_split($string);
-			}
-
-			/**
-			 *	Allows for single/batch addition of protocols
-			 *
-			 *	This method accepts one argument that can be either a string
-			 *	or an array of strings.  Invalid data will be ignored.
-			 *
-			 *	The argument will be processed, and each string will be added
-			 *	via AddProtocol().
-			 *
-			 *	@access public
-			 *	@param mixed , A string or array of protocols that will be added to the internal list of allowed protocols.
-			 *	@return bool Status of adding valid protocols.
-			 *	@see AddProtocol()
-			 *	@since PHP4 OOP 0.2.1
-			 */
-			function AddProtocols()
-			{
-				$c_args = func_num_args();
-				if($c_args != 1)
-				{
-					trigger_error("kses4::AddProtocols() did not receive an argument.", E_USER_WARNING);
-					return false;
-				}
-
-				$protocol_data = func_get_arg(0);
-
-				if(is_array($protocol_data) && count($protocol_data) > 0)
-				{
-					foreach($protocol_data as $protocol)
-					{
-						$this->AddProtocol($protocol);
-					}
-					return true;
-				}
-				elseif(is_string($protocol_data))
-				{
-					$this->AddProtocol($protocol_data);
-					return true;
-				}
-				else
-				{
-					trigger_error("kses4::AddProtocols() did not receive a string or an array.", E_USER_WARNING);
-					return false;
-				}
-			}
-
-			/**
-			 *	Allows for single/batch addition of protocols
-			 *
-			 *	@deprecated Use AddProtocols()
-			 *	@see AddProtocols()
-			 *	@return bool
-			 *	@since PHP4 OOP 0.0.1
-			 */
-			function Protocols()
-			{
-				$c_args = func_num_args();
-				if($c_args != 1)
-				{
-					trigger_error("kses4::Protocols() did not receive an argument.", E_USER_WARNING);
-					return false;
-				}
-
-				return $this->AddProtocols(func_get_arg(0));
-			}
-
-			/**
-			 *	Adds a single protocol to $this->allowed_protocols.
-			 *
-			 *	This method accepts a string argument and adds it to
-			 *	the list of allowed protocols to keep when performing
-			 *	Parse().
-			 *
-			 *	@access public
-			 *	@param string $protocol The name of the protocol to be added.
-			 *	@return bool Status of adding valid protocol.
-			 *	@since PHP4 OOP 0.0.1
-			 */
-			function AddProtocol($protocol = "")
-			{
-				if(!is_string($protocol))
-				{
-					trigger_error("kses4::AddProtocol() requires a string.", E_USER_WARNING);
-					return false;
-				}
-
-				$protocol = strtolower(trim($protocol));
-				if($protocol == "")
-				{
-					trigger_error("kses4::AddProtocol() tried to add an empty/NULL protocol.", E_USER_WARNING);
-					return false;
-				}
-
-				// Remove any inadvertent ':' at the end of the protocol.
-				if(substr($protocol, strlen($protocol) - 1, 1) == ":")
-				{
-					$protocol = substr($protocol, 0, strlen($protocol) - 1);
-				}
-
-				if(!in_array($protocol, $this->allowed_protocols))
-				{
-					array_push($this->allowed_protocols, $protocol);
-					sort($this->allowed_protocols);
-				}
-				return true;
-			}
-
-			/**
-			 *	Allows for single/batch replacement of protocols
-			 *
-			 *	This method accepts one argument that can be either a string
-			 *	or an array of strings.  Invalid data will be ignored.
-			 *
-			 *	Existing protocols will be removed, then the argument will be
-			 *	processed, and each string will be added via AddProtocol().
-			 *
-			 *	@access public
-			 *	@param mixed , A string or array of protocols that will be the new internal list of allowed protocols.
-			 *	@return bool Status of replacing valid protocols.
-			 *	@since PHP4 OOP 0.2.2
-			 *	@see AddProtocol()
-			 */
-			function SetProtocols()
-			{
-				$c_args = func_num_args();
-				if($c_args != 1)
-				{
-					trigger_error("kses4::SetProtocols() did not receive an argument.", E_USER_WARNING);
-					return false;
-				}
-
-				$protocol_data = func_get_arg(0);
-
-				if(is_array($protocol_data) && count($protocol_data) > 0)
-				{
-					$this->allowed_protocols = array();
-					foreach($protocol_data as $protocol)
-					{
-						$this->AddProtocol($protocol);
-					}
-					return true;
-				}
-				elseif(is_string($protocol_data))
-				{
-					$this->allowed_protocols = array();
-					$this->AddProtocol($protocol_data);
-					return true;
-				}
-				else
-				{
-					trigger_error("kses4::SetProtocols() did not receive a string or an array.", E_USER_WARNING);
-					return false;
-				}
-			}
-
-			/**
-			 *	Raw dump of allowed protocols
-			 *
-			 *	This returns an indexed array of allowed protocols for a particular KSES
-			 *	instantiation.
-			 *
-			 *	@access public
-			 *	@return array The list of allowed protocols.
-			 *	@since PHP4 OOP 0.2.2
-			 */
-			function DumpProtocols()
-			{
-				return $this->allowed_protocols;
-			}
-
-			/**
-			 *	Raw dump of allowed (X)HTML elements
-			 *
-			 *	This returns an indexed array of allowed (X)HTML elements and attributes
-			 *	for a particular KSES instantiation.
-			 *
-			 *	@access public
-			 *	@return array The list of allowed elements.
-			 *	@since PHP4 OOP 0.2.2
-			 */
-			function DumpElements()
-			{
-				return $this->allowed_html;
-			}
-
-			/**
-			 *	Adds valid (X)HTML with corresponding attributes that will be kept when stripping 'evil scripts'.
-			 *
-			 *	This method accepts one argument that can be either a string
-			 *	or an array of strings.  Invalid data will be ignored.
-			 *
-			 *	@access public
-			 *	@param string $tag (X)HTML tag that will be allowed after stripping text.
-			 *	@param array $attribs Associative array of allowed attributes - key => attribute name - value => attribute parameter
-			 *	@return bool Status of Adding (X)HTML and attributes.
-			 *	@since PHP4 OOP 0.0.1
-			 */
-			function AddHTML($tag = "", $attribs = array())
-			{
-				if(!is_string($tag))
-				{
-					trigger_error("kses4::AddHTML() requires the tag to be a string", E_USER_WARNING);
-					return false;
-				}
-
-				$tag = strtolower(trim($tag));
-				if($tag == "")
-				{
-					trigger_error("kses4::AddHTML() tried to add an empty/NULL tag", E_USER_WARNING);
-					return false;
-				}
-
-				if(!is_array($attribs))
-				{
-					trigger_error("kses4::AddHTML() requires an array (even an empty one) of attributes for '$tag'", E_USER_WARNING);
-					return false;
-				}
-
-				$new_attribs = array();
-				if(is_array($attribs) && count($attribs) > 0)
-				{
-					foreach($attribs as $idx1 => $val1)
-					{
-						$new_idx1 = strtolower($idx1);
-						$new_val1 = $attribs[$idx1];
-
-						if(is_array($new_val1) && count($new_val1) > 0)
-						{
-							$tmp_val = array();
-							foreach($new_val1 as $idx2 => $val2)
-							{
-								$new_idx2 = strtolower($idx2);
-								$tmp_val[$new_idx2] = $val2;
-							}
-							$new_val1 = $tmp_val;
-						}
-
-						$new_attribs[$new_idx1] = $new_val1;
-					}
-				}
-
-				$this->allowed_html[$tag] = $new_attribs;
-				return true;
-			}
-
-			/**
-			 *	Removes a single protocol from $this->allowed_protocols.
-			 *
-			 *	This method accepts a string argument and removes it from
-			 *	the list of allowed protocols to keep when performing
-			 *	Parse().
-			 *
-			 *	@access public
-			 *	@param string $protocol The name of the protocol to be removed.
-			 *	@return bool Status of removing valid protocol.
-			 *	@since PHP4 OOP 0.2.1
-			 */
-			function RemoveProtocol($protocol = "")
-			{
-				if(!is_string($protocol))
-				{
-					trigger_error("kses4::RemoveProtocol() requires a string.", E_USER_WARNING);
-					return false;
-				}
-
-				// Remove any inadvertent ':' at the end of the protocol.
-				if(substr($protocol, strlen($protocol) - 1, 1) == ":")
-				{
-					$protocol = substr($protocol, 0, strlen($protocol) - 1);
-				}
-
-				$protocol = strtolower(trim($protocol));
-				if($protocol == "")
-				{
-					trigger_error("kses4::RemoveProtocol() tried to remove an empty/NULL protocol.", E_USER_WARNING);
-					return false;
-				}
-
-				//	Ensures that the protocol exists before removing it.
-				if(in_array($protocol, $this->allowed_protocols))
-				{
-					$this->allowed_protocols = array_diff($this->allowed_protocols, array($protocol));
-					sort($this->allowed_protocols);
-				}
-
-				return true;
-			}
-
-			/**
-			 *	Allows for single/batch removal of protocols
-			 *
-			 *	This method accepts one argument that can be either a string
-			 *	or an array of strings.  Invalid data will be ignored.
-			 *
-			 *	The argument will be processed, and each string will be removed
-			 *	via RemoveProtocol().
-			 *
-			 *	@access public
-			 *	@param mixed , A string or array of protocols that will be removed from the internal list of allowed protocols.
-			 *	@return bool Status of removing valid protocols.
-			 *	@see RemoveProtocol()
-			 *	@since PHP5 OOP 0.2.1
-			 */
-			function RemoveProtocols()
-			{
-				$c_args = func_num_args();
-				if($c_args != 1)
-				{
-					return false;
-				}
-
-				$protocol_data = func_get_arg(0);
-
-				if(is_array($protocol_data) && count($protocol_data) > 0)
-				{
-					foreach($protocol_data as $protocol)
-					{
-						$this->RemoveProtocol($protocol);
-					}
-				}
-				elseif(is_string($protocol_data))
-				{
-					$this->RemoveProtocol($protocol_data);
-					return true;
-				}
-				else
-				{
-					trigger_error("kses4::RemoveProtocols() did not receive a string or an array.", E_USER_WARNING);
-					return false;
-				}
-			}
-
-			/**
-			 *	This method removes any NULL or characters in $string.
-			 *
-			 *	@access private
-			 *	@param string $string
-			 *	@return string String without any NULL/chr(173)
-			 *	@since PHP4 OOP 0.0.1
-			 */
-			function _no_null($string)
-			{
-				$string = preg_replace('/\0+/', '', $string);
-				$string = preg_replace('/(\\\\0)+/', '', $string);
-				return $string;
-			}
-
-			/**
-			 *	This function removes the HTML JavaScript entities found in early versions of
-			 *	Netscape 4.
-			 *
-			 *	@access private
-			 *	@param string $string
-			 *	@return string String without any NULL/chr(173)
-			 *	@since PHP4 OOP 0.0.1
-			 */
-			function _js_entities($string)
-			{
-			  return preg_replace('%&\s*\{[^}]*(\}\s*;?|$)%', '', $string);
-			}
-
-			/**
-			 *	Normalizes HTML entities
-			 *
-			 *	This function normalizes HTML entities. It will convert "AT&T" to the correct
-			 *	"AT&amp;T", "&#00058;" to "&#58;", "&#XYZZY;" to "&amp;#XYZZY;" and so on.
-			 *
-			 *	@access private
-			 *	@param string $string
-			 *	@return string String with normalized entities
-			 *	@since PHP4 OOP 0.0.1
-			 */
-			function _normalize_entities($string)
-			{
-				# Disarm all entities by converting & to &amp;
-			  $string = str_replace('&', '&amp;', $string);
-
-				# Change back the allowed entities in our entity white list
-
-			  $string = preg_replace('/&amp;([A-Za-z][A-Za-z0-9]{0,19});/', '&\\1;', $string);
-			  $string = preg_replace('/&amp;#0*([0-9]{1,5});/e', '\$this->_normalize_entities2("\\1")', $string);
-			  $string = preg_replace('/&amp;#([Xx])0*(([0-9A-Fa-f]{2}){1,2});/', '&#\\1\\2;', $string);
-
-			  return $string;
-			}
-
-			/**
-			 *	Helper method used by normalizeEntites()
-			 *
-			 *	This method helps normalizeEntities() to only accept 16 bit values
-			 *	and nothing more for &#number; entities.
-			 *
-			 *	This method helps normalize_entities() during a preg_replace()
-			 *	where a &#(0)*XXXXX; occurs.  The '(0)*XXXXXX' value is converted to
-			 *	a number and the result is returned as a numeric entity if the number
-			 *	is less than 65536.  Otherwise, the value is returned 'as is'.
-			 *
-			 *	@access private
-			 *	@param string $i
-			 *	@return string Normalized numeric entity
-			 *	@see _normalize_entities()
-			 *	@since PHP4 OOP 0.0.1
-			 */
-			function _normalize_entities2($i)
-			{
-			  return (($i > 65535) ? "&amp;#$i;" : "&#$i;");
-			}
-
-			/**
-			 *	Allows for additional user defined modifications to text.
-			 *
-			 *	@deprecated use filterKsesTextHook()
-			 *	@param string $string
-			 *	@see filterKsesTextHook()
-			 *	@return string
-			 *	@since PHP4 OOP 0.0.1
-			 */
-			function _hook($string)
-			{
-			  return $this->filterKsesTextHook($string);
-			}
-
-			/**
-			 *	Allows for additional user defined modifications to text.
-			 *
-			 *	This method allows for additional modifications to be performed on
-			 *	a string that's being run through Parse().  Currently, it returns the
-			 *	input string 'as is'.
-			 *
-			 *	This method is provided for users to extend the kses class for their own
-			 *	requirements.
-			 *
-			 *	@access public
-			 *	@param string $string String to perfrom additional modifications on.
-			 *	@return string User modified string.
-			 *	@see Parse()
-			 *	@since PHP5 OOP 1.0.0
-			 */
-			function filterKsesTextHook($string)
-			{
-			  return $string;
-			}
-
-			/**
-			 *	This method goes through an array, and changes the keys to all lower case.
-			 *
-			 *	@access private
-			 *	@param array $in_array Associative array
-			 *	@return array Modified array
-			 *	@since PHP4 OOP 0.0.1
-			 */
-			function _array_lc($inarray)
-			{
-			  $outarray = array();
-
-				if(is_array($inarray) && count($inarray) > 0)
-				{
-					foreach ($inarray as $inkey => $inval)
-					{
-						$outkey = strtolower($inkey);
-						$outarray[$outkey] = array();
-
-						if(is_array($inval) && count($inval) > 0)
-						{
-							foreach ($inval as $inkey2 => $inval2)
-							{
-								$outkey2 = strtolower($inkey2);
-								$outarray[$outkey][$outkey2] = $inval2;
-							}
-						}
-					}
-				}
-
-			  return $outarray;
-			}
-
-			/**
-			 *	This method searched for HTML tags, no matter how malformed.  It also
-			 *	matches stray ">" characters.
-			 *
-			 *	@access private
-			 *	@param string $string
-			 *	@return string HTML tags
-			 *	@since PHP4 OOP 0.0.1
-			 */
-			function _split($string)
-			{
-				return preg_replace(
-					'%(<'.   # EITHER: <
-					'[^>]*'. # things that aren't >
-					'(>|$)'. # > or end of string
-					'|>)%e', # OR: just a >
-					"\$this->_split2('\\1')",
-					$string);
-			}
-
-			/**
-			 *	This method strips out disallowed and/or mangled (X)HTML tags along with assigned attributes.
-			 *
-			 *	This method does a lot of work. It rejects some very malformed things
-			 *	like <:::>. It returns an empty string if the element isn't allowed (look
-			 *	ma, no strip_tags()!). Otherwise it splits the tag into an element and an
-			 *	allowed attribute list.
-			 *
-			 *	@access private
-			 *	@param string $string
-			 *	@return string Modified string minus disallowed/mangled (X)HTML and attributes
-			 *	@since PHP4 OOP 0.0.1
-			 */
-			function _split2($string)
-			{
-				$string = $this->_stripslashes($string);
-
-				if (substr($string, 0, 1) != '<')
-				{
-					# It matched a ">" character
-					return '&gt;';
-				}
-
-				if (!preg_match('%^<\s*(/\s*)?([a-zA-Z0-9]+)([^>]*)>?$%', $string, $matches))
-				{
-					# It's seriously malformed
-					return '';
-				}
-
-				$slash    = trim($matches[1]);
-				$elem     = $matches[2];
-				$attrlist = $matches[3];
-
-				if (
-					!isset($this->allowed_html[strtolower($elem)]) ||
-					!is_array($this->allowed_html[strtolower($elem)])
-				)
-				{
-					# They are using a not allowed HTML element
-					return '';
-				}
-
-				if ($slash != '')
-				{
-					return "<$slash$elem>";
-				}
-				# No attributes are allowed for closing elements
-
-				return $this->_attr("$slash$elem", $attrlist);
-			}
-
-			/**
-			 *	This method strips out disallowed attributes for (X)HTML tags.
-			 *
-			 *	This method removes all attributes if none are allowed for this element.
-			 *	If some are allowed it calls $this->_hair() to split them further, and then it
-			 *	builds up new HTML code from the data that $this->_hair() returns. It also
-			 *	removes "<" and ">" characters, if there are any left. One more thing it
-			 *	does is to check if the tag has a closing XHTML slash, and if it does,
-			 *	it puts one in the returned code as well.
-			 *
-			 *	@access private
-			 *	@param string $element (X)HTML tag to check
-			 *	@param string $attr Text containing attributes to check for validity.
-			 *	@return string Resulting valid (X)HTML or ''
-			 *	@see _hair()
-			 *	@since PHP4 OOP 0.0.1
-			 */
-			function _attr($element, $attr)
-			{
-				# Is there a closing XHTML slash at the end of the attributes?
-				$xhtml_slash = '';
-				if (preg_match('%\s/\s*$%', $attr))
-				{
-					$xhtml_slash = ' /';
-				}
-
-				# Are any attributes allowed at all for this element?
-				if (
-					!isset($this->allowed_html[strtolower($element)]) ||
-					count($this->allowed_html[strtolower($element)]) == 0
-				)
-				{
-					return "<$element$xhtml_slash>";
-				}
-
-				# Split it
-				$attrarr = $this->_hair($attr);
-
-				# Go through $attrarr, and save the allowed attributes for this element
-				# in $attr2
-				$attr2 = '';
-				if(is_array($attrarr) && count($attrarr) > 0)
-				{
-					foreach ($attrarr as $arreach)
-					{
-						if(!isset($this->allowed_html[strtolower($element)][strtolower($arreach['name'])]))
-						{
-							continue;
-						}
-
-						$current = $this->allowed_html[strtolower($element)][strtolower($arreach['name'])];
-						if ($current == '')
-						{
-							# the attribute is not allowed
-							continue;
-						}
-
-						if (!is_array($current))
-						{
-							# there are no checks
-							$attr2 .= ' '.$arreach['whole'];
-						}
-						else
-						{
-							# there are some checks
-							$ok = true;
-							if(is_array($current) && count($current) > 0)
-							{
-								foreach ($current as $currkey => $currval)
-								{
-									if (!$this->_check_attr_val($arreach['value'], $arreach['vless'], $currkey, $currval))
-									{
-										$ok = false;
-										break;
-									}
-								}
-
-								if ($ok)
-								{
-									# it passed them
-									$attr2 .= ' '.$arreach['whole'];
-								}
-							}
-						}
-					}
-				}
-
-				# Remove any "<" or ">" characters
-				$attr2 = preg_replace('/[<>]/', '', $attr2);
-				return "<$element$attr2$xhtml_slash>";
-			}
-
-			/**
-			 *	This method combs through an attribute list string and returns an associative array of attributes and values.
-			 *
-			 *	This method does a lot of work. It parses an attribute list into an array
-			 *	with attribute data, and tries to do the right thing even if it gets weird
-			 *	input. It will add quotes around attribute values that don't have any quotes
-			 *	or apostrophes around them, to make it easier to produce HTML code that will
-			 *	conform to W3C's HTML specification. It will also remove bad URL protocols
-			 *	from attribute values.
-			 *
-			 *	@access private
-			 *	@param string $attr Text containing tag attributes for parsing
-			 *	@return array Associative array containing data on attribute and value
-			 *	@since PHP4 OOP 0.0.1
-			 */
-			function _hair($attr)
-			{
-				$attrarr  = array();
-				$mode     = 0;
-				$attrname = '';
-
-				# Loop through the whole attribute list
-
-				while (strlen($attr) != 0)
-				{
-					# Was the last operation successful?
-					$working = 0;
-
-					switch ($mode)
-					{
-						case 0:	# attribute name, href for instance
-							if (preg_match('/^([-a-zA-Z]+)/', $attr, $match))
-							{
-								$attrname = $match[1];
-								$working = $mode = 1;
-								$attr = preg_replace('/^[-a-zA-Z]+/', '', $attr);
-							}
-							break;
-						case 1:	# equals sign or valueless ("selected")
-							if (preg_match('/^\s*=\s*/', $attr)) # equals sign
-							{
-								$working = 1;
-								$mode    = 2;
-								$attr    = preg_replace('/^\s*=\s*/', '', $attr);
-								break;
-							}
-							if (preg_match('/^\s+/', $attr)) # valueless
-							{
-								$working   = 1;
-								$mode      = 0;
-								$attrarr[] = array(
-									'name'  => $attrname,
-									'value' => '',
-									'whole' => $attrname,
-									'vless' => 'y'
-								);
-								$attr      = preg_replace('/^\s+/', '', $attr);
-							}
-							break;
-						case 2: # attribute value, a URL after href= for instance
-							if (preg_match('/^"([^"]*)"(\s+|$)/', $attr, $match)) # "value"
-							{
-								$thisval   = $this->_bad_protocol($match[1]);
-								$attrarr[] = array(
-									'name'  => $attrname,
-									'value' => $thisval,
-									'whole' => "$attrname=\"$thisval\"",
-									'vless' => 'n'
-								);
-								$working   = 1;
-								$mode      = 0;
-								$attr      = preg_replace('/^"[^"]*"(\s+|$)/', '', $attr);
-								break;
-							}
-							if (preg_match("/^'([^']*)'(\s+|$)/", $attr, $match)) # 'value'
-							{
-								$thisval   = $this->_bad_protocol($match[1]);
-								$attrarr[] = array(
-									'name'  => $attrname,
-									'value' => $thisval,
-									'whole' => "$attrname='$thisval'",
-									'vless' => 'n'
-								);
-								$working   = 1;
-								$mode      = 0;
-								$attr      = preg_replace("/^'[^']*'(\s+|$)/", '', $attr);
-								break;
-							}
-							if (preg_match("%^([^\s\"']+)(\s+|$)%", $attr, $match)) # value
-							{
-								$thisval   = $this->_bad_protocol($match[1]);
-								$attrarr[] = array(
-									'name'  => $attrname,
-									'value' => $thisval,
-									'whole' => "$attrname=\"$thisval\"",
-									'vless' => 'n'
-								);
-								# We add quotes to conform to W3C's HTML spec.
-								$working   = 1;
-								$mode      = 0;
-								$attr      = preg_replace("%^[^\s\"']+(\s+|$)%", '', $attr);
-							}
-							break;
-					}
-
-					if ($working == 0) # not well formed, remove and try again
-					{
-						$attr = $this->_html_error($attr);
-						$mode = 0;
-					}
-				}
-
-				# special case, for when the attribute list ends with a valueless
-				# attribute like "selected"
-				if ($mode == 1)
-				{
-					$attrarr[] = array(
-						'name'  => $attrname,
-						'value' => '',
-						'whole' => $attrname,
-						'vless' => 'y'
-					);
-				}
-
-				return $attrarr;
-			}
-
-			/**
-			 *	This method removes disallowed protocols.
-			 *
-			 *	This method removes all non-allowed protocols from the beginning of
-			 *	$string. It ignores whitespace and the case of the letters, and it does
-			 *	understand HTML entities. It does its work in a while loop, so it won't be
-			 *	fooled by a string like "javascript:javascript:alert(57)".
-			 *
-			 *	@access private
-			 *	@param string $string String to check for protocols
-			 *	@return string String with removed protocols
-			 *	@since PHP4 OOP 0.0.1
-			 */
-			function _bad_protocol($string)
-			{
-				$string  = $this->_no_null($string);
-				$string = preg_replace('/\xad+/', '', $string); # deals with Opera "feature"
-				$string2 = $string.'a';
-
-				while ($string != $string2)
-				{
-					$string2 = $string;
-					$string  = $this->_bad_protocol_once($string);
-				} # while
-
-				return $string;
-			}
-
-			/**
-			 *	Helper method used by _bad_protocol()
-			 *
-			 *	This function searches for URL protocols at the beginning of $string, while
-			 *	handling whitespace and HTML entities.
-			 *  Function updated to fix security vulnerability (see http://projects.dokeos.com/index.php?do=details&task_id=2312)
-			 *
-			 *	@access private
-			 *	@param string $string String to check for protocols
-			 *	@return string String with removed protocols
-			 *	@see _bad_protocol()
-			 *	@since PHP4 OOP 0.0.1
-			 */
-			function _bad_protocol_once($string)
-			{
-				$string2 = preg_split('/:|&#58;|&#x3a;/i', $string, 2);
-				if(isset($string2[1]) && !preg_match('%/\?%',$string2[0]))
-				{
-					$string = $this->_bad_protocol_once2($string2[0]).trim($string2[1]);
-				}
-				return $string;
-			}
-			/**
-			 *	Helper method used by _bad_protocol_once() regex
-			 *
-			 *	This function processes URL protocols, checks to see if they're in the white-
-			 *	list or not, and returns different data depending on the answer.
-			 *
-			 *	@access private
-			 *	@param string $string String to check for protocols
-			 *	@return string String with removed protocols
-			 *	@see _bad_protocol()
-			 *	@see _bad_protocol_once()
-			 *	@since PHP4 OOP 0.0.1
-			 */
-			function _bad_protocol_once2($string)
-			{
-				$string = $this->_decode_entities($string);
-				$string = preg_replace('/\s/', '', $string);
-				$string = $this->_no_null($string);
-				$string = preg_replace('/\xad+/', '', $string); # deals with Opera "feature"
-				$string = strtolower($string);
-
-				$allowed = false;
-				if(is_array($this->allowed_protocols) && count($this->allowed_protocols) > 0)
-				{
-					foreach ($this->allowed_protocols as $one_protocol)
-					{
-						if (strtolower($one_protocol) == $string)
-						{
-							$allowed = true;
-							break;
-						}
-					}
-				}
-
-				if ($allowed)
-				{
-					return "$string:";
-				}
-				else
-				{
-					return '';
-				}
-			}
-
-			/**
-			 *	This function performs different checks for attribute values.
-			 *
-			 *	The currently implemented checks are "maxlen", "minlen", "maxval",
-			 *	"minval" and "valueless" with even more checks to come soon.
-			 *
-			 *	@access private
-			 *	@param string $value The value of the attribute to be checked.
-			 *	@param string $vless Indicates whether the the value is supposed to be valueless
-			 *	@param string $checkname The check to be performed
-			 *	@param string $checkvalue The value that is to be checked against
-			 *	@return bool Indicates whether the check passed or not
-			 *	@since PHP4 OOP 0.0.1
-			 */
-			function _check_attr_val($value, $vless, $checkname, $checkvalue)
-			{
-				$ok = true;
-
-				switch (strtolower($checkname))
-				{
-					/**
-					*	The maxlen check makes sure that the attribute value has a length not
-					*	greater than the given value. This can be used to avoid Buffer Overflows
-					*	in WWW clients and various Internet servers.
-					*/
-					case 'maxlen':
-						if (strlen($value) > $checkvalue)
-						{
-							$ok = false;
-						}
-						break;
-
-					/**
-					*	The minlen check makes sure that the attribute value has a length not
-					*	smaller than the given value.
-					*/
-					case 'minlen':
-						if (strlen($value) < $checkvalue)
-						{
-							$ok = false;
-						}
-						break;
-
-					/**
-					*	The maxval check does two things: it checks that the attribute value is
-					*	an integer from 0 and up, without an excessive amount of zeroes or
-					*	whitespace (to avoid Buffer Overflows). It also checks that the attribute
-					*	value is not greater than the given value.
-					*	This check can be used to avoid Denial of Service attacks.
-					*/
-					case 'maxval':
-						if (!preg_match('/^\s{0,6}[0-9]{1,6}\s{0,6}$/', $value))
-						{
-							$ok = false;
-						}
-						if ($value > $checkvalue)
-						{
-							$ok = false;
-						}
-						break;
-
-					/**
-					*	The minval check checks that the attribute value is a positive integer,
-					*	and that it is not smaller than the given value.
-					*/
-					case 'minval':
-						if (!preg_match('/^\s{0,6}[0-9]{1,6}\s{0,6}$/', $value))
-						{
-							$ok = false;
-						}
-						if ($value < $checkvalue)
-						{
-							$ok = false;
-						}
-						break;
-
-					/**
-					*	The valueless check checks if the attribute has a value
-					*	(like <a href="blah">) or not (<option selected>). If the given value
-					*	is a "y" or a "Y", the attribute must not have a value.
-					*	If the given value is an "n" or an "N", the attribute must have one.
-					*/
-					case 'valueless':
-					if (strtolower($checkvalue) != $vless)
-					{
-						$ok = false;
-					}
-					break;
-
-				}
-
-				return $ok;
-			}
-
-			/**
-			 *	Changes \" to "
-			 *
-			 *	This function changes the character sequence  \"  to just  "
-			 *	It leaves all other slashes alone. It's really weird, but the quoting from
-			 *	preg_replace(//e) seems to require this.
-			 *
-			 *	@access private
-			 *	@param string $string The string to be stripped.
-			 *	@return string string stripped of \"
-			 *	@since PHP4 OOP 0.0.1
-			 */
-			function _stripslashes($string)
-			{
-				return preg_replace('%\\\\"%', '"', $string);
-			}
-
-			/**
-			 *	helper method for _hair()
-			 *
-			 *	This function deals with parsing errors in _hair(). The general plan is
-			 *	to remove everything to and including some whitespace, but it deals with
-			 *	quotes and apostrophes as well.
-			 *
-			 *	@access private
-			 *	@param string $string The string to be stripped.
-			 *	@return string string stripped of whitespace
-			 *	@see _hair()
-			 *	@since PHP4 OOP 0.0.1
-			 */
-			function _html_error($string)
-			{
-				return preg_replace('/^("[^"]*("|$)|\'[^\']*(\'|$)|\S)*\s*/', '', $string);
-			}
-
-			/**
-			 *	Decodes numeric HTML entities
-			 *
-			 *	This method decodes numeric HTML entities (&#65; and &#x41;). It doesn't
-			 *	do anything with other entities like &auml;, but we don't need them in the
-			 *	URL protocol white listing system anyway.
-			 *
-			 *	@access private
-			 *	@param string $value The entitiy to be decoded.
-			 *	@return string Decoded entity
-			 *	@since PHP4 OOP 0.0.1
-			 */
-			function _decode_entities($string)
-			{
-				$string = preg_replace('/&#([0-9]+);/e', 'chr("\\1")', $string);
-				$string = preg_replace('/&#[Xx]([0-9A-Fa-f]+);/e', 'chr(hexdec("\\1"))', $string);
-				return $string;
-			}
-
-			/**
-			 *	Returns PHP4 OOP version # of kses.
-			 *
-			 *	Since this class has been refactored and documented and proven to work,
-			 *	I'm syncing the version number to procedural kses.
-			 *
-			 *	@access public
-			 *	@return string Version number
-			 *	@since PHP4 OOP 0.0.1
-			 */
-			function _version()
-			{
-				return 'PHP4 0.2.2 (OOP fork of procedural kses 0.2.2)';
-			}
-		}
-
-
-
-	}
+            var $allowed_protocols = array();
+            var $allowed_html      = array();
+            /**#@-*/
+
+            /**
+             *	Constructor for kses.
+             *
+             *	This sets a default collection of protocols allowed in links, and creates an
+             *	empty set of allowed HTML tags.
+             *	@since PHP4 OOP 0.0.1
+             */
+            function kses4()
+            {
+                /**
+                 *	You could add protocols such as ftp, new, gopher, mailto, irc, etc.
+                 *
+                 *	The base values the original kses provided were:
+                 *		'http', 'https', 'ftp', 'news', 'nntp', 'telnet', 'gopher', 'mailto'
+                 */
+                $this->allowed_protocols = array('http', 'ftp', 'mailto');
+                $this->allowed_html      = array();
+            }
+
+            /**
+             *	Basic task of kses - parses $string and strips it as required.
+             *
+             *	This method strips all the disallowed (X)HTML tags, attributes
+             *	and protocols from the input $string.
+             *
+             *	@access public
+             *	@param string $string String to be stripped of 'evil scripts'
+             *	@return string The stripped string
+             *	@since PHP4 OOP 0.2.1
+             */
+            function Parse($string = "")
+            {
+                if (get_magic_quotes_gpc())
+                {
+                    $string = stripslashes($string);
+                }
+                $string = $this->_no_null($string);
+                $string = $this->_js_entities($string);
+                $string = $this->_normalize_entities($string);
+                $string = $this->filterKsesTextHook($string);
+                return    $this->_split($string);
+            }
+
+            /**
+             *	Allows for single/batch addition of protocols
+             *
+             *	This method accepts one argument that can be either a string
+             *	or an array of strings.  Invalid data will be ignored.
+             *
+             *	The argument will be processed, and each string will be added
+             *	via AddProtocol().
+             *
+             *	@access public
+             *	@param mixed , A string or array of protocols that will be added to the internal list of allowed protocols.
+             *	@return bool Status of adding valid protocols.
+             *	@see AddProtocol()
+             *	@since PHP4 OOP 0.2.1
+             */
+            function AddProtocols()
+            {
+                $c_args = func_num_args();
+                if($c_args != 1)
+                {
+                    trigger_error("kses4::AddProtocols() did not receive an argument.", E_USER_WARNING);
+                    return false;
+                }
+
+                $protocol_data = func_get_arg(0);
+
+                if(is_array($protocol_data) && count($protocol_data) > 0)
+                {
+                    foreach($protocol_data as $protocol)
+                    {
+                        $this->AddProtocol($protocol);
+                    }
+                    return true;
+                }
+                elseif(is_string($protocol_data))
+                {
+                    $this->AddProtocol($protocol_data);
+                    return true;
+                }
+                else
+                {
+                    trigger_error("kses4::AddProtocols() did not receive a string or an array.", E_USER_WARNING);
+                    return false;
+                }
+            }
+
+            /**
+             *	Allows for single/batch addition of protocols
+             *
+             *	@deprecated Use AddProtocols()
+             *	@see AddProtocols()
+             *	@return bool
+             *	@since PHP4 OOP 0.0.1
+             */
+            function Protocols()
+            {
+                $c_args = func_num_args();
+                if($c_args != 1)
+                {
+                    trigger_error("kses4::Protocols() did not receive an argument.", E_USER_WARNING);
+                    return false;
+                }
+
+                return $this->AddProtocols(func_get_arg(0));
+            }
+
+            /**
+             *	Adds a single protocol to $this->allowed_protocols.
+             *
+             *	This method accepts a string argument and adds it to
+             *	the list of allowed protocols to keep when performing
+             *	Parse().
+             *
+             *	@access public
+             *	@param string $protocol The name of the protocol to be added.
+             *	@return bool Status of adding valid protocol.
+             *	@since PHP4 OOP 0.0.1
+             */
+            function AddProtocol($protocol = "")
+            {
+                if(!is_string($protocol))
+                {
+                    trigger_error("kses4::AddProtocol() requires a string.", E_USER_WARNING);
+                    return false;
+                }
+
+                $protocol = strtolower(trim($protocol));
+                if($protocol == "")
+                {
+                    trigger_error("kses4::AddProtocol() tried to add an empty/NULL protocol.", E_USER_WARNING);
+                    return false;
+                }
+
+                // Remove any inadvertent ':' at the end of the protocol.
+                if(substr($protocol, strlen($protocol) - 1, 1) == ":")
+                {
+                    $protocol = substr($protocol, 0, strlen($protocol) - 1);
+                }
+
+                if(!in_array($protocol, $this->allowed_protocols))
+                {
+                    array_push($this->allowed_protocols, $protocol);
+                    sort($this->allowed_protocols);
+                }
+                return true;
+            }
+
+            /**
+             *	Allows for single/batch replacement of protocols
+             *
+             *	This method accepts one argument that can be either a string
+             *	or an array of strings.  Invalid data will be ignored.
+             *
+             *	Existing protocols will be removed, then the argument will be
+             *	processed, and each string will be added via AddProtocol().
+             *
+             *	@access public
+             *	@param mixed , A string or array of protocols that will be the new internal list of allowed protocols.
+             *	@return bool Status of replacing valid protocols.
+             *	@since PHP4 OOP 0.2.2
+             *	@see AddProtocol()
+             */
+            function SetProtocols()
+            {
+                $c_args = func_num_args();
+                if($c_args != 1)
+                {
+                    trigger_error("kses4::SetProtocols() did not receive an argument.", E_USER_WARNING);
+                    return false;
+                }
+
+                $protocol_data = func_get_arg(0);
+
+                if(is_array($protocol_data) && count($protocol_data) > 0)
+                {
+                    $this->allowed_protocols = array();
+                    foreach($protocol_data as $protocol)
+                    {
+                        $this->AddProtocol($protocol);
+                    }
+                    return true;
+                }
+                elseif(is_string($protocol_data))
+                {
+                    $this->allowed_protocols = array();
+                    $this->AddProtocol($protocol_data);
+                    return true;
+                }
+                else
+                {
+                    trigger_error("kses4::SetProtocols() did not receive a string or an array.", E_USER_WARNING);
+                    return false;
+                }
+            }
+
+            /**
+             *	Raw dump of allowed protocols
+             *
+             *	This returns an indexed array of allowed protocols for a particular KSES
+             *	instantiation.
+             *
+             *	@access public
+             *	@return array The list of allowed protocols.
+             *	@since PHP4 OOP 0.2.2
+             */
+            function DumpProtocols()
+            {
+                return $this->allowed_protocols;
+            }
+
+            /**
+             *	Raw dump of allowed (X)HTML elements
+             *
+             *	This returns an indexed array of allowed (X)HTML elements and attributes
+             *	for a particular KSES instantiation.
+             *
+             *	@access public
+             *	@return array The list of allowed elements.
+             *	@since PHP4 OOP 0.2.2
+             */
+            function DumpElements()
+            {
+                return $this->allowed_html;
+            }
+
+            /**
+             *	Adds valid (X)HTML with corresponding attributes that will be kept when stripping 'evil scripts'.
+             *
+             *	This method accepts one argument that can be either a string
+             *	or an array of strings.  Invalid data will be ignored.
+             *
+             *	@access public
+             *	@param string $tag (X)HTML tag that will be allowed after stripping text.
+             *	@param array $attribs Associative array of allowed attributes - key => attribute name - value => attribute parameter
+             *	@return bool Status of Adding (X)HTML and attributes.
+             *	@since PHP4 OOP 0.0.1
+             */
+            function AddHTML($tag = "", $attribs = array())
+            {
+                if(!is_string($tag))
+                {
+                    trigger_error("kses4::AddHTML() requires the tag to be a string", E_USER_WARNING);
+                    return false;
+                }
+
+                $tag = strtolower(trim($tag));
+                if($tag == "")
+                {
+                    trigger_error("kses4::AddHTML() tried to add an empty/NULL tag", E_USER_WARNING);
+                    return false;
+                }
+
+                if(!is_array($attribs))
+                {
+                    trigger_error("kses4::AddHTML() requires an array (even an empty one) of attributes for '$tag'", E_USER_WARNING);
+                    return false;
+                }
+
+                $new_attribs = array();
+                if(is_array($attribs) && count($attribs) > 0)
+                {
+                    foreach($attribs as $idx1 => $val1)
+                    {
+                        $new_idx1 = strtolower($idx1);
+                        $new_val1 = $attribs[$idx1];
+
+                        if(is_array($new_val1) && count($new_val1) > 0)
+                        {
+                            $tmp_val = array();
+                            foreach($new_val1 as $idx2 => $val2)
+                            {
+                                $new_idx2 = strtolower($idx2);
+                                $tmp_val[$new_idx2] = $val2;
+                            }
+                            $new_val1 = $tmp_val;
+                        }
+
+                        $new_attribs[$new_idx1] = $new_val1;
+                    }
+                }
+
+                $this->allowed_html[$tag] = $new_attribs;
+                return true;
+            }
+
+            /**
+             *	Removes a single protocol from $this->allowed_protocols.
+             *
+             *	This method accepts a string argument and removes it from
+             *	the list of allowed protocols to keep when performing
+             *	Parse().
+             *
+             *	@access public
+             *	@param string $protocol The name of the protocol to be removed.
+             *	@return bool Status of removing valid protocol.
+             *	@since PHP4 OOP 0.2.1
+             */
+            function RemoveProtocol($protocol = "")
+            {
+                if(!is_string($protocol))
+                {
+                    trigger_error("kses4::RemoveProtocol() requires a string.", E_USER_WARNING);
+                    return false;
+                }
+
+                // Remove any inadvertent ':' at the end of the protocol.
+                if(substr($protocol, strlen($protocol) - 1, 1) == ":")
+                {
+                    $protocol = substr($protocol, 0, strlen($protocol) - 1);
+                }
+
+                $protocol = strtolower(trim($protocol));
+                if($protocol == "")
+                {
+                    trigger_error("kses4::RemoveProtocol() tried to remove an empty/NULL protocol.", E_USER_WARNING);
+                    return false;
+                }
+
+                //	Ensures that the protocol exists before removing it.
+                if(in_array($protocol, $this->allowed_protocols))
+                {
+                    $this->allowed_protocols = array_diff($this->allowed_protocols, array($protocol));
+                    sort($this->allowed_protocols);
+                }
+
+                return true;
+            }
+
+            /**
+             *	Allows for single/batch removal of protocols
+             *
+             *	This method accepts one argument that can be either a string
+             *	or an array of strings.  Invalid data will be ignored.
+             *
+             *	The argument will be processed, and each string will be removed
+             *	via RemoveProtocol().
+             *
+             *	@access public
+             *	@param mixed , A string or array of protocols that will be removed from the internal list of allowed protocols.
+             *	@return bool Status of removing valid protocols.
+             *	@see RemoveProtocol()
+             *	@since PHP5 OOP 0.2.1
+             */
+            function RemoveProtocols()
+            {
+                $c_args = func_num_args();
+                if($c_args != 1)
+                {
+                    return false;
+                }
+
+                $protocol_data = func_get_arg(0);
+
+                if(is_array($protocol_data) && count($protocol_data) > 0)
+                {
+                    foreach($protocol_data as $protocol)
+                    {
+                        $this->RemoveProtocol($protocol);
+                    }
+                }
+                elseif(is_string($protocol_data))
+                {
+                    $this->RemoveProtocol($protocol_data);
+                    return true;
+                }
+                else
+                {
+                    trigger_error("kses4::RemoveProtocols() did not receive a string or an array.", E_USER_WARNING);
+                    return false;
+                }
+            }
+
+            /**
+             *	This method removes any NULL or characters in $string.
+             *
+             *	@access private
+             *	@param string $string
+             *	@return string String without any NULL/chr(173)
+             *	@since PHP4 OOP 0.0.1
+             */
+            function _no_null($string)
+            {
+                $string = preg_replace('/\0+/', '', $string);
+                $string = preg_replace('/(\\\\0)+/', '', $string);
+                return $string;
+            }
+
+            /**
+             *	This function removes the HTML JavaScript entities found in early versions of
+             *	Netscape 4.
+             *
+             *	@access private
+             *	@param string $string
+             *	@return string String without any NULL/chr(173)
+             *	@since PHP4 OOP 0.0.1
+             */
+            function _js_entities($string)
+            {
+                return preg_replace('%&\s*\{[^}]*(\}\s*;?|$)%', '', $string);
+            }
+
+            /**
+             *	Normalizes HTML entities
+             *
+             *	This function normalizes HTML entities. It will convert "AT&T" to the correct
+             *	"AT&amp;T", "&#00058;" to "&#58;", "&#XYZZY;" to "&amp;#XYZZY;" and so on.
+             *
+             *	@access private
+             *	@param string $string
+             *	@return string String with normalized entities
+             *	@since PHP4 OOP 0.0.1
+             */
+            function _normalize_entities($string)
+            {
+                # Disarm all entities by converting & to &amp;
+                $string = str_replace('&', '&amp;', $string);
+
+                # Change back the allowed entities in our entity white list
+
+                $string = preg_replace('/&amp;([A-Za-z][A-Za-z0-9]{0,19});/', '&\\1;', $string);
+                $string = preg_replace('/&amp;#0*([0-9]{1,5});/e', '\$this->_normalize_entities2("\\1")', $string);
+                $string = preg_replace('/&amp;#([Xx])0*(([0-9A-Fa-f]{2}){1,2});/', '&#\\1\\2;', $string);
+
+                return $string;
+            }
+
+            /**
+             *	Helper method used by normalizeEntites()
+             *
+             *	This method helps normalizeEntities() to only accept 16 bit values
+             *	and nothing more for &#number; entities.
+             *
+             *	This method helps normalize_entities() during a preg_replace()
+             *	where a &#(0)*XXXXX; occurs.  The '(0)*XXXXXX' value is converted to
+             *	a number and the result is returned as a numeric entity if the number
+             *	is less than 65536.  Otherwise, the value is returned 'as is'.
+             *
+             *	@access private
+             *	@param string $i
+             *	@return string Normalized numeric entity
+             *	@see _normalize_entities()
+             *	@since PHP4 OOP 0.0.1
+             */
+            function _normalize_entities2($i)
+            {
+                return (($i > 65535) ? "&amp;#$i;" : "&#$i;");
+            }
+
+            /**
+             *	Allows for additional user defined modifications to text.
+             *
+             *	@deprecated use filterKsesTextHook()
+             *	@param string $string
+             *	@see filterKsesTextHook()
+             *	@return string
+             *	@since PHP4 OOP 0.0.1
+             */
+            function _hook($string)
+            {
+                return $this->filterKsesTextHook($string);
+            }
+
+            /**
+             *	Allows for additional user defined modifications to text.
+             *
+             *	This method allows for additional modifications to be performed on
+             *	a string that's being run through Parse().  Currently, it returns the
+             *	input string 'as is'.
+             *
+             *	This method is provided for users to extend the kses class for their own
+             *	requirements.
+             *
+             *	@access public
+             *	@param string $string String to perfrom additional modifications on.
+             *	@return string User modified string.
+             *	@see Parse()
+             *	@since PHP5 OOP 1.0.0
+             */
+            function filterKsesTextHook($string)
+            {
+                return $string;
+            }
+
+            /**
+             *	This method goes through an array, and changes the keys to all lower case.
+             *
+             *	@access private
+             *	@param array $in_array Associative array
+             *	@return array Modified array
+             *	@since PHP4 OOP 0.0.1
+             */
+            function _array_lc($inarray)
+            {
+                $outarray = array();
+
+                if(is_array($inarray) && count($inarray) > 0)
+                {
+                    foreach ($inarray as $inkey => $inval)
+                    {
+                        $outkey = strtolower($inkey);
+                        $outarray[$outkey] = array();
+
+                        if(is_array($inval) && count($inval) > 0)
+                        {
+                            foreach ($inval as $inkey2 => $inval2)
+                            {
+                                $outkey2 = strtolower($inkey2);
+                                $outarray[$outkey][$outkey2] = $inval2;
+                            }
+                        }
+                    }
+                }
+
+                return $outarray;
+            }
+
+            /**
+             *	This method searched for HTML tags, no matter how malformed.  It also
+             *	matches stray ">" characters.
+             *
+             *	@access private
+             *	@param string $string
+             *	@return string HTML tags
+             *	@since PHP4 OOP 0.0.1
+             */
+            function _split($string)
+            {
+                return preg_replace(
+                    '%(<'.   # EITHER: <
+                    '[^>]*'. # things that aren't >
+                    '(>|$)'. # > or end of string
+                    '|>)%e', # OR: just a >
+                    "\$this->_split2('\\1')",
+                    $string);
+            }
+
+            /**
+             *	This method strips out disallowed and/or mangled (X)HTML tags along with assigned attributes.
+             *
+             *	This method does a lot of work. It rejects some very malformed things
+             *	like <:::>. It returns an empty string if the element isn't allowed (look
+             *	ma, no strip_tags()!). Otherwise it splits the tag into an element and an
+             *	allowed attribute list.
+             *
+             *	@access private
+             *	@param string $string
+             *	@return string Modified string minus disallowed/mangled (X)HTML and attributes
+             *	@since PHP4 OOP 0.0.1
+             */
+            function _split2($string)
+            {
+                $string = $this->_stripslashes($string);
+
+                if (substr($string, 0, 1) != '<')
+                {
+                    # It matched a ">" character
+                    return '&gt;';
+                }
+
+                if (!preg_match('%^<\s*(/\s*)?([a-zA-Z0-9]+)([^>]*)>?$%', $string, $matches))
+                {
+                    # It's seriously malformed
+                    return '';
+                }
+
+                $slash    = trim($matches[1]);
+                $elem     = $matches[2];
+                $attrlist = $matches[3];
+
+                if (
+                    !isset($this->allowed_html[strtolower($elem)]) ||
+                    !is_array($this->allowed_html[strtolower($elem)])
+                )
+                {
+                    # They are using a not allowed HTML element
+                    return '';
+                }
+
+                if ($slash != '')
+                {
+                    return "<$slash$elem>";
+                }
+                # No attributes are allowed for closing elements
+
+                return $this->_attr("$slash$elem", $attrlist);
+            }
+
+            /**
+             *	This method strips out disallowed attributes for (X)HTML tags.
+             *
+             *	This method removes all attributes if none are allowed for this element.
+             *	If some are allowed it calls $this->_hair() to split them further, and then it
+             *	builds up new HTML code from the data that $this->_hair() returns. It also
+             *	removes "<" and ">" characters, if there are any left. One more thing it
+             *	does is to check if the tag has a closing XHTML slash, and if it does,
+             *	it puts one in the returned code as well.
+             *
+             *	@access private
+             *	@param string $element (X)HTML tag to check
+             *	@param string $attr Text containing attributes to check for validity.
+             *	@return string Resulting valid (X)HTML or ''
+             *	@see _hair()
+             *	@since PHP4 OOP 0.0.1
+             */
+            function _attr($element, $attr)
+            {
+                # Is there a closing XHTML slash at the end of the attributes?
+                $xhtml_slash = '';
+                if (preg_match('%\s/\s*$%', $attr))
+                {
+                    $xhtml_slash = ' /';
+                }
+
+                # Are any attributes allowed at all for this element?
+                if (
+                    !isset($this->allowed_html[strtolower($element)]) ||
+                    count($this->allowed_html[strtolower($element)]) == 0
+                )
+                {
+                    return "<$element$xhtml_slash>";
+                }
+
+                # Split it
+                $attrarr = $this->_hair($attr);
+
+                # Go through $attrarr, and save the allowed attributes for this element
+                # in $attr2
+                $attr2 = '';
+                if(is_array($attrarr) && count($attrarr) > 0)
+                {
+                    foreach ($attrarr as $arreach)
+                    {
+                        if(!isset($this->allowed_html[strtolower($element)][strtolower($arreach['name'])]))
+                        {
+                            continue;
+                        }
+
+                        $current = $this->allowed_html[strtolower($element)][strtolower($arreach['name'])];
+                        if ($current == '')
+                        {
+                            # the attribute is not allowed
+                            continue;
+                        }
+
+                        if (!is_array($current))
+                        {
+                            # there are no checks
+                            $attr2 .= ' '.$arreach['whole'];
+                        }
+                        else
+                        {
+                            # there are some checks
+                            $ok = true;
+                            if(is_array($current) && count($current) > 0)
+                            {
+                                foreach ($current as $currkey => $currval)
+                                {
+                                    if (!$this->_check_attr_val($arreach['value'], $arreach['vless'], $currkey, $currval))
+                                    {
+                                        $ok = false;
+                                        break;
+                                    }
+                                }
+
+                                if ($ok)
+                                {
+                                    # it passed them
+                                    $attr2 .= ' '.$arreach['whole'];
+                                }
+                            }
+                        }
+                    }
+                }
+
+                # Remove any "<" or ">" characters
+                $attr2 = preg_replace('/[<>]/', '', $attr2);
+                return "<$element$attr2$xhtml_slash>";
+            }
+
+            /**
+             *	This method combs through an attribute list string and returns an associative array of attributes and values.
+             *
+             *	This method does a lot of work. It parses an attribute list into an array
+             *	with attribute data, and tries to do the right thing even if it gets weird
+             *	input. It will add quotes around attribute values that don't have any quotes
+             *	or apostrophes around them, to make it easier to produce HTML code that will
+             *	conform to W3C's HTML specification. It will also remove bad URL protocols
+             *	from attribute values.
+             *
+             *	@access private
+             *	@param string $attr Text containing tag attributes for parsing
+             *	@return array Associative array containing data on attribute and value
+             *	@since PHP4 OOP 0.0.1
+             */
+            function _hair($attr)
+            {
+                $attrarr  = array();
+                $mode     = 0;
+                $attrname = '';
+
+                # Loop through the whole attribute list
+
+                while (strlen($attr) != 0)
+                {
+                    # Was the last operation successful?
+                    $working = 0;
+
+                    switch ($mode)
+                    {
+                        case 0:	# attribute name, href for instance
+                            if (preg_match('/^([-a-zA-Z]+)/', $attr, $match))
+                            {
+                                $attrname = $match[1];
+                                $working = $mode = 1;
+                                $attr = preg_replace('/^[-a-zA-Z]+/', '', $attr);
+                            }
+                            break;
+                        case 1:	# equals sign or valueless ("selected")
+                            if (preg_match('/^\s*=\s*/', $attr)) # equals sign
+                            {
+                                $working = 1;
+                                $mode    = 2;
+                                $attr    = preg_replace('/^\s*=\s*/', '', $attr);
+                                break;
+                            }
+                            if (preg_match('/^\s+/', $attr)) # valueless
+                            {
+                                $working   = 1;
+                                $mode      = 0;
+                                $attrarr[] = array(
+                                    'name'  => $attrname,
+                                    'value' => '',
+                                    'whole' => $attrname,
+                                    'vless' => 'y'
+                                );
+                                $attr      = preg_replace('/^\s+/', '', $attr);
+                            }
+                            break;
+                        case 2: # attribute value, a URL after href= for instance
+                            if (preg_match('/^"([^"]*)"(\s+|$)/', $attr, $match)) # "value"
+                            {
+                                $thisval   = $this->_bad_protocol($match[1]);
+                                $attrarr[] = array(
+                                    'name'  => $attrname,
+                                    'value' => $thisval,
+                                    'whole' => "$attrname=\"$thisval\"",
+                                    'vless' => 'n'
+                                );
+                                $working   = 1;
+                                $mode      = 0;
+                                $attr      = preg_replace('/^"[^"]*"(\s+|$)/', '', $attr);
+                                break;
+                            }
+                            if (preg_match("/^'([^']*)'(\s+|$)/", $attr, $match)) # 'value'
+                            {
+                                $thisval   = $this->_bad_protocol($match[1]);
+                                $attrarr[] = array(
+                                    'name'  => $attrname,
+                                    'value' => $thisval,
+                                    'whole' => "$attrname='$thisval'",
+                                    'vless' => 'n'
+                                );
+                                $working   = 1;
+                                $mode      = 0;
+                                $attr      = preg_replace("/^'[^']*'(\s+|$)/", '', $attr);
+                                break;
+                            }
+                            if (preg_match("%^([^\s\"']+)(\s+|$)%", $attr, $match)) # value
+                            {
+                                $thisval   = $this->_bad_protocol($match[1]);
+                                $attrarr[] = array(
+                                    'name'  => $attrname,
+                                    'value' => $thisval,
+                                    'whole' => "$attrname=\"$thisval\"",
+                                    'vless' => 'n'
+                                );
+                                # We add quotes to conform to W3C's HTML spec.
+                                $working   = 1;
+                                $mode      = 0;
+                                $attr      = preg_replace("%^[^\s\"']+(\s+|$)%", '', $attr);
+                            }
+                            break;
+                    }
+
+                    if ($working == 0) # not well formed, remove and try again
+                    {
+                        $attr = $this->_html_error($attr);
+                        $mode = 0;
+                    }
+                }
+
+                # special case, for when the attribute list ends with a valueless
+                # attribute like "selected"
+                if ($mode == 1)
+                {
+                    $attrarr[] = array(
+                        'name'  => $attrname,
+                        'value' => '',
+                        'whole' => $attrname,
+                        'vless' => 'y'
+                    );
+                }
+
+                return $attrarr;
+            }
+
+            /**
+             *	This method removes disallowed protocols.
+             *
+             *	This method removes all non-allowed protocols from the beginning of
+             *	$string. It ignores whitespace and the case of the letters, and it does
+             *	understand HTML entities. It does its work in a while loop, so it won't be
+             *	fooled by a string like "javascript:javascript:alert(57)".
+             *
+             *	@access private
+             *	@param string $string String to check for protocols
+             *	@return string String with removed protocols
+             *	@since PHP4 OOP 0.0.1
+             */
+            function _bad_protocol($string)
+            {
+                $string  = $this->_no_null($string);
+                $string = preg_replace('/\xad+/', '', $string); # deals with Opera "feature"
+                $string2 = $string.'a';
+
+                while ($string != $string2)
+                {
+                    $string2 = $string;
+                    $string  = $this->_bad_protocol_once($string);
+                } # while
+
+                return $string;
+            }
+
+            /**
+             *	Helper method used by _bad_protocol()
+             *
+             *	This function searches for URL protocols at the beginning of $string, while
+             *	handling whitespace and HTML entities.
+             *  Function updated to fix security vulnerability (see http://projects.dokeos.com/index.php?do=details&task_id=2312)
+             *
+             *	@access private
+             *	@param string $string String to check for protocols
+             *	@return string String with removed protocols
+             *	@see _bad_protocol()
+             *	@since PHP4 OOP 0.0.1
+             */
+            function _bad_protocol_once($string)
+            {
+                $string2 = preg_split('/:|&#58;|&#x3a;/i', $string, 2);
+                if(isset($string2[1]) && !preg_match('%/\?%',$string2[0]))
+                {
+                    $string = $this->_bad_protocol_once2($string2[0]).trim($string2[1]);
+                }
+                return $string;
+            }
+            /**
+             *	Helper method used by _bad_protocol_once() regex
+             *
+             *	This function processes URL protocols, checks to see if they're in the white-
+             *	list or not, and returns different data depending on the answer.
+             *
+             *	@access private
+             *	@param string $string String to check for protocols
+             *	@return string String with removed protocols
+             *	@see _bad_protocol()
+             *	@see _bad_protocol_once()
+             *	@since PHP4 OOP 0.0.1
+             */
+            function _bad_protocol_once2($string)
+            {
+                $string = $this->_decode_entities($string);
+                $string = preg_replace('/\s/', '', $string);
+                $string = $this->_no_null($string);
+                $string = preg_replace('/\xad+/', '', $string); # deals with Opera "feature"
+                $string = strtolower($string);
+
+                $allowed = false;
+                if(is_array($this->allowed_protocols) && count($this->allowed_protocols) > 0)
+                {
+                    foreach ($this->allowed_protocols as $one_protocol)
+                    {
+                        if (strtolower($one_protocol) == $string)
+                        {
+                            $allowed = true;
+                            break;
+                        }
+                    }
+                }
+
+                if ($allowed)
+                {
+                    return "$string:";
+                }
+                else
+                {
+                    return '';
+                }
+            }
+
+            /**
+             *	This function performs different checks for attribute values.
+             *
+             *	The currently implemented checks are "maxlen", "minlen", "maxval",
+             *	"minval" and "valueless" with even more checks to come soon.
+             *
+             *	@access private
+             *	@param string $value The value of the attribute to be checked.
+             *	@param string $vless Indicates whether the the value is supposed to be valueless
+             *	@param string $checkname The check to be performed
+             *	@param string $checkvalue The value that is to be checked against
+             *	@return bool Indicates whether the check passed or not
+             *	@since PHP4 OOP 0.0.1
+             */
+            function _check_attr_val($value, $vless, $checkname, $checkvalue)
+            {
+                $ok = true;
+
+                switch (strtolower($checkname))
+                {
+                    /**
+                     *	The maxlen check makes sure that the attribute value has a length not
+                     *	greater than the given value. This can be used to avoid Buffer Overflows
+                     *	in WWW clients and various Internet servers.
+                     */
+                    case 'maxlen':
+                        if (strlen($value) > $checkvalue)
+                        {
+                            $ok = false;
+                        }
+                        break;
+
+                    /**
+                     *	The minlen check makes sure that the attribute value has a length not
+                     *	smaller than the given value.
+                     */
+                    case 'minlen':
+                        if (strlen($value) < $checkvalue)
+                        {
+                            $ok = false;
+                        }
+                        break;
+
+                    /**
+                     *	The maxval check does two things: it checks that the attribute value is
+                     *	an integer from 0 and up, without an excessive amount of zeroes or
+                     *	whitespace (to avoid Buffer Overflows). It also checks that the attribute
+                     *	value is not greater than the given value.
+                     *	This check can be used to avoid Denial of Service attacks.
+                     */
+                    case 'maxval':
+                        if (!preg_match('/^\s{0,6}[0-9]{1,6}\s{0,6}$/', $value))
+                        {
+                            $ok = false;
+                        }
+                        if ($value > $checkvalue)
+                        {
+                            $ok = false;
+                        }
+                        break;
+
+                    /**
+                     *	The minval check checks that the attribute value is a positive integer,
+                     *	and that it is not smaller than the given value.
+                     */
+                    case 'minval':
+                        if (!preg_match('/^\s{0,6}[0-9]{1,6}\s{0,6}$/', $value))
+                        {
+                            $ok = false;
+                        }
+                        if ($value < $checkvalue)
+                        {
+                            $ok = false;
+                        }
+                        break;
+
+                    /**
+                     *	The valueless check checks if the attribute has a value
+                     *	(like <a href="blah">) or not (<option selected>). If the given value
+                     *	is a "y" or a "Y", the attribute must not have a value.
+                     *	If the given value is an "n" or an "N", the attribute must have one.
+                     */
+                    case 'valueless':
+                    if (strtolower($checkvalue) != $vless)
+                    {
+                        $ok = false;
+                    }
+                    break;
+
+                }
+
+                return $ok;
+            }
+
+            /**
+             *	Changes \" to "
+             *
+             *	This function changes the character sequence  \"  to just  "
+             *	It leaves all other slashes alone. It's really weird, but the quoting from
+             *	preg_replace(//e) seems to require this.
+             *
+             *	@access private
+             *	@param string $string The string to be stripped.
+             *	@return string string stripped of \"
+             *	@since PHP4 OOP 0.0.1
+             */
+            function _stripslashes($string)
+            {
+                return preg_replace('%\\\\"%', '"', $string);
+            }
+
+            /**
+             *	helper method for _hair()
+             *
+             *	This function deals with parsing errors in _hair(). The general plan is
+             *	to remove everything to and including some whitespace, but it deals with
+             *	quotes and apostrophes as well.
+             *
+             *	@access private
+             *	@param string $string The string to be stripped.
+             *	@return string string stripped of whitespace
+             *	@see _hair()
+             *	@since PHP4 OOP 0.0.1
+             */
+            function _html_error($string)
+            {
+                return preg_replace('/^("[^"]*("|$)|\'[^\']*(\'|$)|\S)*\s*/', '', $string);
+            }
+
+            /**
+             *	Decodes numeric HTML entities
+             *
+             *	This method decodes numeric HTML entities (&#65; and &#x41;). It doesn't
+             *	do anything with other entities like &auml;, but we don't need them in the
+             *	URL protocol white listing system anyway.
+             *
+             *	@access private
+             *	@param string $value The entitiy to be decoded.
+             *	@return string Decoded entity
+             *	@since PHP4 OOP 0.0.1
+             */
+            function _decode_entities($string)
+            {
+                $string = preg_replace('/&#([0-9]+);/e', 'chr("\\1")', $string);
+                $string = preg_replace('/&#[Xx]([0-9A-Fa-f]+);/e', 'chr(hexdec("\\1"))', $string);
+                return $string;
+            }
+
+            /**
+             *	Returns PHP4 OOP version # of kses.
+             *
+             *	Since this class has been refactored and documented and proven to work,
+             *	I'm syncing the version number to procedural kses.
+             *
+             *	@access public
+             *	@return string Version number
+             *	@since PHP4 OOP 0.0.1
+             */
+            function _version()
+            {
+                return 'PHP4 0.2.2 (OOP fork of procedural kses 0.2.2)';
+            }
+        }
+
+
+
+    }
 ?>
\ No newline at end of file

main/inc/lib/xajax/xajax.inc.php

Indentation +1165 added lines, -1165 removed lines

@@ -47,7 +47,7 @@ 
  */
 if (!defined ('XAJAX_DEFAULT_CHAR_ENCODING'))
 {
-	define ('XAJAX_DEFAULT_CHAR_ENCODING', 'utf-8' );
+    define ('XAJAX_DEFAULT_CHAR_ENCODING', 'utf-8' );
 }
 
 /**
@@ -55,11 +55,11 @@ 
  */
 if (!defined ('XAJAX_GET'))
 {
-	define ('XAJAX_GET', 0);
+    define ('XAJAX_GET', 0);
 }
 if (!defined ('XAJAX_POST'))
 {
-	define ('XAJAX_POST', 1);
+    define ('XAJAX_POST', 1);
 }
 
 /**
@@ -72,1145 +72,1145 @@ 
  */
 class xajax
 {
-	/**#@+
+    /**#@+
 	 * @access protected
 	 */
-	/**
-	 * @var array Array of PHP functions that will be callable through javascript wrappers
-	 */
-	var $aFunctions;
-	/**
-	 * @var array Array of object callbacks that will allow Javascript to call PHP methods (key=function name)
-	 */
-	var $aObjects;
-	/**
-	 * @var array Array of RequestTypes to be used with each function (key=function name)
-	 */
-	var $aFunctionRequestTypes;
-	/**
-	 * @var array Array of Include Files for any external functions (key=function name)
-	 */
-	var $aFunctionIncludeFiles;
-	/**
-	 * @var string Name of the PHP function to call if no callable function was found
-	 */
-	var $sCatchAllFunction;
-	/**
-	 * @var string Name of the PHP function to call before any other function
-	 */
-	var $sPreFunction;
-	/**
-	 * @var string The URI for making requests to the xajax object
-	 */
-	var $sRequestURI;
-	/**
-	 * @var string The prefix to prepend to the javascript wraper function name
-	 */
-	var $sWrapperPrefix;
-	/**
-	 * @var boolean Show debug messages (default false)
-	 */
-	var $bDebug;
-	/**
-	 * @var boolean Show messages in the client browser's status bar (default false)
-	 */
-	var $bStatusMessages;
-	/**
-	 * @var boolean Allow xajax to exit after processing a request (default true)
-	 */
-	var $bExitAllowed;
-	/**
-	 * @var boolean Use wait cursor in browser (default true)
-	 */
-	var $bWaitCursor;
-	/**
-	 * @var boolean Use an special xajax error handler so the errors are sent to the browser properly (default false)
-	 */
-	var $bErrorHandler;
-	/**
-	 * @var string Specify what, if any, file xajax should log errors to (and more information in a future release)
-	 */
-	var $sLogFile;
-	/**
-	 * @var boolean Clean all output buffers before outputting response (default false)
-	 */
-	var $bCleanBuffer;
-	/**
-	 * @var string String containing the character encoding used
-	 */
-	var $sEncoding;
-	/**
-	 * @var boolean Decode input request args from UTF-8 (default false)
-	 */
-	var $bDecodeUTF8Input;
-	/**
-	 * @var boolean Convert special characters to HTML entities (default false)
-	 */
-	var $bOutputEntities;
-	/**
-	 * @var array Array for parsing complex objects
-	 */
-	var $aObjArray;
-	/**
-	 * @var integer Position in $aObjArray
-	 */
-	var $iPos;
-
-	/**#@-*/
-
-	/**
-	 * Constructor. You can set some extra xajax options right away or use
-	 * individual methods later to set options.
-	 *
-	 * @param string  defaults to the current browser URI
-	 * @param string  defaults to "xajax_";
-	 * @param string  defaults to XAJAX_DEFAULT_CHAR_ENCODING defined above
-	 * @param boolean defaults to false
-	 */
-	function xajax($sRequestURI="",$sWrapperPrefix="xajax_",$sEncoding=XAJAX_DEFAULT_CHAR_ENCODING,$bDebug=false)
-	{
-		$this->aFunctions = array();
-		$this->aObjects = array();
-		$this->aFunctionIncludeFiles = array();
-		$this->sRequestURI = $sRequestURI;
-		if ($this->sRequestURI == "")
-			$this->sRequestURI = $this->_detectURI();
-		$this->sWrapperPrefix = $sWrapperPrefix;
-		$this->bDebug = $bDebug;
-		$this->bStatusMessages = false;
-		$this->bWaitCursor = true;
-		$this->bExitAllowed = true;
-		$this->bErrorHandler = false;
-		$this->sLogFile = "";
-		$this->bCleanBuffer = false;
-		$this->setCharEncoding($sEncoding);
-		$this->bDecodeUTF8Input = false;
-		$this->bOutputEntities = false;
-	}
-
-	/**
-	 * Sets the URI to which requests will be made.
-	 * <i>Usage:</i> <kbd>$xajax->setRequestURI("http://www.xajaxproject.org");</kbd>
-	 *
-	 * @param string the URI (can be absolute or relative) of the PHP script
-	 *               that will be accessed when an xajax request occurs
-	 */
-	function setRequestURI($sRequestURI)
-	{
-		$this->sRequestURI = $sRequestURI;
-	}
-
-	/**
-	 * Sets the prefix that will be appended to the Javascript wrapper
-	 * functions (default is "xajax_").
-	 *
-	 * @param string
-	 */
-	//
-	function setWrapperPrefix($sPrefix)
-	{
-		$this->sWrapperPrefix = $sPrefix;
-	}
-
-	/**
-	 * Enables debug messages for xajax.
-	 * */
-	function debugOn()
-	{
-		$this->bDebug = true;
-	}
-
-	/**
-	 * Disables debug messages for xajax (default behavior).
-	 */
-	function debugOff()
-	{
-		$this->bDebug = false;
-	}
-
-	/**
-	 * Enables messages in the browser's status bar for xajax.
-	 */
-	function statusMessagesOn()
-	{
-		$this->bStatusMessages = true;
-	}
-
-	/**
-	 * Disables messages in the browser's status bar for xajax (default behavior).
-	 */
-	function statusMessagesOff()
-	{
-		$this->bStatusMessages = false;
-	}
-
-	/**
-	 * Enables the wait cursor to be displayed in the browser (default behavior).
-	 */
-	function waitCursorOn()
-	{
-		$this->bWaitCursor = true;
-	}
-
-	/**
-	 * Disables the wait cursor to be displayed in the browser.
-	 */
-	function waitCursorOff()
-	{
-		$this->bWaitCursor = false;
-	}
-
-	/**
-	 * Enables xajax to exit immediately after processing a request and
-	 * sending the response back to the browser (default behavior).
-	 */
-	function exitAllowedOn()
-	{
-		$this->bExitAllowed = true;
-	}
-
-	/**
-	 * Disables xajax's default behavior of exiting immediately after
-	 * processing a request and sending the response back to the browser.
-	 */
-	function exitAllowedOff()
-	{
-		$this->bExitAllowed = false;
-	}
-
-	/**
-	 * Turns on xajax's error handling system so that PHP errors that occur
-	 * during a request are trapped and pushed to the browser in the form of
-	 * a Javascript alert.
-	 */
-	function errorHandlerOn()
-	{
-		$this->bErrorHandler = true;
-	}
-
-	/**
-	 * Turns off xajax's error handling system (default behavior).
-	 */
-	function errorHandlerOff()
-	{
-		$this->bErrorHandler = false;
-	}
-
-	/**
-	 * Specifies a log file that will be written to by xajax during a request
-	 * (used only by the error handling system at present). If you don't invoke
-	 * this method, or you pass in "", then no log file will be written to.
-	 * <i>Usage:</i> <kbd>$xajax->setLogFile("/xajax_logs/errors.log");</kbd>
-	 */
-	function setLogFile($sFilename)
-	{
-		$this->sLogFile = $sFilename;
-	}
-
-	/**
-	 * Causes xajax to clean out all output buffers before outputting a
-	 * response (default behavior).
-	 */
-	function cleanBufferOn()
-	{
-		$this->bCleanBuffer = true;
-	}
-	/**
-	 * Turns off xajax's output buffer cleaning.
-	 */
-	function cleanBufferOff()
-	{
-		$this->bCleanBuffer = false;
-	}
-
-	/**
-	 * Sets the character encoding for the HTTP output based on
-	 * <kbd>$sEncoding</kbd>, which is a string containing the character
-	 * encoding to use. You don't need to use this method normally, since the
-	 * character encoding for the response gets set automatically based on the
-	 * <kbd>XAJAX_DEFAULT_CHAR_ENCODING</kbd> constant.
-	 * <i>Usage:</i> <kbd>$xajax->setCharEncoding("utf-8");</kbd>
-	 *
-	 * @param string the encoding type to use (utf-8, iso-8859-1, etc.)
-	 */
-	function setCharEncoding($sEncoding)
-	{
-		$this->sEncoding = $sEncoding;
-	}
-
-	/**
-	 * Causes xajax to decode the input request args from UTF-8 to the current
-	 * encoding if possible. Either the iconv or mb_string extension must be
-	 * present for optimal functionality.
-	 */
-	function decodeUTF8InputOn()
-	{
-		$this->bDecodeUTF8Input = true;
-	}
-
-	/**
-	 * Turns off decoding the input request args from UTF-8 (default behavior).
-	 */
-	function decodeUTF8InputOff()
-	{
-		$this->bDecodeUTF8Input = false;
-	}
-
-	/**
-	 * Tells the response object to convert special characters to HTML entities
-	 * automatically (only works if the mb_string extension is available).
-	 */
-	function outputEntitiesOn()
-	{
-		$this->bOutputEntities = true;
-	}
-
-	/**
-	 * Tells the response object to output special characters intact. (default
-	 * behavior).
-	 */
-	function outputEntitiesOff()
-	{
-		$this->bOutputEntities = false;
-	}
-
-	/**
-	 * Registers a PHP function or method to be callable through xajax in your
-	 * Javascript. If you want to register a function, pass in the name of that
-	 * function. If you want to register a static class method, pass in an
-	 * array like so:
-	 * <kbd>array("myFunctionName", "myClass", "myMethod")</kbd>
-	 * For an object instance method, use an object variable for the second
-	 * array element (and in PHP 4 make sure you put an & before the variable
-	 * to pass the object by reference). Note: the function name is what you
-	 * call via Javascript, so it can be anything as long as it doesn't
-	 * conflict with any other registered function name.
-	 *
-	 * <i>Usage:</i> <kbd>$xajax->registerFunction("myFunction");</kbd>
-	 * or: <kbd>$xajax->registerFunction(array("myFunctionName", &$myObject, "myMethod"));</kbd>
-	 *
-	 * @param mixed  contains the function name or an object callback array
-	 * @param mixed  request type (XAJAX_GET/XAJAX_POST) that should be used
-	 *               for this function.  Defaults to XAJAX_POST.
-	 */
-	function registerFunction($mFunction,$sRequestType=XAJAX_POST)
-	{
-		if (is_array($mFunction)) {
-			$this->aFunctions[$mFunction[0]] = 1;
-			$this->aFunctionRequestTypes[$mFunction[0]] = $sRequestType;
-			$this->aObjects[$mFunction[0]] = array_slice($mFunction, 1);
-		}
-		else {
-			$this->aFunctions[$mFunction] = 1;
-			$this->aFunctionRequestTypes[$mFunction] = $sRequestType;
-		}
-	}
-
-	/**
-	 * Registers a PHP function to be callable through xajax which is located
-	 * in some other file.  If the function is requested the external file will
-	 * be included to define the function before the function is called.
-	 *
-	 * <i>Usage:</i> <kbd>$xajax->registerExternalFunction("myFunction","myFunction.inc.php",XAJAX_POST);</kbd>
-	 *
-	 * @param string contains the function name or an object callback array
-	 *               ({@link xajax::registerFunction() see registerFunction} for
-	 *               more info on object callback arrays)
-	 * @param string contains the path and filename of the include file
-	 * @param mixed  the RequestType (XAJAX_GET/XAJAX_POST) that should be used
-	 *		          for this function. Defaults to XAJAX_POST.
-	 */
-	function registerExternalFunction($mFunction,$sIncludeFile,$sRequestType=XAJAX_POST)
-	{
-		$this->registerFunction($mFunction, $sRequestType);
-
-		if (is_array($mFunction)) {
-			$this->aFunctionIncludeFiles[$mFunction[0]] = $sIncludeFile;
-		}
-		else {
-			$this->aFunctionIncludeFiles[$mFunction] = $sIncludeFile;
-		}
-	}
-
-	/**
-	 * Registers a PHP function to be called when xajax cannot find the
-	 * function being called via Javascript. Because this is technically
-	 * impossible when using "wrapped" functions, the catch-all feature is
-	 * only useful when you're directly using the xajax.call() Javascript
-	 * method. Use the catch-all feature when you want more dynamic ability to
-	 * intercept unknown calls and handle them in a custom way.
-	 *
-	 * <i>Usage:</i> <kbd>$xajax->registerCatchAllFunction("myCatchAllFunction");</kbd>
-	 *
-	 * @param string contains the function name or an object callback array
-	 *               ({@link xajax::registerFunction() see registerFunction} for
-	 *               more info on object callback arrays)
-	 */
-	function registerCatchAllFunction($mFunction)
-	{
-		if (is_array($mFunction)) {
-			$this->sCatchAllFunction = $mFunction[0];
-			$this->aObjects[$mFunction[0]] = array_slice($mFunction, 1);
-		}
-		else {
-			$this->sCatchAllFunction = $mFunction;
-		}
-	}
-
-	/**
-	 * Registers a PHP function to be called before xajax calls the requested
-	 * function. xajax will automatically add the request function's response
-	 * to the pre-function's response to create a single response. Another
-	 * feature is the ability to return not just a response, but an array with
-	 * the first element being false (a boolean) and the second being the
-	 * response. In this case, the pre-function's response will be returned to
-	 * the browser without xajax calling the requested function.
-	 *
-	 * <i>Usage:</i> <kbd>$xajax->registerPreFunction("myPreFunction");</kbd>
-	 *
-	 * @param string contains the function name or an object callback array
-	 *               ({@link xajax::registerFunction() see registerFunction} for
-	 *               more info on object callback arrays)
-	 */
-	function registerPreFunction($mFunction)
-	{
-		if (is_array($mFunction)) {
-			$this->sPreFunction = $mFunction[0];
-			$this->aObjects[$mFunction[0]] = array_slice($mFunction, 1);
-		}
-		else {
-			$this->sPreFunction = $mFunction;
-		}
-	}
-
-	/**
-	 * Returns true if xajax can process the request, false if otherwise.
-	 * You can use this to determine if xajax needs to process the request or
-	 * not.
-	 *
-	 * @return boolean
-	 */
-	function canProcessRequests()
-	{
-		if ($this->getRequestMode() != -1) return true;
-		return false;
-	}
-
-	/**
-	 * Returns the current request mode (XAJAX_GET or XAJAX_POST), or -1 if
-	 * there is none.
-	 *
-	 * @return mixed
-	 */
-	function getRequestMode()
-	{
-		if (!empty($_GET["xajax"]))
-			return XAJAX_GET;
-
-		if (!empty($_POST["xajax"]))
-			return XAJAX_POST;
-
-		return -1;
-	}
-
-	/**
-	 * This is the main communications engine of xajax. The engine handles all
-	 * incoming xajax requests, calls the apporiate PHP functions (or
-	 * class/object methods) and passes the XML responses back to the
-	 * Javascript response handler. If your RequestURI is the same as your Web
-	 * page then this function should be called before any headers or HTML has
-	 * been sent.
-	 */
-	function processRequests()
-	{
-
-		$requestMode = -1;
-		$sFunctionName = "";
-		$bFoundFunction = true;
-		$bFunctionIsCatchAll = false;
-		$sFunctionNameForSpecial = "";
-		$aArgs = array();
-		$sPreResponse = "";
-		$bEndRequest = false;
-		$sResponse = "";
-
-		$requestMode = $this->getRequestMode();
-		if ($requestMode == -1) return;
-
-		if ($requestMode == XAJAX_POST)
-		{
-			$sFunctionName = $_POST["xajax"];
-
-			if (!empty($_POST["xajaxargs"]))
-				$aArgs = $_POST["xajaxargs"];
-		}
-		else
-		{
-			header ("Expires: Mon, 26 Jul 1997 05:00:00 GMT");
-			header ("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT");
-			header ("Cache-Control: no-cache, must-revalidate");
-			header ("Pragma: no-cache");
-
-			$sFunctionName = $_GET["xajax"];
-
-			if (!empty($_GET["xajaxargs"]))
-				$aArgs = $_GET["xajaxargs"];
-		}
-
-		// Use xajax error handler if necessary
-		if ($this->bErrorHandler) {
-			$GLOBALS['xajaxErrorHandlerText'] = "";
-			set_error_handler("xajaxErrorHandler");
-		}
-
-		if ($this->sPreFunction) {
-			if (!$this->_isFunctionCallable($this->sPreFunction)) {
-				$bFoundFunction = false;
-				$objResponse = new xajaxResponse();
-				$objResponse->addAlert("Unknown Pre-Function ". $this->sPreFunction);
-				$sResponse = $objResponse->getXML();
-			}
-		}
-		//include any external dependencies associated with this function name
-		if (array_key_exists($sFunctionName,$this->aFunctionIncludeFiles))
-		{
-			ob_start();
-			include_once($this->aFunctionIncludeFiles[$sFunctionName]);
-			ob_end_clean();
-		}
-
-		if ($bFoundFunction) {
-			$sFunctionNameForSpecial = $sFunctionName;
-			if (!array_key_exists($sFunctionName, $this->aFunctions))
-			{
-				if ($this->sCatchAllFunction) {
-					$sFunctionName = $this->sCatchAllFunction;
-					$bFunctionIsCatchAll = true;
-				}
-				else {
-					$bFoundFunction = false;
-					$objResponse = new xajaxResponse();
-					$objResponse->addAlert("Unknown Function $sFunctionName.");
-					$sResponse = $objResponse->getXML();
-				}
-			}
-			else if ($this->aFunctionRequestTypes[$sFunctionName] != $requestMode)
-			{
-				$bFoundFunction = false;
-				$objResponse = new xajaxResponse();
-				$objResponse->addAlert("Incorrect Request Type.");
-				$sResponse = $objResponse->getXML();
-			}
-		}
-
-		if ($bFoundFunction)
-		{
-			for ($i = 0; $i < sizeof($aArgs); $i++)
-			{
-				// If magic quotes is on, then we need to strip the slashes from the args
-				if (get_magic_quotes_gpc() == 1 && is_string($aArgs[$i])) {
-
-					$aArgs[$i] = stripslashes($aArgs[$i]);
-				}
-				if (stristr($aArgs[$i],"<xjxobj>") != false)
-				{
-					$aArgs[$i] = $this->_xmlToArray("xjxobj",$aArgs[$i]);
-				}
-				else if (stristr($aArgs[$i],"<xjxquery>") != false)
-				{
-					$aArgs[$i] = $this->_xmlToArray("xjxquery",$aArgs[$i]);
-				}
-				else if ($this->bDecodeUTF8Input)
-				{
-					$aArgs[$i] = $this->_decodeUTF8Data($aArgs[$i]);
-				}
-			}
-
-			if ($this->sPreFunction) {
-				$mPreResponse = $this->_callFunction($this->sPreFunction, array($sFunctionNameForSpecial, $aArgs));
-				if (is_array($mPreResponse) && $mPreResponse[0] === false) {
-					$bEndRequest = true;
-					$sPreResponse = $mPreResponse[1];
-				}
-				else {
-					$sPreResponse = $mPreResponse;
-				}
-				if (is_a($sPreResponse, "xajaxResponse")) {
-					$sPreResponse = $sPreResponse->getXML();
-				}
-				if ($bEndRequest) $sResponse = $sPreResponse;
-			}
-
-			if (!$bEndRequest) {
-				if (!$this->_isFunctionCallable($sFunctionName)) {
-					$objResponse = new xajaxResponse();
-					$objResponse->addAlert("The Registered Function $sFunctionName Could Not Be Found.");
-					$sResponse = $objResponse->getXML();
-				}
-				else {
-					if ($bFunctionIsCatchAll) {
-						$aArgs = array($sFunctionNameForSpecial, $aArgs);
-					}
-					$sResponse = $this->_callFunction($sFunctionName, $aArgs);
-				}
-				if (is_a($sResponse, "xajaxResponse")) {
-					$sResponse = $sResponse->getXML();
-				}
-				if (!is_string($sResponse) || strpos($sResponse, "<xjx>") === FALSE) {
-					$objResponse = new xajaxResponse();
-					$objResponse->addAlert("No XML Response Was Returned By Function $sFunctionName.");
-					$sResponse = $objResponse->getXML();
-				}
-				else if ($sPreResponse != "") {
-					$sNewResponse = new xajaxResponse($this->sEncoding, $this->bOutputEntities);
-					$sNewResponse->loadXML($sPreResponse);
-					$sNewResponse->loadXML($sResponse);
-					$sResponse = $sNewResponse->getXML();
-				}
-			}
-		}
-
-		$sContentHeader = "Content-type: text/xml;";
-		if ($this->sEncoding && strlen(trim($this->sEncoding)) > 0)
-			$sContentHeader .= " charset=".$this->sEncoding;
-		header($sContentHeader);
-		if ($this->bErrorHandler && !empty( $GLOBALS['xajaxErrorHandlerText'] )) {
-			$sErrorResponse = new xajaxResponse();
-			$sErrorResponse->addAlert("** PHP Error Messages: **" . $GLOBALS['xajaxErrorHandlerText']);
-			if ($this->sLogFile) {
-				$fH = @fopen($this->sLogFile, "a");
-				if (!$fH) {
-					$sErrorResponse->addAlert("** Logging Error **\n\nxajax was unable to write to the error log file:\n" . $this->sLogFile);
-				}
-				else {
-					fwrite($fH, "** xajax Error Log - " . strftime("%b %e %Y %I:%M:%S %p") . " **" . $GLOBALS['xajaxErrorHandlerText'] . "\n\n\n");
-					fclose($fH);
-				}
-			}
-
-			$sErrorResponse->loadXML($sResponse);
-			$sResponse = $sErrorResponse->getXML();
-
-		}
-		if ($this->bCleanBuffer) while (@ob_end_clean());
-		print $sResponse;
-		if ($this->bErrorHandler) restore_error_handler();
-
-		if ($this->bExitAllowed)
-			exit();
-	}
-
-	/**
-	 * Prints the xajax Javascript header and wrapper code into your page by
-	 * printing the output of the getJavascript() method. It should only be
-	 * called between the <pre><head> </head></pre> tags in your HTML page.
-	 * Remember, if you only want to obtain the result of this function, use
-	 * {@link xajax::getJavascript()} instead.
-	 *
-	 * <i>Usage:</i>
-	 * <code>
-	 *  <head>
-	 *		...
-	 *		< ?php $xajax->printJavascript(); ? >
-	 * </code>
-	 *
-	 * @param string the relative address of the folder where xajax has been
-	 *               installed. For instance, if your PHP file is
-	 *               "http://www.myserver.com/myfolder/mypage.php"
-	 *               and xajax was installed in
-	 *               "http://www.myserver.com/anotherfolder", then $sJsURI
-	 *               should be set to "../anotherfolder". Defaults to assuming
-	 *               xajax is in the same folder as your PHP file.
-	 * @param string the relative folder/file pair of the xajax Javascript
-	 *               engine located within the xajax installation folder.
-	 *               Defaults to xajax_js/xajax.js.
-	 */
-	function printJavascript($sJsURI="", $sJsFile=NULL)
-	{
-		print $this->getJavascript($sJsURI, $sJsFile);
-	}
-
-	/**
-	 * Returns the xajax Javascript code that should be added to your HTML page
-	 * between the <kbd><head> </head></kbd> tags.
-	 *
-	 * <i>Usage:</i>
-	 * <code>
-	 *  < ?php $xajaxJSHead = $xajax->getJavascript(); ? >
-	 *	<head>
-	 *		...
-	 *		< ?php echo $xajaxJSHead; ? >
-	 * </code>
-	 *
-	 * @param string the relative address of the folder where xajax has been
-	 *               installed. For instance, if your PHP file is
-	 *               "http://www.myserver.com/myfolder/mypage.php"
-	 *               and xajax was installed in
-	 *               "http://www.myserver.com/anotherfolder", then $sJsURI
-	 *               should be set to "../anotherfolder". Defaults to assuming
-	 *               xajax is in the same folder as your PHP file.
-	 * @param string the relative folder/file pair of the xajax Javascript
-	 *               engine located within the xajax installation folder.
-	 *               Defaults to xajax_js/xajax.js.
-	 * @return string
-	 */
-	function getJavascript($sJsURI="", $sJsFile=NULL)
-	{
-		$html = $this->getJavascriptConfig();
-		$html .= $this->getJavascriptInclude($sJsURI, $sJsFile);
-
-		return $html;
-	}
-
-	/**
-	 * Returns a string containing inline Javascript that sets up the xajax
-	 * runtime (typically called internally by xajax from get/printJavascript).
-	 *
-	 * @return string
-	 */
-	function getJavascriptConfig()
-	{
-		$html  = "\t<script type=\"text/javascript\">\n";
-		$html .= "var xajaxRequestUri=\"".$this->sRequestURI."\";\n";
-		$html .= "var xajaxDebug=".($this->bDebug?"true":"false").";\n";
-		$html .= "var xajaxStatusMessages=".($this->bStatusMessages?"true":"false").";\n";
-		$html .= "var xajaxWaitCursor=".($this->bWaitCursor?"true":"false").";\n";
-		$html .= "var xajaxDefinedGet=".XAJAX_GET.";\n";
-		$html .= "var xajaxDefinedPost=".XAJAX_POST.";\n";
-		$html .= "var xajaxLoaded=false;\n";
-
-		foreach($this->aFunctions as $sFunction => $bExists) {
-			$html .= $this->_wrap($sFunction,$this->aFunctionRequestTypes[$sFunction]);
-		}
-
-		$html .= "\t</script>\n";
-		return $html;
-	}
-
-	/**
-	 * Returns a string containing a Javascript include of the xajax.js file
-	 * along with a check to see if the file loaded after six seconds
-	 * (typically called internally by xajax from get/printJavascript).
-	 *
-	 * @param string the relative address of the folder where xajax has been
-	 *               installed. For instance, if your PHP file is
-	 *               "http://www.myserver.com/myfolder/mypage.php"
-	 *               and xajax was installed in
-	 *               "http://www.myserver.com/anotherfolder", then $sJsURI
-	 *               should be set to "../anotherfolder". Defaults to assuming
-	 *               xajax is in the same folder as your PHP file.
-	 * @param string the relative folder/file pair of the xajax Javascript
-	 *               engine located within the xajax installation folder.
-	 *               Defaults to xajax_js/xajax.js.
-	 * @return string
-	 */
-	function getJavascriptInclude($sJsURI="", $sJsFile=NULL)
-	{
-		if ($sJsFile == NULL) $sJsFile = "xajax_js/xajax.js";
-
-		if ($sJsURI != "" && substr($sJsURI, -1) != "/") $sJsURI .= "/";
-
-		$html = "\t<script type=\"text/javascript\" src=\"" . $sJsURI . $sJsFile . "\"></script>\n";
-		$html .= "\t<script type=\"text/javascript\">\n";
-		$html .= "window.setTimeout(function () { if (!xajaxLoaded) { alert('Error: the xajax Javascript file could not be included. Perhaps the URL is incorrect?\\nURL: {$sJsURI}{$sJsFile}'); } }, 6000);\n";
-		$html .= "\t</script>\n";
-		return $html;
-	}
-
-	/**
-	 * This method can be used to create a new xajax.js file out of the
-	 * xajax_uncompressed.js file (which will only happen if xajax.js doesn't
-	 * already exist on the filesystem).
-	 *
-	 * @param string an optional argument containing the full server file path
-	 *               of xajax.js.
-	 */
-	function autoCompressJavascript($sJsFullFilename=NULL)
-	{
-		$sJsFile = "xajax_js/xajax.js";
-
-		if ($sJsFullFilename) {
-			$realJsFile = $sJsFullFilename;
-		}
-		else {
-			$realPath = realpath(dirname(__FILE__));
-			$realJsFile = $realPath . "/". $sJsFile;
-		}
-
-		// Create a compressed file if necessary
-		if (!file_exists($realJsFile)) {
-			$srcFile = str_replace(".js", "_uncompressed.js", $realJsFile);
-			if (!file_exists($srcFile)) {
-				trigger_error("The xajax uncompressed Javascript file could not be found in the <b>" . dirname($realJsFile) . "</b> folder. Error ", E_USER_ERROR);
-			}
-			require(dirname(__FILE__)."/xajaxCompress.php");
-			$javaScript = implode('', file($srcFile));
-			$compressedScript = xajaxCompressJavascript($javaScript);
-			$fH = @fopen($realJsFile, "w");
-			if (!$fH) {
-				trigger_error("The xajax compressed javascript file could not be written in the <b>" . dirname($realJsFile) . "</b> folder. Error ", E_USER_ERROR);
-			}
-			else {
-				fwrite($fH, $compressedScript);
-				fclose($fH);
-			}
-		}
-	}
-
-	/**
-	 * Returns the current URL based upon the SERVER vars.
-	 *
-	 * @access private
-	 * @return string
-	 */
-	function _detectURI() {
-		$aURL = array();
-
-		// Try to get the request URL
-		if (!empty($_SERVER['REQUEST_URI'])) {
-			$aURL = parse_url($_SERVER['REQUEST_URI']);
-		}
-
-		// Fill in the empty values
-		if (empty($aURL['scheme'])) {
-			if (!empty($_SERVER['HTTP_SCHEME'])) {
-				$aURL['scheme'] = $_SERVER['HTTP_SCHEME'];
-			} else {
-				$aURL['scheme'] = (!empty($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) != 'off') ? 'https' : 'http';
-			}
-		}
-
-		if (empty($aURL['host'])) {
-			if (!empty($_SERVER['HTTP_HOST'])) {
-				if (strpos($_SERVER['HTTP_HOST'], ':') > 0) {
-					list($aURL['host'], $aURL['port']) = explode(':', $_SERVER['HTTP_HOST']);
-				} else {
-					$aURL['host'] = $_SERVER['HTTP_HOST'];
-				}
-			} else if (!empty($_SERVER['SERVER_NAME'])) {
-				$aURL['host'] = $_SERVER['SERVER_NAME'];
-			} else {
-				print "xajax Error: xajax failed to automatically identify your Request URI.";
-				print "Please set the Request URI explicitly when you instantiate the xajax object.";
-				exit();
-			}
-		}
-
-		if (empty($aURL['port']) && !empty($_SERVER['SERVER_PORT'])) {
-			$aURL['port'] = $_SERVER['SERVER_PORT'];
-		}
-
-		if (empty($aURL['path'])) {
-			if (!empty($_SERVER['PATH_INFO'])) {
-				$sPath = parse_url($_SERVER['PATH_INFO']);
-			} else {
-				$sPath = parse_url(api_get_self());
-			}
-			$aURL['path'] = $sPath['path'];
-			unset($sPath);
-		}
-
-		if (!empty($aURL['query'])) {
-			$aURL['query'] = '?'.$aURL['query'];
-		}
-
-		// Build the URL: Start with scheme, user and pass
-		$sURL = $aURL['scheme'].'://';
-		if (!empty($aURL['user'])) {
-			$sURL.= $aURL['user'];
-			if (!empty($aURL['pass'])) {
-				$sURL.= ':'.$aURL['pass'];
-			}
-			$sURL.= '@';
-		}
-
-		// Add the host
-		$sURL.= $aURL['host'];
-
-		// Add the port if needed
-		if (!empty($aURL['port']) && (($aURL['scheme'] == 'http' && $aURL['port'] != 80) || ($aURL['scheme'] == 'https' && $aURL['port'] != 443))) {
-			$sURL.= ':'.$aURL['port'];
-		}
-
-		// Add the path and the query string
-		$sURL.= $aURL['path'].@$aURL['query'];
-
-		// Clean up
-		unset($aURL);
-		return $sURL;
-	}
-
-	/**
-	 * Returns true if the function name is associated with an object callback,
-	 * false if not.
-	 *
-	 * @param string the name of the function
-	 * @access private
-	 * @return boolean
-	 */
-	function _isObjectCallback($sFunction)
-	{
-		if (array_key_exists($sFunction, $this->aObjects)) return true;
-		return false;
-	}
-
-	/**
-	 * Returns true if the function or object callback can be called, false if
-	 * not.
-	 *
-	 * @param string the name of the function
-	 * @access private
-	 * @return boolean
-	 */
-	function _isFunctionCallable($sFunction)
-	{
-		if ($this->_isObjectCallback($sFunction)) {
-			if (is_object($this->aObjects[$sFunction][0])) {
-				return method_exists($this->aObjects[$sFunction][0], $this->aObjects[$sFunction][1]);
-			}
-			else {
-				return is_callable($this->aObjects[$sFunction]);
-			}
-		}
-		else {
-			return function_exists($sFunction);
-		}
-	}
-
-	/**
-	 * Calls the function, class method, or object method with the supplied
-	 * arguments.
-	 *
-	 * @param string the name of the function
-	 * @param array  arguments to pass to the function
-	 * @access private
-	 * @return mixed the output of the called function or method
-	 */
-	function _callFunction($sFunction, $aArgs)
-	{
-		if ($this->_isObjectCallback($sFunction)) {
-			$mReturn = call_user_func_array($this->aObjects[$sFunction], $aArgs);
-		}
-		else {
-			$mReturn = call_user_func_array($sFunction, $aArgs);
-		}
-		return $mReturn;
-	}
-
-	/**
-	 * Generates the Javascript wrapper for the specified PHP function.
-	 *
-	 * @param string the name of the function
-	 * @param mixed  the request type
-	 * @access private
-	 * @return string
-	 */
-	function _wrap($sFunction,$sRequestType=XAJAX_POST)
-	{
-		$js = "function ".$this->sWrapperPrefix."$sFunction(){return xajax.call(\"$sFunction\", arguments, ".$sRequestType.");}\n";
-		return $js;
-	}
-
-	/**
-	 * Takes a string containing xajax xjxobj XML or xjxquery XML and builds an
-	 * array representation of it to pass as an argument to the PHP function
-	 * being called.
-	 *
-	 * @param string the root tag of the XML
-	 * @param string XML to convert
-	 * @access private
-	 * @return array
-	 */
-	function _xmlToArray($rootTag, $sXml)
-	{
-		$aArray = array();
-		$sXml = str_replace("<$rootTag>","<$rootTag>|~|",$sXml);
-		$sXml = str_replace("</$rootTag>","</$rootTag>|~|",$sXml);
-		$sXml = str_replace("<e>","<e>|~|",$sXml);
-		$sXml = str_replace("</e>","</e>|~|",$sXml);
-		$sXml = str_replace("<k>","<k>|~|",$sXml);
-		$sXml = str_replace("</k>","|~|</k>|~|",$sXml);
-		$sXml = str_replace("<v>","<v>|~|",$sXml);
-		$sXml = str_replace("</v>","|~|</v>|~|",$sXml);
-		$sXml = str_replace("<q>","<q>|~|",$sXml);
-		$sXml = str_replace("</q>","|~|</q>|~|",$sXml);
-
-		$this->aObjArray = explode("|~|",$sXml);
-
-		$this->iPos = 0;
-		$aArray = $this->_parseObjXml($rootTag);
-
-		return $aArray;
-	}
-
-	/**
-	 * A recursive function that generates an array from the contents of
-	 * $this->aObjArray.
-	 *
-	 * @param string the root tag of the XML
-	 * @access private
-	 * @return array
-	 */
-	function _parseObjXml($rootTag)
-	{
-		$aArray = array();
-
-		if ($rootTag == "xjxobj")
-		{
-			while(!stristr($this->aObjArray[$this->iPos],"</xjxobj>"))
-			{
-				$this->iPos++;
-				if(stristr($this->aObjArray[$this->iPos],"<e>"))
-				{
-					$key = "";
-					$value = null;
-
-					$this->iPos++;
-					while(!stristr($this->aObjArray[$this->iPos],"</e>"))
-					{
-						if(stristr($this->aObjArray[$this->iPos],"<k>"))
-						{
-							$this->iPos++;
-							while(!stristr($this->aObjArray[$this->iPos],"</k>"))
-							{
-								$key .= $this->aObjArray[$this->iPos];
-								$this->iPos++;
-							}
-						}
-						if(stristr($this->aObjArray[$this->iPos],"<v>"))
-						{
-							$this->iPos++;
-							while(!stristr($this->aObjArray[$this->iPos],"</v>"))
-							{
-								if(stristr($this->aObjArray[$this->iPos],"<xjxobj>"))
-								{
-									$value = $this->_parseObjXml("xjxobj");
-									$this->iPos++;
-								}
-								else
-								{
-									$value .= $this->aObjArray[$this->iPos];
-									if ($this->bDecodeUTF8Input)
-									{
-										$value = $this->_decodeUTF8Data($value);
-									}
-								}
-								$this->iPos++;
-							}
-						}
-						$this->iPos++;
-					}
-
-					$aArray[$key]=$value;
-				}
-			}
-		}
-
-		if ($rootTag == "xjxquery")
-		{
-			$sQuery = "";
-			$this->iPos++;
-			while(!stristr($this->aObjArray[$this->iPos],"</xjxquery>"))
-			{
-				if (stristr($this->aObjArray[$this->iPos],"<q>") || stristr($this->aObjArray[$this->iPos],"</q>"))
-				{
-					$this->iPos++;
-					continue;
-				}
-				$sQuery	.= $this->aObjArray[$this->iPos];
-				$this->iPos++;
-			}
-
-			parse_str($sQuery, $aArray);
-			if ($this->bDecodeUTF8Input)
-			{
-				foreach($aArray as $key => $value)
-				{
-					$aArray[$key] = $this->_decodeUTF8Data($value);
-				}
-			}
-			// If magic quotes is on, then we need to strip the slashes from the
-			// array values because of the parse_str pass which adds slashes
-			if (get_magic_quotes_gpc() == 1) {
-				$newArray = array();
-				foreach ($aArray as $sKey => $sValue) {
-					if (is_string($sValue))
-						$newArray[$sKey] = stripslashes($sValue);
-					else
-						$newArray[$sKey] = $sValue;
-				}
-				$aArray = $newArray;
-			}
-		}
-
-		return $aArray;
-	}
-
-	/**
-	 * Decodes string data from UTF-8 to the current xajax encoding.
-	 *
-	 * @param string data to convert
-	 * @access private
-	 * @return string converted data
-	 */
-	function _decodeUTF8Data($sData)
-	{
-		$sValue = $sData;
-		if ($this->bDecodeUTF8Input)
-		{
-			$sFuncToUse = NULL;
-
-			// An adaptation for the Dokeos LMS, 22-AUG-2009.
-			if (function_exists('api_convert_encoding'))
-			{
-				$sFuncToUse = "api_convert_encoding";
-			}
-			//if (function_exists('iconv'))
-			elseif (function_exists('iconv'))
-			//
-			{
-				$sFuncToUse = "iconv";
-			}
-			else if (function_exists('mb_convert_encoding'))
-			{
-				$sFuncToUse = "mb_convert_encoding";
-			}
-			else if ($this->sEncoding == "ISO-8859-1")
-			{
-				$sFuncToUse = "utf8_decode";
-			}
-			else
-			{
-				trigger_error("The incoming xajax data could not be converted from UTF-8", E_USER_NOTICE);
-			}
-
-			if ($sFuncToUse)
-			{
-				if (is_string($sValue))
-				{
-					if ($sFuncToUse == "iconv")
-					{
-						$sValue = iconv("UTF-8", $this->sEncoding.'//TRANSLIT', $sValue);
-					}
-					else if ($sFuncToUse == "mb_convert_encoding")
-					{
-						$sValue = mb_convert_encoding($sValue, $this->sEncoding, "UTF-8");
-					}
-					// Added code, an adaptation for the Dokeos LMS, 22-AUG-2009.
-					else if ($sFuncToUse == "api_convert_encoding")
-					{
-						$sValue = api_convert_encoding($sValue, $this->sEncoding, "UTF-8");
-					}
-					//
-					else
-					{
-						$sValue = utf8_decode($sValue);
-					}
-				}
-			}
-		}
-		return $sValue;
-	}
+    /**
+     * @var array Array of PHP functions that will be callable through javascript wrappers
+     */
+    var $aFunctions;
+    /**
+     * @var array Array of object callbacks that will allow Javascript to call PHP methods (key=function name)
+     */
+    var $aObjects;
+    /**
+     * @var array Array of RequestTypes to be used with each function (key=function name)
+     */
+    var $aFunctionRequestTypes;
+    /**
+     * @var array Array of Include Files for any external functions (key=function name)
+     */
+    var $aFunctionIncludeFiles;
+    /**
+     * @var string Name of the PHP function to call if no callable function was found
+     */
+    var $sCatchAllFunction;
+    /**
+     * @var string Name of the PHP function to call before any other function
+     */
+    var $sPreFunction;
+    /**
+     * @var string The URI for making requests to the xajax object
+     */
+    var $sRequestURI;
+    /**
+     * @var string The prefix to prepend to the javascript wraper function name
+     */
+    var $sWrapperPrefix;
+    /**
+     * @var boolean Show debug messages (default false)
+     */
+    var $bDebug;
+    /**
+     * @var boolean Show messages in the client browser's status bar (default false)
+     */
+    var $bStatusMessages;
+    /**
+     * @var boolean Allow xajax to exit after processing a request (default true)
+     */
+    var $bExitAllowed;
+    /**
+     * @var boolean Use wait cursor in browser (default true)
+     */
+    var $bWaitCursor;
+    /**
+     * @var boolean Use an special xajax error handler so the errors are sent to the browser properly (default false)
+     */
+    var $bErrorHandler;
+    /**
+     * @var string Specify what, if any, file xajax should log errors to (and more information in a future release)
+     */
+    var $sLogFile;
+    /**
+     * @var boolean Clean all output buffers before outputting response (default false)
+     */
+    var $bCleanBuffer;
+    /**
+     * @var string String containing the character encoding used
+     */
+    var $sEncoding;
+    /**
+     * @var boolean Decode input request args from UTF-8 (default false)
+     */
+    var $bDecodeUTF8Input;
+    /**
+     * @var boolean Convert special characters to HTML entities (default false)
+     */
+    var $bOutputEntities;
+    /**
+     * @var array Array for parsing complex objects
+     */
+    var $aObjArray;
+    /**
+     * @var integer Position in $aObjArray
+     */
+    var $iPos;
+
+    /**#@-*/
+
+    /**
+     * Constructor. You can set some extra xajax options right away or use
+     * individual methods later to set options.
+     *
+     * @param string  defaults to the current browser URI
+     * @param string  defaults to "xajax_";
+     * @param string  defaults to XAJAX_DEFAULT_CHAR_ENCODING defined above
+     * @param boolean defaults to false
+     */
+    function xajax($sRequestURI="",$sWrapperPrefix="xajax_",$sEncoding=XAJAX_DEFAULT_CHAR_ENCODING,$bDebug=false)
+    {
+        $this->aFunctions = array();
+        $this->aObjects = array();
+        $this->aFunctionIncludeFiles = array();
+        $this->sRequestURI = $sRequestURI;
+        if ($this->sRequestURI == "")
+            $this->sRequestURI = $this->_detectURI();
+        $this->sWrapperPrefix = $sWrapperPrefix;
+        $this->bDebug = $bDebug;
+        $this->bStatusMessages = false;
+        $this->bWaitCursor = true;
+        $this->bExitAllowed = true;
+        $this->bErrorHandler = false;
+        $this->sLogFile = "";
+        $this->bCleanBuffer = false;
+        $this->setCharEncoding($sEncoding);
+        $this->bDecodeUTF8Input = false;
+        $this->bOutputEntities = false;
+    }
+
+    /**
+     * Sets the URI to which requests will be made.
+     * <i>Usage:</i> <kbd>$xajax->setRequestURI("http://www.xajaxproject.org");</kbd>
+     *
+     * @param string the URI (can be absolute or relative) of the PHP script
+     *               that will be accessed when an xajax request occurs
+     */
+    function setRequestURI($sRequestURI)
+    {
+        $this->sRequestURI = $sRequestURI;
+    }
+
+    /**
+     * Sets the prefix that will be appended to the Javascript wrapper
+     * functions (default is "xajax_").
+     *
+     * @param string
+     */
+    //
+    function setWrapperPrefix($sPrefix)
+    {
+        $this->sWrapperPrefix = $sPrefix;
+    }
+
+    /**
+     * Enables debug messages for xajax.
+     * */
+    function debugOn()
+    {
+        $this->bDebug = true;
+    }
+
+    /**
+     * Disables debug messages for xajax (default behavior).
+     */
+    function debugOff()
+    {
+        $this->bDebug = false;
+    }
+
+    /**
+     * Enables messages in the browser's status bar for xajax.
+     */
+    function statusMessagesOn()
+    {
+        $this->bStatusMessages = true;
+    }
+
+    /**
+     * Disables messages in the browser's status bar for xajax (default behavior).
+     */
+    function statusMessagesOff()
+    {
+        $this->bStatusMessages = false;
+    }
+
+    /**
+     * Enables the wait cursor to be displayed in the browser (default behavior).
+     */
+    function waitCursorOn()
+    {
+        $this->bWaitCursor = true;
+    }
+
+    /**
+     * Disables the wait cursor to be displayed in the browser.
+     */
+    function waitCursorOff()
+    {
+        $this->bWaitCursor = false;
+    }
+
+    /**
+     * Enables xajax to exit immediately after processing a request and
+     * sending the response back to the browser (default behavior).
+     */
+    function exitAllowedOn()
+    {
+        $this->bExitAllowed = true;
+    }
+
+    /**
+     * Disables xajax's default behavior of exiting immediately after
+     * processing a request and sending the response back to the browser.
+     */
+    function exitAllowedOff()
+    {
+        $this->bExitAllowed = false;
+    }
+
+    /**
+     * Turns on xajax's error handling system so that PHP errors that occur
+     * during a request are trapped and pushed to the browser in the form of
+     * a Javascript alert.
+     */
+    function errorHandlerOn()
+    {
+        $this->bErrorHandler = true;
+    }
+
+    /**
+     * Turns off xajax's error handling system (default behavior).
+     */
+    function errorHandlerOff()
+    {
+        $this->bErrorHandler = false;
+    }
+
+    /**
+     * Specifies a log file that will be written to by xajax during a request
+     * (used only by the error handling system at present). If you don't invoke
+     * this method, or you pass in "", then no log file will be written to.
+     * <i>Usage:</i> <kbd>$xajax->setLogFile("/xajax_logs/errors.log");</kbd>
+     */
+    function setLogFile($sFilename)
+    {
+        $this->sLogFile = $sFilename;
+    }
+
+    /**
+     * Causes xajax to clean out all output buffers before outputting a
+     * response (default behavior).
+     */
+    function cleanBufferOn()
+    {
+        $this->bCleanBuffer = true;
+    }
+    /**
+     * Turns off xajax's output buffer cleaning.
+     */
+    function cleanBufferOff()
+    {
+        $this->bCleanBuffer = false;
+    }
+
+    /**
+     * Sets the character encoding for the HTTP output based on
+     * <kbd>$sEncoding</kbd>, which is a string containing the character
+     * encoding to use. You don't need to use this method normally, since the
+     * character encoding for the response gets set automatically based on the
+     * <kbd>XAJAX_DEFAULT_CHAR_ENCODING</kbd> constant.
+     * <i>Usage:</i> <kbd>$xajax->setCharEncoding("utf-8");</kbd>
+     *
+     * @param string the encoding type to use (utf-8, iso-8859-1, etc.)
+     */
+    function setCharEncoding($sEncoding)
+    {
+        $this->sEncoding = $sEncoding;
+    }
+
+    /**
+     * Causes xajax to decode the input request args from UTF-8 to the current
+     * encoding if possible. Either the iconv or mb_string extension must be
+     * present for optimal functionality.
+     */
+    function decodeUTF8InputOn()
+    {
+        $this->bDecodeUTF8Input = true;
+    }
+
+    /**
+     * Turns off decoding the input request args from UTF-8 (default behavior).
+     */
+    function decodeUTF8InputOff()
+    {
+        $this->bDecodeUTF8Input = false;
+    }
+
+    /**
+     * Tells the response object to convert special characters to HTML entities
+     * automatically (only works if the mb_string extension is available).
+     */
+    function outputEntitiesOn()
+    {
+        $this->bOutputEntities = true;
+    }
+
+    /**
+     * Tells the response object to output special characters intact. (default
+     * behavior).
+     */
+    function outputEntitiesOff()
+    {
+        $this->bOutputEntities = false;
+    }
+
+    /**
+     * Registers a PHP function or method to be callable through xajax in your
+     * Javascript. If you want to register a function, pass in the name of that
+     * function. If you want to register a static class method, pass in an
+     * array like so:
+     * <kbd>array("myFunctionName", "myClass", "myMethod")</kbd>
+     * For an object instance method, use an object variable for the second
+     * array element (and in PHP 4 make sure you put an & before the variable
+     * to pass the object by reference). Note: the function name is what you
+     * call via Javascript, so it can be anything as long as it doesn't
+     * conflict with any other registered function name.
+     *
+     * <i>Usage:</i> <kbd>$xajax->registerFunction("myFunction");</kbd>
+     * or: <kbd>$xajax->registerFunction(array("myFunctionName", &$myObject, "myMethod"));</kbd>
+     *
+     * @param mixed  contains the function name or an object callback array
+     * @param mixed  request type (XAJAX_GET/XAJAX_POST) that should be used
+     *               for this function.  Defaults to XAJAX_POST.
+     */
+    function registerFunction($mFunction,$sRequestType=XAJAX_POST)
+    {
+        if (is_array($mFunction)) {
+            $this->aFunctions[$mFunction[0]] = 1;
+            $this->aFunctionRequestTypes[$mFunction[0]] = $sRequestType;
+            $this->aObjects[$mFunction[0]] = array_slice($mFunction, 1);
+        }
+        else {
+            $this->aFunctions[$mFunction] = 1;
+            $this->aFunctionRequestTypes[$mFunction] = $sRequestType;
+        }
+    }
+
+    /**
+     * Registers a PHP function to be callable through xajax which is located
+     * in some other file.  If the function is requested the external file will
+     * be included to define the function before the function is called.
+     *
+     * <i>Usage:</i> <kbd>$xajax->registerExternalFunction("myFunction","myFunction.inc.php",XAJAX_POST);</kbd>
+     *
+     * @param string contains the function name or an object callback array
+     *               ({@link xajax::registerFunction() see registerFunction} for
+     *               more info on object callback arrays)
+     * @param string contains the path and filename of the include file
+     * @param mixed  the RequestType (XAJAX_GET/XAJAX_POST) that should be used
+     *		          for this function. Defaults to XAJAX_POST.
+     */
+    function registerExternalFunction($mFunction,$sIncludeFile,$sRequestType=XAJAX_POST)
+    {
+        $this->registerFunction($mFunction, $sRequestType);
+
+        if (is_array($mFunction)) {
+            $this->aFunctionIncludeFiles[$mFunction[0]] = $sIncludeFile;
+        }
+        else {
+            $this->aFunctionIncludeFiles[$mFunction] = $sIncludeFile;
+        }
+    }
+
+    /**
+     * Registers a PHP function to be called when xajax cannot find the
+     * function being called via Javascript. Because this is technically
+     * impossible when using "wrapped" functions, the catch-all feature is
+     * only useful when you're directly using the xajax.call() Javascript
+     * method. Use the catch-all feature when you want more dynamic ability to
+     * intercept unknown calls and handle them in a custom way.
+     *
+     * <i>Usage:</i> <kbd>$xajax->registerCatchAllFunction("myCatchAllFunction");</kbd>
+     *
+     * @param string contains the function name or an object callback array
+     *               ({@link xajax::registerFunction() see registerFunction} for
+     *               more info on object callback arrays)
+     */
+    function registerCatchAllFunction($mFunction)
+    {
+        if (is_array($mFunction)) {
+            $this->sCatchAllFunction = $mFunction[0];
+            $this->aObjects[$mFunction[0]] = array_slice($mFunction, 1);
+        }
+        else {
+            $this->sCatchAllFunction = $mFunction;
+        }
+    }
+
+    /**
+     * Registers a PHP function to be called before xajax calls the requested
+     * function. xajax will automatically add the request function's response
+     * to the pre-function's response to create a single response. Another
+     * feature is the ability to return not just a response, but an array with
+     * the first element being false (a boolean) and the second being the
+     * response. In this case, the pre-function's response will be returned to
+     * the browser without xajax calling the requested function.
+     *
+     * <i>Usage:</i> <kbd>$xajax->registerPreFunction("myPreFunction");</kbd>
+     *
+     * @param string contains the function name or an object callback array
+     *               ({@link xajax::registerFunction() see registerFunction} for
+     *               more info on object callback arrays)
+     */
+    function registerPreFunction($mFunction)
+    {
+        if (is_array($mFunction)) {
+            $this->sPreFunction = $mFunction[0];
+            $this->aObjects[$mFunction[0]] = array_slice($mFunction, 1);
+        }
+        else {
+            $this->sPreFunction = $mFunction;
+        }
+    }
+
+    /**
+     * Returns true if xajax can process the request, false if otherwise.
+     * You can use this to determine if xajax needs to process the request or
+     * not.
+     *
+     * @return boolean
+     */
+    function canProcessRequests()
+    {
+        if ($this->getRequestMode() != -1) return true;
+        return false;
+    }
+
+    /**
+     * Returns the current request mode (XAJAX_GET or XAJAX_POST), or -1 if
+     * there is none.
+     *
+     * @return mixed
+     */
+    function getRequestMode()
+    {
+        if (!empty($_GET["xajax"]))
+            return XAJAX_GET;
+
+        if (!empty($_POST["xajax"]))
+            return XAJAX_POST;
+
+        return -1;
+    }
+
+    /**
+     * This is the main communications engine of xajax. The engine handles all
+     * incoming xajax requests, calls the apporiate PHP functions (or
+     * class/object methods) and passes the XML responses back to the
+     * Javascript response handler. If your RequestURI is the same as your Web
+     * page then this function should be called before any headers or HTML has
+     * been sent.
+     */
+    function processRequests()
+    {
+
+        $requestMode = -1;
+        $sFunctionName = "";
+        $bFoundFunction = true;
+        $bFunctionIsCatchAll = false;
+        $sFunctionNameForSpecial = "";
+        $aArgs = array();
+        $sPreResponse = "";
+        $bEndRequest = false;
+        $sResponse = "";
+
+        $requestMode = $this->getRequestMode();
+        if ($requestMode == -1) return;
+
+        if ($requestMode == XAJAX_POST)
+        {
+            $sFunctionName = $_POST["xajax"];
+
+            if (!empty($_POST["xajaxargs"]))
+                $aArgs = $_POST["xajaxargs"];
+        }
+        else
+        {
+            header ("Expires: Mon, 26 Jul 1997 05:00:00 GMT");
+            header ("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT");
+            header ("Cache-Control: no-cache, must-revalidate");
+            header ("Pragma: no-cache");
+
+            $sFunctionName = $_GET["xajax"];
+
+            if (!empty($_GET["xajaxargs"]))
+                $aArgs = $_GET["xajaxargs"];
+        }
+
+        // Use xajax error handler if necessary
+        if ($this->bErrorHandler) {
+            $GLOBALS['xajaxErrorHandlerText'] = "";
+            set_error_handler("xajaxErrorHandler");
+        }
+
+        if ($this->sPreFunction) {
+            if (!$this->_isFunctionCallable($this->sPreFunction)) {
+                $bFoundFunction = false;
+                $objResponse = new xajaxResponse();
+                $objResponse->addAlert("Unknown Pre-Function ". $this->sPreFunction);
+                $sResponse = $objResponse->getXML();
+            }
+        }
+        //include any external dependencies associated with this function name
+        if (array_key_exists($sFunctionName,$this->aFunctionIncludeFiles))
+        {
+            ob_start();
+            include_once($this->aFunctionIncludeFiles[$sFunctionName]);
+            ob_end_clean();
+        }
+
+        if ($bFoundFunction) {
+            $sFunctionNameForSpecial = $sFunctionName;
+            if (!array_key_exists($sFunctionName, $this->aFunctions))
+            {
+                if ($this->sCatchAllFunction) {
+                    $sFunctionName = $this->sCatchAllFunction;
+                    $bFunctionIsCatchAll = true;
+                }
+                else {
+                    $bFoundFunction = false;
+                    $objResponse = new xajaxResponse();
+                    $objResponse->addAlert("Unknown Function $sFunctionName.");
+                    $sResponse = $objResponse->getXML();
+                }
+            }
+            else if ($this->aFunctionRequestTypes[$sFunctionName] != $requestMode)
+            {
+                $bFoundFunction = false;
+                $objResponse = new xajaxResponse();
+                $objResponse->addAlert("Incorrect Request Type.");
+                $sResponse = $objResponse->getXML();
+            }
+        }
+
+        if ($bFoundFunction)
+        {
+            for ($i = 0; $i < sizeof($aArgs); $i++)
+            {
+                // If magic quotes is on, then we need to strip the slashes from the args
+                if (get_magic_quotes_gpc() == 1 && is_string($aArgs[$i])) {
+
+                    $aArgs[$i] = stripslashes($aArgs[$i]);
+                }
+                if (stristr($aArgs[$i],"<xjxobj>") != false)
+                {
+                    $aArgs[$i] = $this->_xmlToArray("xjxobj",$aArgs[$i]);
+                }
+                else if (stristr($aArgs[$i],"<xjxquery>") != false)
+                {
+                    $aArgs[$i] = $this->_xmlToArray("xjxquery",$aArgs[$i]);
+                }
+                else if ($this->bDecodeUTF8Input)
+                {
+                    $aArgs[$i] = $this->_decodeUTF8Data($aArgs[$i]);
+                }
+            }
+
+            if ($this->sPreFunction) {
+                $mPreResponse = $this->_callFunction($this->sPreFunction, array($sFunctionNameForSpecial, $aArgs));
+                if (is_array($mPreResponse) && $mPreResponse[0] === false) {
+                    $bEndRequest = true;
+                    $sPreResponse = $mPreResponse[1];
+                }
+                else {
+                    $sPreResponse = $mPreResponse;
+                }
+                if (is_a($sPreResponse, "xajaxResponse")) {
+                    $sPreResponse = $sPreResponse->getXML();
+                }
+                if ($bEndRequest) $sResponse = $sPreResponse;
+            }
+
+            if (!$bEndRequest) {
+                if (!$this->_isFunctionCallable($sFunctionName)) {
+                    $objResponse = new xajaxResponse();
+                    $objResponse->addAlert("The Registered Function $sFunctionName Could Not Be Found.");
+                    $sResponse = $objResponse->getXML();
+                }
+                else {
+                    if ($bFunctionIsCatchAll) {
+                        $aArgs = array($sFunctionNameForSpecial, $aArgs);
+                    }
+                    $sResponse = $this->_callFunction($sFunctionName, $aArgs);
+                }
+                if (is_a($sResponse, "xajaxResponse")) {
+                    $sResponse = $sResponse->getXML();
+                }
+                if (!is_string($sResponse) || strpos($sResponse, "<xjx>") === FALSE) {
+                    $objResponse = new xajaxResponse();
+                    $objResponse->addAlert("No XML Response Was Returned By Function $sFunctionName.");
+                    $sResponse = $objResponse->getXML();
+                }
+                else if ($sPreResponse != "") {
+                    $sNewResponse = new xajaxResponse($this->sEncoding, $this->bOutputEntities);
+                    $sNewResponse->loadXML($sPreResponse);
+                    $sNewResponse->loadXML($sResponse);
+                    $sResponse = $sNewResponse->getXML();
+                }
+            }
+        }
+
+        $sContentHeader = "Content-type: text/xml;";
+        if ($this->sEncoding && strlen(trim($this->sEncoding)) > 0)
+            $sContentHeader .= " charset=".$this->sEncoding;
+        header($sContentHeader);
+        if ($this->bErrorHandler && !empty( $GLOBALS['xajaxErrorHandlerText'] )) {
+            $sErrorResponse = new xajaxResponse();
+            $sErrorResponse->addAlert("** PHP Error Messages: **" . $GLOBALS['xajaxErrorHandlerText']);
+            if ($this->sLogFile) {
+                $fH = @fopen($this->sLogFile, "a");
+                if (!$fH) {
+                    $sErrorResponse->addAlert("** Logging Error **\n\nxajax was unable to write to the error log file:\n" . $this->sLogFile);
+                }
+                else {
+                    fwrite($fH, "** xajax Error Log - " . strftime("%b %e %Y %I:%M:%S %p") . " **" . $GLOBALS['xajaxErrorHandlerText'] . "\n\n\n");
+                    fclose($fH);
+                }
+            }
+
+            $sErrorResponse->loadXML($sResponse);
+            $sResponse = $sErrorResponse->getXML();
+
+        }
+        if ($this->bCleanBuffer) while (@ob_end_clean());
+        print $sResponse;
+        if ($this->bErrorHandler) restore_error_handler();
+
+        if ($this->bExitAllowed)
+            exit();
+    }
+
+    /**
+     * Prints the xajax Javascript header and wrapper code into your page by
+     * printing the output of the getJavascript() method. It should only be
+     * called between the <pre><head> </head></pre> tags in your HTML page.
+     * Remember, if you only want to obtain the result of this function, use
+     * {@link xajax::getJavascript()} instead.
+     *
+     * <i>Usage:</i>
+     * <code>
+     *  <head>
+     *		...
+     *		< ?php $xajax->printJavascript(); ? >
+     * </code>
+     *
+     * @param string the relative address of the folder where xajax has been
+     *               installed. For instance, if your PHP file is
+     *               "http://www.myserver.com/myfolder/mypage.php"
+     *               and xajax was installed in
+     *               "http://www.myserver.com/anotherfolder", then $sJsURI
+     *               should be set to "../anotherfolder". Defaults to assuming
+     *               xajax is in the same folder as your PHP file.
+     * @param string the relative folder/file pair of the xajax Javascript
+     *               engine located within the xajax installation folder.
+     *               Defaults to xajax_js/xajax.js.
+     */
+    function printJavascript($sJsURI="", $sJsFile=NULL)
+    {
+        print $this->getJavascript($sJsURI, $sJsFile);
+    }
+
+    /**
+     * Returns the xajax Javascript code that should be added to your HTML page
+     * between the <kbd><head> </head></kbd> tags.
+     *
+     * <i>Usage:</i>
+     * <code>
+     *  < ?php $xajaxJSHead = $xajax->getJavascript(); ? >
+     *	<head>
+     *		...
+     *		< ?php echo $xajaxJSHead; ? >
+     * </code>
+     *
+     * @param string the relative address of the folder where xajax has been
+     *               installed. For instance, if your PHP file is
+     *               "http://www.myserver.com/myfolder/mypage.php"
+     *               and xajax was installed in
+     *               "http://www.myserver.com/anotherfolder", then $sJsURI
+     *               should be set to "../anotherfolder". Defaults to assuming
+     *               xajax is in the same folder as your PHP file.
+     * @param string the relative folder/file pair of the xajax Javascript
+     *               engine located within the xajax installation folder.
+     *               Defaults to xajax_js/xajax.js.
+     * @return string
+     */
+    function getJavascript($sJsURI="", $sJsFile=NULL)
+    {
+        $html = $this->getJavascriptConfig();
+        $html .= $this->getJavascriptInclude($sJsURI, $sJsFile);
+
+        return $html;
+    }
+
+    /**
+     * Returns a string containing inline Javascript that sets up the xajax
+     * runtime (typically called internally by xajax from get/printJavascript).
+     *
+     * @return string
+     */
+    function getJavascriptConfig()
+    {
+        $html  = "\t<script type=\"text/javascript\">\n";
+        $html .= "var xajaxRequestUri=\"".$this->sRequestURI."\";\n";
+        $html .= "var xajaxDebug=".($this->bDebug?"true":"false").";\n";
+        $html .= "var xajaxStatusMessages=".($this->bStatusMessages?"true":"false").";\n";
+        $html .= "var xajaxWaitCursor=".($this->bWaitCursor?"true":"false").";\n";
+        $html .= "var xajaxDefinedGet=".XAJAX_GET.";\n";
+        $html .= "var xajaxDefinedPost=".XAJAX_POST.";\n";
+        $html .= "var xajaxLoaded=false;\n";
+
+        foreach($this->aFunctions as $sFunction => $bExists) {
+            $html .= $this->_wrap($sFunction,$this->aFunctionRequestTypes[$sFunction]);
+        }
+
+        $html .= "\t</script>\n";
+        return $html;
+    }
+
+    /**
+     * Returns a string containing a Javascript include of the xajax.js file
+     * along with a check to see if the file loaded after six seconds
+     * (typically called internally by xajax from get/printJavascript).
+     *
+     * @param string the relative address of the folder where xajax has been
+     *               installed. For instance, if your PHP file is
+     *               "http://www.myserver.com/myfolder/mypage.php"
+     *               and xajax was installed in
+     *               "http://www.myserver.com/anotherfolder", then $sJsURI
+     *               should be set to "../anotherfolder". Defaults to assuming
+     *               xajax is in the same folder as your PHP file.
+     * @param string the relative folder/file pair of the xajax Javascript
+     *               engine located within the xajax installation folder.
+     *               Defaults to xajax_js/xajax.js.
+     * @return string
+     */
+    function getJavascriptInclude($sJsURI="", $sJsFile=NULL)
+    {
+        if ($sJsFile == NULL) $sJsFile = "xajax_js/xajax.js";
+
+        if ($sJsURI != "" && substr($sJsURI, -1) != "/") $sJsURI .= "/";
+
+        $html = "\t<script type=\"text/javascript\" src=\"" . $sJsURI . $sJsFile . "\"></script>\n";
+        $html .= "\t<script type=\"text/javascript\">\n";
+        $html .= "window.setTimeout(function () { if (!xajaxLoaded) { alert('Error: the xajax Javascript file could not be included. Perhaps the URL is incorrect?\\nURL: {$sJsURI}{$sJsFile}'); } }, 6000);\n";
+        $html .= "\t</script>\n";
+        return $html;
+    }
+
+    /**
+     * This method can be used to create a new xajax.js file out of the
+     * xajax_uncompressed.js file (which will only happen if xajax.js doesn't
+     * already exist on the filesystem).
+     *
+     * @param string an optional argument containing the full server file path
+     *               of xajax.js.
+     */
+    function autoCompressJavascript($sJsFullFilename=NULL)
+    {
+        $sJsFile = "xajax_js/xajax.js";
+
+        if ($sJsFullFilename) {
+            $realJsFile = $sJsFullFilename;
+        }
+        else {
+            $realPath = realpath(dirname(__FILE__));
+            $realJsFile = $realPath . "/". $sJsFile;
+        }
+
+        // Create a compressed file if necessary
+        if (!file_exists($realJsFile)) {
+            $srcFile = str_replace(".js", "_uncompressed.js", $realJsFile);
+            if (!file_exists($srcFile)) {
+                trigger_error("The xajax uncompressed Javascript file could not be found in the <b>" . dirname($realJsFile) . "</b> folder. Error ", E_USER_ERROR);
+            }
+            require(dirname(__FILE__)."/xajaxCompress.php");
+            $javaScript = implode('', file($srcFile));
+            $compressedScript = xajaxCompressJavascript($javaScript);
+            $fH = @fopen($realJsFile, "w");
+            if (!$fH) {
+                trigger_error("The xajax compressed javascript file could not be written in the <b>" . dirname($realJsFile) . "</b> folder. Error ", E_USER_ERROR);
+            }
+            else {
+                fwrite($fH, $compressedScript);
+                fclose($fH);
+            }
+        }
+    }
+
+    /**
+     * Returns the current URL based upon the SERVER vars.
+     *
+     * @access private
+     * @return string
+     */
+    function _detectURI() {
+        $aURL = array();
+
+        // Try to get the request URL
+        if (!empty($_SERVER['REQUEST_URI'])) {
+            $aURL = parse_url($_SERVER['REQUEST_URI']);
+        }
+
+        // Fill in the empty values
+        if (empty($aURL['scheme'])) {
+            if (!empty($_SERVER['HTTP_SCHEME'])) {
+                $aURL['scheme'] = $_SERVER['HTTP_SCHEME'];
+            } else {
+                $aURL['scheme'] = (!empty($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) != 'off') ? 'https' : 'http';
+            }
+        }
+
+        if (empty($aURL['host'])) {
+            if (!empty($_SERVER['HTTP_HOST'])) {
+                if (strpos($_SERVER['HTTP_HOST'], ':') > 0) {
+                    list($aURL['host'], $aURL['port']) = explode(':', $_SERVER['HTTP_HOST']);
+                } else {
+                    $aURL['host'] = $_SERVER['HTTP_HOST'];
+                }
+            } else if (!empty($_SERVER['SERVER_NAME'])) {
+                $aURL['host'] = $_SERVER['SERVER_NAME'];
+            } else {
+                print "xajax Error: xajax failed to automatically identify your Request URI.";
+                print "Please set the Request URI explicitly when you instantiate the xajax object.";
+                exit();
+            }
+        }
+
+        if (empty($aURL['port']) && !empty($_SERVER['SERVER_PORT'])) {
+            $aURL['port'] = $_SERVER['SERVER_PORT'];
+        }
+
+        if (empty($aURL['path'])) {
+            if (!empty($_SERVER['PATH_INFO'])) {
+                $sPath = parse_url($_SERVER['PATH_INFO']);
+            } else {
+                $sPath = parse_url(api_get_self());
+            }
+            $aURL['path'] = $sPath['path'];
+            unset($sPath);
+        }
+
+        if (!empty($aURL['query'])) {
+            $aURL['query'] = '?'.$aURL['query'];
+        }
+
+        // Build the URL: Start with scheme, user and pass
+        $sURL = $aURL['scheme'].'://';
+        if (!empty($aURL['user'])) {
+            $sURL.= $aURL['user'];
+            if (!empty($aURL['pass'])) {
+                $sURL.= ':'.$aURL['pass'];
+            }
+            $sURL.= '@';
+        }
+
+        // Add the host
+        $sURL.= $aURL['host'];
+
+        // Add the port if needed
+        if (!empty($aURL['port']) && (($aURL['scheme'] == 'http' && $aURL['port'] != 80) || ($aURL['scheme'] == 'https' && $aURL['port'] != 443))) {
+            $sURL.= ':'.$aURL['port'];
+        }
+
+        // Add the path and the query string
+        $sURL.= $aURL['path'].@$aURL['query'];
+
+        // Clean up
+        unset($aURL);
+        return $sURL;
+    }
+
+    /**
+     * Returns true if the function name is associated with an object callback,
+     * false if not.
+     *
+     * @param string the name of the function
+     * @access private
+     * @return boolean
+     */
+    function _isObjectCallback($sFunction)
+    {
+        if (array_key_exists($sFunction, $this->aObjects)) return true;
+        return false;
+    }
+
+    /**
+     * Returns true if the function or object callback can be called, false if
+     * not.
+     *
+     * @param string the name of the function
+     * @access private
+     * @return boolean
+     */
+    function _isFunctionCallable($sFunction)
+    {
+        if ($this->_isObjectCallback($sFunction)) {
+            if (is_object($this->aObjects[$sFunction][0])) {
+                return method_exists($this->aObjects[$sFunction][0], $this->aObjects[$sFunction][1]);
+            }
+            else {
+                return is_callable($this->aObjects[$sFunction]);
+            }
+        }
+        else {
+            return function_exists($sFunction);
+        }
+    }
+
+    /**
+     * Calls the function, class method, or object method with the supplied
+     * arguments.
+     *
+     * @param string the name of the function
+     * @param array  arguments to pass to the function
+     * @access private
+     * @return mixed the output of the called function or method
+     */
+    function _callFunction($sFunction, $aArgs)
+    {
+        if ($this->_isObjectCallback($sFunction)) {
+            $mReturn = call_user_func_array($this->aObjects[$sFunction], $aArgs);
+        }
+        else {
+            $mReturn = call_user_func_array($sFunction, $aArgs);
+        }
+        return $mReturn;
+    }
+
+    /**
+     * Generates the Javascript wrapper for the specified PHP function.
+     *
+     * @param string the name of the function
+     * @param mixed  the request type
+     * @access private
+     * @return string
+     */
+    function _wrap($sFunction,$sRequestType=XAJAX_POST)
+    {
+        $js = "function ".$this->sWrapperPrefix."$sFunction(){return xajax.call(\"$sFunction\", arguments, ".$sRequestType.");}\n";
+        return $js;
+    }
+
+    /**
+     * Takes a string containing xajax xjxobj XML or xjxquery XML and builds an
+     * array representation of it to pass as an argument to the PHP function
+     * being called.
+     *
+     * @param string the root tag of the XML
+     * @param string XML to convert
+     * @access private
+     * @return array
+     */
+    function _xmlToArray($rootTag, $sXml)
+    {
+        $aArray = array();
+        $sXml = str_replace("<$rootTag>","<$rootTag>|~|",$sXml);
+        $sXml = str_replace("</$rootTag>","</$rootTag>|~|",$sXml);
+        $sXml = str_replace("<e>","<e>|~|",$sXml);
+        $sXml = str_replace("</e>","</e>|~|",$sXml);
+        $sXml = str_replace("<k>","<k>|~|",$sXml);
+        $sXml = str_replace("</k>","|~|</k>|~|",$sXml);
+        $sXml = str_replace("<v>","<v>|~|",$sXml);
+        $sXml = str_replace("</v>","|~|</v>|~|",$sXml);
+        $sXml = str_replace("<q>","<q>|~|",$sXml);
+        $sXml = str_replace("</q>","|~|</q>|~|",$sXml);
+
+        $this->aObjArray = explode("|~|",$sXml);
+
+        $this->iPos = 0;
+        $aArray = $this->_parseObjXml($rootTag);
+
+        return $aArray;
+    }
+
+    /**
+     * A recursive function that generates an array from the contents of
+     * $this->aObjArray.
+     *
+     * @param string the root tag of the XML
+     * @access private
+     * @return array
+     */
+    function _parseObjXml($rootTag)
+    {
+        $aArray = array();
+
+        if ($rootTag == "xjxobj")
+        {
+            while(!stristr($this->aObjArray[$this->iPos],"</xjxobj>"))
+            {
+                $this->iPos++;
+                if(stristr($this->aObjArray[$this->iPos],"<e>"))
+                {
+                    $key = "";
+                    $value = null;
+
+                    $this->iPos++;
+                    while(!stristr($this->aObjArray[$this->iPos],"</e>"))
+                    {
+                        if(stristr($this->aObjArray[$this->iPos],"<k>"))
+                        {
+                            $this->iPos++;
+                            while(!stristr($this->aObjArray[$this->iPos],"</k>"))
+                            {
+                                $key .= $this->aObjArray[$this->iPos];
+                                $this->iPos++;
+                            }
+                        }
+                        if(stristr($this->aObjArray[$this->iPos],"<v>"))
+                        {
+                            $this->iPos++;
+                            while(!stristr($this->aObjArray[$this->iPos],"</v>"))
+                            {
+                                if(stristr($this->aObjArray[$this->iPos],"<xjxobj>"))
+                                {
+                                    $value = $this->_parseObjXml("xjxobj");
+                                    $this->iPos++;
+                                }
+                                else
+                                {
+                                    $value .= $this->aObjArray[$this->iPos];
+                                    if ($this->bDecodeUTF8Input)
+                                    {
+                                        $value = $this->_decodeUTF8Data($value);
+                                    }
+                                }
+                                $this->iPos++;
+                            }
+                        }
+                        $this->iPos++;
+                    }
+
+                    $aArray[$key]=$value;
+                }
+            }
+        }
+
+        if ($rootTag == "xjxquery")
+        {
+            $sQuery = "";
+            $this->iPos++;
+            while(!stristr($this->aObjArray[$this->iPos],"</xjxquery>"))
+            {
+                if (stristr($this->aObjArray[$this->iPos],"<q>") || stristr($this->aObjArray[$this->iPos],"</q>"))
+                {
+                    $this->iPos++;
+                    continue;
+                }
+                $sQuery	.= $this->aObjArray[$this->iPos];
+                $this->iPos++;
+            }
+
+            parse_str($sQuery, $aArray);
+            if ($this->bDecodeUTF8Input)
+            {
+                foreach($aArray as $key => $value)
+                {
+                    $aArray[$key] = $this->_decodeUTF8Data($value);
+                }
+            }
+            // If magic quotes is on, then we need to strip the slashes from the
+            // array values because of the parse_str pass which adds slashes
+            if (get_magic_quotes_gpc() == 1) {
+                $newArray = array();
+                foreach ($aArray as $sKey => $sValue) {
+                    if (is_string($sValue))
+                        $newArray[$sKey] = stripslashes($sValue);
+                    else
+                        $newArray[$sKey] = $sValue;
+                }
+                $aArray = $newArray;
+            }
+        }
+
+        return $aArray;
+    }
+
+    /**
+     * Decodes string data from UTF-8 to the current xajax encoding.
+     *
+     * @param string data to convert
+     * @access private
+     * @return string converted data
+     */
+    function _decodeUTF8Data($sData)
+    {
+        $sValue = $sData;
+        if ($this->bDecodeUTF8Input)
+        {
+            $sFuncToUse = NULL;
+
+            // An adaptation for the Dokeos LMS, 22-AUG-2009.
+            if (function_exists('api_convert_encoding'))
+            {
+                $sFuncToUse = "api_convert_encoding";
+            }
+            //if (function_exists('iconv'))
+            elseif (function_exists('iconv'))
+            //
+            {
+                $sFuncToUse = "iconv";
+            }
+            else if (function_exists('mb_convert_encoding'))
+            {
+                $sFuncToUse = "mb_convert_encoding";
+            }
+            else if ($this->sEncoding == "ISO-8859-1")
+            {
+                $sFuncToUse = "utf8_decode";
+            }
+            else
+            {
+                trigger_error("The incoming xajax data could not be converted from UTF-8", E_USER_NOTICE);
+            }
+
+            if ($sFuncToUse)
+            {
+                if (is_string($sValue))
+                {
+                    if ($sFuncToUse == "iconv")
+                    {
+                        $sValue = iconv("UTF-8", $this->sEncoding.'//TRANSLIT', $sValue);
+                    }
+                    else if ($sFuncToUse == "mb_convert_encoding")
+                    {
+                        $sValue = mb_convert_encoding($sValue, $this->sEncoding, "UTF-8");
+                    }
+                    // Added code, an adaptation for the Dokeos LMS, 22-AUG-2009.
+                    else if ($sFuncToUse == "api_convert_encoding")
+                    {
+                        $sValue = api_convert_encoding($sValue, $this->sEncoding, "UTF-8");
+                    }
+                    //
+                    else
+                    {
+                        $sValue = utf8_decode($sValue);
+                    }
+                }
+            }
+        }
+        return $sValue;
+    }
 
 }// end class xajax
 
@@ -1220,31 +1220,31 @@ 
  */
 function xajaxErrorHandler($errno, $errstr, $errfile, $errline)
 {
-	$errorReporting = error_reporting();
-	if (($errno & $errorReporting) == 0) return;
-
-	if ($errno == E_NOTICE) {
-		$errTypeStr = "NOTICE";
-	}
-	else if ($errno == E_WARNING) {
-		$errTypeStr = "WARNING";
-	}
-	else if ($errno == E_USER_NOTICE) {
-		$errTypeStr = "USER NOTICE";
-	}
-	else if ($errno == E_USER_WARNING) {
-		$errTypeStr = "USER WARNING";
-	}
-	else if ($errno == E_USER_ERROR) {
-		$errTypeStr = "USER FATAL ERROR";
-	}
-	else if ($errno == E_STRICT) {
-		return;
-	}
-	else {
-		$errTypeStr = "UNKNOWN: $errno";
-	}
-	$GLOBALS['xajaxErrorHandlerText'] .= "\n----\n[$errTypeStr] $errstr\nerror in line $errline of file $errfile";
+    $errorReporting = error_reporting();
+    if (($errno & $errorReporting) == 0) return;
+
+    if ($errno == E_NOTICE) {
+        $errTypeStr = "NOTICE";
+    }
+    else if ($errno == E_WARNING) {
+        $errTypeStr = "WARNING";
+    }
+    else if ($errno == E_USER_NOTICE) {
+        $errTypeStr = "USER NOTICE";
+    }
+    else if ($errno == E_USER_WARNING) {
+        $errTypeStr = "USER WARNING";
+    }
+    else if ($errno == E_USER_ERROR) {
+        $errTypeStr = "USER FATAL ERROR";
+    }
+    else if ($errno == E_STRICT) {
+        return;
+    }
+    else {
+        $errTypeStr = "UNKNOWN: $errno";
+    }
+    $GLOBALS['xajaxErrorHandlerText'] .= "\n----\n[$errTypeStr] $errstr\nerror in line $errline of file $errfile";
 }
 
 ?>

main/inc/lib/xajax/xajaxResponse.inc.php

Indentation +512 added lines, -512 removed lines

@@ -67,521 +67,521 @@
  */
 class xajaxResponse
 {
-	/**#@+
+    /**#@+
 	 * @access protected
 	 */
-	/**
-	 * @var string internal XML storage
-	 */
-	var $xml;
-	/**
-	 * @var string the encoding type to use
-	 */
-	var $sEncoding;
-	/**
-	 * @var boolean if special characters in the XML should be converted to
-	 *              entities
-	 */
-	var $bOutputEntities;
-
-	/**#@-*/
-
-	/**
-	 * The constructor's main job is to set the character encoding for the
-	 * response.
-	 *
-	 * <i>Note:</i> to change the character encoding for all of the
-	 * responses, set the XAJAX_DEFAULT_ENCODING constant before you
-	 * instantiate xajax.
-	 *
-	 * @param string  contains the character encoding string to use
-	 * @param boolean lets you set if you want special characters in the output
-	 *                converted to HTML entities
-	 *
-	 */
-	function xajaxResponse($sEncoding=XAJAX_DEFAULT_CHAR_ENCODING, $bOutputEntities=false)
-	{
-		$this->setCharEncoding($sEncoding);
-		$this->bOutputEntities = $bOutputEntities;
-	}
-
-	/**
-	 * Sets the character encoding for the response based on $sEncoding, which
-	 * is a string containing the character encoding to use. You don't need to
-	 * use this method normally, since the character encoding for the response
-	 * gets set automatically based on the XAJAX_DEFAULT_CHAR_ENCODING
-	 * constant.
-	 *
-	 * @param string
-	 */
-	function setCharEncoding($sEncoding)
-	{
-		$this->sEncoding = $sEncoding;
-	}
-
-	/**
-	 * Tells the response object to convert special characters to HTML entities
-	 * automatically (only works if the mb_string extension is available).
-	 */
-	function outputEntitiesOn()
-	{
-		$this->bOutputEntities = true;
-	}
-
-	/**
-	 * Tells the response object to output special characters intact. (default
-	 * behavior)
-	 */
-	function outputEntitiesOff()
-	{
-		$this->bOutputEntities = false;
-	}
-
-	/**
-	 * Adds a confirm commands command message to the XML response.
-	 *
-	 * <i>Usage:</i> <kbd>$objResponse->addConfirmCommands(1, "Do you want to preview the new data?");</kbd>
-	 *
-	 * @param integer the number of commands to skip if the user presses
-	 *                Cancel in the browsers's confirm dialog
-	 * @param string  the message to show in the browser's confirm dialog
-	 */
-	function addConfirmCommands($iCmdNumber, $sMessage)
-	{
-		$this->xml .= $this->_cmdXML(array("n"=>"cc","t"=>$iCmdNumber),$sMessage);
-	}
-
-	/**
-	 * Adds an assign command message to the XML response.
-	 *
-	 * <i>Usage:</i> <kbd>$objResponse->addAssign("contentDiv", "innerHTML", "Some Text");</kbd>
-	 *
-	 * @param string contains the id of an HTML element
-	 * @param string the part of the element you wish to modify ("innerHTML",
-	 *               "value", etc.)
-	 * @param string the data you want to set the attribute to
-	 */
-	function addAssign($sTarget,$sAttribute,$sData)
-	{
-		$this->xml .= $this->_cmdXML(array("n"=>"as","t"=>$sTarget,"p"=>$sAttribute),$sData);
-	}
-
-	/**
-	 * Adds an append command message to the XML response.
-	 *
-	 * <i>Usage:</i> <kbd>$objResponse->addAppend("contentDiv", "innerHTML", "Some New Text");</kbd>
-	 *
-	 * @param string contains the id of an HTML element
-	 * @param string the part of the element you wish to modify ("innerHTML",
-	 *               "value", etc.)
-	 * @param string the data you want to append to the end of the attribute
-	 */
-	function addAppend($sTarget,$sAttribute,$sData)
-	{
-		$this->xml .= $this->_cmdXML(array("n"=>"ap","t"=>$sTarget,"p"=>$sAttribute),$sData);
-	}
-
-	/**
-	 * Adds an prepend command message to the XML response.
-	 *
-	 * <i>Usage:</i> <kbd>$objResponse->addPrepend("contentDiv", "innerHTML", "Some Starting Text");</kbd>
-	 *
-	 * @param string contains the id of an HTML element
-	 * @param string the part of the element you wish to modify ("innerHTML",
-	 *               "value", etc.)
-	 * @param string the data you want to prepend to the beginning of the
-	 *               attribute
-	 */
-	function addPrepend($sTarget,$sAttribute,$sData)
-	{
-		$this->xml .= $this->_cmdXML(array("n"=>"pp","t"=>$sTarget,"p"=>$sAttribute),$sData);
-	}
-
-	/**
-	 * Adds a replace command message to the XML response.
-	 *
-	 * <i>Usage:</i> <kbd>$objResponse->addReplace("contentDiv", "innerHTML", "text", "<b>text</b>");</kbd>
-	 *
-	 * @param string contains the id of an HTML element
-	 * @param string the part of the element you wish to modify ("innerHTML",
-	 *               "value", etc.)
-	 * @param string the string to search for
-	 * @param string the string to replace the search string when found in the
-	 *               attribute
-	 */
-	function addReplace($sTarget,$sAttribute,$sSearch,$sData)
-	{
-		$sDta = "<s><![CDATA[$sSearch]]></s><r><![CDATA[$sData]]></r>";
-		$this->xml .= $this->_cmdXML(array("n"=>"rp","t"=>$sTarget,"p"=>$sAttribute),$sDta);
-	}
-
-	/**
-	 * Adds a clear command message to the XML response.
-	 *
-	 * <i>Usage:</i> <kbd>$objResponse->addClear("contentDiv", "innerHTML");</kbd>
-	 *
-	 * @param string contains the id of an HTML element
-	 * @param string the part of the element you wish to clear ("innerHTML",
-	 *               "value", etc.)
-	 */
-	function addClear($sTarget,$sAttribute)
-	{
-		$this->addAssign($sTarget,$sAttribute,'');
-	}
-
-	/**
-	 * Adds an alert command message to the XML response.
-	 *
-	 * <i>Usage:</i> <kbd>$objResponse->addAlert("This is important information");</kbd>
-	 *
-	 * @param string the text to be displayed in the Javascript alert box
-	 */
-	function addAlert($sMsg)
-	{
-		$this->xml .= $this->_cmdXML(array("n"=>"al"),$sMsg);
-	}
-
-	/**
-	 * Uses the addScript() method to add a Javascript redirect to another URL.
-	 *
-	 * <i>Usage:</i> <kbd>$objResponse->addRedirect("http://www.xajaxproject.org");</kbd>
-	 *
-	 * @param string the URL to redirect the client browser to
-	 */
-	function addRedirect($sURL)
-	{
-		//we need to parse the query part so that the values are rawurlencode()'ed
-		//can't just use parse_url() cos we could be dealing with a relative URL which
-		//  parse_url() can't deal with.
-		$queryStart = strpos($sURL, '?', strrpos($sURL, '/'));
-		if ($queryStart !== FALSE)
-		{
-			$queryStart++;
-			$queryEnd = strpos($sURL, '#', $queryStart);
-			if ($queryEnd === FALSE)
-				$queryEnd = strlen($sURL);
-			$queryPart = substr($sURL, $queryStart, $queryEnd-$queryStart);
+    /**
+     * @var string internal XML storage
+     */
+    var $xml;
+    /**
+     * @var string the encoding type to use
+     */
+    var $sEncoding;
+    /**
+     * @var boolean if special characters in the XML should be converted to
+     *              entities
+     */
+    var $bOutputEntities;
+
+    /**#@-*/
+
+    /**
+     * The constructor's main job is to set the character encoding for the
+     * response.
+     *
+     * <i>Note:</i> to change the character encoding for all of the
+     * responses, set the XAJAX_DEFAULT_ENCODING constant before you
+     * instantiate xajax.
+     *
+     * @param string  contains the character encoding string to use
+     * @param boolean lets you set if you want special characters in the output
+     *                converted to HTML entities
+     *
+     */
+    function xajaxResponse($sEncoding=XAJAX_DEFAULT_CHAR_ENCODING, $bOutputEntities=false)
+    {
+        $this->setCharEncoding($sEncoding);
+        $this->bOutputEntities = $bOutputEntities;
+    }
+
+    /**
+     * Sets the character encoding for the response based on $sEncoding, which
+     * is a string containing the character encoding to use. You don't need to
+     * use this method normally, since the character encoding for the response
+     * gets set automatically based on the XAJAX_DEFAULT_CHAR_ENCODING
+     * constant.
+     *
+     * @param string
+     */
+    function setCharEncoding($sEncoding)
+    {
+        $this->sEncoding = $sEncoding;
+    }
+
+    /**
+     * Tells the response object to convert special characters to HTML entities
+     * automatically (only works if the mb_string extension is available).
+     */
+    function outputEntitiesOn()
+    {
+        $this->bOutputEntities = true;
+    }
+
+    /**
+     * Tells the response object to output special characters intact. (default
+     * behavior)
+     */
+    function outputEntitiesOff()
+    {
+        $this->bOutputEntities = false;
+    }
+
+    /**
+     * Adds a confirm commands command message to the XML response.
+     *
+     * <i>Usage:</i> <kbd>$objResponse->addConfirmCommands(1, "Do you want to preview the new data?");</kbd>
+     *
+     * @param integer the number of commands to skip if the user presses
+     *                Cancel in the browsers's confirm dialog
+     * @param string  the message to show in the browser's confirm dialog
+     */
+    function addConfirmCommands($iCmdNumber, $sMessage)
+    {
+        $this->xml .= $this->_cmdXML(array("n"=>"cc","t"=>$iCmdNumber),$sMessage);
+    }
+
+    /**
+     * Adds an assign command message to the XML response.
+     *
+     * <i>Usage:</i> <kbd>$objResponse->addAssign("contentDiv", "innerHTML", "Some Text");</kbd>
+     *
+     * @param string contains the id of an HTML element
+     * @param string the part of the element you wish to modify ("innerHTML",
+     *               "value", etc.)
+     * @param string the data you want to set the attribute to
+     */
+    function addAssign($sTarget,$sAttribute,$sData)
+    {
+        $this->xml .= $this->_cmdXML(array("n"=>"as","t"=>$sTarget,"p"=>$sAttribute),$sData);
+    }
+
+    /**
+     * Adds an append command message to the XML response.
+     *
+     * <i>Usage:</i> <kbd>$objResponse->addAppend("contentDiv", "innerHTML", "Some New Text");</kbd>
+     *
+     * @param string contains the id of an HTML element
+     * @param string the part of the element you wish to modify ("innerHTML",
+     *               "value", etc.)
+     * @param string the data you want to append to the end of the attribute
+     */
+    function addAppend($sTarget,$sAttribute,$sData)
+    {
+        $this->xml .= $this->_cmdXML(array("n"=>"ap","t"=>$sTarget,"p"=>$sAttribute),$sData);
+    }
+
+    /**
+     * Adds an prepend command message to the XML response.
+     *
+     * <i>Usage:</i> <kbd>$objResponse->addPrepend("contentDiv", "innerHTML", "Some Starting Text");</kbd>
+     *
+     * @param string contains the id of an HTML element
+     * @param string the part of the element you wish to modify ("innerHTML",
+     *               "value", etc.)
+     * @param string the data you want to prepend to the beginning of the
+     *               attribute
+     */
+    function addPrepend($sTarget,$sAttribute,$sData)
+    {
+        $this->xml .= $this->_cmdXML(array("n"=>"pp","t"=>$sTarget,"p"=>$sAttribute),$sData);
+    }
+
+    /**
+     * Adds a replace command message to the XML response.
+     *
+     * <i>Usage:</i> <kbd>$objResponse->addReplace("contentDiv", "innerHTML", "text", "<b>text</b>");</kbd>
+     *
+     * @param string contains the id of an HTML element
+     * @param string the part of the element you wish to modify ("innerHTML",
+     *               "value", etc.)
+     * @param string the string to search for
+     * @param string the string to replace the search string when found in the
+     *               attribute
+     */
+    function addReplace($sTarget,$sAttribute,$sSearch,$sData)
+    {
+        $sDta = "<s><![CDATA[$sSearch]]></s><r><![CDATA[$sData]]></r>";
+        $this->xml .= $this->_cmdXML(array("n"=>"rp","t"=>$sTarget,"p"=>$sAttribute),$sDta);
+    }
+
+    /**
+     * Adds a clear command message to the XML response.
+     *
+     * <i>Usage:</i> <kbd>$objResponse->addClear("contentDiv", "innerHTML");</kbd>
+     *
+     * @param string contains the id of an HTML element
+     * @param string the part of the element you wish to clear ("innerHTML",
+     *               "value", etc.)
+     */
+    function addClear($sTarget,$sAttribute)
+    {
+        $this->addAssign($sTarget,$sAttribute,'');
+    }
+
+    /**
+     * Adds an alert command message to the XML response.
+     *
+     * <i>Usage:</i> <kbd>$objResponse->addAlert("This is important information");</kbd>
+     *
+     * @param string the text to be displayed in the Javascript alert box
+     */
+    function addAlert($sMsg)
+    {
+        $this->xml .= $this->_cmdXML(array("n"=>"al"),$sMsg);
+    }
+
+    /**
+     * Uses the addScript() method to add a Javascript redirect to another URL.
+     *
+     * <i>Usage:</i> <kbd>$objResponse->addRedirect("http://www.xajaxproject.org");</kbd>
+     *
+     * @param string the URL to redirect the client browser to
+     */
+    function addRedirect($sURL)
+    {
+        //we need to parse the query part so that the values are rawurlencode()'ed
+        //can't just use parse_url() cos we could be dealing with a relative URL which
+        //  parse_url() can't deal with.
+        $queryStart = strpos($sURL, '?', strrpos($sURL, '/'));
+        if ($queryStart !== FALSE)
+        {
+            $queryStart++;
+            $queryEnd = strpos($sURL, '#', $queryStart);
+            if ($queryEnd === FALSE)
+                $queryEnd = strlen($sURL);
+            $queryPart = substr($sURL, $queryStart, $queryEnd-$queryStart);
             $queryParts = array();
-			parse_str($queryPart, $queryParts);
-			$newQueryPart = "";
-			foreach($queryParts as $key => $value)
-			{
-				$newQueryPart .= rawurlencode($key).'='.rawurlencode($value).ini_get('arg_separator.output');
-			}
-			$sURL = str_replace($queryPart, $newQueryPart, $sURL);
-		}
-		$this->addScript('window.location = "'.$sURL.'";');
-	}
-
-	/**
-	 * Adds a Javascript command message to the XML response.
-	 *
-	 * <i>Usage:</i> <kbd>$objResponse->addScript("var x = prompt('get some text');");</kbd>
-	 *
-	 * @param string contains Javascript code to be executed
-	 */
-	function addScript($sJS)
-	{
-		$this->xml .= $this->_cmdXML(array("n"=>"js"),$sJS);
-	}
-
-	/**
-	 * Adds a Javascript function call command message to the XML response.
-	 *
-	 * <i>Usage:</i> <kbd>$objResponse->addScriptCall("myJSFunction", "arg 1", "arg 2", 12345);</kbd>
-	 *
-	 * @param string $sFunc the name of a Javascript function
-	 * @param mixed $args,... optional arguments to pass to the Javascript function
-	 */
-	function addScriptCall() {
-		$arguments = func_get_args();
-		$sFunc = array_shift($arguments);
-		$sData = $this->_buildObjXml($arguments);
-		$this->xml .= $this->_cmdXML(array("n"=>"jc","t"=>$sFunc),$sData);
-	}
-
-	/**
-	 * Adds a remove element command message to the XML response.
-	 *
-	 * <i>Usage:</i> <kbd>$objResponse->addRemove("Div2");</kbd>
-	 *
-	 * @param string contains the id of an HTML element to be removed
-	 */
-	function addRemove($sTarget)
-	{
-		$this->xml .= $this->_cmdXML(array("n"=>"rm","t"=>$sTarget),'');
-	}
-
-	/**
-	 * Adds a create element command message to the XML response.
-	 *
-	 * <i>Usage:</i> <kbd>$objResponse->addCreate("parentDiv", "h3", "myid");</kbd>
-	 *
-	 * @param string contains the id of an HTML element to to which the new
-	 *               element will be appended.
-	 * @param string the tag to be added
-	 * @param string the id to be assigned to the new element
-	 * @param string deprecated, use the addCreateInput() method instead
-	 */
-	function addCreate($sParent, $sTag, $sId, $sType="")
-	{
-		if ($sType)
-		{
-			trigger_error("The \$sType parameter of addCreate has been deprecated.  Use the addCreateInput() method instead.", E_USER_WARNING);
-			return;
-		}
-		$this->xml .= $this->_cmdXML(array("n"=>"ce","t"=>$sParent,"p"=>$sId),$sTag);
-	}
-
-	/**
-	 * Adds a insert element command message to the XML response.
-	 *
-	 * <i>Usage:</i> <kbd>$objResponse->addInsert("childDiv", "h3", "myid");</kbd>
-	 *
-	 * @param string contains the id of the child before which the new element
-	 *               will be inserted
-	 * @param string the tag to be added
-	 * @param string the id to be assigned to the new element
-	 */
-	function addInsert($sBefore, $sTag, $sId)
-	{
-		$this->xml .= $this->_cmdXML(array("n"=>"ie","t"=>$sBefore,"p"=>$sId),$sTag);
-	}
-
-	/**
-	 * Adds a insert element command message to the XML response.
-	 *
-	 * <i>Usage:</i> <kbd>$objResponse->addInsertAfter("childDiv", "h3", "myid");</kbd>
-	 *
-	 * @param string contains the id of the child after which the new element
-	 *               will be inserted
-	 * @param string the tag to be added
-	 * @param string the id to be assigned to the new element
-	 */
-	function addInsertAfter($sAfter, $sTag, $sId)
-	{
-		$this->xml .= $this->_cmdXML(array("n"=>"ia","t"=>$sAfter,"p"=>$sId),$sTag);
-	}
-
-	/**
-	 * Adds a create input command message to the XML response.
-	 *
-	 * <i>Usage:</i> <kbd>$objResponse->addCreateInput("form1", "text", "username", "input1");</kbd>
-	 *
-	 * @param string contains the id of an HTML element to which the new input
-	 *               will be appended
-	 * @param string the type of input to be created (text, radio, checkbox,
-	 *               etc.)
-	 * @param string the name to be assigned to the new input and the variable
-	 *               name when it is submitted
-	 * @param string the id to be assigned to the new input
-	 */
-	function addCreateInput($sParent, $sType, $sName, $sId)
-	{
-		$this->xml .= $this->_cmdXML(array("n"=>"ci","t"=>$sParent,"p"=>$sId,"c"=>$sType),$sName);
-	}
-
-	/**
-	 * Adds an insert input command message to the XML response.
-	 *
-	 * <i>Usage:</i> <kbd>$objResponse->addInsertInput("input5", "text", "username", "input1");</kbd>
-	 *
-	 * @param string contains the id of the child before which the new element
-	 *               will be inserted
-	 * @param string the type of input to be created (text, radio, checkbox,
-	 *               etc.)
-	 * @param string the name to be assigned to the new input and the variable
-	 *               name when it is submitted
-	 * @param string the id to be assigned to the new input
-	 */
-	function addInsertInput($sBefore, $sType, $sName, $sId)
-	{
-		$this->xml .= $this->_cmdXML(array("n"=>"ii","t"=>$sBefore,"p"=>$sId,"c"=>$sType),$sName);
-	}
-
-	/**
-	 * Adds an insert input command message to the XML response.
-	 *
-	 * <i>Usage:</i> <kbd>$objResponse->addInsertInputAfter("input7", "text", "email", "input2");</kbd>
-	 *
-	 * @param string contains the id of the child after which the new element
-	 *               will be inserted
-	 * @param string the type of input to be created (text, radio, checkbox,
-	 *               etc.)
-	 * @param string the name to be assigned to the new input and the variable
-	 *               name when it is submitted
-	 * @param string the id to be assigned to the new input
-	 */
-	function addInsertInputAfter($sAfter, $sType, $sName, $sId)
-	{
-		$this->xml .= $this->_cmdXML(array("n"=>"iia","t"=>$sAfter,"p"=>$sId,"c"=>$sType),$sName);
-	}
-
-	/**
-	 * Adds an event command message to the XML response.
-	 *
-	 * <i>Usage:</i> <kbd>$objResponse->addEvent("contentDiv", "onclick", "alert(\'Hello World\');");</kbd>
-	 *
-	 * @param string contains the id of an HTML element
-	 * @param string the event you wish to set ("onclick", "onmouseover", etc.)
-	 * @param string the Javascript string you want the event to invoke
-	 */
-	function addEvent($sTarget,$sEvent,$sScript)
-	{
-		$this->xml .= $this->_cmdXML(array("n"=>"ev","t"=>$sTarget,"p"=>$sEvent),$sScript);
-	}
-
-	/**
-	 * Adds a handler command message to the XML response.
-	 *
-	 * <i>Usage:</i> <kbd>$objResponse->addHandler("contentDiv", "onclick", "content_click");</kbd>
-	 *
-	 * @param string contains the id of an HTML element
-	 * @param string the event you wish to set ("onclick", "onmouseover", etc.)
-	 * @param string the name of a Javascript function that will handle the
-	 *               event. Multiple handlers can be added for the same event
-	 */
-	function addHandler($sTarget,$sEvent,$sHandler)
-	{
-		$this->xml .= $this->_cmdXML(array("n"=>"ah","t"=>$sTarget,"p"=>$sEvent),$sHandler);
-	}
-
-	/**
-	 * Adds a remove handler command message to the XML response.
-	 *
-	 * <i>Usage:</i> <kbd>$objResponse->addRemoveHandler("contentDiv", "onclick", "content_click");</kbd>
-	 *
-	 * @param string contains the id of an HTML element
-	 * @param string the event you wish to remove ("onclick", "onmouseover",
-	 *               etc.)
-	 * @param string the name of a Javascript handler function that you want to
-	 *               remove
-	 */
-	function addRemoveHandler($sTarget,$sEvent,$sHandler)
-	{
-		$this->xml .= $this->_cmdXML(array("n"=>"rh","t"=>$sTarget,"p"=>$sEvent),$sHandler);
-	}
-
-	/**
-	 * Adds an include script command message to the XML response.
-	 *
-	 * <i>Usage:</i> <kbd>$objResponse->addIncludeScript("functions.js");</kbd>
-	 *
-	 * @param string URL of the Javascript file to include
-	 */
-	function addIncludeScript($sFileName)
-	{
-		$this->xml .= $this->_cmdXML(array("n"=>"in"),$sFileName);
-	}
-
-	/**
-	 * Returns the XML to be returned from your function to the xajax processor
-	 * on your page. Since xajax 0.2, you can also return an xajaxResponse
-	 * object from your function directly, and xajax will automatically request
-	 * the XML using this method call.
-	 *
-	 * <i>Usage:</i> <kbd>return $objResponse->getXML();</kbd>
-	 *
-	 * @return string response XML data
-	 */
-	function getXML()
-	{
-		$sXML = "<?xml version=\"1.0\"";
-		if ($this->sEncoding && strlen(trim($this->sEncoding)) > 0)
-			$sXML .= " encoding=\"".$this->sEncoding."\"";
-		$sXML .= " ?"."><xjx>" . $this->xml . "</xjx>";
-
-		return $sXML;
-	}
-
-	/**
-	 * Adds the commands of the provided response XML output to this response
-	 * object
-	 *
-	 * <i>Usage:</i>
-	 * <code>$r1 = $objResponse1->getXML();
-	 * $objResponse2->loadXML($r1);
-	 * return $objResponse2->getXML();</code>
-	 *
-	 * @param string the response XML (returned from a getXML() method) to add
-	 *               to the end of this response object
-	 */
-	function loadXML($mXML)
-	{
-		if (is_a($mXML, "xajaxResponse")) {
-			$mXML = $mXML->getXML();
-		}
-		$sNewXML = "";
-		$iStartPos = strpos($mXML, "<xjx>") + 5;
-		$sNewXML = substr($mXML, $iStartPos);
-		$iEndPos = strpos($sNewXML, "</xjx>");
-		$sNewXML = substr($sNewXML, 0, $iEndPos);
-		$this->xml .= $sNewXML;
-	}
-
-	/**
-	 * Generates XML from command data
-	 *
-	 * @access private
-	 * @param array associative array of attributes
-	 * @param string data
-	 * @return string XML command
-	 */
-	function _cmdXML($aAttributes, $sData)
-	{
-		if ($this->bOutputEntities) {
-			// An adaptation for the Dokeos LMS, 22-AUG-2009.
-			if (function_exists('api_convert_encoding')) {
-				$sData = call_user_func_array('api_convert_encoding', array(&$sData, 'HTML-ENTITIES', $this->sEncoding));
-			}
-			//if (function_exists('mb_convert_encoding')) {
-			elseif (function_exists('mb_convert_encoding')) {
-			//
-				$sData = call_user_func_array('mb_convert_encoding', array(&$sData, 'HTML-ENTITIES', $this->sEncoding));
-			}
-			else {
-				trigger_error("The xajax XML response output could not be converted to HTML entities because the mb_convert_encoding function is not available", E_USER_NOTICE);
-			}
-		}
-		$xml = "<cmd";
-		foreach($aAttributes as $sAttribute => $sValue)
-			$xml .= " $sAttribute=\"$sValue\"";
-		if ($sData !== null && !stristr($sData,'<![CDATA['))
-			$xml .= "><![CDATA[$sData]]></cmd>";
-		else if ($sData !== null)
-			$xml .= ">$sData</cmd>";
-		else
-			$xml .= "></cmd>";
-
-		return $xml;
-	}
-
-	/**
-	 * Recursively serializes a data structure in XML so it can be sent to
-	 * the client. It could be thought of as the opposite of
-	 * {@link xajax::_parseObjXml()}.
-	 *
-	 * @access private
-	 * @param mixed data structure to serialize to XML
-	 * @return string serialized XML
-	 */
-	function _buildObjXml($var) {
-		if (gettype($var) == "object") $var = get_object_vars($var);
-		if (!is_array($var)) {
-			return "<![CDATA[$var]]>";
-		}
-		else {
-			$data = "<xjxobj>";
-			foreach ($var as $key => $value) {
-				$data .= "<e>";
-				$data .= "<k>" . htmlspecialchars($key) . "</k>";
-				$data .= "<v>" . $this->_buildObjXml($value) . "</v>";
-				$data .= "</e>";
-			}
-			$data .= "</xjxobj>";
-			return $data;
-		}
-	}
+            parse_str($queryPart, $queryParts);
+            $newQueryPart = "";
+            foreach($queryParts as $key => $value)
+            {
+                $newQueryPart .= rawurlencode($key).'='.rawurlencode($value).ini_get('arg_separator.output');
+            }
+            $sURL = str_replace($queryPart, $newQueryPart, $sURL);
+        }
+        $this->addScript('window.location = "'.$sURL.'";');
+    }
+
+    /**
+     * Adds a Javascript command message to the XML response.
+     *
+     * <i>Usage:</i> <kbd>$objResponse->addScript("var x = prompt('get some text');");</kbd>
+     *
+     * @param string contains Javascript code to be executed
+     */
+    function addScript($sJS)
+    {
+        $this->xml .= $this->_cmdXML(array("n"=>"js"),$sJS);
+    }
+
+    /**
+     * Adds a Javascript function call command message to the XML response.
+     *
+     * <i>Usage:</i> <kbd>$objResponse->addScriptCall("myJSFunction", "arg 1", "arg 2", 12345);</kbd>
+     *
+     * @param string $sFunc the name of a Javascript function
+     * @param mixed $args,... optional arguments to pass to the Javascript function
+     */
+    function addScriptCall() {
+        $arguments = func_get_args();
+        $sFunc = array_shift($arguments);
+        $sData = $this->_buildObjXml($arguments);
+        $this->xml .= $this->_cmdXML(array("n"=>"jc","t"=>$sFunc),$sData);
+    }
+
+    /**
+     * Adds a remove element command message to the XML response.
+     *
+     * <i>Usage:</i> <kbd>$objResponse->addRemove("Div2");</kbd>
+     *
+     * @param string contains the id of an HTML element to be removed
+     */
+    function addRemove($sTarget)
+    {
+        $this->xml .= $this->_cmdXML(array("n"=>"rm","t"=>$sTarget),'');
+    }
+
+    /**
+     * Adds a create element command message to the XML response.
+     *
+     * <i>Usage:</i> <kbd>$objResponse->addCreate("parentDiv", "h3", "myid");</kbd>
+     *
+     * @param string contains the id of an HTML element to to which the new
+     *               element will be appended.
+     * @param string the tag to be added
+     * @param string the id to be assigned to the new element
+     * @param string deprecated, use the addCreateInput() method instead
+     */
+    function addCreate($sParent, $sTag, $sId, $sType="")
+    {
+        if ($sType)
+        {
+            trigger_error("The \$sType parameter of addCreate has been deprecated.  Use the addCreateInput() method instead.", E_USER_WARNING);
+            return;
+        }
+        $this->xml .= $this->_cmdXML(array("n"=>"ce","t"=>$sParent,"p"=>$sId),$sTag);
+    }
+
+    /**
+     * Adds a insert element command message to the XML response.
+     *
+     * <i>Usage:</i> <kbd>$objResponse->addInsert("childDiv", "h3", "myid");</kbd>
+     *
+     * @param string contains the id of the child before which the new element
+     *               will be inserted
+     * @param string the tag to be added
+     * @param string the id to be assigned to the new element
+     */
+    function addInsert($sBefore, $sTag, $sId)
+    {
+        $this->xml .= $this->_cmdXML(array("n"=>"ie","t"=>$sBefore,"p"=>$sId),$sTag);
+    }
+
+    /**
+     * Adds a insert element command message to the XML response.
+     *
+     * <i>Usage:</i> <kbd>$objResponse->addInsertAfter("childDiv", "h3", "myid");</kbd>
+     *
+     * @param string contains the id of the child after which the new element
+     *               will be inserted
+     * @param string the tag to be added
+     * @param string the id to be assigned to the new element
+     */
+    function addInsertAfter($sAfter, $sTag, $sId)
+    {
+        $this->xml .= $this->_cmdXML(array("n"=>"ia","t"=>$sAfter,"p"=>$sId),$sTag);
+    }
+
+    /**
+     * Adds a create input command message to the XML response.
+     *
+     * <i>Usage:</i> <kbd>$objResponse->addCreateInput("form1", "text", "username", "input1");</kbd>
+     *
+     * @param string contains the id of an HTML element to which the new input
+     *               will be appended
+     * @param string the type of input to be created (text, radio, checkbox,
+     *               etc.)
+     * @param string the name to be assigned to the new input and the variable
+     *               name when it is submitted
+     * @param string the id to be assigned to the new input
+     */
+    function addCreateInput($sParent, $sType, $sName, $sId)
+    {
+        $this->xml .= $this->_cmdXML(array("n"=>"ci","t"=>$sParent,"p"=>$sId,"c"=>$sType),$sName);
+    }
+
+    /**
+     * Adds an insert input command message to the XML response.
+     *
+     * <i>Usage:</i> <kbd>$objResponse->addInsertInput("input5", "text", "username", "input1");</kbd>
+     *
+     * @param string contains the id of the child before which the new element
+     *               will be inserted
+     * @param string the type of input to be created (text, radio, checkbox,
+     *               etc.)
+     * @param string the name to be assigned to the new input and the variable
+     *               name when it is submitted
+     * @param string the id to be assigned to the new input
+     */
+    function addInsertInput($sBefore, $sType, $sName, $sId)
+    {
+        $this->xml .= $this->_cmdXML(array("n"=>"ii","t"=>$sBefore,"p"=>$sId,"c"=>$sType),$sName);
+    }
+
+    /**
+     * Adds an insert input command message to the XML response.
+     *
+     * <i>Usage:</i> <kbd>$objResponse->addInsertInputAfter("input7", "text", "email", "input2");</kbd>
+     *
+     * @param string contains the id of the child after which the new element
+     *               will be inserted
+     * @param string the type of input to be created (text, radio, checkbox,
+     *               etc.)
+     * @param string the name to be assigned to the new input and the variable
+     *               name when it is submitted
+     * @param string the id to be assigned to the new input
+     */
+    function addInsertInputAfter($sAfter, $sType, $sName, $sId)
+    {
+        $this->xml .= $this->_cmdXML(array("n"=>"iia","t"=>$sAfter,"p"=>$sId,"c"=>$sType),$sName);
+    }
+
+    /**
+     * Adds an event command message to the XML response.
+     *
+     * <i>Usage:</i> <kbd>$objResponse->addEvent("contentDiv", "onclick", "alert(\'Hello World\');");</kbd>
+     *
+     * @param string contains the id of an HTML element
+     * @param string the event you wish to set ("onclick", "onmouseover", etc.)
+     * @param string the Javascript string you want the event to invoke
+     */
+    function addEvent($sTarget,$sEvent,$sScript)
+    {
+        $this->xml .= $this->_cmdXML(array("n"=>"ev","t"=>$sTarget,"p"=>$sEvent),$sScript);
+    }
+
+    /**
+     * Adds a handler command message to the XML response.
+     *
+     * <i>Usage:</i> <kbd>$objResponse->addHandler("contentDiv", "onclick", "content_click");</kbd>
+     *
+     * @param string contains the id of an HTML element
+     * @param string the event you wish to set ("onclick", "onmouseover", etc.)
+     * @param string the name of a Javascript function that will handle the
+     *               event. Multiple handlers can be added for the same event
+     */
+    function addHandler($sTarget,$sEvent,$sHandler)
+    {
+        $this->xml .= $this->_cmdXML(array("n"=>"ah","t"=>$sTarget,"p"=>$sEvent),$sHandler);
+    }
+
+    /**
+     * Adds a remove handler command message to the XML response.
+     *
+     * <i>Usage:</i> <kbd>$objResponse->addRemoveHandler("contentDiv", "onclick", "content_click");</kbd>
+     *
+     * @param string contains the id of an HTML element
+     * @param string the event you wish to remove ("onclick", "onmouseover",
+     *               etc.)
+     * @param string the name of a Javascript handler function that you want to
+     *               remove
+     */
+    function addRemoveHandler($sTarget,$sEvent,$sHandler)
+    {
+        $this->xml .= $this->_cmdXML(array("n"=>"rh","t"=>$sTarget,"p"=>$sEvent),$sHandler);
+    }
+
+    /**
+     * Adds an include script command message to the XML response.
+     *
+     * <i>Usage:</i> <kbd>$objResponse->addIncludeScript("functions.js");</kbd>
+     *
+     * @param string URL of the Javascript file to include
+     */
+    function addIncludeScript($sFileName)
+    {
+        $this->xml .= $this->_cmdXML(array("n"=>"in"),$sFileName);
+    }
+
+    /**
+     * Returns the XML to be returned from your function to the xajax processor
+     * on your page. Since xajax 0.2, you can also return an xajaxResponse
+     * object from your function directly, and xajax will automatically request
+     * the XML using this method call.
+     *
+     * <i>Usage:</i> <kbd>return $objResponse->getXML();</kbd>
+     *
+     * @return string response XML data
+     */
+    function getXML()
+    {
+        $sXML = "<?xml version=\"1.0\"";
+        if ($this->sEncoding && strlen(trim($this->sEncoding)) > 0)
+            $sXML .= " encoding=\"".$this->sEncoding."\"";
+        $sXML .= " ?"."><xjx>" . $this->xml . "</xjx>";
+
+        return $sXML;
+    }
+
+    /**
+     * Adds the commands of the provided response XML output to this response
+     * object
+     *
+     * <i>Usage:</i>
+     * <code>$r1 = $objResponse1->getXML();
+     * $objResponse2->loadXML($r1);
+     * return $objResponse2->getXML();</code>
+     *
+     * @param string the response XML (returned from a getXML() method) to add
+     *               to the end of this response object
+     */
+    function loadXML($mXML)
+    {
+        if (is_a($mXML, "xajaxResponse")) {
+            $mXML = $mXML->getXML();
+        }
+        $sNewXML = "";
+        $iStartPos = strpos($mXML, "<xjx>") + 5;
+        $sNewXML = substr($mXML, $iStartPos);
+        $iEndPos = strpos($sNewXML, "</xjx>");
+        $sNewXML = substr($sNewXML, 0, $iEndPos);
+        $this->xml .= $sNewXML;
+    }
+
+    /**
+     * Generates XML from command data
+     *
+     * @access private
+     * @param array associative array of attributes
+     * @param string data
+     * @return string XML command
+     */
+    function _cmdXML($aAttributes, $sData)
+    {
+        if ($this->bOutputEntities) {
+            // An adaptation for the Dokeos LMS, 22-AUG-2009.
+            if (function_exists('api_convert_encoding')) {
+                $sData = call_user_func_array('api_convert_encoding', array(&$sData, 'HTML-ENTITIES', $this->sEncoding));
+            }
+            //if (function_exists('mb_convert_encoding')) {
+            elseif (function_exists('mb_convert_encoding')) {
+            //
+                $sData = call_user_func_array('mb_convert_encoding', array(&$sData, 'HTML-ENTITIES', $this->sEncoding));
+            }
+            else {
+                trigger_error("The xajax XML response output could not be converted to HTML entities because the mb_convert_encoding function is not available", E_USER_NOTICE);
+            }
+        }
+        $xml = "<cmd";
+        foreach($aAttributes as $sAttribute => $sValue)
+            $xml .= " $sAttribute=\"$sValue\"";
+        if ($sData !== null && !stristr($sData,'<![CDATA['))
+            $xml .= "><![CDATA[$sData]]></cmd>";
+        else if ($sData !== null)
+            $xml .= ">$sData</cmd>";
+        else
+            $xml .= "></cmd>";
+
+        return $xml;
+    }
+
+    /**
+     * Recursively serializes a data structure in XML so it can be sent to
+     * the client. It could be thought of as the opposite of
+     * {@link xajax::_parseObjXml()}.
+     *
+     * @access private
+     * @param mixed data structure to serialize to XML
+     * @return string serialized XML
+     */
+    function _buildObjXml($var) {
+        if (gettype($var) == "object") $var = get_object_vars($var);
+        if (!is_array($var)) {
+            return "<![CDATA[$var]]>";
+        }
+        else {
+            $data = "<xjxobj>";
+            foreach ($var as $key => $value) {
+                $data .= "<e>";
+                $data .= "<k>" . htmlspecialchars($key) . "</k>";
+                $data .= "<v>" . $this->_buildObjXml($value) . "</v>";
+                $data .= "</e>";
+            }
+            $data .= "</xjxobj>";
+            return $data;
+        }
+    }
 
 }// end class xajaxResponse
 ?>

main/inc/lib/xajax/xajaxCompress.php

Indentation +136 added lines, -136 removed lines

@@ -42,141 +42,141 @@
  */
 function xajaxCompressJavascript($sJS)
 {
-	//remove windows cariage returns
-	$sJS = str_replace("\r","",$sJS);
-
-	//array to store replaced literal strings
-	$literal_strings = array();
-
-	//explode the string into lines
-	$lines = explode("\n",$sJS);
-	//loop through all the lines, building a new string at the same time as removing literal strings
-	$clean = "";
-	$inComment = false;
-	$literal = "";
-	$inQuote = false;
-	$escaped = false;
-	$quoteChar = "";
-
-	for($i=0;$i<count($lines);$i++)
-	{
-		$line = $lines[$i];
-		$inNormalComment = false;
-
-		//loop through line's characters and take out any literal strings, replace them with ___i___ where i is the index of this string
-		for($j=0;$j<strlen($line);$j++)
-		{
-			$c = substr($line,$j,1);
-			$d = substr($line,$j,2);
-
-			//look for start of quote
-			if(!$inQuote && !$inComment)
-			{
-				//is this character a quote or a comment
-				if(($c=="\"" || $c=="'") && !$inComment && !$inNormalComment)
-				{
-					$inQuote = true;
-					$inComment = false;
-					$escaped = false;
-					$quoteChar = $c;
-					$literal = $c;
-				}
-				else if($d=="/*" && !$inNormalComment)
-				{
-					$inQuote = false;
-					$inComment = true;
-					$escaped = false;
-					$quoteChar = $d;
-					$literal = $d;
-					$j++;
-				}
-				else if($d=="//") //ignore string markers that are found inside comments
-				{
-					$inNormalComment = true;
-					$clean .= $c;
-				}
-				else
-				{
-					$clean .= $c;
-				}
-			}
-			else //allready in a string so find end quote
-			{
-				if($c == $quoteChar && !$escaped && !$inComment)
-				{
-					$inQuote = false;
-					$literal .= $c;
-
-					//subsitute in a marker for the string
-					$clean .= "___" . count($literal_strings) . "___";
-
-					//push the string onto our array
-					array_push($literal_strings,$literal);
-
-				}
-				else if($inComment && $d=="*/")
-				{
-					$inComment = false;
-					$literal .= $d;
-
-					//subsitute in a marker for the string
-					$clean .= "___" . count($literal_strings) . "___";
-
-					//push the string onto our array
-					array_push($literal_strings,$literal);
-
-					$j++;
-				}
-				else if($c == "\\" && !$escaped)
-					$escaped = true;
-				else
-					$escaped = false;
-
-				$literal .= $c;
-			}
-		}
-		if($inComment) $literal .= "\n";
-		$clean .= "\n";
-	}
-	//explode the clean string into lines again
-	$lines = explode("\n",$clean);
-
-	//now process each line at a time
-	for($i=0;$i<count($lines);$i++)
-	{
-		$line = $lines[$i];
-
-		//remove comments
-		$line = preg_replace("/\/\/(.*)/","",$line);
-
-		//strip leading and trailing whitespace
-		$line = trim($line);
-
-		//remove all whitespace with a single space
-		$line = preg_replace("/\s+/"," ",$line);
-
-		//remove any whitespace that occurs after/before an operator
-		$line = preg_replace("/\s*([!\}\{;,&=\|\-\+\*\/\)\(:])\s*/","\\1",$line);
-
-		$lines[$i] = $line;
-	}
-
-	//implode the lines
-	$sJS = implode("\n",$lines);
-
-	//make sure there is a max of 1 \n after each line
-	$sJS = preg_replace("/[\n]+/","\n",$sJS);
-
-	//strip out line breaks that immediately follow a semi-colon
-	$sJS = preg_replace("/;\n/",";",$sJS);
-
-	//curly brackets aren't on their own
-	$sJS = preg_replace("/[\n]*\{[\n]*/","{",$sJS);
-
-	//finally loop through and replace all the literal strings:
-	for($i=0;$i<count($literal_strings);$i++)
-		$sJS = str_replace("___".$i."___",$literal_strings[$i],$sJS);
-
-	return $sJS;
+    //remove windows cariage returns
+    $sJS = str_replace("\r","",$sJS);
+
+    //array to store replaced literal strings
+    $literal_strings = array();
+
+    //explode the string into lines
+    $lines = explode("\n",$sJS);
+    //loop through all the lines, building a new string at the same time as removing literal strings
+    $clean = "";
+    $inComment = false;
+    $literal = "";
+    $inQuote = false;
+    $escaped = false;
+    $quoteChar = "";
+
+    for($i=0;$i<count($lines);$i++)
+    {
+        $line = $lines[$i];
+        $inNormalComment = false;
+
+        //loop through line's characters and take out any literal strings, replace them with ___i___ where i is the index of this string
+        for($j=0;$j<strlen($line);$j++)
+        {
+            $c = substr($line,$j,1);
+            $d = substr($line,$j,2);
+
+            //look for start of quote
+            if(!$inQuote && !$inComment)
+            {
+                //is this character a quote or a comment
+                if(($c=="\"" || $c=="'") && !$inComment && !$inNormalComment)
+                {
+                    $inQuote = true;
+                    $inComment = false;
+                    $escaped = false;
+                    $quoteChar = $c;
+                    $literal = $c;
+                }
+                else if($d=="/*" && !$inNormalComment)
+                {
+                    $inQuote = false;
+                    $inComment = true;
+                    $escaped = false;
+                    $quoteChar = $d;
+                    $literal = $d;
+                    $j++;
+                }
+                else if($d=="//") //ignore string markers that are found inside comments
+                {
+                    $inNormalComment = true;
+                    $clean .= $c;
+                }
+                else
+                {
+                    $clean .= $c;
+                }
+            }
+            else //allready in a string so find end quote
+            {
+                if($c == $quoteChar && !$escaped && !$inComment)
+                {
+                    $inQuote = false;
+                    $literal .= $c;
+
+                    //subsitute in a marker for the string
+                    $clean .= "___" . count($literal_strings) . "___";
+
+                    //push the string onto our array
+                    array_push($literal_strings,$literal);
+
+                }
+                else if($inComment && $d=="*/")
+                {
+                    $inComment = false;
+                    $literal .= $d;
+
+                    //subsitute in a marker for the string
+                    $clean .= "___" . count($literal_strings) . "___";
+
+                    //push the string onto our array
+                    array_push($literal_strings,$literal);
+
+                    $j++;
+                }
+                else if($c == "\\" && !$escaped)
+                    $escaped = true;
+                else
+                    $escaped = false;
+
+                $literal .= $c;
+            }
+        }
+        if($inComment) $literal .= "\n";
+        $clean .= "\n";
+    }
+    //explode the clean string into lines again
+    $lines = explode("\n",$clean);
+
+    //now process each line at a time
+    for($i=0;$i<count($lines);$i++)
+    {
+        $line = $lines[$i];
+
+        //remove comments
+        $line = preg_replace("/\/\/(.*)/","",$line);
+
+        //strip leading and trailing whitespace
+        $line = trim($line);
+
+        //remove all whitespace with a single space
+        $line = preg_replace("/\s+/"," ",$line);
+
+        //remove any whitespace that occurs after/before an operator
+        $line = preg_replace("/\s*([!\}\{;,&=\|\-\+\*\/\)\(:])\s*/","\\1",$line);
+
+        $lines[$i] = $line;
+    }
+
+    //implode the lines
+    $sJS = implode("\n",$lines);
+
+    //make sure there is a max of 1 \n after each line
+    $sJS = preg_replace("/[\n]+/","\n",$sJS);
+
+    //strip out line breaks that immediately follow a semi-colon
+    $sJS = preg_replace("/;\n/",";",$sJS);
+
+    //curly brackets aren't on their own
+    $sJS = preg_replace("/[\n]*\{[\n]*/","{",$sJS);
+
+    //finally loop through and replace all the literal strings:
+    for($i=0;$i<count($literal_strings);$i++)
+        $sJS = str_replace("___".$i."___",$literal_strings[$i],$sJS);
+
+    return $sJS;
 }
 ?>

main/inc/lib/userportal.lib.php

Indentation +17 added lines, -17 removed lines

@@ -248,17 +248,17 @@ 
                 }
             }
 
-			if (trim($home_top_temp) == '' && api_is_platform_admin()) {
-				$home_top_temp = '<div class="welcome-mascot">' . get_lang('PortalHomepageDefaultIntroduction') . '</div>';
-			} else {
-				$home_top_temp = '<div class="welcome-home-top-temp">' . $home_top_temp . '</div>';
-			}
-			$open = str_replace('{rel_path}', api_get_path(REL_PATH), $home_top_temp);
-			$html = api_to_system_encoding($open, api_detect_encoding(strip_tags($open)));
-		}
-
-		return $html;
-	}
+            if (trim($home_top_temp) == '' && api_is_platform_admin()) {
+                $home_top_temp = '<div class="welcome-mascot">' . get_lang('PortalHomepageDefaultIntroduction') . '</div>';
+            } else {
+                $home_top_temp = '<div class="welcome-home-top-temp">' . $home_top_temp . '</div>';
+            }
+            $open = str_replace('{rel_path}', api_get_path(REL_PATH), $home_top_temp);
+            $html = api_to_system_encoding($open, api_detect_encoding(strip_tags($open)));
+        }
+
+        return $html;
+    }
 
     function return_notice()
     {
@@ -509,7 +509,7 @@ 
                     $thereIsSubCat = true;
                 } elseif (api_get_setting('show_empty_course_categories') == 'true') {
                     /* End changed code to eliminate the (0 courses) after empty categories. */
-                      $htmlListCat .= '<li>';
+                        $htmlListCat .= '<li>';
                     $htmlListCat .= $catLine['name'];
                     $htmlListCat .= "</li>";
                     $thereIsSubCat = true;
@@ -639,11 +639,11 @@ 
     }
 
     /**
-    * retrieves all the courses that the user has already subscribed to
-    * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University, Belgium
-    * @param int $user_id: the id of the user
-    * @return array an array containing all the information of the courses of the given user
-    */
+     * retrieves all the courses that the user has already subscribed to
+     * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University, Belgium
+     * @param int $user_id: the id of the user
+     * @return array an array containing all the information of the courses of the given user
+     */
     public function get_courses_of_user($user_id)
     {
         $table_course = Database::get_main_table(TABLE_MAIN_COURSE);

main/tracking/course_log_tools.php

Indentation +2 added lines, -2 removed lines

@@ -78,7 +78,7 @@ 
 
 // getting all the students of the course
 if (empty($session_id)) {
-	// Registered students in a course outside session.
+    // Registered students in a course outside session.
     $a_students = CourseManager:: get_student_list_from_course_code(
         api_get_course_id(),
         false,
@@ -89,7 +89,7 @@ 
         api_get_group_id()
     );
 } else {
-	// Registered students in session.
+    // Registered students in session.
     $a_students = CourseManager:: get_student_list_from_course_code(
         api_get_course_id(),
         true,

main/tracking/courseLog.php

Indentation +1 added lines, -1 removed lines

@@ -111,7 +111,7 @@
                             get_lang('HideColumn'),
                             array('align' => 'absmiddle', 'hspace' => '3px'),
                             ICON_SIZE_SMALL
-                         ) . "</div>'
+                            ) . "</div>'
                     );
                 }
             );