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