includes/OutputPage.php

   1 <?php
   2 if ( ! defined( 'MEDIAWIKI' ) )
   3         die( 1 );
   4 /**
   5  */
   6
   7 /**
   8  * @todo document
   9  */
  10 class OutputPage {
  11         var $mMetatags, $mKeywords;
  12         var $mLinktags, $mPagetitle, $mBodytext, $mDebugtext;
  13         var $mHTMLtitle, $mRobotpolicy, $mIsarticle, $mPrintable;
  14         var $mSubtitle, $mRedirect, $mStatusCode;
  15         var $mLastModified, $mETag, $mCategoryLinks;
  16         var $mScripts, $mLinkColours, $mPageLinkTitle;
  17
  18         var $mAllowUserJs;
  19         var $mSuppressQuickbar;
  20         var $mOnloadHandler;
  21         var $mDoNothing;
  22         var $mContainsOldMagic, $mContainsNewMagic;
  23         var $mIsArticleRelated;
  24         protected $mParserOptions; // lazy initialised, use parserOptions()
  25         var $mShowFeedLinks = false;
  26         var $mFeedLinksAppendQuery = false;
  27         var $mEnableClientCache = true;
  28         var $mArticleBodyOnly = false;
  29
  30         var $mNewSectionLink = false;
  31         var $mNoGallery = false;
  32         var $mPageTitleActionText = '';
  33         var $mParseWarnings = array();
  34
  35         /**
  36          * Constructor
  37          * Initialise private variables
  38          */
  39         function __construct() {
  40                 global $wgAllowUserJs;
  41                 $this->mAllowUserJs = $wgAllowUserJs;
  42                 $this->mMetatags = $this->mKeywords = $this->mLinktags = array();
  43                 $this->mHTMLtitle = $this->mPagetitle = $this->mBodytext =
  44                 $this->mRedirect = $this->mLastModified =
  45                 $this->mSubtitle = $this->mDebugtext = $this->mRobotpolicy =
  46                 $this->mOnloadHandler = $this->mPageLinkTitle = '';
  47                 $this->mIsArticleRelated = $this->mIsarticle = $this->mPrintable = true;
  48                 $this->mSuppressQuickbar = $this->mPrintable = false;
  49                 $this->mLanguageLinks = array();
  50                 $this->mCategoryLinks = array();
  51                 $this->mDoNothing = false;
  52                 $this->mContainsOldMagic = $this->mContainsNewMagic = 0;
  53                 $this->mParserOptions = null;
  54                 $this->mSquidMaxage = 0;
  55                 $this->mScripts = '';
  56                 $this->mHeadItems = array();
  57                 $this->mETag = false;
  58                 $this->mRevisionId = null;
  59                 $this->mNewSectionLink = false;
  60                 $this->mTemplateIds = array();
  61         }
  62
  63         public function redirect( $url, $responsecode = '302' ) {
  64                 # Strip newlines as a paranoia check for header injection in PHP<5.1.2
  65                 $this->mRedirect = str_replace( "\n", '', $url );
  66                 $this->mRedirectCode = $responsecode;
  67         }
  68
  69         public function getRedirect() {
  70                 return $this->mRedirect;
  71         }
  72
  73         /**
  74          * Set the HTTP status code to send with the output.
  75          *
  76          * @param int $statusCode
  77          * @return nothing
  78          */
  79         function setStatusCode( $statusCode ) { $this->mStatusCode = $statusCode; }
  80
  81         # To add an http-equiv meta tag, precede the name with "http:"
  82         function addMeta( $name, $val ) { array_push( $this->mMetatags, array( $name, $val ) ); }
  83         function addKeyword( $text ) { array_push( $this->mKeywords, $text ); }
  84         function addScript( $script ) { $this->mScripts .= "\t\t".$script; }
  85         function addStyle( $style ) {
  86                 global $wgStylePath, $wgStyleVersion;
  87                 $this->addLink(
  88                                 array(
  89                                         'rel' => 'stylesheet',
  90                                         'href' => $wgStylePath . '/' . $style . '?' . $wgStyleVersion ) );
  91         }
  92
  93         /**
  94          * Add a self-contained script tag with the given contents
  95          * @param string $script JavaScript text, no <script> tags
  96          */
  97         function addInlineScript( $script ) {
  98                 global $wgJsMimeType;
  99                 $this->mScripts .= "<script type=\"$wgJsMimeType\">/*<![CDATA[*/\n$script\n/*]]>*/</script>";
 100         }
 101
 102         function getScript() {
 103                 return $this->mScripts . $this->getHeadItems();
 104         }
 105
 106         function getHeadItems() {
 107                 $s = '';
 108                 foreach ( $this->mHeadItems as $item ) {
 109                         $s .= $item;
 110                 }
 111                 return $s;
 112         }
 113
 114         function addHeadItem( $name, $value ) {
 115                 $this->mHeadItems[$name] = $value;
 116         }
 117
 118         function hasHeadItem( $name ) {
 119                 return isset( $this->mHeadItems[$name] );
 120         }
 121
 122         function setETag($tag) { $this->mETag = $tag; }
 123         function setArticleBodyOnly($only) { $this->mArticleBodyOnly = $only; }
 124         function getArticleBodyOnly($only) { return $this->mArticleBodyOnly; }
 125
 126         function addLink( $linkarr ) {
 127                 # $linkarr should be an associative array of attributes. We'll escape on output.
 128                 array_push( $this->mLinktags, $linkarr );
 129         }
 130
 131         function addMetadataLink( $linkarr ) {
 132                 # note: buggy CC software only reads first "meta" link
 133                 static $haveMeta = false;
 134                 $linkarr['rel'] = ($haveMeta) ? 'alternate meta' : 'meta';
 135                 $this->addLink( $linkarr );
 136                 $haveMeta = true;
 137         }
 138
 139         /**
 140          * checkLastModified tells the client to use the client-cached page if
 141          * possible. If sucessful, the OutputPage is disabled so that
 142          * any future call to OutputPage->output() have no effect.
 143          *
 144          * @return bool True iff cache-ok headers was sent.
 145          */
 146         function checkLastModified ( $timestamp ) {
 147                 global $wgCachePages, $wgCacheEpoch, $wgUser, $wgRequest;
 148                 $fname = 'OutputPage::checkLastModified';
 149
 150                 if ( !$timestamp || $timestamp == '19700101000000' ) {
 151                         wfDebug( "$fname: CACHE DISABLED, NO TIMESTAMP\n" );
 152                         return;
 153                 }
 154                 if( !$wgCachePages ) {
 155                         wfDebug( "$fname: CACHE DISABLED\n", false );
 156                         return;
 157                 }
 158                 if( $wgUser->getOption( 'nocache' ) ) {
 159                         wfDebug( "$fname: USER DISABLED CACHE\n", false );
 160                         return;
 161                 }
 162
 163                 $timestamp=wfTimestamp(TS_MW,$timestamp);
 164                 $lastmod = wfTimestamp( TS_RFC2822, max( $timestamp, $wgUser->mTouched, $wgCacheEpoch ) );
 165
 166                 if( !empty( $_SERVER['HTTP_IF_MODIFIED_SINCE'] ) ) {
 167                         # IE sends sizes after the date like this:
 168                         # Wed, 20 Aug 2003 06:51:19 GMT; length=5202
 169                         # this breaks strtotime().
 170                         $modsince = preg_replace( '/;.*$/', '', $_SERVER["HTTP_IF_MODIFIED_SINCE"] );
 171
 172                         wfSuppressWarnings(); // E_STRICT system time bitching
 173                         $modsinceTime = strtotime( $modsince );
 174                         wfRestoreWarnings();
 175
 176                         $ismodsince = wfTimestamp( TS_MW, $modsinceTime ? $modsinceTime : 1 );
 177                         wfDebug( "$fname: -- client send If-Modified-Since: " . $modsince . "\n", false );
 178                         wfDebug( "$fname: --  we might send Last-Modified : $lastmod\n", false );
 179                         if( ($ismodsince >= $timestamp ) && $wgUser->validateCache( $ismodsince ) && $ismodsince >= $wgCacheEpoch ) {
 180                                 # Make sure you're in a place you can leave when you call us!
 181                                 $wgRequest->response()->header( "HTTP/1.0 304 Not Modified" );
 182                                 $this->mLastModified = $lastmod;
 183                                 $this->sendCacheControl();
 184                                 wfDebug( "$fname: CACHED client: $ismodsince ; user: $wgUser->mTouched ; page: $timestamp ; site $wgCacheEpoch\n", false );
 185                                 $this->disable();
 186
 187                                 // Don't output a compressed blob when using ob_gzhandler;
 188                                 // it's technically against HTTP spec and seems to confuse
 189                                 // Firefox when the response gets split over two packets.
 190                                 wfClearOutputBuffers();
 191
 192                                 return true;
 193                         } else {
 194                                 wfDebug( "$fname: READY  client: $ismodsince ; user: $wgUser->mTouched ; page: $timestamp ; site $wgCacheEpoch\n", false );
 195                                 $this->mLastModified = $lastmod;
 196                         }
 197                 } else {
 198                         wfDebug( "$fname: client did not send If-Modified-Since header\n", false );
 199                         $this->mLastModified = $lastmod;
 200                 }
 201         }
 202
 203         function setPageTitleActionText( $text ) {
 204                 $this->mPageTitleActionText = $text;
 205         }
 206
 207         function getPageTitleActionText () {
 208                 if ( isset( $this->mPageTitleActionText ) ) {
 209                         return $this->mPageTitleActionText;
 210                 }
 211         }
 212
 213         public function setRobotpolicy( $str ) { $this->mRobotpolicy = $str; }
 214         public function setHTMLTitle( $name ) {$this->mHTMLtitle = $name; }
 215         public function setPageTitle( $name ) {
 216                 global $action, $wgContLang;
 217                 $name = $wgContLang->convert($name, true);
 218                 $this->mPagetitle = $name;
 219                 if(!empty($action)) {
 220                         $taction =  $this->getPageTitleActionText();
 221                         if( !empty( $taction ) ) {
 222                                 $name .= ' - '.$taction;
 223                         }
 224                 }
 225
 226                 $this->setHTMLTitle( wfMsg( 'pagetitle', $name ) );
 227         }
 228         public function getHTMLTitle() { return $this->mHTMLtitle; }
 229         public function getPageTitle() { return $this->mPagetitle; }
 230         public function setSubtitle( $str ) { $this->mSubtitle = /*$this->parse(*/$str/*)*/; } // @bug 2514
 231         public function getSubtitle() { return $this->mSubtitle; }
 232         public function isArticle() { return $this->mIsarticle; }
 233         public function setPrintable() { $this->mPrintable = true; }
 234         public function isPrintable() { return $this->mPrintable; }
 235         public function setSyndicated( $show = true ) { $this->mShowFeedLinks = $show; }
 236         public function isSyndicated() { return $this->mShowFeedLinks; }
 237         public function setFeedAppendQuery( $val ) { $this->mFeedLinksAppendQuery = $val; }
 238         public function getFeedAppendQuery() { return $this->mFeedLinksAppendQuery; }
 239         public function setOnloadHandler( $js ) { $this->mOnloadHandler = $js; }
 240         public function getOnloadHandler() { return $this->mOnloadHandler; }
 241         public function disable() { $this->mDoNothing = true; }
 242
 243         public function setArticleRelated( $v ) {
 244                 $this->mIsArticleRelated = $v;
 245                 if ( !$v ) {
 246                         $this->mIsarticle = false;
 247                 }
 248         }
 249         public function setArticleFlag( $v ) {
 250                 $this->mIsarticle = $v;
 251                 if ( $v ) {
 252                         $this->mIsArticleRelated = $v;
 253                 }
 254         }
 255
 256         public function isArticleRelated() { return $this->mIsArticleRelated; }
 257
 258         public function getLanguageLinks() { return $this->mLanguageLinks; }
 259         public function addLanguageLinks($newLinkArray) {
 260                 $this->mLanguageLinks += $newLinkArray;
 261         }
 262         public function setLanguageLinks($newLinkArray) {
 263                 $this->mLanguageLinks = $newLinkArray;
 264         }
 265
 266         public function getCategoryLinks() {
 267                 return $this->mCategoryLinks;
 268         }
 269
 270         /**
 271          * Add an array of categories, with names in the keys
 272          */
 273         public function addCategoryLinks($categories) {
 274                 global $wgUser, $wgContLang;
 275
 276                 if ( !is_array( $categories ) ) {
 277                         return;
 278                 }
 279                 # Add the links to the link cache in a batch
 280                 $arr = array( NS_CATEGORY => $categories );
 281                 $lb = new LinkBatch;
 282                 $lb->setArray( $arr );
 283                 $lb->execute();
 284
 285                 $sk = $wgUser->getSkin();
 286                 foreach ( $categories as $category => $unused ) {
 287                         $title = Title::makeTitleSafe( NS_CATEGORY, $category );
 288                         $text = $wgContLang->convertHtml( $title->getText() );
 289                         $this->mCategoryLinks[] = $sk->makeLinkObj( $title, $text );
 290                 }
 291         }
 292
 293         public function setCategoryLinks($categories) {
 294                 $this->mCategoryLinks = array();
 295                 $this->addCategoryLinks($categories);
 296         }
 297
 298         public function suppressQuickbar() { $this->mSuppressQuickbar = true; }
 299         public function isQuickbarSuppressed() { return $this->mSuppressQuickbar; }
 300
 301         public function disallowUserJs() { $this->mAllowUserJs = false; }
 302         public function isUserJsAllowed() { return $this->mAllowUserJs; }
 303
 304         public function addHTML( $text ) { $this->mBodytext .= $text; }
 305         public function clearHTML() { $this->mBodytext = ''; }
 306         public function getHTML() { return $this->mBodytext; }
 307         public function debug( $text ) { $this->mDebugtext .= $text; }
 308
 309         /* @deprecated */
 310         public function setParserOptions( $options ) {
 311                 return $this->parserOptions( $options );
 312         }
 313
 314         public function parserOptions( $options = null ) {
 315                 if ( !$this->mParserOptions ) {
 316                         $this->mParserOptions = new ParserOptions;
 317                 }
 318                 return wfSetVar( $this->mParserOptions, $options );
 319         }
 320
 321         /**
 322          * Set the revision ID which will be seen by the wiki text parser
 323          * for things such as embedded {{REVISIONID}} variable use.
 324          * @param mixed $revid an integer, or NULL
 325          * @return mixed previous value
 326          */
 327         public function setRevisionId( $revid ) {
 328                 $val = is_null( $revid ) ? null : intval( $revid );
 329                 return wfSetVar( $this->mRevisionId, $val );
 330         }
 331
 332         /**
 333          * Convert wikitext to HTML and add it to the buffer
 334          * Default assumes that the current page title will
 335          * be used.
 336          *
 337          * @param string $text
 338          * @param bool   $linestart
 339          */
 340         public function addWikiText( $text, $linestart = true ) {
 341                 global $wgTitle;
 342                 $this->addWikiTextTitle($text, $wgTitle, $linestart);
 343         }
 344
 345         public function addWikiTextWithTitle($text, &$title, $linestart = true) {
 346                 $this->addWikiTextTitle($text, $title, $linestart);
 347         }
 348
 349         function addWikiTextTitleTidy($text, &$title, $linestart = true) {
 350                 $this->addWikiTextTitle( $text, $title, $linestart, true );
 351         }
 352
 353         public function addWikiTextTitle($text, &$title, $linestart, $tidy = false) {
 354                 global $wgParser;
 355
 356                 $fname = 'OutputPage:addWikiTextTitle';
 357                 wfProfileIn($fname);
 358
 359                 wfIncrStats('pcache_not_possible');
 360
 361                 $popts = $this->parserOptions();
 362                 $oldTidy = $popts->setTidy($tidy);
 363
 364                 $parserOutput = $wgParser->parse( $text, $title, $popts,
 365                         $linestart, true, $this->mRevisionId );
 366
 367                 $popts->setTidy( $oldTidy );
 368
 369                 $this->addParserOutput( $parserOutput );
 370
 371                 wfProfileOut($fname);
 372         }
 373
 374         /**
 375          * @todo document
 376          * @param ParserOutput object &$parserOutput
 377          */
 378         public function addParserOutputNoText( &$parserOutput ) {
 379                 $this->mLanguageLinks += $parserOutput->getLanguageLinks();
 380                 $this->addCategoryLinks( $parserOutput->getCategories() );
 381                 $this->mNewSectionLink = $parserOutput->getNewSection();
 382                 $this->addKeywords( $parserOutput );
 383                 $this->mParseWarnings = $parserOutput->getWarnings();
 384                 if ( $parserOutput->getCacheTime() == -1 ) {
 385                         $this->enableClientCache( false );
 386                 }
 387                 $this->mNoGallery = $parserOutput->getNoGallery();
 388                 $this->mHeadItems = array_merge( $this->mHeadItems, (array)$parserOutput->mHeadItems );
 389                 // Versioning...
 390                 $this->mTemplateIds += (array)$parserOutput->mTemplateIds;
 391
 392                 # Display title
 393                 if( ( $dt = $parserOutput->getDisplayTitle() ) !== false )
 394                         $this->setPageTitle( $dt );
 395
 396                 # Hooks registered in the object
 397                 global $wgParserOutputHooks;
 398                 foreach ( $parserOutput->getOutputHooks() as $hookInfo ) {
 399                         list( $hookName, $data ) = $hookInfo;
 400                         if ( isset( $wgParserOutputHooks[$hookName] ) ) {
 401                                 call_user_func( $wgParserOutputHooks[$hookName], $this, $parserOutput, $data );
 402                         }
 403                 }
 404
 405                 wfRunHooks( 'OutputPageParserOutput', array( &$this, $parserOutput ) );
 406         }
 407
 408         /**
 409          * @todo document
 410          * @param ParserOutput &$parserOutput
 411          */
 412         function addParserOutput( &$parserOutput ) {
 413                 $this->addParserOutputNoText( $parserOutput );
 414                 $text = $parserOutput->getText();
 415                 wfRunHooks( 'OutputPageBeforeHTML',array( &$this, &$text ) );
 416                 $this->addHTML( $text );
 417         }
 418
 419         /**
 420          * Add wikitext to the buffer, assuming that this is the primary text for a page view
 421          * Saves the text into the parser cache if possible.
 422          *
 423          * @param string  $text
 424          * @param Article $article
 425          * @param bool    $cache
 426          * @deprecated Use Article::outputWikitext
 427          */
 428         public function addPrimaryWikiText( $text, $article, $cache = true ) {
 429                 global $wgParser, $wgUser;
 430
 431                 $popts = $this->parserOptions();
 432                 $popts->setTidy(true);
 433                 $parserOutput = $wgParser->parse( $text, $article->mTitle,
 434                         $popts, true, true, $this->mRevisionId );
 435                 $popts->setTidy(false);
 436                 if ( $cache && $article && $parserOutput->getCacheTime() != -1 ) {
 437                         $parserCache =& ParserCache::singleton();
 438                         $parserCache->save( $parserOutput, $article, $wgUser );
 439                 }
 440
 441                 $this->addParserOutput( $parserOutput );
 442         }
 443
 444         /**
 445          * @deprecated use addWikiTextTidy()
 446          */
 447         public function addSecondaryWikiText( $text, $linestart = true ) {
 448                 global $wgTitle;
 449                 $this->addWikiTextTitleTidy($text, $wgTitle, $linestart);
 450         }
 451
 452         /**
 453          * Add wikitext with tidy enabled
 454          */
 455         public function addWikiTextTidy(  $text, $linestart = true ) {
 456                 global $wgTitle;
 457                 $this->addWikiTextTitleTidy($text, $wgTitle, $linestart);
 458         }
 459
 460
 461         /**
 462          * Add the output of a QuickTemplate to the output buffer
 463          *
 464          * @param QuickTemplate $template
 465          */
 466         public function addTemplate( &$template ) {
 467                 ob_start();
 468                 $template->execute();
 469                 $this->addHTML( ob_get_contents() );
 470                 ob_end_clean();
 471         }
 472
 473         /**
 474          * Parse wikitext and return the HTML.
 475          *
 476          * @param string $text
 477          * @param bool   $linestart Is this the start of a line?
 478          * @param bool   $interface ??
 479          */
 480         public function parse( $text, $linestart = true, $interface = false ) {
 481                 global $wgParser, $wgTitle;
 482                 $popts = $this->parserOptions();
 483                 if ( $interface) { $popts->setInterfaceMessage(true); }
 484                 $parserOutput = $wgParser->parse( $text, $wgTitle, $popts,
 485                         $linestart, true, $this->mRevisionId );
 486                 if ( $interface) { $popts->setInterfaceMessage(false); }
 487                 return $parserOutput->getText();
 488         }
 489
 490         /**
 491          * @param Article $article
 492          * @param User    $user
 493          *
 494          * @return bool True if successful, else false.
 495          */
 496         public function tryParserCache( &$article, $user ) {
 497                 $parserCache =& ParserCache::singleton();
 498                 $parserOutput = $parserCache->get( $article, $user );
 499                 if ( $parserOutput !== false ) {
 500                         $this->addParserOutput( $parserOutput );
 501                         return true;
 502                 } else {
 503                         return false;
 504                 }
 505         }
 506
 507         /**
 508          * @param int $maxage Maximum cache time on the Squid, in seconds.
 509          */
 510         public function setSquidMaxage( $maxage ) {
 511                 $this->mSquidMaxage = $maxage;
 512         }
 513
 514         /**
 515          * Use enableClientCache(false) to force it to send nocache headers
 516          * @param $state ??
 517          */
 518         public function enableClientCache( $state ) {
 519                 return wfSetVar( $this->mEnableClientCache, $state );
 520         }
 521
 522         function uncacheableBecauseRequestvars() {
 523                 global $wgRequest;
 524                 return  $wgRequest->getText('useskin', false) === false
 525                         && $wgRequest->getText('uselang', false) === false;
 526         }
 527
 528         /** Get a complete X-Vary-Options header */
 529         public function getXVO() {
 530                 global $wgCookiePrefix;
 531                 return 'X-Vary-Options: ' .
 532                         # User ID cookie
 533                         "Cookie;string-contains={$wgCookiePrefix}UserID;" .
 534                         # Session cookie
 535                         'string-contains=' . session_name() . ',' .
 536                         # Encoding checks for gzip only
 537                         'Accept-Encoding;list-contains=gzip';
 538         }
 539
 540         public function sendCacheControl() {
 541                 global $wgUseSquid, $wgUseESI, $wgUseETag, $wgSquidMaxage, $wgRequest;
 542                 $fname = 'OutputPage::sendCacheControl';
 543
 544                 $response = $wgRequest->response();
 545                 if ($wgUseETag && $this->mETag)
 546                         $response->header("ETag: $this->mETag");
 547
 548                 # don't serve compressed data to clients who can't handle it
 549                 # maintain different caches for logged-in users and non-logged in ones
 550                 $response->header( 'Vary: Accept-Encoding, Cookie' );
 551
 552                 # Add an X-Vary-Options header for Squid with Wikimedia patches
 553                 $response->header( $this->getXVO() );
 554
 555                 if( !$this->uncacheableBecauseRequestvars() && $this->mEnableClientCache ) {
 556                         if( $wgUseSquid && session_id() == '' &&
 557                           ! $this->isPrintable() && $this->mSquidMaxage != 0 )
 558                         {
 559                                 if ( $wgUseESI ) {
 560                                         # We'll purge the proxy cache explicitly, but require end user agents
 561                                         # to revalidate against the proxy on each visit.
 562                                         # Surrogate-Control controls our Squid, Cache-Control downstream caches
 563                                         wfDebug( "$fname: proxy caching with ESI; {$this->mLastModified} **\n", false );
 564                                         # start with a shorter timeout for initial testing
 565                                         # header( 'Surrogate-Control: max-age=2678400+2678400, content="ESI/1.0"');
 566                                         $response->header( 'Surrogate-Control: max-age='.$wgSquidMaxage.'+'.$this->mSquidMaxage.', content="ESI/1.0"');
 567                                         $response->header( 'Cache-Control: s-maxage=0, must-revalidate, max-age=0' );
 568                                 } else {
 569                                         # We'll purge the proxy cache for anons explicitly, but require end user agents
 570                                         # to revalidate against the proxy on each visit.
 571                                         # IMPORTANT! The Squid needs to replace the Cache-Control header with
 572                                         # Cache-Control: s-maxage=0, must-revalidate, max-age=0
 573                                         wfDebug( "$fname: local proxy caching; {$this->mLastModified} **\n", false );
 574                                         # start with a shorter timeout for initial testing
 575                                         # header( "Cache-Control: s-maxage=2678400, must-revalidate, max-age=0" );
 576                                         $response->header( 'Cache-Control: s-maxage='.$this->mSquidMaxage.', must-revalidate, max-age=0' );
 577                                 }
 578                         } else {
 579                                 # We do want clients to cache if they can, but they *must* check for updates
 580                                 # on revisiting the page.
 581                                 wfDebug( "$fname: private caching; {$this->mLastModified} **\n", false );
 582                                 $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
 583                                 $response->header( "Cache-Control: private, must-revalidate, max-age=0" );
 584                         }
 585                         if($this->mLastModified) $response->header( "Last-modified: {$this->mLastModified}" );
 586                 } else {
 587                         wfDebug( "$fname: no caching **\n", false );
 588
 589                         # In general, the absence of a last modified header should be enough to prevent
 590                         # the client from using its cache. We send a few other things just to make sure.
 591                         $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
 592                         $response->header( 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate' );
 593                         $response->header( 'Pragma: no-cache' );
 594                 }
 595         }
 596
 597         /**
 598          * Finally, all the text has been munged and accumulated into
 599          * the object, let's actually output it:
 600          */
 601         public function output() {
 602                 global $wgUser, $wgOutputEncoding, $wgRequest;
 603                 global $wgContLanguageCode, $wgDebugRedirects, $wgMimeType;
 604                 global $wgJsMimeType, $wgStylePath, $wgUseAjax, $wgAjaxSearch, $wgAjaxWatch;
 605                 global $wgServer, $wgStyleVersion;
 606
 607                 if( $this->mDoNothing ){
 608                         return;
 609                 }
 610                 $fname = 'OutputPage::output';
 611                 wfProfileIn( $fname );
 612
 613                 if ( '' != $this->mRedirect ) {
 614                         # Standards require redirect URLs to be absolute
 615                         $this->mRedirect = wfExpandUrl( $this->mRedirect );
 616                         if( $this->mRedirectCode == '301') {
 617                                 if( !$wgDebugRedirects ) {
 618                                         $wgRequest->response()->header("HTTP/1.1 {$this->mRedirectCode} Moved Permanently");
 619                                 }
 620                                 $this->mLastModified = wfTimestamp( TS_RFC2822 );
 621                         }
 622
 623                         $this->sendCacheControl();
 624
 625                         $wgRequest->response()->header("Content-Type: text/html; charset=utf-8");
 626                         if( $wgDebugRedirects ) {
 627                                 $url = htmlspecialchars( $this->mRedirect );
 628                                 print "<html>\n<head>\n<title>Redirect</title>\n</head>\n<body>\n";
 629                                 print "<p>Location: <a href=\"$url\">$url</a></p>\n";
 630                                 print "</body>\n</html>\n";
 631                         } else {
 632                                 $wgRequest->response()->header( 'Location: '.$this->mRedirect );
 633                         }
 634                         wfProfileOut( $fname );
 635                         return;
 636                 }
 637                 elseif ( $this->mStatusCode )
 638                 {
 639                         $statusMessage = array(
 640                                 100 => 'Continue',
 641                                 101 => 'Switching Protocols',
 642                                 102 => 'Processing',
 643                                 200 => 'OK',
 644                                 201 => 'Created',
 645                                 202 => 'Accepted',
 646                                 203 => 'Non-Authoritative Information',
 647                                 204 => 'No Content',
 648                                 205 => 'Reset Content',
 649                                 206 => 'Partial Content',
 650                                 207 => 'Multi-Status',
 651                                 300 => 'Multiple Choices',
 652                                 301 => 'Moved Permanently',
 653                                 302 => 'Found',
 654                                 303 => 'See Other',
 655                                 304 => 'Not Modified',
 656                                 305 => 'Use Proxy',
 657                                 307 => 'Temporary Redirect',
 658                                 400 => 'Bad Request',
 659                                 401 => 'Unauthorized',
 660                                 402 => 'Payment Required',
 661                                 403 => 'Forbidden',
 662                                 404 => 'Not Found',
 663                                 405 => 'Method Not Allowed',
 664                                 406 => 'Not Acceptable',
 665                                 407 => 'Proxy Authentication Required',
 666                                 408 => 'Request Timeout',
 667                                 409 => 'Conflict',
 668                                 410 => 'Gone',
 669                                 411 => 'Length Required',
 670                                 412 => 'Precondition Failed',
 671                                 413 => 'Request Entity Too Large',
 672                                 414 => 'Request-URI Too Large',
 673                                 415 => 'Unsupported Media Type',
 674                                 416 => 'Request Range Not Satisfiable',
 675                                 417 => 'Expectation Failed',
 676                                 422 => 'Unprocessable Entity',
 677                                 423 => 'Locked',
 678                                 424 => 'Failed Dependency',
 679                                 500 => 'Internal Server Error',
 680                                 501 => 'Not Implemented',
 681                                 502 => 'Bad Gateway',
 682                                 503 => 'Service Unavailable',
 683                                 504 => 'Gateway Timeout',
 684                                 505 => 'HTTP Version Not Supported',
 685                                 507 => 'Insufficient Storage'
 686                         );
 687
 688                         if ( $statusMessage[$this->mStatusCode] )
 689                                 $wgRequest->response()->header( 'HTTP/1.1 ' . $this->mStatusCode . ' ' . $statusMessage[$this->mStatusCode] );
 690                 }
 691
 692                 $sk = $wgUser->getSkin();
 693
 694                 if ( $wgUseAjax ) {
 695                         $this->addScript( "<script type=\"{$wgJsMimeType}\" src=\"{$wgStylePath}/common/ajax.js?$wgStyleVersion\"></script>\n" );
 696
 697                         wfRunHooks( 'AjaxAddScript', array( &$this ) );
 698
 699                         if( $wgAjaxSearch && $wgUser->getBoolOption( 'ajaxsearch' ) ) {
 700                                 $this->addScript( "<script type=\"{$wgJsMimeType}\" src=\"{$wgStylePath}/common/ajaxsearch.js?$wgStyleVersion\"></script>\n" );
 701                                 $this->addScript( "<script type=\"{$wgJsMimeType}\">hookEvent(\"load\", sajax_onload);</script>\n" );
 702                         }
 703
 704                         if( $wgAjaxWatch && $wgUser->isLoggedIn() ) {
 705                                 $this->addScript( "<script type=\"{$wgJsMimeType}\" src=\"{$wgStylePath}/common/ajaxwatch.js?$wgStyleVersion\"></script>\n" );
 706                         }
 707                 }
 708
 709
 710
 711                 # Buffer output; final headers may depend on later processing
 712                 ob_start();
 713
 714                 # Disable temporary placeholders, so that the skin produces HTML
 715                 $sk->postParseLinkColour( false );
 716
 717                 $wgRequest->response()->header( "Content-type: $wgMimeType; charset={$wgOutputEncoding}" );
 718                 $wgRequest->response()->header( 'Content-language: '.$wgContLanguageCode );
 719
 720                 if ($this->mArticleBodyOnly) {
 721                         $this->out($this->mBodytext);
 722                 } else {
 723                         wfProfileIn( 'Output-skin' );
 724                         $sk->outputPage( $this );
 725                         wfProfileOut( 'Output-skin' );
 726                 }
 727
 728                 $this->sendCacheControl();
 729                 ob_end_flush();
 730                 wfProfileOut( $fname );
 731         }
 732
 733         /**
 734          * @todo document
 735          * @param string $ins
 736          */
 737         public function out( $ins ) {
 738                 global $wgInputEncoding, $wgOutputEncoding, $wgContLang;
 739                 if ( 0 == strcmp( $wgInputEncoding, $wgOutputEncoding ) ) {
 740                         $outs = $ins;
 741                 } else {
 742                         $outs = $wgContLang->iconv( $wgInputEncoding, $wgOutputEncoding, $ins );
 743                         if ( false === $outs ) { $outs = $ins; }
 744                 }
 745                 print $outs;
 746         }
 747
 748         /**
 749          * @todo document
 750          */
 751         public static function setEncodings() {
 752                 global $wgInputEncoding, $wgOutputEncoding;
 753                 global $wgUser, $wgContLang;
 754
 755                 $wgInputEncoding = strtolower( $wgInputEncoding );
 756
 757                 if ( empty( $_SERVER['HTTP_ACCEPT_CHARSET'] ) ) {
 758                         $wgOutputEncoding = strtolower( $wgOutputEncoding );
 759                         return;
 760                 }
 761                 $wgOutputEncoding = $wgInputEncoding;
 762         }
 763
 764         /**
 765          * Deprecated, use wfReportTime() instead.
 766          * @return string
 767          * @deprecated
 768          */
 769         public function reportTime() {
 770                 $time = wfReportTime();
 771                 return $time;
 772         }
 773
 774         /**
 775          * Produce a "user is blocked" page.
 776          *
 777          * @param bool $return Whether to have a "return to $wgTitle" message or not.
 778          * @return nothing
 779          */
 780         function blockedPage( $return = true ) {
 781                 global $wgUser, $wgContLang, $wgTitle, $wgLang;
 782
 783                 $this->setPageTitle( wfMsg( 'blockedtitle' ) );
 784                 $this->setRobotpolicy( 'noindex,nofollow' );
 785                 $this->setArticleRelated( false );
 786
 787                 $name = User::whoIs( $wgUser->blockedBy() );
 788                 $reason = $wgUser->blockedFor();
 789                 if( $reason == '' ) {
 790                         $reason = wfMsg( 'blockednoreason' );
 791                 }
 792                 $blockTimestamp = $wgLang->timeanddate( wfTimestamp( TS_MW, $wgUser->mBlock->mTimestamp ), true );
 793                 $ip = wfGetIP();
 794
 795                 $link = '[[' . $wgContLang->getNsText( NS_USER ) . ":{$name}|{$name}]]";
 796
 797                 $blockid = $wgUser->mBlock->mId;
 798
 799                 $blockExpiry = $wgUser->mBlock->mExpiry;
 800                 if ( $blockExpiry == 'infinity' ) {
 801                         // Entry in database (table ipblocks) is 'infinity' but 'ipboptions' uses 'infinite' or 'indefinite'
 802                         // Search for localization in 'ipboptions'
 803                         $scBlockExpiryOptions = wfMsg( 'ipboptions' );
 804                         foreach ( explode( ',', $scBlockExpiryOptions ) as $option ) {
 805                                 if ( strpos( $option, ":" ) === false )
 806                                         continue;
 807                                 list( $show, $value ) = explode( ":", $option );
 808                                 if ( $value == 'infinite' || $value == 'indefinite' ) {
 809                                         $blockExpiry = $show;
 810                                         break;
 811                                 }
 812                         }
 813                 } else {
 814                         $blockExpiry = $wgLang->timeanddate( wfTimestamp( TS_MW, $blockExpiry ), true );
 815                 }
 816
 817                 if ( $wgUser->mBlock->mAuto ) {
 818                         $msg = 'autoblockedtext';
 819                 } else {
 820                         $msg = 'blockedtext';
 821                 }
 822
 823                 /* $ip returns who *is* being blocked, $intended contains who was meant to be blocked.
 824                  * This could be a username, an ip range, or a single ip. */
 825                 $intended = $wgUser->mBlock->mAddress;
 826
 827                 $this->addWikiText( wfMsg( $msg, $link, $reason, $ip, $name, $blockid, $blockExpiry, $intended, $blockTimestamp ) );
 828
 829                 # Don't auto-return to special pages
 830                 if( $return ) {
 831                         $return = $wgTitle->getNamespace() > -1 ? $wgTitle->getPrefixedText() : NULL;
 832                         $this->returnToMain( false, $return );
 833                 }
 834         }
 835
 836         /**
 837          * Output a standard error page
 838          *
 839          * @param string $title Message key for page title
 840          * @param string $msg Message key for page text
 841          * @param array $params Message parameters
 842          */
 843         public function showErrorPage( $title, $msg, $params = array() ) {
 844                 global $wgTitle;
 845                 if ( isset($wgTitle) ) {
 846                         $this->mDebugtext .= 'Original title: ' . $wgTitle->getPrefixedText() . "\n";
 847                 }
 848                 $this->setPageTitle( wfMsg( $title ) );
 849                 $this->setHTMLTitle( wfMsg( 'errorpagetitle' ) );
 850                 $this->setRobotpolicy( 'noindex,nofollow' );
 851                 $this->setArticleRelated( false );
 852                 $this->enableClientCache( false );
 853                 $this->mRedirect = '';
 854                 $this->mBodytext = '';
 855
 856                 array_unshift( $params, 'parse' );
 857                 array_unshift( $params, $msg );
 858                 $this->addHtml( call_user_func_array( 'wfMsgExt', $params ) );
 859
 860                 $this->returnToMain( false );
 861         }
 862
 863         /**
 864          * Output a standard permission error page
 865          *
 866          * @param array $errors Error message keys
 867          */
 868         public function showPermissionsErrorPage( $errors )
 869         {
 870                 global $wgTitle;
 871
 872                 $this->mDebugtext .= 'Original title: ' .
 873                 $wgTitle->getPrefixedText() . "\n";
 874                 $this->setPageTitle( wfMsg( 'permissionserrors' ) );
 875                 $this->setHTMLTitle( wfMsg( 'permissionserrors' ) );
 876                 $this->setRobotpolicy( 'noindex,nofollow' );
 877                 $this->setArticleRelated( false );
 878                 $this->enableClientCache( false );
 879                 $this->mRedirect = '';
 880                 $this->mBodytext = '';
 881                 $this->addWikiText( $this->formatPermissionsErrorMessage( $errors ) );
 882         }
 883
 884         /** @deprecated */
 885         public function errorpage( $title, $msg ) {
 886                 throw new ErrorPageError( $title, $msg );
 887         }
 888
 889         /**
 890          * Display an error page indicating that a given version of MediaWiki is
 891          * required to use it
 892          *
 893          * @param mixed $version The version of MediaWiki needed to use the page
 894          */
 895         public function versionRequired( $version ) {
 896                 $this->setPageTitle( wfMsg( 'versionrequired', $version ) );
 897                 $this->setHTMLTitle( wfMsg( 'versionrequired', $version ) );
 898                 $this->setRobotpolicy( 'noindex,nofollow' );
 899                 $this->setArticleRelated( false );
 900                 $this->mBodytext = '';
 901
 902                 $this->addWikiText( wfMsg( 'versionrequiredtext', $version ) );
 903                 $this->returnToMain();
 904         }
 905
 906         /**
 907          * Display an error page noting that a given permission bit is required.
 908          *
 909          * @param string $permission key required
 910          */
 911         public function permissionRequired( $permission ) {
 912                 global $wgGroupPermissions, $wgUser;
 913
 914                 $this->setPageTitle( wfMsg( 'badaccess' ) );
 915                 $this->setHTMLTitle( wfMsg( 'errorpagetitle' ) );
 916                 $this->setRobotpolicy( 'noindex,nofollow' );
 917                 $this->setArticleRelated( false );
 918                 $this->mBodytext = '';
 919
 920                 $groups = array();
 921                 foreach( $wgGroupPermissions as $key => $value ) {
 922                         if( isset( $value[$permission] ) && $value[$permission] == true ) {
 923                                 $groupName = User::getGroupName( $key );
 924                                 $groupPage = User::getGroupPage( $key );
 925                                 if( $groupPage ) {
 926                                         $skin = $wgUser->getSkin();
 927                                         $groups[] = $skin->makeLinkObj( $groupPage, $groupName );
 928                                 } else {
 929                                         $groups[] = $groupName;
 930                                 }
 931                         }
 932                 }
 933                 $n = count( $groups );
 934                 $groups = implode( ', ', $groups );
 935                 switch( $n ) {
 936                         case 0:
 937                         case 1:
 938                         case 2:
 939                                 $message = wfMsgHtml( "badaccess-group$n", $groups );
 940                                 break;
 941                         default:
 942                                 $message = wfMsgHtml( 'badaccess-groups', $groups );
 943                 }
 944                 $this->addHtml( $message );
 945                 $this->returnToMain( false );
 946         }
 947
 948         /**
 949          * Use permissionRequired.
 950          * @deprecated
 951          */
 952         public function sysopRequired() {
 953                 throw new MWException( "Call to deprecated OutputPage::sysopRequired() method\n" );
 954         }
 955
 956         /**
 957          * Use permissionRequired.
 958          * @deprecated
 959          */
 960         public function developerRequired() {
 961                 throw new MWException( "Call to deprecated OutputPage::developerRequired() method\n" );
 962         }
 963
 964         /**
 965          * Produce the stock "please login to use the wiki" page
 966          */
 967         public function loginToUse() {
 968                 global $wgUser, $wgTitle, $wgContLang;
 969
 970                 if( $wgUser->isLoggedIn() ) {
 971                         $this->permissionRequired( 'read' );
 972                         return;
 973                 }
 974
 975                 $skin = $wgUser->getSkin();
 976
 977                 $this->setPageTitle( wfMsg( 'loginreqtitle' ) );
 978                 $this->setHtmlTitle( wfMsg( 'errorpagetitle' ) );
 979                 $this->setRobotPolicy( 'noindex,nofollow' );
 980                 $this->setArticleFlag( false );
 981
 982                 $loginTitle = SpecialPage::getTitleFor( 'Userlogin' );
 983                 $loginLink = $skin->makeKnownLinkObj( $loginTitle, wfMsgHtml( 'loginreqlink' ), 'returnto=' . $wgTitle->getPrefixedUrl() );
 984                 $this->addHtml( wfMsgWikiHtml( 'loginreqpagetext', $loginLink ) );
 985                 $this->addHtml( "\n<!--" . $wgTitle->getPrefixedUrl() . "-->" );
 986
 987                 # Don't return to the main page if the user can't read it
 988                 # otherwise we'll end up in a pointless loop
 989                 $mainPage = Title::newMainPage();
 990                 if( $mainPage->userCanRead() )
 991                         $this->returnToMain( true, $mainPage );
 992         }
 993
 994         /** @deprecated */
 995         public function databaseError( $fname, $sql, $error, $errno ) {
 996                 throw new MWException( "OutputPage::databaseError is obsolete\n" );
 997         }
 998
 999         /**
1000          * @param array $errors An array of arrays returned by Title::getUserPermissionsErrors
1001          * @return string The wikitext error-messages, formatted into a list.
1002          */
1003         public function formatPermissionsErrorMessage( $errors ) {
1004                 $text = wfMsgExt( 'permissionserrorstext', array( 'parsemag' ), count( $errors ) ) . "\n\n";
1005
1006                 if (count( $errors ) > 1) {
1007                         $text .= '<ul class="permissions-errors">' . "\n";
1008
1009                         foreach( $errors as $error )
1010                         {
1011                                 $text .= '<li>';
1012                                 $text .= call_user_func_array( 'wfMsg', $error );
1013                                 $text .= "</li>\n";
1014                         }
1015                         $text .= '</ul>';
1016                 } else {
1017                         $text .= '<div class="permissions-errors">' . call_user_func_array( 'wfMsg', $errors[0]) . '</div>';
1018                 }
1019
1020                 return $text;
1021         }
1022
1023         /**
1024          * Display a page stating that the Wiki is in read-only mode,
1025          * and optionally show the source of the page that the user
1026          * was trying to edit.  Should only be called (for this
1027          * purpose) after wfReadOnly() has returned true.
1028          *
1029          * For historical reasons, this function is _also_ used to
1030          * show the error message when a user tries to edit a page
1031          * they are not allowed to edit.  (Unless it's because they're
1032          * blocked, then we show blockedPage() instead.)  In this
1033          * case, the second parameter should be set to true and a list
1034          * of reasons supplied as the third parameter.
1035          *
1036          * @todo Needs to be split into multiple functions.
1037          *
1038          * @param string $source    Source code to show (or null).
1039          * @param bool   $protected Is this a permissions error?
1040          * @param array  $reasons   List of reasons for this error, as returned by Title::getUserPermissionsErrors().
1041          */
1042         public function readOnlyPage( $source = null, $protected = false, $reasons = array() ) {
1043                 global $wgUser, $wgReadOnlyFile, $wgReadOnly, $wgTitle;
1044                 $skin = $wgUser->getSkin();
1045
1046                 $this->setRobotpolicy( 'noindex,nofollow' );
1047                 $this->setArticleRelated( false );
1048
1049                 // If no reason is given, just supply a default "I can't let you do
1050                 // that, Dave" message.  Should only occur if called by legacy code.
1051                 if ( $protected && empty($reasons) ) {
1052                         $reasons[] = array( 'badaccess-group0' );
1053                 }
1054
1055                 if ( !empty($reasons) ) {
1056                         // Permissions error
1057                         if( $source ) {
1058                                 $this->setPageTitle( wfMsg( 'viewsource' ) );
1059                                 $this->setSubtitle( wfMsg( 'viewsourcefor', $skin->makeKnownLinkObj( $wgTitle ) ) );
1060                         } else {
1061                                 $this->setPageTitle( wfMsg( 'badaccess' ) );
1062                         }
1063                         $this->addWikiText( $this->formatPermissionsErrorMessage( $reasons ) );
1064                 } else {
1065                         // Wiki is read only
1066                         $this->setPageTitle( wfMsg( 'readonly' ) );
1067                         if ( $wgReadOnly ) {
1068                                 $reason = $wgReadOnly;
1069                         } else {
1070                                 // Should not happen, user should have called wfReadOnly() first
1071                                 $reason = file_get_contents( $wgReadOnlyFile );
1072                         }
1073                         $this->addWikiText( wfMsg( 'readonlytext', $reason ) );
1074                 }
1075
1076                 // Show source, if supplied
1077                 if( is_string( $source ) ) {
1078                         $this->addWikiText( wfMsg( 'viewsourcetext' ) );
1079                         $text = wfOpenElement( 'textarea',
1080                                                 array( 'id'   => 'wpTextbox1',
1081                                                        'name' => 'wpTextbox1',
1082                                                        'cols' => $wgUser->getOption( 'cols' ),
1083                                                        'rows' => $wgUser->getOption( 'rows' ),
1084                                                        'readonly' => 'readonly' ) );
1085                         $text .= htmlspecialchars( $source );
1086                         $text .= wfCloseElement( 'textarea' );
1087                         $this->addHTML( $text );
1088
1089                         // Show templates used by this article
1090                         $skin = $wgUser->getSkin();
1091                         $article = new Article( $wgTitle );
1092                         $this->addHTML( $skin->formatTemplates( $article->getUsedTemplates() ) );
1093                 }
1094
1095                 # If the title doesn't exist, it's fairly pointless to print a return
1096                 # link to it.  After all, you just tried editing it and couldn't, so
1097                 # what's there to do there?
1098                 if( $wgTitle->exists() ) {
1099                         $this->returnToMain( false, $wgTitle );
1100                 }
1101         }
1102
1103         /** @deprecated */
1104         public function fatalError( $message ) {
1105                 throw new FatalError( $message );
1106         }
1107
1108         /** @deprecated */
1109         public function unexpectedValueError( $name, $val ) {
1110                 throw new FatalError( wfMsg( 'unexpected', $name, $val ) );
1111         }
1112
1113         /** @deprecated */
1114         public function fileCopyError( $old, $new ) {
1115                 throw new FatalError( wfMsg( 'filecopyerror', $old, $new ) );
1116         }
1117
1118         /** @deprecated */
1119         public function fileRenameError( $old, $new ) {
1120                 throw new FatalError( wfMsg( 'filerenameerror', $old, $new ) );
1121         }
1122
1123         /** @deprecated */
1124         public function fileDeleteError( $name ) {
1125                 throw new FatalError( wfMsg( 'filedeleteerror', $name ) );
1126         }
1127
1128         /** @deprecated */
1129         public function fileNotFoundError( $name ) {
1130                 throw new FatalError( wfMsg( 'filenotfound', $name ) );
1131         }
1132
1133         public function showFatalError( $message ) {
1134                 $this->setPageTitle( wfMsg( "internalerror" ) );
1135                 $this->setRobotpolicy( "noindex,nofollow" );
1136                 $this->setArticleRelated( false );
1137                 $this->enableClientCache( false );
1138                 $this->mRedirect = '';
1139                 $this->mBodytext = $message;
1140         }
1141
1142         public function showUnexpectedValueError( $name, $val ) {
1143                 $this->showFatalError( wfMsg( 'unexpected', $name, $val ) );
1144         }
1145
1146         public function showFileCopyError( $old, $new ) {
1147                 $this->showFatalError( wfMsg( 'filecopyerror', $old, $new ) );
1148         }
1149
1150         public function showFileRenameError( $old, $new ) {
1151                 $this->showFatalError( wfMsg( 'filerenameerror', $old, $new ) );
1152         }
1153
1154         public function showFileDeleteError( $name ) {
1155                 $this->showFatalError( wfMsg( 'filedeleteerror', $name ) );
1156         }
1157
1158         public function showFileNotFoundError( $name ) {
1159                 $this->showFatalError( wfMsg( 'filenotfound', $name ) );
1160         }
1161
1162         /**
1163          * Add a "return to" link pointing to a specified title
1164          *
1165          * @param Title $title Title to link
1166          */
1167         public function addReturnTo( $title ) {
1168                 global $wgUser;
1169                 $link = wfMsg( 'returnto', $wgUser->getSkin()->makeLinkObj( $title ) );
1170                 $this->addHtml( "<p>{$link}</p>\n" );
1171         }
1172
1173         /**
1174          * Add a "return to" link pointing to a specified title,
1175          * or the title indicated in the request, or else the main page
1176          *
1177          * @param null $unused No longer used
1178          * @param Title $returnto Title to return to
1179          */
1180         public function returnToMain( $unused = null, $returnto = NULL ) {
1181                 global $wgRequest;
1182
1183                 if ( $returnto == NULL ) {
1184                         $returnto = $wgRequest->getText( 'returnto' );
1185                 }
1186
1187                 if ( '' === $returnto ) {
1188                         $returnto = Title::newMainPage();
1189                 }
1190
1191                 if ( is_object( $returnto ) ) {
1192                         $titleObj = $returnto;
1193                 } else {
1194                         $titleObj = Title::newFromText( $returnto );
1195                 }
1196                 if ( !is_object( $titleObj ) ) {
1197                         $titleObj = Title::newMainPage();
1198                 }
1199
1200                 $this->addReturnTo( $titleObj );
1201         }
1202
1203         /**
1204          * This function takes the title (first item of mGoodLinks), categories, existing and broken links for the page
1205          * and uses the first 10 of them for META keywords
1206          *
1207          * @param ParserOutput &$parserOutput
1208          */
1209         private function addKeywords( &$parserOutput ) {
1210                 global $wgTitle;
1211                 $this->addKeyword( $wgTitle->getPrefixedText() );
1212                 $count = 1;
1213                 $links2d =& $parserOutput->getLinks();
1214                 if ( !is_array( $links2d ) ) {
1215                         return;
1216                 }
1217                 foreach ( $links2d as $dbkeys ) {
1218                         foreach( $dbkeys as $dbkey => $unused ) {
1219                                 $this->addKeyword( $dbkey );
1220                                 if ( ++$count > 10 ) {
1221                                         break 2;
1222                                 }
1223                         }
1224                 }
1225         }
1226
1227         /**
1228          * @return string The doctype, opening <html>, and head element.
1229          */
1230         public function headElement() {
1231                 global $wgDocType, $wgDTD, $wgContLanguageCode, $wgOutputEncoding, $wgMimeType;
1232                 global $wgXhtmlDefaultNamespace, $wgXhtmlNamespaces;
1233                 global $wgUser, $wgContLang, $wgUseTrackbacks, $wgTitle, $wgStyleVersion;
1234
1235                 if( $wgMimeType == 'text/xml' || $wgMimeType == 'application/xhtml+xml' || $wgMimeType == 'application/xml' ) {
1236                         $ret = "<?xml version=\"1.0\" encoding=\"$wgOutputEncoding\" ?>\n";
1237                 } else {
1238                         $ret = '';
1239                 }
1240
1241                 $ret .= "<!DOCTYPE html PUBLIC \"$wgDocType\"\n        \"$wgDTD\">\n";
1242
1243                 if ( '' == $this->getHTMLTitle() ) {
1244                         $this->setHTMLTitle(  wfMsg( 'pagetitle', $this->getPageTitle() ));
1245                 }
1246
1247                 $rtl = $wgContLang->isRTL() ? " dir='RTL'" : '';
1248                 $ret .= "<html xmlns=\"{$wgXhtmlDefaultNamespace}\" ";
1249                 foreach($wgXhtmlNamespaces as $tag => $ns) {
1250                         $ret .= "xmlns:{$tag}=\"{$ns}\" ";
1251                 }
1252                 $ret .= "xml:lang=\"$wgContLanguageCode\" lang=\"$wgContLanguageCode\" $rtl>\n";
1253                 $ret .= "<head>\n<title>" . htmlspecialchars( $this->getHTMLTitle() ) . "</title>\n";
1254                 array_push( $this->mMetatags, array( "http:Content-type", "$wgMimeType; charset={$wgOutputEncoding}" ) );
1255
1256                 $ret .= $this->getHeadLinks();
1257                 global $wgStylePath;
1258                 if( $this->isPrintable() ) {
1259                         $media = '';
1260                 } else {
1261                         $media = "media='print'";
1262                 }
1263                 $printsheet = htmlspecialchars( "$wgStylePath/common/wikiprintable.css?$wgStyleVersion" );
1264                 $ret .= "<link rel='stylesheet' type='text/css' $media href='$printsheet' />\n";
1265
1266                 $sk = $wgUser->getSkin();
1267                 $ret .= $sk->getHeadScripts( $this->mAllowUserJs );
1268                 $ret .= $this->mScripts;
1269                 $ret .= $sk->getUserStyles();
1270                 $ret .= $this->getHeadItems();
1271
1272                 if ($wgUseTrackbacks && $this->isArticleRelated())
1273                         $ret .= $wgTitle->trackbackRDF();
1274
1275                 $ret .= "</head>\n";
1276                 return $ret;
1277         }
1278
1279         /**
1280          * @return string HTML tag links to be put in the header.
1281          */
1282         public function getHeadLinks() {
1283                 global $wgRequest;
1284                 $ret = '';
1285                 foreach ( $this->mMetatags as $tag ) {
1286                         if ( 0 == strcasecmp( 'http:', substr( $tag[0], 0, 5 ) ) ) {
1287                                 $a = 'http-equiv';
1288                                 $tag[0] = substr( $tag[0], 5 );
1289                         } else {
1290                                 $a = 'name';
1291                         }
1292                         $ret .= "<meta $a=\"{$tag[0]}\" content=\"{$tag[1]}\" />\n";
1293                 }
1294
1295                 $p = $this->mRobotpolicy;
1296                 if( $p !== '' && $p != 'index,follow' ) {
1297                         // http://www.robotstxt.org/wc/meta-user.html
1298                         // Only show if it's different from the default robots policy
1299                         $ret .= "<meta name=\"robots\" content=\"$p\" />\n";
1300                 }
1301
1302                 if ( count( $this->mKeywords ) > 0 ) {
1303                         $strip = array(
1304                                 "/<.*?>/" => '',
1305                                 "/_/" => ' '
1306                         );
1307                         $ret .= "\t\t<meta name=\"keywords\" content=\"" .
1308                           htmlspecialchars(preg_replace(array_keys($strip), array_values($strip),implode( ",", $this->mKeywords ))) . "\" />\n";
1309                 }
1310                 foreach ( $this->mLinktags as $tag ) {
1311                         $ret .= "\t\t<link";
1312                         foreach( $tag as $attr => $val ) {
1313                                 $ret .= " $attr=\"" . htmlspecialchars( $val ) . "\"";
1314                         }
1315                         $ret .= " />\n";
1316                 }
1317
1318                 foreach( $this->getSyndicationLinks() as $format => $link ) {
1319                         # Use the page name for the title (accessed through $wgTitle since
1320                         # there's no other way).  In principle, this could lead to issues
1321                         # with having the same name for different feeds corresponding to
1322                         # the same page, but we can't avoid that at this low a level.
1323                         global $wgTitle;
1324
1325                         $ret .= $this->feedLink(
1326                                 $format,
1327                                 $link,
1328                                 wfMsg( "page-{$format}-feed", $wgTitle->getPrefixedText() ) ); # Used messages: 'page-rss-feed' and 'page-atom-feed' (for an easier grep)
1329                 }
1330
1331                 # Recent changes feed should appear on every page
1332                 # Put it after the per-page feed to avoid changing existing behavior.
1333                 # It's still available, probably via a menu in your browser.
1334                 global $wgSitename;
1335                 $rctitle = SpecialPage::getTitleFor( 'Recentchanges' );
1336                 $ret .= $this->feedLink(
1337                         'rss',
1338                         $rctitle->getFullURL( 'feed=rss' ),
1339                         wfMsg( 'site-rss-feed', $wgSitename ) );
1340                 $ret .= $this->feedLink(
1341                         'atom',
1342                         $rctitle->getFullURL( 'feed=atom' ),
1343                         wfMsg( 'site-atom-feed', $wgSitename ) );
1344
1345                 return $ret;
1346         }
1347
1348         /**
1349          * Return URLs for each supported syndication format for this page.
1350          * @return array associating format keys with URLs
1351          */
1352         public function getSyndicationLinks() {
1353                 global $wgTitle, $wgFeedClasses;
1354                 $links = array();
1355
1356                 if( $this->isSyndicated() ) {
1357                         if( is_string( $this->getFeedAppendQuery() ) ) {
1358                                 $appendQuery = "&" . $this->getFeedAppendQuery();
1359                         } else {
1360                                 $appendQuery = "";
1361                         }
1362
1363                         foreach( $wgFeedClasses as $format => $class ) {
1364                                 $links[$format] = $wgTitle->getLocalUrl( "feed=$format{$appendQuery}" );
1365                         }
1366                 }
1367                 return $links;
1368         }
1369
1370         /**
1371          * Generate a <link rel/> for an RSS feed.
1372          */
1373         private function feedLink( $type, $url, $text ) {
1374                 return Xml::element( 'link', array(
1375                         'rel' => 'alternate',
1376                         'type' => "application/$type+xml",
1377                         'title' => $text,
1378                         'href' => $url ) ) . "\n";
1379         }
1380
1381         /**
1382          * Turn off regular page output and return an error reponse
1383          * for when rate limiting has triggered.
1384          */
1385         public function rateLimited() {
1386                 global $wgOut, $wgTitle;
1387
1388                 $this->setPageTitle(wfMsg('actionthrottled'));
1389                 $this->setRobotPolicy( 'noindex,follow' );
1390                 $this->setArticleRelated( false );
1391                 $this->enableClientCache( false );
1392                 $this->mRedirect = '';
1393                 $this->clearHTML();
1394                 $this->setStatusCode(503);
1395                 $this->addWikiText( wfMsg('actionthrottledtext') );
1396
1397                 $this->returnToMain( false, $wgTitle );
1398         }
1399
1400         /**
1401          * Show an "add new section" link?
1402          *
1403          * @return bool
1404          */
1405         public function showNewSectionLink() {
1406                 return $this->mNewSectionLink;
1407         }
1408
1409         /**
1410          * Show a warning about slave lag
1411          *
1412          * If the lag is higher than $wgSlaveLagCritical seconds,
1413          * then the warning is a bit more obvious. If the lag is
1414          * lower than $wgSlaveLagWarning, then no warning is shown.
1415          *
1416          * @param int $lag Slave lag
1417          */
1418         public function showLagWarning( $lag ) {
1419                 global $wgSlaveLagWarning, $wgSlaveLagCritical;
1420                 if( $lag >= $wgSlaveLagWarning ) {
1421                         $message = $lag < $wgSlaveLagCritical
1422                                 ? 'lag-warn-normal'
1423                                 : 'lag-warn-high';
1424                         $warning = wfMsgExt( $message, 'parse', $lag );
1425                         $this->addHtml( "<div class=\"mw-{$message}\">\n{$warning}\n</div>\n" );
1426                 }
1427         }
1428
1429 }