includes/OutputPage.php

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