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