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