91a920fd85
Having such comments is worse than not having them. They add zero information. But you must read the text to understand there is nothing you don't already know from the class and the method name. This is similar to I994d11e. Even more trivial, because this here is about comments that don't say anything but "constructor". Change-Id: I474dcdb5997bea3aafd11c0760ee072dfaff124c
129 lines
3.3 KiB
PHP
129 lines
3.3 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;
|
|
|
|
/**
|
|
* Show an error that looks like an HTTP server error.
|
|
* Replacement for wfHttpError().
|
|
*
|
|
* @since 1.19
|
|
* @ingroup Exception
|
|
*/
|
|
class HttpError extends MWException {
|
|
private $httpCode, $header, $content;
|
|
|
|
/**
|
|
* @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\>)
|
|
*/
|
|
public function __construct( $httpCode, $content, $header = null ) {
|
|
parent::__construct( $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></head>\n" .
|
|
"<body><h1>$titleHtml</h1><p>$contentHtml</p></body></html>\n";
|
|
}
|
|
}
|