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