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