includes/deferred/LinksUpdate.php

   1 <?php
   2 /**
   3  * Updater for link tracking tables after a page edit.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  */
  22
  23 /**
  24  * See docs/deferred.txt
  25  *
  26  * @todo document (e.g. one-sentence top-level class description).
  27  */
  28 class LinksUpdate extends SqlDataUpdate implements EnqueueableDataUpdate {
  29         // @todo make members protected, but make sure extensions don't break
  30
  31         /** @var int Page ID of the article linked from */
  32         public $mId;
  33
  34         /** @var Title Title object of the article linked from */
  35         public $mTitle;
  36
  37         /** @var ParserOutput */
  38         public $mParserOutput;
  39
  40         /** @var array Map of title strings to IDs for the links in the document */
  41         public $mLinks;
  42
  43         /** @var array DB keys of the images used, in the array key only */
  44         public $mImages;
  45
  46         /** @var array Map of title strings to IDs for the template references, including broken ones */
  47         public $mTemplates;
  48
  49         /** @var array URLs of external links, array key only */
  50         public $mExternals;
  51
  52         /** @var array Map of category names to sort keys */
  53         public $mCategories;
  54
  55         /** @var array Map of language codes to titles */
  56         public $mInterlangs;
  57
  58         /** @var array 2-D map of (prefix => DBK => 1) */
  59         public $mInterwikis;
  60
  61         /** @var array Map of arbitrary name to value */
  62         public $mProperties;
  63
  64         /** @var bool Whether to queue jobs for recursive updates */
  65         public $mRecursive;
  66
  67         /** @var Revision Revision for which this update has been triggered */
  68         private $mRevision;
  69
  70         /**
  71          * @var null|array Added links if calculated.
  72          */
  73         private $linkInsertions = null;
  74
  75         /**
  76          * @var null|array Deleted links if calculated.
  77          */
  78         private $linkDeletions = null;
  79
  80         /**
  81          * @var User|null
  82          */
  83         private $user;
  84
  85         /**
  86          * Constructor
  87          *
  88          * @param Title $title Title of the page we're updating
  89          * @param ParserOutput $parserOutput Output from a full parse of this page
  90          * @param bool $recursive Queue jobs for recursive updates?
  91          * @throws MWException
  92          */
  93         function __construct( Title $title, ParserOutput $parserOutput, $recursive = true ) {
  94                 parent::__construct( false ); // no implicit transaction
  95
  96                 $this->mTitle = $title;
  97                 $this->mId = $title->getArticleID( Title::GAID_FOR_UPDATE );
  98
  99                 if ( !$this->mId ) {
 100                         throw new InvalidArgumentException(
 101                                 "The Title object yields no ID. Perhaps the page doesn't exist?"
 102                         );
 103                 }
 104
 105                 $this->mParserOutput = $parserOutput;
 106
 107                 $this->mLinks = $parserOutput->getLinks();
 108                 $this->mImages = $parserOutput->getImages();
 109                 $this->mTemplates = $parserOutput->getTemplates();
 110                 $this->mExternals = $parserOutput->getExternalLinks();
 111                 $this->mCategories = $parserOutput->getCategories();
 112                 $this->mProperties = $parserOutput->getProperties();
 113                 $this->mInterwikis = $parserOutput->getInterwikiLinks();
 114
 115                 # Convert the format of the interlanguage links
 116                 # I didn't want to change it in the ParserOutput, because that array is passed all
 117                 # the way back to the skin, so either a skin API break would be required, or an
 118                 # inefficient back-conversion.
 119                 $ill = $parserOutput->getLanguageLinks();
 120                 $this->mInterlangs = [];
 121                 foreach ( $ill as $link ) {
 122                         list( $key, $title ) = explode( ':', $link, 2 );
 123                         $this->mInterlangs[$key] = $title;
 124                 }
 125
 126                 foreach ( $this->mCategories as &$sortkey ) {
 127                         # If the sortkey is longer then 255 bytes,
 128                         # it truncated by DB, and then doesn't get
 129                         # matched when comparing existing vs current
 130                         # categories, causing bug 25254.
 131                         # Also. substr behaves weird when given "".
 132                         if ( $sortkey !== '' ) {
 133                                 $sortkey = substr( $sortkey, 0, 255 );
 134                         }
 135                 }
 136
 137                 $this->mRecursive = $recursive;
 138
 139                 Hooks::run( 'LinksUpdateConstructed', [ &$this ] );
 140         }
 141
 142         /**
 143          * Update link tables with outgoing links from an updated article
 144          */
 145         public function doUpdate() {
 146                 Hooks::run( 'LinksUpdate', [ &$this ] );
 147                 $this->doIncrementalUpdate();
 148
 149                 $this->mDb->onTransactionIdle( function() {
 150                         Hooks::run( 'LinksUpdateComplete', [ &$this ] );
 151                 } );
 152         }
 153
 154         protected function doIncrementalUpdate() {
 155                 # Page links
 156                 $existing = $this->getExistingLinks();
 157                 $this->linkDeletions = $this->getLinkDeletions( $existing );
 158                 $this->linkInsertions = $this->getLinkInsertions( $existing );
 159                 $this->incrTableUpdate( 'pagelinks', 'pl', $this->linkDeletions, $this->linkInsertions );
 160
 161                 # Image links
 162                 $existing = $this->getExistingImages();
 163
 164                 $imageDeletes = $this->getImageDeletions( $existing );
 165                 $this->incrTableUpdate( 'imagelinks', 'il', $imageDeletes,
 166                         $this->getImageInsertions( $existing ) );
 167
 168                 # Invalidate all image description pages which had links added or removed
 169                 $imageUpdates = $imageDeletes + array_diff_key( $this->mImages, $existing );
 170                 $this->invalidateImageDescriptions( $imageUpdates );
 171
 172                 # External links
 173                 $existing = $this->getExistingExternals();
 174                 $this->incrTableUpdate( 'externallinks', 'el', $this->getExternalDeletions( $existing ),
 175                         $this->getExternalInsertions( $existing ) );
 176
 177                 # Language links
 178                 $existing = $this->getExistingInterlangs();
 179                 $this->incrTableUpdate( 'langlinks', 'll', $this->getInterlangDeletions( $existing ),
 180                         $this->getInterlangInsertions( $existing ) );
 181
 182                 # Inline interwiki links
 183                 $existing = $this->getExistingInterwikis();
 184                 $this->incrTableUpdate( 'iwlinks', 'iwl', $this->getInterwikiDeletions( $existing ),
 185                         $this->getInterwikiInsertions( $existing ) );
 186
 187                 # Template links
 188                 $existing = $this->getExistingTemplates();
 189                 $this->incrTableUpdate( 'templatelinks', 'tl', $this->getTemplateDeletions( $existing ),
 190                         $this->getTemplateInsertions( $existing ) );
 191
 192                 # Category links
 193                 $existing = $this->getExistingCategories();
 194
 195                 $categoryDeletes = $this->getCategoryDeletions( $existing );
 196
 197                 $this->incrTableUpdate( 'categorylinks', 'cl', $categoryDeletes,
 198                         $this->getCategoryInsertions( $existing ) );
 199
 200                 # Invalidate all categories which were added, deleted or changed (set symmetric difference)
 201                 $categoryInserts = array_diff_assoc( $this->mCategories, $existing );
 202                 $categoryUpdates = $categoryInserts + $categoryDeletes;
 203                 $this->invalidateCategories( $categoryUpdates );
 204                 $this->updateCategoryCounts( $categoryInserts, $categoryDeletes );
 205
 206                 # Page properties
 207                 $existing = $this->getExistingProperties();
 208
 209                 $propertiesDeletes = $this->getPropertyDeletions( $existing );
 210
 211                 $this->incrTableUpdate( 'page_props', 'pp', $propertiesDeletes,
 212                         $this->getPropertyInsertions( $existing ) );
 213
 214                 # Invalidate the necessary pages
 215                 $changed = $propertiesDeletes + array_diff_assoc( $this->mProperties, $existing );
 216                 $this->invalidateProperties( $changed );
 217
 218                 # Update the links table freshness for this title
 219                 $this->updateLinksTimestamp();
 220
 221                 # Refresh links of all pages including this page
 222                 # This will be in a separate transaction
 223                 if ( $this->mRecursive ) {
 224                         $this->queueRecursiveJobs();
 225                 }
 226
 227         }
 228
 229         /**
 230          * Queue recursive jobs for this page
 231          *
 232          * Which means do LinksUpdate on all pages that include the current page,
 233          * using the job queue.
 234          */
 235         protected function queueRecursiveJobs() {
 236                 self::queueRecursiveJobsForTable( $this->mTitle, 'templatelinks' );
 237                 if ( $this->mTitle->getNamespace() == NS_FILE ) {
 238                         // Process imagelinks in case the title is or was a redirect
 239                         self::queueRecursiveJobsForTable( $this->mTitle, 'imagelinks' );
 240                 }
 241
 242                 $bc = $this->mTitle->getBacklinkCache();
 243                 // Get jobs for cascade-protected backlinks for a high priority queue.
 244                 // If meta-templates change to using a new template, the new template
 245                 // should be implicitly protected as soon as possible, if applicable.
 246                 // These jobs duplicate a subset of the above ones, but can run sooner.
 247                 // Which ever runs first generally no-ops the other one.
 248                 $jobs = [];
 249                 foreach ( $bc->getCascadeProtectedLinks() as $title ) {
 250                         $jobs[] = RefreshLinksJob::newPrioritized( $title, [] );
 251                 }
 252                 JobQueueGroup::singleton()->push( $jobs );
 253         }
 254
 255         /**
 256          * Queue a RefreshLinks job for any table.
 257          *
 258          * @param Title $title Title to do job for
 259          * @param string $table Table to use (e.g. 'templatelinks')
 260          */
 261         public static function queueRecursiveJobsForTable( Title $title, $table ) {
 262                 if ( $title->getBacklinkCache()->hasLinks( $table ) ) {
 263                         $job = new RefreshLinksJob(
 264                                 $title,
 265                                 [
 266                                         'table' => $table,
 267                                         'recursive' => true,
 268                                 ] + Job::newRootJobParams( // "overall" refresh links job info
 269                                         "refreshlinks:{$table}:{$title->getPrefixedText()}"
 270                                 )
 271                         );
 272
 273                         JobQueueGroup::singleton()->push( $job );
 274                 }
 275         }
 276
 277         /**
 278          * @param array $cats
 279          */
 280         function invalidateCategories( $cats ) {
 281                 $this->invalidatePages( NS_CATEGORY, array_keys( $cats ) );
 282         }
 283
 284         /**
 285          * Update all the appropriate counts in the category table.
 286          * @param array $added Associative array of category name => sort key
 287          * @param array $deleted Associative array of category name => sort key
 288          */
 289         function updateCategoryCounts( $added, $deleted ) {
 290                 $a = WikiPage::factory( $this->mTitle );
 291                 $a->updateCategoryCounts(
 292                         array_keys( $added ), array_keys( $deleted )
 293                 );
 294         }
 295
 296         /**
 297          * @param array $images
 298          */
 299         function invalidateImageDescriptions( $images ) {
 300                 $this->invalidatePages( NS_FILE, array_keys( $images ) );
 301         }
 302
 303         /**
 304          * Update a table by doing a delete query then an insert query
 305          * @param string $table Table name
 306          * @param string $prefix Field name prefix
 307          * @param array $deletions
 308          * @param array $insertions Rows to insert
 309          */
 310         function incrTableUpdate( $table, $prefix, $deletions, $insertions ) {
 311                 if ( $table == 'page_props' ) {
 312                         $fromField = 'pp_page';
 313                 } else {
 314                         $fromField = "{$prefix}_from";
 315                 }
 316                 $where = [ $fromField => $this->mId ];
 317                 if ( $table == 'pagelinks' || $table == 'templatelinks' || $table == 'iwlinks' ) {
 318                         if ( $table == 'iwlinks' ) {
 319                                 $baseKey = 'iwl_prefix';
 320                         } else {
 321                                 $baseKey = "{$prefix}_namespace";
 322                         }
 323                         $clause = $this->mDb->makeWhereFrom2d( $deletions, $baseKey, "{$prefix}_title" );
 324                         if ( $clause ) {
 325                                 $where[] = $clause;
 326                         } else {
 327                                 $where = false;
 328                         }
 329                 } else {
 330                         if ( $table == 'langlinks' ) {
 331                                 $toField = 'll_lang';
 332                         } elseif ( $table == 'page_props' ) {
 333                                 $toField = 'pp_propname';
 334                         } else {
 335                                 $toField = $prefix . '_to';
 336                         }
 337                         if ( count( $deletions ) ) {
 338                                 $where[$toField] = array_keys( $deletions );
 339                         } else {
 340                                 $where = false;
 341                         }
 342                 }
 343                 if ( $where ) {
 344                         $this->mDb->delete( $table, $where, __METHOD__ );
 345                 }
 346                 if ( count( $insertions ) ) {
 347                         $this->mDb->insert( $table, $insertions, __METHOD__, 'IGNORE' );
 348                         Hooks::run( 'LinksUpdateAfterInsert', [ $this, $table, $insertions ] );
 349                 }
 350         }
 351
 352         /**
 353          * Get an array of pagelinks insertions for passing to the DB
 354          * Skips the titles specified by the 2-D array $existing
 355          * @param array $existing
 356          * @return array
 357          */
 358         private function getLinkInsertions( $existing = [] ) {
 359                 $arr = [];
 360                 foreach ( $this->mLinks as $ns => $dbkeys ) {
 361                         $diffs = isset( $existing[$ns] )
 362                                 ? array_diff_key( $dbkeys, $existing[$ns] )
 363                                 : $dbkeys;
 364                         foreach ( $diffs as $dbk => $id ) {
 365                                 $arr[] = [
 366                                         'pl_from' => $this->mId,
 367                                         'pl_from_namespace' => $this->mTitle->getNamespace(),
 368                                         'pl_namespace' => $ns,
 369                                         'pl_title' => $dbk
 370                                 ];
 371                         }
 372                 }
 373
 374                 return $arr;
 375         }
 376
 377         /**
 378          * Get an array of template insertions. Like getLinkInsertions()
 379          * @param array $existing
 380          * @return array
 381          */
 382         private function getTemplateInsertions( $existing = [] ) {
 383                 $arr = [];
 384                 foreach ( $this->mTemplates as $ns => $dbkeys ) {
 385                         $diffs = isset( $existing[$ns] ) ? array_diff_key( $dbkeys, $existing[$ns] ) : $dbkeys;
 386                         foreach ( $diffs as $dbk => $id ) {
 387                                 $arr[] = [
 388                                         'tl_from' => $this->mId,
 389                                         'tl_from_namespace' => $this->mTitle->getNamespace(),
 390                                         'tl_namespace' => $ns,
 391                                         'tl_title' => $dbk
 392                                 ];
 393                         }
 394                 }
 395
 396                 return $arr;
 397         }
 398
 399         /**
 400          * Get an array of image insertions
 401          * Skips the names specified in $existing
 402          * @param array $existing
 403          * @return array
 404          */
 405         private function getImageInsertions( $existing = [] ) {
 406                 $arr = [];
 407                 $diffs = array_diff_key( $this->mImages, $existing );
 408                 foreach ( $diffs as $iname => $dummy ) {
 409                         $arr[] = [
 410                                 'il_from' => $this->mId,
 411                                 'il_from_namespace' => $this->mTitle->getNamespace(),
 412                                 'il_to' => $iname
 413                         ];
 414                 }
 415
 416                 return $arr;
 417         }
 418
 419         /**
 420          * Get an array of externallinks insertions. Skips the names specified in $existing
 421          * @param array $existing
 422          * @return array
 423          */
 424         private function getExternalInsertions( $existing = [] ) {
 425                 $arr = [];
 426                 $diffs = array_diff_key( $this->mExternals, $existing );
 427                 foreach ( $diffs as $url => $dummy ) {
 428                         foreach ( wfMakeUrlIndexes( $url ) as $index ) {
 429                                 $arr[] = [
 430                                         'el_id' => $this->mDb->nextSequenceValue( 'externallinks_el_id_seq' ),
 431                                         'el_from' => $this->mId,
 432                                         'el_to' => $url,
 433                                         'el_index' => $index,
 434                                 ];
 435                         }
 436                 }
 437
 438                 return $arr;
 439         }
 440
 441         /**
 442          * Get an array of category insertions
 443          *
 444          * @param array $existing Mapping existing category names to sort keys. If both
 445          * match a link in $this, the link will be omitted from the output
 446          *
 447          * @return array
 448          */
 449         private function getCategoryInsertions( $existing = [] ) {
 450                 global $wgContLang, $wgCategoryCollation;
 451                 $diffs = array_diff_assoc( $this->mCategories, $existing );
 452                 $arr = [];
 453                 foreach ( $diffs as $name => $prefix ) {
 454                         $nt = Title::makeTitleSafe( NS_CATEGORY, $name );
 455                         $wgContLang->findVariantLink( $name, $nt, true );
 456
 457                         if ( $this->mTitle->getNamespace() == NS_CATEGORY ) {
 458                                 $type = 'subcat';
 459                         } elseif ( $this->mTitle->getNamespace() == NS_FILE ) {
 460                                 $type = 'file';
 461                         } else {
 462                                 $type = 'page';
 463                         }
 464
 465                         # Treat custom sortkeys as a prefix, so that if multiple
 466                         # things are forced to sort as '*' or something, they'll
 467                         # sort properly in the category rather than in page_id
 468                         # order or such.
 469                         $sortkey = Collation::singleton()->getSortKey(
 470                                 $this->mTitle->getCategorySortkey( $prefix ) );
 471
 472                         $arr[] = [
 473                                 'cl_from' => $this->mId,
 474                                 'cl_to' => $name,
 475                                 'cl_sortkey' => $sortkey,
 476                                 'cl_timestamp' => $this->mDb->timestamp(),
 477                                 'cl_sortkey_prefix' => $prefix,
 478                                 'cl_collation' => $wgCategoryCollation,
 479                                 'cl_type' => $type,
 480                         ];
 481                 }
 482
 483                 return $arr;
 484         }
 485
 486         /**
 487          * Get an array of interlanguage link insertions
 488          *
 489          * @param array $existing Mapping existing language codes to titles
 490          *
 491          * @return array
 492          */
 493         private function getInterlangInsertions( $existing = [] ) {
 494                 $diffs = array_diff_assoc( $this->mInterlangs, $existing );
 495                 $arr = [];
 496                 foreach ( $diffs as $lang => $title ) {
 497                         $arr[] = [
 498                                 'll_from' => $this->mId,
 499                                 'll_lang' => $lang,
 500                                 'll_title' => $title
 501                         ];
 502                 }
 503
 504                 return $arr;
 505         }
 506
 507         /**
 508          * Get an array of page property insertions
 509          * @param array $existing
 510          * @return array
 511          */
 512         function getPropertyInsertions( $existing = [] ) {
 513                 $diffs = array_diff_assoc( $this->mProperties, $existing );
 514
 515                 $arr = [];
 516                 foreach ( array_keys( $diffs ) as $name ) {
 517                         $arr[] = $this->getPagePropRowData( $name );
 518                 }
 519
 520                 return $arr;
 521         }
 522
 523         /**
 524          * Returns an associative array to be used for inserting a row into
 525          * the page_props table. Besides the given property name, this will
 526          * include the page id from $this->mId and any property value from
 527          * $this->mProperties.
 528          *
 529          * The array returned will include the pp_sortkey field if this
 530          * is present in the database (as indicated by $wgPagePropsHaveSortkey).
 531          * The sortkey value is currently determined by getPropertySortKeyValue().
 532          *
 533          * @note this assumes that $this->mProperties[$prop] is defined.
 534          *
 535          * @param string $prop The name of the property.
 536          *
 537          * @return array
 538          */
 539         private function getPagePropRowData( $prop ) {
 540                 global $wgPagePropsHaveSortkey;
 541
 542                 $value = $this->mProperties[$prop];
 543
 544                 $row = [
 545                         'pp_page' => $this->mId,
 546                         'pp_propname' => $prop,
 547                         'pp_value' => $value,
 548                 ];
 549
 550                 if ( $wgPagePropsHaveSortkey ) {
 551                         $row['pp_sortkey'] = $this->getPropertySortKeyValue( $value );
 552                 }
 553
 554                 return $row;
 555         }
 556
 557         /**
 558          * Determines the sort key for the given property value.
 559          * This will return $value if it is a float or int,
 560          * 1 or resp. 0 if it is a bool, and null otherwise.
 561          *
 562          * @note In the future, we may allow the sortkey to be specified explicitly
 563          *       in ParserOutput::setProperty.
 564          *
 565          * @param mixed $value
 566          *
 567          * @return float|null
 568          */
 569         private function getPropertySortKeyValue( $value ) {
 570                 if ( is_int( $value ) || is_float( $value ) || is_bool( $value ) ) {
 571                         return floatval( $value );
 572                 }
 573
 574                 return null;
 575         }
 576
 577         /**
 578          * Get an array of interwiki insertions for passing to the DB
 579          * Skips the titles specified by the 2-D array $existing
 580          * @param array $existing
 581          * @return array
 582          */
 583         private function getInterwikiInsertions( $existing = [] ) {
 584                 $arr = [];
 585                 foreach ( $this->mInterwikis as $prefix => $dbkeys ) {
 586                         $diffs = isset( $existing[$prefix] )
 587                                 ? array_diff_key( $dbkeys, $existing[$prefix] )
 588                                 : $dbkeys;
 589
 590                         foreach ( $diffs as $dbk => $id ) {
 591                                 $arr[] = [
 592                                         'iwl_from' => $this->mId,
 593                                         'iwl_prefix' => $prefix,
 594                                         'iwl_title' => $dbk
 595                                 ];
 596                         }
 597                 }
 598
 599                 return $arr;
 600         }
 601
 602         /**
 603          * Given an array of existing links, returns those links which are not in $this
 604          * and thus should be deleted.
 605          * @param array $existing
 606          * @return array
 607          */
 608         private function getLinkDeletions( $existing ) {
 609                 $del = [];
 610                 foreach ( $existing as $ns => $dbkeys ) {
 611                         if ( isset( $this->mLinks[$ns] ) ) {
 612                                 $del[$ns] = array_diff_key( $existing[$ns], $this->mLinks[$ns] );
 613                         } else {
 614                                 $del[$ns] = $existing[$ns];
 615                         }
 616                 }
 617
 618                 return $del;
 619         }
 620
 621         /**
 622          * Given an array of existing templates, returns those templates which are not in $this
 623          * and thus should be deleted.
 624          * @param array $existing
 625          * @return array
 626          */
 627         private function getTemplateDeletions( $existing ) {
 628                 $del = [];
 629                 foreach ( $existing as $ns => $dbkeys ) {
 630                         if ( isset( $this->mTemplates[$ns] ) ) {
 631                                 $del[$ns] = array_diff_key( $existing[$ns], $this->mTemplates[$ns] );
 632                         } else {
 633                                 $del[$ns] = $existing[$ns];
 634                         }
 635                 }
 636
 637                 return $del;
 638         }
 639
 640         /**
 641          * Given an array of existing images, returns those images which are not in $this
 642          * and thus should be deleted.
 643          * @param array $existing
 644          * @return array
 645          */
 646         private function getImageDeletions( $existing ) {
 647                 return array_diff_key( $existing, $this->mImages );
 648         }
 649
 650         /**
 651          * Given an array of existing external links, returns those links which are not
 652          * in $this and thus should be deleted.
 653          * @param array $existing
 654          * @return array
 655          */
 656         private function getExternalDeletions( $existing ) {
 657                 return array_diff_key( $existing, $this->mExternals );
 658         }
 659
 660         /**
 661          * Given an array of existing categories, returns those categories which are not in $this
 662          * and thus should be deleted.
 663          * @param array $existing
 664          * @return array
 665          */
 666         private function getCategoryDeletions( $existing ) {
 667                 return array_diff_assoc( $existing, $this->mCategories );
 668         }
 669
 670         /**
 671          * Given an array of existing interlanguage links, returns those links which are not
 672          * in $this and thus should be deleted.
 673          * @param array $existing
 674          * @return array
 675          */
 676         private function getInterlangDeletions( $existing ) {
 677                 return array_diff_assoc( $existing, $this->mInterlangs );
 678         }
 679
 680         /**
 681          * Get array of properties which should be deleted.
 682          * @param array $existing
 683          * @return array
 684          */
 685         function getPropertyDeletions( $existing ) {
 686                 return array_diff_assoc( $existing, $this->mProperties );
 687         }
 688
 689         /**
 690          * Given an array of existing interwiki links, returns those links which are not in $this
 691          * and thus should be deleted.
 692          * @param array $existing
 693          * @return array
 694          */
 695         private function getInterwikiDeletions( $existing ) {
 696                 $del = [];
 697                 foreach ( $existing as $prefix => $dbkeys ) {
 698                         if ( isset( $this->mInterwikis[$prefix] ) ) {
 699                                 $del[$prefix] = array_diff_key( $existing[$prefix], $this->mInterwikis[$prefix] );
 700                         } else {
 701                                 $del[$prefix] = $existing[$prefix];
 702                         }
 703                 }
 704
 705                 return $del;
 706         }
 707
 708         /**
 709          * Get an array of existing links, as a 2-D array
 710          *
 711          * @return array
 712          */
 713         private function getExistingLinks() {
 714                 $res = $this->mDb->select( 'pagelinks', [ 'pl_namespace', 'pl_title' ],
 715                         [ 'pl_from' => $this->mId ], __METHOD__, $this->mOptions );
 716                 $arr = [];
 717                 foreach ( $res as $row ) {
 718                         if ( !isset( $arr[$row->pl_namespace] ) ) {
 719                                 $arr[$row->pl_namespace] = [];
 720                         }
 721                         $arr[$row->pl_namespace][$row->pl_title] = 1;
 722                 }
 723
 724                 return $arr;
 725         }
 726
 727         /**
 728          * Get an array of existing templates, as a 2-D array
 729          *
 730          * @return array
 731          */
 732         private function getExistingTemplates() {
 733                 $res = $this->mDb->select( 'templatelinks', [ 'tl_namespace', 'tl_title' ],
 734                         [ 'tl_from' => $this->mId ], __METHOD__, $this->mOptions );
 735                 $arr = [];
 736                 foreach ( $res as $row ) {
 737                         if ( !isset( $arr[$row->tl_namespace] ) ) {
 738                                 $arr[$row->tl_namespace] = [];
 739                         }
 740                         $arr[$row->tl_namespace][$row->tl_title] = 1;
 741                 }
 742
 743                 return $arr;
 744         }
 745
 746         /**
 747          * Get an array of existing images, image names in the keys
 748          *
 749          * @return array
 750          */
 751         private function getExistingImages() {
 752                 $res = $this->mDb->select( 'imagelinks', [ 'il_to' ],
 753                         [ 'il_from' => $this->mId ], __METHOD__, $this->mOptions );
 754                 $arr = [];
 755                 foreach ( $res as $row ) {
 756                         $arr[$row->il_to] = 1;
 757                 }
 758
 759                 return $arr;
 760         }
 761
 762         /**
 763          * Get an array of existing external links, URLs in the keys
 764          *
 765          * @return array
 766          */
 767         private function getExistingExternals() {
 768                 $res = $this->mDb->select( 'externallinks', [ 'el_to' ],
 769                         [ 'el_from' => $this->mId ], __METHOD__, $this->mOptions );
 770                 $arr = [];
 771                 foreach ( $res as $row ) {
 772                         $arr[$row->el_to] = 1;
 773                 }
 774
 775                 return $arr;
 776         }
 777
 778         /**
 779          * Get an array of existing categories, with the name in the key and sort key in the value.
 780          *
 781          * @return array
 782          */
 783         private function getExistingCategories() {
 784                 $res = $this->mDb->select( 'categorylinks', [ 'cl_to', 'cl_sortkey_prefix' ],
 785                         [ 'cl_from' => $this->mId ], __METHOD__, $this->mOptions );
 786                 $arr = [];
 787                 foreach ( $res as $row ) {
 788                         $arr[$row->cl_to] = $row->cl_sortkey_prefix;
 789                 }
 790
 791                 return $arr;
 792         }
 793
 794         /**
 795          * Get an array of existing interlanguage links, with the language code in the key and the
 796          * title in the value.
 797          *
 798          * @return array
 799          */
 800         private function getExistingInterlangs() {
 801                 $res = $this->mDb->select( 'langlinks', [ 'll_lang', 'll_title' ],
 802                         [ 'll_from' => $this->mId ], __METHOD__, $this->mOptions );
 803                 $arr = [];
 804                 foreach ( $res as $row ) {
 805                         $arr[$row->ll_lang] = $row->ll_title;
 806                 }
 807
 808                 return $arr;
 809         }
 810
 811         /**
 812          * Get an array of existing inline interwiki links, as a 2-D array
 813          * @return array (prefix => array(dbkey => 1))
 814          */
 815         protected function getExistingInterwikis() {
 816                 $res = $this->mDb->select( 'iwlinks', [ 'iwl_prefix', 'iwl_title' ],
 817                         [ 'iwl_from' => $this->mId ], __METHOD__, $this->mOptions );
 818                 $arr = [];
 819                 foreach ( $res as $row ) {
 820                         if ( !isset( $arr[$row->iwl_prefix] ) ) {
 821                                 $arr[$row->iwl_prefix] = [];
 822                         }
 823                         $arr[$row->iwl_prefix][$row->iwl_title] = 1;
 824                 }
 825
 826                 return $arr;
 827         }
 828
 829         /**
 830          * Get an array of existing categories, with the name in the key and sort key in the value.
 831          *
 832          * @return array Array of property names and values
 833          */
 834         private function getExistingProperties() {
 835                 $res = $this->mDb->select( 'page_props', [ 'pp_propname', 'pp_value' ],
 836                         [ 'pp_page' => $this->mId ], __METHOD__, $this->mOptions );
 837                 $arr = [];
 838                 foreach ( $res as $row ) {
 839                         $arr[$row->pp_propname] = $row->pp_value;
 840                 }
 841
 842                 return $arr;
 843         }
 844
 845         /**
 846          * Return the title object of the page being updated
 847          * @return Title
 848          */
 849         public function getTitle() {
 850                 return $this->mTitle;
 851         }
 852
 853         /**
 854          * Returns parser output
 855          * @since 1.19
 856          * @return ParserOutput
 857          */
 858         public function getParserOutput() {
 859                 return $this->mParserOutput;
 860         }
 861
 862         /**
 863          * Return the list of images used as generated by the parser
 864          * @return array
 865          */
 866         public function getImages() {
 867                 return $this->mImages;
 868         }
 869
 870         /**
 871          * Set the revision corresponding to this LinksUpdate
 872          *
 873          * @since 1.27
 874          *
 875          * @param Revision $revision
 876          */
 877         public function setRevision( Revision $revision ) {
 878                 $this->mRevision = $revision;
 879         }
 880
 881         /**
 882          * Set the User who triggered this LinksUpdate
 883          *
 884          * @since 1.27
 885          * @param User $user
 886          */
 887         public function setTriggeringUser( User $user ) {
 888                 $this->user = $user;
 889         }
 890
 891         /**
 892          * @since 1.27
 893          * @return null|User
 894          */
 895         public function getTriggeringUser() {
 896                 return $this->user;
 897         }
 898
 899         /**
 900          * Invalidate any necessary link lists related to page property changes
 901          * @param array $changed
 902          */
 903         private function invalidateProperties( $changed ) {
 904                 global $wgPagePropLinkInvalidations;
 905
 906                 foreach ( $changed as $name => $value ) {
 907                         if ( isset( $wgPagePropLinkInvalidations[$name] ) ) {
 908                                 $inv = $wgPagePropLinkInvalidations[$name];
 909                                 if ( !is_array( $inv ) ) {
 910                                         $inv = [ $inv ];
 911                                 }
 912                                 foreach ( $inv as $table ) {
 913                                         DeferredUpdates::addUpdate( new HTMLCacheUpdate( $this->mTitle, $table ) );
 914                                 }
 915                         }
 916                 }
 917         }
 918
 919         /**
 920          * Fetch page links added by this LinksUpdate.  Only available after the update is complete.
 921          * @since 1.22
 922          * @return null|array Array of Titles
 923          */
 924         public function getAddedLinks() {
 925                 if ( $this->linkInsertions === null ) {
 926                         return null;
 927                 }
 928                 $result = [];
 929                 foreach ( $this->linkInsertions as $insertion ) {
 930                         $result[] = Title::makeTitle( $insertion['pl_namespace'], $insertion['pl_title'] );
 931                 }
 932
 933                 return $result;
 934         }
 935
 936         /**
 937          * Fetch page links removed by this LinksUpdate.  Only available after the update is complete.
 938          * @since 1.22
 939          * @return null|array Array of Titles
 940          */
 941         public function getRemovedLinks() {
 942                 if ( $this->linkDeletions === null ) {
 943                         return null;
 944                 }
 945                 $result = [];
 946                 foreach ( $this->linkDeletions as $ns => $titles ) {
 947                         foreach ( $titles as $title => $unused ) {
 948                                 $result[] = Title::makeTitle( $ns, $title );
 949                         }
 950                 }
 951
 952                 return $result;
 953         }
 954
 955         /**
 956          * Update links table freshness
 957          */
 958         protected function updateLinksTimestamp() {
 959                 if ( $this->mId ) {
 960                         // The link updates made here only reflect the freshness of the parser output
 961                         $timestamp = $this->mParserOutput->getCacheTime();
 962                         $this->mDb->update( 'page',
 963                                 [ 'page_links_updated' => $this->mDb->timestamp( $timestamp ) ],
 964                                 [ 'page_id' => $this->mId ],
 965                                 __METHOD__
 966                         );
 967                 }
 968         }
 969
 970         public function getAsJobSpecification() {
 971                 if ( $this->user ) {
 972                         $userInfo = [
 973                                 'userId' => $this->user->getId(),
 974                                 'userName' => $this->user->getName(),
 975                         ];
 976                 } else {
 977                         $userInfo = false;
 978                 }
 979
 980                 if ( $this->mRevision ) {
 981                         $triggeringRevisionId = $this->mRevision->getId();
 982                 } else {
 983                         $triggeringRevisionId = false;
 984                 }
 985
 986                 return [
 987                         'wiki' => $this->mDb->getWikiID(),
 988                         'job'  => new JobSpecification(
 989                                 'refreshLinksPrioritized',
 990                                 [
 991                                         // Reuse the parser cache if it was saved
 992                                         'rootJobTimestamp' => $this->mParserOutput->getCacheTime(),
 993                                         'useRecursiveLinksUpdate' => $this->mRecursive,
 994                                         'triggeringUser' => $userInfo,
 995                                         'triggeringRevisionId' => $triggeringRevisionId,
 996                                 ],
 997                                 [ 'removeDuplicates' => true ],
 998                                 $this->getTitle()
 999                         )
1000                 ];
1001         }
1002 }