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
22 * Show an error that looks like an HTTP server error.
23 * Replacement for wfHttpError().
28 class HttpError
extends MWException
{
29 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 $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 $httpMessage = HttpStatus
::getMessage( $this->httpCode
);
77 header( "Status: {$this->httpCode} {$httpMessage}", true, $this->httpCode
);
78 header( 'Content-type: text/html; charset=utf-8' );
80 print $this->getHTML();
83 private function doLog() {
84 $logger = MWLoggerFactory
::getInstance( 'HttpError' );
85 $content = $this->content
;
87 if ( $content instanceof Message
) {
88 $content = $content->text();
92 'file' => $this->getFile(),
93 'line' => $this->getLine(),
94 'http_code' => $this->httpCode
,
97 $logMsg = "$content ({http_code}) from {file}:{line}";
99 if ( $this->getStatusCode() < 500 ) {
100 $logger->info( $logMsg, $context );
102 $logger->error( $logMsg, $context );
107 * Returns HTML for reporting the HTTP error.
108 * This will be a minimal but complete HTML document.
110 * @return string HTML
112 public function getHTML() {
113 if ( $this->header
=== null ) {
114 $header = HttpStatus
::getMessage( $this->httpCode
);
115 } elseif ( $this->header
instanceof Message
) {
116 $header = $this->header
->escaped();
118 $header = htmlspecialchars( $this->header
);
121 if ( $this->content
instanceof Message
) {
122 $content = $this->content
->escaped();
124 $content = htmlspecialchars( $this->content
);
127 return "<!DOCTYPE html>\n" .
128 "<html><head><title>$header</title></head>\n" .
129 "<body><h1>$header</h1><p>$content</p></body></html>\n";