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
133
134
135
136
137
138
139
140
|
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
use MediaWiki\Logger\LoggerFactory;
use MediaWiki\Message\Message;
/**
* Show an error that looks like an HTTP server error.
* Replacement for wfHttpError().
*
* @newable
* @stable to extend
* @since 1.19
* @ingroup Exception
*/
class HttpError extends MWException {
/** @var int */
private $httpCode;
/** @var string|Message|null */
private $header;
/** @var string|Message */
private $content;
/**
* @stable to call
* @param int $httpCode HTTP status code to send to the client
* @param string|Message $content Content of the message
* @param string|Message|null $header Content of the header (\<title\> and \<h1\>)
* @param-taint $content tainted
* @param-taint $header tainted
*/
public function __construct( $httpCode, $content, $header = null ) {
parent::__construct( (string)$content );
$this->httpCode = (int)$httpCode;
$this->header = $header;
$this->content = $content;
}
/**
* We don't want the default exception logging as we got our own logging set
* up in self::report.
*
* @see MWException::isLoggable
*
* @since 1.24
* @return bool
*/
public function isLoggable() {
return false;
}
/**
* Returns the HTTP status code supplied to the constructor.
*
* @return int
*/
public function getStatusCode() {
return $this->httpCode;
}
/**
* Report and log the HTTP error.
* Sends the appropriate HTTP status code and outputs an
* HTML page with an error message.
*/
public function report() {
$this->doLog();
HttpStatus::header( $this->httpCode );
header( 'Content-type: text/html; charset=utf-8' );
print $this->getHTML();
}
private function doLog() {
$logger = LoggerFactory::getInstance( 'HttpError' );
$content = $this->content;
if ( $content instanceof Message ) {
$content = $content->text();
}
$context = [
'file' => $this->getFile(),
'line' => $this->getLine(),
'http_code' => $this->httpCode,
];
$logMsg = "$content ({http_code}) from {file}:{line}";
if ( $this->getStatusCode() < 500 ) {
$logger->info( $logMsg, $context );
} else {
$logger->error( $logMsg, $context );
}
}
/**
* Returns HTML for reporting the HTTP error.
* This will be a minimal but complete HTML document.
*
* @return string HTML
*/
public function getHTML() {
if ( $this->header === null ) {
$titleHtml = htmlspecialchars( HttpStatus::getMessage( $this->httpCode ) );
} elseif ( $this->header instanceof Message ) {
$titleHtml = $this->header->escaped();
} else {
$titleHtml = htmlspecialchars( $this->header );
}
if ( $this->content instanceof Message ) {
$contentHtml = $this->content->escaped();
} else {
$contentHtml = nl2br( htmlspecialchars( $this->content ) );
}
return "<!DOCTYPE html>\n" .
"<html><head><title>$titleHtml</title><meta name=\"color-scheme\" content=\"light dark\" /></head>\n" .
"<body><h1>$titleHtml</h1><p>$contentHtml</p></body></html>\n";
}
}
|
