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;
248 // ###################################################################
252 function __construct()
254 $GLOBALS['isso:callback'] = null
;
257 set_error_handler(array(&$this, '_error_handler'));
260 $this->magicquotes
= get_magic_quotes_gpc();
261 set_magic_quotes_runtime(0);
263 // some debug info that's always useful
264 $this->debug('magic_quotes_gpc = ' . $this->magicquotes
);
265 $this->debug('register_globals = ' . ini_get('register_globals'));
267 // attempt to set the sourcepath
268 $path = call_user_func('debug_backtrace');
269 $this->setSourcePath(str_replace('kernel.php', '', $path[0]['file']));
271 // start input sanitize using variable_order GPC
272 if (!defined('ISSO_NO_INPUT_SANITIZE'))
274 $this->exec_sanitize_data();
277 if (defined('ISSO_CHECK_POST_REFERER'))
279 $this->exec_referer_check();
283 // ###################################################################
285 * (PHP 4) Constructor
289 $this->__construct();
292 // ###################################################################
294 * Sets the sourcepath
298 * @param string Source path
300 function setSourcePath($path)
302 $this->sourcepath
= $this->fetch_sourcepath($path);
305 // ###################################################################
307 * Gets the sourcepath
311 * @return string Source path
313 function getSourcePath()
315 return $this->sourcepath
;
318 // ###################################################################
324 * @param string Application path
326 function setAppPath($path)
328 $this->apppath
= $this->fetch_sourcepath($path);
331 // ###################################################################
337 * @return string Source path
339 function getAppPath()
341 return $this->apppath
;
344 // ###################################################################
350 * @param string Web path
352 function setWebPath($path)
354 $this->webpath
= $this->fetch_sourcepath($path);
357 // ###################################################################
363 * @return string Web path
365 function getWebPath()
367 return $this->webpath
;
370 // ###################################################################
372 * Sets the applicaiton
376 * @param string Applicaiton
378 function setApplication($app)
380 $this->application
= $app;
383 // ###################################################################
385 * Gets the application
389 * @return string Application
391 function getApplication()
393 return $this->application
;
396 // ###################################################################
398 * Sets the appverison
402 * @param string Applicaiton version
404 function setAppVersion($version)
406 $this->appversion
= $version;
409 // ###################################################################
411 * Gets the appversion
415 * @return string Application version
417 function getAppVersion()
419 return $this->appversion
;
422 // ###################################################################
428 * @param boolean Debug?
430 function setDebug($debug)
432 $this->debug
= $debug;
435 // ###################################################################
437 * Gets debug mode state
441 * @return boolean Debug?
448 // ###################################################################
450 * Prepares a path for being set as the sourcepath
454 * @param string Source path or URL
456 * @return string Prepared source path
458 function fetch_sourcepath($source)
460 if (substr($source, strlen($source) - 1) != DIRECTORY_SEPARATOR
)
462 $source .= DIRECTORY_SEPARATOR
;
467 // ###################################################################
469 * Loads a framework module
473 * @param string Name of the framework file to load
474 * @param string Internal variable to initialize as; to not instantiate (just require) leave it as NULL
475 * @param bool Globalize the internal variable?
477 * @return object Instantiated instance
479 function &load($framework, $asobject, $globalize = false
)
481 // set the object interlock
482 if (!method_exists($GLOBALS['isso:callback'], 'load'))
484 $GLOBALS['isso:callback'] =& $this;
485 $this->modules
['isso'] =& $this;
488 if ($this->is_loaded($framework))
490 return $this->modules
["$framework"];
493 if ($this->sourcepath
== '')
495 trigger_error('Invalid sourcepath specified', E_USER_ERROR
);
498 if (file_exists($this->sourcepath
. $framework . '.php'))
500 require_once($this->sourcepath
. $framework . '.php');
504 trigger_error('Could not find the framework ' . $this->sourcepath
. $framework . '.php', E_USER_ERROR
);
507 if ($asobject === null
)
512 if (isset($this->$asobject))
514 trigger_error('Cannot instantiate framework `' . $framework . '` into `' . $asobject . '`', E_USER_ERROR
);
517 $this->$asobject = new $framework($this);
519 $this->modules
["$framework"] =& $this->$asobject;
523 $GLOBALS["$asobject"] =& $this->$asobject;
526 // allow for init_as_package to link
527 if (method_exists($this->modules
["$framework"], 'init_as_package'))
529 $this->modules
[ $this->modules
["$framework"]->init_as_package() ] =& $this->modules
["$framework"];
532 return $this->$asobject;
535 // ###################################################################
537 * Prints a list of all currently loaded framework modules
541 * @param bool Return the data as an array?
543 * @return mixed HTML output or an array of loaded modules
545 function show_modules($return = false
)
548 foreach ($this->modules
AS $object)
550 $module = get_class($object);
551 if (method_exists($object, 'init_as_package') AND in_array($module, $modules))
553 $module = $object->init_as_package() . " - ($module)";
556 $modules[] = $module;
565 $output = "\n\n<ul>\n\t<li>";
566 $output .= implode("</li>\n\t<li>", $modules);
567 $output .= "</li>\n</ul>\n\n";
568 $this->message('Loaded Modules', $output, 1);
572 // ###################################################################
574 * Verifies to see if a framework has been loaded
578 * @param string Framework name
580 * @return bool Whether or not the framework has been loaded
582 function is_loaded($framework)
584 if (isset($this->modules
["$framework"]))
594 // ###################################################################
596 * Prints an ISSO message
600 * @param string The title of the message
601 * @param string The content of the message
602 * @param integer Type of message to be printed
603 * @param bool Return the output?
604 * @param bool Show the debug stack?
605 * @param integer Message width
607 * @return mixed Output or null
609 function message($title, $message, $type, $return = false
, $stack = true
, $width = 500)
634 $backtrace = debug_backtrace();
635 array_shift($backtrace);
637 if (isset($backtrace[0]) AND $backtrace[0]['function'] == '_error_handler')
639 array_shift($backtrace);
642 $trace = $this->format_debug_trace($backtrace);
644 $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;\">";
645 $output .= "\n<tr style=\"color: $font; text-align: left\">\n\t<td><strong>$prefix: $title</strong></td>\n</tr>";
646 $output .= "\n<tr style=\"background-color: #FFFFFF; text-align: left\">\n\t<td>$message</td>\n</tr>";
647 $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>" : '');
648 $output .= "\n</table>\n<br />\n";
660 // ###################################################################
662 * Prepares a debug_backtrace() array for output to the browser by
663 * compressing the array into visible text
667 * @param array debug_backtrace() array
669 * @return array Formatted trace output
671 function format_debug_trace($backtrace)
674 foreach ($backtrace AS $i => $step)
677 $file = $step['file'] . ':' . $step['line'];
678 $funct = (isset($step['class']) ?
$step['class'] . '::' . $step['function'] : $step['function']);
680 if (isset($step['args']) AND is_array($step['args']))
682 // we need to do this so we don't get "Array to string conversion" notices
683 foreach ($step['args'] AS $id => $arg)
687 $step['args']["$id"] = 'Array';
690 $args = implode(', ', $step['args']);
693 $trace[] = "#$i $funct($args) called at [$file]";
699 // ###################################################################
701 * Custom error handler for ISSO; only handle E_WARNING, E_NOTICE,
702 * E_USER_ERROR, E_USER_WARNING, E_USER_NOTICE
706 * @param integer Error number
707 * @param string Error message string
708 * @param string File that contains the error
709 * @param string The line number of the error
710 * @param string The active symbol table at which point the error occurred
712 function _error_handler($errno, $errstr, $errfile, $errline, $errcontext)
714 $level = ini_get('error_reporting');
722 if (!($level & E_USER_ERROR
))
733 if (! (($level & E_USER_WARNING
) AND ($level & E_WARNING
)) )
745 if (! (($level & E_USER_NOTICE
) AND ($level & E_NOTICE
)) )
752 $errstr .= " in <strong>$errfile</strong> on line <strong>$errline</strong>";
754 $errstr = str_replace(array(getcwd(), dirname(getcwd())), '', $errstr);
756 $this->message($title, $errstr, $mode);
758 if ($errno == E_USER_ERROR
)
764 // ###################################################################
766 * Creates a table that explains the error reporting levels and their
771 function explain_error_reporting()
774 'E_ERROR' => E_ERROR
,
775 'E_WARNING' => E_WARNING
,
776 'E_PARSE' => E_PARSE
,
777 'E_NOTICE' => E_NOTICE
,
778 'E_CORE_ERROR' => E_CORE_ERROR
,
779 'E_CORE_WARNING' => E_CORE_WARNING
,
780 'E_COMPILE_ERROR' => 64,
781 'E_COMPILE_WARNING' => 128,
782 'E_USER_ERROR' => E_USER_ERROR
,
783 'E_USER_WARNING' => E_USER_WARNING
,
784 'E_USER_NOTICE' => E_USER_NOTICE
,
789 $table = '<table cellspacing="0" cellpadding="2" border="0">';
791 foreach ($levels AS $name => $value)
795 <td>' . $name . '</td>
796 <td>' . (ini_get('error_reporting') & $value) . '</td>
803 $this->message('Error Reporting', $table, 1);
806 // ###################################################################
808 * Logs a debug message for verbose output
812 * @param string Message
814 function debug($message)
816 $this->debuginfo
[] = $message;
819 // ###################################################################
821 * Recursive XSS cleaner
825 * @param mixed Unsanitized REQUEST data
827 * @return mixed Sanitized data
829 function _sanitize_input_recursive($data)
831 foreach ($data AS $key => $value)
833 if (is_array($value))
835 $data["$key"] = $this->_sanitize_input_recursive($value);
839 if ($this->magicquotes
)
841 $value = str_replace("\'", "'", $value);
843 $data["$key"] = $this->sanitize($value);
849 // ###################################################################
851 * Simple way to protect against HTML attacks with Unicode support
855 * @param string Unsanitzed text
857 * @return string Properly protected text that only encodes potential threats
859 function sanitize($text)
861 if ($this->magicquotes
)
863 return str_replace(array('<', '>', '\"', '"'), array('<', '>', '"', '"'), $text);
867 return str_replace(array('<', '>', '"'), array('<', '>', '"'), $text);
871 // ###################################################################
873 * Unicode-safe entity encoding system; similar to sanitize()
877 * @param string Unsanitized text
879 * @return string Unicode-safe sanitized text with entities preserved
881 function entity_encode($text)
883 $text = str_replace('&', '&', $text);
884 $text = $this->sanitize($text);
888 // ###################################################################
890 * Takes text that has been processed for HTML and unsanitizes it
894 * @param string Text that needs to be turned back into HTML
896 * @return string Unsanitized text
898 function unsanitize($text)
900 return str_replace(array('<', '>', '"'), array('<', '>', '"'), $text);
903 // ###################################################################
905 * Smart addslashes() that only applies itself it the Magic Quotes GPC
906 * is off. This should only be run on database query values that come
907 * from ISSO->in[] input; data that needs sanitization should be run
908 * through ISSO->DB->escape_string()
912 * @param string Some string
913 * @param bool Force magic quotes to be off
915 * @return string String that has slashes added
917 function escape($str, $force = true
)
919 if ($this->magicquotes
AND !$force)
921 if (isset($this->modules
[ISSO_DB_LAYER
]))
923 return $this->modules
[ISSO_DB_LAYER
]->escape_string(str_replace(array("\'", '\"'), array("'", '"'), $str));
929 if (isset($this->modules
[ISSO_DB_LAYER
]))
931 return $this->modules
[ISSO_DB_LAYER
]->escape_string($str);
933 return addslashes($str);
937 // ###################################################################
939 * Runs through all of the input data and sanitizes it.
943 function exec_sanitize_data()
945 $this->in
= $this->_sanitize_input_recursive(array_merge($_GET, $_POST, $_COOKIE));
948 // ###################################################################
950 * Sanitize function for something other than a string (which
951 * everything is sanitized for if you use exec_sanitize_data(). Cleaned
952 * data is placed back into $isso->in; this makes it so you don't have
953 * to constantly intval() [etc.] data.
957 * @param array Array of elements to clean as varname => type
959 function input_clean_array($vars)
961 foreach ($vars AS $varname => $type)
963 $this->input_clean($varname, $type);
967 // ###################################################################
969 * Sanitize function that does a single variable as oppoesd to an array
970 * (see input_clean_array() for more details)
974 * @param string Variable name in $isso->in[]
975 * @param integer Sanitization type constant
977 function input_clean($varname, $type)
979 if (isset($this->in
["$varname"]))
981 $this->in
["$varname"] = $this->clean($this->in
["$varname"], $type);
985 $this->in
["$varname"] = $this->clean(null
, $type);
988 return $this->in
["$varname"];
991 // ###################################################################
993 * Runs ISSO->escape() on a variable on ISSO->in[]. This is just a
994 * short-hand wrapper so that queries can be shortened. When this is used,
995 * the actual value in ISSO->in[] is not changed, only the return value
1000 * @param string Input variable
1002 * @return string Escaped input
1004 function input_escape($varname)
1006 if (isset($this->in
["$varname"]))
1008 return $this->escape($this->in
["$varname"]);
1012 return $this->escape(null
);
1016 // ###################################################################
1018 * Cleaning function that does the work for input_clean(); this is
1019 * moved here so it can be used to clean things that aren't in
1025 * @param integer Sanitization type constant
1027 * @return mixed Cleaned data
1029 function clean($value, $type)
1031 if (is_array($value))
1033 return $this->clean_array($value, $type);
1036 if ($type == TYPE_INT
)
1038 $value = intval($value);
1040 else if ($type == TYPE_UINT
)
1042 $value = (($val = intval($value)) < 0 ?
0 : $val);
1044 else if ($type == TYPE_FLOAT
)
1046 $value = floatval($value);
1048 else if ($type == TYPE_BOOL
)
1050 $value = (bool
)$value;
1052 else if ($type == TYPE_STR
)
1056 else if ($type == TYPE_STRUN
)
1058 $value = $this->unsanitize($value);
1060 else if ($type == TYPE_NOCLEAN
)
1062 if ($this->magicquotes
)
1064 $value = str_replace(array('\"', "\'"), array('"', "'"), $value);
1071 else if ($type == TYPE_BIN
)
1077 trigger_error('Invalid clean type `' . $type . '` specified', E_USER_ERROR
);
1083 // ###################################################################
1085 * Recursion function for ISSO->clean()
1089 * @param array Uncleaned array
1090 * @param integer Sanitization type constant
1092 * @return array Cleaned array of data
1094 function clean_array($array, $type)
1096 foreach ($array AS $key => $value)
1098 $array["$key"] = $this->clean($value, $type);
1104 // ###################################################################
1106 * Checks to see if a POST refer is actually from us
1110 function exec_referer_check()
1112 if ($_SERVER['REQUEST_METHOD'] == 'POST')
1114 $host = ($_SERVER['HTTP_HOST']) ?
$_SERVER['HTTP_HOST'] : $_ENV['HTTP_HOST'];
1116 if ($host AND $_SERVER['HTTP_REFERER'])
1118 $parts = parse_url($_SERVER['HTTP_REFERER']);
1119 $ourhost = $parts['host'] . (isset($parts['port']) ?
":$parts[port]" : '');
1121 if ($ourhost != $host)
1123 trigger_error('No external hosts are allowed to POST to this application', E_USER_ERROR
);
1125 $this->debug('remote post check = ok');
1129 $this->debug('remote post check = FAILED');
1134 // ###################################################################
1136 * Constructs a debug information box that contains various debugging
1137 * information points
1141 * @param bool Show template information?
1143 * @return string Debugging block
1145 function construct_debug_block($dotemplates)
1158 foreach ($this->modules
['template']->usage
AS $name => $count)
1160 if (in_array($name, $this->modules
['template']->uncached
))
1162 $optlist[] = $name . '[' . $count . ']';
1164 $usage[] = $name . " ($count)";
1167 $sizeof = sizeof($this->modules
['template']->uncached
);
1170 $debug .= "\n\t<li><strong style=\"color: red\">Uncached Template(s):</strong> $sizeof ( " . implode(' ', $optlist) . " )</li>";
1175 $scinfo = 'Not Under Source Control';
1178 $scinfo = constant('SVN');
1180 if (preg_match('#\$Id:?\s*\$#', $scinfo))
1182 $scinfo = 'Not Under Source Control';
1186 $scinfo = preg_replace('#\$' . '(Head)?URL: (.+?) \$#e', "end(explode('/', '\\2'))", $scinfo);
1187 $scinfo = preg_replace('#\$' . '(LastModified)?Revision: (.+?) \$#', 'SVN \\2', $scinfo);
1188 $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);
1192 $scinfo = trim($scinfo);
1193 $debug .= "\n\t<li><strong>Source Control:</strong> $scinfo</li>";
1195 // query information
1196 if (is_object($this->modules
[ISSO_DB_LAYER
]))
1198 $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>";
1201 // total execution time
1202 if (defined('ISSO_MT_START'))
1204 $this->load('functions', 'functions');
1205 $debug .= "\n\t<li><strong>Total Execution Time:</strong> " . round($this->modules
['functions']->fetch_microtime_diff(ISSO_MT_START
), 10) . "</li>";
1209 $debug .= "\n\t<li>\n\t\t<select>\n\t\t\t<option>Debug Notices (" . sizeof($this->debuginfo
) . ")</option>";
1210 foreach ((array)$this->debuginfo
AS $msg)
1212 $debug .= "\n\t\t\t<option>--- $msg</option>";
1214 $debug .= "\n\t\t</select>\n\t</li>";
1217 $modules = $this->show_modules(true
);
1218 $debug .= "\n\t<li>\n\t\t<select>\n\t\t\t<option>Loaded Modules (" . sizeof($modules) . ")</option>";
1219 foreach ($modules AS $mod)
1221 $debug .= "\n\t\t\t<option>--- $mod</option>";
1223 $debug .= "\n\t\t</select>\n\t</li>";
1228 $debug .= "\n\t<li>\n\t\t<select>\n\t\t\t<option>Template Usage (" . array_sum($this->modules
['template']->usage
) . ")</option>";
1229 foreach ($usage AS $tpl)
1231 $debug .= "\n\t\t\t<option>--- $tpl</option>";
1233 $debug .= "\n\t\t</select>\n\t</li>";
1236 $debug .= "\n</ul>";
1238 $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";
1245 /*=====================================================================*\
1246 || ###################################################################
1249 || ###################################################################
1250 \*=====================================================================*/