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