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 Shared_Object_Framework()
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 * Prepares a path for being set as the sourcepath
247 * @param string Source path or URL
249 * @return string Prepared source path
251 function fetch_sourcepath($source)
253 if (substr($source, strlen($source) - 1) != DIRECTORY_SEPARATOR
)
255 $source .= DIRECTORY_SEPARATOR
;
261 * Loads a framework module
263 * @param string Name of the framework file to load
264 * @param string Internal variable to initialize as; to not instantiate (just require) leave it as NULL
265 * @param bool Globalize the internal variable?
267 * @return object Instantiated instance
269 function &load($framework, $asobject, $globalize = false)
271 if ($this->is_loaded($framework))
273 return $this->getobj($framework);
276 if ($this->sourcepath
== '')
278 trigger_error('Invalid sourcepath specified', E_USER_ERROR
);
281 if (file_exists($this->sourcepath
. $framework . '.php'))
283 require_once($this->sourcepath
. $framework . '.php');
287 trigger_error('Could not find the framework ' . $this->sourcepath
. $framework . '.php', E_USER_ERROR
);
290 if ($asobject === null)
295 if (isset($this->$asobject))
297 trigger_error('Cannot instantiate framework `' . $framework . '` into `' . $asobject . '`', E_USER_ERROR
);
300 $this->$asobject = new $framework($this);
302 $this->modules
["$framework"] =& $this->$asobject;
306 $GLOBALS["$asobject"] =& $this->$asobject;
309 return $this->$asobject;
313 * Prints a list of all currently loaded framework modules
315 * @param bool Return the data as an array?
317 * @return mixed HTML output or an array of loaded modules
319 function show_modules($return = false)
321 foreach ($this->modules
AS $object)
323 $modules[] = get_class($object);
332 $output = "\n\n<ul>\n\t<li>";
333 $output .= implode("</li>\n\t<li>", $modules);
334 $output .= "</li>\n</ul>\n\n";
335 $this->_message('Loaded Modules', $output, 1);
340 * Verifies to see if a framework has been loaded
342 * @param string Framework name
344 * @return bool Whether or not the framework has been loaded
346 function is_loaded($framework)
348 if (isset($this->modules
["$framework"]))
359 * Prints an ISSO message
361 * @param string The title of the message
362 * @param string The content of the message
363 * @param integer Type of message to be printed
364 * @param bool Return the output?
366 * @return mixed Output or null
368 function _message($title, $message, $type, $return = false)
393 $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
;\">";
394 $output .= "\n
<tr style
=\"color
: $font; text
-align
: left\"
>\n\t<td
><strong
>$prefix: $title</strong
></td
>\n</tr
>";
395 $output .= "\n
<tr style
=\"background
-color
: #FFFFFF; text-align: left\">\n\t<td>$message</td>\n</tr>\n</table>\n<br />\n";
408 * Custom error handler for ISSO
409 * We only handle E_WARNING, E_NOTICE, E_USER_ERROR, E_USER_WARNING, E_USER_NOTICE
411 * @param integer Error number
412 * @param string Error message string
413 * @param string File that contains the error
414 * @param string The line number of the error
415 * @param string The active symbol table at which point the error occurred
417 function _error_handler($errno, $errstr, $errfile, $errline)
425 if (!(ini_get('error_reporting') & E_USER_ERROR
))
435 if (!(ini_get('error_reporting') & E_USER_WARNING
) AND !(ini_get('error_reporting') & E_WARNING
))
446 if (!(ini_get('error_reporting') & E_USER_NOTICE
) AND !(ini_get('error_reporting') & E_NOTICE
))
453 $errfile = str_replace(array(getcwd(), dirname(getcwd())), '', $errfile);
455 $errstr .= " in <strong>$errfile</strong> on line <strong>$errline</strong>";
457 $this->_message($title, $errstr, $level);
459 if ($errno == E_USER_ERROR
)
466 * Logs a debug message for verbose output
468 * @param string Message
470 function debug($message)
472 $this->debuginfo
[] = $message;
476 * Recursive XSS cleaner
478 * @param mixed Unsanitized REQUEST data
480 * @return mixed Sanitized data
482 function _sanitize_input_recursive($data)
484 foreach ($data AS $key => $value)
486 if (is_array($value))
488 $data["$key"] = $this->_sanitize_input_recursive($value);
492 if ($this->escapestrings)
494 $data["$key"] = $this->escape($this->sanitize($value), false, false);
498 $data["$key"] = $this->sanitize($value);
506 * Simple way to protect against HTML attacks with Unicode support
508 * @param string Unsanitzed text
510 * @return string Properly protected text that only encodes potential threats
512 function sanitize($text)
514 if ($this->magicquotes)
516 return str_replace(array('<', '>', '\"', '"'), array('<
;', '>
;', '"
;', '"
;'), $text);
520 return str_replace(array('<', '>', '"'), array('<', '>', '"'), $text);
525 * Unicode-safe entity encoding system; similar to sanitize()
527 * @param string Unsanitized text
529 * @return string Unicode-safe sanitized text with entities preserved
531 function entity_encode($text)
533 $text = str_replace('&', '&', $text);
534 $text = $this->sanitize($text);
539 * Takes text that has been processed for HTML and unsanitizes it
541 * @param string Text that needs to be turned back into HTML
542 * @param bool Force magicquotes off
544 * @return string Unsanitized text
546 function unsanitize($text, $force = false)
548 if ($this->magicquotes AND !$force)
550 return str_replace(array('<', '>', '"'), array('<', '>', '\"'), $text);
554 return str_replace(array('<', '>', '"'), array('<', '>', '"'), $text);
559 * Smart addslashes() that only applies itself it the Magic Quotes GPC is off
561 * @param string Some string
562 * @param bool If the data is binary; if so it'll be run through DB
::escape_stringing()
563 * @param
bool Force magic quotes to be off
565 * @return string String that has slashes added
567 function escape($str, $binary = false, $force = true)
569 if ($this->magicquotes
AND !$force)
571 if (isset($this->db
) AND $binary)
573 if (is_resource($this->db
->link_id
))
575 return $this->db
->escape_string(stripslashes($str));
582 if (isset($this->db
) AND $binary)
584 if (is_resource($this->db
->link_id
))
586 return $this->db
->escape_string($str);
589 return addslashes($str);
594 * Runs through all of the input data and sanitizes it.
596 function exec_sanitize_data()
598 $this->in
= $this->_sanitize_input_recursive(array_merge($_GET, $_POST, $_COOKIE));
599 // we're now using magic quotes
600 if ($this->escapestrings
)
602 $this->magicquotes
= 1;
607 * Sanitize function for something other than a string (which everything is sanitized for if you use exec_sanitize_data().
608 * Cleaned data is placed back into $isso->in; this makes it so you don't have to constantly intval() [etc.] data
610 * @param array Array of elements to clean as varname => type
612 function input_clean_array($vars)
614 foreach ($vars AS $varname => $type)
616 $this->input_clean($varname, $type);
621 * Sanitize function that does a single variable as oppoesd to an array (see input_clean_array() for more details)
623 * @param string Variable name in $isso->in[]
624 * @param integer Sanitization type constant
626 function input_clean($varname, $type)
628 $this->in
["$varname"] = $this->clean($this->in["$varname"], $type);
632 * 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[]
635 * @param integer Sanitization type constant
637 * @return mixed Cleaned data
639 function clean($value, $type)
641 if ($type == TYPE_INT
)
643 $value = intval($value);
645 else if ($type == TYPE_UINT
)
647 $value = abs(intval($value));
649 else if ($type == TYPE_FLOAT
)
651 $value = floatval($value);
653 else if ($type == TYPE_BOOL
)
655 $value = (bool)$value;
657 else if ($type == TYPE_STR
)
659 if (!$this->escapestrings
)
661 $value = $this->escape($value);
664 else if ($type == TYPE_STRUN
)
666 $value = $this->unsanitize($value);
668 else if ($type == TYPE_NOCLEAN
)
670 if ($this->escapestrings
)
672 $value = $this->escape($value);
677 trigger_error('Invalid clean type `' . $type . '` specified', E_USER_ERROR
);
684 * Checks to see if a POST refer is actually from us
686 function exec_referer_check()
688 if ($_SERVER['REQUEST_METHOD'] == 'POST')
690 $host = ($_SERVER['HTTP_HOST']) ? $_SERVER['HTTP_HOST'] : $_ENV['HTTP_HOST'];
692 if ($host AND $_SERVER['HTTP_REFERER'])
694 $parts = parse_url($_SERVER['HTTP_REFERER']);
695 $ourhost = $parts['host'] . (($parts['port']) ? ":$parts[port]" : '');
697 if ($ourhost != $host)
699 trigger_error('No external hosts are allowed to POST to this application', E_USER_ERROR
);
701 $this->debug('remote post check = ok');
705 $this->debug('remote post check = FAILED');
711 /*=====================================================================*\
712 || ###################################################################
715 || ###################################################################
716 \*=====================================================================*/