]> src.bluestatic.org Git - isso.git/blob - kernel.php
getobject() apparently causes a parse error; guess we have to use arrays
[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 * Iris Studios Shared Object Framework (ISSO)
91 *
92 * This framework allows a common backend to be used amongst all Iris
93 * Studios applications and is built to be abstract and flexible.
94 * The base framework handles all loading and module management.
95 *
96 * @author Iris Studios, Inc.
97 * @copyright Copyright ©2002 - [#]year[#], Iris Studios, Inc.
98 * @version $Revision$
99 * @package ISSO
100 *
101 */
102 class Shared_Object_Framework
103 {
104 /**
105 * ISSO version
106 * @var string
107 */
108 var $version = '[#]version[#]';
109
110 /**
111 * Location of ISSO, used for internal linking
112 * @var string
113 */
114 var $sourcepath = '';
115
116 /**
117 * Path of the current application
118 * @var string
119 */
120 var $apppath = '';
121
122 /**
123 * Name of the current application
124 * @var string
125 */
126 var $application = '';
127
128 /**
129 * Version of the current application
130 * @var string
131 */
132 var $appversion = '';
133
134 /**
135 * Whether debug mode is on or off
136 * @var bool
137 */
138 var $debug = false;
139
140 /**
141 * List of all active debug messages
142 * @var array
143 */
144 var $debuginfo = array();
145
146 /**
147 * List of loaded modules
148 * @var array
149 */
150 var $modules = array();
151
152 /**
153 * An array of sanitized variables that have been cleaned for HTML tag openers and double quotes
154 * @var array
155 */
156 var $in = array();
157
158 /**
159 * If we are running with magic_quotes_gpc on or off
160 * @var int
161 */
162 var $magicquotes = 0;
163
164 /**
165 * If we should automagically escape strings, mimicking magic_quotes_gpc
166 * @var bool
167 */
168 var $escapestrings = false;
169
170 /**
171 * Constructor
172 */
173 function Shared_Object_Framework()
174 {
175 // error reporting
176 set_error_handler(array(&$this, '_error_handler'));
177
178 // magic quotes
179 $this->magicquotes = get_magic_quotes_gpc();
180 set_magic_quotes_runtime(0);
181
182 if (defined('ISSO_ESCAPE_STRINGS'))
183 {
184 $this->escapestrings = (bool)constant('ISSO_ESCAPE_STRINGS');
185 }
186
187 // start input sanitize using variable_order GPC
188 if (!$this->escapestrings)
189 {
190 $this->exec_sanitize_data();
191 }
192
193 if (defined('ISSO_CHECK_POST_REFERER'))
194 {
195 $this->exec_referer_check();
196 }
197
198 $this->modules['kernel'] = 'Shared Object Framework Core';
199 }
200
201 /**
202 * Prepares a path for being set as the sourcepath
203 *
204 * @param string Source path or URL
205 *
206 * @return string Prepared source path
207 */
208 function fetch_sourcepath($source)
209 {
210 if (substr($source, strlen($source) - 1) != DIRECTORY_SEPARATOR)
211 {
212 $source .= DIRECTORY_SEPARATOR;
213 }
214 return $source;
215 }
216
217 /**
218 * Loads a framework module
219 *
220 * @param string Name of the framework file to load
221 * @param string Internal variable to initialize as; to not instantiate (just require) leave it as NULL
222 * @param bool Globalize the internal variable?
223 *
224 * @return object Instantiated instance
225 */
226 function &load($framework, $asobject, $globalize = false)
227 {
228 if ($this->is_loaded($framework))
229 {
230 return $this->getobj($framework);
231 }
232
233 if ($this->sourcepath == '')
234 {
235 trigger_error('Invalid sourcepath specified', E_USER_ERROR);
236 }
237
238 if (file_exists($this->sourcepath . $framework . '.php'))
239 {
240 require_once($this->sourcepath . $framework . '.php');
241 }
242 else
243 {
244 trigger_error('Could not find the framework ' . $this->sourcepath . $framework . '.php', E_USER_ERROR);
245 }
246
247 if ($asobject === null)
248 {
249 return;
250 }
251
252 if (isset($this->$asobject))
253 {
254 trigger_error('Cannot instantiate framework `' . $framework . '` into `' . $asobject . '`', E_USER_ERROR);
255 }
256
257 $this->$asobject = new $framework($this);
258
259 $this->modules["$framework"] =& $this->$asobject;
260
261 if ($globalize)
262 {
263 $GLOBALS["$asobject"] =& $this->$asobject;
264 }
265
266 return $this->$asobject;
267 }
268
269 /**
270 * Prints a list of all currently loaded framework modules
271 *
272 * @param bool Return the data as an array?
273 *
274 * @return mixed HTML output or an array of loaded modules
275 */
276 function show_modules($return = false)
277 {
278 if ($return)
279 {
280 return $this->modules;
281 }
282 else
283 {
284 $output = "\n\n<ul>\n\t<li>";
285 $output .= implode("</li>\n\t<li>", $this->modules);
286 $output .= "</li>\n</ul>\n\n";
287 $this->_message('Loaded Modules', $output, 1);
288 }
289 }
290
291 /**
292 * Verifies to see if a framework has been loaded
293 *
294 * @param string Framework name
295 *
296 * @return bool Whether or not the framework has been loaded
297 */
298 function is_loaded($framework)
299 {
300 if (isset($this->modules["$framework"]))
301 {
302 return true;
303 }
304 else
305 {
306 return false;
307 }
308 }
309
310 /**
311 * Prints an ISSO message
312 *
313 * @param string The title of the message
314 * @param string The content of the message
315 * @param integer Type of message to be printed
316 * @param bool Return the output?
317 *
318 * @return mixed Output or null
319 */
320 function _message($title, $message, $type, $return = false)
321 {
322 switch ($type)
323 {
324 // Message
325 case 1:
326 $prefix = 'Message';
327 $color = '#669900';
328 $font = '#000000';
329 break;
330
331 // Warning
332 case 2:
333 $prefix = 'Warning';
334 $color = '#003399';
335 $font = '#FFFFFF';
336 break;
337
338 case 3:
339 $prefix = 'Error';
340 $color = '#990000';
341 $font = '#EFEFEF';
342 break;
343 }
344
345 $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;\">";
346 $output .= "\n<tr style=\"color: $font; text-align: left\">\n\t<td><strong>$prefix: $title</strong></td>\n</tr>";
347 $output .= "\n<tr style=\"background-color: #FFFFFF; text-align: left\">\n\t<td>$message</td>\n</tr>\n</table>\n<br />\n";
348
349 if ($return)
350 {
351 return $output;
352 }
353 else
354 {
355 print($output);
356 }
357 }
358
359 /**
360 * Custom error handler for ISSO
361 * We only handle E_WARNING, E_NOTICE, E_USER_ERROR, E_USER_WARNING, E_USER_NOTICE
362 *
363 * @param integer Error number
364 * @param string Error message string
365 * @param string File that contains the error
366 * @param string The line number of the error
367 * @param string The active symbol table at which point the error occurred
368 */
369 function _error_handler($errno, $errstr, $errfile, $errline)
370 {
371 switch ($errno)
372 {
373 // Fatal
374 case E_USER_ERROR:
375 $title = 'Fatal';
376 $level = 3;
377 if (!(ini_get('error_reporting') & E_USER_ERROR))
378 {
379 return;
380 }
381 break;
382
383 // Error
384 case E_USER_WARNING:
385 $title = 'Warning';
386 $level = 2;
387 if (!(ini_get('error_reporting') & E_USER_WARNING) AND !(ini_get('error_reporting') & E_WARNING))
388 {
389 return;
390 }
391 break;
392
393 // Warning
394 case E_USER_NOTICE:
395 default:
396 $title = 'Notice';
397 $level = 1;
398 if (!(ini_get('error_reporting') & E_USER_NOTICE) AND !(ini_get('error_reporting') & E_NOTICE))
399 {
400 return;
401 }
402 break;
403 }
404
405 $errfile = str_replace(array(getcwd(), dirname(getcwd())), '', $errfile);
406
407 $errstr .= " in <strong>$errfile</strong> on line <strong>$errline</strong>";
408
409 $this->_message($title, $errstr, $level);
410
411 if ($errno == E_USER_ERROR)
412 {
413 exit;
414 }
415 }
416
417 /**
418 * Logs a debug message for verbose output
419 *
420 * @param string Message
421 */
422 function debug($message)
423 {
424 $this->debuginfo[] = $message;
425 }
426
427 /**
428 * Recursive XSS cleaner
429 *
430 * @param mixed Unsanitized REQUEST data
431 *
432 * @return mixed Sanitized data
433 */
434 function _sanitize_input_recursive($data)
435 {
436 foreach ($data AS $key => $value)
437 {
438 if (is_array($value))
439 {
440 $data["$key"] = $this->_sanitize_input_recursive($value);
441 }
442 else
443 {
444 if ($this->escapestrings)
445 {
446 $data["$key"] = $this->escape($this->sanitize($value), false, false);
447 }
448 else
449 {
450 $data["$key"] = $this->sanitize($value);
451 }
452 }
453 }
454 return $data;
455 }
456
457 /**
458 * Simple way to protect against HTML attacks with Unicode support
459 *
460 * @param string Unsanitzed text
461 *
462 * @return string Properly protected text that only encodes potential threats
463 */
464 function sanitize($text)
465 {
466 if ($this->magicquotes)
467 {
468 return str_replace(array('<', '>', '\"', '"'), array('&lt;', '&gt;', '&quot;', '&quot;'), $text);
469 }
470 else
471 {
472 return str_replace(array('<', '>', '"'), array('&lt;', '&gt;', '&quot;'), $text);
473 }
474 }
475
476 /**
477 * Takes text that has been processed for HTML and unsanitizes it
478 *
479 * @param string Text that needs to be turned back into HTML
480 * @param bool Force magicquotes off
481 *
482 * @return string Unsanitized text
483 */
484 function unsanitize($text, $force = false)
485 {
486 if ($this->magicquotes AND !$force)
487 {
488 return str_replace(array('&lt;', '&gt;', '&quot;'), array('<', '>', '\"'), $text);
489 }
490 else
491 {
492 return str_replace(array('&lt;', '&gt;', '&quot;'), array('<', '>', '"'), $text);
493 }
494 }
495
496 /**
497 * Smart addslashes() that only applies itself it the Magic Quotes GPC is off
498 *
499 * @param string Some string
500 * @param bool If the data is binary; if so it'll be run through DB::escape_stringing()
501 * @param bool Force magic quotes to be off
502 *
503 * @return string String that has slashes added
504 */
505 function escape($str, $binary = false, $force = true)
506 {
507 if ($this->magicquotes AND !$force)
508 {
509 if (isset($this->db) AND $binary)
510 {
511 if (is_resource($this->db->link_id))
512 {
513 return $this->db->escape_string(stripslashes($str));
514 }
515 }
516 return $str;
517 }
518 else
519 {
520 if (isset($this->db) AND $binary)
521 {
522 if (is_resource($this->db->link_id))
523 {
524 return $this->db->escape_string($str);
525 }
526 }
527 return addslashes($str);
528 }
529 }
530
531 /**
532 * Runs through all of the input data and sanitizes it.
533 */
534 function exec_sanitize_data()
535 {
536 $this->in = $this->_sanitize_input_recursive(array_merge($_GET, $_POST, $_COOKIE));
537 // we're now using magic quotes
538 if ($this->escapestrings)
539 {
540 $this->magicquotes = 1;
541 }
542 }
543
544 /**
545 * Checks to see if a POST refer is actually from us
546 */
547 function exec_referer_check()
548 {
549 if ($_SERVER['REQUEST_METHOD'] == 'POST')
550 {
551 $host = ($_SERVER['HTTP_HOST']) ? $_SERVER['HTTP_HOST'] : $_ENV['HTTP_HOST'];
552
553 if ($host AND $_SERVER['HTTP_REFERER'])
554 {
555 $parts = parse_url($_SERVER['HTTP_REFERER']);
556 $ourhost = $parts['host'] . (($parts['port']) ? ":$parts[port]" : '');
557
558 if ($ourhost != $host)
559 {
560 trigger_error('No external hosts are allowed to POST to this application', E_USER_ERROR);
561 }
562 $this->debug('remote post check = ok');
563 }
564 else
565 {
566 $this->debug('remote post check = FAILED');
567 }
568 }
569 }
570 }
571
572 /*=====================================================================*\
573 || ###################################################################
574 || # $HeadURL$
575 || # $Id$
576 || ###################################################################
577 \*=====================================================================*/
578 ?>