]>
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]*)$#', 'array(&$\1, "\
2")', $field[1]);
330 eval('$caller = ' . $caller . ';');
334 $caller = array(&$this, $field[1]);
337 $value = call_user_func($caller, $value);
342 $this->$fieldname = $value;
346 $this->modules["$module"]->$fieldname = $value;
353 trigger_error('Invalid field `' . $module . '.' . $fieldname . '` specified in ISSO->do_set()', E_USER_ERROR
);
357 // ###################################################################
359 * Fetches the value of a field. This is protected because get() should
360 * be defined in each module to make a call to this function.
364 * @param string Field name
365 * @param string Module name (as referred to in ISSO->modules[]) to fetch from
367 function do_get($fieldname, $module)
371 $field =& $this->fields
["$fieldname"];
375 $field =& $this->modules["$module"]->fields
["$fieldname"];
378 if (is_array($field))
380 if ($field[2] == false)
382 trigger_error('Field ' . $module . ':: ' . $filedname . ' is not set and therefore cannot be get()', E_USER_ERROR);
387 return $this->$fieldname;
391 return $this->modules["$module"]->$fieldname;
398 trigger_error('Invalid field `' . $module . '.' . $fieldname . '` specified in ISSO->do_get()', E_USER_ERROR
);
402 // ###################################################################
404 * Returns the value of an ISSO field. You should not access any instance
405 * variables directly, use this instead.
409 * @param string Field name
411 * @return mixed Value of the field
413 function get($fieldname)
415 return $this->do_get($fieldname, null);
418 // ###################################################################
420 * Makes sure that all of the required fields in ISSO are set before
421 * any action is done. This will throw an error block describing
422 * the fields that need to be set if any are missing.
426 * @param string Module to check for; null is kernel, string is a module name, false is all
427 * @param bool Is this a non-error environment that should display all fields?
429 function check_isso_fields($module = null, $called = false)
433 if ($module === false)
435 $modules = $this->show_modules(true);
437 else if ($module === null)
439 $modules = array(get_class($this));
443 $modules = array($module);
446 foreach ($modules AS $module)
448 if (empty($this->modules
["$module"]->fields))
453 foreach ($this->modules["$module"]->fields
AS $name => $field)
455 if ($field[0] == REQ_YES
AND $field[2] == false AND $called == false)
457 $missing[] = $module . ':: ' . $name;
459 else if ($called == true AND $field[2] == false)
461 $missing[] = $module . ':: ' . $name . ($field[0] == REQ_YES
? ' <strong>(REQUIRED)</strong>' : '');
466 if (count($missing) > 0)
468 $error = ($called ? 'The following fields are not set:' : 'You are missing required ISSO fields. Please make sure you have set:');
472 foreach ($missing AS $field)
474 $error .= "\n\t" . '<li>' . $field . '</li>';
477 $error .= "\n" . '</ul>';
479 $this->message(($called ? '' : 'Missing ') . 'Fields', $error, ($called ? 1 : 3));
481 if ($called == false)
488 // ###################################################################
490 * Prepares a path for being set as the sourcepath
494 * @param string Source path or URL
496 * @return string Prepared source path
498 function fetch_sourcepath($source)
500 if (substr($source, strlen($source) - 1) != DIRECTORY_SEPARATOR
)
502 $source .= DIRECTORY_SEPARATOR
;
507 // ###################################################################
509 * Loads a framework module
513 * @param string Name of the framework file to load
514 * @param string Internal variable to initialize as; to not instantiate (just require) leave it as NULL
515 * @param bool Globalize the internal variable?
517 * @return object Instantiated instance
519 function &load($framework, $asobject, $globalize = false)
521 $this->check_isso_fields(null);
523 // set the object interlock
524 if (!method_exists($GLOBALS['isso:null-framework'], 'load'))
526 $GLOBALS['isso:null-framework'] =& $this;
527 $this->modules
['shared_object_framework'] =& $this;
530 if ($this->is_loaded($framework))
532 return $this->modules
["$framework"];
535 if ($this->sourcepath == '')
537 trigger_error('Invalid sourcepath specified', E_USER_ERROR);
540 if (file_exists($this->sourcepath . $framework . '.php'))
542 require_once($this->sourcepath . $framework . '.php');
546 trigger_error('Could not find the framework ' . $this->sourcepath . $framework . '.php', E_USER_ERROR);
549 if ($asobject === null)
554 if (isset($this->$asobject))
556 trigger_error('Cannot instantiate framework `' . $framework . '` into `' . $asobject . '`', E_USER_ERROR);
559 $this->$asobject = new $framework($this);
561 $this->modules["$framework"] =& $this->$asobject;
565 $GLOBALS["$asobject"] =& $this->$asobject;
568 // allow for init_as_package to link
569 if (method_exists($this->modules["$framework"], 'init_as_package'))
571 $this->modules
[ $this->modules
["$framework"]->init_as_package() ] =& $this->modules["$framework"];
574 return $this->$asobject;
577 // ###################################################################
579 * Prints a list of all currently loaded framework modules
583 * @param bool Return the data as an array?
585 * @return mixed HTML output or an array of loaded modules
587 function show_modules($return = false)
590 foreach ($this->modules
AS $object)
592 $module = get_class($object);
593 if (method_exists($object, 'init_as_package') AND in_array($module, $modules))
595 $module = $object->init_as_package() . " - ($module)";
598 $modules[] = $module;
607 $output = "\n\n<ul>\n\t<li>";
608 $output .= implode("</li>\n\t<li>", $modules);
609 $output .= "</li>\n</ul>\n\n";
610 $this->message('Loaded Modules', $output, 1);
614 // ###################################################################
616 * Verifies to see if a framework has been loaded
620 * @param string Framework name
622 * @return bool Whether or not the framework has been loaded
624 function is_loaded($framework)
626 if (isset($this->modules
["$framework"]))
636 // ###################################################################
638 * Prints an ISSO message
642 * @param string The title of the message
643 * @param string The content of the message
644 * @param integer Type of message to be printed
645 * @param bool Return the output?
646 * @param bool Show the debug stack?
648 * @return mixed Output or null
650 function message($title, $message, $type, $return = false, $stack = true)
675 $backtrace = debug_backtrace();
676 array_shift($backtrace);
678 if (isset($backtrace[0]) AND $backtrace[0]['function'] == '_error_handler')
680 array_shift($backtrace);
684 foreach ($backtrace AS $i => $step)
686 $file = $step['file'] . ':' . $step['line'];
687 $funct = (isset($step['class']) ? $step['class'] . '::' . $step['function'] : $step['function']);
688 $args = (is_array($step['args']) ? implode(', ', $step['args']) : '');
690 $trace[] = "#$i $funct($args) called at [$file]";
693 $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;\">";
694 $output .= "\n<tr style=\"color: $font; text-align: left\">\n\t<td><strong>$prefix: $title</strong></td>\n</tr>";
695 $output .= "\n<tr style=\"background-color: #FFFFFF; text-align: left\">\n\t<td>$message</td>\n</tr>";
696 $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>" . implode("\n", $trace) . "</pre></td>\n</tr>" : '');
697 $output .= "\n</table>\n<br />\n";
709 // ###################################################################
711 * Custom error handler for ISSO; only handle E_WARNING, E_NOTICE,
712 * E_USER_ERROR, E_USER_WARNING, E_USER_NOTICE
716 * @param integer Error number
717 * @param string Error message string
718 * @param string File that contains the error
719 * @param string The line number of the error
720 * @param string The active symbol table at which point the error occurred
722 function _error_handler($errno, $errstr, $errfile, $errline)
730 if (!(ini_get('error_reporting') & E_USER_ERROR
))
740 if (!(ini_get('error_reporting') & E_USER_WARNING
) AND !(ini_get('error_reporting') & E_WARNING
))
751 if (!(ini_get('error_reporting') & E_USER_NOTICE
) AND !(ini_get('error_reporting') & E_NOTICE
))
758 $errstr .= " in <strong>$errfile</strong> on line <strong>$errline</strong>";
760 $errstr = str_replace(array(getcwd(), dirname(getcwd())), '', $errstr);
762 $this->message($title, $errstr, $level);
764 if ($errno == E_USER_ERROR
)
770 // ###################################################################
772 * Creates a table that explains the error reporting levels and their
777 function explain_error_reporting()
780 'E_ERROR' => E_ERROR
,
781 'E_WARNING' => E_WARNING
,
782 'E_PARSE' => E_PARSE
,
783 'E_NOTICE' => E_NOTICE
,
784 'E_CORE_ERROR' => E_CORE_ERROR
,
785 'E_CORE_WARNING' => E_CORE_WARNING
,
786 'E_COMPILE_ERROR' => 64,
787 'E_COMPILE_WARNING' => 128,
788 'E_USER_ERROR' => E_USER_ERROR
,
789 'E_USER_WARNING' => E_USER_WARNING
,
790 'E_USER_NOTICE' => E_USER_NOTICE
,
795 $table = '<table cellspacing="0" cellpadding="2" border="0">';
797 foreach ($levels AS $name => $value)
801 <td>' . $name . '</td>
802 <td>' . (ini_get('error_reporting') & $value) . '</td>
809 $this->message('Error Reporting', $table, 1);
812 // ###################################################################
814 * Logs a debug message for verbose output
818 * @param string Message
820 function debug($message)
822 $this->debuginfo
[] = $message;
825 // ###################################################################
827 * Recursive XSS cleaner
831 * @param mixed Unsanitized REQUEST data
833 * @return mixed Sanitized data
835 function _sanitize_input_recursive($data)
837 foreach ($data AS $key => $value)
839 if (is_array($value))
841 $data["$key"] = $this->_sanitize_input_recursive($value);
845 $data["$key"] = $this->sanitize($value);
851 // ###################################################################
853 * Simple way to protect against HTML attacks with Unicode support
857 * @param string Unsanitzed text
859 * @return string Properly protected text that only encodes potential threats
861 function sanitize($text)
863 if ($this->magicquotes
)
865 return str_replace(array('<', '>', '\"', '"'), array('<', '>', '"', '"'), $text);
869 return str_replace(array('<', '>', '"'), array('<', '>', '"'), $text);
873 // ###################################################################
875 * Unicode-safe entity encoding system; similar to sanitize()
879 * @param string Unsanitized text
881 * @return string Unicode-safe sanitized text with entities preserved
883 function entity_encode($text)
885 $text = str_replace('&', '&', $text);
886 $text = $this->sanitize($text);
890 // ###################################################################
892 * Takes text that has been processed for HTML and unsanitizes it
896 * @param string Text that needs to be turned back into HTML
898 * @return string Unsanitized text
900 function unsanitize($text)
902 return str_replace(array('<', '>', '"'), array('<', '>', '"'), $text);
905 // ###################################################################
907 * Smart addslashes() that only applies itself it the Magic Quotes GPC
908 * is off. This should only be run on database query values.
912 * @param string Some string
913 * @param bool If the data is binary; if so it'll be run through DB::escape_stringing()
914 * @param bool Force magic quotes to be off
916 * @return string String that has slashes added
918 function escape($str, $binary = false, $force = true)
920 if ($this->magicquotes
AND !$force)
922 if (isset($this->modules
[ISSO_DB_LAYER
]) AND $binary)
924 return $this->modules
[ISSO_DB_LAYER
]->escape_string(str_replace(array("\'", '\"'), array("'", '"'), $str));
930 if (isset($this->modules
[ISSO_DB_LAYER
]) AND $binary)
932 return $this->modules
[ISSO_DB_LAYER
]->escape_string($str);
934 return addslashes($str);
938 // ###################################################################
940 * Runs through all of the input data and sanitizes it.
944 function exec_sanitize_data()
946 $this->in
= $this->_sanitize_input_recursive(array_merge($_GET, $_POST, $_COOKIE));
949 // ###################################################################
951 * Sanitize function for something other than a string (which
952 * everything is sanitized for if you use exec_sanitize_data(). Cleaned
953 * data is placed back into $isso->in; this makes it so you don't have
954 * to constantly intval() [etc.] data.
958 * @param array Array of elements to clean as varname => type
960 function input_clean_array($vars)
962 foreach ($vars AS $varname => $type)
964 $this->input_clean($varname, $type);
968 // ###################################################################
970 * Sanitize function that does a single variable as oppoesd to an array
971 * (see input_clean_array() for more details)
975 * @param string Variable name in $isso->in[]
976 * @param integer Sanitization type constant
978 function input_clean($varname, $type)
980 if (isset($this->in
["$varname"]))
982 $this->in["$varname"] = $this->clean($this->in
["$varname"], $type);
986 $this->in["$varname"] = null;
989 return $this->in
["$varname"];
992 // ###################################################################
994 * Cleaning function that does the work for input_clean(); this is
995 * moved here so it can be used to clean things that aren't in
1001 * @param integer Sanitization type constant
1003 * @return mixed Cleaned data
1005 function clean($value, $type)
1007 if ($type == TYPE_INT)
1009 $value = intval($value);
1011 else if ($type == TYPE_UINT)
1013 $value = abs(intval($value));
1015 else if ($type == TYPE_FLOAT)
1017 $value = floatval($value);
1019 else if ($type == TYPE_BOOL)
1021 $value = (bool)$value;
1023 else if ($type == TYPE_STR)
1027 else if ($type == TYPE_STRUN)
1029 $value = $this->unsanitize($value);
1031 else if ($type == TYPE_NOCLEAN)
1037 trigger_error('Invalid clean type `' . $type . '` specified', E_USER_ERROR);
1043 // ###################################################################
1045 * Checks to see if a POST refer is actually from us
1049 function exec_referer_check()
1051 if ($_SERVER['REQUEST_METHOD'] == 'POST')
1053 $host = ($_SERVER['HTTP_HOST']) ? $_SERVER['HTTP_HOST'] : $_ENV['HTTP_HOST'];
1055 if ($host AND $_SERVER['HTTP_REFERER'])
1057 $parts = parse_url($_SERVER['HTTP_REFERER']);
1058 $ourhost = $parts['host'] . (isset($parts['port']) ? ":$parts[port
]" : '');
1060 if ($ourhost != $host)
1062 trigger_error('No external hosts are allowed to POST to this application', E_USER_ERROR);
1064 $this->debug('remote post check = ok');
1068 $this->debug('remote post check = FAILED');
1073 // ###################################################################
1075 * Constructs a debug information box that contains various debugging
1076 * information points
1080 * @param bool Show template information?
1082 * @return string Debugging block
1084 function construct_debug_block($dotemplates)
1097 foreach ($this->modules['template']->usage AS $name => $count)
1099 if (in_array($name, $this->modules['template']->uncached))
1101 $optlist[] = $name . '[' . $count . ']';
1103 $usage[] = $name . " ($count)";
1106 $sizeof = sizeof($this->modules['template']->uncached);
1109 $debug .= "\n\t
<li
><strong style
=\"color
: red\"
>Uncached
Template(s
):</strong
> $sizeof ( " . implode(' ', $optlist) . " )</li
>";
1114 $scinfo = 'Not Under Source Control';
1117 $scinfo = constant('SVN');
1119 if (preg_match('#\$Id:?\s*\$#', $scinfo))
1121 $scinfo = 'Not Under Source Control';
1125 $scinfo = preg_replace('#\$' . '(Head)?URL: (.+?) \$#e', "end(explode('/', '\\2'))", $scinfo);
1126 $scinfo = preg_replace('#\$' . '(LastModified)?Revision: (.+?) \$#', 'SVN \\2', $scinfo);
1127 $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);
1131 $scinfo = trim($scinfo);
1132 $debug .= "\n\t
<li
><strong
>Source Control
:</strong
> $scinfo</li
>";
1134 // query information
1135 if (is_object($this->modules[ISSO_DB_LAYER]))
1137 $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
>";
1140 // total execution time
1141 if (defined('ISSO_MT_START'))
1143 $this->load('functions', 'functions');
1144 $debug .= "\n\t
<li
><strong
>Total Execution Time
:</strong
> " . round($this->modules['functions']->fetch_microtime_diff(ISSO_MT_START), 10) . "</li
>";
1148 $debug .= "\n\t
<li
>\n\t\t<select
>\n\t\t\t<option
>Debug
Notices (" . sizeof($this->debuginfo) . ")</option
>";
1149 foreach ((array)$this->debuginfo AS $msg)
1151 $debug .= "\n\t\t\t
<option
>--- $msg</option
>";
1153 $debug .= "\n\t\t
</select
>\n\t</li
>";
1156 $modules = $this->show_modules(true);
1157 $debug .= "\n\t
<li
>\n\t\t<select
>\n\t\t\t<option
>Loaded
Modules (" . sizeof($modules) . ")</option
>";
1158 foreach ($modules AS $mod)
1160 $debug .= "\n\t\t\t
<option
>--- $mod</option
>";
1162 $debug .= "\n\t\t
</select
>\n\t</li
>";
1167 $debug .= "\n\t
<li
>\n\t\t<select
>\n\t\t\t<option
>Template
Usage (" . array_sum($this->modules['template']->usage) . ")</option
>";
1168 foreach ($usage AS $tpl)
1170 $debug .= "\n\t\t\t
<option
>--- $tpl</option
>";
1172 $debug .= "\n\t\t
</select
>\n\t</li
>";
1175 $debug .= "\n
</ul
>";
1177 $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";
1184 /*=====================================================================*\
1185 || ###################################################################
1188 || ###################################################################
1189 \*=====================================================================*/