Saves error informations into file. More...

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 (string $path)

	content ()

	pageHeader ()

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

const	FILE_FORMAT = ".log"

Inspector	$inspector

string	$file_path

string	$file_name

Private Member Functions
	hideSensitiveData (array $super_global)

	shortenPHPSessionId (array $server)
	Shorts the php session id. More...

Private Attributes
array	$exclusion_list = []

Detailed Description

Saves error informations into file.

Author: Stefan Hecken stefa.nosp@m.n.he.nosp@m.cken@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de

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

Constructor & Destructor Documentation

◆ __construct()

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

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

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

References $file_name, $file_path, and $inspector.

Member Function Documentation

◆ content()

ilLoggingErrorFileStorage::content ( )

protected

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

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

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

Referenced by write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createDir()

ilLoggingErrorFileStorage::createDir ( string $path )

protected

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

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

References ilFileUtils\makeDirParents().

Referenced by write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exceptionContent()

ilLoggingErrorFileStorage::exceptionContent ( )

protected

Get a short info about the exception.

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

                                         : string
    {
        return Formatter::formatExceptionPlain($this->inspector);
    }

Referenced by content().

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 153 of file class.ilLoggingErrorFileStorage.php.

                                                           : 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;
    }

Referenced by tables().

Here is the caller graph for this function:

◆ pageHeader()

ilLoggingErrorFileStorage::pageHeader ( )

protected

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

                                   : string
    {
        return "";
    }

Referenced by content().

Here is the caller graph for this function:

◆ shortenPHPSessionId()

ilLoggingErrorFileStorage::shortenPHPSessionId ( array $server )

private

Shorts the php session id.

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

                                                       : 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;
    }

References ILIAS\LTI\ToolProvider\$key, and $server.

Referenced by tables().

Here is the caller graph for this function:

◆ tables()

ilLoggingErrorFileStorage::tables ( )

protected

Get the tables that should be rendered.

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

                               : array
    {
        $post = $_POST;
        $server = $_SERVER;
 
        $post = $this->hideSensitiveData($post);
        $server = $this->hideSensitiveData($server);
        $server = $this->shortenPHPSessionId($server);
 
        return array( "GET Data" => $_GET
            , "POST Data" => $post
            , "Files" => $_FILES
            , "Cookies" => $_COOKIE
            , "Session" => $_SESSION ?? array()
            , "Server/Request Data" => $server
            , "Environment Variables" => $_ENV
            );
    }

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

Referenced by tablesContent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ tablesContent()

ilLoggingErrorFileStorage::tablesContent ( )

protected

Get the header for the page.

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

                                      : 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(function ($line) use (&$first, $indentation) {
                        if ($first) {
                            $first = false;
                            return $line;
                        }
                        return $indentation . $line;
                    }, explode("\n", print_r($value, true))));
 
                    $ret .= "$key: $value\n";
                }
            } else {
                $ret .= "empty\n";
            }
        }
        return $ret;
    }

References ILIAS\LTI\ToolProvider\$key, and tables().

Referenced by content().

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 48 of file class.ilLoggingErrorFileStorage.php.

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

References $exclusion_list.

◆ write()

ilLoggingErrorFileStorage::write ( )

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

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