ilDelegatingHandler Class Reference

A Whoops error handler that delegates calls on it self to another handler that is created only in the case an error is thrown. More...

Inheritance diagram for ilDelegatingHandler:

Collaboration diagram for ilDelegatingHandler:

Public Member Functions
	__construct (private readonly ilErrorHandling $error_handling, private readonly array $sensitive_data=[])
	handle ()
	Last missing method from HandlerInterface. More...
	contentType ()
	This is an implicit interface method of the Whoops handlers. More...

Private Member Functions
	hideSensitiveData (array $key_value_pairs)

Private Attributes
HandlerInterface	$current_handler = null

Detailed Description

A Whoops error handler that delegates calls on it self to another handler that is created only in the case an error is thrown.

This is necessary to make it possible to use another handler when the DEVMODE is activated. During the Init-Dance (see ilInitialisation), the error handling is initialized before the client ini file is read and the DEVMODE is determined. Thus we can't initialize a handler based on the DEVMODE and need this workaround. This class is not ment to be extended, as the definition of error handlers should be handled in one place in ilErrorHandling, so this class acts rather dump and asks ilErrorHandling for a handler.

Author

Richard Klees richa.nosp@m.rd.k.nosp@m.lees@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de

Definition at line 35 of file class.ilDelegatingHandler.php.

Constructor & Destructor Documentation

__construct()

ilDelegatingHandler::__construct	(	private readonly ilErrorHandling	$error_handling,
		private readonly array	$sensitive_data = []
	)

Parameters

list<string>

$sensitive_data

Definition at line 42 of file class.ilDelegatingHandler.php.

      {
    }

Member Function Documentation

contentType()

ilDelegatingHandler::contentType

(

)

This is an implicit interface method of the Whoops handlers.

See also

: ::handleException

Definition at line 113 of file class.ilDelegatingHandler.php.

References null.

                                 : ?string
    {
        if ($this->current_handler === null ||
            !method_exists($this->current_handler, 'contentType')) {
            return null;
        }

        return $this->current_handler->contentType();
    }

handle()

ilDelegatingHandler::handle

(

)

Last missing method from HandlerInterface.

Asks ilErrorHandling for the appropriate Handler and delegates it's tasks to that handler. PhpCastIsUnnecessaryInspection

Definition at line 86 of file class.ilDelegatingHandler.php.

References $_COOKIE, $_GET, $_SERVER, and hideSensitiveData().

                            : ?int
    {
        if (defined("IL_INITIAL_WD")) {
            chdir(IL_INITIAL_WD);
        }

        /* We must cast the superglobals back to normal arrays since the error handler needs them. They were replaced by
           SuperGlobalDropInReplacement . The keys contain NULL bytes, so accessing values directly by key is not
           really possible */
        $_GET = $this->hideSensitiveData((array) $_GET);
        $_POST = $this->hideSensitiveData((array) $_POST);
        $_COOKIE = $this->hideSensitiveData((array) $_COOKIE);
        $_REQUEST = $this->hideSensitiveData((array) $_REQUEST);

        $_SERVER = $this->hideSensitiveData($_SERVER);

        $this->current_handler = $this->error_handling->getHandler();
        $this->current_handler->setRun($this->getRun());
        $this->current_handler->setException($this->getException());
        $this->current_handler->setInspector($this->getInspector());
        return $this->current_handler->handle();
    }

Here is the call graph for this function:

hideSensitiveData()

ilDelegatingHandler::hideSensitiveData ( array  $key_value_pairs )

private

Definition at line 48 of file class.ilDelegatingHandler.php.

Referenced by handle().

                                                              : array
    {
        foreach ($key_value_pairs as $key => &$value) {
            if (is_array($value)) {
                $value = $this->hideSensitiveData($value);
            }

            if (is_string($value) && in_array($key, $this->sensitive_data, true)) {
                $value = 'REMOVED FOR SECURITY';
            }

            if ($key === 'PHPSESSID' && is_string($value)) {
                $value = substr($value, 0, 5) . ' (SHORTENED FOR SECURITY)';
            }

            if ($key === 'HTTP_COOKIE') {
                $cookie_content = explode(';', $value);
                foreach ($cookie_content as &$cookie_pair_string) {
                    $cookie_pair = explode('=', $cookie_pair_string);
                    if (trim($cookie_pair[0]) === session_name()) {
                        $cookie_pair[1] = substr($cookie_pair[1], 0, 5) . ' (SHORTENED FOR SECURITY)';
                        $cookie_pair_string = implode('=', $cookie_pair);
                    }
                }
                $value = implode(';', $cookie_content);
            }
        }

        return $key_value_pairs;
    }

Here is the caller graph for this function:

Field Documentation

$current_handler

HandlerInterface ilDelegatingHandler::$current_handler = null

private

Definition at line 37 of file class.ilDelegatingHandler.php.

---

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

• components/ILIAS/Init/classes/ErrorHandling/class.ilDelegatingHandler.php