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