MediaWiki REL1_31
WebInstallerOutput.php
Go to the documentation of this file.
1<?php
36
42 public $parent;
43
48 private $contents = '';
49
54 private $headerDone = false;
55
60
67 public $allowFrames = false;
68
73 private $useShortHeader = false;
74
78 public function __construct( WebInstaller $parent ) {
79 $this->parent = $parent;
80 }
81
85 public function addHTML( $html ) {
86 $this->contents .= $html;
87 $this->flush();
88 }
89
93 public function addWikiText( $text ) {
94 $this->addHTML( $this->parent->parse( $text ) );
95 }
96
100 public function addHTMLNoFlush( $html ) {
101 $this->contents .= $html;
102 }
103
109 public function redirect( $url ) {
110 if ( $this->headerDone ) {
111 throw new MWException( __METHOD__ . ' called after sending headers' );
112 }
113 $this->redirectTarget = $url;
114 }
115
116 public function output() {
117 $this->flush();
118
119 if ( !$this->redirectTarget ) {
120 $this->outputFooter();
121 }
122 }
123
129 public function getCSS() {
130 global $wgStyleDirectory;
131
132 $moduleNames = [
133 // See SkinTemplate::setupSkinUserCss
134 'mediawiki.legacy.shared',
135 // See Vector::setupSkinUserCss
136 'mediawiki.skinning.interface',
137 ];
138
140
141 if ( file_exists( "$wgStyleDirectory/Vector/skin.json" ) ) {
142 // Force loading Vector skin if available as a fallback skin
143 // for whatever ResourceLoader wants to have as the default.
144 $registry = new ExtensionRegistry();
145 $data = $registry->readFromQueue( [
146 "$wgStyleDirectory/Vector/skin.json" => 1,
147 ] );
148 if ( isset( $data['globals']['wgResourceModules'] ) ) {
149 $resourceLoader->register( $data['globals']['wgResourceModules'] );
150 }
151
152 $moduleNames[] = 'skins.vector.styles';
153 }
154
155 $moduleNames[] = 'mediawiki.legacy.config';
156
157 $rlContext = new ResourceLoaderContext( $resourceLoader, new FauxRequest( [
158 'debug' => 'true',
159 'lang' => $this->getLanguageCode(),
160 'only' => 'styles',
161 ] ) );
162
163 $styles = [];
164 foreach ( $moduleNames as $moduleName ) {
166 $module = $resourceLoader->getModule( $moduleName );
167 if ( !$module ) {
168 // T98043: Don't fatal, but it won't look as pretty.
169 continue;
170 }
171
172 // Based on: ResourceLoaderFileModule::getStyles (without the DB query)
173 $styles = array_merge( $styles, ResourceLoader::makeCombinedStyles(
174 $module->readStyleFiles(
175 $module->getStyleFiles( $rlContext ),
176 $module->getFlip( $rlContext ),
177 $rlContext
178 ) ) );
179 }
180
181 return implode( "\n", $styles );
182 }
183
189 private function getCssUrl() {
190 return Html::linkedStyle( $_SERVER['PHP_SELF'] . '?css=1' );
191 }
192
193 public function useShortHeader( $use = true ) {
194 $this->useShortHeader = $use;
195 }
196
197 public function allowFrames( $allow = true ) {
198 $this->allowFrames = $allow;
199 }
200
201 public function flush() {
202 if ( !$this->headerDone ) {
203 $this->outputHeader();
204 }
205 if ( !$this->redirectTarget && strlen( $this->contents ) ) {
206 echo $this->contents;
207 flush();
208 $this->contents = '';
209 }
210 }
211
215 public function getDir() {
216 global $wgLang;
217
218 return is_object( $wgLang ) ? $wgLang->getDir() : 'ltr';
219 }
220
224 public function getLanguageCode() {
225 global $wgLang;
226
227 return is_object( $wgLang ) ? $wgLang->getCode() : 'en';
228 }
229
233 public function getHeadAttribs() {
234 return [
235 'dir' => $this->getDir(),
236 'lang' => LanguageCode::bcp47( $this->getLanguageCode() ),
237 ];
238 }
239
245 public function headerDone() {
246 return $this->headerDone;
247 }
248
249 public function outputHeader() {
250 $this->headerDone = true;
251 $this->parent->request->response()->header( 'Content-Type: text/html; charset=utf-8' );
252
253 if ( !$this->allowFrames ) {
254 $this->parent->request->response()->header( 'X-Frame-Options: DENY' );
255 }
256
257 if ( $this->redirectTarget ) {
258 $this->parent->request->response()->header( 'Location: ' . $this->redirectTarget );
259
260 return;
261 }
262
263 if ( $this->useShortHeader ) {
264 $this->outputShortHeader();
265
266 return;
267 }
268?>
269<?php echo Html::htmlHeader( $this->getHeadAttribs() ); ?>
270
271<head>
272 <meta name="robots" content="noindex, nofollow" />
273 <meta http-equiv="Content-type" content="text/html; charset=utf-8" />
274 <title><?php $this->outputTitle(); ?></title>
275 <?php echo $this->getCssUrl() . "\n"; ?>
276 <?php echo $this->getJQuery() . "\n"; ?>
277 <?php echo Html::linkedScript( 'config.js' ) . "\n"; ?>
278</head>
279
280<?php echo Html::openElement( 'body', [ 'class' => $this->getDir() ] ) . "\n"; ?>
281<div id="mw-page-base"></div>
282<div id="mw-head-base"></div>
283<div id="content" class="mw-body">
284<div id="bodyContent" class="mw-body-content">
285
286<h1><?php $this->outputTitle(); ?></h1>
287<?php
288 }
289
290 public function outputFooter() {
291 if ( $this->useShortHeader ) {
292 echo Html::closeElement( 'body' ) . Html::closeElement( 'html' );
293
294 return;
295 }
296?>
297
298</div></div>
299
300<div id="mw-panel">
301 <div class="portal" id="p-logo">
302 <a style="background-image: url(images/installer-logo.png);"
303 href="https://www.mediawiki.org/"
304 title="Main Page"></a>
305 </div>
306<?php
307 $message = wfMessage( 'config-sidebar' )->plain();
308 foreach ( explode( '----', $message ) as $section ) {
309 echo '<div class="portal"><div class="body">';
310 echo $this->parent->parse( $section, true );
311 echo '</div></div>';
312 }
313?>
314</div>
315
316<?php
317 echo Html::closeElement( 'body' ) . Html::closeElement( 'html' );
318 }
319
320 public function outputShortHeader() {
321?>
322<?php echo Html::htmlHeader( $this->getHeadAttribs() ); ?>
323<head>
324 <meta http-equiv="Content-type" content="text/html; charset=utf-8" />
325 <meta name="robots" content="noindex, nofollow" />
326 <title><?php $this->outputTitle(); ?></title>
327 <?php echo $this->getCssUrl() . "\n"; ?>
328 <?php echo $this->getJQuery(); ?>
329 <?php echo Html::linkedScript( 'config.js' ); ?>
330</head>
331
332<body style="background-image: none">
333<?php
334 }
335
336 public function outputTitle() {
337 global $wgVersion;
338 echo wfMessage( 'config-title', $wgVersion )->escaped();
339 }
340
344 public function getJQuery() {
345 return Html::linkedScript( "../resources/lib/jquery/jquery.js" );
346 }
347
348}
Apache License January http
shown</td >< td > a href
$wgStyleDirectory
Filesystem stylesheets directory.
$wgVersion
MediaWiki version number.
ExtensionRegistry class.
WebRequest clone which takes values from a provided array.
MediaWiki exception.
Object passed around to modules which contains information about the state of a specific loader reque...
Dynamic JavaScript and CSS resource loading system.
static makeCombinedStyles(array $stylePairs)
Combines an associative array mapping media type to CSS into a single stylesheet with "@media" blocks...
Output class modelled on OutputPage.
bool $useShortHeader
Whether to use the limited header (used during CC license callbacks)
__construct(WebInstaller $parent)
string $contents
Buffered contents that haven't been output yet.
getCssUrl()
"<link>" to index.php?css=1 for the "<head>"
getCSS()
Get the stylesheet of the MediaWiki skin.
bool $allowFrames
Does the current page need to allow being used as a frame? If not, X-Frame-Options will be output to ...
WebInstaller $parent
The WebInstaller object this WebInstallerOutput is used by.
bool $headerDone
Has the header (or short header) been output?
headerDone()
Get whether the header has been output.
Class for the core installer web interface.
Some information about database access in MediaWiki By Tim January Database layout For information about the MediaWiki database such as a description of the tables and their contents
Definition database.txt:9
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as $wgLang
Definition design.txt:56
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt;div ...>$1&lt;/div>"). - flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException':Called before an exception(or PHP error) is logged. This is meant for integration with external error aggregation services
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses & $html
Definition hooks.txt:2013
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext such as when responding to a resource loader request or generating HTML output & $resourceLoader
Definition hooks.txt:2818
> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) name
Definition hooks.txt:1840
usually copyright or history_copyright This message must be in HTML not wikitext if the section is included from a template $section
Definition hooks.txt:3022
Bar style