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