MediaWiki REL1_28
HttpError.php
Go to the documentation of this file.
1<?php
21use MediaWiki\Logger\LoggerFactory;
22
30class HttpError extends MWException {
31 private $httpCode, $header, $content;
32
40 public function __construct( $httpCode, $content, $header = null ) {
41 parent::__construct( $content );
42 $this->httpCode = (int)$httpCode;
43 $this->header = $header;
44 $this->content = $content;
45 }
46
56 public function isLoggable() {
57 return false;
58 }
59
65 public function getStatusCode() {
66 return $this->httpCode;
67 }
68
74 public function report() {
75 $this->doLog();
76
77 HttpStatus::header( $this->httpCode );
78 header( 'Content-type: text/html; charset=utf-8' );
79
80 print $this->getHTML();
81 }
82
83 private function doLog() {
84 $logger = LoggerFactory::getInstance( 'HttpError' );
85 $content = $this->content;
86
87 if ( $content instanceof Message ) {
88 $content = $content->text();
89 }
90
91 $context = [
92 'file' => $this->getFile(),
93 'line' => $this->getLine(),
94 'http_code' => $this->httpCode,
95 ];
96
97 $logMsg = "$content ({http_code}) from {file}:{line}";
98
99 if ( $this->getStatusCode() < 500 ) {
100 $logger->info( $logMsg, $context );
101 } else {
102 $logger->error( $logMsg, $context );
103 }
104 }
105
112 public function getHTML() {
113 if ( $this->header === null ) {
114 $titleHtml = htmlspecialchars( HttpStatus::getMessage( $this->httpCode ) );
115 } elseif ( $this->header instanceof Message ) {
116 $titleHtml = $this->header->escaped();
117 } else {
118 $titleHtml = htmlspecialchars( $this->header );
119 }
120
121 if ( $this->content instanceof Message ) {
122 $contentHtml = $this->content->escaped();
123 } else {
124 $contentHtml = nl2br( htmlspecialchars( $this->content ) );
125 }
126
127 return "<!DOCTYPE html>\n" .
128 "<html><head><title>$titleHtml</title></head>\n" .
129 "<body><h1>$titleHtml</h1><p>$contentHtml</p></body></html>\n";
130 }
131}
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition APACHE-LICENSE-2.0.txt:10
HttpError
Show an error that looks like an HTTP server error.
Definition HttpError.php:30
HttpError\report
report()
Report and log the HTTP error.
Definition HttpError.php:74
HttpError\getStatusCode
getStatusCode()
Returns the HTTP status code supplied to the constructor.
Definition HttpError.php:65
HttpError\__construct
__construct( $httpCode, $content, $header=null)
Constructor.
Definition HttpError.php:40
HttpError\isLoggable
isLoggable()
We don't want the default exception logging as we got our own logging set up in self::report.
Definition HttpError.php:56
HttpError\getHTML
getHTML()
Returns HTML for reporting the HTTP error.
Definition HttpError.php:112
HttpStatus\header
static header( $code)
Output an HTTP status code header.
Definition HttpStatus.php:96
HttpStatus\getMessage
static getMessage( $code)
Get the message associated with an HTTP response status code.
Definition HttpStatus.php:34
MWException
MediaWiki exception.
Definition MWException.php:26
MWException\header
static header( $header)
Send a header, if we haven't already sent them.
Definition MWException.php:241
MediaWiki\Logger\LoggerFactory
PSR-3 logger instance factory.
Definition LoggerFactory.php:46
Message
The Message class provides methods which fulfil two basic services:
Definition Message.php:159
content
per default it will return the text for text based content
Definition contenthandler.txt:108
print
while(( $__line=Maintenance::readconsole()) !==false) print
Definition eval.php:64
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37
$context
$context
Definition load.php:50