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