libraries/Error.class.php

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