Saves error informations into file. More...

Collaboration diagram for ilLoggingErrorFileStorage:

Public Member Functions
	__construct ($inspector, $file_path, $file_name)

	write ()

Data Fields
const	KEY_SPACE = 25

const	FILE_FORMAT = ".log"

Protected Member Functions
	createDir ($path)

	content ()

	pageHeader ()
	Get the header for the page. More...

	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...

Private Member Functions
	hidePassword (array $post)
	Replace passwort from post array with security message. More...

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

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

Constructor & Destructor Documentation

◆ __construct()

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

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

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

Member Function Documentation

◆ content()

ilLoggingErrorFileStorage::content ( )

protected

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

References pageHeader().

Referenced by write().

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

protected

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

References ilUtil\makeDirParents().

Referenced by write().

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

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.

Returns: string

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

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

◆ hidePassword()

ilLoggingErrorFileStorage::hidePassword ( array $post )

private

Replace passwort from post array with security message.

Parameters

array $post

Returns: array

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

Referenced by tables().

                                                    {
                 if(isset($post["password"])) {
                         $post["password"] = "REMOVED FOR SECURITY";
                 }
 
                 return $post;
         }

Here is the caller graph for this function:

◆ pageHeader()

ilLoggingErrorFileStorage::pageHeader ( )

protected

Get the header for the page.

Returns: string

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

Referenced by content().

                                         {
                 return "";
         }

Here is the caller graph for this function:

◆ shortenPHPSessionId()

ilLoggingErrorFileStorage::shortenPHPSessionId ( array $server )

private

Shorts the php session id.

Parameters

array $server

Returns: array

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

References $ilLog, and $server.

Referenced by tables().

                                                             {
                 global $ilLog;
 
                 $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:

◆ tables()

ilLoggingErrorFileStorage::tables ( )

protected

Get the tables that should be rendered.

Returns: array $title => $table

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

References $_COOKIE, $_GET, $_POST, $_SERVER, $_SESSION, $server, array, hidePassword(), and shortenPHPSessionId().

Referenced by tablesContent().

                                     {
                 $post = $_POST;
                 $server = $_SERVER;
 
                 $post = $this->hidePassword($post);
                 $server = $this->shortenPHPSessionId($server);
 
                 return array
                         ( "GET Data" => $_GET
                         , "POST Data" => $post
                         , "Files" => $_FILES
                         , "Cookies" => $_COOKIE
                         , "Session" => isset($_SESSION) ? $_SESSION : array()
                         , "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

Get the header for the page.

Returns: string

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

References $ret, $title, and tables().

                                            {
                 $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($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;
         }

Here is the call graph for this function:

◆ write()

ilLoggingErrorFileStorage::write ( )

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

References content(), and createDir().

Referenced by ilErrorHandling\defaultHandler().

                                 {
                 $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);
         }