libraries/Error.class.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Holds class PMA_Error
   5  *
   6  * @version $Id$
   7  */
   8
   9 /**
  10  * base class
  11  */
  12 require_once './libraries/Message.class.php';
  13
  14 /**
  15  * a single error
  16  *
  17  */
  18 class PMA_Error extends PMA_Message
  19 {
  20     /**
  21      * Error types
  22      *
  23      * @var array
  24      */
  25     static public $errortype = array (
  26         E_ERROR              => 'Error',
  27         E_WARNING            => 'Warning',
  28         E_PARSE              => 'Parsing Error',
  29         E_NOTICE             => 'Notice',
  30         E_CORE_ERROR         => 'Core Error',
  31         E_CORE_WARNING       => 'Core Warning',
  32         E_COMPILE_ERROR      => 'Compile Error',
  33         E_COMPILE_WARNING    => 'Compile Warning',
  34         E_USER_ERROR         => 'User Error',
  35         E_USER_WARNING       => 'User Warning',
  36         E_USER_NOTICE        => 'User Notice',
  37         E_STRICT             => 'Runtime Notice',
  38         E_RECOVERABLE_ERROR  => 'Catchable Fatal Error',
  39     );
  40
  41     /**
  42      * Error levels
  43      *
  44      * @var array
  45      */
  46     static public $errorlevel = array (
  47         E_ERROR              => 'error',
  48         E_WARNING            => 'warning',
  49         E_PARSE              => 'error',
  50         E_NOTICE             => 'notice',
  51         E_CORE_ERROR         => 'error',
  52         E_CORE_WARNING       => 'warning',
  53         E_COMPILE_ERROR      => 'error',
  54         E_COMPILE_WARNING    => 'warning',
  55         E_USER_ERROR         => 'error',
  56         E_USER_WARNING       => 'warning',
  57         E_USER_NOTICE        => 'notice',
  58         E_STRICT             => 'notice',
  59         E_RECOVERABLE_ERROR  => 'error',
  60     );
  61
  62     /**
  63      * The file in which the error occured
  64      *
  65      * @var string
  66      */
  67     protected $_file = '';
  68
  69     /**
  70      * The line in which the error occured
  71      *
  72      * @var integer
  73      */
  74     protected $_line = 0;
  75
  76     /**
  77      * Holds any variables defined in the context where the error occured
  78      * f. e. $this if the error occured in an object method
  79      *
  80      * @var array
  81      */
  82     protected $_context = array();
  83
  84     /**
  85      * Holds the backtrace for this error
  86      *
  87      * @var array
  88      */
  89     protected $_backtrace = array();
  90
  91     /**
  92      * Unique id
  93      *
  94      * @var string
  95      */
  96     protected $_hash = null;
  97
  98     /**
  99      * Constructor
 100      *
 101      * @uses    debug_backtrace()
 102      * @uses    PMA_Error::setNumber()
 103      * @uses    PMA_Error::setMessage()
 104      * @uses    PMA_Error::setFile()
 105      * @uses    PMA_Error::setLine()
 106      * @uses    PMA_Error::setContext()
 107      * @uses    PMA_Error::setBacktrace()
 108      * @param   integer $errno
 109      * @param   string  $errstr
 110      * @param   string  $errfile
 111      * @param   integer $errline
 112      * @param   array   $errcontext
 113      */
 114     public function __construct($errno, $errstr, $errfile, $errline, $errcontext)
 115     {
 116         $this->setNumber($errno);
 117         $this->setMessage($errstr, false);
 118         $this->setFile($errfile);
 119         $this->setLine($errline);
 120         $this->setContext($errcontext);
 121
 122         $backtrace = debug_backtrace();
 123         // remove last two calls: debug_backtrace() and handleError()
 124         unset($backtrace[0]);
 125         unset($backtrace[1]);
 126
 127         $this->setBacktrace($backtrace);
 128     }
 129
 130     /**
 131      * sets PMA_Error::$_backtrace
 132      *
 133      * @uses    PMA_Error::$_backtrace to set it
 134      * @param   array $backtrace
 135      */
 136     public function setBacktrace($backtrace)
 137     {
 138         $this->_backtrace = $backtrace;
 139     }
 140
 141     /**
 142      * sets PMA_Error::$_context
 143      *
 144      * @uses    PMA_Error::$_context to set it
 145      * @param   array $context
 146      */
 147     public function setContext($context)
 148     {
 149         $this->_context = $context;
 150     }
 151
 152     /**
 153      * sets PMA_Error::$_line
 154      *
 155      * @uses    PMA_Error::$_line to set it
 156      * @param   integer $line
 157      */
 158     public function setLine($line)
 159     {
 160         $this->_line = $line;
 161     }
 162
 163     /**
 164      * sets PMA_Error::$_file
 165      *
 166      * @uses    PMA_Error::$_file to set it
 167      * @uses    PMA_Error::relPath()
 168      * @param   string $file
 169      */
 170     public function setFile($file)
 171     {
 172         $this->_file = PMA_Error::relPath($file);
 173     }
 174
 175
 176     /**
 177      * returns unique PMA_Error::$_hash, if not exists it will be created
 178      *
 179      * @uses    PMA_Error::$_hash as return value and to set it if required
 180      * @uses    PMA_Error::getNumber()
 181      * @uses    PMA_Error::getMessage()
 182      * @uses    PMA_Error::getFile()
 183      * @uses    PMA_Error::getLine()
 184      * @uses    PMA_Error::getBacktrace()
 185      * @uses    md5()
 186      * @param   string $file
 187      * @return  string PMA_Error::$_hash
 188      */
 189     public function getHash()
 190     {
 191         if (null === $this->_hash) {
 192             $this->_hash = md5(
 193                 $this->getNumber() .
 194                 $this->getMessage() .
 195                 $this->getFile() .
 196                 $this->getLine() .
 197                 $this->getBacktrace()
 198             );
 199         }
 200
 201         return $this->_hash;
 202     }
 203
 204     /**
 205      * returns PMA_Error::$_backtrace
 206      *
 207      * @uses    PMA_Error::$_backtrace as return value
 208      * @return  array PMA_Error::$_backtrace
 209      */
 210     public function getBacktrace()
 211     {
 212         return $this->_backtrace;
 213     }
 214
 215     /**
 216      * returns PMA_Error::$_file
 217      *
 218      * @uses    PMA_Error::$_file as return value
 219      * @return  string PMA_Error::$_file
 220      */
 221     public function getFile()
 222     {
 223         return $this->_file;
 224     }
 225
 226     /**
 227      * returns PMA_Error::$_line
 228      *
 229      * @uses    PMA_Error::$_line as return value
 230      * @return  integer PMA_Error::$_line
 231      */
 232     public function getLine()
 233     {
 234         return $this->_line;
 235     }
 236
 237     /**
 238      * returns type of error
 239      *
 240      * @uses    PMA_Error::$errortype
 241      * @uses    PMA_Error::getNumber()
 242      * @return  string  type of error
 243      */
 244     public function getType()
 245     {
 246         return PMA_Error::$errortype[$this->getNumber()];
 247     }
 248
 249     /**
 250      * returns level of error
 251      *
 252      * @uses    PMA_Error::$$errorlevel
 253      * @uses    PMA_Error::getNumber()
 254      * @return  string  level of error
 255      */
 256     public function getLevel()
 257     {
 258         return PMA_Error::$errorlevel[$this->getNumber()];
 259     }
 260
 261     /**
 262      * returns title prepared for HTML Title-Tag
 263      *
 264      * @uses    PMA_Error::getTitle()
 265      * @uses    htmlspecialchars()
 266      * @uses    substr()
 267      * @return  string   HTML escaped and truncated title
 268      */
 269     public function getHtmlTitle()
 270     {
 271         return htmlspecialchars(substr($this->getTitle(), 0, 100));
 272     }
 273
 274     /**
 275      * returns title for error
 276      *
 277      * @uses    PMA_Error::getType()
 278      * @uses    PMA_Error::getMessage()
 279      * @return string
 280      */
 281     public function getTitle()
 282     {
 283         return $this->getType() . ': ' . $this->getMessage();
 284     }
 285
 286     /**
 287      * Display HTML backtrace
 288      *
 289      * @uses    PMA_Error::getBacktrace()
 290      * @uses    PMA_Error::relPath()
 291      * @uses    PMA_Error::displayArg()
 292      * @uses    count()
 293      */
 294     public function displayBacktrace()
 295     {
 296         foreach ($this->getBacktrace() as $step) {
 297             echo PMA_Error::relPath($step['file']) . '#' . $step['line'] . ': ';
 298             if (isset($step['class'])) {
 299                 echo $step['class'] . $step['type'];
 300             }
 301             echo $step['function'] . '(';
 302             if (count($step['args']) > 1) {
 303                 echo "<br />\n";
 304                 foreach ($step['args'] as $arg) {
 305                     echo "\t";
 306                     $this->displayArg($arg, $step['function']);
 307                     echo ',' . "<br />\n";
 308                 }
 309             } elseif (count($step['args']) > 0) {
 310                 foreach ($step['args'] as $arg) {
 311                     $this->displayArg($arg, $step['function']);
 312                 }
 313             }
 314             echo ')' . "<br />\n";
 315         }
 316     }
 317
 318     /**
 319      * Display a single function argument
 320      * if $function is one of include/require the $arg is converted te relative path
 321      *
 322      * @uses    PMA_Error::relPath()
 323      * @uses    in_array()
 324      * @uses    gettype()
 325      * @param string $arg
 326      * @param string $function
 327      */
 328     protected function displayArg($arg, $function)
 329     {
 330         $include_functions = array(
 331             'include',
 332             'include_once',
 333             'require',
 334             'require_once',
 335         );
 336
 337         if (in_array($function, $include_functions)) {
 338             echo PMA_Error::relPath($arg);
 339         } elseif (is_scalar($arg)) {
 340             echo gettype($arg) . ' ' . $arg;
 341         } else {
 342             echo gettype($arg);
 343         }
 344     }
 345
 346     /**
 347      * Displays the error in HTML
 348      *
 349      * @uses    PMA_Error::getLevel()
 350      * @uses    PMA_Error::getType()
 351      * @uses    PMA_Error::getMessage()
 352      * @uses    PMA_Error::displayBacktrace()
 353      * @uses    PMA_Error::isDisplayed()
 354      */
 355     public function display()
 356     {
 357         echo '<div class="' . $this->getLevel() . '">';
 358         if (! $this->isUserError()) {
 359             echo '<strong>' . $this->getType() . '</strong>';
 360             echo ' in ' . $this->getFile() . '#' . $this->getLine();
 361             echo "<br />\n";
 362         }
 363         echo $this->getMessage();
 364         if (! $this->isUserError()) {
 365             echo "<br />\n";
 366             echo "<br />\n";
 367             echo "<strong>Backtrace</strong><br />\n";
 368             echo "<br />\n";
 369             echo $this->displayBacktrace();
 370         }
 371         echo '</div>';
 372         $this->isDisplayed(true);
 373     }
 374
 375     /**
 376      * whether this error is a user error
 377      *
 378      * @uses    E_USER_WARNING
 379      * @uses    E_USER_ERROR
 380      * @uses    E_USER_NOTICE
 381      * @uses    PMA_Error::getNumber()
 382      * @return  boolean
 383      */
 384     public function isUserError()
 385     {
 386         return $this->getNumber() & (E_USER_WARNING | E_USER_ERROR | E_USER_NOTICE);
 387     }
 388
 389     /**
 390      * return short relative path to phpMyAdmin basedir
 391      *
 392      * prevent path disclusore in error message,
 393      * and make users feel save to submit error reports
 394      *
 395      * @static
 396      * @uses    PHP_OS()
 397      * @uses    __FILE__()
 398      * @uses    realpath()
 399      * @uses    substr()
 400      * @uses    explode()
 401      * @uses    dirname()
 402      * @uses    implode()
 403      * @uses    count()
 404      * @uses    array_pop()
 405      * @uses    str_replace()
 406      * @param   string $dest  path to be shorten
 407      * @return  string shortened path
 408      */
 409     static function relPath($dest)
 410     {
 411         $dest = realpath($dest);
 412
 413         if (substr(PHP_OS, 0, 3) == 'WIN') {
 414             $path_separator = '\\';
 415         } else {
 416             $path_separator = '/';
 417         }
 418
 419         $Ahere = explode($path_separator, realpath(dirname(__FILE__) . $path_separator . '..'));
 420         $Adest = explode($path_separator, $dest);
 421
 422         $result = '.';
 423         // && count ($Adest)>0 && count($Ahere)>0 )
 424         while (implode($path_separator, $Adest) != implode($path_separator, $Ahere)) {
 425             if (count($Ahere) > count($Adest)) {
 426                 array_pop($Ahere);
 427                 $result .= $path_separator . '..';
 428             } else {
 429                 array_pop($Adest);
 430             }
 431         }
 432         $path = $result . str_replace(implode($path_separator, $Adest), '', $dest);
 433         return str_replace($path_separator . $path_separator, $path_separator, $path);
 434     }
 435 }
 436 ?>