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