includes/OutputPage.php

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