2 /*=====================================================================*\
3 || ###################################################################
4 || # Blue Static ISSO Framework [#]issoversion[#]
5 || # Copyright ©2002-[#]year[#] Blue Static
7 || # This program is free software; you can redistribute it and/or modify
8 || # it under the terms of the GNU General Public License as published by
9 || # the Free Software Foundation; version [#]gpl[#] of the License.
11 || # This program is distributed in the hope that it will be useful, but
12 || # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13 || # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
16 || # You should have received a copy of the GNU General Public License along
17 || # with this program; if not, write to the Free Software Foundation, Inc.,
18 || # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
19 || ###################################################################
20 \*=====================================================================*/
23 * Blue Static ISSO Framework Kernel
29 if (!function_exists('version_compare'))
31 trigger_error('You need PHP version 4.1.0 or newer to run ISSO', E_USER_ERROR
);
35 // when we are PHP5-nat instead of PHP5-compat, we can remove this
36 if (version_compare(PHP_VERSION
, '5.0.0', '>='))
38 if (ini_get('error_reporting') & E_NOTICE
)
40 error_reporting(ini_get('error_reporting') - E_NOTICE
);
42 if (ini_get('error_reporting') & E_USER_NOTICE
)
44 error_reporting(ini_get('error_reporting') - E_USER_NOTICE
);
48 if ((bool
)ini_get('register_globals') === true
)
50 $superglobals = array('_GET', '_COOKIE', '_FILES', '_POST', '_SERVER', '_ENV');
51 foreach ($superglobals AS $global)
53 if (is_array($
{$global}))
55 foreach ($
{$global} AS $_key => $_val)
66 $oldlevel = ini_get('error_reporting');
67 $newlevel = $oldlevel;
68 $levels = array(E_ERROR
=> E_USER_ERROR
, E_WARNING
=> E_USER_WARNING
, E_NOTICE
=> E_USER_NOTICE
);
69 foreach ($levels AS $php => $isso)
73 if (!($oldlevel & $isso))
80 if ($oldlevel & $isso)
86 error_reporting($newlevel);
89 * Input cleaning type constant
94 define('TYPE_INT', 1);
99 define('TYPE_UINT', 2);
104 define('TYPE_FLOAT', 4);
109 define('TYPE_BOOL', 8);
114 define('TYPE_STR', 16);
117 * String - deliberate unclean
119 define('TYPE_STRUN', 32);
122 * No cleaning - here for use in API
124 define('TYPE_NOCLEAN', 64);
127 * Duplicate of TYPE_NOCLEAN, but shorter
129 define('TYPE_NONE', TYPE_NOCLEAN
);
132 * Macro for using DB->escape_binary() without cleaning - used in API
134 define('TYPE_BIN', 128);
140 define('REQ_YES', 1);
148 * Blue Static ISSO Framework (ISSO)
150 * This framework allows a common backend to be used amongst all Blue
151 * Static applications and is built to be abstract and flexible.
152 * The base framework handles all loading and module management.
155 * ISSO_NO_INPUT_SANITIZE - Disables the automatic input sanitizer
156 * ISSO_CHECK_POST_REFERER - Will check to make sure that on POSTed
157 * data, the referer matches the host
158 * ISSO_MT_START - Define the microtime() value at the top of your
159 * script and this will calculate the total execution
161 * SVN - Place SVN keywords (like $Id) to display the information on output
163 * @author Blue Static
164 * @copyright Copyright ©2002 - [#]year[#], Blue Static
165 * @version $Revision$
176 var $version = '[#]issoversion[#]';
179 * Location of ISSO, used for internal linking
183 var $sourcepath = '';
186 * Path of the current application
193 * Web path used to get the web location of the installation of ISSO; only used for Printer module
200 * Name of the current application
204 var $application = '';
207 * Version of the current application
211 var $appversion = '';
214 * Whether debug mode is on or off
221 * List of all active debug messages
225 var $debuginfo = array();
228 * List of loaded modules
232 var $modules = array();
235 * An array of sanitized variables that have been cleaned for HTML tag openers and double quotes
242 * If we are running with magic_quotes_gpc on or off
246 var $magicquotes = 0;
249 * Array of user-specified fields that are required for ISSO initialization
250 * fieldname => array(REQUIRED, CALLBACK PARSER, SET)
255 'webpath' => array(REQ_NO
, 'fetch_sourcepath', false
),
256 'application' => array(REQ_YES
, null
, false
),
257 'appversion' => array(REQ_NO
, null
, false
),
258 'debug' => array(REQ_NO
, null
, false
)
261 // ###################################################################
265 function __construct()
267 $GLOBALS['isso:callback'] = null
;
270 set_error_handler(array(&$this, '_error_handler'));
273 $this->magicquotes
= get_magic_quotes_gpc();
274 set_magic_quotes_runtime(0);
276 // some debug info that's always useful
277 $this->debug('magic_quotes_gpc = ' . $this->magicquotes
);
278 $this->debug('register_globals = ' . ini_get('register_globals'));
280 // attempt to set the sourcepath
281 $path = call_user_func('debug_backtrace');
282 $this->setSourcePath(str_replace('kernel.php', '', $path[0]['file']));
284 // start input sanitize using variable_order GPC
285 if (!defined('ISSO_NO_INPUT_SANITIZE'))
287 $this->exec_sanitize_data();
290 if (defined('ISSO_CHECK_POST_REFERER'))
292 $this->exec_referer_check();
296 // ###################################################################
298 * (PHP 4) Constructor
302 $this->__construct();
305 // ###################################################################
307 * Sets the sourcepath
311 * @param string Source path
313 function setSourcePath($path)
315 $this->sourcepath
= $this->fetch_sourcepath($path);
318 // ###################################################################
320 * Gets the sourcepath
324 * @return string Source path
326 function getSourcePath()
328 return $this->sourcepath
;
331 // ###################################################################
337 * @param string Application path
339 function setAppPath($path)
341 $this->apppath
= $this->fetch_sourcepath($path);
344 // ###################################################################
350 * @return string Source path
352 function getAppPath()
354 return $this->apppath
;
357 // ###################################################################
359 * Prepares a path for being set as the sourcepath
363 * @param string Source path or URL
365 * @return string Prepared source path
367 function fetch_sourcepath($source)
369 if (substr($source, strlen($source) - 1) != DIRECTORY_SEPARATOR
)
371 $source .= DIRECTORY_SEPARATOR
;
376 // ###################################################################
378 * Loads a framework module
382 * @param string Name of the framework file to load
383 * @param string Internal variable to initialize as; to not instantiate (just require) leave it as NULL
384 * @param bool Globalize the internal variable?
386 * @return object Instantiated instance
388 function &load($framework, $asobject, $globalize = false
)
390 $this->check_isso_fields(null
);
392 // set the object interlock
393 if (!method_exists($GLOBALS['isso:callback'], 'load'))
395 $GLOBALS['isso:callback'] =& $this;
396 $this->modules
['isso'] =& $this;
399 if ($this->is_loaded($framework))
401 return $this->modules
["$framework"];
404 if ($this->sourcepath
== '')
406 trigger_error('Invalid sourcepath specified', E_USER_ERROR
);
409 if (file_exists($this->sourcepath
. $framework . '.php'))
411 require_once($this->sourcepath
. $framework . '.php');
415 trigger_error('Could not find the framework ' . $this->sourcepath
. $framework . '.php', E_USER_ERROR
);
418 if ($asobject === null
)
423 if (isset($this->$asobject))
425 trigger_error('Cannot instantiate framework `' . $framework . '` into `' . $asobject . '`', E_USER_ERROR
);
428 $this->$asobject = new $framework($this);
430 $this->modules
["$framework"] =& $this->$asobject;
434 $GLOBALS["$asobject"] =& $this->$asobject;
437 // allow for init_as_package to link
438 if (method_exists($this->modules
["$framework"], 'init_as_package'))
440 $this->modules
[ $this->modules
["$framework"]->init_as_package() ] =& $this->modules
["$framework"];
443 return $this->$asobject;
446 // ###################################################################
448 * Prints a list of all currently loaded framework modules
452 * @param bool Return the data as an array?
454 * @return mixed HTML output or an array of loaded modules
456 function show_modules($return = false
)
459 foreach ($this->modules
AS $object)
461 $module = get_class($object);
462 if (method_exists($object, 'init_as_package') AND in_array($module, $modules))
464 $module = $object->init_as_package() . " - ($module)";
467 $modules[] = $module;
476 $output = "\n\n<ul>\n\t<li>";
477 $output .= implode("</li>\n\t<li>", $modules);
478 $output .= "</li>\n</ul>\n\n";
479 $this->message('Loaded Modules', $output, 1);
483 // ###################################################################
485 * Verifies to see if a framework has been loaded
489 * @param string Framework name
491 * @return bool Whether or not the framework has been loaded
493 function is_loaded($framework)
495 if (isset($this->modules
["$framework"]))
505 // ###################################################################
507 * Prints an ISSO message
511 * @param string The title of the message
512 * @param string The content of the message
513 * @param integer Type of message to be printed
514 * @param bool Return the output?
515 * @param bool Show the debug stack?
516 * @param integer Message width
518 * @return mixed Output or null
520 function message($title, $message, $type, $return = false
, $stack = true
, $width = 500)
545 $backtrace = debug_backtrace();
546 array_shift($backtrace);
548 if (isset($backtrace[0]) AND $backtrace[0]['function'] == '_error_handler')
550 array_shift($backtrace);
553 $trace = $this->format_debug_trace($backtrace);
555 $output = "\n<br />\n<table cellpadding=\"4\" cellspacing=\"1\" border=\"0\" width=\"$width\" style=\"background-color: $color; color: black; font-family: Verdana, sans-serif; font-size: 12px;\">";
556 $output .= "\n<tr style=\"color: $font; text-align: left\">\n\t<td><strong>$prefix: $title</strong></td>\n</tr>";
557 $output .= "\n<tr style=\"background-color: #FFFFFF; text-align: left\">\n\t<td>$message</td>\n</tr>";
558 $output .= (($stack AND $GLOBALS['isso:callback']->debug
) ?
"\n<tr style=\"background-color: #FFFFFF; text-align: left\">\n\t<td><strong>Debug Stack:</strong> <pre>" . implode("\n", $trace) . "</pre></td>\n</tr>" : '');
559 $output .= "\n</table>\n<br />\n";
571 // ###################################################################
573 * Prepares a debug_backtrace() array for output to the browser by
574 * compressing the array into visible text
578 * @param array debug_backtrace() array
580 * @return array Formatted trace output
582 function format_debug_trace($backtrace)
585 foreach ($backtrace AS $i => $step)
588 $file = $step['file'] . ':' . $step['line'];
589 $funct = (isset($step['class']) ?
$step['class'] . '::' . $step['function'] : $step['function']);
591 if (isset($step['args']) AND is_array($step['args']))
593 // we need to do this so we don't get "Array to string conversion" notices
594 foreach ($step['args'] AS $id => $arg)
598 $step['args']["$id"] = 'Array';
601 $args = implode(', ', $step['args']);
604 $trace[] = "#$i $funct($args) called at [$file]";
610 // ###################################################################
612 * Custom error handler for ISSO; only handle E_WARNING, E_NOTICE,
613 * E_USER_ERROR, E_USER_WARNING, E_USER_NOTICE
617 * @param integer Error number
618 * @param string Error message string
619 * @param string File that contains the error
620 * @param string The line number of the error
621 * @param string The active symbol table at which point the error occurred
623 function _error_handler($errno, $errstr, $errfile, $errline, $errcontext)
625 $level = ini_get('error_reporting');
633 if (!($level & E_USER_ERROR
))
644 if (! (($level & E_USER_WARNING
) AND ($level & E_WARNING
)) )
656 if (! (($level & E_USER_NOTICE
) AND ($level & E_NOTICE
)) )
663 $errstr .= " in <strong>$errfile</strong> on line <strong>$errline</strong>";
665 $errstr = str_replace(array(getcwd(), dirname(getcwd())), '', $errstr);
667 $this->message($title, $errstr, $mode);
669 if ($errno == E_USER_ERROR
)
675 // ###################################################################
677 * Creates a table that explains the error reporting levels and their
682 function explain_error_reporting()
685 'E_ERROR' => E_ERROR
,
686 'E_WARNING' => E_WARNING
,
687 'E_PARSE' => E_PARSE
,
688 'E_NOTICE' => E_NOTICE
,
689 'E_CORE_ERROR' => E_CORE_ERROR
,
690 'E_CORE_WARNING' => E_CORE_WARNING
,
691 'E_COMPILE_ERROR' => 64,
692 'E_COMPILE_WARNING' => 128,
693 'E_USER_ERROR' => E_USER_ERROR
,
694 'E_USER_WARNING' => E_USER_WARNING
,
695 'E_USER_NOTICE' => E_USER_NOTICE
,
700 $table = '<table cellspacing="0" cellpadding="2" border="0">';
702 foreach ($levels AS $name => $value)
706 <td>' . $name . '</td>
707 <td>' . (ini_get('error_reporting') & $value) . '</td>
714 $this->message('Error Reporting', $table, 1);
717 // ###################################################################
719 * Logs a debug message for verbose output
723 * @param string Message
725 function debug($message)
727 $this->debuginfo
[] = $message;
730 // ###################################################################
732 * Recursive XSS cleaner
736 * @param mixed Unsanitized REQUEST data
738 * @return mixed Sanitized data
740 function _sanitize_input_recursive($data)
742 foreach ($data AS $key => $value)
744 if (is_array($value))
746 $data["$key"] = $this->_sanitize_input_recursive($value);
750 if ($this->magicquotes
)
752 $value = str_replace("\'", "'", $value);
754 $data["$key"] = $this->sanitize($value);
760 // ###################################################################
762 * Simple way to protect against HTML attacks with Unicode support
766 * @param string Unsanitzed text
768 * @return string Properly protected text that only encodes potential threats
770 function sanitize($text)
772 if ($this->magicquotes
)
774 return str_replace(array('<', '>', '\"', '"'), array('<', '>', '"', '"'), $text);
778 return str_replace(array('<', '>', '"'), array('<', '>', '"'), $text);
782 // ###################################################################
784 * Unicode-safe entity encoding system; similar to sanitize()
788 * @param string Unsanitized text
790 * @return string Unicode-safe sanitized text with entities preserved
792 function entity_encode($text)
794 $text = str_replace('&', '&', $text);
795 $text = $this->sanitize($text);
799 // ###################################################################
801 * Takes text that has been processed for HTML and unsanitizes it
805 * @param string Text that needs to be turned back into HTML
807 * @return string Unsanitized text
809 function unsanitize($text)
811 return str_replace(array('<', '>', '"'), array('<', '>', '"'), $text);
814 // ###################################################################
816 * Smart addslashes() that only applies itself it the Magic Quotes GPC
817 * is off. This should only be run on database query values that come
818 * from ISSO->in[] input; data that needs sanitization should be run
819 * through ISSO->DB->escape_string()
823 * @param string Some string
824 * @param bool Force magic quotes to be off
826 * @return string String that has slashes added
828 function escape($str, $force = true
)
830 if ($this->magicquotes
AND !$force)
832 if (isset($this->modules
[ISSO_DB_LAYER
]))
834 return $this->modules
[ISSO_DB_LAYER
]->escape_string(str_replace(array("\'", '\"'), array("'", '"'), $str));
840 if (isset($this->modules
[ISSO_DB_LAYER
]))
842 return $this->modules
[ISSO_DB_LAYER
]->escape_string($str);
844 return addslashes($str);
848 // ###################################################################
850 * Runs through all of the input data and sanitizes it.
854 function exec_sanitize_data()
856 $this->in
= $this->_sanitize_input_recursive(array_merge($_GET, $_POST, $_COOKIE));
859 // ###################################################################
861 * Sanitize function for something other than a string (which
862 * everything is sanitized for if you use exec_sanitize_data(). Cleaned
863 * data is placed back into $isso->in; this makes it so you don't have
864 * to constantly intval() [etc.] data.
868 * @param array Array of elements to clean as varname => type
870 function input_clean_array($vars)
872 foreach ($vars AS $varname => $type)
874 $this->input_clean($varname, $type);
878 // ###################################################################
880 * Sanitize function that does a single variable as oppoesd to an array
881 * (see input_clean_array() for more details)
885 * @param string Variable name in $isso->in[]
886 * @param integer Sanitization type constant
888 function input_clean($varname, $type)
890 if (isset($this->in
["$varname"]))
892 $this->in
["$varname"] = $this->clean($this->in
["$varname"], $type);
896 $this->in
["$varname"] = $this->clean(null
, $type);
899 return $this->in
["$varname"];
902 // ###################################################################
904 * Runs ISSO->escape() on a variable on ISSO->in[]. This is just a
905 * short-hand wrapper so that queries can be shortened. When this is used,
906 * the actual value in ISSO->in[] is not changed, only the return value
911 * @param string Input variable
913 * @return string Escaped input
915 function input_escape($varname)
917 if (isset($this->in
["$varname"]))
919 return $this->escape($this->in
["$varname"]);
923 return $this->escape(null
);
927 // ###################################################################
929 * Cleaning function that does the work for input_clean(); this is
930 * moved here so it can be used to clean things that aren't in
936 * @param integer Sanitization type constant
938 * @return mixed Cleaned data
940 function clean($value, $type)
942 if (is_array($value))
944 return $this->clean_array($value, $type);
947 if ($type == TYPE_INT
)
949 $value = intval($value);
951 else if ($type == TYPE_UINT
)
953 $value = (($val = intval($value)) < 0 ?
0 : $val);
955 else if ($type == TYPE_FLOAT
)
957 $value = floatval($value);
959 else if ($type == TYPE_BOOL
)
961 $value = (bool
)$value;
963 else if ($type == TYPE_STR
)
967 else if ($type == TYPE_STRUN
)
969 $value = $this->unsanitize($value);
971 else if ($type == TYPE_NOCLEAN
)
973 if ($this->magicquotes
)
975 $value = str_replace(array('\"', "\'"), array('"', "'"), $value);
982 else if ($type == TYPE_BIN
)
988 trigger_error('Invalid clean type `' . $type . '` specified', E_USER_ERROR
);
994 // ###################################################################
996 * Recursion function for ISSO->clean()
1000 * @param array Uncleaned array
1001 * @param integer Sanitization type constant
1003 * @return array Cleaned array of data
1005 function clean_array($array, $type)
1007 foreach ($array AS $key => $value)
1009 $array["$key"] = $this->clean($value, $type);
1015 // ###################################################################
1017 * Checks to see if a POST refer is actually from us
1021 function exec_referer_check()
1023 if ($_SERVER['REQUEST_METHOD'] == 'POST')
1025 $host = ($_SERVER['HTTP_HOST']) ?
$_SERVER['HTTP_HOST'] : $_ENV['HTTP_HOST'];
1027 if ($host AND $_SERVER['HTTP_REFERER'])
1029 $parts = parse_url($_SERVER['HTTP_REFERER']);
1030 $ourhost = $parts['host'] . (isset($parts['port']) ?
":$parts[port]" : '');
1032 if ($ourhost != $host)
1034 trigger_error('No external hosts are allowed to POST to this application', E_USER_ERROR
);
1036 $this->debug('remote post check = ok');
1040 $this->debug('remote post check = FAILED');
1045 // ###################################################################
1047 * Constructs a debug information box that contains various debugging
1048 * information points
1052 * @param bool Show template information?
1054 * @return string Debugging block
1056 function construct_debug_block($dotemplates)
1069 foreach ($this->modules
['template']->usage
AS $name => $count)
1071 if (in_array($name, $this->modules
['template']->uncached
))
1073 $optlist[] = $name . '[' . $count . ']';
1075 $usage[] = $name . " ($count)";
1078 $sizeof = sizeof($this->modules
['template']->uncached
);
1081 $debug .= "\n\t<li><strong style=\"color: red\">Uncached Template(s):</strong> $sizeof ( " . implode(' ', $optlist) . " )</li>";
1086 $scinfo = 'Not Under Source Control';
1089 $scinfo = constant('SVN');
1091 if (preg_match('#\$Id:?\s*\$#', $scinfo))
1093 $scinfo = 'Not Under Source Control';
1097 $scinfo = preg_replace('#\$' . '(Head)?URL: (.+?) \$#e', "end(explode('/', '\\2'))", $scinfo);
1098 $scinfo = preg_replace('#\$' . '(LastModified)?Revision: (.+?) \$#', 'SVN \\2', $scinfo);
1099 $scinfo = preg_replace('#\$' . 'Id: (.+?) ([0-9].+?) [0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}(.+?) (.+?) \$#', '\\1 - SVN \\2', $scinfo);
1103 $scinfo = trim($scinfo);
1104 $debug .= "\n\t<li><strong>Source Control:</strong> $scinfo</li>";
1106 // query information
1107 if (is_object($this->modules
[ISSO_DB_LAYER
]))
1109 $debug .= "\n\t<li><strong>Total Queries:</strong> " . sizeof($this->modules
[ISSO_DB_LAYER
]->history
) . " (<a href=\"" . $this->sanitize($_SERVER['REQUEST_URI']) . ((strpos($_SERVER['REQUEST_URI'], '?') !== false
) ?
'&query=1' : '?query=1') . "\">?</a>)</li>";
1112 // total execution time
1113 if (defined('ISSO_MT_START'))
1115 $this->load('functions', 'functions');
1116 $debug .= "\n\t<li><strong>Total Execution Time:</strong> " . round($this->modules
['functions']->fetch_microtime_diff(ISSO_MT_START
), 10) . "</li>";
1120 $debug .= "\n\t<li>\n\t\t<select>\n\t\t\t<option>Debug Notices (" . sizeof($this->debuginfo
) . ")</option>";
1121 foreach ((array)$this->debuginfo
AS $msg)
1123 $debug .= "\n\t\t\t<option>--- $msg</option>";
1125 $debug .= "\n\t\t</select>\n\t</li>";
1128 $modules = $this->show_modules(true
);
1129 $debug .= "\n\t<li>\n\t\t<select>\n\t\t\t<option>Loaded Modules (" . sizeof($modules) . ")</option>";
1130 foreach ($modules AS $mod)
1132 $debug .= "\n\t\t\t<option>--- $mod</option>";
1134 $debug .= "\n\t\t</select>\n\t</li>";
1139 $debug .= "\n\t<li>\n\t\t<select>\n\t\t\t<option>Template Usage (" . array_sum($this->modules
['template']->usage
) . ")</option>";
1140 foreach ($usage AS $tpl)
1142 $debug .= "\n\t\t\t<option>--- $tpl</option>";
1144 $debug .= "\n\t\t</select>\n\t</li>";
1147 $debug .= "\n</ul>";
1149 $debug = "\n\n<!-- dev debug -->\n<div align=\"center\">\n\n<hr />\n" . $this->message('Debug Information', $debug, 1, true
, false
) . "\n</div>\n<!-- / dev debug -->\n\n";
1156 /*=====================================================================*\
1157 || ###################################################################
1160 || ###################################################################
1161 \*=====================================================================*/