b4dc368f72
In theory PHP should use coerce objects with a __toString method to string when passing them to a method which has a string-typed argument, but with the native Exception class this doesn't seem to be working, so cast explicitly. Bug: T388171 Change-Id: I310b97164877445837babed2a4c47795f1c2c277 (cherry picked from commit a14ef848f758612ac9d4e8c881ecdbbccf3e1158)
140 lines
3.6 KiB
PHP
140 lines
3.6 KiB
PHP
<?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";
|
|
}
|
|
}
|