summaryrefslogtreecommitdiff
path: root/www/wiki/extensions/SemanticMediaWiki/src/Maintenance/ExceptionFileLogger.php
blob: 4530e49f10ebc43a1d582777b1c47631bce996ae (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
<?php

namespace SMW\Maintenance;

use Exception;
use SMW\Options;
use SMW\Utils\File;

/**
 * @private
 *
 * @license GNU GPL v2+
 * @since 2.4
 *
 * @author mwjames
 */
class ExceptionFileLogger {

	/**
	 * @var string
	 */
	private $namespace;

	/**
	 * @var File
	 */
	private $file;

	/**
	 * @var string
	 */
	private $exceptionFile;

	/**
	 * @var integer
	 */
	private $exceptionCount = 0;

	/**
	 * @var array
	 */
	private $exceptionLogMessages = [];

	/**
	 * @since 2.4
	 *
	 * @param string $namespace
	 * @param File|null $file
	 */
	public function __construct( $namespace = 'smw', File $file = null ) {
		$this->namespace = $namespace;
		$this->file = $file;

		if ( $this->file === null ) {
			$this->file = new File();
		}
	}

	/**
	 * @since 2.4
	 *
	 * @param Options $options
	 */
	public function setOptions( Options $options ) {

		$dateTimeUtc = new \DateTime( 'now', new \DateTimeZone( 'UTC' ) );
		$this->exceptionFile = __DIR__ . "../../../";

		if ( $options->has( 'exception-log' ) ) {
			$this->exceptionFile = $options->get( 'exception-log' );
		}

		$this->exceptionFile .= $this->namespace . "-exceptions-" . $dateTimeUtc->format( 'Y-m-d' ) . ".log";
	}

	/**
	 * @since 2.4
	 *
	 * @return string
	 */
	public function getExceptionFile() {
		return realpath( $this->exceptionFile );
	}

	/**
	 * @since 2.4
	 *
	 * @return integer
	 */
	public function getExceptionCount() {
		return $this->exceptionCount;
	}

	/**
	 * @since 2.4
	 *
	 * @param string $id
	 * @param Exception $exception
	 */
	public function recordException( $id, Exception $exception ) {
		$this->exceptionCount++;

		$this->exceptionLogMessages[$id] = [
			'msg' => $exception->getMessage(),
			'trace' => $exception->getTraceAsString()
		];
	}

	/**
	 * @since 3.0
	 */
	public function doWrite() {

		foreach ( $this->exceptionLogMessages as $id => $exception ) {
			$this->put( $id, $exception );
		}

		$this->exceptionLogMessages = [];
		$this->exceptionCount = 0;
	}

	private function put( $id, $exception ) {

		$text = "\n======== EXCEPTION ======\n" .
			"$id | " . $exception['msg'] . "\n\n" .
			$exception['trace'] . "\n" .
			"======== END ======" ."\n";

		$this->file->write( $this->exceptionFile, $text, FILE_APPEND );
	}

}