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        string  Module to check for; null is kernel, string is a module name, false is all
 393         * @param        bool    Is this a non-error environment that should display all fields?
 394         */
 395         function check_isso_fields($module = null, $called = false)
 396         {
 397                 $missing = array();
 398
 399                 if ($module === false)
 400                 {
 401                         $modules = $this->show_modules(true);
 402                 }
 403                 else if ($module === null)
 404                 {
 405                         $modules = array(get_class($this));
 406                 }
 407                 else
 408                 {
 409                         $modules = array($module);
 410                 }
 411
 412                 foreach ($modules AS $module)
 413                 {
 414                         if (empty($this->modules["$module"]->fields))
 415                         {
 416                                 continue;
 417                         }
 418
 419                         foreach ($this->modules["$module"]->fields AS $name => $field)
 420                         {
 421                                 if ($field[0] == REQ_YES AND $field[2] == false AND $called == false)
 422                                 {
 423                                         $missing[] = $module . ':: ' . $name;
 424                                 }
 425                                 else if ($called == true AND $field[2] == false)
 426                                 {
 427                                         $missing[] = $module . ':: ' . $name . ($field[0] == REQ_YES ? ' <strong>(REQUIRED)</strong>' : '');
 428                                 }
 429                         }
 430                 }
 431
 432                 if (count($missing) > 0)
 433                 {
 434                         $error = ($called ? 'The following fields are not set:' : 'You are missing required ISSO fields. Please make sure you have set:');
 435                         $error .= "\n";
 436                         $error .= '<ul>';
 437
 438                         foreach ($missing AS $field)
 439                         {
 440                                 $error .= "\n\t" . '<li>' . $field . '</li>';
 441                         }
 442
 443                         $error .= "\n" . '</ul>';
 444
 445                         $this->message(($called ? '' : 'Missing ') . 'Fields', $error, ($called ? 1 : 3));
 446
 447                         if ($called == false)
 448                         {
 449                                 exit;
 450                         }
 451                 }
 452         }
 453
 454         // ###################################################################
 455         /**
 456         * Prepares a path for being set as the sourcepath
 457         *
 458         * @access       public
 459         *
 460         * @param        string  Source path or URL
 461         *
 462         * @return       string  Prepared source path
 463         */
 464         function fetch_sourcepath($source)
 465         {
 466                 if (substr($source, strlen($source) - 1) != DIRECTORY_SEPARATOR)
 467                 {
 468                         $source .= DIRECTORY_SEPARATOR;
 469                 }
 470                 return $source;
 471         }
 472
 473         // ###################################################################
 474         /**
 475         * Loads a framework module
 476         *
 477         * @access       public
 478         *
 479         * @param        string  Name of the framework file to load
 480         * @param        string  Internal variable to initialize as; to not instantiate (just require) leave it as NULL
 481         * @param        bool    Globalize the internal variable?
 482         *
 483         * @return       object  Instantiated instance
 484         */
 485         function &load($framework, $asobject, $globalize = false)
 486         {
 487                 $this->check_isso_fields(null);
 488
 489                 // set the object interlock
 490                 if (!method_exists($GLOBALS['isso:null-framework'], 'load'))
 491                 {
 492                         $GLOBALS['isso:null-framework'] =& $this;
 493                         $this->modules['shared_object_framework'] =& $this;
 494                 }
 495
 496                 if ($this->is_loaded($framework))
 497                 {
 498                         return $this->modules["$framework"];
 499                 }
 500
 501                 if ($this->sourcepath == '')
 502                 {
 503                         trigger_error('Invalid sourcepath specified', E_USER_ERROR);
 504                 }
 505
 506                 if (file_exists($this->sourcepath . $framework . '.php'))
 507                 {
 508                         require_once($this->sourcepath . $framework . '.php');
 509                 }
 510                 else
 511                 {
 512                         trigger_error('Could not find the framework ' . $this->sourcepath . $framework . '.php', E_USER_ERROR);
 513                 }
 514
 515                 if ($asobject === null)
 516                 {
 517                         return;
 518                 }
 519
 520                 if (isset($this->$asobject))
 521                 {
 522                         trigger_error('Cannot instantiate framework `' . $framework . '` into `' . $asobject . '`', E_USER_ERROR);
 523                 }
 524
 525                 $this->$asobject = new $framework($this);
 526
 527                 $this->modules["$framework"] =& $this->$asobject;
 528
 529                 if ($globalize)
 530                 {
 531                         $GLOBALS["$asobject"] =& $this->$asobject;
 532                 }
 533
 534                 return $this->$asobject;
 535         }
 536
 537         // ###################################################################
 538         /**
 539         * Prints a list of all currently loaded framework modules
 540         *
 541         * @access       public
 542         *
 543         * @param        bool    Return the data as an array?
 544         *
 545         * @return       mixed   HTML output or an array of loaded modules
 546         */
 547         function show_modules($return = false)
 548         {
 549                 $modules = array();
 550                 foreach ($this->modules AS $object)
 551                 {
 552                         $modules[] = get_class($object);
 553                 }
 554
 555                 if ($return)
 556                 {
 557                         return $modules;
 558                 }
 559                 else
 560                 {
 561                         $output = "\n\n<ul>\n\t<li>";
 562                         $output .= implode("</li>\n\t<li>", $modules);
 563                         $output .= "</li>\n</ul>\n\n";
 564                         $this->message('Loaded Modules', $output, 1);
 565                 }
 566         }
 567
 568         // ###################################################################
 569         /**
 570         * Verifies to see if a framework has been loaded
 571         *
 572         * @access       public
 573         *
 574         * @param        string  Framework name
 575         *
 576         * @return       bool    Whether or not the framework has been loaded
 577         */
 578         function is_loaded($framework)
 579         {
 580                 if (isset($this->modules["$framework"]))
 581                 {
 582                         return true;
 583                 }
 584                 else
 585                 {
 586                         return false;
 587                 }
 588         }
 589
 590         // ###################################################################
 591         /**
 592         * Prints an ISSO message
 593         *
 594         * @access       public
 595         *
 596         * @param        string  The title of the message
 597         * @param        string  The content of the message
 598         * @param        integer Type of message to be printed
 599         * @param        bool    Return the output?
 600         * @param        bool    Show the debug stack?
 601         *
 602         * @return       mixed   Output or null
 603         */
 604         function message($title, $message, $type, $return = false, $stack = true)
 605         {
 606                 switch ($type)
 607                 {
 608                         // Message
 609                         case 1:
 610                                 $prefix = 'Message';
 611                                 $color = '#669900';
 612                                 $font = '#000000';
 613                         break;
 614
 615                         // Warning
 616                         case 2:
 617                                 $prefix = 'Warning';
 618                                 $color = '#003399';
 619                                 $font = '#FFFFFF';
 620                         break;
 621
 622                         case 3:
 623                                 $prefix = 'Error';
 624                                 $color = '#990000';
 625                                 $font = '#EFEFEF';
 626                         break;
 627                 }
 628
 629                 $backtrace = debug_backtrace();
 630                 unset($backtrace[0]);
 631
 632                 $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;\">";
 633                 $output .= "\n<tr style=\"color: $font; text-align: left\">\n\t<td><strong>$prefix: $title</strong></td>\n</tr>";
 634                 $output .= "\n<tr style=\"background-color: #FFFFFF; text-align: left\">\n\t<td>$message</td>\n</tr>";
 635                 $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>" : '');
 636                 $output .= "\n</table>\n<br />\n";
 637
 638                 if ($return)
 639                 {
 640                         return $output;
 641                 }
 642                 else
 643                 {
 644                         print($output);
 645                 }
 646         }
 647
 648         // ###################################################################
 649         /**
 650         * Custom error handler for ISSO; only handle E_WARNING, E_NOTICE,
 651         * E_USER_ERROR, E_USER_WARNING, E_USER_NOTICE
 652         *
 653         * @access       private
 654         *
 655         * @param        integer Error number
 656         * @param        string  Error message string
 657         * @param        string  File that contains the error
 658         * @param        string  The line number of the error
 659         * @param        string  The active symbol table at which point the error occurred
 660         */
 661         function _error_handler($errno, $errstr, $errfile, $errline)
 662         {
 663                 switch ($errno)
 664                 {
 665                         // Fatal
 666                         case E_USER_ERROR:
 667                                 $title = 'Fatal';
 668                                 $level = 3;
 669                                 if (!(ini_get('error_reporting') & E_USER_ERROR))
 670                                 {
 671                                         return;
 672                                 }
 673                         break;
 674
 675                         // Error
 676                         case E_USER_WARNING:
 677                                 $title = 'Warning';
 678                                 $level = 2;
 679                                 if (!(ini_get('error_reporting') & E_USER_WARNING) AND !(ini_get('error_reporting') & E_WARNING))
 680                                 {
 681                                         return;
 682                                 }
 683                         break;
 684
 685                         // Warning
 686                         case E_USER_NOTICE:
 687                         default:
 688                                 $title = 'Notice';
 689                                 $level = 1;
 690                                 if (!(ini_get('error_reporting') & E_USER_NOTICE) AND !(ini_get('error_reporting') & E_NOTICE))
 691                                 {
 692                                         return;
 693                                 }
 694                         break;
 695                 }
 696
 697                 $errstr .= " in <strong>$errfile</strong> on line <strong>$errline</strong>";
 698
 699                 $errstr = str_replace(array(getcwd(), dirname(getcwd())), '', $errstr);
 700
 701                 $this->message($title, $errstr, $level);
 702
 703                 if ($errno == E_USER_ERROR)
 704                 {
 705                         exit;
 706                 }
 707         }
 708
 709         // ###################################################################
 710         /**
 711         * Creates a table that explains the error reporting levels and their
 712         * state
 713         *
 714         * @access       public
 715         */
 716         function explain_error_reporting()
 717         {
 718                 $levels = array(
 719                         'E_ERROR'                       => E_ERROR,
 720                         'E_WARNING'                     => E_WARNING,
 721                         'E_PARSE'                       => E_PARSE,
 722                         'E_NOTICE'                      => E_NOTICE,
 723                         'E_CORE_ERROR'          => E_CORE_ERROR,
 724                         'E_CORE_WARNING'        => E_CORE_WARNING,
 725                         'E_COMPILE_ERROR'       => 64,
 726                         'E_COMPILE_WARNING'     => 128,
 727                         'E_USER_ERROR'          => E_USER_ERROR,
 728                         'E_USER_WARNING'        => E_USER_WARNING,
 729                         'E_USER_NOTICE'         => E_USER_NOTICE,
 730                         'E_ALL'                         => E_ALL,
 731                         'E_STRICT'                      => 2048
 732                 );
 733
 734                 $table = '<table cellspacing="0" cellpadding="2" border="0">';
 735
 736                 foreach ($levels AS $name => $value)
 737                 {
 738                         $table .= '
 739                         <tr>
 740                                 <td>' . $name . '</td>
 741                                 <td>' . (ini_get('error_reporting') & $value) . '</td>
 742                         </tr>';
 743                 }
 744
 745                 $table .= '
 746                 </table>';
 747
 748                 $this->message('Error Reporting', $table, 1);
 749         }
 750
 751         // ###################################################################
 752         /**
 753         * Logs a debug message for verbose output
 754         *
 755         * @access       public
 756         *
 757         * @param        string  Message
 758         */
 759         function debug($message)
 760         {
 761                 $this->debuginfo[] = $message;
 762         }
 763
 764         // ###################################################################
 765         /**
 766         * Recursive XSS cleaner
 767         *
 768         * @access       private
 769         *
 770         * @param        mixed   Unsanitized REQUEST data
 771         *
 772         * @return       mixed   Sanitized data
 773         */
 774         function _sanitize_input_recursive($data)
 775         {
 776                 foreach ($data AS $key => $value)
 777                 {
 778                         if (is_array($value))
 779                         {
 780                                 $data["$key"] = $this->_sanitize_input_recursive($value);
 781                         }
 782                         else
 783                         {
 784                                 $data["$key"] = $this->sanitize($value);
 785                         }
 786                 }
 787                 return $data;
 788         }
 789
 790         // ###################################################################
 791         /**
 792         * Simple way to protect against HTML attacks with Unicode support
 793         *
 794         * @access       public
 795         *
 796         * @param        string  Unsanitzed text
 797         *
 798         * @return       string  Properly protected text that only encodes potential threats
 799         */
 800         function sanitize($text)
 801         {
 802                 if ($this->magicquotes)
 803                 {
 804                         return str_replace(array('<', '>', '\"', '"'), array('&lt;', '&gt;', '&quot;', '&quot;'), $text);
 805                 }
 806                 else
 807                 {
 808                         return str_replace(array('<', '>', '"'), array('&lt;', '&gt;', '&quot;'), $text);
 809                 }
 810         }
 811
 812         // ###################################################################
 813         /**
 814         * Unicode-safe entity encoding system; similar to sanitize()
 815         *
 816         * @access       public
 817         *
 818         * @param        string  Unsanitized text
 819         *
 820         * @return       string  Unicode-safe sanitized text with entities preserved
 821         */
 822         function entity_encode($text)
 823         {
 824                 $text = str_replace('&', '&amp;', $text);
 825                 $text = $this->sanitize($text);
 826                 return $text;
 827         }
 828
 829         // ###################################################################
 830         /**
 831         * Takes text that has been processed for HTML and unsanitizes it
 832         *
 833         * @access       public
 834         *
 835         * @param        string  Text that needs to be turned back into HTML
 836         *
 837         * @return       string  Unsanitized text
 838         */
 839         function unsanitize($text)
 840         {
 841                 return str_replace(array('&lt;', '&gt;', '&quot;'), array('<', '>', '"'), $text);
 842         }
 843
 844         // ###################################################################
 845         /**
 846         * Smart addslashes() that only applies itself it the Magic Quotes GPC
 847         * is off. This should only be run on database query values.
 848         *
 849         * @access       public
 850         *
 851         * @param        string  Some string
 852         * @param        bool    If the data is binary; if so it'll be run through DB::escape_stringing()
 853         * @param        bool    Force magic quotes to be off
 854         *
 855         * @return       string  String that has slashes added
 856         */
 857         function escape($str, $binary = false, $force = true)
 858         {
 859                 if ($this->magicquotes AND !$force)
 860                 {
 861                         if (isset($this->modules[ISSO_DB_LAYER]) AND $binary)
 862                         {
 863                                 return $this->modules[ISSO_DB_LAYER]->escape_string(str_replace(array("\'", '\"'), array("'", '"'), $str));
 864                         }
 865                         return $str;
 866                 }
 867                 else
 868                 {
 869                         if (isset($this->modules[ISSO_DB_LAYER]) AND $binary)
 870                         {
 871                                 return $this->modules[ISSO_DB_LAYER]->escape_string($str);
 872                         }
 873                         return addslashes($str);
 874                 }
 875         }
 876
 877         // ###################################################################
 878         /**
 879         * Runs through all of the input data and sanitizes it.
 880         *
 881         * @access       public
 882         */
 883         function exec_sanitize_data()
 884         {
 885                 $this->in = $this->_sanitize_input_recursive(array_merge($_GET, $_POST, $_COOKIE));
 886         }
 887
 888         // ###################################################################
 889         /**
 890         * Sanitize function for something other than a string (which
 891         * everything is sanitized for if you use exec_sanitize_data(). Cleaned
 892         * data is placed back into $isso->in; this makes it so you don't have
 893         * to constantly intval() [etc.] data.
 894         *
 895         * @access       public
 896         *
 897         * @param        array   Array of elements to clean as varname => type
 898         */
 899         function input_clean_array($vars)
 900         {
 901                 foreach ($vars AS $varname => $type)
 902                 {
 903                         $this->input_clean($varname, $type);
 904                 }
 905         }
 906
 907         // ###################################################################
 908         /**
 909         * Sanitize function that does a single variable as oppoesd to an array
 910         * (see input_clean_array() for more details)
 911         *
 912         * @access       public
 913         *
 914         * @param        string  Variable name in $isso->in[]
 915         * @param        integer Sanitization type constant
 916         */
 917         function input_clean($varname, $type)
 918         {
 919                 if (isset($this->in["$varname"]))
 920                 {
 921                         $this->in["$varname"] = $this->clean($this->in["$varname"], $type);
 922                 }
 923                 else
 924                 {
 925                         $this->in["$varname"] = null;
 926                 }
 927
 928                 return $this->in["$varname"];
 929         }
 930
 931         // ###################################################################
 932         /**
 933         * Cleaning function that does the work for input_clean(); this is
 934         * moved here so it can be used to clean things that aren't in
 935         * $isso->in[]
 936         *
 937         * @access       public
 938         *
 939         * @param        mixed   Data
 940         * @param        integer Sanitization type constant
 941         *
 942         * @return       mixed   Cleaned data
 943         */
 944         function clean($value, $type)
 945         {
 946                 if ($type == TYPE_INT)
 947                 {
 948                         $value = intval($value);
 949                 }
 950                 else if ($type == TYPE_UINT)
 951                 {
 952                         $value = abs(intval($value));
 953                 }
 954                 else if ($type == TYPE_FLOAT)
 955                 {
 956                         $value = floatval($value);
 957                 }
 958                 else if ($type == TYPE_BOOL)
 959                 {
 960                         $value = (bool)$value;
 961                 }
 962                 else if ($type == TYPE_STR)
 963                 {
 964                         $value = $value;
 965                 }
 966                 else if ($type == TYPE_STRUN)
 967                 {
 968                         $value = $this->unsanitize($value);
 969                 }
 970                 else if ($type == TYPE_NOCLEAN)
 971                 {
 972                         $value = $value;
 973                 }
 974                 else
 975                 {
 976                         trigger_error('Invalid clean type `' . $type . '` specified', E_USER_ERROR);
 977                 }
 978
 979                 return $value;
 980         }
 981
 982         // ###################################################################
 983         /**
 984         * Checks to see if a POST refer is actually from us
 985         *
 986         * @access       public
 987         */
 988         function exec_referer_check()
 989         {
 990                 if ($_SERVER['REQUEST_METHOD'] == 'POST')
 991                 {
 992                         $host = ($_SERVER['HTTP_HOST']) ? $_SERVER['HTTP_HOST'] : $_ENV['HTTP_HOST'];
 993
 994                         if ($host AND $_SERVER['HTTP_REFERER'])
 995                         {
 996                                 $parts = parse_url($_SERVER['HTTP_REFERER']);
 997                                 $ourhost = $parts['host'] . (isset($parts['port']) ? ":$parts[port]" : '');
 998
 999                                 if ($ourhost != $host)
1000                                 {
1001                                         trigger_error('No external hosts are allowed to POST to this application', E_USER_ERROR);
1002                                 }
1003                                 $this->debug('remote post check = ok');
1004                         }
1005                         else
1006                         {
1007                                 $this->debug('remote post check = FAILED');
1008                         }
1009                 }
1010         }
1011
1012         // ###################################################################
1013         /**
1014         * Constructs a debug information box that contains various debugging
1015         * information points
1016         *
1017         * @access       public
1018         *
1019         * @param        bool    Show template information?
1020         *
1021         * @return       string  Debugging block
1022         */
1023         function construct_debug_block($dotemplates)
1024         {
1025                 $debug = '';
1026
1027                 if ($this->debug)
1028                 {
1029                         $debug = "\n<ul>";
1030
1031                         // templates
1032                         if ($dotemplates)
1033                         {
1034                                 // both template and template_fs are viable, so we need to determine the right one
1035                                 if ($this->is_loaded('template'))
1036                                 {
1037                                         $tpl_obj =& $this->modules['template'];
1038                                 }
1039                                 else if ($this->is_loaded('template_fs'))
1040                                 {
1041                                         $tpl_obj =& $this->modules['template_fs'];
1042                                 }
1043                                 else
1044                                 {
1045                                         $tpl_obj = null;
1046                                 }
1047
1048                                 $optlist = array();
1049                                 $usage = array();
1050                                 foreach ($tpl_obj->usage AS $name => $count)
1051                                 {
1052                                         if (in_array($name, $tpl_obj->uncached))
1053                                         {
1054                                                 $optlist[] = $name . '[' . $count . ']';
1055                                         }
1056                                         $usage[] = $name . " ($count)";
1057                                 }
1058
1059                                 $sizeof = sizeof($tpl_obj->uncached);
1060                                 if ($sizeof > 0)
1061                                 {
1062                                         $debug .= "\n\t<li><strong style=\"color: red\">Uncached Template(s):</strong> $sizeof ( " . implode(' &nbsp; ', $optlist) . " )</li>";
1063                                 }
1064                         }
1065
1066                         // source control
1067                         $scinfo = 'Not Under Source Control';
1068                         if (defined('SVN'))
1069                         {
1070                                 $scinfo = constant('SVN');
1071
1072                                 if (preg_match('#\$Id:?\s*\$#', $scinfo))
1073                                 {
1074                                         $scinfo = 'Not Under Source Control';
1075                                 }
1076                                 else
1077                                 {
1078                                         $scinfo = preg_replace('#\$' . '(Head)?URL: (.+?) \$#e', "end(explode('/', '\\2'))", $scinfo);
1079                                         $scinfo = preg_replace('#\$' . '(LastModified)?Revision: (.+?) \$#', 'SVN \\2', $scinfo);
1080                                         $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);
1081                                 }
1082                         }
1083
1084                         $scinfo = trim($scinfo);
1085                         $debug .= "\n\t<li><strong>Source Control:</strong> $scinfo</li>";
1086
1087                         // query information
1088                         if (is_object($this->modules[ISSO_DB_LAYER]))
1089                         {
1090                                 $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>";
1091                         }
1092
1093                         // total execution time
1094                         if (defined('ISSO_MT_START'))
1095                         {
1096                                 $this->load('functions', 'functions');
1097                                 $debug .= "\n\t<li><strong>Total Execution Time:</strong> " . round($this->modules['functions']->fetch_microtime_diff(ISSO_MT_START), 10) . "</li>";
1098                         }
1099
1100                         // debug notices
1101                         $debug .= "\n\t<li>\n\t\t<select>\n\t\t\t<option>Debug Notices (" . sizeof($this->debuginfo) . ")</option>";
1102                         foreach ((array)$this->debuginfo AS $msg)
1103                         {
1104                                 $debug .= "\n\t\t\t<option>--- $msg</option>";
1105                         }
1106                         $debug .= "\n\t\t</select>\n\t</li>";
1107
1108                         // loaded modules
1109                         $modules = $this->show_modules(true);
1110                         $debug .= "\n\t<li>\n\t\t<select>\n\t\t\t<option>Loaded Modules (" . sizeof($modules) . ")</option>";
1111                         foreach ($modules AS $mod)
1112                         {
1113                                 $debug .= "\n\t\t\t<option>--- $mod</option>";
1114                         }
1115                         $debug .= "\n\t\t</select>\n\t</li>";
1116
1117                         // template usage
1118                         if ($dotemplates)
1119                         {
1120                                 $debug .= "\n\t<li>\n\t\t<select>\n\t\t\t<option>Template Usage (" . array_sum($tpl_obj->usage) . ")</option>";
1121                                 foreach ($usage AS $tpl)
1122                                 {
1123                                         $debug .= "\n\t\t\t<option>--- $tpl</option>";
1124                                 }
1125                                 $debug .= "\n\t\t</select>\n\t</li>";
1126                         }
1127
1128                         $debug .= "\n</ul>";
1129
1130                         $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";
1131                 }
1132
1133                 return $debug;
1134         }
1135 }
1136
1137 /*=====================================================================*\
1138 || ###################################################################
1139 || # $HeadURL$
1140 || # $Id$
1141 || ###################################################################
1142 \*=====================================================================*/
1143 ?>