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