]>
src.bluestatic.org Git - isso.git/blob - kernel.php
2 /*=====================================================================*\
3 || ###################################################################
4 || # Iris Studios Shared Object Framework [#]version[#]
5 || # Copyright ©2002-[#]year[#] Iris Studios, Inc.
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 * Iris Studios Shared Object 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 if (version_compare(PHP_VERSION
, '5.0.0', '>='))
37 if (ini_get('error_reporting') & E_NOTICE
)
39 error_reporting(ini_get('error_reporting') - E_NOTICE
);
41 if (ini_get('error_reporting') & E_USER_NOTICE
)
43 error_reporting(ini_get('error_reporting') - E_USER_NOTICE
);
47 $oldlevel = ini_get('error_reporting');
48 $newlevel = $oldlevel;
49 $levels = array(E_ERROR
=> E_USER_ERROR
, E_WARNING
=> E_USER_WARNING
, E_NOTICE
=> E_USER_NOTICE
);
50 foreach ($levels AS $php => $isso)
54 if (!($oldlevel & $isso))
61 if ($oldlevel & $isso)
67 error_reporting($newlevel);
69 if ((bool)ini_get('register_globals') === true)
71 $superglobals = array('_GET', '_COOKIE', '_FILES', '_POST', '_SERVER', '_ENV');
72 foreach ($superglobals AS $global)
74 if (is_array(${$global}))
76 foreach (${$global} AS $_key => $_val)
88 * Input cleaning type constant
93 define('TYPE_INT', 1);
98 define('TYPE_UINT', 2);
103 define('TYPE_FLOAT', 4);
108 define('TYPE_BOOL', 8);
113 define('TYPE_STR', 16);
116 * String - deliberate unclean
118 define('TYPE_STRUN', 32);
121 * No cleaning - here for use in API
123 define('TYPE_NOCLEAN', 64);
129 define('REQ_YES', 1);
137 * Iris Studios Shared Object Framework (ISSO)
139 * This framework allows a common backend to be used amongst all Iris
140 * Studios applications and is built to be abstract and flexible.
141 * The base framework handles all loading and module management.
144 * ISSO_NO_INPUT_SANITIZE - Disables the automatic input sanitizer
145 * ISSO_CHECK_POST_REFERER - Will check to make sure that on POSTed
146 * data, the referer matches the host
148 * @author Iris Studios, Inc.
149 * @copyright Copyright ©2002 - [#]year[#], Iris Studios, Inc.
150 * @version $Revision$
154 class Shared_Object_Framework
161 var $version = '[#]version[#]';
164 * Location of ISSO, used for internal linking
168 var $sourcepath = '';
171 * Path of the current application
178 * Web path used to get the web location of the installation of ISSO; only used for Printer module
185 * Name of the current application
189 var $application = '';
192 * Version of the current application
196 var $appversion = '';
199 * Whether debug mode is on or off
206 * List of all active debug messages
210 var $debuginfo = array();
213 * List of loaded modules
217 var $modules = array();
220 * An array of sanitized variables that have been cleaned for HTML tag openers and double quotes
227 * If we are running with magic_quotes_gpc on or off
231 var $magicquotes = 0;
234 * Array of user-specified fields that are required for ISSO initialization
235 * fieldname => array(REQUIRED, CALLBACK PARSER, SET)
240 'sourcepath' => array(REQ_YES
, 'fetch_sourcepath', false),
241 'apppath' => array(REQ_YES
, 'fetch_sourcepath', false),
242 'webpath' => array(REQ_NO
, 'fetch_sourcepath', false),
243 'application' => array(REQ_YES
, null, false),
244 'appversion' => array(REQ_NO
, null, false),
245 'debug' => array(REQ_NO
, null, false)
248 // ###################################################################
252 function __construct()
254 $GLOBALS['isso:null-framework'] = null;
257 set_error_handler(array(&$this, '_error_handler'));
260 $this->magicquotes
= get_magic_quotes_gpc();
261 set_magic_quotes_runtime(0);
263 // start input sanitize using variable_order GPC
264 if (!defined('ISSO_NO_INPUT_SANITIZE'))
266 $this->exec_sanitize_data();
269 if (defined('ISSO_CHECK_POST_REFERER'))
271 $this->exec_referer_check();
275 // ###################################################################
277 * (PHP 4) Constructor
279 function Shared_Object_Framework()
281 $this->__construct();
284 // ###################################################################
286 * Sets a specified field in the ISSO. This is used to set all the
287 * required fields that ISSO uses for linking. It replaces the old
288 * method of setting the instance variables directly.
292 * @param string Field name
293 * @param mixed Value of the field
295 function set($fieldname, $value)
297 $this->do_set($fieldname, $value, null);
300 // ###################################################################
302 * Does the actual setting of the field. set() is defined in each
303 * module, but this controls the actual data. This is done so that
304 * there isn't an extra parameter in set() that controls module spaces
308 * @param string Field name
310 * @param string Module name (as referred to in ISSO->modules[]) to place in
312 function do_set($fieldname, $value, $module)
316 $field =& $this->fields
["$fieldname"];
320 $field =& $this->modules["$module"]->fields
["$fieldname"];
323 if (is_array($field))
325 if ($field[1] != null)
327 if (preg_match('#^\$(.*)#', $field[1]))
329 $caller = preg_replace('#^\$(.*)->([a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*)$#e', 'array(&$\1, "\
2")', $field[1]);
333 $caller = array(&$this, $field[1]);
336 $value = call_user_func($caller, $value);
341 $this->$fieldname = $value;
345 $this->modules["$module"]->$fieldname = $value;
352 trigger_error('Invalid field `' . $module . '.' . $fieldname . '` specified in ISSO->do_set()', E_USER_ERROR
);
356 // ###################################################################
358 * Returns the value of an ISSO field. You should not access any instance
359 * variables directly, use this instead.
363 * @param string Field name
365 * @return mixed Value of the field
367 function get($fieldname)
369 if (is_array($this->fields
["$fieldname"]))
371 if ($this->fields["$fieldname"][2] == false)
373 trigger_error('Field `' . $fieldname . '` is not set and therefore cannot ISSO->get()', E_USER_ERROR
);
376 return $this->$fieldname;
380 trigger_error('Invalid field `' . $fieldname . '` specified in ISSO->get()', E_USER_ERROR
);
384 // ###################################################################
386 * Makes sure that all of the required fields in ISSO are set before
387 * any action is done. This will throw an error block describing
388 * the fields that need to be set if any are missing.
392 * @param string Module to check for; null is kernel, string is a module name, false is all
393 * @param bool Is this a non-error environment that should display all fields?
395 function check_isso_fields($module = null, $called = false)
399 if ($module === false)
401 $modules = $this->show_modules(true);
403 else if ($module === null)
405 $modules = array(get_class($this));
409 $modules = array($module);
412 foreach ($modules AS $module)
414 if (empty($this->modules
["$module"]->fields))
419 foreach ($this->modules["$module"]->fields
AS $name => $field)
421 if ($field[0] == REQ_YES
AND $field[2] == false AND $called == false)
423 $missing[] = $module . ':: ' . $name;
425 else if ($called == true AND $field[2] == false)
427 $missing[] = $module . ':: ' . $name . ($field[0] == REQ_YES
? ' <strong>(REQUIRED)</strong>' : '');
432 if (count($missing) > 0)
434 $error = ($called ? 'The following fields are not set:' : 'You are missing required ISSO fields. Please make sure you have set:');
438 foreach ($missing AS $field)
440 $error .= "\n\t" . '<li>' . $field . '</li>';
443 $error .= "\n" . '</ul>';
445 $this->message(($called ? '' : 'Missing ') . 'Fields', $error, ($called ? 1 : 3));
447 if ($called == false)
454 // ###################################################################
456 * Prepares a path for being set as the sourcepath
460 * @param string Source path or URL
462 * @return string Prepared source path
464 function fetch_sourcepath($source)
466 if (substr($source, strlen($source) - 1) != DIRECTORY_SEPARATOR
)
468 $source .= DIRECTORY_SEPARATOR
;
473 // ###################################################################
475 * Loads a framework module
479 * @param string Name of the framework file to load
480 * @param string Internal variable to initialize as; to not instantiate (just require) leave it as NULL
481 * @param bool Globalize the internal variable?
483 * @return object Instantiated instance
485 function &load($framework, $asobject, $globalize = false)
487 $this->check_isso_fields(null);
489 // set the object interlock
490 if (!method_exists($GLOBALS['isso:null-framework'], 'load'))
492 $GLOBALS['isso:null-framework'] =& $this;
493 $this->modules
['shared_object_framework'] =& $this;
496 if ($this->is_loaded($framework))
498 return $this->modules
["$framework"];
501 if ($this->sourcepath == '')
503 trigger_error('Invalid sourcepath specified', E_USER_ERROR);
506 if (file_exists($this->sourcepath . $framework . '.php'))
508 require_once($this->sourcepath . $framework . '.php');
512 trigger_error('Could not find the framework ' . $this->sourcepath . $framework . '.php', E_USER_ERROR);
515 if ($asobject === null)
520 if (isset($this->$asobject))
522 trigger_error('Cannot instantiate framework `' . $framework . '` into `' . $asobject . '`', E_USER_ERROR);
525 $this->$asobject = new $framework($this);
527 $this->modules["$framework"] =& $this->$asobject;
531 $GLOBALS["$asobject"] =& $this->$asobject;
534 return $this->$asobject;
537 // ###################################################################
539 * Prints a list of all currently loaded framework modules
543 * @param bool Return the data as an array?
545 * @return mixed HTML output or an array of loaded modules
547 function show_modules($return = false)
550 foreach ($this->modules AS $object)
552 $modules[] = get_class($object);
561 $output = "\n\n
<ul
>\n\t<li
>";
562 $output .= implode("</li
>\n\t<li
>", $modules);
563 $output .= "</li
>\n</ul
>\n\n";
564 $this->message('Loaded Modules', $output, 1);
568 // ###################################################################
570 * Verifies to see if a framework has been loaded
574 * @param string Framework name
576 * @return bool Whether or not the framework has been loaded
578 function is_loaded($framework)
580 if (isset($this->modules["$framework"]))
590 // ###################################################################
592 * Prints an ISSO message
596 * @param string The title of the message
597 * @param string The content of the message
598 * @param integer Type of message to be printed
599 * @param bool Return the output?
600 * @param bool Show the debug stack?
602 * @return mixed Output or null
604 function message($title, $message, $type, $return = false, $stack = true)
629 $backtrace = debug_backtrace();
630 unset($backtrace[0]);
632 $output = "\n<br />\n<table cellpadding=\"4\" cellspacing=\"1\" border=\"0\" width=\"500\" style=\"background-color: $color; color: black; font-family: Verdana, sans-serif; font-size: 12px;\">";
633 $output .= "\n<tr style=\"color: $font; text-align: left\">\n\t<td><strong>$prefix: $title</strong></td>\n</tr>";
634 $output .= "\n<tr style=\"background-color: #FFFFFF; text-align: left\">\n\t<td>$message</td>\n</tr>";
635 $output .= (($stack AND $GLOBALS['isso:null-framework']->debug
) ? "\n<tr style=\"background-color: #FFFFFF; text-align: left\">\n\t<td><strong>Debug Stack:</strong> <pre>" . print_r($backtrace, true) . "</pre></td>\n</tr>" : '');
636 $output .= "\n</table>\n<br />\n";
648 // ###################################################################
650 * Custom error handler for ISSO; only handle E_WARNING, E_NOTICE,
651 * E_USER_ERROR, E_USER_WARNING, E_USER_NOTICE
655 * @param integer Error number
656 * @param string Error message string
657 * @param string File that contains the error
658 * @param string The line number of the error
659 * @param string The active symbol table at which point the error occurred
661 function _error_handler($errno, $errstr, $errfile, $errline)
669 if (!(ini_get('error_reporting') & E_USER_ERROR
))
679 if (!(ini_get('error_reporting') & E_USER_WARNING
) AND !(ini_get('error_reporting') & E_WARNING
))
690 if (!(ini_get('error_reporting') & E_USER_NOTICE
) AND !(ini_get('error_reporting') & E_NOTICE
))
697 $errstr .= " in <strong>$errfile</strong> on line <strong>$errline</strong>";
699 $errstr = str_replace(array(getcwd(), dirname(getcwd())), '', $errstr);
701 $this->message($title, $errstr, $level);
703 if ($errno == E_USER_ERROR
)
709 // ###################################################################
711 * Creates a table that explains the error reporting levels and their
716 function explain_error_reporting()
719 'E_ERROR' => E_ERROR
,
720 'E_WARNING' => E_WARNING
,
721 'E_PARSE' => E_PARSE
,
722 'E_NOTICE' => E_NOTICE
,
723 'E_CORE_ERROR' => E_CORE_ERROR
,
724 'E_CORE_WARNING' => E_CORE_WARNING
,
725 'E_COMPILE_ERROR' => 64,
726 'E_COMPILE_WARNING' => 128,
727 'E_USER_ERROR' => E_USER_ERROR
,
728 'E_USER_WARNING' => E_USER_WARNING
,
729 'E_USER_NOTICE' => E_USER_NOTICE
,
734 $table = '<table cellspacing="0" cellpadding="2" border="0">';
736 foreach ($levels AS $name => $value)
740 <td>' . $name . '</td>
741 <td>' . (ini_get('error_reporting') & $value) . '</td>
748 $this->message('Error Reporting', $table, 1);
751 // ###################################################################
753 * Logs a debug message for verbose output
757 * @param string Message
759 function debug($message)
761 $this->debuginfo
[] = $message;
764 // ###################################################################
766 * Recursive XSS cleaner
770 * @param mixed Unsanitized REQUEST data
772 * @return mixed Sanitized data
774 function _sanitize_input_recursive($data)
776 foreach ($data AS $key => $value)
778 if (is_array($value))
780 $data["$key"] = $this->_sanitize_input_recursive($value);
784 $data["$key"] = $this->sanitize($value);
790 // ###################################################################
792 * Simple way to protect against HTML attacks with Unicode support
796 * @param string Unsanitzed text
798 * @return string Properly protected text that only encodes potential threats
800 function sanitize($text)
802 if ($this->magicquotes
)
804 return str_replace(array('<', '>', '\"', '"'), array('<', '>', '"', '"'), $text);
808 return str_replace(array('<', '>', '"'), array('<', '>', '"'), $text);
812 // ###################################################################
814 * Unicode-safe entity encoding system; similar to sanitize()
818 * @param string Unsanitized text
820 * @return string Unicode-safe sanitized text with entities preserved
822 function entity_encode($text)
824 $text = str_replace('&', '&', $text);
825 $text = $this->sanitize($text);
829 // ###################################################################
831 * Takes text that has been processed for HTML and unsanitizes it
835 * @param string Text that needs to be turned back into HTML
837 * @return string Unsanitized text
839 function unsanitize($text)
841 return str_replace(array('<', '>', '"'), array('<', '>', '"'), $text);
844 // ###################################################################
846 * Smart addslashes() that only applies itself it the Magic Quotes GPC
847 * is off. This should only be run on database query values.
851 * @param string Some string
852 * @param bool If the data is binary; if so it'll be run through DB::escape_stringing()
853 * @param bool Force magic quotes to be off
855 * @return string String that has slashes added
857 function escape($str, $binary = false, $force = true)
859 if ($this->magicquotes
AND !$force)
861 if (isset($this->modules
[ISSO_DB_LAYER
]) AND $binary)
863 return $this->modules
[ISSO_DB_LAYER
]->escape_string(str_replace(array("\'", '\"'), array("'", '"'), $str));
869 if (isset($this->modules
[ISSO_DB_LAYER
]) AND $binary)
871 return $this->modules
[ISSO_DB_LAYER
]->escape_string($str);
873 return addslashes($str);
877 // ###################################################################
879 * Runs through all of the input data and sanitizes it.
883 function exec_sanitize_data()
885 $this->in
= $this->_sanitize_input_recursive(array_merge($_GET, $_POST, $_COOKIE));
888 // ###################################################################
890 * Sanitize function for something other than a string (which
891 * everything is sanitized for if you use exec_sanitize_data(). Cleaned
892 * data is placed back into $isso->in; this makes it so you don't have
893 * to constantly intval() [etc.] data.
897 * @param array Array of elements to clean as varname => type
899 function input_clean_array($vars)
901 foreach ($vars AS $varname => $type)
903 $this->input_clean($varname, $type);
907 // ###################################################################
909 * Sanitize function that does a single variable as oppoesd to an array
910 * (see input_clean_array() for more details)
914 * @param string Variable name in $isso->in[]
915 * @param integer Sanitization type constant
917 function input_clean($varname, $type)
919 if (isset($this->in
["$varname"]))
921 $this->in["$varname"] = $this->clean($this->in
["$varname"], $type);
925 $this->in["$varname"] = null;
928 return $this->in
["$varname"];
931 // ###################################################################
933 * Cleaning function that does the work for input_clean(); this is
934 * moved here so it can be used to clean things that aren't in
940 * @param integer Sanitization type constant
942 * @return mixed Cleaned data
944 function clean($value, $type)
946 if ($type == TYPE_INT)
948 $value = intval($value);
950 else if ($type == TYPE_UINT)
952 $value = abs(intval($value));
954 else if ($type == TYPE_FLOAT)
956 $value = floatval($value);
958 else if ($type == TYPE_BOOL)
960 $value = (bool)$value;
962 else if ($type == TYPE_STR)
966 else if ($type == TYPE_STRUN)
968 $value = $this->unsanitize($value);
970 else if ($type == TYPE_NOCLEAN)
976 trigger_error('Invalid clean type `' . $type . '` specified', E_USER_ERROR);
982 // ###################################################################
984 * Checks to see if a POST refer is actually from us
988 function exec_referer_check()
990 if ($_SERVER['REQUEST_METHOD'] == 'POST')
992 $host = ($_SERVER['HTTP_HOST']) ? $_SERVER['HTTP_HOST'] : $_ENV['HTTP_HOST'];
994 if ($host AND $_SERVER['HTTP_REFERER'])
996 $parts = parse_url($_SERVER['HTTP_REFERER']);
997 $ourhost = $parts['host'] . (isset($parts['port']) ? ":$parts[port
]" : '');
999 if ($ourhost != $host)
1001 trigger_error('No external hosts are allowed to POST to this application', E_USER_ERROR);
1003 $this->debug('remote post check = ok');
1007 $this->debug('remote post check = FAILED');
1012 // ###################################################################
1014 * Constructs a debug information box that contains various debugging
1015 * information points
1019 * @param bool Show template information?
1021 * @return string Debugging block
1023 function construct_debug_block($dotemplates)
1034 // both template and template_fs are viable, so we need to determine the right one
1035 if ($this->is_loaded('template'))
1037 $tpl_obj =& $this->modules['template'];
1039 else if ($this->is_loaded('template_fs'))
1041 $tpl_obj =& $this->modules['template_fs'];
1050 foreach ($tpl_obj->usage AS $name => $count)
1052 if (in_array($name, $tpl_obj->uncached))
1054 $optlist[] = $name . '[' . $count . ']';
1056 $usage[] = $name . " ($count)";
1059 $sizeof = sizeof($tpl_obj->uncached);
1062 $debug .= "\n\t
<li
><strong style
=\"color
: red\"
>Uncached
Template(s
):</strong
> $sizeof ( " . implode(' ', $optlist) . " )</li
>";
1067 $scinfo = 'Not Under Source Control';
1070 $scinfo = constant('SVN');
1072 if (preg_match('#\$Id:?\s*\$#', $scinfo))
1074 $scinfo = 'Not Under Source Control';
1078 $scinfo = preg_replace('#\$' . '(Head)?URL: (.+?) \$#e', "end(explode('/', '\\2'))", $scinfo);
1079 $scinfo = preg_replace('#\$' . '(LastModified)?Revision: (.+?) \$#', 'SVN \\2', $scinfo);
1080 $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);
1084 $scinfo = trim($scinfo);
1085 $debug .= "\n\t
<li
><strong
>Source Control
:</strong
> $scinfo</li
>";
1087 // query information
1088 if (is_object($this->modules[ISSO_DB_LAYER]))
1090 $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
>";
1093 // total execution time
1094 if (defined('ISSO_MT_START'))
1096 $this->load('functions', 'functions');
1097 $debug .= "\n\t
<li
><strong
>Total Execution Time
:</strong
> " . round($this->modules['functions']->fetch_microtime_diff(ISSO_MT_START), 10) . "</li
>";
1101 $debug .= "\n\t
<li
>\n\t\t<select
>\n\t\t\t<option
>Debug
Notices (" . sizeof($this->debuginfo) . ")</option
>";
1102 foreach ((array)$this->debuginfo AS $msg)
1104 $debug .= "\n\t\t\t
<option
>--- $msg</option
>";
1106 $debug .= "\n\t\t
</select
>\n\t</li
>";
1109 $modules = $this->show_modules(true);
1110 $debug .= "\n\t
<li
>\n\t\t<select
>\n\t\t\t<option
>Loaded
Modules (" . sizeof($modules) . ")</option
>";
1111 foreach ($modules AS $mod)
1113 $debug .= "\n\t\t\t
<option
>--- $mod</option
>";
1115 $debug .= "\n\t\t
</select
>\n\t</li
>";
1120 $debug .= "\n\t
<li
>\n\t\t<select
>\n\t\t\t<option
>Template
Usage (" . array_sum($tpl_obj->usage) . ")</option
>";
1121 foreach ($usage AS $tpl)
1123 $debug .= "\n\t\t\t
<option
>--- $tpl</option
>";
1125 $debug .= "\n\t\t
</select
>\n\t</li
>";
1128 $debug .= "\n
</ul
>";
1130 $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";
1137 /*=====================================================================*\
1138 || ###################################################################
1141 || ###################################################################
1142 \*=====================================================================*/