includes/OutputPage.php

   1 <?php
   2 /**
   3  * Preparation for the final page rendering.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  */
  22
  23 use MediaWiki\Logger\LoggerFactory;
  24 use MediaWiki\MediaWikiServices;
  25 use MediaWiki\Session\SessionManager;
  26 use WrappedString\WrappedString;
  27 use WrappedString\WrappedStringList;
  28
  29 /**
  30  * This class should be covered by a general architecture document which does
  31  * not exist as of January 2011.  This is one of the Core classes and should
  32  * be read at least once by any new developers.
  33  *
  34  * This class is used to prepare the final rendering. A skin is then
  35  * applied to the output parameters (links, javascript, html, categories ...).
  36  *
  37  * @todo FIXME: Another class handles sending the whole page to the client.
  38  *
  39  * Some comments comes from a pairing session between Zak Greant and Antoine Musso
  40  * in November 2010.
  41  *
  42  * @todo document
  43  */
  44 class OutputPage extends ContextSource {
  45         /** @var array Should be private. Used with addMeta() which adds "<meta>" */
  46         protected $mMetatags = [];
  47
  48         /** @var array */
  49         protected $mLinktags = [];
  50
  51         /** @var bool */
  52         protected $mCanonicalUrl = false;
  53
  54         /**
  55          * @var array Additional stylesheets. Looks like this is for extensions.
  56          *   Might be replaced by ResourceLoader.
  57          */
  58         protected $mExtStyles = [];
  59
  60         /**
  61          * @var string Should be private - has getter and setter. Contains
  62          *   the HTML title */
  63         public $mPagetitle = '';
  64
  65         /**
  66          * @var string Contains all of the "<body>" content. Should be private we
  67          *   got set/get accessors and the append() method.
  68          */
  69         public $mBodytext = '';
  70
  71         /** @var string Stores contents of "<title>" tag */
  72         private $mHTMLtitle = '';
  73
  74         /**
  75          * @var bool Is the displayed content related to the source of the
  76          *   corresponding wiki article.
  77          */
  78         private $mIsarticle = false;
  79
  80         /** @var bool Stores "article flag" toggle. */
  81         private $mIsArticleRelated = true;
  82
  83         /**
  84          * @var bool We have to set isPrintable(). Some pages should
  85          * never be printed (ex: redirections).
  86          */
  87         private $mPrintable = false;
  88
  89         /**
  90          * @var array Contains the page subtitle. Special pages usually have some
  91          *   links here. Don't confuse with site subtitle added by skins.
  92          */
  93         private $mSubtitle = [];
  94
  95         /** @var string */
  96         public $mRedirect = '';
  97
  98         /** @var int */
  99         protected $mStatusCode;
 100
 101         /**
 102          * @var string Used for sending cache control.
 103          *   The whole caching system should probably be moved into its own class.
 104          */
 105         protected $mLastModified = '';
 106
 107         /** @var array */
 108         protected $mCategoryLinks = [];
 109
 110         /** @var array */
 111         protected $mCategories = [
 112                 'hidden' => [],
 113                 'normal' => [],
 114         ];
 115
 116         /** @var array */
 117         protected $mIndicators = [];
 118
 119         /** @var array Array of Interwiki Prefixed (non DB key) Titles (e.g. 'fr:Test page') */
 120         private $mLanguageLinks = [];
 121
 122         /**
 123          * Used for JavaScript (predates ResourceLoader)
 124          * @todo We should split JS / CSS.
 125          * mScripts content is inserted as is in "<head>" by Skin. This might
 126          * contain either a link to a stylesheet or inline CSS.
 127          */
 128         private $mScripts = '';
 129
 130         /** @var string Inline CSS styles. Use addInlineStyle() sparingly */
 131         protected $mInlineStyles = '';
 132
 133         /**
 134          * @var string Used by skin template.
 135          * Example: $tpl->set( 'displaytitle', $out->mPageLinkTitle );
 136          */
 137         public $mPageLinkTitle = '';
 138
 139         /** @var array Array of elements in "<head>". Parser might add its own headers! */
 140         protected $mHeadItems = [];
 141
 142         /** @var array */
 143         protected $mModules = [];
 144
 145         /** @var array */
 146         protected $mModuleScripts = [];
 147
 148         /** @var array */
 149         protected $mModuleStyles = [];
 150
 151         /** @var ResourceLoader */
 152         protected $mResourceLoader;
 153
 154         /** @var ResourceLoaderClientHtml */
 155         private $rlClient;
 156
 157         /** @var ResourceLoaderContext */
 158         private $rlClientContext;
 159
 160         /** @var string */
 161         private $rlUserModuleState;
 162
 163         /** @var array */
 164         private $rlExemptStyleModules;
 165
 166         /** @var array */
 167         protected $mJsConfigVars = [];
 168
 169         /** @var array */
 170         protected $mTemplateIds = [];
 171
 172         /** @var array */
 173         protected $mImageTimeKeys = [];
 174
 175         /** @var string */
 176         public $mRedirectCode = '';
 177
 178         protected $mFeedLinksAppendQuery = null;
 179
 180         /** @var array
 181          * What level of 'untrustworthiness' is allowed in CSS/JS modules loaded on this page?
 182          * @see ResourceLoaderModule::$origin
 183          * ResourceLoaderModule::ORIGIN_ALL is assumed unless overridden;
 184          */
 185         protected $mAllowedModules = [
 186                 ResourceLoaderModule::TYPE_COMBINED => ResourceLoaderModule::ORIGIN_ALL,
 187         ];
 188
 189         /** @var bool Whether output is disabled.  If this is true, the 'output' method will do nothing. */
 190         protected $mDoNothing = false;
 191
 192         // Parser related.
 193
 194         /** @var int */
 195         protected $mContainsNewMagic = 0;
 196
 197         /**
 198          * lazy initialised, use parserOptions()
 199          * @var ParserOptions
 200          */
 201         protected $mParserOptions = null;
 202
 203         /**
 204          * Handles the Atom / RSS links.
 205          * We probably only support Atom in 2011.
 206          * @see $wgAdvertisedFeedTypes
 207          */
 208         private $mFeedLinks = [];
 209
 210         // Gwicke work on squid caching? Roughly from 2003.
 211         protected $mEnableClientCache = true;
 212
 213         /** @var bool Flag if output should only contain the body of the article. */
 214         private $mArticleBodyOnly = false;
 215
 216         /** @var bool */
 217         protected $mNewSectionLink = false;
 218
 219         /** @var bool */
 220         protected $mHideNewSectionLink = false;
 221
 222         /**
 223          * @var bool Comes from the parser. This was probably made to load CSS/JS
 224          * only if we had "<gallery>". Used directly in CategoryPage.php.
 225          * Looks like ResourceLoader can replace this.
 226          */
 227         public $mNoGallery = false;
 228
 229         /** @var string */
 230         private $mPageTitleActionText = '';
 231
 232         /** @var int Cache stuff. Looks like mEnableClientCache */
 233         protected $mCdnMaxage = 0;
 234         /** @var int Upper limit on mCdnMaxage */
 235         protected $mCdnMaxageLimit = INF;
 236
 237         /**
 238          * @var bool Controls if anti-clickjacking / frame-breaking headers will
 239          * be sent. This should be done for pages where edit actions are possible.
 240          * Setters: $this->preventClickjacking() and $this->allowClickjacking().
 241          */
 242         protected $mPreventClickjacking = true;
 243
 244         /** @var int To include the variable {{REVISIONID}} */
 245         private $mRevisionId = null;
 246
 247         /** @var string */
 248         private $mRevisionTimestamp = null;
 249
 250         /** @var array */
 251         protected $mFileVersion = null;
 252
 253         /**
 254          * @var array An array of stylesheet filenames (relative from skins path),
 255          * with options for CSS media, IE conditions, and RTL/LTR direction.
 256          * For internal use; add settings in the skin via $this->addStyle()
 257          *
 258          * Style again! This seems like a code duplication since we already have
 259          * mStyles. This is what makes Open Source amazing.
 260          */
 261         protected $styles = [];
 262
 263         private $mIndexPolicy = 'index';
 264         private $mFollowPolicy = 'follow';
 265         private $mVaryHeader = [
 266                 'Accept-Encoding' => [ 'match=gzip' ],
 267         ];
 268
 269         /**
 270          * If the current page was reached through a redirect, $mRedirectedFrom contains the Title
 271          * of the redirect.
 272          *
 273          * @var Title
 274          */
 275         private $mRedirectedFrom = null;
 276
 277         /**
 278          * Additional key => value data
 279          */
 280         private $mProperties = [];
 281
 282         /**
 283          * @var string|null ResourceLoader target for load.php links. If null, will be omitted
 284          */
 285         private $mTarget = null;
 286
 287         /**
 288          * @var bool Whether parser output contains a table of contents
 289          */
 290         private $mEnableTOC = false;
 291
 292         /**
 293          * @var bool Whether parser output should contain section edit links
 294          */
 295         private $mEnableSectionEditLinks = true;
 296
 297         /**
 298          * @var string|null The URL to send in a <link> element with rel=license
 299          */
 300         private $copyrightUrl;
 301
 302         /** @var array Profiling data */
 303         private $limitReportJSData = [];
 304
 305         /**
 306          * Link: header contents
 307          */
 308         private $mLinkHeader = [];
 309
 310         /**
 311          * Constructor for OutputPage. This should not be called directly.
 312          * Instead a new RequestContext should be created and it will implicitly create
 313          * a OutputPage tied to that context.
 314          * @param IContextSource|null $context
 315          */
 316         function __construct( IContextSource $context = null ) {
 317                 if ( $context === null ) {
 318                         # Extensions should use `new RequestContext` instead of `new OutputPage` now.
 319                         wfDeprecated( __METHOD__, '1.18' );
 320                 } else {
 321                         $this->setContext( $context );
 322                 }
 323         }
 324
 325         /**
 326          * Redirect to $url rather than displaying the normal page
 327          *
 328          * @param string $url URL
 329          * @param string $responsecode HTTP status code
 330          */
 331         public function redirect( $url, $responsecode = '302' ) {
 332                 # Strip newlines as a paranoia check for header injection in PHP<5.1.2
 333                 $this->mRedirect = str_replace( "\n", '', $url );
 334                 $this->mRedirectCode = $responsecode;
 335         }
 336
 337         /**
 338          * Get the URL to redirect to, or an empty string if not redirect URL set
 339          *
 340          * @return string
 341          */
 342         public function getRedirect() {
 343                 return $this->mRedirect;
 344         }
 345
 346         /**
 347          * Set the copyright URL to send with the output.
 348          * Empty string to omit, null to reset.
 349          *
 350          * @since 1.26
 351          *
 352          * @param string|null $url
 353          */
 354         public function setCopyrightUrl( $url ) {
 355                 $this->copyrightUrl = $url;
 356         }
 357
 358         /**
 359          * Set the HTTP status code to send with the output.
 360          *
 361          * @param int $statusCode
 362          */
 363         public function setStatusCode( $statusCode ) {
 364                 $this->mStatusCode = $statusCode;
 365         }
 366
 367         /**
 368          * Add a new "<meta>" tag
 369          * To add an http-equiv meta tag, precede the name with "http:"
 370          *
 371          * @param string $name Tag name
 372          * @param string $val Tag value
 373          */
 374         function addMeta( $name, $val ) {
 375                 array_push( $this->mMetatags, [ $name, $val ] );
 376         }
 377
 378         /**
 379          * Returns the current <meta> tags
 380          *
 381          * @since 1.25
 382          * @return array
 383          */
 384         public function getMetaTags() {
 385                 return $this->mMetatags;
 386         }
 387
 388         /**
 389          * Add a new \<link\> tag to the page header.
 390          *
 391          * Note: use setCanonicalUrl() for rel=canonical.
 392          *
 393          * @param array $linkarr Associative array of attributes.
 394          */
 395         function addLink( array $linkarr ) {
 396                 array_push( $this->mLinktags, $linkarr );
 397         }
 398
 399         /**
 400          * Returns the current <link> tags
 401          *
 402          * @since 1.25
 403          * @return array
 404          */
 405         public function getLinkTags() {
 406                 return $this->mLinktags;
 407         }
 408
 409         /**
 410          * Add a new \<link\> with "rel" attribute set to "meta"
 411          *
 412          * @param array $linkarr Associative array mapping attribute names to their
 413          *                 values, both keys and values will be escaped, and the
 414          *                 "rel" attribute will be automatically added
 415          */
 416         function addMetadataLink( array $linkarr ) {
 417                 $linkarr['rel'] = $this->getMetadataAttribute();
 418                 $this->addLink( $linkarr );
 419         }
 420
 421         /**
 422          * Set the URL to be used for the <link rel=canonical>. This should be used
 423          * in preference to addLink(), to avoid duplicate link tags.
 424          * @param string $url
 425          */
 426         function setCanonicalUrl( $url ) {
 427                 $this->mCanonicalUrl = $url;
 428         }
 429
 430         /**
 431          * Returns the URL to be used for the <link rel=canonical> if
 432          * one is set.
 433          *
 434          * @since 1.25
 435          * @return bool|string
 436          */
 437         public function getCanonicalUrl() {
 438                 return $this->mCanonicalUrl;
 439         }
 440
 441         /**
 442          * Get the value of the "rel" attribute for metadata links
 443          *
 444          * @return string
 445          */
 446         public function getMetadataAttribute() {
 447                 # note: buggy CC software only reads first "meta" link
 448                 static $haveMeta = false;
 449                 if ( $haveMeta ) {
 450                         return 'alternate meta';
 451                 } else {
 452                         $haveMeta = true;
 453                         return 'meta';
 454                 }
 455         }
 456
 457         /**
 458          * Add raw HTML to the list of scripts (including \<script\> tag, etc.)
 459          * Internal use only. Use OutputPage::addModules() or OutputPage::addJsConfigVars()
 460          * if possible.
 461          *
 462          * @param string $script Raw HTML
 463          */
 464         function addScript( $script ) {
 465                 $this->mScripts .= $script;
 466         }
 467
 468         /**
 469          * Register and add a stylesheet from an extension directory.
 470          *
 471          * @deprecated since 1.27 use addModuleStyles() or addStyle() instead
 472          * @param string $url Path to sheet.  Provide either a full url (beginning
 473          *             with 'http', etc) or a relative path from the document root
 474          *             (beginning with '/').  Otherwise it behaves identically to
 475          *             addStyle() and draws from the /skins folder.
 476          */
 477         public function addExtensionStyle( $url ) {
 478                 wfDeprecated( __METHOD__, '1.27' );
 479                 array_push( $this->mExtStyles, $url );
 480         }
 481
 482         /**
 483          * Get all styles added by extensions
 484          *
 485          * @deprecated since 1.27
 486          * @return array
 487          */
 488         function getExtStyle() {
 489                 wfDeprecated( __METHOD__, '1.27' );
 490                 return $this->mExtStyles;
 491         }
 492
 493         /**
 494          * Add a JavaScript file out of skins/common, or a given relative path.
 495          * Internal use only. Use OutputPage::addModules() if possible.
 496          *
 497          * @param string $file Filename in skins/common or complete on-server path
 498          *              (/foo/bar.js)
 499          * @param string $version Style version of the file. Defaults to $wgStyleVersion
 500          */
 501         public function addScriptFile( $file, $version = null ) {
 502                 // See if $file parameter is an absolute URL or begins with a slash
 503                 if ( substr( $file, 0, 1 ) == '/' || preg_match( '#^[a-z]*://#i', $file ) ) {
 504                         $path = $file;
 505                 } else {
 506                         $path = $this->getConfig()->get( 'StylePath' ) . "/common/{$file}";
 507                 }
 508                 if ( is_null( $version ) ) {
 509                         $version = $this->getConfig()->get( 'StyleVersion' );
 510                 }
 511                 $this->addScript( Html::linkedScript( wfAppendQuery( $path, $version ) ) );
 512         }
 513
 514         /**
 515          * Add a self-contained script tag with the given contents
 516          * Internal use only. Use OutputPage::addModules() if possible.
 517          *
 518          * @param string $script JavaScript text, no script tags
 519          */
 520         public function addInlineScript( $script ) {
 521                 $this->mScripts .= Html::inlineScript( $script );
 522         }
 523
 524         /**
 525          * Filter an array of modules to remove insufficiently trustworthy members, and modules
 526          * which are no longer registered (eg a page is cached before an extension is disabled)
 527          * @param array $modules
 528          * @param string|null $position If not null, only return modules with this position
 529          * @param string $type
 530          * @return array
 531          */
 532         protected function filterModules( array $modules, $position = null,
 533                 $type = ResourceLoaderModule::TYPE_COMBINED
 534         ) {
 535                 $resourceLoader = $this->getResourceLoader();
 536                 $filteredModules = [];
 537                 foreach ( $modules as $val ) {
 538                         $module = $resourceLoader->getModule( $val );
 539                         if ( $module instanceof ResourceLoaderModule
 540                                 && $module->getOrigin() <= $this->getAllowedModules( $type )
 541                                 && ( is_null( $position ) || $module->getPosition() == $position )
 542                         ) {
 543                                 if ( $this->mTarget && !in_array( $this->mTarget, $module->getTargets() ) ) {
 544                                         $this->warnModuleTargetFilter( $module->getName() );
 545                                         continue;
 546                                 }
 547                                 $filteredModules[] = $val;
 548                         }
 549                 }
 550                 return $filteredModules;
 551         }
 552
 553         private function warnModuleTargetFilter( $moduleName ) {
 554                 static $warnings = [];
 555                 if ( isset( $warnings[$this->mTarget][$moduleName] ) ) {
 556                         return;
 557                 }
 558                 $warnings[$this->mTarget][$moduleName] = true;
 559                 $this->getResourceLoader()->getLogger()->debug(
 560                         'Module "{module}" not loadable on target "{target}".',
 561                         [
 562                                 'module' => $moduleName,
 563                                 'target' => $this->mTarget,
 564                         ]
 565                 );
 566         }
 567
 568         /**
 569          * Get the list of modules to include on this page
 570          *
 571          * @param bool $filter Whether to filter out insufficiently trustworthy modules
 572          * @param string|null $position If not null, only return modules with this position
 573          * @param string $param
 574          * @return array Array of module names
 575          */
 576         public function getModules( $filter = false, $position = null, $param = 'mModules',
 577                 $type = ResourceLoaderModule::TYPE_COMBINED
 578         ) {
 579                 $modules = array_values( array_unique( $this->$param ) );
 580                 return $filter
 581                         ? $this->filterModules( $modules, $position, $type )
 582                         : $modules;
 583         }
 584
 585         /**
 586          * Add one or more modules recognized by ResourceLoader. Modules added
 587          * through this function will be loaded by ResourceLoader when the
 588          * page loads.
 589          *
 590          * @param string|array $modules Module name (string) or array of module names
 591          */
 592         public function addModules( $modules ) {
 593                 $this->mModules = array_merge( $this->mModules, (array)$modules );
 594         }
 595
 596         /**
 597          * Get the list of module JS to include on this page
 598          *
 599          * @param bool $filter
 600          * @param string|null $position
 601          * @return array Array of module names
 602          */
 603         public function getModuleScripts( $filter = false, $position = null ) {
 604                 return $this->getModules( $filter, $position, 'mModuleScripts',
 605                         ResourceLoaderModule::TYPE_SCRIPTS
 606                 );
 607         }
 608
 609         /**
 610          * Add only JS of one or more modules recognized by ResourceLoader. Module
 611          * scripts added through this function will be loaded by ResourceLoader when
 612          * the page loads.
 613          *
 614          * @param string|array $modules Module name (string) or array of module names
 615          */
 616         public function addModuleScripts( $modules ) {
 617                 $this->mModuleScripts = array_merge( $this->mModuleScripts, (array)$modules );
 618         }
 619
 620         /**
 621          * Get the list of module CSS to include on this page
 622          *
 623          * @param bool $filter
 624          * @param string|null $position
 625          * @return array Array of module names
 626          */
 627         public function getModuleStyles( $filter = false, $position = null ) {
 628                 return $this->getModules( $filter, $position, 'mModuleStyles',
 629                         ResourceLoaderModule::TYPE_STYLES
 630                 );
 631         }
 632
 633         /**
 634          * Add only CSS of one or more modules recognized by ResourceLoader.
 635          *
 636          * Module styles added through this function will be added using standard link CSS
 637          * tags, rather than as a combined Javascript and CSS package. Thus, they will
 638          * load when JavaScript is disabled (unless CSS also happens to be disabled).
 639          *
 640          * @param string|array $modules Module name (string) or array of module names
 641          */
 642         public function addModuleStyles( $modules ) {
 643                 $this->mModuleStyles = array_merge( $this->mModuleStyles, (array)$modules );
 644         }
 645
 646         /**
 647          * @return null|string ResourceLoader target
 648          */
 649         public function getTarget() {
 650                 return $this->mTarget;
 651         }
 652
 653         /**
 654          * Sets ResourceLoader target for load.php links. If null, will be omitted
 655          *
 656          * @param string|null $target
 657          */
 658         public function setTarget( $target ) {
 659                 $this->mTarget = $target;
 660         }
 661
 662         /**
 663          * Get an array of head items
 664          *
 665          * @return array
 666          */
 667         function getHeadItemsArray() {
 668                 return $this->mHeadItems;
 669         }
 670
 671         /**
 672          * Add or replace a head item to the output
 673          *
 674          * Whenever possible, use more specific options like ResourceLoader modules,
 675          * OutputPage::addLink(), OutputPage::addMetaLink() and OutputPage::addFeedLink()
 676          * Fallback options for those are: OutputPage::addStyle, OutputPage::addScript(),
 677          * OutputPage::addInlineScript() and OutputPage::addInlineStyle()
 678          * This would be your very LAST fallback.
 679          *
 680          * @param string $name Item name
 681          * @param string $value Raw HTML
 682          */
 683         public function addHeadItem( $name, $value ) {
 684                 $this->mHeadItems[$name] = $value;
 685         }
 686
 687         /**
 688          * Add one or more head items to the output
 689          *
 690          * @since 1.28
 691          * @param string|string[] $value Raw HTML
 692          */
 693         public function addHeadItems( $values ) {
 694                 $this->mHeadItems = array_merge( $this->mHeadItems, (array)$values );
 695         }
 696
 697         /**
 698          * Check if the header item $name is already set
 699          *
 700          * @param string $name Item name
 701          * @return bool
 702          */
 703         public function hasHeadItem( $name ) {
 704                 return isset( $this->mHeadItems[$name] );
 705         }
 706
 707         /**
 708          * @deprecated since 1.28 Obsolete - wgUseETag experiment was removed.
 709          * @param string $tag
 710          */
 711         public function setETag( $tag ) {
 712         }
 713
 714         /**
 715          * Set whether the output should only contain the body of the article,
 716          * without any skin, sidebar, etc.
 717          * Used e.g. when calling with "action=render".
 718          *
 719          * @param bool $only Whether to output only the body of the article
 720          */
 721         public function setArticleBodyOnly( $only ) {
 722                 $this->mArticleBodyOnly = $only;
 723         }
 724
 725         /**
 726          * Return whether the output will contain only the body of the article
 727          *
 728          * @return bool
 729          */
 730         public function getArticleBodyOnly() {
 731                 return $this->mArticleBodyOnly;
 732         }
 733
 734         /**
 735          * Set an additional output property
 736          * @since 1.21
 737          *
 738          * @param string $name
 739          * @param mixed $value
 740          */
 741         public function setProperty( $name, $value ) {
 742                 $this->mProperties[$name] = $value;
 743         }
 744
 745         /**
 746          * Get an additional output property
 747          * @since 1.21
 748          *
 749          * @param string $name
 750          * @return mixed Property value or null if not found
 751          */
 752         public function getProperty( $name ) {
 753                 if ( isset( $this->mProperties[$name] ) ) {
 754                         return $this->mProperties[$name];
 755                 } else {
 756                         return null;
 757                 }
 758         }
 759
 760         /**
 761          * checkLastModified tells the client to use the client-cached page if
 762          * possible. If successful, the OutputPage is disabled so that
 763          * any future call to OutputPage->output() have no effect.
 764          *
 765          * Side effect: sets mLastModified for Last-Modified header
 766          *
 767          * @param string $timestamp
 768          *
 769          * @return bool True if cache-ok headers was sent.
 770          */
 771         public function checkLastModified( $timestamp ) {
 772                 if ( !$timestamp || $timestamp == '19700101000000' ) {
 773                         wfDebug( __METHOD__ . ": CACHE DISABLED, NO TIMESTAMP\n" );
 774                         return false;
 775                 }
 776                 $config = $this->getConfig();
 777                 if ( !$config->get( 'CachePages' ) ) {
 778                         wfDebug( __METHOD__ . ": CACHE DISABLED\n" );
 779                         return false;
 780                 }
 781
 782                 $timestamp = wfTimestamp( TS_MW, $timestamp );
 783                 $modifiedTimes = [
 784                         'page' => $timestamp,
 785                         'user' => $this->getUser()->getTouched(),
 786                         'epoch' => $config->get( 'CacheEpoch' )
 787                 ];
 788                 if ( $config->get( 'UseSquid' ) ) {
 789                         // T46570: the core page itself may not change, but resources might
 790                         $modifiedTimes['sepoch'] = wfTimestamp( TS_MW, time() - $config->get( 'SquidMaxage' ) );
 791                 }
 792                 Hooks::run( 'OutputPageCheckLastModified', [ &$modifiedTimes, $this ] );
 793
 794                 $maxModified = max( $modifiedTimes );
 795                 $this->mLastModified = wfTimestamp( TS_RFC2822, $maxModified );
 796
 797                 $clientHeader = $this->getRequest()->getHeader( 'If-Modified-Since' );
 798                 if ( $clientHeader === false ) {
 799                         wfDebug( __METHOD__ . ": client did not send If-Modified-Since header", 'private' );
 800                         return false;
 801                 }
 802
 803                 # IE sends sizes after the date like this:
 804                 # Wed, 20 Aug 2003 06:51:19 GMT; length=5202
 805                 # this breaks strtotime().
 806                 $clientHeader = preg_replace( '/;.*$/', '', $clientHeader );
 807
 808                 MediaWiki\suppressWarnings(); // E_STRICT system time bitching
 809                 $clientHeaderTime = strtotime( $clientHeader );
 810                 MediaWiki\restoreWarnings();
 811                 if ( !$clientHeaderTime ) {
 812                         wfDebug( __METHOD__
 813                                 . ": unable to parse the client's If-Modified-Since header: $clientHeader\n" );
 814                         return false;
 815                 }
 816                 $clientHeaderTime = wfTimestamp( TS_MW, $clientHeaderTime );
 817
 818                 # Make debug info
 819                 $info = '';
 820                 foreach ( $modifiedTimes as $name => $value ) {
 821                         if ( $info !== '' ) {
 822                                 $info .= ', ';
 823                         }
 824                         $info .= "$name=" . wfTimestamp( TS_ISO_8601, $value );
 825                 }
 826
 827                 wfDebug( __METHOD__ . ": client sent If-Modified-Since: " .
 828                         wfTimestamp( TS_ISO_8601, $clientHeaderTime ), 'private' );
 829                 wfDebug( __METHOD__ . ": effective Last-Modified: " .
 830                         wfTimestamp( TS_ISO_8601, $maxModified ), 'private' );
 831                 if ( $clientHeaderTime < $maxModified ) {
 832                         wfDebug( __METHOD__ . ": STALE, $info", 'private' );
 833                         return false;
 834                 }
 835
 836                 # Not modified
 837                 # Give a 304 Not Modified response code and disable body output
 838                 wfDebug( __METHOD__ . ": NOT MODIFIED, $info", 'private' );
 839                 ini_set( 'zlib.output_compression', 0 );
 840                 $this->getRequest()->response()->statusHeader( 304 );
 841                 $this->sendCacheControl();
 842                 $this->disable();
 843
 844                 // Don't output a compressed blob when using ob_gzhandler;
 845                 // it's technically against HTTP spec and seems to confuse
 846                 // Firefox when the response gets split over two packets.
 847                 wfClearOutputBuffers();
 848
 849                 return true;
 850         }
 851
 852         /**
 853          * Override the last modified timestamp
 854          *
 855          * @param string $timestamp New timestamp, in a format readable by
 856          *        wfTimestamp()
 857          */
 858         public function setLastModified( $timestamp ) {
 859                 $this->mLastModified = wfTimestamp( TS_RFC2822, $timestamp );
 860         }
 861
 862         /**
 863          * Set the robot policy for the page: <http://www.robotstxt.org/meta.html>
 864          *
 865          * @param string $policy The literal string to output as the contents of
 866          *   the meta tag.  Will be parsed according to the spec and output in
 867          *   standardized form.
 868          * @return null
 869          */
 870         public function setRobotPolicy( $policy ) {
 871                 $policy = Article::formatRobotPolicy( $policy );
 872
 873                 if ( isset( $policy['index'] ) ) {
 874                         $this->setIndexPolicy( $policy['index'] );
 875                 }
 876                 if ( isset( $policy['follow'] ) ) {
 877                         $this->setFollowPolicy( $policy['follow'] );
 878                 }
 879         }
 880
 881         /**
 882          * Set the index policy for the page, but leave the follow policy un-
 883          * touched.
 884          *
 885          * @param string $policy Either 'index' or 'noindex'.
 886          * @return null
 887          */
 888         public function setIndexPolicy( $policy ) {
 889                 $policy = trim( $policy );
 890                 if ( in_array( $policy, [ 'index', 'noindex' ] ) ) {
 891                         $this->mIndexPolicy = $policy;
 892                 }
 893         }
 894
 895         /**
 896          * Set the follow policy for the page, but leave the index policy un-
 897          * touched.
 898          *
 899          * @param string $policy Either 'follow' or 'nofollow'.
 900          * @return null
 901          */
 902         public function setFollowPolicy( $policy ) {
 903                 $policy = trim( $policy );
 904                 if ( in_array( $policy, [ 'follow', 'nofollow' ] ) ) {
 905                         $this->mFollowPolicy = $policy;
 906                 }
 907         }
 908
 909         /**
 910          * Set the new value of the "action text", this will be added to the
 911          * "HTML title", separated from it with " - ".
 912          *
 913          * @param string $text New value of the "action text"
 914          */
 915         public function setPageTitleActionText( $text ) {
 916                 $this->mPageTitleActionText = $text;
 917         }
 918
 919         /**
 920          * Get the value of the "action text"
 921          *
 922          * @return string
 923          */
 924         public function getPageTitleActionText() {
 925                 return $this->mPageTitleActionText;
 926         }
 927
 928         /**
 929          * "HTML title" means the contents of "<title>".
 930          * It is stored as plain, unescaped text and will be run through htmlspecialchars in the skin file.
 931          *
 932          * @param string|Message $name
 933          */
 934         public function setHTMLTitle( $name ) {
 935                 if ( $name instanceof Message ) {
 936                         $this->mHTMLtitle = $name->setContext( $this->getContext() )->text();
 937                 } else {
 938                         $this->mHTMLtitle = $name;
 939                 }
 940         }
 941
 942         /**
 943          * Return the "HTML title", i.e. the content of the "<title>" tag.
 944          *
 945          * @return string
 946          */
 947         public function getHTMLTitle() {
 948                 return $this->mHTMLtitle;
 949         }
 950
 951         /**
 952          * Set $mRedirectedFrom, the Title of the page which redirected us to the current page.
 953          *
 954          * @param Title $t
 955          */
 956         public function setRedirectedFrom( $t ) {
 957                 $this->mRedirectedFrom = $t;
 958         }
 959
 960         /**
 961          * "Page title" means the contents of \<h1\>. It is stored as a valid HTML
 962          * fragment. This function allows good tags like \<sup\> in the \<h1\> tag,
 963          * but not bad tags like \<script\>. This function automatically sets
 964          * \<title\> to the same content as \<h1\> but with all tags removed. Bad
 965          * tags that were escaped in \<h1\> will still be escaped in \<title\>, and
 966          * good tags like \<i\> will be dropped entirely.
 967          *
 968          * @param string|Message $name
 969          */
 970         public function setPageTitle( $name ) {
 971                 if ( $name instanceof Message ) {
 972                         $name = $name->setContext( $this->getContext() )->text();
 973                 }
 974
 975                 # change "<script>foo&bar</script>" to "&lt;script&gt;foo&amp;bar&lt;/script&gt;"
 976                 # but leave "<i>foobar</i>" alone
 977                 $nameWithTags = Sanitizer::normalizeCharReferences( Sanitizer::removeHTMLtags( $name ) );
 978                 $this->mPagetitle = $nameWithTags;
 979
 980                 # change "<i>foo&amp;bar</i>" to "foo&bar"
 981                 $this->setHTMLTitle(
 982                         $this->msg( 'pagetitle' )->rawParams( Sanitizer::stripAllTags( $nameWithTags ) )
 983                                 ->inContentLanguage()
 984                 );
 985         }
 986
 987         /**
 988          * Return the "page title", i.e. the content of the \<h1\> tag.
 989          *
 990          * @return string
 991          */
 992         public function getPageTitle() {
 993                 return $this->mPagetitle;
 994         }
 995
 996         /**
 997          * Set the Title object to use
 998          *
 999          * @param Title $t
1000          */
1001         public function setTitle( Title $t ) {
1002                 $this->getContext()->setTitle( $t );
1003         }
1004
1005         /**
1006          * Replace the subtitle with $str
1007          *
1008          * @param string|Message $str New value of the subtitle. String should be safe HTML.
1009          */
1010         public function setSubtitle( $str ) {
1011                 $this->clearSubtitle();
1012                 $this->addSubtitle( $str );
1013         }
1014
1015         /**
1016          * Add $str to the subtitle
1017          *
1018          * @param string|Message $str String or Message to add to the subtitle. String should be safe HTML.
1019          */
1020         public function addSubtitle( $str ) {
1021                 if ( $str instanceof Message ) {
1022                         $this->mSubtitle[] = $str->setContext( $this->getContext() )->parse();
1023                 } else {
1024                         $this->mSubtitle[] = $str;
1025                 }
1026         }
1027
1028         /**
1029          * Build message object for a subtitle containing a backlink to a page
1030          *
1031          * @param Title $title Title to link to
1032          * @param array $query Array of additional parameters to include in the link
1033          * @return Message
1034          * @since 1.25
1035          */
1036         public static function buildBacklinkSubtitle( Title $title, $query = [] ) {
1037                 if ( $title->isRedirect() ) {
1038                         $query['redirect'] = 'no';
1039                 }
1040                 $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
1041                 return wfMessage( 'backlinksubtitle' )
1042                         ->rawParams( $linkRenderer->makeLink( $title, null, [], $query ) );
1043         }
1044
1045         /**
1046          * Add a subtitle containing a backlink to a page
1047          *
1048          * @param Title $title Title to link to
1049          * @param array $query Array of additional parameters to include in the link
1050          */
1051         public function addBacklinkSubtitle( Title $title, $query = [] ) {
1052                 $this->addSubtitle( self::buildBacklinkSubtitle( $title, $query ) );
1053         }
1054
1055         /**
1056          * Clear the subtitles
1057          */
1058         public function clearSubtitle() {
1059                 $this->mSubtitle = [];
1060         }
1061
1062         /**
1063          * Get the subtitle
1064          *
1065          * @return string
1066          */
1067         public function getSubtitle() {
1068                 return implode( "<br />\n\t\t\t\t", $this->mSubtitle );
1069         }
1070
1071         /**
1072          * Set the page as printable, i.e. it'll be displayed with all
1073          * print styles included
1074          */
1075         public function setPrintable() {
1076                 $this->mPrintable = true;
1077         }
1078
1079         /**
1080          * Return whether the page is "printable"
1081          *
1082          * @return bool
1083          */
1084         public function isPrintable() {
1085                 return $this->mPrintable;
1086         }
1087
1088         /**
1089          * Disable output completely, i.e. calling output() will have no effect
1090          */
1091         public function disable() {
1092                 $this->mDoNothing = true;
1093         }
1094
1095         /**
1096          * Return whether the output will be completely disabled
1097          *
1098          * @return bool
1099          */
1100         public function isDisabled() {
1101                 return $this->mDoNothing;
1102         }
1103
1104         /**
1105          * Show an "add new section" link?
1106          *
1107          * @return bool
1108          */
1109         public function showNewSectionLink() {
1110                 return $this->mNewSectionLink;
1111         }
1112
1113         /**
1114          * Forcibly hide the new section link?
1115          *
1116          * @return bool
1117          */
1118         public function forceHideNewSectionLink() {
1119                 return $this->mHideNewSectionLink;
1120         }
1121
1122         /**
1123          * Add or remove feed links in the page header
1124          * This is mainly kept for backward compatibility, see OutputPage::addFeedLink()
1125          * for the new version
1126          * @see addFeedLink()
1127          *
1128          * @param bool $show True: add default feeds, false: remove all feeds
1129          */
1130         public function setSyndicated( $show = true ) {
1131                 if ( $show ) {
1132                         $this->setFeedAppendQuery( false );
1133                 } else {
1134                         $this->mFeedLinks = [];
1135                 }
1136         }
1137
1138         /**
1139          * Add default feeds to the page header
1140          * This is mainly kept for backward compatibility, see OutputPage::addFeedLink()
1141          * for the new version
1142          * @see addFeedLink()
1143          *
1144          * @param string $val Query to append to feed links or false to output
1145          *        default links
1146          */
1147         public function setFeedAppendQuery( $val ) {
1148                 $this->mFeedLinks = [];
1149
1150                 foreach ( $this->getConfig()->get( 'AdvertisedFeedTypes' ) as $type ) {
1151                         $query = "feed=$type";
1152                         if ( is_string( $val ) ) {
1153                                 $query .= '&' . $val;
1154                         }
1155                         $this->mFeedLinks[$type] = $this->getTitle()->getLocalURL( $query );
1156                 }
1157         }
1158
1159         /**
1160          * Add a feed link to the page header
1161          *
1162          * @param string $format Feed type, should be a key of $wgFeedClasses
1163          * @param string $href URL
1164          */
1165         public function addFeedLink( $format, $href ) {
1166                 if ( in_array( $format, $this->getConfig()->get( 'AdvertisedFeedTypes' ) ) ) {
1167                         $this->mFeedLinks[$format] = $href;
1168                 }
1169         }
1170
1171         /**
1172          * Should we output feed links for this page?
1173          * @return bool
1174          */
1175         public function isSyndicated() {
1176                 return count( $this->mFeedLinks ) > 0;
1177         }
1178
1179         /**
1180          * Return URLs for each supported syndication format for this page.
1181          * @return array Associating format keys with URLs
1182          */
1183         public function getSyndicationLinks() {
1184                 return $this->mFeedLinks;
1185         }
1186
1187         /**
1188          * Will currently always return null
1189          *
1190          * @return null
1191          */
1192         public function getFeedAppendQuery() {
1193                 return $this->mFeedLinksAppendQuery;
1194         }
1195
1196         /**
1197          * Set whether the displayed content is related to the source of the
1198          * corresponding article on the wiki
1199          * Setting true will cause the change "article related" toggle to true
1200          *
1201          * @param bool $v
1202          */
1203         public function setArticleFlag( $v ) {
1204                 $this->mIsarticle = $v;
1205                 if ( $v ) {
1206                         $this->mIsArticleRelated = $v;
1207                 }
1208         }
1209
1210         /**
1211          * Return whether the content displayed page is related to the source of
1212          * the corresponding article on the wiki
1213          *
1214          * @return bool
1215          */
1216         public function isArticle() {
1217                 return $this->mIsarticle;
1218         }
1219
1220         /**
1221          * Set whether this page is related an article on the wiki
1222          * Setting false will cause the change of "article flag" toggle to false
1223          *
1224          * @param bool $v
1225          */
1226         public function setArticleRelated( $v ) {
1227                 $this->mIsArticleRelated = $v;
1228                 if ( !$v ) {
1229                         $this->mIsarticle = false;
1230                 }
1231         }
1232
1233         /**
1234          * Return whether this page is related an article on the wiki
1235          *
1236          * @return bool
1237          */
1238         public function isArticleRelated() {
1239                 return $this->mIsArticleRelated;
1240         }
1241
1242         /**
1243          * Add new language links
1244          *
1245          * @param string[] $newLinkArray Array of interwiki-prefixed (non DB key) titles
1246          *                               (e.g. 'fr:Test page')
1247          */
1248         public function addLanguageLinks( array $newLinkArray ) {
1249                 $this->mLanguageLinks += $newLinkArray;
1250         }
1251
1252         /**
1253          * Reset the language links and add new language links
1254          *
1255          * @param string[] $newLinkArray Array of interwiki-prefixed (non DB key) titles
1256          *                               (e.g. 'fr:Test page')
1257          */
1258         public function setLanguageLinks( array $newLinkArray ) {
1259                 $this->mLanguageLinks = $newLinkArray;
1260         }
1261
1262         /**
1263          * Get the list of language links
1264          *
1265          * @return string[] Array of interwiki-prefixed (non DB key) titles (e.g. 'fr:Test page')
1266          */
1267         public function getLanguageLinks() {
1268                 return $this->mLanguageLinks;
1269         }
1270
1271         /**
1272          * Add an array of categories, with names in the keys
1273          *
1274          * @param array $categories Mapping category name => sort key
1275          */
1276         public function addCategoryLinks( array $categories ) {
1277                 global $wgContLang;
1278
1279                 if ( !is_array( $categories ) || count( $categories ) == 0 ) {
1280                         return;
1281                 }
1282
1283                 $res = $this->addCategoryLinksToLBAndGetResult( $categories );
1284
1285                 # Set all the values to 'normal'.
1286                 $categories = array_fill_keys( array_keys( $categories ), 'normal' );
1287
1288                 # Mark hidden categories
1289                 foreach ( $res as $row ) {
1290                         if ( isset( $row->pp_value ) ) {
1291                                 $categories[$row->page_title] = 'hidden';
1292                         }
1293                 }
1294
1295                 // Avoid PHP 7.1 warning of passing $this by reference
1296                 $outputPage = $this;
1297                 # Add the remaining categories to the skin
1298                 if ( Hooks::run(
1299                         'OutputPageMakeCategoryLinks',
1300                         [ &$outputPage, $categories, &$this->mCategoryLinks ] )
1301                 ) {
1302                         $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
1303                         foreach ( $categories as $category => $type ) {
1304                                 // array keys will cast numeric category names to ints, so cast back to string
1305                                 $category = (string)$category;
1306                                 $origcategory = $category;
1307                                 $title = Title::makeTitleSafe( NS_CATEGORY, $category );
1308                                 if ( !$title ) {
1309                                         continue;
1310                                 }
1311                                 $wgContLang->findVariantLink( $category, $title, true );
1312                                 if ( $category != $origcategory && array_key_exists( $category, $categories ) ) {
1313                                         continue;
1314                                 }
1315                                 $text = $wgContLang->convertHtml( $title->getText() );
1316                                 $this->mCategories[$type][] = $title->getText();
1317                                 $this->mCategoryLinks[$type][] = $linkRenderer->makeLink( $title, new HtmlArmor( $text ) );
1318                         }
1319                 }
1320         }
1321
1322         /**
1323          * @param array $categories
1324          * @return bool|ResultWrapper
1325          */
1326         protected function addCategoryLinksToLBAndGetResult( array $categories ) {
1327                 # Add the links to a LinkBatch
1328                 $arr = [ NS_CATEGORY => $categories ];
1329                 $lb = new LinkBatch;
1330                 $lb->setArray( $arr );
1331
1332                 # Fetch existence plus the hiddencat property
1333                 $dbr = wfGetDB( DB_REPLICA );
1334                 $fields = array_merge(
1335                         LinkCache::getSelectFields(),
1336                         [ 'page_namespace', 'page_title', 'pp_value' ]
1337                 );
1338
1339                 $res = $dbr->select( [ 'page', 'page_props' ],
1340                         $fields,
1341                         $lb->constructSet( 'page', $dbr ),
1342                         __METHOD__,
1343                         [],
1344                         [ 'page_props' => [ 'LEFT JOIN', [
1345                                 'pp_propname' => 'hiddencat',
1346                                 'pp_page = page_id'
1347                         ] ] ]
1348                 );
1349
1350                 # Add the results to the link cache
1351                 $lb->addResultToCache( LinkCache::singleton(), $res );
1352
1353                 return $res;
1354         }
1355
1356         /**
1357          * Reset the category links (but not the category list) and add $categories
1358          *
1359          * @param array $categories Mapping category name => sort key
1360          */
1361         public function setCategoryLinks( array $categories ) {
1362                 $this->mCategoryLinks = [];
1363                 $this->addCategoryLinks( $categories );
1364         }
1365
1366         /**
1367          * Get the list of category links, in a 2-D array with the following format:
1368          * $arr[$type][] = $link, where $type is either "normal" or "hidden" (for
1369          * hidden categories) and $link a HTML fragment with a link to the category
1370          * page
1371          *
1372          * @return array
1373          */
1374         public function getCategoryLinks() {
1375                 return $this->mCategoryLinks;
1376         }
1377
1378         /**
1379          * Get the list of category names this page belongs to.
1380          *
1381          * @param string $type The type of categories which should be returned. Possible values:
1382          *  * all: all categories of all types
1383          *  * hidden: only the hidden categories
1384          *  * normal: all categories, except hidden categories
1385          * @return array Array of strings
1386          */
1387         public function getCategories( $type = 'all' ) {
1388                 if ( $type === 'all' ) {
1389                         $allCategories = [];
1390                         foreach ( $this->mCategories as $categories ) {
1391                                 $allCategories = array_merge( $allCategories, $categories );
1392                         }
1393                         return $allCategories;
1394                 }
1395                 if ( !isset( $this->mCategories[$type] ) ) {
1396                         throw new InvalidArgumentException( 'Invalid category type given: ' . $type );
1397                 }
1398                 return $this->mCategories[$type];
1399         }
1400
1401         /**
1402          * Add an array of indicators, with their identifiers as array
1403          * keys and HTML contents as values.
1404          *
1405          * In case of duplicate keys, existing values are overwritten.
1406          *
1407          * @param array $indicators
1408          * @since 1.25
1409          */
1410         public function setIndicators( array $indicators ) {
1411                 $this->mIndicators = $indicators + $this->mIndicators;
1412                 // Keep ordered by key
1413                 ksort( $this->mIndicators );
1414         }
1415
1416         /**
1417          * Get the indicators associated with this page.
1418          *
1419          * The array will be internally ordered by item keys.
1420          *
1421          * @return array Keys: identifiers, values: HTML contents
1422          * @since 1.25
1423          */
1424         public function getIndicators() {
1425                 return $this->mIndicators;
1426         }
1427
1428         /**
1429          * Adds help link with an icon via page indicators.
1430          * Link target can be overridden by a local message containing a wikilink:
1431          * the message key is: lowercase action or special page name + '-helppage'.
1432          * @param string $to Target MediaWiki.org page title or encoded URL.
1433          * @param bool $overrideBaseUrl Whether $url is a full URL, to avoid MW.o.
1434          * @since 1.25
1435          */
1436         public function addHelpLink( $to, $overrideBaseUrl = false ) {
1437                 $this->addModuleStyles( 'mediawiki.helplink' );
1438                 $text = $this->msg( 'helppage-top-gethelp' )->escaped();
1439
1440                 if ( $overrideBaseUrl ) {
1441                         $helpUrl = $to;
1442                 } else {
1443                         $toUrlencoded = wfUrlencode( str_replace( ' ', '_', $to ) );
1444                         $helpUrl = "//www.mediawiki.org/wiki/Special:MyLanguage/$toUrlencoded";
1445                 }
1446
1447                 $link = Html::rawElement(
1448                         'a',
1449                         [
1450                                 'href' => $helpUrl,
1451                                 'target' => '_blank',
1452                                 'class' => 'mw-helplink',
1453                         ],
1454                         $text
1455                 );
1456
1457                 $this->setIndicators( [ 'mw-helplink' => $link ] );
1458         }
1459
1460         /**
1461          * Do not allow scripts which can be modified by wiki users to load on this page;
1462          * only allow scripts bundled with, or generated by, the software.
1463          * Site-wide styles are controlled by a config setting, since they can be
1464          * used to create a custom skin/theme, but not user-specific ones.
1465          *
1466          * @todo this should be given a more accurate name
1467          */
1468         public function disallowUserJs() {
1469                 $this->reduceAllowedModules(
1470                         ResourceLoaderModule::TYPE_SCRIPTS,
1471                         ResourceLoaderModule::ORIGIN_CORE_INDIVIDUAL
1472                 );
1473
1474                 // Site-wide styles are controlled by a config setting, see T73621
1475                 // for background on why. User styles are never allowed.
1476                 if ( $this->getConfig()->get( 'AllowSiteCSSOnRestrictedPages' ) ) {
1477                         $styleOrigin = ResourceLoaderModule::ORIGIN_USER_SITEWIDE;
1478                 } else {
1479                         $styleOrigin = ResourceLoaderModule::ORIGIN_CORE_INDIVIDUAL;
1480                 }
1481                 $this->reduceAllowedModules(
1482                         ResourceLoaderModule::TYPE_STYLES,
1483                         $styleOrigin
1484                 );
1485         }
1486
1487         /**
1488          * Show what level of JavaScript / CSS untrustworthiness is allowed on this page
1489          * @see ResourceLoaderModule::$origin
1490          * @param string $type ResourceLoaderModule TYPE_ constant
1491          * @return int ResourceLoaderModule ORIGIN_ class constant
1492          */
1493         public function getAllowedModules( $type ) {
1494                 if ( $type == ResourceLoaderModule::TYPE_COMBINED ) {
1495                         return min( array_values( $this->mAllowedModules ) );
1496                 } else {
1497                         return isset( $this->mAllowedModules[$type] )
1498                                 ? $this->mAllowedModules[$type]
1499                                 : ResourceLoaderModule::ORIGIN_ALL;
1500                 }
1501         }
1502
1503         /**
1504          * Limit the highest level of CSS/JS untrustworthiness allowed.
1505          *
1506          * If passed the same or a higher level than the current level of untrustworthiness set, the
1507          * level will remain unchanged.
1508          *
1509          * @param string $type
1510          * @param int $level ResourceLoaderModule class constant
1511          */
1512         public function reduceAllowedModules( $type, $level ) {
1513                 $this->mAllowedModules[$type] = min( $this->getAllowedModules( $type ), $level );
1514         }
1515
1516         /**
1517          * Prepend $text to the body HTML
1518          *
1519          * @param string $text HTML
1520          */
1521         public function prependHTML( $text ) {
1522                 $this->mBodytext = $text . $this->mBodytext;
1523         }
1524
1525         /**
1526          * Append $text to the body HTML
1527          *
1528          * @param string $text HTML
1529          */
1530         public function addHTML( $text ) {
1531                 $this->mBodytext .= $text;
1532         }
1533
1534         /**
1535          * Shortcut for adding an Html::element via addHTML.
1536          *
1537          * @since 1.19
1538          *
1539          * @param string $element
1540          * @param array $attribs
1541          * @param string $contents
1542          */
1543         public function addElement( $element, array $attribs = [], $contents = '' ) {
1544                 $this->addHTML( Html::element( $element, $attribs, $contents ) );
1545         }
1546
1547         /**
1548          * Clear the body HTML
1549          */
1550         public function clearHTML() {
1551                 $this->mBodytext = '';
1552         }
1553
1554         /**
1555          * Get the body HTML
1556          *
1557          * @return string HTML
1558          */
1559         public function getHTML() {
1560                 return $this->mBodytext;
1561         }
1562
1563         /**
1564          * Get/set the ParserOptions object to use for wikitext parsing
1565          *
1566          * @param ParserOptions|null $options Either the ParserOption to use or null to only get the
1567          *   current ParserOption object
1568          * @return ParserOptions
1569          */
1570         public function parserOptions( $options = null ) {
1571                 if ( $options !== null && !empty( $options->isBogus ) ) {
1572                         // Someone is trying to set a bogus pre-$wgUser PO. Check if it has
1573                         // been changed somehow, and keep it if so.
1574                         $anonPO = ParserOptions::newFromAnon();
1575                         $anonPO->setEditSection( false );
1576                         $anonPO->setAllowUnsafeRawHtml( false );
1577                         if ( !$options->matches( $anonPO ) ) {
1578                                 wfLogWarning( __METHOD__ . ': Setting a changed bogus ParserOptions: ' . wfGetAllCallers( 5 ) );
1579                                 $options->isBogus = false;
1580                         }
1581                 }
1582
1583                 if ( !$this->mParserOptions ) {
1584                         if ( !$this->getContext()->getUser()->isSafeToLoad() ) {
1585                                 // $wgUser isn't unstubbable yet, so don't try to get a
1586                                 // ParserOptions for it. And don't cache this ParserOptions
1587                                 // either.
1588                                 $po = ParserOptions::newFromAnon();
1589                                 $po->setEditSection( false );
1590                                 $po->setAllowUnsafeRawHtml( false );
1591                                 $po->isBogus = true;
1592                                 if ( $options !== null ) {
1593                                         $this->mParserOptions = empty( $options->isBogus ) ? $options : null;
1594                                 }
1595                                 return $po;
1596                         }
1597
1598                         $this->mParserOptions = ParserOptions::newFromContext( $this->getContext() );
1599                         $this->mParserOptions->setEditSection( false );
1600                         $this->mParserOptions->setAllowUnsafeRawHtml( false );
1601                 }
1602
1603                 if ( $options !== null && !empty( $options->isBogus ) ) {
1604                         // They're trying to restore the bogus pre-$wgUser PO. Do the right
1605                         // thing.
1606                         return wfSetVar( $this->mParserOptions, null, true );
1607                 } else {
1608                         return wfSetVar( $this->mParserOptions, $options );
1609                 }
1610         }
1611
1612         /**
1613          * Set the revision ID which will be seen by the wiki text parser
1614          * for things such as embedded {{REVISIONID}} variable use.
1615          *
1616          * @param int|null $revid An positive integer, or null
1617          * @return mixed Previous value
1618          */
1619         public function setRevisionId( $revid ) {
1620                 $val = is_null( $revid ) ? null : intval( $revid );
1621                 return wfSetVar( $this->mRevisionId, $val );
1622         }
1623
1624         /**
1625          * Get the displayed revision ID
1626          *
1627          * @return int
1628          */
1629         public function getRevisionId() {
1630                 return $this->mRevisionId;
1631         }
1632
1633         /**
1634          * Set the timestamp of the revision which will be displayed. This is used
1635          * to avoid a extra DB call in Skin::lastModified().
1636          *
1637          * @param string|null $timestamp
1638          * @return mixed Previous value
1639          */
1640         public function setRevisionTimestamp( $timestamp ) {
1641                 return wfSetVar( $this->mRevisionTimestamp, $timestamp );
1642         }
1643
1644         /**
1645          * Get the timestamp of displayed revision.
1646          * This will be null if not filled by setRevisionTimestamp().
1647          *
1648          * @return string|null
1649          */
1650         public function getRevisionTimestamp() {
1651                 return $this->mRevisionTimestamp;
1652         }
1653
1654         /**
1655          * Set the displayed file version
1656          *
1657          * @param File|bool $file
1658          * @return mixed Previous value
1659          */
1660         public function setFileVersion( $file ) {
1661                 $val = null;
1662                 if ( $file instanceof File && $file->exists() ) {
1663                         $val = [ 'time' => $file->getTimestamp(), 'sha1' => $file->getSha1() ];
1664                 }
1665                 return wfSetVar( $this->mFileVersion, $val, true );
1666         }
1667
1668         /**
1669          * Get the displayed file version
1670          *
1671          * @return array|null ('time' => MW timestamp, 'sha1' => sha1)
1672          */
1673         public function getFileVersion() {
1674                 return $this->mFileVersion;
1675         }
1676
1677         /**
1678          * Get the templates used on this page
1679          *
1680          * @return array (namespace => dbKey => revId)
1681          * @since 1.18
1682          */
1683         public function getTemplateIds() {
1684                 return $this->mTemplateIds;
1685         }
1686
1687         /**
1688          * Get the files used on this page
1689          *
1690          * @return array (dbKey => array('time' => MW timestamp or null, 'sha1' => sha1 or ''))
1691          * @since 1.18
1692          */
1693         public function getFileSearchOptions() {
1694                 return $this->mImageTimeKeys;
1695         }
1696
1697         /**
1698          * Convert wikitext to HTML and add it to the buffer
1699          * Default assumes that the current page title will be used.
1700          *
1701          * @param string $text
1702          * @param bool $linestart Is this the start of a line?
1703          * @param bool $interface Is this text in the user interface language?
1704          * @throws MWException
1705          */
1706         public function addWikiText( $text, $linestart = true, $interface = true ) {
1707                 $title = $this->getTitle(); // Work around E_STRICT
1708                 if ( !$title ) {
1709                         throw new MWException( 'Title is null' );
1710                 }
1711                 $this->addWikiTextTitle( $text, $title, $linestart, /*tidy*/false, $interface );
1712         }
1713
1714         /**
1715          * Add wikitext with a custom Title object
1716          *
1717          * @param string $text Wikitext
1718          * @param Title $title
1719          * @param bool $linestart Is this the start of a line?
1720          */
1721         public function addWikiTextWithTitle( $text, &$title, $linestart = true ) {
1722                 $this->addWikiTextTitle( $text, $title, $linestart );
1723         }
1724
1725         /**
1726          * Add wikitext with a custom Title object and tidy enabled.
1727          *
1728          * @param string $text Wikitext
1729          * @param Title $title
1730          * @param bool $linestart Is this the start of a line?
1731          */
1732         function addWikiTextTitleTidy( $text, &$title, $linestart = true ) {
1733                 $this->addWikiTextTitle( $text, $title, $linestart, true );
1734         }
1735
1736         /**
1737          * Add wikitext with tidy enabled
1738          *
1739          * @param string $text Wikitext
1740          * @param bool $linestart Is this the start of a line?
1741          */
1742         public function addWikiTextTidy( $text, $linestart = true ) {
1743                 $title = $this->getTitle();
1744                 $this->addWikiTextTitleTidy( $text, $title, $linestart );
1745         }
1746
1747         /**
1748          * Add wikitext with a custom Title object
1749          *
1750          * @param string $text Wikitext
1751          * @param Title $title
1752          * @param bool $linestart Is this the start of a line?
1753          * @param bool $tidy Whether to use tidy
1754          * @param bool $interface Whether it is an interface message
1755          *   (for example disables conversion)
1756          */
1757         public function addWikiTextTitle( $text, Title $title, $linestart,
1758                 $tidy = false, $interface = false
1759         ) {
1760                 global $wgParser;
1761
1762                 $popts = $this->parserOptions();
1763                 $oldTidy = $popts->setTidy( $tidy );
1764                 $popts->setInterfaceMessage( (bool)$interface );
1765
1766                 $parserOutput = $wgParser->getFreshParser()->parse(
1767                         $text, $title, $popts,
1768                         $linestart, true, $this->mRevisionId
1769                 );
1770
1771                 $popts->setTidy( $oldTidy );
1772
1773                 $this->addParserOutput( $parserOutput );
1774         }
1775
1776         /**
1777          * Add all metadata associated with a ParserOutput object, but without the actual HTML. This
1778          * includes categories, language links, ResourceLoader modules, effects of certain magic words,
1779          * and so on.
1780          *
1781          * @since 1.24
1782          * @param ParserOutput $parserOutput
1783          */
1784         public function addParserOutputMetadata( $parserOutput ) {
1785                 $this->mLanguageLinks += $parserOutput->getLanguageLinks();
1786                 $this->addCategoryLinks( $parserOutput->getCategories() );
1787                 $this->setIndicators( $parserOutput->getIndicators() );
1788                 $this->mNewSectionLink = $parserOutput->getNewSection();
1789                 $this->mHideNewSectionLink = $parserOutput->getHideNewSection();
1790
1791                 if ( !$parserOutput->isCacheable() ) {
1792                         $this->enableClientCache( false );
1793                 }
1794                 $this->mNoGallery = $parserOutput->getNoGallery();
1795                 $this->mHeadItems = array_merge( $this->mHeadItems, $parserOutput->getHeadItems() );
1796                 $this->addModules( $parserOutput->getModules() );
1797                 $this->addModuleScripts( $parserOutput->getModuleScripts() );
1798                 $this->addModuleStyles( $parserOutput->getModuleStyles() );
1799                 $this->addJsConfigVars( $parserOutput->getJsConfigVars() );
1800                 $this->mPreventClickjacking = $this->mPreventClickjacking
1801                         || $parserOutput->preventClickjacking();
1802
1803                 // Template versioning...
1804                 foreach ( (array)$parserOutput->getTemplateIds() as $ns => $dbks ) {
1805                         if ( isset( $this->mTemplateIds[$ns] ) ) {
1806                                 $this->mTemplateIds[$ns] = $dbks + $this->mTemplateIds[$ns];
1807                         } else {
1808                                 $this->mTemplateIds[$ns] = $dbks;
1809                         }
1810                 }
1811                 // File versioning...
1812                 foreach ( (array)$parserOutput->getFileSearchOptions() as $dbk => $data ) {
1813                         $this->mImageTimeKeys[$dbk] = $data;
1814                 }
1815
1816                 // Hooks registered in the object
1817                 $parserOutputHooks = $this->getConfig()->get( 'ParserOutputHooks' );
1818                 foreach ( $parserOutput->getOutputHooks() as $hookInfo ) {
1819                         list( $hookName, $data ) = $hookInfo;
1820                         if ( isset( $parserOutputHooks[$hookName] ) ) {
1821                                 call_user_func( $parserOutputHooks[$hookName], $this, $parserOutput, $data );
1822                         }
1823                 }
1824
1825                 // Enable OOUI if requested via ParserOutput
1826                 if ( $parserOutput->getEnableOOUI() ) {
1827                         $this->enableOOUI();
1828                 }
1829
1830                 // Include parser limit report
1831                 if ( !$this->limitReportJSData ) {
1832                         $this->limitReportJSData = $parserOutput->getLimitReportJSData();
1833                 }
1834
1835                 // Link flags are ignored for now, but may in the future be
1836                 // used to mark individual language links.
1837                 $linkFlags = [];
1838                 // Avoid PHP 7.1 warning of passing $this by reference
1839                 $outputPage = $this;
1840                 Hooks::run( 'LanguageLinks', [ $this->getTitle(), &$this->mLanguageLinks, &$linkFlags ] );
1841                 Hooks::run( 'OutputPageParserOutput', [ &$outputPage, $parserOutput ] );
1842
1843                 // This check must be after 'OutputPageParserOutput' runs in addParserOutputMetadata
1844                 // so that extensions may modify ParserOutput to toggle TOC.
1845                 // This cannot be moved to addParserOutputText because that is not
1846                 // called by EditPage for Preview.
1847                 if ( $parserOutput->getTOCEnabled() && $parserOutput->getTOCHTML() ) {
1848                         $this->mEnableTOC = true;
1849                 }
1850         }
1851
1852         /**
1853          * Add the HTML and enhancements for it (like ResourceLoader modules) associated with a
1854          * ParserOutput object, without any other metadata.
1855          *
1856          * @since 1.24
1857          * @param ParserOutput $parserOutput
1858          */
1859         public function addParserOutputContent( $parserOutput ) {
1860                 $this->addParserOutputText( $parserOutput );
1861
1862                 $this->addModules( $parserOutput->getModules() );
1863                 $this->addModuleScripts( $parserOutput->getModuleScripts() );
1864                 $this->addModuleStyles( $parserOutput->getModuleStyles() );
1865
1866                 $this->addJsConfigVars( $parserOutput->getJsConfigVars() );
1867         }
1868
1869         /**
1870          * Add the HTML associated with a ParserOutput object, without any metadata.
1871          *
1872          * @since 1.24
1873          * @param ParserOutput $parserOutput
1874          */
1875         public function addParserOutputText( $parserOutput ) {
1876                 $text = $parserOutput->getText();
1877                 // Avoid PHP 7.1 warning of passing $this by reference
1878                 $outputPage = $this;
1879                 Hooks::run( 'OutputPageBeforeHTML', [ &$outputPage, &$text ] );
1880                 $this->addHTML( $text );
1881         }
1882
1883         /**
1884          * Add everything from a ParserOutput object.
1885          *
1886          * @param ParserOutput $parserOutput
1887          */
1888         function addParserOutput( $parserOutput ) {
1889                 $this->addParserOutputMetadata( $parserOutput );
1890
1891                 // Touch section edit links only if not previously disabled
1892                 if ( $parserOutput->getEditSectionTokens() ) {
1893                         $parserOutput->setEditSectionTokens( $this->mEnableSectionEditLinks );
1894                 }
1895
1896                 $this->addParserOutputText( $parserOutput );
1897         }
1898
1899         /**
1900          * Add the output of a QuickTemplate to the output buffer
1901          *
1902          * @param QuickTemplate $template
1903          */
1904         public function addTemplate( &$template ) {
1905                 $this->addHTML( $template->getHTML() );
1906         }
1907
1908         /**
1909          * Parse wikitext and return the HTML.
1910          *
1911          * @param string $text
1912          * @param bool $linestart Is this the start of a line?
1913          * @param bool $interface Use interface language ($wgLang instead of
1914          *   $wgContLang) while parsing language sensitive magic words like GRAMMAR and PLURAL.
1915          *   This also disables LanguageConverter.
1916          * @param Language $language Target language object, will override $interface
1917          * @throws MWException
1918          * @return string HTML
1919          */
1920         public function parse( $text, $linestart = true, $interface = false, $language = null ) {
1921                 global $wgParser;
1922
1923                 if ( is_null( $this->getTitle() ) ) {
1924                         throw new MWException( 'Empty $mTitle in ' . __METHOD__ );
1925                 }
1926
1927                 $popts = $this->parserOptions();
1928                 if ( $interface ) {
1929                         $popts->setInterfaceMessage( true );
1930                 }
1931                 if ( $language !== null ) {
1932                         $oldLang = $popts->setTargetLanguage( $language );
1933                 }
1934
1935                 $parserOutput = $wgParser->getFreshParser()->parse(
1936                         $text, $this->getTitle(), $popts,
1937                         $linestart, true, $this->mRevisionId
1938                 );
1939
1940                 if ( $interface ) {
1941                         $popts->setInterfaceMessage( false );
1942                 }
1943                 if ( $language !== null ) {
1944                         $popts->setTargetLanguage( $oldLang );
1945                 }
1946
1947                 return $parserOutput->getText();
1948         }
1949
1950         /**
1951          * Parse wikitext, strip paragraphs, and return the HTML.
1952          *
1953          * @param string $text
1954          * @param bool $linestart Is this the start of a line?
1955          * @param bool $interface Use interface language ($wgLang instead of
1956          *   $wgContLang) while parsing language sensitive magic
1957          *   words like GRAMMAR and PLURAL
1958          * @return string HTML
1959          */
1960         public function parseInline( $text, $linestart = true, $interface = false ) {
1961                 $parsed = $this->parse( $text, $linestart, $interface );
1962                 return Parser::stripOuterParagraph( $parsed );
1963         }
1964
1965         /**
1966          * @param $maxage
1967          * @deprecated since 1.27 Use setCdnMaxage() instead
1968          */
1969         public function setSquidMaxage( $maxage ) {
1970                 $this->setCdnMaxage( $maxage );
1971         }
1972
1973         /**
1974          * Set the value of the "s-maxage" part of the "Cache-control" HTTP header
1975          *
1976          * @param int $maxage Maximum cache time on the CDN, in seconds.
1977          */
1978         public function setCdnMaxage( $maxage ) {
1979                 $this->mCdnMaxage = min( $maxage, $this->mCdnMaxageLimit );
1980         }
1981
1982         /**
1983          * Lower the value of the "s-maxage" part of the "Cache-control" HTTP header
1984          *
1985          * @param int $maxage Maximum cache time on the CDN, in seconds
1986          * @since 1.27
1987          */
1988         public function lowerCdnMaxage( $maxage ) {
1989                 $this->mCdnMaxageLimit = min( $maxage, $this->mCdnMaxageLimit );
1990                 $this->setCdnMaxage( $this->mCdnMaxage );
1991         }
1992
1993         /**
1994          * Get TTL in [$minTTL,$maxTTL] in pass it to lowerCdnMaxage()
1995          *
1996          * This sets and returns $minTTL if $mtime is false or null. Otherwise,
1997          * the TTL is higher the older the $mtime timestamp is. Essentially, the
1998          * TTL is 90% of the age of the object, subject to the min and max.
1999          *
2000          * @param string|integer|float|bool|null $mtime Last-Modified timestamp
2001          * @param integer $minTTL Mimimum TTL in seconds [default: 1 minute]
2002          * @param integer $maxTTL Maximum TTL in seconds [default: $wgSquidMaxage]
2003          * @return integer TTL in seconds
2004          * @since 1.28
2005          */
2006         public function adaptCdnTTL( $mtime, $minTTL = 0, $maxTTL = 0 ) {
2007                 $minTTL = $minTTL ?: IExpiringStore::TTL_MINUTE;
2008                 $maxTTL = $maxTTL ?: $this->getConfig()->get( 'SquidMaxage' );
2009
2010                 if ( $mtime === null || $mtime === false ) {
2011                         return $minTTL; // entity does not exist
2012                 }
2013
2014                 $age = time() - wfTimestamp( TS_UNIX, $mtime );
2015                 $adaptiveTTL = max( .9 * $age, $minTTL );
2016                 $adaptiveTTL = min( $adaptiveTTL, $maxTTL );
2017
2018                 $this->lowerCdnMaxage( (int)$adaptiveTTL );
2019
2020                 return $adaptiveTTL;
2021         }
2022
2023         /**
2024          * Use enableClientCache(false) to force it to send nocache headers
2025          *
2026          * @param bool $state
2027          *
2028          * @return bool
2029          */
2030         public function enableClientCache( $state ) {
2031                 return wfSetVar( $this->mEnableClientCache, $state );
2032         }
2033
2034         /**
2035          * Get the list of cookies that will influence on the cache
2036          *
2037          * @return array
2038          */
2039         function getCacheVaryCookies() {
2040                 static $cookies;
2041                 if ( $cookies === null ) {
2042                         $config = $this->getConfig();
2043                         $cookies = array_merge(
2044                                 SessionManager::singleton()->getVaryCookies(),
2045                                 [
2046                                         'forceHTTPS',
2047                                 ],
2048                                 $config->get( 'CacheVaryCookies' )
2049                         );
2050                         Hooks::run( 'GetCacheVaryCookies', [ $this, &$cookies ] );
2051                 }
2052                 return $cookies;
2053         }
2054
2055         /**
2056          * Check if the request has a cache-varying cookie header
2057          * If it does, it's very important that we don't allow public caching
2058          *
2059          * @return bool
2060          */
2061         function haveCacheVaryCookies() {
2062                 $request = $this->getRequest();
2063                 foreach ( $this->getCacheVaryCookies() as $cookieName ) {
2064                         if ( $request->getCookie( $cookieName, '', '' ) !== '' ) {
2065                                 wfDebug( __METHOD__ . ": found $cookieName\n" );
2066                                 return true;
2067                         }
2068                 }
2069                 wfDebug( __METHOD__ . ": no cache-varying cookies found\n" );
2070                 return false;
2071         }
2072
2073         /**
2074          * Add an HTTP header that will influence on the cache
2075          *
2076          * @param string $header Header name
2077          * @param string[]|null $option Options for the Key header. See
2078          * https://datatracker.ietf.org/doc/draft-fielding-http-key/
2079          * for the list of valid options.
2080          */
2081         public function addVaryHeader( $header, array $option = null ) {
2082                 if ( !array_key_exists( $header, $this->mVaryHeader ) ) {
2083                         $this->mVaryHeader[$header] = [];
2084                 }
2085                 if ( !is_array( $option ) ) {
2086                         $option = [];
2087                 }
2088                 $this->mVaryHeader[$header] = array_unique( array_merge( $this->mVaryHeader[$header], $option ) );
2089         }
2090
2091         /**
2092          * Return a Vary: header on which to vary caches. Based on the keys of $mVaryHeader,
2093          * such as Accept-Encoding or Cookie
2094          *
2095          * @return string
2096          */
2097         public function getVaryHeader() {
2098                 // If we vary on cookies, let's make sure it's always included here too.
2099                 if ( $this->getCacheVaryCookies() ) {
2100                         $this->addVaryHeader( 'Cookie' );
2101                 }
2102
2103                 foreach ( SessionManager::singleton()->getVaryHeaders() as $header => $options ) {
2104                         $this->addVaryHeader( $header, $options );
2105                 }
2106                 return 'Vary: ' . implode( ', ', array_keys( $this->mVaryHeader ) );
2107         }
2108
2109         /**
2110          * Add an HTTP Link: header
2111          *
2112          * @param string $header Header value
2113          */
2114         public function addLinkHeader( $header ) {
2115                 $this->mLinkHeader[] = $header;
2116         }
2117
2118         /**
2119          * Return a Link: header. Based on the values of $mLinkHeader.
2120          *
2121          * @return string
2122          */
2123         public function getLinkHeader() {
2124                 if ( !$this->mLinkHeader ) {
2125                         return false;
2126                 }
2127
2128                 return 'Link: ' . implode( ',', $this->mLinkHeader );
2129         }
2130
2131         /**
2132          * Get a complete Key header
2133          *
2134          * @return string
2135          */
2136         public function getKeyHeader() {
2137                 $cvCookies = $this->getCacheVaryCookies();
2138
2139                 $cookiesOption = [];
2140                 foreach ( $cvCookies as $cookieName ) {
2141                         $cookiesOption[] = 'param=' . $cookieName;
2142                 }
2143                 $this->addVaryHeader( 'Cookie', $cookiesOption );
2144
2145                 foreach ( SessionManager::singleton()->getVaryHeaders() as $header => $options ) {
2146                         $this->addVaryHeader( $header, $options );
2147                 }
2148
2149                 $headers = [];
2150                 foreach ( $this->mVaryHeader as $header => $option ) {
2151                         $newheader = $header;
2152                         if ( is_array( $option ) && count( $option ) > 0 ) {
2153                                 $newheader .= ';' . implode( ';', $option );
2154                         }
2155                         $headers[] = $newheader;
2156                 }
2157                 $key = 'Key: ' . implode( ',', $headers );
2158
2159                 return $key;
2160         }
2161
2162         /**
2163          * T23672: Add Accept-Language to Vary and Key headers
2164          * if there's no 'variant' parameter existed in GET.
2165          *
2166          * For example:
2167          *   /w/index.php?title=Main_page should always be served; but
2168          *   /w/index.php?title=Main_page&variant=zh-cn should never be served.
2169          */
2170         function addAcceptLanguage() {
2171                 $title = $this->getTitle();
2172                 if ( !$title instanceof Title ) {
2173                         return;
2174                 }
2175
2176                 $lang = $title->getPageLanguage();
2177                 if ( !$this->getRequest()->getCheck( 'variant' ) && $lang->hasVariants() ) {
2178                         $variants = $lang->getVariants();
2179                         $aloption = [];
2180                         foreach ( $variants as $variant ) {
2181                                 if ( $variant === $lang->getCode() ) {
2182                                         continue;
2183                                 } else {
2184                                         $aloption[] = 'substr=' . $variant;
2185
2186                                         // IE and some other browsers use BCP 47 standards in
2187                                         // their Accept-Language header, like "zh-CN" or "zh-Hant".
2188                                         // We should handle these too.
2189                                         $variantBCP47 = wfBCP47( $variant );
2190                                         if ( $variantBCP47 !== $variant ) {
2191                                                 $aloption[] = 'substr=' . $variantBCP47;
2192                                         }
2193                                 }
2194                         }
2195                         $this->addVaryHeader( 'Accept-Language', $aloption );
2196                 }
2197         }
2198
2199         /**
2200          * Set a flag which will cause an X-Frame-Options header appropriate for
2201          * edit pages to be sent. The header value is controlled by
2202          * $wgEditPageFrameOptions.
2203          *
2204          * This is the default for special pages. If you display a CSRF-protected
2205          * form on an ordinary view page, then you need to call this function.
2206          *
2207          * @param bool $enable
2208          */
2209         public function preventClickjacking( $enable = true ) {
2210                 $this->mPreventClickjacking = $enable;
2211         }
2212
2213         /**
2214          * Turn off frame-breaking. Alias for $this->preventClickjacking(false).
2215          * This can be called from pages which do not contain any CSRF-protected
2216          * HTML form.
2217          */
2218         public function allowClickjacking() {
2219                 $this->mPreventClickjacking = false;
2220         }
2221
2222         /**
2223          * Get the prevent-clickjacking flag
2224          *
2225          * @since 1.24
2226          * @return bool
2227          */
2228         public function getPreventClickjacking() {
2229                 return $this->mPreventClickjacking;
2230         }
2231
2232         /**
2233          * Get the X-Frame-Options header value (without the name part), or false
2234          * if there isn't one. This is used by Skin to determine whether to enable
2235          * JavaScript frame-breaking, for clients that don't support X-Frame-Options.
2236          *
2237          * @return string|false
2238          */
2239         public function getFrameOptions() {
2240                 $config = $this->getConfig();
2241                 if ( $config->get( 'BreakFrames' ) ) {
2242                         return 'DENY';
2243                 } elseif ( $this->mPreventClickjacking && $config->get( 'EditPageFrameOptions' ) ) {
2244                         return $config->get( 'EditPageFrameOptions' );
2245                 }
2246                 return false;
2247         }
2248
2249         /**
2250          * Send cache control HTTP headers
2251          */
2252         public function sendCacheControl() {
2253                 $response = $this->getRequest()->response();
2254                 $config = $this->getConfig();
2255
2256                 $this->addVaryHeader( 'Cookie' );
2257                 $this->addAcceptLanguage();
2258
2259                 # don't serve compressed data to clients who can't handle it
2260                 # maintain different caches for logged-in users and non-logged in ones
2261                 $response->header( $this->getVaryHeader() );
2262
2263                 if ( $config->get( 'UseKeyHeader' ) ) {
2264                         $response->header( $this->getKeyHeader() );
2265                 }
2266
2267                 if ( $this->mEnableClientCache ) {
2268                         if (
2269                                 $config->get( 'UseSquid' ) &&
2270                                 !$response->hasCookies() &&
2271                                 !SessionManager::getGlobalSession()->isPersistent() &&
2272                                 !$this->isPrintable() &&
2273                                 $this->mCdnMaxage != 0 &&
2274                                 !$this->haveCacheVaryCookies()
2275                         ) {
2276                                 if ( $config->get( 'UseESI' ) ) {
2277                                         # We'll purge the proxy cache explicitly, but require end user agents
2278                                         # to revalidate against the proxy on each visit.
2279                                         # Surrogate-Control controls our CDN, Cache-Control downstream caches
2280                                         wfDebug( __METHOD__ .
2281                                                 ": proxy caching with ESI; {$this->mLastModified} **", 'private' );
2282                                         # start with a shorter timeout for initial testing
2283                                         # header( 'Surrogate-Control: max-age=2678400+2678400, content="ESI/1.0"');
2284                                         $response->header(
2285                                                 "Surrogate-Control: max-age={$config->get( 'SquidMaxage' )}" .
2286                                                 "+{$this->mCdnMaxage}, content=\"ESI/1.0\""
2287                                         );
2288                                         $response->header( 'Cache-Control: s-maxage=0, must-revalidate, max-age=0' );
2289                                 } else {
2290                                         # We'll purge the proxy cache for anons explicitly, but require end user agents
2291                                         # to revalidate against the proxy on each visit.
2292                                         # IMPORTANT! The CDN needs to replace the Cache-Control header with
2293                                         # Cache-Control: s-maxage=0, must-revalidate, max-age=0
2294                                         wfDebug( __METHOD__ .
2295                                                 ": local proxy caching; {$this->mLastModified} **", 'private' );
2296                                         # start with a shorter timeout for initial testing
2297                                         # header( "Cache-Control: s-maxage=2678400, must-revalidate, max-age=0" );
2298                                         $response->header( "Cache-Control: " .
2299                                                 "s-maxage={$this->mCdnMaxage}, must-revalidate, max-age=0" );
2300                                 }
2301                         } else {
2302                                 # We do want clients to cache if they can, but they *must* check for updates
2303                                 # on revisiting the page.
2304                                 wfDebug( __METHOD__ . ": private caching; {$this->mLastModified} **", 'private' );
2305                                 $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
2306                                 $response->header( "Cache-Control: private, must-revalidate, max-age=0" );
2307                         }
2308                         if ( $this->mLastModified ) {
2309                                 $response->header( "Last-Modified: {$this->mLastModified}" );
2310                         }
2311                 } else {
2312                         wfDebug( __METHOD__ . ": no caching **", 'private' );
2313
2314                         # In general, the absence of a last modified header should be enough to prevent
2315                         # the client from using its cache. We send a few other things just to make sure.
2316                         $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
2317                         $response->header( 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate' );
2318                         $response->header( 'Pragma: no-cache' );
2319                 }
2320         }
2321
2322         /**
2323          * Finally, all the text has been munged and accumulated into
2324          * the object, let's actually output it:
2325          *
2326          * @param bool $return Set to true to get the result as a string rather than sending it
2327          * @return string|null
2328          * @throws Exception
2329          * @throws FatalError
2330          * @throws MWException
2331          */
2332         public function output( $return = false ) {
2333                 global $wgContLang;
2334
2335                 if ( $this->mDoNothing ) {
2336                         return $return ? '' : null;
2337                 }
2338
2339                 $response = $this->getRequest()->response();
2340                 $config = $this->getConfig();
2341
2342                 if ( $this->mRedirect != '' ) {
2343                         # Standards require redirect URLs to be absolute
2344                         $this->mRedirect = wfExpandUrl( $this->mRedirect, PROTO_CURRENT );
2345
2346                         $redirect = $this->mRedirect;
2347                         $code = $this->mRedirectCode;
2348
2349                         if ( Hooks::run( "BeforePageRedirect", [ $this, &$redirect, &$code ] ) ) {
2350                                 if ( $code == '301' || $code == '303' ) {
2351                                         if ( !$config->get( 'DebugRedirects' ) ) {
2352                                                 $response->statusHeader( $code );
2353                                         }
2354                                         $this->mLastModified = wfTimestamp( TS_RFC2822 );
2355                                 }
2356                                 if ( $config->get( 'VaryOnXFP' ) ) {
2357                                         $this->addVaryHeader( 'X-Forwarded-Proto' );
2358                                 }
2359                                 $this->sendCacheControl();
2360
2361                                 $response->header( "Content-Type: text/html; charset=utf-8" );
2362                                 if ( $config->get( 'DebugRedirects' ) ) {
2363                                         $url = htmlspecialchars( $redirect );
2364                                         print "<!DOCTYPE html>\n<html>\n<head>\n<title>Redirect</title>\n</head>\n<body>\n";
2365                                         print "<p>Location: <a href=\"$url\">$url</a></p>\n";
2366                                         print "</body>\n</html>\n";
2367                                 } else {
2368                                         $response->header( 'Location: ' . $redirect );
2369                                 }
2370                         }
2371
2372                         return $return ? '' : null;
2373                 } elseif ( $this->mStatusCode ) {
2374                         $response->statusHeader( $this->mStatusCode );
2375                 }
2376
2377                 # Buffer output; final headers may depend on later processing
2378                 ob_start();
2379
2380                 $response->header( 'Content-type: ' . $config->get( 'MimeType' ) . '; charset=UTF-8' );
2381                 $response->header( 'Content-language: ' . $wgContLang->getHtmlCode() );
2382
2383                 // Avoid Internet Explorer "compatibility view" in IE 8-10, so that
2384                 // jQuery etc. can work correctly.
2385                 $response->header( 'X-UA-Compatible: IE=Edge' );
2386
2387                 if ( !$this->mArticleBodyOnly ) {
2388                         $sk = $this->getSkin();
2389
2390                         if ( $sk->shouldPreloadLogo() ) {
2391                                 $this->addLogoPreloadLinkHeaders();
2392                         }
2393                 }
2394
2395                 $linkHeader = $this->getLinkHeader();
2396                 if ( $linkHeader ) {
2397                         $response->header( $linkHeader );
2398                 }
2399
2400                 // Prevent framing, if requested
2401                 $frameOptions = $this->getFrameOptions();
2402                 if ( $frameOptions ) {
2403                         $response->header( "X-Frame-Options: $frameOptions" );
2404                 }
2405
2406                 if ( $this->mArticleBodyOnly ) {
2407                         echo $this->mBodytext;
2408                 } else {
2409                         // Enable safe mode if requested
2410                         if ( $this->getRequest()->getBool( 'safemode' ) ) {
2411                                 $this->disallowUserJs();
2412                         }
2413
2414                         $sk = $this->getSkin();
2415                         foreach ( $sk->getDefaultModules() as $group ) {
2416                                 $this->addModules( $group );
2417                         }
2418
2419                         MWDebug::addModules( $this );
2420
2421                         // Avoid PHP 7.1 warning of passing $this by reference
2422                         $outputPage = $this;
2423                         // Hook that allows last minute changes to the output page, e.g.
2424                         // adding of CSS or Javascript by extensions.
2425                         Hooks::run( 'BeforePageDisplay', [ &$outputPage, &$sk ] );
2426
2427                         try {
2428                                 $sk->outputPage();
2429                         } catch ( Exception $e ) {
2430                                 ob_end_clean(); // bug T129657
2431                                 throw $e;
2432                         }
2433                 }
2434
2435                 try {
2436                         // This hook allows last minute changes to final overall output by modifying output buffer
2437                         Hooks::run( 'AfterFinalPageOutput', [ $this ] );
2438                 } catch ( Exception $e ) {
2439                         ob_end_clean(); // bug T129657
2440                         throw $e;
2441                 }
2442
2443                 $this->sendCacheControl();
2444
2445                 if ( $return ) {
2446                         return ob_get_clean();
2447                 } else {
2448                         ob_end_flush();
2449                         return null;
2450                 }
2451         }
2452
2453         /**
2454          * Prepare this object to display an error page; disable caching and
2455          * indexing, clear the current text and redirect, set the page's title
2456          * and optionally an custom HTML title (content of the "<title>" tag).
2457          *
2458          * @param string|Message $pageTitle Will be passed directly to setPageTitle()
2459          * @param string|Message $htmlTitle Will be passed directly to setHTMLTitle();
2460          *                   optional, if not passed the "<title>" attribute will be
2461          *                   based on $pageTitle
2462          */
2463         public function prepareErrorPage( $pageTitle, $htmlTitle = false ) {
2464                 $this->setPageTitle( $pageTitle );
2465                 if ( $htmlTitle !== false ) {
2466                         $this->setHTMLTitle( $htmlTitle );
2467                 }
2468                 $this->setRobotPolicy( 'noindex,nofollow' );
2469                 $this->setArticleRelated( false );
2470                 $this->enableClientCache( false );
2471                 $this->mRedirect = '';
2472                 $this->clearSubtitle();
2473                 $this->clearHTML();
2474         }
2475
2476         /**
2477          * Output a standard error page
2478          *
2479          * showErrorPage( 'titlemsg', 'pagetextmsg' );
2480          * showErrorPage( 'titlemsg', 'pagetextmsg', [ 'param1', 'param2' ] );
2481          * showErrorPage( 'titlemsg', $messageObject );
2482          * showErrorPage( $titleMessageObject, $messageObject );
2483          *
2484          * @param string|Message $title Message key (string) for page title, or a Message object
2485          * @param string|Message $msg Message key (string) for page text, or a Message object
2486          * @param array $params Message parameters; ignored if $msg is a Message object
2487          */
2488         public function showErrorPage( $title, $msg, $params = [] ) {
2489                 if ( !$title instanceof Message ) {
2490                         $title = $this->msg( $title );
2491                 }
2492
2493                 $this->prepareErrorPage( $title );
2494
2495                 if ( $msg instanceof Message ) {
2496                         if ( $params !== [] ) {
2497                                 trigger_error( 'Argument ignored: $params. The message parameters argument '
2498                                         . 'is discarded when the $msg argument is a Message object instead of '
2499                                         . 'a string.', E_USER_NOTICE );
2500                         }
2501                         $this->addHTML( $msg->parseAsBlock() );
2502                 } else {
2503                         $this->addWikiMsgArray( $msg, $params );
2504                 }
2505
2506                 $this->returnToMain();
2507         }
2508
2509         /**
2510          * Output a standard permission error page
2511          *
2512          * @param array $errors Error message keys or [key, param...] arrays
2513          * @param string $action Action that was denied or null if unknown
2514          */
2515         public function showPermissionsErrorPage( array $errors, $action = null ) {
2516                 foreach ( $errors as $key => $error ) {
2517                         $errors[$key] = (array)$error;
2518                 }
2519
2520                 // For some action (read, edit, create and upload), display a "login to do this action"
2521                 // error if all of the following conditions are met:
2522                 // 1. the user is not logged in
2523                 // 2. the only error is insufficient permissions (i.e. no block or something else)
2524                 // 3. the error can be avoided simply by logging in
2525                 if ( in_array( $action, [ 'read', 'edit', 'createpage', 'createtalk', 'upload' ] )
2526                         && $this->getUser()->isAnon() && count( $errors ) == 1 && isset( $errors[0][0] )
2527                         && ( $errors[0][0] == 'badaccess-groups' || $errors[0][0] == 'badaccess-group0' )
2528                         && ( User::groupHasPermission( 'user', $action )
2529                         || User::groupHasPermission( 'autoconfirmed', $action ) )
2530                 ) {
2531                         $displayReturnto = null;
2532
2533                         # Due to T34276, if a user does not have read permissions,
2534                         # $this->getTitle() will just give Special:Badtitle, which is
2535                         # not especially useful as a returnto parameter. Use the title
2536                         # from the request instead, if there was one.
2537                         $request = $this->getRequest();
2538                         $returnto = Title::newFromText( $request->getVal( 'title', '' ) );
2539                         if ( $action == 'edit' ) {
2540                                 $msg = 'whitelistedittext';
2541                                 $displayReturnto = $returnto;
2542                         } elseif ( $action == 'createpage' || $action == 'createtalk' ) {
2543                                 $msg = 'nocreatetext';
2544                         } elseif ( $action == 'upload' ) {
2545                                 $msg = 'uploadnologintext';
2546                         } else { # Read
2547                                 $msg = 'loginreqpagetext';
2548                                 $displayReturnto = Title::newMainPage();
2549                         }
2550
2551                         $query = [];
2552
2553                         if ( $returnto ) {
2554                                 $query['returnto'] = $returnto->getPrefixedText();
2555
2556                                 if ( !$request->wasPosted() ) {
2557                                         $returntoquery = $request->getValues();
2558                                         unset( $returntoquery['title'] );
2559                                         unset( $returntoquery['returnto'] );
2560                                         unset( $returntoquery['returntoquery'] );
2561                                         $query['returntoquery'] = wfArrayToCgi( $returntoquery );
2562                                 }
2563                         }
2564                         $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
2565                         $loginLink = $linkRenderer->makeKnownLink(
2566                                 SpecialPage::getTitleFor( 'Userlogin' ),
2567                                 $this->msg( 'loginreqlink' )->text(),
2568                                 [],
2569                                 $query
2570                         );
2571
2572                         $this->prepareErrorPage( $this->msg( 'loginreqtitle' ) );
2573                         $this->addHTML( $this->msg( $msg )->rawParams( $loginLink )->parse() );
2574
2575                         # Don't return to a page the user can't read otherwise
2576                         # we'll end up in a pointless loop
2577                         if ( $displayReturnto && $displayReturnto->userCan( 'read', $this->getUser() ) ) {
2578                                 $this->returnToMain( null, $displayReturnto );
2579                         }
2580                 } else {
2581                         $this->prepareErrorPage( $this->msg( 'permissionserrors' ) );
2582                         $this->addWikiText( $this->formatPermissionsErrorMessage( $errors, $action ) );
2583                 }
2584         }
2585
2586         /**
2587          * Display an error page indicating that a given version of MediaWiki is
2588          * required to use it
2589          *
2590          * @param mixed $version The version of MediaWiki needed to use the page
2591          */
2592         public function versionRequired( $version ) {
2593                 $this->prepareErrorPage( $this->msg( 'versionrequired', $version ) );
2594
2595                 $this->addWikiMsg( 'versionrequiredtext', $version );
2596                 $this->returnToMain();
2597         }
2598
2599         /**
2600          * Format a list of error messages
2601          *
2602          * @param array $errors Array of arrays returned by Title::getUserPermissionsErrors
2603          * @param string $action Action that was denied or null if unknown
2604          * @return string The wikitext error-messages, formatted into a list.
2605          */
2606         public function formatPermissionsErrorMessage( array $errors, $action = null ) {
2607                 if ( $action == null ) {
2608                         $text = $this->msg( 'permissionserrorstext', count( $errors ) )->plain() . "\n\n";
2609                 } else {
2610                         $action_desc = $this->msg( "action-$action" )->plain();
2611                         $text = $this->msg(
2612                                 'permissionserrorstext-withaction',
2613                                 count( $errors ),
2614                                 $action_desc
2615                         )->plain() . "\n\n";
2616                 }
2617
2618                 if ( count( $errors ) > 1 ) {
2619                         $text .= '<ul class="permissions-errors">' . "\n";
2620
2621                         foreach ( $errors as $error ) {
2622                                 $text .= '<li>';
2623                                 $text .= call_user_func_array( [ $this, 'msg' ], $error )->plain();
2624                                 $text .= "</li>\n";
2625                         }
2626                         $text .= '</ul>';
2627                 } else {
2628                         $text .= "<div class=\"permissions-errors\">\n" .
2629                                         call_user_func_array( [ $this, 'msg' ], reset( $errors ) )->plain() .
2630                                         "\n</div>";
2631                 }
2632
2633                 return $text;
2634         }
2635
2636         /**
2637          * Display a page stating that the Wiki is in read-only mode.
2638          * Should only be called after wfReadOnly() has returned true.
2639          *
2640          * Historically, this function was used to show the source of the page that the user
2641          * was trying to edit and _also_ permissions error messages. The relevant code was
2642          * moved into EditPage in 1.19 (r102024 / d83c2a431c2a) and removed here in 1.25.
2643          *
2644          * @deprecated since 1.25; throw the exception directly
2645          * @throws ReadOnlyError
2646          */
2647         public function readOnlyPage() {
2648                 if ( func_num_args() > 0 ) {
2649                         throw new MWException( __METHOD__ . ' no longer accepts arguments since 1.25.' );
2650                 }
2651
2652                 throw new ReadOnlyError;
2653         }
2654
2655         /**
2656          * Turn off regular page output and return an error response
2657          * for when rate limiting has triggered.
2658          *
2659          * @deprecated since 1.25; throw the exception directly
2660          */
2661         public function rateLimited() {
2662                 wfDeprecated( __METHOD__, '1.25' );
2663                 throw new ThrottledError;
2664         }
2665
2666         /**
2667          * Show a warning about replica DB lag
2668          *
2669          * If the lag is higher than $wgSlaveLagCritical seconds,
2670          * then the warning is a bit more obvious. If the lag is
2671          * lower than $wgSlaveLagWarning, then no warning is shown.
2672          *
2673          * @param int $lag Slave lag
2674          */
2675         public function showLagWarning( $lag ) {
2676                 $config = $this->getConfig();
2677                 if ( $lag >= $config->get( 'SlaveLagWarning' ) ) {
2678                         $lag = floor( $lag ); // floor to avoid nano seconds to display
2679                         $message = $lag < $config->get( 'SlaveLagCritical' )
2680                                 ? 'lag-warn-normal'
2681                                 : 'lag-warn-high';
2682                         $wrap = Html::rawElement( 'div', [ 'class' => "mw-{$message}" ], "\n$1\n" );
2683                         $this->wrapWikiMsg( "$wrap\n", [ $message, $this->getLanguage()->formatNum( $lag ) ] );
2684                 }
2685         }
2686
2687         public function showFatalError( $message ) {
2688                 $this->prepareErrorPage( $this->msg( 'internalerror' ) );
2689
2690                 $this->addHTML( $message );
2691         }
2692
2693         public function showUnexpectedValueError( $name, $val ) {
2694                 $this->showFatalError( $this->msg( 'unexpected', $name, $val )->text() );
2695         }
2696
2697         public function showFileCopyError( $old, $new ) {
2698                 $this->showFatalError( $this->msg( 'filecopyerror', $old, $new )->text() );
2699         }
2700
2701         public function showFileRenameError( $old, $new ) {
2702                 $this->showFatalError( $this->msg( 'filerenameerror', $old, $new )->text() );
2703         }
2704
2705         public function showFileDeleteError( $name ) {
2706                 $this->showFatalError( $this->msg( 'filedeleteerror', $name )->text() );
2707         }
2708
2709         public function showFileNotFoundError( $name ) {
2710                 $this->showFatalError( $this->msg( 'filenotfound', $name )->text() );
2711         }
2712
2713         /**
2714          * Add a "return to" link pointing to a specified title
2715          *
2716          * @param Title $title Title to link
2717          * @param array $query Query string parameters
2718          * @param string $text Text of the link (input is not escaped)
2719          * @param array $options Options array to pass to Linker
2720          */
2721         public function addReturnTo( $title, array $query = [], $text = null, $options = [] ) {
2722                 $linkRenderer = MediaWikiServices::getInstance()
2723                         ->getLinkRendererFactory()->createFromLegacyOptions( $options );
2724                 $link = $this->msg( 'returnto' )->rawParams(
2725                         $linkRenderer->makeLink( $title, $text, [], $query ) )->escaped();
2726                 $this->addHTML( "<p id=\"mw-returnto\">{$link}</p>\n" );
2727         }
2728
2729         /**
2730          * Add a "return to" link pointing to a specified title,
2731          * or the title indicated in the request, or else the main page
2732          *
2733          * @param mixed $unused
2734          * @param Title|string $returnto Title or String to return to
2735          * @param string $returntoquery Query string for the return to link
2736          */
2737         public function returnToMain( $unused = null, $returnto = null, $returntoquery = null ) {
2738                 if ( $returnto == null ) {
2739                         $returnto = $this->getRequest()->getText( 'returnto' );
2740                 }
2741
2742                 if ( $returntoquery == null ) {
2743                         $returntoquery = $this->getRequest()->getText( 'returntoquery' );
2744                 }
2745
2746                 if ( $returnto === '' ) {
2747                         $returnto = Title::newMainPage();
2748                 }
2749
2750                 if ( is_object( $returnto ) ) {
2751                         $titleObj = $returnto;
2752                 } else {
2753                         $titleObj = Title::newFromText( $returnto );
2754                 }
2755                 // We don't want people to return to external interwiki. That
2756                 // might potentially be used as part of a phishing scheme
2757                 if ( !is_object( $titleObj ) || $titleObj->isExternal() ) {
2758                         $titleObj = Title::newMainPage();
2759                 }
2760
2761                 $this->addReturnTo( $titleObj, wfCgiToArray( $returntoquery ) );
2762         }
2763
2764         private function getRlClientContext() {
2765                 if ( !$this->rlClientContext ) {
2766                         $query = ResourceLoader::makeLoaderQuery(
2767                                 [], // modules; not relevant
2768                                 $this->getLanguage()->getCode(),
2769                                 $this->getSkin()->getSkinName(),
2770                                 $this->getUser()->isLoggedIn() ? $this->getUser()->getName() : null,
2771                                 null, // version; not relevant
2772                                 ResourceLoader::inDebugMode(),
2773                                 null, // only; not relevant
2774                                 $this->isPrintable(),
2775                                 $this->getRequest()->getBool( 'handheld' )
2776                         );
2777                         $this->rlClientContext = new ResourceLoaderContext(
2778                                 $this->getResourceLoader(),
2779                                 new FauxRequest( $query )
2780                         );
2781                 }
2782                 return $this->rlClientContext;
2783         }
2784
2785         /**
2786          * Call this to freeze the module queue and JS config and create a formatter.
2787          *
2788          * Depending on the Skin, this may get lazy-initialised in either headElement() or
2789          * getBottomScripts(). See SkinTemplate::prepareQuickTemplate(). Calling this too early may
2790          * cause unexpected side-effects since disallowUserJs() may be called at any time to change
2791          * the module filters retroactively. Skins and extension hooks may also add modules until very
2792          * late in the request lifecycle.
2793          *
2794          * @return ResourceLoaderClientHtml
2795          */
2796         public function getRlClient() {
2797                 if ( !$this->rlClient ) {
2798                         $context = $this->getRlClientContext();
2799                         $rl = $this->getResourceLoader();
2800                         $this->addModules( [
2801                                 'user.options',
2802                                 'user.tokens',
2803                         ] );
2804                         $this->addModuleStyles( [
2805                                 'site.styles',
2806                                 'noscript',
2807                                 'user.styles',
2808                         ] );
2809                         $this->getSkin()->setupSkinUserCss( $this );
2810
2811                         // Prepare exempt modules for buildExemptModules()
2812                         $exemptGroups = [ 'site' => [], 'noscript' => [], 'private' => [], 'user' => [] ];
2813                         $exemptStates = [];
2814                         $moduleStyles = $this->getModuleStyles( /*filter*/ true );
2815
2816                         // Preload getTitleInfo for isKnownEmpty calls below and in ResourceLoaderClientHtml
2817                         // Separate user-specific batch for improved cache-hit ratio.
2818                         $userBatch = [ 'user.styles', 'user' ];
2819                         $siteBatch = array_diff( $moduleStyles, $userBatch );
2820                         $dbr = wfGetDB( DB_REPLICA );
2821                         ResourceLoaderWikiModule::preloadTitleInfo( $context, $dbr, $siteBatch );
2822                         ResourceLoaderWikiModule::preloadTitleInfo( $context, $dbr, $userBatch );
2823
2824                         // Filter out modules handled by buildExemptModules()
2825                         $moduleStyles = array_filter( $moduleStyles,
2826                                 function ( $name ) use ( $rl, $context, &$exemptGroups, &$exemptStates ) {
2827                                         $module = $rl->getModule( $name );
2828                                         if ( $module ) {
2829                                                 if ( $name === 'user.styles' && $this->isUserCssPreview() ) {
2830                                                         $exemptStates[$name] = 'ready';
2831                                                         // Special case in buildExemptModules()
2832                                                         return false;
2833                                                 }
2834                                                 $group = $module->getGroup();
2835                                                 if ( isset( $exemptGroups[$group] ) ) {
2836                                                         $exemptStates[$name] = 'ready';
2837                                                         if ( !$module->isKnownEmpty( $context ) ) {
2838                                                                 // E.g. Don't output empty <styles>
2839                                                                 $exemptGroups[$group][] = $name;
2840                                                         }
2841                                                         return false;
2842                                                 }
2843                                         }
2844                                         return true;
2845                                 }
2846                         );
2847                         $this->rlExemptStyleModules = $exemptGroups;
2848
2849                         $isUserModuleFiltered = !$this->filterModules( [ 'user' ] );
2850                         // If this page filters out 'user', makeResourceLoaderLink will drop it.
2851                         // Avoid indefinite "loading" state or untrue "ready" state (T145368).
2852                         if ( !$isUserModuleFiltered ) {
2853                                 // Manually handled by getBottomScripts()
2854                                 $userModule = $rl->getModule( 'user' );
2855                                 $userState = $userModule->isKnownEmpty( $context ) && !$this->isUserJsPreview()
2856                                         ? 'ready'
2857                                         : 'loading';
2858                                 $this->rlUserModuleState = $exemptStates['user'] = $userState;
2859                         }
2860
2861                         $rlClient = new ResourceLoaderClientHtml( $context, $this->getTarget() );
2862                         $rlClient->setConfig( $this->getJSVars() );
2863                         $rlClient->setModules( $this->getModules( /*filter*/ true ) );
2864                         $rlClient->setModuleStyles( $moduleStyles );
2865                         $rlClient->setModuleScripts( $this->getModuleScripts( /*filter*/ true ) );
2866                         $rlClient->setExemptStates( $exemptStates );
2867                         $this->rlClient = $rlClient;
2868                 }
2869                 return $this->rlClient;
2870         }
2871
2872         /**
2873          * @param Skin $sk The given Skin
2874          * @param bool $includeStyle Unused
2875          * @return string The doctype, opening "<html>", and head element.
2876          */
2877         public function headElement( Skin $sk, $includeStyle = true ) {
2878                 global $wgContLang;
2879
2880                 $userdir = $this->getLanguage()->getDir();
2881                 $sitedir = $wgContLang->getDir();
2882
2883                 $pieces = [];
2884                 $pieces[] = Html::htmlHeader( Sanitizer::mergeAttributes(
2885                         $this->getRlClient()->getDocumentAttributes(),
2886                         $sk->getHtmlElementAttributes()
2887                 ) );
2888                 $pieces[] = Html::openElement( 'head' );
2889
2890                 if ( $this->getHTMLTitle() == '' ) {
2891                         $this->setHTMLTitle( $this->msg( 'pagetitle', $this->getPageTitle() )->inContentLanguage() );
2892                 }
2893
2894                 if ( !Html::isXmlMimeType( $this->getConfig()->get( 'MimeType' ) ) ) {
2895                         // Add <meta charset="UTF-8">
2896                         // This should be before <title> since it defines the charset used by
2897                         // text including the text inside <title>.
2898                         // The spec recommends defining XHTML5's charset using the XML declaration
2899                         // instead of meta.
2900                         // Our XML declaration is output by Html::htmlHeader.
2901                         // https://html.spec.whatwg.org/multipage/semantics.html#attr-meta-http-equiv-content-type
2902                         // https://html.spec.whatwg.org/multipage/semantics.html#charset
2903                         $pieces[] = Html::element( 'meta', [ 'charset' => 'UTF-8' ] );
2904                 }
2905
2906                 $pieces[] = Html::element( 'title', null, $this->getHTMLTitle() );
2907                 $pieces[] = $this->getRlClient()->getHeadHtml();
2908                 $pieces[] = $this->buildExemptModules();
2909                 $pieces = array_merge( $pieces, array_values( $this->getHeadLinksArray() ) );
2910                 $pieces = array_merge( $pieces, array_values( $this->mHeadItems ) );
2911
2912                 $min = ResourceLoader::inDebugMode() ? '' : '.min';
2913                 // Use an IE conditional comment to serve the script only to old IE
2914                 $pieces[] = '<!--[if lt IE 9]>' .
2915                         Html::element( 'script', [
2916                                 'src' => OutputPage::transformResourcePath(
2917                                         $this->getConfig(),
2918                                         "/resources/lib/html5shiv/html5shiv{$min}.js"
2919                                 ),
2920                         ] ) .
2921                         '<![endif]-->';
2922
2923                 $pieces[] = Html::closeElement( 'head' );
2924
2925                 $bodyClasses = [];
2926                 $bodyClasses[] = 'mediawiki';
2927
2928                 # Classes for LTR/RTL directionality support
2929                 $bodyClasses[] = $userdir;
2930                 $bodyClasses[] = "sitedir-$sitedir";
2931
2932                 $underline = $this->getUser()->getOption( 'underline' );
2933                 if ( $underline < 2 ) {
2934                         // The following classes can be used here:
2935                         // * mw-underline-always
2936                         // * mw-underline-never
2937                         $bodyClasses[] = 'mw-underline-' . ( $underline ? 'always' : 'never' );
2938                 }
2939
2940                 if ( $this->getLanguage()->capitalizeAllNouns() ) {
2941                         # A <body> class is probably not the best way to do this . . .
2942                         $bodyClasses[] = 'capitalize-all-nouns';
2943                 }
2944
2945                 // Parser feature migration class
2946                 // The idea is that this will eventually be removed, after the wikitext
2947                 // which requires it is cleaned up.
2948                 $bodyClasses[] = 'mw-hide-empty-elt';
2949
2950                 $bodyClasses[] = $sk->getPageClasses( $this->getTitle() );
2951                 $bodyClasses[] = 'skin-' . Sanitizer::escapeClass( $sk->getSkinName() );
2952                 $bodyClasses[] =
2953                         'action-' . Sanitizer::escapeClass( Action::getActionName( $this->getContext() ) );
2954
2955                 $bodyAttrs = [];
2956                 // While the implode() is not strictly needed, it's used for backwards compatibility
2957                 // (this used to be built as a string and hooks likely still expect that).
2958                 $bodyAttrs['class'] = implode( ' ', $bodyClasses );
2959
2960                 // Allow skins and extensions to add body attributes they need
2961                 $sk->addToBodyAttributes( $this, $bodyAttrs );
2962                 Hooks::run( 'OutputPageBodyAttributes', [ $this, $sk, &$bodyAttrs ] );
2963
2964                 $pieces[] = Html::openElement( 'body', $bodyAttrs );
2965
2966                 return self::combineWrappedStrings( $pieces );
2967         }
2968
2969         /**
2970          * Get a ResourceLoader object associated with this OutputPage
2971          *
2972          * @return ResourceLoader
2973          */
2974         public function getResourceLoader() {
2975                 if ( is_null( $this->mResourceLoader ) ) {
2976                         $this->mResourceLoader = new ResourceLoader(
2977                                 $this->getConfig(),
2978                                 LoggerFactory::getInstance( 'resourceloader' )
2979                         );
2980                 }
2981                 return $this->mResourceLoader;
2982         }
2983
2984         /**
2985          * Explicily load or embed modules on a page.
2986          *
2987          * @param array|string $modules One or more module names
2988          * @param string $only ResourceLoaderModule TYPE_ class constant
2989          * @param array $extraQuery [optional] Array with extra query parameters for the request
2990          * @return string|WrappedStringList HTML
2991          */
2992         public function makeResourceLoaderLink( $modules, $only, array $extraQuery = [] ) {
2993                 // Apply 'target' and 'origin' filters
2994                 $modules = $this->filterModules( (array)$modules, null, $only );
2995
2996                 return ResourceLoaderClientHtml::makeLoad(
2997                         $this->getRlClientContext(),
2998                         $modules,
2999                         $only,
3000                         $extraQuery
3001                 );
3002         }
3003
3004         /**
3005          * Combine WrappedString chunks and filter out empty ones
3006          *
3007          * @param array $chunks
3008          * @return string|WrappedStringList HTML
3009          */
3010         protected static function combineWrappedStrings( array $chunks ) {
3011                 // Filter out empty values
3012                 $chunks = array_filter( $chunks, 'strlen' );
3013                 return WrappedString::join( "\n", $chunks );
3014         }
3015
3016         private function isUserJsPreview() {
3017                 return $this->getConfig()->get( 'AllowUserJs' )
3018                         && $this->getTitle()
3019                         && $this->getTitle()->isJsSubpage()
3020                         && $this->userCanPreview();
3021         }
3022
3023         protected function isUserCssPreview() {
3024                 return $this->getConfig()->get( 'AllowUserCss' )
3025                         && $this->getTitle()
3026                         && $this->getTitle()->isCssSubpage()
3027                         && $this->userCanPreview();
3028         }
3029
3030         /**
3031          * JS stuff to put at the bottom of the `<body>`. These are modules with position 'bottom',
3032          * legacy scripts ($this->mScripts), and user JS.
3033          *
3034          * @return string|WrappedStringList HTML
3035          */
3036         public function getBottomScripts() {
3037                 $chunks = [];
3038                 $chunks[] = $this->getRlClient()->getBodyHtml();
3039
3040                 // Legacy non-ResourceLoader scripts
3041                 $chunks[] = $this->mScripts;
3042
3043                 // Exempt 'user' module
3044                 // - May need excludepages for live preview. (T28283)
3045                 // - Must use TYPE_COMBINED so its response is handled by mw.loader.implement() which
3046                 //   ensures execution is scheduled after the "site" module.
3047                 // - Don't load if module state is already resolved as "ready".
3048                 if ( $this->rlUserModuleState === 'loading' ) {
3049                         if ( $this->isUserJsPreview() ) {
3050                                 $chunks[] = $this->makeResourceLoaderLink( 'user', ResourceLoaderModule::TYPE_COMBINED,
3051                                         [ 'excludepage' => $this->getTitle()->getPrefixedDBkey() ]
3052                                 );
3053                                 $chunks[] = ResourceLoader::makeInlineScript(
3054                                         Xml::encodeJsCall( 'mw.loader.using', [
3055                                                 [ 'user', 'site' ],
3056                                                 new XmlJsCode(
3057                                                         'function () {'
3058                                                                 . Xml::encodeJsCall( '$.globalEval', [
3059                                                                         $this->getRequest()->getText( 'wpTextbox1' )
3060                                                                 ] )
3061                                                                 . '}'
3062                                                 )
3063                                         ] )
3064                                 );
3065                                 // FIXME: If the user is previewing, say, ./vector.js, his ./common.js will be loaded
3066                                 // asynchronously and may arrive *after* the inline script here. So the previewed code
3067                                 // may execute before ./common.js runs. Normally, ./common.js runs before ./vector.js.
3068                                 // Similarly, when previewing ./common.js and the user module does arrive first,
3069                                 // it will arrive without common.js and the inline script runs after.
3070                                 // Thus running common after the excluded subpage.
3071                         } else {
3072                                 // Load normally
3073                                 $chunks[] = $this->makeResourceLoaderLink( 'user', ResourceLoaderModule::TYPE_COMBINED );
3074                         }
3075                 }
3076
3077                 if ( $this->limitReportJSData ) {
3078                         $chunks[] = ResourceLoader::makeInlineScript(
3079                                 ResourceLoader::makeConfigSetScript(
3080                                         [ 'wgPageParseReport' => $this->limitReportJSData ]
3081                                 )
3082                         );
3083                 }
3084
3085                 return self::combineWrappedStrings( $chunks );
3086         }
3087
3088         /**
3089          * Get the javascript config vars to include on this page
3090          *
3091          * @return array Array of javascript config vars
3092          * @since 1.23
3093          */
3094         public function getJsConfigVars() {
3095                 return $this->mJsConfigVars;
3096         }
3097
3098         /**
3099          * Add one or more variables to be set in mw.config in JavaScript
3100          *
3101          * @param string|array $keys Key or array of key/value pairs
3102          * @param mixed $value [optional] Value of the configuration variable
3103          */
3104         public function addJsConfigVars( $keys, $value = null ) {
3105                 if ( is_array( $keys ) ) {
3106                         foreach ( $keys as $key => $value ) {
3107                                 $this->mJsConfigVars[$key] = $value;
3108                         }
3109                         return;
3110                 }
3111
3112                 $this->mJsConfigVars[$keys] = $value;
3113         }
3114
3115         /**
3116          * Get an array containing the variables to be set in mw.config in JavaScript.
3117          *
3118          * Do not add things here which can be evaluated in ResourceLoaderStartUpModule
3119          * - in other words, page-independent/site-wide variables (without state).
3120          * You will only be adding bloat to the html page and causing page caches to
3121          * have to be purged on configuration changes.
3122          * @return array
3123          */
3124         public function getJSVars() {
3125                 global $wgContLang;
3126
3127                 $curRevisionId = 0;
3128                 $articleId = 0;
3129                 $canonicalSpecialPageName = false; # T23115
3130
3131                 $title = $this->getTitle();
3132                 $ns = $title->getNamespace();
3133                 $canonicalNamespace = MWNamespace::exists( $ns )
3134                         ? MWNamespace::getCanonicalName( $ns )
3135                         : $title->getNsText();
3136
3137                 $sk = $this->getSkin();
3138                 // Get the relevant title so that AJAX features can use the correct page name
3139                 // when making API requests from certain special pages (T36972).
3140                 $relevantTitle = $sk->getRelevantTitle();
3141                 $relevantUser = $sk->getRelevantUser();
3142
3143                 if ( $ns == NS_SPECIAL ) {
3144                         list( $canonicalSpecialPageName, /*...*/ ) =
3145                                 SpecialPageFactory::resolveAlias( $title->getDBkey() );
3146                 } elseif ( $this->canUseWikiPage() ) {
3147                         $wikiPage = $this->getWikiPage();
3148                         $curRevisionId = $wikiPage->getLatest();
3149                         $articleId = $wikiPage->getId();
3150                 }
3151
3152                 $lang = $title->getPageViewLanguage();
3153
3154                 // Pre-process information
3155                 $separatorTransTable = $lang->separatorTransformTable();
3156                 $separatorTransTable = $separatorTransTable ? $separatorTransTable : [];
3157                 $compactSeparatorTransTable = [
3158                         implode( "\t", array_keys( $separatorTransTable ) ),
3159                         implode( "\t", $separatorTransTable ),
3160                 ];
3161                 $digitTransTable = $lang->digitTransformTable();
3162                 $digitTransTable = $digitTransTable ? $digitTransTable : [];
3163                 $compactDigitTransTable = [
3164                         implode( "\t", array_keys( $digitTransTable ) ),
3165                         implode( "\t", $digitTransTable ),
3166                 ];
3167
3168                 $user = $this->getUser();
3169
3170                 $vars = [
3171                         'wgCanonicalNamespace' => $canonicalNamespace,
3172                         'wgCanonicalSpecialPageName' => $canonicalSpecialPageName,
3173                         'wgNamespaceNumber' => $title->getNamespace(),
3174                         'wgPageName' => $title->getPrefixedDBkey(),
3175                         'wgTitle' => $title->getText(),
3176                         'wgCurRevisionId' => $curRevisionId,
3177                         'wgRevisionId' => (int)$this->getRevisionId(),
3178                         'wgArticleId' => $articleId,
3179                         'wgIsArticle' => $this->isArticle(),
3180                         'wgIsRedirect' => $title->isRedirect(),
3181                         'wgAction' => Action::getActionName( $this->getContext() ),
3182                         'wgUserName' => $user->isAnon() ? null : $user->getName(),
3183                         'wgUserGroups' => $user->getEffectiveGroups(),
3184                         'wgCategories' => $this->getCategories(),
3185                         'wgBreakFrames' => $this->getFrameOptions() == 'DENY',
3186                         'wgPageContentLanguage' => $lang->getCode(),
3187                         'wgPageContentModel' => $title->getContentModel(),
3188                         'wgSeparatorTransformTable' => $compactSeparatorTransTable,
3189                         'wgDigitTransformTable' => $compactDigitTransTable,
3190                         'wgDefaultDateFormat' => $lang->getDefaultDateFormat(),
3191                         'wgMonthNames' => $lang->getMonthNamesArray(),
3192                         'wgMonthNamesShort' => $lang->getMonthAbbreviationsArray(),
3193                         'wgRelevantPageName' => $relevantTitle->getPrefixedDBkey(),
3194                         'wgRelevantArticleId' => $relevantTitle->getArticleID(),
3195                         'wgRequestId' => WebRequest::getRequestId(),
3196                 ];
3197
3198                 if ( $user->isLoggedIn() ) {
3199                         $vars['wgUserId'] = $user->getId();
3200                         $vars['wgUserEditCount'] = $user->getEditCount();
3201                         $userReg = $user->getRegistration();
3202                         $vars['wgUserRegistration'] = $userReg ? wfTimestamp( TS_UNIX, $userReg ) * 1000 : null;
3203                         // Get the revision ID of the oldest new message on the user's talk
3204                         // page. This can be used for constructing new message alerts on
3205                         // the client side.
3206                         $vars['wgUserNewMsgRevisionId'] = $user->getNewMessageRevisionId();
3207                 }
3208
3209                 if ( $wgContLang->hasVariants() ) {
3210                         $vars['wgUserVariant'] = $wgContLang->getPreferredVariant();
3211                 }
3212                 // Same test as SkinTemplate
3213                 $vars['wgIsProbablyEditable'] = $title->quickUserCan( 'edit', $user )
3214                         && ( $title->exists() || $title->quickUserCan( 'create', $user ) );
3215
3216                 $vars['wgRelevantPageIsProbablyEditable'] = $relevantTitle
3217                         && $relevantTitle->quickUserCan( 'edit', $user )
3218                         && ( $relevantTitle->exists() || $relevantTitle->quickUserCan( 'create', $user ) );
3219
3220                 foreach ( $title->getRestrictionTypes() as $type ) {
3221                         $vars['wgRestriction' . ucfirst( $type )] = $title->getRestrictions( $type );
3222                 }
3223
3224                 if ( $title->isMainPage() ) {
3225                         $vars['wgIsMainPage'] = true;
3226                 }
3227
3228                 if ( $this->mRedirectedFrom ) {
3229                         $vars['wgRedirectedFrom'] = $this->mRedirectedFrom->getPrefixedDBkey();
3230                 }
3231
3232                 if ( $relevantUser ) {
3233                         $vars['wgRelevantUserName'] = $relevantUser->getName();
3234                 }
3235
3236                 // Allow extensions to add their custom variables to the mw.config map.
3237                 // Use the 'ResourceLoaderGetConfigVars' hook if the variable is not
3238                 // page-dependant but site-wide (without state).
3239                 // Alternatively, you may want to use OutputPage->addJsConfigVars() instead.
3240                 Hooks::run( 'MakeGlobalVariablesScript', [ &$vars, $this ] );
3241
3242                 // Merge in variables from addJsConfigVars last
3243                 return array_merge( $vars, $this->getJsConfigVars() );
3244         }
3245
3246         /**
3247          * To make it harder for someone to slip a user a fake
3248          * user-JavaScript or user-CSS preview, a random token
3249          * is associated with the login session. If it's not
3250          * passed back with the preview request, we won't render
3251          * the code.
3252          *
3253          * @return bool
3254          */
3255         public function userCanPreview() {
3256                 $request = $this->getRequest();
3257                 if (
3258                         $request->getVal( 'action' ) !== 'submit' ||
3259                         !$request->getCheck( 'wpPreview' ) ||
3260                         !$request->wasPosted()
3261                 ) {
3262                         return false;
3263                 }
3264
3265                 $user = $this->getUser();
3266
3267                 if ( !$user->isLoggedIn() ) {
3268                         // Anons have predictable edit tokens
3269                         return false;
3270                 }
3271                 if ( !$user->matchEditToken( $request->getVal( 'wpEditToken' ) ) ) {
3272                         return false;
3273                 }
3274
3275                 $title = $this->getTitle();
3276                 if ( !$title->isJsSubpage() && !$title->isCssSubpage() ) {
3277                         return false;
3278                 }
3279                 if ( !$title->isSubpageOf( $user->getUserPage() ) ) {
3280                         // Don't execute another user's CSS or JS on preview (T85855)
3281                         return false;
3282                 }
3283
3284                 $errors = $title->getUserPermissionsErrors( 'edit', $user );
3285                 if ( count( $errors ) !== 0 ) {
3286                         return false;
3287                 }
3288
3289                 return true;
3290         }
3291
3292         /**
3293          * @return array Array in format "link name or number => 'link html'".
3294          */
3295         public function getHeadLinksArray() {
3296                 global $wgVersion;
3297
3298                 $tags = [];
3299                 $config = $this->getConfig();
3300
3301                 $canonicalUrl = $this->mCanonicalUrl;
3302
3303                 $tags['meta-generator'] = Html::element( 'meta', [
3304                         'name' => 'generator',
3305                         'content' => "MediaWiki $wgVersion",
3306                 ] );
3307
3308                 if ( $config->get( 'ReferrerPolicy' ) !== false ) {
3309                         $tags['meta-referrer'] = Html::element( 'meta', [
3310                                 'name' => 'referrer',
3311                                 'content' => $config->get( 'ReferrerPolicy' )
3312                         ] );
3313                 }
3314
3315                 $p = "{$this->mIndexPolicy},{$this->mFollowPolicy}";
3316                 if ( $p !== 'index,follow' ) {
3317                         // http://www.robotstxt.org/wc/meta-user.html
3318                         // Only show if it's different from the default robots policy
3319                         $tags['meta-robots'] = Html::element( 'meta', [
3320                                 'name' => 'robots',
3321                                 'content' => $p,
3322                         ] );
3323                 }
3324
3325                 foreach ( $this->mMetatags as $tag ) {
3326                         if ( strncasecmp( $tag[0], 'http:', 5 ) === 0 ) {
3327                                 $a = 'http-equiv';
3328                                 $tag[0] = substr( $tag[0], 5 );
3329                         } elseif ( strncasecmp( $tag[0], 'og:', 3 ) === 0 ) {
3330                                 $a = 'property';
3331                         } else {
3332                                 $a = 'name';
3333                         }
3334                         $tagName = "meta-{$tag[0]}";
3335                         if ( isset( $tags[$tagName] ) ) {
3336                                 $tagName .= $tag[1];
3337                         }
3338                         $tags[$tagName] = Html::element( 'meta',
3339                                 [
3340                                         $a => $tag[0],
3341                                         'content' => $tag[1]
3342                                 ]
3343                         );
3344                 }
3345
3346                 foreach ( $this->mLinktags as $tag ) {
3347                         $tags[] = Html::element( 'link', $tag );
3348                 }
3349
3350                 # Universal edit button
3351                 if ( $config->get( 'UniversalEditButton' ) && $this->isArticleRelated() ) {
3352                         $user = $this->getUser();
3353                         if ( $this->getTitle()->quickUserCan( 'edit', $user )
3354                                 && ( $this->getTitle()->exists() ||
3355                                         $this->getTitle()->quickUserCan( 'create', $user ) )
3356                         ) {
3357                                 // Original UniversalEditButton
3358                                 $msg = $this->msg( 'edit' )->text();
3359                                 $tags['universal-edit-button'] = Html::element( 'link', [
3360                                         'rel' => 'alternate',
3361                                         'type' => 'application/x-wiki',
3362                                         'title' => $msg,
3363                                         'href' => $this->getTitle()->getEditURL(),
3364                                 ] );
3365                                 // Alternate edit link
3366                                 $tags['alternative-edit'] = Html::element( 'link', [
3367                                         'rel' => 'edit',
3368                                         'title' => $msg,
3369                                         'href' => $this->getTitle()->getEditURL(),
3370                                 ] );
3371                         }
3372                 }
3373
3374                 # Generally the order of the favicon and apple-touch-icon links
3375                 # should not matter, but Konqueror (3.5.9 at least) incorrectly
3376                 # uses whichever one appears later in the HTML source. Make sure
3377                 # apple-touch-icon is specified first to avoid this.
3378                 if ( $config->get( 'AppleTouchIcon' ) !== false ) {
3379                         $tags['apple-touch-icon'] = Html::element( 'link', [
3380                                 'rel' => 'apple-touch-icon',
3381                                 'href' => $config->get( 'AppleTouchIcon' )
3382                         ] );
3383                 }
3384
3385                 if ( $config->get( 'Favicon' ) !== false ) {
3386                         $tags['favicon'] = Html::element( 'link', [
3387                                 'rel' => 'shortcut icon',
3388                                 'href' => $config->get( 'Favicon' )
3389                         ] );
3390                 }
3391
3392                 # OpenSearch description link
3393                 $tags['opensearch'] = Html::element( 'link', [
3394                         'rel' => 'search',
3395                         'type' => 'application/opensearchdescription+xml',
3396                         'href' => wfScript( 'opensearch_desc' ),
3397                         'title' => $this->msg( 'opensearch-desc' )->inContentLanguage()->text(),
3398                 ] );
3399
3400                 if ( $config->get( 'EnableAPI' ) ) {
3401                         # Real Simple Discovery link, provides auto-discovery information
3402                         # for the MediaWiki API (and potentially additional custom API
3403                         # support such as WordPress or Twitter-compatible APIs for a
3404                         # blogging extension, etc)
3405                         $tags['rsd'] = Html::element( 'link', [
3406                                 'rel' => 'EditURI',
3407                                 'type' => 'application/rsd+xml',
3408                                 // Output a protocol-relative URL here if $wgServer is protocol-relative.
3409                                 // Whether RSD accepts relative or protocol-relative URLs is completely
3410                                 // undocumented, though.
3411                                 'href' => wfExpandUrl( wfAppendQuery(
3412                                         wfScript( 'api' ),
3413                                         [ 'action' => 'rsd' ] ),
3414                                         PROTO_RELATIVE
3415                                 ),
3416                         ] );
3417                 }
3418
3419                 # Language variants
3420                 if ( !$config->get( 'DisableLangConversion' ) ) {
3421                         $lang = $this->getTitle()->getPageLanguage();
3422                         if ( $lang->hasVariants() ) {
3423                                 $variants = $lang->getVariants();
3424                                 foreach ( $variants as $variant ) {
3425                                         $tags["variant-$variant"] = Html::element( 'link', [
3426                                                 'rel' => 'alternate',
3427                                                 'hreflang' => wfBCP47( $variant ),
3428                                                 'href' => $this->getTitle()->getLocalURL(
3429                                                         [ 'variant' => $variant ] )
3430                                                 ]
3431                                         );
3432                                 }
3433                                 # x-default link per https://support.google.com/webmasters/answer/189077?hl=en
3434                                 $tags["variant-x-default"] = Html::element( 'link', [
3435                                         'rel' => 'alternate',
3436                                         'hreflang' => 'x-default',
3437                                         'href' => $this->getTitle()->getLocalURL() ] );
3438                         }
3439                 }
3440
3441                 # Copyright
3442                 if ( $this->copyrightUrl !== null ) {
3443                         $copyright = $this->copyrightUrl;
3444                 } else {
3445                         $copyright = '';
3446                         if ( $config->get( 'RightsPage' ) ) {
3447                                 $copy = Title::newFromText( $config->get( 'RightsPage' ) );
3448
3449                                 if ( $copy ) {
3450                                         $copyright = $copy->getLocalURL();
3451                                 }
3452                         }
3453
3454                         if ( !$copyright && $config->get( 'RightsUrl' ) ) {
3455                                 $copyright = $config->get( 'RightsUrl' );
3456                         }
3457                 }
3458
3459                 if ( $copyright ) {
3460                         $tags['copyright'] = Html::element( 'link', [
3461                                 'rel' => 'license',
3462                                 'href' => $copyright ]
3463                         );
3464                 }
3465
3466                 # Feeds
3467                 if ( $config->get( 'Feed' ) ) {
3468                         $feedLinks = [];
3469
3470                         foreach ( $this->getSyndicationLinks() as $format => $link ) {
3471                                 # Use the page name for the title.  In principle, this could
3472                                 # lead to issues with having the same name for different feeds
3473                                 # corresponding to the same page, but we can't avoid that at
3474                                 # this low a level.
3475
3476                                 $feedLinks[] = $this->feedLink(
3477                                         $format,
3478                                         $link,
3479                                         # Used messages: 'page-rss-feed' and 'page-atom-feed' (for an easier grep)
3480                                         $this->msg(
3481                                                 "page-{$format}-feed", $this->getTitle()->getPrefixedText()
3482                                         )->text()
3483                                 );
3484                         }
3485
3486                         # Recent changes feed should appear on every page (except recentchanges,
3487                         # that would be redundant). Put it after the per-page feed to avoid
3488                         # changing existing behavior. It's still available, probably via a
3489                         # menu in your browser. Some sites might have a different feed they'd
3490                         # like to promote instead of the RC feed (maybe like a "Recent New Articles"
3491                         # or "Breaking news" one). For this, we see if $wgOverrideSiteFeed is defined.
3492                         # If so, use it instead.
3493                         $sitename = $config->get( 'Sitename' );
3494                         if ( $config->get( 'OverrideSiteFeed' ) ) {
3495                                 foreach ( $config->get( 'OverrideSiteFeed' ) as $type => $feedUrl ) {
3496                                         // Note, this->feedLink escapes the url.
3497                                         $feedLinks[] = $this->feedLink(
3498                                                 $type,
3499                                                 $feedUrl,
3500                                                 $this->msg( "site-{$type}-feed", $sitename )->text()
3501                                         );
3502                                 }
3503                         } elseif ( !$this->getTitle()->isSpecial( 'Recentchanges' ) ) {
3504                                 $rctitle = SpecialPage::getTitleFor( 'Recentchanges' );
3505                                 foreach ( $config->get( 'AdvertisedFeedTypes' ) as $format ) {
3506                                         $feedLinks[] = $this->feedLink(
3507                                                 $format,
3508                                                 $rctitle->getLocalURL( [ 'feed' => $format ] ),
3509                                                 # For grep: 'site-rss-feed', 'site-atom-feed'
3510                                                 $this->msg( "site-{$format}-feed", $sitename )->text()
3511                                         );
3512                                 }
3513                         }
3514
3515                         # Allow extensions to change the list pf feeds. This hook is primarily for changing,
3516                         # manipulating or removing existing feed tags. If you want to add new feeds, you should
3517                         # use OutputPage::addFeedLink() instead.
3518                         Hooks::run( 'AfterBuildFeedLinks', [ &$feedLinks ] );
3519
3520                         $tags += $feedLinks;
3521                 }
3522
3523                 # Canonical URL
3524                 if ( $config->get( 'EnableCanonicalServerLink' ) ) {
3525                         if ( $canonicalUrl !== false ) {
3526                                 $canonicalUrl = wfExpandUrl( $canonicalUrl, PROTO_CANONICAL );
3527                         } else {
3528                                 if ( $this->isArticleRelated() ) {
3529                                         // This affects all requests where "setArticleRelated" is true. This is
3530                                         // typically all requests that show content (query title, curid, oldid, diff),
3531                                         // and all wikipage actions (edit, delete, purge, info, history etc.).
3532                                         // It does not apply to File pages and Special pages.
3533                                         // 'history' and 'info' actions address page metadata rather than the page
3534                                         // content itself, so they may not be canonicalized to the view page url.
3535                                         // TODO: this ought to be better encapsulated in the Action class.
3536                                         $action = Action::getActionName( $this->getContext() );
3537                                         if ( in_array( $action, [ 'history', 'info' ] ) ) {
3538                                                 $query = "action={$action}";
3539                                         } else {
3540                                                 $query = '';
3541                                         }
3542                                         $canonicalUrl = $this->getTitle()->getCanonicalURL( $query );
3543                                 } else {
3544                                         $reqUrl = $this->getRequest()->getRequestURL();
3545                                         $canonicalUrl = wfExpandUrl( $reqUrl, PROTO_CANONICAL );
3546                                 }
3547                         }
3548                 }
3549                 if ( $canonicalUrl !== false ) {
3550                         $tags[] = Html::element( 'link', [
3551                                 'rel' => 'canonical',
3552                                 'href' => $canonicalUrl
3553                         ] );
3554                 }
3555
3556                 return $tags;
3557         }
3558
3559         /**
3560          * Generate a "<link rel/>" for a feed.
3561          *
3562          * @param string $type Feed type
3563          * @param string $url URL to the feed
3564          * @param string $text Value of the "title" attribute
3565          * @return string HTML fragment
3566          */
3567         private function feedLink( $type, $url, $text ) {
3568                 return Html::element( 'link', [
3569                         'rel' => 'alternate',
3570                         'type' => "application/$type+xml",
3571                         'title' => $text,
3572                         'href' => $url ]
3573                 );
3574         }
3575
3576         /**
3577          * Add a local or specified stylesheet, with the given media options.
3578          * Internal use only. Use OutputPage::addModuleStyles() if possible.
3579          *
3580          * @param string $style URL to the file
3581          * @param string $media To specify a media type, 'screen', 'printable', 'handheld' or any.
3582          * @param string $condition For IE conditional comments, specifying an IE version
3583          * @param string $dir Set to 'rtl' or 'ltr' for direction-specific sheets
3584          */
3585         public function addStyle( $style, $media = '', $condition = '', $dir = '' ) {
3586                 $options = [];
3587                 if ( $media ) {
3588                         $options['media'] = $media;
3589                 }
3590                 if ( $condition ) {
3591                         $options['condition'] = $condition;
3592                 }
3593                 if ( $dir ) {
3594                         $options['dir'] = $dir;
3595                 }
3596                 $this->styles[$style] = $options;
3597         }
3598
3599         /**
3600          * Adds inline CSS styles
3601          * Internal use only. Use OutputPage::addModuleStyles() if possible.
3602          *
3603          * @param mixed $style_css Inline CSS
3604          * @param string $flip Set to 'flip' to flip the CSS if needed
3605          */
3606         public function addInlineStyle( $style_css, $flip = 'noflip' ) {
3607                 if ( $flip === 'flip' && $this->getLanguage()->isRTL() ) {
3608                         # If wanted, and the interface is right-to-left, flip the CSS
3609                         $style_css = CSSJanus::transform( $style_css, true, false );
3610                 }
3611                 $this->mInlineStyles .= Html::inlineStyle( $style_css );
3612         }
3613
3614         /**
3615          * Build exempt modules and legacy non-ResourceLoader styles.
3616          *
3617          * @return string|WrappedStringList HTML
3618          */
3619         protected function buildExemptModules() {
3620                 global $wgContLang;
3621
3622                 $chunks = [];
3623                 // Things that go after the ResourceLoaderDynamicStyles marker
3624                 $append = [];
3625
3626                 // Exempt 'user' styles module (may need 'excludepages' for live preview)
3627                 if ( $this->isUserCssPreview() ) {
3628                         $append[] = $this->makeResourceLoaderLink(
3629                                 'user.styles',
3630                                 ResourceLoaderModule::TYPE_STYLES,
3631                                 [ 'excludepage' => $this->getTitle()->getPrefixedDBkey() ]
3632                         );
3633
3634                         // Load the previewed CSS. Janus it if needed.
3635                         // User-supplied CSS is assumed to in the wiki's content language.
3636                         $previewedCSS = $this->getRequest()->getText( 'wpTextbox1' );
3637                         if ( $this->getLanguage()->getDir() !== $wgContLang->getDir() ) {
3638                                 $previewedCSS = CSSJanus::transform( $previewedCSS, true, false );
3639                         }
3640                         $append[] = Html::inlineStyle( $previewedCSS );
3641                 }
3642
3643                 // We want site, private and user styles to override dynamically added styles from
3644                 // general modules, but we want dynamically added styles to override statically added
3645                 // style modules. So the order has to be:
3646                 // - page style modules (formatted by ResourceLoaderClientHtml::getHeadHtml())
3647                 // - dynamically loaded styles (added by mw.loader before ResourceLoaderDynamicStyles)
3648                 // - ResourceLoaderDynamicStyles marker
3649                 // - site/private/user styles
3650
3651                 // Add legacy styles added through addStyle()/addInlineStyle() here
3652                 $chunks[] = implode( '', $this->buildCssLinksArray() ) . $this->mInlineStyles;
3653
3654                 $chunks[] = Html::element(
3655                         'meta',
3656                         [ 'name' => 'ResourceLoaderDynamicStyles', 'content' => '' ]
3657                 );
3658
3659                 $separateReq = [ 'site.styles', 'user.styles' ];
3660                 foreach ( $this->rlExemptStyleModules as $group => $moduleNames ) {
3661                         // Combinable modules
3662                         $chunks[] = $this->makeResourceLoaderLink(
3663                                 array_diff( $moduleNames, $separateReq ),
3664                                 ResourceLoaderModule::TYPE_STYLES
3665                         );
3666
3667                         foreach ( array_intersect( $moduleNames, $separateReq ) as $name ) {
3668                                 // These require their own dedicated request in order to support "@import"
3669                                 // syntax, which is incompatible with concatenation. (T147667, T37562)
3670                                 $chunks[] = $this->makeResourceLoaderLink( $name,
3671                                         ResourceLoaderModule::TYPE_STYLES
3672                                 );
3673                         }
3674                 }
3675
3676                 return self::combineWrappedStrings( array_merge( $chunks, $append ) );
3677         }
3678
3679         /**
3680          * @return array
3681          */
3682         public function buildCssLinksArray() {
3683                 $links = [];
3684
3685                 // Add any extension CSS
3686                 foreach ( $this->mExtStyles as $url ) {
3687                         $this->addStyle( $url );
3688                 }
3689                 $this->mExtStyles = [];
3690
3691                 foreach ( $this->styles as $file => $options ) {
3692                         $link = $this->styleLink( $file, $options );
3693                         if ( $link ) {
3694                                 $links[$file] = $link;
3695                         }
3696                 }
3697                 return $links;
3698         }
3699
3700         /**
3701          * Generate \<link\> tags for stylesheets
3702          *
3703          * @param string $style URL to the file
3704          * @param array $options Option, can contain 'condition', 'dir', 'media' keys
3705          * @return string HTML fragment
3706          */
3707         protected function styleLink( $style, array $options ) {
3708                 if ( isset( $options['dir'] ) ) {
3709                         if ( $this->getLanguage()->getDir() != $options['dir'] ) {
3710                                 return '';
3711                         }
3712                 }
3713
3714                 if ( isset( $options['media'] ) ) {
3715                         $media = self::transformCssMedia( $options['media'] );
3716                         if ( is_null( $media ) ) {
3717                                 return '';
3718                         }
3719                 } else {
3720                         $media = 'all';
3721                 }
3722
3723                 if ( substr( $style, 0, 1 ) == '/' ||
3724                         substr( $style, 0, 5 ) == 'http:' ||
3725                         substr( $style, 0, 6 ) == 'https:' ) {
3726                         $url = $style;
3727                 } else {
3728                         $config = $this->getConfig();
3729                         $url = $config->get( 'StylePath' ) . '/' . $style . '?' .
3730                                 $config->get( 'StyleVersion' );
3731                 }
3732
3733                 $link = Html::linkedStyle( $url, $media );
3734
3735                 if ( isset( $options['condition'] ) ) {
3736                         $condition = htmlspecialchars( $options['condition'] );
3737                         $link = "<!--[if $condition]>$link<![endif]-->";
3738                 }
3739                 return $link;
3740         }
3741
3742         /**
3743          * Transform path to web-accessible static resource.
3744          *
3745          * This is used to add a validation hash as query string.
3746          * This aids various behaviors:
3747          *
3748          * - Put long Cache-Control max-age headers on responses for improved
3749          *   cache performance.
3750          * - Get the correct version of a file as expected by the current page.
3751          * - Instantly get the updated version of a file after deployment.
3752          *
3753          * Avoid using this for urls included in HTML as otherwise clients may get different
3754          * versions of a resource when navigating the site depending on when the page was cached.
3755          * If changes to the url propagate, this is not a problem (e.g. if the url is in
3756          * an external stylesheet).
3757          *
3758          * @since 1.27
3759          * @param Config $config
3760          * @param string $path Path-absolute URL to file (from document root, must start with "/")
3761          * @return string URL
3762          */
3763         public static function transformResourcePath( Config $config, $path ) {
3764                 global $IP;
3765
3766                 $localDir = $IP;
3767                 $remotePathPrefix = $config->get( 'ResourceBasePath' );
3768                 if ( $remotePathPrefix === '' ) {
3769                         // The configured base path is required to be empty string for
3770                         // wikis in the domain root
3771                         $remotePath = '/';
3772                 } else {
3773                         $remotePath = $remotePathPrefix;
3774                 }
3775                 if ( strpos( $path, $remotePath ) !== 0 || substr( $path, 0, 2 ) === '//' ) {
3776                         // - Path is outside wgResourceBasePath, ignore.
3777                         // - Path is protocol-relative. Fixes T155310. Not supported by RelPath lib.
3778                         return $path;
3779                 }
3780                 // For files in resources, extensions/ or skins/, ResourceBasePath is preferred here.
3781                 // For other misc files in $IP, we'll fallback to that as well. There is, however, a fourth
3782                 // supported dir/path pair in the configuration (wgUploadDirectory, wgUploadPath)
3783                 // which is not expected to be in wgResourceBasePath on CDNs. (T155146)
3784                 $uploadPath = $config->get( 'UploadPath' );
3785                 if ( strpos( $path, $uploadPath ) === 0 ) {
3786                         $localDir = $config->get( 'UploadDirectory' );
3787                         $remotePathPrefix = $remotePath = $uploadPath;
3788                 }
3789
3790                 $path = RelPath\getRelativePath( $path, $remotePath );
3791                 return self::transformFilePath( $remotePathPrefix, $localDir, $path );
3792         }
3793
3794         /**
3795          * Utility method for transformResourceFilePath().
3796          *
3797          * Caller is responsible for ensuring the file exists. Emits a PHP warning otherwise.
3798          *
3799          * @since 1.27
3800          * @param string $remotePath URL path prefix that points to $localPath
3801          * @param string $localPath File directory exposed at $remotePath
3802          * @param string $file Path to target file relative to $localPath
3803          * @return string URL
3804          */
3805         public static function transformFilePath( $remotePathPrefix, $localPath, $file ) {
3806                 $hash = md5_file( "$localPath/$file" );
3807                 if ( $hash === false ) {
3808                         wfLogWarning( __METHOD__ . ": Failed to hash $localPath/$file" );
3809                         $hash = '';
3810                 }
3811                 return "$remotePathPrefix/$file?" . substr( $hash, 0, 5 );
3812         }
3813
3814         /**
3815          * Transform "media" attribute based on request parameters
3816          *
3817          * @param string $media Current value of the "media" attribute
3818          * @return string Modified value of the "media" attribute, or null to skip
3819          * this stylesheet
3820          */
3821         public static function transformCssMedia( $media ) {
3822                 global $wgRequest;
3823
3824                 // https://www.w3.org/TR/css3-mediaqueries/#syntax
3825                 $screenMediaQueryRegex = '/^(?:only\s+)?screen\b/i';
3826
3827                 // Switch in on-screen display for media testing
3828                 $switches = [
3829                         'printable' => 'print',
3830                         'handheld' => 'handheld',
3831                 ];
3832                 foreach ( $switches as $switch => $targetMedia ) {
3833                         if ( $wgRequest->getBool( $switch ) ) {
3834                                 if ( $media == $targetMedia ) {
3835                                         $media = '';
3836                                 } elseif ( preg_match( $screenMediaQueryRegex, $media ) === 1 ) {
3837                                         /* This regex will not attempt to understand a comma-separated media_query_list
3838                                          *
3839                                          * Example supported values for $media:
3840                                          * 'screen', 'only screen', 'screen and (min-width: 982px)' ),
3841                                          * Example NOT supported value for $media:
3842                                          * '3d-glasses, screen, print and resolution > 90dpi'
3843                                          *
3844                                          * If it's a print request, we never want any kind of screen stylesheets
3845                                          * If it's a handheld request (currently the only other choice with a switch),
3846                                          * we don't want simple 'screen' but we might want screen queries that
3847                                          * have a max-width or something, so we'll pass all others on and let the
3848                                          * client do the query.
3849                                          */
3850                                         if ( $targetMedia == 'print' || $media == 'screen' ) {
3851                                                 return null;
3852                                         }
3853                                 }
3854                         }
3855                 }
3856
3857                 return $media;
3858         }
3859
3860         /**
3861          * Add a wikitext-formatted message to the output.
3862          * This is equivalent to:
3863          *
3864          *    $wgOut->addWikiText( wfMessage( ... )->plain() )
3865          */
3866         public function addWikiMsg( /*...*/ ) {
3867                 $args = func_get_args();
3868                 $name = array_shift( $args );
3869                 $this->addWikiMsgArray( $name, $args );
3870         }
3871
3872         /**
3873          * Add a wikitext-formatted message to the output.
3874          * Like addWikiMsg() except the parameters are taken as an array
3875          * instead of a variable argument list.
3876          *
3877          * @param string $name
3878          * @param array $args
3879          */
3880         public function addWikiMsgArray( $name, $args ) {
3881                 $this->addHTML( $this->msg( $name, $args )->parseAsBlock() );
3882         }
3883
3884         /**
3885          * This function takes a number of message/argument specifications, wraps them in
3886          * some overall structure, and then parses the result and adds it to the output.
3887          *
3888          * In the $wrap, $1 is replaced with the first message, $2 with the second,
3889          * and so on. The subsequent arguments may be either
3890          * 1) strings, in which case they are message names, or
3891          * 2) arrays, in which case, within each array, the first element is the message
3892          *    name, and subsequent elements are the parameters to that message.
3893          *
3894          * Don't use this for messages that are not in the user's interface language.
3895          *
3896          * For example:
3897          *
3898          *    $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>", 'some-error' );
3899          *
3900          * Is equivalent to:
3901          *
3902          *    $wgOut->addWikiText( "<div class='error'>\n"
3903          *        . wfMessage( 'some-error' )->plain() . "\n</div>" );
3904          *
3905          * The newline after the opening div is needed in some wikitext. See T21226.
3906          *
3907          * @param string $wrap
3908          */
3909         public function wrapWikiMsg( $wrap /*, ...*/ ) {
3910                 $msgSpecs = func_get_args();
3911                 array_shift( $msgSpecs );
3912                 $msgSpecs = array_values( $msgSpecs );
3913                 $s = $wrap;
3914                 foreach ( $msgSpecs as $n => $spec ) {
3915                         if ( is_array( $spec ) ) {
3916                                 $args = $spec;
3917                                 $name = array_shift( $args );
3918                                 if ( isset( $args['options'] ) ) {
3919                                         unset( $args['options'] );
3920                                         wfDeprecated(
3921                                                 'Adding "options" to ' . __METHOD__ . ' is no longer supported',
3922                                                 '1.20'
3923                                         );
3924                                 }
3925                         } else {
3926                                 $args = [];
3927                                 $name = $spec;
3928                         }
3929                         $s = str_replace( '$' . ( $n + 1 ), $this->msg( $name, $args )->plain(), $s );
3930                 }
3931                 $this->addWikiText( $s );
3932         }
3933
3934         /**
3935          * Whether the output has a table of contents
3936          * @return bool
3937          * @since 1.22
3938          */
3939         public function isTOCEnabled() {
3940                 return $this->mEnableTOC;
3941         }
3942
3943         /**
3944          * Enables/disables section edit links, doesn't override __NOEDITSECTION__
3945          * @param bool $flag
3946          * @since 1.23
3947          */
3948         public function enableSectionEditLinks( $flag = true ) {
3949                 $this->mEnableSectionEditLinks = $flag;
3950         }
3951
3952         /**
3953          * @return bool
3954          * @since 1.23
3955          */
3956         public function sectionEditLinksEnabled() {
3957                 return $this->mEnableSectionEditLinks;
3958         }
3959
3960         /**
3961          * Helper function to setup the PHP implementation of OOUI to use in this request.
3962          *
3963          * @since 1.26
3964          * @param String $skinName The Skin name to determine the correct OOUI theme
3965          * @param String $dir Language direction
3966          */
3967         public static function setupOOUI( $skinName = 'default', $dir = 'ltr' ) {
3968                 $themes = ResourceLoaderOOUIModule::getSkinThemeMap();
3969                 $theme = isset( $themes[$skinName] ) ? $themes[$skinName] : $themes['default'];
3970                 // For example, 'OOUI\WikimediaUITheme'.
3971                 $themeClass = "OOUI\\{$theme}Theme";
3972                 OOUI\Theme::setSingleton( new $themeClass() );
3973                 OOUI\Element::setDefaultDir( $dir );
3974         }
3975
3976         /**
3977          * Add ResourceLoader module styles for OOUI and set up the PHP implementation of it for use with
3978          * MediaWiki and this OutputPage instance.
3979          *
3980          * @since 1.25
3981          */
3982         public function enableOOUI() {
3983                 self::setupOOUI(
3984                         strtolower( $this->getSkin()->getSkinName() ),
3985                         $this->getLanguage()->getDir()
3986                 );
3987                 $this->addModuleStyles( [
3988                         'oojs-ui-core.styles',
3989                         'oojs-ui.styles.indicators',
3990                         'oojs-ui.styles.textures',
3991                         'mediawiki.widgets.styles',
3992                         'oojs-ui.styles.icons-content',
3993                         'oojs-ui.styles.icons-alerts',
3994                         'oojs-ui.styles.icons-interactions',
3995                 ] );
3996         }
3997
3998         /**
3999          * Add Link headers for preloading the wiki's logo.
4000          *
4001          * @since 1.26
4002          */
4003         protected function addLogoPreloadLinkHeaders() {
4004                 $logo = ResourceLoaderSkinModule::getLogo( $this->getConfig() );
4005
4006                 $tags = [];
4007                 $logosPerDppx = [];
4008                 $logos = [];
4009
4010                 if ( !is_array( $logo ) ) {
4011                         // No media queries required if we only have one variant
4012                         $this->addLinkHeader( '<' . $logo . '>;rel=preload;as=image' );
4013                         return;
4014                 }
4015
4016                 foreach ( $logo as $dppx => $src ) {
4017                         // Keys are in this format: "1.5x"
4018                         $dppx = substr( $dppx, 0, -1 );
4019                         $logosPerDppx[$dppx] = $src;
4020                 }
4021
4022                 // Because PHP can't have floats as array keys
4023                 uksort( $logosPerDppx, function ( $a , $b ) {
4024                         $a = floatval( $a );
4025                         $b = floatval( $b );
4026
4027                         if ( $a == $b ) {
4028                                 return 0;
4029                         }
4030                         // Sort from smallest to largest (e.g. 1x, 1.5x, 2x)
4031                         return ( $a < $b ) ? -1 : 1;
4032                 } );
4033
4034                 foreach ( $logosPerDppx as $dppx => $src ) {
4035                         $logos[] = [ 'dppx' => $dppx, 'src' => $src ];
4036                 }
4037
4038                 $logosCount = count( $logos );
4039                 // Logic must match ResourceLoaderSkinModule:
4040                 // - 1x applies to resolution < 1.5dppx
4041                 // - 1.5x applies to resolution >= 1.5dppx && < 2dppx
4042                 // - 2x applies to resolution >= 2dppx
4043                 // Note that min-resolution and max-resolution are both inclusive.
4044                 for ( $i = 0; $i < $logosCount; $i++ ) {
4045                         if ( $i === 0 ) {
4046                                 // Smallest dppx
4047                                 // min-resolution is ">=" (larger than or equal to)
4048                                 // "not min-resolution" is essentially "<"
4049                                 $media_query = 'not all and (min-resolution: ' . $logos[ 1 ]['dppx'] . 'dppx)';
4050                         } elseif ( $i !== $logosCount - 1 ) {
4051                                 // In between
4052                                 // Media query expressions can only apply "not" to the entire expression
4053                                 // (e.g. can't express ">= 1.5 and not >= 2).
4054                                 // Workaround: Use <= 1.9999 in place of < 2.
4055                                 $upper_bound = floatval( $logos[ $i + 1 ]['dppx'] ) - 0.000001;
4056                                 $media_query = '(min-resolution: ' . $logos[ $i ]['dppx'] .
4057                                         'dppx) and (max-resolution: ' . $upper_bound . 'dppx)';
4058                         } else {
4059                                 // Largest dppx
4060                                 $media_query = '(min-resolution: ' . $logos[ $i ]['dppx'] . 'dppx)';
4061                         }
4062
4063                         $this->addLinkHeader(
4064                                 '<' . $logos[$i]['src'] . '>;rel=preload;as=image;media=' . $media_query
4065                         );
4066                 }
4067         }
4068 }