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