]>
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
160 var $version = '[#]version[#]';
163 * Location of ISSO, used for internal linking
166 var $sourcepath = '';
169 * Path of the current application
175 * Web path used to get the web location of the installation of ISSO; only used for Printer module
181 * Name of the current application
184 var $application = '';
187 * Version of the current application
190 var $appversion = '';
193 * Whether debug mode is on or off
199 * List of all active debug messages
202 var $debuginfo = array();
205 * List of loaded modules
208 var $modules = array();
211 * An array of sanitized variables that have been cleaned for HTML tag openers and double quotes
217 * If we are running with magic_quotes_gpc on or off
220 var $magicquotes = 0;
223 * Array of user-specified fields that are required for ISSO initialization
224 * fieldname => array(REQUIRED, CALLBACK PARSER, SET)
228 'sourcepath' => array(REQ_YES
, 'fetch_sourcepath', false),
229 'apppath' => array(REQ_YES
, 'fetch_sourcepath', false),
230 'webpath' => array(REQ_YES
, 'fetch_sourcepath', false),
231 'application' => array(REQ_YES
, null, false),
232 'appversion' => array(REQ_NO
, null, false),
233 'debug' => array(REQ_NO
, null, false)
236 // ###################################################################
240 function __construct()
242 $GLOBALS['isso:null-framework'] = null;
245 set_error_handler(array(&$this, '_error_handler'));
248 $this->magicquotes
= get_magic_quotes_gpc();
249 set_magic_quotes_runtime(0);
251 // start input sanitize using variable_order GPC
252 if (!defined('ISSO_NO_INPUT_SANITIZE'))
254 $this->exec_sanitize_data();
257 if (defined('ISSO_CHECK_POST_REFERER'))
259 $this->exec_referer_check();
263 // ###################################################################
265 * (PHP 4) Constructor
267 function Shared_Object_Framework()
269 $this->__construct();
272 // ###################################################################
274 * Sets a specified field in the ISSO. This is used to set all the
275 * required fields that ISSO uses for linking. It replaces the old
276 * method of setting the instance variables directly.
280 * @param string Field name
281 * @param mixed Value of the field
283 function set($fieldname, $value)
285 if (is_array($this->fields
["$fieldname"]))
287 if (method_exists($this, $this->fields["$fieldname"][1]))
289 $value = $this->{$this
->fields
["$fieldname"][1]}($value);
292 $this->$fieldname = $value;
294 $this->fields
["$fieldname"][2] = true;
298 trigger_error('Invalid field `' . $fieldname . '` specified in ISSO->set()', E_USER_ERROR);
302 // ###################################################################
304 * Returns the value of an ISSO field. You should not access any instance
305 * variables directly, use this instead.
309 * @param string Field name
311 * @return mixed Value of the field
313 function get($fieldname)
315 if (is_array($this->fields["$fieldname"]))
317 if ($this->fields
["$fieldname"][2] == false)
319 trigger_error('Field `' . $fieldname . '` is not set and therefore cannot ISSO->get()', E_USER_ERROR);
322 return $this->$fieldname;
326 trigger_error('Invalid field `' . $fieldname . '` specified in ISSO->get()', E_USER_ERROR);
330 // ###################################################################
332 * Prepares a path for being set as the sourcepath
336 * @param string Source path or URL
338 * @return string Prepared source path
340 function fetch_sourcepath($source)
342 if (substr($source, strlen($source) - 1) != DIRECTORY_SEPARATOR)
344 $source .= DIRECTORY_SEPARATOR;
349 // ###################################################################
351 * Loads a framework module
355 * @param string Name of the framework file to load
356 * @param string Internal variable to initialize as; to not instantiate (just require) leave it as NULL
357 * @param bool Globalize the internal variable?
359 * @return object Instantiated instance
361 function &load($framework, $asobject, $globalize = false)
363 // set the object interlock
364 if (!method_exists($GLOBALS['isso:null-framework'], 'load'))
366 $GLOBALS['isso:null-framework'] =& $this;
369 if ($this->is_loaded($framework))
371 return $this->modules["$framework"];
374 if ($this->sourcepath
== '')
376 trigger_error('Invalid sourcepath specified', E_USER_ERROR
);
379 if (file_exists($this->sourcepath
. $framework . '.php'))
381 require_once($this->sourcepath
. $framework . '.php');
385 trigger_error('Could not find the framework ' . $this->sourcepath
. $framework . '.php', E_USER_ERROR
);
388 if ($asobject === null)
393 if (isset($this->$asobject))
395 trigger_error('Cannot instantiate framework `' . $framework . '` into `' . $asobject . '`', E_USER_ERROR
);
398 $this->$asobject = new $framework($this);
400 $this->modules
["$framework"] =& $this->$asobject;
404 $GLOBALS["$asobject"] =& $this->$asobject;
407 return $this->$asobject;
410 // ###################################################################
412 * Prints a list of all currently loaded framework modules
416 * @param bool Return the data as an array?
418 * @return mixed HTML output or an array of loaded modules
420 function show_modules($return = false)
422 foreach ($this->modules
AS $object)
424 $modules[] = get_class($object);
433 $output = "\n\n<ul>\n\t<li>";
434 $output .= implode("</li>\n\t<li>", $modules);
435 $output .= "</li>\n</ul>\n\n";
436 $this->message('Loaded Modules', $output, 1);
440 // ###################################################################
442 * Verifies to see if a framework has been loaded
446 * @param string Framework name
448 * @return bool Whether or not the framework has been loaded
450 function is_loaded($framework)
452 if (isset($this->modules
["$framework"]))
462 // ###################################################################
464 * Prints an ISSO message
468 * @param string The title of the message
469 * @param string The content of the message
470 * @param integer Type of message to be printed
471 * @param bool Return the output?
472 * @param bool Show the debug stack?
474 * @return mixed Output or null
476 function message($title, $message, $type, $return = false, $stack = true)
501 $backtrace = debug_backtrace();
502 unset($backtrace[0]);
504 $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
;\">";
505 $output .= "\n
<tr style
=\"color
: $font; text
-align
: left\"
>\n\t<td
><strong
>$prefix: $title</strong
></td
>\n</tr
>";
506 $output .= "\n
<tr style
=\"background
-color
: #FFFFFF; text-align: left\">\n\t<td>$message</td>\n</tr>";
507 $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>" : '');
508 $output .= "\n</table>\n<br />\n";
520 // ###################################################################
522 * Custom error handler for ISSO; only handle E_WARNING, E_NOTICE,
523 * E_USER_ERROR, E_USER_WARNING, E_USER_NOTICE
527 * @param integer Error number
528 * @param string Error message string
529 * @param string File that contains the error
530 * @param string The line number of the error
531 * @param string The active symbol table at which point the error occurred
533 function _error_handler($errno, $errstr, $errfile, $errline)
541 if (!(ini_get('error_reporting') & E_USER_ERROR
))
551 if (!(ini_get('error_reporting') & E_USER_WARNING
) AND !(ini_get('error_reporting') & E_WARNING
))
562 if (!(ini_get('error_reporting') & E_USER_NOTICE
) AND !(ini_get('error_reporting') & E_NOTICE
))
569 $errstr .= " in <strong>$errfile</strong> on line <strong>$errline</strong>";
571 $errstr = str_replace(array(getcwd(), dirname(getcwd())), '', $errstr);
573 $this->message($title, $errstr, $level);
575 if ($errno == E_USER_ERROR
)
581 // ###################################################################
583 * Creates a table that explains the error reporting levels and their
588 function explain_error_reporting()
591 'E_ERROR' => E_ERROR
,
592 'E_WARNING' => E_WARNING
,
593 'E_PARSE' => E_PARSE
,
594 'E_NOTICE' => E_NOTICE
,
595 'E_CORE_ERROR' => E_CORE_ERROR
,
596 'E_CORE_WARNING' => E_CORE_WARNING
,
597 'E_COMPILE_ERROR' => 64,
598 'E_COMPILE_WARNING' => 128,
599 'E_USER_ERROR' => E_USER_ERROR
,
600 'E_USER_WARNING' => E_USER_WARNING
,
601 'E_USER_NOTICE' => E_USER_NOTICE
,
606 $table = '<table cellspacing="0" cellpadding="2" border="0">';
608 foreach ($levels AS $name => $value)
612 <td>' . $name . '</td>
613 <td>' . (ini_get('error_reporting') & $value) . '</td>
620 $this->message('Error Reporting', $table, 1);
623 // ###################################################################
625 * Logs a debug message for verbose output
629 * @param string Message
631 function debug($message)
633 $this->debuginfo
[] = $message;
636 // ###################################################################
638 * Recursive XSS cleaner
642 * @param mixed Unsanitized REQUEST data
644 * @return mixed Sanitized data
646 function _sanitize_input_recursive($data)
648 foreach ($data AS $key => $value)
650 if (is_array($value))
652 $data["$key"] = $this->_sanitize_input_recursive($value);
656 $data["$key"] = $this->sanitize($value);
662 // ###################################################################
664 * Simple way to protect against HTML attacks with Unicode support
668 * @param string Unsanitzed text
670 * @return string Properly protected text that only encodes potential threats
672 function sanitize($text)
674 if ($this->magicquotes
)
676 return str_replace(array('<', '>', '\"', '"'), array('<', '>', '"', '"'), $text);
680 return str_replace(array('<', '>', '"'), array('<', '>', '"'), $text);
684 // ###################################################################
686 * Unicode-safe entity encoding system; similar to sanitize()
690 * @param string Unsanitized text
692 * @return string Unicode-safe sanitized text with entities preserved
694 function entity_encode($text)
696 $text = str_replace('&', '&', $text);
697 $text = $this->sanitize($text);
701 // ###################################################################
703 * Takes text that has been processed for HTML and unsanitizes it
707 * @param string Text that needs to be turned back into HTML
709 * @return string Unsanitized text
711 function unsanitize($text)
713 return str_replace(array('<', '>', '"'), array('<', '>', '"'), $text);
716 // ###################################################################
718 * Smart addslashes() that only applies itself it the Magic Quotes GPC
719 * is off. This should only be run on database query values.
723 * @param string Some string
724 * @param bool If the data is binary; if so it'll be run through DB::escape_stringing()
725 * @param bool Force magic quotes to be off
727 * @return string String that has slashes added
729 function escape($str, $binary = false, $force = true)
731 if ($this->magicquotes
AND !$force)
733 if (isset($this->modules
[ISSO_DB_LAYER
]) AND $binary)
735 return $this->modules
[ISSO_DB_LAYER
]->escape_string(str_replace(array("\'", '\"'), array("'", '"'), $str));
741 if (isset($this->modules
[ISSO_DB_LAYER
]) AND $binary)
743 return $this->modules
[ISSO_DB_LAYER
]->escape_string($str);
745 return addslashes($str);
749 // ###################################################################
751 * Runs through all of the input data and sanitizes it.
755 function exec_sanitize_data()
757 $this->in
= $this->_sanitize_input_recursive(array_merge($_GET, $_POST, $_COOKIE));
760 // ###################################################################
762 * Sanitize function for something other than a string (which
763 * everything is sanitized for if you use exec_sanitize_data(). Cleaned
764 * data is placed back into $isso->in; this makes it so you don't have
765 * to constantly intval() [etc.] data.
769 * @param array Array of elements to clean as varname => type
771 function input_clean_array($vars)
773 foreach ($vars AS $varname => $type)
775 $this->input_clean($varname, $type);
779 // ###################################################################
781 * Sanitize function that does a single variable as oppoesd to an array
782 * (see input_clean_array() for more details)
786 * @param string Variable name in $isso->in[]
787 * @param integer Sanitization type constant
789 function input_clean($varname, $type)
791 if (isset($this->in
["$varname"]))
793 $this->in["$varname"] = $this->clean($this->in
["$varname"], $type);
797 $this->in["$varname"] = null;
800 return $this->in
["$varname"];
803 // ###################################################################
805 * Cleaning function that does the work for input_clean(); this is
806 * moved here so it can be used to clean things that aren't in
812 * @param integer Sanitization type constant
814 * @return mixed Cleaned data
816 function clean($value, $type)
818 if ($type == TYPE_INT)
820 $value = intval($value);
822 else if ($type == TYPE_UINT)
824 $value = abs(intval($value));
826 else if ($type == TYPE_FLOAT)
828 $value = floatval($value);
830 else if ($type == TYPE_BOOL)
832 $value = (bool)$value;
834 else if ($type == TYPE_STR)
838 else if ($type == TYPE_STRUN)
840 $value = $this->unsanitize($value);
842 else if ($type == TYPE_NOCLEAN)
848 trigger_error('Invalid clean type `' . $type . '` specified', E_USER_ERROR);
854 // ###################################################################
856 * Checks to see if a POST refer is actually from us
860 function exec_referer_check()
862 if ($_SERVER['REQUEST_METHOD'] == 'POST')
864 $host = ($_SERVER['HTTP_HOST']) ? $_SERVER['HTTP_HOST'] : $_ENV['HTTP_HOST'];
866 if ($host AND $_SERVER['HTTP_REFERER'])
868 $parts = parse_url($_SERVER['HTTP_REFERER']);
869 $ourhost = $parts['host'] . (isset($parts['port']) ? ":$parts[port
]" : '');
871 if ($ourhost != $host)
873 trigger_error('No external hosts are allowed to POST to this application', E_USER_ERROR);
875 $this->debug('remote post check = ok');
879 $this->debug('remote post check = FAILED');
884 // ###################################################################
886 * Constructs a debug information box that contains various debugging
891 * @param bool Show template information?
893 * @return string Debugging block
895 function construct_debug_block($dotemplates)
906 // both template and template_fs are viable, so we need to determine the right one
907 if ($this->is_loaded('template'))
909 $tpl_obj =& $this->modules['template'];
911 else if ($this->is_loaded('template_fs'))
913 $tpl_obj =& $this->modules['template_fs'];
922 foreach ($tpl_obj->usage AS $name => $count)
924 if (in_array($name, $tpl_obj->uncached))
926 $optlist[] = $name . '[' . $count . ']';
928 $usage[] = $name . " ($count)";
931 $sizeof = sizeof($tpl_obj->uncached);
934 $debug .= "\n\t
<li
><strong style
=\"color
: red\"
>Uncached
Template(s
):</strong
> $sizeof ( " . implode(' ', $optlist) . " )</li
>";
939 $scinfo = 'Not Under Source Control';
942 $scinfo = constant('SVN');
944 if (preg_match('#\$Id:?\s*\$#', $scinfo))
946 $scinfo = 'Not Under Source Control';
950 $scinfo = preg_replace('#\$' . '(Head)?URL: (.+?) \$#e', "end(explode('/', '\\2'))", $scinfo);
951 $scinfo = preg_replace('#\$' . '(LastModified)?Revision: (.+?) \$#', 'SVN \\2', $scinfo);
952 $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);
956 $scinfo = trim($scinfo);
957 $debug .= "\n\t
<li
><strong
>Source Control
:</strong
> $scinfo</li
>";
960 if (is_object($this->modules[ISSO_DB_LAYER]))
962 $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
>";
965 // total execution time
966 if (defined('ISSO_MT_START'))
968 $this->load('functions', 'functions');
969 $debug .= "\n\t
<li
><strong
>Total Execution Time
:</strong
> " . round($this->modules['functions']->fetch_microtime_diff(ISSO_MT_START), 10) . "</li
>";
973 $debug .= "\n\t
<li
>\n\t\t<select
>\n\t\t\t<option
>Debug
Notices (" . sizeof($this->debuginfo) . ")</option
>";
974 foreach ((array)$this->debuginfo AS $msg)
976 $debug .= "\n\t\t\t
<option
>--- $msg</option
>";
978 $debug .= "\n\t\t
</select
>\n\t</li
>";
981 $modules = $this->show_modules(true);
982 $debug .= "\n\t
<li
>\n\t\t<select
>\n\t\t\t<option
>Loaded
Modules (" . sizeof($modules) . ")</option
>";
983 foreach ($modules AS $mod)
985 $debug .= "\n\t\t\t
<option
>--- $mod</option
>";
987 $debug .= "\n\t\t
</select
>\n\t</li
>";
992 $debug .= "\n\t
<li
>\n\t\t<select
>\n\t\t\t<option
>Template
Usage (" . array_sum($tpl_obj->usage) . ")</option
>";
993 foreach ($usage AS $tpl)
995 $debug .= "\n\t\t\t
<option
>--- $tpl</option
>";
997 $debug .= "\n\t\t
</select
>\n\t</li
>";
1000 $debug .= "\n
</ul
>";
1002 $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";
1009 /*=====================================================================*\
1010 || ###################################################################
1013 || ###################################################################
1014 \*=====================================================================*/