ilPlainTextHandler Class Reference

A Whoops error handler that prints the same content as the PrettyPageHandler but as plain text. More...

Inheritance diagram for ilPlainTextHandler:

Collaboration diagram for ilPlainTextHandler:

Public Member Functions
	withExclusionList (array $exclusion_list)
	generateResponse ()

Protected Member Functions
	getSimpleExceptionOutput (Throwable $exception)
	getPlainTextExceptionOutput (bool $with_previous=true)
	Get a short info about the exception. More...
	tablesContent ()
	Get the header for the page. More...
	tables ()
	Get the tables that should be rendered. More...

Protected Attributes
const	KEY_SPACE = 25

Private Member Functions
	stripNullBytes (string $ret)
	hideSensitiveData (array $super_global)
	shortenPHPSessionId (array $server)

Private Attributes
array	$exclusion_list = []

Detailed Description

A Whoops error handler that prints the same content as the PrettyPageHandler but as plain text.

This is used for better coexistence with xdebug, see #16627.

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 28 of file class.ilPlainTextHandler.php.

Member Function Documentation

generateResponse()

ilPlainTextHandler::generateResponse

(

)

Definition at line 50 of file class.ilPlainTextHandler.php.

References getPlainTextExceptionOutput(), and tablesContent().

                                      : string
    {
        return $this->getPlainTextExceptionOutput() . $this->tablesContent() . "\n";
    }

Here is the call graph for this function:

getPlainTextExceptionOutput()

ilPlainTextHandler::getPlainTextExceptionOutput ( bool  $with_previous = true )

protected

Get a short info about the exception.

Definition at line 69 of file class.ilPlainTextHandler.php.

References $message, and getSimpleExceptionOutput().

Referenced by ilTestingHandler\generateResponse(), and generateResponse().

                                                                              : string
    {
        $message = Formatter::formatExceptionPlain($this->getInspector());

        if ($with_previous) {
            $exception = $this->getInspector()->getException();
            $previous = $exception->getPrevious();
            while ($previous) {
                $message .= "\n\nCaused by\n" . $this->getSimpleExceptionOutput($previous);
                $previous = $previous->getPrevious();
            }
        }

        return $message;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSimpleExceptionOutput()

ilPlainTextHandler::getSimpleExceptionOutput ( Throwable  $exception )

protected

Definition at line 55 of file class.ilPlainTextHandler.php.

Referenced by getPlainTextExceptionOutput().

                                                                     : string
    {
        return sprintf(
            '%s: %s in file %s on line %d',
            get_class($exception),
            $exception->getMessage(),
            $exception->getFile(),
            $exception->getLine()
        );
    }

Here is the caller graph for this function:

hideSensitiveData()

ilPlainTextHandler::hideSensitiveData ( array  $super_global )

private

Parameters

array<string,mixed>

$super_global

Returns

array<string, mixed>

Definition at line 152 of file class.ilPlainTextHandler.php.

Referenced by tables().

                                                           : array
    {
        foreach ($this->exclusion_list as $parameter) {
            if (isset($super_global[$parameter])) {
                $super_global[$parameter] = 'REMOVED FOR SECURITY';
            }

            if (isset($super_global['post_vars'][$parameter])) {
                $super_global['post_vars'][$parameter] = 'REMOVED FOR SECURITY';
            }
        }

        return $super_global;
    }

Here is the caller graph for this function:

shortenPHPSessionId()

ilPlainTextHandler::shortenPHPSessionId ( array  $server )

private

Parameters

array<string,mixed>

$server

Returns

array<string, mixed>

Definition at line 171 of file class.ilPlainTextHandler.php.

References $server.

Referenced by tables().

                                                       : array
    {
        $cookie_content = $server['HTTP_COOKIE'];
        $cookie_content = explode(';', $cookie_content);

        foreach ($cookie_content as $key => $content) {
            $content_array = explode('=', $content);
            if (trim($content_array[0]) === session_name()) {
                $content_array[1] = substr($content_array[1], 0, 5) . ' (SHORTENED FOR SECURITY)';
                $cookie_content[$key] = implode('=', $content_array);
            }
        }

        $server['HTTP_COOKIE'] = implode(';', $cookie_content);

        return $server;
    }

Here is the caller graph for this function:

stripNullBytes()

ilPlainTextHandler::stripNullBytes ( string  $ret )

private

Definition at line 45 of file class.ilPlainTextHandler.php.

Referenced by tablesContent().

                                                : string
    {
        return str_replace("\0", '', $ret);
    }

Here is the caller graph for this function:

tables()

ilPlainTextHandler::tables ( )

protected

Get the tables that should be rendered.

Definition at line 128 of file class.ilPlainTextHandler.php.

References $_COOKIE, $_GET, $_SERVER, $post, $server, hideSensitiveData(), and shortenPHPSessionId().

Referenced by tablesContent().

                               : array
    {
        $post = $_POST;
        $server = $_SERVER;

        $post = $this->hideSensitiveData($post);
        $server = $this->hideSensitiveData($server);
        $server = $this->shortenPHPSessionId($server);

        return [
            'GET Data' => $_GET,
            'POST Data' => $post,
            'Files' => $_FILES,
            'Cookies' => $_COOKIE,
            'Session' => $_SESSION ?? [],
            'Server/Request Data' => $server,
            'Environment Variables' => $_ENV,
        ];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

tablesContent()

ilPlainTextHandler::tablesContent ( )

protected

Get the header for the page.

Definition at line 88 of file class.ilPlainTextHandler.php.

References stripNullBytes(), and tables().

Referenced by generateResponse().

                                      : string
    {
        $ret = '';
        foreach ($this->tables() as $title => $content) {
            $ret .= "\n\n-- $title --\n\n";
            if (count($content) > 0) {
                foreach ($content as $key => $value) {
                    $key = str_pad((string) $key, self::KEY_SPACE);

                    // indent multiline values, first print_r, split in lines,
                    // indent all but first line, then implode again.
                    $first = true;
                    $indentation = str_pad('', self::KEY_SPACE);
                    $value = implode(
                        "\n",
                        array_map(
                            static function ($line) use (&$first, $indentation): string {
                                if ($first) {
                                    $first = false;
                                    return $line;
                                }
                                return $indentation . $line;
                            },
                            explode("\n", print_r($value, true))
                        )
                    );

                    $ret .= "$key: $value\n";
                }
            } else {
                $ret .= "empty\n";
            }
        }

        return $this->stripNullBytes($ret);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

withExclusionList()

ilPlainTextHandler::withExclusionList

(

array

$exclusion_list

)

Parameters

list<string>

$exclusion_list

Definition at line 38 of file class.ilPlainTextHandler.php.

References $exclusion_list.

                                                            : self
    {
        $clone = clone $this;
        $clone->exclusion_list = $exclusion_list;
        return $clone;
    }

Field Documentation

$exclusion_list

array ilPlainTextHandler::$exclusion_list = []

private

Definition at line 33 of file class.ilPlainTextHandler.php.

Referenced by withExclusionList().

KEY_SPACE

const ilPlainTextHandler::KEY_SPACE = 25

protected

Definition at line 30 of file class.ilPlainTextHandler.php.

---

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

• components/ILIAS/Exceptions/classes/class.ilPlainTextHandler.php