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          * TODO: make a getter method for this
  60          */
  61         public $mDebugtext = ''; // TODO: we might want to replace it by wfDebug() wfDebugLog()
  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 contains
 120          * 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                 if( empty( $_SERVER['HTTP_IF_MODIFIED_SINCE'] ) ) {
 651                         wfDebug( __METHOD__ . ": client did not send If-Modified-Since header\n", false );
 652                         return false;
 653                 }
 654
 655                 # Make debug info
 656                 $info = '';
 657                 foreach ( $modifiedTimes as $name => $value ) {
 658                         if ( $info !== '' ) {
 659                                 $info .= ', ';
 660                         }
 661                         $info .= "$name=" . wfTimestamp( TS_ISO_8601, $value );
 662                 }
 663
 664                 # IE sends sizes after the date like this:
 665                 # Wed, 20 Aug 2003 06:51:19 GMT; length=5202
 666                 # this breaks strtotime().
 667                 $clientHeader = preg_replace( '/;.*$/', '', $_SERVER["HTTP_IF_MODIFIED_SINCE"] );
 668
 669                 wfSuppressWarnings(); // E_STRICT system time bitching
 670                 $clientHeaderTime = strtotime( $clientHeader );
 671                 wfRestoreWarnings();
 672                 if ( !$clientHeaderTime ) {
 673                         wfDebug( __METHOD__ . ": unable to parse the client's If-Modified-Since header: $clientHeader\n" );
 674                         return false;
 675                 }
 676                 $clientHeaderTime = wfTimestamp( TS_MW, $clientHeaderTime );
 677
 678                 wfDebug( __METHOD__ . ": client sent If-Modified-Since: " .
 679                         wfTimestamp( TS_ISO_8601, $clientHeaderTime ) . "\n", false );
 680                 wfDebug( __METHOD__ . ": effective Last-Modified: " .
 681                         wfTimestamp( TS_ISO_8601, $maxModified ) . "\n", false );
 682                 if( $clientHeaderTime < $maxModified ) {
 683                         wfDebug( __METHOD__ . ": STALE, $info\n", false );
 684                         return false;
 685                 }
 686
 687                 # Not modified
 688                 # Give a 304 response code and disable body output
 689                 wfDebug( __METHOD__ . ": NOT MODIFIED, $info\n", false );
 690                 ini_set( 'zlib.output_compression', 0 );
 691                 $this->getRequest()->response()->header( "HTTP/1.1 304 Not Modified" );
 692                 $this->sendCacheControl();
 693                 $this->disable();
 694
 695                 // Don't output a compressed blob when using ob_gzhandler;
 696                 // it's technically against HTTP spec and seems to confuse
 697                 // Firefox when the response gets split over two packets.
 698                 wfClearOutputBuffers();
 699
 700                 return true;
 701         }
 702
 703         /**
 704          * Override the last modified timestamp
 705          *
 706          * @param $timestamp String: new timestamp, in a format readable by
 707          *        wfTimestamp()
 708          */
 709         public function setLastModified( $timestamp ) {
 710                 $this->mLastModified = wfTimestamp( TS_RFC2822, $timestamp );
 711         }
 712
 713         /**
 714          * Set the robot policy for the page: <http://www.robotstxt.org/meta.html>
 715          *
 716          * @param $policy String: the literal string to output as the contents of
 717          *   the meta tag.  Will be parsed according to the spec and output in
 718          *   standardized form.
 719          * @return null
 720          */
 721         public function setRobotPolicy( $policy ) {
 722                 $policy = Article::formatRobotPolicy( $policy );
 723
 724                 if( isset( $policy['index'] ) ) {
 725                         $this->setIndexPolicy( $policy['index'] );
 726                 }
 727                 if( isset( $policy['follow'] ) ) {
 728                         $this->setFollowPolicy( $policy['follow'] );
 729                 }
 730         }
 731
 732         /**
 733          * Set the index policy for the page, but leave the follow policy un-
 734          * touched.
 735          *
 736          * @param $policy string Either 'index' or 'noindex'.
 737          * @return null
 738          */
 739         public function setIndexPolicy( $policy ) {
 740                 $policy = trim( $policy );
 741                 if( in_array( $policy, array( 'index', 'noindex' ) ) ) {
 742                         $this->mIndexPolicy = $policy;
 743                 }
 744         }
 745
 746         /**
 747          * Set the follow policy for the page, but leave the index policy un-
 748          * touched.
 749          *
 750          * @param $policy String: either 'follow' or 'nofollow'.
 751          * @return null
 752          */
 753         public function setFollowPolicy( $policy ) {
 754                 $policy = trim( $policy );
 755                 if( in_array( $policy, array( 'follow', 'nofollow' ) ) ) {
 756                         $this->mFollowPolicy = $policy;
 757                 }
 758         }
 759
 760         /**
 761          * Set the new value of the "action text", this will be added to the
 762          * "HTML title", separated from it with " - ".
 763          *
 764          * @param $text String: new value of the "action text"
 765          */
 766         public function setPageTitleActionText( $text ) {
 767                 $this->mPageTitleActionText = $text;
 768         }
 769
 770         /**
 771          * Get the value of the "action text"
 772          *
 773          * @return String
 774          */
 775         public function getPageTitleActionText() {
 776                 if ( isset( $this->mPageTitleActionText ) ) {
 777                         return $this->mPageTitleActionText;
 778                 }
 779         }
 780
 781         /**
 782          * "HTML title" means the contents of <title>.
 783          * It is stored as plain, unescaped text and will be run through htmlspecialchars in the skin file.
 784          *
 785          * @param $name string
 786          */
 787         public function setHTMLTitle( $name ) {
 788                 if ( $name instanceof Message ) {
 789                         $this->mHTMLtitle = $name->setContext( $this->getContext() )->text();
 790                 } else {
 791                         $this->mHTMLtitle = $name;
 792                 }
 793         }
 794
 795         /**
 796          * Return the "HTML title", i.e. the content of the <title> tag.
 797          *
 798          * @return String
 799          */
 800         public function getHTMLTitle() {
 801                 return $this->mHTMLtitle;
 802         }
 803
 804         /**
 805          * Set $mRedirectedFrom, the Title of the page which redirected us to the current page.
 806          *
 807          * param @t Title
 808          */
 809         public function setRedirectedFrom( $t ) {
 810                 $this->mRedirectedFrom = $t;
 811         }
 812
 813         /**
 814          * "Page title" means the contents of \<h1\>. It is stored as a valid HTML fragment.
 815          * This function allows good tags like \<sup\> in the \<h1\> tag, but not bad tags like \<script\>.
 816          * This function automatically sets \<title\> to the same content as \<h1\> but with all tags removed.
 817          * Bad tags that were escaped in \<h1\> will still be escaped in \<title\>, and good tags like \<i\> will be dropped entirely.
 818          *
 819          * @param $name string|Message
 820          */
 821         public function setPageTitle( $name ) {
 822                 if ( $name instanceof Message ) {
 823                         $name = $name->setContext( $this->getContext() )->text();
 824                 }
 825
 826                 # change "<script>foo&bar</script>" to "&lt;script&gt;foo&amp;bar&lt;/script&gt;"
 827                 # but leave "<i>foobar</i>" alone
 828                 $nameWithTags = Sanitizer::normalizeCharReferences( Sanitizer::removeHTMLtags( $name ) );
 829                 $this->mPagetitle = $nameWithTags;
 830
 831                 # change "<i>foo&amp;bar</i>" to "foo&bar"
 832                 $this->setHTMLTitle( $this->msg( 'pagetitle' )->rawParams( Sanitizer::stripAllTags( $nameWithTags ) ) );
 833         }
 834
 835         /**
 836          * Return the "page title", i.e. the content of the \<h1\> tag.
 837          *
 838          * @return String
 839          */
 840         public function getPageTitle() {
 841                 return $this->mPagetitle;
 842         }
 843
 844         /**
 845          * Set the Title object to use
 846          *
 847          * @param $t Title object
 848          */
 849         public function setTitle( Title $t ) {
 850                 $this->getContext()->setTitle( $t );
 851         }
 852
 853
 854         /**
 855          * Replace the subtile with $str
 856          *
 857          * @param $str String|Message: new value of the subtitle
 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
 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          * Add $text to the debug output
1318          *
1319          * @param $text String: debug text
1320          */
1321         public function debug( $text ) {
1322                 $this->mDebugtext .= $text;
1323         }
1324
1325         /**
1326          * Get/set the ParserOptions object to use for wikitext parsing
1327          *
1328          * @param $options ParserOptions|null either the ParserOption to use or null to only get the
1329          *                 current ParserOption object
1330          * @return ParserOptions object
1331          */
1332         public function parserOptions( $options = null ) {
1333                 if ( !$this->mParserOptions ) {
1334                         $this->mParserOptions = ParserOptions::newFromContext( $this->getContext() );
1335                         $this->mParserOptions->setEditSection( false );
1336                 }
1337                 return wfSetVar( $this->mParserOptions, $options );
1338         }
1339
1340         /**
1341          * Set the revision ID which will be seen by the wiki text parser
1342          * for things such as embedded {{REVISIONID}} variable use.
1343          *
1344          * @param $revid Mixed: an positive integer, or null
1345          * @return Mixed: previous value
1346          */
1347         public function setRevisionId( $revid ) {
1348                 $val = is_null( $revid ) ? null : intval( $revid );
1349                 return wfSetVar( $this->mRevisionId, $val );
1350         }
1351
1352         /**
1353          * Get the displayed revision ID
1354          *
1355          * @return Integer
1356          */
1357         public function getRevisionId() {
1358                 return $this->mRevisionId;
1359         }
1360
1361         /**
1362          * Set the timestamp of the revision which will be displayed. This is used
1363          * to avoid a extra DB call in Skin::lastModified().
1364          *
1365          * @param $revid Mixed: string, or null
1366          * @return Mixed: previous value
1367          */
1368         public function setRevisionTimestamp( $timestmap ) {
1369                 return wfSetVar( $this->mRevisionTimestamp, $timestmap );
1370         }
1371
1372         /**
1373          * Get the timestamp of displayed revision.
1374          * This will be null if not filled by setRevisionTimestamp().
1375          *
1376          * @return String or null
1377          */
1378         public function getRevisionTimestamp() {
1379                 return $this->mRevisionTimestamp;
1380         }
1381
1382         /**
1383          * Set the displayed file version
1384          *
1385          * @param $file File|bool
1386          * @return Mixed: previous value
1387          */
1388         public function setFileVersion( $file ) {
1389                 $val = null;
1390                 if ( $file instanceof File && $file->exists() ) {
1391                         $val = array( 'time' => $file->getTimestamp(), 'sha1' => $file->getSha1() );
1392                 }
1393                 return wfSetVar( $this->mFileVersion, $val, true );
1394         }
1395
1396         /**
1397          * Get the displayed file version
1398          *
1399          * @return Array|null ('time' => MW timestamp, 'sha1' => sha1)
1400          */
1401         public function getFileVersion() {
1402                 return $this->mFileVersion;
1403         }
1404
1405         /**
1406          * Get the templates used on this page
1407          *
1408          * @return Array (namespace => dbKey => revId)
1409          * @since 1.18
1410          */
1411         public function getTemplateIds() {
1412                 return $this->mTemplateIds;
1413         }
1414
1415         /**
1416          * Get the files used on this page
1417          *
1418          * @return Array (dbKey => array('time' => MW timestamp or null, 'sha1' => sha1 or ''))
1419          * @since 1.18
1420          */
1421         public function getFileSearchOptions() {
1422                 return $this->mImageTimeKeys;
1423         }
1424
1425         /**
1426          * Convert wikitext to HTML and add it to the buffer
1427          * Default assumes that the current page title will be used.
1428          *
1429          * @param $text String
1430          * @param $linestart Boolean: is this the start of a line?
1431          * @param $interface Boolean: is this text in the user interface language?
1432          */
1433         public function addWikiText( $text, $linestart = true, $interface = true ) {
1434                 $title = $this->getTitle(); // Work arround E_STRICT
1435                 $this->addWikiTextTitle( $text, $title, $linestart, /*tidy*/false, $interface );
1436         }
1437
1438         /**
1439          * Add wikitext with a custom Title object
1440          *
1441          * @param $text String: wikitext
1442          * @param $title Title object
1443          * @param $linestart Boolean: is this the start of a line?
1444          */
1445         public function addWikiTextWithTitle( $text, &$title, $linestart = true ) {
1446                 $this->addWikiTextTitle( $text, $title, $linestart );
1447         }
1448
1449         /**
1450          * Add wikitext with a custom Title object and tidy enabled.
1451          *
1452          * @param $text String: wikitext
1453          * @param $title Title object
1454          * @param $linestart Boolean: is this the start of a line?
1455          */
1456         function addWikiTextTitleTidy( $text, &$title, $linestart = true ) {
1457                 $this->addWikiTextTitle( $text, $title, $linestart, true );
1458         }
1459
1460         /**
1461          * Add wikitext with tidy enabled
1462          *
1463          * @param $text String: wikitext
1464          * @param $linestart Boolean: is this the start of a line?
1465          */
1466         public function addWikiTextTidy( $text, $linestart = true ) {
1467                 $title = $this->getTitle();
1468                 $this->addWikiTextTitleTidy( $text, $title, $linestart );
1469         }
1470
1471         /**
1472          * Add wikitext with a custom Title object
1473          *
1474          * @param $text String: wikitext
1475          * @param $title Title object
1476          * @param $linestart Boolean: is this the start of a line?
1477          * @param $tidy Boolean: whether to use tidy
1478          * @param $interface Boolean: whether it is an interface message
1479          *                                                              (for example disables conversion)
1480          */
1481         public function addWikiTextTitle( $text, &$title, $linestart, $tidy = false, $interface = false ) {
1482                 global $wgParser;
1483
1484                 wfProfileIn( __METHOD__ );
1485
1486                 $popts = $this->parserOptions();
1487                 $oldTidy = $popts->setTidy( $tidy );
1488                 $popts->setInterfaceMessage( (bool) $interface );
1489
1490                 $parserOutput = $wgParser->parse(
1491                         $text, $title, $popts,
1492                         $linestart, true, $this->mRevisionId
1493                 );
1494
1495                 $popts->setTidy( $oldTidy );
1496
1497                 $this->addParserOutput( $parserOutput );
1498
1499                 wfProfileOut( __METHOD__ );
1500         }
1501
1502         /**
1503          * Add a ParserOutput object, but without Html
1504          *
1505          * @param $parserOutput ParserOutput object
1506          */
1507         public function addParserOutputNoText( &$parserOutput ) {
1508                 $this->mLanguageLinks += $parserOutput->getLanguageLinks();
1509                 $this->addCategoryLinks( $parserOutput->getCategories() );
1510                 $this->mNewSectionLink = $parserOutput->getNewSection();
1511                 $this->mHideNewSectionLink = $parserOutput->getHideNewSection();
1512
1513                 $this->mParseWarnings = $parserOutput->getWarnings();
1514                 if ( !$parserOutput->isCacheable() ) {
1515                         $this->enableClientCache( false );
1516                 }
1517                 $this->mNoGallery = $parserOutput->getNoGallery();
1518                 $this->mHeadItems = array_merge( $this->mHeadItems, $parserOutput->getHeadItems() );
1519                 $this->addModules( $parserOutput->getModules() );
1520                 $this->addModuleScripts( $parserOutput->getModuleScripts() );
1521                 $this->addModuleStyles( $parserOutput->getModuleStyles() );
1522                 $this->addModuleMessages( $parserOutput->getModuleMessages() );
1523
1524                 // Template versioning...
1525                 foreach ( (array)$parserOutput->getTemplateIds() as $ns => $dbks ) {
1526                         if ( isset( $this->mTemplateIds[$ns] ) ) {
1527                                 $this->mTemplateIds[$ns] = $dbks + $this->mTemplateIds[$ns];
1528                         } else {
1529                                 $this->mTemplateIds[$ns] = $dbks;
1530                         }
1531                 }
1532                 // File versioning...
1533                 foreach ( (array)$parserOutput->getFileSearchOptions() as $dbk => $data ) {
1534                         $this->mImageTimeKeys[$dbk] = $data;
1535                 }
1536
1537                 // Hooks registered in the object
1538                 global $wgParserOutputHooks;
1539                 foreach ( $parserOutput->getOutputHooks() as $hookInfo ) {
1540                         list( $hookName, $data ) = $hookInfo;
1541                         if ( isset( $wgParserOutputHooks[$hookName] ) ) {
1542                                 call_user_func( $wgParserOutputHooks[$hookName], $this, $parserOutput, $data );
1543                         }
1544                 }
1545
1546                 wfRunHooks( 'OutputPageParserOutput', array( &$this, $parserOutput ) );
1547         }
1548
1549         /**
1550          * Add a ParserOutput object
1551          *
1552          * @param $parserOutput ParserOutput
1553          */
1554         function addParserOutput( &$parserOutput ) {
1555                 $this->addParserOutputNoText( $parserOutput );
1556                 $text = $parserOutput->getText();
1557                 wfRunHooks( 'OutputPageBeforeHTML', array( &$this, &$text ) );
1558                 $this->addHTML( $text );
1559         }
1560
1561
1562         /**
1563          * Add the output of a QuickTemplate to the output buffer
1564          *
1565          * @param $template QuickTemplate
1566          */
1567         public function addTemplate( &$template ) {
1568                 ob_start();
1569                 $template->execute();
1570                 $this->addHTML( ob_get_contents() );
1571                 ob_end_clean();
1572         }
1573
1574         /**
1575          * Parse wikitext and return the HTML.
1576          *
1577          * @param $text String
1578          * @param $linestart Boolean: is this the start of a line?
1579          * @param $interface Boolean: use interface language ($wgLang instead of
1580          *                   $wgContLang) while parsing language sensitive magic
1581          *                   words like GRAMMAR and PLURAL. This also disables
1582          *                                       LanguageConverter.
1583          * @param $language  Language object: target language object, will override
1584          *                   $interface
1585          * @return String: HTML
1586          */
1587         public function parse( $text, $linestart = true, $interface = false, $language = null ) {
1588                 global $wgParser;
1589
1590                 if( is_null( $this->getTitle() ) ) {
1591                         throw new MWException( 'Empty $mTitle in ' . __METHOD__ );
1592                 }
1593
1594                 $popts = $this->parserOptions();
1595                 if ( $interface ) {
1596                         $popts->setInterfaceMessage( true );
1597                 }
1598                 if ( $language !== null ) {
1599                         $oldLang = $popts->setTargetLanguage( $language );
1600                 }
1601
1602                 $parserOutput = $wgParser->parse(
1603                         $text, $this->getTitle(), $popts,
1604                         $linestart, true, $this->mRevisionId
1605                 );
1606
1607                 if ( $interface ) {
1608                         $popts->setInterfaceMessage( false );
1609                 }
1610                 if ( $language !== null ) {
1611                         $popts->setTargetLanguage( $oldLang );
1612                 }
1613
1614                 return $parserOutput->getText();
1615         }
1616
1617         /**
1618          * Parse wikitext, strip paragraphs, and return the HTML.
1619          *
1620          * @param $text String
1621          * @param $linestart Boolean: is this the start of a line?
1622          * @param $interface Boolean: use interface language ($wgLang instead of
1623          *                   $wgContLang) while parsing language sensitive magic
1624          *                   words like GRAMMAR and PLURAL
1625          * @return String: HTML
1626          */
1627         public function parseInline( $text, $linestart = true, $interface = false ) {
1628                 $parsed = $this->parse( $text, $linestart, $interface );
1629
1630                 $m = array();
1631                 if ( preg_match( '/^<p>(.*)\n?<\/p>\n?/sU', $parsed, $m ) ) {
1632                         $parsed = $m[1];
1633                 }
1634
1635                 return $parsed;
1636         }
1637
1638         /**
1639          * Set the value of the "s-maxage" part of the "Cache-control" HTTP header
1640          *
1641          * @param $maxage Integer: maximum cache time on the Squid, in seconds.
1642          */
1643         public function setSquidMaxage( $maxage ) {
1644                 $this->mSquidMaxage = $maxage;
1645         }
1646
1647         /**
1648          * Use enableClientCache(false) to force it to send nocache headers
1649          *
1650          * @param $state bool
1651          *
1652          * @return bool
1653          */
1654         public function enableClientCache( $state ) {
1655                 return wfSetVar( $this->mEnableClientCache, $state );
1656         }
1657
1658         /**
1659          * Get the list of cookies that will influence on the cache
1660          *
1661          * @return Array
1662          */
1663         function getCacheVaryCookies() {
1664                 global $wgCookiePrefix, $wgCacheVaryCookies;
1665                 static $cookies;
1666                 if ( $cookies === null ) {
1667                         $cookies = array_merge(
1668                                 array(
1669                                         "{$wgCookiePrefix}Token",
1670                                         "{$wgCookiePrefix}LoggedOut",
1671                                         session_name()
1672                                 ),
1673                                 $wgCacheVaryCookies
1674                         );
1675                         wfRunHooks( 'GetCacheVaryCookies', array( $this, &$cookies ) );
1676                 }
1677                 return $cookies;
1678         }
1679
1680         /**
1681          * Check if the request has a cache-varying cookie header
1682          * If it does, it's very important that we don't allow public caching
1683          *
1684          * @return Boolean
1685          */
1686         function haveCacheVaryCookies() {
1687                 $cookieHeader = $this->getRequest()->getHeader( 'cookie' );
1688                 if ( $cookieHeader === false ) {
1689                         return false;
1690                 }
1691                 $cvCookies = $this->getCacheVaryCookies();
1692                 foreach ( $cvCookies as $cookieName ) {
1693                         # Check for a simple string match, like the way squid does it
1694                         if ( strpos( $cookieHeader, $cookieName ) !== false ) {
1695                                 wfDebug( __METHOD__ . ": found $cookieName\n" );
1696                                 return true;
1697                         }
1698                 }
1699                 wfDebug( __METHOD__ . ": no cache-varying cookies found\n" );
1700                 return false;
1701         }
1702
1703         /**
1704          * Add an HTTP header that will influence on the cache
1705          *
1706          * @param $header String: header name
1707          * @param $option Array|null
1708          * @todo FIXME: Document the $option parameter; it appears to be for
1709          *        X-Vary-Options but what format is acceptable?
1710          */
1711         public function addVaryHeader( $header, $option = null ) {
1712                 if ( !array_key_exists( $header, $this->mVaryHeader ) ) {
1713                         $this->mVaryHeader[$header] = (array)$option;
1714                 } elseif( is_array( $option ) ) {
1715                         if( is_array( $this->mVaryHeader[$header] ) ) {
1716                                 $this->mVaryHeader[$header] = array_merge( $this->mVaryHeader[$header], $option );
1717                         } else {
1718                                 $this->mVaryHeader[$header] = $option;
1719                         }
1720                 }
1721                 $this->mVaryHeader[$header] = array_unique( (array)$this->mVaryHeader[$header] );
1722         }
1723
1724         /**
1725          * Return a Vary: header on which to vary caches. Based on the keys of $mVaryHeader,
1726          * such as Accept-Encoding or Cookie
1727          *
1728          * @return String
1729          */
1730         public function getVaryHeader() {
1731                 return 'Vary: ' . join( ', ', array_keys( $this->mVaryHeader ) );
1732         }
1733
1734         /**
1735          * Get a complete X-Vary-Options header
1736          *
1737          * @return String
1738          */
1739         public function getXVO() {
1740                 $cvCookies = $this->getCacheVaryCookies();
1741
1742                 $cookiesOption = array();
1743                 foreach ( $cvCookies as $cookieName ) {
1744                         $cookiesOption[] = 'string-contains=' . $cookieName;
1745                 }
1746                 $this->addVaryHeader( 'Cookie', $cookiesOption );
1747
1748                 $headers = array();
1749                 foreach( $this->mVaryHeader as $header => $option ) {
1750                         $newheader = $header;
1751                         if ( is_array( $option ) && count( $option ) > 0 ) {
1752                                 $newheader .= ';' . implode( ';', $option );
1753                         }
1754                         $headers[] = $newheader;
1755                 }
1756                 $xvo = 'X-Vary-Options: ' . implode( ',', $headers );
1757
1758                 return $xvo;
1759         }
1760
1761         /**
1762          * bug 21672: Add Accept-Language to Vary and XVO headers
1763          * if there's no 'variant' parameter existed in GET.
1764          *
1765          * For example:
1766          *   /w/index.php?title=Main_page should always be served; but
1767          *   /w/index.php?title=Main_page&variant=zh-cn should never be served.
1768          */
1769         function addAcceptLanguage() {
1770                 $lang = $this->getTitle()->getPageLanguage();
1771                 if( !$this->getRequest()->getCheck( 'variant' ) && $lang->hasVariants() ) {
1772                         $variants = $lang->getVariants();
1773                         $aloption = array();
1774                         foreach ( $variants as $variant ) {
1775                                 if( $variant === $lang->getCode() ) {
1776                                         continue;
1777                                 } else {
1778                                         $aloption[] = 'string-contains=' . $variant;
1779
1780                                         // IE and some other browsers use another form of language code
1781                                         // in their Accept-Language header, like "zh-CN" or "zh-TW".
1782                                         // We should handle these too.
1783                                         $ievariant = explode( '-', $variant );
1784                                         if ( count( $ievariant ) == 2 ) {
1785                                                 $ievariant[1] = strtoupper( $ievariant[1] );
1786                                                 $ievariant = implode( '-', $ievariant );
1787                                                 $aloption[] = 'string-contains=' . $ievariant;
1788                                         }
1789                                 }
1790                         }
1791                         $this->addVaryHeader( 'Accept-Language', $aloption );
1792                 }
1793         }
1794
1795         /**
1796          * Set a flag which will cause an X-Frame-Options header appropriate for
1797          * edit pages to be sent. The header value is controlled by
1798          * $wgEditPageFrameOptions.
1799          *
1800          * This is the default for special pages. If you display a CSRF-protected
1801          * form on an ordinary view page, then you need to call this function.
1802          *
1803          * @param $enable bool
1804          */
1805         public function preventClickjacking( $enable = true ) {
1806                 $this->mPreventClickjacking = $enable;
1807         }
1808
1809         /**
1810          * Turn off frame-breaking. Alias for $this->preventClickjacking(false).
1811          * This can be called from pages which do not contain any CSRF-protected
1812          * HTML form.
1813          */
1814         public function allowClickjacking() {
1815                 $this->mPreventClickjacking = false;
1816         }
1817
1818         /**
1819          * Get the X-Frame-Options header value (without the name part), or false
1820          * if there isn't one. This is used by Skin to determine whether to enable
1821          * JavaScript frame-breaking, for clients that don't support X-Frame-Options.
1822          *
1823          * @return string
1824          */
1825         public function getFrameOptions() {
1826                 global $wgBreakFrames, $wgEditPageFrameOptions;
1827                 if ( $wgBreakFrames ) {
1828                         return 'DENY';
1829                 } elseif ( $this->mPreventClickjacking && $wgEditPageFrameOptions ) {
1830                         return $wgEditPageFrameOptions;
1831                 }
1832                 return false;
1833         }
1834
1835         /**
1836          * Send cache control HTTP headers
1837          */
1838         public function sendCacheControl() {
1839                 global $wgUseSquid, $wgUseESI, $wgUseETag, $wgSquidMaxage, $wgUseXVO;
1840
1841                 $response = $this->getRequest()->response();
1842                 if ( $wgUseETag && $this->mETag ) {
1843                         $response->header( "ETag: $this->mETag" );
1844                 }
1845
1846                 $this->addVaryHeader( 'Cookie' );
1847                 $this->addAcceptLanguage();
1848
1849                 # don't serve compressed data to clients who can't handle it
1850                 # maintain different caches for logged-in users and non-logged in ones
1851                 $response->header( $this->getVaryHeader() );
1852
1853                 if ( $wgUseXVO ) {
1854                         # Add an X-Vary-Options header for Squid with Wikimedia patches
1855                         $response->header( $this->getXVO() );
1856                 }
1857
1858                 if( $this->mEnableClientCache ) {
1859                         if(
1860                                 $wgUseSquid && session_id() == '' && !$this->isPrintable() &&
1861                                 $this->mSquidMaxage != 0 && !$this->haveCacheVaryCookies()
1862                         )
1863                         {
1864                                 if ( $wgUseESI ) {
1865                                         # We'll purge the proxy cache explicitly, but require end user agents
1866                                         # to revalidate against the proxy on each visit.
1867                                         # Surrogate-Control controls our Squid, Cache-Control downstream caches
1868                                         wfDebug( __METHOD__ . ": proxy caching with ESI; {$this->mLastModified} **\n", false );
1869                                         # start with a shorter timeout for initial testing
1870                                         # header( 'Surrogate-Control: max-age=2678400+2678400, content="ESI/1.0"');
1871                                         $response->header( 'Surrogate-Control: max-age='.$wgSquidMaxage.'+'.$this->mSquidMaxage.', content="ESI/1.0"');
1872                                         $response->header( 'Cache-Control: s-maxage=0, must-revalidate, max-age=0' );
1873                                 } else {
1874                                         # We'll purge the proxy cache for anons explicitly, but require end user agents
1875                                         # to revalidate against the proxy on each visit.
1876                                         # IMPORTANT! The Squid needs to replace the Cache-Control header with
1877                                         # Cache-Control: s-maxage=0, must-revalidate, max-age=0
1878                                         wfDebug( __METHOD__ . ": local proxy caching; {$this->mLastModified} **\n", false );
1879                                         # start with a shorter timeout for initial testing
1880                                         # header( "Cache-Control: s-maxage=2678400, must-revalidate, max-age=0" );
1881                                         $response->header( 'Cache-Control: s-maxage='.$this->mSquidMaxage.', must-revalidate, max-age=0' );
1882                                 }
1883                         } else {
1884                                 # We do want clients to cache if they can, but they *must* check for updates
1885                                 # on revisiting the page.
1886                                 wfDebug( __METHOD__ . ": private caching; {$this->mLastModified} **\n", false );
1887                                 $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
1888                                 $response->header( "Cache-Control: private, must-revalidate, max-age=0" );
1889                         }
1890                         if($this->mLastModified) {
1891                                 $response->header( "Last-Modified: {$this->mLastModified}" );
1892                         }
1893                 } else {
1894                         wfDebug( __METHOD__ . ": no caching **\n", false );
1895
1896                         # In general, the absence of a last modified header should be enough to prevent
1897                         # the client from using its cache. We send a few other things just to make sure.
1898                         $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
1899                         $response->header( 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate' );
1900                         $response->header( 'Pragma: no-cache' );
1901                 }
1902         }
1903
1904         /**
1905          * Get the message associed with the HTTP response code $code
1906          *
1907          * @param $code Integer: status code
1908          * @return String or null: message or null if $code is not in the list of
1909          *         messages
1910          *
1911          * @deprecated since 1.18 Use HttpStatus::getMessage() instead.
1912          */
1913         public static function getStatusMessage( $code ) {
1914                 wfDeprecated( __METHOD__ );
1915                 return HttpStatus::getMessage( $code );
1916         }
1917
1918         /**
1919          * Finally, all the text has been munged and accumulated into
1920          * the object, let's actually output it:
1921          */
1922         public function output() {
1923                 global $wgLanguageCode, $wgDebugRedirects, $wgMimeType, $wgVaryOnXFP;
1924
1925                 if( $this->mDoNothing ) {
1926                         return;
1927                 }
1928
1929                 wfProfileIn( __METHOD__ );
1930
1931                 $response = $this->getRequest()->response();
1932
1933                 if ( $this->mRedirect != '' ) {
1934                         # Standards require redirect URLs to be absolute
1935                         $this->mRedirect = wfExpandUrl( $this->mRedirect, PROTO_CURRENT );
1936
1937                         $redirect = $this->mRedirect;
1938                         $code = $this->mRedirectCode;
1939
1940                         if( wfRunHooks( "BeforePageRedirect", array( $this, &$redirect, &$code ) ) ) {
1941                                 if( $code == '301' || $code == '303' ) {
1942                                         if( !$wgDebugRedirects ) {
1943                                                 $message = HttpStatus::getMessage( $code );
1944                                                 $response->header( "HTTP/1.1 $code $message" );
1945                                         }
1946                                         $this->mLastModified = wfTimestamp( TS_RFC2822 );
1947                                 }
1948                                 if ( $wgVaryOnXFP ) {
1949                                         $this->addVaryHeader( 'X-Forwarded-Proto' );
1950                                 }
1951                                 $this->sendCacheControl();
1952
1953                                 $response->header( "Content-Type: text/html; charset=utf-8" );
1954                                 if( $wgDebugRedirects ) {
1955                                         $url = htmlspecialchars( $redirect );
1956                                         print "<html>\n<head>\n<title>Redirect</title>\n</head>\n<body>\n";
1957                                         print "<p>Location: <a href=\"$url\">$url</a></p>\n";
1958                                         print "</body>\n</html>\n";
1959                                 } else {
1960                                         $response->header( 'Location: ' . $redirect );
1961                                 }
1962                         }
1963
1964                         wfProfileOut( __METHOD__ );
1965                         return;
1966                 } elseif ( $this->mStatusCode ) {
1967                         $message = HttpStatus::getMessage( $this->mStatusCode );
1968                         if ( $message ) {
1969                                 $response->header( 'HTTP/1.1 ' . $this->mStatusCode . ' ' . $message );
1970                         }
1971                 }
1972
1973                 # Buffer output; final headers may depend on later processing
1974                 ob_start();
1975
1976                 $response->header( "Content-type: $wgMimeType; charset=UTF-8" );
1977                 $response->header( 'Content-language: ' . $wgLanguageCode );
1978
1979                 // Prevent framing, if requested
1980                 $frameOptions = $this->getFrameOptions();
1981                 if ( $frameOptions ) {
1982                         $response->header( "X-Frame-Options: $frameOptions" );
1983                 }
1984
1985                 if ( $this->mArticleBodyOnly ) {
1986                         $this->out( $this->mBodytext );
1987                 } else {
1988                         $this->addDefaultModules();
1989
1990                         $sk = $this->getSkin();
1991
1992                         // Hook that allows last minute changes to the output page, e.g.
1993                         // adding of CSS or Javascript by extensions.
1994                         wfRunHooks( 'BeforePageDisplay', array( &$this, &$sk ) );
1995
1996                         wfProfileIn( 'Output-skin' );
1997                         $sk->outputPage();
1998                         wfProfileOut( 'Output-skin' );
1999                 }
2000
2001                 $this->sendCacheControl();
2002                 ob_end_flush();
2003                 wfProfileOut( __METHOD__ );
2004         }
2005
2006         /**
2007          * Actually output something with print().
2008          *
2009          * @param $ins String: the string to output
2010          */
2011         public function out( $ins ) {
2012                 print $ins;
2013         }
2014
2015         /**
2016          * Produce a "user is blocked" page.
2017          * @deprecated since 1.18
2018          */
2019         function blockedPage() {
2020                 throw new UserBlockedError( $this->getUser()->mBlock );
2021         }
2022
2023         /**
2024          * Prepare this object to display an error page; disable caching and
2025          * indexing, clear the current text and redirect, set the page's title
2026          * and optionally an custom HTML title (content of the <title> tag).
2027          *
2028          * @param $pageTitle String|Message will be passed directly to setPageTitle()
2029          * @param $htmlTitle String|Message will be passed directly to setHTMLTitle();
2030          *                   optional, if not passed the <title> attribute will be
2031          *                   based on $pageTitle
2032          */
2033         public function prepareErrorPage( $pageTitle, $htmlTitle = false ) {
2034                 if ( $this->getTitle() ) {
2035                         $this->mDebugtext .= 'Original title: ' . $this->getTitle()->getPrefixedText() . "\n";
2036                 }
2037
2038                 $this->setPageTitle( $pageTitle );
2039                 if ( $htmlTitle !== false ) {
2040                         $this->setHTMLTitle( $htmlTitle );
2041                 }
2042                 $this->setRobotPolicy( 'noindex,nofollow' );
2043                 $this->setArticleRelated( false );
2044                 $this->enableClientCache( false );
2045                 $this->mRedirect = '';
2046                 $this->clearSubtitle();
2047                 $this->clearHTML();
2048         }
2049
2050         /**
2051          * Output a standard error page
2052          *
2053          * showErrorPage( 'titlemsg', 'pagetextmsg', array( 'param1', 'param2' ) );
2054          * showErrorPage( 'titlemsg', $messageObject );
2055          *
2056          * @param $title String: message key for page title
2057          * @param $msg Mixed: message key (string) for page text, or a Message object
2058          * @param $params Array: message parameters; ignored if $msg is a Message object
2059          */
2060         public function showErrorPage( $title, $msg, $params = array() ) {
2061                 $this->prepareErrorPage( $this->msg( $title ), $this->msg( 'errorpagetitle' ) );
2062
2063                 if ( $msg instanceof Message ){
2064                         $this->addHTML( $msg->parse() );
2065                 } else {
2066                         $this->addWikiMsgArray( $msg, $params );
2067                 }
2068
2069                 $this->returnToMain();
2070         }
2071
2072         /**
2073          * Output a standard permission error page
2074          *
2075          * @param $errors Array: error message keys
2076          * @param $action String: action that was denied or null if unknown
2077          */
2078         public function showPermissionsErrorPage( $errors, $action = null ) {
2079                 global $wgGroupPermissions;
2080
2081                 // For some action (read, edit, create and upload), display a "login to do this action"
2082                 // error if all of the following conditions are met:
2083                 // 1. the user is not logged in
2084                 // 2. the only error is insufficient permissions (i.e. no block or something else)
2085                 // 3. the error can be avoided simply by logging in
2086                 if ( in_array( $action, array( 'read', 'edit', 'createpage', 'createtalk', 'upload' ) )
2087                         && $this->getUser()->isAnon() && count( $errors ) == 1 && isset( $errors[0][0] )
2088                         && ( $errors[0][0] == 'badaccess-groups' || $errors[0][0] == 'badaccess-group0' )
2089                         && ( ( isset( $wgGroupPermissions['user'][$action] ) && $wgGroupPermissions['user'][$action] )
2090                         || ( isset( $wgGroupPermissions['autoconfirmed'][$action] ) && $wgGroupPermissions['autoconfirmed'][$action] ) )
2091                 ) {
2092                         $displayReturnto = null;
2093
2094                         # Due to bug 32276, if a user does not have read permissions,
2095                         # $this->getTitle() will just give Special:Badtitle, which is
2096                         # not especially useful as a returnto parameter. Use the title
2097                         # from the request instead, if there was one.
2098                         $request = $this->getRequest();
2099                         $returnto = Title::newFromURL( $request->getVal( 'title', '' ) );
2100                         if ( $action == 'edit' ) {
2101                                 $msg = 'whitelistedittext';
2102                                 $displayReturnto = $returnto;
2103                         } elseif ( $action == 'createpage' || $action == 'createtalk' ) {
2104                                 $msg = 'nocreatetext';
2105                         } elseif ( $action == 'upload' ) {
2106                                 $msg = 'uploadnologintext';
2107                         } else { # Read
2108                                 $msg = 'loginreqpagetext';
2109                                 $displayReturnto = Title::newMainPage();
2110                         }
2111
2112                         $query = array();
2113
2114                         if ( $returnto ) {
2115                                 $query['returnto'] = $returnto->getPrefixedText();
2116
2117                                 if ( !$request->wasPosted() ) {
2118                                         $returntoquery = $request->getValues();
2119                                         unset( $returntoquery['title'] );
2120                                         unset( $returntoquery['returnto'] );
2121                                         unset( $returntoquery['returntoquery'] );
2122                                         $query['returntoquery'] = wfArrayToCGI( $returntoquery );
2123                                 }
2124                         }
2125                         $loginLink = Linker::linkKnown(
2126                                 SpecialPage::getTitleFor( 'Userlogin' ),
2127                                 $this->msg( 'loginreqlink' )->escaped(),
2128                                 array(),
2129                                 $query
2130                         );
2131
2132                         $this->prepareErrorPage( $this->msg( 'loginreqtitle' ) );
2133                         $this->addHTML( $this->msg( $msg )->rawParams( $loginLink )->parse() );
2134
2135                         # Don't return to a page the user can't read otherwise
2136                         # we'll end up in a pointless loop
2137                         if ( $displayReturnto && $displayReturnto->userCan( 'read', $this->getUser() ) ) {
2138                                 $this->returnToMain( null, $displayReturnto );
2139                         }
2140                 } else {
2141                         $this->prepareErrorPage( $this->msg( 'permissionserrors' ) );
2142                         $this->addWikiText( $this->formatPermissionsErrorMessage( $errors, $action ) );
2143                 }
2144         }
2145
2146         /**
2147          * Display an error page indicating that a given version of MediaWiki is
2148          * required to use it
2149          *
2150          * @param $version Mixed: the version of MediaWiki needed to use the page
2151          */
2152         public function versionRequired( $version ) {
2153                 $this->prepareErrorPage( $this->msg( 'versionrequired', $version ) );
2154
2155                 $this->addWikiMsg( 'versionrequiredtext', $version );
2156                 $this->returnToMain();
2157         }
2158
2159         /**
2160          * Display an error page noting that a given permission bit is required.
2161          * @deprecated since 1.18, just throw the exception directly
2162          * @param $permission String: key required
2163          */
2164         public function permissionRequired( $permission ) {
2165                 throw new PermissionsError( $permission );
2166         }
2167
2168         /**
2169          * Produce the stock "please login to use the wiki" page
2170          *
2171          * @deprecated in 1.19; throw the exception directly
2172          */
2173         public function loginToUse() {
2174                 throw new PermissionsError( 'read' );
2175         }
2176
2177         /**
2178          * Format a list of error messages
2179          *
2180          * @param $errors Array of arrays returned by Title::getUserPermissionsErrors
2181          * @param $action String: action that was denied or null if unknown
2182          * @return String: the wikitext error-messages, formatted into a list.
2183          */
2184         public function formatPermissionsErrorMessage( $errors, $action = null ) {
2185                 if ( $action == null ) {
2186                         $text = $this->msg( 'permissionserrorstext', count( $errors ) )->plain() . "\n\n";
2187                 } else {
2188                         $action_desc = $this->msg( "action-$action" )->plain();
2189                         $text = $this->msg(
2190                                 'permissionserrorstext-withaction',
2191                                 count( $errors ),
2192                                 $action_desc
2193                         )->plain() . "\n\n";
2194                 }
2195
2196                 if ( count( $errors ) > 1 ) {
2197                         $text .= '<ul class="permissions-errors">' . "\n";
2198
2199                         foreach( $errors as $error ) {
2200                                 $text .= '<li>';
2201                                 $text .= call_user_func_array( array( $this, 'msg' ), $error )->plain();
2202                                 $text .= "</li>\n";
2203                         }
2204                         $text .= '</ul>';
2205                 } else {
2206                         $text .= "<div class=\"permissions-errors\">\n" .
2207                                         call_user_func_array( array( $this, 'msg' ), reset( $errors ) )->plain() .
2208                                         "\n</div>";
2209                 }
2210
2211                 return $text;
2212         }
2213
2214         /**
2215          * Display a page stating that the Wiki is in read-only mode,
2216          * and optionally show the source of the page that the user
2217          * was trying to edit.  Should only be called (for this
2218          * purpose) after wfReadOnly() has returned true.
2219          *
2220          * For historical reasons, this function is _also_ used to
2221          * show the error message when a user tries to edit a page
2222          * they are not allowed to edit.  (Unless it's because they're
2223          * blocked, then we show blockedPage() instead.)  In this
2224          * case, the second parameter should be set to true and a list
2225          * of reasons supplied as the third parameter.
2226          *
2227          * @todo Needs to be split into multiple functions.
2228          *
2229          * @param $source    String: source code to show (or null).
2230          * @param $protected Boolean: is this a permissions error?
2231          * @param $reasons   Array: list of reasons for this error, as returned by Title::getUserPermissionsErrors().
2232          * @param $action    String: action that was denied or null if unknown
2233          */
2234         public function readOnlyPage( $source = null, $protected = false, $reasons = array(), $action = null ) {
2235                 $this->setRobotPolicy( 'noindex,nofollow' );
2236                 $this->setArticleRelated( false );
2237
2238                 // If no reason is given, just supply a default "I can't let you do
2239                 // that, Dave" message.  Should only occur if called by legacy code.
2240                 if ( $protected && empty( $reasons ) ) {
2241                         $reasons[] = array( 'badaccess-group0' );
2242                 }
2243
2244                 if ( !empty( $reasons ) ) {
2245                         // Permissions error
2246                         if( $source ) {
2247                                 $this->setPageTitle( $this->msg( 'viewsource-title', $this->getTitle()->getPrefixedText() ) );
2248                                 $this->addBacklinkSubtitle( $this->getTitle() );
2249                         } else {
2250                                 $this->setPageTitle( $this->msg( 'badaccess' ) );
2251                         }
2252                         $this->addWikiText( $this->formatPermissionsErrorMessage( $reasons, $action ) );
2253                 } else {
2254                         // Wiki is read only
2255                         throw new ReadOnlyError;
2256                 }
2257
2258                 // Show source, if supplied
2259                 if( is_string( $source ) ) {
2260                         $this->addWikiMsg( 'viewsourcetext' );
2261
2262                         $pageLang = $this->getTitle()->getPageLanguage();
2263                         $params = array(
2264                                 'id'   => 'wpTextbox1',
2265                                 'name' => 'wpTextbox1',
2266                                 'cols' => $this->getUser()->getOption( 'cols' ),
2267                                 'rows' => $this->getUser()->getOption( 'rows' ),
2268                                 'readonly' => 'readonly',
2269                                 'lang' => $pageLang->getHtmlCode(),
2270                                 'dir' => $pageLang->getDir(),
2271                         );
2272                         $this->addHTML( Html::element( 'textarea', $params, $source ) );
2273
2274                         // Show templates used by this article
2275                         $templates = Linker::formatTemplates( $this->getTitle()->getTemplateLinksFrom() );
2276                         $this->addHTML( "<div class='templatesUsed'>
2277 $templates
2278 </div>
2279 " );
2280                 }
2281
2282                 # If the title doesn't exist, it's fairly pointless to print a return
2283                 # link to it.  After all, you just tried editing it and couldn't, so
2284                 # what's there to do there?
2285                 if( $this->getTitle()->exists() ) {
2286                         $this->returnToMain( null, $this->getTitle() );
2287                 }
2288         }
2289
2290         /**
2291          * Turn off regular page output and return an error reponse
2292          * for when rate limiting has triggered.
2293          */
2294         public function rateLimited() {
2295                 throw new ThrottledError;
2296         }
2297
2298         /**
2299          * Show a warning about slave lag
2300          *
2301          * If the lag is higher than $wgSlaveLagCritical seconds,
2302          * then the warning is a bit more obvious. If the lag is
2303          * lower than $wgSlaveLagWarning, then no warning is shown.
2304          *
2305          * @param $lag Integer: slave lag
2306          */
2307         public function showLagWarning( $lag ) {
2308                 global $wgSlaveLagWarning, $wgSlaveLagCritical;
2309                 if( $lag >= $wgSlaveLagWarning ) {
2310                         $message = $lag < $wgSlaveLagCritical
2311                                 ? 'lag-warn-normal'
2312                                 : 'lag-warn-high';
2313                         $wrap = Html::rawElement( 'div', array( 'class' => "mw-{$message}" ), "\n$1\n" );
2314                         $this->wrapWikiMsg( "$wrap\n", array( $message, $this->getLanguage()->formatNum( $lag ) ) );
2315                 }
2316         }
2317
2318         public function showFatalError( $message ) {
2319                 $this->prepareErrorPage( $this->msg( 'internalerror' ) );
2320
2321                 $this->addHTML( $message );
2322         }
2323
2324         public function showUnexpectedValueError( $name, $val ) {
2325                 $this->showFatalError( $this->msg( 'unexpected', $name, $val )->text() );
2326         }
2327
2328         public function showFileCopyError( $old, $new ) {
2329                 $this->showFatalError( $this->msg( 'filecopyerror', $old, $new )->text() );
2330         }
2331
2332         public function showFileRenameError( $old, $new ) {
2333                 $this->showFatalError( $this->msg( 'filerenameerror', $old, $new )->text() );
2334         }
2335
2336         public function showFileDeleteError( $name ) {
2337                 $this->showFatalError( $this->msg( 'filedeleteerror', $name )->text() );
2338         }
2339
2340         public function showFileNotFoundError( $name ) {
2341                 $this->showFatalError( $this->msg( 'filenotfound', $name )->text() );
2342         }
2343
2344         /**
2345          * Add a "return to" link pointing to a specified title
2346          *
2347          * @param $title Title to link
2348          * @param $query String query string
2349          * @param $text String text of the link (input is not escaped)
2350          */
2351         public function addReturnTo( $title, $query = array(), $text = null ) {
2352                 $this->addLink( array( 'rel' => 'next', 'href' => $title->getFullURL() ) );
2353                 $link = $this->msg( 'returnto' )->rawParams(
2354                         Linker::link( $title, $text, array(), $query ) )->escaped();
2355                 $this->addHTML( "<p id=\"mw-returnto\">{$link}</p>\n" );
2356         }
2357
2358         /**
2359          * Add a "return to" link pointing to a specified title,
2360          * or the title indicated in the request, or else the main page
2361          *
2362          * @param $unused
2363          * @param $returnto Title or String to return to
2364          * @param $returntoquery String: query string for the return to link
2365          */
2366         public function returnToMain( $unused = null, $returnto = null, $returntoquery = null ) {
2367                 if ( $returnto == null ) {
2368                         $returnto = $this->getRequest()->getText( 'returnto' );
2369                 }
2370
2371                 if ( $returntoquery == null ) {
2372                         $returntoquery = $this->getRequest()->getText( 'returntoquery' );
2373                 }
2374
2375                 if ( $returnto === '' ) {
2376                         $returnto = Title::newMainPage();
2377                 }
2378
2379                 if ( is_object( $returnto ) ) {
2380                         $titleObj = $returnto;
2381                 } else {
2382                         $titleObj = Title::newFromText( $returnto );
2383                 }
2384                 if ( !is_object( $titleObj ) ) {
2385                         $titleObj = Title::newMainPage();
2386                 }
2387
2388                 $this->addReturnTo( $titleObj, $returntoquery );
2389         }
2390
2391         /**
2392          * @param $sk Skin The given Skin
2393          * @param $includeStyle Boolean: unused
2394          * @return String: The doctype, opening <html>, and head element.
2395          */
2396         public function headElement( Skin $sk, $includeStyle = true ) {
2397                 global $wgContLang;
2398
2399                 $userdir = $this->getLanguage()->getDir();
2400                 $sitedir = $wgContLang->getDir();
2401
2402                 if ( $sk->commonPrintStylesheet() ) {
2403                         $this->addModuleStyles( 'mediawiki.legacy.wikiprintable' );
2404                 }
2405
2406                 $ret = Html::htmlHeader( array( 'lang' => $this->getLanguage()->getHtmlCode(), 'dir' => $userdir, 'class' => 'client-nojs' ) );
2407
2408                 if ( $this->getHTMLTitle() == '' ) {
2409                         $this->setHTMLTitle( $this->msg( 'pagetitle', $this->getPageTitle() ) );
2410                 }
2411
2412                 $openHead = Html::openElement( 'head' );
2413                 if ( $openHead ) {
2414                         # Don't bother with the newline if $head == ''
2415                         $ret .= "$openHead\n";
2416                 }
2417
2418                 $ret .= Html::element( 'title', null, $this->getHTMLTitle() ) . "\n";
2419
2420                 $ret .= implode( "\n", array(
2421                         $this->getHeadLinks( null, true ),
2422                         $this->buildCssLinks(),
2423                         $this->getHeadScripts(),
2424                         $this->getHeadItems()
2425                 ) );
2426
2427                 $closeHead = Html::closeElement( 'head' );
2428                 if ( $closeHead ) {
2429                         $ret .= "$closeHead\n";
2430                 }
2431
2432                 $bodyAttrs = array();
2433
2434                 # Classes for LTR/RTL directionality support
2435                 $bodyAttrs['class'] = "mediawiki $userdir sitedir-$sitedir";
2436
2437                 if ( $this->getLanguage()->capitalizeAllNouns() ) {
2438                         # A <body> class is probably not the best way to do this . . .
2439                         $bodyAttrs['class'] .= ' capitalize-all-nouns';
2440                 }
2441                 $bodyAttrs['class'] .= ' ' . $sk->getPageClasses( $this->getTitle() );
2442                 $bodyAttrs['class'] .= ' skin-' . Sanitizer::escapeClass( $sk->getSkinName() );
2443                 $bodyAttrs['class'] .= ' action-' . Sanitizer::escapeClass( Action::getActionName( $this->getContext() ) );
2444
2445                 $sk->addToBodyAttributes( $this, $bodyAttrs ); // Allow skins to add body attributes they need
2446                 wfRunHooks( 'OutputPageBodyAttributes', array( $this, $sk, &$bodyAttrs ) );
2447
2448                 $ret .= Html::openElement( 'body', $bodyAttrs ) . "\n";
2449
2450                 return $ret;
2451         }
2452
2453         /**
2454          * Add the default ResourceLoader modules to this object
2455          */
2456         private function addDefaultModules() {
2457                 global $wgIncludeLegacyJavaScript, $wgPreloadJavaScriptMwUtil, $wgUseAjax,
2458                         $wgAjaxWatch, $wgEnableMWSuggest;
2459
2460                 // Add base resources
2461                 $this->addModules( array(
2462                         'mediawiki.user',
2463                         'mediawiki.page.startup',
2464                         'mediawiki.page.ready',
2465                 ) );
2466                 if ( $wgIncludeLegacyJavaScript ){
2467                         $this->addModules( 'mediawiki.legacy.wikibits' );
2468                 }
2469
2470                 if ( $wgPreloadJavaScriptMwUtil ) {
2471                         $this->addModules( 'mediawiki.util' );
2472                 }
2473
2474                 MWDebug::addModules( $this );
2475
2476                 // Add various resources if required
2477                 if ( $wgUseAjax ) {
2478                         $this->addModules( 'mediawiki.legacy.ajax' );
2479
2480                         wfRunHooks( 'AjaxAddScript', array( &$this ) );
2481
2482                         if( $wgAjaxWatch && $this->getUser()->isLoggedIn() ) {
2483                                 $this->addModules( 'mediawiki.page.watch.ajax' );
2484                         }
2485
2486                         if ( $wgEnableMWSuggest && !$this->getUser()->getOption( 'disablesuggest', false ) ) {
2487                                 $this->addModules( 'mediawiki.legacy.mwsuggest' );
2488                         }
2489                 }
2490
2491                 if ( $this->getUser()->getBoolOption( 'editsectiononrightclick' ) ) {
2492                         $this->addModules( 'mediawiki.action.view.rightClickEdit' );
2493                 }
2494
2495                 # Crazy edit-on-double-click stuff
2496                 if ( $this->isArticle() && $this->getUser()->getOption( 'editondblclick' ) ) {
2497                         $this->addModules( 'mediawiki.action.view.dblClickEdit' );
2498                 }
2499         }
2500
2501         /**
2502          * Get a ResourceLoader object associated with this OutputPage
2503          *
2504          * @return ResourceLoader
2505          */
2506         public function getResourceLoader() {
2507                 if ( is_null( $this->mResourceLoader ) ) {
2508                         $this->mResourceLoader = new ResourceLoader();
2509                 }
2510                 return $this->mResourceLoader;
2511         }
2512
2513         /**
2514          * TODO: Document
2515          * @param $modules Array/string with the module name(s)
2516          * @param $only String ResourceLoaderModule TYPE_ class constant
2517          * @param $useESI boolean
2518          * @param $extraQuery Array with extra query parameters to add to each request. array( param => value )
2519          * @param $loadCall boolean If true, output an (asynchronous) mw.loader.load() call rather than a <script src="..."> tag
2520          * @return string html <script> and <style> tags
2521          */
2522         protected function makeResourceLoaderLink( $modules, $only, $useESI = false, array $extraQuery = array(), $loadCall = false ) {
2523                 global $wgResourceLoaderUseESI;
2524
2525                 $modules = (array) $modules;
2526
2527                 if ( !count( $modules ) ) {
2528                         return '';
2529                 }
2530
2531                 if ( count( $modules ) > 1 ) {
2532                         // Remove duplicate module requests
2533                         $modules = array_unique( $modules );
2534                         // Sort module names so requests are more uniform
2535                         sort( $modules );
2536
2537                         if ( ResourceLoader::inDebugMode() ) {
2538                                 // Recursively call us for every item
2539                                 $links = '';
2540                                 foreach ( $modules as $name ) {
2541                                         $links .= $this->makeResourceLoaderLink( $name, $only, $useESI );
2542                                 }
2543                                 return $links;
2544                         }
2545                 }
2546
2547                 // Create keyed-by-group list of module objects from modules list
2548                 $groups = array();
2549                 $resourceLoader = $this->getResourceLoader();
2550                 foreach ( $modules as $name ) {
2551                         $module = $resourceLoader->getModule( $name );
2552                         # Check that we're allowed to include this module on this page
2553                         if ( !$module
2554                                 || ( $module->getOrigin() > $this->getAllowedModules( ResourceLoaderModule::TYPE_SCRIPTS )
2555                                         && $only == ResourceLoaderModule::TYPE_SCRIPTS )
2556                                 || ( $module->getOrigin() > $this->getAllowedModules( ResourceLoaderModule::TYPE_STYLES )
2557                                         && $only == ResourceLoaderModule::TYPE_STYLES )
2558                                 )
2559                         {
2560                                 continue;
2561                         }
2562
2563                         $group = $module->getGroup();
2564                         if ( !isset( $groups[$group] ) ) {
2565                                 $groups[$group] = array();
2566                         }
2567                         $groups[$group][$name] = $module;
2568                 }
2569
2570                 $links = '';
2571                 foreach ( $groups as $group => $grpModules ) {
2572                         // Special handling for user-specific groups
2573                         $user = null;
2574                         if ( ( $group === 'user' || $group === 'private' ) && $this->getUser()->isLoggedIn() ) {
2575                                 $user = $this->getUser()->getName();
2576                         }
2577
2578                         // Create a fake request based on the one we are about to make so modules return
2579                         // correct timestamp and emptiness data
2580                         $query = ResourceLoader::makeLoaderQuery(
2581                                 array(), // modules; not determined yet
2582                                 $this->getLanguage()->getCode(),
2583                                 $this->getSkin()->getSkinName(),
2584                                 $user,
2585                                 null, // version; not determined yet
2586                                 ResourceLoader::inDebugMode(),
2587                                 $only === ResourceLoaderModule::TYPE_COMBINED ? null : $only,
2588                                 $this->isPrintable(),
2589                                 $this->getRequest()->getBool( 'handheld' ),
2590                                 $extraQuery
2591                         );
2592                         $context = new ResourceLoaderContext( $resourceLoader, new FauxRequest( $query ) );
2593                         // Extract modules that know they're empty
2594                         $emptyModules = array ();
2595                         foreach ( $grpModules as $key => $module ) {
2596                                 if ( $module->isKnownEmpty( $context ) ) {
2597                                         $emptyModules[$key] = 'ready';
2598                                         unset( $grpModules[$key] );
2599                                 }
2600                         }
2601                         // Inline empty modules: since they're empty, just mark them as 'ready'
2602                         if ( count( $emptyModules ) > 0 && $only !== ResourceLoaderModule::TYPE_STYLES ) {
2603                                 // If we're only getting the styles, we don't need to do anything for empty modules.
2604                                 $links .= Html::inlineScript(
2605
2606                                                 ResourceLoader::makeLoaderConditionalScript(
2607
2608                                                                 ResourceLoader::makeLoaderStateScript( $emptyModules )
2609
2610                                                 )
2611
2612                                 ) . "\n";
2613                         }
2614
2615                         // If there are no modules left, skip this group
2616                         if ( count( $grpModules ) === 0 ) {
2617                                 continue;
2618                         }
2619
2620                         // Inline private modules. These can't be loaded through load.php for security
2621                         // reasons, see bug 34907. Note that these modules should be loaded from
2622                         // getHeadScripts() before the first loader call. Otherwise other modules can't
2623                         // properly use them as dependencies (bug 30914)
2624                         if ( $group === 'private' ) {
2625                                 if ( $only == ResourceLoaderModule::TYPE_STYLES ) {
2626                                         $links .= Html::inlineStyle(
2627                                                 $resourceLoader->makeModuleResponse( $context, $grpModules )
2628                                         );
2629                                 } else {
2630                                         $links .= Html::inlineScript(
2631                                                 ResourceLoader::makeLoaderConditionalScript(
2632                                                         $resourceLoader->makeModuleResponse( $context, $grpModules )
2633                                                 )
2634                                         );
2635                                 }
2636                                 $links .= "\n";
2637                                 continue;
2638                         }
2639                         // Special handling for the user group; because users might change their stuff
2640                         // on-wiki like user pages, or user preferences; we need to find the highest
2641                         // timestamp of these user-changable modules so we can ensure cache misses on change
2642                         // This should NOT be done for the site group (bug 27564) because anons get that too
2643                         // and we shouldn't be putting timestamps in Squid-cached HTML
2644                         $version = null;
2645                         if ( $group === 'user' ) {
2646                                 // Get the maximum timestamp
2647                                 $timestamp = 1;
2648                                 foreach ( $grpModules as $module ) {
2649                                         $timestamp = max( $timestamp, $module->getModifiedTime( $context ) );
2650                                 }
2651                                 // Add a version parameter so cache will break when things change
2652                                 $version = wfTimestamp( TS_ISO_8601_BASIC, $timestamp );
2653                         }
2654
2655                         $url = ResourceLoader::makeLoaderURL(
2656                                 array_keys( $grpModules ),
2657                                 $this->getLanguage()->getCode(),
2658                                 $this->getSkin()->getSkinName(),
2659                                 $user,
2660                                 $version,
2661                                 ResourceLoader::inDebugMode(),
2662                                 $only === ResourceLoaderModule::TYPE_COMBINED ? null : $only,
2663                                 $this->isPrintable(),
2664                                 $this->getRequest()->getBool( 'handheld' ),
2665                                 $extraQuery
2666                         );
2667                         if ( $useESI && $wgResourceLoaderUseESI ) {
2668                                 $esi = Xml::element( 'esi:include', array( 'src' => $url ) );
2669                                 if ( $only == ResourceLoaderModule::TYPE_STYLES ) {
2670                                         $link = Html::inlineStyle( $esi );
2671                                 } else {
2672                                         $link = Html::inlineScript( $esi );
2673                                 }
2674                         } else {
2675                                 // Automatically select style/script elements
2676                                 if ( $only === ResourceLoaderModule::TYPE_STYLES ) {
2677                                         $link = Html::linkedStyle( $url );
2678                                 } else if ( $loadCall ) {
2679                                         $link = Html::inlineScript(
2680                                                 ResourceLoader::makeLoaderConditionalScript(
2681                                                         Xml::encodeJsCall( 'mw.loader.load', array( $url, 'text/javascript', true ) )
2682                                                 )
2683                                         );
2684                                 } else {
2685                                         $link = Html::linkedScript( $url );
2686                                 }
2687                         }
2688
2689                         if( $group == 'noscript' ){
2690                                 $links .= Html::rawElement( 'noscript', array(), $link ) . "\n";
2691                         } else {
2692                                 $links .= $link . "\n";
2693                         }
2694                 }
2695                 return $links;
2696         }
2697
2698         /**
2699          * JS stuff to put in the <head>. This is the startup module, config
2700          * vars and modules marked with position 'top'
2701          *
2702          * @return String: HTML fragment
2703          */
2704         function getHeadScripts() {
2705                 global $wgResourceLoaderExperimentalAsyncLoading;
2706
2707                 // Startup - this will immediately load jquery and mediawiki modules
2708                 $scripts = $this->makeResourceLoaderLink( 'startup', ResourceLoaderModule::TYPE_SCRIPTS, true );
2709
2710                 // Load config before anything else
2711                 $scripts .= Html::inlineScript(
2712                         ResourceLoader::makeLoaderConditionalScript(
2713                                 ResourceLoader::makeConfigSetScript( $this->getJSVars() )
2714                         )
2715                 );
2716
2717                 // Load embeddable private modules before any loader links
2718                 // This needs to be TYPE_COMBINED so these modules are properly wrapped
2719                 // in mw.loader.implement() calls and deferred until mw.user is available
2720                 $embedScripts = array( 'user.options', 'user.tokens' );
2721                 $scripts .= $this->makeResourceLoaderLink( $embedScripts, ResourceLoaderModule::TYPE_COMBINED );
2722
2723                 // Script and Messages "only" requests marked for top inclusion
2724                 // Messages should go first
2725                 $scripts .= $this->makeResourceLoaderLink( $this->getModuleMessages( true, 'top' ), ResourceLoaderModule::TYPE_MESSAGES );
2726                 $scripts .= $this->makeResourceLoaderLink( $this->getModuleScripts( true, 'top' ), ResourceLoaderModule::TYPE_SCRIPTS );
2727
2728                 // Modules requests - let the client calculate dependencies and batch requests as it likes
2729                 // Only load modules that have marked themselves for loading at the top
2730                 $modules = $this->getModules( true, 'top' );
2731                 if ( $modules ) {
2732                         $scripts .= Html::inlineScript(
2733                                 ResourceLoader::makeLoaderConditionalScript(
2734                                         Xml::encodeJsCall( 'mw.loader.load', array( $modules ) )
2735                                 )
2736                         );
2737                 }
2738
2739                 if ( $wgResourceLoaderExperimentalAsyncLoading ) {
2740                         $scripts .= $this->getScriptsForBottomQueue( true );
2741                 }
2742
2743                 return $scripts;
2744         }
2745
2746         /**
2747          * JS stuff to put at the 'bottom', which can either be the bottom of the <body>
2748          * or the bottom of the <head> depending on $wgResourceLoaderExperimentalAsyncLoading:
2749          * modules marked with position 'bottom', legacy scripts ($this->mScripts),
2750          * user preferences, site JS and user JS
2751          *
2752          * @param $inHead boolean If true, this HTML goes into the <head>, if false it goes into the <body>
2753          * @return string
2754          */
2755         function getScriptsForBottomQueue( $inHead ) {
2756                 global $wgUseSiteJs, $wgAllowUserJs;
2757
2758                 // Script and Messages "only" requests marked for bottom inclusion
2759                 // If we're in the <head>, use load() calls rather than <script src="..."> tags
2760                 // Messages should go first
2761                 $scripts = $this->makeResourceLoaderLink( $this->getModuleMessages( true, 'bottom' ),
2762                         ResourceLoaderModule::TYPE_MESSAGES, /* $useESI = */ false, /* $extraQuery = */ array(),
2763                         /* $loadCall = */ $inHead
2764                 );
2765                 $scripts .= $this->makeResourceLoaderLink( $this->getModuleScripts( true, 'bottom' ),
2766                         ResourceLoaderModule::TYPE_SCRIPTS, /* $useESI = */ false, /* $extraQuery = */ array(),
2767                         /* $loadCall = */ $inHead
2768                 );
2769
2770                 // Modules requests - let the client calculate dependencies and batch requests as it likes
2771                 // Only load modules that have marked themselves for loading at the bottom
2772                 $modules = $this->getModules( true, 'bottom' );
2773                 if ( $modules ) {
2774                         $scripts .= Html::inlineScript(
2775                                 ResourceLoader::makeLoaderConditionalScript(
2776                                         Xml::encodeJsCall( 'mw.loader.load', array( $modules, null, true ) )
2777                                 )
2778                         );
2779                 }
2780
2781                 // Legacy Scripts
2782                 $scripts .= "\n" . $this->mScripts;
2783
2784                 $defaultModules = array();
2785
2786                 // Add site JS if enabled
2787                 if ( $wgUseSiteJs ) {
2788                         $scripts .= $this->makeResourceLoaderLink( 'site', ResourceLoaderModule::TYPE_SCRIPTS,
2789                                 /* $useESI = */ false, /* $extraQuery = */ array(), /* $loadCall = */ $inHead
2790                         );
2791                         $defaultModules['site'] = 'loading';
2792                 } else {
2793                         // The wiki is configured to not allow a site module.
2794                         $defaultModules['site'] = 'missing';
2795                 }
2796
2797                 // Add user JS if enabled
2798                 if ( $wgAllowUserJs ) {
2799                         if ( $this->getUser()->isLoggedIn() ) {
2800                                 if( $this->getTitle() && $this->getTitle()->isJsSubpage() && $this->userCanPreview() ) {
2801                                         # XXX: additional security check/prompt?
2802                                         // We're on a preview of a JS subpage
2803                                         // Exclude this page from the user module in case it's in there (bug 26283)
2804                                         $scripts .= $this->makeResourceLoaderLink( 'user', ResourceLoaderModule::TYPE_SCRIPTS, false,
2805                                                 array( 'excludepage' => $this->getTitle()->getPrefixedDBkey() ), $inHead
2806                                         );
2807                                         // Load the previewed JS
2808                                         $scripts .= Html::inlineScript( "\n" . $this->getRequest()->getText( 'wpTextbox1' ) . "\n" ) . "\n";
2809                                         // FIXME: If the user is previewing, say, ./vector.js, his ./common.js will be loaded
2810                                         // asynchronously and may arrive *after* the inline script here. So the previewed code
2811                                         // may execute before ./common.js runs. Normally, ./common.js runs before ./vector.js...
2812                                 } else {
2813                                         // Include the user module normally, i.e., raw to avoid it being wrapped in a closure.
2814                                         $scripts .= $this->makeResourceLoaderLink( 'user', ResourceLoaderModule::TYPE_SCRIPTS,
2815                                                 /* $useESI = */ false, /* $extraQuery = */ array(), /* $loadCall = */ $inHead
2816                                         );
2817                                 }
2818                                 $defaultModules['user'] = 'loading';
2819                         } else {
2820                                 // Non-logged-in users have no user module. Treat it as empty and 'ready' to avoid
2821                                 // blocking default gadgets that might depend on it. Although arguably default-enabled
2822                                 // gadgets should not depend on the user module, it's harmless and less error-prone to
2823                                 // handle this case.
2824                                 $defaultModules['user'] = 'ready';
2825                         }
2826                 } else {
2827                         // User JS disabled
2828                         $defaultModules['user'] = 'missing';
2829                 }
2830
2831                 // Group JS is only enabled if site JS is enabled.
2832                 if ( $wgUseSiteJs ) {
2833                         if ( $this->getUser()->isLoggedIn() ) {
2834                                 $scripts .= $this->makeResourceLoaderLink( 'user.groups', ResourceLoaderModule::TYPE_COMBINED,
2835                                         /* $useESI = */ false, /* $extraQuery = */ array(), /* $loadCall = */ $inHead
2836                                 );
2837                                 $defaultModules['user.groups'] = 'loading';
2838                         } else {
2839                                 // Non-logged-in users have no user.groups module. Treat it as empty and 'ready' to
2840                                 // avoid blocking gadgets that might depend upon the module.
2841                                 $defaultModules['user.groups'] = 'ready';
2842                         }
2843                 } else {
2844                         // Site (and group JS) disabled
2845                         $defaultModules['user.groups'] = 'missing';
2846                 }
2847
2848                 $loaderInit = '';
2849                 if ( $inHead ) {
2850                         // We generate loader calls anyway, so no need to fix the client-side loader's state to 'loading'.
2851                         foreach ( $defaultModules as $m => $state ) {
2852                                 if ( $state == 'loading' ) {
2853                                         unset( $defaultModules[$m] );
2854                                 }
2855                         }
2856                 }
2857                 if ( count( $defaultModules ) > 0 ) {
2858                         $loaderInit = Html::inlineScript(
2859                                 ResourceLoader::makeLoaderConditionalScript(
2860                                         ResourceLoader::makeLoaderStateScript( $defaultModules )
2861                                 )
2862                         ) . "\n";
2863                 }
2864                 return $loaderInit . $scripts;
2865         }
2866
2867         /**
2868          * JS stuff to put at the bottom of the <body>
2869          * @return string
2870          */
2871         function getBottomScripts() {
2872                 global $wgResourceLoaderExperimentalAsyncLoading;
2873                 if ( !$wgResourceLoaderExperimentalAsyncLoading ) {
2874                         return $this->getScriptsForBottomQueue( false );
2875                 } else {
2876                         return '';
2877                 }
2878         }
2879
2880         /**
2881          * Add one or more variables to be set in mw.config in JavaScript.
2882          *
2883          * @param $key {String|Array} Key or array of key/value pars.
2884          * @param $value {Mixed} [optional] Value of the configuration variable.
2885          */
2886         public function addJsConfigVars( $keys, $value = null ) {
2887                 if ( is_array( $keys ) ) {
2888                         foreach ( $keys as $key => $value ) {
2889                                 $this->mJsConfigVars[$key] = $value;
2890                         }
2891                         return;
2892                 }
2893
2894                 $this->mJsConfigVars[$keys] = $value;
2895         }
2896
2897
2898         /**
2899          * Get an array containing the variables to be set in mw.config in JavaScript.
2900          *
2901          * DO NOT CALL THIS FROM OUTSIDE OF THIS CLASS OR Skin::makeGlobalVariablesScript().
2902          * This is only public until that function is removed. You have been warned.
2903          *
2904          * Do not add things here which can be evaluated in ResourceLoaderStartupScript
2905          * - in other words, page-independent/site-wide variables (without state).
2906          * You will only be adding bloat to the html page and causing page caches to
2907          * have to be purged on configuration changes.
2908          * @return array
2909          */
2910         public function getJSVars() {
2911                 global $wgUseAjax, $wgEnableMWSuggest, $wgContLang;
2912
2913                 $latestRevID = 0;
2914                 $pageID = 0;
2915                 $canonicalName = false; # bug 21115
2916
2917                 $title = $this->getTitle();
2918                 $ns = $title->getNamespace();
2919                 $nsname = MWNamespace::exists( $ns ) ? MWNamespace::getCanonicalName( $ns ) : $title->getNsText();
2920
2921                 // Get the relevant title so that AJAX features can use the correct page name
2922                 // when making API requests from certain special pages (bug 34972).
2923                 $relevantTitle = $this->getSkin()->getRelevantTitle();
2924
2925                 if ( $ns == NS_SPECIAL ) {
2926                         list( $canonicalName, /*...*/ ) = SpecialPageFactory::resolveAlias( $title->getDBkey() );
2927                 } elseif ( $this->canUseWikiPage() ) {
2928                         $wikiPage = $this->getWikiPage();
2929                         $latestRevID = $wikiPage->getLatest();
2930                         $pageID = $wikiPage->getId();
2931                 }
2932
2933                 $lang = $title->getPageLanguage();
2934
2935                 // Pre-process information
2936                 $separatorTransTable = $lang->separatorTransformTable();
2937                 $separatorTransTable = $separatorTransTable ? $separatorTransTable : array();
2938                 $compactSeparatorTransTable = array(
2939                         implode( "\t", array_keys( $separatorTransTable ) ),
2940                         implode( "\t", $separatorTransTable ),
2941                 );
2942                 $digitTransTable = $lang->digitTransformTable();
2943                 $digitTransTable = $digitTransTable ? $digitTransTable : array();
2944                 $compactDigitTransTable = array(
2945                         implode( "\t", array_keys( $digitTransTable ) ),
2946                         implode( "\t", $digitTransTable ),
2947                 );
2948
2949                 $vars = array(
2950                         'wgCanonicalNamespace' => $nsname,
2951                         'wgCanonicalSpecialPageName' => $canonicalName,
2952                         'wgNamespaceNumber' => $title->getNamespace(),
2953                         'wgPageName' => $title->getPrefixedDBKey(),
2954                         'wgTitle' => $title->getText(),
2955                         'wgCurRevisionId' => $latestRevID,
2956                         'wgArticleId' => $pageID,
2957                         'wgIsArticle' => $this->isArticle(),
2958                         'wgAction' => Action::getActionName( $this->getContext() ),
2959                         'wgUserName' => $this->getUser()->isAnon() ? null : $this->getUser()->getName(),
2960                         'wgUserGroups' => $this->getUser()->getEffectiveGroups(),
2961                         'wgCategories' => $this->getCategories(),
2962                         'wgBreakFrames' => $this->getFrameOptions() == 'DENY',
2963                         'wgPageContentLanguage' => $lang->getCode(),
2964                         'wgSeparatorTransformTable' => $compactSeparatorTransTable,
2965                         'wgDigitTransformTable' => $compactDigitTransTable,
2966                         'wgRelevantPageName' => $relevantTitle->getPrefixedDBKey(),
2967                 );
2968                 if ( $wgContLang->hasVariants() ) {
2969                         $vars['wgUserVariant'] = $wgContLang->getPreferredVariant();
2970                 }
2971                 foreach ( $title->getRestrictionTypes() as $type ) {
2972                         $vars['wgRestriction' . ucfirst( $type )] = $title->getRestrictions( $type );
2973                 }
2974                 if ( $wgUseAjax && $wgEnableMWSuggest && !$this->getUser()->getOption( 'disablesuggest', false ) ) {
2975                         $vars['wgSearchNamespaces'] = SearchEngine::userNamespaces( $this->getUser() );
2976                 }
2977                 if ( $title->isMainPage() ) {
2978                         $vars['wgIsMainPage'] = true;
2979                 }
2980                 if ( $this->mRedirectedFrom ) {
2981                         $vars['wgRedirectedFrom'] = $this->mRedirectedFrom->getPrefixedDBKey();
2982                 }
2983
2984                 // Allow extensions to add their custom variables to the mw.config map.
2985                 // Use the 'ResourceLoaderGetConfigVars' hook if the variable is not
2986                 // page-dependant but site-wide (without state).
2987                 // Alternatively, you may want to use OutputPage->addJsConfigVars() instead.
2988                 wfRunHooks( 'MakeGlobalVariablesScript', array( &$vars, $this ) );
2989
2990                 // Merge in variables from addJsConfigVars last
2991                 return array_merge( $vars, $this->mJsConfigVars );
2992         }
2993
2994         /**
2995          * To make it harder for someone to slip a user a fake
2996          * user-JavaScript or user-CSS preview, a random token
2997          * is associated with the login session. If it's not
2998          * passed back with the preview request, we won't render
2999          * the code.
3000          *
3001          * @return bool
3002          */
3003         public function userCanPreview() {
3004                 if ( $this->getRequest()->getVal( 'action' ) != 'submit'
3005                         || !$this->getRequest()->wasPosted()
3006                         || !$this->getUser()->matchEditToken(
3007                                 $this->getRequest()->getVal( 'wpEditToken' ) )
3008                 ) {
3009                         return false;
3010                 }
3011                 if ( !$this->getTitle()->isJsSubpage() && !$this->getTitle()->isCssSubpage() ) {
3012                         return false;
3013                 }
3014
3015                 return !count( $this->getTitle()->getUserPermissionsErrors( 'edit', $this->getUser() ) );
3016         }
3017
3018         /**
3019          * @param $addContentType bool: Whether <meta> specifying content type should be returned
3020          *
3021          * @return array in format "link name or number => 'link html'".
3022          */
3023         public function getHeadLinksArray( $addContentType = false ) {
3024                 global $wgUniversalEditButton, $wgFavicon, $wgAppleTouchIcon, $wgEnableAPI,
3025                         $wgSitename, $wgVersion, $wgHtml5, $wgMimeType,
3026                         $wgFeed, $wgOverrideSiteFeed, $wgAdvertisedFeedTypes,
3027                         $wgDisableLangConversion, $wgCanonicalLanguageLinks,
3028                         $wgRightsPage, $wgRightsUrl;
3029
3030                 $tags = array();
3031
3032                 if ( $addContentType ) {
3033                         if ( $wgHtml5 ) {
3034                                 # More succinct than <meta http-equiv=Content-Type>, has the
3035                                 # same effect
3036                                 $tags['meta-charset'] = Html::element( 'meta', array( 'charset' => 'UTF-8' ) );
3037                         } else {
3038                                 $tags['meta-content-type'] = Html::element( 'meta', array(
3039                                         'http-equiv' => 'Content-Type',
3040                                         'content' => "$wgMimeType; charset=UTF-8"
3041                                 ) );
3042                                 $tags['meta-content-style-type'] = Html::element( 'meta', array(  // bug 15835
3043                                         'http-equiv' => 'Content-Style-Type',
3044                                         'content' => 'text/css'
3045                                 ) );
3046                         }
3047                 }
3048
3049                 $tags['meta-generator'] = Html::element( 'meta', array(
3050                         'name' => 'generator',
3051                         'content' => "MediaWiki $wgVersion",
3052                 ) );
3053
3054                 $p = "{$this->mIndexPolicy},{$this->mFollowPolicy}";
3055                 if( $p !== 'index,follow' ) {
3056                         // http://www.robotstxt.org/wc/meta-user.html
3057                         // Only show if it's different from the default robots policy
3058                         $tags['meta-robots'] = Html::element( 'meta', array(
3059                                 'name' => 'robots',
3060                                 'content' => $p,
3061                         ) );
3062                 }
3063
3064                 if ( count( $this->mKeywords ) > 0 ) {
3065                         $strip = array(
3066                                 "/<.*?" . ">/" => '',
3067                                 "/_/" => ' '
3068                         );
3069                         $tags['meta-keywords'] = Html::element( 'meta', array(
3070                                 'name' => 'keywords',
3071                                 'content' =>  preg_replace(
3072                                         array_keys( $strip ),
3073                                         array_values( $strip ),
3074                                         implode( ',', $this->mKeywords )
3075                                 )
3076                         ) );
3077                 }
3078
3079                 foreach ( $this->mMetatags as $tag ) {
3080                         if ( 0 == strcasecmp( 'http:', substr( $tag[0], 0, 5 ) ) ) {
3081                                 $a = 'http-equiv';
3082                                 $tag[0] = substr( $tag[0], 5 );
3083                         } else {
3084                                 $a = 'name';
3085                         }
3086                         $tagName = "meta-{$tag[0]}";
3087                         if ( isset( $tags[$tagName] ) ) {
3088                                 $tagName .= $tag[1];
3089                         }
3090                         $tags[$tagName] = Html::element( 'meta',
3091                                 array(
3092                                         $a => $tag[0],
3093                                         'content' => $tag[1]
3094                                 )
3095                         );
3096                 }
3097
3098                 foreach ( $this->mLinktags as $tag ) {
3099                         $tags[] = Html::element( 'link', $tag );
3100                 }
3101
3102                 # Universal edit button
3103                 if ( $wgUniversalEditButton && $this->isArticleRelated() ) {
3104                         $user = $this->getUser();
3105                         if ( $this->getTitle()->quickUserCan( 'edit', $user )
3106                                 && ( $this->getTitle()->exists() || $this->getTitle()->quickUserCan( 'create', $user ) ) ) {
3107                                 // Original UniversalEditButton
3108                                 $msg = $this->msg( 'edit' )->text();
3109                                 $tags['universal-edit-button'] = Html::element( 'link', array(
3110                                         'rel' => 'alternate',
3111                                         'type' => 'application/x-wiki',
3112                                         'title' => $msg,
3113                                         'href' => $this->getTitle()->getLocalURL( 'action=edit' )
3114                                 ) );
3115                                 // Alternate edit link
3116                                 $tags['alternative-edit'] = Html::element( 'link', array(
3117                                         'rel' => 'edit',
3118                                         'title' => $msg,
3119                                         'href' => $this->getTitle()->getLocalURL( 'action=edit' )
3120                                 ) );
3121                         }
3122                 }
3123
3124                 # Generally the order of the favicon and apple-touch-icon links
3125                 # should not matter, but Konqueror (3.5.9 at least) incorrectly
3126                 # uses whichever one appears later in the HTML source. Make sure
3127                 # apple-touch-icon is specified first to avoid this.
3128                 if ( $wgAppleTouchIcon !== false ) {
3129                         $tags['apple-touch-icon'] = Html::element( 'link', array( 'rel' => 'apple-touch-icon', 'href' => $wgAppleTouchIcon ) );
3130                 }
3131
3132                 if ( $wgFavicon !== false ) {
3133                         $tags['favicon'] = Html::element( 'link', array( 'rel' => 'shortcut icon', 'href' => $wgFavicon ) );
3134                 }
3135
3136                 # OpenSearch description link
3137                 $tags['opensearch'] = Html::element( 'link', array(
3138                         'rel' => 'search',
3139                         'type' => 'application/opensearchdescription+xml',
3140                         'href' => wfScript( 'opensearch_desc' ),
3141                         'title' => $this->msg( 'opensearch-desc' )->inContentLanguage()->text(),
3142                 ) );
3143
3144                 if ( $wgEnableAPI ) {
3145                         # Real Simple Discovery link, provides auto-discovery information
3146                         # for the MediaWiki API (and potentially additional custom API
3147                         # support such as WordPress or Twitter-compatible APIs for a
3148                         # blogging extension, etc)
3149                         $tags['rsd'] = Html::element( 'link', array(
3150                                 'rel' => 'EditURI',
3151                                 'type' => 'application/rsd+xml',
3152                                 // Output a protocol-relative URL here if $wgServer is protocol-relative
3153                                 // Whether RSD accepts relative or protocol-relative URLs is completely undocumented, though
3154                                 'href' => wfExpandUrl( wfAppendQuery( wfScript( 'api' ), array( 'action' => 'rsd' ) ), PROTO_RELATIVE ),
3155                         ) );
3156                 }
3157
3158
3159                 # Language variants
3160                 if ( !$wgDisableLangConversion && $wgCanonicalLanguageLinks ) {
3161                         $lang = $this->getTitle()->getPageLanguage();
3162                         if ( $lang->hasVariants() ) {
3163
3164                                 $urlvar = $lang->getURLVariant();
3165
3166                                 if ( !$urlvar ) {
3167                                         $variants = $lang->getVariants();
3168                                         foreach ( $variants as $_v ) {
3169                                                 $tags["variant-$_v"] = Html::element( 'link', array(
3170                                                         'rel' => 'alternate',
3171                                                         'hreflang' => $_v,
3172                                                         'href' => $this->getTitle()->getLocalURL( array( 'variant' => $_v ) ) )
3173                                                 );
3174                                         }
3175                                 } else {
3176                                         $tags['canonical'] = Html::element( 'link', array(
3177                                                 'rel' => 'canonical',
3178                                                 'href' => $this->getTitle()->getCanonicalUrl()
3179                                         ) );
3180                                 }
3181                         }
3182                 }
3183
3184                 # Copyright
3185                 $copyright = '';
3186                 if ( $wgRightsPage ) {
3187                         $copy = Title::newFromText( $wgRightsPage );
3188
3189                         if ( $copy ) {
3190                                 $copyright = $copy->getLocalURL();
3191                         }
3192                 }
3193
3194                 if ( !$copyright && $wgRightsUrl ) {
3195                         $copyright = $wgRightsUrl;
3196                 }
3197
3198                 if ( $copyright ) {
3199                         $tags['copyright'] = Html::element( 'link', array(
3200                                 'rel' => 'copyright',
3201                                 'href' => $copyright )
3202                         );
3203                 }
3204
3205                 # Feeds
3206                 if ( $wgFeed ) {
3207                         foreach( $this->getSyndicationLinks() as $format => $link ) {
3208                                 # Use the page name for the title.  In principle, this could
3209                                 # lead to issues with having the same name for different feeds
3210                                 # corresponding to the same page, but we can't avoid that at
3211                                 # this low a level.
3212
3213                                 $tags[] = $this->feedLink(
3214                                         $format,
3215                                         $link,
3216                                         # Used messages: 'page-rss-feed' and 'page-atom-feed' (for an easier grep)
3217                                         $this->msg( "page-{$format}-feed", $this->getTitle()->getPrefixedText() )->text()
3218                                 );
3219                         }
3220
3221                         # Recent changes feed should appear on every page (except recentchanges,
3222                         # that would be redundant). Put it after the per-page feed to avoid
3223                         # changing existing behavior. It's still available, probably via a
3224                         # menu in your browser. Some sites might have a different feed they'd
3225                         # like to promote instead of the RC feed (maybe like a "Recent New Articles"
3226                         # or "Breaking news" one). For this, we see if $wgOverrideSiteFeed is defined.
3227                         # If so, use it instead.
3228                         if ( $wgOverrideSiteFeed ) {
3229                                 foreach ( $wgOverrideSiteFeed as $type => $feedUrl ) {
3230                                         // Note, this->feedLink escapes the url.
3231                                         $tags[] = $this->feedLink(
3232                                                 $type,
3233                                                 $feedUrl,
3234                                                 $this->msg( "site-{$type}-feed", $wgSitename )->text()
3235                                         );
3236                                 }
3237                         } elseif ( !$this->getTitle()->isSpecial( 'Recentchanges' ) ) {
3238                                 $rctitle = SpecialPage::getTitleFor( 'Recentchanges' );
3239                                 foreach ( $wgAdvertisedFeedTypes as $format ) {
3240                                         $tags[] = $this->feedLink(
3241                                                 $format,
3242                                                 $rctitle->getLocalURL( "feed={$format}" ),
3243                                                 $this->msg( "site-{$format}-feed", $wgSitename )->text() # For grep: 'site-rss-feed', 'site-atom-feed'.
3244                                         );
3245                                 }
3246                         }
3247                 }
3248                 return $tags;
3249         }
3250
3251         /**
3252          * @param $unused
3253          * @param $addContentType bool: Whether <meta> specifying content type should be returned
3254          *
3255          * @return string HTML tag links to be put in the header.
3256          */
3257         public function getHeadLinks( $unused = null, $addContentType = false ) {
3258                 return implode( "\n", $this->getHeadLinksArray( $addContentType ) );
3259         }
3260
3261         /**
3262          * Generate a <link rel/> for a feed.
3263          *
3264          * @param $type String: feed type
3265          * @param $url String: URL to the feed
3266          * @param $text String: value of the "title" attribute
3267          * @return String: HTML fragment
3268          */
3269         private function feedLink( $type, $url, $text ) {
3270                 return Html::element( 'link', array(
3271                         'rel' => 'alternate',
3272                         'type' => "application/$type+xml",
3273                         'title' => $text,
3274                         'href' => $url )
3275                 );
3276         }
3277
3278         /**
3279          * Add a local or specified stylesheet, with the given media options.
3280          * Meant primarily for internal use...
3281          *
3282          * @param $style String: URL to the file
3283          * @param $media String: to specify a media type, 'screen', 'printable', 'handheld' or any.
3284          * @param $condition String: for IE conditional comments, specifying an IE version
3285          * @param $dir String: set to 'rtl' or 'ltr' for direction-specific sheets
3286          */
3287         public function addStyle( $style, $media = '', $condition = '', $dir = '' ) {
3288                 $options = array();
3289                 // Even though we expect the media type to be lowercase, but here we
3290                 // force it to lowercase to be safe.
3291                 if( $media ) {
3292                         $options['media'] = $media;
3293                 }
3294                 if( $condition ) {
3295                         $options['condition'] = $condition;
3296                 }
3297                 if( $dir ) {
3298                         $options['dir'] = $dir;
3299                 }
3300                 $this->styles[$style] = $options;
3301         }
3302
3303         /**
3304          * Adds inline CSS styles
3305          * @param $style_css Mixed: inline CSS
3306          * @param $flip String: Set to 'flip' to flip the CSS if needed
3307          */
3308         public function addInlineStyle( $style_css, $flip = 'noflip' ) {
3309                 if( $flip === 'flip' && $this->getLanguage()->isRTL() ) {
3310                         # If wanted, and the interface is right-to-left, flip the CSS
3311                         $style_css = CSSJanus::transform( $style_css, true, false );
3312                 }
3313                 $this->mInlineStyles .= Html::inlineStyle( $style_css );
3314         }
3315
3316         /**
3317          * Build a set of <link>s for the stylesheets specified in the $this->styles array.
3318          * These will be applied to various media & IE conditionals.
3319          *
3320          * @return string
3321          */
3322         public function buildCssLinks() {
3323                 global $wgUseSiteCss, $wgAllowUserCss, $wgAllowUserCssPrefs,
3324                         $wgLang, $wgContLang;
3325
3326                 $this->getSkin()->setupSkinUserCss( $this );
3327
3328                 // Add ResourceLoader styles
3329                 // Split the styles into four groups
3330                 $styles = array( 'other' => array(), 'user' => array(), 'site' => array(), 'private' => array(), 'noscript' => array() );
3331                 $otherTags = ''; // Tags to append after the normal <link> tags
3332                 $resourceLoader = $this->getResourceLoader();
3333
3334                 $moduleStyles = $this->getModuleStyles();
3335
3336                 // Per-site custom styles
3337                 if ( $wgUseSiteCss ) {
3338                         $moduleStyles[] = 'site';
3339                         $moduleStyles[] = 'noscript';
3340                         if( $this->getUser()->isLoggedIn() ){
3341                                 $moduleStyles[] = 'user.groups';
3342                         }
3343                 }
3344
3345                 // Per-user custom styles
3346                 if ( $wgAllowUserCss ) {
3347                         if ( $this->getTitle()->isCssSubpage() && $this->userCanPreview() ) {
3348                                 // We're on a preview of a CSS subpage
3349                                 // Exclude this page from the user module in case it's in there (bug 26283)
3350                                 $otherTags .= $this->makeResourceLoaderLink( 'user', ResourceLoaderModule::TYPE_STYLES, false,
3351                                         array( 'excludepage' => $this->getTitle()->getPrefixedDBkey() )
3352                                 );
3353
3354                                 // Load the previewed CSS
3355                                 // If needed, Janus it first. This is user-supplied CSS, so it's
3356                                 // assumed to be right for the content language directionality.
3357                                 $previewedCSS = $this->getRequest()->getText( 'wpTextbox1' );
3358                                 if ( $wgLang->getDir() !== $wgContLang->getDir() ) {
3359                                         $previewedCSS = CSSJanus::transform( $previewedCSS, true, false );
3360                                 }
3361                                 $otherTags .= Html::inlineStyle( $previewedCSS );
3362                         } else {
3363                                 // Load the user styles normally
3364                                 $moduleStyles[] = 'user';
3365                         }
3366                 }
3367
3368                 // Per-user preference styles
3369                 if ( $wgAllowUserCssPrefs ) {
3370                         $moduleStyles[] = 'user.cssprefs';
3371                 }
3372
3373                 foreach ( $moduleStyles as $name ) {
3374                         $module = $resourceLoader->getModule( $name );
3375                         if ( !$module ) {
3376                                 continue;
3377                         }
3378                         $group = $module->getGroup();
3379                         // Modules in groups named "other" or anything different than "user", "site" or "private"
3380                         // will be placed in the "other" group
3381                         $styles[isset( $styles[$group] ) ? $group : 'other'][] = $name;
3382                 }
3383
3384                 // We want site, private and user styles to override dynamically added styles from modules, but we want
3385                 // dynamically added styles to override statically added styles from other modules. So the order
3386                 // has to be other, dynamic, site, private, user
3387                 // Add statically added styles for other modules
3388                 $ret = $this->makeResourceLoaderLink( $styles['other'], ResourceLoaderModule::TYPE_STYLES );
3389                 // Add normal styles added through addStyle()/addInlineStyle() here
3390                 $ret .= implode( "\n", $this->buildCssLinksArray() ) . $this->mInlineStyles;
3391                 // Add marker tag to mark the place where the client-side loader should inject dynamic styles
3392                 // We use a <meta> tag with a made-up name for this because that's valid HTML
3393                 $ret .= Html::element( 'meta', array( 'name' => 'ResourceLoaderDynamicStyles', 'content' => '' ) ) . "\n";
3394
3395                 // Add site, private and user styles
3396                 // 'private' at present only contains user.options, so put that before 'user'
3397                 // Any future private modules will likely have a similar user-specific character
3398                 foreach ( array( 'site', 'noscript', 'private', 'user' ) as $group ) {
3399                         $ret .= $this->makeResourceLoaderLink( $styles[$group],
3400                                         ResourceLoaderModule::TYPE_STYLES
3401                         );
3402                 }
3403
3404                 // Add stuff in $otherTags (previewed user CSS if applicable)
3405                 $ret .= $otherTags;
3406                 return $ret;
3407         }
3408
3409         /**
3410          * @return Array
3411          */
3412         public function buildCssLinksArray() {
3413                 $links = array();
3414
3415                 // Add any extension CSS
3416                 foreach ( $this->mExtStyles as $url ) {
3417                         $this->addStyle( $url );
3418                 }
3419                 $this->mExtStyles = array();
3420
3421                 foreach( $this->styles as $file => $options ) {
3422                         $link = $this->styleLink( $file, $options );
3423                         if( $link ) {
3424                                 $links[$file] = $link;
3425                         }
3426                 }
3427                 return $links;
3428         }
3429
3430         /**
3431          * Generate \<link\> tags for stylesheets
3432          *
3433          * @param $style String: URL to the file
3434          * @param $options Array: option, can contain 'condition', 'dir', 'media'
3435          *                 keys
3436          * @return String: HTML fragment
3437          */
3438         protected function styleLink( $style, $options ) {
3439                 if( isset( $options['dir'] ) ) {
3440                         if( $this->getLanguage()->getDir() != $options['dir'] ) {
3441                                 return '';
3442                         }
3443                 }
3444
3445                 if( isset( $options['media'] ) ) {
3446                         $media = self::transformCssMedia( $options['media'] );
3447                         if( is_null( $media ) ) {
3448                                 return '';
3449                         }
3450                 } else {
3451                         $media = 'all';
3452                 }
3453
3454                 if( substr( $style, 0, 1 ) == '/' ||
3455                         substr( $style, 0, 5 ) == 'http:' ||
3456                         substr( $style, 0, 6 ) == 'https:' ) {
3457                         $url = $style;
3458                 } else {
3459                         global $wgStylePath, $wgStyleVersion;
3460                         $url = $wgStylePath . '/' . $style . '?' . $wgStyleVersion;
3461                 }
3462
3463                 $link = Html::linkedStyle( $url, $media );
3464
3465                 if( isset( $options['condition'] ) ) {
3466                         $condition = htmlspecialchars( $options['condition'] );
3467                         $link = "<!--[if $condition]>$link<![endif]-->";
3468                 }
3469                 return $link;
3470         }
3471
3472         /**
3473          * Transform "media" attribute based on request parameters
3474          *
3475          * @param $media String: current value of the "media" attribute
3476          * @return String: modified value of the "media" attribute
3477          */
3478         public static function transformCssMedia( $media ) {
3479                 global $wgRequest, $wgHandheldForIPhone;
3480
3481                 // Switch in on-screen display for media testing
3482                 $switches = array(
3483                         'printable' => 'print',
3484                         'handheld' => 'handheld',
3485                 );
3486                 foreach( $switches as $switch => $targetMedia ) {
3487                         if( $wgRequest->getBool( $switch ) ) {
3488                                 if( $media == $targetMedia ) {
3489                                         $media = '';
3490                                 } elseif( $media == 'screen' ) {
3491                                         return null;
3492                                 }
3493                         }
3494                 }
3495
3496                 // Expand longer media queries as iPhone doesn't grok 'handheld'
3497                 if( $wgHandheldForIPhone ) {
3498                         $mediaAliases = array(
3499                                 'screen' => 'screen and (min-device-width: 481px)',
3500                                 'handheld' => 'handheld, only screen and (max-device-width: 480px)',
3501                         );
3502
3503                         if( isset( $mediaAliases[$media] ) ) {
3504                                 $media = $mediaAliases[$media];
3505                         }
3506                 }
3507
3508                 return $media;
3509         }
3510
3511         /**
3512          * Add a wikitext-formatted message to the output.
3513          * This is equivalent to:
3514          *
3515          *    $wgOut->addWikiText( wfMsgNoTrans( ... ) )
3516          */
3517         public function addWikiMsg( /*...*/ ) {
3518                 $args = func_get_args();
3519                 $name = array_shift( $args );
3520                 $this->addWikiMsgArray( $name, $args );
3521         }
3522
3523         /**
3524          * Add a wikitext-formatted message to the output.
3525          * Like addWikiMsg() except the parameters are taken as an array
3526          * instead of a variable argument list.
3527          *
3528          * @param $name string
3529          * @param $args array
3530          */
3531         public function addWikiMsgArray( $name, $args ) {
3532                 $this->addHTML( $this->msg( $name, $args )->parseAsBlock() );
3533         }
3534
3535         /**
3536          * This function takes a number of message/argument specifications, wraps them in
3537          * some overall structure, and then parses the result and adds it to the output.
3538          *
3539          * In the $wrap, $1 is replaced with the first message, $2 with the second, and so
3540          * on. The subsequent arguments may either be strings, in which case they are the
3541          * message names, or arrays, in which case the first element is the message name,
3542          * and subsequent elements are the parameters to that message.
3543          *
3544          * The special named parameter 'options' in a message specification array is passed
3545          * through to the $options parameter of wfMsgExt().
3546          *
3547          * Don't use this for messages that are not in users interface language.
3548          *
3549          * For example:
3550          *
3551          *    $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>", 'some-error' );
3552          *
3553          * Is equivalent to:
3554          *
3555          *    $wgOut->addWikiText( "<div class='error'>\n" . wfMsgNoTrans( 'some-error' ) . "\n</div>" );
3556          *
3557          * The newline after opening div is needed in some wikitext. See bug 19226.
3558          *
3559          * @param $wrap string
3560          */
3561         public function wrapWikiMsg( $wrap /*, ...*/ ) {
3562                 $msgSpecs = func_get_args();
3563                 array_shift( $msgSpecs );
3564                 $msgSpecs = array_values( $msgSpecs );
3565                 $s = $wrap;
3566                 foreach ( $msgSpecs as $n => $spec ) {
3567                         $options = array();
3568                         if ( is_array( $spec ) ) {
3569                                 $args = $spec;
3570                                 $name = array_shift( $args );
3571                                 if ( isset( $args['options'] ) ) {
3572                                         $options = $args['options'];
3573                                         unset( $args['options'] );
3574                                 }
3575                         }  else {
3576                                 $args = array();
3577                                 $name = $spec;
3578                         }
3579                         $s = str_replace( '$' . ( $n + 1 ), wfMsgExt( $name, $options, $args ), $s );
3580                 }
3581                 $this->addWikiText( $s );
3582         }
3583
3584         /**
3585          * Include jQuery core. Use this to avoid loading it multiple times
3586          * before we get a usable script loader.
3587          *
3588          * @param $modules Array: list of jQuery modules which should be loaded
3589          * @return Array: the list of modules which were not loaded.
3590          * @since 1.16
3591          * @deprecated since 1.17
3592          */
3593         public function includeJQuery( $modules = array() ) {
3594                 return array();
3595         }
3596
3597 }