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