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                         $newlevel += $isso;
  57                 }
  58         }
  59         else
  60         {
  61                 if ($oldlevel & $isso)
  62                 {
  63                         $newlevel -= $isso;
  64                 }
  65         }
  66 }
  67 error_reporting($newlevel);
  68
  69 if ((bool)ini_get('register_globals') === true)
  70 {
  71         $superglobals = array('_GET', '_COOKIE', '_FILES', '_POST', '_SERVER', '_ENV');
  72         foreach ($superglobals AS $global)
  73         {
  74                 if (is_array(${$global}))
  75                 {
  76                         foreach (${$global} AS $_key => $_val)
  77                         {
  78                                 if (isset(${$_key}))
  79                                 {
  80                                         unset(${$_key});
  81                                 }
  82                         }
  83                 }
  84         }
  85 }
  86
  87 /**#@+
  88 * Input cleaning type constant
  89 */
  90 /**
  91 * Integer type
  92 */
  93 define('TYPE_INT', 1);
  94
  95 /**
  96 * Unsigned integer
  97 */
  98 define('TYPE_UINT', 2);
  99
 100 /**
 101 * Float type
 102 */
 103 define('TYPE_FLOAT', 4);
 104
 105 /**
 106 * Boolean type
 107 */
 108 define('TYPE_BOOL', 8);
 109
 110 /**
 111 * String - cleaned
 112 */
 113 define('TYPE_STR', 16);
 114
 115 /**
 116 * String - deliberate unclean
 117 */
 118 define('TYPE_STRUN', 32);
 119
 120 /**
 121 * No cleaning - here for use in API
 122 */
 123 define('TYPE_NOCLEAN', 64);
 124 /**#@-*/
 125
 126 /**
 127 * Yes, required
 128 */
 129 define('REQ_YES', 1);
 130
 131 /**
 132 * No, not required
 133 */
 134 define('REQ_NO', 0);
 135
 136 /**
 137 * Iris Studios Shared Object Framework (ISSO)
 138 *
 139 * This framework allows a common backend to be used amongst all Iris
 140 * Studios applications and is built to be abstract and flexible.
 141 * The base framework handles all loading and module management.
 142 *
 143 * Constants:
 144 *               ISSO_NO_INPUT_SANITIZE - Disables the automatic input sanitizer
 145 *               ISSO_CHECK_POST_REFERER - Will check to make sure that on POSTed
 146 *                                                                       data, the referer matches the host
 147 *
 148 * @author               Iris Studios, Inc.
 149 * @copyright    Copyright ©2002 - [#]year[#], Iris Studios, Inc.
 150 * @version              $Revision$
 151 * @package              ISSO
 152 *
 153 */
 154 class Shared_Object_Framework
 155 {
 156         /**
 157         * ISSO version
 158         * @var  string
 159         * @access       private
 160         */
 161         var $version = '[#]version[#]';
 162
 163         /**
 164         * Location of ISSO, used for internal linking
 165         * @var  string
 166         * @access       private
 167         */
 168         var $sourcepath = '';
 169
 170         /**
 171         * Path of the current application
 172         * @var  string
 173         * @access       private
 174         */
 175         var $apppath = '';
 176
 177         /**
 178         * Web path used to get the web location of the installation of ISSO; only used for Printer module
 179         * @var  string
 180         * @access       private
 181         */
 182         var $webpath = '';
 183
 184         /**
 185         * Name of the current application
 186         * @var  string
 187         * @access       private
 188         */
 189         var $application = '';
 190
 191         /**
 192         * Version of the current application
 193         * @var  string
 194         * @access       private
 195         */
 196         var $appversion = '';
 197
 198         /**
 199         * Whether debug mode is on or off
 200         * @var  bool
 201         * @access       private
 202         */
 203         var $debug = false;
 204
 205         /**
 206         * List of all active debug messages
 207         * @var  array
 208         * @access       private
 209         */
 210         var $debuginfo = array();
 211
 212         /**
 213         * List of loaded modules
 214         * @var  array
 215         * @access       private
 216         */
 217         var $modules = array();
 218
 219         /**
 220         * An array of sanitized variables that have been cleaned for HTML tag openers and double quotes
 221         * @var  array
 222         * @access       public
 223         */
 224         var $in = array();
 225
 226         /**
 227         * If we are running with magic_quotes_gpc on or off
 228         * @var  int
 229         * @access       private
 230         */
 231         var $magicquotes = 0;
 232
 233         /**
 234         * Array of user-specified fields that are required for ISSO initialization
 235         * fieldname => array(REQUIRED, CALLBACK PARSER, SET)
 236         * @var  array
 237         * @access       private
 238         */
 239         var $fields = array(
 240                 'sourcepath'    => array(REQ_YES,       'fetch_sourcepath', false),
 241                 'apppath'               => array(REQ_YES,       'fetch_sourcepath',     false),
 242                 'webpath'               => array(REQ_NO,        'fetch_sourcepath',     false),
 243                 'application'   => array(REQ_YES,       null,                           false),
 244                 'appversion'    => array(REQ_NO,        null,                           false),
 245                 'debug'                 => array(REQ_NO,        null,                           false)
 246         );
 247
 248         // ###################################################################
 249         /**
 250         * Constructor
 251         */
 252         function __construct()
 253         {
 254                 $GLOBALS['isso:null-framework'] = null;
 255
 256                 // error reporting
 257                 set_error_handler(array(&$this, '_error_handler'));
 258
 259                 // magic quotes
 260                 $this->magicquotes = get_magic_quotes_gpc();
 261                 set_magic_quotes_runtime(0);
 262
 263                 // start input sanitize using variable_order GPC
 264                 if (!defined('ISSO_NO_INPUT_SANITIZE'))
 265                 {
 266                         $this->exec_sanitize_data();
 267                 }
 268
 269                 if (defined('ISSO_CHECK_POST_REFERER'))
 270                 {
 271                         $this->exec_referer_check();
 272                 }
 273         }
 274
 275         // ###################################################################
 276         /**
 277         * (PHP 4) Constructor
 278         */
 279         function Shared_Object_Framework()
 280         {
 281                 $this->__construct();
 282         }
 283
 284         // ###################################################################
 285         /**
 286         * Sets a specified field in the ISSO. This is used to set all the
 287         * required fields that ISSO uses for linking. It replaces the old
 288         * method of setting the instance variables directly.
 289         *
 290         * @access       public
 291         *
 292         * @param        string  Field name
 293         * @param        mixed   Value of the field
 294         */
 295         function set($fieldname, $value)
 296         {
 297                 $this->do_set($fieldname, $value, null);
 298         }
 299
 300         // ###################################################################
 301         /**
 302         * Does the actual setting of the field. set() is defined in each
 303         * module, but this controls the actual data. This is done so that
 304         * there isn't an extra parameter in set() that controls module spaces
 305         *
 306         * @access       protected
 307         *
 308         * @param        string  Field name
 309         * @param        mixed   Value
 310         * @param        string  Module name (as referred to in ISSO->modules[]) to place in
 311         */
 312         function do_set($fieldname, $value, $module)
 313         {
 314                 if ($module == null)
 315                 {
 316                         $field =& $this->fields["$fieldname"];
 317                 }
 318                 else
 319                 {
 320                         $field =& $this->modules["$module"]->fields["$fieldname"];
 321                 }
 322
 323                 if (is_array($field))
 324                 {
 325                         if ($field[1] != null)
 326                         {
 327                                 if (preg_match('#^\$(.*)#', $field[1]))
 328                                 {
 329                                         $caller = preg_replace('#^\$(.*)->([a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*)$#e', 'array(&\1, \2)', $field[1]);
 330                                 }
 331                                 else
 332                                 {
 333                                         $caller = array(&$this, $field[1]);
 334                                 }
 335
 336                                 $value = call_user_func($caller, $value);
 337                         }
 338
 339                         if ($module == null)
 340                         {
 341                                 $this->$fieldname = $value;
 342                         }
 343                         else
 344                         {
 345                                 $this->modules["$module"]->$fieldname = $value;
 346                         }
 347
 348                         $field[2] = true;
 349                 }
 350                 else
 351                 {
 352                         trigger_error('Invalid field `' . $module . '.' . $fieldname . '` specified in ISSO->do_set()', E_USER_ERROR);
 353                 }
 354         }
 355
 356         // ###################################################################
 357         /**
 358         * Returns the value of an ISSO field. You should not access any instance
 359         * variables directly, use this instead.
 360         *
 361         * @access       public
 362         *
 363         * @param        string  Field name
 364         *
 365         * @return       mixed   Value of the field
 366         */
 367         function get($fieldname)
 368         {
 369                 if (is_array($this->fields["$fieldname"]))
 370                 {
 371                         if ($this->fields["$fieldname"][2] == false)
 372                         {
 373                                 trigger_error('Field `' . $fieldname . '` is not set and therefore cannot ISSO->get()', E_USER_ERROR);
 374                         }
 375
 376                         return $this->$fieldname;
 377                 }
 378                 else
 379                 {
 380                         trigger_error('Invalid field `' . $fieldname . '` specified in ISSO->get()', E_USER_ERROR);
 381                 }
 382         }
 383
 384         // ###################################################################
 385         /**
 386         * Makes sure that all of the required fields in ISSO are set before
 387         * any action is done. This will throw an error block describing
 388         * the fields that need to be set if any are missing.
 389         *
 390         * @access       public
 391         *
 392         * @param        bool    Is this a non-error environment that should display all fields?
 393         */
 394         function check_isso_fields($called = false)
 395         {
 396                 $missing = array();
 397                 foreach ($this->fields AS $name => $field)
 398                 {
 399                         if ($field[0] == REQ_YES AND $field[2] == false)
 400                         {
 401                                 $missing[] = $name;
 402                         }
 403                         else if ($called == true AND $field[2] == false)
 404                         {
 405                                 $missing[] = $name . ($field[0] == REQ_YES ? ' (REQUIRED)' : '');
 406                         }
 407                 }
 408
 409                 if (count($missing) > 0)
 410                 {
 411                         $error = ($called ? 'The following fields are not set:' : 'You are missing required ISSO fields. Please make sure you have set:');
 412                         $error .= "\n";
 413                         $error .= '<ul>';
 414
 415                         foreach ($missing AS $field)
 416                         {
 417                                 $error .= "\n\t" . '<li>' . $field . '</li>';
 418                         }
 419
 420                         $error .= "\n" . '</ul>';
 421
 422                         $this->message(($called ? '' : 'Missing ') . 'Fields', $error, ($called ? 1 : 3));
 423
 424                         if ($called == false)
 425                         {
 426                                 exit;
 427                         }
 428                 }
 429         }
 430
 431         // ###################################################################
 432         /**
 433         * Prepares a path for being set as the sourcepath
 434         *
 435         * @access       public
 436         *
 437         * @param        string  Source path or URL
 438         *
 439         * @return       string  Prepared source path
 440         */
 441         function fetch_sourcepath($source)
 442         {
 443                 if (substr($source, strlen($source) - 1) != DIRECTORY_SEPARATOR)
 444                 {
 445                         $source .= DIRECTORY_SEPARATOR;
 446                 }
 447                 return $source;
 448         }
 449
 450         // ###################################################################
 451         /**
 452         * Loads a framework module
 453         *
 454         * @access       public
 455         *
 456         * @param        string  Name of the framework file to load
 457         * @param        string  Internal variable to initialize as; to not instantiate (just require) leave it as NULL
 458         * @param        bool    Globalize the internal variable?
 459         *
 460         * @return       object  Instantiated instance
 461         */
 462         function &load($framework, $asobject, $globalize = false)
 463         {
 464                 $this->check_isso_fields();
 465
 466                 // set the object interlock
 467                 if (!method_exists($GLOBALS['isso:null-framework'], 'load'))
 468                 {
 469                         $GLOBALS['isso:null-framework'] =& $this;
 470                 }
 471
 472                 if ($this->is_loaded($framework))
 473                 {
 474                         return $this->modules["$framework"];
 475                 }
 476
 477                 if ($this->sourcepath == '')
 478                 {
 479                         trigger_error('Invalid sourcepath specified', E_USER_ERROR);
 480                 }
 481
 482                 if (file_exists($this->sourcepath . $framework . '.php'))
 483                 {
 484                         require_once($this->sourcepath . $framework . '.php');
 485                 }
 486                 else
 487                 {
 488                         trigger_error('Could not find the framework ' . $this->sourcepath . $framework . '.php', E_USER_ERROR);
 489                 }
 490
 491                 if ($asobject === null)
 492                 {
 493                         return;
 494                 }
 495
 496                 if (isset($this->$asobject))
 497                 {
 498                         trigger_error('Cannot instantiate framework `' . $framework . '` into `' . $asobject . '`', E_USER_ERROR);
 499                 }
 500
 501                 $this->$asobject = new $framework($this);
 502
 503                 $this->modules["$framework"] =& $this->$asobject;
 504
 505                 if ($globalize)
 506                 {
 507                         $GLOBALS["$asobject"] =& $this->$asobject;
 508                 }
 509
 510                 return $this->$asobject;
 511         }
 512
 513         // ###################################################################
 514         /**
 515         * Prints a list of all currently loaded framework modules
 516         *
 517         * @access       public
 518         *
 519         * @param        bool    Return the data as an array?
 520         *
 521         * @return       mixed   HTML output or an array of loaded modules
 522         */
 523         function show_modules($return = false)
 524         {
 525                 foreach ($this->modules AS $object)
 526                 {
 527                         $modules[] = get_class($object);
 528                 }
 529
 530                 if ($return)
 531                 {
 532                         return $modules;
 533                 }
 534                 else
 535                 {
 536                         $output = "\n\n<ul>\n\t<li>";
 537                         $output .= implode("</li>\n\t<li>", $modules);
 538                         $output .= "</li>\n</ul>\n\n";
 539                         $this->message('Loaded Modules', $output, 1);
 540                 }
 541         }
 542
 543         // ###################################################################
 544         /**
 545         * Verifies to see if a framework has been loaded
 546         *
 547         * @access       public
 548         *
 549         * @param        string  Framework name
 550         *
 551         * @return       bool    Whether or not the framework has been loaded
 552         */
 553         function is_loaded($framework)
 554         {
 555                 if (isset($this->modules["$framework"]))
 556                 {
 557                         return true;
 558                 }
 559                 else
 560                 {
 561                         return false;
 562                 }
 563         }
 564
 565         // ###################################################################
 566         /**
 567         * Prints an ISSO message
 568         *
 569         * @access       public
 570         *
 571         * @param        string  The title of the message
 572         * @param        string  The content of the message
 573         * @param        integer Type of message to be printed
 574         * @param        bool    Return the output?
 575         * @param        bool    Show the debug stack?
 576         *
 577         * @return       mixed   Output or null
 578         */
 579         function message($title, $message, $type, $return = false, $stack = true)
 580         {
 581                 switch ($type)
 582                 {
 583                         // Message
 584                         case 1:
 585                                 $prefix = 'Message';
 586                                 $color = '#669900';
 587                                 $font = '#000000';
 588                         break;
 589
 590                         // Warning
 591                         case 2:
 592                                 $prefix = 'Warning';
 593                                 $color = '#003399';
 594                                 $font = '#FFFFFF';
 595                         break;
 596
 597                         case 3:
 598                                 $prefix = 'Error';
 599                                 $color = '#990000';
 600                                 $font = '#EFEFEF';
 601                         break;
 602                 }
 603
 604                 $backtrace = debug_backtrace();
 605                 unset($backtrace[0]);
 606
 607                 $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;\">";
 608                 $output .= "\n<tr style=\"color: $font; text-align: left\">\n\t<td><strong>$prefix: $title</strong></td>\n</tr>";
 609                 $output .= "\n<tr style=\"background-color: #FFFFFF; text-align: left\">\n\t<td>$message</td>\n</tr>";
 610                 $output .= (($stack AND $GLOBALS['isso:null-framework']->debug) ? "\n<tr style=\"background-color: #FFFFFF; text-align: left\">\n\t<td><strong>Debug Stack:</strong> <pre>" . print_r($backtrace, true) . "</pre></td>\n</tr>" : '');
 611                 $output .= "\n</table>\n<br />\n";
 612
 613                 if ($return)
 614                 {
 615                         return $output;
 616                 }
 617                 else
 618                 {
 619                         print($output);
 620                 }
 621         }
 622
 623         // ###################################################################
 624         /**
 625         * Custom error handler for ISSO; only handle E_WARNING, E_NOTICE,
 626         * E_USER_ERROR, E_USER_WARNING, E_USER_NOTICE
 627         *
 628         * @access       private
 629         *
 630         * @param        integer Error number
 631         * @param        string  Error message string
 632         * @param        string  File that contains the error
 633         * @param        string  The line number of the error
 634         * @param        string  The active symbol table at which point the error occurred
 635         */
 636         function _error_handler($errno, $errstr, $errfile, $errline)
 637         {
 638                 switch ($errno)
 639                 {
 640                         // Fatal
 641                         case E_USER_ERROR:
 642                                 $title = 'Fatal';
 643                                 $level = 3;
 644                                 if (!(ini_get('error_reporting') & E_USER_ERROR))
 645                                 {
 646                                         return;
 647                                 }
 648                         break;
 649
 650                         // Error
 651                         case E_USER_WARNING:
 652                                 $title = 'Warning';
 653                                 $level = 2;
 654                                 if (!(ini_get('error_reporting') & E_USER_WARNING) AND !(ini_get('error_reporting') & E_WARNING))
 655                                 {
 656                                         return;
 657                                 }
 658                         break;
 659
 660                         // Warning
 661                         case E_USER_NOTICE:
 662                         default:
 663                                 $title = 'Notice';
 664                                 $level = 1;
 665                                 if (!(ini_get('error_reporting') & E_USER_NOTICE) AND !(ini_get('error_reporting') & E_NOTICE))
 666                                 {
 667                                         return;
 668                                 }
 669                         break;
 670                 }
 671
 672                 $errstr .= " in <strong>$errfile</strong> on line <strong>$errline</strong>";
 673
 674                 $errstr = str_replace(array(getcwd(), dirname(getcwd())), '', $errstr);
 675
 676                 $this->message($title, $errstr, $level);
 677
 678                 if ($errno == E_USER_ERROR)
 679                 {
 680                         exit;
 681                 }
 682         }
 683
 684         // ###################################################################
 685         /**
 686         * Creates a table that explains the error reporting levels and their
 687         * state
 688         *
 689         * @access       public
 690         */
 691         function explain_error_reporting()
 692         {
 693                 $levels = array(
 694                         'E_ERROR'                       => E_ERROR,
 695                         'E_WARNING'                     => E_WARNING,
 696                         'E_PARSE'                       => E_PARSE,
 697                         'E_NOTICE'                      => E_NOTICE,
 698                         'E_CORE_ERROR'          => E_CORE_ERROR,
 699                         'E_CORE_WARNING'        => E_CORE_WARNING,
 700                         'E_COMPILE_ERROR'       => 64,
 701                         'E_COMPILE_WARNING'     => 128,
 702                         'E_USER_ERROR'          => E_USER_ERROR,
 703                         'E_USER_WARNING'        => E_USER_WARNING,
 704                         'E_USER_NOTICE'         => E_USER_NOTICE,
 705                         'E_ALL'                         => E_ALL,
 706                         'E_STRICT'                      => 2048
 707                 );
 708
 709                 $table = '<table cellspacing="0" cellpadding="2" border="0">';
 710
 711                 foreach ($levels AS $name => $value)
 712                 {
 713                         $table .= '
 714                         <tr>
 715                                 <td>' . $name . '</td>
 716                                 <td>' . (ini_get('error_reporting') & $value) . '</td>
 717                         </tr>';
 718                 }
 719
 720                 $table .= '
 721                 </table>';
 722
 723                 $this->message('Error Reporting', $table, 1);
 724         }
 725
 726         // ###################################################################
 727         /**
 728         * Logs a debug message for verbose output
 729         *
 730         * @access       public
 731         *
 732         * @param        string  Message
 733         */
 734         function debug($message)
 735         {
 736                 $this->debuginfo[] = $message;
 737         }
 738
 739         // ###################################################################
 740         /**
 741         * Recursive XSS cleaner
 742         *
 743         * @access       private
 744         *
 745         * @param        mixed   Unsanitized REQUEST data
 746         *
 747         * @return       mixed   Sanitized data
 748         */
 749         function _sanitize_input_recursive($data)
 750         {
 751                 foreach ($data AS $key => $value)
 752                 {
 753                         if (is_array($value))
 754                         {
 755                                 $data["$key"] = $this->_sanitize_input_recursive($value);
 756                         }
 757                         else
 758                         {
 759                                 $data["$key"] = $this->sanitize($value);
 760                         }
 761                 }
 762                 return $data;
 763         }
 764
 765         // ###################################################################
 766         /**
 767         * Simple way to protect against HTML attacks with Unicode support
 768         *
 769         * @access       public
 770         *
 771         * @param        string  Unsanitzed text
 772         *
 773         * @return       string  Properly protected text that only encodes potential threats
 774         */
 775         function sanitize($text)
 776         {
 777                 if ($this->magicquotes)
 778                 {
 779                         return str_replace(array('<', '>', '\"', '"'), array('&lt;', '&gt;', '&quot;', '&quot;'), $text);
 780                 }
 781                 else
 782                 {
 783                         return str_replace(array('<', '>', '"'), array('&lt;', '&gt;', '&quot;'), $text);
 784                 }
 785         }
 786
 787         // ###################################################################
 788         /**
 789         * Unicode-safe entity encoding system; similar to sanitize()
 790         *
 791         * @access       public
 792         *
 793         * @param        string  Unsanitized text
 794         *
 795         * @return       string  Unicode-safe sanitized text with entities preserved
 796         */
 797         function entity_encode($text)
 798         {
 799                 $text = str_replace('&', '&amp;', $text);
 800                 $text = $this->sanitize($text);
 801                 return $text;
 802         }
 803
 804         // ###################################################################
 805         /**
 806         * Takes text that has been processed for HTML and unsanitizes it
 807         *
 808         * @access       public
 809         *
 810         * @param        string  Text that needs to be turned back into HTML
 811         *
 812         * @return       string  Unsanitized text
 813         */
 814         function unsanitize($text)
 815         {
 816                 return str_replace(array('&lt;', '&gt;', '&quot;'), array('<', '>', '"'), $text);
 817         }
 818
 819         // ###################################################################
 820         /**
 821         * Smart addslashes() that only applies itself it the Magic Quotes GPC
 822         * is off. This should only be run on database query values.
 823         *
 824         * @access       public
 825         *
 826         * @param        string  Some string
 827         * @param        bool    If the data is binary; if so it'll be run through DB::escape_stringing()
 828         * @param        bool    Force magic quotes to be off
 829         *
 830         * @return       string  String that has slashes added
 831         */
 832         function escape($str, $binary = false, $force = true)
 833         {
 834                 if ($this->magicquotes AND !$force)
 835                 {
 836                         if (isset($this->modules[ISSO_DB_LAYER]) AND $binary)
 837                         {
 838                                 return $this->modules[ISSO_DB_LAYER]->escape_string(str_replace(array("\'", '\"'), array("'", '"'), $str));
 839                         }
 840                         return $str;
 841                 }
 842                 else
 843                 {
 844                         if (isset($this->modules[ISSO_DB_LAYER]) AND $binary)
 845                         {
 846                                 return $this->modules[ISSO_DB_LAYER]->escape_string($str);
 847                         }
 848                         return addslashes($str);
 849                 }
 850         }
 851
 852         // ###################################################################
 853         /**
 854         * Runs through all of the input data and sanitizes it.
 855         *
 856         * @access       public
 857         */
 858         function exec_sanitize_data()
 859         {
 860                 $this->in = $this->_sanitize_input_recursive(array_merge($_GET, $_POST, $_COOKIE));
 861         }
 862
 863         // ###################################################################
 864         /**
 865         * Sanitize function for something other than a string (which
 866         * everything is sanitized for if you use exec_sanitize_data(). Cleaned
 867         * data is placed back into $isso->in; this makes it so you don't have
 868         * to constantly intval() [etc.] data.
 869         *
 870         * @access       public
 871         *
 872         * @param        array   Array of elements to clean as varname => type
 873         */
 874         function input_clean_array($vars)
 875         {
 876                 foreach ($vars AS $varname => $type)
 877                 {
 878                         $this->input_clean($varname, $type);
 879                 }
 880         }
 881
 882         // ###################################################################
 883         /**
 884         * Sanitize function that does a single variable as oppoesd to an array
 885         * (see input_clean_array() for more details)
 886         *
 887         * @access       public
 888         *
 889         * @param        string  Variable name in $isso->in[]
 890         * @param        integer Sanitization type constant
 891         */
 892         function input_clean($varname, $type)
 893         {
 894                 if (isset($this->in["$varname"]))
 895                 {
 896                         $this->in["$varname"] = $this->clean($this->in["$varname"], $type);
 897                 }
 898                 else
 899                 {
 900                         $this->in["$varname"] = null;
 901                 }
 902
 903                 return $this->in["$varname"];
 904         }
 905
 906         // ###################################################################
 907         /**
 908         * Cleaning function that does the work for input_clean(); this is
 909         * moved here so it can be used to clean things that aren't in
 910         * $isso->in[]
 911         *
 912         * @access       public
 913         *
 914         * @param        mixed   Data
 915         * @param        integer Sanitization type constant
 916         *
 917         * @return       mixed   Cleaned data
 918         */
 919         function clean($value, $type)
 920         {
 921                 if ($type == TYPE_INT)
 922                 {
 923                         $value = intval($value);
 924                 }
 925                 else if ($type == TYPE_UINT)
 926                 {
 927                         $value = abs(intval($value));
 928                 }
 929                 else if ($type == TYPE_FLOAT)
 930                 {
 931                         $value = floatval($value);
 932                 }
 933                 else if ($type == TYPE_BOOL)
 934                 {
 935                         $value = (bool)$value;
 936                 }
 937                 else if ($type == TYPE_STR)
 938                 {
 939                         $value = $value;
 940                 }
 941                 else if ($type == TYPE_STRUN)
 942                 {
 943                         $value = $this->unsanitize($value);
 944                 }
 945                 else if ($type == TYPE_NOCLEAN)
 946                 {
 947                         $value = $value;
 948                 }
 949                 else
 950                 {
 951                         trigger_error('Invalid clean type `' . $type . '` specified', E_USER_ERROR);
 952                 }
 953
 954                 return $value;
 955         }
 956
 957         // ###################################################################
 958         /**
 959         * Checks to see if a POST refer is actually from us
 960         *
 961         * @access       public
 962         */
 963         function exec_referer_check()
 964         {
 965                 if ($_SERVER['REQUEST_METHOD'] == 'POST')
 966                 {
 967                         $host = ($_SERVER['HTTP_HOST']) ? $_SERVER['HTTP_HOST'] : $_ENV['HTTP_HOST'];
 968
 969                         if ($host AND $_SERVER['HTTP_REFERER'])
 970                         {
 971                                 $parts = parse_url($_SERVER['HTTP_REFERER']);
 972                                 $ourhost = $parts['host'] . (isset($parts['port']) ? ":$parts[port]" : '');
 973
 974                                 if ($ourhost != $host)
 975                                 {
 976                                         trigger_error('No external hosts are allowed to POST to this application', E_USER_ERROR);
 977                                 }
 978                                 $this->debug('remote post check = ok');
 979                         }
 980                         else
 981                         {
 982                                 $this->debug('remote post check = FAILED');
 983                         }
 984                 }
 985         }
 986
 987         // ###################################################################
 988         /**
 989         * Constructs a debug information box that contains various debugging
 990         * information points
 991         *
 992         * @access       public
 993         *
 994         * @param        bool    Show template information?
 995         *
 996         * @return       string  Debugging block
 997         */
 998         function construct_debug_block($dotemplates)
 999         {
1000                 $debug = '';
1001
1002                 if ($this->debug)
1003                 {
1004                         $debug = "\n<ul>";
1005
1006                         // templates
1007                         if ($dotemplates)
1008                         {
1009                                 // both template and template_fs are viable, so we need to determine the right one
1010                                 if ($this->is_loaded('template'))
1011                                 {
1012                                         $tpl_obj =& $this->modules['template'];
1013                                 }
1014                                 else if ($this->is_loaded('template_fs'))
1015                                 {
1016                                         $tpl_obj =& $this->modules['template_fs'];
1017                                 }
1018                                 else
1019                                 {
1020                                         $tpl_obj = null;
1021                                 }
1022
1023                                 $optlist = array();
1024                                 $usage = array();
1025                                 foreach ($tpl_obj->usage AS $name => $count)
1026                                 {
1027                                         if (in_array($name, $tpl_obj->uncached))
1028                                         {
1029                                                 $optlist[] = $name . '[' . $count . ']';
1030                                         }
1031                                         $usage[] = $name . " ($count)";
1032                                 }
1033
1034                                 $sizeof = sizeof($tpl_obj->uncached);
1035                                 if ($sizeof > 0)
1036                                 {
1037                                         $debug .= "\n\t<li><strong style=\"color: red\">Uncached Template(s):</strong> $sizeof ( " . implode(' &nbsp; ', $optlist) . " )</li>";
1038                                 }
1039                         }
1040
1041                         // source control
1042                         $scinfo = 'Not Under Source Control';
1043                         if (defined('SVN'))
1044                         {
1045                                 $scinfo = constant('SVN');
1046
1047                                 if (preg_match('#\$Id:?\s*\$#', $scinfo))
1048                                 {
1049                                         $scinfo = 'Not Under Source Control';
1050                                 }
1051                                 else
1052                                 {
1053                                         $scinfo = preg_replace('#\$' . '(Head)?URL: (.+?) \$#e', "end(explode('/', '\\2'))", $scinfo);
1054                                         $scinfo = preg_replace('#\$' . '(LastModified)?Revision: (.+?) \$#', 'SVN \\2', $scinfo);
1055                                         $scinfo = preg_replace('#\$' . 'Id: (.+?) ([0-9].+?) [0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}(.+?) (.+?) \$#', '\\1 - SVN \\2', $scinfo);
1056                                 }
1057                         }
1058
1059                         $scinfo = trim($scinfo);
1060                         $debug .= "\n\t<li><strong>Source Control:</strong> $scinfo</li>";
1061
1062                         // query information
1063                         if (is_object($this->modules[ISSO_DB_LAYER]))
1064                         {
1065                                 $debug .= "\n\t<li><strong>Total Queries:</strong> " . sizeof($this->modules[ISSO_DB_LAYER]->history) . " (<a href=\"" . $this->sanitize($_SERVER['REQUEST_URI']) . ((strpos($_SERVER['REQUEST_URI'], '?') !== false) ? '&amp;query=1' : '?query=1') . "\">?</a>)</li>";
1066                         }
1067
1068                         // total execution time
1069                         if (defined('ISSO_MT_START'))
1070                         {
1071                                 $this->load('functions', 'functions');
1072                                 $debug .= "\n\t<li><strong>Total Execution Time:</strong> " . round($this->modules['functions']->fetch_microtime_diff(ISSO_MT_START), 10) . "</li>";
1073                         }
1074
1075                         // debug notices
1076                         $debug .= "\n\t<li>\n\t\t<select>\n\t\t\t<option>Debug Notices (" . sizeof($this->debuginfo) . ")</option>";
1077                         foreach ((array)$this->debuginfo AS $msg)
1078                         {
1079                                 $debug .= "\n\t\t\t<option>--- $msg</option>";
1080                         }
1081                         $debug .= "\n\t\t</select>\n\t</li>";
1082
1083                         // loaded modules
1084                         $modules = $this->show_modules(true);
1085                         $debug .= "\n\t<li>\n\t\t<select>\n\t\t\t<option>Loaded Modules (" . sizeof($modules) . ")</option>";
1086                         foreach ($modules AS $mod)
1087                         {
1088                                 $debug .= "\n\t\t\t<option>--- $mod</option>";
1089                         }
1090                         $debug .= "\n\t\t</select>\n\t</li>";
1091
1092                         // template usage
1093                         if ($dotemplates)
1094                         {
1095                                 $debug .= "\n\t<li>\n\t\t<select>\n\t\t\t<option>Template Usage (" . array_sum($tpl_obj->usage) . ")</option>";
1096                                 foreach ($usage AS $tpl)
1097                                 {
1098                                         $debug .= "\n\t\t\t<option>--- $tpl</option>";
1099                                 }
1100                                 $debug .= "\n\t\t</select>\n\t</li>";
1101                         }
1102
1103                         $debug .= "\n</ul>";
1104
1105                         $debug = "\n\n<!-- dev debug -->\n<div align=\"center\">\n\n<hr />\n" . $this->message('Debug Information', $debug, 1, true, false) . "\n</div>\n<!-- / dev debug -->\n\n";
1106                 }
1107
1108                 return $debug;
1109         }
1110 }
1111
1112 /*=====================================================================*\
1113 || ###################################################################
1114 || # $HeadURL$
1115 || # $Id$
1116 || ###################################################################
1117 \*=====================================================================*/
1118 ?>