git.roojs.org Git - pear/blob - PEAR.php

   1 <?php
   2 /**
   3  * PEAR, the PHP Extension and Application Repository
   4  *
   5  * PEAR class and PEAR_Error class
   6  *
   7  * PHP versions 4 and 5
   8  *
   9  * @category   pear
  10  * @package    PEAR
  11  * @author     Sterling Hughes <sterling@php.net>
  12  * @author     Stig Bakken <ssb@php.net>
  13  * @author     Tomas V.V.Cox <cox@idecnet.com>
  14  * @author     Greg Beaver <cellog@php.net>
  15  * @copyright  1997-2010 The Authors
  16  * @license    http://opensource.org/licenses/bsd-license.php New BSD License
  17  * @version    CVS: $Id: PEAR.php 313023 2011-07-06 19:17:11Z dufuz $
  18  * @link       http://pear.php.net/package/PEAR
  19  * @since      File available since Release 0.1
  20  */
  21
  22 /**#@+
  23  * ERROR constants
  24  */
  25 define('PEAR_ERROR_RETURN',     1);
  26 define('PEAR_ERROR_PRINT',      2);
  27 define('PEAR_ERROR_TRIGGER',    4);
  28 define('PEAR_ERROR_DIE',        8);
  29 define('PEAR_ERROR_CALLBACK',  16);
  30 /**
  31  * WARNING: obsolete
  32  * @deprecated
  33  */
  34 define('PEAR_ERROR_EXCEPTION', 32);
  35 /**#@-*/
  36 define('PEAR_ZE2', (function_exists('version_compare') &&
  37                     version_compare(zend_version(), "2-dev", "ge")));
  38
  39 if (substr(PHP_OS, 0, 3) == 'WIN') {
  40     define('OS_WINDOWS', true);
  41     define('OS_UNIX',    false);
  42     define('PEAR_OS',    'Windows');
  43 } else {
  44     define('OS_WINDOWS', false);
  45     define('OS_UNIX',    true);
  46     define('PEAR_OS',    'Unix'); // blatant assumption
  47 }
  48
  49 $GLOBALS['_PEAR_default_error_mode']     = PEAR_ERROR_RETURN;
  50 $GLOBALS['_PEAR_default_error_options']  = E_USER_NOTICE;
  51 $GLOBALS['_PEAR_destructor_object_list'] = array();
  52 $GLOBALS['_PEAR_shutdown_funcs']         = array();
  53 $GLOBALS['_PEAR_error_handler_stack']    = array();
  54
  55 @ini_set('track_errors', true);
  56
  57 /**
  58  * Base class for other PEAR classes.  Provides rudimentary
  59  * emulation of destructors.
  60  *
  61  * If you want a destructor in your class, inherit PEAR and make a
  62  * destructor method called _yourclassname (same name as the
  63  * constructor, but with a "_" prefix).  Also, in your constructor you
  64  * have to call the PEAR constructor: $this->PEAR();.
  65  * The destructor method will be called without parameters.  Note that
  66  * at in some SAPI implementations (such as Apache), any output during
  67  * the request shutdown (in which destructors are called) seems to be
  68  * discarded.  If you need to get any debug information from your
  69  * destructor, use error_log(), syslog() or something similar.
  70  *
  71  * IMPORTANT! To use the emulated destructors you need to create the
  72  * objects by reference: $obj =& new PEAR_child;
  73  *
  74  * @category   pear
  75  * @package    PEAR
  76  * @author     Stig Bakken <ssb@php.net>
  77  * @author     Tomas V.V. Cox <cox@idecnet.com>
  78  * @author     Greg Beaver <cellog@php.net>
  79  * @copyright  1997-2006 The PHP Group
  80  * @license    http://opensource.org/licenses/bsd-license.php New BSD License
  81  * @version    Release: 1.9.4
  82  * @link       http://pear.php.net/package/PEAR
  83  * @see        PEAR_Error
  84  * @since      Class available since PHP 4.0.2
  85  * @link        http://pear.php.net/manual/en/core.pear.php#core.pear.pear
  86  */
  87 class PEAR
  88 {
  89     /**
  90      * Whether to enable internal debug messages.
  91      *
  92      * @var     bool
  93      * @access  private
  94      */
  95     var $_debug = false;
  96
  97     /**
  98      * Default error mode for this object.
  99      *
 100      * @var     int
 101      * @access  private
 102      */
 103     var $_default_error_mode = null;
 104
 105     /**
 106      * Default error options used for this object when error mode
 107      * is PEAR_ERROR_TRIGGER.
 108      *
 109      * @var     int
 110      * @access  private
 111      */
 112     var $_default_error_options = null;
 113
 114     /**
 115      * Default error handler (callback) for this object, if error mode is
 116      * PEAR_ERROR_CALLBACK.
 117      *
 118      * @var     string
 119      * @access  private
 120      */
 121     var $_default_error_handler = '';
 122
 123     /**
 124      * Which class to use for error objects.
 125      *
 126      * @var     string
 127      * @access  private
 128      */
 129     var $_error_class = 'PEAR_Error';
 130
 131     /**
 132      * An array of expected errors.
 133      *
 134      * @var     array
 135      * @access  private
 136      */
 137     var $_expected_errors = array();
 138
 139     /**
 140      * Constructor.  Registers this object in
 141      * $_PEAR_destructor_object_list for destructor emulation if a
 142      * destructor object exists.
 143      *
 144      * @param string $error_class  (optional) which class to use for
 145      *        error objects, defaults to PEAR_Error.
 146      * @access public
 147      * @return void
 148      */
 149     function PEAR($error_class = null)
 150     {
 151         $classname = strtolower(get_class($this));
 152         if ($this->_debug) {
 153             print "PEAR constructor called, class=$classname\n";
 154         }
 155
 156         if ($error_class !== null) {
 157             $this->_error_class = $error_class;
 158         }
 159
 160         while ($classname && strcasecmp($classname, "pear")) {
 161             $destructor = "_$classname";
 162             if (method_exists($this, $destructor)) {
 163                 global $_PEAR_destructor_object_list;
 164                 $_PEAR_destructor_object_list[] = &$this;
 165                 if (!isset($GLOBALS['_PEAR_SHUTDOWN_REGISTERED'])) {
 166                     register_shutdown_function("_PEAR_call_destructors");
 167                     $GLOBALS['_PEAR_SHUTDOWN_REGISTERED'] = true;
 168                 }
 169                 break;
 170             } else {
 171                 $classname = get_parent_class($classname);
 172             }
 173         }
 174     }
 175
 176     /**
 177      * Destructor (the emulated type of...).  Does nothing right now,
 178      * but is included for forward compatibility, so subclass
 179      * destructors should always call it.
 180      *
 181      * See the note in the class desciption about output from
 182      * destructors.
 183      *
 184      * @access public
 185      * @return void
 186      */
 187     function _PEAR() {
 188         if ($this->_debug) {
 189             printf("PEAR destructor called, class=%s\n", strtolower(get_class($this)));
 190         }
 191     }
 192
 193     /**
 194     * If you have a class that's mostly/entirely static, and you need static
 195     * properties, you can use this method to simulate them. Eg. in your method(s)
 196     * do this: $myVar = &PEAR::getStaticProperty('myclass', 'myVar');
 197     * You MUST use a reference, or they will not persist!
 198     *
 199     * @access public
 200     * @param  string $class  The calling classname, to prevent clashes
 201     * @param  string $var    The variable to retrieve.
 202     * @return mixed   A reference to the variable. If not set it will be
 203     *                 auto initialised to NULL.
 204     */
 205     static function &getStaticProperty($class, $var)
 206     {
 207         static $properties;
 208         if (!isset($properties[$class])) {
 209             $properties[$class] = array();
 210         }
 211
 212         if (!array_key_exists($var, $properties[$class])) {
 213             $properties[$class][$var] = null;
 214         }
 215         PRINT_R($class);
 216         echo "\n";
 217         PRINT_R($var);
 218         echo "\n";
 219         return $properties[$class][$var];
 220     }
 221
 222     /**
 223     * Use this function to register a shutdown method for static
 224     * classes.
 225     *
 226     * @access public
 227     * @param  mixed $func  The function name (or array of class/method) to call
 228     * @param  mixed $args  The arguments to pass to the function
 229     * @return void
 230     */
 231     function registerShutdownFunc($func, $args = array())
 232     {
 233         // if we are called statically, there is a potential
 234         // that no shutdown func is registered.  Bug #6445
 235         if (!isset($GLOBALS['_PEAR_SHUTDOWN_REGISTERED'])) {
 236             register_shutdown_function("_PEAR_call_destructors");
 237             $GLOBALS['_PEAR_SHUTDOWN_REGISTERED'] = true;
 238         }
 239         $GLOBALS['_PEAR_shutdown_funcs'][] = array($func, $args);
 240     }
 241
 242     /**
 243      * Tell whether a value is a PEAR error.
 244      *
 245      * @param   mixed $data   the value to test
 246      * @param   int   $code   if $data is an error object, return true
 247      *                        only if $code is a string and
 248      *                        $obj->getMessage() == $code or
 249      *                        $code is an integer and $obj->getCode() == $code
 250      * @access  public
 251      * @return  bool    true if parameter is an error
 252      */
 253     static function isError($data, $code = null)
 254     {
 255         if (!is_a($data, 'PEAR_Error')) {
 256             return false;
 257         }
 258
 259         if (is_null($code)) {
 260             return true;
 261         } elseif (is_string($code)) {
 262             return $data->getMessage() == $code;
 263         }
 264
 265         return $data->getCode() == $code;
 266     }
 267
 268     /**
 269      * Sets how errors generated by this object should be handled.
 270      * Can be invoked both in objects and statically.  If called
 271      * statically, setErrorHandling sets the default behaviour for all
 272      * PEAR objects.  If called in an object, setErrorHandling sets
 273      * the default behaviour for that object.
 274      *
 275      * @param int $mode
 276      *        One of PEAR_ERROR_RETURN, PEAR_ERROR_PRINT,
 277      *        PEAR_ERROR_TRIGGER, PEAR_ERROR_DIE,
 278      *        PEAR_ERROR_CALLBACK or PEAR_ERROR_EXCEPTION.
 279      *
 280      * @param mixed $options
 281      *        When $mode is PEAR_ERROR_TRIGGER, this is the error level (one
 282      *        of E_USER_NOTICE, E_USER_WARNING or E_USER_ERROR).
 283      *
 284      *        When $mode is PEAR_ERROR_CALLBACK, this parameter is expected
 285      *        to be the callback function or method.  A callback
 286      *        function is a string with the name of the function, a
 287      *        callback method is an array of two elements: the element
 288      *        at index 0 is the object, and the element at index 1 is
 289      *        the name of the method to call in the object.
 290      *
 291      *        When $mode is PEAR_ERROR_PRINT or PEAR_ERROR_DIE, this is
 292      *        a printf format string used when printing the error
 293      *        message.
 294      *
 295      * @access public
 296      * @return void
 297      * @see PEAR_ERROR_RETURN
 298      * @see PEAR_ERROR_PRINT
 299      * @see PEAR_ERROR_TRIGGER
 300      * @see PEAR_ERROR_DIE
 301      * @see PEAR_ERROR_CALLBACK
 302      * @see PEAR_ERROR_EXCEPTION
 303      *
 304      * @since PHP 4.0.5
 305      */
 306     static function setErrorHandling($mode = null, $options = null)
 307     {
 308         //if (isset($this) && is_a($this, 'PEAR')) {
 309         //    $setmode     = &$this->_default_error_mode;
 310         //    $setoptions  = &$this->_default_error_options;
 311         //} else {
 312             $setmode     = &$GLOBALS['_PEAR_default_error_mode'];
 313             $setoptions  = &$GLOBALS['_PEAR_default_error_options'];
 314         //}
 315
 316         switch ($mode) {
 317             case PEAR_ERROR_EXCEPTION:
 318             case PEAR_ERROR_RETURN:
 319             case PEAR_ERROR_PRINT:
 320             case PEAR_ERROR_TRIGGER:
 321             case PEAR_ERROR_DIE:
 322             case null:
 323                 $setmode = $mode;
 324                 $setoptions = $options;
 325                 break;
 326
 327             case PEAR_ERROR_CALLBACK:
 328                 $setmode = $mode;
 329                 // class/object method callback
 330                 if (is_callable($options)) {
 331                     $setoptions = $options;
 332                 } else {
 333                     trigger_error("invalid error callback", E_USER_WARNING);
 334                 }
 335                 break;
 336
 337             default:
 338                 trigger_error("invalid error mode", E_USER_WARNING);
 339                 break;
 340         }
 341     }
 342
 343     /**
 344      * This method is used to tell which errors you expect to get.
 345      * Expected errors are always returned with error mode
 346      * PEAR_ERROR_RETURN.  Expected error codes are stored in a stack,
 347      * and this method pushes a new element onto it.  The list of
 348      * expected errors are in effect until they are popped off the
 349      * stack with the popExpect() method.
 350      *
 351      * Note that this method can not be called statically
 352      *
 353      * @param mixed $code a single error code or an array of error codes to expect
 354      *
 355      * @return int     the new depth of the "expected errors" stack
 356      * @access public
 357      */
 358     function expectError($code = '*')
 359     {
 360         if (is_array($code)) {
 361             array_push($this->_expected_errors, $code);
 362         } else {
 363             array_push($this->_expected_errors, array($code));
 364         }
 365         return count($this->_expected_errors);
 366     }
 367
 368     /**
 369      * This method pops one element off the expected error codes
 370      * stack.
 371      *
 372      * @return array   the list of error codes that were popped
 373      */
 374     function popExpect()
 375     {
 376         return array_pop($this->_expected_errors);
 377     }
 378
 379     /**
 380      * This method checks unsets an error code if available
 381      *
 382      * @param mixed error code
 383      * @return bool true if the error code was unset, false otherwise
 384      * @access private
 385      * @since PHP 4.3.0
 386      */
 387     function _checkDelExpect($error_code)
 388     {
 389         $deleted = false;
 390         foreach ($this->_expected_errors as $key => $error_array) {
 391             if (in_array($error_code, $error_array)) {
 392                 unset($this->_expected_errors[$key][array_search($error_code, $error_array)]);
 393                 $deleted = true;
 394             }
 395
 396             // clean up empty arrays
 397             if (0 == count($this->_expected_errors[$key])) {
 398                 unset($this->_expected_errors[$key]);
 399             }
 400         }
 401
 402         return $deleted;
 403     }
 404
 405     /**
 406      * This method deletes all occurences of the specified element from
 407      * the expected error codes stack.
 408      *
 409      * @param  mixed $error_code error code that should be deleted
 410      * @return mixed list of error codes that were deleted or error
 411      * @access public
 412      * @since PHP 4.3.0
 413      */
 414     function delExpect($error_code)
 415     {
 416         $deleted = false;
 417         if ((is_array($error_code) && (0 != count($error_code)))) {
 418             // $error_code is a non-empty array here; we walk through it trying
 419             // to unset all values
 420             foreach ($error_code as $key => $error) {
 421                 $deleted =  $this->_checkDelExpect($error) ? true : false;
 422             }
 423
 424             return $deleted ? true : PEAR::raiseError("The expected error you submitted does not exist"); // IMPROVE ME
 425         } elseif (!empty($error_code)) {
 426             // $error_code comes alone, trying to unset it
 427             if ($this->_checkDelExpect($error_code)) {
 428                 return true;
 429             }
 430
 431             return PEAR::raiseError("The expected error you submitted does not exist"); // IMPROVE ME
 432         }
 433
 434         // $error_code is empty
 435         return PEAR::raiseError("The expected error you submitted is empty"); // IMPROVE ME
 436     }
 437
 438     /**
 439      * This method is a wrapper that returns an instance of the
 440      * configured error class with this object's default error
 441      * handling applied.  If the $mode and $options parameters are not
 442      * specified, the object's defaults are used.
 443      *
 444      * @param mixed $message a text error message or a PEAR error object
 445      *
 446      * @param int $code      a numeric error code (it is up to your class
 447      *                  to define these if you want to use codes)
 448      *
 449      * @param int $mode      One of PEAR_ERROR_RETURN, PEAR_ERROR_PRINT,
 450      *                  PEAR_ERROR_TRIGGER, PEAR_ERROR_DIE,
 451      *                  PEAR_ERROR_CALLBACK, PEAR_ERROR_EXCEPTION.
 452      *
 453      * @param mixed $options If $mode is PEAR_ERROR_TRIGGER, this parameter
 454      *                  specifies the PHP-internal error level (one of
 455      *                  E_USER_NOTICE, E_USER_WARNING or E_USER_ERROR).
 456      *                  If $mode is PEAR_ERROR_CALLBACK, this
 457      *                  parameter specifies the callback function or
 458      *                  method.  In other error modes this parameter
 459      *                  is ignored.
 460      *
 461      * @param string $userinfo If you need to pass along for example debug
 462      *                  information, this parameter is meant for that.
 463      *
 464      * @param string $error_class The returned error object will be
 465      *                  instantiated from this class, if specified.
 466      *
 467      * @param bool $skipmsg If true, raiseError will only pass error codes,
 468      *                  the error message parameter will be dropped.
 469      *
 470      * @access public
 471      * @return object   a PEAR error object
 472      * @see PEAR::setErrorHandling
 473      * @since PHP 4.0.5
 474      */
 475       function &raiseError($message = null,
 476                          $code = null,
 477                          $mode = null,
 478                          $options = null,
 479                          $userinfo = null,
 480                          $error_class = null,
 481                          $skipmsg = false)
 482     {
 483         // The error is yet a PEAR error object
 484         if (is_object($message)) {
 485             $code        = $message->getCode();
 486             $userinfo    = $message->getUserInfo();
 487             $error_class = $message->getType();
 488             $message->error_message_prefix = '';
 489             $message     = $message->getMessage();
 490         }
 491
 492         if (
 493             isset($this) &&
 494             isset($this->_expected_errors) &&
 495             count($this->_expected_errors) > 0 &&
 496             count($exp = end($this->_expected_errors))
 497         ) {
 498             if ($exp[0] == "*" ||
 499                 (is_int(reset($exp)) && in_array($code, $exp)) ||
 500                 (is_string(reset($exp)) && in_array($message, $exp))
 501             ) {
 502                 $mode = PEAR_ERROR_RETURN;
 503             }
 504         }
 505
 506         // No mode given, try global ones
 507         if ($mode === null) {
 508             // Class error handler
 509             if (isset($this) && isset($this->_default_error_mode)) {
 510                 $mode    = $this->_default_error_mode;
 511                 $options = $this->_default_error_options;
 512             // Global error handler
 513             } elseif (isset($GLOBALS['_PEAR_default_error_mode'])) {
 514                 $mode    = $GLOBALS['_PEAR_default_error_mode'];
 515                 $options = $GLOBALS['_PEAR_default_error_options'];
 516             }
 517         }
 518
 519         if ($error_class !== null) {
 520             $ec = $error_class;
 521         } elseif (isset($this) && isset($this->_error_class)) {
 522             $ec = $this->_error_class;
 523         } else {
 524             $ec = 'PEAR_Error';
 525         }
 526
 527         if (intval(PHP_VERSION) < 5) {
 528             // little non-eval hack to fix bug #12147
 529             include 'PEAR/FixPHP5PEARWarnings.php';
 530             return $a;
 531         }
 532
 533         if ($skipmsg) {
 534             $a = new $ec($code, $mode, $options, $userinfo);
 535         } else {
 536             $a = new $ec($message, $code, $mode, $options, $userinfo);
 537         }
 538
 539         return $a;
 540     }
 541
 542     static function staticRaiseError ($message = null,
 543                          $code = null,
 544                          $mode = null,
 545                          $options = null,
 546                          $userinfo = null,
 547                          $error_class = null,
 548                          $skipmsg = false) {
 549         $p = new PEAR();
 550         return $p->raiseError($message  ,$code ,  $mode , $options , $userinfo , $error_class , $skipmsg );
 551     }
 552
 553     /**
 554      * Simpler form of raiseError with fewer options.  In most cases
 555      * message, code and userinfo are enough.
 556      *
 557      * @param mixed $message a text error message or a PEAR error object
 558      *
 559      * @param int $code      a numeric error code (it is up to your class
 560      *                  to define these if you want to use codes)
 561      *
 562      * @param string $userinfo If you need to pass along for example debug
 563      *                  information, this parameter is meant for that.
 564      *
 565      * @access public
 566      * @return object   a PEAR error object
 567      * @see PEAR::raiseError
 568      */
 569     function &throwError($message = null, $code = null, $userinfo = null)
 570     {
 571         if (isset($this) && is_a($this, 'PEAR')) {
 572             $a = &$this->raiseError($message, $code, null, null, $userinfo);
 573             return $a;
 574         }
 575
 576         $a = &PEAR::raiseError($message, $code, null, null, $userinfo);
 577         return $a;
 578     }
 579
 580     function staticPushErrorHandling($mode, $options = null)
 581     {
 582         $stack       = &$GLOBALS['_PEAR_error_handler_stack'];
 583         $def_mode    = &$GLOBALS['_PEAR_default_error_mode'];
 584         $def_options = &$GLOBALS['_PEAR_default_error_options'];
 585         $stack[] = array($def_mode, $def_options);
 586         switch ($mode) {
 587             case PEAR_ERROR_EXCEPTION:
 588             case PEAR_ERROR_RETURN:
 589             case PEAR_ERROR_PRINT:
 590             case PEAR_ERROR_TRIGGER:
 591             case PEAR_ERROR_DIE:
 592             case null:
 593                 $def_mode = $mode;
 594                 $def_options = $options;
 595                 break;
 596
 597             case PEAR_ERROR_CALLBACK:
 598                 $def_mode = $mode;
 599                 // class/object method callback
 600                 if (is_callable($options)) {
 601                     $def_options = $options;
 602                 } else {
 603                     trigger_error("invalid error callback", E_USER_WARNING);
 604                 }
 605                 break;
 606
 607             default:
 608                 trigger_error("invalid error mode", E_USER_WARNING);
 609                 break;
 610         }
 611         $stack[] = array($mode, $options);
 612         return true;
 613     }
 614
 615     function staticPopErrorHandling()
 616     {
 617         $stack = &$GLOBALS['_PEAR_error_handler_stack'];
 618         $setmode     = &$GLOBALS['_PEAR_default_error_mode'];
 619         $setoptions  = &$GLOBALS['_PEAR_default_error_options'];
 620         array_pop($stack);
 621         list($mode, $options) = $stack[sizeof($stack) - 1];
 622         array_pop($stack);
 623         switch ($mode) {
 624             case PEAR_ERROR_EXCEPTION:
 625             case PEAR_ERROR_RETURN:
 626             case PEAR_ERROR_PRINT:
 627             case PEAR_ERROR_TRIGGER:
 628             case PEAR_ERROR_DIE:
 629             case null:
 630                 $setmode = $mode;
 631                 $setoptions = $options;
 632                 break;
 633
 634             case PEAR_ERROR_CALLBACK:
 635                 $setmode = $mode;
 636                 // class/object method callback
 637                 if (is_callable($options)) {
 638                     $setoptions = $options;
 639                 } else {
 640                     trigger_error("invalid error callback", E_USER_WARNING);
 641                 }
 642                 break;
 643
 644             default:
 645                 trigger_error("invalid error mode", E_USER_WARNING);
 646                 break;
 647         }
 648         return true;
 649     }
 650
 651     /**
 652      * Push a new error handler on top of the error handler options stack. With this
 653      * you can easily override the actual error handler for some code and restore
 654      * it later with popErrorHandling.
 655      *
 656      * @param mixed $mode (same as setErrorHandling)
 657      * @param mixed $options (same as setErrorHandling)
 658      *
 659      * @return bool Always true
 660      *
 661      * @see PEAR::setErrorHandling
 662      */
 663     function pushErrorHandling($mode, $options = null)
 664     {
 665         $stack = &$GLOBALS['_PEAR_error_handler_stack'];
 666         if (isset($this) && is_a($this, 'PEAR')) {
 667             $def_mode    = &$this->_default_error_mode;
 668             $def_options = &$this->_default_error_options;
 669         } else {
 670             $def_mode    = &$GLOBALS['_PEAR_default_error_mode'];
 671             $def_options = &$GLOBALS['_PEAR_default_error_options'];
 672         }
 673         $stack[] = array($def_mode, $def_options);
 674
 675         if (isset($this) && is_a($this, 'PEAR')) {
 676             $this->setErrorHandling($mode, $options);
 677         } else {
 678             PEAR::setErrorHandling($mode, $options);
 679         }
 680         $stack[] = array($mode, $options);
 681         return true;
 682     }
 683
 684     /**
 685     * Pop the last error handler used
 686     *
 687     * @return bool Always true
 688     *
 689     * @see PEAR::pushErrorHandling
 690     */
 691     function popErrorHandling()
 692     {
 693         $stack = &$GLOBALS['_PEAR_error_handler_stack'];
 694         array_pop($stack);
 695         list($mode, $options) = $stack[sizeof($stack) - 1];
 696         array_pop($stack);
 697         if (isset($this) && is_a($this, 'PEAR')) {
 698             $this->setErrorHandling($mode, $options);
 699         } else {
 700             PEAR::setErrorHandling($mode, $options);
 701         }
 702         return true;
 703     }
 704
 705     /**
 706     * OS independant PHP extension load. Remember to take care
 707     * on the correct extension name for case sensitive OSes.
 708     *
 709     * @param string $ext The extension name
 710     * @return bool Success or not on the dl() call
 711     */
 712     function loadExtension($ext)
 713     {
 714         if (extension_loaded($ext)) {
 715             return true;
 716         }
 717
 718         // if either returns true dl() will produce a FATAL error, stop that
 719         if (
 720             function_exists('dl') === false ||
 721             ini_get('enable_dl') != 1 ||
 722             ini_get('safe_mode') == 1
 723         ) {
 724             return false;
 725         }
 726
 727         if (OS_WINDOWS) {
 728             $suffix = '.dll';
 729         } elseif (PHP_OS == 'HP-UX') {
 730             $suffix = '.sl';
 731         } elseif (PHP_OS == 'AIX') {
 732             $suffix = '.a';
 733         } elseif (PHP_OS == 'OSX') {
 734             $suffix = '.bundle';
 735         } else {
 736             $suffix = '.so';
 737         }
 738
 739         return @dl('php_'.$ext.$suffix) || @dl($ext.$suffix);
 740     }
 741 }
 742
 743 if (PEAR_ZE2) {
 744     include_once 'PEAR5.php';
 745 }
 746
 747 function _PEAR_call_destructors()
 748 {
 749     global $_PEAR_destructor_object_list;
 750     if (is_array($_PEAR_destructor_object_list) &&
 751         sizeof($_PEAR_destructor_object_list))
 752     {
 753         reset($_PEAR_destructor_object_list);
 754         if (PEAR_ZE2) {
 755             $destructLifoExists = PEAR5::getStaticProperty('PEAR', 'destructlifo');
 756         } else {
 757             $destructLifoExists = PEAR::getStaticProperty('PEAR', 'destructlifo');
 758         }
 759
 760         if ($destructLifoExists) {
 761             $_PEAR_destructor_object_list = array_reverse($_PEAR_destructor_object_list);
 762         }
 763
 764         while (list($k, $objref) = each($_PEAR_destructor_object_list)) {
 765             $classname = get_class($objref);
 766             while ($classname) {
 767                 $destructor = "_$classname";
 768                 if (method_exists($objref, $destructor)) {
 769                     $objref->$destructor();
 770                     break;
 771                 } else {
 772                     $classname = get_parent_class($classname);
 773                 }
 774             }
 775         }
 776         // Empty the object list to ensure that destructors are
 777         // not called more than once.
 778         $_PEAR_destructor_object_list = array();
 779     }
 780
 781     // Now call the shutdown functions
 782     if (
 783         isset($GLOBALS['_PEAR_shutdown_funcs']) &&
 784         is_array($GLOBALS['_PEAR_shutdown_funcs']) &&
 785         !empty($GLOBALS['_PEAR_shutdown_funcs'])
 786     ) {
 787         foreach ($GLOBALS['_PEAR_shutdown_funcs'] as $value) {
 788             call_user_func_array($value[0], $value[1]);
 789         }
 790     }
 791 }
 792
 793 /**
 794  * Standard PEAR error class for PHP 4
 795  *
 796  * This class is supserseded by {@link PEAR_Exception} in PHP 5
 797  *
 798  * @category   pear
 799  * @package    PEAR
 800  * @author     Stig Bakken <ssb@php.net>
 801  * @author     Tomas V.V. Cox <cox@idecnet.com>
 802  * @author     Gregory Beaver <cellog@php.net>
 803  * @copyright  1997-2006 The PHP Group
 804  * @license    http://opensource.org/licenses/bsd-license.php New BSD License
 805  * @version    Release: 1.9.4
 806  * @link       http://pear.php.net/manual/en/core.pear.pear-error.php
 807  * @see        PEAR::raiseError(), PEAR::throwError()
 808  * @since      Class available since PHP 4.0.2
 809  */
 810 class PEAR_Error
 811 {
 812     var $error_message_prefix = '';
 813     var $mode                 = PEAR_ERROR_RETURN;
 814     var $level                = E_USER_NOTICE;
 815     var $code                 = -1;
 816     var $message              = '';
 817     var $userinfo             = '';
 818     var $backtrace            = null;
 819
 820     /**
 821      * PEAR_Error constructor
 822      *
 823      * @param string $message  message
 824      *
 825      * @param int $code     (optional) error code
 826      *
 827      * @param int $mode     (optional) error mode, one of: PEAR_ERROR_RETURN,
 828      * PEAR_ERROR_PRINT, PEAR_ERROR_DIE, PEAR_ERROR_TRIGGER,
 829      * PEAR_ERROR_CALLBACK or PEAR_ERROR_EXCEPTION
 830      *
 831      * @param mixed $options   (optional) error level, _OR_ in the case of
 832      * PEAR_ERROR_CALLBACK, the callback function or object/method
 833      * tuple.
 834      *
 835      * @param string $userinfo (optional) additional user/debug info
 836      *
 837      * @access public
 838      *
 839      */
 840     function PEAR_Error($message = 'unknown error', $code = null,
 841                         $mode = null, $options = null, $userinfo = null)
 842     {
 843         if ($mode === null) {
 844             $mode = PEAR_ERROR_RETURN;
 845         }
 846         $this->message   = $message;
 847         $this->code      = $code;
 848         $this->mode      = $mode;
 849         $this->userinfo  = $userinfo;
 850
 851         if (PEAR_ZE2) {
 852             $skiptrace = PEAR5::getStaticProperty('PEAR_Error', 'skiptrace');
 853         } else {
 854             $skiptrace = PEAR::getStaticProperty('PEAR_Error', 'skiptrace');
 855         }
 856
 857         if (!$skiptrace) {
 858             $this->backtrace = debug_backtrace();
 859             if (isset($this->backtrace[0]) && isset($this->backtrace[0]['object'])) {
 860                 unset($this->backtrace[0]['object']);
 861             }
 862         }
 863
 864         if ($mode & PEAR_ERROR_CALLBACK) {
 865             $this->level = E_USER_NOTICE;
 866             $this->callback = $options;
 867         } else {
 868             if ($options === null) {
 869                 $options = E_USER_NOTICE;
 870             }
 871
 872             $this->level = $options;
 873             $this->callback = null;
 874         }
 875
 876         if ($this->mode & PEAR_ERROR_PRINT) {
 877             if (is_null($options) || is_int($options)) {
 878                 $format = "%s";
 879             } else {
 880                 $format = $options;
 881             }
 882
 883             printf($format, $this->getMessage());
 884         }
 885
 886         if ($this->mode & PEAR_ERROR_TRIGGER) {
 887             trigger_error($this->getMessage(), $this->level);
 888         }
 889
 890         if ($this->mode & PEAR_ERROR_DIE) {
 891             $msg = $this->getMessage();
 892             if (is_null($options) || is_int($options)) {
 893                 $format = "%s";
 894                 if (substr($msg, -1) != "\n") {
 895                     $msg .= "\n";
 896                 }
 897             } else {
 898                 $format = $options;
 899             }
 900             die(sprintf($format, $msg));
 901         }
 902
 903
 904         if ($this->mode & PEAR_ERROR_CALLBACK && is_callable($this->callback)) {
 905             call_user_func($this->callback, $this);
 906         }
 907
 908         if ($this->mode & PEAR_ERROR_EXCEPTION) {
 909             trigger_error("PEAR_ERROR_EXCEPTION is obsolete, use class PEAR_Exception for exceptions", E_USER_WARNING);
 910             eval('$e = new Exception($this->message, $this->code);throw($e);');
 911         }
 912     }
 913
 914     /**
 915      * Get the error mode from an error object.
 916      *
 917      * @return int error mode
 918      * @access public
 919      */
 920     function getMode()
 921     {
 922         return $this->mode;
 923     }
 924
 925     /**
 926      * Get the callback function/method from an error object.
 927      *
 928      * @return mixed callback function or object/method array
 929      * @access public
 930      */
 931     function getCallback()
 932     {
 933         return $this->callback;
 934     }
 935
 936     /**
 937      * Get the error message from an error object.
 938      *
 939      * @return  string  full error message
 940      * @access public
 941      */
 942     function getMessage()
 943     {
 944         return ($this->error_message_prefix . $this->message);
 945     }
 946
 947     /**
 948      * Get error code from an error object
 949      *
 950      * @return int error code
 951      * @access public
 952      */
 953      function getCode()
 954      {
 955         return $this->code;
 956      }
 957
 958     /**
 959      * Get the name of this error/exception.
 960      *
 961      * @return string error/exception name (type)
 962      * @access public
 963      */
 964     function getType()
 965     {
 966         return get_class($this);
 967     }
 968
 969     /**
 970      * Get additional user-supplied information.
 971      *
 972      * @return string user-supplied information
 973      * @access public
 974      */
 975     function getUserInfo()
 976     {
 977         return $this->userinfo;
 978     }
 979
 980     /**
 981      * Get additional debug information supplied by the application.
 982      *
 983      * @return string debug information
 984      * @access public
 985      */
 986     function getDebugInfo()
 987     {
 988         return $this->getUserInfo();
 989     }
 990
 991     /**
 992      * Get the call backtrace from where the error was generated.
 993      * Supported with PHP 4.3.0 or newer.
 994      *
 995      * @param int $frame (optional) what frame to fetch
 996      * @return array Backtrace, or NULL if not available.
 997      * @access public
 998      */
 999     function getBacktrace($frame = null)
1000     {
1001         if (defined('PEAR_IGNORE_BACKTRACE')) {
1002             return null;
1003         }
1004         if ($frame === null) {
1005             return $this->backtrace;
1006         }
1007         return $this->backtrace[$frame];
1008     }
1009
1010     function addUserInfo($info)
1011     {
1012         if (empty($this->userinfo)) {
1013             $this->userinfo = $info;
1014         } else {
1015             $this->userinfo .= " ** $info";
1016         }
1017     }
1018
1019     function __toString()
1020     {
1021         return $this->getMessage();
1022     }
1023
1024     /**
1025      * Make a string representation of this object.
1026      *
1027      * @return string a string with an object summary
1028      * @access public
1029      */
1030     function toString()
1031     {
1032         $modes = array();
1033         $levels = array(E_USER_NOTICE  => 'notice',
1034                         E_USER_WARNING => 'warning',
1035                         E_USER_ERROR   => 'error');
1036         if ($this->mode & PEAR_ERROR_CALLBACK) {
1037             if (is_array($this->callback)) {
1038                 $callback = (is_object($this->callback[0]) ?
1039                     strtolower(get_class($this->callback[0])) :
1040                     $this->callback[0]) . '::' .
1041                     $this->callback[1];
1042             } else {
1043                 $callback = $this->callback;
1044             }
1045             return sprintf('[%s: message="%s" code=%d mode=callback '.
1046                            'callback=%s prefix="%s" info="%s"]',
1047                            strtolower(get_class($this)), $this->message, $this->code,
1048                            $callback, $this->error_message_prefix,
1049                            is_string($this->userinfo) ? $this->userinfo : print_r($this->userinfo,true));
1050         }
1051         if ($this->mode & PEAR_ERROR_PRINT) {
1052             $modes[] = 'print';
1053         }
1054         if ($this->mode & PEAR_ERROR_TRIGGER) {
1055             $modes[] = 'trigger';
1056         }
1057         if ($this->mode & PEAR_ERROR_DIE) {
1058             $modes[] = 'die';
1059         }
1060         if ($this->mode & PEAR_ERROR_RETURN) {
1061             $modes[] = 'return';
1062         }
1063         return sprintf('[%s: message="%s" code=%d mode=%s level=%s '.
1064                        'prefix="%s" info="%s"]',
1065                        strtolower(get_class($this)), $this->message, $this->code,
1066                        implode("|", $modes), $levels[$this->level],
1067                        $this->error_message_prefix,
1068                        $this->userinfo);
1069     }
1070 }
1071
1072 /*
1073  * Local Variables:
1074  * mode: php
1075  * tab-width: 4
1076  * c-basic-offset: 4
1077  * End:
1078  */