includes/OutputPage.php

   1 <?php
   2 if ( !defined( 'MEDIAWIKI' ) ) {
   3         die( 1 );
   4 }
   5
   6 /**
   7  * This class should be covered by a general architecture document which does
   8  * not exist as of January 2011.  This is one of the Core classes and should
   9  * be read at least once by any new developers.
  10  *
  11  * This class is used to prepare the final rendering. A skin is then
  12  * applied to the output parameters (links, javascript, html, categories ...).
  13  *
  14  * @todo FIXME: Another class handles sending the whole page to the client.
  15  *
  16  * Some comments comes from a pairing session between Zak Greant and Ashar Voultoiz
  17  * in November 2010.
  18  *
  19  * @todo document
  20  */
  21 class OutputPage extends ContextSource {
  22         /// Should be private. Used with addMeta() which adds <meta>
  23         var $mMetatags = array();
  24
  25         /// <meta keyworkds="stuff"> most of the time the first 10 links to an article
  26         var $mKeywords = array();
  27
  28         var $mLinktags = array();
  29
  30         /// Additional stylesheets. Looks like this is for extensions. Might be replaced by resource loader.
  31         var $mExtStyles = array();
  32
  33         /// Should be private - has getter and setter. Contains the HTML title
  34         var $mPagetitle = '';
  35
  36         /// Contains all of the <body> content. Should be private we got set/get accessors and the append() method.
  37         var $mBodytext = '';
  38
  39         /**
  40          * Holds the debug lines that will be output as comments in page source if
  41          * $wgDebugComments is enabled. See also $wgShowDebug.
  42          * TODO: make a getter method for this
  43          */
  44         public $mDebugtext = ''; // TODO: we might want to replace it by wfDebug() wfDebugLog()
  45
  46         /// Should be private. Stores contents of <title> tag
  47         var $mHTMLtitle = '';
  48
  49         /// Should be private. Is the displayed content related to the source of the corresponding wiki article.
  50         var $mIsarticle = false;
  51
  52         /**
  53          * Should be private. Has get/set methods properly documented.
  54          * Stores "article flag" toggle.
  55          */
  56         var $mIsArticleRelated = true;
  57
  58         /**
  59          * Should be private. We have to set isPrintable(). Some pages should
  60          * never be printed (ex: redirections).
  61          */
  62         var $mPrintable = false;
  63
  64         /**
  65          * Should be private. We have set/get/append methods.
  66          *
  67          * Contains the page subtitle. Special pages usually have some links here.
  68          * Don't confuse with site subtitle added by skins.
  69          */
  70         var $mSubtitle = '';
  71
  72         var $mRedirect = '';
  73         var $mStatusCode;
  74
  75         /**
  76          * mLastModified and mEtag are used for sending cache control.
  77          * The whole caching system should probably be moved into its own class.
  78          */
  79         var $mLastModified = '';
  80
  81         /**
  82          * Should be private. No getter but used in sendCacheControl();
  83          * Contains an HTTP Entity Tags (see RFC 2616 section 3.13) which is used
  84          * as a unique identifier for the content. It is later used by the client
  85          * to compare its cached version with the server version. Client sends
  86          * headers If-Match and If-None-Match containing its locally cached ETAG value.
  87          *
  88          * To get more information, you will have to look at HTTP/1.1 protocol which
  89          * is properly described in RFC 2616 : http://tools.ietf.org/html/rfc2616
  90          */
  91         var $mETag = false;
  92
  93         var $mCategoryLinks = array();
  94         var $mCategories = array();
  95
  96         /// Should be private. Array of Interwiki Prefixed (non DB key) Titles (e.g. 'fr:Test page')
  97         var $mLanguageLinks = array();
  98
  99         /**
 100          * Should be private. Used for JavaScript (pre resource loader)
 101          * We should split js / css.
 102          * mScripts content is inserted as is in <head> by Skin. This might contains
 103          * either a link to a stylesheet or inline css.
 104          */
 105         var $mScripts = '';
 106
 107         /**
 108          * Inline CSS styles. Use addInlineStyle() sparsingly
 109          */
 110         var $mInlineStyles = '';
 111
 112         //
 113         var $mLinkColours;
 114
 115         /**
 116          * Used by skin template.
 117          * Example: $tpl->set( 'displaytitle', $out->mPageLinkTitle );
 118          */
 119         var $mPageLinkTitle = '';
 120
 121         /// Array of elements in <head>. Parser might add its own headers!
 122         var $mHeadItems = array();
 123
 124         // @todo FIXME: Next variables probably comes from the resource loader
 125         var $mModules = array(), $mModuleScripts = array(), $mModuleStyles = array(), $mModuleMessages = array();
 126         var $mResourceLoader;
 127
 128         /** @todo FIXME: Is this still used ?*/
 129         var $mInlineMsg = array();
 130
 131         var $mTemplateIds = array();
 132         var $mImageTimeKeys = array();
 133
 134         var $mRedirectCode = '';
 135
 136         var $mFeedLinksAppendQuery = null;
 137
 138         # What level of 'untrustworthiness' is allowed in CSS/JS modules loaded on this page?
 139         # @see ResourceLoaderModule::$origin
 140         # ResourceLoaderModule::ORIGIN_ALL is assumed unless overridden;
 141         protected $mAllowedModules = array(
 142                 ResourceLoaderModule::TYPE_COMBINED => ResourceLoaderModule::ORIGIN_ALL,
 143         );
 144
 145         /**
 146          * @EasterEgg I just love the name for this self documenting variable.
 147          * @todo document
 148          */
 149         var $mDoNothing = false;
 150
 151         // Parser related.
 152         var $mContainsOldMagic = 0, $mContainsNewMagic = 0;
 153
 154         /// lazy initialised, use parserOptions()
 155         protected $mParserOptions = null;
 156
 157         /**
 158          * Handles the atom / rss links.
 159          * We probably only support atom in 2011.
 160          * Looks like a private variable.
 161          * @see $wgAdvertisedFeedTypes
 162          */
 163         var $mFeedLinks = array();
 164
 165         // Gwicke work on squid caching? Roughly from 2003.
 166         var $mEnableClientCache = true;
 167
 168         /**
 169          * Flag if output should only contain the body of the article.
 170          * Should be private.
 171          */
 172         var $mArticleBodyOnly = false;
 173
 174         var $mNewSectionLink = false;
 175         var $mHideNewSectionLink = false;
 176
 177         /**
 178          * Comes from the parser. This was probably made to load CSS/JS only
 179          * if we had <gallery>. Used directly in CategoryPage.php
 180          * Looks like resource loader can replace this.
 181          */
 182         var $mNoGallery = false;
 183
 184         // should be private.
 185         var $mPageTitleActionText = '';
 186         var $mParseWarnings = array();
 187
 188         // Cache stuff. Looks like mEnableClientCache
 189         var $mSquidMaxage = 0;
 190
 191         // @todo document
 192         var $mPreventClickjacking = true;
 193
 194         /// should be private. To include the variable {{REVISIONID}}
 195         var $mRevisionId = null;
 196
 197         var $mFileVersion = null;
 198
 199         /**
 200          * An array of stylesheet filenames (relative from skins path), with options
 201          * for CSS media, IE conditions, and RTL/LTR direction.
 202          * For internal use; add settings in the skin via $this->addStyle()
 203          *
 204          * Style again! This seems like a code duplication since we already have
 205          * mStyles. This is what makes OpenSource amazing.
 206          */
 207         var $styles = array();
 208
 209         /**
 210          * Whether jQuery is already handled.
 211          */
 212         protected $mJQueryDone = false;
 213
 214         private $mIndexPolicy = 'index';
 215         private $mFollowPolicy = 'follow';
 216         private $mVaryHeader = array(
 217                 'Accept-Encoding' => array( 'list-contains=gzip' ),
 218                 'Cookie' => null
 219         );
 220
 221         /**
 222          * Constructor for OutputPage. This should not be called directly.
 223          * Instead a new RequestContext should be created and it will implicitly create
 224          * a OutputPage tied to that context.
 225          */
 226         function __construct( RequestContext $context = null ) {
 227                 if ( $context === null ) {
 228                         # Extensions should use `new RequestContext` instead of `new OutputPage` now.
 229                         wfDeprecated( __METHOD__ );
 230                 } else {
 231                         $this->setContext( $context );
 232                 }
 233         }
 234
 235         /**
 236          * Redirect to $url rather than displaying the normal page
 237          *
 238          * @param $url String: URL
 239          * @param $responsecode String: HTTP status code
 240          */
 241         public function redirect( $url, $responsecode = '302' ) {
 242                 # Strip newlines as a paranoia check for header injection in PHP<5.1.2
 243                 $this->mRedirect = str_replace( "\n", '', $url );
 244                 $this->mRedirectCode = $responsecode;
 245         }
 246
 247         /**
 248          * Get the URL to redirect to, or an empty string if not redirect URL set
 249          *
 250          * @return String
 251          */
 252         public function getRedirect() {
 253                 return $this->mRedirect;
 254         }
 255
 256         /**
 257          * Set the HTTP status code to send with the output.
 258          *
 259          * @param $statusCode Integer
 260          */
 261         public function setStatusCode( $statusCode ) {
 262                 $this->mStatusCode = $statusCode;
 263         }
 264
 265         /**
 266          * Add a new <meta> tag
 267          * To add an http-equiv meta tag, precede the name with "http:"
 268          *
 269          * @param $name String tag name
 270          * @param $val String tag value
 271          */
 272         function addMeta( $name, $val ) {
 273                 array_push( $this->mMetatags, array( $name, $val ) );
 274         }
 275
 276         /**
 277          * Add a keyword or a list of keywords in the page header
 278          *
 279          * @param $text String or array of strings
 280          */
 281         function addKeyword( $text ) {
 282                 if( is_array( $text ) ) {
 283                         $this->mKeywords = array_merge( $this->mKeywords, $text );
 284                 } else {
 285                         array_push( $this->mKeywords, $text );
 286                 }
 287         }
 288
 289         /**
 290          * Add a new \<link\> tag to the page header
 291          *
 292          * @param $linkarr Array: associative array of attributes.
 293          */
 294         function addLink( $linkarr ) {
 295                 array_push( $this->mLinktags, $linkarr );
 296         }
 297
 298         /**
 299          * Add a new \<link\> with "rel" attribute set to "meta"
 300          *
 301          * @param $linkarr Array: associative array mapping attribute names to their
 302          *                 values, both keys and values will be escaped, and the
 303          *                 "rel" attribute will be automatically added
 304          */
 305         function addMetadataLink( $linkarr ) {
 306                 $linkarr['rel'] = $this->getMetadataAttribute();
 307                 $this->addLink( $linkarr );
 308         }
 309
 310         /**
 311          * Get the value of the "rel" attribute for metadata links
 312          *
 313          * @return String
 314          */
 315         public function getMetadataAttribute() {
 316                 # note: buggy CC software only reads first "meta" link
 317                 static $haveMeta = false;
 318                 if ( $haveMeta ) {
 319                         return 'alternate meta';
 320                 } else {
 321                         $haveMeta = true;
 322                         return 'meta';
 323                 }
 324         }
 325
 326         /**
 327          * Add raw HTML to the list of scripts (including \<script\> tag, etc.)
 328          *
 329          * @param $script String: raw HTML
 330          */
 331         function addScript( $script ) {
 332                 $this->mScripts .= $script . "\n";
 333         }
 334
 335         /**
 336          * Register and add a stylesheet from an extension directory.
 337          *
 338          * @param $url String path to sheet.  Provide either a full url (beginning
 339          *             with 'http', etc) or a relative path from the document root
 340          *             (beginning with '/').  Otherwise it behaves identically to
 341          *             addStyle() and draws from the /skins folder.
 342          */
 343         public function addExtensionStyle( $url ) {
 344                 array_push( $this->mExtStyles, $url );
 345         }
 346
 347         /**
 348          * Get all styles added by extensions
 349          *
 350          * @return Array
 351          */
 352         function getExtStyle() {
 353                 return $this->mExtStyles;
 354         }
 355
 356         /**
 357          * Add a JavaScript file out of skins/common, or a given relative path.
 358          *
 359          * @param $file String: filename in skins/common or complete on-server path
 360          *              (/foo/bar.js)
 361          * @param $version String: style version of the file. Defaults to $wgStyleVersion
 362          */
 363         public function addScriptFile( $file, $version = null ) {
 364                 global $wgStylePath, $wgStyleVersion;
 365                 // See if $file parameter is an absolute URL or begins with a slash
 366                 if( substr( $file, 0, 1 ) == '/' || preg_match( '#^[a-z]*://#i', $file ) ) {
 367                         $path = $file;
 368                 } else {
 369                         $path = "{$wgStylePath}/common/{$file}";
 370                 }
 371                 if ( is_null( $version ) )
 372                         $version = $wgStyleVersion;
 373                 $this->addScript( Html::linkedScript( wfAppendQuery( $path, $version ) ) );
 374         }
 375
 376         /**
 377          * Add a self-contained script tag with the given contents
 378          *
 379          * @param $script String: JavaScript text, no <script> tags
 380          */
 381         public function addInlineScript( $script ) {
 382                 $this->mScripts .= Html::inlineScript( "\n$script\n" ) . "\n";
 383         }
 384
 385         /**
 386          * Get all registered JS and CSS tags for the header.
 387          *
 388          * @return String
 389          */
 390         function getScript() {
 391                 return $this->mScripts . $this->getHeadItems();
 392         }
 393
 394         /**
 395          * Filter an array of modules to remove insufficiently trustworthy members, and modules
 396          * which are no longer registered (eg a page is cached before an extension is disabled)
 397          * @param $modules Array
 398          * @param $position String if not null, only return modules with this position
 399          * @param $type string
 400          * @return Array
 401          */
 402         protected function filterModules( $modules, $position = null, $type = ResourceLoaderModule::TYPE_COMBINED ){
 403                 $resourceLoader = $this->getResourceLoader();
 404                 $filteredModules = array();
 405                 foreach( $modules as $val ){
 406                         $module = $resourceLoader->getModule( $val );
 407                         if( $module instanceof ResourceLoaderModule
 408                                 && $module->getOrigin() <= $this->getAllowedModules( $type )
 409                                 && ( is_null( $position ) || $module->getPosition() == $position ) )
 410                         {
 411                                 $filteredModules[] = $val;
 412                         }
 413                 }
 414                 return $filteredModules;
 415         }
 416
 417         /**
 418          * Get the list of modules to include on this page
 419          *
 420          * @param $filter Bool whether to filter out insufficiently trustworthy modules
 421          * @param $position String if not null, only return modules with this position
 422          * @param $param string
 423          * @return Array of module names
 424          */
 425         public function getModules( $filter = false, $position = null, $param = 'mModules' ) {
 426                 $modules = array_values( array_unique( $this->$param ) );
 427                 return $filter
 428                         ? $this->filterModules( $modules, $position )
 429                         : $modules;
 430         }
 431
 432         /**
 433          * Add one or more modules recognized by the resource loader. Modules added
 434          * through this function will be loaded by the resource loader when the
 435          * page loads.
 436          *
 437          * @param $modules Mixed: module name (string) or array of module names
 438          */
 439         public function addModules( $modules ) {
 440                 $this->mModules = array_merge( $this->mModules, (array)$modules );
 441         }
 442
 443         /**
 444          * Get the list of module JS to include on this page
 445          *
 446          * @param $filter
 447          * @param $position
 448          *
 449          * @return array of module names
 450          */
 451         public function getModuleScripts( $filter = false, $position = null ) {
 452                 return $this->getModules( $filter, $position, 'mModuleScripts' );
 453         }
 454
 455         /**
 456          * Add only JS of one or more modules recognized by the resource loader. Module
 457          * scripts added through this function will be loaded by the resource loader when
 458          * the page loads.
 459          *
 460          * @param $modules Mixed: module name (string) or array of module names
 461          */
 462         public function addModuleScripts( $modules ) {
 463                 $this->mModuleScripts = array_merge( $this->mModuleScripts, (array)$modules );
 464         }
 465
 466         /**
 467          * Get the list of module CSS to include on this page
 468          *
 469          * @param $filter
 470          * @param $position
 471          *
 472          * @return Array of module names
 473          */
 474         public function getModuleStyles( $filter = false, $position = null ) {
 475                 return $this->getModules( $filter,  $position, 'mModuleStyles' );
 476         }
 477
 478         /**
 479          * Add only CSS of one or more modules recognized by the resource loader. Module
 480          * styles added through this function will be loaded by the resource loader when
 481          * the page loads.
 482          *
 483          * @param $modules Mixed: module name (string) or array of module names
 484          */
 485         public function addModuleStyles( $modules ) {
 486                 $this->mModuleStyles = array_merge( $this->mModuleStyles, (array)$modules );
 487         }
 488
 489         /**
 490          * Get the list of module messages to include on this page
 491          *
 492          * @param $filter
 493          * @param $position
 494          *
 495          * @return Array of module names
 496          */
 497         public function getModuleMessages( $filter = false, $position = null ) {
 498                 return $this->getModules( $filter, $position, 'mModuleMessages' );
 499         }
 500
 501         /**
 502          * Add only messages of one or more modules recognized by the resource loader.
 503          * Module messages added through this function will be loaded by the resource
 504          * loader when the page loads.
 505          *
 506          * @param $modules Mixed: module name (string) or array of module names
 507          */
 508         public function addModuleMessages( $modules ) {
 509                 $this->mModuleMessages = array_merge( $this->mModuleMessages, (array)$modules );
 510         }
 511
 512         /**
 513          * Get an array of head items
 514          *
 515          * @return Array
 516          */
 517         function getHeadItemsArray() {
 518                 return $this->mHeadItems;
 519         }
 520
 521         /**
 522          * Get all header items in a string
 523          *
 524          * @return String
 525          */
 526         function getHeadItems() {
 527                 $s = '';
 528                 foreach ( $this->mHeadItems as $item ) {
 529                         $s .= $item;
 530                 }
 531                 return $s;
 532         }
 533
 534         /**
 535          * Add or replace an header item to the output
 536          *
 537          * @param $name String: item name
 538          * @param $value String: raw HTML
 539          */
 540         public function addHeadItem( $name, $value ) {
 541                 $this->mHeadItems[$name] = $value;
 542         }
 543
 544         /**
 545          * Check if the header item $name is already set
 546          *
 547          * @param $name String: item name
 548          * @return Boolean
 549          */
 550         public function hasHeadItem( $name ) {
 551                 return isset( $this->mHeadItems[$name] );
 552         }
 553
 554         /**
 555          * Set the value of the ETag HTTP header, only used if $wgUseETag is true
 556          *
 557          * @param $tag String: value of "ETag" header
 558          */
 559         function setETag( $tag ) {
 560                 $this->mETag = $tag;
 561         }
 562
 563         /**
 564          * Set whether the output should only contain the body of the article,
 565          * without any skin, sidebar, etc.
 566          * Used e.g. when calling with "action=render".
 567          *
 568          * @param $only Boolean: whether to output only the body of the article
 569          */
 570         public function setArticleBodyOnly( $only ) {
 571                 $this->mArticleBodyOnly = $only;
 572         }
 573
 574         /**
 575          * Return whether the output will contain only the body of the article
 576          *
 577          * @return Boolean
 578          */
 579         public function getArticleBodyOnly() {
 580                 return $this->mArticleBodyOnly;
 581         }
 582
 583         /**
 584          * checkLastModified tells the client to use the client-cached page if
 585          * possible. If sucessful, the OutputPage is disabled so that
 586          * any future call to OutputPage->output() have no effect.
 587          *
 588          * Side effect: sets mLastModified for Last-Modified header
 589          *
 590          * @param $timestamp string
 591          *
 592          * @return Boolean: true iff cache-ok headers was sent.
 593          */
 594         public function checkLastModified( $timestamp ) {
 595                 global $wgCachePages, $wgCacheEpoch;
 596
 597                 if ( !$timestamp || $timestamp == '19700101000000' ) {
 598                         wfDebug( __METHOD__ . ": CACHE DISABLED, NO TIMESTAMP\n" );
 599                         return false;
 600                 }
 601                 if( !$wgCachePages ) {
 602                         wfDebug( __METHOD__ . ": CACHE DISABLED\n", false );
 603                         return false;
 604                 }
 605                 if( $this->getUser()->getOption( 'nocache' ) ) {
 606                         wfDebug( __METHOD__ . ": USER DISABLED CACHE\n", false );
 607                         return false;
 608                 }
 609
 610                 $timestamp = wfTimestamp( TS_MW, $timestamp );
 611                 $modifiedTimes = array(
 612                         'page' => $timestamp,
 613                         'user' => $this->getUser()->getTouched(),
 614                         'epoch' => $wgCacheEpoch
 615                 );
 616                 wfRunHooks( 'OutputPageCheckLastModified', array( &$modifiedTimes ) );
 617
 618                 $maxModified = max( $modifiedTimes );
 619                 $this->mLastModified = wfTimestamp( TS_RFC2822, $maxModified );
 620
 621                 if( empty( $_SERVER['HTTP_IF_MODIFIED_SINCE'] ) ) {
 622                         wfDebug( __METHOD__ . ": client did not send If-Modified-Since header\n", false );
 623                         return false;
 624                 }
 625
 626                 # Make debug info
 627                 $info = '';
 628                 foreach ( $modifiedTimes as $name => $value ) {
 629                         if ( $info !== '' ) {
 630                                 $info .= ', ';
 631                         }
 632                         $info .= "$name=" . wfTimestamp( TS_ISO_8601, $value );
 633                 }
 634
 635                 # IE sends sizes after the date like this:
 636                 # Wed, 20 Aug 2003 06:51:19 GMT; length=5202
 637                 # this breaks strtotime().
 638                 $clientHeader = preg_replace( '/;.*$/', '', $_SERVER["HTTP_IF_MODIFIED_SINCE"] );
 639
 640                 wfSuppressWarnings(); // E_STRICT system time bitching
 641                 $clientHeaderTime = strtotime( $clientHeader );
 642                 wfRestoreWarnings();
 643                 if ( !$clientHeaderTime ) {
 644                         wfDebug( __METHOD__ . ": unable to parse the client's If-Modified-Since header: $clientHeader\n" );
 645                         return false;
 646                 }
 647                 $clientHeaderTime = wfTimestamp( TS_MW, $clientHeaderTime );
 648
 649                 wfDebug( __METHOD__ . ": client sent If-Modified-Since: " .
 650                         wfTimestamp( TS_ISO_8601, $clientHeaderTime ) . "\n", false );
 651                 wfDebug( __METHOD__ . ": effective Last-Modified: " .
 652                         wfTimestamp( TS_ISO_8601, $maxModified ) . "\n", false );
 653                 if( $clientHeaderTime < $maxModified ) {
 654                         wfDebug( __METHOD__ . ": STALE, $info\n", false );
 655                         return false;
 656                 }
 657
 658                 # Not modified
 659                 # Give a 304 response code and disable body output
 660                 wfDebug( __METHOD__ . ": NOT MODIFIED, $info\n", false );
 661                 ini_set( 'zlib.output_compression', 0 );
 662                 $this->getRequest()->response()->header( "HTTP/1.1 304 Not Modified" );
 663                 $this->sendCacheControl();
 664                 $this->disable();
 665
 666                 // Don't output a compressed blob when using ob_gzhandler;
 667                 // it's technically against HTTP spec and seems to confuse
 668                 // Firefox when the response gets split over two packets.
 669                 wfClearOutputBuffers();
 670
 671                 return true;
 672         }
 673
 674         /**
 675          * Override the last modified timestamp
 676          *
 677          * @param $timestamp String: new timestamp, in a format readable by
 678          *        wfTimestamp()
 679          */
 680         public function setLastModified( $timestamp ) {
 681                 $this->mLastModified = wfTimestamp( TS_RFC2822, $timestamp );
 682         }
 683
 684         /**
 685          * Set the robot policy for the page: <http://www.robotstxt.org/meta.html>
 686          *
 687          * @param $policy String: the literal string to output as the contents of
 688          *   the meta tag.  Will be parsed according to the spec and output in
 689          *   standardized form.
 690          * @return null
 691          */
 692         public function setRobotPolicy( $policy ) {
 693                 $policy = Article::formatRobotPolicy( $policy );
 694
 695                 if( isset( $policy['index'] ) ) {
 696                         $this->setIndexPolicy( $policy['index'] );
 697                 }
 698                 if( isset( $policy['follow'] ) ) {
 699                         $this->setFollowPolicy( $policy['follow'] );
 700                 }
 701         }
 702
 703         /**
 704          * Set the index policy for the page, but leave the follow policy un-
 705          * touched.
 706          *
 707          * @param $policy string Either 'index' or 'noindex'.
 708          * @return null
 709          */
 710         public function setIndexPolicy( $policy ) {
 711                 $policy = trim( $policy );
 712                 if( in_array( $policy, array( 'index', 'noindex' ) ) ) {
 713                         $this->mIndexPolicy = $policy;
 714                 }
 715         }
 716
 717         /**
 718          * Set the follow policy for the page, but leave the index policy un-
 719          * touched.
 720          *
 721          * @param $policy String: either 'follow' or 'nofollow'.
 722          * @return null
 723          */
 724         public function setFollowPolicy( $policy ) {
 725                 $policy = trim( $policy );
 726                 if( in_array( $policy, array( 'follow', 'nofollow' ) ) ) {
 727                         $this->mFollowPolicy = $policy;
 728                 }
 729         }
 730
 731         /**
 732          * Set the new value of the "action text", this will be added to the
 733          * "HTML title", separated from it with " - ".
 734          *
 735          * @param $text String: new value of the "action text"
 736          */
 737         public function setPageTitleActionText( $text ) {
 738                 $this->mPageTitleActionText = $text;
 739         }
 740
 741         /**
 742          * Get the value of the "action text"
 743          *
 744          * @return String
 745          */
 746         public function getPageTitleActionText() {
 747                 if ( isset( $this->mPageTitleActionText ) ) {
 748                         return $this->mPageTitleActionText;
 749                 }
 750         }
 751
 752         /**
 753          * "HTML title" means the contents of <title>.
 754          * It is stored as plain, unescaped text and will be run through htmlspecialchars in the skin file.
 755          *
 756          * @param $name string
 757          */
 758         public function setHTMLTitle( $name ) {
 759                 $this->mHTMLtitle = $name;
 760         }
 761
 762         /**
 763          * Return the "HTML title", i.e. the content of the <title> tag.
 764          *
 765          * @return String
 766          */
 767         public function getHTMLTitle() {
 768                 return $this->mHTMLtitle;
 769         }
 770
 771         /**
 772          * "Page title" means the contents of \<h1\>. It is stored as a valid HTML fragment.
 773          * This function allows good tags like \<sup\> in the \<h1\> tag, but not bad tags like \<script\>.
 774          * This function automatically sets \<title\> to the same content as \<h1\> but with all tags removed.
 775          * Bad tags that were escaped in \<h1\> will still be escaped in \<title\>, and good tags like \<i\> will be dropped entirely.
 776          *
 777          * @param $name string
 778          */
 779         public function setPageTitle( $name ) {
 780                 # change "<script>foo&bar</script>" to "&lt;script&gt;foo&amp;bar&lt;/script&gt;"
 781                 # but leave "<i>foobar</i>" alone
 782                 $nameWithTags = Sanitizer::normalizeCharReferences( Sanitizer::removeHTMLtags( $name ) );
 783                 $this->mPagetitle = $nameWithTags;
 784
 785                 # change "<i>foo&amp;bar</i>" to "foo&bar"
 786                 $this->setHTMLTitle( wfMsg( 'pagetitle', Sanitizer::stripAllTags( $nameWithTags ) ) );
 787         }
 788
 789         /**
 790          * Return the "page title", i.e. the content of the \<h1\> tag.
 791          *
 792          * @return String
 793          */
 794         public function getPageTitle() {
 795                 return $this->mPagetitle;
 796         }
 797
 798         /**
 799          * Set the Title object to use
 800          *
 801          * @param $t Title object
 802          */
 803         public function setTitle( Title $t ) {
 804                 $this->getContext()->setTitle( $t );
 805         }
 806
 807
 808         /**
 809          * Replace the subtile with $str
 810          *
 811          * @param $str String: new value of the subtitle
 812          */
 813         public function setSubtitle( $str ) {
 814                 $this->mSubtitle = /*$this->parse(*/ $str /*)*/; // @bug 2514
 815         }
 816
 817         /**
 818          * Add $str to the subtitle
 819          *
 820          * @param $str String to add to the subtitle
 821          */
 822         public function appendSubtitle( $str ) {
 823                 $this->mSubtitle .= /*$this->parse(*/ $str /*)*/; // @bug 2514
 824         }
 825
 826         /**
 827          * Get the subtitle
 828          *
 829          * @return String
 830          */
 831         public function getSubtitle() {
 832                 return $this->mSubtitle;
 833         }
 834
 835         /**
 836          * Set the page as printable, i.e. it'll be displayed with with all
 837          * print styles included
 838          */
 839         public function setPrintable() {
 840                 $this->mPrintable = true;
 841         }
 842
 843         /**
 844          * Return whether the page is "printable"
 845          *
 846          * @return Boolean
 847          */
 848         public function isPrintable() {
 849                 return $this->mPrintable;
 850         }
 851
 852         /**
 853          * Disable output completely, i.e. calling output() will have no effect
 854          */
 855         public function disable() {
 856                 $this->mDoNothing = true;
 857         }
 858
 859         /**
 860          * Return whether the output will be completely disabled
 861          *
 862          * @return Boolean
 863          */
 864         public function isDisabled() {
 865                 return $this->mDoNothing;
 866         }
 867
 868         /**
 869          * Show an "add new section" link?
 870          *
 871          * @return Boolean
 872          */
 873         public function showNewSectionLink() {
 874                 return $this->mNewSectionLink;
 875         }
 876
 877         /**
 878          * Forcibly hide the new section link?
 879          *
 880          * @return Boolean
 881          */
 882         public function forceHideNewSectionLink() {
 883                 return $this->mHideNewSectionLink;
 884         }
 885
 886         /**
 887          * Add or remove feed links in the page header
 888          * This is mainly kept for backward compatibility, see OutputPage::addFeedLink()
 889          * for the new version
 890          * @see addFeedLink()
 891          *
 892          * @param $show Boolean: true: add default feeds, false: remove all feeds
 893          */
 894         public function setSyndicated( $show = true ) {
 895                 if ( $show ) {
 896                         $this->setFeedAppendQuery( false );
 897                 } else {
 898                         $this->mFeedLinks = array();
 899                 }
 900         }
 901
 902         /**
 903          * Add default feeds to the page header
 904          * This is mainly kept for backward compatibility, see OutputPage::addFeedLink()
 905          * for the new version
 906          * @see addFeedLink()
 907          *
 908          * @param $val String: query to append to feed links or false to output
 909          *        default links
 910          */
 911         public function setFeedAppendQuery( $val ) {
 912                 global $wgAdvertisedFeedTypes;
 913
 914                 $this->mFeedLinks = array();
 915
 916                 foreach ( $wgAdvertisedFeedTypes as $type ) {
 917                         $query = "feed=$type";
 918                         if ( is_string( $val ) ) {
 919                                 $query .= '&' . $val;
 920                         }
 921                         $this->mFeedLinks[$type] = $this->getTitle()->getLocalURL( $query );
 922                 }
 923         }
 924
 925         /**
 926          * Add a feed link to the page header
 927          *
 928          * @param $format String: feed type, should be a key of $wgFeedClasses
 929          * @param $href String: URL
 930          */
 931         public function addFeedLink( $format, $href ) {
 932                 global $wgAdvertisedFeedTypes;
 933
 934                 if ( in_array( $format, $wgAdvertisedFeedTypes ) ) {
 935                         $this->mFeedLinks[$format] = $href;
 936                 }
 937         }
 938
 939         /**
 940          * Should we output feed links for this page?
 941          * @return Boolean
 942          */
 943         public function isSyndicated() {
 944                 return count( $this->mFeedLinks ) > 0;
 945         }
 946
 947         /**
 948          * Return URLs for each supported syndication format for this page.
 949          * @return array associating format keys with URLs
 950          */
 951         public function getSyndicationLinks() {
 952                 return $this->mFeedLinks;
 953         }
 954
 955         /**
 956          * Will currently always return null
 957          *
 958          * @return null
 959          */
 960         public function getFeedAppendQuery() {
 961                 return $this->mFeedLinksAppendQuery;
 962         }
 963
 964         /**
 965          * Set whether the displayed content is related to the source of the
 966          * corresponding article on the wiki
 967          * Setting true will cause the change "article related" toggle to true
 968          *
 969          * @param $v Boolean
 970          */
 971         public function setArticleFlag( $v ) {
 972                 $this->mIsarticle = $v;
 973                 if ( $v ) {
 974                         $this->mIsArticleRelated = $v;
 975                 }
 976         }
 977
 978         /**
 979          * Return whether the content displayed page is related to the source of
 980          * the corresponding article on the wiki
 981          *
 982          * @return Boolean
 983          */
 984         public function isArticle() {
 985                 return $this->mIsarticle;
 986         }
 987
 988         /**
 989          * Set whether this page is related an article on the wiki
 990          * Setting false will cause the change of "article flag" toggle to false
 991          *
 992          * @param $v Boolean
 993          */
 994         public function setArticleRelated( $v ) {
 995                 $this->mIsArticleRelated = $v;
 996                 if ( !$v ) {
 997                         $this->mIsarticle = false;
 998                 }
 999         }
1000
1001         /**
1002          * Return whether this page is related an article on the wiki
1003          *
1004          * @return Boolean
1005          */
1006         public function isArticleRelated() {
1007                 return $this->mIsArticleRelated;
1008         }
1009
1010         /**
1011          * Add new language links
1012          *
1013          * @param $newLinkArray Associative array mapping language code to the page
1014          *                      name
1015          */
1016         public function addLanguageLinks( $newLinkArray ) {
1017                 $this->mLanguageLinks += $newLinkArray;
1018         }
1019
1020         /**
1021          * Reset the language links and add new language links
1022          *
1023          * @param $newLinkArray Associative array mapping language code to the page
1024          *                      name
1025          */
1026         public function setLanguageLinks( $newLinkArray ) {
1027                 $this->mLanguageLinks = $newLinkArray;
1028         }
1029
1030         /**
1031          * Get the list of language links
1032          *
1033          * @return Array of Interwiki Prefixed (non DB key) Titles (e.g. 'fr:Test page')
1034          */
1035         public function getLanguageLinks() {
1036                 return $this->mLanguageLinks;
1037         }
1038
1039         /**
1040          * Add an array of categories, with names in the keys
1041          *
1042          * @param $categories Array mapping category name => sort key
1043          */
1044         public function addCategoryLinks( $categories ) {
1045                 global $wgContLang;
1046
1047                 if ( !is_array( $categories ) || count( $categories ) == 0 ) {
1048                         return;
1049                 }
1050
1051                 # Add the links to a LinkBatch
1052                 $arr = array( NS_CATEGORY => $categories );
1053                 $lb = new LinkBatch;
1054                 $lb->setArray( $arr );
1055
1056                 # Fetch existence plus the hiddencat property
1057                 $dbr = wfGetDB( DB_SLAVE );
1058                 $res = $dbr->select( array( 'page', 'page_props' ),
1059                         array( 'page_id', 'page_namespace', 'page_title', 'page_len', 'page_is_redirect', 'page_latest', 'pp_value' ),
1060                         $lb->constructSet( 'page', $dbr ),
1061                         __METHOD__,
1062                         array(),
1063                         array( 'page_props' => array( 'LEFT JOIN', array( 'pp_propname' => 'hiddencat', 'pp_page = page_id' ) ) )
1064                 );
1065
1066                 # Add the results to the link cache
1067                 $lb->addResultToCache( LinkCache::singleton(), $res );
1068
1069                 # Set all the values to 'normal'. This can be done with array_fill_keys in PHP 5.2.0+
1070                 $categories = array_combine(
1071                         array_keys( $categories ),
1072                         array_fill( 0, count( $categories ), 'normal' )
1073                 );
1074
1075                 # Mark hidden categories
1076                 foreach ( $res as $row ) {
1077                         if ( isset( $row->pp_value ) ) {
1078                                 $categories[$row->page_title] = 'hidden';
1079                         }
1080                 }
1081
1082                 # Add the remaining categories to the skin
1083                 if ( wfRunHooks( 'OutputPageMakeCategoryLinks', array( &$this, $categories, &$this->mCategoryLinks ) ) ) {
1084                         foreach ( $categories as $category => $type ) {
1085                                 $origcategory = $category;
1086                                 $title = Title::makeTitleSafe( NS_CATEGORY, $category );
1087                                 $wgContLang->findVariantLink( $category, $title, true );
1088                                 if ( $category != $origcategory ) {
1089                                         if ( array_key_exists( $category, $categories ) ) {
1090                                                 continue;
1091                                         }
1092                                 }
1093                                 $text = $wgContLang->convertHtml( $title->getText() );
1094                                 $this->mCategories[] = $title->getText();
1095                                 $this->mCategoryLinks[$type][] = Linker::link( $title, $text );
1096                         }
1097                 }
1098         }
1099
1100         /**
1101          * Reset the category links (but not the category list) and add $categories
1102          *
1103          * @param $categories Array mapping category name => sort key
1104          */
1105         public function setCategoryLinks( $categories ) {
1106                 $this->mCategoryLinks = array();
1107                 $this->addCategoryLinks( $categories );
1108         }
1109
1110         /**
1111          * Get the list of category links, in a 2-D array with the following format:
1112          * $arr[$type][] = $link, where $type is either "normal" or "hidden" (for
1113          * hidden categories) and $link a HTML fragment with a link to the category
1114          * page
1115          *
1116          * @return Array
1117          */
1118         public function getCategoryLinks() {
1119                 return $this->mCategoryLinks;
1120         }
1121
1122         /**
1123          * Get the list of category names this page belongs to
1124          *
1125          * @return Array of strings
1126          */
1127         public function getCategories() {
1128                 return $this->mCategories;
1129         }
1130
1131         /**
1132          * Do not allow scripts which can be modified by wiki users to load on this page;
1133          * only allow scripts bundled with, or generated by, the software.
1134          */
1135         public function disallowUserJs() {
1136                 $this->reduceAllowedModules(
1137                         ResourceLoaderModule::TYPE_SCRIPTS,
1138                         ResourceLoaderModule::ORIGIN_CORE_INDIVIDUAL
1139                 );
1140         }
1141
1142         /**
1143          * Return whether user JavaScript is allowed for this page
1144          * @deprecated since 1.18 Load modules with ResourceLoader, and origin and
1145          *     trustworthiness is identified and enforced automagically.
1146          * @return Boolean
1147          */
1148         public function isUserJsAllowed() {
1149                 return $this->getAllowedModules( ResourceLoaderModule::TYPE_SCRIPTS ) >= ResourceLoaderModule::ORIGIN_USER_INDIVIDUAL;
1150         }
1151
1152         /**
1153          * Show what level of JavaScript / CSS untrustworthiness is allowed on this page
1154          * @see ResourceLoaderModule::$origin
1155          * @param $type String ResourceLoaderModule TYPE_ constant
1156          * @return Int ResourceLoaderModule ORIGIN_ class constant
1157          */
1158         public function getAllowedModules( $type ){
1159                 if( $type == ResourceLoaderModule::TYPE_COMBINED ){
1160                         return min( array_values( $this->mAllowedModules ) );
1161                 } else {
1162                         return isset( $this->mAllowedModules[$type] )
1163                                 ? $this->mAllowedModules[$type]
1164                                 : ResourceLoaderModule::ORIGIN_ALL;
1165                 }
1166         }
1167
1168         /**
1169          * Set the highest level of CSS/JS untrustworthiness allowed
1170          * @param  $type String ResourceLoaderModule TYPE_ constant
1171          * @param  $level Int ResourceLoaderModule class constant
1172          */
1173         public function setAllowedModules( $type, $level ){
1174                 $this->mAllowedModules[$type] = $level;
1175         }
1176
1177         /**
1178          * As for setAllowedModules(), but don't inadvertantly make the page more accessible
1179          * @param  $type String
1180          * @param  $level Int ResourceLoaderModule class constant
1181          */
1182         public function reduceAllowedModules( $type, $level ){
1183                 $this->mAllowedModules[$type] = min( $this->getAllowedModules($type), $level );
1184         }
1185
1186         /**
1187          * Prepend $text to the body HTML
1188          *
1189          * @param $text String: HTML
1190          */
1191         public function prependHTML( $text ) {
1192                 $this->mBodytext = $text . $this->mBodytext;
1193         }
1194
1195         /**
1196          * Append $text to the body HTML
1197          *
1198          * @param $text String: HTML
1199          */
1200         public function addHTML( $text ) {
1201                 $this->mBodytext .= $text;
1202         }
1203
1204         /**
1205          * Clear the body HTML
1206          */
1207         public function clearHTML() {
1208                 $this->mBodytext = '';
1209         }
1210
1211         /**
1212          * Get the body HTML
1213          *
1214          * @return String: HTML
1215          */
1216         public function getHTML() {
1217                 return $this->mBodytext;
1218         }
1219
1220         /**
1221          * Add $text to the debug output
1222          *
1223          * @param $text String: debug text
1224          */
1225         public function debug( $text ) {
1226                 $this->mDebugtext .= $text;
1227         }
1228
1229         /**
1230          * Get/set the ParserOptions object to use for wikitext parsing
1231          *
1232          * @param $options either the ParserOption to use or null to only get the
1233          *                 current ParserOption object
1234          * @return ParserOptions object
1235          */
1236         public function parserOptions( $options = null ) {
1237                 if ( !$this->mParserOptions ) {
1238                         $this->mParserOptions = new ParserOptions;
1239                         $this->mParserOptions->setEditSection( false );
1240                 }
1241                 return wfSetVar( $this->mParserOptions, $options );
1242         }
1243
1244         /**
1245          * Set the revision ID which will be seen by the wiki text parser
1246          * for things such as embedded {{REVISIONID}} variable use.
1247          *
1248          * @param $revid Mixed: an positive integer, or null
1249          * @return Mixed: previous value
1250          */
1251         public function setRevisionId( $revid ) {
1252                 $val = is_null( $revid ) ? null : intval( $revid );
1253                 return wfSetVar( $this->mRevisionId, $val );
1254         }
1255
1256         /**
1257          * Get the displayed revision ID
1258          *
1259          * @return Integer
1260          */
1261         public function getRevisionId() {
1262                 return $this->mRevisionId;
1263         }
1264
1265         /**
1266          * Set the displayed file version
1267          *
1268          * @param $file File|false
1269          * @return Mixed: previous value
1270          */
1271         public function setFileVersion( $file ) {
1272                 $val = null;
1273                 if ( $file instanceof File && $file->exists() ) {
1274                         $val = array( 'time' => $file->getTimestamp(), 'sha1' => $file->getSha1() );
1275                 }
1276                 return wfSetVar( $this->mFileVersion, $val, true );
1277         }
1278
1279         /**
1280          * Get the displayed file version
1281          *
1282          * @return Array|null ('time' => MW timestamp, 'sha1' => sha1)
1283          */
1284         public function getFileVersion() {
1285                 return $this->mFileVersion;
1286         }
1287
1288         /**
1289          * Get the templates used on this page
1290          *
1291          * @return Array (namespace => dbKey => revId)
1292          * @since 1.18
1293          */
1294         public function getTemplateIds() {
1295                 return $this->mTemplateIds;
1296         }
1297
1298         /**
1299          * Get the files used on this page
1300          *
1301          * @return Array (dbKey => array('time' => MW timestamp or null, 'sha1' => sha1 or ''))
1302          * @since 1.18
1303          */
1304         public function getImageTimeKeys() {
1305                 return $this->mImageTimeKeys;
1306         }
1307
1308         /**
1309          * Convert wikitext to HTML and add it to the buffer
1310          * Default assumes that the current page title will be used.
1311          *
1312          * @param $text String
1313          * @param $linestart Boolean: is this the start of a line?
1314          */
1315         public function addWikiText( $text, $linestart = true ) {
1316                 $title = $this->getTitle(); // Work arround E_STRICT
1317                 $this->addWikiTextTitle( $text, $title, $linestart );
1318         }
1319
1320         /**
1321          * Add wikitext with a custom Title object
1322          *
1323          * @param $text String: wikitext
1324          * @param $title Title object
1325          * @param $linestart Boolean: is this the start of a line?
1326          */
1327         public function addWikiTextWithTitle( $text, &$title, $linestart = true ) {
1328                 $this->addWikiTextTitle( $text, $title, $linestart );
1329         }
1330
1331         /**
1332          * Add wikitext with a custom Title object and
1333          *
1334          * @param $text String: wikitext
1335          * @param $title Title object
1336          * @param $linestart Boolean: is this the start of a line?
1337          */
1338         function addWikiTextTitleTidy( $text, &$title, $linestart = true ) {
1339                 $this->addWikiTextTitle( $text, $title, $linestart, true );
1340         }
1341
1342         /**
1343          * Add wikitext with tidy enabled
1344          *
1345          * @param $text String: wikitext
1346          * @param $linestart Boolean: is this the start of a line?
1347          */
1348         public function addWikiTextTidy( $text, $linestart = true ) {
1349                 $title = $this->getTitle();
1350                 $this->addWikiTextTitleTidy( $text, $title, $linestart );
1351         }
1352
1353         /**
1354          * Add wikitext with a custom Title object
1355          *
1356          * @param $text String: wikitext
1357          * @param $title Title object
1358          * @param $linestart Boolean: is this the start of a line?
1359          * @param $tidy Boolean: whether to use tidy
1360          */
1361         public function addWikiTextTitle( $text, &$title, $linestart, $tidy = false ) {
1362                 global $wgParser;
1363
1364                 wfProfileIn( __METHOD__ );
1365
1366                 wfIncrStats( 'pcache_not_possible' );
1367
1368                 $popts = $this->parserOptions();
1369                 $oldTidy = $popts->setTidy( $tidy );
1370
1371                 $parserOutput = $wgParser->parse(
1372                         $text, $title, $popts,
1373                         $linestart, true, $this->mRevisionId
1374                 );
1375
1376                 $popts->setTidy( $oldTidy );
1377
1378                 $this->addParserOutput( $parserOutput );
1379
1380                 wfProfileOut( __METHOD__ );
1381         }
1382
1383         /**
1384          * Add a ParserOutput object, but without Html
1385          *
1386          * @param $parserOutput ParserOutput object
1387          */
1388         public function addParserOutputNoText( &$parserOutput ) {
1389                 $this->mLanguageLinks += $parserOutput->getLanguageLinks();
1390                 $this->addCategoryLinks( $parserOutput->getCategories() );
1391                 $this->mNewSectionLink = $parserOutput->getNewSection();
1392                 $this->mHideNewSectionLink = $parserOutput->getHideNewSection();
1393
1394                 $this->mParseWarnings = $parserOutput->getWarnings();
1395                 if ( !$parserOutput->isCacheable() ) {
1396                         $this->enableClientCache( false );
1397                 }
1398                 $this->mNoGallery = $parserOutput->getNoGallery();
1399                 $this->mHeadItems = array_merge( $this->mHeadItems, $parserOutput->getHeadItems() );
1400                 $this->addModules( $parserOutput->getModules() );
1401                 $this->addModuleScripts( $parserOutput->getModuleScripts() );
1402                 $this->addModuleStyles( $parserOutput->getModuleStyles() );
1403                 $this->addModuleMessages( $parserOutput->getModuleMessages() );
1404
1405                 // Template versioning...
1406                 foreach ( (array)$parserOutput->getTemplateIds() as $ns => $dbks ) {
1407                         if ( isset( $this->mTemplateIds[$ns] ) ) {
1408                                 $this->mTemplateIds[$ns] = $dbks + $this->mTemplateIds[$ns];
1409                         } else {
1410                                 $this->mTemplateIds[$ns] = $dbks;
1411                         }
1412                 }
1413                 // File versioning...
1414                 foreach ( (array)$parserOutput->getImageTimeKeys() as $dbk => $data ) {
1415                         $this->mImageTimeKeys[$dbk] = $data;
1416                 }
1417
1418                 // Hooks registered in the object
1419                 global $wgParserOutputHooks;
1420                 foreach ( $parserOutput->getOutputHooks() as $hookInfo ) {
1421                         list( $hookName, $data ) = $hookInfo;
1422                         if ( isset( $wgParserOutputHooks[$hookName] ) ) {
1423                                 call_user_func( $wgParserOutputHooks[$hookName], $this, $parserOutput, $data );
1424                         }
1425                 }
1426
1427                 wfRunHooks( 'OutputPageParserOutput', array( &$this, $parserOutput ) );
1428         }
1429
1430         /**
1431          * Add a ParserOutput object
1432          *
1433          * @param $parserOutput ParserOutput
1434          */
1435         function addParserOutput( &$parserOutput ) {
1436                 $this->addParserOutputNoText( $parserOutput );
1437                 $text = $parserOutput->getText();
1438                 wfRunHooks( 'OutputPageBeforeHTML', array( &$this, &$text ) );
1439                 $this->addHTML( $text );
1440         }
1441
1442
1443         /**
1444          * Add the output of a QuickTemplate to the output buffer
1445          *
1446          * @param $template QuickTemplate
1447          */
1448         public function addTemplate( &$template ) {
1449                 ob_start();
1450                 $template->execute();
1451                 $this->addHTML( ob_get_contents() );
1452                 ob_end_clean();
1453         }
1454
1455         /**
1456          * Parse wikitext and return the HTML.
1457          *
1458          * @param $text String
1459          * @param $linestart Boolean: is this the start of a line?
1460          * @param $interface Boolean: use interface language ($wgLang instead of
1461          *                   $wgContLang) while parsing language sensitive magic
1462          *                   words like GRAMMAR and PLURAL
1463          * @param $language  Language object: target language object, will override
1464          *                   $interface
1465          * @return String: HTML
1466          */
1467         public function parse( $text, $linestart = true, $interface = false, $language = null ) {
1468                 global $wgParser;
1469
1470                 if( is_null( $this->getTitle() ) ) {
1471                         throw new MWException( 'Empty $mTitle in ' . __METHOD__ );
1472                 }
1473
1474                 $popts = $this->parserOptions();
1475                 if ( $interface ) {
1476                         $popts->setInterfaceMessage( true );
1477                 }
1478                 if ( $language !== null ) {
1479                         $oldLang = $popts->setTargetLanguage( $language );
1480                 }
1481
1482                 $parserOutput = $wgParser->parse(
1483                         $text, $this->getTitle(), $popts,
1484                         $linestart, true, $this->mRevisionId
1485                 );
1486
1487                 if ( $interface ) {
1488                         $popts->setInterfaceMessage( false );
1489                 }
1490                 if ( $language !== null ) {
1491                         $popts->setTargetLanguage( $oldLang );
1492                 }
1493
1494                 return $parserOutput->getText();
1495         }
1496
1497         /**
1498          * Parse wikitext, strip paragraphs, and return the HTML.
1499          *
1500          * @param $text String
1501          * @param $linestart Boolean: is this the start of a line?
1502          * @param $interface Boolean: use interface language ($wgLang instead of
1503          *                   $wgContLang) while parsing language sensitive magic
1504          *                   words like GRAMMAR and PLURAL
1505          * @return String: HTML
1506          */
1507         public function parseInline( $text, $linestart = true, $interface = false ) {
1508                 $parsed = $this->parse( $text, $linestart, $interface );
1509
1510                 $m = array();
1511                 if ( preg_match( '/^<p>(.*)\n?<\/p>\n?/sU', $parsed, $m ) ) {
1512                         $parsed = $m[1];
1513                 }
1514
1515                 return $parsed;
1516         }
1517
1518         /**
1519          * Set the value of the "s-maxage" part of the "Cache-control" HTTP header
1520          *
1521          * @param $maxage Integer: maximum cache time on the Squid, in seconds.
1522          */
1523         public function setSquidMaxage( $maxage ) {
1524                 $this->mSquidMaxage = $maxage;
1525         }
1526
1527         /**
1528          * Use enableClientCache(false) to force it to send nocache headers
1529          *
1530          * @param $state bool
1531          *
1532          * @return bool
1533          */
1534         public function enableClientCache( $state ) {
1535                 return wfSetVar( $this->mEnableClientCache, $state );
1536         }
1537
1538         /**
1539          * Get the list of cookies that will influence on the cache
1540          *
1541          * @return Array
1542          */
1543         function getCacheVaryCookies() {
1544                 global $wgCookiePrefix, $wgCacheVaryCookies;
1545                 static $cookies;
1546                 if ( $cookies === null ) {
1547                         $cookies = array_merge(
1548                                 array(
1549                                         "{$wgCookiePrefix}Token",
1550                                         "{$wgCookiePrefix}LoggedOut",
1551                                         session_name()
1552                                 ),
1553                                 $wgCacheVaryCookies
1554                         );
1555                         wfRunHooks( 'GetCacheVaryCookies', array( $this, &$cookies ) );
1556                 }
1557                 return $cookies;
1558         }
1559
1560         /**
1561          * Return whether this page is not cacheable because "useskin" or "uselang"
1562          * URL parameters were passed.
1563          *
1564          * @return Boolean
1565          */
1566         function uncacheableBecauseRequestVars() {
1567                 $request = $this->getRequest();
1568                 return $request->getText( 'useskin', false ) === false
1569                         && $request->getText( 'uselang', false ) === false;
1570         }
1571
1572         /**
1573          * Check if the request has a cache-varying cookie header
1574          * If it does, it's very important that we don't allow public caching
1575          *
1576          * @return Boolean
1577          */
1578         function haveCacheVaryCookies() {
1579                 $cookieHeader = $this->getRequest()->getHeader( 'cookie' );
1580                 if ( $cookieHeader === false ) {
1581                         return false;
1582                 }
1583                 $cvCookies = $this->getCacheVaryCookies();
1584                 foreach ( $cvCookies as $cookieName ) {
1585                         # Check for a simple string match, like the way squid does it
1586                         if ( strpos( $cookieHeader, $cookieName ) !== false ) {
1587                                 wfDebug( __METHOD__ . ": found $cookieName\n" );
1588                                 return true;
1589                         }
1590                 }
1591                 wfDebug( __METHOD__ . ": no cache-varying cookies found\n" );
1592                 return false;
1593         }
1594
1595         /**
1596          * Add an HTTP header that will influence on the cache
1597          *
1598          * @param $header String: header name
1599          * @param $option Array|null
1600          * @todo FIXME: Document the $option parameter; it appears to be for
1601          *        X-Vary-Options but what format is acceptable?
1602          */
1603         public function addVaryHeader( $header, $option = null ) {
1604                 if ( !array_key_exists( $header, $this->mVaryHeader ) ) {
1605                         $this->mVaryHeader[$header] = (array)$option;
1606                 } elseif( is_array( $option ) ) {
1607                         if( is_array( $this->mVaryHeader[$header] ) ) {
1608                                 $this->mVaryHeader[$header] = array_merge( $this->mVaryHeader[$header], $option );
1609                         } else {
1610                                 $this->mVaryHeader[$header] = $option;
1611                         }
1612                 }
1613                 $this->mVaryHeader[$header] = array_unique( $this->mVaryHeader[$header] );
1614         }
1615
1616         /**
1617          * Get a complete X-Vary-Options header
1618          *
1619          * @return String
1620          */
1621         public function getXVO() {
1622                 $cvCookies = $this->getCacheVaryCookies();
1623
1624                 $cookiesOption = array();
1625                 foreach ( $cvCookies as $cookieName ) {
1626                         $cookiesOption[] = 'string-contains=' . $cookieName;
1627                 }
1628                 $this->addVaryHeader( 'Cookie', $cookiesOption );
1629
1630                 $headers = array();
1631                 foreach( $this->mVaryHeader as $header => $option ) {
1632                         $newheader = $header;
1633                         if( is_array( $option ) ) {
1634                                 $newheader .= ';' . implode( ';', $option );
1635                         }
1636                         $headers[] = $newheader;
1637                 }
1638                 $xvo = 'X-Vary-Options: ' . implode( ',', $headers );
1639
1640                 return $xvo;
1641         }
1642
1643         /**
1644          * bug 21672: Add Accept-Language to Vary and XVO headers
1645          * if there's no 'variant' parameter existed in GET.
1646          *
1647          * For example:
1648          *   /w/index.php?title=Main_page should always be served; but
1649          *   /w/index.php?title=Main_page&variant=zh-cn should never be served.
1650          */
1651         function addAcceptLanguage() {
1652                 global $wgContLang;
1653                 if( !$this->getRequest()->getCheck( 'variant' ) && $wgContLang->hasVariants() ) {
1654                         $variants = $wgContLang->getVariants();
1655                         $aloption = array();
1656                         foreach ( $variants as $variant ) {
1657                                 if( $variant === $wgContLang->getCode() ) {
1658                                         continue;
1659                                 } else {
1660                                         $aloption[] = 'string-contains=' . $variant;
1661
1662                                         // IE and some other browsers use another form of language code
1663                                         // in their Accept-Language header, like "zh-CN" or "zh-TW".
1664                                         // We should handle these too.
1665                                         $ievariant = explode( '-', $variant );
1666                                         if ( count( $ievariant ) == 2 ) {
1667                                                 $ievariant[1] = strtoupper( $ievariant[1] );
1668                                                 $ievariant = implode( '-', $ievariant );
1669                                                 $aloption[] = 'string-contains=' . $ievariant;
1670                                         }
1671                                 }
1672                         }
1673                         $this->addVaryHeader( 'Accept-Language', $aloption );
1674                 }
1675         }
1676
1677         /**
1678          * Set a flag which will cause an X-Frame-Options header appropriate for
1679          * edit pages to be sent. The header value is controlled by
1680          * $wgEditPageFrameOptions.
1681          *
1682          * This is the default for special pages. If you display a CSRF-protected
1683          * form on an ordinary view page, then you need to call this function.
1684          *
1685          * @param $enable bool
1686          */
1687         public function preventClickjacking( $enable = true ) {
1688                 $this->mPreventClickjacking = $enable;
1689         }
1690
1691         /**
1692          * Turn off frame-breaking. Alias for $this->preventClickjacking(false).
1693          * This can be called from pages which do not contain any CSRF-protected
1694          * HTML form.
1695          */
1696         public function allowClickjacking() {
1697                 $this->mPreventClickjacking = false;
1698         }
1699
1700         /**
1701          * Get the X-Frame-Options header value (without the name part), or false
1702          * if there isn't one. This is used by Skin to determine whether to enable
1703          * JavaScript frame-breaking, for clients that don't support X-Frame-Options.
1704          *
1705          * @return string
1706          */
1707         public function getFrameOptions() {
1708                 global $wgBreakFrames, $wgEditPageFrameOptions;
1709                 if ( $wgBreakFrames ) {
1710                         return 'DENY';
1711                 } elseif ( $this->mPreventClickjacking && $wgEditPageFrameOptions ) {
1712                         return $wgEditPageFrameOptions;
1713                 }
1714         }
1715
1716         /**
1717          * Send cache control HTTP headers
1718          */
1719         public function sendCacheControl() {
1720                 global $wgUseSquid, $wgUseESI, $wgUseETag, $wgSquidMaxage, $wgUseXVO;
1721
1722                 $response = $this->getRequest()->response();
1723                 if ( $wgUseETag && $this->mETag ) {
1724                         $response->header( "ETag: $this->mETag" );
1725                 }
1726
1727                 $this->addAcceptLanguage();
1728
1729                 # don't serve compressed data to clients who can't handle it
1730                 # maintain different caches for logged-in users and non-logged in ones
1731                 $response->header( 'Vary: ' . join( ', ', array_keys( $this->mVaryHeader ) ) );
1732
1733                 if ( $wgUseXVO ) {
1734                         # Add an X-Vary-Options header for Squid with Wikimedia patches
1735                         $response->header( $this->getXVO() );
1736                 }
1737
1738                 if( !$this->uncacheableBecauseRequestVars() && $this->mEnableClientCache ) {
1739                         if(
1740                                 $wgUseSquid && session_id() == '' && !$this->isPrintable() &&
1741                                 $this->mSquidMaxage != 0 && !$this->haveCacheVaryCookies()
1742                         )
1743                         {
1744                                 if ( $wgUseESI ) {
1745                                         # We'll purge the proxy cache explicitly, but require end user agents
1746                                         # to revalidate against the proxy on each visit.
1747                                         # Surrogate-Control controls our Squid, Cache-Control downstream caches
1748                                         wfDebug( __METHOD__ . ": proxy caching with ESI; {$this->mLastModified} **\n", false );
1749                                         # start with a shorter timeout for initial testing
1750                                         # header( 'Surrogate-Control: max-age=2678400+2678400, content="ESI/1.0"');
1751                                         $response->header( 'Surrogate-Control: max-age='.$wgSquidMaxage.'+'.$this->mSquidMaxage.', content="ESI/1.0"');
1752                                         $response->header( 'Cache-Control: s-maxage=0, must-revalidate, max-age=0' );
1753                                 } else {
1754                                         # We'll purge the proxy cache for anons explicitly, but require end user agents
1755                                         # to revalidate against the proxy on each visit.
1756                                         # IMPORTANT! The Squid needs to replace the Cache-Control header with
1757                                         # Cache-Control: s-maxage=0, must-revalidate, max-age=0
1758                                         wfDebug( __METHOD__ . ": local proxy caching; {$this->mLastModified} **\n", false );
1759                                         # start with a shorter timeout for initial testing
1760                                         # header( "Cache-Control: s-maxage=2678400, must-revalidate, max-age=0" );
1761                                         $response->header( 'Cache-Control: s-maxage='.$this->mSquidMaxage.', must-revalidate, max-age=0' );
1762                                 }
1763                         } else {
1764                                 # We do want clients to cache if they can, but they *must* check for updates
1765                                 # on revisiting the page.
1766                                 wfDebug( __METHOD__ . ": private caching; {$this->mLastModified} **\n", false );
1767                                 $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
1768                                 $response->header( "Cache-Control: private, must-revalidate, max-age=0" );
1769                         }
1770                         if($this->mLastModified) {
1771                                 $response->header( "Last-Modified: {$this->mLastModified}" );
1772                         }
1773                 } else {
1774                         wfDebug( __METHOD__ . ": no caching **\n", false );
1775
1776                         # In general, the absence of a last modified header should be enough to prevent
1777                         # the client from using its cache. We send a few other things just to make sure.
1778                         $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
1779                         $response->header( 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate' );
1780                         $response->header( 'Pragma: no-cache' );
1781                 }
1782         }
1783
1784         /**
1785          * Get the message associed with the HTTP response code $code
1786          *
1787          * @param $code Integer: status code
1788          * @return String or null: message or null if $code is not in the list of
1789          *         messages
1790          *
1791          * @deprecated since 1.18 Use HttpStatus::getMessage() instead.
1792          */
1793         public static function getStatusMessage( $code ) {
1794                 wfDeprecated( __METHOD__ );
1795                 return HttpStatus::getMessage( $code );
1796         }
1797
1798         /**
1799          * Finally, all the text has been munged and accumulated into
1800          * the object, let's actually output it:
1801          */
1802         public function output() {
1803                 global $wgLanguageCode, $wgDebugRedirects, $wgMimeType;
1804
1805                 if( $this->mDoNothing ) {
1806                         return;
1807                 }
1808
1809                 wfProfileIn( __METHOD__ );
1810
1811                 $response = $this->getRequest()->response();
1812
1813                 if ( $this->mRedirect != '' ) {
1814                         # Standards require redirect URLs to be absolute
1815                         $this->mRedirect = wfExpandUrl( $this->mRedirect );
1816                         if( $this->mRedirectCode == '301' || $this->mRedirectCode == '303' ) {
1817                                 if( !$wgDebugRedirects ) {
1818                                         $message = HttpStatus::getMessage( $this->mRedirectCode );
1819                                         $response->header( "HTTP/1.1 {$this->mRedirectCode} $message" );
1820                                 }
1821                                 $this->mLastModified = wfTimestamp( TS_RFC2822 );
1822                         }
1823                         $this->sendCacheControl();
1824
1825                         $response->header( "Content-Type: text/html; charset=utf-8" );
1826                         if( $wgDebugRedirects ) {
1827                                 $url = htmlspecialchars( $this->mRedirect );
1828                                 print "<html>\n<head>\n<title>Redirect</title>\n</head>\n<body>\n";
1829                                 print "<p>Location: <a href=\"$url\">$url</a></p>\n";
1830                                 print "</body>\n</html>\n";
1831                         } else {
1832                                 $response->header( 'Location: ' . $this->mRedirect );
1833                         }
1834                         wfProfileOut( __METHOD__ );
1835                         return;
1836                 } elseif ( $this->mStatusCode ) {
1837                         $message = HttpStatus::getMessage( $this->mStatusCode );
1838                         if ( $message ) {
1839                                 $response->header( 'HTTP/1.1 ' . $this->mStatusCode . ' ' . $message );
1840                         }
1841                 }
1842
1843                 # Buffer output; final headers may depend on later processing
1844                 ob_start();
1845
1846                 $response->header( "Content-type: $wgMimeType; charset=UTF-8" );
1847                 $response->header( 'Content-language: ' . $wgLanguageCode );
1848
1849                 // Prevent framing, if requested
1850                 $frameOptions = $this->getFrameOptions();
1851                 if ( $frameOptions ) {
1852                         $response->header( "X-Frame-Options: $frameOptions" );
1853                 }
1854
1855                 if ( $this->mArticleBodyOnly ) {
1856                         $this->out( $this->mBodytext );
1857                 } else {
1858                         $this->addDefaultModules();
1859
1860                         $sk = $this->getSkin();
1861
1862                         // Hook that allows last minute changes to the output page, e.g.
1863                         // adding of CSS or Javascript by extensions.
1864                         wfRunHooks( 'BeforePageDisplay', array( &$this, &$sk ) );
1865
1866                         wfProfileIn( 'Output-skin' );
1867                         $sk->outputPage( $this );
1868                         wfProfileOut( 'Output-skin' );
1869                 }
1870
1871                 $this->sendCacheControl();
1872                 ob_end_flush();
1873                 wfProfileOut( __METHOD__ );
1874         }
1875
1876         /**
1877          * Actually output something with print().
1878          *
1879          * @param $ins String: the string to output
1880          */
1881         public function out( $ins ) {
1882                 print $ins;
1883         }
1884
1885         /**
1886          * Produce a "user is blocked" page.
1887          * @deprecated since 1.18
1888          */
1889         function blockedPage() {
1890                 throw new UserBlockedError( $this->getUser()->mBlock );
1891         }
1892
1893         /**
1894          * Output a standard error page
1895          *
1896          * @param $title String: message key for page title
1897          * @param $msg String: message key for page text
1898          * @param $params Array: message parameters
1899          */
1900         public function showErrorPage( $title, $msg, $params = array() ) {
1901                 if ( $this->getTitle() ) {
1902                         $this->mDebugtext .= 'Original title: ' . $this->getTitle()->getPrefixedText() . "\n";
1903                 }
1904                 $this->setPageTitle( wfMsg( $title ) );
1905                 $this->setHTMLTitle( wfMsg( 'errorpagetitle' ) );
1906                 $this->setRobotPolicy( 'noindex,nofollow' );
1907                 $this->setArticleRelated( false );
1908                 $this->enableClientCache( false );
1909                 $this->mRedirect = '';
1910                 $this->mBodytext = '';
1911
1912                 $this->addWikiMsgArray( $msg, $params );
1913
1914                 $this->returnToMain();
1915         }
1916
1917         /**
1918          * Output a standard permission error page
1919          *
1920          * @param $errors Array: error message keys
1921          * @param $action String: action that was denied or null if unknown
1922          */
1923         public function showPermissionsErrorPage( $errors, $action = null ) {
1924                 $this->mDebugtext .= 'Original title: ' .
1925                 $this->getTitle()->getPrefixedText() . "\n";
1926                 $this->setPageTitle( wfMsg( 'permissionserrors' ) );
1927                 $this->setHTMLTitle( wfMsg( 'permissionserrors' ) );
1928                 $this->setRobotPolicy( 'noindex,nofollow' );
1929                 $this->setArticleRelated( false );
1930                 $this->enableClientCache( false );
1931                 $this->mRedirect = '';
1932                 $this->mBodytext = '';
1933                 $this->addWikiText( $this->formatPermissionsErrorMessage( $errors, $action ) );
1934         }
1935
1936         /**
1937          * Display an error page indicating that a given version of MediaWiki is
1938          * required to use it
1939          *
1940          * @param $version Mixed: the version of MediaWiki needed to use the page
1941          */
1942         public function versionRequired( $version ) {
1943                 $this->setPageTitle( wfMsg( 'versionrequired', $version ) );
1944                 $this->setHTMLTitle( wfMsg( 'versionrequired', $version ) );
1945                 $this->setRobotPolicy( 'noindex,nofollow' );
1946                 $this->setArticleRelated( false );
1947                 $this->mBodytext = '';
1948
1949                 $this->addWikiMsg( 'versionrequiredtext', $version );
1950                 $this->returnToMain();
1951         }
1952
1953         /**
1954          * Display an error page noting that a given permission bit is required.
1955          * @deprecated since 1.18, just throw the exception directly
1956          * @param $permission String: key required
1957          */
1958         public function permissionRequired( $permission ) {
1959                 throw new PermissionsError( $permission );
1960         }
1961
1962         /**
1963          * Produce the stock "please login to use the wiki" page
1964          */
1965         public function loginToUse() {
1966                 if( $this->getUser()->isLoggedIn() ) {
1967                         throw new PermissionsError( 'read' );
1968                 }
1969
1970                 $this->setPageTitle( wfMsg( 'loginreqtitle' ) );
1971                 $this->setHtmlTitle( wfMsg( 'errorpagetitle' ) );
1972                 $this->setRobotPolicy( 'noindex,nofollow' );
1973                 $this->setArticleRelated( false );
1974
1975                 $loginTitle = SpecialPage::getTitleFor( 'Userlogin' );
1976                 $loginLink = Linker::linkKnown(
1977                         $loginTitle,
1978                         wfMsgHtml( 'loginreqlink' ),
1979                         array(),
1980                         array( 'returnto' => $this->getTitle()->getPrefixedText() )
1981                 );
1982                 $this->addHTML( wfMessage( 'loginreqpagetext' )->rawParams( $loginLink )->parse() .
1983                         "\n<!--" . $this->getTitle()->getPrefixedUrl() . '-->' );
1984
1985                 # Don't return to the main page if the user can't read it
1986                 # otherwise we'll end up in a pointless loop
1987                 $mainPage = Title::newMainPage();
1988                 if( $mainPage->userCanRead() ) {
1989                         $this->returnToMain( null, $mainPage );
1990                 }
1991         }
1992
1993         /**
1994          * Format a list of error messages
1995          *
1996          * @param $errors Array of arrays returned by Title::getUserPermissionsErrors
1997          * @param $action String: action that was denied or null if unknown
1998          * @return String: the wikitext error-messages, formatted into a list.
1999          */
2000         public function formatPermissionsErrorMessage( $errors, $action = null ) {
2001                 if ( $action == null ) {
2002                         $text = wfMsgNoTrans( 'permissionserrorstext', count( $errors ) ) . "\n\n";
2003                 } else {
2004                         $action_desc = wfMsgNoTrans( "action-$action" );
2005                         $text = wfMsgNoTrans(
2006                                 'permissionserrorstext-withaction',
2007                                 count( $errors ),
2008                                 $action_desc
2009                         ) . "\n\n";
2010                 }
2011
2012                 if ( count( $errors ) > 1 ) {
2013                         $text .= '<ul class="permissions-errors">' . "\n";
2014
2015                         foreach( $errors as $error ) {
2016                                 $text .= '<li>';
2017                                 $text .= call_user_func_array( 'wfMsgNoTrans', $error );
2018                                 $text .= "</li>\n";
2019                         }
2020                         $text .= '</ul>';
2021                 } else {
2022                         $text .= "<div class=\"permissions-errors\">\n" .
2023                                         call_user_func_array( 'wfMsgNoTrans', reset( $errors ) ) .
2024                                         "\n</div>";
2025                 }
2026
2027                 return $text;
2028         }
2029
2030         /**
2031          * Display a page stating that the Wiki is in read-only mode,
2032          * and optionally show the source of the page that the user
2033          * was trying to edit.  Should only be called (for this
2034          * purpose) after wfReadOnly() has returned true.
2035          *
2036          * For historical reasons, this function is _also_ used to
2037          * show the error message when a user tries to edit a page
2038          * they are not allowed to edit.  (Unless it's because they're
2039          * blocked, then we show blockedPage() instead.)  In this
2040          * case, the second parameter should be set to true and a list
2041          * of reasons supplied as the third parameter.
2042          *
2043          * @todo Needs to be split into multiple functions.
2044          *
2045          * @param $source    String: source code to show (or null).
2046          * @param $protected Boolean: is this a permissions error?
2047          * @param $reasons   Array: list of reasons for this error, as returned by Title::getUserPermissionsErrors().
2048          * @param $action    String: action that was denied or null if unknown
2049          */
2050         public function readOnlyPage( $source = null, $protected = false, $reasons = array(), $action = null ) {
2051                 $this->setRobotPolicy( 'noindex,nofollow' );
2052                 $this->setArticleRelated( false );
2053
2054                 // If no reason is given, just supply a default "I can't let you do
2055                 // that, Dave" message.  Should only occur if called by legacy code.
2056                 if ( $protected && empty( $reasons ) ) {
2057                         $reasons[] = array( 'badaccess-group0' );
2058                 }
2059
2060                 if ( !empty( $reasons ) ) {
2061                         // Permissions error
2062                         if( $source ) {
2063                                 $this->setPageTitle( wfMsg( 'viewsource' ) );
2064                                 $this->setSubtitle(
2065                                         wfMsg( 'viewsourcefor', Linker::linkKnown( $this->getTitle() ) )
2066                                 );
2067                         } else {
2068                                 $this->setPageTitle( wfMsg( 'badaccess' ) );
2069                         }
2070                         $this->addWikiText( $this->formatPermissionsErrorMessage( $reasons, $action ) );
2071                 } else {
2072                         // Wiki is read only
2073                         throw new ReadOnlyError;
2074                 }
2075
2076                 // Show source, if supplied
2077                 if( is_string( $source ) ) {
2078                         $this->addWikiMsg( 'viewsourcetext' );
2079
2080                         $params = array(
2081                                 'id'   => 'wpTextbox1',
2082                                 'name' => 'wpTextbox1',
2083                                 'cols' => $this->getUser()->getOption( 'cols' ),
2084                                 'rows' => $this->getUser()->getOption( 'rows' ),
2085                                 'readonly' => 'readonly'
2086                         );
2087                         $this->addHTML( Html::element( 'textarea', $params, $source ) );
2088
2089                         // Show templates used by this article
2090                         $article = new Article( $this->getTitle() );
2091                         $templates = Linker::formatTemplates( $article->getUsedTemplates() );
2092                         $this->addHTML( "<div class='templatesUsed'>
2093 $templates
2094 </div>
2095 " );
2096                 }
2097
2098                 # If the title doesn't exist, it's fairly pointless to print a return
2099                 # link to it.  After all, you just tried editing it and couldn't, so
2100                 # what's there to do there?
2101                 if( $this->getTitle()->exists() ) {
2102                         $this->returnToMain( null, $this->getTitle() );
2103                 }
2104         }
2105
2106         /**
2107          * Turn off regular page output and return an error reponse
2108          * for when rate limiting has triggered.
2109          */
2110         public function rateLimited() {
2111                 throw new ThrottledError;
2112         }
2113
2114         /**
2115          * Show a warning about slave lag
2116          *
2117          * If the lag is higher than $wgSlaveLagCritical seconds,
2118          * then the warning is a bit more obvious. If the lag is
2119          * lower than $wgSlaveLagWarning, then no warning is shown.
2120          *
2121          * @param $lag Integer: slave lag
2122          */
2123         public function showLagWarning( $lag ) {
2124                 global $wgSlaveLagWarning, $wgSlaveLagCritical;
2125                 if( $lag >= $wgSlaveLagWarning ) {
2126                         $message = $lag < $wgSlaveLagCritical
2127                                 ? 'lag-warn-normal'
2128                                 : 'lag-warn-high';
2129                         $wrap = Html::rawElement( 'div', array( 'class' => "mw-{$message}" ), "\n$1\n" );
2130                         $this->wrapWikiMsg( "$wrap\n", array( $message, $this->getContext()->getLang()->formatNum( $lag ) ) );
2131                 }
2132         }
2133
2134         public function showFatalError( $message ) {
2135                 $this->setPageTitle( wfMsg( 'internalerror' ) );
2136                 $this->setRobotPolicy( 'noindex,nofollow' );
2137                 $this->setArticleRelated( false );
2138                 $this->enableClientCache( false );
2139                 $this->mRedirect = '';
2140                 $this->mBodytext = $message;
2141         }
2142
2143         public function showUnexpectedValueError( $name, $val ) {
2144                 $this->showFatalError( wfMsg( 'unexpected', $name, $val ) );
2145         }
2146
2147         public function showFileCopyError( $old, $new ) {
2148                 $this->showFatalError( wfMsg( 'filecopyerror', $old, $new ) );
2149         }
2150
2151         public function showFileRenameError( $old, $new ) {
2152                 $this->showFatalError( wfMsg( 'filerenameerror', $old, $new ) );
2153         }
2154
2155         public function showFileDeleteError( $name ) {
2156                 $this->showFatalError( wfMsg( 'filedeleteerror', $name ) );
2157         }
2158
2159         public function showFileNotFoundError( $name ) {
2160                 $this->showFatalError( wfMsg( 'filenotfound', $name ) );
2161         }
2162
2163         /**
2164          * Add a "return to" link pointing to a specified title
2165          *
2166          * @param $title Title to link
2167          * @param $query String query string
2168          * @param $text String text of the link (input is not escaped)
2169          */
2170         public function addReturnTo( $title, $query = array(), $text = null ) {
2171                 $this->addLink( array( 'rel' => 'next', 'href' => $title->getFullURL() ) );
2172                 $link = wfMsgHtml(
2173                         'returnto',
2174                         Linker::link( $title, $text, array(), $query )
2175                 );
2176                 $this->addHTML( "<p id=\"mw-returnto\">{$link}</p>\n" );
2177         }
2178
2179         /**
2180          * Add a "return to" link pointing to a specified title,
2181          * or the title indicated in the request, or else the main page
2182          *
2183          * @param $unused No longer used
2184          * @param $returnto Title or String to return to
2185          * @param $returntoquery String: query string for the return to link
2186          */
2187         public function returnToMain( $unused = null, $returnto = null, $returntoquery = null ) {
2188                 if ( $returnto == null ) {
2189                         $returnto = $this->getRequest()->getText( 'returnto' );
2190                 }
2191
2192                 if ( $returntoquery == null ) {
2193                         $returntoquery = $this->getRequest()->getText( 'returntoquery' );
2194                 }
2195
2196                 if ( $returnto === '' ) {
2197                         $returnto = Title::newMainPage();
2198                 }
2199
2200                 if ( is_object( $returnto ) ) {
2201                         $titleObj = $returnto;
2202                 } else {
2203                         $titleObj = Title::newFromText( $returnto );
2204                 }
2205                 if ( !is_object( $titleObj ) ) {
2206                         $titleObj = Title::newMainPage();
2207                 }
2208
2209                 $this->addReturnTo( $titleObj, $returntoquery );
2210         }
2211
2212         /**
2213          * @param $sk Skin The given Skin
2214          * @param $includeStyle Boolean: unused
2215          * @return String: The doctype, opening <html>, and head element.
2216          */
2217         public function headElement( Skin $sk, $includeStyle = true ) {
2218                 global $wgContLang, $wgUseTrackbacks;
2219                 $userdir = $this->getLang()->getDir();
2220                 $sitedir = $wgContLang->getDir();
2221
2222                 if ( $sk->commonPrintStylesheet() ) {
2223                         $this->addModuleStyles( 'mediawiki.legacy.wikiprintable' );
2224                 }
2225
2226                 $ret = Html::htmlHeader( array( 'lang' => $this->getLang()->getCode(), 'dir' => $userdir ) );
2227
2228                 if ( $this->getHTMLTitle() == '' ) {
2229                         $this->setHTMLTitle( wfMsg( 'pagetitle', $this->getPageTitle() ) );
2230                 }
2231
2232                 $openHead = Html::openElement( 'head' );
2233                 if ( $openHead ) {
2234                         # Don't bother with the newline if $head == ''
2235                         $ret .= "$openHead\n";
2236                 }
2237
2238                 $ret .= Html::element( 'title', null, $this->getHTMLTitle() ) . "\n";
2239
2240                 $ret .= implode( "\n", array(
2241                         $this->getHeadLinks( null, true ),
2242                         $this->buildCssLinks(),
2243                         $this->getHeadScripts(),
2244                         $this->getHeadItems()
2245                 ) );
2246
2247                 if ( $wgUseTrackbacks && $this->isArticleRelated() ) {
2248                         $ret .= $this->getTitle()->trackbackRDF();
2249                 }
2250
2251                 $closeHead = Html::closeElement( 'head' );
2252                 if ( $closeHead ) {
2253                         $ret .= "$closeHead\n";
2254                 }
2255
2256                 $bodyAttrs = array();
2257
2258                 # Classes for LTR/RTL directionality support
2259                 $bodyAttrs['class'] = "mediawiki $userdir sitedir-$sitedir";
2260
2261                 if ( $this->getContext()->getLang()->capitalizeAllNouns() ) {
2262                         # A <body> class is probably not the best way to do this . . .
2263                         $bodyAttrs['class'] .= ' capitalize-all-nouns';
2264                 }
2265                 $bodyAttrs['class'] .= ' ' . $sk->getPageClasses( $this->getTitle() );
2266                 $bodyAttrs['class'] .= ' skin-' . Sanitizer::escapeClass( $sk->getSkinName() );
2267
2268                 $sk->addToBodyAttributes( $this, $bodyAttrs ); // Allow skins to add body attributes they need
2269                 wfRunHooks( 'OutputPageBodyAttributes', array( $this, $sk, &$bodyAttrs ) );
2270
2271                 $ret .= Html::openElement( 'body', $bodyAttrs ) . "\n";
2272
2273                 return $ret;
2274         }
2275
2276         /**
2277          * Add the default ResourceLoader modules to this object
2278          */
2279         private function addDefaultModules() {
2280                 global $wgIncludeLegacyJavaScript, $wgUseAjax,
2281                         $wgAjaxWatch, $wgEnableMWSuggest, $wgUseAJAXCategories;
2282
2283                 // Add base resources
2284                 $this->addModules( array(
2285                         'mediawiki.user',
2286                         'mediawiki.util',
2287                         'mediawiki.page.startup',
2288                         'mediawiki.page.ready',
2289                 ) );
2290                 if ( $wgIncludeLegacyJavaScript ){
2291                         $this->addModules( 'mediawiki.legacy.wikibits' );
2292                 }
2293
2294                 // Add various resources if required
2295                 if ( $wgUseAjax ) {
2296                         $this->addModules( 'mediawiki.legacy.ajax' );
2297
2298                         wfRunHooks( 'AjaxAddScript', array( &$this ) );
2299
2300                         if( $wgAjaxWatch && $this->getUser()->isLoggedIn() ) {
2301                                 $this->addModules( 'mediawiki.action.watch.ajax' );
2302                         }
2303
2304                         if ( $wgEnableMWSuggest && !$this->getUser()->getOption( 'disablesuggest', false ) ) {
2305                                 $this->addModules( 'mediawiki.page.mwsuggest' );
2306                         }
2307                 }
2308
2309                 if ( $this->getUser()->getBoolOption( 'editsectiononrightclick' ) ) {
2310                         $this->addModules( 'mediawiki.action.view.rightClickEdit' );
2311                 }
2312
2313                 # Crazy edit-on-double-click stuff
2314                 if ( $this->isArticle() && $this->getUser()->getOption( 'editondblclick' ) ) {
2315                         $this->addModules( 'mediawiki.action.view.dblClickEdit' );
2316                 }
2317
2318                 if ( $wgUseAJAXCategories ) {
2319                         global $wgAJAXCategoriesNamespaces;
2320
2321                         $title = $this->getTitle();
2322
2323                         if( empty( $wgAJAXCategoriesNamespaces ) || in_array( $title->getNamespace(), $wgAJAXCategoriesNamespaces ) ) {
2324                                 $this->addModules( 'mediawiki.page.ajaxCategories.init' );
2325                         }
2326                 }
2327         }
2328
2329         /**
2330          * Get a ResourceLoader object associated with this OutputPage
2331          *
2332          * @return ResourceLoader
2333          */
2334         public function getResourceLoader() {
2335                 if ( is_null( $this->mResourceLoader ) ) {
2336                         $this->mResourceLoader = new ResourceLoader();
2337                 }
2338                 return $this->mResourceLoader;
2339         }
2340
2341         /**
2342          * TODO: Document
2343          * @param $modules Array/string with the module name(s)
2344          * @param $only String ResourceLoaderModule TYPE_ class constant
2345          * @param $useESI boolean
2346          * @param $extraQuery Array with extra query parameters to add to each request. array( param => value )
2347          * @return string html <script> and <style> tags
2348          */
2349         protected function makeResourceLoaderLink( $modules, $only, $useESI = false, array $extraQuery = array() ) {
2350                 global $wgLoadScript, $wgResourceLoaderUseESI,
2351                         $wgResourceLoaderInlinePrivateModules;
2352                 $baseQuery = array(
2353                         'lang' => $this->getContext()->getLang()->getCode(),
2354                         'debug' => ResourceLoader::inDebugMode() ? 'true' : 'false',
2355                         'skin' => $this->getSkin()->getSkinName(),
2356                 ) + $extraQuery;
2357                 if ( $only !== ResourceLoaderModule::TYPE_COMBINED ) {
2358                         $baseQuery['only'] = $only;
2359                 }
2360                 // Propagate printable and handheld parameters if present
2361                 if ( $this->isPrintable() ) {
2362                         $baseQuery['printable'] = 1;
2363                 }
2364                 if ( $this->getRequest()->getBool( 'handheld' ) ) {
2365                         $baseQuery['handheld'] = 1;
2366                 }
2367
2368                 if ( !count( $modules ) ) {
2369                         return '';
2370                 }
2371
2372                 if ( count( $modules ) > 1 ) {
2373                         // Remove duplicate module requests
2374                         $modules = array_unique( (array) $modules );
2375                         // Sort module names so requests are more uniform
2376                         sort( $modules );
2377
2378                         if ( ResourceLoader::inDebugMode() ) {
2379                                 // Recursively call us for every item
2380                                 $links = '';
2381                                 foreach ( $modules as $name ) {
2382                                         $links .= $this->makeResourceLoaderLink( $name, $only, $useESI );
2383                                 }
2384                                 return $links;
2385                         }
2386                 }
2387
2388                 // Create keyed-by-group list of module objects from modules list
2389                 $groups = array();
2390                 $resourceLoader = $this->getResourceLoader();
2391                 foreach ( (array) $modules as $name ) {
2392                         $module = $resourceLoader->getModule( $name );
2393                         # Check that we're allowed to include this module on this page
2394                         if ( ( $module->getOrigin() > $this->getAllowedModules( ResourceLoaderModule::TYPE_SCRIPTS )
2395                                         && $only == ResourceLoaderModule::TYPE_SCRIPTS )
2396                                 || ( $module->getOrigin() > $this->getAllowedModules( ResourceLoaderModule::TYPE_STYLES )
2397                                         && $only == ResourceLoaderModule::TYPE_STYLES )
2398                                 )
2399                         {
2400                                 continue;
2401                         }
2402
2403                         $group = $module->getGroup();
2404                         if ( !isset( $groups[$group] ) ) {
2405                                 $groups[$group] = array();
2406                         }
2407                         $groups[$group][$name] = $module;
2408                 }
2409
2410                 $links = '';
2411                 foreach ( $groups as $group => $modules ) {
2412                         $query = $baseQuery;
2413                         // Special handling for user-specific groups
2414                         if ( ( $group === 'user' || $group === 'private' ) && $this->getUser()->isLoggedIn() ) {
2415                                 $query['user'] = $this->getUser()->getName();
2416                         }
2417
2418                         // Create a fake request based on the one we are about to make so modules return
2419                         // correct timestamp and emptiness data
2420                         $context = new ResourceLoaderContext( $resourceLoader, new FauxRequest( $query ) );
2421                         // Drop modules that know they're empty
2422                         foreach ( $modules as $key => $module ) {
2423                                 if ( $module->isKnownEmpty( $context ) ) {
2424                                         unset( $modules[$key] );
2425                                 }
2426                         }
2427                         // If there are no modules left, skip this group
2428                         if ( $modules === array() ) {
2429                                 continue;
2430                         }
2431
2432                         $query['modules'] = ResourceLoader::makePackedModulesString( array_keys( $modules ) );
2433
2434                         // Support inlining of private modules if configured as such
2435                         if ( $group === 'private' && $wgResourceLoaderInlinePrivateModules ) {
2436                                 if ( $only == ResourceLoaderModule::TYPE_STYLES ) {
2437                                         $links .= Html::inlineStyle(
2438                                                 $resourceLoader->makeModuleResponse( $context, $modules )
2439                                         );
2440                                 } else {
2441                                         $links .= Html::inlineScript(
2442                                                 ResourceLoader::makeLoaderConditionalScript(
2443                                                         $resourceLoader->makeModuleResponse( $context, $modules )
2444                                                 )
2445                                         );
2446                                 }
2447                                 $links .= "\n";
2448                                 continue;
2449                         }
2450                         // Special handling for the user group; because users might change their stuff
2451                         // on-wiki like user pages, or user preferences; we need to find the highest
2452                         // timestamp of these user-changable modules so we can ensure cache misses on change
2453                         // This should NOT be done for the site group (bug 27564) because anons get that too
2454                         // and we shouldn't be putting timestamps in Squid-cached HTML
2455                         if ( $group === 'user' ) {
2456                                 // Get the maximum timestamp
2457                                 $timestamp = 1;
2458                                 foreach ( $modules as $module ) {
2459                                         $timestamp = max( $timestamp, $module->getModifiedTime( $context ) );
2460                                 }
2461                                 // Add a version parameter so cache will break when things change
2462                                 $query['version'] = wfTimestamp( TS_ISO_8601_BASIC, $timestamp );
2463                         }
2464                         // Make queries uniform in order
2465                         ksort( $query );
2466
2467                         $url = wfAppendQuery( $wgLoadScript, $query );
2468                         // Prevent the IE6 extension check from being triggered (bug 28840)
2469                         // by appending a character that's invalid in Windows extensions ('*')
2470                         $url .= '&*';
2471                         if ( $useESI && $wgResourceLoaderUseESI ) {
2472                                 $esi = Xml::element( 'esi:include', array( 'src' => $url ) );
2473                                 if ( $only == ResourceLoaderModule::TYPE_STYLES ) {
2474                                         $link = Html::inlineStyle( $esi );
2475                                 } else {
2476                                         $link = Html::inlineScript( $esi );
2477                                 }
2478                         } else {
2479                                 // Automatically select style/script elements
2480                                 if ( $only === ResourceLoaderModule::TYPE_STYLES ) {
2481                                         $link = Html::linkedStyle( $url );
2482                                 } else {
2483                                         $link = Html::linkedScript( $url );
2484                                 }
2485                         }
2486
2487                         if( $group == 'noscript' ){
2488                                 $links .= Html::rawElement( 'noscript', array(), $link ) . "\n";
2489                         } else {
2490                                 $links .= $link . "\n";
2491                         }
2492                 }
2493                 return $links;
2494         }
2495
2496         /**
2497          * JS stuff to put in the <head>. This is the startup module, config
2498          * vars and modules marked with position 'top'
2499          *
2500          * @return String: HTML fragment
2501          */
2502         function getHeadScripts() {
2503                 // Startup - this will immediately load jquery and mediawiki modules
2504                 $scripts = $this->makeResourceLoaderLink( 'startup', ResourceLoaderModule::TYPE_SCRIPTS, true );
2505
2506                 // Load config before anything else
2507                 $scripts .= Html::inlineScript(
2508                         ResourceLoader::makeLoaderConditionalScript(
2509                                 ResourceLoader::makeConfigSetScript( $this->getJSVars() )
2510                         )
2511                 );
2512
2513                 // Script and Messages "only" requests marked for top inclusion
2514                 // Messages should go first
2515                 $scripts .= $this->makeResourceLoaderLink( $this->getModuleMessages( true, 'top' ), ResourceLoaderModule::TYPE_MESSAGES );
2516                 $scripts .= $this->makeResourceLoaderLink( $this->getModuleScripts( true, 'top' ), ResourceLoaderModule::TYPE_SCRIPTS );
2517
2518                 // Modules requests - let the client calculate dependencies and batch requests as it likes
2519                 // Only load modules that have marked themselves for loading at the top
2520                 $modules = $this->getModules( true, 'top' );
2521                 if ( $modules ) {
2522                         $scripts .= Html::inlineScript(
2523                                 ResourceLoader::makeLoaderConditionalScript(
2524                                         Xml::encodeJsCall( 'mw.loader.load', array( $modules ) )
2525                                 )
2526                         );
2527                 }
2528
2529                 return $scripts;
2530         }
2531
2532         /**
2533          * JS stuff to put at the bottom of the <body>: modules marked with position 'bottom',
2534          * legacy scripts ($this->mScripts), user preferences, site JS and user JS
2535          *
2536          * @return string
2537          */
2538         function getBottomScripts() {
2539                 global $wgUseSiteJs, $wgAllowUserJs;
2540
2541                 // Script and Messages "only" requests marked for bottom inclusion
2542                 // Messages should go first
2543                 $scripts = $this->makeResourceLoaderLink( $this->getModuleMessages( true, 'bottom' ), ResourceLoaderModule::TYPE_MESSAGES );
2544                 $scripts .= $this->makeResourceLoaderLink( $this->getModuleScripts( true, 'bottom' ), ResourceLoaderModule::TYPE_SCRIPTS );
2545
2546                 // Modules requests - let the client calculate dependencies and batch requests as it likes
2547                 // Only load modules that have marked themselves for loading at the bottom
2548                 $modules = $this->getModules( true, 'bottom' );
2549                 if ( $modules ) {
2550                         $scripts .= Html::inlineScript(
2551                                 ResourceLoader::makeLoaderConditionalScript(
2552                                         Xml::encodeJsCall( 'mw.loader.load', array( $modules ) )
2553                                 )
2554                         );
2555                 }
2556
2557                 // Legacy Scripts
2558                 $scripts .= "\n" . $this->mScripts;
2559
2560                 $userScripts = array( 'user.options', 'user.tokens' );
2561
2562                 // Add site JS if enabled
2563                 if ( $wgUseSiteJs ) {
2564                         $scripts .= $this->makeResourceLoaderLink( 'site', ResourceLoaderModule::TYPE_SCRIPTS );
2565                         if( $this->getUser()->isLoggedIn() ){
2566                                 $userScripts[] = 'user.groups';
2567                         }
2568                 }
2569
2570                 // Add user JS if enabled
2571                 if ( $wgAllowUserJs && $this->getUser()->isLoggedIn() ) {
2572                         if( $this->getTitle() && $this->getTitle()->isJsSubpage() && $this->userCanPreview() ) {
2573                                 # XXX: additional security check/prompt?
2574                                 // We're on a preview of a JS subpage
2575                                 // Exclude this page from the user module in case it's in there (bug 26283)
2576                                 $scripts .= $this->makeResourceLoaderLink( 'user', ResourceLoaderModule::TYPE_SCRIPTS, false,
2577                                         array( 'excludepage' => $this->getTitle()->getPrefixedDBkey() )
2578                                 );
2579                                 // Load the previewed JS
2580                                 $scripts .= Html::inlineScript( "\n" . $this->getRequest()->getText( 'wpTextbox1' ) . "\n" ) . "\n";
2581                         } else {
2582                                 // Include the user module normally
2583                                 // We can't do $userScripts[] = 'user'; because the user module would end up
2584                                 // being wrapped in a closure, so load it raw like 'site'
2585                                 $scripts .= $this->makeResourceLoaderLink( 'user', ResourceLoaderModule::TYPE_SCRIPTS );
2586                         }
2587                 }
2588                 $scripts .= $this->makeResourceLoaderLink( $userScripts, ResourceLoaderModule::TYPE_COMBINED );
2589
2590                 return $scripts;
2591         }
2592
2593         /**
2594          * Get an array containing global JS variables
2595          *
2596          * Do not add things here which can be evaluated in
2597          * ResourceLoaderStartupScript - in other words, without state.
2598          * You will only be adding bloat to the page and causing page caches to
2599          * have to be purged on configuration changes.
2600          */
2601         protected function getJSVars() {
2602                 global $wgUseAjax, $wgEnableMWSuggest, $wgContLang;
2603
2604                 $title = $this->getTitle();
2605                 $ns = $title->getNamespace();
2606                 $nsname = MWNamespace::exists( $ns ) ? MWNamespace::getCanonicalName( $ns ) : $title->getNsText();
2607                 if ( $ns == NS_SPECIAL ) {
2608                         list( $canonicalName, /*...*/ ) = SpecialPageFactory::resolveAlias( $title->getDBkey() );
2609                 } else {
2610                         $canonicalName = false; # bug 21115
2611                 }
2612
2613                 $vars = array(
2614                         'wgCanonicalNamespace' => $nsname,
2615                         'wgCanonicalSpecialPageName' => $canonicalName,
2616                         'wgNamespaceNumber' => $title->getNamespace(),
2617                         'wgPageName' => $title->getPrefixedDBKey(),
2618                         'wgTitle' => $title->getText(),
2619                         'wgCurRevisionId' => $title->getLatestRevID(),
2620                         'wgArticleId' => $title->getArticleId(),
2621                         'wgIsArticle' => $this->isArticle(),
2622                         'wgAction' => $this->getRequest()->getText( 'action', 'view' ),
2623                         'wgUserName' => $this->getUser()->isAnon() ? null : $this->getUser()->getName(),
2624                         'wgUserGroups' => $this->getUser()->getEffectiveGroups(),
2625                         'wgCategories' => $this->getCategories(),
2626                         'wgBreakFrames' => $this->getFrameOptions() == 'DENY',
2627                 );
2628                 if ( $wgContLang->hasVariants() ) {
2629                         $vars['wgUserVariant'] = $wgContLang->getPreferredVariant();
2630                 }
2631                 foreach ( $title->getRestrictionTypes() as $type ) {
2632                         $vars['wgRestriction' . ucfirst( $type )] = $title->getRestrictions( $type );
2633                 }
2634                 if ( $wgUseAjax && $wgEnableMWSuggest && !$this->getUser()->getOption( 'disablesuggest', false ) ) {
2635                         $vars['wgSearchNamespaces'] = SearchEngine::userNamespaces( $this->getUser() );
2636                 }
2637                 if ( $title->isMainPage() ) {
2638                         $vars['wgIsMainPage'] = true;
2639                 }
2640
2641                 // Allow extensions to add their custom variables to the global JS variables
2642                 wfRunHooks( 'MakeGlobalVariablesScript', array( &$vars ) );
2643
2644                 return $vars;
2645         }
2646
2647         /**
2648          * To make it harder for someone to slip a user a fake
2649          * user-JavaScript or user-CSS preview, a random token
2650          * is associated with the login session. If it's not
2651          * passed back with the preview request, we won't render
2652          * the code.
2653          *
2654          * @return bool
2655          */
2656         public function userCanPreview() {
2657                 if ( $this->getRequest()->getVal( 'action' ) != 'submit'
2658                         || !$this->getRequest()->wasPosted()
2659                         || !$this->getUser()->matchEditToken(
2660                                 $this->getRequest()->getVal( 'wpEditToken' ) )
2661                 ) {
2662                         return false;
2663                 }
2664                 if ( !$this->getTitle()->isJsSubpage() && !$this->getTitle()->isCssSubpage() ) {
2665                         return false;
2666                 }
2667
2668                 return !count( $this->getTitle()->getUserPermissionsErrors( 'edit', $this->getUser() ) );
2669         }
2670
2671         /**
2672          * @param $unused Unused
2673          * @param $addContentType bool
2674          *
2675          * @return string HTML tag links to be put in the header.
2676          */
2677         public function getHeadLinks( $unused = null, $addContentType = false ) {
2678                 global $wgUniversalEditButton, $wgFavicon, $wgAppleTouchIcon, $wgEnableAPI,
2679                         $wgSitename, $wgVersion, $wgHtml5, $wgMimeType,
2680                         $wgFeed, $wgOverrideSiteFeed, $wgAdvertisedFeedTypes,
2681                         $wgDisableLangConversion, $wgCanonicalLanguageLinks, $wgContLang,
2682                         $wgRightsPage, $wgRightsUrl;
2683
2684                 $tags = array();
2685
2686                 if ( $addContentType ) {
2687                         if ( $wgHtml5 ) {
2688                                 # More succinct than <meta http-equiv=Content-Type>, has the
2689                                 # same effect
2690                                 $tags[] = Html::element( 'meta', array( 'charset' => 'UTF-8' ) );
2691                         } else {
2692                                 $tags[] = Html::element( 'meta', array(
2693                                         'http-equiv' => 'Content-Type',
2694                                         'content' => "$wgMimeType; charset=UTF-8"
2695                                 ) );
2696                                 $tags[] = Html::element( 'meta', array(  // bug 15835
2697                                         'http-equiv' => 'Content-Style-Type',
2698                                         'content' => 'text/css'
2699                                 ) );
2700                         }
2701                 }
2702
2703                 $tags[] = Html::element( 'meta', array(
2704                         'name' => 'generator',
2705                         'content' => "MediaWiki $wgVersion",
2706                 ) );
2707
2708                 $p = "{$this->mIndexPolicy},{$this->mFollowPolicy}";
2709                 if( $p !== 'index,follow' ) {
2710                         // http://www.robotstxt.org/wc/meta-user.html
2711                         // Only show if it's different from the default robots policy
2712                         $tags[] = Html::element( 'meta', array(
2713                                 'name' => 'robots',
2714                                 'content' => $p,
2715                         ) );
2716                 }
2717
2718                 if ( count( $this->mKeywords ) > 0 ) {
2719                         $strip = array(
2720                                 "/<.*?" . ">/" => '',
2721                                 "/_/" => ' '
2722                         );
2723                         $tags[] = Html::element( 'meta', array(
2724                                 'name' => 'keywords',
2725                                 'content' =>  preg_replace(
2726                                         array_keys( $strip ),
2727                                         array_values( $strip ),
2728                                         implode( ',', $this->mKeywords )
2729                                 )
2730                         ) );
2731                 }
2732
2733                 foreach ( $this->mMetatags as $tag ) {
2734                         if ( 0 == strcasecmp( 'http:', substr( $tag[0], 0, 5 ) ) ) {
2735                                 $a = 'http-equiv';
2736                                 $tag[0] = substr( $tag[0], 5 );
2737                         } else {
2738                                 $a = 'name';
2739                         }
2740                         $tags[] = Html::element( 'meta',
2741                                 array(
2742                                         $a => $tag[0],
2743                                         'content' => $tag[1]
2744                                 )
2745                         );
2746                 }
2747
2748                 foreach ( $this->mLinktags as $tag ) {
2749                         $tags[] = Html::element( 'link', $tag );
2750                 }
2751
2752                 # Universal edit button
2753                 if ( $wgUniversalEditButton ) {
2754                         if ( $this->isArticleRelated() && $this->getTitle() && $this->getTitle()->quickUserCan( 'edit' )
2755                                 && ( $this->getTitle()->exists() || $this->getTitle()->quickUserCan( 'create' ) ) ) {
2756                                 // Original UniversalEditButton
2757                                 $msg = wfMsg( 'edit' );
2758                                 $tags[] = Html::element( 'link', array(
2759                                         'rel' => 'alternate',
2760                                         'type' => 'application/x-wiki',
2761                                         'title' => $msg,
2762                                         'href' => $this->getTitle()->getLocalURL( 'action=edit' )
2763                                 ) );
2764                                 // Alternate edit link
2765                                 $tags[] = Html::element( 'link', array(
2766                                         'rel' => 'edit',
2767                                         'title' => $msg,
2768                                         'href' => $this->getTitle()->getLocalURL( 'action=edit' )
2769                                 ) );
2770                         }
2771                 }
2772
2773                 # Generally the order of the favicon and apple-touch-icon links
2774                 # should not matter, but Konqueror (3.5.9 at least) incorrectly
2775                 # uses whichever one appears later in the HTML source. Make sure
2776                 # apple-touch-icon is specified first to avoid this.
2777                 if ( $wgAppleTouchIcon !== false ) {
2778                         $tags[] = Html::element( 'link', array( 'rel' => 'apple-touch-icon', 'href' => $wgAppleTouchIcon ) );
2779                 }
2780
2781                 if ( $wgFavicon !== false ) {
2782                         $tags[] = Html::element( 'link', array( 'rel' => 'shortcut icon', 'href' => $wgFavicon ) );
2783                 }
2784
2785                 # OpenSearch description link
2786                 $tags[] = Html::element( 'link', array(
2787                         'rel' => 'search',
2788                         'type' => 'application/opensearchdescription+xml',
2789                         'href' => wfScript( 'opensearch_desc' ),
2790                         'title' => wfMsgForContent( 'opensearch-desc' ),
2791                 ) );
2792
2793                 if ( $wgEnableAPI ) {
2794                         # Real Simple Discovery link, provides auto-discovery information
2795                         # for the MediaWiki API (and potentially additional custom API
2796                         # support such as WordPress or Twitter-compatible APIs for a
2797                         # blogging extension, etc)
2798                         $tags[] = Html::element( 'link', array(
2799                                 'rel' => 'EditURI',
2800                                 'type' => 'application/rsd+xml',
2801                                 // Output a protocol-relative URL here if $wgServer is protocol-relative
2802                                 // Whether RSD accepts relative or protocol-relative URLs is completely undocumented, though
2803                                 'href' => wfExpandUrl( wfAppendQuery( wfScript( 'api' ), array( 'action' => 'rsd' ) ), PROTO_RELATIVE ),
2804                         ) );
2805                 }
2806
2807                 # Language variants
2808                 if ( !$wgDisableLangConversion && $wgCanonicalLanguageLinks
2809                         && $wgContLang->hasVariants() ) {
2810
2811                         $urlvar = $wgContLang->getURLVariant();
2812
2813                         if ( !$urlvar ) {
2814                                 $variants = $wgContLang->getVariants();
2815                                 foreach ( $variants as $_v ) {
2816                                         $tags[] = Html::element( 'link', array(
2817                                                 'rel' => 'alternate',
2818                                                 'hreflang' => $_v,
2819                                                 'href' => $this->getTitle()->getLocalURL( '', $_v ) )
2820                                         );
2821                                 }
2822                         } else {
2823                                 $tags[] = Html::element( 'link', array(
2824                                         'rel' => 'canonical',
2825                                         'href' => wfExpandUrl( $this->getTitle()->getFullURL(), PROTO_HTTP ) )
2826                                 );
2827                         }
2828                 }
2829
2830                 # Copyright
2831                 $copyright = '';
2832                 if ( $wgRightsPage ) {
2833                         $copy = Title::newFromText( $wgRightsPage );
2834
2835                         if ( $copy ) {
2836                                 $copyright = $copy->getLocalURL();
2837                         }
2838                 }
2839
2840                 if ( !$copyright && $wgRightsUrl ) {
2841                         $copyright = $wgRightsUrl;
2842                 }
2843
2844                 if ( $copyright ) {
2845                         $tags[] = Html::element( 'link', array(
2846                                 'rel' => 'copyright',
2847                                 'href' => $copyright )
2848                         );
2849                 }
2850
2851                 # Feeds
2852                 if ( $wgFeed ) {
2853                         foreach( $this->getSyndicationLinks() as $format => $link ) {
2854                                 # Use the page name for the title.  In principle, this could
2855                                 # lead to issues with having the same name for different feeds
2856                                 # corresponding to the same page, but we can't avoid that at
2857                                 # this low a level.
2858
2859                                 $tags[] = $this->feedLink(
2860                                         $format,
2861                                         $link,
2862                                         # Used messages: 'page-rss-feed' and 'page-atom-feed' (for an easier grep)
2863                                         wfMsg( "page-{$format}-feed", $this->getTitle()->getPrefixedText() )
2864                                 );
2865                         }
2866
2867                         # Recent changes feed should appear on every page (except recentchanges,
2868                         # that would be redundant). Put it after the per-page feed to avoid
2869                         # changing existing behavior. It's still available, probably via a
2870                         # menu in your browser. Some sites might have a different feed they'd
2871                         # like to promote instead of the RC feed (maybe like a "Recent New Articles"
2872                         # or "Breaking news" one). For this, we see if $wgOverrideSiteFeed is defined.
2873                         # If so, use it instead.
2874
2875                         $rctitle = SpecialPage::getTitleFor( 'Recentchanges' );
2876
2877                         if ( $wgOverrideSiteFeed ) {
2878                                 foreach ( $wgOverrideSiteFeed as $type => $feedUrl ) {
2879                                         $tags[] = $this->feedLink(
2880                                                 $type,
2881                                                 htmlspecialchars( $feedUrl ),
2882                                                 wfMsg( "site-{$type}-feed", $wgSitename )
2883                                         );
2884                                 }
2885                         } elseif ( $this->getTitle()->getPrefixedText() != $rctitle->getPrefixedText() ) {
2886                                 foreach ( $wgAdvertisedFeedTypes as $format ) {
2887                                         $tags[] = $this->feedLink(
2888                                                 $format,
2889                                                 $rctitle->getLocalURL( "feed={$format}" ),
2890                                                 wfMsg( "site-{$format}-feed", $wgSitename ) # For grep: 'site-rss-feed', 'site-atom-feed'.
2891                                         );
2892                                 }
2893                         }
2894                 }
2895                 return implode( "\n", $tags );
2896         }
2897
2898         /**
2899          * Generate a <link rel/> for a feed.
2900          *
2901          * @param $type String: feed type
2902          * @param $url String: URL to the feed
2903          * @param $text String: value of the "title" attribute
2904          * @return String: HTML fragment
2905          */
2906         private function feedLink( $type, $url, $text ) {
2907                 return Html::element( 'link', array(
2908                         'rel' => 'alternate',
2909                         'type' => "application/$type+xml",
2910                         'title' => $text,
2911                         'href' => $url )
2912                 );
2913         }
2914
2915         /**
2916          * Add a local or specified stylesheet, with the given media options.
2917          * Meant primarily for internal use...
2918          *
2919          * @param $style String: URL to the file
2920          * @param $media String: to specify a media type, 'screen', 'printable', 'handheld' or any.
2921          * @param $condition String: for IE conditional comments, specifying an IE version
2922          * @param $dir String: set to 'rtl' or 'ltr' for direction-specific sheets
2923          */
2924         public function addStyle( $style, $media = '', $condition = '', $dir = '' ) {
2925                 $options = array();
2926                 // Even though we expect the media type to be lowercase, but here we
2927                 // force it to lowercase to be safe.
2928                 if( $media ) {
2929                         $options['media'] = $media;
2930                 }
2931                 if( $condition ) {
2932                         $options['condition'] = $condition;
2933                 }
2934                 if( $dir ) {
2935                         $options['dir'] = $dir;
2936                 }
2937                 $this->styles[$style] = $options;
2938         }
2939
2940         /**
2941          * Adds inline CSS styles
2942          * @param $style_css Mixed: inline CSS
2943          */
2944         public function addInlineStyle( $style_css ){
2945                 $this->mInlineStyles .= Html::inlineStyle( $style_css );
2946         }
2947
2948         /**
2949          * Build a set of <link>s for the stylesheets specified in the $this->styles array.
2950          * These will be applied to various media & IE conditionals.
2951          *
2952          * @return string
2953          */
2954         public function buildCssLinks() {
2955                 global $wgUseSiteCss, $wgAllowUserCss, $wgAllowUserCssPrefs;
2956
2957                 $this->getSkin()->setupSkinUserCss( $this );
2958
2959                 // Add ResourceLoader styles
2960                 // Split the styles into four groups
2961                 $styles = array( 'other' => array(), 'user' => array(), 'site' => array(), 'private' => array(), 'noscript' => array() );
2962                 $otherTags = ''; // Tags to append after the normal <link> tags
2963                 $resourceLoader = $this->getResourceLoader();
2964
2965                 $moduleStyles = $this->getModuleStyles();
2966
2967                 // Per-site custom styles
2968                 if ( $wgUseSiteCss ) {
2969                         $moduleStyles[] = 'site';
2970                         $moduleStyles[] = 'noscript';
2971                         if( $this->getUser()->isLoggedIn() ){
2972                                 $moduleStyles[] = 'user.groups';
2973                         }
2974                 }
2975
2976                 // Per-user custom styles
2977                 if ( $wgAllowUserCss ) {
2978                         if ( $this->getTitle()->isCssSubpage() && $this->userCanPreview() ) {
2979                                 // We're on a preview of a CSS subpage
2980                                 // Exclude this page from the user module in case it's in there (bug 26283)
2981                                 $otherTags .= $this->makeResourceLoaderLink( 'user', ResourceLoaderModule::TYPE_STYLES, false,
2982                                         array( 'excludepage' => $this->getTitle()->getPrefixedDBkey() )
2983                                 );
2984                                 // Load the previewed CSS
2985                                 $otherTags .= Html::inlineStyle( $this->getRequest()->getText( 'wpTextbox1' ) );
2986                         } else {
2987                                 // Load the user styles normally
2988                                 $moduleStyles[] = 'user';
2989                         }
2990                 }
2991
2992                 // Per-user preference styles
2993                 if ( $wgAllowUserCssPrefs ) {
2994                         $moduleStyles[] = 'user.options';
2995                 }
2996
2997                 foreach ( $moduleStyles as $name ) {
2998                         $group = $resourceLoader->getModule( $name )->getGroup();
2999                         // Modules in groups named "other" or anything different than "user", "site" or "private"
3000                         // will be placed in the "other" group
3001                         $styles[isset( $styles[$group] ) ? $group : 'other'][] = $name;
3002                 }
3003
3004                 // We want site, private and user styles to override dynamically added styles from modules, but we want
3005                 // dynamically added styles to override statically added styles from other modules. So the order
3006                 // has to be other, dynamic, site, private, user
3007                 // Add statically added styles for other modules
3008                 $ret = $this->makeResourceLoaderLink( $styles['other'], ResourceLoaderModule::TYPE_STYLES );
3009                 // Add normal styles added through addStyle()/addInlineStyle() here
3010                 $ret .= implode( "\n", $this->buildCssLinksArray() ) . $this->mInlineStyles;
3011                 // Add marker tag to mark the place where the client-side loader should inject dynamic styles
3012                 // We use a <meta> tag with a made-up name for this because that's valid HTML
3013                 $ret .= Html::element( 'meta', array( 'name' => 'ResourceLoaderDynamicStyles', 'content' => '' ) ) . "\n";
3014
3015                 // Add site, private and user styles
3016                 // 'private' at present only contains user.options, so put that before 'user'
3017                 // Any future private modules will likely have a similar user-specific character
3018                 foreach ( array( 'site', 'noscript', 'private', 'user' ) as $group ) {
3019                         $ret .= $this->makeResourceLoaderLink( $styles[$group],
3020                                         ResourceLoaderModule::TYPE_STYLES
3021                         );
3022                 }
3023
3024                 // Add stuff in $otherTags (previewed user CSS if applicable)
3025                 $ret .= $otherTags;
3026                 return $ret;
3027         }
3028
3029         public function buildCssLinksArray() {
3030                 $links = array();
3031
3032                 // Add any extension CSS
3033                 foreach ( $this->mExtStyles as $url ) {
3034                         $this->addStyle( $url );
3035                 }
3036                 $this->mExtStyles = array();
3037
3038                 foreach( $this->styles as $file => $options ) {
3039                         $link = $this->styleLink( $file, $options );
3040                         if( $link ) {
3041                                 $links[$file] = $link;
3042                         }
3043                 }
3044                 return $links;
3045         }
3046
3047         /**
3048          * Generate \<link\> tags for stylesheets
3049          *
3050          * @param $style String: URL to the file
3051          * @param $options Array: option, can contain 'condition', 'dir', 'media'
3052          *                 keys
3053          * @return String: HTML fragment
3054          */
3055         protected function styleLink( $style, $options ) {
3056                 if( isset( $options['dir'] ) ) {
3057                         if( $this->getLang()->getDir() != $options['dir'] ) {
3058                                 return '';
3059                         }
3060                 }
3061
3062                 if( isset( $options['media'] ) ) {
3063                         $media = self::transformCssMedia( $options['media'] );
3064                         if( is_null( $media ) ) {
3065                                 return '';
3066                         }
3067                 } else {
3068                         $media = 'all';
3069                 }
3070
3071                 if( substr( $style, 0, 1 ) == '/' ||
3072                         substr( $style, 0, 5 ) == 'http:' ||
3073                         substr( $style, 0, 6 ) == 'https:' ) {
3074                         $url = $style;
3075                 } else {
3076                         global $wgStylePath, $wgStyleVersion;
3077                         $url = $wgStylePath . '/' . $style . '?' . $wgStyleVersion;
3078                 }
3079
3080                 $link = Html::linkedStyle( $url, $media );
3081
3082                 if( isset( $options['condition'] ) ) {
3083                         $condition = htmlspecialchars( $options['condition'] );
3084                         $link = "<!--[if $condition]>$link<![endif]-->";
3085                 }
3086                 return $link;
3087         }
3088
3089         /**
3090          * Transform "media" attribute based on request parameters
3091          *
3092          * @param $media String: current value of the "media" attribute
3093          * @return String: modified value of the "media" attribute
3094          */
3095         public static function transformCssMedia( $media ) {
3096                 global $wgRequest, $wgHandheldForIPhone;
3097
3098                 // Switch in on-screen display for media testing
3099                 $switches = array(
3100                         'printable' => 'print',
3101                         'handheld' => 'handheld',
3102                 );
3103                 foreach( $switches as $switch => $targetMedia ) {
3104                         if( $wgRequest->getBool( $switch ) ) {
3105                                 if( $media == $targetMedia ) {
3106                                         $media = '';
3107                                 } elseif( $media == 'screen' ) {
3108                                         return null;
3109                                 }
3110                         }
3111                 }
3112
3113                 // Expand longer media queries as iPhone doesn't grok 'handheld'
3114                 if( $wgHandheldForIPhone ) {
3115                         $mediaAliases = array(
3116                                 'screen' => 'screen and (min-device-width: 481px)',
3117                                 'handheld' => 'handheld, only screen and (max-device-width: 480px)',
3118                         );
3119
3120                         if( isset( $mediaAliases[$media] ) ) {
3121                                 $media = $mediaAliases[$media];
3122                         }
3123                 }
3124
3125                 return $media;
3126         }
3127
3128         /**
3129          * Add a wikitext-formatted message to the output.
3130          * This is equivalent to:
3131          *
3132          *    $wgOut->addWikiText( wfMsgNoTrans( ... ) )
3133          */
3134         public function addWikiMsg( /*...*/ ) {
3135                 $args = func_get_args();
3136                 $name = array_shift( $args );
3137                 $this->addWikiMsgArray( $name, $args );
3138         }
3139
3140         /**
3141          * Add a wikitext-formatted message to the output.
3142          * Like addWikiMsg() except the parameters are taken as an array
3143          * instead of a variable argument list.
3144          *
3145          * $options is passed through to wfMsgExt(), see that function for details.
3146          *
3147          * @param $name string
3148          * @param $args array
3149          * @param $options array
3150          */
3151         public function addWikiMsgArray( $name, $args, $options = array() ) {
3152                 $options[] = 'parse';
3153                 $text = wfMsgExt( $name, $options, $args );
3154                 $this->addHTML( $text );
3155         }
3156
3157         /**
3158          * This function takes a number of message/argument specifications, wraps them in
3159          * some overall structure, and then parses the result and adds it to the output.
3160          *
3161          * In the $wrap, $1 is replaced with the first message, $2 with the second, and so
3162          * on. The subsequent arguments may either be strings, in which case they are the
3163          * message names, or arrays, in which case the first element is the message name,
3164          * and subsequent elements are the parameters to that message.
3165          *
3166          * The special named parameter 'options' in a message specification array is passed
3167          * through to the $options parameter of wfMsgExt().
3168          *
3169          * Don't use this for messages that are not in users interface language.
3170          *
3171          * For example:
3172          *
3173          *    $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>", 'some-error' );
3174          *
3175          * Is equivalent to:
3176          *
3177          *    $wgOut->addWikiText( "<div class='error'>\n" . wfMsgNoTrans( 'some-error' ) . "\n</div>" );
3178          *
3179          * The newline after opening div is needed in some wikitext. See bug 19226.
3180          *
3181          * @param $wrap string
3182          */
3183         public function wrapWikiMsg( $wrap /*, ...*/ ) {
3184                 $msgSpecs = func_get_args();
3185                 array_shift( $msgSpecs );
3186                 $msgSpecs = array_values( $msgSpecs );
3187                 $s = $wrap;
3188                 foreach ( $msgSpecs as $n => $spec ) {
3189                         $options = array();
3190                         if ( is_array( $spec ) ) {
3191                                 $args = $spec;
3192                                 $name = array_shift( $args );
3193                                 if ( isset( $args['options'] ) ) {
3194                                         $options = $args['options'];
3195                                         unset( $args['options'] );
3196                                 }
3197                         }  else {
3198                                 $args = array();
3199                                 $name = $spec;
3200                         }
3201                         $s = str_replace( '$' . ( $n + 1 ), wfMsgExt( $name, $options, $args ), $s );
3202                 }
3203                 $this->addWikiText( $s );
3204         }
3205
3206         /**
3207          * Include jQuery core. Use this to avoid loading it multiple times
3208          * before we get a usable script loader.
3209          *
3210          * @param $modules Array: list of jQuery modules which should be loaded
3211          * @return Array: the list of modules which were not loaded.
3212          * @since 1.16
3213          * @deprecated since 1.17
3214          */
3215         public function includeJQuery( $modules = array() ) {
3216                 return array();
3217         }
3218
3219 }