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