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