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);
127 * Iris Studios Shared Object Framework (ISSO)
129 * This framework allows a common backend to be used amongst all Iris
130 * Studios applications and is built to be abstract and flexible.
131 * The base framework handles all loading and module management.
133 * @author Iris Studios, Inc.
134 * @copyright Copyright ©2002 - [#]year[#], Iris Studios, Inc.
135 * @version $Revision$
139 class Shared_Object_Framework
145 var $version = '[#]version[#]';
148 * Location of ISSO, used for internal linking
151 var $sourcepath = '';
154 * Path of the current application
160 * Web path used to get the web location of the installation of ISSO; only used for Printer module
166 * Name of the current application
169 var $application = '';
172 * Version of the current application
175 var $appversion = '';
178 * Whether debug mode is on or off
184 * List of all active debug messages
187 var $debuginfo = array();
190 * List of loaded modules
193 var $modules = array();
196 * An array of sanitized variables that have been cleaned for HTML tag openers and double quotes
202 * If we are running with magic_quotes_gpc on or off
205 var $magicquotes = 0;
208 * If we should automagically escape strings, mimicking magic_quotes_gpc
211 var $escapestrings = false
;
213 // ###################################################################
217 function __construct()
220 set_error_handler(array(&$this, '_error_handler'));
223 $this->magicquotes
= get_magic_quotes_gpc();
224 set_magic_quotes_runtime(0);
226 // start input sanitize using variable_order GPC
227 if (!defined('ISSO_NO_INPUT_SANITIZE'))
229 $this->exec_sanitize_data();
232 if (defined('ISSO_CHECK_POST_REFERER'))
234 $this->exec_referer_check();
237 $GLOBALS['isso:null-framework'] = null
;
240 // ###################################################################
242 * (PHP 4) Constructor
244 function Shared_Object_Framework()
246 $this->__construct();
249 // ###################################################################
251 * 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
;
268 // ###################################################################
270 * Loads a framework module
274 * @param string Name of the framework file to load
275 * @param string Internal variable to initialize as; to not instantiate (just require) leave it as NULL
276 * @param bool Globalize the internal variable?
278 * @return object Instantiated instance
280 function &load($framework, $asobject, $globalize = false
)
282 // set the object interlock
283 if (!method_exists($GLOBALS['isso:null-framework'], 'load'))
285 $GLOBALS['isso:null-framework'] =& $this;
288 if ($this->is_loaded($framework))
290 return $this->modules
["$framework"];
293 if ($this->sourcepath
== '')
295 trigger_error('Invalid sourcepath specified', E_USER_ERROR
);
298 if (file_exists($this->sourcepath
. $framework . '.php'))
300 require_once($this->sourcepath
. $framework . '.php');
304 trigger_error('Could not find the framework ' . $this->sourcepath
. $framework . '.php', E_USER_ERROR
);
307 if ($asobject === null
)
312 if (isset($this->$asobject))
314 trigger_error('Cannot instantiate framework `' . $framework . '` into `' . $asobject . '`', E_USER_ERROR
);
317 $this->$asobject = new $framework($this);
319 $this->modules
["$framework"] =& $this->$asobject;
323 $GLOBALS["$asobject"] =& $this->$asobject;
326 return $this->$asobject;
329 // ###################################################################
331 * Prints a list of all currently loaded framework modules
335 * @param bool Return the data as an array?
337 * @return mixed HTML output or an array of loaded modules
339 function show_modules($return = false
)
341 foreach ($this->modules
AS $object)
343 $modules[] = get_class($object);
352 $output = "\n\n<ul>\n\t<li>";
353 $output .= implode("</li>\n\t<li>", $modules);
354 $output .= "</li>\n</ul>\n\n";
355 $this->message('Loaded Modules', $output, 1);
359 // ###################################################################
361 * Verifies to see if a framework has been loaded
365 * @param string Framework name
367 * @return bool Whether or not the framework has been loaded
369 function is_loaded($framework)
371 if (isset($this->modules
["$framework"]))
381 // ###################################################################
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";
439 // ###################################################################
441 * Custom error handler for ISSO; only handle E_WARNING, E_NOTICE,
442 * E_USER_ERROR, E_USER_WARNING, E_USER_NOTICE
446 * @param integer Error number
447 * @param string Error message string
448 * @param string File that contains the error
449 * @param string The line number of the error
450 * @param string The active symbol table at which point the error occurred
452 function _error_handler($errno, $errstr, $errfile, $errline)
460 if (!(ini_get('error_reporting') & E_USER_ERROR
))
470 if (!(ini_get('error_reporting') & E_USER_WARNING
) AND !(ini_get('error_reporting') & E_WARNING
))
481 if (!(ini_get('error_reporting') & E_USER_NOTICE
) AND !(ini_get('error_reporting') & E_NOTICE
))
488 $errfile = str_replace(array(getcwd(), dirname(getcwd())), '', $errfile);
490 $errstr .= " in <strong>$errfile</strong> on line <strong>$errline</strong>";
492 $this->message($title, $errstr, $level);
494 if ($errno == E_USER_ERROR
)
500 // ###################################################################
502 * Creates a table that explains the error reporting levels and their
507 function explain_error_reporting()
510 'E_ERROR' => E_ERROR
,
511 'E_WARNING' => E_WARNING
,
512 'E_PARSE' => E_PARSE
,
513 'E_NOTICE' => E_NOTICE
,
514 'E_CORE_ERROR' => E_CORE_ERROR
,
515 'E_CORE_WARNING' => E_CORE_WARNING
,
516 'E_COMPILE_ERROR' => 64,
517 'E_COMPILE_WARNING' => 128,
518 'E_USER_ERROR' => E_USER_ERROR
,
519 'E_USER_WARNING' => E_USER_WARNING
,
520 'E_USER_NOTICE' => E_USER_NOTICE
,
525 $table = '<table cellspacing="0" cellpadding="2" border="0">';
527 foreach ($levels AS $name => $value)
531 <td>' . $name . '</td>
532 <td>' . (ini_get('error_reporting') & $value) . '</td>
539 $this->message('Error Reporting', $table, 1);
542 // ###################################################################
544 * Logs a debug message for verbose output
548 * @param string Message
550 function debug($message)
552 $this->debuginfo
[] = $message;
555 // ###################################################################
557 * Recursive XSS cleaner
561 * @param mixed Unsanitized REQUEST data
563 * @return mixed Sanitized data
565 function _sanitize_input_recursive($data)
567 foreach ($data AS $key => $value)
569 if (is_array($value))
571 $data["$key"] = $this->_sanitize_input_recursive($value);
575 $data["$key"] = $this->sanitize($value);
581 // ###################################################################
583 * Simple way to protect against HTML attacks with Unicode support
587 * @param string Unsanitzed text
589 * @return string Properly protected text that only encodes potential threats
591 function sanitize($text)
593 if ($this->magicquotes
)
595 return str_replace(array('<', '>', '\"', '"'), array('<', '>', '"', '"'), $text);
599 return str_replace(array('<', '>', '"'), array('<', '>', '"'), $text);
603 // ###################################################################
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);
620 // ###################################################################
622 * Takes text that has been processed for HTML and unsanitizes it
626 * @param string Text that needs to be turned back into HTML
628 * @return string Unsanitized text
630 function unsanitize($text)
632 return str_replace(array('<', '>', '"'), array('<', '>', '"'), $text);
635 // ###################################################################
637 * Smart addslashes() that only applies itself it the Magic Quotes GPC
638 * is off. This should only be run on database query values.
642 * @param string Some string
643 * @param bool If the data is binary; if so it'll be run through DB::escape_stringing()
644 * @param bool Force magic quotes to be off
646 * @return string String that has slashes added
648 function escape($str, $binary = false
, $force = true
)
650 if ($this->magicquotes
AND !$force)
652 if (isset($this->db
) AND $binary)
654 if (is_resource($this->db
->link_id
))
656 return $this->db
->escape_string(str_replace(array("\'", '\"'), array("'", '"'), $str));
663 if (isset($this->db
) AND $binary)
665 if (is_resource($this->db
->link_id
))
667 return $this->db
->escape_string($str);
670 return addslashes($str);
674 // ###################################################################
676 * Runs through all of the input data and sanitizes it.
680 function exec_sanitize_data()
682 $this->in
= $this->_sanitize_input_recursive(array_merge($_GET, $_POST, $_COOKIE));
685 // ###################################################################
687 * Sanitize function for something other than a string (which
688 * everything is sanitized for if you use exec_sanitize_data(). Cleaned
689 * data is placed back into $isso->in; this makes it so you don't have
690 * to constantly intval() [etc.] data.
694 * @param array Array of elements to clean as varname => type
696 function input_clean_array($vars)
698 foreach ($vars AS $varname => $type)
700 $this->input_clean($varname, $type);
704 // ###################################################################
706 * Sanitize function that does a single variable as oppoesd to an array
707 * (see input_clean_array() for more details)
711 * @param string Variable name in $isso->in[]
712 * @param integer Sanitization type constant
714 function input_clean($varname, $type)
716 if (isset($this->in
["$varname"]))
718 $this->in
["$varname"] = $this->clean($this->in
["$varname"], $type);
722 $this->in
["$varname"] = null
;
726 // ###################################################################
728 * Cleaning function that does the work for input_clean(); this is
729 * moved here so it can be used to clean things that aren't in
735 * @param integer Sanitization type constant
737 * @return mixed Cleaned data
739 function clean($value, $type)
741 if ($type == TYPE_INT
)
743 $value = intval($value);
745 else if ($type == TYPE_UINT
)
747 $value = abs(intval($value));
749 else if ($type == TYPE_FLOAT
)
751 $value = floatval($value);
753 else if ($type == TYPE_BOOL
)
755 $value = (bool
)$value;
757 else if ($type == TYPE_STR
)
761 else if ($type == TYPE_STRUN
)
763 $value = $this->unsanitize($value);
765 else if ($type == TYPE_NOCLEAN
)
771 trigger_error('Invalid clean type `' . $type . '` specified', E_USER_ERROR
);
777 // ###################################################################
779 * Checks to see if a POST refer is actually from us
783 function exec_referer_check()
785 if ($_SERVER['REQUEST_METHOD'] == 'POST')
787 $host = ($_SERVER['HTTP_HOST']) ?
$_SERVER['HTTP_HOST'] : $_ENV['HTTP_HOST'];
789 if ($host AND $_SERVER['HTTP_REFERER'])
791 $parts = parse_url($_SERVER['HTTP_REFERER']);
792 $ourhost = $parts['host'] . (($parts['port']) ?
":$parts[port]" : '');
794 if ($ourhost != $host)
796 trigger_error('No external hosts are allowed to POST to this application', E_USER_ERROR
);
798 $this->debug('remote post check = ok');
802 $this->debug('remote post check = FAILED');
807 // ###################################################################
809 * Constructs a debug information box that contains various debugging
814 * @param bool Show template information?
816 * @return string Debugging block
818 function construct_debug_block($dotemplates)
829 // both template and template_fs are viable, so we need to determine the right one
830 if ($this->is_loaded('template'))
832 $tpl_obj =& $this->modules
['template'];
834 else if ($this->is_loaded('template_fs'))
836 $tpl_obj =& $this->modules
['template_fs'];
845 foreach ($tpl_obj->usage
AS $name => $count)
847 if (in_array($name, $tpl_obj->uncached
))
849 $optlist[] = $name . '[' . $count . ']';
851 $usage[] = $name . " ($count)";
854 $sizeof = sizeof($tpl_obj->uncached
);
857 $debug .= "\n\t<li><strong style=\"color: red\">Uncached Template(s):</strong> $sizeof ( " . implode(' ', $optlist) . " )</li>";
862 $scinfo = 'Not Under Source Control';
865 $scinfo = constant('SVN');
867 if ($test == '$' . 'Id: $')
869 $scinfo = 'Not Under Source Control';
873 $scinfo = preg_replace('#\$' . '(Head)?URL: (.+?) \$#e', "end(explode('/', '\\2'))", $scinfo);
874 $scinfo = preg_replace('#\$' . '(LastModified)?Revision: (.+?) \$#', 'SVN \\2', $scinfo);
875 $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);
879 $scinfo = trim($scinfo);
880 $debug .= "\n\t<li><strong>Source Control:</strong> $scinfo</li>";
883 if (is_object($this->modules
['db_mysql']))
885 $debug .= "\n\t<li><strong>Total Queries:</strong> " . sizeof($this->modules
['db_mysql']->history
) . " (<a href=\"" . $this->sanitize($_SERVER['REQUEST_URI']) . ((strpos($_SERVER['REQUEST_URI'], '?') !== false
) ?
'&query=1' : '?query=1') . "\">?</a>)</li>";
888 // total execution time
889 if (defined('ISSO_MT_START'))
891 $this->registry
->load('functions', 'functions');
892 $debug .= "\n\t<li><strong>Total Execution Time:</strong> " . round($this->modules
['functions']->fetch_microtime_diff(ISSO_MT_START
), 10) . "</li>";
896 $debug .= "\n\t<li>\n\t\t<select>\n\t\t\t<option>Debug Notices (" . sizeof($this->debuginfo
) . ")</option>";
897 foreach ((array)$this->debuginfo
AS $msg)
899 $debug .= "\n\t\t\t<option>--- $msg</option>";
901 $debug .= "\n\t\t</select>\n\t</li>";
904 $modules = $this->show_modules(true
);
905 $debug .= "\n\t<li>\n\t\t<select>\n\t\t\t<option>Loaded Modules (" . sizeof($modules) . ")</option>";
906 foreach ($modules AS $mod)
908 $debug .= "\n\t\t\t<option>--- $mod</option>";
910 $debug .= "\n\t\t</select>\n\t</li>";
915 $debug .= "\n\t<li>\n\t\t<select>\n\t\t\t<option>Template Usage (" . array_sum($tpl_obj->usage
) . ")</option>";
916 foreach ($usage AS $tpl)
918 $debug .= "\n\t\t\t<option>--- $tpl</option>";
920 $debug .= "\n\t\t</select>\n\t</li>";
925 $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";
932 /*=====================================================================*\
933 || ###################################################################
936 || ###################################################################
937 \*=====================================================================*/