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                 $GLOBALS['isso:null-framework'] = null;
 244         }
 245
 246         /**
 247         * (PHP 4) Constructor
 248         */
 249         function Shared_Object_Framework()
 250         {
 251                 $this->__construct();
 252         }
 253
 254         /**
 255         * Prepares a path for being set as the sourcepath
 256         *
 257         * @param        string  Source path or URL
 258         *
 259         * @return       string  Prepared source path
 260         */
 261         function fetch_sourcepath($source)
 262         {
 263                 if (substr($source, strlen($source) - 1) != DIRECTORY_SEPARATOR)
 264                 {
 265                         $source .= DIRECTORY_SEPARATOR;
 266                 }
 267                 return $source;
 268         }
 269
 270         /**
 271         * Loads a framework module
 272         *
 273         * @param        string  Name of the framework file to load
 274         * @param        string  Internal variable to initialize as; to not instantiate (just require) leave it as NULL
 275         * @param        bool    Globalize the internal variable?
 276         *
 277         * @return       object  Instantiated instance
 278         */
 279         function &load($framework, $asobject, $globalize = false)
 280         {
 281                 // set the object interlock
 282                 if (!method_exists($GLOBALS['isso:null-framework'], 'load'))
 283                 {
 284                         $GLOBALS['isso:null-framework'] =& $this;
 285                 }
 286
 287                 if ($this->is_loaded($framework))
 288                 {
 289                         return $this->modules["$framework"];
 290                 }
 291
 292                 if ($this->sourcepath == '')
 293                 {
 294                         trigger_error('Invalid sourcepath specified', E_USER_ERROR);
 295                 }
 296
 297                 if (file_exists($this->sourcepath . $framework . '.php'))
 298                 {
 299                         require_once($this->sourcepath . $framework . '.php');
 300                 }
 301                 else
 302                 {
 303                         trigger_error('Could not find the framework ' . $this->sourcepath . $framework . '.php', E_USER_ERROR);
 304                 }
 305
 306                 if ($asobject === null)
 307                 {
 308                         return;
 309                 }
 310
 311                 if (isset($this->$asobject))
 312                 {
 313                         trigger_error('Cannot instantiate framework `' . $framework . '` into `' . $asobject . '`', E_USER_ERROR);
 314                 }
 315
 316                 $this->$asobject = new $framework($this);
 317
 318                 $this->modules["$framework"] =& $this->$asobject;
 319
 320                 if ($globalize)
 321                 {
 322                         $GLOBALS["$asobject"] =& $this->$asobject;
 323                 }
 324
 325                 return $this->$asobject;
 326         }
 327
 328         /**
 329         * Prints a list of all currently loaded framework modules
 330         *
 331         * @param        bool    Return the data as an array?
 332         *
 333         * @return       mixed   HTML output or an array of loaded modules
 334         */
 335         function show_modules($return = false)
 336         {
 337                 foreach ($this->modules AS $object)
 338                 {
 339                         $modules[] = get_class($object);
 340                 }
 341
 342                 if ($return)
 343                 {
 344                         return $modules;
 345                 }
 346                 else
 347                 {
 348                         $output = "\n\n<ul>\n\t<li>";
 349                         $output .= implode("</li>\n\t<li>", $modules);
 350                         $output .= "</li>\n</ul>\n\n";
 351                         $this->message('Loaded Modules', $output, 1);
 352                 }
 353         }
 354
 355         /**
 356         * Verifies to see if a framework has been loaded
 357         *
 358         * @param        string  Framework name
 359         *
 360         * @return       bool    Whether or not the framework has been loaded
 361         */
 362         function is_loaded($framework)
 363         {
 364                 if (isset($this->modules["$framework"]))
 365                 {
 366                         return true;
 367                 }
 368                 else
 369                 {
 370                         return false;
 371                 }
 372         }
 373
 374         /**
 375         * Prints an ISSO message
 376         *
 377         * @param        string  The title of the message
 378         * @param        string  The content of the message
 379         * @param        integer Type of message to be printed
 380         * @param        bool    Return the output?
 381         * @param        bool    Show the debug stack?
 382         *
 383         * @return       mixed   Output or null
 384         */
 385         function message($title, $message, $type, $return = false, $stack = true)
 386         {
 387                 switch ($type)
 388                 {
 389                         // Message
 390                         case 1:
 391                                 $prefix = 'Message';
 392                                 $color = '#669900';
 393                                 $font = '#000000';
 394                         break;
 395
 396                         // Warning
 397                         case 2:
 398                                 $prefix = 'Warning';
 399                                 $color = '#003399';
 400                                 $font = '#FFFFFF';
 401                         break;
 402
 403                         case 3:
 404                                 $prefix = 'Error';
 405                                 $color = '#990000';
 406                                 $font = '#EFEFEF';
 407                         break;
 408                 }
 409
 410                 $backtrace = debug_backtrace();
 411                 unset($backtrace[0]);
 412
 413                 $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;\">";
 414                 $output .= "\n<tr style=\"color: $font; text-align: left\">\n\t<td><strong>$prefix: $title</strong></td>\n</tr>";
 415                 $output .= "\n<tr style=\"background-color: #FFFFFF; text-align: left\">\n\t<td>$message</td>\n</tr>";
 416                 $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>" : '');
 417                 $output .= "\n</table>\n<br />\n";
 418
 419                 if ($return)
 420                 {
 421                         return $output;
 422                 }
 423                 else
 424                 {
 425                         print($output);
 426                 }
 427         }
 428
 429         /**
 430         * Custom error handler for ISSO
 431         * We only handle E_WARNING, E_NOTICE, E_USER_ERROR, E_USER_WARNING, E_USER_NOTICE
 432         *
 433         * @param        integer Error number
 434         * @param        string  Error message string
 435         * @param        string  File that contains the error
 436         * @param        string  The line number of the error
 437         * @param        string  The active symbol table at which point the error occurred
 438         */
 439         function _error_handler($errno, $errstr, $errfile, $errline)
 440         {
 441                 switch ($errno)
 442                 {
 443                         // Fatal
 444                         case E_USER_ERROR:
 445                                 $title = 'Fatal';
 446                                 $level = 3;
 447                                 if (!(ini_get('error_reporting') & E_USER_ERROR))
 448                                 {
 449                                         return;
 450                                 }
 451                         break;
 452
 453                         // Error
 454                         case E_USER_WARNING:
 455                                 $title = 'Warning';
 456                                 $level = 2;
 457                                 if (!(ini_get('error_reporting') & E_USER_WARNING) AND !(ini_get('error_reporting') & E_WARNING))
 458                                 {
 459                                         return;
 460                                 }
 461                         break;
 462
 463                         // Warning
 464                         case E_USER_NOTICE:
 465                         default:
 466                                 $title = 'Notice';
 467                                 $level = 1;
 468                                 if (!(ini_get('error_reporting') & E_USER_NOTICE) AND !(ini_get('error_reporting') & E_NOTICE))
 469                                 {
 470                                         return;
 471                                 }
 472                         break;
 473                 }
 474
 475                 $errfile = str_replace(array(getcwd(), dirname(getcwd())), '', $errfile);
 476
 477                 $errstr .= " in <strong>$errfile</strong> on line <strong>$errline</strong>";
 478
 479                 $this->message($title, $errstr, $level);
 480
 481                 if ($errno == E_USER_ERROR)
 482                 {
 483                         exit;
 484                 }
 485         }
 486
 487         /**
 488         * Creates a table that explains the error reporting levels and their sate
 489         */
 490         function explain_error_reporting()
 491         {
 492                 $levels = array(
 493                         'E_ERROR'                       => E_ERROR,
 494                         'E_WARNING'                     => E_WARNING,
 495                         'E_PARSE'                       => E_PARSE,
 496                         'E_NOTICE'                      => E_NOTICE,
 497                         'E_CORE_ERROR'          => E_CORE_ERROR,
 498                         'E_CORE_WARNING'        => E_CORE_WARNING,
 499                         'E_COMPILE_ERROR'       => 64,
 500                         'E_COMPILE_WARNING'     => 128,
 501                         'E_USER_ERROR'          => E_USER_ERROR,
 502                         'E_USER_WARNING'        => E_USER_WARNING,
 503                         'E_USER_NOTICE'         => E_USER_NOTICE,
 504                         'E_ALL'                         => E_ALL,
 505                         'E_STRICT'                      => 2048
 506                 );
 507
 508                 $table = '<table cellspacing="0" cellpadding="2" border="0">';
 509
 510                 foreach ($levels AS $name => $value)
 511                 {
 512                         $table .= '
 513                         <tr>
 514                                 <td>' . $name . '</td>
 515                                 <td>' . (ini_get('error_reporting') & $value) . '</td>
 516                         </tr>';
 517                 }
 518
 519                 $table .= '
 520                 </table>';
 521
 522                 $this->message('Error Reporting', $table, 1);
 523         }
 524
 525         /**
 526         * Logs a debug message for verbose output
 527         *
 528         * @param        string  Message
 529         */
 530         function debug($message)
 531         {
 532                 $this->debuginfo[] = $message;
 533         }
 534
 535         /**
 536         * Recursive XSS cleaner
 537         *
 538         * @param        mixed   Unsanitized REQUEST data
 539         *
 540         * @return       mixed   Sanitized data
 541         */
 542         function _sanitize_input_recursive($data)
 543         {
 544                 foreach ($data AS $key => $value)
 545                 {
 546                         if (is_array($value))
 547                         {
 548                                 $data["$key"] = $this->_sanitize_input_recursive($value);
 549                         }
 550                         else
 551                         {
 552                                 if ($this->escapestrings)
 553                                 {
 554                                         $data["$key"] = $this->escape($this->sanitize($value), false, false);
 555                                 }
 556                                 else
 557                                 {
 558                                         $data["$key"] = $this->sanitize($value);
 559                                 }
 560                         }
 561                 }
 562                 return $data;
 563         }
 564
 565         /**
 566         * Simple way to protect against HTML attacks with Unicode support
 567         *
 568         * @param        string  Unsanitzed text
 569         *
 570         * @return       string  Properly protected text that only encodes potential threats
 571         */
 572         function sanitize($text)
 573         {
 574                 if ($this->magicquotes)
 575                 {
 576                         return str_replace(array('<', '>', '\"', '"'), array('&lt;', '&gt;', '&quot;', '&quot;'), $text);
 577                 }
 578                 else
 579                 {
 580                         return str_replace(array('<', '>', '"'), array('&lt;', '&gt;', '&quot;'), $text);
 581                 }
 582         }
 583
 584         /**
 585         * Unicode-safe entity encoding system; similar to sanitize()
 586         *
 587         * @param        string  Unsanitized text
 588         *
 589         * @return       string  Unicode-safe sanitized text with entities preserved
 590         */
 591         function entity_encode($text)
 592         {
 593                 $text = str_replace('&', '&amp;', $text);
 594                 $text = $this->sanitize($text);
 595                 return $text;
 596         }
 597
 598         /**
 599         * Takes text that has been processed for HTML and unsanitizes it
 600         *
 601         * @param        string  Text that needs to be turned back into HTML
 602         * @param        bool    Force magicquotes off
 603         *
 604         * @return       string  Unsanitized text
 605         */
 606         function unsanitize($text, $force = false)
 607         {
 608                 if ($this->magicquotes AND !$force)
 609                 {
 610                         return str_replace(array('&lt;', '&gt;', '&quot;'), array('<', '>', '\"'), $text);
 611                 }
 612                 else
 613                 {
 614                         return str_replace(array('&lt;', '&gt;', '&quot;'), array('<', '>', '"'), $text);
 615                 }
 616         }
 617
 618         /**
 619         * Smart addslashes() that only applies itself it the Magic Quotes GPC is off
 620         *
 621         * @param        string  Some string
 622         * @param        bool    If the data is binary; if so it'll be run through DB::escape_stringing()
 623         * @param        bool    Force magic quotes to be off
 624         *
 625         * @return       string  String that has slashes added
 626         */
 627         function escape($str, $binary = false, $force = true)
 628         {
 629                 if ($this->magicquotes AND !$force)
 630                 {
 631                         if (isset($this->db) AND $binary)
 632                         {
 633                                 if (is_resource($this->db->link_id))
 634                                 {
 635                                         return $this->db->escape_string(stripslashes($str));
 636                                 }
 637                         }
 638                         return $str;
 639                 }
 640                 else
 641                 {
 642                         if (isset($this->db) AND $binary)
 643                         {
 644                                 if (is_resource($this->db->link_id))
 645                                 {
 646                                         return $this->db->escape_string($str);
 647                                 }
 648                         }
 649                         return addslashes($str);
 650                 }
 651         }
 652
 653         /**
 654         * Runs through all of the input data and sanitizes it.
 655         */
 656         function exec_sanitize_data()
 657         {
 658                 $this->in = $this->_sanitize_input_recursive(array_merge($_GET, $_POST, $_COOKIE));
 659                 // we're now using magic quotes
 660                 if ($this->escapestrings)
 661                 {
 662                         $this->magicquotes = 1;
 663                 }
 664         }
 665
 666         /**
 667         * Sanitize function for something other than a string (which everything is sanitized for if you use exec_sanitize_data().
 668         * Cleaned data is placed back into $isso->in; this makes it so you don't have to constantly intval() [etc.] data
 669         *
 670         * @param        array   Array of elements to clean as varname => type
 671         */
 672         function input_clean_array($vars)
 673         {
 674                 foreach ($vars AS $varname => $type)
 675                 {
 676                         $this->input_clean($varname, $type);
 677                 }
 678         }
 679
 680         /**
 681         * Sanitize function that does a single variable as oppoesd to an array (see input_clean_array() for more details)
 682         *
 683         * @param        string  Variable name in $isso->in[]
 684         * @param        integer Sanitization type constant
 685         */
 686         function input_clean($varname, $type)
 687         {
 688                 $this->in["$varname"] = $this->clean($this->in["$varname"], $type);
 689         }
 690
 691         /**
 692         * 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         *
 694         * @param        mixed   Data
 695         * @param        integer Sanitization type constant
 696         *
 697         * @return       mixed   Cleaned data
 698         */
 699         function clean($value, $type)
 700         {
 701                 if ($type == TYPE_INT)
 702                 {
 703                         $value = intval($value);
 704                 }
 705                 else if ($type == TYPE_UINT)
 706                 {
 707                         $value = abs(intval($value));
 708                 }
 709                 else if ($type == TYPE_FLOAT)
 710                 {
 711                         $value = floatval($value);
 712                 }
 713                 else if ($type == TYPE_BOOL)
 714                 {
 715                         $value = (bool)$value;
 716                 }
 717                 else if ($type == TYPE_STR)
 718                 {
 719                         if (!$this->escapestrings)
 720                         {
 721                                 $value = $this->escape($value);
 722                         }
 723                 }
 724                 else if ($type == TYPE_STRUN)
 725                 {
 726                         $value = $this->unsanitize($value);
 727                 }
 728                 else if ($type == TYPE_NOCLEAN)
 729                 {
 730                         if ($this->escapestrings)
 731                         {
 732                                 $value = $this->escape($value);
 733                         }
 734                 }
 735                 else
 736                 {
 737                         trigger_error('Invalid clean type `' . $type . '` specified', E_USER_ERROR);
 738                 }
 739
 740                 return $value;
 741         }
 742
 743         /**
 744         * Checks to see if a POST refer is actually from us
 745         */
 746         function exec_referer_check()
 747         {
 748                 if ($_SERVER['REQUEST_METHOD'] == 'POST')
 749                 {
 750                         $host = ($_SERVER['HTTP_HOST']) ? $_SERVER['HTTP_HOST'] : $_ENV['HTTP_HOST'];
 751
 752                         if ($host AND $_SERVER['HTTP_REFERER'])
 753                         {
 754                                 $parts = parse_url($_SERVER['HTTP_REFERER']);
 755                                 $ourhost = $parts['host'] . (($parts['port']) ? ":$parts[port]" : '');
 756
 757                                 if ($ourhost != $host)
 758                                 {
 759                                         trigger_error('No external hosts are allowed to POST to this application', E_USER_ERROR);
 760                                 }
 761                                 $this->debug('remote post check = ok');
 762                         }
 763                         else
 764                         {
 765                                 $this->debug('remote post check = FAILED');
 766                         }
 767                 }
 768         }
 769 }
 770
 771 /*=====================================================================*\
 772 || ###################################################################
 773 || # $HeadURL$
 774 || # $Id$
 775 || ###################################################################
 776 \*=====================================================================*/
 777 ?>