Viewing file:  Exception.php (4.98 KB) -rwxrwxr-x
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
/**
* Baseclass for simpleSAML Exceptions
*
* This class tries to make sure that every exception is serializable.
*
* @author Thomas Graff <thomas.graff@uninett.no>
* @package simpleSAMLphp_base
* @version $Id$
*/
class SimpleSAML_Error_Exception extends Exception {
/**
* The backtrace for this exception.
*
* We need to save the backtrace, since we cannot rely on
* serializing the Exception::trace-variable.
*
* @var string
*/
private $backtrace;
/**
* The cause of this exception.
*
* @var SimpleSAML_Error_Exception
*/
private $cause;
/**
* Constructor for this error.
*
* Note that the cause will be converted to a SimpleSAML_Error_UnserializableException
* unless it is a subclass of SimpleSAML_Error_Exception.
*
* @param string $message Exception message
* @param int $code Error code
* @param Exception|NULL $cause The cause of this exception.
*/
public function __construct($message, $code = 0, Exception $cause = NULL) {
assert('is_string($message)');
assert('is_int($code)');
parent::__construct($message, $code);
$this->initBacktrace($this);
if ($cause !== NULL) {
$this->cause = SimpleSAML_Error_Exception::fromException($cause);
}
}
/**
* Convert any exception into a SimpleSAML_Error_Exception.
*
* @param Exception $e The exception.
* @return SimpleSAML_Error_Exception The new exception.
*/
public static function fromException(Exception $e) {
if ($e instanceof SimpleSAML_Error_Exception) {
return $e;
}
return new SimpleSAML_Error_UnserializableException($e);
}
/**
* Load the backtrace from the given exception.
*
* @param Exception $exception The exception we should fetch the backtrace from.
*/
protected function initBacktrace(Exception $exception) {
$this->backtrace = array();
/* Position in the top function on the stack. */
$pos = $exception->getFile() . ':' . $exception->getLine();
foreach($exception->getTrace() as $t) {
$function = $t['function'];
if(array_key_exists('class', $t)) {
$function = $t['class'] . '::' . $function;
}
$this->backtrace[] = $pos . ' (' . $function . ')';
if(array_key_exists('file', $t)) {
$pos = $t['file'] . ':' . $t['line'];
} else {
$pos = '[builtin]';
}
}
$this->backtrace[] = $pos . ' (N/A)';
}
/**
* Retrieve the backtrace.
*
* @return array An array where each function call is a single item.
*/
public function getBacktrace() {
return $this->backtrace;
}
/**
* Retrieve the cause of this exception.
*
* @return SimpleSAML_Error_Exception|NULL The cause of this exception.
*/
public function getCause() {
return $this->cause;
}
/**
* Retrieve the class of this exception.
*
* @return string The classname.
*/
public function getClass() {
return get_class($this);
}
/**
* Format this exception for logging.
*
* Create an array with lines for logging.
*
* @return array Log lines which should be written out.
*/
public function format() {
$ret = array();
$e = $this;
do {
$err = $e->getClass() . ': ' . $e->getMessage();
if ($e === $this) {
$ret[] = $err;
} else {
$ret[] = 'Caused by: ' . $err;
}
$ret[] = 'Backtrace:';
$depth = count($e->backtrace);
foreach ($e->backtrace as $i => $trace) {
$ret[] = ($depth - $i - 1) . ' ' . $trace;
}
$e = $e->cause;
} while ($e !== NULL);
return $ret;
}
/**
* Print the exception to the log with log level error.
*
* This function will write this exception to the log, including a full backtrace.
*/
public function logError() {
$lines = $this->format();
foreach ($lines as $line) {
SimpleSAML_Logger::error($line);
}
}
/**
* Print the exception to the log with log level warning.
*
* This function will write this exception to the log, including a full backtrace.
*/
public function logWarning() {
$lines = $this->format();
foreach ($lines as $line) {
SimpleSAML_Logger::warning($line);
}
}
/**
* Print the exception to the log with log level info.
*
* This function will write this exception to the log, including a full backtrace.
*/
public function logInfo() {
$lines = $this->format();
foreach ($lines as $line) {
SimpleSAML_Logger::debug($line);
}
}
/**
* Print the exception to the log with log level debug.
*
* This function will write this exception to the log, including a full backtrace.
*/
public function logDebug() {
$lines = $this->format();
foreach ($lines as $line) {
SimpleSAML_Logger::debug($line);
}
}
/**
* Function for serialization.
*
* This function builds a list of all variables which should be serialized.
* It will serialize all variables except the Exception::trace variable.
*
* @return array Array with the variables which should be serialized.
*/
public function __sleep() {
$ret = array();
$ret = array_keys((array)$this);
foreach ($ret as $i => $e) {
if ($e === "\0Exception\0trace") {
unset($ret[$i]);
}
}
return $ret;
}
}
?>
|