includes/OutputPage.php

   1 <?php
   2 if ( !defined( 'MEDIAWIKI' ) ) {
   3         die( 1 );
   4 }
   5
   6 /**
   7  * @todo document
   8  */
   9 class OutputPage {
  10         var $mMetatags = array(), $mKeywords = array(), $mLinktags = array();
  11         var $mExtStyles = array();
  12         var $mPagetitle = '', $mBodytext = '';
  13
  14         /**
  15          * Holds the debug lines that will be outputted as comments in page source if
  16          * $wgDebugComments is enabled. See also $wgShowDebug.
  17          * TODO: make a getter method for this
  18          */
  19         public $mDebugtext = '';
  20
  21         var $mHTMLtitle = '', $mIsarticle = true, $mPrintable = false;
  22         var $mSubtitle = '', $mRedirect = '', $mStatusCode;
  23         var $mLastModified = '', $mETag = false;
  24         var $mCategoryLinks = array(), $mCategories = array(), $mLanguageLinks = array();
  25
  26         var $mScripts = '', $mInlineStyles = '', $mLinkColours, $mPageLinkTitle = '', $mHeadItems = array();
  27         var $mModules = array(), $mModuleScripts = array(), $mModuleStyles = array(), $mModuleMessages = array();
  28         var $mResourceLoader;
  29         var $mInlineMsg = array();
  30
  31         var $mTemplateIds = array();
  32
  33         var $mAllowUserJs;
  34         var $mSuppressQuickbar = false;
  35         var $mDoNothing = false;
  36         var $mContainsOldMagic = 0, $mContainsNewMagic = 0;
  37         var $mIsArticleRelated = true;
  38         protected $mParserOptions = null; // lazy initialised, use parserOptions()
  39
  40         var $mFeedLinks = array();
  41
  42         var $mEnableClientCache = true;
  43         var $mArticleBodyOnly = false;
  44
  45         var $mNewSectionLink = false;
  46         var $mHideNewSectionLink = false;
  47         var $mNoGallery = false;
  48         var $mPageTitleActionText = '';
  49         var $mParseWarnings = array();
  50         var $mSquidMaxage = 0;
  51         var $mPreventClickjacking = true;
  52         var $mRevisionId = null;
  53         protected $mTitle = null;
  54
  55         /**
  56          * An array of stylesheet filenames (relative from skins path), with options
  57          * for CSS media, IE conditions, and RTL/LTR direction.
  58          * For internal use; add settings in the skin via $this->addStyle()
  59          */
  60         var $styles = array();
  61
  62         /**
  63          * Whether to load jQuery core.
  64          */
  65         protected $mJQueryDone = false;
  66
  67         private $mIndexPolicy = 'index';
  68         private $mFollowPolicy = 'follow';
  69         private $mVaryHeader = array(
  70                 'Accept-Encoding' => array( 'list-contains=gzip' ),
  71                 'Cookie' => null
  72         );
  73
  74         /**
  75          * Constructor
  76          * Initialise private variables
  77          */
  78         function __construct() {
  79                 global $wgAllowUserJs;
  80                 $this->mAllowUserJs = $wgAllowUserJs;
  81         }
  82
  83         /**
  84          * Redirect to $url rather than displaying the normal page
  85          *
  86          * @param $url String: URL
  87          * @param $responsecode String: HTTP status code
  88          */
  89         public function redirect( $url, $responsecode = '302' ) {
  90                 # Strip newlines as a paranoia check for header injection in PHP<5.1.2
  91                 $this->mRedirect = str_replace( "\n", '', $url );
  92                 $this->mRedirectCode = $responsecode;
  93         }
  94
  95         /**
  96          * Get the URL to redirect to, or an empty string if not redirect URL set
  97          *
  98          * @return String
  99          */
 100         public function getRedirect() {
 101                 return $this->mRedirect;
 102         }
 103
 104         /**
 105          * Set the HTTP status code to send with the output.
 106          *
 107          * @param $statusCode Integer
 108          * @return nothing
 109          */
 110         public function setStatusCode( $statusCode ) {
 111                 $this->mStatusCode = $statusCode;
 112         }
 113
 114         /**
 115          * Add a new <meta> tag
 116          * To add an http-equiv meta tag, precede the name with "http:"
 117          *
 118          * @param $name tag name
 119          * @param $val tag value
 120          */
 121         function addMeta( $name, $val ) {
 122                 array_push( $this->mMetatags, array( $name, $val ) );
 123         }
 124
 125         /**
 126          * Add a keyword or a list of keywords in the page header
 127          *
 128          * @param $text String or array of strings
 129          */
 130         function addKeyword( $text ) {
 131                 if( is_array( $text ) ) {
 132                         $this->mKeywords = array_merge( $this->mKeywords, $text );
 133                 } else {
 134                         array_push( $this->mKeywords, $text );
 135                 }
 136         }
 137
 138         /**
 139          * Add a new \<link\> tag to the page header
 140          *
 141          * @param $linkarr Array: associative array of attributes.
 142          */
 143         function addLink( $linkarr ) {
 144                 array_push( $this->mLinktags, $linkarr );
 145         }
 146
 147         /**
 148          * Add a new \<link\> with "rel" attribute set to "meta"
 149          *
 150          * @param $linkarr Array: associative array mapping attribute names to their
 151          *                 values, both keys and values will be escaped, and the
 152          *                 "rel" attribute will be automatically added
 153          */
 154         function addMetadataLink( $linkarr ) {
 155                 # note: buggy CC software only reads first "meta" link
 156                 static $haveMeta = false;
 157                 $linkarr['rel'] = $haveMeta ? 'alternate meta' : 'meta';
 158                 $this->addLink( $linkarr );
 159                 $haveMeta = true;
 160         }
 161
 162         /**
 163          * Add raw HTML to the list of scripts (including \<script\> tag, etc.)
 164          *
 165          * @param $script String: raw HTML
 166          */
 167         function addScript( $script ) {
 168                 $this->mScripts .= $script . "\n";
 169         }
 170
 171         /**
 172          * Register and add a stylesheet from an extension directory.
 173          *
 174          * @param $url String path to sheet.  Provide either a full url (beginning
 175          *             with 'http', etc) or a relative path from the document root
 176          *             (beginning with '/').  Otherwise it behaves identically to
 177          *             addStyle() and draws from the /skins folder.
 178          */
 179         public function addExtensionStyle( $url ) {
 180                 array_push( $this->mExtStyles, $url );
 181         }
 182
 183         /**
 184          * Get all links added by extensions
 185          *
 186          * @return Array
 187          */
 188         function getExtStyle() {
 189                 return $this->mExtStyles;
 190         }
 191
 192         /**
 193          * Add a JavaScript file out of skins/common, or a given relative path.
 194          *
 195          * @param $file String: filename in skins/common or complete on-server path
 196          *              (/foo/bar.js)
 197          * @param $version String: style version of the file. Defaults to $wgStyleVersion
 198          */
 199         public function addScriptFile( $file, $version = null ) {
 200                 global $wgStylePath, $wgStyleVersion;
 201                 // See if $file parameter is an absolute URL or begins with a slash
 202                 if( substr( $file, 0, 1 ) == '/' || preg_match( '#^[a-z]*://#i', $file ) ) {
 203                         $path = $file;
 204                 } else {
 205                         $path = "{$wgStylePath}/common/{$file}";
 206                 }
 207                 if ( is_null( $version ) )
 208                         $version = $wgStyleVersion;
 209                 $this->addScript( Html::linkedScript( wfAppendQuery( $path, $version ) ) );
 210         }
 211
 212         /**
 213          * Add a self-contained script tag with the given contents
 214          *
 215          * @param $script String: JavaScript text, no <script> tags
 216          */
 217         public function addInlineScript( $script ) {
 218                 $this->mScripts .= Html::inlineScript( "\n$script\n" ) . "\n";
 219         }
 220
 221         /**
 222          * Get all registered JS and CSS tags for the header.
 223          *
 224          * @return String
 225          */
 226         function getScript() {
 227                 return $this->mScripts . $this->getHeadItems();
 228         }
 229
 230         /**
 231          * Get the list of modules to include on this page
 232          *
 233          * @return Array of module names
 234          */
 235         public function getModules() {
 236                 return array_values( array_unique( $this->mModules ) );
 237         }
 238
 239         /**
 240          * Add one or more modules recognized by the resource loader. Modules added
 241          * through this function will be loaded by the resource loader when the
 242          * page loads.
 243          *
 244          * @param $modules Mixed: module name (string) or array of module names
 245          */
 246         public function addModules( $modules ) {
 247                 $this->mModules = array_merge( $this->mModules, (array)$modules );
 248         }
 249
 250         /**
 251          * Get the list of module JS to include on this page
 252          * @return array of module names
 253          */
 254         public function getModuleScripts() {
 255                 return array_values( array_unique( $this->mModuleScripts ) );
 256         }
 257
 258         /**
 259          * Add only JS of one or more modules recognized by the resource loader. Module
 260          * scripts added through this function will be loaded by the resource loader when
 261          * the page loads.
 262          *
 263          * @param $modules Mixed: module name (string) or array of module names
 264          */
 265         public function addModuleScripts( $modules ) {
 266                 $this->mModuleScripts = array_merge( $this->mModuleScripts, (array)$modules );
 267         }
 268
 269         /**
 270          * Get the list of module CSS to include on this page
 271          *
 272          * @return Array of module names
 273          */
 274         public function getModuleStyles() {
 275                 return array_values( array_unique( $this->mModuleStyles ) );
 276         }
 277
 278         /**
 279          * Add only CSS of one or more modules recognized by the resource loader. Module
 280          * styles added through this function will be loaded by the resource loader when
 281          * the page loads.
 282          *
 283          * @param $modules Mixed: module name (string) or array of module names
 284          */
 285         public function addModuleStyles( $modules ) {
 286                 $this->mModuleStyles = array_merge( $this->mModuleStyles, (array)$modules );
 287         }
 288
 289         /**
 290          * Get the list of module messages to include on this page
 291          *
 292          * @return Array of module names
 293          */
 294         public function getModuleMessages() {
 295                 return array_values( array_unique( $this->mModuleMessages ) );
 296         }
 297
 298         /**
 299          * Add only messages of one or more modules recognized by the resource loader.
 300          * Module messages added through this function will be loaded by the resource
 301          * loader when the page loads.
 302          *
 303          * @param $modules Mixed: module name (string) or array of module names
 304          */
 305         public function addModuleMessages( $modules ) {
 306                 $this->mModuleMessages = array_merge( $this->mModuleMessages, (array)$modules );
 307         }
 308
 309         /**
 310          * Get all header items in a string
 311          *
 312          * @return String
 313          */
 314         function getHeadItems() {
 315                 $s = '';
 316                 foreach ( $this->mHeadItems as $item ) {
 317                         $s .= $item;
 318                 }
 319                 return $s;
 320         }
 321
 322         /**
 323          * Add or replace an header item to the output
 324          *
 325          * @param $name String: item name
 326          * @param $value String: raw HTML
 327          */
 328         public function addHeadItem( $name, $value ) {
 329                 $this->mHeadItems[$name] = $value;
 330         }
 331
 332         /**
 333          * Check if the header item $name is already set
 334          *
 335          * @param $name String: item name
 336          * @return Boolean
 337          */
 338         public function hasHeadItem( $name ) {
 339                 return isset( $this->mHeadItems[$name] );
 340         }
 341
 342         /**
 343          * Set the value of the ETag HTTP header, only used if $wgUseETag is true
 344          *
 345          * @param $tag String: value of "ETag" header
 346          */
 347         function setETag( $tag ) {
 348                 $this->mETag = $tag;
 349         }
 350
 351         /**
 352          * Set whether the output should only contain the body of the article,
 353          * without any skin, sidebar, etc.
 354          * Used e.g. when calling with "action=render".
 355          *
 356          * @param $only Boolean: whether to output only the body of the article
 357          */
 358         public function setArticleBodyOnly( $only ) {
 359                 $this->mArticleBodyOnly = $only;
 360         }
 361
 362         /**
 363          * Return whether the output will contain only the body of the article
 364          *
 365          * @return Boolean
 366          */
 367         public function getArticleBodyOnly() {
 368                 return $this->mArticleBodyOnly;
 369         }
 370
 371         /**
 372          * checkLastModified tells the client to use the client-cached page if
 373          * possible. If sucessful, the OutputPage is disabled so that
 374          * any future call to OutputPage->output() have no effect.
 375          *
 376          * Side effect: sets mLastModified for Last-Modified header
 377          *
 378          * @return Boolean: true iff cache-ok headers was sent.
 379          */
 380         public function checkLastModified( $timestamp ) {
 381                 global $wgCachePages, $wgCacheEpoch, $wgUser, $wgRequest;
 382
 383                 if ( !$timestamp || $timestamp == '19700101000000' ) {
 384                         wfDebug( __METHOD__ . ": CACHE DISABLED, NO TIMESTAMP\n" );
 385                         return false;
 386                 }
 387                 if( !$wgCachePages ) {
 388                         wfDebug( __METHOD__ . ": CACHE DISABLED\n", false );
 389                         return false;
 390                 }
 391                 if( $wgUser->getOption( 'nocache' ) ) {
 392                         wfDebug( __METHOD__ . ": USER DISABLED CACHE\n", false );
 393                         return false;
 394                 }
 395
 396                 $timestamp = wfTimestamp( TS_MW, $timestamp );
 397                 $modifiedTimes = array(
 398                         'page' => $timestamp,
 399                         'user' => $wgUser->getTouched(),
 400                         'epoch' => $wgCacheEpoch
 401                 );
 402                 wfRunHooks( 'OutputPageCheckLastModified', array( &$modifiedTimes ) );
 403
 404                 $maxModified = max( $modifiedTimes );
 405                 $this->mLastModified = wfTimestamp( TS_RFC2822, $maxModified );
 406
 407                 if( empty( $_SERVER['HTTP_IF_MODIFIED_SINCE'] ) ) {
 408                         wfDebug( __METHOD__ . ": client did not send If-Modified-Since header\n", false );
 409                         return false;
 410                 }
 411
 412                 # Make debug info
 413                 $info = '';
 414                 foreach ( $modifiedTimes as $name => $value ) {
 415                         if ( $info !== '' ) {
 416                                 $info .= ', ';
 417                         }
 418                         $info .= "$name=" . wfTimestamp( TS_ISO_8601, $value );
 419                 }
 420
 421                 # IE sends sizes after the date like this:
 422                 # Wed, 20 Aug 2003 06:51:19 GMT; length=5202
 423                 # this breaks strtotime().
 424                 $clientHeader = preg_replace( '/;.*$/', '', $_SERVER["HTTP_IF_MODIFIED_SINCE"] );
 425
 426                 wfSuppressWarnings(); // E_STRICT system time bitching
 427                 $clientHeaderTime = strtotime( $clientHeader );
 428                 wfRestoreWarnings();
 429                 if ( !$clientHeaderTime ) {
 430                         wfDebug( __METHOD__ . ": unable to parse the client's If-Modified-Since header: $clientHeader\n" );
 431                         return false;
 432                 }
 433                 $clientHeaderTime = wfTimestamp( TS_MW, $clientHeaderTime );
 434
 435                 wfDebug( __METHOD__ . ": client sent If-Modified-Since: " .
 436                         wfTimestamp( TS_ISO_8601, $clientHeaderTime ) . "\n", false );
 437                 wfDebug( __METHOD__ . ": effective Last-Modified: " .
 438                         wfTimestamp( TS_ISO_8601, $maxModified ) . "\n", false );
 439                 if( $clientHeaderTime < $maxModified ) {
 440                         wfDebug( __METHOD__ . ": STALE, $info\n", false );
 441                         return false;
 442                 }
 443
 444                 # Not modified
 445                 # Give a 304 response code and disable body output
 446                 wfDebug( __METHOD__ . ": NOT MODIFIED, $info\n", false );
 447                 ini_set( 'zlib.output_compression', 0 );
 448                 $wgRequest->response()->header( "HTTP/1.1 304 Not Modified" );
 449                 $this->sendCacheControl();
 450                 $this->disable();
 451
 452                 // Don't output a compressed blob when using ob_gzhandler;
 453                 // it's technically against HTTP spec and seems to confuse
 454                 // Firefox when the response gets split over two packets.
 455                 wfClearOutputBuffers();
 456
 457                 return true;
 458         }
 459
 460         /**
 461          * Override the last modified timestamp
 462          *
 463          * @param $timestamp String: new timestamp, in a format readable by
 464          *        wfTimestamp()
 465          */
 466         public function setLastModified( $timestamp ) {
 467                 $this->mLastModified = wfTimestamp( TS_RFC2822, $timestamp );
 468         }
 469
 470         /**
 471          * Set the robot policy for the page: <http://www.robotstxt.org/meta.html>
 472          *
 473          * @param $policy String: the literal string to output as the contents of
 474          *   the meta tag.  Will be parsed according to the spec and output in
 475          *   standardized form.
 476          * @return null
 477          */
 478         public function setRobotPolicy( $policy ) {
 479                 $policy = Article::formatRobotPolicy( $policy );
 480
 481                 if( isset( $policy['index'] ) ) {
 482                         $this->setIndexPolicy( $policy['index'] );
 483                 }
 484                 if( isset( $policy['follow'] ) ) {
 485                         $this->setFollowPolicy( $policy['follow'] );
 486                 }
 487         }
 488
 489         /**
 490          * Set the index policy for the page, but leave the follow policy un-
 491          * touched.
 492          *
 493          * @param $policy string Either 'index' or 'noindex'.
 494          * @return null
 495          */
 496         public function setIndexPolicy( $policy ) {
 497                 $policy = trim( $policy );
 498                 if( in_array( $policy, array( 'index', 'noindex' ) ) ) {
 499                         $this->mIndexPolicy = $policy;
 500                 }
 501         }
 502
 503         /**
 504          * Set the follow policy for the page, but leave the index policy un-
 505          * touched.
 506          *
 507          * @param $policy String: either 'follow' or 'nofollow'.
 508          * @return null
 509          */
 510         public function setFollowPolicy( $policy ) {
 511                 $policy = trim( $policy );
 512                 if( in_array( $policy, array( 'follow', 'nofollow' ) ) ) {
 513                         $this->mFollowPolicy = $policy;
 514                 }
 515         }
 516
 517         /**
 518          * Set the new value of the "action text", this will be added to the
 519          * "HTML title", separated from it with " - ".
 520          *
 521          * @param $text String: new value of the "action text"
 522          */
 523         public function setPageTitleActionText( $text ) {
 524                 $this->mPageTitleActionText = $text;
 525         }
 526
 527         /**
 528          * Get the value of the "action text"
 529          *
 530          * @return String
 531          */
 532         public function getPageTitleActionText() {
 533                 if ( isset( $this->mPageTitleActionText ) ) {
 534                         return $this->mPageTitleActionText;
 535                 }
 536         }
 537
 538         /**
 539          * "HTML title" means the contents of <title>.
 540          * It is stored as plain, unescaped text and will be run through htmlspecialchars in the skin file.
 541          */
 542         public function setHTMLTitle( $name ) {
 543                 $this->mHTMLtitle = $name;
 544         }
 545
 546         /**
 547          * Return the "HTML title", i.e. the content of the <title> tag.
 548          *
 549          * @return String
 550          */
 551         public function getHTMLTitle() {
 552                 return $this->mHTMLtitle;
 553         }
 554
 555         /**
 556          * "Page title" means the contents of \<h1\>. It is stored as a valid HTML fragment.
 557          * This function allows good tags like \<sup\> in the \<h1\> tag, but not bad tags like \<script\>.
 558          * This function automatically sets \<title\> to the same content as \<h1\> but with all tags removed.
 559          * Bad tags that were escaped in \<h1\> will still be escaped in \<title\>, and good tags like \<i\> will be dropped entirely.
 560          */
 561         public function setPageTitle( $name ) {
 562                 # change "<script>foo&bar</script>" to "&lt;script&gt;foo&amp;bar&lt;/script&gt;"
 563                 # but leave "<i>foobar</i>" alone
 564                 $nameWithTags = Sanitizer::normalizeCharReferences( Sanitizer::removeHTMLtags( $name ) );
 565                 $this->mPagetitle = $nameWithTags;
 566
 567                 # change "<i>foo&amp;bar</i>" to "foo&bar"
 568                 $this->setHTMLTitle( wfMsg( 'pagetitle', Sanitizer::stripAllTags( $nameWithTags ) ) );
 569         }
 570
 571         /**
 572          * Return the "page title", i.e. the content of the \<h1\> tag.
 573          *
 574          * @return String
 575          */
 576         public function getPageTitle() {
 577                 return $this->mPagetitle;
 578         }
 579
 580         /**
 581          * Set the Title object to use
 582          *
 583          * @param $t Title object
 584          */
 585         public function setTitle( $t ) {
 586                 $this->mTitle = $t;
 587         }
 588
 589         /**
 590          * Get the Title object used in this instance
 591          *
 592          * @return Title
 593          */
 594         public function getTitle() {
 595                 if ( $this->mTitle instanceof Title ) {
 596                         return $this->mTitle;
 597                 } else {
 598                         wfDebug( __METHOD__ . " called and \$mTitle is null. Return \$wgTitle for sanity\n" );
 599                         global $wgTitle;
 600                         return $wgTitle;
 601                 }
 602         }
 603
 604         /**
 605          * Replace the subtile with $str
 606          *
 607          * @param $str String: new value of the subtitle
 608          */
 609         public function setSubtitle( $str ) {
 610                 $this->mSubtitle = /*$this->parse(*/ $str /*)*/; // @bug 2514
 611         }
 612
 613         /**
 614          * Add $str to the subtitle
 615          *
 616          * @param $str String to add to the subtitle
 617          */
 618         public function appendSubtitle( $str ) {
 619                 $this->mSubtitle .= /*$this->parse(*/ $str /*)*/; // @bug 2514
 620         }
 621
 622         /**
 623          * Get the subtitle
 624          *
 625          * @return String
 626          */
 627         public function getSubtitle() {
 628                 return $this->mSubtitle;
 629         }
 630
 631         /**
 632          * Set the page as printable, i.e. it'll be displayed with with all
 633          * print styles included
 634          */
 635         public function setPrintable() {
 636                 $this->mPrintable = true;
 637         }
 638
 639         /**
 640          * Return whether the page is "printable"
 641          *
 642          * @return Boolean
 643          */
 644         public function isPrintable() {
 645                 return $this->mPrintable;
 646         }
 647
 648         /**
 649          * Disable output completely, i.e. calling output() will have no effect
 650          */
 651         public function disable() {
 652                 $this->mDoNothing = true;
 653         }
 654
 655         /**
 656          * Return whether the output will be completely disabled
 657          *
 658          * @return Boolean
 659          */
 660         public function isDisabled() {
 661                 return $this->mDoNothing;
 662         }
 663
 664         /**
 665          * Show an "add new section" link?
 666          *
 667          * @return Boolean
 668          */
 669         public function showNewSectionLink() {
 670                 return $this->mNewSectionLink;
 671         }
 672
 673         /**
 674          * Forcibly hide the new section link?
 675          *
 676          * @return Boolean
 677          */
 678         public function forceHideNewSectionLink() {
 679                 return $this->mHideNewSectionLink;
 680         }
 681
 682         /**
 683          * Add or remove feed links in the page header
 684          * This is mainly kept for backward compatibility, see OutputPage::addFeedLink()
 685          * for the new version
 686          * @see addFeedLink()
 687          *
 688          * @param $show Boolean: true: add default feeds, false: remove all feeds
 689          */
 690         public function setSyndicated( $show = true ) {
 691                 if ( $show ) {
 692                         $this->setFeedAppendQuery( false );
 693                 } else {
 694                         $this->mFeedLinks = array();
 695                 }
 696         }
 697
 698         /**
 699          * Add default feeds to the page header
 700          * This is mainly kept for backward compatibility, see OutputPage::addFeedLink()
 701          * for the new version
 702          * @see addFeedLink()
 703          *
 704          * @param $val String: query to append to feed links or false to output
 705          *        default links
 706          */
 707         public function setFeedAppendQuery( $val ) {
 708                 global $wgAdvertisedFeedTypes;
 709
 710                 $this->mFeedLinks = array();
 711
 712                 foreach ( $wgAdvertisedFeedTypes as $type ) {
 713                         $query = "feed=$type";
 714                         if ( is_string( $val ) ) {
 715                                 $query .= '&' . $val;
 716                         }
 717                         $this->mFeedLinks[$type] = $this->getTitle()->getLocalURL( $query );
 718                 }
 719         }
 720
 721         /**
 722          * Add a feed link to the page header
 723          *
 724          * @param $format String: feed type, should be a key of $wgFeedClasses
 725          * @param $href String: URL
 726          */
 727         public function addFeedLink( $format, $href ) {
 728                 global $wgAdvertisedFeedTypes;
 729
 730                 if ( in_array( $format, $wgAdvertisedFeedTypes ) ) {
 731                         $this->mFeedLinks[$format] = $href;
 732                 }
 733         }
 734
 735         /**
 736          * Should we output feed links for this page?
 737          * @return Boolean
 738          */
 739         public function isSyndicated() {
 740                 return count( $this->mFeedLinks ) > 0;
 741         }
 742
 743         /**
 744          * Return URLs for each supported syndication format for this page.
 745          * @return array associating format keys with URLs
 746          */
 747         public function getSyndicationLinks() {
 748                 return $this->mFeedLinks;
 749         }
 750
 751         /**
 752          * Will currently always return null
 753          *
 754          * @return null
 755          */
 756         public function getFeedAppendQuery() {
 757                 return $this->mFeedLinksAppendQuery;
 758         }
 759
 760         /**
 761          * Set whether the displayed content is related to the source of the
 762          * corresponding article on the wiki
 763          * Setting true will cause the change "article related" toggle to true
 764          *
 765          * @param $v Boolean
 766          */
 767         public function setArticleFlag( $v ) {
 768                 $this->mIsarticle = $v;
 769                 if ( $v ) {
 770                         $this->mIsArticleRelated = $v;
 771                 }
 772         }
 773
 774         /**
 775          * Return whether the content displayed page is related to the source of
 776          * the corresponding article on the wiki
 777          *
 778          * @return Boolean
 779          */
 780         public function isArticle() {
 781                 return $this->mIsarticle;
 782         }
 783
 784         /**
 785          * Set whether this page is related an article on the wiki
 786          * Setting false will cause the change of "article flag" toggle to false
 787          *
 788          * @param $v Boolean
 789          */
 790         public function setArticleRelated( $v ) {
 791                 $this->mIsArticleRelated = $v;
 792                 if ( !$v ) {
 793                         $this->mIsarticle = false;
 794                 }
 795         }
 796
 797         /**
 798          * Return whether this page is related an article on the wiki
 799          *
 800          * @return Boolean
 801          */
 802         public function isArticleRelated() {
 803                 return $this->mIsArticleRelated;
 804         }
 805
 806         /**
 807          * Add new language links
 808          *
 809          * @param $newLinkArray Associative array mapping language code to the page
 810          *                      name
 811          */
 812         public function addLanguageLinks( $newLinkArray ) {
 813                 $this->mLanguageLinks += $newLinkArray;
 814         }
 815
 816         /**
 817          * Reset the language links and add new language links
 818          *
 819          * @param $newLinkArray Associative array mapping language code to the page
 820          *                      name
 821          */
 822         public function setLanguageLinks( $newLinkArray ) {
 823                 $this->mLanguageLinks = $newLinkArray;
 824         }
 825
 826         /**
 827          * Get the list of language links
 828          *
 829          * @return Associative array mapping language code to the page name
 830          */
 831         public function getLanguageLinks() {
 832                 return $this->mLanguageLinks;
 833         }
 834
 835         /**
 836          * Add an array of categories, with names in the keys
 837          *
 838          * @param $categories Associative array mapping category name to its sort key
 839          */
 840         public function addCategoryLinks( $categories ) {
 841                 global $wgUser, $wgContLang;
 842
 843                 if ( !is_array( $categories ) || count( $categories ) == 0 ) {
 844                         return;
 845                 }
 846
 847                 # Add the links to a LinkBatch
 848                 $arr = array( NS_CATEGORY => $categories );
 849                 $lb = new LinkBatch;
 850                 $lb->setArray( $arr );
 851
 852                 # Fetch existence plus the hiddencat property
 853                 $dbr = wfGetDB( DB_SLAVE );
 854                 $pageTable = $dbr->tableName( 'page' );
 855                 $where = $lb->constructSet( 'page', $dbr );
 856                 $propsTable = $dbr->tableName( 'page_props' );
 857                 $sql = "SELECT page_id, page_namespace, page_title, page_len, page_is_redirect, page_latest, pp_value
 858                         FROM $pageTable LEFT JOIN $propsTable ON pp_propname='hiddencat' AND pp_page=page_id WHERE $where";
 859                 $res = $dbr->query( $sql, __METHOD__ );
 860
 861                 # Add the results to the link cache
 862                 $lb->addResultToCache( LinkCache::singleton(), $res );
 863
 864                 # Set all the values to 'normal'. This can be done with array_fill_keys in PHP 5.2.0+
 865                 $categories = array_combine(
 866                         array_keys( $categories ),
 867                         array_fill( 0, count( $categories ), 'normal' )
 868                 );
 869
 870                 # Mark hidden categories
 871                 foreach ( $res as $row ) {
 872                         if ( isset( $row->pp_value ) ) {
 873                                 $categories[$row->page_title] = 'hidden';
 874                         }
 875                 }
 876
 877                 # Add the remaining categories to the skin
 878                 if ( wfRunHooks( 'OutputPageMakeCategoryLinks', array( &$this, $categories, &$this->mCategoryLinks ) ) ) {
 879                         $sk = $wgUser->getSkin();
 880                         foreach ( $categories as $category => $type ) {
 881                                 $origcategory = $category;
 882                                 $title = Title::makeTitleSafe( NS_CATEGORY, $category );
 883                                 $wgContLang->findVariantLink( $category, $title, true );
 884                                 if ( $category != $origcategory ) {
 885                                         if ( array_key_exists( $category, $categories ) ) {
 886                                                 continue;
 887                                         }
 888                                 }
 889                                 $text = $wgContLang->convertHtml( $title->getText() );
 890                                 $this->mCategories[] = $title->getText();
 891                                 $this->mCategoryLinks[$type][] = $sk->link( $title, $text );
 892                         }
 893                 }
 894         }
 895
 896         /**
 897          * Reset the category links (but not the category list) and add $categories
 898          *
 899          * @param $categories Associative array mapping category name to its sort key
 900          */
 901         public function setCategoryLinks( $categories ) {
 902                 $this->mCategoryLinks = array();
 903                 $this->addCategoryLinks( $categories );
 904         }
 905
 906         /**
 907          * Get the list of category links, in a 2-D array with the following format:
 908          * $arr[$type][] = $link, where $type is either "normal" or "hidden" (for
 909          * hidden categories) and $link a HTML fragment with a link to the category
 910          * page
 911          *
 912          * @return Array
 913          */
 914         public function getCategoryLinks() {
 915                 return $this->mCategoryLinks;
 916         }
 917
 918         /**
 919          * Get the list of category names this page belongs to
 920          *
 921          * @return Array of strings
 922          */
 923         public function getCategories() {
 924                 return $this->mCategories;
 925         }
 926
 927         /**
 928          * Suppress the quickbar from the output, only for skin supporting
 929          * the quickbar
 930          */
 931         public function suppressQuickbar() {
 932                 $this->mSuppressQuickbar = true;
 933         }
 934
 935         /**
 936          * Return whether the quickbar should be suppressed from the output
 937          *
 938          * @return Boolean
 939          */
 940         public function isQuickbarSuppressed() {
 941                 return $this->mSuppressQuickbar;
 942         }
 943
 944         /**
 945          * Remove user JavaScript from scripts to load
 946          */
 947         public function disallowUserJs() {
 948                 $this->mAllowUserJs = false;
 949         }
 950
 951         /**
 952          * Return whether user JavaScript is allowed for this page
 953          *
 954          * @return Boolean
 955          */
 956         public function isUserJsAllowed() {
 957                 return $this->mAllowUserJs;
 958         }
 959
 960         /**
 961          * Prepend $text to the body HTML
 962          *
 963          * @param $text String: HTML
 964          */
 965         public function prependHTML( $text ) {
 966                 $this->mBodytext = $text . $this->mBodytext;
 967         }
 968
 969         /**
 970          * Append $text to the body HTML
 971          *
 972          * @param $text String: HTML
 973          */
 974         public function addHTML( $text ) {
 975                 $this->mBodytext .= $text;
 976         }
 977
 978         /**
 979          * Clear the body HTML
 980          */
 981         public function clearHTML() {
 982                 $this->mBodytext = '';
 983         }
 984
 985         /**
 986          * Get the body HTML
 987          *
 988          * @return String: HTML
 989          */
 990         public function getHTML() {
 991                 return $this->mBodytext;
 992         }
 993
 994         /**
 995          * Add $text to the debug output
 996          *
 997          * @param $text String: debug text
 998          */
 999         public function debug( $text ) {
1000                 $this->mDebugtext .= $text;
1001         }
1002
1003         /**
1004          * @deprecated use parserOptions() instead
1005          */
1006         public function setParserOptions( $options ) {
1007                 wfDeprecated( __METHOD__ );
1008                 return $this->parserOptions( $options );
1009         }
1010
1011         /**
1012          * Get/set the ParserOptions object to use for wikitext parsing
1013          *
1014          * @param $options either the ParserOption to use or null to only get the
1015          *                 current ParserOption object
1016          * @return current ParserOption object
1017          */
1018         public function parserOptions( $options = null ) {
1019                 if ( !$this->mParserOptions ) {
1020                         $this->mParserOptions = new ParserOptions;
1021                 }
1022                 return wfSetVar( $this->mParserOptions, $options );
1023         }
1024
1025         /**
1026          * Set the revision ID which will be seen by the wiki text parser
1027          * for things such as embedded {{REVISIONID}} variable use.
1028          *
1029          * @param $revid Mixed: an positive integer, or null
1030          * @return Mixed: previous value
1031          */
1032         public function setRevisionId( $revid ) {
1033                 $val = is_null( $revid ) ? null : intval( $revid );
1034                 return wfSetVar( $this->mRevisionId, $val );
1035         }
1036
1037         /**
1038          * Get the current revision ID
1039          *
1040          * @return Integer
1041          */
1042         public function getRevisionId() {
1043                 return $this->mRevisionId;
1044         }
1045
1046         /**
1047          * Convert wikitext to HTML and add it to the buffer
1048          * Default assumes that the current page title will be used.
1049          *
1050          * @param $text String
1051          * @param $linestart Boolean: is this the start of a line?
1052          */
1053         public function addWikiText( $text, $linestart = true ) {
1054                 $title = $this->getTitle(); // Work arround E_STRICT
1055                 $this->addWikiTextTitle( $text, $title, $linestart );
1056         }
1057
1058         /**
1059          * Add wikitext with a custom Title object
1060          *
1061          * @param $text String: wikitext
1062          * @param $title Title object
1063          * @param $linestart Boolean: is this the start of a line?
1064          */
1065         public function addWikiTextWithTitle( $text, &$title, $linestart = true ) {
1066                 $this->addWikiTextTitle( $text, $title, $linestart );
1067         }
1068
1069         /**
1070          * Add wikitext with a custom Title object and
1071          *
1072          * @param $text String: wikitext
1073          * @param $title Title object
1074          * @param $linestart Boolean: is this the start of a line?
1075          */
1076         function addWikiTextTitleTidy( $text, &$title, $linestart = true ) {
1077                 $this->addWikiTextTitle( $text, $title, $linestart, true );
1078         }
1079
1080         /**
1081          * Add wikitext with tidy enabled
1082          *
1083          * @param $text String: wikitext
1084          * @param $linestart Boolean: is this the start of a line?
1085          */
1086         public function addWikiTextTidy( $text, $linestart = true ) {
1087                 $title = $this->getTitle();
1088                 $this->addWikiTextTitleTidy( $text, $title, $linestart );
1089         }
1090
1091         /**
1092          * Add wikitext with a custom Title object
1093          *
1094          * @param $text String: wikitext
1095          * @param $title Title object
1096          * @param $linestart Boolean: is this the start of a line?
1097          * @param $tidy Boolean: whether to use tidy
1098          */
1099         public function addWikiTextTitle( $text, &$title, $linestart, $tidy = false ) {
1100                 global $wgParser;
1101
1102                 wfProfileIn( __METHOD__ );
1103
1104                 wfIncrStats( 'pcache_not_possible' );
1105
1106                 $popts = $this->parserOptions();
1107                 $oldTidy = $popts->setTidy( $tidy );
1108
1109                 $parserOutput = $wgParser->parse(
1110                         $text, $title, $popts,
1111                         $linestart, true, $this->mRevisionId
1112                 );
1113
1114                 $popts->setTidy( $oldTidy );
1115
1116                 $this->addParserOutput( $parserOutput );
1117
1118                 wfProfileOut( __METHOD__ );
1119         }
1120
1121         /**
1122          * Add wikitext to the buffer, assuming that this is the primary text for a page view
1123          * Saves the text into the parser cache if possible.
1124          *
1125          * @param $text String: wikitext
1126          * @param $article Article object
1127          * @param $cache Boolean
1128          * @deprecated Use Article::outputWikitext
1129          */
1130         public function addPrimaryWikiText( $text, $article, $cache = true ) {
1131                 global $wgParser;
1132
1133                 wfDeprecated( __METHOD__ );
1134
1135                 $popts = $this->parserOptions();
1136                 $popts->setTidy( true );
1137                 $parserOutput = $wgParser->parse(
1138                         $text, $article->mTitle,
1139                         $popts, true, true, $this->mRevisionId
1140                 );
1141                 $popts->setTidy( false );
1142                 if ( $cache && $article && $parserOutput->isCacheable() ) {
1143                         $parserCache = ParserCache::singleton();
1144                         $parserCache->save( $parserOutput, $article, $popts );
1145                 }
1146
1147                 $this->addParserOutput( $parserOutput );
1148         }
1149
1150         /**
1151          * @deprecated use addWikiTextTidy()
1152          */
1153         public function addSecondaryWikiText( $text, $linestart = true ) {
1154                 wfDeprecated( __METHOD__ );
1155                 $this->addWikiTextTitleTidy( $text, $this->getTitle(), $linestart );
1156         }
1157
1158         /**
1159          * Add a ParserOutput object, but without Html
1160          *
1161          * @param $parserOutput ParserOutput object
1162          */
1163         public function addParserOutputNoText( &$parserOutput ) {
1164                 $this->mLanguageLinks += $parserOutput->getLanguageLinks();
1165                 $this->addCategoryLinks( $parserOutput->getCategories() );
1166                 $this->mNewSectionLink = $parserOutput->getNewSection();
1167                 $this->mHideNewSectionLink = $parserOutput->getHideNewSection();
1168
1169                 $this->mParseWarnings = $parserOutput->getWarnings();
1170                 if ( !$parserOutput->isCacheable() ) {
1171                         $this->enableClientCache( false );
1172                 }
1173                 $this->mNoGallery = $parserOutput->getNoGallery();
1174                 $this->mHeadItems = array_merge( $this->mHeadItems, $parserOutput->getHeadItems() );
1175                 $this->addModules( $parserOutput->getModules() );
1176                 // Versioning...
1177                 foreach ( (array)$parserOutput->mTemplateIds as $ns => $dbks ) {
1178                         if ( isset( $this->mTemplateIds[$ns] ) ) {
1179                                 $this->mTemplateIds[$ns] = $dbks + $this->mTemplateIds[$ns];
1180                         } else {
1181                                 $this->mTemplateIds[$ns] = $dbks;
1182                         }
1183                 }
1184
1185                 // Hooks registered in the object
1186                 global $wgParserOutputHooks;
1187                 foreach ( $parserOutput->getOutputHooks() as $hookInfo ) {
1188                         list( $hookName, $data ) = $hookInfo;
1189                         if ( isset( $wgParserOutputHooks[$hookName] ) ) {
1190                                 call_user_func( $wgParserOutputHooks[$hookName], $this, $parserOutput, $data );
1191                         }
1192                 }
1193
1194                 wfRunHooks( 'OutputPageParserOutput', array( &$this, $parserOutput ) );
1195         }
1196
1197         /**
1198          * Add a ParserOutput object
1199          *
1200          * @param $parserOutput ParserOutput
1201          */
1202         function addParserOutput( &$parserOutput ) {
1203                 $this->addParserOutputNoText( $parserOutput );
1204                 $text = $parserOutput->getText();
1205                 wfRunHooks( 'OutputPageBeforeHTML', array( &$this, &$text ) );
1206                 $this->addHTML( $text );
1207         }
1208
1209
1210         /**
1211          * Add the output of a QuickTemplate to the output buffer
1212          *
1213          * @param $template QuickTemplate
1214          */
1215         public function addTemplate( &$template ) {
1216                 ob_start();
1217                 $template->execute();
1218                 $this->addHTML( ob_get_contents() );
1219                 ob_end_clean();
1220         }
1221
1222         /**
1223          * Parse wikitext and return the HTML.
1224          *
1225          * @param $text String
1226          * @param $linestart Boolean: is this the start of a line?
1227          * @param $interface Boolean: use interface language ($wgLang instead of
1228          *                   $wgContLang) while parsing language sensitive magic
1229          *                   words like GRAMMAR and PLURAL
1230          * @return String: HTML
1231          */
1232         public function parse( $text, $linestart = true, $interface = false ) {
1233                 global $wgParser;
1234                 if( is_null( $this->getTitle() ) ) {
1235                         throw new MWException( 'Empty $mTitle in ' . __METHOD__ );
1236                 }
1237                 $popts = $this->parserOptions();
1238                 if ( $interface ) {
1239                         $popts->setInterfaceMessage( true );
1240                 }
1241                 $parserOutput = $wgParser->parse(
1242                         $text, $this->getTitle(), $popts,
1243                         $linestart, true, $this->mRevisionId
1244                 );
1245                 if ( $interface ) {
1246                         $popts->setInterfaceMessage( false );
1247                 }
1248                 return $parserOutput->getText();
1249         }
1250
1251         /**
1252          * Parse wikitext, strip paragraphs, and return the HTML.
1253          *
1254          * @param $text String
1255          * @param $linestart Boolean: is this the start of a line?
1256          * @param $interface Boolean: use interface language ($wgLang instead of
1257          *                   $wgContLang) while parsing language sensitive magic
1258          *                   words like GRAMMAR and PLURAL
1259          * @return String: HTML
1260          */
1261         public function parseInline( $text, $linestart = true, $interface = false ) {
1262                 $parsed = $this->parse( $text, $linestart, $interface );
1263
1264                 $m = array();
1265                 if ( preg_match( '/^<p>(.*)\n?<\/p>\n?/sU', $parsed, $m ) ) {
1266                         $parsed = $m[1];
1267                 }
1268
1269                 return $parsed;
1270         }
1271
1272         /**
1273          * @deprecated
1274          *
1275          * @param $article Article
1276          * @return Boolean: true if successful, else false.
1277          */
1278         public function tryParserCache( &$article ) {
1279                 wfDeprecated( __METHOD__ );
1280                 $parserOutput = ParserCache::singleton()->get( $article, $article->getParserOptions() );
1281
1282                 if ( $parserOutput !== false ) {
1283                         $this->addParserOutput( $parserOutput );
1284                         return true;
1285                 } else {
1286                         return false;
1287                 }
1288         }
1289
1290         /**
1291          * Set the value of the "s-maxage" part of the "Cache-control" HTTP header
1292          *
1293          * @param $maxage Integer: maximum cache time on the Squid, in seconds.
1294          */
1295         public function setSquidMaxage( $maxage ) {
1296                 $this->mSquidMaxage = $maxage;
1297         }
1298
1299         /**
1300          * Use enableClientCache(false) to force it to send nocache headers
1301          *
1302          * @param $state ??
1303          */
1304         public function enableClientCache( $state ) {
1305                 return wfSetVar( $this->mEnableClientCache, $state );
1306         }
1307
1308         /**
1309          * Get the list of cookies that will influence on the cache
1310          *
1311          * @return Array
1312          */
1313         function getCacheVaryCookies() {
1314                 global $wgCookiePrefix, $wgCacheVaryCookies;
1315                 static $cookies;
1316                 if ( $cookies === null ) {
1317                         $cookies = array_merge(
1318                                 array(
1319                                         "{$wgCookiePrefix}Token",
1320                                         "{$wgCookiePrefix}LoggedOut",
1321                                         session_name()
1322                                 ),
1323                                 $wgCacheVaryCookies
1324                         );
1325                         wfRunHooks( 'GetCacheVaryCookies', array( $this, &$cookies ) );
1326                 }
1327                 return $cookies;
1328         }
1329
1330         /**
1331          * Return whether this page is not cacheable because "useskin" or "uselang"
1332          * URL parameters were passed.
1333          *
1334          * @return Boolean
1335          */
1336         function uncacheableBecauseRequestVars() {
1337                 global $wgRequest;
1338                 return $wgRequest->getText( 'useskin', false ) === false
1339                         && $wgRequest->getText( 'uselang', false ) === false;
1340         }
1341
1342         /**
1343          * Check if the request has a cache-varying cookie header
1344          * If it does, it's very important that we don't allow public caching
1345          *
1346          * @return Boolean
1347          */
1348         function haveCacheVaryCookies() {
1349                 global $wgRequest;
1350                 $cookieHeader = $wgRequest->getHeader( 'cookie' );
1351                 if ( $cookieHeader === false ) {
1352                         return false;
1353                 }
1354                 $cvCookies = $this->getCacheVaryCookies();
1355                 foreach ( $cvCookies as $cookieName ) {
1356                         # Check for a simple string match, like the way squid does it
1357                         if ( strpos( $cookieHeader, $cookieName ) !== false ) {
1358                                 wfDebug( __METHOD__ . ": found $cookieName\n" );
1359                                 return true;
1360                         }
1361                 }
1362                 wfDebug( __METHOD__ . ": no cache-varying cookies found\n" );
1363                 return false;
1364         }
1365
1366         /**
1367          * Add an HTTP header that will influence on the cache
1368          *
1369          * @param $header String: header name
1370          * @param $option either an Array or null
1371          * @fixme Document the $option parameter; it appears to be for
1372          *        X-Vary-Options but what format is acceptable?
1373          */
1374         public function addVaryHeader( $header, $option = null ) {
1375                 if ( !array_key_exists( $header, $this->mVaryHeader ) ) {
1376                         $this->mVaryHeader[$header] = (array)$option;
1377                 } elseif( is_array( $option ) ) {
1378                         if( is_array( $this->mVaryHeader[$header] ) ) {
1379                                 $this->mVaryHeader[$header] = array_merge( $this->mVaryHeader[$header], $option );
1380                         } else {
1381                                 $this->mVaryHeader[$header] = $option;
1382                         }
1383                 }
1384                 $this->mVaryHeader[$header] = array_unique( $this->mVaryHeader[$header] );
1385         }
1386
1387         /**
1388          * Get a complete X-Vary-Options header
1389          *
1390          * @return String
1391          */
1392         public function getXVO() {
1393                 $cvCookies = $this->getCacheVaryCookies();
1394
1395                 $cookiesOption = array();
1396                 foreach ( $cvCookies as $cookieName ) {
1397                         $cookiesOption[] = 'string-contains=' . $cookieName;
1398                 }
1399                 $this->addVaryHeader( 'Cookie', $cookiesOption );
1400
1401                 $headers = array();
1402                 foreach( $this->mVaryHeader as $header => $option ) {
1403                         $newheader = $header;
1404                         if( is_array( $option ) ) {
1405                                 $newheader .= ';' . implode( ';', $option );
1406                         }
1407                         $headers[] = $newheader;
1408                 }
1409                 $xvo = 'X-Vary-Options: ' . implode( ',', $headers );
1410
1411                 return $xvo;
1412         }
1413
1414         /**
1415          * bug 21672: Add Accept-Language to Vary and XVO headers
1416          * if there's no 'variant' parameter existed in GET.
1417          *
1418          * For example:
1419          *   /w/index.php?title=Main_page should always be served; but
1420          *   /w/index.php?title=Main_page&variant=zh-cn should never be served.
1421          */
1422         function addAcceptLanguage() {
1423                 global $wgRequest, $wgContLang;
1424                 if( !$wgRequest->getCheck( 'variant' ) && $wgContLang->hasVariants() ) {
1425                         $variants = $wgContLang->getVariants();
1426                         $aloption = array();
1427                         foreach ( $variants as $variant ) {
1428                                 if( $variant === $wgContLang->getCode() ) {
1429                                         continue;
1430                                 } else {
1431                                         $aloption[] = 'string-contains=' . $variant;
1432
1433                                         // IE and some other browsers use another form of language code
1434                                         // in their Accept-Language header, like "zh-CN" or "zh-TW".
1435                                         // We should handle these too.
1436                                         $ievariant = explode( '-', $variant );
1437                                         if ( count( $ievariant ) == 2 ) {
1438                                                 $ievariant[1] = strtoupper( $ievariant[1] );
1439                                                 $ievariant = implode( '-', $ievariant );
1440                                                 $aloption[] = 'string-contains=' . $ievariant;
1441                                         }
1442                                 }
1443                         }
1444                         $this->addVaryHeader( 'Accept-Language', $aloption );
1445                 }
1446         }
1447
1448         /**
1449          * Set a flag which will cause an X-Frame-Options header appropriate for
1450          * edit pages to be sent. The header value is controlled by
1451          * $wgEditPageFrameOptions.
1452          *
1453          * This is the default for special pages. If you display a CSRF-protected
1454          * form on an ordinary view page, then you need to call this function.
1455          */
1456         public function preventClickjacking( $enable = true ) {
1457                 $this->mPreventClickjacking = $enable;
1458         }
1459
1460         /**
1461          * Turn off frame-breaking. Alias for $this->preventClickjacking(false).
1462          * This can be called from pages which do not contain any CSRF-protected
1463          * HTML form.
1464          */
1465         public function allowClickjacking() {
1466                 $this->mPreventClickjacking = false;
1467         }
1468
1469         /**
1470          * Get the X-Frame-Options header value (without the name part), or false
1471          * if there isn't one. This is used by Skin to determine whether to enable
1472          * JavaScript frame-breaking, for clients that don't support X-Frame-Options.
1473          */
1474         public function getFrameOptions() {
1475                 global $wgBreakFrames, $wgEditPageFrameOptions;
1476                 if ( $wgBreakFrames ) {
1477                         return 'DENY';
1478                 } elseif ( $this->mPreventClickjacking && $wgEditPageFrameOptions ) {
1479                         return $wgEditPageFrameOptions;
1480                 }
1481         }
1482
1483         /**
1484          * Send cache control HTTP headers
1485          */
1486         public function sendCacheControl() {
1487                 global $wgUseSquid, $wgUseESI, $wgUseETag, $wgSquidMaxage, $wgRequest, $wgUseXVO;
1488
1489                 $response = $wgRequest->response();
1490                 if ( $wgUseETag && $this->mETag ) {
1491                         $response->header( "ETag: $this->mETag" );
1492                 }
1493
1494                 $this->addAcceptLanguage();
1495
1496                 # don't serve compressed data to clients who can't handle it
1497                 # maintain different caches for logged-in users and non-logged in ones
1498                 $response->header( 'Vary: ' . join( ', ', array_keys( $this->mVaryHeader ) ) );
1499
1500                 if ( $wgUseXVO ) {
1501                         # Add an X-Vary-Options header for Squid with Wikimedia patches
1502                         $response->header( $this->getXVO() );
1503                 }
1504
1505                 if( !$this->uncacheableBecauseRequestVars() && $this->mEnableClientCache ) {
1506                         if(
1507                                 $wgUseSquid && session_id() == '' && !$this->isPrintable() &&
1508                                 $this->mSquidMaxage != 0 && !$this->haveCacheVaryCookies()
1509                         )
1510                         {
1511                                 if ( $wgUseESI ) {
1512                                         # We'll purge the proxy cache explicitly, but require end user agents
1513                                         # to revalidate against the proxy on each visit.
1514                                         # Surrogate-Control controls our Squid, Cache-Control downstream caches
1515                                         wfDebug( __METHOD__ . ": proxy caching with ESI; {$this->mLastModified} **\n", false );
1516                                         # start with a shorter timeout for initial testing
1517                                         # header( 'Surrogate-Control: max-age=2678400+2678400, content="ESI/1.0"');
1518                                         $response->header( 'Surrogate-Control: max-age='.$wgSquidMaxage.'+'.$this->mSquidMaxage.', content="ESI/1.0"');
1519                                         $response->header( 'Cache-Control: s-maxage=0, must-revalidate, max-age=0' );
1520                                 } else {
1521                                         # We'll purge the proxy cache for anons explicitly, but require end user agents
1522                                         # to revalidate against the proxy on each visit.
1523                                         # IMPORTANT! The Squid needs to replace the Cache-Control header with
1524                                         # Cache-Control: s-maxage=0, must-revalidate, max-age=0
1525                                         wfDebug( __METHOD__ . ": local proxy caching; {$this->mLastModified} **\n", false );
1526                                         # start with a shorter timeout for initial testing
1527                                         # header( "Cache-Control: s-maxage=2678400, must-revalidate, max-age=0" );
1528                                         $response->header( 'Cache-Control: s-maxage='.$this->mSquidMaxage.', must-revalidate, max-age=0' );
1529                                 }
1530                         } else {
1531                                 # We do want clients to cache if they can, but they *must* check for updates
1532                                 # on revisiting the page.
1533                                 wfDebug( __METHOD__ . ": private caching; {$this->mLastModified} **\n", false );
1534                                 $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
1535                                 $response->header( "Cache-Control: private, must-revalidate, max-age=0" );
1536                         }
1537                         if($this->mLastModified) {
1538                                 $response->header( "Last-Modified: {$this->mLastModified}" );
1539                         }
1540                 } else {
1541                         wfDebug( __METHOD__ . ": no caching **\n", false );
1542
1543                         # In general, the absence of a last modified header should be enough to prevent
1544                         # the client from using its cache. We send a few other things just to make sure.
1545                         $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
1546                         $response->header( 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate' );
1547                         $response->header( 'Pragma: no-cache' );
1548                 }
1549         }
1550
1551         /**
1552          * Get the message associed with the HTTP response code $code
1553          *
1554          * @param $code Integer: status code
1555          * @return String or null: message or null if $code is not in the list of
1556          *         messages
1557          */
1558         public static function getStatusMessage( $code ) {
1559                 static $statusMessage = array(
1560                         100 => 'Continue',
1561                         101 => 'Switching Protocols',
1562                         102 => 'Processing',
1563                         200 => 'OK',
1564                         201 => 'Created',
1565                         202 => 'Accepted',
1566                         203 => 'Non-Authoritative Information',
1567                         204 => 'No Content',
1568                         205 => 'Reset Content',
1569                         206 => 'Partial Content',
1570                         207 => 'Multi-Status',
1571                         300 => 'Multiple Choices',
1572                         301 => 'Moved Permanently',
1573                         302 => 'Found',
1574                         303 => 'See Other',
1575                         304 => 'Not Modified',
1576                         305 => 'Use Proxy',
1577                         307 => 'Temporary Redirect',
1578                         400 => 'Bad Request',
1579                         401 => 'Unauthorized',
1580                         402 => 'Payment Required',
1581                         403 => 'Forbidden',
1582                         404 => 'Not Found',
1583                         405 => 'Method Not Allowed',
1584                         406 => 'Not Acceptable',
1585                         407 => 'Proxy Authentication Required',
1586                         408 => 'Request Timeout',
1587                         409 => 'Conflict',
1588                         410 => 'Gone',
1589                         411 => 'Length Required',
1590                         412 => 'Precondition Failed',
1591                         413 => 'Request Entity Too Large',
1592                         414 => 'Request-URI Too Large',
1593                         415 => 'Unsupported Media Type',
1594                         416 => 'Request Range Not Satisfiable',
1595                         417 => 'Expectation Failed',
1596                         422 => 'Unprocessable Entity',
1597                         423 => 'Locked',
1598                         424 => 'Failed Dependency',
1599                         500 => 'Internal Server Error',
1600                         501 => 'Not Implemented',
1601                         502 => 'Bad Gateway',
1602                         503 => 'Service Unavailable',
1603                         504 => 'Gateway Timeout',
1604                         505 => 'HTTP Version Not Supported',
1605                         507 => 'Insufficient Storage'
1606                 );
1607                 return isset( $statusMessage[$code] ) ? $statusMessage[$code] : null;
1608         }
1609
1610         /**
1611          * Finally, all the text has been munged and accumulated into
1612          * the object, let's actually output it:
1613          */
1614         public function output() {
1615                 global $wgUser, $wgOutputEncoding, $wgRequest;
1616                 global $wgLanguageCode, $wgDebugRedirects, $wgMimeType;
1617                 global $wgUseAjax, $wgAjaxWatch;
1618                 global $wgEnableMWSuggest, $wgUniversalEditButton;
1619                 global $wgArticle;
1620
1621                 if( $this->mDoNothing ) {
1622                         return;
1623                 }
1624                 wfProfileIn( __METHOD__ );
1625                 if ( $this->mRedirect != '' ) {
1626                         # Standards require redirect URLs to be absolute
1627                         $this->mRedirect = wfExpandUrl( $this->mRedirect );
1628                         if( $this->mRedirectCode == '301' || $this->mRedirectCode == '303' ) {
1629                                 if( !$wgDebugRedirects ) {
1630                                         $message = self::getStatusMessage( $this->mRedirectCode );
1631                                         $wgRequest->response()->header( "HTTP/1.1 {$this->mRedirectCode} $message" );
1632                                 }
1633                                 $this->mLastModified = wfTimestamp( TS_RFC2822 );
1634                         }
1635                         $this->sendCacheControl();
1636
1637                         $wgRequest->response()->header( "Content-Type: text/html; charset=utf-8" );
1638                         if( $wgDebugRedirects ) {
1639                                 $url = htmlspecialchars( $this->mRedirect );
1640                                 print "<html>\n<head>\n<title>Redirect</title>\n</head>\n<body>\n";
1641                                 print "<p>Location: <a href=\"$url\">$url</a></p>\n";
1642                                 print "</body>\n</html>\n";
1643                         } else {
1644                                 $wgRequest->response()->header( 'Location: ' . $this->mRedirect );
1645                         }
1646                         wfProfileOut( __METHOD__ );
1647                         return;
1648                 } elseif ( $this->mStatusCode ) {
1649                         $message = self::getStatusMessage( $this->mStatusCode );
1650                         if ( $message ) {
1651                                 $wgRequest->response()->header( 'HTTP/1.1 ' . $this->mStatusCode . ' ' . $message );
1652                         }
1653                 }
1654
1655                 $sk = $wgUser->getSkin();
1656
1657                 // Add base resources
1658                 $this->addModules( 'mediawiki.util' );
1659                 global $wgIncludeLegacyJavaScript;
1660                 if( $wgIncludeLegacyJavaScript ){
1661                         $this->addModules( 'mediawiki.legacy.wikibits' );
1662                 }
1663
1664                 // Add various resources if required
1665                 if ( $wgUseAjax ) {
1666                         $this->addModules( 'mediawiki.legacy.ajax' );
1667
1668                         wfRunHooks( 'AjaxAddScript', array( &$this ) );
1669
1670                         if( $wgAjaxWatch && $wgUser->isLoggedIn() ) {
1671                                 $this->addModules( 'mediawiki.legacy.ajaxwatch' );
1672                         }
1673
1674                         if ( $wgEnableMWSuggest && !$wgUser->getOption( 'disablesuggest', false ) ) {
1675                                 $this->addModules( 'mediawiki.legacy.mwsuggest' );
1676                         }
1677                 }
1678
1679                 if( $wgUser->getBoolOption( 'editsectiononrightclick' ) ) {
1680                         $this->addModules( 'mediawiki.action.view.rightClickEdit' );
1681                 }
1682
1683                 if( $wgUniversalEditButton ) {
1684                         if( isset( $wgArticle ) && $this->getTitle() && $this->getTitle()->quickUserCan( 'edit' )
1685                                 && ( $this->getTitle()->exists() || $this->getTitle()->quickUserCan( 'create' ) ) ) {
1686                                 // Original UniversalEditButton
1687                                 $msg = wfMsg( 'edit' );
1688                                 $this->addLink( array(
1689                                         'rel' => 'alternate',
1690                                         'type' => 'application/x-wiki',
1691                                         'title' => $msg,
1692                                         'href' => $this->getTitle()->getLocalURL( 'action=edit' )
1693                                 ) );
1694                                 // Alternate edit link
1695                                 $this->addLink( array(
1696                                         'rel' => 'edit',
1697                                         'title' => $msg,
1698                                         'href' => $this->getTitle()->getLocalURL( 'action=edit' )
1699                                 ) );
1700                         }
1701                 }
1702
1703
1704                 # Buffer output; final headers may depend on later processing
1705                 ob_start();
1706
1707                 $wgRequest->response()->header( "Content-type: $wgMimeType; charset={$wgOutputEncoding}" );
1708                 $wgRequest->response()->header( 'Content-language: ' . $wgLanguageCode );
1709
1710                 // Prevent framing, if requested
1711                 $frameOptions = $this->getFrameOptions();
1712                 if ( $frameOptions ) {
1713                         $wgRequest->response()->header( "X-Frame-Options: $frameOptions" );
1714                 }
1715
1716                 if ( $this->mArticleBodyOnly ) {
1717                         $this->out( $this->mBodytext );
1718                 } else {
1719                         // Hook that allows last minute changes to the output page, e.g.
1720                         // adding of CSS or Javascript by extensions.
1721                         wfRunHooks( 'BeforePageDisplay', array( &$this, &$sk ) );
1722
1723                         wfProfileIn( 'Output-skin' );
1724                         $sk->outputPage( $this );
1725                         wfProfileOut( 'Output-skin' );
1726                 }
1727
1728                 $this->sendCacheControl();
1729                 ob_end_flush();
1730                 wfProfileOut( __METHOD__ );
1731         }
1732
1733         /**
1734          * Actually output something with print(). Performs an iconv to the
1735          * output encoding, if needed.
1736          *
1737          * @param $ins String: the string to output
1738          */
1739         public function out( $ins ) {
1740                 global $wgInputEncoding, $wgOutputEncoding, $wgContLang;
1741                 if ( 0 == strcmp( $wgInputEncoding, $wgOutputEncoding ) ) {
1742                         $outs = $ins;
1743                 } else {
1744                         $outs = $wgContLang->iconv( $wgInputEncoding, $wgOutputEncoding, $ins );
1745                         if ( false === $outs ) {
1746                                 $outs = $ins;
1747                         }
1748                 }
1749                 print $outs;
1750         }
1751
1752         /**
1753          * @todo document
1754          */
1755         public static function setEncodings() {
1756                 global $wgInputEncoding, $wgOutputEncoding;
1757
1758                 $wgInputEncoding = strtolower( $wgInputEncoding );
1759
1760                 if ( empty( $_SERVER['HTTP_ACCEPT_CHARSET'] ) ) {
1761                         $wgOutputEncoding = strtolower( $wgOutputEncoding );
1762                         return;
1763                 }
1764                 $wgOutputEncoding = $wgInputEncoding;
1765         }
1766
1767         /**
1768          * @deprecated use wfReportTime() instead.
1769          *
1770          * @return String
1771          */
1772         public function reportTime() {
1773                 wfDeprecated( __METHOD__ );
1774                 $time = wfReportTime();
1775                 return $time;
1776         }
1777
1778         /**
1779          * Produce a "user is blocked" page.
1780          *
1781          * @param $return Boolean: whether to have a "return to $wgTitle" message or not.
1782          * @return nothing
1783          */
1784         function blockedPage( $return = true ) {
1785                 global $wgUser, $wgContLang, $wgLang;
1786
1787                 $this->setPageTitle( wfMsg( 'blockedtitle' ) );
1788                 $this->setRobotPolicy( 'noindex,nofollow' );
1789                 $this->setArticleRelated( false );
1790
1791                 $name = User::whoIs( $wgUser->blockedBy() );
1792                 $reason = $wgUser->blockedFor();
1793                 if( $reason == '' ) {
1794                         $reason = wfMsg( 'blockednoreason' );
1795                 }
1796                 $blockTimestamp = $wgLang->timeanddate(
1797                         wfTimestamp( TS_MW, $wgUser->mBlock->mTimestamp ), true
1798                 );
1799                 $ip = wfGetIP();
1800
1801                 $link = '[[' . $wgContLang->getNsText( NS_USER ) . ":{$name}|{$name}]]";
1802
1803                 $blockid = $wgUser->mBlock->mId;
1804
1805                 $blockExpiry = $wgUser->mBlock->mExpiry;
1806                 if ( $blockExpiry == 'infinity' ) {
1807                         // Entry in database (table ipblocks) is 'infinity' but 'ipboptions' uses 'infinite' or 'indefinite'
1808                         // Search for localization in 'ipboptions'
1809                         $scBlockExpiryOptions = wfMsg( 'ipboptions' );
1810                         foreach ( explode( ',', $scBlockExpiryOptions ) as $option ) {
1811                                 if ( strpos( $option, ':' ) === false ) {
1812                                         continue;
1813                                 }
1814                                 list( $show, $value ) = explode( ':', $option );
1815                                 if ( $value == 'infinite' || $value == 'indefinite' ) {
1816                                         $blockExpiry = $show;
1817                                         break;
1818                                 }
1819                         }
1820                 } else {
1821                         $blockExpiry = $wgLang->timeanddate(
1822                                 wfTimestamp( TS_MW, $blockExpiry ),
1823                                 true
1824                         );
1825                 }
1826
1827                 if ( $wgUser->mBlock->mAuto ) {
1828                         $msg = 'autoblockedtext';
1829                 } else {
1830                         $msg = 'blockedtext';
1831                 }
1832
1833                 /* $ip returns who *is* being blocked, $intended contains who was meant to be blocked.
1834                  * This could be a username, an IP range, or a single IP. */
1835                 $intended = $wgUser->mBlock->mAddress;
1836
1837                 $this->addWikiMsg(
1838                         $msg, $link, $reason, $ip, $name, $blockid, $blockExpiry,
1839                         $intended, $blockTimestamp
1840                 );
1841
1842                 # Don't auto-return to special pages
1843                 if( $return ) {
1844                         $return = $this->getTitle()->getNamespace() > -1 ? $this->getTitle() : null;
1845                         $this->returnToMain( null, $return );
1846                 }
1847         }
1848
1849         /**
1850          * Output a standard error page
1851          *
1852          * @param $title String: message key for page title
1853          * @param $msg String: message key for page text
1854          * @param $params Array: message parameters
1855          */
1856         public function showErrorPage( $title, $msg, $params = array() ) {
1857                 if ( $this->getTitle() ) {
1858                         $this->mDebugtext .= 'Original title: ' . $this->getTitle()->getPrefixedText() . "\n";
1859                 }
1860                 $this->setPageTitle( wfMsg( $title ) );
1861                 $this->setHTMLTitle( wfMsg( 'errorpagetitle' ) );
1862                 $this->setRobotPolicy( 'noindex,nofollow' );
1863                 $this->setArticleRelated( false );
1864                 $this->enableClientCache( false );
1865                 $this->mRedirect = '';
1866                 $this->mBodytext = '';
1867
1868                 array_unshift( $params, 'parse' );
1869                 array_unshift( $params, $msg );
1870                 $this->addHTML( call_user_func_array( 'wfMsgExt', $params ) );
1871
1872                 $this->returnToMain();
1873         }
1874
1875         /**
1876          * Output a standard permission error page
1877          *
1878          * @param $errors Array: error message keys
1879          * @param $action String: action that was denied or null if unknown
1880          */
1881         public function showPermissionsErrorPage( $errors, $action = null ) {
1882                 $this->mDebugtext .= 'Original title: ' .
1883                 $this->getTitle()->getPrefixedText() . "\n";
1884                 $this->setPageTitle( wfMsg( 'permissionserrors' ) );
1885                 $this->setHTMLTitle( wfMsg( 'permissionserrors' ) );
1886                 $this->setRobotPolicy( 'noindex,nofollow' );
1887                 $this->setArticleRelated( false );
1888                 $this->enableClientCache( false );
1889                 $this->mRedirect = '';
1890                 $this->mBodytext = '';
1891                 $this->addWikiText( $this->formatPermissionsErrorMessage( $errors, $action ) );
1892         }
1893
1894         /**
1895          * Display an error page indicating that a given version of MediaWiki is
1896          * required to use it
1897          *
1898          * @param $version Mixed: the version of MediaWiki needed to use the page
1899          */
1900         public function versionRequired( $version ) {
1901                 $this->setPageTitle( wfMsg( 'versionrequired', $version ) );
1902                 $this->setHTMLTitle( wfMsg( 'versionrequired', $version ) );
1903                 $this->setRobotPolicy( 'noindex,nofollow' );
1904                 $this->setArticleRelated( false );
1905                 $this->mBodytext = '';
1906
1907                 $this->addWikiMsg( 'versionrequiredtext', $version );
1908                 $this->returnToMain();
1909         }
1910
1911         /**
1912          * Display an error page noting that a given permission bit is required.
1913          *
1914          * @param $permission String: key required
1915          */
1916         public function permissionRequired( $permission ) {
1917                 global $wgLang;
1918
1919                 $this->setPageTitle( wfMsg( 'badaccess' ) );
1920                 $this->setHTMLTitle( wfMsg( 'errorpagetitle' ) );
1921                 $this->setRobotPolicy( 'noindex,nofollow' );
1922                 $this->setArticleRelated( false );
1923                 $this->mBodytext = '';
1924
1925                 $groups = array_map( array( 'User', 'makeGroupLinkWiki' ),
1926                         User::getGroupsWithPermission( $permission ) );
1927                 if( $groups ) {
1928                         $this->addWikiMsg(
1929                                 'badaccess-groups',
1930                                 $wgLang->commaList( $groups ),
1931                                 count( $groups )
1932                         );
1933                 } else {
1934                         $this->addWikiMsg( 'badaccess-group0' );
1935                 }
1936                 $this->returnToMain();
1937         }
1938
1939         /**
1940          * Produce the stock "please login to use the wiki" page
1941          */
1942         public function loginToUse() {
1943                 global $wgUser, $wgRequest;
1944
1945                 if( $wgUser->isLoggedIn() ) {
1946                         $this->permissionRequired( 'read' );
1947                         return;
1948                 }
1949
1950                 $skin = $wgUser->getSkin();
1951
1952                 $this->setPageTitle( wfMsg( 'loginreqtitle' ) );
1953                 $this->setHtmlTitle( wfMsg( 'errorpagetitle' ) );
1954                 $this->setRobotPolicy( 'noindex,nofollow' );
1955                 $this->setArticleFlag( false );
1956
1957                 $returnto = Title::newFromURL( $wgRequest->getVal( 'title', '' ) );
1958                 $returntoquery = array();
1959                 if( $returnto ) {
1960                         $returntoquery = array( 'returnto' => $returnto->getPrefixedText() );
1961                 }
1962
1963                 $loginTitle = SpecialPage::getTitleFor( 'Userlogin' );
1964                 $loginLink = $skin->link(
1965                         $loginTitle,
1966                         wfMsgHtml( 'loginreqlink' ),
1967                         array(),
1968                         $returntoquery,
1969                         array( 'known', 'noclasses' )
1970                 );
1971                 $this->addHTML( wfMsgWikiHtml( 'loginreqpagetext', $loginLink ) );
1972                 $this->addHTML( "\n<!--" . $this->getTitle()->getPrefixedUrl() . '-->' );
1973
1974                 # Don't return to the main page if the user can't read it
1975                 # otherwise we'll end up in a pointless loop
1976                 $mainPage = Title::newMainPage();
1977                 if( $mainPage->userCanRead() ) {
1978                         $this->returnToMain( null, $mainPage );
1979                 }
1980         }
1981
1982         /**
1983          * Format a list of error messages
1984          *
1985          * @param $errors An array of arrays returned by Title::getUserPermissionsErrors
1986          * @param $action String: action that was denied or null if unknown
1987          * @return String: the wikitext error-messages, formatted into a list.
1988          */
1989         public function formatPermissionsErrorMessage( $errors, $action = null ) {
1990                 if ( $action == null ) {
1991                         $text = wfMsgNoTrans( 'permissionserrorstext', count( $errors ) ) . "\n\n";
1992                 } else {
1993                         $action_desc = wfMsgNoTrans( "action-$action" );
1994                         $text = wfMsgNoTrans(
1995                                 'permissionserrorstext-withaction',
1996                                 count( $errors ),
1997                                 $action_desc
1998                         ) . "\n\n";
1999                 }
2000
2001                 if ( count( $errors ) > 1 ) {
2002                         $text .= '<ul class="permissions-errors">' . "\n";
2003
2004                         foreach( $errors as $error ) {
2005                                 $text .= '<li>';
2006                                 $text .= call_user_func_array( 'wfMsgNoTrans', $error );
2007                                 $text .= "</li>\n";
2008                         }
2009                         $text .= '</ul>';
2010                 } else {
2011                         $text .= "<div class=\"permissions-errors\">\n" .
2012                                         call_user_func_array( 'wfMsgNoTrans', reset( $errors ) ) .
2013                                         "\n</div>";
2014                 }
2015
2016                 return $text;
2017         }
2018
2019         /**
2020          * Display a page stating that the Wiki is in read-only mode,
2021          * and optionally show the source of the page that the user
2022          * was trying to edit.  Should only be called (for this
2023          * purpose) after wfReadOnly() has returned true.
2024          *
2025          * For historical reasons, this function is _also_ used to
2026          * show the error message when a user tries to edit a page
2027          * they are not allowed to edit.  (Unless it's because they're
2028          * blocked, then we show blockedPage() instead.)  In this
2029          * case, the second parameter should be set to true and a list
2030          * of reasons supplied as the third parameter.
2031          *
2032          * @todo Needs to be split into multiple functions.
2033          *
2034          * @param $source    String: source code to show (or null).
2035          * @param $protected Boolean: is this a permissions error?
2036          * @param $reasons   Array: list of reasons for this error, as returned by Title::getUserPermissionsErrors().
2037          * @param $action    String: action that was denied or null if unknown
2038          */
2039         public function readOnlyPage( $source = null, $protected = false, $reasons = array(), $action = null ) {
2040                 global $wgUser;
2041                 $skin = $wgUser->getSkin();
2042
2043                 $this->setRobotPolicy( 'noindex,nofollow' );
2044                 $this->setArticleRelated( false );
2045
2046                 // If no reason is given, just supply a default "I can't let you do
2047                 // that, Dave" message.  Should only occur if called by legacy code.
2048                 if ( $protected && empty( $reasons ) ) {
2049                         $reasons[] = array( 'badaccess-group0' );
2050                 }
2051
2052                 if ( !empty( $reasons ) ) {
2053                         // Permissions error
2054                         if( $source ) {
2055                                 $this->setPageTitle( wfMsg( 'viewsource' ) );
2056                                 $this->setSubtitle(
2057                                         wfMsg( 'viewsourcefor', $skin->linkKnown( $this->getTitle() ) )
2058                                 );
2059                         } else {
2060                                 $this->setPageTitle( wfMsg( 'badaccess' ) );
2061                         }
2062                         $this->addWikiText( $this->formatPermissionsErrorMessage( $reasons, $action ) );
2063                 } else {
2064                         // Wiki is read only
2065                         $this->setPageTitle( wfMsg( 'readonly' ) );
2066                         $reason = wfReadOnlyReason();
2067                         $this->wrapWikiMsg( "<div class='mw-readonly-error'>\n$1\n</div>", array( 'readonlytext', $reason ) );
2068                 }
2069
2070                 // Show source, if supplied
2071                 if( is_string( $source ) ) {
2072                         $this->addWikiMsg( 'viewsourcetext' );
2073
2074                         $params = array(
2075                                 'id'   => 'wpTextbox1',
2076                                 'name' => 'wpTextbox1',
2077                                 'cols' => $wgUser->getOption( 'cols' ),
2078                                 'rows' => $wgUser->getOption( 'rows' ),
2079                                 'readonly' => 'readonly'
2080                         );
2081                         $this->addHTML( Html::element( 'textarea', $params, $source ) );
2082
2083                         // Show templates used by this article
2084                         $skin = $wgUser->getSkin();
2085                         $article = new Article( $this->getTitle() );
2086                         $this->addHTML( "<div class='templatesUsed'>
2087 {$skin->formatTemplates( $article->getUsedTemplates() )}
2088 </div>
2089 " );
2090                 }
2091
2092                 # If the title doesn't exist, it's fairly pointless to print a return
2093                 # link to it.  After all, you just tried editing it and couldn't, so
2094                 # what's there to do there?
2095                 if( $this->getTitle()->exists() ) {
2096                         $this->returnToMain( null, $this->getTitle() );
2097                 }
2098         }
2099
2100         /** @deprecated */
2101         public function errorpage( $title, $msg ) {
2102                 wfDeprecated( __METHOD__ );
2103                 throw new ErrorPageError( $title, $msg );
2104         }
2105
2106         /** @deprecated */
2107         public function databaseError( $fname, $sql, $error, $errno ) {
2108                 throw new MWException( "OutputPage::databaseError is obsolete\n" );
2109         }
2110
2111         /** @deprecated */
2112         public function fatalError( $message ) {
2113                 wfDeprecated( __METHOD__ );
2114                 throw new FatalError( $message );
2115         }
2116
2117         /** @deprecated */
2118         public function unexpectedValueError( $name, $val ) {
2119                 wfDeprecated( __METHOD__ );
2120                 throw new FatalError( wfMsg( 'unexpected', $name, $val ) );
2121         }
2122
2123         /** @deprecated */
2124         public function fileCopyError( $old, $new ) {
2125                 wfDeprecated( __METHOD__ );
2126                 throw new FatalError( wfMsg( 'filecopyerror', $old, $new ) );
2127         }
2128
2129         /** @deprecated */
2130         public function fileRenameError( $old, $new ) {
2131                 wfDeprecated( __METHOD__ );
2132                 throw new FatalError( wfMsg( 'filerenameerror', $old, $new ) );
2133         }
2134
2135         /** @deprecated */
2136         public function fileDeleteError( $name ) {
2137                 wfDeprecated( __METHOD__ );
2138                 throw new FatalError( wfMsg( 'filedeleteerror', $name ) );
2139         }
2140
2141         /** @deprecated */
2142         public function fileNotFoundError( $name ) {
2143                 wfDeprecated( __METHOD__ );
2144                 throw new FatalError( wfMsg( 'filenotfound', $name ) );
2145         }
2146
2147         public function showFatalError( $message ) {
2148                 $this->setPageTitle( wfMsg( 'internalerror' ) );
2149                 $this->setRobotPolicy( 'noindex,nofollow' );
2150                 $this->setArticleRelated( false );
2151                 $this->enableClientCache( false );
2152                 $this->mRedirect = '';
2153                 $this->mBodytext = $message;
2154         }
2155
2156         public function showUnexpectedValueError( $name, $val ) {
2157                 $this->showFatalError( wfMsg( 'unexpected', $name, $val ) );
2158         }
2159
2160         public function showFileCopyError( $old, $new ) {
2161                 $this->showFatalError( wfMsg( 'filecopyerror', $old, $new ) );
2162         }
2163
2164         public function showFileRenameError( $old, $new ) {
2165                 $this->showFatalError( wfMsg( 'filerenameerror', $old, $new ) );
2166         }
2167
2168         public function showFileDeleteError( $name ) {
2169                 $this->showFatalError( wfMsg( 'filedeleteerror', $name ) );
2170         }
2171
2172         public function showFileNotFoundError( $name ) {
2173                 $this->showFatalError( wfMsg( 'filenotfound', $name ) );
2174         }
2175
2176         /**
2177          * Add a "return to" link pointing to a specified title
2178          *
2179          * @param $title Title to link
2180          * @param $query String: query string
2181          * @param $text String text of the link (input is not escaped)
2182          */
2183         public function addReturnTo( $title, $query = array(), $text = null ) {
2184                 global $wgUser;
2185                 $this->addLink( array( 'rel' => 'next', 'href' => $title->getFullURL() ) );
2186                 $link = wfMsgHtml(
2187                         'returnto',
2188                         $wgUser->getSkin()->link( $title, $text, array(), $query )
2189                 );
2190                 $this->addHTML( "<p id=\"mw-returnto\">{$link}</p>\n" );
2191         }
2192
2193         /**
2194          * Add a "return to" link pointing to a specified title,
2195          * or the title indicated in the request, or else the main page
2196          *
2197          * @param $unused No longer used
2198          * @param $returnto Title or String to return to
2199          * @param $returntoquery String: query string for the return to link
2200          */
2201         public function returnToMain( $unused = null, $returnto = null, $returntoquery = null ) {
2202                 global $wgRequest;
2203
2204                 if ( $returnto == null ) {
2205                         $returnto = $wgRequest->getText( 'returnto' );
2206                 }
2207
2208                 if ( $returntoquery == null ) {
2209                         $returntoquery = $wgRequest->getText( 'returntoquery' );
2210                 }
2211
2212                 if ( $returnto === '' ) {
2213                         $returnto = Title::newMainPage();
2214                 }
2215
2216                 if ( is_object( $returnto ) ) {
2217                         $titleObj = $returnto;
2218                 } else {
2219                         $titleObj = Title::newFromText( $returnto );
2220                 }
2221                 if ( !is_object( $titleObj ) ) {
2222                         $titleObj = Title::newMainPage();
2223                 }
2224
2225                 $this->addReturnTo( $titleObj, $returntoquery );
2226         }
2227
2228         /**
2229          * @param $sk Skin The given Skin
2230          * @param $includeStyle Boolean: unused
2231          * @return String: The doctype, opening <html>, and head element.
2232          */
2233         public function headElement( Skin $sk, $includeStyle = true ) {
2234                 global $wgOutputEncoding, $wgMimeType;
2235                 global $wgUseTrackbacks, $wgHtml5;
2236                 global $wgUser, $wgRequest, $wgLang;
2237
2238                 if ( $sk->commonPrintStylesheet() ) {
2239                         $this->addModuleStyles( 'mediawiki.legacy.wikiprintable' );
2240                 }
2241                 $sk->setupUserCss( $this );
2242
2243                 $lang = wfUILang();
2244                 $ret = Html::htmlHeader( array( 'lang' => $lang->getCode(), 'dir' => $lang->getDir() ) );
2245
2246                 if ( $this->getHTMLTitle() == '' ) {
2247                         $this->setHTMLTitle( wfMsg( 'pagetitle', $this->getPageTitle() ) );
2248                 }
2249
2250                 $openHead = Html::openElement( 'head' );
2251                 if ( $openHead ) {
2252                         # Don't bother with the newline if $head == ''
2253                         $ret .= "$openHead\n";
2254                 }
2255
2256                 if ( $wgHtml5 ) {
2257                         # More succinct than <meta http-equiv=Content-Type>, has the
2258                         # same effect
2259                         $ret .= Html::element( 'meta', array( 'charset' => $wgOutputEncoding ) ) . "\n";
2260                 } else {
2261                         $this->addMeta( 'http:Content-Type', "$wgMimeType; charset=$wgOutputEncoding" );
2262                 }
2263
2264                 $ret .= Html::element( 'title', null, $this->getHTMLTitle() ) . "\n";
2265
2266                 $ret .= implode( "\n", array(
2267                         $this->getHeadLinks( $sk ),
2268                         $this->buildCssLinks( $sk ),
2269                         $this->getHeadItems()
2270                 ) );
2271
2272                 if ( $wgUseTrackbacks && $this->isArticleRelated() ) {
2273                         $ret .= $this->getTitle()->trackbackRDF();
2274                 }
2275
2276                 $closeHead = Html::closeElement( 'head' );
2277                 if ( $closeHead ) {
2278                         $ret .= "$closeHead\n";
2279                 }
2280
2281                 $bodyAttrs = array();
2282
2283                 # Crazy edit-on-double-click stuff
2284                 $action = $wgRequest->getVal( 'action', 'view' );
2285
2286                 if (
2287                         $this->getTitle()->getNamespace() != NS_SPECIAL &&
2288                         !in_array( $action, array( 'edit', 'submit' ) ) &&
2289                         $wgUser->getOption( 'editondblclick' )
2290                 )
2291                 {
2292                         $editUrl = $this->getTitle()->getLocalUrl( $sk->editUrlOptions() );
2293                         $bodyAttrs['ondblclick'] = "document.location = '" .
2294                                 Xml::escapeJsString( $editUrl ) . "'";
2295                 }
2296
2297                 # Class bloat
2298                 $dir = wfUILang()->getDir();
2299                 $bodyAttrs['class'] = "mediawiki $dir";
2300
2301                 if ( $wgLang->capitalizeAllNouns() ) {
2302                         # A <body> class is probably not the best way to do this . . .
2303                         $bodyAttrs['class'] .= ' capitalize-all-nouns';
2304                 }
2305                 $bodyAttrs['class'] .= ' ns-' . $this->getTitle()->getNamespace();
2306                 if ( $this->getTitle()->getNamespace() == NS_SPECIAL ) {
2307                         $bodyAttrs['class'] .= ' ns-special';
2308                 } elseif ( $this->getTitle()->isTalkPage() ) {
2309                         $bodyAttrs['class'] .= ' ns-talk';
2310                 } else {
2311                         $bodyAttrs['class'] .= ' ns-subject';
2312                 }
2313                 $bodyAttrs['class'] .= ' ' . Sanitizer::escapeClass( 'page-' . $this->getTitle()->getPrefixedText() );
2314                 $bodyAttrs['class'] .= ' skin-' . Sanitizer::escapeClass( $wgUser->getSkin()->getSkinName() );
2315
2316                 $sk->addToBodyAttributes( $this, $bodyAttrs ); // Allow skins to add body attributes they need
2317                 wfRunHooks( 'OutputPageBodyAttributes', array( $this, $sk, &$bodyAttrs ) );
2318
2319                 $ret .= Html::openElement( 'body', $bodyAttrs ) . "\n";
2320
2321                 return $ret;
2322         }
2323
2324         /**
2325          * Get a ResourceLoader object associated with this OutputPage
2326          */
2327         public function getResourceLoader() {
2328                 if ( is_null( $this->mResourceLoader ) ) {
2329                         $this->mResourceLoader = new ResourceLoader();
2330                 }
2331                 return $this->mResourceLoader;
2332         }
2333
2334         /**
2335          * TODO: Document
2336          * @param $skin Skin
2337          * @param $modules Array/string with the module name
2338          * @param $only string May be styles, messages or scripts
2339          * @param $useESI boolean
2340          * @return string html <script> and <style> tags
2341          */
2342         protected function makeResourceLoaderLink( Skin $skin, $modules, $only, $useESI = false ) {
2343                 global $wgUser, $wgLang, $wgLoadScript, $wgResourceLoaderUseESI, $wgRequest;
2344                 // Lazy-load ResourceLoader
2345                 // TODO: Should this be a static function of ResourceLoader instead?
2346                 $baseQuery = array(
2347                         'lang' => $wgLang->getCode(),
2348                         'debug' => ResourceLoader::inDebugMode() ? 'true' : 'false',
2349                         'skin' => $skin->getSkinName(),
2350                         'only' => $only,
2351                 );
2352                 // Propagate printable and handheld parameters if present
2353                 if ( $wgRequest->getBool( 'printable' ) ) {
2354                         $baseQuery['printable'] = 1;
2355                 }
2356                 if ( $wgRequest->getBool( 'handheld' ) ) {
2357                         $baseQuery['handheld'] = 1;
2358                 }
2359
2360                 if ( !count( $modules ) ) {
2361                         return '';
2362                 }
2363
2364                 if ( count( $modules ) > 1 ) {
2365                         // Remove duplicate module requests
2366                         $modules = array_unique( (array) $modules );
2367                         // Sort module names so requests are more uniform
2368                         sort( $modules );
2369
2370                         if ( ResourceLoader::inDebugMode() ) {
2371                                 // Recursively call us for every item
2372                                 $links = '';
2373                                 foreach ( $modules as $name ) {
2374                                         $links .= $this->makeResourceLoaderLink( $skin, $name, $only, $useESI );
2375                                 }
2376                                 return $links;
2377                         }
2378                 }
2379
2380                 // Create keyed-by-group list of module objects from modules list
2381                 $groups = array();
2382                 $resourceLoader = $this->getResourceLoader();
2383                 foreach ( (array) $modules as $name ) {
2384                         $module = $resourceLoader->getModule( $name );
2385
2386                         $group = $module->getGroup();
2387                         if ( !isset( $groups[$group] ) ) {
2388                                 $groups[$group] = array();
2389                         }
2390                         $groups[$group][$name] = $module;
2391                 }
2392                 $links = '';
2393                 foreach ( $groups as $group => $modules ) {
2394                         $query = $baseQuery;
2395                         // Special handling for user-specific groups
2396                         if ( ( $group === 'user' || $group === 'private' ) && $wgUser->isLoggedIn() ) {
2397                                 $query['user'] = $wgUser->getName();
2398                         }
2399
2400                         // Create a fake request based on the one we are about to make so modules return
2401                         // correct timestamp and emptiness data
2402                         $context = new ResourceLoaderContext( $resourceLoader, new FauxRequest( $query ) );
2403                         // Drop modules that know they're empty
2404                         foreach ( $modules as $key => $module ) {
2405                                 if ( $module->isKnownEmpty( $context ) ) {
2406                                         unset( $modules[$key] );
2407                                 }
2408                         }
2409                         // If there are no modules left, skip this group
2410                         if ( $modules === array() ) {
2411                                 continue;
2412                         }
2413
2414                         $query['modules'] = ResourceLoader::makePackedModulesString( array_keys( $modules ) );
2415
2416                         // Inline private modules. These can't be loaded through load.php for security
2417                         // reasons, see bug 34907. Note that these modules should be loaded from
2418                         // getHeadScripts() before the first loader call. Otherwise other modules can't
2419                         // properly use them as dependencies (bug 30914)
2420                         if ( $group === 'private' ) {
2421                                 if ( $only == 'styles' ) {
2422                                         $links .= Html::inlineStyle(
2423                                                 $resourceLoader->makeModuleResponse( $context, $modules )
2424                                         );
2425                                 } else {
2426                                         $links .= Html::inlineScript(
2427                                                 ResourceLoader::makeLoaderConditionalScript(
2428                                                         $resourceLoader->makeModuleResponse( $context, $modules )
2429                                                 )
2430                                         );
2431                                 }
2432                                 continue;
2433                         }
2434                         // Special handling for the user group; because users might change their stuff
2435                         // on-wiki like user pages, or user preferences; we need to find the highest
2436                         // timestamp of these user-changable modules so we can ensure cache misses on change
2437                         // This should NOT be done for the site group (bug 27564) because anons get that too
2438                         // and we shouldn't be putting timestamps in Squid-cached HTML
2439                         if ( $group === 'user' ) {
2440                                 // Get the maximum timestamp
2441                                 $timestamp = 1;
2442                                 foreach ( $modules as $module ) {
2443                                         $timestamp = max( $timestamp, $module->getModifiedTime( $context ) );
2444                                 }
2445                                 // Add a version parameter so cache will break when things change
2446                                 $query['version'] = wfTimestamp( TS_ISO_8601_BASIC, $timestamp );
2447                         }
2448                         // Make queries uniform in order
2449                         ksort( $query );
2450
2451                         $url = wfAppendQuery( $wgLoadScript, $query );
2452                         // Prevent the IE6 extension check from being triggered (bug 28840)
2453                         // by appending a character that's invalid in Windows extensions ('*')
2454                         $url .= '&*';
2455                         if ( $useESI && $wgResourceLoaderUseESI ) {
2456                                 $esi = Xml::element( 'esi:include', array( 'src' => $url ) );
2457                                 if ( $only == 'styles' ) {
2458                                         $links .= Html::inlineStyle( $esi );
2459                                 } else {
2460                                         $links .= Html::inlineScript( $esi );
2461                                 }
2462                         } else {
2463                                 // Automatically select style/script elements
2464                                 if ( $only === 'styles' ) {
2465                                         $links .= Html::linkedStyle( $url ) . "\n";
2466                                 } else {
2467                                         $links .= Html::linkedScript( $url ) . "\n";
2468                                 }
2469                         }
2470                 }
2471                 return $links;
2472         }
2473
2474         /**
2475          * Gets the global variables and mScripts; also adds userjs to the end if
2476          * enabled. Despite the name, these scripts are no longer put in the
2477          * <head> but at the bottom of the <body>
2478          *
2479          * @param $sk Skin object to use
2480          * @return String: HTML fragment
2481          */
2482         function getHeadScripts( Skin $sk ) {
2483                 global $wgUser, $wgRequest, $wgUseSiteJs;
2484
2485                 // Startup - this will immediately load jquery and mediawiki modules
2486                 $scripts = $this->makeResourceLoaderLink( $sk, 'startup', 'scripts', true );
2487
2488                 // Configuration -- This could be merged together with the load and go, but
2489                 // makeGlobalVariablesScript returns a whole script tag -- grumble grumble...
2490                 $scripts .= Skin::makeGlobalVariablesScript( $sk->getSkinName() ) . "\n";
2491
2492                 // Script and Messages "only" requests
2493                 $scripts .= $this->makeResourceLoaderLink( $sk, $this->getModuleScripts(), 'scripts' );
2494                 $scripts .= $this->makeResourceLoaderLink( $sk, $this->getModuleMessages(), 'messages' );
2495
2496                 // Modules requests - let the client calculate dependencies and batch requests as it likes
2497                 if ( $this->getModules() ) {
2498                         $scripts .= Html::inlineScript(
2499                                 ResourceLoader::makeLoaderConditionalScript(
2500                                         Xml::encodeJsCall( 'mediaWiki.loader.load', array( $this->getModules() ) ) .
2501                                         Xml::encodeJsCall( 'mediaWiki.loader.go', array() )
2502                                 )
2503                         ) . "\n";
2504                 }
2505
2506                 // Legacy Scripts
2507                 $scripts .= "\n" . $this->mScripts;
2508
2509                 // Add site JS if enabled
2510                 if ( $wgUseSiteJs ) {
2511                         $scripts .= $this->makeResourceLoaderLink( $sk, 'site', 'scripts' );
2512                 }
2513
2514                 // Add user JS if enabled - trying to load user.options as a bundle if possible
2515                 $userOptionsAdded = false;
2516                 if ( $this->isUserJsAllowed() && $wgUser->isLoggedIn() ) {
2517                         $action = $wgRequest->getVal( 'action', 'view' );
2518                         if( $this->mTitle && $this->mTitle->isJsSubpage() && $sk->userCanPreview( $action ) ) {
2519                                 # XXX: additional security check/prompt?
2520                                 $scripts .= Html::inlineScript( "\n" . $wgRequest->getText( 'wpTextbox1' ) . "\n" ) . "\n";
2521                         } else {
2522                                 $scripts .= $this->makeResourceLoaderLink(
2523                                         $sk, array( 'user', 'user.options' ), 'scripts'
2524                                 );
2525                                 $userOptionsAdded = true;
2526                         }
2527                 }
2528                 if ( !$userOptionsAdded ) {
2529                         $scripts .= $this->makeResourceLoaderLink( $sk, 'user.options', 'scripts' );
2530                 }
2531
2532                 return $scripts;
2533         }
2534
2535         /**
2536          * Add default \<meta\> tags
2537          */
2538         protected function addDefaultMeta() {
2539                 global $wgVersion, $wgHtml5;
2540
2541                 static $called = false;
2542                 if ( $called ) {
2543                         # Don't run this twice
2544                         return;
2545                 }
2546                 $called = true;
2547
2548                 if ( !$wgHtml5 ) {
2549                         $this->addMeta( 'http:Content-Style-Type', 'text/css' ); // bug 15835
2550                 }
2551                 $this->addMeta( 'generator', "MediaWiki $wgVersion" );
2552
2553                 $p = "{$this->mIndexPolicy},{$this->mFollowPolicy}";
2554                 if( $p !== 'index,follow' ) {
2555                         // http://www.robotstxt.org/wc/meta-user.html
2556                         // Only show if it's different from the default robots policy
2557                         $this->addMeta( 'robots', $p );
2558                 }
2559
2560                 if ( count( $this->mKeywords ) > 0 ) {
2561                         $strip = array(
2562                                 "/<.*?" . ">/" => '',
2563                                 "/_/" => ' '
2564                         );
2565                         $this->addMeta(
2566                                 'keywords',
2567                                 preg_replace(
2568                                         array_keys( $strip ),
2569                                         array_values( $strip ),
2570                                         implode( ',', $this->mKeywords )
2571                                 )
2572                         );
2573                 }
2574         }
2575
2576         /**
2577          * @return string HTML tag links to be put in the header.
2578          */
2579         public function getHeadLinks( Skin $sk ) {
2580                 global $wgFeed;
2581
2582                 // Ideally this should happen earlier, somewhere. :P
2583                 $this->addDefaultMeta();
2584
2585                 $tags = array();
2586
2587                 foreach ( $this->mMetatags as $tag ) {
2588                         if ( 0 == strcasecmp( 'http:', substr( $tag[0], 0, 5 ) ) ) {
2589                                 $a = 'http-equiv';
2590                                 $tag[0] = substr( $tag[0], 5 );
2591                         } else {
2592                                 $a = 'name';
2593                         }
2594                         $tags[] = Html::element( 'meta',
2595                                 array(
2596                                         $a => $tag[0],
2597                                         'content' => $tag[1]
2598                                 )
2599                         );
2600                 }
2601                 foreach ( $this->mLinktags as $tag ) {
2602                         $tags[] = Html::element( 'link', $tag );
2603                 }
2604
2605                 if( $wgFeed ) {
2606                         foreach( $this->getSyndicationLinks() as $format => $link ) {
2607                                 # Use the page name for the title (accessed through $wgTitle since
2608                                 # there's no other way).  In principle, this could lead to issues
2609                                 # with having the same name for different feeds corresponding to
2610                                 # the same page, but we can't avoid that at this low a level.
2611
2612                                 $tags[] = $this->feedLink(
2613                                         $format,
2614                                         $link,
2615                                         # Used messages: 'page-rss-feed' and 'page-atom-feed' (for an easier grep)
2616                                         wfMsg( "page-{$format}-feed", $this->getTitle()->getPrefixedText() )
2617                                 );
2618                         }
2619
2620                         # Recent changes feed should appear on every page (except recentchanges,
2621                         # that would be redundant). Put it after the per-page feed to avoid
2622                         # changing existing behavior. It's still available, probably via a
2623                         # menu in your browser. Some sites might have a different feed they'd
2624                         # like to promote instead of the RC feed (maybe like a "Recent New Articles"
2625                         # or "Breaking news" one). For this, we see if $wgOverrideSiteFeed is defined.
2626                         # If so, use it instead.
2627
2628                         global $wgOverrideSiteFeed, $wgSitename, $wgAdvertisedFeedTypes;
2629                         $rctitle = SpecialPage::getTitleFor( 'Recentchanges' );
2630
2631                         if ( $wgOverrideSiteFeed ) {
2632                                 foreach ( $wgOverrideSiteFeed as $type => $feedUrl ) {
2633                                         $tags[] = $this->feedLink(
2634                                                 $type,
2635                                                 htmlspecialchars( $feedUrl ),
2636                                                 wfMsg( "site-{$type}-feed", $wgSitename )
2637                                         );
2638                                 }
2639                         } elseif ( $this->getTitle()->getPrefixedText() != $rctitle->getPrefixedText() ) {
2640                                 foreach ( $wgAdvertisedFeedTypes as $format ) {
2641                                         $tags[] = $this->feedLink(
2642                                                 $format,
2643                                                 $rctitle->getLocalURL( "feed={$format}" ),
2644                                                 wfMsg( "site-{$format}-feed", $wgSitename ) # For grep: 'site-rss-feed', 'site-atom-feed'.
2645                                         );
2646                                 }
2647                         }
2648                 }
2649
2650                 return implode( "\n", $tags );
2651         }
2652
2653         /**
2654          * Generate a <link rel/> for a feed.
2655          *
2656          * @param $type String: feed type
2657          * @param $url String: URL to the feed
2658          * @param $text String: value of the "title" attribute
2659          * @return String: HTML fragment
2660          */
2661         private function feedLink( $type, $url, $text ) {
2662                 return Html::element( 'link', array(
2663                         'rel' => 'alternate',
2664                         'type' => "application/$type+xml",
2665                         'title' => $text,
2666                         'href' => $url )
2667                 );
2668         }
2669
2670         /**
2671          * Add a local or specified stylesheet, with the given media options.
2672          * Meant primarily for internal use...
2673          *
2674          * @param $style String: URL to the file
2675          * @param $media String: to specify a media type, 'screen', 'printable', 'handheld' or any.
2676          * @param $condition String: for IE conditional comments, specifying an IE version
2677          * @param $dir String: set to 'rtl' or 'ltr' for direction-specific sheets
2678          */
2679         public function addStyle( $style, $media = '', $condition = '', $dir = '' ) {
2680                 $options = array();
2681                 // Even though we expect the media type to be lowercase, but here we
2682                 // force it to lowercase to be safe.
2683                 if( $media ) {
2684                         $options['media'] = $media;
2685                 }
2686                 if( $condition ) {
2687                         $options['condition'] = $condition;
2688                 }
2689                 if( $dir ) {
2690                         $options['dir'] = $dir;
2691                 }
2692                 $this->styles[$style] = $options;
2693         }
2694
2695         /**
2696          * Adds inline CSS styles
2697          * @param $style_css Mixed: inline CSS
2698          */
2699         public function addInlineStyle( $style_css ){
2700                 $this->mInlineStyles .= Html::inlineStyle( $style_css );
2701         }
2702
2703         /**
2704          * Build a set of <link>s for the stylesheets specified in the $this->styles array.
2705          * These will be applied to various media & IE conditionals.
2706          * @param $sk Skin object
2707          */
2708         public function buildCssLinks( $sk ) {
2709                 $ret = '';
2710                 // Add ResourceLoader styles
2711                 // Split the styles into four groups
2712                 $styles = array( 'other' => array(), 'user' => array(), 'site' => array(), 'private' => array() );
2713                 $resourceLoader = $this->getResourceLoader();
2714                 foreach ( $this->getModuleStyles() as $name ) {
2715                         $group = $resourceLoader->getModule( $name )->getGroup();
2716                         // Modules in groups named "other" or anything different than "user", "site" or "private"
2717                         // will be placed in the "other" group
2718                         $styles[isset( $styles[$group] ) ? $group : 'other'][] = $name;
2719                 }
2720
2721                 // We want site, private and user styles to override dynamically added styles from modules, but we want
2722                 // dynamically added styles to override statically added styles from other modules. So the order
2723                 // has to be other, dynamic, site, private, user
2724                 // Add statically added styles for other modules
2725                 $ret .= $this->makeResourceLoaderLink( $sk, $styles['other'], 'styles' );
2726                 // Add normal styles added through addStyle()/addInlineStyle() here
2727                 $ret .= implode( "\n", $this->buildCssLinksArray() ) . $this->mInlineStyles;
2728                 // Add marker tag to mark the place where the client-side loader should inject dynamic styles
2729                 // We use a <meta> tag with a made-up name for this because that's valid HTML
2730                 $ret .= Html::element( 'meta', array( 'name' => 'ResourceLoaderDynamicStyles', 'content' => '' ) );
2731
2732                 // Add site, private and user styles
2733                 // 'private' at present only contains user.options, so put that before 'user'
2734                 // Any future private modules will likely have a similar user-specific character
2735                 foreach ( array( 'site', 'private', 'user' ) as $group ) {
2736                         $ret .= $this->makeResourceLoaderLink(
2737                                 $sk, array_merge( $styles['site'], $styles['user'] ), 'styles'
2738                         );
2739                 }
2740                 return $ret;
2741         }
2742
2743         public function buildCssLinksArray() {
2744                 $links = array();
2745                 foreach( $this->styles as $file => $options ) {
2746                         $link = $this->styleLink( $file, $options );
2747                         if( $link ) {
2748                                 $links[$file] = $link;
2749                         }
2750                 }
2751                 return $links;
2752         }
2753
2754         /**
2755          * Generate \<link\> tags for stylesheets
2756          *
2757          * @param $style String: URL to the file
2758          * @param $options Array: option, can contain 'condition', 'dir', 'media'
2759          *                 keys
2760          * @return String: HTML fragment
2761          */
2762         protected function styleLink( $style, $options ) {
2763                 if( isset( $options['dir'] ) ) {
2764                         $siteDir = wfUILang()->getDir();
2765                         if( $siteDir != $options['dir'] ) {
2766                                 return '';
2767                         }
2768                 }
2769
2770                 if( isset( $options['media'] ) ) {
2771                         $media = self::transformCssMedia( $options['media'] );
2772                         if( is_null( $media ) ) {
2773                                 return '';
2774                         }
2775                 } else {
2776                         $media = 'all';
2777                 }
2778
2779                 if( substr( $style, 0, 1 ) == '/' ||
2780                         substr( $style, 0, 5 ) == 'http:' ||
2781                         substr( $style, 0, 6 ) == 'https:' ) {
2782                         $url = $style;
2783                 } else {
2784                         global $wgStylePath, $wgStyleVersion;
2785                         $url = $wgStylePath . '/' . $style . '?' . $wgStyleVersion;
2786                 }
2787
2788                 $link = Html::linkedStyle( $url, $media );
2789
2790                 if( isset( $options['condition'] ) ) {
2791                         $condition = htmlspecialchars( $options['condition'] );
2792                         $link = "<!--[if $condition]>$link<![endif]-->";
2793                 }
2794                 return $link;
2795         }
2796
2797         /**
2798          * Transform "media" attribute based on request parameters
2799          *
2800          * @param $media String: current value of the "media" attribute
2801          * @return String: modified value of the "media" attribute
2802          */
2803         public static function transformCssMedia( $media ) {
2804                 global $wgRequest, $wgHandheldForIPhone;
2805
2806                 // Switch in on-screen display for media testing
2807                 $switches = array(
2808                         'printable' => 'print',
2809                         'handheld' => 'handheld',
2810                 );
2811                 foreach( $switches as $switch => $targetMedia ) {
2812                         if( $wgRequest->getBool( $switch ) ) {
2813                                 if( $media == $targetMedia ) {
2814                                         $media = '';
2815                                 } elseif( $media == 'screen' ) {
2816                                         return null;
2817                                 }
2818                         }
2819                 }
2820
2821                 // Expand longer media queries as iPhone doesn't grok 'handheld'
2822                 if( $wgHandheldForIPhone ) {
2823                         $mediaAliases = array(
2824                                 'screen' => 'screen and (min-device-width: 481px)',
2825                                 'handheld' => 'handheld, only screen and (max-device-width: 480px)',
2826                         );
2827
2828                         if( isset( $mediaAliases[$media] ) ) {
2829                                 $media = $mediaAliases[$media];
2830                         }
2831                 }
2832
2833                 return $media;
2834         }
2835
2836         /**
2837          * Turn off regular page output and return an error reponse
2838          * for when rate limiting has triggered.
2839          */
2840         public function rateLimited() {
2841                 $this->setPageTitle( wfMsg( 'actionthrottled' ) );
2842                 $this->setRobotPolicy( 'noindex,follow' );
2843                 $this->setArticleRelated( false );
2844                 $this->enableClientCache( false );
2845                 $this->mRedirect = '';
2846                 $this->clearHTML();
2847                 $this->setStatusCode( 503 );
2848                 $this->addWikiMsg( 'actionthrottledtext' );
2849
2850                 $this->returnToMain( null, $this->getTitle() );
2851         }
2852
2853         /**
2854          * Show a warning about slave lag
2855          *
2856          * If the lag is higher than $wgSlaveLagCritical seconds,
2857          * then the warning is a bit more obvious. If the lag is
2858          * lower than $wgSlaveLagWarning, then no warning is shown.
2859          *
2860          * @param $lag Integer: slave lag
2861          */
2862         public function showLagWarning( $lag ) {
2863                 global $wgSlaveLagWarning, $wgSlaveLagCritical, $wgLang;
2864                 if( $lag >= $wgSlaveLagWarning ) {
2865                         $message = $lag < $wgSlaveLagCritical
2866                                 ? 'lag-warn-normal'
2867                                 : 'lag-warn-high';
2868                         $wrap = Html::rawElement( 'div', array( 'class' => "mw-{$message}" ), "\n$1\n" );
2869                         $this->wrapWikiMsg( "$wrap\n", array( $message, $wgLang->formatNum( $lag ) ) );
2870                 }
2871         }
2872
2873         /**
2874          * Add a wikitext-formatted message to the output.
2875          * This is equivalent to:
2876          *
2877          *    $wgOut->addWikiText( wfMsgNoTrans( ... ) )
2878          */
2879         public function addWikiMsg( /*...*/ ) {
2880                 $args = func_get_args();
2881                 $name = array_shift( $args );
2882                 $this->addWikiMsgArray( $name, $args );
2883         }
2884
2885         /**
2886          * Add a wikitext-formatted message to the output.
2887          * Like addWikiMsg() except the parameters are taken as an array
2888          * instead of a variable argument list.
2889          *
2890          * $options is passed through to wfMsgExt(), see that function for details.
2891          */
2892         public function addWikiMsgArray( $name, $args, $options = array() ) {
2893                 $options[] = 'parse';
2894                 $text = wfMsgExt( $name, $options, $args );
2895                 $this->addHTML( $text );
2896         }
2897
2898         /**
2899          * This function takes a number of message/argument specifications, wraps them in
2900          * some overall structure, and then parses the result and adds it to the output.
2901          *
2902          * In the $wrap, $1 is replaced with the first message, $2 with the second, and so
2903          * on. The subsequent arguments may either be strings, in which case they are the
2904          * message names, or arrays, in which case the first element is the message name,
2905          * and subsequent elements are the parameters to that message.
2906          *
2907          * The special named parameter 'options' in a message specification array is passed
2908          * through to the $options parameter of wfMsgExt().
2909          *
2910          * Don't use this for messages that are not in users interface language.
2911          *
2912          * For example:
2913          *
2914          *    $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>", 'some-error' );
2915          *
2916          * Is equivalent to:
2917          *
2918          *    $wgOut->addWikiText( "<div class='error'>\n" . wfMsgNoTrans( 'some-error' ) . "\n</div>" );
2919          *
2920          * The newline after opening div is needed in some wikitext. See bug 19226.
2921          */
2922         public function wrapWikiMsg( $wrap /*, ...*/ ) {
2923                 $msgSpecs = func_get_args();
2924                 array_shift( $msgSpecs );
2925                 $msgSpecs = array_values( $msgSpecs );
2926                 $s = $wrap;
2927                 foreach ( $msgSpecs as $n => $spec ) {
2928                         $options = array();
2929                         if ( is_array( $spec ) ) {
2930                                 $args = $spec;
2931                                 $name = array_shift( $args );
2932                                 if ( isset( $args['options'] ) ) {
2933                                         $options = $args['options'];
2934                                         unset( $args['options'] );
2935                                 }
2936                         }  else {
2937                                 $args = array();
2938                                 $name = $spec;
2939                         }
2940                         $s = str_replace( '$' . ( $n + 1 ), wfMsgExt( $name, $options, $args ), $s );
2941                 }
2942                 $this->addHTML( $this->parse( $s, /*linestart*/true, /*uilang*/true ) );
2943         }
2944
2945         /**
2946          * Include jQuery core. Use this to avoid loading it multiple times
2947          * before we get a usable script loader.
2948          *
2949          * @param $modules Array: list of jQuery modules which should be loaded
2950          * @return Array: the list of modules which were not loaded.
2951          * @since 1.16
2952          * @deprecated No longer needed as of 1.17
2953          */
2954         public function includeJQuery( $modules = array() ) {
2955                 return array();
2956         }
2957
2958 }