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          * Show what level of JavaScript / CSS untrustworthiness is allowed on this page
1347          * @see ResourceLoaderModule::$origin
1348          * @param string $type ResourceLoaderModule TYPE_ constant
1349          * @return int ResourceLoaderModule ORIGIN_ class constant
1350          */
1351         public function getAllowedModules( $type ) {
1352                 if ( $type == ResourceLoaderModule::TYPE_COMBINED ) {
1353                         return min( array_values( $this->mAllowedModules ) );
1354                 } else {
1355                         return isset( $this->mAllowedModules[$type] )
1356                                 ? $this->mAllowedModules[$type]
1357                                 : ResourceLoaderModule::ORIGIN_ALL;
1358                 }
1359         }
1360
1361         /**
1362          * Set the highest level of CSS/JS untrustworthiness allowed
1363          * @param string $type ResourceLoaderModule TYPE_ constant
1364          * @param int $level ResourceLoaderModule class constant
1365          */
1366         public function setAllowedModules( $type, $level ) {
1367                 $this->mAllowedModules[$type] = $level;
1368         }
1369
1370         /**
1371          * As for setAllowedModules(), but don't inadvertently make the page more accessible
1372          * @param string $type
1373          * @param int $level ResourceLoaderModule class constant
1374          */
1375         public function reduceAllowedModules( $type, $level ) {
1376                 $this->mAllowedModules[$type] = min( $this->getAllowedModules( $type ), $level );
1377         }
1378
1379         /**
1380          * Prepend $text to the body HTML
1381          *
1382          * @param string $text HTML
1383          */
1384         public function prependHTML( $text ) {
1385                 $this->mBodytext = $text . $this->mBodytext;
1386         }
1387
1388         /**
1389          * Append $text to the body HTML
1390          *
1391          * @param string $text HTML
1392          */
1393         public function addHTML( $text ) {
1394                 $this->mBodytext .= $text;
1395         }
1396
1397         /**
1398          * Shortcut for adding an Html::element via addHTML.
1399          *
1400          * @since 1.19
1401          *
1402          * @param string $element
1403          * @param array $attribs
1404          * @param string $contents
1405          */
1406         public function addElement( $element, $attribs = array(), $contents = '' ) {
1407                 $this->addHTML( Html::element( $element, $attribs, $contents ) );
1408         }
1409
1410         /**
1411          * Clear the body HTML
1412          */
1413         public function clearHTML() {
1414                 $this->mBodytext = '';
1415         }
1416
1417         /**
1418          * Get the body HTML
1419          *
1420          * @return string HTML
1421          */
1422         public function getHTML() {
1423                 return $this->mBodytext;
1424         }
1425
1426         /**
1427          * Get/set the ParserOptions object to use for wikitext parsing
1428          *
1429          * @param ParserOptions|null $options Either the ParserOption to use or null to only get the
1430          *   current ParserOption object
1431          * @return ParserOptions
1432          */
1433         public function parserOptions( $options = null ) {
1434                 if ( !$this->mParserOptions ) {
1435                         $this->mParserOptions = ParserOptions::newFromContext( $this->getContext() );
1436                         $this->mParserOptions->setEditSection( false );
1437                 }
1438                 return wfSetVar( $this->mParserOptions, $options );
1439         }
1440
1441         /**
1442          * Set the revision ID which will be seen by the wiki text parser
1443          * for things such as embedded {{REVISIONID}} variable use.
1444          *
1445          * @param int|null $revid An positive integer, or null
1446          * @return mixed Previous value
1447          */
1448         public function setRevisionId( $revid ) {
1449                 $val = is_null( $revid ) ? null : intval( $revid );
1450                 return wfSetVar( $this->mRevisionId, $val );
1451         }
1452
1453         /**
1454          * Get the displayed revision ID
1455          *
1456          * @return int
1457          */
1458         public function getRevisionId() {
1459                 return $this->mRevisionId;
1460         }
1461
1462         /**
1463          * Set the timestamp of the revision which will be displayed. This is used
1464          * to avoid a extra DB call in Skin::lastModified().
1465          *
1466          * @param string|null $timestamp
1467          * @return mixed Previous value
1468          */
1469         public function setRevisionTimestamp( $timestamp ) {
1470                 return wfSetVar( $this->mRevisionTimestamp, $timestamp );
1471         }
1472
1473         /**
1474          * Get the timestamp of displayed revision.
1475          * This will be null if not filled by setRevisionTimestamp().
1476          *
1477          * @return string|null
1478          */
1479         public function getRevisionTimestamp() {
1480                 return $this->mRevisionTimestamp;
1481         }
1482
1483         /**
1484          * Set the displayed file version
1485          *
1486          * @param File|bool $file
1487          * @return mixed Previous value
1488          */
1489         public function setFileVersion( $file ) {
1490                 $val = null;
1491                 if ( $file instanceof File && $file->exists() ) {
1492                         $val = array( 'time' => $file->getTimestamp(), 'sha1' => $file->getSha1() );
1493                 }
1494                 return wfSetVar( $this->mFileVersion, $val, true );
1495         }
1496
1497         /**
1498          * Get the displayed file version
1499          *
1500          * @return array|null ('time' => MW timestamp, 'sha1' => sha1)
1501          */
1502         public function getFileVersion() {
1503                 return $this->mFileVersion;
1504         }
1505
1506         /**
1507          * Get the templates used on this page
1508          *
1509          * @return array (namespace => dbKey => revId)
1510          * @since 1.18
1511          */
1512         public function getTemplateIds() {
1513                 return $this->mTemplateIds;
1514         }
1515
1516         /**
1517          * Get the files used on this page
1518          *
1519          * @return array (dbKey => array('time' => MW timestamp or null, 'sha1' => sha1 or ''))
1520          * @since 1.18
1521          */
1522         public function getFileSearchOptions() {
1523                 return $this->mImageTimeKeys;
1524         }
1525
1526         /**
1527          * Convert wikitext to HTML and add it to the buffer
1528          * Default assumes that the current page title will be used.
1529          *
1530          * @param string $text
1531          * @param bool $linestart Is this the start of a line?
1532          * @param bool $interface Is this text in the user interface language?
1533          */
1534         public function addWikiText( $text, $linestart = true, $interface = true ) {
1535                 $title = $this->getTitle(); // Work around E_STRICT
1536                 if ( !$title ) {
1537                         throw new MWException( 'Title is null' );
1538                 }
1539                 $this->addWikiTextTitle( $text, $title, $linestart, /*tidy*/false, $interface );
1540         }
1541
1542         /**
1543          * Add wikitext with a custom Title object
1544          *
1545          * @param string $text Wikitext
1546          * @param Title $title
1547          * @param bool $linestart Is this the start of a line?
1548          */
1549         public function addWikiTextWithTitle( $text, &$title, $linestart = true ) {
1550                 $this->addWikiTextTitle( $text, $title, $linestart );
1551         }
1552
1553         /**
1554          * Add wikitext with a custom Title object and tidy enabled.
1555          *
1556          * @param string $text Wikitext
1557          * @param Title $title
1558          * @param bool $linestart Is this the start of a line?
1559          */
1560         function addWikiTextTitleTidy( $text, &$title, $linestart = true ) {
1561                 $this->addWikiTextTitle( $text, $title, $linestart, true );
1562         }
1563
1564         /**
1565          * Add wikitext with tidy enabled
1566          *
1567          * @param string $text Wikitext
1568          * @param bool $linestart Is this the start of a line?
1569          */
1570         public function addWikiTextTidy( $text, $linestart = true ) {
1571                 $title = $this->getTitle();
1572                 $this->addWikiTextTitleTidy( $text, $title, $linestart );
1573         }
1574
1575         /**
1576          * Add wikitext with a custom Title object
1577          *
1578          * @param string $text Wikitext
1579          * @param Title $title
1580          * @param bool $linestart Is this the start of a line?
1581          * @param bool $tidy Whether to use tidy
1582          * @param bool $interface Whether it is an interface message
1583          *   (for example disables conversion)
1584          */
1585         public function addWikiTextTitle( $text, Title $title, $linestart,
1586                 $tidy = false, $interface = false
1587         ) {
1588                 global $wgParser;
1589
1590                 wfProfileIn( __METHOD__ );
1591
1592                 $popts = $this->parserOptions();
1593                 $oldTidy = $popts->setTidy( $tidy );
1594                 $popts->setInterfaceMessage( (bool)$interface );
1595
1596                 $parserOutput = $wgParser->getFreshParser()->parse(
1597                         $text, $title, $popts,
1598                         $linestart, true, $this->mRevisionId
1599                 );
1600
1601                 $popts->setTidy( $oldTidy );
1602
1603                 $this->addParserOutput( $parserOutput );
1604
1605                 wfProfileOut( __METHOD__ );
1606         }
1607
1608         /**
1609          * Add a ParserOutput object, but without Html.
1610          *
1611          * @deprecated since 1.24, use addParserOutputMetadata() instead.
1612          * @param ParserOutput $parserOutput
1613          */
1614         public function addParserOutputNoText( &$parserOutput ) {
1615                 $this->addParserOutputMetadata( $parserOutput );
1616         }
1617
1618         /**
1619          * Add all metadata associated with a ParserOutput object, but without the actual HTML. This
1620          * includes categories, language links, ResourceLoader modules, effects of certain magic words,
1621          * and so on.
1622          *
1623          * @since 1.24
1624          * @param ParserOutput $parserOutput
1625          */
1626         public function addParserOutputMetadata( &$parserOutput ) {
1627                 $this->mLanguageLinks += $parserOutput->getLanguageLinks();
1628                 $this->addCategoryLinks( $parserOutput->getCategories() );
1629                 $this->mNewSectionLink = $parserOutput->getNewSection();
1630                 $this->mHideNewSectionLink = $parserOutput->getHideNewSection();
1631
1632                 $this->mParseWarnings = $parserOutput->getWarnings();
1633                 if ( !$parserOutput->isCacheable() ) {
1634                         $this->enableClientCache( false );
1635                 }
1636                 $this->mNoGallery = $parserOutput->getNoGallery();
1637                 $this->mHeadItems = array_merge( $this->mHeadItems, $parserOutput->getHeadItems() );
1638                 $this->addModules( $parserOutput->getModules() );
1639                 $this->addModuleScripts( $parserOutput->getModuleScripts() );
1640                 $this->addModuleStyles( $parserOutput->getModuleStyles() );
1641                 $this->addModuleMessages( $parserOutput->getModuleMessages() );
1642                 $this->addJsConfigVars( $parserOutput->getJsConfigVars() );
1643
1644                 // Template versioning...
1645                 foreach ( (array)$parserOutput->getTemplateIds() as $ns => $dbks ) {
1646                         if ( isset( $this->mTemplateIds[$ns] ) ) {
1647                                 $this->mTemplateIds[$ns] = $dbks + $this->mTemplateIds[$ns];
1648                         } else {
1649                                 $this->mTemplateIds[$ns] = $dbks;
1650                         }
1651                 }
1652                 // File versioning...
1653                 foreach ( (array)$parserOutput->getFileSearchOptions() as $dbk => $data ) {
1654                         $this->mImageTimeKeys[$dbk] = $data;
1655                 }
1656
1657                 // Hooks registered in the object
1658                 global $wgParserOutputHooks;
1659                 foreach ( $parserOutput->getOutputHooks() as $hookInfo ) {
1660                         list( $hookName, $data ) = $hookInfo;
1661                         if ( isset( $wgParserOutputHooks[$hookName] ) ) {
1662                                 call_user_func( $wgParserOutputHooks[$hookName], $this, $parserOutput, $data );
1663                         }
1664                 }
1665
1666                 // Link flags are ignored for now, but may in the future be
1667                 // used to mark individual language links.
1668                 $linkFlags = array();
1669                 wfRunHooks( 'LanguageLinks', array( $this->getTitle(), &$this->mLanguageLinks, &$linkFlags ) );
1670                 wfRunHooks( 'OutputPageParserOutput', array( &$this, $parserOutput ) );
1671         }
1672
1673         /**
1674          * Add the HTML and enhancements for it (like ResourceLoader modules) associated with a
1675          * ParserOutput object, without any other metadata.
1676          *
1677          * @since 1.24
1678          * @param ParserOutput $parserOutput
1679          */
1680         public function addParserOutputContent( &$parserOutput ) {
1681                 $this->addParserOutputText( $parserOutput );
1682
1683                 $this->addModules( $parserOutput->getModules() );
1684                 $this->addModuleScripts( $parserOutput->getModuleScripts() );
1685                 $this->addModuleStyles( $parserOutput->getModuleStyles() );
1686                 $this->addModuleMessages( $parserOutput->getModuleMessages() );
1687
1688                 $this->addJsConfigVars( $parserOutput->getJsConfigVars() );
1689         }
1690
1691         /**
1692          * Add the HTML associated with a ParserOutput object, without any metadata.
1693          *
1694          * @since 1.24
1695          * @param ParserOutput $parserOutput
1696          */
1697         public function addParserOutputText( &$parserOutput ) {
1698                 $text = $parserOutput->getText();
1699                 wfRunHooks( 'OutputPageBeforeHTML', array( &$this, &$text ) );
1700                 $this->addHTML( $text );
1701         }
1702
1703         /**
1704          * Add everything from a ParserOutput object.
1705          *
1706          * @param ParserOutput $parserOutput
1707          */
1708         function addParserOutput( &$parserOutput ) {
1709                 $this->addParserOutputMetadata( $parserOutput );
1710                 $parserOutput->setTOCEnabled( $this->mEnableTOC );
1711
1712                 // Touch section edit links only if not previously disabled
1713                 if ( $parserOutput->getEditSectionTokens() ) {
1714                         $parserOutput->setEditSectionTokens( $this->mEnableSectionEditLinks );
1715                 }
1716
1717                 $this->addParserOutputText( $parserOutput );
1718         }
1719
1720         /**
1721          * Add the output of a QuickTemplate to the output buffer
1722          *
1723          * @param QuickTemplate $template
1724          */
1725         public function addTemplate( &$template ) {
1726                 $this->addHTML( $template->getHTML() );
1727         }
1728
1729         /**
1730          * Parse wikitext and return the HTML.
1731          *
1732          * @param string $text
1733          * @param bool $linestart Is this the start of a line?
1734          * @param bool $interface Use interface language ($wgLang instead of
1735          *   $wgContLang) while parsing language sensitive magic words like GRAMMAR and PLURAL.
1736          *   This also disables LanguageConverter.
1737          * @param Language $language Target language object, will override $interface
1738          * @throws MWException
1739          * @return string HTML
1740          */
1741         public function parse( $text, $linestart = true, $interface = false, $language = null ) {
1742                 global $wgParser;
1743
1744                 if ( is_null( $this->getTitle() ) ) {
1745                         throw new MWException( 'Empty $mTitle in ' . __METHOD__ );
1746                 }
1747
1748                 $popts = $this->parserOptions();
1749                 if ( $interface ) {
1750                         $popts->setInterfaceMessage( true );
1751                 }
1752                 if ( $language !== null ) {
1753                         $oldLang = $popts->setTargetLanguage( $language );
1754                 }
1755
1756                 $parserOutput = $wgParser->getFreshParser()->parse(
1757                         $text, $this->getTitle(), $popts,
1758                         $linestart, true, $this->mRevisionId
1759                 );
1760
1761                 if ( $interface ) {
1762                         $popts->setInterfaceMessage( false );
1763                 }
1764                 if ( $language !== null ) {
1765                         $popts->setTargetLanguage( $oldLang );
1766                 }
1767
1768                 return $parserOutput->getText();
1769         }
1770
1771         /**
1772          * Parse wikitext, strip paragraphs, and return the HTML.
1773          *
1774          * @param string $text
1775          * @param bool $linestart Is this the start of a line?
1776          * @param bool $interface Use interface language ($wgLang instead of
1777          *   $wgContLang) while parsing language sensitive magic
1778          *   words like GRAMMAR and PLURAL
1779          * @return string HTML
1780          */
1781         public function parseInline( $text, $linestart = true, $interface = false ) {
1782                 $parsed = $this->parse( $text, $linestart, $interface );
1783                 return Parser::stripOuterParagraph( $parsed );
1784         }
1785
1786         /**
1787          * Set the value of the "s-maxage" part of the "Cache-control" HTTP header
1788          *
1789          * @param int $maxage Maximum cache time on the Squid, in seconds.
1790          */
1791         public function setSquidMaxage( $maxage ) {
1792                 $this->mSquidMaxage = $maxage;
1793         }
1794
1795         /**
1796          * Use enableClientCache(false) to force it to send nocache headers
1797          *
1798          * @param bool $state
1799          *
1800          * @return bool
1801          */
1802         public function enableClientCache( $state ) {
1803                 return wfSetVar( $this->mEnableClientCache, $state );
1804         }
1805
1806         /**
1807          * Get the list of cookies that will influence on the cache
1808          *
1809          * @return array
1810          */
1811         function getCacheVaryCookies() {
1812                 global $wgCookiePrefix, $wgCacheVaryCookies;
1813                 static $cookies;
1814                 if ( $cookies === null ) {
1815                         $cookies = array_merge(
1816                                 array(
1817                                         "{$wgCookiePrefix}Token",
1818                                         "{$wgCookiePrefix}LoggedOut",
1819                                         "forceHTTPS",
1820                                         session_name()
1821                                 ),
1822                                 $wgCacheVaryCookies
1823                         );
1824                         wfRunHooks( 'GetCacheVaryCookies', array( $this, &$cookies ) );
1825                 }
1826                 return $cookies;
1827         }
1828
1829         /**
1830          * Check if the request has a cache-varying cookie header
1831          * If it does, it's very important that we don't allow public caching
1832          *
1833          * @return bool
1834          */
1835         function haveCacheVaryCookies() {
1836                 $cookieHeader = $this->getRequest()->getHeader( 'cookie' );
1837                 if ( $cookieHeader === false ) {
1838                         return false;
1839                 }
1840                 $cvCookies = $this->getCacheVaryCookies();
1841                 foreach ( $cvCookies as $cookieName ) {
1842                         # Check for a simple string match, like the way squid does it
1843                         if ( strpos( $cookieHeader, $cookieName ) !== false ) {
1844                                 wfDebug( __METHOD__ . ": found $cookieName\n" );
1845                                 return true;
1846                         }
1847                 }
1848                 wfDebug( __METHOD__ . ": no cache-varying cookies found\n" );
1849                 return false;
1850         }
1851
1852         /**
1853          * Add an HTTP header that will influence on the cache
1854          *
1855          * @param string $header header name
1856          * @param array|null $option
1857          * @todo FIXME: Document the $option parameter; it appears to be for
1858          *        X-Vary-Options but what format is acceptable?
1859          */
1860         public function addVaryHeader( $header, $option = null ) {
1861                 if ( !array_key_exists( $header, $this->mVaryHeader ) ) {
1862                         $this->mVaryHeader[$header] = (array)$option;
1863                 } elseif ( is_array( $option ) ) {
1864                         if ( is_array( $this->mVaryHeader[$header] ) ) {
1865                                 $this->mVaryHeader[$header] = array_merge( $this->mVaryHeader[$header], $option );
1866                         } else {
1867                                 $this->mVaryHeader[$header] = $option;
1868                         }
1869                 }
1870                 $this->mVaryHeader[$header] = array_unique( (array)$this->mVaryHeader[$header] );
1871         }
1872
1873         /**
1874          * Return a Vary: header on which to vary caches. Based on the keys of $mVaryHeader,
1875          * such as Accept-Encoding or Cookie
1876          *
1877          * @return string
1878          */
1879         public function getVaryHeader() {
1880                 return 'Vary: ' . join( ', ', array_keys( $this->mVaryHeader ) );
1881         }
1882
1883         /**
1884          * Get a complete X-Vary-Options header
1885          *
1886          * @return string
1887          */
1888         public function getXVO() {
1889                 $cvCookies = $this->getCacheVaryCookies();
1890
1891                 $cookiesOption = array();
1892                 foreach ( $cvCookies as $cookieName ) {
1893                         $cookiesOption[] = 'string-contains=' . $cookieName;
1894                 }
1895                 $this->addVaryHeader( 'Cookie', $cookiesOption );
1896
1897                 $headers = array();
1898                 foreach ( $this->mVaryHeader as $header => $option ) {
1899                         $newheader = $header;
1900                         if ( is_array( $option ) && count( $option ) > 0 ) {
1901                                 $newheader .= ';' . implode( ';', $option );
1902                         }
1903                         $headers[] = $newheader;
1904                 }
1905                 $xvo = 'X-Vary-Options: ' . implode( ',', $headers );
1906
1907                 return $xvo;
1908         }
1909
1910         /**
1911          * bug 21672: Add Accept-Language to Vary and XVO headers
1912          * if there's no 'variant' parameter existed in GET.
1913          *
1914          * For example:
1915          *   /w/index.php?title=Main_page should always be served; but
1916          *   /w/index.php?title=Main_page&variant=zh-cn should never be served.
1917          */
1918         function addAcceptLanguage() {
1919                 $title = $this->getTitle();
1920                 if ( !$title instanceof Title ) {
1921                         return;
1922                 }
1923
1924                 $lang = $title->getPageLanguage();
1925                 if ( !$this->getRequest()->getCheck( 'variant' ) && $lang->hasVariants() ) {
1926                         $variants = $lang->getVariants();
1927                         $aloption = array();
1928                         foreach ( $variants as $variant ) {
1929                                 if ( $variant === $lang->getCode() ) {
1930                                         continue;
1931                                 } else {
1932                                         $aloption[] = 'string-contains=' . $variant;
1933
1934                                         // IE and some other browsers use BCP 47 standards in
1935                                         // their Accept-Language header, like "zh-CN" or "zh-Hant".
1936                                         // We should handle these too.
1937                                         $variantBCP47 = wfBCP47( $variant );
1938                                         if ( $variantBCP47 !== $variant ) {
1939                                                 $aloption[] = 'string-contains=' . $variantBCP47;
1940                                         }
1941                                 }
1942                         }
1943                         $this->addVaryHeader( 'Accept-Language', $aloption );
1944                 }
1945         }
1946
1947         /**
1948          * Set a flag which will cause an X-Frame-Options header appropriate for
1949          * edit pages to be sent. The header value is controlled by
1950          * $wgEditPageFrameOptions.
1951          *
1952          * This is the default for special pages. If you display a CSRF-protected
1953          * form on an ordinary view page, then you need to call this function.
1954          *
1955          * @param bool $enable
1956          */
1957         public function preventClickjacking( $enable = true ) {
1958                 $this->mPreventClickjacking = $enable;
1959         }
1960
1961         /**
1962          * Turn off frame-breaking. Alias for $this->preventClickjacking(false).
1963          * This can be called from pages which do not contain any CSRF-protected
1964          * HTML form.
1965          */
1966         public function allowClickjacking() {
1967                 $this->mPreventClickjacking = false;
1968         }
1969
1970         /**
1971          * Get the X-Frame-Options header value (without the name part), or false
1972          * if there isn't one. This is used by Skin to determine whether to enable
1973          * JavaScript frame-breaking, for clients that don't support X-Frame-Options.
1974          *
1975          * @return string
1976          */
1977         public function getFrameOptions() {
1978                 global $wgBreakFrames, $wgEditPageFrameOptions;
1979                 if ( $wgBreakFrames ) {
1980                         return 'DENY';
1981                 } elseif ( $this->mPreventClickjacking && $wgEditPageFrameOptions ) {
1982                         return $wgEditPageFrameOptions;
1983                 }
1984                 return false;
1985         }
1986
1987         /**
1988          * Send cache control HTTP headers
1989          */
1990         public function sendCacheControl() {
1991                 global $wgUseSquid, $wgUseESI, $wgUseETag, $wgSquidMaxage, $wgUseXVO;
1992
1993                 $response = $this->getRequest()->response();
1994                 if ( $wgUseETag && $this->mETag ) {
1995                         $response->header( "ETag: $this->mETag" );
1996                 }
1997
1998                 $this->addVaryHeader( 'Cookie' );
1999                 $this->addAcceptLanguage();
2000
2001                 # don't serve compressed data to clients who can't handle it
2002                 # maintain different caches for logged-in users and non-logged in ones
2003                 $response->header( $this->getVaryHeader() );
2004
2005                 if ( $wgUseXVO ) {
2006                         # Add an X-Vary-Options header for Squid with Wikimedia patches
2007                         $response->header( $this->getXVO() );
2008                 }
2009
2010                 if ( $this->mEnableClientCache ) {
2011                         if (
2012                                 $wgUseSquid && session_id() == '' && !$this->isPrintable() &&
2013                                 $this->mSquidMaxage != 0 && !$this->haveCacheVaryCookies()
2014                         ) {
2015                                 if ( $wgUseESI ) {
2016                                         # We'll purge the proxy cache explicitly, but require end user agents
2017                                         # to revalidate against the proxy on each visit.
2018                                         # Surrogate-Control controls our Squid, Cache-Control downstream caches
2019                                         wfDebug( __METHOD__ . ": proxy caching with ESI; {$this->mLastModified} **\n", 'log' );
2020                                         # start with a shorter timeout for initial testing
2021                                         # header( 'Surrogate-Control: max-age=2678400+2678400, content="ESI/1.0"');
2022                                         $response->header( 'Surrogate-Control: max-age=' . $wgSquidMaxage
2023                                                 . '+' . $this->mSquidMaxage . ', content="ESI/1.0"' );
2024                                         $response->header( 'Cache-Control: s-maxage=0, must-revalidate, max-age=0' );
2025                                 } else {
2026                                         # We'll purge the proxy cache for anons explicitly, but require end user agents
2027                                         # to revalidate against the proxy on each visit.
2028                                         # IMPORTANT! The Squid needs to replace the Cache-Control header with
2029                                         # Cache-Control: s-maxage=0, must-revalidate, max-age=0
2030                                         wfDebug( __METHOD__ . ": local proxy caching; {$this->mLastModified} **\n", 'log' );
2031                                         # start with a shorter timeout for initial testing
2032                                         # header( "Cache-Control: s-maxage=2678400, must-revalidate, max-age=0" );
2033                                         $response->header( 'Cache-Control: s-maxage=' . $this->mSquidMaxage
2034                                                 . ', must-revalidate, max-age=0' );
2035                                 }
2036                         } else {
2037                                 # We do want clients to cache if they can, but they *must* check for updates
2038                                 # on revisiting the page.
2039                                 wfDebug( __METHOD__ . ": private caching; {$this->mLastModified} **\n", 'log' );
2040                                 $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
2041                                 $response->header( "Cache-Control: private, must-revalidate, max-age=0" );
2042                         }
2043                         if ( $this->mLastModified ) {
2044                                 $response->header( "Last-Modified: {$this->mLastModified}" );
2045                         }
2046                 } else {
2047                         wfDebug( __METHOD__ . ": no caching **\n", 'log' );
2048
2049                         # In general, the absence of a last modified header should be enough to prevent
2050                         # the client from using its cache. We send a few other things just to make sure.
2051                         $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
2052                         $response->header( 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate' );
2053                         $response->header( 'Pragma: no-cache' );
2054                 }
2055         }
2056
2057         /**
2058          * Finally, all the text has been munged and accumulated into
2059          * the object, let's actually output it:
2060          */
2061         public function output() {
2062                 global $wgLanguageCode, $wgDebugRedirects, $wgMimeType, $wgVaryOnXFP,
2063                         $wgUseAjax, $wgResponsiveImages;
2064
2065                 if ( $this->mDoNothing ) {
2066                         return;
2067                 }
2068
2069                 wfProfileIn( __METHOD__ );
2070
2071                 $response = $this->getRequest()->response();
2072
2073                 if ( $this->mRedirect != '' ) {
2074                         # Standards require redirect URLs to be absolute
2075                         $this->mRedirect = wfExpandUrl( $this->mRedirect, PROTO_CURRENT );
2076
2077                         $redirect = $this->mRedirect;
2078                         $code = $this->mRedirectCode;
2079
2080                         if ( wfRunHooks( "BeforePageRedirect", array( $this, &$redirect, &$code ) ) ) {
2081                                 if ( $code == '301' || $code == '303' ) {
2082                                         if ( !$wgDebugRedirects ) {
2083                                                 $message = HttpStatus::getMessage( $code );
2084                                                 $response->header( "HTTP/1.1 $code $message" );
2085                                         }
2086                                         $this->mLastModified = wfTimestamp( TS_RFC2822 );
2087                                 }
2088                                 if ( $wgVaryOnXFP ) {
2089                                         $this->addVaryHeader( 'X-Forwarded-Proto' );
2090                                 }
2091                                 $this->sendCacheControl();
2092
2093                                 $response->header( "Content-Type: text/html; charset=utf-8" );
2094                                 if ( $wgDebugRedirects ) {
2095                                         $url = htmlspecialchars( $redirect );
2096                                         print "<html>\n<head>\n<title>Redirect</title>\n</head>\n<body>\n";
2097                                         print "<p>Location: <a href=\"$url\">$url</a></p>\n";
2098                                         print "</body>\n</html>\n";
2099                                 } else {
2100                                         $response->header( 'Location: ' . $redirect );
2101                                 }
2102                         }
2103
2104                         wfProfileOut( __METHOD__ );
2105                         return;
2106                 } elseif ( $this->mStatusCode ) {
2107                         $message = HttpStatus::getMessage( $this->mStatusCode );
2108                         if ( $message ) {
2109                                 $response->header( 'HTTP/1.1 ' . $this->mStatusCode . ' ' . $message );
2110                         }
2111                 }
2112
2113                 # Buffer output; final headers may depend on later processing
2114                 ob_start();
2115
2116                 $response->header( "Content-type: $wgMimeType; charset=UTF-8" );
2117                 $response->header( 'Content-language: ' . $wgLanguageCode );
2118
2119                 // Avoid Internet Explorer "compatibility view" in IE 8-10, so that
2120                 // jQuery etc. can work correctly.
2121                 $response->header( 'X-UA-Compatible: IE=Edge' );
2122
2123                 // Prevent framing, if requested
2124                 $frameOptions = $this->getFrameOptions();
2125                 if ( $frameOptions ) {
2126                         $response->header( "X-Frame-Options: $frameOptions" );
2127                 }
2128
2129                 if ( $this->mArticleBodyOnly ) {
2130                         echo $this->mBodytext;
2131                 } else {
2132
2133                         $sk = $this->getSkin();
2134                         // add skin specific modules
2135                         $modules = $sk->getDefaultModules();
2136
2137                         // enforce various default modules for all skins
2138                         $coreModules = array(
2139                                 // keep this list as small as possible
2140                                 'mediawiki.page.startup',
2141                                 'mediawiki.user',
2142                         );
2143
2144                         // Support for high-density display images if enabled
2145                         if ( $wgResponsiveImages ) {
2146                                 $coreModules[] = 'mediawiki.hidpi';
2147                         }
2148
2149                         $this->addModules( $coreModules );
2150                         foreach ( $modules as $group ) {
2151                                 $this->addModules( $group );
2152                         }
2153                         MWDebug::addModules( $this );
2154                         if ( $wgUseAjax ) {
2155                                 // FIXME: deprecate? - not clear why this is useful
2156                                 wfRunHooks( 'AjaxAddScript', array( &$this ) );
2157                         }
2158
2159                         // Hook that allows last minute changes to the output page, e.g.
2160                         // adding of CSS or Javascript by extensions.
2161                         wfRunHooks( 'BeforePageDisplay', array( &$this, &$sk ) );
2162
2163                         wfProfileIn( 'Output-skin' );
2164                         $sk->outputPage();
2165                         wfProfileOut( 'Output-skin' );
2166                 }
2167
2168                 // This hook allows last minute changes to final overall output by modifying output buffer
2169                 wfRunHooks( 'AfterFinalPageOutput', array( $this ) );
2170
2171                 $this->sendCacheControl();
2172
2173                 ob_end_flush();
2174
2175                 wfProfileOut( __METHOD__ );
2176         }
2177
2178         /**
2179          * Actually output something with print.
2180          *
2181          * @param string $ins the string to output
2182          * @deprecated since 1.22 Use echo yourself.
2183          */
2184         public function out( $ins ) {
2185                 wfDeprecated( __METHOD__, '1.22' );
2186                 print $ins;
2187         }
2188
2189         /**
2190          * Produce a "user is blocked" page.
2191          * @deprecated since 1.18
2192          */
2193         function blockedPage() {
2194                 throw new UserBlockedError( $this->getUser()->mBlock );
2195         }
2196
2197         /**
2198          * Prepare this object to display an error page; disable caching and
2199          * indexing, clear the current text and redirect, set the page's title
2200          * and optionally an custom HTML title (content of the "<title>" tag).
2201          *
2202          * @param string|Message $pageTitle will be passed directly to setPageTitle()
2203          * @param string|Message $htmlTitle will be passed directly to setHTMLTitle();
2204          *                   optional, if not passed the "<title>" attribute will be
2205          *                   based on $pageTitle
2206          */
2207         public function prepareErrorPage( $pageTitle, $htmlTitle = false ) {
2208                 $this->setPageTitle( $pageTitle );
2209                 if ( $htmlTitle !== false ) {
2210                         $this->setHTMLTitle( $htmlTitle );
2211                 }
2212                 $this->setRobotPolicy( 'noindex,nofollow' );
2213                 $this->setArticleRelated( false );
2214                 $this->enableClientCache( false );
2215                 $this->mRedirect = '';
2216                 $this->clearSubtitle();
2217                 $this->clearHTML();
2218         }
2219
2220         /**
2221          * Output a standard error page
2222          *
2223          * showErrorPage( 'titlemsg', 'pagetextmsg' );
2224          * showErrorPage( 'titlemsg', 'pagetextmsg', array( 'param1', 'param2' ) );
2225          * showErrorPage( 'titlemsg', $messageObject );
2226          * showErrorPage( $titleMessageObject, $messageObject );
2227          *
2228          * @param string|Message $title Message key (string) for page title, or a Message object
2229          * @param string|Message $msg Message key (string) for page text, or a Message object
2230          * @param array $params Message parameters; ignored if $msg is a Message object
2231          */
2232         public function showErrorPage( $title, $msg, $params = array() ) {
2233                 if ( !$title instanceof Message ) {
2234                         $title = $this->msg( $title );
2235                 }
2236
2237                 $this->prepareErrorPage( $title );
2238
2239                 if ( $msg instanceof Message ) {
2240                         if ( $params !== array() ) {
2241                                 trigger_error( 'Argument ignored: $params. The message parameters argument '
2242                                         . 'is discarded when the $msg argument is a Message object instead of '
2243                                         . 'a string.', E_USER_NOTICE );
2244                         }
2245                         $this->addHTML( $msg->parseAsBlock() );
2246                 } else {
2247                         $this->addWikiMsgArray( $msg, $params );
2248                 }
2249
2250                 $this->returnToMain();
2251         }
2252
2253         /**
2254          * Output a standard permission error page
2255          *
2256          * @param array $errors error message keys
2257          * @param string $action action that was denied or null if unknown
2258          */
2259         public function showPermissionsErrorPage( $errors, $action = null ) {
2260                 // For some action (read, edit, create and upload), display a "login to do this action"
2261                 // error if all of the following conditions are met:
2262                 // 1. the user is not logged in
2263                 // 2. the only error is insufficient permissions (i.e. no block or something else)
2264                 // 3. the error can be avoided simply by logging in
2265                 if ( in_array( $action, array( 'read', 'edit', 'createpage', 'createtalk', 'upload' ) )
2266                         && $this->getUser()->isAnon() && count( $errors ) == 1 && isset( $errors[0][0] )
2267                         && ( $errors[0][0] == 'badaccess-groups' || $errors[0][0] == 'badaccess-group0' )
2268                         && ( User::groupHasPermission( 'user', $action )
2269                         || User::groupHasPermission( 'autoconfirmed', $action ) )
2270                 ) {
2271                         $displayReturnto = null;
2272
2273                         # Due to bug 32276, if a user does not have read permissions,
2274                         # $this->getTitle() will just give Special:Badtitle, which is
2275                         # not especially useful as a returnto parameter. Use the title
2276                         # from the request instead, if there was one.
2277                         $request = $this->getRequest();
2278                         $returnto = Title::newFromURL( $request->getVal( 'title', '' ) );
2279                         if ( $action == 'edit' ) {
2280                                 $msg = 'whitelistedittext';
2281                                 $displayReturnto = $returnto;
2282                         } elseif ( $action == 'createpage' || $action == 'createtalk' ) {
2283                                 $msg = 'nocreatetext';
2284                         } elseif ( $action == 'upload' ) {
2285                                 $msg = 'uploadnologintext';
2286                         } else { # Read
2287                                 $msg = 'loginreqpagetext';
2288                                 $displayReturnto = Title::newMainPage();
2289                         }
2290
2291                         $query = array();
2292
2293                         if ( $returnto ) {
2294                                 $query['returnto'] = $returnto->getPrefixedText();
2295
2296                                 if ( !$request->wasPosted() ) {
2297                                         $returntoquery = $request->getValues();
2298                                         unset( $returntoquery['title'] );
2299                                         unset( $returntoquery['returnto'] );
2300                                         unset( $returntoquery['returntoquery'] );
2301                                         $query['returntoquery'] = wfArrayToCgi( $returntoquery );
2302                                 }
2303                         }
2304                         $loginLink = Linker::linkKnown(
2305                                 SpecialPage::getTitleFor( 'Userlogin' ),
2306                                 $this->msg( 'loginreqlink' )->escaped(),
2307                                 array(),
2308                                 $query
2309                         );
2310
2311                         $this->prepareErrorPage( $this->msg( 'loginreqtitle' ) );
2312                         $this->addHTML( $this->msg( $msg )->rawParams( $loginLink )->parse() );
2313
2314                         # Don't return to a page the user can't read otherwise
2315                         # we'll end up in a pointless loop
2316                         if ( $displayReturnto && $displayReturnto->userCan( 'read', $this->getUser() ) ) {
2317                                 $this->returnToMain( null, $displayReturnto );
2318                         }
2319                 } else {
2320                         $this->prepareErrorPage( $this->msg( 'permissionserrors' ) );
2321                         $this->addWikiText( $this->formatPermissionsErrorMessage( $errors, $action ) );
2322                 }
2323         }
2324
2325         /**
2326          * Display an error page indicating that a given version of MediaWiki is
2327          * required to use it
2328          *
2329          * @param mixed $version The version of MediaWiki needed to use the page
2330          */
2331         public function versionRequired( $version ) {
2332                 $this->prepareErrorPage( $this->msg( 'versionrequired', $version ) );
2333
2334                 $this->addWikiMsg( 'versionrequiredtext', $version );
2335                 $this->returnToMain();
2336         }
2337
2338         /**
2339          * Display an error page noting that a given permission bit is required.
2340          * @deprecated since 1.18, just throw the exception directly
2341          * @param string $permission key required
2342          * @throws PermissionsError
2343          */
2344         public function permissionRequired( $permission ) {
2345                 throw new PermissionsError( $permission );
2346         }
2347
2348         /**
2349          * Produce the stock "please login to use the wiki" page
2350          *
2351          * @deprecated since 1.19; throw the exception directly
2352          */
2353         public function loginToUse() {
2354                 throw new PermissionsError( 'read' );
2355         }
2356
2357         /**
2358          * Format a list of error messages
2359          *
2360          * @param array $errors Array of arrays returned by Title::getUserPermissionsErrors
2361          * @param string $action Action that was denied or null if unknown
2362          * @return string The wikitext error-messages, formatted into a list.
2363          */
2364         public function formatPermissionsErrorMessage( $errors, $action = null ) {
2365                 if ( $action == null ) {
2366                         $text = $this->msg( 'permissionserrorstext', count( $errors ) )->plain() . "\n\n";
2367                 } else {
2368                         $action_desc = $this->msg( "action-$action" )->plain();
2369                         $text = $this->msg(
2370                                 'permissionserrorstext-withaction',
2371                                 count( $errors ),
2372                                 $action_desc
2373                         )->plain() . "\n\n";
2374                 }
2375
2376                 if ( count( $errors ) > 1 ) {
2377                         $text .= '<ul class="permissions-errors">' . "\n";
2378
2379                         foreach ( $errors as $error ) {
2380                                 $text .= '<li>';
2381                                 $text .= call_user_func_array( array( $this, 'msg' ), $error )->plain();
2382                                 $text .= "</li>\n";
2383                         }
2384                         $text .= '</ul>';
2385                 } else {
2386                         $text .= "<div class=\"permissions-errors\">\n" .
2387                                         call_user_func_array( array( $this, 'msg' ), reset( $errors ) )->plain() .
2388                                         "\n</div>";
2389                 }
2390
2391                 return $text;
2392         }
2393
2394         /**
2395          * Display a page stating that the Wiki is in read-only mode,
2396          * and optionally show the source of the page that the user
2397          * was trying to edit.  Should only be called (for this
2398          * purpose) after wfReadOnly() has returned true.
2399          *
2400          * For historical reasons, this function is _also_ used to
2401          * show the error message when a user tries to edit a page
2402          * they are not allowed to edit.  (Unless it's because they're
2403          * blocked, then we show blockedPage() instead.)  In this
2404          * case, the second parameter should be set to true and a list
2405          * of reasons supplied as the third parameter.
2406          *
2407          * @todo Needs to be split into multiple functions.
2408          *
2409          * @param string $source Source code to show (or null).
2410          * @param bool $protected Is this a permissions error?
2411          * @param array $reasons List of reasons for this error, as returned by
2412          *   Title::getUserPermissionsErrors().
2413          * @param string $action Action that was denied or null if unknown
2414          * @throws ReadOnlyError
2415          */
2416         public function readOnlyPage( $source = null, $protected = false,
2417                 $reasons = array(), $action = null
2418         ) {
2419                 $this->setRobotPolicy( 'noindex,nofollow' );
2420                 $this->setArticleRelated( false );
2421
2422                 // If no reason is given, just supply a default "I can't let you do
2423                 // that, Dave" message.  Should only occur if called by legacy code.
2424                 if ( $protected && empty( $reasons ) ) {
2425                         $reasons[] = array( 'badaccess-group0' );
2426                 }
2427
2428                 if ( !empty( $reasons ) ) {
2429                         // Permissions error
2430                         if ( $source ) {
2431                                 $this->setPageTitle( $this->msg( 'viewsource-title', $this->getTitle()->getPrefixedText() ) );
2432                                 $this->addBacklinkSubtitle( $this->getTitle() );
2433                         } else {
2434                                 $this->setPageTitle( $this->msg( 'badaccess' ) );
2435                         }
2436                         $this->addWikiText( $this->formatPermissionsErrorMessage( $reasons, $action ) );
2437                 } else {
2438                         // Wiki is read only
2439                         throw new ReadOnlyError;
2440                 }
2441
2442                 // Show source, if supplied
2443                 if ( is_string( $source ) ) {
2444                         $this->addWikiMsg( 'viewsourcetext' );
2445
2446                         $pageLang = $this->getTitle()->getPageLanguage();
2447                         $params = array(
2448                                 'id' => 'wpTextbox1',
2449                                 'name' => 'wpTextbox1',
2450                                 'cols' => $this->getUser()->getOption( 'cols' ),
2451                                 'rows' => $this->getUser()->getOption( 'rows' ),
2452                                 'readonly' => 'readonly',
2453                                 'lang' => $pageLang->getHtmlCode(),
2454                                 'dir' => $pageLang->getDir(),
2455                         );
2456                         $this->addHTML( Html::element( 'textarea', $params, $source ) );
2457
2458                         // Show templates used by this article
2459                         $templates = Linker::formatTemplates( $this->getTitle()->getTemplateLinksFrom() );
2460                         $this->addHTML( "<div class='templatesUsed'>
2461 $templates
2462 </div>
2463 " );
2464                 }
2465
2466                 # If the title doesn't exist, it's fairly pointless to print a return
2467                 # link to it.  After all, you just tried editing it and couldn't, so
2468                 # what's there to do there?
2469                 if ( $this->getTitle()->exists() ) {
2470                         $this->returnToMain( null, $this->getTitle() );
2471                 }
2472         }
2473
2474         /**
2475          * Turn off regular page output and return an error response
2476          * for when rate limiting has triggered.
2477          */
2478         public function rateLimited() {
2479                 throw new ThrottledError;
2480         }
2481
2482         /**
2483          * Show a warning about slave lag
2484          *
2485          * If the lag is higher than $wgSlaveLagCritical seconds,
2486          * then the warning is a bit more obvious. If the lag is
2487          * lower than $wgSlaveLagWarning, then no warning is shown.
2488          *
2489          * @param int $lag Slave lag
2490          */
2491         public function showLagWarning( $lag ) {
2492                 global $wgSlaveLagWarning, $wgSlaveLagCritical;
2493                 if ( $lag >= $wgSlaveLagWarning ) {
2494                         $message = $lag < $wgSlaveLagCritical
2495                                 ? 'lag-warn-normal'
2496                                 : 'lag-warn-high';
2497                         $wrap = Html::rawElement( 'div', array( 'class' => "mw-{$message}" ), "\n$1\n" );
2498                         $this->wrapWikiMsg( "$wrap\n", array( $message, $this->getLanguage()->formatNum( $lag ) ) );
2499                 }
2500         }
2501
2502         public function showFatalError( $message ) {
2503                 $this->prepareErrorPage( $this->msg( 'internalerror' ) );
2504
2505                 $this->addHTML( $message );
2506         }
2507
2508         public function showUnexpectedValueError( $name, $val ) {
2509                 $this->showFatalError( $this->msg( 'unexpected', $name, $val )->text() );
2510         }
2511
2512         public function showFileCopyError( $old, $new ) {
2513                 $this->showFatalError( $this->msg( 'filecopyerror', $old, $new )->text() );
2514         }
2515
2516         public function showFileRenameError( $old, $new ) {
2517                 $this->showFatalError( $this->msg( 'filerenameerror', $old, $new )->text() );
2518         }
2519
2520         public function showFileDeleteError( $name ) {
2521                 $this->showFatalError( $this->msg( 'filedeleteerror', $name )->text() );
2522         }
2523
2524         public function showFileNotFoundError( $name ) {
2525                 $this->showFatalError( $this->msg( 'filenotfound', $name )->text() );
2526         }
2527
2528         /**
2529          * Add a "return to" link pointing to a specified title
2530          *
2531          * @param Title $title Title to link
2532          * @param array $query Query string parameters
2533          * @param string $text Text of the link (input is not escaped)
2534          * @param array $options Options array to pass to Linker
2535          */
2536         public function addReturnTo( $title, $query = array(), $text = null, $options = array() ) {
2537                 $link = $this->msg( 'returnto' )->rawParams(
2538                         Linker::link( $title, $text, array(), $query, $options ) )->escaped();
2539                 $this->addHTML( "<p id=\"mw-returnto\">{$link}</p>\n" );
2540         }
2541
2542         /**
2543          * Add a "return to" link pointing to a specified title,
2544          * or the title indicated in the request, or else the main page
2545          *
2546          * @param mixed $unused
2547          * @param Title|string $returnto Title or String to return to
2548          * @param string $returntoquery Query string for the return to link
2549          */
2550         public function returnToMain( $unused = null, $returnto = null, $returntoquery = null ) {
2551                 if ( $returnto == null ) {
2552                         $returnto = $this->getRequest()->getText( 'returnto' );
2553                 }
2554
2555                 if ( $returntoquery == null ) {
2556                         $returntoquery = $this->getRequest()->getText( 'returntoquery' );
2557                 }
2558
2559                 if ( $returnto === '' ) {
2560                         $returnto = Title::newMainPage();
2561                 }
2562
2563                 if ( is_object( $returnto ) ) {
2564                         $titleObj = $returnto;
2565                 } else {
2566                         $titleObj = Title::newFromText( $returnto );
2567                 }
2568                 if ( !is_object( $titleObj ) ) {
2569                         $titleObj = Title::newMainPage();
2570                 }
2571
2572                 $this->addReturnTo( $titleObj, wfCgiToArray( $returntoquery ) );
2573         }
2574
2575         /**
2576          * @param Skin $sk The given Skin
2577          * @param bool $includeStyle Unused
2578          * @return string The doctype, opening "<html>", and head element.
2579          */
2580         public function headElement( Skin $sk, $includeStyle = true ) {
2581                 global $wgContLang, $wgMimeType;
2582
2583                 $userdir = $this->getLanguage()->getDir();
2584                 $sitedir = $wgContLang->getDir();
2585
2586                 $ret = Html::htmlHeader( $sk->getHtmlElementAttributes() );
2587
2588                 if ( $this->getHTMLTitle() == '' ) {
2589                         $this->setHTMLTitle( $this->msg( 'pagetitle', $this->getPageTitle() )->inContentLanguage() );
2590                 }
2591
2592                 $openHead = Html::openElement( 'head' );
2593                 if ( $openHead ) {
2594                         # Don't bother with the newline if $head == ''
2595                         $ret .= "$openHead\n";
2596                 }
2597
2598                 if ( !Html::isXmlMimeType( $wgMimeType ) ) {
2599                         // Add <meta charset="UTF-8">
2600                         // This should be before <title> since it defines the charset used by
2601                         // text including the text inside <title>.
2602                         // The spec recommends defining XHTML5's charset using the XML declaration
2603                         // instead of meta.
2604                         // Our XML declaration is output by Html::htmlHeader.
2605                         // http://www.whatwg.org/html/semantics.html#attr-meta-http-equiv-content-type
2606                         // http://www.whatwg.org/html/semantics.html#charset
2607                         $ret .= Html::element( 'meta', array( 'charset' => 'UTF-8' ) ) . "\n";
2608                 }
2609
2610                 $ret .= Html::element( 'title', null, $this->getHTMLTitle() ) . "\n";
2611
2612                 foreach ( $this->getHeadLinksArray() as $item ) {
2613                         $ret .= $item . "\n";
2614                 }
2615
2616                 // No newline after buildCssLinks since makeResourceLoaderLink did that already
2617                 $ret .= $this->buildCssLinks();
2618
2619                 $ret .= $this->getHeadScripts() . "\n";
2620
2621                 foreach ( $this->mHeadItems as $item ) {
2622                         $ret .= $item . "\n";
2623                 }
2624
2625                 $closeHead = Html::closeElement( 'head' );
2626                 if ( $closeHead ) {
2627                         $ret .= "$closeHead\n";
2628                 }
2629
2630                 $bodyClasses = array();
2631                 $bodyClasses[] = 'mediawiki';
2632
2633                 # Classes for LTR/RTL directionality support
2634                 $bodyClasses[] = $userdir;
2635                 $bodyClasses[] = "sitedir-$sitedir";
2636
2637                 if ( $this->getLanguage()->capitalizeAllNouns() ) {
2638                         # A <body> class is probably not the best way to do this . . .
2639                         $bodyClasses[] = 'capitalize-all-nouns';
2640                 }
2641
2642                 $bodyClasses[] = $sk->getPageClasses( $this->getTitle() );
2643                 $bodyClasses[] = 'skin-' . Sanitizer::escapeClass( $sk->getSkinName() );
2644                 $bodyClasses[] =
2645                         'action-' . Sanitizer::escapeClass( Action::getActionName( $this->getContext() ) );
2646
2647                 $bodyAttrs = array();
2648                 // While the implode() is not strictly needed, it's used for backwards compatibility
2649                 // (this used to be built as a string and hooks likely still expect that).
2650                 $bodyAttrs['class'] = implode( ' ', $bodyClasses );
2651
2652                 // Allow skins and extensions to add body attributes they need
2653                 $sk->addToBodyAttributes( $this, $bodyAttrs );
2654                 wfRunHooks( 'OutputPageBodyAttributes', array( $this, $sk, &$bodyAttrs ) );
2655
2656                 $ret .= Html::openElement( 'body', $bodyAttrs ) . "\n";
2657
2658                 return $ret;
2659         }
2660
2661         /**
2662          * Get a ResourceLoader object associated with this OutputPage
2663          *
2664          * @return ResourceLoader
2665          */
2666         public function getResourceLoader() {
2667                 if ( is_null( $this->mResourceLoader ) ) {
2668                         $this->mResourceLoader = new ResourceLoader();
2669                 }
2670                 return $this->mResourceLoader;
2671         }
2672
2673         /**
2674          * @todo Document
2675          * @param array|string $modules One or more module names
2676          * @param string $only ResourceLoaderModule TYPE_ class constant
2677          * @param bool $useESI
2678          * @param array $extraQuery Array with extra query parameters to add to each
2679          *   request. array( param => value ).
2680          * @param bool $loadCall If true, output an (asynchronous) mw.loader.load()
2681          *   call rather than a "<script src='...'>" tag.
2682          * @return string The html "<script>", "<link>" and "<style>" tags
2683          */
2684         protected function makeResourceLoaderLink( $modules, $only, $useESI = false,
2685                 array $extraQuery = array(), $loadCall = false
2686         ) {
2687                 global $wgResourceLoaderUseESI;
2688
2689                 $modules = (array)$modules;
2690
2691                 $links = array(
2692                         'html' => '',
2693                         'states' => array(),
2694                 );
2695
2696                 if ( !count( $modules ) ) {
2697                         return $links;
2698                 }
2699
2700                 if ( count( $modules ) > 1 ) {
2701                         // Remove duplicate module requests
2702                         $modules = array_unique( $modules );
2703                         // Sort module names so requests are more uniform
2704                         sort( $modules );
2705
2706                         if ( ResourceLoader::inDebugMode() ) {
2707                                 // Recursively call us for every item
2708                                 foreach ( $modules as $name ) {
2709                                         $link = $this->makeResourceLoaderLink( $name, $only, $useESI );
2710                                         $links['html'] .= $link['html'];
2711                                         $links['states'] += $link['states'];
2712                                 }
2713                                 return $links;
2714                         }
2715                 }
2716
2717                 if ( !is_null( $this->mTarget ) ) {
2718                         $extraQuery['target'] = $this->mTarget;
2719                 }
2720
2721                 // Create keyed-by-group list of module objects from modules list
2722                 $groups = array();
2723                 $resourceLoader = $this->getResourceLoader();
2724                 foreach ( $modules as $name ) {
2725                         $module = $resourceLoader->getModule( $name );
2726                         # Check that we're allowed to include this module on this page
2727                         if ( !$module
2728                                 || ( $module->getOrigin() > $this->getAllowedModules( ResourceLoaderModule::TYPE_SCRIPTS )
2729                                         && $only == ResourceLoaderModule::TYPE_SCRIPTS )
2730                                 || ( $module->getOrigin() > $this->getAllowedModules( ResourceLoaderModule::TYPE_STYLES )
2731                                         && $only == ResourceLoaderModule::TYPE_STYLES )
2732                                 || ( $this->mTarget && !in_array( $this->mTarget, $module->getTargets() ) )
2733                         ) {
2734                                 continue;
2735                         }
2736
2737                         $group = $module->getGroup();
2738                         if ( !isset( $groups[$group] ) ) {
2739                                 $groups[$group] = array();
2740                         }
2741                         $groups[$group][$name] = $module;
2742                 }
2743
2744                 foreach ( $groups as $group => $grpModules ) {
2745                         // Special handling for user-specific groups
2746                         $user = null;
2747                         if ( ( $group === 'user' || $group === 'private' ) && $this->getUser()->isLoggedIn() ) {
2748                                 $user = $this->getUser()->getName();
2749                         }
2750
2751                         // Create a fake request based on the one we are about to make so modules return
2752                         // correct timestamp and emptiness data
2753                         $query = ResourceLoader::makeLoaderQuery(
2754                                 array(), // modules; not determined yet
2755                                 $this->getLanguage()->getCode(),
2756                                 $this->getSkin()->getSkinName(),
2757                                 $user,
2758                                 null, // version; not determined yet
2759                                 ResourceLoader::inDebugMode(),
2760                                 $only === ResourceLoaderModule::TYPE_COMBINED ? null : $only,
2761                                 $this->isPrintable(),
2762                                 $this->getRequest()->getBool( 'handheld' ),
2763                                 $extraQuery
2764                         );
2765                         $context = new ResourceLoaderContext( $resourceLoader, new FauxRequest( $query ) );
2766
2767                         // Extract modules that know they're empty
2768                         foreach ( $grpModules as $key => $module ) {
2769                                 // Inline empty modules: since they're empty, just mark them as 'ready' (bug 46857)
2770                                 // If we're only getting the styles, we don't need to do anything for empty modules.
2771                                 if ( $module->isKnownEmpty( $context ) ) {
2772                                         unset( $grpModules[$key] );
2773                                         if ( $only !== ResourceLoaderModule::TYPE_STYLES ) {
2774                                                 $links['states'][$key] = 'ready';
2775                                         }
2776                                 }
2777                         }
2778
2779                         // If there are no non-empty modules, skip this group
2780                         if ( count( $grpModules ) === 0 ) {
2781                                 continue;
2782                         }
2783
2784                         // Inline private modules. These can't be loaded through load.php for security
2785                         // reasons, see bug 34907. Note that these modules should be loaded from
2786                         // getHeadScripts() before the first loader call. Otherwise other modules can't
2787                         // properly use them as dependencies (bug 30914)
2788                         if ( $group === 'private' ) {
2789                                 if ( $only == ResourceLoaderModule::TYPE_STYLES ) {
2790                                         $links['html'] .= Html::inlineStyle(
2791                                                 $resourceLoader->makeModuleResponse( $context, $grpModules )
2792                                         );
2793                                 } else {
2794                                         $links['html'] .= Html::inlineScript(
2795                                                 ResourceLoader::makeLoaderConditionalScript(
2796                                                         $resourceLoader->makeModuleResponse( $context, $grpModules )
2797                                                 )
2798                                         );
2799                                 }
2800                                 $links['html'] .= "\n";
2801                                 continue;
2802                         }
2803
2804                         // Special handling for the user group; because users might change their stuff
2805                         // on-wiki like user pages, or user preferences; we need to find the highest
2806                         // timestamp of these user-changeable modules so we can ensure cache misses on change
2807                         // This should NOT be done for the site group (bug 27564) because anons get that too
2808                         // and we shouldn't be putting timestamps in Squid-cached HTML
2809                         $version = null;
2810                         if ( $group === 'user' ) {
2811                                 // Get the maximum timestamp
2812                                 $timestamp = 1;
2813                                 foreach ( $grpModules as $module ) {
2814                                         $timestamp = max( $timestamp, $module->getModifiedTime( $context ) );
2815                                 }
2816                                 // Add a version parameter so cache will break when things change
2817                                 $version = wfTimestamp( TS_ISO_8601_BASIC, $timestamp );
2818                         }
2819
2820                         $url = ResourceLoader::makeLoaderURL(
2821                                 array_keys( $grpModules ),
2822                                 $this->getLanguage()->getCode(),
2823                                 $this->getSkin()->getSkinName(),
2824                                 $user,
2825                                 $version,
2826                                 ResourceLoader::inDebugMode(),
2827                                 $only === ResourceLoaderModule::TYPE_COMBINED ? null : $only,
2828                                 $this->isPrintable(),
2829                                 $this->getRequest()->getBool( 'handheld' ),
2830                                 $extraQuery
2831                         );
2832                         if ( $useESI && $wgResourceLoaderUseESI ) {
2833                                 $esi = Xml::element( 'esi:include', array( 'src' => $url ) );
2834                                 if ( $only == ResourceLoaderModule::TYPE_STYLES ) {
2835                                         $link = Html::inlineStyle( $esi );
2836                                 } else {
2837                                         $link = Html::inlineScript( $esi );
2838                                 }
2839                         } else {
2840                                 // Automatically select style/script elements
2841                                 if ( $only === ResourceLoaderModule::TYPE_STYLES ) {
2842                                         $link = Html::linkedStyle( $url );
2843                                 } elseif ( $loadCall ) {
2844                                         $link = Html::inlineScript(
2845                                                 ResourceLoader::makeLoaderConditionalScript(
2846                                                         Xml::encodeJsCall( 'mw.loader.load', array( $url, 'text/javascript', true ) )
2847                                                 )
2848                                         );
2849                                 } else {
2850                                         $link = Html::linkedScript( $url );
2851
2852                                         // For modules requested directly in the html via <link> or <script>,
2853                                         // tell mw.loader they are being loading to prevent duplicate requests.
2854                                         foreach ( $grpModules as $key => $module ) {
2855                                                 // Don't output state=loading for the startup module..
2856                                                 if ( $key !== 'startup' ) {
2857                                                         $links['states'][$key] = 'loading';
2858                                                 }
2859                                         }
2860                                 }
2861                         }
2862
2863                         if ( $group == 'noscript' ) {
2864                                 $links['html'] .= Html::rawElement( 'noscript', array(), $link ) . "\n";
2865                         } else {
2866                                 $links['html'] .= $link . "\n";
2867                         }
2868                 }
2869
2870                 return $links;
2871         }
2872
2873         /**
2874          * Build html output from an array of links from makeResourceLoaderLink.
2875          * @param array $links
2876          * @return string HTML
2877          */
2878         protected static function getHtmlFromLoaderLinks( Array $links ) {
2879                 $html = '';
2880                 $states = array();
2881                 foreach ( $links as $link ) {
2882                         if ( !is_array( $link ) ) {
2883                                 $html .= $link;
2884                         } else {
2885                                 $html .= $link['html'];
2886                                 $states += $link['states'];
2887                         }
2888                 }
2889
2890                 if ( count( $states ) ) {
2891                         $html = Html::inlineScript(
2892                                 ResourceLoader::makeLoaderConditionalScript(
2893                                         ResourceLoader::makeLoaderStateScript( $states )
2894                                 )
2895                         ) . "\n" . $html;
2896                 }
2897
2898                 return $html;
2899         }
2900
2901         /**
2902          * JS stuff to put in the "<head>". This is the startup module, config
2903          * vars and modules marked with position 'top'
2904          *
2905          * @return string HTML fragment
2906          */
2907         function getHeadScripts() {
2908                 global $wgResourceLoaderExperimentalAsyncLoading;
2909
2910                 // Startup - this will immediately load jquery and mediawiki modules
2911                 $links = array();
2912                 $links[] = $this->makeResourceLoaderLink( 'startup', ResourceLoaderModule::TYPE_SCRIPTS, true );
2913
2914                 // Load config before anything else
2915                 $links[] = Html::inlineScript(
2916                         ResourceLoader::makeLoaderConditionalScript(
2917                                 ResourceLoader::makeConfigSetScript( $this->getJSVars() )
2918                         )
2919                 );
2920
2921                 // Load embeddable private modules before any loader links
2922                 // This needs to be TYPE_COMBINED so these modules are properly wrapped
2923                 // in mw.loader.implement() calls and deferred until mw.user is available
2924                 $embedScripts = array( 'user.options', 'user.tokens' );
2925                 $links[] = $this->makeResourceLoaderLink( $embedScripts, ResourceLoaderModule::TYPE_COMBINED );
2926
2927                 // Scripts and messages "only" requests marked for top inclusion
2928                 // Messages should go first
2929                 $links[] = $this->makeResourceLoaderLink(
2930                         $this->getModuleMessages( true, 'top' ),
2931                         ResourceLoaderModule::TYPE_MESSAGES
2932                 );
2933                 $links[] = $this->makeResourceLoaderLink(
2934                         $this->getModuleScripts( true, 'top' ),
2935                         ResourceLoaderModule::TYPE_SCRIPTS
2936                 );
2937
2938                 // Modules requests - let the client calculate dependencies and batch requests as it likes
2939                 // Only load modules that have marked themselves for loading at the top
2940                 $modules = $this->getModules( true, 'top' );
2941                 if ( $modules ) {
2942                         $links[] = Html::inlineScript(
2943                                 ResourceLoader::makeLoaderConditionalScript(
2944                                         Xml::encodeJsCall( 'mw.loader.load', array( $modules ) )
2945                                 )
2946                         );
2947                 }
2948
2949                 if ( $wgResourceLoaderExperimentalAsyncLoading ) {
2950                         $links[] = $this->getScriptsForBottomQueue( true );
2951                 }
2952
2953                 return self::getHtmlFromLoaderLinks( $links );
2954         }
2955
2956         /**
2957          * JS stuff to put at the 'bottom', which can either be the bottom of the
2958          * "<body>" or the bottom of the "<head>" depending on
2959          * $wgResourceLoaderExperimentalAsyncLoading: modules marked with position
2960          * 'bottom', legacy scripts ($this->mScripts), user preferences, site JS
2961          * and user JS.
2962          *
2963          * @param bool $inHead If true, this HTML goes into the "<head>",
2964          *   if false it goes into the "<body>".
2965          * @return string
2966          */
2967         function getScriptsForBottomQueue( $inHead ) {
2968                 global $wgUseSiteJs, $wgAllowUserJs;
2969
2970                 // Scripts and messages "only" requests marked for bottom inclusion
2971                 // If we're in the <head>, use load() calls rather than <script src="..."> tags
2972                 // Messages should go first
2973                 $links = array();
2974                 $links[] = $this->makeResourceLoaderLink( $this->getModuleMessages( true, 'bottom' ),
2975                         ResourceLoaderModule::TYPE_MESSAGES, /* $useESI = */ false, /* $extraQuery = */ array(),
2976                         /* $loadCall = */ $inHead
2977                 );
2978                 $links[] = $this->makeResourceLoaderLink( $this->getModuleScripts( true, 'bottom' ),
2979                         ResourceLoaderModule::TYPE_SCRIPTS, /* $useESI = */ false, /* $extraQuery = */ array(),
2980                         /* $loadCall = */ $inHead
2981                 );
2982
2983                 // Modules requests - let the client calculate dependencies and batch requests as it likes
2984                 // Only load modules that have marked themselves for loading at the bottom
2985                 $modules = $this->getModules( true, 'bottom' );
2986                 if ( $modules ) {
2987                         $links[] = Html::inlineScript(
2988                                 ResourceLoader::makeLoaderConditionalScript(
2989                                         Xml::encodeJsCall( 'mw.loader.load', array( $modules, null, true ) )
2990                                 )
2991                         );
2992                 }
2993
2994                 // Legacy Scripts
2995                 $links[] = "\n" . $this->mScripts;
2996
2997                 // Add site JS if enabled
2998                 $links[] = $this->makeResourceLoaderLink( 'site', ResourceLoaderModule::TYPE_SCRIPTS,
2999                         /* $useESI = */ false, /* $extraQuery = */ array(), /* $loadCall = */ $inHead
3000                 );
3001
3002                 // Add user JS if enabled
3003                 if ( $wgAllowUserJs
3004                         && $this->getUser()->isLoggedIn()
3005                         && $this->getTitle()
3006                         && $this->getTitle()->isJsSubpage()
3007                         && $this->userCanPreview()
3008                 ) {
3009                         # XXX: additional security check/prompt?
3010                         // We're on a preview of a JS subpage
3011                         // Exclude this page from the user module in case it's in there (bug 26283)
3012                         $links[] = $this->makeResourceLoaderLink( 'user', ResourceLoaderModule::TYPE_SCRIPTS, false,
3013                                 array( 'excludepage' => $this->getTitle()->getPrefixedDBkey() ), $inHead
3014                         );
3015                         // Load the previewed JS
3016                         $links[] = Html::inlineScript( "\n"
3017                                         . $this->getRequest()->getText( 'wpTextbox1' ) . "\n" ) . "\n";
3018
3019                         // FIXME: If the user is previewing, say, ./vector.js, his ./common.js will be loaded
3020                         // asynchronously and may arrive *after* the inline script here. So the previewed code
3021                         // may execute before ./common.js runs. Normally, ./common.js runs before ./vector.js...
3022                 } else {
3023                         // Include the user module normally, i.e., raw to avoid it being wrapped in a closure.
3024                         $links[] = $this->makeResourceLoaderLink( 'user', ResourceLoaderModule::TYPE_SCRIPTS,
3025                                 /* $useESI = */ false, /* $extraQuery = */ array(), /* $loadCall = */ $inHead
3026                         );
3027                 }
3028
3029                 // Group JS is only enabled if site JS is enabled.
3030                 $links[] = $this->makeResourceLoaderLink( 'user.groups', ResourceLoaderModule::TYPE_COMBINED,
3031                         /* $useESI = */ false, /* $extraQuery = */ array(), /* $loadCall = */ $inHead
3032                 );
3033
3034                 return self::getHtmlFromLoaderLinks( $links );
3035         }
3036
3037         /**
3038          * JS stuff to put at the bottom of the "<body>"
3039          * @return string
3040          */
3041         function getBottomScripts() {
3042                 global $wgResourceLoaderExperimentalAsyncLoading;
3043
3044                 // Optimise jQuery ready event cross-browser.
3045                 // This also enforces $.isReady to be true at </body> which fixes the
3046                 // mw.loader bug in Firefox with using document.write between </body>
3047                 // and the DOMContentReady event (bug 47457).
3048                 $html = Html::inlineScript( 'window.jQuery && jQuery.ready();' );
3049
3050                 if ( !$wgResourceLoaderExperimentalAsyncLoading ) {
3051                         $html .= $this->getScriptsForBottomQueue( false );
3052                 }
3053
3054                 return $html;
3055         }
3056
3057         /**
3058          * Get the javascript config vars to include on this page
3059          *
3060          * @return array Array of javascript config vars
3061          * @since 1.23
3062          */
3063         public function getJsConfigVars() {
3064                 return $this->mJsConfigVars;
3065         }
3066
3067         /**
3068          * Add one or more variables to be set in mw.config in JavaScript
3069          *
3070          * @param string|array $keys Key or array of key/value pairs
3071          * @param mixed $value [optional] Value of the configuration variable
3072          */
3073         public function addJsConfigVars( $keys, $value = null ) {
3074                 if ( is_array( $keys ) ) {
3075                         foreach ( $keys as $key => $value ) {
3076                                 $this->mJsConfigVars[$key] = $value;
3077                         }
3078                         return;
3079                 }
3080
3081                 $this->mJsConfigVars[$keys] = $value;
3082         }
3083
3084         /**
3085          * Get an array containing the variables to be set in mw.config in JavaScript.
3086          *
3087          * Do not add things here which can be evaluated in ResourceLoaderStartUpModule
3088          * - in other words, page-independent/site-wide variables (without state).
3089          * You will only be adding bloat to the html page and causing page caches to
3090          * have to be purged on configuration changes.
3091          * @return array
3092          */
3093         private function getJSVars() {
3094                 global $wgContLang;
3095
3096                 $curRevisionId = 0;
3097                 $articleId = 0;
3098                 $canonicalSpecialPageName = false; # bug 21115
3099
3100                 $title = $this->getTitle();
3101                 $ns = $title->getNamespace();
3102                 $canonicalNamespace = MWNamespace::exists( $ns )
3103                         ? MWNamespace::getCanonicalName( $ns )
3104                         : $title->getNsText();
3105
3106                 $sk = $this->getSkin();
3107                 // Get the relevant title so that AJAX features can use the correct page name
3108                 // when making API requests from certain special pages (bug 34972).
3109                 $relevantTitle = $sk->getRelevantTitle();
3110                 $relevantUser = $sk->getRelevantUser();
3111
3112                 if ( $ns == NS_SPECIAL ) {
3113                         list( $canonicalSpecialPageName, /*...*/ ) =
3114                                 SpecialPageFactory::resolveAlias( $title->getDBkey() );
3115                 } elseif ( $this->canUseWikiPage() ) {
3116                         $wikiPage = $this->getWikiPage();
3117                         $curRevisionId = $wikiPage->getLatest();
3118                         $articleId = $wikiPage->getId();
3119                 }
3120
3121                 $lang = $title->getPageLanguage();
3122
3123                 // Pre-process information
3124                 $separatorTransTable = $lang->separatorTransformTable();
3125                 $separatorTransTable = $separatorTransTable ? $separatorTransTable : array();
3126                 $compactSeparatorTransTable = array(
3127                         implode( "\t", array_keys( $separatorTransTable ) ),
3128                         implode( "\t", $separatorTransTable ),
3129                 );
3130                 $digitTransTable = $lang->digitTransformTable();
3131                 $digitTransTable = $digitTransTable ? $digitTransTable : array();
3132                 $compactDigitTransTable = array(
3133                         implode( "\t", array_keys( $digitTransTable ) ),
3134                         implode( "\t", $digitTransTable ),
3135                 );
3136
3137                 $user = $this->getUser();
3138
3139                 $vars = array(
3140                         'wgCanonicalNamespace' => $canonicalNamespace,
3141                         'wgCanonicalSpecialPageName' => $canonicalSpecialPageName,
3142                         'wgNamespaceNumber' => $title->getNamespace(),
3143                         'wgPageName' => $title->getPrefixedDBkey(),
3144                         'wgTitle' => $title->getText(),
3145                         'wgCurRevisionId' => $curRevisionId,
3146                         'wgRevisionId' => (int)$this->getRevisionId(),
3147                         'wgArticleId' => $articleId,
3148                         'wgIsArticle' => $this->isArticle(),
3149                         'wgIsRedirect' => $title->isRedirect(),
3150                         'wgAction' => Action::getActionName( $this->getContext() ),
3151                         'wgUserName' => $user->isAnon() ? null : $user->getName(),
3152                         'wgUserGroups' => $user->getEffectiveGroups(),
3153                         'wgCategories' => $this->getCategories(),
3154                         'wgBreakFrames' => $this->getFrameOptions() == 'DENY',
3155                         'wgPageContentLanguage' => $lang->getCode(),
3156                         'wgPageContentModel' => $title->getContentModel(),
3157                         'wgSeparatorTransformTable' => $compactSeparatorTransTable,
3158                         'wgDigitTransformTable' => $compactDigitTransTable,
3159                         'wgDefaultDateFormat' => $lang->getDefaultDateFormat(),
3160                         'wgMonthNames' => $lang->getMonthNamesArray(),
3161                         'wgMonthNamesShort' => $lang->getMonthAbbreviationsArray(),
3162                         'wgRelevantPageName' => $relevantTitle->getPrefixedDBkey(),
3163                 );
3164
3165                 if ( $user->isLoggedIn() ) {
3166                         $vars['wgUserId'] = $user->getId();
3167                         $vars['wgUserEditCount'] = $user->getEditCount();
3168                         $userReg = wfTimestampOrNull( TS_UNIX, $user->getRegistration() );
3169                         $vars['wgUserRegistration'] = $userReg !== null ? ( $userReg * 1000 ) : null;
3170                         // Get the revision ID of the oldest new message on the user's talk
3171                         // page. This can be used for constructing new message alerts on
3172                         // the client side.
3173                         $vars['wgUserNewMsgRevisionId'] = $user->getNewMessageRevisionId();
3174                 }
3175
3176                 if ( $wgContLang->hasVariants() ) {
3177                         $vars['wgUserVariant'] = $wgContLang->getPreferredVariant();
3178                 }
3179                 // Same test as SkinTemplate
3180                 $vars['wgIsProbablyEditable'] = $title->quickUserCan( 'edit', $user )
3181                         && ( $title->exists() || $title->quickUserCan( 'create', $user ) );
3182
3183                 foreach ( $title->getRestrictionTypes() as $type ) {
3184                         $vars['wgRestriction' . ucfirst( $type )] = $title->getRestrictions( $type );
3185                 }
3186
3187                 if ( $title->isMainPage() ) {
3188                         $vars['wgIsMainPage'] = true;
3189                 }
3190
3191                 if ( $this->mRedirectedFrom ) {
3192                         $vars['wgRedirectedFrom'] = $this->mRedirectedFrom->getPrefixedDBkey();
3193                 }
3194
3195                 if ( $relevantUser ) {
3196                         $vars['wgRelevantUserName'] = $relevantUser->getName();
3197                 }
3198
3199                 // Allow extensions to add their custom variables to the mw.config map.
3200                 // Use the 'ResourceLoaderGetConfigVars' hook if the variable is not
3201                 // page-dependant but site-wide (without state).
3202                 // Alternatively, you may want to use OutputPage->addJsConfigVars() instead.
3203                 wfRunHooks( 'MakeGlobalVariablesScript', array( &$vars, $this ) );
3204
3205                 // Merge in variables from addJsConfigVars last
3206                 return array_merge( $vars, $this->getJsConfigVars() );
3207         }
3208
3209         /**
3210          * To make it harder for someone to slip a user a fake
3211          * user-JavaScript or user-CSS preview, a random token
3212          * is associated with the login session. If it's not
3213          * passed back with the preview request, we won't render
3214          * the code.
3215          *
3216          * @return bool
3217          */
3218         public function userCanPreview() {
3219                 if ( $this->getRequest()->getVal( 'action' ) != 'submit'
3220                         || !$this->getRequest()->wasPosted()
3221                         || !$this->getUser()->matchEditToken(
3222                                 $this->getRequest()->getVal( 'wpEditToken' ) )
3223                 ) {
3224                         return false;
3225                 }
3226                 if ( !$this->getTitle()->isJsSubpage() && !$this->getTitle()->isCssSubpage() ) {
3227                         return false;
3228                 }
3229
3230                 return !count( $this->getTitle()->getUserPermissionsErrors( 'edit', $this->getUser() ) );
3231         }
3232
3233         /**
3234          * @return array in format "link name or number => 'link html'".
3235          */
3236         public function getHeadLinksArray() {
3237                 global $wgUniversalEditButton, $wgFavicon, $wgAppleTouchIcon, $wgEnableAPI,
3238                         $wgSitename, $wgVersion,
3239                         $wgFeed, $wgOverrideSiteFeed, $wgAdvertisedFeedTypes,
3240                         $wgDisableLangConversion, $wgCanonicalLanguageLinks,
3241                         $wgRightsPage, $wgRightsUrl;
3242
3243                 $tags = array();
3244
3245                 $canonicalUrl = $this->mCanonicalUrl;
3246
3247                 $tags['meta-generator'] = Html::element( 'meta', array(
3248                         'name' => 'generator',
3249                         'content' => "MediaWiki $wgVersion",
3250                 ) );
3251
3252                 $p = "{$this->mIndexPolicy},{$this->mFollowPolicy}";
3253                 if ( $p !== 'index,follow' ) {
3254                         // http://www.robotstxt.org/wc/meta-user.html
3255                         // Only show if it's different from the default robots policy
3256                         $tags['meta-robots'] = Html::element( 'meta', array(
3257                                 'name' => 'robots',
3258                                 'content' => $p,
3259                         ) );
3260                 }
3261
3262                 foreach ( $this->mMetatags as $tag ) {
3263                         if ( 0 == strcasecmp( 'http:', substr( $tag[0], 0, 5 ) ) ) {
3264                                 $a = 'http-equiv';
3265                                 $tag[0] = substr( $tag[0], 5 );
3266                         } else {
3267                                 $a = 'name';
3268                         }
3269                         $tagName = "meta-{$tag[0]}";
3270                         if ( isset( $tags[$tagName] ) ) {
3271                                 $tagName .= $tag[1];
3272                         }
3273                         $tags[$tagName] = Html::element( 'meta',
3274                                 array(
3275                                         $a => $tag[0],
3276                                         'content' => $tag[1]
3277                                 )
3278                         );
3279                 }
3280
3281                 foreach ( $this->mLinktags as $tag ) {
3282                         $tags[] = Html::element( 'link', $tag );
3283                 }
3284
3285                 # Universal edit button
3286                 if ( $wgUniversalEditButton && $this->isArticleRelated() ) {
3287                         $user = $this->getUser();
3288                         if ( $this->getTitle()->quickUserCan( 'edit', $user )
3289                                 && ( $this->getTitle()->exists() || $this->getTitle()->quickUserCan( 'create', $user ) ) ) {
3290                                 // Original UniversalEditButton
3291                                 $msg = $this->msg( 'edit' )->text();
3292                                 $tags['universal-edit-button'] = Html::element( 'link', array(
3293                                         'rel' => 'alternate',
3294                                         'type' => 'application/x-wiki',
3295                                         'title' => $msg,
3296                                         'href' => $this->getTitle()->getEditURL(),
3297                                 ) );
3298                                 // Alternate edit link
3299                                 $tags['alternative-edit'] = Html::element( 'link', array(
3300                                         'rel' => 'edit',
3301                                         'title' => $msg,
3302                                         'href' => $this->getTitle()->getEditURL(),
3303                                 ) );
3304                         }
3305                 }
3306
3307                 # Generally the order of the favicon and apple-touch-icon links
3308                 # should not matter, but Konqueror (3.5.9 at least) incorrectly
3309                 # uses whichever one appears later in the HTML source. Make sure
3310                 # apple-touch-icon is specified first to avoid this.
3311                 if ( $wgAppleTouchIcon !== false ) {
3312                         $tags['apple-touch-icon'] = Html::element( 'link', array(
3313                                 'rel' => 'apple-touch-icon',
3314                                 'href' => $wgAppleTouchIcon
3315                         ) );
3316                 }
3317
3318                 if ( $wgFavicon !== false ) {
3319                         $tags['favicon'] = Html::element( 'link', array(
3320                                 'rel' => 'shortcut icon',
3321                                 'href' => $wgFavicon
3322                         ) );
3323                 }
3324
3325                 # OpenSearch description link
3326                 $tags['opensearch'] = Html::element( 'link', array(
3327                         'rel' => 'search',
3328                         'type' => 'application/opensearchdescription+xml',
3329                         'href' => wfScript( 'opensearch_desc' ),
3330                         'title' => $this->msg( 'opensearch-desc' )->inContentLanguage()->text(),
3331                 ) );
3332
3333                 if ( $wgEnableAPI ) {
3334                         # Real Simple Discovery link, provides auto-discovery information
3335                         # for the MediaWiki API (and potentially additional custom API
3336                         # support such as WordPress or Twitter-compatible APIs for a
3337                         # blogging extension, etc)
3338                         $tags['rsd'] = Html::element( 'link', array(
3339                                 'rel' => 'EditURI',
3340                                 'type' => 'application/rsd+xml',
3341                                 // Output a protocol-relative URL here if $wgServer is protocol-relative
3342                                 // Whether RSD accepts relative or protocol-relative URLs is completely undocumented, though
3343                                 'href' => wfExpandUrl( wfAppendQuery(
3344                                         wfScript( 'api' ),
3345                                         array( 'action' => 'rsd' ) ),
3346                                         PROTO_RELATIVE
3347                                 ),
3348                         ) );
3349                 }
3350
3351                 # Language variants
3352                 if ( !$wgDisableLangConversion && $wgCanonicalLanguageLinks ) {
3353                         $lang = $this->getTitle()->getPageLanguage();
3354                         if ( $lang->hasVariants() ) {
3355
3356                                 $urlvar = $lang->getURLVariant();
3357
3358                                 if ( !$urlvar ) {
3359                                         $variants = $lang->getVariants();
3360                                         foreach ( $variants as $_v ) {
3361                                                 $tags["variant-$_v"] = Html::element( 'link', array(
3362                                                         'rel' => 'alternate',
3363                                                         'hreflang' => wfBCP47( $_v ),
3364                                                         'href' => $this->getTitle()->getLocalURL( array( 'variant' => $_v ) ) )
3365                                                 );
3366                                         }
3367                                 } else {
3368                                         $canonicalUrl = $this->getTitle()->getLocalURL();
3369                                 }
3370                         }
3371                 }
3372
3373                 # Copyright
3374                 $copyright = '';
3375                 if ( $wgRightsPage ) {
3376                         $copy = Title::newFromText( $wgRightsPage );
3377
3378                         if ( $copy ) {
3379                                 $copyright = $copy->getLocalURL();
3380                         }
3381                 }
3382
3383                 if ( !$copyright && $wgRightsUrl ) {
3384                         $copyright = $wgRightsUrl;
3385                 }
3386
3387                 if ( $copyright ) {
3388                         $tags['copyright'] = Html::element( 'link', array(
3389                                 'rel' => 'copyright',
3390                                 'href' => $copyright )
3391                         );
3392                 }
3393
3394                 # Feeds
3395                 if ( $wgFeed ) {
3396                         foreach ( $this->getSyndicationLinks() as $format => $link ) {
3397                                 # Use the page name for the title.  In principle, this could
3398                                 # lead to issues with having the same name for different feeds
3399                                 # corresponding to the same page, but we can't avoid that at
3400                                 # this low a level.
3401
3402                                 $tags[] = $this->feedLink(
3403                                         $format,
3404                                         $link,
3405                                         # Used messages: 'page-rss-feed' and 'page-atom-feed' (for an easier grep)
3406                                         $this->msg( "page-{$format}-feed", $this->getTitle()->getPrefixedText() )->text()
3407                                 );
3408                         }
3409
3410                         # Recent changes feed should appear on every page (except recentchanges,
3411                         # that would be redundant). Put it after the per-page feed to avoid
3412                         # changing existing behavior. It's still available, probably via a
3413                         # menu in your browser. Some sites might have a different feed they'd
3414                         # like to promote instead of the RC feed (maybe like a "Recent New Articles"
3415                         # or "Breaking news" one). For this, we see if $wgOverrideSiteFeed is defined.
3416                         # If so, use it instead.
3417                         if ( $wgOverrideSiteFeed ) {
3418                                 foreach ( $wgOverrideSiteFeed as $type => $feedUrl ) {
3419                                         // Note, this->feedLink escapes the url.
3420                                         $tags[] = $this->feedLink(
3421                                                 $type,
3422                                                 $feedUrl,
3423                                                 $this->msg( "site-{$type}-feed", $wgSitename )->text()
3424                                         );
3425                                 }
3426                         } elseif ( !$this->getTitle()->isSpecial( 'Recentchanges' ) ) {
3427                                 $rctitle = SpecialPage::getTitleFor( 'Recentchanges' );
3428                                 foreach ( $wgAdvertisedFeedTypes as $format ) {
3429                                         $tags[] = $this->feedLink(
3430                                                 $format,
3431                                                 $rctitle->getLocalURL( array( 'feed' => $format ) ),
3432                                                 # For grep: 'site-rss-feed', 'site-atom-feed'
3433                                                 $this->msg( "site-{$format}-feed", $wgSitename )->text()
3434                                         );
3435                                 }
3436                         }
3437                 }
3438
3439                 # Canonical URL
3440                 global $wgEnableCanonicalServerLink;
3441                 if ( $wgEnableCanonicalServerLink ) {
3442                         if ( $canonicalUrl !== false ) {
3443                                 $canonicalUrl = wfExpandUrl( $canonicalUrl, PROTO_CANONICAL );
3444                         } else {
3445                                 $reqUrl = $this->getRequest()->getRequestURL();
3446                                 $canonicalUrl = wfExpandUrl( $reqUrl, PROTO_CANONICAL );
3447                         }
3448                 }
3449                 if ( $canonicalUrl !== false ) {
3450                         $tags[] = Html::element( 'link', array(
3451                                 'rel' => 'canonical',
3452                                 'href' => $canonicalUrl
3453                         ) );
3454                 }
3455
3456                 return $tags;
3457         }
3458
3459         /**
3460          * @return string HTML tag links to be put in the header.
3461          * @deprecated since 1.24 Use OutputPage::headElement or if you have to,
3462          *   OutputPage::getHeadLinksArray directly.
3463          */
3464         public function getHeadLinks() {
3465                 wfDeprecated( __METHOD__, '1.24' );
3466                 return implode( "\n", $this->getHeadLinksArray() );
3467         }
3468
3469         /**
3470          * Generate a "<link rel/>" for a feed.
3471          *
3472          * @param string $type Feed type
3473          * @param string $url URL to the feed
3474          * @param string $text Value of the "title" attribute
3475          * @return string HTML fragment
3476          */
3477         private function feedLink( $type, $url, $text ) {
3478                 return Html::element( 'link', array(
3479                         'rel' => 'alternate',
3480                         'type' => "application/$type+xml",
3481                         'title' => $text,
3482                         'href' => $url )
3483                 );
3484         }
3485
3486         /**
3487          * Add a local or specified stylesheet, with the given media options.
3488          * Meant primarily for internal use...
3489          *
3490          * @param string $style URL to the file
3491          * @param string $media to specify a media type, 'screen', 'printable', 'handheld' or any.
3492          * @param string $condition for IE conditional comments, specifying an IE version
3493          * @param string $dir set to 'rtl' or 'ltr' for direction-specific sheets
3494          */
3495         public function addStyle( $style, $media = '', $condition = '', $dir = '' ) {
3496                 $options = array();
3497                 // Even though we expect the media type to be lowercase, but here we
3498                 // force it to lowercase to be safe.
3499                 if ( $media ) {
3500                         $options['media'] = $media;
3501                 }
3502                 if ( $condition ) {
3503                         $options['condition'] = $condition;
3504                 }
3505                 if ( $dir ) {
3506                         $options['dir'] = $dir;
3507                 }
3508                 $this->styles[$style] = $options;
3509         }
3510
3511         /**
3512          * Adds inline CSS styles
3513          * @param mixed $style_css Inline CSS
3514          * @param string $flip Set to 'flip' to flip the CSS if needed
3515          */
3516         public function addInlineStyle( $style_css, $flip = 'noflip' ) {
3517                 if ( $flip === 'flip' && $this->getLanguage()->isRTL() ) {
3518                         # If wanted, and the interface is right-to-left, flip the CSS
3519                         $style_css = CSSJanus::transform( $style_css, true, false );
3520                 }
3521                 $this->mInlineStyles .= Html::inlineStyle( $style_css ) . "\n";
3522         }
3523
3524         /**
3525          * Build a set of "<link>" elements for the stylesheets specified in the $this->styles array.
3526          * These will be applied to various media & IE conditionals.
3527          *
3528          * @return string
3529          */
3530         public function buildCssLinks() {
3531                 global $wgUseSiteCss, $wgAllowUserCss, $wgAllowUserCssPrefs, $wgContLang;
3532
3533                 $this->getSkin()->setupSkinUserCss( $this );
3534
3535                 // Add ResourceLoader styles
3536                 // Split the styles into these groups
3537                 $styles = array(
3538                         'other' => array(),
3539                         'user' => array(),
3540                         'site' => array(),
3541                         'private' => array(),
3542                         'noscript' => array()
3543                 );
3544                 $links = array();
3545                 $otherTags = ''; // Tags to append after the normal <link> tags
3546                 $resourceLoader = $this->getResourceLoader();
3547
3548                 $moduleStyles = $this->getModuleStyles();
3549
3550                 // Per-site custom styles
3551                 $moduleStyles[] = 'site';
3552                 $moduleStyles[] = 'noscript';
3553                 $moduleStyles[] = 'user.groups';
3554
3555                 // Per-user custom styles
3556                 if ( $wgAllowUserCss && $this->getTitle()->isCssSubpage() && $this->userCanPreview() ) {
3557                         // We're on a preview of a CSS subpage
3558                         // Exclude this page from the user module in case it's in there (bug 26283)
3559                         $link = $this->makeResourceLoaderLink( 'user', ResourceLoaderModule::TYPE_STYLES, false,
3560                                 array( 'excludepage' => $this->getTitle()->getPrefixedDBkey() )
3561                         );
3562                         $otherTags .= $link['html'];
3563
3564                         // Load the previewed CSS
3565                         // If needed, Janus it first. This is user-supplied CSS, so it's
3566                         // assumed to be right for the content language directionality.
3567                         $previewedCSS = $this->getRequest()->getText( 'wpTextbox1' );
3568                         if ( $this->getLanguage()->getDir() !== $wgContLang->getDir() ) {
3569                                 $previewedCSS = CSSJanus::transform( $previewedCSS, true, false );
3570                         }
3571                         $otherTags .= Html::inlineStyle( $previewedCSS ) . "\n";
3572                 } else {
3573                         // Load the user styles normally
3574                         $moduleStyles[] = 'user';
3575                 }
3576
3577                 // Per-user preference styles
3578                 $moduleStyles[] = 'user.cssprefs';
3579
3580                 foreach ( $moduleStyles as $name ) {
3581                         $module = $resourceLoader->getModule( $name );
3582                         if ( !$module ) {
3583                                 continue;
3584                         }
3585                         $group = $module->getGroup();
3586                         // Modules in groups different than the ones listed on top (see $styles assignment)
3587                         // will be placed in the "other" group
3588                         $styles[ isset( $styles[$group] ) ? $group : 'other' ][] = $name;
3589                 }
3590
3591                 // We want site, private and user styles to override dynamically added
3592                 // styles from modules, but we want dynamically added styles to override
3593                 // statically added styles from other modules. So the order has to be
3594                 // other, dynamic, site, private, user. Add statically added styles for
3595                 // other modules
3596                 $links[] = $this->makeResourceLoaderLink( $styles['other'], ResourceLoaderModule::TYPE_STYLES );
3597                 // Add normal styles added through addStyle()/addInlineStyle() here
3598                 $links[] = implode( "\n", $this->buildCssLinksArray() ) . $this->mInlineStyles;
3599                 // Add marker tag to mark the place where the client-side loader should inject dynamic styles
3600                 // We use a <meta> tag with a made-up name for this because that's valid HTML
3601                 $links[] = Html::element(
3602                         'meta',
3603                         array( 'name' => 'ResourceLoaderDynamicStyles', 'content' => '' )
3604                 ) . "\n";
3605
3606                 // Add site, private and user styles
3607                 // 'private' at present only contains user.options, so put that before 'user'
3608                 // Any future private modules will likely have a similar user-specific character
3609                 foreach ( array( 'site', 'noscript', 'private', 'user' ) as $group ) {
3610                         $links[] = $this->makeResourceLoaderLink( $styles[$group],
3611                                 ResourceLoaderModule::TYPE_STYLES
3612                         );
3613                 }
3614
3615                 // Add stuff in $otherTags (previewed user CSS if applicable)
3616                 return self::getHtmlFromLoaderLinks( $links ) . $otherTags;
3617         }
3618
3619         /**
3620          * @return array
3621          */
3622         public function buildCssLinksArray() {
3623                 $links = array();
3624
3625                 // Add any extension CSS
3626                 foreach ( $this->mExtStyles as $url ) {
3627                         $this->addStyle( $url );
3628                 }
3629                 $this->mExtStyles = array();
3630
3631                 foreach ( $this->styles as $file => $options ) {
3632                         $link = $this->styleLink( $file, $options );
3633                         if ( $link ) {
3634                                 $links[$file] = $link;
3635                         }
3636                 }
3637                 return $links;
3638         }
3639
3640         /**
3641          * Generate \<link\> tags for stylesheets
3642          *
3643          * @param string $style URL to the file
3644          * @param array $options Option, can contain 'condition', 'dir', 'media' keys
3645          * @return string HTML fragment
3646          */
3647         protected function styleLink( $style, $options ) {
3648                 if ( isset( $options['dir'] ) ) {
3649                         if ( $this->getLanguage()->getDir() != $options['dir'] ) {
3650                                 return '';
3651                         }
3652                 }
3653
3654                 if ( isset( $options['media'] ) ) {
3655                         $media = self::transformCssMedia( $options['media'] );
3656                         if ( is_null( $media ) ) {
3657                                 return '';
3658                         }
3659                 } else {
3660                         $media = 'all';
3661                 }
3662
3663                 if ( substr( $style, 0, 1 ) == '/' ||
3664                         substr( $style, 0, 5 ) == 'http:' ||
3665                         substr( $style, 0, 6 ) == 'https:' ) {
3666                         $url = $style;
3667                 } else {
3668                         global $wgStylePath, $wgStyleVersion;
3669                         $url = $wgStylePath . '/' . $style . '?' . $wgStyleVersion;
3670                 }
3671
3672                 $link = Html::linkedStyle( $url, $media );
3673
3674                 if ( isset( $options['condition'] ) ) {
3675                         $condition = htmlspecialchars( $options['condition'] );
3676                         $link = "<!--[if $condition]>$link<![endif]-->";
3677                 }
3678                 return $link;
3679         }
3680
3681         /**
3682          * Transform "media" attribute based on request parameters
3683          *
3684          * @param string $media Current value of the "media" attribute
3685          * @return string Modified value of the "media" attribute, or null to skip
3686          * this stylesheet
3687          */
3688         public static function transformCssMedia( $media ) {
3689                 global $wgRequest;
3690
3691                 // http://www.w3.org/TR/css3-mediaqueries/#syntax
3692                 $screenMediaQueryRegex = '/^(?:only\s+)?screen\b/i';
3693
3694                 // Switch in on-screen display for media testing
3695                 $switches = array(
3696                         'printable' => 'print',
3697                         'handheld' => 'handheld',
3698                 );
3699                 foreach ( $switches as $switch => $targetMedia ) {
3700                         if ( $wgRequest->getBool( $switch ) ) {
3701                                 if ( $media == $targetMedia ) {
3702                                         $media = '';
3703                                 } elseif ( preg_match( $screenMediaQueryRegex, $media ) === 1 ) {
3704                                         // This regex will not attempt to understand a comma-separated media_query_list
3705                                         //
3706                                         // Example supported values for $media:
3707                                         // 'screen', 'only screen', 'screen and (min-width: 982px)' ),
3708                                         // Example NOT supported value for $media:
3709                                         // '3d-glasses, screen, print and resolution > 90dpi'
3710                                         //
3711                                         // If it's a print request, we never want any kind of screen stylesheets
3712                                         // If it's a handheld request (currently the only other choice with a switch),
3713                                         // we don't want simple 'screen' but we might want screen queries that
3714                                         // have a max-width or something, so we'll pass all others on and let the
3715                                         // client do the query.
3716                                         if ( $targetMedia == 'print' || $media == 'screen' ) {
3717                                                 return null;
3718                                         }
3719                                 }
3720                         }
3721                 }
3722
3723                 return $media;
3724         }
3725
3726         /**
3727          * Add a wikitext-formatted message to the output.
3728          * This is equivalent to:
3729          *
3730          *    $wgOut->addWikiText( wfMessage( ... )->plain() )
3731          */
3732         public function addWikiMsg( /*...*/ ) {
3733                 $args = func_get_args();
3734                 $name = array_shift( $args );
3735                 $this->addWikiMsgArray( $name, $args );
3736         }
3737
3738         /**
3739          * Add a wikitext-formatted message to the output.
3740          * Like addWikiMsg() except the parameters are taken as an array
3741          * instead of a variable argument list.
3742          *
3743          * @param string $name
3744          * @param array $args
3745          */
3746         public function addWikiMsgArray( $name, $args ) {
3747                 $this->addHTML( $this->msg( $name, $args )->parseAsBlock() );
3748         }
3749
3750         /**
3751          * This function takes a number of message/argument specifications, wraps them in
3752          * some overall structure, and then parses the result and adds it to the output.
3753          *
3754          * In the $wrap, $1 is replaced with the first message, $2 with the second, and so
3755          * on. The subsequent arguments may either be strings, in which case they are the
3756          * message names, or arrays, in which case the first element is the message name,
3757          * and subsequent elements are the parameters to that message.
3758          *
3759          * Don't use this for messages that are not in users interface language.
3760          *
3761          * For example:
3762          *
3763          *    $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>", 'some-error' );
3764          *
3765          * Is equivalent to:
3766          *
3767          *    $wgOut->addWikiText( "<div class='error'>\n"
3768          *        . wfMessage( 'some-error' )->plain() . "\n</div>" );
3769          *
3770          * The newline after opening div is needed in some wikitext. See bug 19226.
3771          *
3772          * @param string $wrap
3773          */
3774         public function wrapWikiMsg( $wrap /*, ...*/ ) {
3775                 $msgSpecs = func_get_args();
3776                 array_shift( $msgSpecs );
3777                 $msgSpecs = array_values( $msgSpecs );
3778                 $s = $wrap;
3779                 foreach ( $msgSpecs as $n => $spec ) {
3780                         if ( is_array( $spec ) ) {
3781                                 $args = $spec;
3782                                 $name = array_shift( $args );
3783                                 if ( isset( $args['options'] ) ) {
3784                                         unset( $args['options'] );
3785                                         wfDeprecated(
3786                                                 'Adding "options" to ' . __METHOD__ . ' is no longer supported',
3787                                                 '1.20'
3788                                         );
3789                                 }
3790                         } else {
3791                                 $args = array();
3792                                 $name = $spec;
3793                         }
3794                         $s = str_replace( '$' . ( $n + 1 ), $this->msg( $name, $args )->plain(), $s );
3795                 }
3796                 $this->addWikiText( $s );
3797         }
3798
3799         /**
3800          * Include jQuery core. Use this to avoid loading it multiple times
3801          * before we get a usable script loader.
3802          *
3803          * @param array $modules List of jQuery modules which should be loaded
3804          * @return array The list of modules which were not loaded.
3805          * @since 1.16
3806          * @deprecated since 1.17
3807          */
3808         public function includeJQuery( $modules = array() ) {
3809                 return array();
3810         }
3811
3812         /**
3813          * Enables/disables TOC, doesn't override __NOTOC__
3814          * @param bool $flag
3815          * @since 1.22
3816          */
3817         public function enableTOC( $flag = true ) {
3818                 $this->mEnableTOC = $flag;
3819         }
3820
3821         /**
3822          * @return bool
3823          * @since 1.22
3824          */
3825         public function isTOCEnabled() {
3826                 return $this->mEnableTOC;
3827         }
3828
3829         /**
3830          * Enables/disables section edit links, doesn't override __NOEDITSECTION__
3831          * @param bool $flag
3832          * @since 1.23
3833          */
3834         public function enableSectionEditLinks( $flag = true ) {
3835                 $this->mEnableSectionEditLinks = $flag;
3836         }
3837
3838         /**
3839          * @return bool
3840          * @since 1.23
3841          */
3842         public function sectionEditLinksEnabled() {
3843                 return $this->mEnableSectionEditLinks;
3844         }
3845 }