SimpleSAML_Error_Error Class Reference

Inheritance diagram for SimpleSAML_Error_Error:

Collaboration diagram for SimpleSAML_Error_Error:

Public Member Functions
	__construct ($errorCode, Exception $cause=null, $httpCode=null)
	Constructor for this error. More...
	getErrorCode ()
	Retrieve the error code given when throwing this error. More...
	getParameters ()
	Retrieve the error parameters given when throwing this error. More...
	getDictTitle ()
	Retrieve the error title tag in dictionary. More...
	getDictDescr ()
	Retrieve the error description tag in dictionary. More...
	show ()
	Display this error. More...
Public Member Functions inherited from SimpleSAML_Error_Exception
	__construct ($message, $code=0, Exception $cause=null)
	Constructor for this error. More...
	getBacktrace ()
	Retrieve the backtrace. More...
	getCause ()
	Retrieve the cause of this exception. More...
	getClass ()
	Retrieve the class of this exception. More...
	format ($anonymize=false)
	Format this exception for logging. More...
	formatBacktrace ($anonymize=false)
	Format the backtrace for logging. More...
	log ($default_level)
	Print the exception to the log, by default with log level error. More...
	logError ()
	Print the exception to the log with log level error. More...
	logWarning ()
	Print the exception to the log with log level warning. More...
	logInfo ()
	Print the exception to the log with log level info. More...
	logDebug ()
	Print the exception to the log with log level debug. More...
	__sleep ()
	Function for serialization. More...

Protected Member Functions
	setHTTPCode ()
	Set the HTTP return code for this error. More...
	saveError ()
	Save an error report. More...
Protected Member Functions inherited from SimpleSAML_Error_Exception
	initBacktrace (Exception $exception)
	Load the backtrace from the given exception. More...
	logBacktrace ($level=\SimpleSAML\Logger::DEBUG)
	Print the backtrace to the log if the 'debug' option is enabled in the configuration. More...

Protected Attributes
	$httpCode = 500
	$includeTemplate = null

Private Attributes
	$errorCode
	$dictTitle
	$dictDescr
	$module = null
	$parameters

Additional Inherited Members
Static Public Member Functions inherited from SimpleSAML_Error_Exception
static	fromException (Exception $e)
	Convert any exception into a SimpleSAML_Error_Exception. More...

Detailed Description

Definition at line 10 of file Error.php.

Constructor & Destructor Documentation

__construct()

SimpleSAML_Error_Error::__construct	(		$errorCode,
		Exception	$cause = null,
			$httpCode = null
	)

Constructor for this error.

The error can either be given as a string, or as an array. If it is an array, the first element in the array (with index 0), is the error code, while the other elements are replacements for the error text.

Parameters

mixed	$errorCode	One of the error codes defined in the errors dictionary.
Exception	$cause	The exception which caused this fatal error (if any). Optional.
int | null	$httpCode	The HTTP response code to use. Optional.

Definition at line 71 of file Error.php.

    {
        assert(is_string($errorCode) || is_array($errorCode));
 
        if (is_array($errorCode)) {
            $this->parameters = $errorCode;
            unset($this->parameters[0]);
            $this->errorCode = $errorCode[0];
        } else {
            $this->parameters = array();
            $this->errorCode = $errorCode;
        }
 
        if (isset($httpCode)) {
            $this->httpCode = $httpCode;
        }
 
        $moduleCode = explode(':', $this->errorCode, 2);
        if (count($moduleCode) === 2) {
            $this->module = $moduleCode[0];
            $this->dictTitle = '{'.$this->module.':errors:title_'.$moduleCode[1].'}';
            $this->dictDescr = '{'.$this->module.':errors:descr_'.$moduleCode[1].'}';
        } else {
            $this->dictTitle = SimpleSAML\Error\ErrorCodes::getErrorCodeTitle($this->errorCode);
            $this->dictDescr = SimpleSAML\Error\ErrorCodes::getErrorCodeDescription($this->errorCode);
        }
 
        if (!empty($this->parameters)) {
            $msg = $this->errorCode.'(';
            foreach ($this->parameters as $k => $v) {
                if ($k === 0) {
                    continue;
                }
 
                $msg .= var_export($k, true).' => '.var_export($v, true).', ';
            }
            $msg = substr($msg, 0, -2).')';
        } else {
            $msg = $this->errorCode;
        }
        parent::__construct($msg, -1, $cause);
    }

References SimpleSAML_Error_Exception\$cause, $errorCode, $httpCode, SimpleSAML\Error\ErrorCodes\getErrorCodeDescription(), and SimpleSAML\Error\ErrorCodes\getErrorCodeTitle().

Here is the call graph for this function:

Member Function Documentation

getDictDescr()

SimpleSAML_Error_Error::getDictDescr

(

)

Retrieve the error description tag in dictionary.

Returns

string The error description tag.

Definition at line 153 of file Error.php.

    {
        return $this->dictDescr;
    }

References $dictDescr.

getDictTitle()

SimpleSAML_Error_Error::getDictTitle

(

)

Retrieve the error title tag in dictionary.

Returns

string The error title tag.

Definition at line 142 of file Error.php.

    {
        return $this->dictTitle;
    }

References $dictTitle.

getErrorCode()

SimpleSAML_Error_Error::getErrorCode

(

)

Retrieve the error code given when throwing this error.

Returns

string The error code.

Definition at line 120 of file Error.php.

    {
        return $this->errorCode;
    }

References $errorCode.

Referenced by sspmod_authYubiKey_Auth_Source_YubiKey\handleLogin().

Here is the caller graph for this function:

getParameters()

SimpleSAML_Error_Error::getParameters

(

)

Retrieve the error parameters given when throwing this error.

Returns

array The parameters.

Definition at line 131 of file Error.php.

    {
        return $this->parameters;
    }

References $parameters.

saveError()

SimpleSAML_Error_Error::saveError ( )

protected

Save an error report.

Returns

array The array with the error report data.

Definition at line 198 of file Error.php.

    {
        $data = $this->format(true);
        $emsg = array_shift($data);
        $etrace = implode("\n", $data);
 
        $reportId = bin2hex(openssl_random_pseudo_bytes(4));
        SimpleSAML\Logger::error('Error report with id '.$reportId.' generated.');
 
        $config = SimpleSAML_Configuration::getInstance();
        $session = SimpleSAML_Session::getSessionFromRequest();
 
        if (isset($_SERVER['HTTP_REFERER'])) {
            $referer = $_SERVER['HTTP_REFERER'];
            // remove anything after the first '?' or ';', just in case it contains any sensitive data
            $referer = explode('?', $referer, 2);
            $referer = $referer[0];
            $referer = explode(';', $referer, 2);
            $referer = $referer[0];
        } else {
            $referer = 'unknown';
        }
        $errorData = array(
            'exceptionMsg'   => $emsg,
            'exceptionTrace' => $etrace,
            'reportId'       => $reportId,
            'trackId'        => $session->getTrackID(),
            'url'            => \SimpleSAML\Utils\HTTP::getSelfURLNoQuery(),
            'version'        => $config->getVersion(),
            'referer'        => $referer,
        );
        $session->setData('core:errorreport', $reportId, $errorData);
 
        return $errorData;
    }

References $_SERVER, $config, $data, $reportId, $session, SimpleSAML\Logger\error(), SimpleSAML_Error_Exception\format(), SimpleSAML_Configuration\getInstance(), and SimpleSAML_Session\getSessionFromRequest().

Referenced by show().

Here is the call graph for this function:

Here is the caller graph for this function:

setHTTPCode()

SimpleSAML_Error_Error::setHTTPCode ( )

protected

Set the HTTP return code for this error.

This should be overridden by subclasses who want a different return code than 500 Internal Server Error.

Definition at line 164 of file Error.php.

    {
        // Some mostly used HTTP codes
        $httpCodesMap = array(
            400 => 'HTTP/1.0 400 Bad Request',
            403 => 'HTTP/1.0 403 Forbidden',
            404 => 'HTTP/1.0 404 Not Found',
            405 => 'HTTP/1.0 405 Method Not Allowed',
            500 => 'HTTP/1.0 500 Internal Server Error',
            501 => 'HTTP/1.0 501 Method Not Implemented',
            503 => 'HTTP/1.0 503 Service Temporarily Unavailable',
        );
 
        $httpCode = $this->httpCode;
 
        if (function_exists('http_response_code')) {
            http_response_code($httpCode);
            return;
        }
 
        if (!array_key_exists($this->httpCode, $httpCodesMap)) {
            $httpCode = 500;
            SimpleSAML\Logger::warning('HTTP response code not defined: '.var_export($this->httpCode, true));
        }
 
        header($httpCodesMap[$httpCode]);
    }

References $httpCode, and SimpleSAML\Logger\warning().

Referenced by show().

Here is the call graph for this function:

Here is the caller graph for this function:

show()

SimpleSAML_Error_Error::show

(

)

Display this error.

This method displays a standard SimpleSAMLphp error page and exits.

Definition at line 240 of file Error.php.

    {
        $this->setHTTPCode();
 
        // log the error message
        $this->logError();
 
        $errorData = $this->saveError();
        $config = SimpleSAML_Configuration::getInstance();
 
        $data = array();
        $data['showerrors'] = $config->getBoolean('showerrors', true);
        $data['error'] = $errorData;
        $data['errorCode'] = $this->errorCode;
        $data['parameters'] = $this->parameters;
        $data['module'] = $this->module;
        $data['dictTitle'] = $this->dictTitle;
        $data['dictDescr'] = $this->dictDescr;
        $data['includeTemplate'] = $this->includeTemplate;
        $data['clipboard.js'] = true;
 
        // check if there is a valid technical contact email address
        if ($config->getBoolean('errorreporting', true) &&
            $config->getString('technicalcontact_email', 'na@example.org') !== 'na@example.org'
        ) {
            // enable error reporting
            $baseurl = \SimpleSAML\Utils\HTTP::getBaseURL();
            $data['errorReportAddress'] = $baseurl.'errorreport.php';
        }
 
        $data['email'] = '';
        $session = SimpleSAML_Session::getSessionFromRequest();
        $authorities = $session->getAuthorities();
        foreach ($authorities as $authority) {
            $attributes = $session->getAuthData($authority, 'Attributes');
            if ($attributes !== null && array_key_exists('mail', $attributes) && count($attributes['mail']) > 0) {
                $data['email'] = $attributes['mail'][0];
                break; // enough, don't need to get all available mails, if more than one
            }
        }
 
        $show_function = $config->getArray('errors.show_function', null);
        if (isset($show_function)) {
            assert(is_callable($show_function));
            call_user_func($show_function, $config, $data);
            assert(false);
        } else {
            $t = new SimpleSAML_XHTML_Template($config, 'error.php', 'errors');
            $t->data = array_merge($t->data, $data);
            $t->data['dictTitleTranslated'] = $t->getTranslator()->t($t->data['dictTitle']);
            $t->data['dictDescrTranslated'] = $t->getTranslator()->t($t->data['dictDescr'], $t->data['parameters']);
            $t->show();
        }
 
        exit;
    }

References $attributes, $authority, $config, $data, $dictDescr, $dictTitle, $errorCode, $includeTemplate, $module, $parameters, $session, $t, exit, SimpleSAML\Utils\HTTP\getBaseURL(), SimpleSAML_Configuration\getInstance(), SimpleSAML_Session\getSessionFromRequest(), SimpleSAML_Error_Exception\logError(), saveError(), and setHTTPCode().

Here is the call graph for this function:

Field Documentation

$dictDescr

SimpleSAML_Error_Error::$dictDescr

private

Definition at line 38 of file Error.php.

Referenced by getDictDescr(), and show().

$dictTitle

SimpleSAML_Error_Error::$dictTitle

private

Definition at line 31 of file Error.php.

Referenced by getDictTitle(), and show().

$errorCode

SimpleSAML_Error_Error::$errorCode

private

Definition at line 17 of file Error.php.

Referenced by __construct(), getErrorCode(), and show().

$httpCode

SimpleSAML_Error_Error::$httpCode = 500

protected

Definition at line 24 of file Error.php.

Referenced by __construct(), and setHTTPCode().

$includeTemplate

SimpleSAML_Error_Error::$includeTemplate = null

protected

Definition at line 59 of file Error.php.

Referenced by show().

$module

SimpleSAML_Error_Error::$module = null

private

Definition at line 45 of file Error.php.

Referenced by show().

$parameters

SimpleSAML_Error_Error::$parameters

private

Definition at line 52 of file Error.php.

Referenced by getParameters(), and show().

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/simplesamlphp/simplesamlphp/lib/SimpleSAML/Error/Error.php