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                 $this->modules["$framework"] = $asobject;
 253
 254                 if (isset($this->$asobject))
 255                 {
 256                         trigger_error('Cannot instantiate framework `' . $framework . '` into `' . $asobject . '`', E_USER_ERROR);
 257                 }
 258
 259                 $this->$asobject = new $framework($this);
 260
 261                 if ($globalize)
 262                 {
 263                         $GLOBALS["$asobject"] =& $this->$asobject;
 264                 }
 265
 266                 return $this->$asobject;
 267         }
 268
 269         /**
 270         * Returns the instance of a loaded module
 271         *
 272         * @param        string  Framework name
 273         *
 274         * @return       object  Instantiated instance
 275         */
 276         function &getobject($framework)
 277         {
 278                 if (!$this->is_loaded($framework))
 279                 {
 280                         trigger_error('Framework module `' . $framework . '` is not loaded', E_USER_WARNING);
 281                 }
 282
 283                 return $this->{$this->modules["$framework"]};
 284         }
 285
 286         /**
 287         * Prints a list of all currently loaded framework modules
 288         *
 289         * @param        bool    Return the data as an array?
 290         *
 291         * @return       mixed   HTML output or an array of loaded modules
 292         */
 293         function show_modules($return = false)
 294         {
 295                 if ($return)
 296                 {
 297                         return $this->modules;
 298                 }
 299                 else
 300                 {
 301                         $output = "\n\n<ul>\n\t<li>";
 302                         $output .= implode("</li>\n\t<li>", $this->modules);
 303                         $output .= "</li>\n</ul>\n\n";
 304                         $this->_message('Loaded Modules', $output, 1);
 305                 }
 306         }
 307
 308         /**
 309         * Verifies to see if a framework has been loaded
 310         *
 311         * @param        string  Framework name
 312         *
 313         * @return       bool    Whether or not the framework has been loaded
 314         */
 315         function is_loaded($framework)
 316         {
 317                 if (isset($this->modules["$framework"]))
 318                 {
 319                         return true;
 320                 }
 321                 else
 322                 {
 323                         return false;
 324                 }
 325         }
 326
 327         /**
 328         * Prints an ISSO message
 329         *
 330         * @param        string  The title of the message
 331         * @param        string  The content of the message
 332         * @param        integer Type of message to be printed
 333         * @param        bool    Return the output?
 334         *
 335         * @return       mixed   Output or null
 336         */
 337         function _message($title, $message, $type, $return = false)
 338         {
 339                 switch ($type)
 340                 {
 341                         // Message
 342                         case 1:
 343                                 $prefix = 'Message';
 344                                 $color = '#669900';
 345                                 $font = '#000000';
 346                         break;
 347
 348                         // Warning
 349                         case 2:
 350                                 $prefix = 'Warning';
 351                                 $color = '#003399';
 352                                 $font = '#FFFFFF';
 353                         break;
 354
 355                         case 3:
 356                                 $prefix = 'Error';
 357                                 $color = '#990000';
 358                                 $font = '#EFEFEF';
 359                         break;
 360                 }
 361
 362                 $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;\">";
 363                 $output .= "\n<tr style=\"color: $font; text-align: left\">\n\t<td><strong>$prefix: $title</strong></td>\n</tr>";
 364                 $output .= "\n<tr style=\"background-color: #FFFFFF; text-align: left\">\n\t<td>$message</td>\n</tr>\n</table>\n<br />\n";
 365
 366                 if ($return)
 367                 {
 368                         return $output;
 369                 }
 370                 else
 371                 {
 372                         print($output);
 373                 }
 374         }
 375
 376         /**
 377         * Custom error handler for ISSO
 378         * We only handle E_WARNING, E_NOTICE, E_USER_ERROR, E_USER_WARNING, E_USER_NOTICE
 379         *
 380         * @param        integer Error number
 381         * @param        string  Error message string
 382         * @param        string  File that contains the error
 383         * @param        string  The line number of the error
 384         * @param        string  The active symbol table at which point the error occurred
 385         */
 386         function _error_handler($errno, $errstr, $errfile, $errline)
 387         {
 388                 switch ($errno)
 389                 {
 390                         // Fatal
 391                         case E_USER_ERROR:
 392                                 $title = 'Fatal';
 393                                 $level = 3;
 394                                 if (!(ini_get('error_reporting') & E_USER_ERROR))
 395                                 {
 396                                         return;
 397                                 }
 398                         break;
 399
 400                         // Error
 401                         case E_USER_WARNING:
 402                                 $title = 'Warning';
 403                                 $level = 2;
 404                                 if (!(ini_get('error_reporting') & E_USER_WARNING) AND !(ini_get('error_reporting') & E_WARNING))
 405                                 {
 406                                         return;
 407                                 }
 408                         break;
 409
 410                         // Warning
 411                         case E_USER_NOTICE:
 412                         default:
 413                                 $title = 'Notice';
 414                                 $level = 1;
 415                                 if (!(ini_get('error_reporting') & E_USER_NOTICE) AND !(ini_get('error_reporting') & E_NOTICE))
 416                                 {
 417                                         return;
 418                                 }
 419                         break;
 420                 }
 421
 422                 $errfile = str_replace(array(getcwd(), dirname(getcwd())), '', $errfile);
 423
 424                 $errstr .= " in <strong>$errfile</strong> on line <strong>$errline</strong>";
 425
 426                 $this->_message($title, $errstr, $level);
 427
 428                 if ($errno == E_USER_ERROR)
 429                 {
 430                         exit;
 431                 }
 432         }
 433
 434         /**
 435         * Logs a debug message for verbose output
 436         *
 437         * @param        string  Message
 438         */
 439         function debug($message)
 440         {
 441                 $this->debuginfo[] = $message;
 442         }
 443
 444         /**
 445         * Recursive XSS cleaner
 446         *
 447         * @param        mixed   Unsanitized REQUEST data
 448         *
 449         * @return       mixed   Sanitized data
 450         */
 451         function _sanitize_input_recursive($data)
 452         {
 453                 foreach ($data AS $key => $value)
 454                 {
 455                         if (is_array($value))
 456                         {
 457                                 $data["$key"] = $this->_sanitize_input_recursive($value);
 458                         }
 459                         else
 460                         {
 461                                 if ($this->escapestrings)
 462                                 {
 463                                         $data["$key"] = $this->escape($this->sanitize($value), false, false);
 464                                 }
 465                                 else
 466                                 {
 467                                         $data["$key"] = $this->sanitize($value);
 468                                 }
 469                         }
 470                 }
 471                 return $data;
 472         }
 473
 474         /**
 475         * Simple way to protect against HTML attacks with Unicode support
 476         *
 477         * @param        string  Unsanitzed text
 478         *
 479         * @return       string  Properly protected text that only encodes potential threats
 480         */
 481         function sanitize($text)
 482         {
 483                 if ($this->magicquotes)
 484                 {
 485                         return str_replace(array('<', '>', '\"', '"'), array('&lt;', '&gt;', '&quot;', '&quot;'), $text);
 486                 }
 487                 else
 488                 {
 489                         return str_replace(array('<', '>', '"'), array('&lt;', '&gt;', '&quot;'), $text);
 490                 }
 491         }
 492
 493         /**
 494         * Takes text that has been processed for HTML and unsanitizes it
 495         *
 496         * @param        string  Text that needs to be turned back into HTML
 497         * @param        bool    Force magicquotes off
 498         *
 499         * @return       string  Unsanitized text
 500         */
 501         function unsanitize($text, $force = false)
 502         {
 503                 if ($this->magicquotes AND !$force)
 504                 {
 505                         return str_replace(array('&lt;', '&gt;', '&quot;'), array('<', '>', '\"'), $text);
 506                 }
 507                 else
 508                 {
 509                         return str_replace(array('&lt;', '&gt;', '&quot;'), array('<', '>', '"'), $text);
 510                 }
 511         }
 512
 513         /**
 514         * Smart addslashes() that only applies itself it the Magic Quotes GPC is off
 515         *
 516         * @param        string  Some string
 517         * @param        bool    If the data is binary; if so it'll be run through DB::escape_stringing()
 518         * @param        bool    Force magic quotes to be off
 519         *
 520         * @return       string  String that has slashes added
 521         */
 522         function escape($str, $binary = false, $force = true)
 523         {
 524                 if ($this->magicquotes AND !$force)
 525                 {
 526                         if (isset($this->db) AND $binary)
 527                         {
 528                                 if (is_resource($this->db->link_id))
 529                                 {
 530                                         return $this->db->escape_string(stripslashes($str));
 531                                 }
 532                         }
 533                         return $str;
 534                 }
 535                 else
 536                 {
 537                         if (isset($this->db) AND $binary)
 538                         {
 539                                 if (is_resource($this->db->link_id))
 540                                 {
 541                                         return $this->db->escape_string($str);
 542                                 }
 543                         }
 544                         return addslashes($str);
 545                 }
 546         }
 547
 548         /**
 549         * Runs through all of the input data and sanitizes it.
 550         */
 551         function exec_sanitize_data()
 552         {
 553                 $this->in = $this->_sanitize_input_recursive(array_merge($_GET, $_POST, $_COOKIE));
 554                 // we're now using magic quotes
 555                 if ($this->escapestrings)
 556                 {
 557                         $this->magicquotes = 1;
 558                 }
 559         }
 560
 561         /**
 562         * Checks to see if a POST refer is actually from us
 563         */
 564         function exec_referer_check()
 565         {
 566                 if ($_SERVER['REQUEST_METHOD'] == 'POST')
 567                 {
 568                         $host = ($_SERVER['HTTP_HOST']) ? $_SERVER['HTTP_HOST'] : $_ENV['HTTP_HOST'];
 569
 570                         if ($host AND $_SERVER['HTTP_REFERER'])
 571                         {
 572                                 $parts = parse_url($_SERVER['HTTP_REFERER']);
 573                                 $ourhost = $parts['host'] . (($parts['port']) ? ":$parts[port]" : '');
 574
 575                                 if ($ourhost != $host)
 576                                 {
 577                                         trigger_error('No external hosts are allowed to POST to this application', E_USER_ERROR);
 578                                 }
 579                                 $this->debug('remote post check = ok');
 580                         }
 581                         else
 582                         {
 583                                 $this->debug('remote post check = FAILED');
 584                         }
 585                 }
 586         }
 587 }
 588
 589 /*=====================================================================*\
 590 || ###################################################################
 591 || # $HeadURL$
 592 || # $Id$
 593 || ###################################################################
 594 \*=====================================================================*/
 595 ?>