3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 * http://www.gnu.org/copyleft/gpl.html
21 use MediaWiki\Logger\LoggerFactory
;
24 * Show an error that looks like an HTTP server error.
25 * Replacement for wfHttpError().
30 class HttpError
extends MWException
{
31 private $httpCode, $header, $content;
34 * @param int $httpCode HTTP status code to send to the client
35 * @param string|Message $content Content of the message
36 * @param string|Message|null $header Content of the header (\<title\> and \<h1\>)
38 public function __construct( $httpCode, $content, $header = null ) {
39 parent
::__construct( $content );
40 $this->httpCode
= (int)$httpCode;
41 $this->header
= $header;
42 $this->content
= $content;
46 * We don't want the default exception logging as we got our own logging set
49 * @see MWException::isLoggable
54 public function isLoggable() {
59 * Returns the HTTP status code supplied to the constructor.
63 public function getStatusCode() {
64 return $this->httpCode
;
68 * Report and log the HTTP error.
69 * Sends the appropriate HTTP status code and outputs an
70 * HTML page with an error message.
72 public function report() {
75 HttpStatus
::header( $this->httpCode
);
76 header( 'Content-type: text/html; charset=utf-8' );
78 print $this->getHTML();
81 private function doLog() {
82 $logger = LoggerFactory
::getInstance( 'HttpError' );
83 $content = $this->content
;
85 if ( $content instanceof Message
) {
86 $content = $content->text();
90 'file' => $this->getFile(),
91 'line' => $this->getLine(),
92 'http_code' => $this->httpCode
,
95 $logMsg = "$content ({http_code}) from {file}:{line}";
97 if ( $this->getStatusCode() < 500 ) {
98 $logger->info( $logMsg, $context );
100 $logger->error( $logMsg, $context );
105 * Returns HTML for reporting the HTTP error.
106 * This will be a minimal but complete HTML document.
108 * @return string HTML
110 public function getHTML() {
111 if ( $this->header
=== null ) {
112 $titleHtml = htmlspecialchars( HttpStatus
::getMessage( $this->httpCode
) );
113 } elseif ( $this->header
instanceof Message
) {
114 $titleHtml = $this->header
->escaped();
116 $titleHtml = htmlspecialchars( $this->header
);
119 if ( $this->content
instanceof Message
) {
120 $contentHtml = $this->content
->escaped();
122 $contentHtml = nl2br( htmlspecialchars( $this->content
) );
125 return "<!DOCTYPE html>\n" .
126 "<html><head><title>$titleHtml</title></head>\n" .
127 "<body><h1>$titleHtml</h1><p>$contentHtml</p></body></html>\n";