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(), $mLanguageLinks = array();
  16         var $mScripts = '', $mLinkColours, $mPageLinkTitle = '', $mHeadItems = array();
  17         var $mTemplateIds = array();
  18
  19         var $mAllowUserJs;
  20         var $mSuppressQuickbar = false;
  21         var $mOnloadHandler = '';
  22         var $mDoNothing = false;
  23         var $mContainsOldMagic = 0, $mContainsNewMagic = 0;
  24         var $mIsArticleRelated = true;
  25         protected $mParserOptions = null; // lazy initialised, use parserOptions()
  26         var $mShowFeedLinks = false;
  27         var $mFeedLinksAppendQuery = false;
  28         var $mEnableClientCache = true;
  29         var $mArticleBodyOnly = false;
  30
  31         var $mNewSectionLink = false;
  32         var $mNoGallery = false;
  33         var $mPageTitleActionText = '';
  34         var $mParseWarnings = array();
  35         var $mSquidMaxage = 0;
  36         var $mRevisionId = null;
  37
  38         /**
  39          * An array of stylesheet filenames (relative from skins path), with options
  40          * for CSS media, IE conditions, and RTL/LTR direction.
  41          * For internal use; add settings in the skin via $this->addStyle()
  42          */
  43         var $styles = array();
  44
  45         private $mIndexPolicy = 'index';
  46         private $mFollowPolicy = 'follow';
  47
  48         /**
  49          * Constructor
  50          * Initialise private variables
  51          */
  52         function __construct() {
  53                 global $wgAllowUserJs;
  54                 $this->mAllowUserJs = $wgAllowUserJs;
  55         }
  56
  57         public function redirect( $url, $responsecode = '302' ) {
  58                 # Strip newlines as a paranoia check for header injection in PHP<5.1.2
  59                 $this->mRedirect = str_replace( "\n", '', $url );
  60                 $this->mRedirectCode = $responsecode;
  61         }
  62
  63         public function getRedirect() {
  64                 return $this->mRedirect;
  65         }
  66
  67         /**
  68          * Set the HTTP status code to send with the output.
  69          *
  70          * @param int $statusCode
  71          * @return nothing
  72          */
  73         function setStatusCode( $statusCode ) { $this->mStatusCode = $statusCode; }
  74
  75         /**
  76          * Add a new <meta> tag
  77          * To add an http-equiv meta tag, precede the name with "http:"
  78          *
  79          * @param $name tag name
  80          * @param $val tag value
  81          */
  82         function addMeta( $name, $val ) {
  83                 array_push( $this->mMetatags, array( $name, $val ) );
  84         }
  85
  86         function addKeyword( $text ) { array_push( $this->mKeywords, $text ); }
  87         function addScript( $script ) { $this->mScripts .= "\t\t".$script; }
  88
  89         function addExtensionStyle( $url ) {
  90                 $linkarr = array( 'rel' => 'stylesheet', 'href' => $url, 'type' => 'text/css' );
  91                 array_push( $this->mExtStyles, $linkarr );
  92         }
  93
  94         /**
  95          * Add a JavaScript file out of skins/common, or a given relative path.
  96          * @param string $file filename in skins/common or complete on-server path (/foo/bar.js)
  97          */
  98         function addScriptFile( $file ) {
  99                 global $wgStylePath, $wgStyleVersion, $wgJsMimeType;
 100                 if( substr( $file, 0, 1 ) == '/' ) {
 101                         $path = $file;
 102                 } else {
 103                         $path =  "{$wgStylePath}/common/{$file}";
 104                 }
 105                 $this->addScript( "<script type=\"{$wgJsMimeType}\" src=\"$path?$wgStyleVersion\"></script>\n" );
 106         }
 107
 108         /**
 109          * Add a self-contained script tag with the given contents
 110          * @param string $script JavaScript text, no <script> tags
 111          */
 112         function addInlineScript( $script ) {
 113                 global $wgJsMimeType;
 114                 $this->mScripts .= "<script type=\"$wgJsMimeType\">/*<![CDATA[*/\n$script\n/*]]>*/</script>";
 115         }
 116
 117         function getScript() {
 118                 return $this->mScripts . $this->getHeadItems();
 119         }
 120
 121         function getHeadItems() {
 122                 $s = '';
 123                 foreach ( $this->mHeadItems as $item ) {
 124                         $s .= $item;
 125                 }
 126                 return $s;
 127         }
 128
 129         function addHeadItem( $name, $value ) {
 130                 $this->mHeadItems[$name] = $value;
 131         }
 132
 133         function hasHeadItem( $name ) {
 134                 return isset( $this->mHeadItems[$name] );
 135         }
 136
 137         function setETag($tag) { $this->mETag = $tag; }
 138         function setArticleBodyOnly($only) { $this->mArticleBodyOnly = $only; }
 139         function getArticleBodyOnly($only) { return $this->mArticleBodyOnly; }
 140
 141         function addLink( $linkarr ) {
 142                 # $linkarr should be an associative array of attributes. We'll escape on output.
 143                 array_push( $this->mLinktags, $linkarr );
 144         }
 145
 146         # Get all links added by extensions
 147         function getExtStyle() {
 148                 return $this->mExtStyles;
 149         }
 150
 151         function addMetadataLink( $linkarr ) {
 152                 # note: buggy CC software only reads first "meta" link
 153                 static $haveMeta = false;
 154                 $linkarr['rel'] = ($haveMeta) ? 'alternate meta' : 'meta';
 155                 $this->addLink( $linkarr );
 156                 $haveMeta = true;
 157         }
 158
 159         /**
 160          * checkLastModified tells the client to use the client-cached page if
 161          * possible. If sucessful, the OutputPage is disabled so that
 162          * any future call to OutputPage->output() have no effect.
 163          *
 164          * Side effect: sets mLastModified for Last-Modified header
 165          *
 166          * @return bool True iff cache-ok headers was sent.
 167          */
 168         function checkLastModified ( $timestamp ) {
 169                 global $wgCachePages, $wgCacheEpoch, $wgUser, $wgRequest;
 170
 171                 if ( !$timestamp || $timestamp == '19700101000000' ) {
 172                         wfDebug( __METHOD__ . ": CACHE DISABLED, NO TIMESTAMP\n" );
 173                         return false;
 174                 }
 175                 if( !$wgCachePages ) {
 176                         wfDebug( __METHOD__ . ": CACHE DISABLED\n", false );
 177                         return false;
 178                 }
 179                 if( $wgUser->getOption( 'nocache' ) ) {
 180                         wfDebug( __METHOD__ . ": USER DISABLED CACHE\n", false );
 181                         return false;
 182                 }
 183
 184                 $timestamp = wfTimestamp( TS_MW, $timestamp );
 185                 $modifiedTimes = array(
 186                         'page' => $timestamp,
 187                         'user' => $wgUser->getTouched(),
 188                         'epoch' => $wgCacheEpoch
 189                 );
 190                 wfRunHooks( 'OutputPageCheckLastModified', array( &$modifiedTimes ) );
 191
 192                 $maxModified = max( $modifiedTimes );
 193                 $this->mLastModified = wfTimestamp( TS_RFC2822, $maxModified );
 194
 195                 if( empty( $_SERVER['HTTP_IF_MODIFIED_SINCE'] ) ) {
 196                         wfDebug( __METHOD__ . ": client did not send If-Modified-Since header\n", false );
 197                         return false;
 198                 }
 199
 200                 # Make debug info
 201                 $info = '';
 202                 foreach ( $modifiedTimes as $name => $value ) {
 203                         if ( $info !== '' ) {
 204                                 $info .= ', ';
 205                         }
 206                         $info .= "$name=" . wfTimestamp( TS_ISO_8601, $value );
 207                 }
 208
 209                 # IE sends sizes after the date like this:
 210                 # Wed, 20 Aug 2003 06:51:19 GMT; length=5202
 211                 # this breaks strtotime().
 212                 $clientHeader = preg_replace( '/;.*$/', '', $_SERVER["HTTP_IF_MODIFIED_SINCE"] );
 213
 214                 wfSuppressWarnings(); // E_STRICT system time bitching
 215                 $clientHeaderTime = strtotime( $clientHeader );
 216                 wfRestoreWarnings();
 217                 if ( !$clientHeaderTime ) {
 218                         wfDebug( __METHOD__ . ": unable to parse the client's If-Modified-Since header: $clientHeader\n" );
 219                         return false;
 220                 }
 221                 $clientHeaderTime = wfTimestamp( TS_MW, $clientHeaderTime );
 222
 223                 wfDebug( __METHOD__ . ": client sent If-Modified-Since: " .
 224                         wfTimestamp( TS_ISO_8601, $clientHeaderTime ) . "\n", false );
 225                 wfDebug( __METHOD__ . ": effective Last-Modified: " .
 226                         wfTimestamp( TS_ISO_8601, $maxModified ) . "\n", false );
 227                 if( $clientHeaderTime < $maxModified ) {
 228                         wfDebug( __METHOD__ . ": STALE, $info\n", false );
 229                         return false;
 230                 }
 231
 232                 # Not modified
 233                 # Give a 304 response code and disable body output
 234                 wfDebug( __METHOD__ . ": NOT MODIFIED, $info\n", false );
 235                 $wgRequest->response()->header( "HTTP/1.1 304 Not Modified" );
 236                 $this->sendCacheControl();
 237                 $this->disable();
 238
 239                 // Don't output a compressed blob when using ob_gzhandler;
 240                 // it's technically against HTTP spec and seems to confuse
 241                 // Firefox when the response gets split over two packets.
 242                 wfClearOutputBuffers();
 243
 244                 return true;
 245         }
 246
 247         function setPageTitleActionText( $text ) {
 248                 $this->mPageTitleActionText = $text;
 249         }
 250
 251         function getPageTitleActionText () {
 252                 if ( isset( $this->mPageTitleActionText ) ) {
 253                         return $this->mPageTitleActionText;
 254                 }
 255         }
 256
 257         /**
 258          * Set the robot policy for the page: <http://www.robotstxt.org/meta.html>
 259          *
 260          * @param $policy string The literal string to output as the contents of
 261          *   the meta tag.  Will be parsed according to the spec and output in
 262          *   standardized form.
 263          * @return null
 264          */
 265         public function setRobotPolicy( $policy ) {
 266                 $policy = explode( ',', $policy );
 267                 $policy = array_map( 'trim', $policy );
 268
 269                 # The default policy is follow, so if nothing is said explicitly, we
 270                 # do that.
 271                 if( in_array( 'nofollow', $policy ) ) {
 272                         $this->mFollowPolicy = 'nofollow';
 273                 } else {
 274                         $this->mFollowPolicy = 'follow';
 275                 }
 276
 277                 if( in_array( 'noindex', $policy ) ) {
 278                         $this->mIndexPolicy = 'noindex';
 279                 } else {
 280                         $this->mIndexPolicy = 'index';
 281                 }
 282         }
 283
 284         /**
 285          * Set the index policy for the page, but leave the follow policy un-
 286          * touched.
 287          *
 288          * @param $policy string Either 'index' or 'noindex'.
 289          * @return null
 290          */
 291         public function setIndexPolicy( $policy ) {
 292                 $policy = trim( $policy );
 293                 if( in_array( $policy, array( 'index', 'noindex' ) ) ) {
 294                         $this->mIndexPolicy = $policy;
 295                 }
 296         }
 297
 298         /**
 299          * Set the follow policy for the page, but leave the index policy un-
 300          * touched.
 301          *
 302          * @param $policy string Either 'follow' or 'nofollow'.
 303          * @return null
 304          */
 305         public function setFollowPolicy( $policy ) {
 306                 $policy = trim( $policy );
 307                 if( in_array( $policy, array( 'follow', 'nofollow' ) ) ) {
 308                         $this->mFollowPolicy = $policy;
 309                 }
 310         }
 311
 312         public function setHTMLTitle( $name ) {$this->mHTMLtitle = $name; }
 313         public function setPageTitle( $name ) {
 314                 global $action, $wgContLang;
 315                 $name = $wgContLang->convert($name, true);
 316                 $this->mPagetitle = $name;
 317                 if(!empty($action)) {
 318                         $taction =  $this->getPageTitleActionText();
 319                         if( !empty( $taction ) ) {
 320                                 $name .= ' - '.$taction;
 321                         }
 322                 }
 323
 324                 $this->setHTMLTitle( wfMsg( 'pagetitle', $name ) );
 325         }
 326         public function getHTMLTitle() { return $this->mHTMLtitle; }
 327         public function getPageTitle() { return $this->mPagetitle; }
 328         public function setSubtitle( $str ) { $this->mSubtitle = /*$this->parse(*/$str/*)*/; } // @bug 2514
 329         public function appendSubtitle( $str ) { $this->mSubtitle .= /*$this->parse(*/$str/*)*/; } // @bug 2514
 330         public function getSubtitle() { return $this->mSubtitle; }
 331         public function isArticle() { return $this->mIsarticle; }
 332         public function setPrintable() { $this->mPrintable = true; }
 333         public function isPrintable() { return $this->mPrintable; }
 334         public function setSyndicated( $show = true ) { $this->mShowFeedLinks = $show; }
 335         public function isSyndicated() { return $this->mShowFeedLinks; }
 336         public function setFeedAppendQuery( $val ) { $this->mFeedLinksAppendQuery = $val; }
 337         public function getFeedAppendQuery() { return $this->mFeedLinksAppendQuery; }
 338         public function setOnloadHandler( $js ) { $this->mOnloadHandler = $js; }
 339         public function getOnloadHandler() { return $this->mOnloadHandler; }
 340         public function disable() { $this->mDoNothing = true; }
 341
 342         public function setArticleRelated( $v ) {
 343                 $this->mIsArticleRelated = $v;
 344                 if ( !$v ) {
 345                         $this->mIsarticle = false;
 346                 }
 347         }
 348         public function setArticleFlag( $v ) {
 349                 $this->mIsarticle = $v;
 350                 if ( $v ) {
 351                         $this->mIsArticleRelated = $v;
 352                 }
 353         }
 354
 355         public function isArticleRelated() { return $this->mIsArticleRelated; }
 356
 357         public function getLanguageLinks() { return $this->mLanguageLinks; }
 358         public function addLanguageLinks($newLinkArray) {
 359                 $this->mLanguageLinks += $newLinkArray;
 360         }
 361         public function setLanguageLinks($newLinkArray) {
 362                 $this->mLanguageLinks = $newLinkArray;
 363         }
 364
 365         public function getCategoryLinks() {
 366                 return $this->mCategoryLinks;
 367         }
 368
 369         /**
 370          * Add an array of categories, with names in the keys
 371          */
 372         public function addCategoryLinks( $categories ) {
 373                 global $wgUser, $wgContLang;
 374
 375                 if ( !is_array( $categories ) || count( $categories ) == 0 ) {
 376                         return;
 377                 }
 378
 379                 # Add the links to a LinkBatch
 380                 $arr = array( NS_CATEGORY => $categories );
 381                 $lb = new LinkBatch;
 382                 $lb->setArray( $arr );
 383
 384                 # Fetch existence plus the hiddencat property
 385                 $dbr = wfGetDB( DB_SLAVE );
 386                 $pageTable = $dbr->tableName( 'page' );
 387                 $where = $lb->constructSet( 'page', $dbr );
 388                 $propsTable = $dbr->tableName( 'page_props' );
 389                 $sql = "SELECT page_id, page_namespace, page_title, page_len, page_is_redirect, pp_value
 390                         FROM $pageTable LEFT JOIN $propsTable ON pp_propname='hiddencat' AND pp_page=page_id WHERE $where";
 391                 $res = $dbr->query( $sql, __METHOD__ );
 392
 393                 # Add the results to the link cache
 394                 $lb->addResultToCache( LinkCache::singleton(), $res );
 395
 396                 # Set all the values to 'normal'. This can be done with array_fill_keys in PHP 5.2.0+
 397                 $categories = array_combine( array_keys( $categories ),
 398                         array_fill( 0, count( $categories ), 'normal' ) );
 399
 400                 # Mark hidden categories
 401                 foreach ( $res as $row ) {
 402                         if ( isset( $row->pp_value ) ) {
 403                                 $categories[$row->page_title] = 'hidden';
 404                         }
 405                 }
 406
 407                 # Add the remaining categories to the skin
 408                 if ( wfRunHooks( 'OutputPageMakeCategoryLinks', array( &$this, $categories, &$this->mCategoryLinks ) ) ) {
 409                         $sk = $wgUser->getSkin();
 410                         foreach ( $categories as $category => $type ) {
 411                                 $title = Title::makeTitleSafe( NS_CATEGORY, $category );
 412                                 $text = $wgContLang->convertHtml( $title->getText() );
 413                                 $this->mCategoryLinks[$type][] = $sk->makeLinkObj( $title, $text );
 414                         }
 415                 }
 416         }
 417
 418         public function setCategoryLinks($categories) {
 419                 $this->mCategoryLinks = array();
 420                 $this->addCategoryLinks($categories);
 421         }
 422
 423         public function suppressQuickbar() { $this->mSuppressQuickbar = true; }
 424         public function isQuickbarSuppressed() { return $this->mSuppressQuickbar; }
 425
 426         public function disallowUserJs() { $this->mAllowUserJs = false; }
 427         public function isUserJsAllowed() { return $this->mAllowUserJs; }
 428
 429         public function prependHTML( $text ) { $this->mBodytext = $text . $this->mBodytext; }
 430         public function addHTML( $text ) { $this->mBodytext .= $text; }
 431         public function clearHTML() { $this->mBodytext = ''; }
 432         public function getHTML() { return $this->mBodytext; }
 433         public function debug( $text ) { $this->mDebugtext .= $text; }
 434
 435         /* @deprecated */
 436         public function setParserOptions( $options ) {
 437                 wfDeprecated( __METHOD__ );
 438                 return $this->parserOptions( $options );
 439         }
 440
 441         public function parserOptions( $options = null ) {
 442                 if ( !$this->mParserOptions ) {
 443                         $this->mParserOptions = new ParserOptions;
 444                 }
 445                 return wfSetVar( $this->mParserOptions, $options );
 446         }
 447
 448         /**
 449          * Set the revision ID which will be seen by the wiki text parser
 450          * for things such as embedded {{REVISIONID}} variable use.
 451          * @param mixed $revid an integer, or NULL
 452          * @return mixed previous value
 453          */
 454         public function setRevisionId( $revid ) {
 455                 $val = is_null( $revid ) ? null : intval( $revid );
 456                 return wfSetVar( $this->mRevisionId, $val );
 457         }
 458
 459         public function getRevisionId() {
 460                 return $this->mRevisionId;
 461         }
 462
 463         /**
 464          * Convert wikitext to HTML and add it to the buffer
 465          * Default assumes that the current page title will
 466          * be used.
 467          *
 468          * @param string $text
 469          * @param bool   $linestart
 470          */
 471         public function addWikiText( $text, $linestart = true ) {
 472                 global $wgTitle;
 473                 $this->addWikiTextTitle($text, $wgTitle, $linestart);
 474         }
 475
 476         public function addWikiTextWithTitle($text, &$title, $linestart = true) {
 477                 $this->addWikiTextTitle($text, $title, $linestart);
 478         }
 479
 480         function addWikiTextTitleTidy($text, &$title, $linestart = true) {
 481                 $this->addWikiTextTitle( $text, $title, $linestart, true );
 482         }
 483
 484         public function addWikiTextTitle($text, &$title, $linestart, $tidy = false) {
 485                 global $wgParser;
 486
 487                 wfProfileIn( __METHOD__ );
 488
 489                 wfIncrStats( 'pcache_not_possible' );
 490
 491                 $popts = $this->parserOptions();
 492                 $oldTidy = $popts->setTidy( $tidy );
 493
 494                 $parserOutput = $wgParser->parse( $text, $title, $popts,
 495                         $linestart, true, $this->mRevisionId );
 496
 497                 $popts->setTidy( $oldTidy );
 498
 499                 $this->addParserOutput( $parserOutput );
 500
 501                 wfProfileOut( __METHOD__ );
 502         }
 503
 504         /**
 505          * @todo document
 506          * @param ParserOutput object &$parserOutput
 507          */
 508         public function addParserOutputNoText( &$parserOutput ) {
 509                 global $wgTitle, $wgExemptFromUserRobotsControl, $wgContentNamespaces;
 510
 511                 $this->mLanguageLinks += $parserOutput->getLanguageLinks();
 512                 $this->addCategoryLinks( $parserOutput->getCategories() );
 513                 $this->mNewSectionLink = $parserOutput->getNewSection();
 514
 515                 if( is_null( $wgExemptFromUserRobotsControl ) ) {
 516                         $bannedNamespaces = $wgContentNamespaces;
 517                 } else {
 518                         $bannedNamespaces = $wgExemptFromUserRobotsControl;
 519                 }
 520                 if( !in_array( $wgTitle->getNamespace(), $bannedNamespaces ) ) {
 521                         # FIXME (bug 14900): This overrides $wgArticleRobotPolicies, and it
 522                         # shouldn't
 523                         $this->setIndexPolicy( $parserOutput->getIndexPolicy() );
 524                 }
 525
 526                 $this->addKeywords( $parserOutput );
 527                 $this->mParseWarnings = $parserOutput->getWarnings();
 528                 if ( $parserOutput->getCacheTime() == -1 ) {
 529                         $this->enableClientCache( false );
 530                 }
 531                 $this->mNoGallery = $parserOutput->getNoGallery();
 532                 $this->mHeadItems = array_merge( $this->mHeadItems, (array)$parserOutput->mHeadItems );
 533                 // Versioning...
 534                 foreach ( (array)$parserOutput->mTemplateIds as $ns => $dbks ) {
 535                         if ( isset( $this->mTemplateIds[$ns] ) ) {
 536                                 $this->mTemplateIds[$ns] = $dbks + $this->mTemplateIds[$ns];
 537                         } else {
 538                                 $this->mTemplateIds[$ns] = $dbks;
 539                         }
 540                 }
 541                 // Display title
 542                 if( ( $dt = $parserOutput->getDisplayTitle() ) !== false )
 543                         $this->setPageTitle( $dt );
 544
 545                 // Hooks registered in the object
 546                 global $wgParserOutputHooks;
 547                 foreach ( $parserOutput->getOutputHooks() as $hookInfo ) {
 548                         list( $hookName, $data ) = $hookInfo;
 549                         if ( isset( $wgParserOutputHooks[$hookName] ) ) {
 550                                 call_user_func( $wgParserOutputHooks[$hookName], $this, $parserOutput, $data );
 551                         }
 552                 }
 553
 554                 wfRunHooks( 'OutputPageParserOutput', array( &$this, $parserOutput ) );
 555         }
 556
 557         /**
 558          * @todo document
 559          * @param ParserOutput &$parserOutput
 560          */
 561         function addParserOutput( &$parserOutput ) {
 562                 $this->addParserOutputNoText( $parserOutput );
 563                 $text = $parserOutput->getText();
 564                 wfRunHooks( 'OutputPageBeforeHTML',array( &$this, &$text ) );
 565                 $this->addHTML( $text );
 566         }
 567
 568         /**
 569          * Add wikitext to the buffer, assuming that this is the primary text for a page view
 570          * Saves the text into the parser cache if possible.
 571          *
 572          * @param string  $text
 573          * @param Article $article
 574          * @param bool    $cache
 575          * @deprecated Use Article::outputWikitext
 576          */
 577         public function addPrimaryWikiText( $text, $article, $cache = true ) {
 578                 global $wgParser, $wgUser;
 579
 580                 wfDeprecated( __METHOD__ );
 581
 582                 $popts = $this->parserOptions();
 583                 $popts->setTidy(true);
 584                 $parserOutput = $wgParser->parse( $text, $article->mTitle,
 585                         $popts, true, true, $this->mRevisionId );
 586                 $popts->setTidy(false);
 587                 if ( $cache && $article && $parserOutput->getCacheTime() != -1 ) {
 588                         $parserCache = ParserCache::singleton();
 589                         $parserCache->save( $parserOutput, $article, $wgUser );
 590                 }
 591
 592                 $this->addParserOutput( $parserOutput );
 593         }
 594
 595         /**
 596          * @deprecated use addWikiTextTidy()
 597          */
 598         public function addSecondaryWikiText( $text, $linestart = true ) {
 599                 global $wgTitle;
 600                 wfDeprecated( __METHOD__ );
 601                 $this->addWikiTextTitleTidy($text, $wgTitle, $linestart);
 602         }
 603
 604         /**
 605          * Add wikitext with tidy enabled
 606          */
 607         public function addWikiTextTidy(  $text, $linestart = true ) {
 608                 global $wgTitle;
 609                 $this->addWikiTextTitleTidy($text, $wgTitle, $linestart);
 610         }
 611
 612
 613         /**
 614          * Add the output of a QuickTemplate to the output buffer
 615          *
 616          * @param QuickTemplate $template
 617          */
 618         public function addTemplate( &$template ) {
 619                 ob_start();
 620                 $template->execute();
 621                 $this->addHTML( ob_get_contents() );
 622                 ob_end_clean();
 623         }
 624
 625         /**
 626          * Parse wikitext and return the HTML.
 627          *
 628          * @param string $text
 629          * @param bool   $linestart Is this the start of a line?
 630          * @param bool   $interface ??
 631          */
 632         public function parse( $text, $linestart = true, $interface = false ) {
 633                 global $wgParser, $wgTitle;
 634                 if( is_null( $wgTitle ) ) {
 635                         throw new MWException( 'Empty $wgTitle in ' . __METHOD__ );
 636                 }
 637                 $popts = $this->parserOptions();
 638                 if ( $interface) { $popts->setInterfaceMessage(true); }
 639                 $parserOutput = $wgParser->parse( $text, $wgTitle, $popts,
 640                         $linestart, true, $this->mRevisionId );
 641                 if ( $interface) { $popts->setInterfaceMessage(false); }
 642                 return $parserOutput->getText();
 643         }
 644
 645         /**
 646          * @param Article $article
 647          * @param User    $user
 648          *
 649          * @return bool True if successful, else false.
 650          */
 651         public function tryParserCache( &$article, $user ) {
 652                 $parserCache = ParserCache::singleton();
 653                 $parserOutput = $parserCache->get( $article, $user );
 654                 if ( $parserOutput !== false ) {
 655                         $this->addParserOutput( $parserOutput );
 656                         return true;
 657                 } else {
 658                         return false;
 659                 }
 660         }
 661
 662         /**
 663          * @param int $maxage Maximum cache time on the Squid, in seconds.
 664          */
 665         public function setSquidMaxage( $maxage ) {
 666                 $this->mSquidMaxage = $maxage;
 667         }
 668
 669         /**
 670          * Use enableClientCache(false) to force it to send nocache headers
 671          * @param $state ??
 672          */
 673         public function enableClientCache( $state ) {
 674                 return wfSetVar( $this->mEnableClientCache, $state );
 675         }
 676
 677         function getCacheVaryCookies() {
 678                 global $wgCookiePrefix, $wgCacheVaryCookies;
 679                 static $cookies;
 680                 if ( $cookies === null ) {
 681                         $cookies = array_merge(
 682                                 array(
 683                                         "{$wgCookiePrefix}Token",
 684                                         "{$wgCookiePrefix}LoggedOut",
 685                                         session_name()
 686                                 ),
 687                                 $wgCacheVaryCookies
 688                         );
 689                         wfRunHooks('GetCacheVaryCookies', array( $this, &$cookies ) );
 690                 }
 691                 return $cookies;
 692         }
 693
 694         function uncacheableBecauseRequestVars() {
 695                 global $wgRequest;
 696                 return  $wgRequest->getText('useskin', false) === false
 697                         && $wgRequest->getText('uselang', false) === false;
 698         }
 699
 700         /**
 701          * Check if the request has a cache-varying cookie header
 702          * If it does, it's very important that we don't allow public caching
 703          */
 704         function haveCacheVaryCookies() {
 705                 global $wgRequest;
 706                 $cookieHeader = $wgRequest->getHeader( 'cookie' );
 707                 if ( $cookieHeader === false ) {
 708                         return false;
 709                 }
 710                 $cvCookies = $this->getCacheVaryCookies();
 711                 foreach ( $cvCookies as $cookieName ) {
 712                         # Check for a simple string match, like the way squid does it
 713                         if ( strpos( $cookieHeader, $cookieName ) ) {
 714                                 wfDebug( __METHOD__.": found $cookieName\n" );
 715                                 return true;
 716                         }
 717                 }
 718                 wfDebug( __METHOD__.": no cache-varying cookies found\n" );
 719                 return false;
 720         }
 721
 722         /** Get a complete X-Vary-Options header */
 723         public function getXVO() {
 724                 $cvCookies = $this->getCacheVaryCookies();
 725                 $xvo = 'X-Vary-Options: Accept-Encoding;list-contains=gzip,Cookie;';
 726                 $first = true;
 727                 foreach ( $cvCookies as $cookieName ) {
 728                         if ( $first ) {
 729                                 $first = false;
 730                         } else {
 731                                 $xvo .= ';';
 732                         }
 733                         $xvo .= 'string-contains=' . $cookieName;
 734                 }
 735                 return $xvo;
 736         }
 737
 738         public function sendCacheControl() {
 739                 global $wgUseSquid, $wgUseESI, $wgUseETag, $wgSquidMaxage, $wgRequest;
 740
 741                 $response = $wgRequest->response();
 742                 if ($wgUseETag && $this->mETag)
 743                         $response->header("ETag: $this->mETag");
 744
 745                 # don't serve compressed data to clients who can't handle it
 746                 # maintain different caches for logged-in users and non-logged in ones
 747                 $response->header( 'Vary: Accept-Encoding, Cookie' );
 748
 749                 # Add an X-Vary-Options header for Squid with Wikimedia patches
 750                 $response->header( $this->getXVO() );
 751
 752                 if( !$this->uncacheableBecauseRequestVars() && $this->mEnableClientCache ) {
 753                         if( $wgUseSquid && session_id() == '' &&
 754                           ! $this->isPrintable() && $this->mSquidMaxage != 0 && !$this->haveCacheVaryCookies() )
 755                         {
 756                                 if ( $wgUseESI ) {
 757                                         # We'll purge the proxy cache explicitly, but require end user agents
 758                                         # to revalidate against the proxy on each visit.
 759                                         # Surrogate-Control controls our Squid, Cache-Control downstream caches
 760                                         wfDebug( __METHOD__ . ": proxy caching with ESI; {$this->mLastModified} **\n", false );
 761                                         # start with a shorter timeout for initial testing
 762                                         # header( 'Surrogate-Control: max-age=2678400+2678400, content="ESI/1.0"');
 763                                         $response->header( 'Surrogate-Control: max-age='.$wgSquidMaxage.'+'.$this->mSquidMaxage.', content="ESI/1.0"');
 764                                         $response->header( 'Cache-Control: s-maxage=0, must-revalidate, max-age=0' );
 765                                 } else {
 766                                         # We'll purge the proxy cache for anons explicitly, but require end user agents
 767                                         # to revalidate against the proxy on each visit.
 768                                         # IMPORTANT! The Squid needs to replace the Cache-Control header with
 769                                         # Cache-Control: s-maxage=0, must-revalidate, max-age=0
 770                                         wfDebug( __METHOD__ . ": local proxy caching; {$this->mLastModified} **\n", false );
 771                                         # start with a shorter timeout for initial testing
 772                                         # header( "Cache-Control: s-maxage=2678400, must-revalidate, max-age=0" );
 773                                         $response->header( 'Cache-Control: s-maxage='.$this->mSquidMaxage.', must-revalidate, max-age=0' );
 774                                 }
 775                         } else {
 776                                 # We do want clients to cache if they can, but they *must* check for updates
 777                                 # on revisiting the page.
 778                                 wfDebug( __METHOD__ . ": private caching; {$this->mLastModified} **\n", false );
 779                                 $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
 780                                 $response->header( "Cache-Control: private, must-revalidate, max-age=0" );
 781                         }
 782                         if($this->mLastModified) {
 783                                 $response->header( "Last-Modified: {$this->mLastModified}" );
 784                         }
 785                 } else {
 786                         wfDebug( __METHOD__ . ": no caching **\n", false );
 787
 788                         # In general, the absence of a last modified header should be enough to prevent
 789                         # the client from using its cache. We send a few other things just to make sure.
 790                         $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
 791                         $response->header( 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate' );
 792                         $response->header( 'Pragma: no-cache' );
 793                 }
 794         }
 795
 796         /**
 797          * Finally, all the text has been munged and accumulated into
 798          * the object, let's actually output it:
 799          */
 800         public function output() {
 801                 global $wgUser, $wgOutputEncoding, $wgRequest;
 802                 global $wgContLanguageCode, $wgDebugRedirects, $wgMimeType;
 803                 global $wgJsMimeType, $wgUseAjax, $wgAjaxWatch;
 804                 global $wgEnableMWSuggest, $wgUniversalEditButton;
 805                 global $wgArticle, $wgTitle;
 806
 807                 if( $this->mDoNothing ){
 808                         return;
 809                 }
 810
 811                 wfProfileIn( __METHOD__ );
 812
 813                 if ( '' != $this->mRedirect ) {
 814                         # Standards require redirect URLs to be absolute
 815                         $this->mRedirect = wfExpandUrl( $this->mRedirect );
 816                         if( $this->mRedirectCode == '301') {
 817                                 if( !$wgDebugRedirects ) {
 818                                         $wgRequest->response()->header("HTTP/1.1 {$this->mRedirectCode} Moved Permanently");
 819                                 }
 820                                 $this->mLastModified = wfTimestamp( TS_RFC2822 );
 821                         }
 822
 823                         $this->sendCacheControl();
 824
 825                         $wgRequest->response()->header("Content-Type: text/html; charset=utf-8");
 826                         if( $wgDebugRedirects ) {
 827                                 $url = htmlspecialchars( $this->mRedirect );
 828                                 print "<html>\n<head>\n<title>Redirect</title>\n</head>\n<body>\n";
 829                                 print "<p>Location: <a href=\"$url\">$url</a></p>\n";
 830                                 print "</body>\n</html>\n";
 831                         } else {
 832                                 $wgRequest->response()->header( 'Location: '.$this->mRedirect );
 833                         }
 834                         wfProfileOut( __METHOD__ );
 835                         return;
 836                 }
 837                 elseif ( $this->mStatusCode )
 838                 {
 839                         $statusMessage = array(
 840                                 100 => 'Continue',
 841                                 101 => 'Switching Protocols',
 842                                 102 => 'Processing',
 843                                 200 => 'OK',
 844                                 201 => 'Created',
 845                                 202 => 'Accepted',
 846                                 203 => 'Non-Authoritative Information',
 847                                 204 => 'No Content',
 848                                 205 => 'Reset Content',
 849                                 206 => 'Partial Content',
 850                                 207 => 'Multi-Status',
 851                                 300 => 'Multiple Choices',
 852                                 301 => 'Moved Permanently',
 853                                 302 => 'Found',
 854                                 303 => 'See Other',
 855                                 304 => 'Not Modified',
 856                                 305 => 'Use Proxy',
 857                                 307 => 'Temporary Redirect',
 858                                 400 => 'Bad Request',
 859                                 401 => 'Unauthorized',
 860                                 402 => 'Payment Required',
 861                                 403 => 'Forbidden',
 862                                 404 => 'Not Found',
 863                                 405 => 'Method Not Allowed',
 864                                 406 => 'Not Acceptable',
 865                                 407 => 'Proxy Authentication Required',
 866                                 408 => 'Request Timeout',
 867                                 409 => 'Conflict',
 868                                 410 => 'Gone',
 869                                 411 => 'Length Required',
 870                                 412 => 'Precondition Failed',
 871                                 413 => 'Request Entity Too Large',
 872                                 414 => 'Request-URI Too Large',
 873                                 415 => 'Unsupported Media Type',
 874                                 416 => 'Request Range Not Satisfiable',
 875                                 417 => 'Expectation Failed',
 876                                 422 => 'Unprocessable Entity',
 877                                 423 => 'Locked',
 878                                 424 => 'Failed Dependency',
 879                                 500 => 'Internal Server Error',
 880                                 501 => 'Not Implemented',
 881                                 502 => 'Bad Gateway',
 882                                 503 => 'Service Unavailable',
 883                                 504 => 'Gateway Timeout',
 884                                 505 => 'HTTP Version Not Supported',
 885                                 507 => 'Insufficient Storage'
 886                         );
 887
 888                         if ( $statusMessage[$this->mStatusCode] )
 889                                 $wgRequest->response()->header( 'HTTP/1.1 ' . $this->mStatusCode . ' ' . $statusMessage[$this->mStatusCode] );
 890                 }
 891
 892                 $sk = $wgUser->getSkin();
 893
 894                 if ( $wgUseAjax ) {
 895                         $this->addScriptFile( 'ajax.js' );
 896
 897                         wfRunHooks( 'AjaxAddScript', array( &$this ) );
 898
 899                         if( $wgAjaxWatch && $wgUser->isLoggedIn() ) {
 900                                 $this->addScriptFile( 'ajaxwatch.js' );
 901                         }
 902
 903                         if ( $wgEnableMWSuggest && !$wgUser->getOption( 'disablesuggest', false ) ){
 904                                 $this->addScriptFile( 'mwsuggest.js' );
 905                         }
 906                 }
 907
 908                 if( $wgUser->getBoolOption( 'editsectiononrightclick' ) ) {
 909                         $this->addScriptFile( 'rightclickedit.js' );
 910                 }
 911
 912                 if( $wgUniversalEditButton ) {
 913                         if( isset( $wgArticle ) && isset( $wgTitle ) && $wgTitle->quickUserCan( 'edit' )
 914                                 && ( $wgTitle->exists() || $wgTitle->quickUserCan( 'create' ) ) ) {
 915                                 // Original UniversalEditButton
 916                                 $this->addLink( array(
 917                                         'rel' => 'alternate',
 918                                         'type' => 'application/x-wiki',
 919                                         'title' => wfMsg( 'edit' ),
 920                                         'href' => $wgTitle->getFullURL( 'action=edit' )
 921                                 ) );
 922                                 // Alternate edit link
 923                                 $this->addLink( array(
 924                                         'rel' => 'edit',
 925                                         'title' => wfMsg( 'edit' ),
 926                                         'href' => $wgTitle->getFullURL( 'action=edit' )
 927                                 ) );
 928                         }
 929                 }
 930
 931                 # Buffer output; final headers may depend on later processing
 932                 ob_start();
 933
 934                 $wgRequest->response()->header( "Content-type: $wgMimeType; charset={$wgOutputEncoding}" );
 935                 $wgRequest->response()->header( 'Content-language: '.$wgContLanguageCode );
 936
 937                 if ($this->mArticleBodyOnly) {
 938                         $this->out($this->mBodytext);
 939                 } else {
 940                         // Hook that allows last minute changes to the output page, e.g.
 941                         // adding of CSS or Javascript by extensions.
 942                         wfRunHooks( 'BeforePageDisplay', array( &$this, &$sk ) );
 943
 944                         wfProfileIn( 'Output-skin' );
 945                         $sk->outputPage( $this );
 946                         wfProfileOut( 'Output-skin' );
 947                 }
 948
 949                 $this->sendCacheControl();
 950                 ob_end_flush();
 951                 wfProfileOut( __METHOD__ );
 952         }
 953
 954         /**
 955          * @todo document
 956          * @param string $ins
 957          */
 958         public function out( $ins ) {
 959                 global $wgInputEncoding, $wgOutputEncoding, $wgContLang;
 960                 if ( 0 == strcmp( $wgInputEncoding, $wgOutputEncoding ) ) {
 961                         $outs = $ins;
 962                 } else {
 963                         $outs = $wgContLang->iconv( $wgInputEncoding, $wgOutputEncoding, $ins );
 964                         if ( false === $outs ) { $outs = $ins; }
 965                 }
 966                 print $outs;
 967         }
 968
 969         /**
 970          * @todo document
 971          */
 972         public static function setEncodings() {
 973                 global $wgInputEncoding, $wgOutputEncoding;
 974                 global $wgUser, $wgContLang;
 975
 976                 $wgInputEncoding = strtolower( $wgInputEncoding );
 977
 978                 if ( empty( $_SERVER['HTTP_ACCEPT_CHARSET'] ) ) {
 979                         $wgOutputEncoding = strtolower( $wgOutputEncoding );
 980                         return;
 981                 }
 982                 $wgOutputEncoding = $wgInputEncoding;
 983         }
 984
 985         /**
 986          * Deprecated, use wfReportTime() instead.
 987          * @return string
 988          * @deprecated
 989          */
 990         public function reportTime() {
 991                 wfDeprecated( __METHOD__ );
 992                 $time = wfReportTime();
 993                 return $time;
 994         }
 995
 996         /**
 997          * Produce a "user is blocked" page.
 998          *
 999          * @param bool $return Whether to have a "return to $wgTitle" message or not.
1000          * @return nothing
1001          */
1002         function blockedPage( $return = true ) {
1003                 global $wgUser, $wgContLang, $wgTitle, $wgLang;
1004
1005                 $this->setPageTitle( wfMsg( 'blockedtitle' ) );
1006                 $this->setRobotPolicy( 'noindex,nofollow' );
1007                 $this->setArticleRelated( false );
1008
1009                 $name = User::whoIs( $wgUser->blockedBy() );
1010                 $reason = $wgUser->blockedFor();
1011                 if( $reason == '' ) {
1012                         $reason = wfMsg( 'blockednoreason' );
1013                 }
1014                 $blockTimestamp = $wgLang->timeanddate( wfTimestamp( TS_MW, $wgUser->mBlock->mTimestamp ), true );
1015                 $ip = wfGetIP();
1016
1017                 $link = '[[' . $wgContLang->getNsText( NS_USER ) . ":{$name}|{$name}]]";
1018
1019                 $blockid = $wgUser->mBlock->mId;
1020
1021                 $blockExpiry = $wgUser->mBlock->mExpiry;
1022                 if ( $blockExpiry == 'infinity' ) {
1023                         // Entry in database (table ipblocks) is 'infinity' but 'ipboptions' uses 'infinite' or 'indefinite'
1024                         // Search for localization in 'ipboptions'
1025                         $scBlockExpiryOptions = wfMsg( 'ipboptions' );
1026                         foreach ( explode( ',', $scBlockExpiryOptions ) as $option ) {
1027                                 if ( strpos( $option, ":" ) === false )
1028                                         continue;
1029                                 list( $show, $value ) = explode( ":", $option );
1030                                 if ( $value == 'infinite' || $value == 'indefinite' ) {
1031                                         $blockExpiry = $show;
1032                                         break;
1033                                 }
1034                         }
1035                 } else {
1036                         $blockExpiry = $wgLang->timeanddate( wfTimestamp( TS_MW, $blockExpiry ), true );
1037                 }
1038
1039                 if ( $wgUser->mBlock->mAuto ) {
1040                         $msg = 'autoblockedtext';
1041                 } else {
1042                         $msg = 'blockedtext';
1043                 }
1044
1045                 /* $ip returns who *is* being blocked, $intended contains who was meant to be blocked.
1046                  * This could be a username, an ip range, or a single ip. */
1047                 $intended = $wgUser->mBlock->mAddress;
1048
1049                 $this->addWikiMsg( $msg, $link, $reason, $ip, $name, $blockid, $blockExpiry, $intended, $blockTimestamp );
1050
1051                 # Don't auto-return to special pages
1052                 if( $return ) {
1053                         $return = $wgTitle->getNamespace() > -1 ? $wgTitle : NULL;
1054                         $this->returnToMain( null, $return );
1055                 }
1056         }
1057
1058         /**
1059          * Output a standard error page
1060          *
1061          * @param string $title Message key for page title
1062          * @param string $msg Message key for page text
1063          * @param array $params Message parameters
1064          */
1065         public function showErrorPage( $title, $msg, $params = array() ) {
1066                 global $wgTitle;
1067                 if ( isset($wgTitle) ) {
1068                         $this->mDebugtext .= 'Original title: ' . $wgTitle->getPrefixedText() . "\n";
1069                 }
1070                 $this->setPageTitle( wfMsg( $title ) );
1071                 $this->setHTMLTitle( wfMsg( 'errorpagetitle' ) );
1072                 $this->setRobotPolicy( 'noindex,nofollow' );
1073                 $this->setArticleRelated( false );
1074                 $this->enableClientCache( false );
1075                 $this->mRedirect = '';
1076                 $this->mBodytext = '';
1077
1078                 array_unshift( $params, 'parse' );
1079                 array_unshift( $params, $msg );
1080                 $this->addHTML( call_user_func_array( 'wfMsgExt', $params ) );
1081
1082                 $this->returnToMain();
1083         }
1084
1085         /**
1086          * Output a standard permission error page
1087          *
1088          * @param array $errors Error message keys
1089          */
1090         public function showPermissionsErrorPage( $errors, $action = null )
1091         {
1092                 global $wgTitle;
1093
1094                 $this->mDebugtext .= 'Original title: ' .
1095                 $wgTitle->getPrefixedText() . "\n";
1096                 $this->setPageTitle( wfMsg( 'permissionserrors' ) );
1097                 $this->setHTMLTitle( wfMsg( 'permissionserrors' ) );
1098                 $this->setRobotPolicy( 'noindex,nofollow' );
1099                 $this->setArticleRelated( false );
1100                 $this->enableClientCache( false );
1101                 $this->mRedirect = '';
1102                 $this->mBodytext = '';
1103                 $this->addWikiText( $this->formatPermissionsErrorMessage( $errors, $action ) );
1104         }
1105
1106         /** @deprecated */
1107         public function errorpage( $title, $msg ) {
1108                 wfDeprecated( __METHOD__ );
1109                 throw new ErrorPageError( $title, $msg );
1110         }
1111
1112         /**
1113          * Display an error page indicating that a given version of MediaWiki is
1114          * required to use it
1115          *
1116          * @param mixed $version The version of MediaWiki needed to use the page
1117          */
1118         public function versionRequired( $version ) {
1119                 $this->setPageTitle( wfMsg( 'versionrequired', $version ) );
1120                 $this->setHTMLTitle( wfMsg( 'versionrequired', $version ) );
1121                 $this->setRobotPolicy( 'noindex,nofollow' );
1122                 $this->setArticleRelated( false );
1123                 $this->mBodytext = '';
1124
1125                 $this->addWikiMsg( 'versionrequiredtext', $version );
1126                 $this->returnToMain();
1127         }
1128
1129         /**
1130          * Display an error page noting that a given permission bit is required.
1131          *
1132          * @param string $permission key required
1133          */
1134         public function permissionRequired( $permission ) {
1135                 global $wgUser;
1136
1137                 $this->setPageTitle( wfMsg( 'badaccess' ) );
1138                 $this->setHTMLTitle( wfMsg( 'errorpagetitle' ) );
1139                 $this->setRobotPolicy( 'noindex,nofollow' );
1140                 $this->setArticleRelated( false );
1141                 $this->mBodytext = '';
1142
1143                 $groups = array_map( array( 'User', 'makeGroupLinkWiki' ),
1144                         User::getGroupsWithPermission( $permission ) );
1145                 if( $groups ) {
1146                         $this->addWikiMsg( 'badaccess-groups',
1147                                 implode( ', ', $groups ),
1148                                 count( $groups) );
1149                 } else {
1150                         $this->addWikiMsg( 'badaccess-group0' );
1151                 }
1152                 $this->returnToMain();
1153         }
1154
1155         /**
1156          * Use permissionRequired.
1157          * @deprecated
1158          */
1159         public function sysopRequired() {
1160                 throw new MWException( "Call to deprecated OutputPage::sysopRequired() method\n" );
1161         }
1162
1163         /**
1164          * Use permissionRequired.
1165          * @deprecated
1166          */
1167         public function developerRequired() {
1168                 throw new MWException( "Call to deprecated OutputPage::developerRequired() method\n" );
1169         }
1170
1171         /**
1172          * Produce the stock "please login to use the wiki" page
1173          */
1174         public function loginToUse() {
1175                 global $wgUser, $wgTitle, $wgContLang;
1176
1177                 if( $wgUser->isLoggedIn() ) {
1178                         $this->permissionRequired( 'read' );
1179                         return;
1180                 }
1181
1182                 $skin = $wgUser->getSkin();
1183
1184                 $this->setPageTitle( wfMsg( 'loginreqtitle' ) );
1185                 $this->setHtmlTitle( wfMsg( 'errorpagetitle' ) );
1186                 $this->setRobotPolicy( 'noindex,nofollow' );
1187                 $this->setArticleFlag( false );
1188
1189                 $loginTitle = SpecialPage::getTitleFor( 'Userlogin' );
1190                 $loginLink = $skin->makeKnownLinkObj( $loginTitle, wfMsgHtml( 'loginreqlink' ), 'returnto=' . $wgTitle->getPrefixedUrl() );
1191                 $this->addHTML( wfMsgWikiHtml( 'loginreqpagetext', $loginLink ) );
1192                 $this->addHTML( "\n<!--" . $wgTitle->getPrefixedUrl() . "-->" );
1193
1194                 # Don't return to the main page if the user can't read it
1195                 # otherwise we'll end up in a pointless loop
1196                 $mainPage = Title::newMainPage();
1197                 if( $mainPage->userCanRead() )
1198                         $this->returnToMain( null, $mainPage );
1199         }
1200
1201         /** @deprecated */
1202         public function databaseError( $fname, $sql, $error, $errno ) {
1203                 throw new MWException( "OutputPage::databaseError is obsolete\n" );
1204         }
1205
1206         /**
1207          * @param array $errors An array of arrays returned by Title::getUserPermissionsErrors
1208          * @return string The wikitext error-messages, formatted into a list.
1209          */
1210         public function formatPermissionsErrorMessage( $errors, $action = null ) {
1211                 if ($action == null) {
1212                         $text = wfMsgNoTrans( 'permissionserrorstext', count($errors)). "\n\n";
1213                 } else {
1214                         global $wgLang;
1215                         $action_desc = wfMsg( "action-$action" );
1216                         $text = wfMsgNoTrans( 'permissionserrorstext-withaction', count($errors), $action_desc ) . "\n\n";
1217                 }
1218
1219                 if (count( $errors ) > 1) {
1220                         $text .= '<ul class="permissions-errors">' . "\n";
1221
1222                         foreach( $errors as $error )
1223                         {
1224                                 $text .= '<li>';
1225                                 $text .= call_user_func_array( 'wfMsgNoTrans', $error );
1226                                 $text .= "</li>\n";
1227                         }
1228                         $text .= '</ul>';
1229                 } else {
1230                         $text .= '<div class="permissions-errors">' . call_user_func_array( 'wfMsgNoTrans', reset( $errors ) ) . '</div>';
1231                 }
1232
1233                 return $text;
1234         }
1235
1236         /**
1237          * Display a page stating that the Wiki is in read-only mode,
1238          * and optionally show the source of the page that the user
1239          * was trying to edit.  Should only be called (for this
1240          * purpose) after wfReadOnly() has returned true.
1241          *
1242          * For historical reasons, this function is _also_ used to
1243          * show the error message when a user tries to edit a page
1244          * they are not allowed to edit.  (Unless it's because they're
1245          * blocked, then we show blockedPage() instead.)  In this
1246          * case, the second parameter should be set to true and a list
1247          * of reasons supplied as the third parameter.
1248          *
1249          * @todo Needs to be split into multiple functions.
1250          *
1251          * @param string $source    Source code to show (or null).
1252          * @param bool   $protected Is this a permissions error?
1253          * @param array  $reasons   List of reasons for this error, as returned by Title::getUserPermissionsErrors().
1254          */
1255         public function readOnlyPage( $source = null, $protected = false, $reasons = array(), $action = null ) {
1256                 global $wgUser, $wgTitle;
1257                 $skin = $wgUser->getSkin();
1258
1259                 $this->setRobotPolicy( 'noindex,nofollow' );
1260                 $this->setArticleRelated( false );
1261
1262                 // If no reason is given, just supply a default "I can't let you do
1263                 // that, Dave" message.  Should only occur if called by legacy code.
1264                 if ( $protected && empty($reasons) ) {
1265                         $reasons[] = array( 'badaccess-group0' );
1266                 }
1267
1268                 if ( !empty($reasons) ) {
1269                         // Permissions error
1270                         if( $source ) {
1271                                 $this->setPageTitle( wfMsg( 'viewsource' ) );
1272                                 $this->setSubtitle( wfMsg( 'viewsourcefor', $skin->makeKnownLinkObj( $wgTitle ) ) );
1273                         } else {
1274                                 $this->setPageTitle( wfMsg( 'badaccess' ) );
1275                         }
1276                         $this->addWikiText( $this->formatPermissionsErrorMessage( $reasons, $action ) );
1277                 } else {
1278                         // Wiki is read only
1279                         $this->setPageTitle( wfMsg( 'readonly' ) );
1280                         $reason = wfReadOnlyReason();
1281                         $this->wrapWikiMsg( '<div class="mw-readonly-error">$1</div>', array( 'readonlytext', $reason ) );
1282                 }
1283
1284                 // Show source, if supplied
1285                 if( is_string( $source ) ) {
1286                         $this->addWikiMsg( 'viewsourcetext' );
1287                         $text = Xml::openElement( 'textarea',
1288                                                 array( 'id'   => 'wpTextbox1',
1289                                                        'name' => 'wpTextbox1',
1290                                                        'cols' => $wgUser->getOption( 'cols' ),
1291                                                        'rows' => $wgUser->getOption( 'rows' ),
1292                                                        'readonly' => 'readonly' ) );
1293                         $text .= htmlspecialchars( $source );
1294                         $text .= Xml::closeElement( 'textarea' );
1295                         $this->addHTML( $text );
1296
1297                         // Show templates used by this article
1298                         $skin = $wgUser->getSkin();
1299                         $article = new Article( $wgTitle );
1300                         $this->addHTML( "<div class='templatesUsed'>
1301 {$skin->formatTemplates( $article->getUsedTemplates() )}
1302 </div>
1303 " );
1304                 }
1305
1306                 # If the title doesn't exist, it's fairly pointless to print a return
1307                 # link to it.  After all, you just tried editing it and couldn't, so
1308                 # what's there to do there?
1309                 if( $wgTitle->exists() ) {
1310                         $this->returnToMain( null, $wgTitle );
1311                 }
1312         }
1313
1314         /** @deprecated */
1315         public function fatalError( $message ) {
1316                 wfDeprecated( __METHOD__ );
1317                 throw new FatalError( $message );
1318         }
1319
1320         /** @deprecated */
1321         public function unexpectedValueError( $name, $val ) {
1322                 wfDeprecated( __METHOD__ );
1323                 throw new FatalError( wfMsg( 'unexpected', $name, $val ) );
1324         }
1325
1326         /** @deprecated */
1327         public function fileCopyError( $old, $new ) {
1328                 wfDeprecated( __METHOD__ );
1329                 throw new FatalError( wfMsg( 'filecopyerror', $old, $new ) );
1330         }
1331
1332         /** @deprecated */
1333         public function fileRenameError( $old, $new ) {
1334                 wfDeprecated( __METHOD__ );
1335                 throw new FatalError( wfMsg( 'filerenameerror', $old, $new ) );
1336         }
1337
1338         /** @deprecated */
1339         public function fileDeleteError( $name ) {
1340                 wfDeprecated( __METHOD__ );
1341                 throw new FatalError( wfMsg( 'filedeleteerror', $name ) );
1342         }
1343
1344         /** @deprecated */
1345         public function fileNotFoundError( $name ) {
1346                 wfDeprecated( __METHOD__ );
1347                 throw new FatalError( wfMsg( 'filenotfound', $name ) );
1348         }
1349
1350         public function showFatalError( $message ) {
1351                 $this->setPageTitle( wfMsg( "internalerror" ) );
1352                 $this->setRobotPolicy( "noindex,nofollow" );
1353                 $this->setArticleRelated( false );
1354                 $this->enableClientCache( false );
1355                 $this->mRedirect = '';
1356                 $this->mBodytext = $message;
1357         }
1358
1359         public function showUnexpectedValueError( $name, $val ) {
1360                 $this->showFatalError( wfMsg( 'unexpected', $name, $val ) );
1361         }
1362
1363         public function showFileCopyError( $old, $new ) {
1364                 $this->showFatalError( wfMsg( 'filecopyerror', $old, $new ) );
1365         }
1366
1367         public function showFileRenameError( $old, $new ) {
1368                 $this->showFatalError( wfMsg( 'filerenameerror', $old, $new ) );
1369         }
1370
1371         public function showFileDeleteError( $name ) {
1372                 $this->showFatalError( wfMsg( 'filedeleteerror', $name ) );
1373         }
1374
1375         public function showFileNotFoundError( $name ) {
1376                 $this->showFatalError( wfMsg( 'filenotfound', $name ) );
1377         }
1378
1379         /**
1380          * Add a "return to" link pointing to a specified title
1381          *
1382          * @param Title $title Title to link
1383          */
1384         public function addReturnTo( $title ) {
1385                 global $wgUser;
1386                 $link = wfMsg( 'returnto', $wgUser->getSkin()->makeLinkObj( $title ) );
1387                 $this->addHTML( "<p>{$link}</p>\n" );
1388         }
1389
1390         /**
1391          * Add a "return to" link pointing to a specified title,
1392          * or the title indicated in the request, or else the main page
1393          *
1394          * @param null $unused No longer used
1395          * @param Title $returnto Title to return to
1396          */
1397         public function returnToMain( $unused = null, $returnto = NULL ) {
1398                 global $wgRequest;
1399
1400                 if ( $returnto == NULL ) {
1401                         $returnto = $wgRequest->getText( 'returnto' );
1402                 }
1403
1404                 if ( '' === $returnto ) {
1405                         $returnto = Title::newMainPage();
1406                 }
1407
1408                 if ( is_object( $returnto ) ) {
1409                         $titleObj = $returnto;
1410                 } else {
1411                         $titleObj = Title::newFromText( $returnto );
1412                 }
1413                 if ( !is_object( $titleObj ) ) {
1414                         $titleObj = Title::newMainPage();
1415                 }
1416
1417                 $this->addReturnTo( $titleObj );
1418         }
1419
1420         /**
1421          * This function takes the title (first item of mGoodLinks), categories, existing and broken links for the page
1422          * and uses the first 10 of them for META keywords
1423          *
1424          * @param ParserOutput &$parserOutput
1425          */
1426         private function addKeywords( &$parserOutput ) {
1427                 global $wgTitle;
1428                 $this->addKeyword( $wgTitle->getPrefixedText() );
1429                 $count = 1;
1430                 $links2d =& $parserOutput->getLinks();
1431                 if ( !is_array( $links2d ) ) {
1432                         return;
1433                 }
1434                 foreach ( $links2d as $dbkeys ) {
1435                         foreach( $dbkeys as $dbkey => $unused ) {
1436                                 $this->addKeyword( $dbkey );
1437                                 if ( ++$count > 10 ) {
1438                                         break 2;
1439                                 }
1440                         }
1441                 }
1442         }
1443
1444         /**
1445          * @return string The doctype, opening <html>, and head element.
1446          */
1447         public function headElement( Skin $sk ) {
1448                 global $wgDocType, $wgDTD, $wgContLanguageCode, $wgOutputEncoding, $wgMimeType;
1449                 global $wgXhtmlDefaultNamespace, $wgXhtmlNamespaces;
1450                 global $wgUser, $wgContLang, $wgUseTrackbacks, $wgTitle, $wgStyleVersion;
1451
1452                 $this->addMeta( "http:Content-type", "$wgMimeType; charset={$wgOutputEncoding}" );
1453                 $this->addStyle( 'common/wikiprintable.css', 'print' );
1454                 $sk->setupUserCss( $this );
1455
1456                 $ret = '';
1457
1458                 if( $wgMimeType == 'text/xml' || $wgMimeType == 'application/xhtml+xml' || $wgMimeType == 'application/xml' ) {
1459                         $ret .= "<?xml version=\"1.0\" encoding=\"$wgOutputEncoding\" ?>\n";
1460                 }
1461
1462                 $ret .= "<!DOCTYPE html PUBLIC \"$wgDocType\"\n        \"$wgDTD\">\n";
1463
1464                 if ( '' == $this->getHTMLTitle() ) {
1465                         $this->setHTMLTitle(  wfMsg( 'pagetitle', $this->getPageTitle() ));
1466                 }
1467
1468                 $rtl = $wgContLang->isRTL() ? " dir='RTL'" : '';
1469                 $ret .= "<html xmlns=\"{$wgXhtmlDefaultNamespace}\" ";
1470                 foreach($wgXhtmlNamespaces as $tag => $ns) {
1471                         $ret .= "xmlns:{$tag}=\"{$ns}\" ";
1472                 }
1473                 $ret .= "xml:lang=\"$wgContLanguageCode\" lang=\"$wgContLanguageCode\" $rtl>\n";
1474                 $ret .= "<head>\n<title>" . htmlspecialchars( $this->getHTMLTitle() ) . "</title>\n\t\t";
1475                 $ret .= implode( "\t\t", array(
1476                         $this->getHeadLinks(),
1477                         $this->buildCssLinks(),
1478                         $sk->getHeadScripts( $this->mAllowUserJs ),
1479                         $this->mScripts,
1480                         $this->getHeadItems(),
1481                 ));
1482                 if( $sk->usercss ){
1483                         $ret .= "<style type='text/css'>{$sk->usercss}</style>";
1484                 }
1485
1486                 if ($wgUseTrackbacks && $this->isArticleRelated())
1487                         $ret .= $wgTitle->trackbackRDF();
1488
1489                 $ret .= "</head>\n";
1490                 return $ret;
1491         }
1492
1493         protected function addDefaultMeta() {
1494                 global $wgVersion;
1495                 $this->addMeta( 'http:Content-Style-Type', 'text/css' ); //bug 15835
1496                 $this->addMeta( 'generator', "MediaWiki $wgVersion" );
1497
1498                 $p = "{$this->mIndexPolicy},{$this->mFollowPolicy}";
1499                 if( $p !== 'index,follow' ) {
1500                         // http://www.robotstxt.org/wc/meta-user.html
1501                         // Only show if it's different from the default robots policy
1502                         $this->addMeta( 'robots', $p );
1503                 }
1504
1505                 if ( count( $this->mKeywords ) > 0 ) {
1506                         $strip = array(
1507                                 "/<.*?>/" => '',
1508                                 "/_/" => ' '
1509                         );
1510                         $this->addMeta( 'keywords', preg_replace(array_keys($strip), array_values($strip),implode( ",", $this->mKeywords ) ) );
1511                 }
1512         }
1513
1514         /**
1515          * @return string HTML tag links to be put in the header.
1516          */
1517         public function getHeadLinks() {
1518                 global $wgRequest, $wgFeed;
1519
1520                 // Ideally this should happen earlier, somewhere. :P
1521                 $this->addDefaultMeta();
1522
1523                 $tags = array();
1524
1525                 foreach ( $this->mMetatags as $tag ) {
1526                         if ( 0 == strcasecmp( 'http:', substr( $tag[0], 0, 5 ) ) ) {
1527                                 $a = 'http-equiv';
1528                                 $tag[0] = substr( $tag[0], 5 );
1529                         } else {
1530                                 $a = 'name';
1531                         }
1532                         $tags[] = Xml::element( 'meta',
1533                                 array(
1534                                         $a => $tag[0],
1535                                         'content' => $tag[1] ) );
1536                 }
1537                 foreach ( $this->mLinktags as $tag ) {
1538                         $tags[] = Xml::element( 'link', $tag );
1539                 }
1540
1541                 if( $wgFeed ) {
1542                         global $wgTitle;
1543                         foreach( $this->getSyndicationLinks() as $format => $link ) {
1544                                 # Use the page name for the title (accessed through $wgTitle since
1545                                 # there's no other way).  In principle, this could lead to issues
1546                                 # with having the same name for different feeds corresponding to
1547                                 # the same page, but we can't avoid that at this low a level.
1548
1549                                 $tags[] = $this->feedLink(
1550                                         $format,
1551                                         $link,
1552                                         wfMsg( "page-{$format}-feed", $wgTitle->getPrefixedText() ) ); # Used messages: 'page-rss-feed' and 'page-atom-feed' (for an easier grep)
1553                         }
1554
1555                         # Recent changes feed should appear on every page (except recentchanges,
1556                         # that would be redundant). Put it after the per-page feed to avoid
1557                         # changing existing behavior. It's still available, probably via a
1558                         # menu in your browser. Some sites might have a different feed they'd
1559                         # like to promote instead of the RC feed (maybe like a "Recent New Articles"
1560                         # or "Breaking news" one). For this, we see if $wgOverrideSiteFeed is defined.
1561                         # If so, use it instead.
1562
1563                         global $wgOverrideSiteFeed, $wgSitename, $wgFeedClasses;
1564                         $rctitle = SpecialPage::getTitleFor( 'Recentchanges' );
1565
1566                         if ( $wgOverrideSiteFeed ) {
1567                                 foreach ( $wgOverrideSiteFeed as $type => $feedUrl ) {
1568                                         $tags[] = $this->feedLink (
1569                                                 $type,
1570                                                 htmlspecialchars( $feedUrl ),
1571                                                 wfMsg( "site-{$type}-feed", $wgSitename ) );
1572                                 }
1573                         }
1574                         else if ( $wgTitle->getPrefixedText() != $rctitle->getPrefixedText() ) {
1575                                 foreach( $wgFeedClasses as $format => $class ) {
1576                                         $tags[] = $this->feedLink(
1577                                                 $format,
1578                                                 $rctitle->getFullURL( "feed={$format}" ),
1579                                                 wfMsg( "site-{$format}-feed", $wgSitename ) ); # For grep: 'site-rss-feed', 'site-atom-feed'.
1580                                 }
1581                         }
1582                 }
1583
1584                 return implode( "\n\t\t", $tags ) . "\n";
1585         }
1586
1587         /**
1588          * Return URLs for each supported syndication format for this page.
1589          * @return array associating format keys with URLs
1590          */
1591         public function getSyndicationLinks() {
1592                 global $wgTitle, $wgFeedClasses;
1593                 $links = array();
1594
1595                 if( $this->isSyndicated() ) {
1596                         if( is_string( $this->getFeedAppendQuery() ) ) {
1597                                 $appendQuery = "&" . $this->getFeedAppendQuery();
1598                         } else {
1599                                 $appendQuery = "";
1600                         }
1601
1602                         foreach( $wgFeedClasses as $format => $class ) {
1603                                 $links[$format] = $wgTitle->getLocalUrl( "feed=$format{$appendQuery}" );
1604                         }
1605                 }
1606                 return $links;
1607         }
1608
1609         /**
1610          * Generate a <link rel/> for an RSS feed.
1611          */
1612         private function feedLink( $type, $url, $text ) {
1613                 return Xml::element( 'link', array(
1614                         'rel' => 'alternate',
1615                         'type' => "application/$type+xml",
1616                         'title' => $text,
1617                         'href' => $url ) );
1618         }
1619
1620         /**
1621          * Add a local or specified stylesheet, with the given media options.
1622          * Meant primarily for internal use...
1623          *
1624          * @param $media -- to specify a media type, 'screen', 'printable', 'handheld' or any.
1625          * @param $conditional -- for IE conditional comments, specifying an IE version
1626          * @param $dir -- set to 'rtl' or 'ltr' for direction-specific sheets
1627          */
1628         public function addStyle( $style, $media='', $condition='', $dir='' ) {
1629                 $options = array();
1630                 if( $media )
1631                         $options['media'] = $media;
1632                 if( $condition )
1633                         $options['condition'] = $condition;
1634                 if( $dir )
1635                         $options['dir'] = $dir;
1636                 $this->styles[$style] = $options;
1637         }
1638
1639         /**
1640          * Build a set of <link>s for the stylesheets specified in the $this->styles array.
1641          * These will be applied to various media & IE conditionals.
1642          */
1643         public function buildCssLinks() {
1644                 $links = array();
1645                 foreach( $this->styles as $file => $options ) {
1646                         $link = $this->styleLink( $file, $options );
1647                         if( $link )
1648                                 $links[] = $link;
1649                 }
1650
1651                 return implode( "\n\t\t", $links );
1652         }
1653
1654         protected function styleLink( $style, $options ) {
1655                 global $wgRequest;
1656
1657                 if( isset( $options['dir'] ) ) {
1658                         global $wgContLang;
1659                         $siteDir = $wgContLang->isRTL() ? 'rtl' : 'ltr';
1660                         if( $siteDir != $options['dir'] )
1661                                 return '';
1662                 }
1663
1664                 if( isset( $options['media'] ) ) {
1665                         $media = $this->transformCssMedia( $options['media'] );
1666                         if( is_null( $media ) ) {
1667                                 return '';
1668                         }
1669                 } else {
1670                         $media = '';
1671                 }
1672
1673                 if( substr( $style, 0, 1 ) == '/' ||
1674                         substr( $style, 0, 5 ) == 'http:' ||
1675                         substr( $style, 0, 6 ) == 'https:' ) {
1676                         $url = $style;
1677                 } else {
1678                         global $wgStylePath, $wgStyleVersion;
1679                         $url = $wgStylePath . '/' . $style . '?' . $wgStyleVersion;
1680                 }
1681
1682                 $attribs = array(
1683                         'rel' => 'stylesheet',
1684                         'href' => $url,
1685                         'type' => 'text/css' );
1686                 if( $media ) {
1687                         $attribs['media'] = $media;
1688                 }
1689
1690                 $link = Xml::element( 'link', $attribs );
1691
1692                 if( isset( $options['condition'] ) ) {
1693                         $condition = htmlspecialchars( $options['condition'] );
1694                         $link = "<!--[if $condition]>$link<![endif]-->";
1695                 }
1696                 return $link;
1697         }
1698
1699         function transformCssMedia( $media ) {
1700                 global $wgRequest, $wgHandheldForIPhone;
1701
1702                 // Switch in on-screen display for media testing
1703                 $switches = array(
1704                         'printable' => 'print',
1705                         'handheld' => 'handheld',
1706                 );
1707                 foreach( $switches as $switch => $targetMedia ) {
1708                         if( $wgRequest->getBool( $switch ) ) {
1709                                 if( $media == $targetMedia ) {
1710                                         $media = '';
1711                                 } elseif( $media == 'screen' ) {
1712                                         return null;
1713                                 }
1714                         }
1715                 }
1716
1717                 // Expand longer media queries as iPhone doesn't grok 'handheld'
1718                 if( $wgHandheldForIPhone ) {
1719                         $mediaAliases = array(
1720                                 'screen' => 'screen and (min-device-width: 481px)',
1721                                 'handheld' => 'handheld, only screen and (max-device-width: 480px)',
1722                         );
1723
1724                         if( isset( $mediaAliases[$media] ) ) {
1725                                 $media = $mediaAliases[$media];
1726                         }
1727                 }
1728
1729                 return $media;
1730         }
1731
1732         /**
1733          * Turn off regular page output and return an error reponse
1734          * for when rate limiting has triggered.
1735          */
1736         public function rateLimited() {
1737                 global $wgTitle;
1738
1739                 $this->setPageTitle(wfMsg('actionthrottled'));
1740                 $this->setRobotPolicy( 'noindex,follow' );
1741                 $this->setArticleRelated( false );
1742                 $this->enableClientCache( false );
1743                 $this->mRedirect = '';
1744                 $this->clearHTML();
1745                 $this->setStatusCode(503);
1746                 $this->addWikiMsg( 'actionthrottledtext' );
1747
1748                 $this->returnToMain( null, $wgTitle );
1749         }
1750
1751         /**
1752          * Show an "add new section" link?
1753          *
1754          * @return bool
1755          */
1756         public function showNewSectionLink() {
1757                 return $this->mNewSectionLink;
1758         }
1759
1760         /**
1761          * Show a warning about slave lag
1762          *
1763          * If the lag is higher than $wgSlaveLagCritical seconds,
1764          * then the warning is a bit more obvious. If the lag is
1765          * lower than $wgSlaveLagWarning, then no warning is shown.
1766          *
1767          * @param int $lag Slave lag
1768          */
1769         public function showLagWarning( $lag ) {
1770                 global $wgSlaveLagWarning, $wgSlaveLagCritical;
1771                 if( $lag >= $wgSlaveLagWarning ) {
1772                         $message = $lag < $wgSlaveLagCritical
1773                                 ? 'lag-warn-normal'
1774                                 : 'lag-warn-high';
1775                         $warning = wfMsgExt( $message, 'parse', $lag );
1776                         $this->addHTML( "<div class=\"mw-{$message}\">\n{$warning}\n</div>\n" );
1777                 }
1778         }
1779
1780         /**
1781          * Add a wikitext-formatted message to the output.
1782          * This is equivalent to:
1783          *
1784          *    $wgOut->addWikiText( wfMsgNoTrans( ... ) )
1785          */
1786         public function addWikiMsg( /*...*/ ) {
1787                 $args = func_get_args();
1788                 $name = array_shift( $args );
1789                 $this->addWikiMsgArray( $name, $args );
1790         }
1791
1792         /**
1793          * Add a wikitext-formatted message to the output.
1794          * Like addWikiMsg() except the parameters are taken as an array
1795          * instead of a variable argument list.
1796          *
1797          * $options is passed through to wfMsgExt(), see that function for details.
1798          */
1799         public function addWikiMsgArray( $name, $args, $options = array() ) {
1800                 $options[] = 'parse';
1801                 $text = wfMsgExt( $name, $options, $args );
1802                 $this->addHTML( $text );
1803         }
1804
1805         /**
1806          * This function takes a number of message/argument specifications, wraps them in
1807          * some overall structure, and then parses the result and adds it to the output.
1808          *
1809          * In the $wrap, $1 is replaced with the first message, $2 with the second, and so
1810          * on. The subsequent arguments may either be strings, in which case they are the
1811          * message names, or an arrays, in which case the first element is the message name,
1812          * and subsequent elements are the parameters to that message.
1813          *
1814          * The special named parameter 'options' in a message specification array is passed
1815          * through to the $options parameter of wfMsgExt().
1816          *
1817          * Don't use this for messages that are not in users interface language.
1818          *
1819          * For example:
1820          *
1821          *    $wgOut->wrapWikiMsg( '<div class="error">$1</div>', 'some-error' );
1822          *
1823          * Is equivalent to:
1824          *
1825          *    $wgOut->addWikiText( '<div class="error">' . wfMsgNoTrans( 'some-error' ) . '</div>' );
1826          */
1827         public function wrapWikiMsg( $wrap /*, ...*/ ) {
1828                 $msgSpecs = func_get_args();
1829                 array_shift( $msgSpecs );
1830                 $msgSpecs = array_values( $msgSpecs );
1831                 $s = $wrap;
1832                 foreach ( $msgSpecs as $n => $spec ) {
1833                         $options = array();
1834                         if ( is_array( $spec ) ) {
1835                                 $args = $spec;
1836                                 $name = array_shift( $args );
1837                                 if ( isset( $args['options'] ) ) {
1838                                         $options = $args['options'];
1839                                         unset( $args['options'] );
1840                                 }
1841                         }  else {
1842                                 $args = array();
1843                                 $name = $spec;
1844                         }
1845                         $s = str_replace( '$' . ($n+1), wfMsgExt( $name, $options, $args ), $s );
1846                 }
1847                 $this->addHTML( $this->parse( $s, /*linestart*/true, /*uilang*/true ) );
1848         }
1849 }