ilLoggingErrorFileStorage Class Reference

Collaboration diagram for ilLoggingErrorFileStorage:

Public Member Functions
	__construct (Inspector $inspector, string $file_path, string $file_name)
	withExclusionList (array $exclusion_list)
	write ()

Protected Member Functions
	createDir ()
	content ()
	pageHeader ()
	exceptionContent ()
	tablesContent ()
	tables ()

Protected Attributes
const	KEY_SPACE = 25
const	FILE_FORMAT = '.log'
Inspector	$inspector
string	$file_path
string	$file_name

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

Private Attributes
array	$exclusion_list = []

Detailed Description

Definition at line 24 of file class.ilLoggingErrorFileStorage.php.

Constructor & Destructor Documentation

__construct()

ilLoggingErrorFileStorage::__construct	(	Inspector	$inspector,
		string	$file_path,
		string	$file_name
	)

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

References $file_name, $file_path, and $inspector.

    {
        $this->inspector = $inspector;
        $this->file_path = $file_path;
        $this->file_name = $file_name;
    }

Member Function Documentation

content()

ilLoggingErrorFileStorage::content ( )

protected

Definition at line 64 of file class.ilLoggingErrorFileStorage.php.

References exceptionContent(), pageHeader(), and tablesContent().

Referenced by write().

                                : string
    {
        return $this->pageHeader()
            . $this->exceptionContent()
            . $this->tablesContent();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createDir()

ilLoggingErrorFileStorage::createDir ( )

protected

Definition at line 57 of file class.ilLoggingErrorFileStorage.php.

References ilFileUtils\makeDirParents().

Referenced by write().

                                  : void
    {
        if (!is_dir($this->file_path)) {
            ilFileUtils::makeDirParents($this->file_path);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

exceptionContent()

ilLoggingErrorFileStorage::exceptionContent ( )

protected

Definition at line 87 of file class.ilLoggingErrorFileStorage.php.

References $message.

Referenced by content().

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

        $exception = $this->inspector->getException();
        $previous = $exception->getPrevious();
        while ($previous) {
            $message .= "\n\nCaused by\n" . sprintf(
                '%s: %s in file %s on line %d',
                get_class($previous),
                $previous->getMessage(),
                $previous->getFile(),
                $previous->getLine()
            );
            $previous = $previous->getPrevious();
        }

        return $message;
    }

Here is the caller graph for this function:

hideSensitiveData()

ilLoggingErrorFileStorage::hideSensitiveData ( array  $super_global )

private

Parameters

array<string,mixed>

$super_global

Returns

array<string, mixed>

Definition at line 162 of file class.ilLoggingErrorFileStorage.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:

pageHeader()

ilLoggingErrorFileStorage::pageHeader ( )

protected

Definition at line 82 of file class.ilLoggingErrorFileStorage.php.

Referenced by content().

                                   : string
    {
        return '';
    }

Here is the caller graph for this function:

shortenPHPSessionId()

ilLoggingErrorFileStorage::shortenPHPSessionId ( array  $server )

private

Definition at line 177 of file class.ilLoggingErrorFileStorage.php.

References $server.

Referenced by tables().

                                                       : array
    {
        if (!isset($server['HTTP_COOKIE'])) {
            return $server;
        }
        $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()

ilLoggingErrorFileStorage::stripNullBytes ( string  $ret )

private

Definition at line 52 of file class.ilLoggingErrorFileStorage.php.

Referenced by tablesContent().

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

Here is the caller graph for this function:

tables()

ilLoggingErrorFileStorage::tables ( )

protected

Definition at line 138 of file class.ilLoggingErrorFileStorage.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()

ilLoggingErrorFileStorage::tablesContent ( )

protected

Definition at line 107 of file class.ilLoggingErrorFileStorage.php.

References stripNullBytes(), and tables().

Referenced by content().

                                      : 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()

ilLoggingErrorFileStorage::withExclusionList

(

array

$exclusion_list

)

Parameters

list<string>

$exclusion_list

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

References $exclusion_list.

Referenced by ilErrorHandling\defaultHandler().

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

Here is the caller graph for this function:

write()

ilLoggingErrorFileStorage::write

(

)

Definition at line 71 of file class.ilLoggingErrorFileStorage.php.

References content(), and createDir().

Referenced by ilErrorHandling\defaultHandler().

                           : void
    {
        $this->createDir();

        $file_name = $this->file_path . '/' . $this->file_name . self::FILE_FORMAT;
        $stream = fopen($file_name, 'wb+');
        fwrite($stream, $this->content());
        fclose($stream);
        chmod($file_name, 0755);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$exclusion_list

array ilLoggingErrorFileStorage::$exclusion_list = []

private

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

Referenced by withExclusionList().

$file_name

string ilLoggingErrorFileStorage::$file_name

protected

Definition at line 31 of file class.ilLoggingErrorFileStorage.php.

Referenced by __construct().

$file_path

string ilLoggingErrorFileStorage::$file_path

protected

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

Referenced by __construct().

$inspector

Inspector ilLoggingErrorFileStorage::$inspector

protected

Definition at line 29 of file class.ilLoggingErrorFileStorage.php.

Referenced by __construct().

FILE_FORMAT

const ilLoggingErrorFileStorage::FILE_FORMAT = '.log'

protected

Definition at line 27 of file class.ilLoggingErrorFileStorage.php.

KEY_SPACE

const ilLoggingErrorFileStorage::KEY_SPACE = 25

protected

Definition at line 26 of file class.ilLoggingErrorFileStorage.php.

---

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

• components/ILIAS/Logging/classes/error/class.ilLoggingErrorFileStorage.php