includes/parser/ParserOutput.php

   1 <?php
   2
   3 /**
   4  * Output of the PHP parser.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19  * http://www.gnu.org/copyleft/gpl.html
  20  *
  21  * @file
  22  * @ingroup Parser
  23  */
  24
  25 class ParserOutput extends CacheTime {
  26         /**
  27          * Feature flags to indicate to extensions that MediaWiki core supports and
  28          * uses getText() stateless transforms.
  29          */
  30         const SUPPORTS_STATELESS_TRANSFORMS = 1;
  31         const SUPPORTS_UNWRAP_TRANSFORM = 1;
  32
  33         /**
  34          * @var string|null $mText The output text
  35          */
  36         public $mText = null;
  37
  38         /**
  39          * @var array $mLanguageLinks List of the full text of language links,
  40          *  in the order they appear.
  41          */
  42         public $mLanguageLinks;
  43
  44         /**
  45          * @var array $mCategories Map of category names to sort keys
  46          */
  47         public $mCategories;
  48
  49         /**
  50          * @var array $mIndicators Page status indicators, usually displayed in top-right corner.
  51          */
  52         public $mIndicators = [];
  53
  54         /**
  55          * @var string $mTitleText Title text of the chosen language variant, as HTML.
  56          */
  57         public $mTitleText;
  58
  59         /**
  60          * @var array $mLinks 2-D map of NS/DBK to ID for the links in the document.
  61          *  ID=zero for broken.
  62          */
  63         public $mLinks = [];
  64
  65         /**
  66          * @var array $mTemplates 2-D map of NS/DBK to ID for the template references.
  67          *  ID=zero for broken.
  68          */
  69         public $mTemplates = [];
  70
  71         /**
  72          * @var array $mTemplateIds 2-D map of NS/DBK to rev ID for the template references.
  73          *  ID=zero for broken.
  74          */
  75         public $mTemplateIds = [];
  76
  77         /**
  78          * @var array $mImages DB keys of the images used, in the array key only
  79          */
  80         public $mImages = [];
  81
  82         /**
  83          * @var array $mFileSearchOptions DB keys of the images used mapped to sha1 and MW timestamp.
  84          */
  85         public $mFileSearchOptions = [];
  86
  87         /**
  88          * @var array $mExternalLinks External link URLs, in the key only.
  89          */
  90         public $mExternalLinks = [];
  91
  92         /**
  93          * @var array $mInterwikiLinks 2-D map of prefix/DBK (in keys only)
  94          *  for the inline interwiki links in the document.
  95          */
  96         public $mInterwikiLinks = [];
  97
  98         /**
  99          * @var bool $mNewSection Show a new section link?
 100          */
 101         public $mNewSection = false;
 102
 103         /**
 104          * @var bool $mHideNewSection Hide the new section link?
 105          */
 106         public $mHideNewSection = false;
 107
 108         /**
 109          * @var bool $mNoGallery No gallery on category page? (__NOGALLERY__).
 110          */
 111         public $mNoGallery = false;
 112
 113         /**
 114          * @var array $mHeadItems Items to put in the <head> section
 115          */
 116         public $mHeadItems = [];
 117
 118         /**
 119          * @var array $mModules Modules to be loaded by ResourceLoader
 120          */
 121         public $mModules = [];
 122
 123         /**
 124          * @var array $mModuleStyles Modules of which only the CSSS will be loaded by ResourceLoader.
 125          */
 126         public $mModuleStyles = [];
 127
 128         /**
 129          * @var array $mJsConfigVars JavaScript config variable for mw.config combined with this page.
 130          */
 131         public $mJsConfigVars = [];
 132
 133         /**
 134          * @var array $mOutputHooks Hook tags as per $wgParserOutputHooks.
 135          */
 136         public $mOutputHooks = [];
 137
 138         /**
 139          * @var array $mWarnings Warning text to be returned to the user.
 140          *  Wikitext formatted, in the key only.
 141          */
 142         public $mWarnings = [];
 143
 144         /**
 145          * @var array $mSections Table of contents
 146          */
 147         public $mSections = [];
 148
 149         /**
 150          * @var array $mProperties Name/value pairs to be cached in the DB.
 151          */
 152         public $mProperties = [];
 153
 154         /**
 155          * @var string $mTOCHTML HTML of the TOC.
 156          */
 157         public $mTOCHTML = '';
 158
 159         /**
 160          * @var string $mTimestamp Timestamp of the revision.
 161          */
 162         public $mTimestamp;
 163
 164         /**
 165          * @var bool $mEnableOOUI Whether OOUI should be enabled.
 166          */
 167         public $mEnableOOUI = false;
 168
 169         /**
 170          * @var string $mIndexPolicy 'index' or 'noindex'?  Any other value will result in no change.
 171          */
 172         private $mIndexPolicy = '';
 173
 174         /**
 175          * @var true[] $mAccessedOptions List of ParserOptions (stored in the keys).
 176          */
 177         private $mAccessedOptions = [];
 178
 179         /**
 180          * @var array $mExtensionData extra data used by extensions.
 181          */
 182         private $mExtensionData = [];
 183
 184         /**
 185          * @var array $mLimitReportData Parser limit report data.
 186          */
 187         private $mLimitReportData = [];
 188
 189         /** @var array Parser limit report data for JSON */
 190         private $mLimitReportJSData = [];
 191
 192         /**
 193          * @var array $mParseStartTime Timestamps for getTimeSinceStart().
 194          */
 195         private $mParseStartTime = [];
 196
 197         /**
 198          * @var bool $mPreventClickjacking Whether to emit X-Frame-Options: DENY.
 199          */
 200         private $mPreventClickjacking = false;
 201
 202         /**
 203          * @var array $mFlags Generic flags.
 204          */
 205         private $mFlags = [];
 206
 207         /** @var int|null Assumed rev ID for {{REVISIONID}} if no revision is set */
 208         private $mSpeculativeRevId;
 209
 210         /** string CSS classes to use for the wrapping div, stored in the array keys.
 211          * If no class is given, no wrapper is added.
 212          */
 213         private $mWrapperDivClasses = [];
 214
 215         /** @var int Upper bound of expiry based on parse duration */
 216         private $mMaxAdaptiveExpiry = INF;
 217
 218         const EDITSECTION_REGEX =
 219                 '#<(?:mw:)?editsection page="(.*?)" section="(.*?)"(?:/>|>(.*?)(</(?:mw:)?editsection>))#s';
 220
 221         // finalizeAdaptiveCacheExpiry() uses TTL = MAX( m * PARSE_TIME + b, MIN_AR_TTL)
 222         // Current values imply that m=3933.333333 and b=-333.333333
 223         // See https://www.nngroup.com/articles/website-response-times/
 224         const PARSE_FAST_SEC = 0.100; // perceived "fast" page parse
 225         const PARSE_SLOW_SEC = 1.0; // perceived "slow" page parse
 226         const FAST_AR_TTL = 60; // adaptive TTL for "fast" pages
 227         const SLOW_AR_TTL = 3600; // adaptive TTL for "slow" pages
 228         const MIN_AR_TTL = 15; // min adaptive TTL (for sanity, pool counter, and edit stashing)
 229
 230         /**
 231          * @param string|null $text HTML. Use null to indicate that this ParserOutput contains only
 232          *        meta-data, and the HTML output is undetermined, as opposed to empty. Passing null
 233          *        here causes hasText() to return false.
 234          * @param array $languageLinks
 235          * @param array $categoryLinks
 236          * @param bool $unused
 237          * @param string $titletext
 238          */
 239         public function __construct( $text = '', $languageLinks = [], $categoryLinks = [],
 240                 $unused = false, $titletext = ''
 241         ) {
 242                 $this->mText = $text;
 243                 $this->mLanguageLinks = $languageLinks;
 244                 $this->mCategories = $categoryLinks;
 245                 $this->mTitleText = $titletext;
 246         }
 247
 248         /**
 249          * Returns true if text was passed to the constructor, or set using setText(). Returns false
 250          * if null was passed to the $text parameter of the constructor to indicate that this
 251          * ParserOutput only contains meta-data, and the HTML output is undetermined.
 252          *
 253          * @since 1.32
 254          *
 255          * @return bool Whether this ParserOutput contains rendered text. If this returns false, the
 256          *         ParserOutput contains meta-data only.
 257          */
 258         public function hasText() {
 259                 return ( $this->mText !== null );
 260         }
 261
 262         /**
 263          * Get the cacheable text with <mw:editsection> markers still in it. The
 264          * return value is suitable for writing back via setText() but is not valid
 265          * for display to the user.
 266          *
 267          * @return string
 268          * @since 1.27
 269          */
 270         public function getRawText() {
 271                 if ( $this->mText === null ) {
 272                         throw new LogicException( 'This ParserOutput contains no text!' );
 273                 }
 274
 275                 return $this->mText;
 276         }
 277
 278         /**
 279          * Get the output HTML
 280          *
 281          * @param array $options (since 1.31) Transformations to apply to the HTML
 282          *  - allowTOC: (bool) Show the TOC, assuming there were enough headings
 283          *     to generate one and `__NOTOC__` wasn't used. Default is true,
 284          *     but might be statefully overridden.
 285          *  - enableSectionEditLinks: (bool) Include section edit links, assuming
 286          *     section edit link tokens are present in the HTML. Default is true,
 287          *     but might be statefully overridden.
 288          *  - unwrap: (bool) Return text without a wrapper div. Default is false,
 289          *    meaning a wrapper div will be added if getWrapperDivClass() returns
 290          *    a non-empty string.
 291          *  - wrapperDivClass: (string) Wrap the output in a div and apply the given
 292          *    CSS class to that div. This overrides the output of getWrapperDivClass().
 293          *    Setting this to an empty string has the same effect as 'unwrap' => true.
 294          *  - deduplicateStyles: (bool) When true, which is the default, `<style>`
 295          *    tags with the `data-mw-deduplicate` attribute set are deduplicated by
 296          *    value of the attribute: all but the first will be replaced by `<link
 297          *    rel="mw-deduplicated-inline-style" href="mw-data:..."/>` tags, where
 298          *    the scheme-specific-part of the href is the (percent-encoded) value
 299          *    of the `data-mw-deduplicate` attribute.
 300          * @return string HTML
 301          * @return-taint escaped
 302          */
 303         public function getText( $options = [] ) {
 304                 $options += [
 305                         'allowTOC' => true,
 306                         'enableSectionEditLinks' => true,
 307                         'unwrap' => false,
 308                         'deduplicateStyles' => true,
 309                         'wrapperDivClass' => $this->getWrapperDivClass(),
 310                 ];
 311                 $text = $this->getRawText();
 312
 313                 Hooks::runWithoutAbort( 'ParserOutputPostCacheTransform', [ $this, &$text, &$options ] );
 314
 315                 if ( $options['wrapperDivClass'] !== '' && !$options['unwrap'] ) {
 316                         $text = Html::rawElement( 'div', [ 'class' => $options['wrapperDivClass'] ], $text );
 317                 }
 318
 319                 if ( $options['enableSectionEditLinks'] ) {
 320                         $text = preg_replace_callback(
 321                                 self::EDITSECTION_REGEX,
 322                                 function ( $m ) {
 323                                         $editsectionPage = Title::newFromText( htmlspecialchars_decode( $m[1] ) );
 324                                         $editsectionSection = htmlspecialchars_decode( $m[2] );
 325                                         $editsectionContent = isset( $m[4] ) ? Sanitizer::decodeCharReferences( $m[3] ) : null;
 326
 327                                         if ( !is_object( $editsectionPage ) ) {
 328                                                 throw new MWException( "Bad parser output text." );
 329                                         }
 330
 331                                         $context = RequestContext::getMain();
 332                                         return $context->getSkin()->doEditSectionLink(
 333                                                 $editsectionPage,
 334                                                 $editsectionSection,
 335                                                 $editsectionContent,
 336                                                 $context->getLanguage()
 337                                         );
 338                                 },
 339                                 $text
 340                         );
 341                 } else {
 342                         $text = preg_replace( self::EDITSECTION_REGEX, '', $text );
 343                 }
 344
 345                 if ( $options['allowTOC'] ) {
 346                         $text = str_replace( [ Parser::TOC_START, Parser::TOC_END ], '', $text );
 347                 } else {
 348                         $text = preg_replace(
 349                                 '#' . preg_quote( Parser::TOC_START, '#' ) . '.*?' . preg_quote( Parser::TOC_END, '#' ) . '#s',
 350                                 '',
 351                                 $text
 352                         );
 353                 }
 354
 355                 if ( $options['deduplicateStyles'] ) {
 356                         $seen = [];
 357                         $text = preg_replace_callback(
 358                                 '#<style\s+([^>]*data-mw-deduplicate\s*=[^>]*)>.*?</style>#s',
 359                                 function ( $m ) use ( &$seen ) {
 360                                         $attr = Sanitizer::decodeTagAttributes( $m[1] );
 361                                         if ( !isset( $attr['data-mw-deduplicate'] ) ) {
 362                                                 return $m[0];
 363                                         }
 364
 365                                         $key = $attr['data-mw-deduplicate'];
 366                                         if ( !isset( $seen[$key] ) ) {
 367                                                 $seen[$key] = true;
 368                                                 return $m[0];
 369                                         }
 370
 371                                         // We were going to use an empty <style> here, but there
 372                                         // was concern that would be too much overhead for browsers.
 373                                         // So let's hope a <link> with a non-standard rel and href isn't
 374                                         // going to be misinterpreted or mangled by any subsequent processing.
 375                                         return Html::element( 'link', [
 376                                                 'rel' => 'mw-deduplicated-inline-style',
 377                                                 'href' => "mw-data:" . wfUrlencode( $key ),
 378                                         ] );
 379                                 },
 380                                 $text
 381                         );
 382                 }
 383
 384                 // Hydrate slot section header placeholders generated by RevisionRenderer.
 385                 $text = preg_replace_callback(
 386                         '#<mw:slotheader>(.*?)</mw:slotheader>#',
 387                         function ( $m ) {
 388                                 $role = htmlspecialchars_decode( $m[1] );
 389                                 // TODO: map to message, using the interface language. Set lang="xyz" accordingly.
 390                                 $headerText = $role;
 391                                 return $headerText;
 392                         },
 393                         $text
 394                 );
 395                 return $text;
 396         }
 397
 398         /**
 399          * Add a CSS class to use for the wrapping div. If no class is given, no wrapper is added.
 400          *
 401          * @param string $class
 402          */
 403         public function addWrapperDivClass( $class ) {
 404                 $this->mWrapperDivClasses[$class] = true;
 405         }
 406
 407         /**
 408          * Clears the CSS class to use for the wrapping div, effectively disabling the wrapper div
 409          * until addWrapperDivClass() is called.
 410          */
 411         public function clearWrapperDivClass() {
 412                 $this->mWrapperDivClasses = [];
 413         }
 414
 415         /**
 416          * Returns the class (or classes) to be used with the wrapper div for this otuput.
 417          * If there is no wrapper class given, no wrapper div should be added.
 418          * The wrapper div is added automatically by getText().
 419          *
 420          * @return string
 421          */
 422         public function getWrapperDivClass() {
 423                 return implode( ' ', array_keys( $this->mWrapperDivClasses ) );
 424         }
 425
 426         /**
 427          * @param int $id
 428          * @since 1.28
 429          */
 430         public function setSpeculativeRevIdUsed( $id ) {
 431                 $this->mSpeculativeRevId = $id;
 432         }
 433
 434         /**
 435          * @return int|null
 436          * @since 1.28
 437          */
 438         public function getSpeculativeRevIdUsed() {
 439                 return $this->mSpeculativeRevId;
 440         }
 441
 442         public function &getLanguageLinks() {
 443                 return $this->mLanguageLinks;
 444         }
 445
 446         public function getInterwikiLinks() {
 447                 return $this->mInterwikiLinks;
 448         }
 449
 450         public function getCategoryLinks() {
 451                 return array_keys( $this->mCategories );
 452         }
 453
 454         public function &getCategories() {
 455                 return $this->mCategories;
 456         }
 457
 458         /**
 459          * @return array
 460          * @since 1.25
 461          */
 462         public function getIndicators() {
 463                 return $this->mIndicators;
 464         }
 465
 466         public function getTitleText() {
 467                 return $this->mTitleText;
 468         }
 469
 470         public function getSections() {
 471                 return $this->mSections;
 472         }
 473
 474         public function &getLinks() {
 475                 return $this->mLinks;
 476         }
 477
 478         public function &getTemplates() {
 479                 return $this->mTemplates;
 480         }
 481
 482         public function &getTemplateIds() {
 483                 return $this->mTemplateIds;
 484         }
 485
 486         public function &getImages() {
 487                 return $this->mImages;
 488         }
 489
 490         public function &getFileSearchOptions() {
 491                 return $this->mFileSearchOptions;
 492         }
 493
 494         public function &getExternalLinks() {
 495                 return $this->mExternalLinks;
 496         }
 497
 498         public function setNoGallery( $value ) {
 499                 $this->mNoGallery = (bool)$value;
 500         }
 501
 502         public function getNoGallery() {
 503                 return $this->mNoGallery;
 504         }
 505
 506         public function getHeadItems() {
 507                 return $this->mHeadItems;
 508         }
 509
 510         public function getModules() {
 511                 return $this->mModules;
 512         }
 513
 514         public function getModuleStyles() {
 515                 return $this->mModuleStyles;
 516         }
 517
 518         /**
 519          * @return array
 520          * @since 1.23
 521          */
 522         public function getJsConfigVars() {
 523                 return $this->mJsConfigVars;
 524         }
 525
 526         public function getOutputHooks() {
 527                 return (array)$this->mOutputHooks;
 528         }
 529
 530         public function getWarnings() {
 531                 return array_keys( $this->mWarnings );
 532         }
 533
 534         public function getIndexPolicy() {
 535                 return $this->mIndexPolicy;
 536         }
 537
 538         public function getTOCHTML() {
 539                 return $this->mTOCHTML;
 540         }
 541
 542         /**
 543          * @return string|null TS_MW timestamp of the revision content
 544          */
 545         public function getTimestamp() {
 546                 return $this->mTimestamp;
 547         }
 548
 549         public function getLimitReportData() {
 550                 return $this->mLimitReportData;
 551         }
 552
 553         public function getLimitReportJSData() {
 554                 return $this->mLimitReportJSData;
 555         }
 556
 557         public function getEnableOOUI() {
 558                 return $this->mEnableOOUI;
 559         }
 560
 561         public function setText( $text ) {
 562                 return wfSetVar( $this->mText, $text );
 563         }
 564
 565         public function setLanguageLinks( $ll ) {
 566                 return wfSetVar( $this->mLanguageLinks, $ll );
 567         }
 568
 569         public function setCategoryLinks( $cl ) {
 570                 return wfSetVar( $this->mCategories, $cl );
 571         }
 572
 573         public function setTitleText( $t ) {
 574                 return wfSetVar( $this->mTitleText, $t );
 575         }
 576
 577         public function setSections( $toc ) {
 578                 return wfSetVar( $this->mSections, $toc );
 579         }
 580
 581         public function setIndexPolicy( $policy ) {
 582                 return wfSetVar( $this->mIndexPolicy, $policy );
 583         }
 584
 585         public function setTOCHTML( $tochtml ) {
 586                 return wfSetVar( $this->mTOCHTML, $tochtml );
 587         }
 588
 589         public function setTimestamp( $timestamp ) {
 590                 return wfSetVar( $this->mTimestamp, $timestamp );
 591         }
 592
 593         public function addCategory( $c, $sort ) {
 594                 $this->mCategories[$c] = $sort;
 595         }
 596
 597         /**
 598          * @param string $id
 599          * @param string $content
 600          * @since 1.25
 601          */
 602         public function setIndicator( $id, $content ) {
 603                 $this->mIndicators[$id] = $content;
 604         }
 605
 606         /**
 607          * Enables OOUI, if true, in any OutputPage instance this ParserOutput
 608          * object is added to.
 609          *
 610          * @since 1.26
 611          * @param bool $enable If OOUI should be enabled or not
 612          */
 613         public function setEnableOOUI( $enable = false ) {
 614                 $this->mEnableOOUI = $enable;
 615         }
 616
 617         public function addLanguageLink( $t ) {
 618                 $this->mLanguageLinks[] = $t;
 619         }
 620
 621         public function addWarning( $s ) {
 622                 $this->mWarnings[$s] = 1;
 623         }
 624
 625         public function addOutputHook( $hook, $data = false ) {
 626                 $this->mOutputHooks[] = [ $hook, $data ];
 627         }
 628
 629         public function setNewSection( $value ) {
 630                 $this->mNewSection = (bool)$value;
 631         }
 632
 633         public function hideNewSection( $value ) {
 634                 $this->mHideNewSection = (bool)$value;
 635         }
 636
 637         public function getHideNewSection() {
 638                 return (bool)$this->mHideNewSection;
 639         }
 640
 641         public function getNewSection() {
 642                 return (bool)$this->mNewSection;
 643         }
 644
 645         /**
 646          * Checks, if a url is pointing to the own server
 647          *
 648          * @param string $internal The server to check against
 649          * @param string $url The url to check
 650          * @return bool
 651          */
 652         public static function isLinkInternal( $internal, $url ) {
 653                 return (bool)preg_match( '/^' .
 654                         # If server is proto relative, check also for http/https links
 655                         ( substr( $internal, 0, 2 ) === '//' ? '(?:https?:)?' : '' ) .
 656                         preg_quote( $internal, '/' ) .
 657                         # check for query/path/anchor or end of link in each case
 658                         '(?:[\?\/\#]|$)/i',
 659                         $url
 660                 );
 661         }
 662
 663         public function addExternalLink( $url ) {
 664                 # We don't register links pointing to our own server, unless... :-)
 665                 global $wgServer, $wgRegisterInternalExternals;
 666
 667                 # Replace unnecessary URL escape codes with the referenced character
 668                 # This prevents spammers from hiding links from the filters
 669                 $url = Parser::normalizeLinkUrl( $url );
 670
 671                 $registerExternalLink = true;
 672                 if ( !$wgRegisterInternalExternals ) {
 673                         $registerExternalLink = !self::isLinkInternal( $wgServer, $url );
 674                 }
 675                 if ( $registerExternalLink ) {
 676                         $this->mExternalLinks[$url] = 1;
 677                 }
 678         }
 679
 680         /**
 681          * Record a local or interwiki inline link for saving in future link tables.
 682          *
 683          * @param Title $title
 684          * @param int|null $id Optional known page_id so we can skip the lookup
 685          */
 686         public function addLink( Title $title, $id = null ) {
 687                 if ( $title->isExternal() ) {
 688                         // Don't record interwikis in pagelinks
 689                         $this->addInterwikiLink( $title );
 690                         return;
 691                 }
 692                 $ns = $title->getNamespace();
 693                 $dbk = $title->getDBkey();
 694                 if ( $ns == NS_MEDIA ) {
 695                         // Normalize this pseudo-alias if it makes it down here...
 696                         $ns = NS_FILE;
 697                 } elseif ( $ns == NS_SPECIAL ) {
 698                         // We don't record Special: links currently
 699                         // It might actually be wise to, but we'd need to do some normalization.
 700                         return;
 701                 } elseif ( $dbk === '' ) {
 702                         // Don't record self links -  [[#Foo]]
 703                         return;
 704                 }
 705                 if ( !isset( $this->mLinks[$ns] ) ) {
 706                         $this->mLinks[$ns] = [];
 707                 }
 708                 if ( is_null( $id ) ) {
 709                         $id = $title->getArticleID();
 710                 }
 711                 $this->mLinks[$ns][$dbk] = $id;
 712         }
 713
 714         /**
 715          * Register a file dependency for this output
 716          * @param string $name Title dbKey
 717          * @param string|false|null $timestamp MW timestamp of file creation (or false if non-existing)
 718          * @param string|false|null $sha1 Base 36 SHA-1 of file (or false if non-existing)
 719          */
 720         public function addImage( $name, $timestamp = null, $sha1 = null ) {
 721                 $this->mImages[$name] = 1;
 722                 if ( $timestamp !== null && $sha1 !== null ) {
 723                         $this->mFileSearchOptions[$name] = [ 'time' => $timestamp, 'sha1' => $sha1 ];
 724                 }
 725         }
 726
 727         /**
 728          * Register a template dependency for this output
 729          * @param Title $title
 730          * @param int $page_id
 731          * @param int $rev_id
 732          */
 733         public function addTemplate( $title, $page_id, $rev_id ) {
 734                 $ns = $title->getNamespace();
 735                 $dbk = $title->getDBkey();
 736                 if ( !isset( $this->mTemplates[$ns] ) ) {
 737                         $this->mTemplates[$ns] = [];
 738                 }
 739                 $this->mTemplates[$ns][$dbk] = $page_id;
 740                 if ( !isset( $this->mTemplateIds[$ns] ) ) {
 741                         $this->mTemplateIds[$ns] = [];
 742                 }
 743                 $this->mTemplateIds[$ns][$dbk] = $rev_id; // For versioning
 744         }
 745
 746         /**
 747          * @param Title $title Title object, must be an interwiki link
 748          * @throws MWException If given invalid input
 749          */
 750         public function addInterwikiLink( $title ) {
 751                 if ( !$title->isExternal() ) {
 752                         throw new MWException( 'Non-interwiki link passed, internal parser error.' );
 753                 }
 754                 $prefix = $title->getInterwiki();
 755                 if ( !isset( $this->mInterwikiLinks[$prefix] ) ) {
 756                         $this->mInterwikiLinks[$prefix] = [];
 757                 }
 758                 $this->mInterwikiLinks[$prefix][$title->getDBkey()] = 1;
 759         }
 760
 761         /**
 762          * Add some text to the "<head>".
 763          * If $tag is set, the section with that tag will only be included once
 764          * in a given page.
 765          * @param string $section
 766          * @param string|bool $tag
 767          */
 768         public function addHeadItem( $section, $tag = false ) {
 769                 if ( $tag !== false ) {
 770                         $this->mHeadItems[$tag] = $section;
 771                 } else {
 772                         $this->mHeadItems[] = $section;
 773                 }
 774         }
 775
 776         /**
 777          * @see OutputPage::addModules
 778          */
 779         public function addModules( $modules ) {
 780                 $this->mModules = array_merge( $this->mModules, (array)$modules );
 781         }
 782
 783         /**
 784          * @see OutputPage::addModuleStyles
 785          */
 786         public function addModuleStyles( $modules ) {
 787                 $this->mModuleStyles = array_merge( $this->mModuleStyles, (array)$modules );
 788         }
 789
 790         /**
 791          * Add one or more variables to be set in mw.config in JavaScript.
 792          *
 793          * @param string|array $keys Key or array of key/value pairs.
 794          * @param mixed|null $value [optional] Value of the configuration variable.
 795          * @since 1.23
 796          */
 797         public function addJsConfigVars( $keys, $value = null ) {
 798                 if ( is_array( $keys ) ) {
 799                         foreach ( $keys as $key => $value ) {
 800                                 $this->mJsConfigVars[$key] = $value;
 801                         }
 802                         return;
 803                 }
 804
 805                 $this->mJsConfigVars[$keys] = $value;
 806         }
 807
 808         /**
 809          * Copy items from the OutputPage object into this one
 810          *
 811          * @param OutputPage $out
 812          */
 813         public function addOutputPageMetadata( OutputPage $out ) {
 814                 $this->addModules( $out->getModules() );
 815                 $this->addModuleStyles( $out->getModuleStyles() );
 816                 $this->addJsConfigVars( $out->getJsConfigVars() );
 817
 818                 $this->mHeadItems = array_merge( $this->mHeadItems, $out->getHeadItemsArray() );
 819                 $this->mPreventClickjacking = $this->mPreventClickjacking || $out->getPreventClickjacking();
 820         }
 821
 822         /**
 823          * Add a tracking category, getting the title from a system message,
 824          * or print a debug message if the title is invalid.
 825          *
 826          * Any message used with this function should be registered so it will
 827          * show up on Special:TrackingCategories. Core messages should be added
 828          * to SpecialTrackingCategories::$coreTrackingCategories, and extensions
 829          * should add to "TrackingCategories" in their extension.json.
 830          *
 831          * @todo Migrate some code to TrackingCategories
 832          *
 833          * @param string $msg Message key
 834          * @param Title $title title of the page which is being tracked
 835          * @return bool Whether the addition was successful
 836          * @since 1.25
 837          */
 838         public function addTrackingCategory( $msg, $title ) {
 839                 if ( $title->isSpecialPage() ) {
 840                         wfDebug( __METHOD__ . ": Not adding tracking category $msg to special page!\n" );
 841                         return false;
 842                 }
 843
 844                 // Important to parse with correct title (T33469)
 845                 $cat = wfMessage( $msg )
 846                         ->title( $title )
 847                         ->inContentLanguage()
 848                         ->text();
 849
 850                 # Allow tracking categories to be disabled by setting them to "-"
 851                 if ( $cat === '-' ) {
 852                         return false;
 853                 }
 854
 855                 $containerCategory = Title::makeTitleSafe( NS_CATEGORY, $cat );
 856                 if ( $containerCategory ) {
 857                         $this->addCategory( $containerCategory->getDBkey(), $this->getProperty( 'defaultsort' ) ?: '' );
 858                         return true;
 859                 } else {
 860                         wfDebug( __METHOD__ . ": [[MediaWiki:$msg]] is not a valid title!\n" );
 861                         return false;
 862                 }
 863         }
 864
 865         /**
 866          * Override the title to be used for display
 867          *
 868          * @note this is assumed to have been validated
 869          * (check equal normalisation, etc.)
 870          *
 871          * @note this is expected to be safe HTML,
 872          * ready to be served to the client.
 873          *
 874          * @param string $text Desired title text
 875          */
 876         public function setDisplayTitle( $text ) {
 877                 $this->setTitleText( $text );
 878                 $this->setProperty( 'displaytitle', $text );
 879         }
 880
 881         /**
 882          * Get the title to be used for display.
 883          *
 884          * As per the contract of setDisplayTitle(), this is safe HTML,
 885          * ready to be served to the client.
 886          *
 887          * @return string HTML
 888          */
 889         public function getDisplayTitle() {
 890                 $t = $this->getTitleText();
 891                 if ( $t === '' ) {
 892                         return false;
 893                 }
 894                 return $t;
 895         }
 896
 897         /**
 898          * Fairly generic flag setter thingy.
 899          * @param string $flag
 900          */
 901         public function setFlag( $flag ) {
 902                 $this->mFlags[$flag] = true;
 903         }
 904
 905         public function getFlag( $flag ) {
 906                 return isset( $this->mFlags[$flag] );
 907         }
 908
 909         /**
 910          * Set a property to be stored in the page_props database table.
 911          *
 912          * page_props is a key value store indexed by the page ID. This allows
 913          * the parser to set a property on a page which can then be quickly
 914          * retrieved given the page ID or via a DB join when given the page
 915          * title.
 916          *
 917          * Since 1.23, page_props are also indexed by numeric value, to allow
 918          * for efficient "top k" queries of pages wrt a given property.
 919          *
 920          * setProperty() is thus used to propagate properties from the parsed
 921          * page to request contexts other than a page view of the currently parsed
 922          * article.
 923          *
 924          * Some applications examples:
 925          *
 926          *   * To implement hidden categories, hiding pages from category listings
 927          *     by storing a property.
 928          *
 929          *   * Overriding the displayed article title (ParserOutput::setDisplayTitle()).
 930          *
 931          *   * To implement image tagging, for example displaying an icon on an
 932          *     image thumbnail to indicate that it is listed for deletion on
 933          *     Wikimedia Commons.
 934          *     This is not actually implemented, yet but would be pretty cool.
 935          *
 936          * @note Do not use setProperty() to set a property which is only used
 937          * in a context where the ParserOutput object itself is already available,
 938          * for example a normal page view. There is no need to save such a property
 939          * in the database since the text is already parsed. You can just hook
 940          * OutputPageParserOutput and get your data out of the ParserOutput object.
 941          *
 942          * If you are writing an extension where you want to set a property in the
 943          * parser which is used by an OutputPageParserOutput hook, you have to
 944          * associate the extension data directly with the ParserOutput object.
 945          * Since MediaWiki 1.21, you can use setExtensionData() to do this:
 946          *
 947          * @par Example:
 948          * @code
 949          *    $parser->getOutput()->setExtensionData( 'my_ext_foo', '...' );
 950          * @endcode
 951          *
 952          * And then later, in OutputPageParserOutput or similar:
 953          *
 954          * @par Example:
 955          * @code
 956          *    $output->getExtensionData( 'my_ext_foo' );
 957          * @endcode
 958          *
 959          * In MediaWiki 1.20 and older, you have to use a custom member variable
 960          * within the ParserOutput object:
 961          *
 962          * @par Example:
 963          * @code
 964          *    $parser->getOutput()->my_ext_foo = '...';
 965          * @endcode
 966          * @param string $name
 967          * @param mixed $value
 968          */
 969         public function setProperty( $name, $value ) {
 970                 $this->mProperties[$name] = $value;
 971         }
 972
 973         /**
 974          * @param string $name The property name to look up.
 975          *
 976          * @return mixed|bool The value previously set using setProperty(). False if null or no value
 977          * was set for the given property name.
 978          *
 979          * @note You need to use getProperties() to check for boolean and null properties.
 980          */
 981         public function getProperty( $name ) {
 982                 return $this->mProperties[$name] ?? false;
 983         }
 984
 985         public function unsetProperty( $name ) {
 986                 unset( $this->mProperties[$name] );
 987         }
 988
 989         public function getProperties() {
 990                 if ( !isset( $this->mProperties ) ) {
 991                         $this->mProperties = [];
 992                 }
 993                 return $this->mProperties;
 994         }
 995
 996         /**
 997          * Returns the options from its ParserOptions which have been taken
 998          * into account to produce this output.
 999          * @return string[]
1000          */
1001         public function getUsedOptions() {
1002                 if ( !isset( $this->mAccessedOptions ) ) {
1003                         return [];
1004                 }
1005                 return array_keys( $this->mAccessedOptions );
1006         }
1007
1008         /**
1009          * Tags a parser option for use in the cache key for this parser output.
1010          * Registered as a watcher at ParserOptions::registerWatcher() by Parser::clearState().
1011          * The information gathered here is available via getUsedOptions(),
1012          * and is used by ParserCache::save().
1013          *
1014          * @see ParserCache::getKey
1015          * @see ParserCache::save
1016          * @see ParserOptions::addExtraKey
1017          * @see ParserOptions::optionsHash
1018          * @param string $option
1019          */
1020         public function recordOption( $option ) {
1021                 $this->mAccessedOptions[$option] = true;
1022         }
1023
1024         /**
1025          * Attaches arbitrary data to this ParserObject. This can be used to store some information in
1026          * the ParserOutput object for later use during page output. The data will be cached along with
1027          * the ParserOutput object, but unlike data set using setProperty(), it is not recorded in the
1028          * database.
1029          *
1030          * This method is provided to overcome the unsafe practice of attaching extra information to a
1031          * ParserObject by directly assigning member variables.
1032          *
1033          * To use setExtensionData() to pass extension information from a hook inside the parser to a
1034          * hook in the page output, use this in the parser hook:
1035          *
1036          * @par Example:
1037          * @code
1038          *    $parser->getOutput()->setExtensionData( 'my_ext_foo', '...' );
1039          * @endcode
1040          *
1041          * And then later, in OutputPageParserOutput or similar:
1042          *
1043          * @par Example:
1044          * @code
1045          *    $output->getExtensionData( 'my_ext_foo' );
1046          * @endcode
1047          *
1048          * In MediaWiki 1.20 and older, you have to use a custom member variable
1049          * within the ParserOutput object:
1050          *
1051          * @par Example:
1052          * @code
1053          *    $parser->getOutput()->my_ext_foo = '...';
1054          * @endcode
1055          *
1056          * @since 1.21
1057          *
1058          * @param string $key The key for accessing the data. Extensions should take care to avoid
1059          *   conflicts in naming keys. It is suggested to use the extension's name as a prefix.
1060          *
1061          * @param mixed $value The value to set. Setting a value to null is equivalent to removing
1062          *   the value.
1063          */
1064         public function setExtensionData( $key, $value ) {
1065                 if ( $value === null ) {
1066                         unset( $this->mExtensionData[$key] );
1067                 } else {
1068                         $this->mExtensionData[$key] = $value;
1069                 }
1070         }
1071
1072         /**
1073          * Gets extensions data previously attached to this ParserOutput using setExtensionData().
1074          * Typically, such data would be set while parsing the page, e.g. by a parser function.
1075          *
1076          * @since 1.21
1077          *
1078          * @param string $key The key to look up.
1079          *
1080          * @return mixed|null The value previously set for the given key using setExtensionData()
1081          *         or null if no value was set for this key.
1082          */
1083         public function getExtensionData( $key ) {
1084                 return $this->mExtensionData[$key] ?? null;
1085         }
1086
1087         private static function getTimes( $clock = null ) {
1088                 $ret = [];
1089                 if ( !$clock || $clock === 'wall' ) {
1090                         $ret['wall'] = microtime( true );
1091                 }
1092                 if ( !$clock || $clock === 'cpu' ) {
1093                         $ru = wfGetRusage();
1094                         if ( $ru ) {
1095                                 $ret['cpu'] = $ru['ru_utime.tv_sec'] + $ru['ru_utime.tv_usec'] / 1e6;
1096                                 $ret['cpu'] += $ru['ru_stime.tv_sec'] + $ru['ru_stime.tv_usec'] / 1e6;
1097                         }
1098                 }
1099                 return $ret;
1100         }
1101
1102         /**
1103          * Resets the parse start timestamps for future calls to getTimeSinceStart()
1104          * @since 1.22
1105          */
1106         public function resetParseStartTime() {
1107                 $this->mParseStartTime = self::getTimes();
1108         }
1109
1110         /**
1111          * Returns the time since resetParseStartTime() was last called
1112          *
1113          * Clocks available are:
1114          *  - wall: Wall clock time
1115          *  - cpu: CPU time (requires getrusage)
1116          *
1117          * @since 1.22
1118          * @param string $clock
1119          * @return float|null
1120          */
1121         public function getTimeSinceStart( $clock ) {
1122                 if ( !isset( $this->mParseStartTime[$clock] ) ) {
1123                         return null;
1124                 }
1125
1126                 $end = self::getTimes( $clock );
1127                 return $end[$clock] - $this->mParseStartTime[$clock];
1128         }
1129
1130         /**
1131          * Sets parser limit report data for a key
1132          *
1133          * The key is used as the prefix for various messages used for formatting:
1134          *  - $key: The label for the field in the limit report
1135          *  - $key-value-text: Message used to format the value in the "NewPP limit
1136          *      report" HTML comment. If missing, uses $key-format.
1137          *  - $key-value-html: Message used to format the value in the preview
1138          *      limit report table. If missing, uses $key-format.
1139          *  - $key-value: Message used to format the value. If missing, uses "$1".
1140          *
1141          * Note that all values are interpreted as wikitext, and so should be
1142          * encoded with htmlspecialchars() as necessary, but should avoid complex
1143          * HTML for sanity of display in the "NewPP limit report" comment.
1144          *
1145          * @since 1.22
1146          * @param string $key Message key
1147          * @param mixed $value Appropriate for Message::params()
1148          */
1149         public function setLimitReportData( $key, $value ) {
1150                 $this->mLimitReportData[$key] = $value;
1151
1152                 if ( is_array( $value ) ) {
1153                         if ( array_keys( $value ) === [ 0, 1 ]
1154                                 && is_numeric( $value[0] )
1155                                 && is_numeric( $value[1] )
1156                         ) {
1157                                 $data = [ 'value' => $value[0], 'limit' => $value[1] ];
1158                         } else {
1159                                 $data = $value;
1160                         }
1161                 } else {
1162                         $data = $value;
1163                 }
1164
1165                 if ( strpos( $key, '-' ) ) {
1166                         list( $ns, $name ) = explode( '-', $key, 2 );
1167                         $this->mLimitReportJSData[$ns][$name] = $data;
1168                 } else {
1169                         $this->mLimitReportJSData[$key] = $data;
1170                 }
1171         }
1172
1173         /**
1174          * Check whether the cache TTL was lowered due to dynamic content
1175          *
1176          * When content is determined by more than hard state (e.g. page edits),
1177          * such as template/file transclusions based on the current timestamp or
1178          * extension tags that generate lists based on queries, this return true.
1179          *
1180          * @return bool
1181          * @since 1.25
1182          */
1183         public function hasDynamicContent() {
1184                 global $wgParserCacheExpireTime;
1185
1186                 return $this->getCacheExpiry() < $wgParserCacheExpireTime;
1187         }
1188
1189         /**
1190          * Get or set the prevent-clickjacking flag
1191          *
1192          * @since 1.24
1193          * @param bool|null $flag New flag value, or null to leave it unchanged
1194          * @return bool Old flag value
1195          */
1196         public function preventClickjacking( $flag = null ) {
1197                 return wfSetVar( $this->mPreventClickjacking, $flag );
1198         }
1199
1200         /**
1201          * Lower the runtime adaptive TTL to at most this value
1202          *
1203          * @param int $ttl
1204          * @since 1.28
1205          */
1206         public function updateRuntimeAdaptiveExpiry( $ttl ) {
1207                 $this->mMaxAdaptiveExpiry = min( $ttl, $this->mMaxAdaptiveExpiry );
1208                 $this->updateCacheExpiry( $ttl );
1209         }
1210
1211         /**
1212          * Call this when parsing is done to lower the TTL based on low parse times
1213          *
1214          * @since 1.28
1215          */
1216         public function finalizeAdaptiveCacheExpiry() {
1217                 if ( is_infinite( $this->mMaxAdaptiveExpiry ) ) {
1218                         return; // not set
1219                 }
1220
1221                 $runtime = $this->getTimeSinceStart( 'wall' );
1222                 if ( is_float( $runtime ) ) {
1223                         $slope = ( self::SLOW_AR_TTL - self::FAST_AR_TTL )
1224                                 / ( self::PARSE_SLOW_SEC - self::PARSE_FAST_SEC );
1225                         // SLOW_AR_TTL = PARSE_SLOW_SEC * $slope + $point
1226                         $point = self::SLOW_AR_TTL - self::PARSE_SLOW_SEC * $slope;
1227
1228                         $adaptiveTTL = min(
1229                                 max( $slope * $runtime + $point, self::MIN_AR_TTL ),
1230                                 $this->mMaxAdaptiveExpiry
1231                         );
1232                         $this->updateCacheExpiry( $adaptiveTTL );
1233                 }
1234         }
1235
1236         public function __sleep() {
1237                 return array_diff(
1238                         array_keys( get_object_vars( $this ) ),
1239                         [ 'mParseStartTime' ]
1240                 );
1241         }
1242
1243         /**
1244          * Merges internal metadata such as flags, accessed options, and profiling info
1245          * from $source into this ParserOutput. This should be used whenever the state of $source
1246          * has any impact on the state of this ParserOutput.
1247          *
1248          * @param ParserOutput $source
1249          */
1250         public function mergeInternalMetaDataFrom( ParserOutput $source ) {
1251                 $this->mOutputHooks = self::mergeList( $this->mOutputHooks, $source->getOutputHooks() );
1252                 $this->mWarnings = self::mergeMap( $this->mWarnings, $source->mWarnings ); // don't use getter
1253                 $this->mTimestamp = $this->useMaxValue( $this->mTimestamp, $source->getTimestamp() );
1254
1255                 if ( $this->mSpeculativeRevId && $source->mSpeculativeRevId
1256                         && $this->mSpeculativeRevId !== $source->mSpeculativeRevId
1257                 ) {
1258                         wfLogWarning(
1259                                 'Inconsistent speculative revision ID encountered while merging parser output!'
1260                         );
1261                 }
1262
1263                 $this->mSpeculativeRevId = $this->useMaxValue(
1264                         $this->mSpeculativeRevId,
1265                         $source->getSpeculativeRevIdUsed()
1266                 );
1267                 $this->mParseStartTime = $this->useEachMinValue(
1268                         $this->mParseStartTime,
1269                         $source->mParseStartTime
1270                 );
1271
1272                 $this->mFlags = self::mergeMap( $this->mFlags, $source->mFlags );
1273                 $this->mAccessedOptions = self::mergeMap( $this->mAccessedOptions, $source->mAccessedOptions );
1274
1275                 // TODO: maintain per-slot limit reports!
1276                 if ( empty( $this->mLimitReportData ) ) {
1277                         $this->mLimitReportData = $source->mLimitReportData;
1278                 }
1279                 if ( empty( $this->mLimitReportJSData ) ) {
1280                         $this->mLimitReportJSData = $source->mLimitReportJSData;
1281                 }
1282         }
1283
1284         /**
1285          * Merges HTML metadata such as head items, JS config vars, and HTTP cache control info
1286          * from $source into this ParserOutput. This should be used whenever the HTML in $source
1287          * has been somehow mered into the HTML of this ParserOutput.
1288          *
1289          * @param ParserOutput $source
1290          */
1291         public function mergeHtmlMetaDataFrom( ParserOutput $source ) {
1292                 // HTML and HTTP
1293                 $this->mHeadItems = self::mergeMixedList( $this->mHeadItems, $source->getHeadItems() );
1294                 $this->mModules = self::mergeList( $this->mModules, $source->getModules() );
1295                 $this->mModuleStyles = self::mergeList( $this->mModuleStyles, $source->getModuleStyles() );
1296                 $this->mJsConfigVars = self::mergeMap( $this->mJsConfigVars, $source->getJsConfigVars() );
1297                 $this->mMaxAdaptiveExpiry = min( $this->mMaxAdaptiveExpiry, $source->mMaxAdaptiveExpiry );
1298
1299                 // "noindex" always wins!
1300                 if ( $this->mIndexPolicy === 'noindex' || $source->mIndexPolicy === 'noindex' ) {
1301                         $this->mIndexPolicy = 'noindex';
1302                 } elseif ( $this->mIndexPolicy !== 'index' ) {
1303                         $this->mIndexPolicy = $source->mIndexPolicy;
1304                 }
1305
1306                 // Skin control
1307                 $this->mNewSection = $this->mNewSection || $source->getNewSection();
1308                 $this->mHideNewSection = $this->mHideNewSection || $source->getHideNewSection();
1309                 $this->mNoGallery = $this->mNoGallery || $source->getNoGallery();
1310                 $this->mEnableOOUI = $this->mEnableOOUI || $source->getEnableOOUI();
1311                 $this->mPreventClickjacking = $this->mPreventClickjacking || $source->preventClickjacking();
1312
1313                 // TODO: we'll have to be smarter about this!
1314                 $this->mSections = array_merge( $this->mSections, $source->getSections() );
1315                 $this->mTOCHTML .= $source->mTOCHTML;
1316
1317                 // XXX: we don't want to concatenate title text, so first write wins.
1318                 // We should use the first *modified* title text, but we don't have the original to check.
1319                 if ( $this->mTitleText === null || $this->mTitleText === '' ) {
1320                         $this->mTitleText = $source->mTitleText;
1321                 }
1322
1323                 // class names are stored in array keys
1324                 $this->mWrapperDivClasses = self::mergeMap(
1325                         $this->mWrapperDivClasses,
1326                         $source->mWrapperDivClasses
1327                 );
1328
1329                 // NOTE: last write wins, same as within one ParserOutput
1330                 $this->mIndicators = self::mergeMap( $this->mIndicators, $source->getIndicators() );
1331
1332                 // NOTE: include extension data in "tracking meta data" as well as "html meta data"!
1333                 // TODO: add a $mergeStrategy parameter to setExtensionData to allow different
1334                 // kinds of extension data to be merged in different ways.
1335                 $this->mExtensionData = self::mergeMap(
1336                         $this->mExtensionData,
1337                         $source->mExtensionData
1338                 );
1339         }
1340
1341         /**
1342          * Merges dependency tracking metadata such as backlinks, images used, and extension data
1343          * from $source into this ParserOutput. This allows dependency tracking to be done for the
1344          * combined output of multiple content slots.
1345          *
1346          * @param ParserOutput $source
1347          */
1348         public function mergeTrackingMetaDataFrom( ParserOutput $source ) {
1349                 $this->mLanguageLinks = self::mergeList( $this->mLanguageLinks, $source->getLanguageLinks() );
1350                 $this->mCategories = self::mergeMap( $this->mCategories, $source->getCategories() );
1351                 $this->mLinks = self::merge2D( $this->mLinks, $source->getLinks() );
1352                 $this->mTemplates = self::merge2D( $this->mTemplates, $source->getTemplates() );
1353                 $this->mTemplateIds = self::merge2D( $this->mTemplateIds, $source->getTemplateIds() );
1354                 $this->mImages = self::mergeMap( $this->mImages, $source->getImages() );
1355                 $this->mFileSearchOptions = self::mergeMap(
1356                         $this->mFileSearchOptions,
1357                         $source->getFileSearchOptions()
1358                 );
1359                 $this->mExternalLinks = self::mergeMap( $this->mExternalLinks, $source->getExternalLinks() );
1360                 $this->mInterwikiLinks = self::merge2D(
1361                         $this->mInterwikiLinks,
1362                         $source->getInterwikiLinks()
1363                 );
1364
1365                 // TODO: add a $mergeStrategy parameter to setProperty to allow different
1366                 // kinds of properties to be merged in different ways.
1367                 $this->mProperties = self::mergeMap( $this->mProperties, $source->getProperties() );
1368
1369                 // NOTE: include extension data in "tracking meta data" as well as "html meta data"!
1370                 // TODO: add a $mergeStrategy parameter to setExtensionData to allow different
1371                 // kinds of extension data to be merged in different ways.
1372                 $this->mExtensionData = self::mergeMap(
1373                         $this->mExtensionData,
1374                         $source->mExtensionData
1375                 );
1376         }
1377
1378         private static function mergeMixedList( array $a, array $b ) {
1379                 return array_unique( array_merge( $a, $b ), SORT_REGULAR );
1380         }
1381
1382         private static function mergeList( array $a, array $b ) {
1383                 return array_values( array_unique( array_merge( $a, $b ), SORT_REGULAR ) );
1384         }
1385
1386         private static function mergeMap( array $a, array $b ) {
1387                 return array_replace( $a, $b );
1388         }
1389
1390         private static function merge2D( array $a, array $b ) {
1391                 $values = [];
1392                 $keys = array_merge( array_keys( $a ), array_keys( $b ) );
1393
1394                 foreach ( $keys as $k ) {
1395                         if ( empty( $a[$k] ) ) {
1396                                 $values[$k] = $b[$k];
1397                         } elseif ( empty( $b[$k] ) ) {
1398                                 $values[$k] = $a[$k];
1399                         } elseif ( is_array( $a[$k] ) && is_array( $b[$k] ) ) {
1400                                 $values[$k] = array_replace( $a[$k], $b[$k] );
1401                         } else {
1402                                 $values[$k] = $b[$k];
1403                         }
1404                 }
1405
1406                 return $values;
1407         }
1408
1409         private static function useEachMinValue( array $a, array $b ) {
1410                 $values = [];
1411                 $keys = array_merge( array_keys( $a ), array_keys( $b ) );
1412
1413                 foreach ( $keys as $k ) {
1414                         if ( is_array( $a[$k] ?? null ) && is_array( $b[$k] ?? null ) ) {
1415                                 $values[$k] = self::useEachMinValue( $a[$k], $b[$k] );
1416                         } else {
1417                                 $values[$k] = self::useMinValue( $a[$k] ?? null, $b[$k] ?? null );
1418                         }
1419                 }
1420
1421                 return $values;
1422         }
1423
1424         private static function useMinValue( $a, $b ) {
1425                 if ( $a === null ) {
1426                         return $b;
1427                 }
1428
1429                 if ( $b === null ) {
1430                         return $a;
1431                 }
1432
1433                 return min( $a, $b );
1434         }
1435
1436         private static function useMaxValue( $a, $b ) {
1437                 if ( $a === null ) {
1438                         return $b;
1439                 }
1440
1441                 if ( $b === null ) {
1442                         return $a;
1443                 }
1444
1445                 return max( $a, $b );
1446         }
1447
1448 }