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))
56 //echo "increasing newlevel by $isso; ";
62 if ($oldlevel & $isso)
64 //echo "decreasing newlevel by $isso; ";
69 error_reporting($newlevel);
71 if ((bool)ini_get('register_globals') === true)
73 $superglobals = array('_GET', '_COOKIE', '_FILES', '_POST', '_SERVER', '_ENV');
74 foreach ($superglobals AS $global)
76 if (is_array(${$global}))
78 foreach (${$global} AS $_key => $_val)
90 * Input cleaning type constant
95 define('TYPE_INT', 1);
100 define('TYPE_UINT', 2);
105 define('TYPE_FLOAT', 4);
110 define('TYPE_BOOL', 8);
115 define('TYPE_STR', 16);
118 * String - deliberate unclean
120 define('TYPE_STRUN', 32);
123 * No cleaning - here for use in API
125 define('TYPE_NOCLEAN', 64);
129 * Iris Studios Shared Object Framework (ISSO)
131 * This framework allows a common backend to be used amongst all Iris
132 * Studios applications and is built to be abstract and flexible.
133 * The base framework handles all loading and module management.
135 * @author Iris Studios, Inc.
136 * @copyright Copyright ©2002 - [#]year[#], Iris Studios, Inc.
137 * @version $Revision$
141 class Shared_Object_Framework
147 var $version = '[#]version[#]';
150 * Location of ISSO, used for internal linking
153 var $sourcepath = '';
156 * Path of the current application
162 * Web path used to get the web location of the installation of ISSO; only used for Printer module
168 * Name of the current application
171 var $application = '';
174 * Version of the current application
177 var $appversion = '';
180 * Whether debug mode is on or off
186 * List of all active debug messages
189 var $debuginfo = array();
192 * List of loaded modules
195 var $modules = array();
198 * An array of sanitized variables that have been cleaned for HTML tag openers and double quotes
204 * If we are running with magic_quotes_gpc on or off
207 var $magicquotes = 0;
210 * If we should automagically escape strings, mimicking magic_quotes_gpc
213 var $escapestrings = false;
218 function __construct()
221 set_error_handler(array(&$this, '_error_handler'));
224 $this->magicquotes
= get_magic_quotes_gpc();
225 set_magic_quotes_runtime(0);
227 if (defined('ISSO_ESCAPE_STRINGS'))
229 $this->escapestrings
= (bool)constant('ISSO_ESCAPE_STRINGS');
232 // start input sanitize using variable_order GPC
233 if (!$this->escapestrings
)
235 $this->exec_sanitize_data();
238 if (defined('ISSO_CHECK_POST_REFERER'))
240 $this->exec_referer_check();
243 $GLOBALS['isso:null-framework'] = null;
247 * (PHP 4) Constructor
249 function Shared_Object_Framework()
251 $this->__construct();
255 * Prepares a path for being set as the sourcepath
259 * @param string Source path or URL
261 * @return string Prepared source path
263 function fetch_sourcepath($source)
265 if (substr($source, strlen($source) - 1) != DIRECTORY_SEPARATOR
)
267 $source .= DIRECTORY_SEPARATOR
;
273 * Loads a framework module
277 * @param string Name of the framework file to load
278 * @param string Internal variable to initialize as; to not instantiate (just require) leave it as NULL
279 * @param bool Globalize the internal variable?
281 * @return object Instantiated instance
283 function &load($framework, $asobject, $globalize = false)
285 // set the object interlock
286 if (!method_exists($GLOBALS['isso:null-framework'], 'load'))
288 $GLOBALS['isso:null-framework'] =& $this;
291 if ($this->is_loaded($framework))
293 return $this->modules
["$framework"];
296 if ($this->sourcepath == '')
298 trigger_error('Invalid sourcepath specified', E_USER_ERROR);
301 if (file_exists($this->sourcepath . $framework . '.php'))
303 require_once($this->sourcepath . $framework . '.php');
307 trigger_error('Could not find the framework ' . $this->sourcepath . $framework . '.php', E_USER_ERROR);
310 if ($asobject === null)
315 if (isset($this->$asobject))
317 trigger_error('Cannot instantiate framework `' . $framework . '` into `' . $asobject . '`', E_USER_ERROR);
320 $this->$asobject = new $framework($this);
322 $this->modules["$framework"] =& $this->$asobject;
326 $GLOBALS["$asobject"] =& $this->$asobject;
329 return $this->$asobject;
333 * Prints a list of all currently loaded framework modules
337 * @param bool Return the data as an array?
339 * @return mixed HTML output or an array of loaded modules
341 function show_modules($return = false)
343 foreach ($this->modules AS $object)
345 $modules[] = get_class($object);
354 $output = "\n\n
<ul
>\n\t<li
>";
355 $output .= implode("</li
>\n\t<li
>", $modules);
356 $output .= "</li
>\n</ul
>\n\n";
357 $this->message('Loaded Modules', $output, 1);
362 * Verifies to see if a framework has been loaded
366 * @param string Framework name
368 * @return bool Whether or not the framework has been loaded
370 function is_loaded($framework)
372 if (isset($this->modules["$framework"]))
383 * Prints an ISSO message
387 * @param string The title of the message
388 * @param string The content of the message
389 * @param integer Type of message to be printed
390 * @param bool Return the output?
391 * @param bool Show the debug stack?
393 * @return mixed Output or null
395 function message($title, $message, $type, $return = false, $stack = true)
420 $backtrace = debug_backtrace();
421 unset($backtrace[0]);
423 $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;\">";
424 $output .= "\n<tr style=\"color: $font; text-align: left\">\n\t<td><strong>$prefix: $title</strong></td>\n</tr>";
425 $output .= "\n<tr style=\"background-color: #FFFFFF; text-align: left\">\n\t<td>$message</td>\n</tr>";
426 $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>" : '');
427 $output .= "\n</table>\n<br />\n";
440 * Custom error handler for ISSO
441 * We only handle E_WARNING, E_NOTICE, E_USER_ERROR, E_USER_WARNING, E_USER_NOTICE
445 * @param integer Error number
446 * @param string Error message string
447 * @param string File that contains the error
448 * @param string The line number of the error
449 * @param string The active symbol table at which point the error occurred
451 function _error_handler($errno, $errstr, $errfile, $errline)
459 if (!(ini_get('error_reporting') & E_USER_ERROR
))
469 if (!(ini_get('error_reporting') & E_USER_WARNING
) AND !(ini_get('error_reporting') & E_WARNING
))
480 if (!(ini_get('error_reporting') & E_USER_NOTICE
) AND !(ini_get('error_reporting') & E_NOTICE
))
487 $errfile = str_replace(array(getcwd(), dirname(getcwd())), '', $errfile);
489 $errstr .= " in <strong>$errfile</strong> on line <strong>$errline</strong>";
491 $this->message($title, $errstr, $level);
493 if ($errno == E_USER_ERROR
)
500 * Creates a table that explains the error reporting levels and their sate
504 function explain_error_reporting()
507 'E_ERROR' => E_ERROR
,
508 'E_WARNING' => E_WARNING
,
509 'E_PARSE' => E_PARSE
,
510 'E_NOTICE' => E_NOTICE
,
511 'E_CORE_ERROR' => E_CORE_ERROR
,
512 'E_CORE_WARNING' => E_CORE_WARNING
,
513 'E_COMPILE_ERROR' => 64,
514 'E_COMPILE_WARNING' => 128,
515 'E_USER_ERROR' => E_USER_ERROR
,
516 'E_USER_WARNING' => E_USER_WARNING
,
517 'E_USER_NOTICE' => E_USER_NOTICE
,
522 $table = '<table cellspacing="0" cellpadding="2" border="0">';
524 foreach ($levels AS $name => $value)
528 <td>' . $name . '</td>
529 <td>' . (ini_get('error_reporting') & $value) . '</td>
536 $this->message('Error Reporting', $table, 1);
540 * Logs a debug message for verbose output
544 * @param string Message
546 function debug($message)
548 $this->debuginfo
[] = $message;
552 * Recursive XSS cleaner
556 * @param mixed Unsanitized REQUEST data
558 * @return mixed Sanitized data
560 function _sanitize_input_recursive($data)
562 foreach ($data AS $key => $value)
564 if (is_array($value))
566 $data["$key"] = $this->_sanitize_input_recursive($value);
570 if ($this->escapestrings)
572 $data["$key"] = $this->escape($this->sanitize($value), false, false);
576 $data["$key"] = $this->sanitize($value);
584 * Simple way to protect against HTML attacks with Unicode support
588 * @param string Unsanitzed text
590 * @return string Properly protected text that only encodes potential threats
592 function sanitize($text)
594 if ($this->magicquotes)
596 return str_replace(array('<', '>', '\"', '"'), array('<
;', '>
;', '"
;', '"
;'), $text);
600 return str_replace(array('<', '>', '"'), array('<', '>', '"'), $text);
605 * Unicode-safe entity encoding system; similar to sanitize()
609 * @param string Unsanitized text
611 * @return string Unicode-safe sanitized text with entities preserved
613 function entity_encode($text)
615 $text = str_replace('&', '&', $text);
616 $text = $this->sanitize($text);
621 * Takes text that has been processed for HTML and unsanitizes it
625 * @param string Text that needs to be turned back into HTML
626 * @param bool Force magicquotes off
628 * @return string Unsanitized text
630 function unsanitize($text, $force = false)
632 if ($this->magicquotes AND !$force)
634 return str_replace(array('<', '>', '"'), array('<', '>', '\"'), $text);
638 return str_replace(array('<', '>', '"'), array('<', '>', '"'), $text);
643 * Smart addslashes() that only applies itself it the Magic Quotes GPC is off
647 * @param string Some string
648 * @param bool If the data is binary; if so it'll be run through DB
::escape_stringing()
649 * @param
bool Force magic quotes to be off
651 * @return string String that has slashes added
653 function escape($str, $binary = false, $force = true)
655 if ($this->magicquotes
AND !$force)
657 if (isset($this->db
) AND $binary)
659 if (is_resource($this->db
->link_id
))
661 return $this->db
->escape_string(stripslashes($str));
668 if (isset($this->db
) AND $binary)
670 if (is_resource($this->db
->link_id
))
672 return $this->db
->escape_string($str);
675 return addslashes($str);
680 * Runs through all of the input data and sanitizes it.
684 function exec_sanitize_data()
686 $this->in
= $this->_sanitize_input_recursive(array_merge($_GET, $_POST, $_COOKIE));
687 // we're now using magic quotes
688 if ($this->escapestrings
)
690 $this->magicquotes
= 1;
695 * Sanitize function for something other than a string (which everything is sanitized for if you use exec_sanitize_data().
696 * Cleaned data is placed back into $isso->in; this makes it so you don't have to constantly intval() [etc.] data
700 * @param array Array of elements to clean as varname => type
702 function input_clean_array($vars)
704 foreach ($vars AS $varname => $type)
706 $this->input_clean($varname, $type);
711 * Sanitize function that does a single variable as oppoesd to an array (see input_clean_array() for more details)
715 * @param string Variable name in $isso->in[]
716 * @param integer Sanitization type constant
718 function input_clean($varname, $type)
720 if (isset($this->in
["$varname"]))
722 $this->in["$varname"] = $this->clean($this->in
["$varname"], $type);
726 $this->in["$varname"] = null;
731 * Cleaning function that does the work for input_clean(); this is moved here so it can be used to clean things that aren't in $isso->in[]
736 * @param integer Sanitization type constant
738 * @return mixed Cleaned data
740 function clean($value, $type)
742 if ($type == TYPE_INT
)
744 $value = intval($value);
746 else if ($type == TYPE_UINT
)
748 $value = abs(intval($value));
750 else if ($type == TYPE_FLOAT
)
752 $value = floatval($value);
754 else if ($type == TYPE_BOOL
)
756 $value = (bool)$value;
758 else if ($type == TYPE_STR
)
760 if (!$this->escapestrings
)
762 $value = $this->escape($value);
765 else if ($type == TYPE_STRUN
)
767 $value = $this->unsanitize($value);
769 else if ($type == TYPE_NOCLEAN
)
771 if ($this->escapestrings
)
773 $value = $this->escape($value);
778 trigger_error('Invalid clean type `' . $type . '` specified', E_USER_ERROR
);
785 * Checks to see if a POST refer is actually from us
789 function exec_referer_check()
791 if ($_SERVER['REQUEST_METHOD'] == 'POST')
793 $host = ($_SERVER['HTTP_HOST']) ? $_SERVER['HTTP_HOST'] : $_ENV['HTTP_HOST'];
795 if ($host AND $_SERVER['HTTP_REFERER'])
797 $parts = parse_url($_SERVER['HTTP_REFERER']);
798 $ourhost = $parts['host'] . (($parts['port']) ? ":$parts[port]" : '');
800 if ($ourhost != $host)
802 trigger_error('No external hosts are allowed to POST to this application', E_USER_ERROR
);
804 $this->debug('remote post check = ok');
808 $this->debug('remote post check = FAILED');
814 /*=====================================================================*\
815 || ###################################################################
818 || ###################################################################
819 \*=====================================================================*/