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                 $this->mTemplateIds = wfArrayMerge( $this->mTemplateIds, (array)$parserOutput->mTemplateIds );
 535
 536                 // Display title
 537                 if( ( $dt = $parserOutput->getDisplayTitle() ) !== false )
 538                         $this->setPageTitle( $dt );
 539
 540                 // Hooks registered in the object
 541                 global $wgParserOutputHooks;
 542                 foreach ( $parserOutput->getOutputHooks() as $hookInfo ) {
 543                         list( $hookName, $data ) = $hookInfo;
 544                         if ( isset( $wgParserOutputHooks[$hookName] ) ) {
 545                                 call_user_func( $wgParserOutputHooks[$hookName], $this, $parserOutput, $data );
 546                         }
 547                 }
 548
 549                 wfRunHooks( 'OutputPageParserOutput', array( &$this, $parserOutput ) );
 550         }
 551
 552         /**
 553          * @todo document
 554          * @param ParserOutput &$parserOutput
 555          */
 556         function addParserOutput( &$parserOutput ) {
 557                 $this->addParserOutputNoText( $parserOutput );
 558                 $text = $parserOutput->getText();
 559                 wfRunHooks( 'OutputPageBeforeHTML',array( &$this, &$text ) );
 560                 $this->addHTML( $text );
 561         }
 562
 563         /**
 564          * Add wikitext to the buffer, assuming that this is the primary text for a page view
 565          * Saves the text into the parser cache if possible.
 566          *
 567          * @param string  $text
 568          * @param Article $article
 569          * @param bool    $cache
 570          * @deprecated Use Article::outputWikitext
 571          */
 572         public function addPrimaryWikiText( $text, $article, $cache = true ) {
 573                 global $wgParser, $wgUser;
 574
 575                 wfDeprecated( __METHOD__ );
 576
 577                 $popts = $this->parserOptions();
 578                 $popts->setTidy(true);
 579                 $parserOutput = $wgParser->parse( $text, $article->mTitle,
 580                         $popts, true, true, $this->mRevisionId );
 581                 $popts->setTidy(false);
 582                 if ( $cache && $article && $parserOutput->getCacheTime() != -1 ) {
 583                         $parserCache = ParserCache::singleton();
 584                         $parserCache->save( $parserOutput, $article, $wgUser );
 585                 }
 586
 587                 $this->addParserOutput( $parserOutput );
 588         }
 589
 590         /**
 591          * @deprecated use addWikiTextTidy()
 592          */
 593         public function addSecondaryWikiText( $text, $linestart = true ) {
 594                 global $wgTitle;
 595                 wfDeprecated( __METHOD__ );
 596                 $this->addWikiTextTitleTidy($text, $wgTitle, $linestart);
 597         }
 598
 599         /**
 600          * Add wikitext with tidy enabled
 601          */
 602         public function addWikiTextTidy(  $text, $linestart = true ) {
 603                 global $wgTitle;
 604                 $this->addWikiTextTitleTidy($text, $wgTitle, $linestart);
 605         }
 606
 607
 608         /**
 609          * Add the output of a QuickTemplate to the output buffer
 610          *
 611          * @param QuickTemplate $template
 612          */
 613         public function addTemplate( &$template ) {
 614                 ob_start();
 615                 $template->execute();
 616                 $this->addHTML( ob_get_contents() );
 617                 ob_end_clean();
 618         }
 619
 620         /**
 621          * Parse wikitext and return the HTML.
 622          *
 623          * @param string $text
 624          * @param bool   $linestart Is this the start of a line?
 625          * @param bool   $interface ??
 626          */
 627         public function parse( $text, $linestart = true, $interface = false ) {
 628                 global $wgParser, $wgTitle;
 629                 $popts = $this->parserOptions();
 630                 if ( $interface) { $popts->setInterfaceMessage(true); }
 631                 $parserOutput = $wgParser->parse( $text, $wgTitle, $popts,
 632                         $linestart, true, $this->mRevisionId );
 633                 if ( $interface) { $popts->setInterfaceMessage(false); }
 634                 return $parserOutput->getText();
 635         }
 636
 637         /**
 638          * @param Article $article
 639          * @param User    $user
 640          *
 641          * @return bool True if successful, else false.
 642          */
 643         public function tryParserCache( &$article, $user ) {
 644                 $parserCache = ParserCache::singleton();
 645                 $parserOutput = $parserCache->get( $article, $user );
 646                 if ( $parserOutput !== false ) {
 647                         $this->addParserOutput( $parserOutput );
 648                         return true;
 649                 } else {
 650                         return false;
 651                 }
 652         }
 653
 654         /**
 655          * @param int $maxage Maximum cache time on the Squid, in seconds.
 656          */
 657         public function setSquidMaxage( $maxage ) {
 658                 $this->mSquidMaxage = $maxage;
 659         }
 660
 661         /**
 662          * Use enableClientCache(false) to force it to send nocache headers
 663          * @param $state ??
 664          */
 665         public function enableClientCache( $state ) {
 666                 return wfSetVar( $this->mEnableClientCache, $state );
 667         }
 668
 669         function getCacheVaryCookies() {
 670                 global $wgCookiePrefix, $wgCacheVaryCookies;
 671                 static $cookies;
 672                 if ( $cookies === null ) {
 673                         $cookies = array_merge(
 674                                 array(
 675                                         "{$wgCookiePrefix}Token",
 676                                         "{$wgCookiePrefix}LoggedOut",
 677                                         session_name()
 678                                 ),
 679                                 $wgCacheVaryCookies
 680                         );
 681                         wfRunHooks('GetCacheVaryCookies', array( $this, &$cookies ) );
 682                 }
 683                 return $cookies;
 684         }
 685
 686         function uncacheableBecauseRequestVars() {
 687                 global $wgRequest;
 688                 return  $wgRequest->getText('useskin', false) === false
 689                         && $wgRequest->getText('uselang', false) === false;
 690         }
 691
 692         /**
 693          * Check if the request has a cache-varying cookie header
 694          * If it does, it's very important that we don't allow public caching
 695          */
 696         function haveCacheVaryCookies() {
 697                 global $wgRequest, $wgCookiePrefix;
 698                 $cookieHeader = $wgRequest->getHeader( 'cookie' );
 699                 if ( $cookieHeader === false ) {
 700                         return false;
 701                 }
 702                 $cvCookies = $this->getCacheVaryCookies();
 703                 foreach ( $cvCookies as $cookieName ) {
 704                         # Check for a simple string match, like the way squid does it
 705                         if ( strpos( $cookieHeader, $cookieName ) ) {
 706                                 wfDebug( __METHOD__.": found $cookieName\n" );
 707                                 return true;
 708                         }
 709                 }
 710                 wfDebug( __METHOD__.": no cache-varying cookies found\n" );
 711                 return false;
 712         }
 713
 714         /** Get a complete X-Vary-Options header */
 715         public function getXVO() {
 716                 global $wgCookiePrefix;
 717                 $cvCookies = $this->getCacheVaryCookies();
 718                 $xvo = 'X-Vary-Options: Accept-Encoding;list-contains=gzip,Cookie;';
 719                 $first = true;
 720                 foreach ( $cvCookies as $cookieName ) {
 721                         if ( $first ) {
 722                                 $first = false;
 723                         } else {
 724                                 $xvo .= ';';
 725                         }
 726                         $xvo .= 'string-contains=' . $cookieName;
 727                 }
 728                 return $xvo;
 729         }
 730
 731         public function sendCacheControl() {
 732                 global $wgUseSquid, $wgUseESI, $wgUseETag, $wgSquidMaxage, $wgRequest;
 733
 734                 $response = $wgRequest->response();
 735                 if ($wgUseETag && $this->mETag)
 736                         $response->header("ETag: $this->mETag");
 737
 738                 # don't serve compressed data to clients who can't handle it
 739                 # maintain different caches for logged-in users and non-logged in ones
 740                 $response->header( 'Vary: Accept-Encoding, Cookie' );
 741
 742                 # Add an X-Vary-Options header for Squid with Wikimedia patches
 743                 $response->header( $this->getXVO() );
 744
 745                 if( !$this->uncacheableBecauseRequestVars() && $this->mEnableClientCache ) {
 746                         if( $wgUseSquid && session_id() == '' &&
 747                           ! $this->isPrintable() && $this->mSquidMaxage != 0 && !$this->haveCacheVaryCookies() )
 748                         {
 749                                 if ( $wgUseESI ) {
 750                                         # We'll purge the proxy cache explicitly, but require end user agents
 751                                         # to revalidate against the proxy on each visit.
 752                                         # Surrogate-Control controls our Squid, Cache-Control downstream caches
 753                                         wfDebug( __METHOD__ . ": proxy caching with ESI; {$this->mLastModified} **\n", false );
 754                                         # start with a shorter timeout for initial testing
 755                                         # header( 'Surrogate-Control: max-age=2678400+2678400, content="ESI/1.0"');
 756                                         $response->header( 'Surrogate-Control: max-age='.$wgSquidMaxage.'+'.$this->mSquidMaxage.', content="ESI/1.0"');
 757                                         $response->header( 'Cache-Control: s-maxage=0, must-revalidate, max-age=0' );
 758                                 } else {
 759                                         # We'll purge the proxy cache for anons explicitly, but require end user agents
 760                                         # to revalidate against the proxy on each visit.
 761                                         # IMPORTANT! The Squid needs to replace the Cache-Control header with
 762                                         # Cache-Control: s-maxage=0, must-revalidate, max-age=0
 763                                         wfDebug( __METHOD__ . ": local proxy caching; {$this->mLastModified} **\n", false );
 764                                         # start with a shorter timeout for initial testing
 765                                         # header( "Cache-Control: s-maxage=2678400, must-revalidate, max-age=0" );
 766                                         $response->header( 'Cache-Control: s-maxage='.$this->mSquidMaxage.', must-revalidate, max-age=0' );
 767                                 }
 768                         } else {
 769                                 # We do want clients to cache if they can, but they *must* check for updates
 770                                 # on revisiting the page.
 771                                 wfDebug( __METHOD__ . ": private caching; {$this->mLastModified} **\n", false );
 772                                 $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
 773                                 $response->header( "Cache-Control: private, must-revalidate, max-age=0" );
 774                         }
 775                         if($this->mLastModified) {
 776                                 $response->header( "Last-Modified: {$this->mLastModified}" );
 777                         }
 778                 } else {
 779                         wfDebug( __METHOD__ . ": no caching **\n", false );
 780
 781                         # In general, the absence of a last modified header should be enough to prevent
 782                         # the client from using its cache. We send a few other things just to make sure.
 783                         $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
 784                         $response->header( 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate' );
 785                         $response->header( 'Pragma: no-cache' );
 786                 }
 787         }
 788
 789         /**
 790          * Finally, all the text has been munged and accumulated into
 791          * the object, let's actually output it:
 792          */
 793         public function output() {
 794                 global $wgUser, $wgOutputEncoding, $wgRequest;
 795                 global $wgContLanguageCode, $wgDebugRedirects, $wgMimeType;
 796                 global $wgJsMimeType, $wgUseAjax, $wgAjaxWatch;
 797                 global $wgEnableMWSuggest, $wgUniversalEditButton;
 798                 global $wgArticle, $wgTitle;
 799
 800                 if( $this->mDoNothing ){
 801                         return;
 802                 }
 803
 804                 wfProfileIn( __METHOD__ );
 805
 806                 if ( '' != $this->mRedirect ) {
 807                         # Standards require redirect URLs to be absolute
 808                         $this->mRedirect = wfExpandUrl( $this->mRedirect );
 809                         if( $this->mRedirectCode == '301') {
 810                                 if( !$wgDebugRedirects ) {
 811                                         $wgRequest->response()->header("HTTP/1.1 {$this->mRedirectCode} Moved Permanently");
 812                                 }
 813                                 $this->mLastModified = wfTimestamp( TS_RFC2822 );
 814                         }
 815
 816                         $this->sendCacheControl();
 817
 818                         $wgRequest->response()->header("Content-Type: text/html; charset=utf-8");
 819                         if( $wgDebugRedirects ) {
 820                                 $url = htmlspecialchars( $this->mRedirect );
 821                                 print "<html>\n<head>\n<title>Redirect</title>\n</head>\n<body>\n";
 822                                 print "<p>Location: <a href=\"$url\">$url</a></p>\n";
 823                                 print "</body>\n</html>\n";
 824                         } else {
 825                                 $wgRequest->response()->header( 'Location: '.$this->mRedirect );
 826                         }
 827                         wfProfileOut( __METHOD__ );
 828                         return;
 829                 }
 830                 elseif ( $this->mStatusCode )
 831                 {
 832                         $statusMessage = array(
 833                                 100 => 'Continue',
 834                                 101 => 'Switching Protocols',
 835                                 102 => 'Processing',
 836                                 200 => 'OK',
 837                                 201 => 'Created',
 838                                 202 => 'Accepted',
 839                                 203 => 'Non-Authoritative Information',
 840                                 204 => 'No Content',
 841                                 205 => 'Reset Content',
 842                                 206 => 'Partial Content',
 843                                 207 => 'Multi-Status',
 844                                 300 => 'Multiple Choices',
 845                                 301 => 'Moved Permanently',
 846                                 302 => 'Found',
 847                                 303 => 'See Other',
 848                                 304 => 'Not Modified',
 849                                 305 => 'Use Proxy',
 850                                 307 => 'Temporary Redirect',
 851                                 400 => 'Bad Request',
 852                                 401 => 'Unauthorized',
 853                                 402 => 'Payment Required',
 854                                 403 => 'Forbidden',
 855                                 404 => 'Not Found',
 856                                 405 => 'Method Not Allowed',
 857                                 406 => 'Not Acceptable',
 858                                 407 => 'Proxy Authentication Required',
 859                                 408 => 'Request Timeout',
 860                                 409 => 'Conflict',
 861                                 410 => 'Gone',
 862                                 411 => 'Length Required',
 863                                 412 => 'Precondition Failed',
 864                                 413 => 'Request Entity Too Large',
 865                                 414 => 'Request-URI Too Large',
 866                                 415 => 'Unsupported Media Type',
 867                                 416 => 'Request Range Not Satisfiable',
 868                                 417 => 'Expectation Failed',
 869                                 422 => 'Unprocessable Entity',
 870                                 423 => 'Locked',
 871                                 424 => 'Failed Dependency',
 872                                 500 => 'Internal Server Error',
 873                                 501 => 'Not Implemented',
 874                                 502 => 'Bad Gateway',
 875                                 503 => 'Service Unavailable',
 876                                 504 => 'Gateway Timeout',
 877                                 505 => 'HTTP Version Not Supported',
 878                                 507 => 'Insufficient Storage'
 879                         );
 880
 881                         if ( $statusMessage[$this->mStatusCode] )
 882                                 $wgRequest->response()->header( 'HTTP/1.1 ' . $this->mStatusCode . ' ' . $statusMessage[$this->mStatusCode] );
 883                 }
 884
 885                 $sk = $wgUser->getSkin();
 886
 887                 if ( $wgUseAjax ) {
 888                         $this->addScriptFile( 'ajax.js' );
 889
 890                         wfRunHooks( 'AjaxAddScript', array( &$this ) );
 891
 892                         if( $wgAjaxWatch && $wgUser->isLoggedIn() ) {
 893                                 $this->addScriptFile( 'ajaxwatch.js' );
 894                         }
 895
 896                         if ( $wgEnableMWSuggest && !$wgUser->getOption( 'disablesuggest', false ) ){
 897                                 $this->addScriptFile( 'mwsuggest.js' );
 898                         }
 899                 }
 900
 901                 if( $wgUser->getBoolOption( 'editsectiononrightclick' ) ) {
 902                         $this->addScriptFile( 'rightclickedit.js' );
 903                 }
 904
 905                 if( $wgUniversalEditButton ) {
 906                         if( isset( $wgArticle ) && isset( $wgTitle ) && $wgTitle->quickUserCan( 'edit' )
 907                                 && ( $wgTitle->exists() || $wgTitle->quickUserCan( 'create' ) ) ) {
 908                                 // Original UniversalEditButton
 909                                 $this->addLink( array(
 910                                         'rel' => 'alternate',
 911                                         'type' => 'application/x-wiki',
 912                                         'title' => wfMsg( 'edit' ),
 913                                         'href' => $wgTitle->getFullURL( 'action=edit' )
 914                                 ) );
 915                                 // Alternate edit link
 916                                 $this->addLink( array(
 917                                         'rel' => 'edit',
 918                                         'title' => wfMsg( 'edit' ),
 919                                         'href' => $wgTitle->getFullURL( 'action=edit' )
 920                                 ) );
 921                         }
 922                 }
 923
 924                 # Buffer output; final headers may depend on later processing
 925                 ob_start();
 926
 927                 $wgRequest->response()->header( "Content-type: $wgMimeType; charset={$wgOutputEncoding}" );
 928                 $wgRequest->response()->header( 'Content-language: '.$wgContLanguageCode );
 929
 930                 if ($this->mArticleBodyOnly) {
 931                         $this->out($this->mBodytext);
 932                 } else {
 933                         // Hook that allows last minute changes to the output page, e.g.
 934                         // adding of CSS or Javascript by extensions.
 935                         wfRunHooks( 'BeforePageDisplay', array( &$this, &$sk ) );
 936
 937                         wfProfileIn( 'Output-skin' );
 938                         $sk->outputPage( $this );
 939                         wfProfileOut( 'Output-skin' );
 940                 }
 941
 942                 $this->sendCacheControl();
 943                 ob_end_flush();
 944                 wfProfileOut( __METHOD__ );
 945         }
 946
 947         /**
 948          * @todo document
 949          * @param string $ins
 950          */
 951         public function out( $ins ) {
 952                 global $wgInputEncoding, $wgOutputEncoding, $wgContLang;
 953                 if ( 0 == strcmp( $wgInputEncoding, $wgOutputEncoding ) ) {
 954                         $outs = $ins;
 955                 } else {
 956                         $outs = $wgContLang->iconv( $wgInputEncoding, $wgOutputEncoding, $ins );
 957                         if ( false === $outs ) { $outs = $ins; }
 958                 }
 959                 print $outs;
 960         }
 961
 962         /**
 963          * @todo document
 964          */
 965         public static function setEncodings() {
 966                 global $wgInputEncoding, $wgOutputEncoding;
 967                 global $wgUser, $wgContLang;
 968
 969                 $wgInputEncoding = strtolower( $wgInputEncoding );
 970
 971                 if ( empty( $_SERVER['HTTP_ACCEPT_CHARSET'] ) ) {
 972                         $wgOutputEncoding = strtolower( $wgOutputEncoding );
 973                         return;
 974                 }
 975                 $wgOutputEncoding = $wgInputEncoding;
 976         }
 977
 978         /**
 979          * Deprecated, use wfReportTime() instead.
 980          * @return string
 981          * @deprecated
 982          */
 983         public function reportTime() {
 984                 wfDeprecated( __METHOD__ );
 985                 $time = wfReportTime();
 986                 return $time;
 987         }
 988
 989         /**
 990          * Produce a "user is blocked" page.
 991          *
 992          * @param bool $return Whether to have a "return to $wgTitle" message or not.
 993          * @return nothing
 994          */
 995         function blockedPage( $return = true ) {
 996                 global $wgUser, $wgContLang, $wgTitle, $wgLang;
 997
 998                 $this->setPageTitle( wfMsg( 'blockedtitle' ) );
 999                 $this->setRobotPolicy( 'noindex,nofollow' );
1000                 $this->setArticleRelated( false );
1001
1002                 $name = User::whoIs( $wgUser->blockedBy() );
1003                 $reason = $wgUser->blockedFor();
1004                 if( $reason == '' ) {
1005                         $reason = wfMsg( 'blockednoreason' );
1006                 }
1007                 $blockTimestamp = $wgLang->timeanddate( wfTimestamp( TS_MW, $wgUser->mBlock->mTimestamp ), true );
1008                 $ip = wfGetIP();
1009
1010                 $link = '[[' . $wgContLang->getNsText( NS_USER ) . ":{$name}|{$name}]]";
1011
1012                 $blockid = $wgUser->mBlock->mId;
1013
1014                 $blockExpiry = $wgUser->mBlock->mExpiry;
1015                 if ( $blockExpiry == 'infinity' ) {
1016                         // Entry in database (table ipblocks) is 'infinity' but 'ipboptions' uses 'infinite' or 'indefinite'
1017                         // Search for localization in 'ipboptions'
1018                         $scBlockExpiryOptions = wfMsg( 'ipboptions' );
1019                         foreach ( explode( ',', $scBlockExpiryOptions ) as $option ) {
1020                                 if ( strpos( $option, ":" ) === false )
1021                                         continue;
1022                                 list( $show, $value ) = explode( ":", $option );
1023                                 if ( $value == 'infinite' || $value == 'indefinite' ) {
1024                                         $blockExpiry = $show;
1025                                         break;
1026                                 }
1027                         }
1028                 } else {
1029                         $blockExpiry = $wgLang->timeanddate( wfTimestamp( TS_MW, $blockExpiry ), true );
1030                 }
1031
1032                 if ( $wgUser->mBlock->mAuto ) {
1033                         $msg = 'autoblockedtext';
1034                 } else {
1035                         $msg = 'blockedtext';
1036                 }
1037
1038                 /* $ip returns who *is* being blocked, $intended contains who was meant to be blocked.
1039                  * This could be a username, an ip range, or a single ip. */
1040                 $intended = $wgUser->mBlock->mAddress;
1041
1042                 $this->addWikiMsg( $msg, $link, $reason, $ip, $name, $blockid, $blockExpiry, $intended, $blockTimestamp );
1043
1044                 # Don't auto-return to special pages
1045                 if( $return ) {
1046                         $return = $wgTitle->getNamespace() > -1 ? $wgTitle : NULL;
1047                         $this->returnToMain( null, $return );
1048                 }
1049         }
1050
1051         /**
1052          * Output a standard error page
1053          *
1054          * @param string $title Message key for page title
1055          * @param string $msg Message key for page text
1056          * @param array $params Message parameters
1057          */
1058         public function showErrorPage( $title, $msg, $params = array() ) {
1059                 global $wgTitle;
1060                 if ( isset($wgTitle) ) {
1061                         $this->mDebugtext .= 'Original title: ' . $wgTitle->getPrefixedText() . "\n";
1062                 }
1063                 $this->setPageTitle( wfMsg( $title ) );
1064                 $this->setHTMLTitle( wfMsg( 'errorpagetitle' ) );
1065                 $this->setRobotPolicy( 'noindex,nofollow' );
1066                 $this->setArticleRelated( false );
1067                 $this->enableClientCache( false );
1068                 $this->mRedirect = '';
1069                 $this->mBodytext = '';
1070
1071                 array_unshift( $params, 'parse' );
1072                 array_unshift( $params, $msg );
1073                 $this->addHtml( call_user_func_array( 'wfMsgExt', $params ) );
1074
1075                 $this->returnToMain();
1076         }
1077
1078         /**
1079          * Output a standard permission error page
1080          *
1081          * @param array $errors Error message keys
1082          */
1083         public function showPermissionsErrorPage( $errors, $action = null )
1084         {
1085                 global $wgTitle;
1086
1087                 $this->mDebugtext .= 'Original title: ' .
1088                 $wgTitle->getPrefixedText() . "\n";
1089                 $this->setPageTitle( wfMsg( 'permissionserrors' ) );
1090                 $this->setHTMLTitle( wfMsg( 'permissionserrors' ) );
1091                 $this->setRobotPolicy( 'noindex,nofollow' );
1092                 $this->setArticleRelated( false );
1093                 $this->enableClientCache( false );
1094                 $this->mRedirect = '';
1095                 $this->mBodytext = '';
1096                 $this->addWikiText( $this->formatPermissionsErrorMessage( $errors, $action ) );
1097         }
1098
1099         /** @deprecated */
1100         public function errorpage( $title, $msg ) {
1101                 wfDeprecated( __METHOD__ );
1102                 throw new ErrorPageError( $title, $msg );
1103         }
1104
1105         /**
1106          * Display an error page indicating that a given version of MediaWiki is
1107          * required to use it
1108          *
1109          * @param mixed $version The version of MediaWiki needed to use the page
1110          */
1111         public function versionRequired( $version ) {
1112                 $this->setPageTitle( wfMsg( 'versionrequired', $version ) );
1113                 $this->setHTMLTitle( wfMsg( 'versionrequired', $version ) );
1114                 $this->setRobotPolicy( 'noindex,nofollow' );
1115                 $this->setArticleRelated( false );
1116                 $this->mBodytext = '';
1117
1118                 $this->addWikiMsg( 'versionrequiredtext', $version );
1119                 $this->returnToMain();
1120         }
1121
1122         /**
1123          * Display an error page noting that a given permission bit is required.
1124          *
1125          * @param string $permission key required
1126          */
1127         public function permissionRequired( $permission ) {
1128                 global $wgUser;
1129
1130                 $this->setPageTitle( wfMsg( 'badaccess' ) );
1131                 $this->setHTMLTitle( wfMsg( 'errorpagetitle' ) );
1132                 $this->setRobotPolicy( 'noindex,nofollow' );
1133                 $this->setArticleRelated( false );
1134                 $this->mBodytext = '';
1135
1136                 $groups = array_map( array( 'User', 'makeGroupLinkWiki' ),
1137                         User::getGroupsWithPermission( $permission ) );
1138                 if( $groups ) {
1139                         $this->addWikiMsg( 'badaccess-groups',
1140                                 implode( ', ', $groups ),
1141                                 count( $groups) );
1142                 } else {
1143                         $this->addWikiMsg( 'badaccess-group0' );
1144                 }
1145                 $this->returnToMain();
1146         }
1147
1148         /**
1149          * Use permissionRequired.
1150          * @deprecated
1151          */
1152         public function sysopRequired() {
1153                 throw new MWException( "Call to deprecated OutputPage::sysopRequired() method\n" );
1154         }
1155
1156         /**
1157          * Use permissionRequired.
1158          * @deprecated
1159          */
1160         public function developerRequired() {
1161                 throw new MWException( "Call to deprecated OutputPage::developerRequired() method\n" );
1162         }
1163
1164         /**
1165          * Produce the stock "please login to use the wiki" page
1166          */
1167         public function loginToUse() {
1168                 global $wgUser, $wgTitle, $wgContLang;
1169
1170                 if( $wgUser->isLoggedIn() ) {
1171                         $this->permissionRequired( 'read' );
1172                         return;
1173                 }
1174
1175                 $skin = $wgUser->getSkin();
1176
1177                 $this->setPageTitle( wfMsg( 'loginreqtitle' ) );
1178                 $this->setHtmlTitle( wfMsg( 'errorpagetitle' ) );
1179                 $this->setRobotPolicy( 'noindex,nofollow' );
1180                 $this->setArticleFlag( false );
1181
1182                 $loginTitle = SpecialPage::getTitleFor( 'Userlogin' );
1183                 $loginLink = $skin->makeKnownLinkObj( $loginTitle, wfMsgHtml( 'loginreqlink' ), 'returnto=' . $wgTitle->getPrefixedUrl() );
1184                 $this->addHtml( wfMsgWikiHtml( 'loginreqpagetext', $loginLink ) );
1185                 $this->addHtml( "\n<!--" . $wgTitle->getPrefixedUrl() . "-->" );
1186
1187                 # Don't return to the main page if the user can't read it
1188                 # otherwise we'll end up in a pointless loop
1189                 $mainPage = Title::newMainPage();
1190                 if( $mainPage->userCanRead() )
1191                         $this->returnToMain( null, $mainPage );
1192         }
1193
1194         /** @deprecated */
1195         public function databaseError( $fname, $sql, $error, $errno ) {
1196                 throw new MWException( "OutputPage::databaseError is obsolete\n" );
1197         }
1198
1199         /**
1200          * @param array $errors An array of arrays returned by Title::getUserPermissionsErrors
1201          * @return string The wikitext error-messages, formatted into a list.
1202          */
1203         public function formatPermissionsErrorMessage( $errors, $action = null ) {
1204                 if ($action == null) {
1205                         $text = wfMsgNoTrans( 'permissionserrorstext', count($errors)). "\n\n";
1206                 } else {
1207                         global $wgLang;
1208                         $action_desc = wfMsg( "action-$action" );
1209                         $text = wfMsgNoTrans( 'permissionserrorstext-withaction', count($errors), $action_desc ) . "\n\n";
1210                 }
1211
1212                 if (count( $errors ) > 1) {
1213                         $text .= '<ul class="permissions-errors">' . "\n";
1214
1215                         foreach( $errors as $error )
1216                         {
1217                                 $text .= '<li>';
1218                                 $text .= call_user_func_array( 'wfMsgNoTrans', $error );
1219                                 $text .= "</li>\n";
1220                         }
1221                         $text .= '</ul>';
1222                 } else {
1223                         $text .= '<div class="permissions-errors">' . call_user_func_array( 'wfMsgNoTrans', reset( $errors ) ) . '</div>';
1224                 }
1225
1226                 return $text;
1227         }
1228
1229         /**
1230          * Display a page stating that the Wiki is in read-only mode,
1231          * and optionally show the source of the page that the user
1232          * was trying to edit.  Should only be called (for this
1233          * purpose) after wfReadOnly() has returned true.
1234          *
1235          * For historical reasons, this function is _also_ used to
1236          * show the error message when a user tries to edit a page
1237          * they are not allowed to edit.  (Unless it's because they're
1238          * blocked, then we show blockedPage() instead.)  In this
1239          * case, the second parameter should be set to true and a list
1240          * of reasons supplied as the third parameter.
1241          *
1242          * @todo Needs to be split into multiple functions.
1243          *
1244          * @param string $source    Source code to show (or null).
1245          * @param bool   $protected Is this a permissions error?
1246          * @param array  $reasons   List of reasons for this error, as returned by Title::getUserPermissionsErrors().
1247          */
1248         public function readOnlyPage( $source = null, $protected = false, $reasons = array(), $action = null ) {
1249                 global $wgUser, $wgTitle;
1250                 $skin = $wgUser->getSkin();
1251
1252                 $this->setRobotPolicy( 'noindex,nofollow' );
1253                 $this->setArticleRelated( false );
1254
1255                 // If no reason is given, just supply a default "I can't let you do
1256                 // that, Dave" message.  Should only occur if called by legacy code.
1257                 if ( $protected && empty($reasons) ) {
1258                         $reasons[] = array( 'badaccess-group0' );
1259                 }
1260
1261                 if ( !empty($reasons) ) {
1262                         // Permissions error
1263                         if( $source ) {
1264                                 $this->setPageTitle( wfMsg( 'viewsource' ) );
1265                                 $this->setSubtitle( wfMsg( 'viewsourcefor', $skin->makeKnownLinkObj( $wgTitle ) ) );
1266                         } else {
1267                                 $this->setPageTitle( wfMsg( 'badaccess' ) );
1268                         }
1269                         $this->addWikiText( $this->formatPermissionsErrorMessage( $reasons, $action ) );
1270                 } else {
1271                         // Wiki is read only
1272                         $this->setPageTitle( wfMsg( 'readonly' ) );
1273                         $reason = wfReadOnlyReason();
1274                         $this->wrapWikiMsg( '<div class="mw-readonly-error">$1</div>', array( 'readonlytext', $reason ) );
1275                 }
1276
1277                 // Show source, if supplied
1278                 if( is_string( $source ) ) {
1279                         $this->addWikiMsg( 'viewsourcetext' );
1280                         $text = Xml::openElement( 'textarea',
1281                                                 array( 'id'   => 'wpTextbox1',
1282                                                        'name' => 'wpTextbox1',
1283                                                        'cols' => $wgUser->getOption( 'cols' ),
1284                                                        'rows' => $wgUser->getOption( 'rows' ),
1285                                                        'readonly' => 'readonly' ) );
1286                         $text .= htmlspecialchars( $source );
1287                         $text .= Xml::closeElement( 'textarea' );
1288                         $this->addHTML( $text );
1289
1290                         // Show templates used by this article
1291                         $skin = $wgUser->getSkin();
1292                         $article = new Article( $wgTitle );
1293                         $this->addHTML( "<div class='templatesUsed'>
1294 {$skin->formatTemplates( $article->getUsedTemplates() )}
1295 </div>
1296 " );
1297                 }
1298
1299                 # If the title doesn't exist, it's fairly pointless to print a return
1300                 # link to it.  After all, you just tried editing it and couldn't, so
1301                 # what's there to do there?
1302                 if( $wgTitle->exists() ) {
1303                         $this->returnToMain( null, $wgTitle );
1304                 }
1305         }
1306
1307         /** @deprecated */
1308         public function fatalError( $message ) {
1309                 wfDeprecated( __METHOD__ );
1310                 throw new FatalError( $message );
1311         }
1312
1313         /** @deprecated */
1314         public function unexpectedValueError( $name, $val ) {
1315                 wfDeprecated( __METHOD__ );
1316                 throw new FatalError( wfMsg( 'unexpected', $name, $val ) );
1317         }
1318
1319         /** @deprecated */
1320         public function fileCopyError( $old, $new ) {
1321                 wfDeprecated( __METHOD__ );
1322                 throw new FatalError( wfMsg( 'filecopyerror', $old, $new ) );
1323         }
1324
1325         /** @deprecated */
1326         public function fileRenameError( $old, $new ) {
1327                 wfDeprecated( __METHOD__ );
1328                 throw new FatalError( wfMsg( 'filerenameerror', $old, $new ) );
1329         }
1330
1331         /** @deprecated */
1332         public function fileDeleteError( $name ) {
1333                 wfDeprecated( __METHOD__ );
1334                 throw new FatalError( wfMsg( 'filedeleteerror', $name ) );
1335         }
1336
1337         /** @deprecated */
1338         public function fileNotFoundError( $name ) {
1339                 wfDeprecated( __METHOD__ );
1340                 throw new FatalError( wfMsg( 'filenotfound', $name ) );
1341         }
1342
1343         public function showFatalError( $message ) {
1344                 $this->setPageTitle( wfMsg( "internalerror" ) );
1345                 $this->setRobotPolicy( "noindex,nofollow" );
1346                 $this->setArticleRelated( false );
1347                 $this->enableClientCache( false );
1348                 $this->mRedirect = '';
1349                 $this->mBodytext = $message;
1350         }
1351
1352         public function showUnexpectedValueError( $name, $val ) {
1353                 $this->showFatalError( wfMsg( 'unexpected', $name, $val ) );
1354         }
1355
1356         public function showFileCopyError( $old, $new ) {
1357                 $this->showFatalError( wfMsg( 'filecopyerror', $old, $new ) );
1358         }
1359
1360         public function showFileRenameError( $old, $new ) {
1361                 $this->showFatalError( wfMsg( 'filerenameerror', $old, $new ) );
1362         }
1363
1364         public function showFileDeleteError( $name ) {
1365                 $this->showFatalError( wfMsg( 'filedeleteerror', $name ) );
1366         }
1367
1368         public function showFileNotFoundError( $name ) {
1369                 $this->showFatalError( wfMsg( 'filenotfound', $name ) );
1370         }
1371
1372         /**
1373          * Add a "return to" link pointing to a specified title
1374          *
1375          * @param Title $title Title to link
1376          */
1377         public function addReturnTo( $title ) {
1378                 global $wgUser;
1379                 $link = wfMsg( 'returnto', $wgUser->getSkin()->makeLinkObj( $title ) );
1380                 $this->addHtml( "<p>{$link}</p>\n" );
1381         }
1382
1383         /**
1384          * Add a "return to" link pointing to a specified title,
1385          * or the title indicated in the request, or else the main page
1386          *
1387          * @param null $unused No longer used
1388          * @param Title $returnto Title to return to
1389          */
1390         public function returnToMain( $unused = null, $returnto = NULL ) {
1391                 global $wgRequest;
1392
1393                 if ( $returnto == NULL ) {
1394                         $returnto = $wgRequest->getText( 'returnto' );
1395                 }
1396
1397                 if ( '' === $returnto ) {
1398                         $returnto = Title::newMainPage();
1399                 }
1400
1401                 if ( is_object( $returnto ) ) {
1402                         $titleObj = $returnto;
1403                 } else {
1404                         $titleObj = Title::newFromText( $returnto );
1405                 }
1406                 if ( !is_object( $titleObj ) ) {
1407                         $titleObj = Title::newMainPage();
1408                 }
1409
1410                 $this->addReturnTo( $titleObj );
1411         }
1412
1413         /**
1414          * This function takes the title (first item of mGoodLinks), categories, existing and broken links for the page
1415          * and uses the first 10 of them for META keywords
1416          *
1417          * @param ParserOutput &$parserOutput
1418          */
1419         private function addKeywords( &$parserOutput ) {
1420                 global $wgTitle;
1421                 $this->addKeyword( $wgTitle->getPrefixedText() );
1422                 $count = 1;
1423                 $links2d =& $parserOutput->getLinks();
1424                 if ( !is_array( $links2d ) ) {
1425                         return;
1426                 }
1427                 foreach ( $links2d as $dbkeys ) {
1428                         foreach( $dbkeys as $dbkey => $unused ) {
1429                                 $this->addKeyword( $dbkey );
1430                                 if ( ++$count > 10 ) {
1431                                         break 2;
1432                                 }
1433                         }
1434                 }
1435         }
1436
1437         /**
1438          * @return string The doctype, opening <html>, and head element.
1439          */
1440         public function headElement( Skin $sk ) {
1441                 global $wgDocType, $wgDTD, $wgContLanguageCode, $wgOutputEncoding, $wgMimeType;
1442                 global $wgXhtmlDefaultNamespace, $wgXhtmlNamespaces;
1443                 global $wgUser, $wgContLang, $wgUseTrackbacks, $wgTitle, $wgStyleVersion;
1444
1445                 $this->addMeta( "http:Content-type", "$wgMimeType; charset={$wgOutputEncoding}" );
1446                 $this->addStyle( 'common/wikiprintable.css', 'print' );
1447                 $sk->setupUserCss( $this );
1448
1449                 $ret = '';
1450
1451                 if( $wgMimeType == 'text/xml' || $wgMimeType == 'application/xhtml+xml' || $wgMimeType == 'application/xml' ) {
1452                         $ret .= "<?xml version=\"1.0\" encoding=\"$wgOutputEncoding\" ?>\n";
1453                 }
1454
1455                 $ret .= "<!DOCTYPE html PUBLIC \"$wgDocType\"\n        \"$wgDTD\">\n";
1456
1457                 if ( '' == $this->getHTMLTitle() ) {
1458                         $this->setHTMLTitle(  wfMsg( 'pagetitle', $this->getPageTitle() ));
1459                 }
1460
1461                 $rtl = $wgContLang->isRTL() ? " dir='RTL'" : '';
1462                 $ret .= "<html xmlns=\"{$wgXhtmlDefaultNamespace}\" ";
1463                 foreach($wgXhtmlNamespaces as $tag => $ns) {
1464                         $ret .= "xmlns:{$tag}=\"{$ns}\" ";
1465                 }
1466                 $ret .= "xml:lang=\"$wgContLanguageCode\" lang=\"$wgContLanguageCode\" $rtl>\n";
1467                 $ret .= "<head>\n<title>" . htmlspecialchars( $this->getHTMLTitle() ) . "</title>\n\t\t";
1468                 $ret .= implode( "\t\t", array(
1469                         $this->getHeadLinks(),
1470                         $this->buildCssLinks(),
1471                         $sk->getHeadScripts( $this->mAllowUserJs ),
1472                         $this->mScripts,
1473                         $this->getHeadItems(),
1474                 ));
1475                 if( $sk->usercss ){
1476                         $ret .= "<style type='text/css'>{$sk->usercss}</style>";
1477                 }
1478
1479                 if ($wgUseTrackbacks && $this->isArticleRelated())
1480                         $ret .= $wgTitle->trackbackRDF();
1481
1482                 $ret .= "</head>\n";
1483                 return $ret;
1484         }
1485
1486         protected function addDefaultMeta() {
1487                 global $wgVersion;
1488                 $this->addMeta( "generator", "MediaWiki $wgVersion" );
1489
1490                 $p = "{$this->mIndexPolicy},{$this->mFollowPolicy}";
1491                 if( $p !== 'index,follow' ) {
1492                         // http://www.robotstxt.org/wc/meta-user.html
1493                         // Only show if it's different from the default robots policy
1494                         $this->addMeta( 'robots', $p );
1495                 }
1496
1497                 if ( count( $this->mKeywords ) > 0 ) {
1498                         $strip = array(
1499                                 "/<.*?>/" => '',
1500                                 "/_/" => ' '
1501                         );
1502                         $this->addMeta( 'keywords', preg_replace(array_keys($strip), array_values($strip),implode( ",", $this->mKeywords ) ) );
1503                 }
1504         }
1505
1506         /**
1507          * @return string HTML tag links to be put in the header.
1508          */
1509         public function getHeadLinks() {
1510                 global $wgRequest, $wgFeed;
1511
1512                 // Ideally this should happen earlier, somewhere. :P
1513                 $this->addDefaultMeta();
1514
1515                 $tags = array();
1516
1517                 foreach ( $this->mMetatags as $tag ) {
1518                         if ( 0 == strcasecmp( 'http:', substr( $tag[0], 0, 5 ) ) ) {
1519                                 $a = 'http-equiv';
1520                                 $tag[0] = substr( $tag[0], 5 );
1521                         } else {
1522                                 $a = 'name';
1523                         }
1524                         $tags[] = Xml::element( 'meta',
1525                                 array(
1526                                         $a => $tag[0],
1527                                         'content' => $tag[1] ) );
1528                 }
1529                 foreach ( $this->mLinktags as $tag ) {
1530                         $tags[] = Xml::element( 'link', $tag );
1531                 }
1532
1533                 if( $wgFeed ) {
1534                         global $wgTitle;
1535                         foreach( $this->getSyndicationLinks() as $format => $link ) {
1536                                 # Use the page name for the title (accessed through $wgTitle since
1537                                 # there's no other way).  In principle, this could lead to issues
1538                                 # with having the same name for different feeds corresponding to
1539                                 # the same page, but we can't avoid that at this low a level.
1540
1541                                 $tags[] = $this->feedLink(
1542                                         $format,
1543                                         $link,
1544                                         wfMsg( "page-{$format}-feed", $wgTitle->getPrefixedText() ) ); # Used messages: 'page-rss-feed' and 'page-atom-feed' (for an easier grep)
1545                         }
1546
1547                         # Recent changes feed should appear on every page (except recentchanges,
1548                         # that would be redundant). Put it after the per-page feed to avoid
1549                         # changing existing behavior. It's still available, probably via a
1550                         # menu in your browser. Some sites might have a different feed they'd
1551                         # like to promote instead of the RC feed (maybe like a "Recent New Articles"
1552                         # or "Breaking news" one). For this, we see if $wgOverrideSiteFeed is defined.
1553                         # If so, use it instead.
1554
1555                         global $wgOverrideSiteFeed, $wgSitename, $wgFeedClasses;
1556                         $rctitle = SpecialPage::getTitleFor( 'Recentchanges' );
1557
1558                         if ( $wgOverrideSiteFeed ) {
1559                                 foreach ( $wgOverrideSiteFeed as $type => $feedUrl ) {
1560                                         $tags[] = $this->feedLink (
1561                                                 $type,
1562                                                 htmlspecialchars( $feedUrl ),
1563                                                 wfMsg( "site-{$type}-feed", $wgSitename ) );
1564                                 }
1565                         }
1566                         else if ( $wgTitle->getPrefixedText() != $rctitle->getPrefixedText() ) {
1567                                 foreach( $wgFeedClasses as $format => $class ) {
1568                                         $tags[] = $this->feedLink(
1569                                                 $format,
1570                                                 $rctitle->getFullURL( "feed={$format}" ),
1571                                                 wfMsg( "site-{$format}-feed", $wgSitename ) ); # For grep: 'site-rss-feed', 'site-atom-feed'.
1572                                 }
1573                         }
1574                 }
1575
1576                 return implode( "\n\t\t", $tags ) . "\n";
1577         }
1578
1579         /**
1580          * Return URLs for each supported syndication format for this page.
1581          * @return array associating format keys with URLs
1582          */
1583         public function getSyndicationLinks() {
1584                 global $wgTitle, $wgFeedClasses;
1585                 $links = array();
1586
1587                 if( $this->isSyndicated() ) {
1588                         if( is_string( $this->getFeedAppendQuery() ) ) {
1589                                 $appendQuery = "&" . $this->getFeedAppendQuery();
1590                         } else {
1591                                 $appendQuery = "";
1592                         }
1593
1594                         foreach( $wgFeedClasses as $format => $class ) {
1595                                 $links[$format] = $wgTitle->getLocalUrl( "feed=$format{$appendQuery}" );
1596                         }
1597                 }
1598                 return $links;
1599         }
1600
1601         /**
1602          * Generate a <link rel/> for an RSS feed.
1603          */
1604         private function feedLink( $type, $url, $text ) {
1605                 return Xml::element( 'link', array(
1606                         'rel' => 'alternate',
1607                         'type' => "application/$type+xml",
1608                         'title' => $text,
1609                         'href' => $url ) );
1610         }
1611
1612         /**
1613          * Add a local or specified stylesheet, with the given media options.
1614          * Meant primarily for internal use...
1615          *
1616          * @param $media -- to specify a media type, 'screen', 'printable', 'handheld' or any.
1617          * @param $conditional -- for IE conditional comments, specifying an IE version
1618          * @param $dir -- set to 'rtl' or 'ltr' for direction-specific sheets
1619          */
1620         public function addStyle( $style, $media='', $condition='', $dir='' ) {
1621                 $options = array();
1622                 if( $media )
1623                         $options['media'] = $media;
1624                 if( $condition )
1625                         $options['condition'] = $condition;
1626                 if( $dir )
1627                         $options['dir'] = $dir;
1628                 $this->styles[$style] = $options;
1629         }
1630
1631         /**
1632          * Build a set of <link>s for the stylesheets specified in the $this->styles array.
1633          * These will be applied to various media & IE conditionals.
1634          */
1635         public function buildCssLinks() {
1636                 $links = array();
1637                 foreach( $this->styles as $file => $options ) {
1638                         $link = $this->styleLink( $file, $options );
1639                         if( $link )
1640                                 $links[] = $link;
1641                 }
1642
1643                 return implode( "\n\t\t", $links );
1644         }
1645
1646         protected function styleLink( $style, $options ) {
1647                 global $wgRequest;
1648
1649                 if( isset( $options['dir'] ) ) {
1650                         global $wgContLang;
1651                         $siteDir = $wgContLang->isRTL() ? 'rtl' : 'ltr';
1652                         if( $siteDir != $options['dir'] )
1653                                 return '';
1654                 }
1655
1656                 if( isset( $options['media'] ) ) {
1657                         $media = $this->transformCssMedia( $options['media'] );
1658                         if( is_null( $media ) ) {
1659                                 return '';
1660                         }
1661                 } else {
1662                         $media = '';
1663                 }
1664
1665                 if( substr( $style, 0, 1 ) == '/' ||
1666                         substr( $style, 0, 5 ) == 'http:' ||
1667                         substr( $style, 0, 6 ) == 'https:' ) {
1668                         $url = $style;
1669                 } else {
1670                         global $wgStylePath, $wgStyleVersion;
1671                         $url = $wgStylePath . '/' . $style . '?' . $wgStyleVersion;
1672                 }
1673
1674                 $attribs = array(
1675                         'rel' => 'stylesheet',
1676                         'href' => $url,
1677                         'type' => 'text/css' );
1678                 if( $media ) {
1679                         $attribs['media'] = $media;
1680                 }
1681
1682                 $link = Xml::element( 'link', $attribs );
1683
1684                 if( isset( $options['condition'] ) ) {
1685                         $condition = htmlspecialchars( $options['condition'] );
1686                         $link = "<!--[if $condition]>$link<![endif]-->";
1687                 }
1688                 return $link;
1689         }
1690
1691         function transformCssMedia( $media ) {
1692                 global $wgRequest, $wgHandheldForIPhone;
1693
1694                 // Switch in on-screen display for media testing
1695                 $switches = array(
1696                         'printable' => 'print',
1697                         'handheld' => 'handheld',
1698                 );
1699                 foreach( $switches as $switch => $targetMedia ) {
1700                         if( $wgRequest->getBool( $switch ) ) {
1701                                 if( $media == $targetMedia ) {
1702                                         $media = '';
1703                                 } elseif( $media == 'screen' ) {
1704                                         return null;
1705                                 }
1706                         }
1707                 }
1708
1709                 // Expand longer media queries as iPhone doesn't grok 'handheld'
1710                 if( $wgHandheldForIPhone ) {
1711                         $mediaAliases = array(
1712                                 'screen' => 'screen and (min-device-width: 481px)',
1713                                 'handheld' => 'handheld, only screen and (max-device-width: 480px)',
1714                         );
1715
1716                         if( isset( $mediaAliases[$media] ) ) {
1717                                 $media = $mediaAliases[$media];
1718                         }
1719                 }
1720
1721                 return $media;
1722         }
1723
1724         /**
1725          * Turn off regular page output and return an error reponse
1726          * for when rate limiting has triggered.
1727          */
1728         public function rateLimited() {
1729                 global $wgTitle;
1730
1731                 $this->setPageTitle(wfMsg('actionthrottled'));
1732                 $this->setRobotPolicy( 'noindex,follow' );
1733                 $this->setArticleRelated( false );
1734                 $this->enableClientCache( false );
1735                 $this->mRedirect = '';
1736                 $this->clearHTML();
1737                 $this->setStatusCode(503);
1738                 $this->addWikiMsg( 'actionthrottledtext' );
1739
1740                 $this->returnToMain( null, $wgTitle );
1741         }
1742
1743         /**
1744          * Show an "add new section" link?
1745          *
1746          * @return bool
1747          */
1748         public function showNewSectionLink() {
1749                 return $this->mNewSectionLink;
1750         }
1751
1752         /**
1753          * Show a warning about slave lag
1754          *
1755          * If the lag is higher than $wgSlaveLagCritical seconds,
1756          * then the warning is a bit more obvious. If the lag is
1757          * lower than $wgSlaveLagWarning, then no warning is shown.
1758          *
1759          * @param int $lag Slave lag
1760          */
1761         public function showLagWarning( $lag ) {
1762                 global $wgSlaveLagWarning, $wgSlaveLagCritical;
1763                 if( $lag >= $wgSlaveLagWarning ) {
1764                         $message = $lag < $wgSlaveLagCritical
1765                                 ? 'lag-warn-normal'
1766                                 : 'lag-warn-high';
1767                         $warning = wfMsgExt( $message, 'parse', $lag );
1768                         $this->addHtml( "<div class=\"mw-{$message}\">\n{$warning}\n</div>\n" );
1769                 }
1770         }
1771
1772         /**
1773          * Add a wikitext-formatted message to the output.
1774          * This is equivalent to:
1775          *
1776          *    $wgOut->addWikiText( wfMsgNoTrans( ... ) )
1777          */
1778         public function addWikiMsg( /*...*/ ) {
1779                 $args = func_get_args();
1780                 $name = array_shift( $args );
1781                 $this->addWikiMsgArray( $name, $args );
1782         }
1783
1784         /**
1785          * Add a wikitext-formatted message to the output.
1786          * Like addWikiMsg() except the parameters are taken as an array
1787          * instead of a variable argument list.
1788          *
1789          * $options is passed through to wfMsgExt(), see that function for details.
1790          */
1791         public function addWikiMsgArray( $name, $args, $options = array() ) {
1792                 $options[] = 'parse';
1793                 $text = wfMsgExt( $name, $options, $args );
1794                 $this->addHTML( $text );
1795         }
1796
1797         /**
1798          * This function takes a number of message/argument specifications, wraps them in
1799          * some overall structure, and then parses the result and adds it to the output.
1800          *
1801          * In the $wrap, $1 is replaced with the first message, $2 with the second, and so
1802          * on. The subsequent arguments may either be strings, in which case they are the
1803          * message names, or an arrays, in which case the first element is the message name,
1804          * and subsequent elements are the parameters to that message.
1805          *
1806          * The special named parameter 'options' in a message specification array is passed
1807          * through to the $options parameter of wfMsgExt().
1808          *
1809          * Don't use this for messages that are not in users interface language.
1810          *
1811          * For example:
1812          *
1813          *    $wgOut->wrapWikiMsg( '<div class="error">$1</div>', 'some-error' );
1814          *
1815          * Is equivalent to:
1816          *
1817          *    $wgOut->addWikiText( '<div class="error">' . wfMsgNoTrans( 'some-error' ) . '</div>' );
1818          */
1819         public function wrapWikiMsg( $wrap /*, ...*/ ) {
1820                 $msgSpecs = func_get_args();
1821                 array_shift( $msgSpecs );
1822                 $msgSpecs = array_values( $msgSpecs );
1823                 $s = $wrap;
1824                 foreach ( $msgSpecs as $n => $spec ) {
1825                         $options = array();
1826                         if ( is_array( $spec ) ) {
1827                                 $args = $spec;
1828                                 $name = array_shift( $args );
1829                                 if ( isset( $args['options'] ) ) {
1830                                         $options = $args['options'];
1831                                         unset( $args['options'] );
1832                                 }
1833                         }  else {
1834                                 $args = array();
1835                                 $name = $spec;
1836                         }
1837                         $s = str_replace( '$' . ($n+1), wfMsgExt( $name, $options, $args ), $s );
1838                 }
1839                 $this->addHTML( $this->parse( $s, /*linestart*/true, /*uilang*/true ) );
1840         }
1841 }