includes/OutputPage.php

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