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