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();
245 * (PHP 4) Constructor
247 function Shared_Object_Framework()
249 $this->__construct();
253 * Prepares a path for being set as the sourcepath
255 * @param string Source path or URL
257 * @return string Prepared source path
259 function fetch_sourcepath($source)
261 if (substr($source, strlen($source) - 1) != DIRECTORY_SEPARATOR
)
263 $source .= DIRECTORY_SEPARATOR
;
269 * Loads a framework module
271 * @param string Name of the framework file to load
272 * @param string Internal variable to initialize as; to not instantiate (just require) leave it as NULL
273 * @param bool Globalize the internal variable?
275 * @return object Instantiated instance
277 function &load($framework, $asobject, $globalize = false)
279 // set the object interlock
280 if ($GLOBALS['isso:null-framework'] === null)
282 $GLOBALS['isso:null-framework'] =& $this;
285 if ($this->is_loaded($framework))
287 return $this->modules
["$framework"];
290 if ($this->sourcepath == '')
292 trigger_error('Invalid sourcepath specified', E_USER_ERROR);
295 if (file_exists($this->sourcepath . $framework . '.php'))
297 require_once($this->sourcepath . $framework . '.php');
301 trigger_error('Could not find the framework ' . $this->sourcepath . $framework . '.php', E_USER_ERROR);
304 if ($asobject === null)
309 if (isset($this->$asobject))
311 trigger_error('Cannot instantiate framework `' . $framework . '` into `' . $asobject . '`', E_USER_ERROR);
314 $this->$asobject = new $framework($this);
316 $this->modules["$framework"] =& $this->$asobject;
320 $GLOBALS["$asobject"] =& $this->$asobject;
323 return $this->$asobject;
327 * Prints a list of all currently loaded framework modules
329 * @param bool Return the data as an array?
331 * @return mixed HTML output or an array of loaded modules
333 function show_modules($return = false)
335 foreach ($this->modules AS $object)
337 $modules[] = get_class($object);
346 $output = "\n\n
<ul
>\n\t<li
>";
347 $output .= implode("</li
>\n\t<li
>", $modules);
348 $output .= "</li
>\n</ul
>\n\n";
349 $this->message('Loaded Modules', $output, 1);
354 * Verifies to see if a framework has been loaded
356 * @param string Framework name
358 * @return bool Whether or not the framework has been loaded
360 function is_loaded($framework)
362 if (isset($this->modules["$framework"]))
373 * Prints an ISSO message
375 * @param string The title of the message
376 * @param string The content of the message
377 * @param integer Type of message to be printed
378 * @param bool Return the output?
379 * @param bool Show the debug stack?
381 * @return mixed Output or null
383 function message($title, $message, $type, $return = false, $stack = true)
408 $backtrace = debug_backtrace();
409 unset($backtrace[0]);
411 $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;\">";
412 $output .= "\n<tr style=\"color: $font; text-align: left\">\n\t<td><strong>$prefix: $title</strong></td>\n</tr>";
413 $output .= "\n<tr style=\"background-color: #FFFFFF; text-align: left\">\n\t<td>$message</td>\n</tr>";
414 $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>" : '');
415 $output .= "\n</table>\n<br />\n";
428 * Custom error handler for ISSO
429 * We only handle E_WARNING, E_NOTICE, E_USER_ERROR, E_USER_WARNING, E_USER_NOTICE
431 * @param integer Error number
432 * @param string Error message string
433 * @param string File that contains the error
434 * @param string The line number of the error
435 * @param string The active symbol table at which point the error occurred
437 function _error_handler($errno, $errstr, $errfile, $errline)
445 if (!(ini_get('error_reporting') & E_USER_ERROR
))
455 if (!(ini_get('error_reporting') & E_USER_WARNING
) AND !(ini_get('error_reporting') & E_WARNING
))
466 if (!(ini_get('error_reporting') & E_USER_NOTICE
) AND !(ini_get('error_reporting') & E_NOTICE
))
473 $errfile = str_replace(array(getcwd(), dirname(getcwd())), '', $errfile);
475 $errstr .= " in <strong>$errfile</strong> on line <strong>$errline</strong>";
477 $this->message($title, $errstr, $level);
479 if ($errno == E_USER_ERROR
)
486 * Creates a table that explains the error reporting levels and their sate
488 function explain_error_reporting()
491 'E_ERROR' => E_ERROR
,
492 'E_WARNING' => E_WARNING
,
493 'E_PARSE' => E_PARSE
,
494 'E_NOTICE' => E_NOTICE
,
495 'E_CORE_ERROR' => E_CORE_ERROR
,
496 'E_CORE_WARNING' => E_CORE_WARNING
,
497 'E_COMPILE_ERROR' => 64,
498 'E_COMPILE_WARNING' => 128,
499 'E_USER_ERROR' => E_USER_ERROR
,
500 'E_USER_WARNING' => E_USER_WARNING
,
501 'E_USER_NOTICE' => E_USER_NOTICE
,
506 $table = '<table cellspacing="0" cellpadding="2" border="0">';
508 foreach ($levels AS $name => $value)
512 <td>' . $name . '</td>
513 <td>' . (ini_get('error_reporting') & $value) . '</td>
520 $this->message('Error Reporting', $table, 1);
524 * Logs a debug message for verbose output
526 * @param string Message
528 function debug($message)
530 $this->debuginfo
[] = $message;
534 * Recursive XSS cleaner
536 * @param mixed Unsanitized REQUEST data
538 * @return mixed Sanitized data
540 function _sanitize_input_recursive($data)
542 foreach ($data AS $key => $value)
544 if (is_array($value))
546 $data["$key"] = $this->_sanitize_input_recursive($value);
550 if ($this->escapestrings)
552 $data["$key"] = $this->escape($this->sanitize($value), false, false);
556 $data["$key"] = $this->sanitize($value);
564 * Simple way to protect against HTML attacks with Unicode support
566 * @param string Unsanitzed text
568 * @return string Properly protected text that only encodes potential threats
570 function sanitize($text)
572 if ($this->magicquotes)
574 return str_replace(array('<', '>', '\"', '"'), array('<
;', '>
;', '"
;', '"
;'), $text);
578 return str_replace(array('<', '>', '"'), array('<', '>', '"'), $text);
583 * Unicode-safe entity encoding system; similar to sanitize()
585 * @param string Unsanitized text
587 * @return string Unicode-safe sanitized text with entities preserved
589 function entity_encode($text)
591 $text = str_replace('&', '&', $text);
592 $text = $this->sanitize($text);
597 * Takes text that has been processed for HTML and unsanitizes it
599 * @param string Text that needs to be turned back into HTML
600 * @param bool Force magicquotes off
602 * @return string Unsanitized text
604 function unsanitize($text, $force = false)
606 if ($this->magicquotes AND !$force)
608 return str_replace(array('<', '>', '"'), array('<', '>', '\"'), $text);
612 return str_replace(array('<', '>', '"'), array('<', '>', '"'), $text);
617 * Smart addslashes() that only applies itself it the Magic Quotes GPC is off
619 * @param string Some string
620 * @param bool If the data is binary; if so it'll be run through DB
::escape_stringing()
621 * @param
bool Force magic quotes to be off
623 * @return string String that has slashes added
625 function escape($str, $binary = false, $force = true)
627 if ($this->magicquotes
AND !$force)
629 if (isset($this->db
) AND $binary)
631 if (is_resource($this->db
->link_id
))
633 return $this->db
->escape_string(stripslashes($str));
640 if (isset($this->db
) AND $binary)
642 if (is_resource($this->db
->link_id
))
644 return $this->db
->escape_string($str);
647 return addslashes($str);
652 * Runs through all of the input data and sanitizes it.
654 function exec_sanitize_data()
656 $this->in
= $this->_sanitize_input_recursive(array_merge($_GET, $_POST, $_COOKIE));
657 // we're now using magic quotes
658 if ($this->escapestrings
)
660 $this->magicquotes
= 1;
665 * Sanitize function for something other than a string (which everything is sanitized for if you use exec_sanitize_data().
666 * Cleaned data is placed back into $isso->in; this makes it so you don't have to constantly intval() [etc.] data
668 * @param array Array of elements to clean as varname => type
670 function input_clean_array($vars)
672 foreach ($vars AS $varname => $type)
674 $this->input_clean($varname, $type);
679 * Sanitize function that does a single variable as oppoesd to an array (see input_clean_array() for more details)
681 * @param string Variable name in $isso->in[]
682 * @param integer Sanitization type constant
684 function input_clean($varname, $type)
686 $this->in
["$varname"] = $this->clean($this->in["$varname"], $type);
690 * 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[]
693 * @param integer Sanitization type constant
695 * @return mixed Cleaned data
697 function clean($value, $type)
699 if ($type == TYPE_INT
)
701 $value = intval($value);
703 else if ($type == TYPE_UINT
)
705 $value = abs(intval($value));
707 else if ($type == TYPE_FLOAT
)
709 $value = floatval($value);
711 else if ($type == TYPE_BOOL
)
713 $value = (bool)$value;
715 else if ($type == TYPE_STR
)
717 if (!$this->escapestrings
)
719 $value = $this->escape($value);
722 else if ($type == TYPE_STRUN
)
724 $value = $this->unsanitize($value);
726 else if ($type == TYPE_NOCLEAN
)
728 if ($this->escapestrings
)
730 $value = $this->escape($value);
735 trigger_error('Invalid clean type `' . $type . '` specified', E_USER_ERROR
);
742 * Checks to see if a POST refer is actually from us
744 function exec_referer_check()
746 if ($_SERVER['REQUEST_METHOD'] == 'POST')
748 $host = ($_SERVER['HTTP_HOST']) ? $_SERVER['HTTP_HOST'] : $_ENV['HTTP_HOST'];
750 if ($host AND $_SERVER['HTTP_REFERER'])
752 $parts = parse_url($_SERVER['HTTP_REFERER']);
753 $ourhost = $parts['host'] . (($parts['port']) ? ":$parts[port]" : '');
755 if ($ourhost != $host)
757 trigger_error('No external hosts are allowed to POST to this application', E_USER_ERROR
);
759 $this->debug('remote post check = ok');
763 $this->debug('remote post check = FAILED');
769 /*=====================================================================*\
770 || ###################################################################
773 || ###################################################################
774 \*=====================================================================*/