includes/OutputPage.php

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