]> src.bluestatic.org Git - isso.git/blob - kernel.php
We want to play nice with PHP5, right?
[isso.git] / kernel.php
1 <?php
2 /*=====================================================================*\
3 || ###################################################################
4 || # Iris Studios Shared Object Framework [#]version[#]
5 || # Copyright ©2002-[#]year[#] Iris Studios, Inc.
6 || #
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.
10 || #
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
14 || # more details.
15 || #
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 \*=====================================================================*/
21
22 /**
23 * Iris Studios Shared Object Framework Kernel
24 * kernel.php
25 *
26 * @package ISSO
27 */
28
29 if (!function_exists('version_compare'))
30 {
31 trigger_error('You need PHP version 4.1.0 or newer to run ISSO', E_USER_ERROR);
32 exit;
33 }
34
35 if (version_compare(PHP_VERSION, '5.0.0', '>='))
36 {
37 if (ini_get('error_reporting') & E_NOTICE)
38 {
39 error_reporting(ini_get('error_reporting') - E_NOTICE);
40 }
41 if (ini_get('error_reporting') & E_USER_NOTICE)
42 {
43 error_reporting(ini_get('error_reporting') - E_USER_NOTICE);
44 }
45 }
46
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)
51 {
52 if ($oldlevel & $php)
53 {
54 if (!($oldlevel & $isso))
55 {
56 //echo "increasing newlevel by $isso; ";
57 $newlevel += $isso;
58 }
59 }
60 else
61 {
62 if ($oldlevel & $isso)
63 {
64 //echo "decreasing newlevel by $isso; ";
65 $newlevel -= $isso;
66 }
67 }
68 }
69 error_reporting($newlevel);
70
71 if ((bool)ini_get('register_globals') === true)
72 {
73 $superglobals = array('_GET', '_COOKIE', '_FILES', '_POST', '_SERVER', '_ENV');
74 foreach ($superglobals AS $global)
75 {
76 if (is_array(${$global}))
77 {
78 foreach (${$global} AS $_key => $_val)
79 {
80 if (isset(${$_key}))
81 {
82 unset(${$_key});
83 }
84 }
85 }
86 }
87 }
88
89 /**#@+
90 * Input cleaning type constant
91 */
92 /**
93 * Integer type
94 */
95 define('TYPE_INT', 1);
96
97 /**
98 * Unsigned integer
99 */
100 define('TYPE_UINT', 2);
101
102 /**
103 * Float type
104 */
105 define('TYPE_FLOAT', 4);
106
107 /**
108 * Boolean type
109 */
110 define('TYPE_BOOL', 8);
111
112 /**
113 * String - cleaned
114 */
115 define('TYPE_STR', 16);
116
117 /**
118 * String - deliberate unclean
119 */
120 define('TYPE_STRUN', 32);
121
122 /**
123 * No cleaning - here for use in API
124 */
125 define('TYPE_NOCLEAN', 64);
126 /**#@-*/
127
128 /**
129 * Iris Studios Shared Object Framework (ISSO)
130 *
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.
134 *
135 * @author Iris Studios, Inc.
136 * @copyright Copyright ©2002 - [#]year[#], Iris Studios, Inc.
137 * @version $Revision$
138 * @package ISSO
139 *
140 */
141 class Shared_Object_Framework
142 {
143 /**
144 * ISSO version
145 * @var string
146 */
147 var $version = '[#]version[#]';
148
149 /**
150 * Location of ISSO, used for internal linking
151 * @var string
152 */
153 var $sourcepath = '';
154
155 /**
156 * Path of the current application
157 * @var string
158 */
159 var $apppath = '';
160
161 /**
162 * Web path used to get the web location of the installation of ISSO; only used for Printer module
163 * @var string
164 */
165 var $webpath = '';
166
167 /**
168 * Name of the current application
169 * @var string
170 */
171 var $application = '';
172
173 /**
174 * Version of the current application
175 * @var string
176 */
177 var $appversion = '';
178
179 /**
180 * Whether debug mode is on or off
181 * @var bool
182 */
183 var $debug = false;
184
185 /**
186 * List of all active debug messages
187 * @var array
188 */
189 var $debuginfo = array();
190
191 /**
192 * List of loaded modules
193 * @var array
194 */
195 var $modules = array();
196
197 /**
198 * An array of sanitized variables that have been cleaned for HTML tag openers and double quotes
199 * @var array
200 */
201 var $in = array();
202
203 /**
204 * If we are running with magic_quotes_gpc on or off
205 * @var int
206 */
207 var $magicquotes = 0;
208
209 /**
210 * If we should automagically escape strings, mimicking magic_quotes_gpc
211 * @var bool
212 */
213 var $escapestrings = false;
214
215 /**
216 * Constructor
217 */
218 function __construct()
219 {
220 // error reporting
221 set_error_handler(array(&$this, '_error_handler'));
222
223 // magic quotes
224 $this->magicquotes = get_magic_quotes_gpc();
225 set_magic_quotes_runtime(0);
226
227 if (defined('ISSO_ESCAPE_STRINGS'))
228 {
229 $this->escapestrings = (bool)constant('ISSO_ESCAPE_STRINGS');
230 }
231
232 // start input sanitize using variable_order GPC
233 if (!$this->escapestrings)
234 {
235 $this->exec_sanitize_data();
236 }
237
238 if (defined('ISSO_CHECK_POST_REFERER'))
239 {
240 $this->exec_referer_check();
241 }
242 }
243
244 /**
245 * (PHP 4) Constructor
246 */
247 function Shared_Object_Framework()
248 {
249 $this->__construct();
250 }
251
252 /**
253 * Prepares a path for being set as the sourcepath
254 *
255 * @param string Source path or URL
256 *
257 * @return string Prepared source path
258 */
259 function fetch_sourcepath($source)
260 {
261 if (substr($source, strlen($source) - 1) != DIRECTORY_SEPARATOR)
262 {
263 $source .= DIRECTORY_SEPARATOR;
264 }
265 return $source;
266 }
267
268 /**
269 * Loads a framework module
270 *
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?
274 *
275 * @return object Instantiated instance
276 */
277 function &load($framework, $asobject, $globalize = false)
278 {
279 // set the object interlock
280 if ($GLOBALS['isso:null-framework'] === null)
281 {
282 $GLOBALS['isso:null-framework'] =& $this;
283 }
284
285 if ($this->is_loaded($framework))
286 {
287 return $this->modules["$framework"];
288 }
289
290 if ($this->sourcepath == '')
291 {
292 trigger_error('Invalid sourcepath specified', E_USER_ERROR);
293 }
294
295 if (file_exists($this->sourcepath . $framework . '.php'))
296 {
297 require_once($this->sourcepath . $framework . '.php');
298 }
299 else
300 {
301 trigger_error('Could not find the framework ' . $this->sourcepath . $framework . '.php', E_USER_ERROR);
302 }
303
304 if ($asobject === null)
305 {
306 return;
307 }
308
309 if (isset($this->$asobject))
310 {
311 trigger_error('Cannot instantiate framework `' . $framework . '` into `' . $asobject . '`', E_USER_ERROR);
312 }
313
314 $this->$asobject = new $framework($this);
315
316 $this->modules["$framework"] =& $this->$asobject;
317
318 if ($globalize)
319 {
320 $GLOBALS["$asobject"] =& $this->$asobject;
321 }
322
323 return $this->$asobject;
324 }
325
326 /**
327 * Prints a list of all currently loaded framework modules
328 *
329 * @param bool Return the data as an array?
330 *
331 * @return mixed HTML output or an array of loaded modules
332 */
333 function show_modules($return = false)
334 {
335 foreach ($this->modules AS $object)
336 {
337 $modules[] = get_class($object);
338 }
339
340 if ($return)
341 {
342 return $modules;
343 }
344 else
345 {
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);
350 }
351 }
352
353 /**
354 * Verifies to see if a framework has been loaded
355 *
356 * @param string Framework name
357 *
358 * @return bool Whether or not the framework has been loaded
359 */
360 function is_loaded($framework)
361 {
362 if (isset($this->modules["$framework"]))
363 {
364 return true;
365 }
366 else
367 {
368 return false;
369 }
370 }
371
372 /**
373 * Prints an ISSO message
374 *
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?
380 *
381 * @return mixed Output or null
382 */
383 function message($title, $message, $type, $return = false, $stack = true)
384 {
385 switch ($type)
386 {
387 // Message
388 case 1:
389 $prefix = 'Message';
390 $color = '#669900';
391 $font = '#000000';
392 break;
393
394 // Warning
395 case 2:
396 $prefix = 'Warning';
397 $color = '#003399';
398 $font = '#FFFFFF';
399 break;
400
401 case 3:
402 $prefix = 'Error';
403 $color = '#990000';
404 $font = '#EFEFEF';
405 break;
406 }
407
408 $backtrace = debug_backtrace();
409 unset($backtrace[0]);
410
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";
416
417 if ($return)
418 {
419 return $output;
420 }
421 else
422 {
423 print($output);
424 }
425 }
426
427 /**
428 * Custom error handler for ISSO
429 * We only handle E_WARNING, E_NOTICE, E_USER_ERROR, E_USER_WARNING, E_USER_NOTICE
430 *
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
436 */
437 function _error_handler($errno, $errstr, $errfile, $errline)
438 {
439 switch ($errno)
440 {
441 // Fatal
442 case E_USER_ERROR:
443 $title = 'Fatal';
444 $level = 3;
445 if (!(ini_get('error_reporting') & E_USER_ERROR))
446 {
447 return;
448 }
449 break;
450
451 // Error
452 case E_USER_WARNING:
453 $title = 'Warning';
454 $level = 2;
455 if (!(ini_get('error_reporting') & E_USER_WARNING) AND !(ini_get('error_reporting') & E_WARNING))
456 {
457 return;
458 }
459 break;
460
461 // Warning
462 case E_USER_NOTICE:
463 default:
464 $title = 'Notice';
465 $level = 1;
466 if (!(ini_get('error_reporting') & E_USER_NOTICE) AND !(ini_get('error_reporting') & E_NOTICE))
467 {
468 return;
469 }
470 break;
471 }
472
473 $errfile = str_replace(array(getcwd(), dirname(getcwd())), '', $errfile);
474
475 $errstr .= " in <strong>$errfile</strong> on line <strong>$errline</strong>";
476
477 $this->message($title, $errstr, $level);
478
479 if ($errno == E_USER_ERROR)
480 {
481 exit;
482 }
483 }
484
485 /**
486 * Creates a table that explains the error reporting levels and their sate
487 */
488 function explain_error_reporting()
489 {
490 $levels = array(
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,
502 'E_ALL' => E_ALL,
503 'E_STRICT' => 2048
504 );
505
506 $table = '<table cellspacing="0" cellpadding="2" border="0">';
507
508 foreach ($levels AS $name => $value)
509 {
510 $table .= '
511 <tr>
512 <td>' . $name . '</td>
513 <td>' . (ini_get('error_reporting') & $value) . '</td>
514 </tr>';
515 }
516
517 $table .= '
518 </table>';
519
520 $this->message('Error Reporting', $table, 1);
521 }
522
523 /**
524 * Logs a debug message for verbose output
525 *
526 * @param string Message
527 */
528 function debug($message)
529 {
530 $this->debuginfo[] = $message;
531 }
532
533 /**
534 * Recursive XSS cleaner
535 *
536 * @param mixed Unsanitized REQUEST data
537 *
538 * @return mixed Sanitized data
539 */
540 function _sanitize_input_recursive($data)
541 {
542 foreach ($data AS $key => $value)
543 {
544 if (is_array($value))
545 {
546 $data["$key"] = $this->_sanitize_input_recursive($value);
547 }
548 else
549 {
550 if ($this->escapestrings)
551 {
552 $data["$key"] = $this->escape($this->sanitize($value), false, false);
553 }
554 else
555 {
556 $data["$key"] = $this->sanitize($value);
557 }
558 }
559 }
560 return $data;
561 }
562
563 /**
564 * Simple way to protect against HTML attacks with Unicode support
565 *
566 * @param string Unsanitzed text
567 *
568 * @return string Properly protected text that only encodes potential threats
569 */
570 function sanitize($text)
571 {
572 if ($this->magicquotes)
573 {
574 return str_replace(array('<', '>', '\"', '"'), array('&lt;', '&gt;', '&quot;', '&quot;'), $text);
575 }
576 else
577 {
578 return str_replace(array('<', '>', '"'), array('&lt;', '&gt;', '&quot;'), $text);
579 }
580 }
581
582 /**
583 * Unicode-safe entity encoding system; similar to sanitize()
584 *
585 * @param string Unsanitized text
586 *
587 * @return string Unicode-safe sanitized text with entities preserved
588 */
589 function entity_encode($text)
590 {
591 $text = str_replace('&', '&amp;', $text);
592 $text = $this->sanitize($text);
593 return $text;
594 }
595
596 /**
597 * Takes text that has been processed for HTML and unsanitizes it
598 *
599 * @param string Text that needs to be turned back into HTML
600 * @param bool Force magicquotes off
601 *
602 * @return string Unsanitized text
603 */
604 function unsanitize($text, $force = false)
605 {
606 if ($this->magicquotes AND !$force)
607 {
608 return str_replace(array('&lt;', '&gt;', '&quot;'), array('<', '>', '\"'), $text);
609 }
610 else
611 {
612 return str_replace(array('&lt;', '&gt;', '&quot;'), array('<', '>', '"'), $text);
613 }
614 }
615
616 /**
617 * Smart addslashes() that only applies itself it the Magic Quotes GPC is off
618 *
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
622 *
623 * @return string String that has slashes added
624 */
625 function escape($str, $binary = false, $force = true)
626 {
627 if ($this->magicquotes AND !$force)
628 {
629 if (isset($this->db) AND $binary)
630 {
631 if (is_resource($this->db->link_id))
632 {
633 return $this->db->escape_string(stripslashes($str));
634 }
635 }
636 return $str;
637 }
638 else
639 {
640 if (isset($this->db) AND $binary)
641 {
642 if (is_resource($this->db->link_id))
643 {
644 return $this->db->escape_string($str);
645 }
646 }
647 return addslashes($str);
648 }
649 }
650
651 /**
652 * Runs through all of the input data and sanitizes it.
653 */
654 function exec_sanitize_data()
655 {
656 $this->in = $this->_sanitize_input_recursive(array_merge($_GET, $_POST, $_COOKIE));
657 // we're now using magic quotes
658 if ($this->escapestrings)
659 {
660 $this->magicquotes = 1;
661 }
662 }
663
664 /**
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
667 *
668 * @param array Array of elements to clean as varname => type
669 */
670 function input_clean_array($vars)
671 {
672 foreach ($vars AS $varname => $type)
673 {
674 $this->input_clean($varname, $type);
675 }
676 }
677
678 /**
679 * Sanitize function that does a single variable as oppoesd to an array (see input_clean_array() for more details)
680 *
681 * @param string Variable name in $isso->in[]
682 * @param integer Sanitization type constant
683 */
684 function input_clean($varname, $type)
685 {
686 $this->in["$varname"] = $this->clean($this->in["$varname"], $type);
687 }
688
689 /**
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[]
691 *
692 * @param mixed Data
693 * @param integer Sanitization type constant
694 *
695 * @return mixed Cleaned data
696 */
697 function clean($value, $type)
698 {
699 if ($type == TYPE_INT)
700 {
701 $value = intval($value);
702 }
703 else if ($type == TYPE_UINT)
704 {
705 $value = abs(intval($value));
706 }
707 else if ($type == TYPE_FLOAT)
708 {
709 $value = floatval($value);
710 }
711 else if ($type == TYPE_BOOL)
712 {
713 $value = (bool)$value;
714 }
715 else if ($type == TYPE_STR)
716 {
717 if (!$this->escapestrings)
718 {
719 $value = $this->escape($value);
720 }
721 }
722 else if ($type == TYPE_STRUN)
723 {
724 $value = $this->unsanitize($value);
725 }
726 else if ($type == TYPE_NOCLEAN)
727 {
728 if ($this->escapestrings)
729 {
730 $value = $this->escape($value);
731 }
732 }
733 else
734 {
735 trigger_error('Invalid clean type `' . $type . '` specified', E_USER_ERROR);
736 }
737
738 return $value;
739 }
740
741 /**
742 * Checks to see if a POST refer is actually from us
743 */
744 function exec_referer_check()
745 {
746 if ($_SERVER['REQUEST_METHOD'] == 'POST')
747 {
748 $host = ($_SERVER['HTTP_HOST']) ? $_SERVER['HTTP_HOST'] : $_ENV['HTTP_HOST'];
749
750 if ($host AND $_SERVER['HTTP_REFERER'])
751 {
752 $parts = parse_url($_SERVER['HTTP_REFERER']);
753 $ourhost = $parts['host'] . (($parts['port']) ? ":$parts[port]" : '');
754
755 if ($ourhost != $host)
756 {
757 trigger_error('No external hosts are allowed to POST to this application', E_USER_ERROR);
758 }
759 $this->debug('remote post check = ok');
760 }
761 else
762 {
763 $this->debug('remote post check = FAILED');
764 }
765 }
766 }
767 }
768
769 /*=====================================================================*\
770 || ###################################################################
771 || # $HeadURL$
772 || # $Id$
773 || ###################################################################
774 \*=====================================================================*/
775 ?>