includes/LinksUpdate.php

   1 <?php
   2 /**
   3  * See docs/deferred.txt
   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  * @todo document (e.g. one-sentence top-level class description).
  21  */
  22 class LinksUpdate {
  23
  24         /**@{{
  25          * @private
  26          */
  27         var $mId,            //!< Page ID of the article linked from
  28                 $mTitle,         //!< Title object of the article linked from
  29                 $mLinks,         //!< Map of title strings to IDs for the links in the document
  30                 $mImages,        //!< DB keys of the images used, in the array key only
  31                 $mTemplates,     //!< Map of title strings to IDs for the template references, including broken ones
  32                 $mExternals,     //!< URLs of external links, array key only
  33                 $mCategories,    //!< Map of category names to sort keys
  34                 $mInterlangs,    //!< Map of language codes to titles
  35                 $mProperties,    //!< Map of arbitrary name to value
  36                 $mDb,            //!< Database connection reference
  37                 $mOptions,       //!< SELECT options to be used (array)
  38                 $mRecursive;     //!< Whether to queue jobs for recursive updates
  39         /**@}}*/
  40
  41         /**
  42          * Constructor
  43          *
  44          * @param $title Title of the page we're updating
  45          * @param $parserOutput ParserOutput: output from a full parse of this page
  46          * @param $recursive Boolean: queue jobs for recursive updates?
  47          */
  48         function __construct( $title, $parserOutput, $recursive = true ) {
  49                 global $wgAntiLockFlags;
  50
  51                 if ( $wgAntiLockFlags & ALF_NO_LINK_LOCK ) {
  52                         $this->mOptions = array();
  53                 } else {
  54                         $this->mOptions = array( 'FOR UPDATE' );
  55                 }
  56                 $this->mDb = wfGetDB( DB_MASTER );
  57
  58                 if ( !is_object( $title ) ) {
  59                         throw new MWException( "The calling convention to LinksUpdate::LinksUpdate() has changed. " .
  60                                 "Please see Article::editUpdates() for an invocation example.\n" );
  61                 }
  62                 $this->mTitle = $title;
  63                 $this->mId = $title->getArticleID();
  64
  65                 $this->mParserOutput = $parserOutput;
  66                 $this->mLinks = $parserOutput->getLinks();
  67                 $this->mImages = $parserOutput->getImages();
  68                 $this->mTemplates = $parserOutput->getTemplates();
  69                 $this->mExternals = $parserOutput->getExternalLinks();
  70                 $this->mCategories = $parserOutput->getCategories();
  71                 $this->mProperties = $parserOutput->getProperties();
  72                 $this->mInterwikis = $parserOutput->getInterwikiLinks();
  73
  74                 # Convert the format of the interlanguage links
  75                 # I didn't want to change it in the ParserOutput, because that array is passed all
  76                 # the way back to the skin, so either a skin API break would be required, or an
  77                 # inefficient back-conversion.
  78                 $ill = $parserOutput->getLanguageLinks();
  79                 $this->mInterlangs = array();
  80                 foreach ( $ill as $link ) {
  81                         list( $key, $title ) = explode( ':', $link, 2 );
  82                         $this->mInterlangs[$key] = $title;
  83                 }
  84
  85                 foreach ( $this->mCategories as &$sortkey ) {
  86                         # If the sortkey is longer then 255 bytes,
  87                         # it truncated by DB, and then doesn't get
  88                         # matched when comparing existing vs current
  89                         # categories, causing bug 25254.
  90                         # Also. substr behaves weird when given "".
  91                         if ( $sortkey !== '' ) {
  92                                 $sortkey = substr( $sortkey, 0, 255 );
  93                         }
  94                 }
  95
  96                 $this->mRecursive = $recursive;
  97
  98                 wfRunHooks( 'LinksUpdateConstructed', array( &$this ) );
  99         }
 100
 101         /**
 102          * Update link tables with outgoing links from an updated article
 103          */
 104         public function doUpdate() {
 105                 global $wgUseDumbLinkUpdate;
 106
 107                 wfRunHooks( 'LinksUpdate', array( &$this ) );
 108                 if ( $wgUseDumbLinkUpdate ) {
 109                         $this->doDumbUpdate();
 110                 } else {
 111                         $this->doIncrementalUpdate();
 112                 }
 113                 wfRunHooks( 'LinksUpdateComplete', array( &$this ) );
 114         }
 115
 116         protected function doIncrementalUpdate() {
 117                 wfProfileIn( __METHOD__ );
 118
 119                 # Page links
 120                 $existing = $this->getExistingLinks();
 121                 $this->incrTableUpdate( 'pagelinks', 'pl', $this->getLinkDeletions( $existing ),
 122                         $this->getLinkInsertions( $existing ) );
 123
 124                 # Image links
 125                 $existing = $this->getExistingImages();
 126
 127                 $imageDeletes = $this->getImageDeletions( $existing );
 128                 $this->incrTableUpdate( 'imagelinks', 'il', $imageDeletes,
 129                         $this->getImageInsertions( $existing ) );
 130
 131                 # Invalidate all image description pages which had links added or removed
 132                 $imageUpdates = $imageDeletes + array_diff_key( $this->mImages, $existing );
 133                 $this->invalidateImageDescriptions( $imageUpdates );
 134
 135                 # External links
 136                 $existing = $this->getExistingExternals();
 137                 $this->incrTableUpdate( 'externallinks', 'el', $this->getExternalDeletions( $existing ),
 138                 $this->getExternalInsertions( $existing ) );
 139
 140                 # Language links
 141                 $existing = $this->getExistingInterlangs();
 142                 $this->incrTableUpdate( 'langlinks', 'll', $this->getInterlangDeletions( $existing ),
 143                         $this->getInterlangInsertions( $existing ) );
 144
 145                 # Inline interwiki links
 146                 $existing = $this->getExistingInterwikis();
 147                 $this->incrTableUpdate( 'iwlinks', 'iwl', $this->getInterwikiDeletions( $existing ),
 148                         $this->getInterwikiInsertions( $existing ) );
 149
 150                 # Template links
 151                 $existing = $this->getExistingTemplates();
 152                 $this->incrTableUpdate( 'templatelinks', 'tl', $this->getTemplateDeletions( $existing ),
 153                         $this->getTemplateInsertions( $existing ) );
 154
 155                 # Category links
 156                 $existing = $this->getExistingCategories();
 157
 158                 $categoryDeletes = $this->getCategoryDeletions( $existing );
 159
 160                 $this->incrTableUpdate( 'categorylinks', 'cl', $categoryDeletes,
 161                         $this->getCategoryInsertions( $existing ) );
 162
 163                 # Invalidate all categories which were added, deleted or changed (set symmetric difference)
 164                 $categoryInserts = array_diff_assoc( $this->mCategories, $existing );
 165                 $categoryUpdates = $categoryInserts + $categoryDeletes;
 166                 $this->invalidateCategories( $categoryUpdates );
 167                 $this->updateCategoryCounts( $categoryInserts, $categoryDeletes );
 168
 169                 # Page properties
 170                 $existing = $this->getExistingProperties();
 171
 172                 $propertiesDeletes = $this->getPropertyDeletions( $existing );
 173
 174                 $this->incrTableUpdate( 'page_props', 'pp', $propertiesDeletes,
 175                         $this->getPropertyInsertions( $existing ) );
 176
 177                 # Invalidate the necessary pages
 178                 $changed = $propertiesDeletes + array_diff_assoc( $this->mProperties, $existing );
 179                 $this->invalidateProperties( $changed );
 180
 181                 # Refresh links of all pages including this page
 182                 # This will be in a separate transaction
 183                 if ( $this->mRecursive ) {
 184                         $this->queueRecursiveJobs();
 185                 }
 186
 187                 wfProfileOut( __METHOD__ );
 188         }
 189
 190         /**
 191          * Link update which clears the previous entries and inserts new ones
 192          * May be slower or faster depending on level of lock contention and write speed of DB
 193          * Also useful where link table corruption needs to be repaired, e.g. in refreshLinks.php
 194          */
 195         protected function doDumbUpdate() {
 196                 wfProfileIn( __METHOD__ );
 197
 198                 # Refresh category pages and image description pages
 199                 $existing = $this->getExistingCategories();
 200                 $categoryInserts = array_diff_assoc( $this->mCategories, $existing );
 201                 $categoryDeletes = array_diff_assoc( $existing, $this->mCategories );
 202                 $categoryUpdates = $categoryInserts + $categoryDeletes;
 203                 $existing = $this->getExistingImages();
 204                 $imageUpdates = array_diff_key( $existing, $this->mImages ) + array_diff_key( $this->mImages, $existing );
 205
 206                 $this->dumbTableUpdate( 'pagelinks',     $this->getLinkInsertions(),     'pl_from' );
 207                 $this->dumbTableUpdate( 'imagelinks',    $this->getImageInsertions(),    'il_from' );
 208                 $this->dumbTableUpdate( 'categorylinks', $this->getCategoryInsertions(), 'cl_from' );
 209                 $this->dumbTableUpdate( 'templatelinks', $this->getTemplateInsertions(), 'tl_from' );
 210                 $this->dumbTableUpdate( 'externallinks', $this->getExternalInsertions(), 'el_from' );
 211                 $this->dumbTableUpdate( 'langlinks',     $this->getInterlangInsertions(),'ll_from' );
 212                 $this->dumbTableUpdate( 'iwlinks',       $this->getInterwikiInsertions(),'iwl_from' );
 213                 $this->dumbTableUpdate( 'page_props',    $this->getPropertyInsertions(), 'pp_page' );
 214
 215                 # Update the cache of all the category pages and image description
 216                 # pages which were changed, and fix the category table count
 217                 $this->invalidateCategories( $categoryUpdates );
 218                 $this->updateCategoryCounts( $categoryInserts, $categoryDeletes );
 219                 $this->invalidateImageDescriptions( $imageUpdates );
 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                 wfProfileOut( __METHOD__ );
 228         }
 229
 230         function queueRecursiveJobs() {
 231                 global $wgUpdateRowsPerJob;
 232                 wfProfileIn( __METHOD__ );
 233
 234                 $cache = $this->mTitle->getBacklinkCache();
 235                 $batches = $cache->partition( 'templatelinks', $wgUpdateRowsPerJob );
 236                 if ( !$batches ) {
 237                         wfProfileOut( __METHOD__ );
 238                         return;
 239                 }
 240                 $jobs = array();
 241                 foreach ( $batches as $batch ) {
 242                         list( $start, $end ) = $batch;
 243                         $params = array(
 244                                 'start' => $start,
 245                                 'end' => $end,
 246                         );
 247                         $jobs[] = new RefreshLinksJob2( $this->mTitle, $params );
 248                 }
 249                 Job::batchInsert( $jobs );
 250
 251                 wfProfileOut( __METHOD__ );
 252         }
 253
 254         /**
 255          * Invalidate the cache of a list of pages from a single namespace
 256          *
 257          * @param $namespace Integer
 258          * @param $dbkeys Array
 259          */
 260         function invalidatePages( $namespace, $dbkeys ) {
 261                 if ( !count( $dbkeys ) ) {
 262                         return;
 263                 }
 264
 265                 /**
 266                  * Determine which pages need to be updated
 267                  * This is necessary to prevent the job queue from smashing the DB with
 268                  * large numbers of concurrent invalidations of the same page
 269                  */
 270                 $now = $this->mDb->timestamp();
 271                 $ids = array();
 272                 $res = $this->mDb->select( 'page', array( 'page_id' ),
 273                         array(
 274                                 'page_namespace' => $namespace,
 275                                 'page_title IN (' . $this->mDb->makeList( $dbkeys ) . ')',
 276                                 'page_touched < ' . $this->mDb->addQuotes( $now )
 277                         ), __METHOD__
 278                 );
 279                 foreach ( $res as $row ) {
 280                         $ids[] = $row->page_id;
 281                 }
 282                 if ( !count( $ids ) ) {
 283                         return;
 284                 }
 285
 286                 /**
 287                  * Do the update
 288                  * We still need the page_touched condition, in case the row has changed since
 289                  * the non-locking select above.
 290                  */
 291                 $this->mDb->update( 'page', array( 'page_touched' => $now ),
 292                         array(
 293                                 'page_id IN (' . $this->mDb->makeList( $ids ) . ')',
 294                                 'page_touched < ' . $this->mDb->addQuotes( $now )
 295                         ), __METHOD__
 296                 );
 297         }
 298
 299         function invalidateCategories( $cats ) {
 300                 $this->invalidatePages( NS_CATEGORY, array_keys( $cats ) );
 301         }
 302
 303         /**
 304          * Update all the appropriate counts in the category table.
 305          * @param $added associative array of category name => sort key
 306          * @param $deleted associative array of category name => sort key
 307          */
 308         function updateCategoryCounts( $added, $deleted ) {
 309                 $a = new Article($this->mTitle);
 310                 $a->updateCategoryCounts(
 311                         array_keys( $added ), array_keys( $deleted )
 312                 );
 313         }
 314
 315         function invalidateImageDescriptions( $images ) {
 316                 $this->invalidatePages( NS_FILE, array_keys( $images ) );
 317         }
 318
 319         function dumbTableUpdate( $table, $insertions, $fromField ) {
 320                 $this->mDb->delete( $table, array( $fromField => $this->mId ), __METHOD__ );
 321                 if ( count( $insertions ) ) {
 322                         # The link array was constructed without FOR UPDATE, so there may
 323                         # be collisions.  This may cause minor link table inconsistencies,
 324                         # which is better than crippling the site with lock contention.
 325                         $this->mDb->insert( $table, $insertions, __METHOD__, array( 'IGNORE' ) );
 326                 }
 327         }
 328
 329         /**
 330          * Update a table by doing a delete query then an insert query
 331          * @private
 332          */
 333         function incrTableUpdate( $table, $prefix, $deletions, $insertions ) {
 334                 if ( $table == 'page_props' ) {
 335                         $fromField = 'pp_page';
 336                 } else {
 337                         $fromField = "{$prefix}_from";
 338                 }
 339                 $where = array( $fromField => $this->mId );
 340                 if ( $table == 'pagelinks' || $table == 'templatelinks' || $table == 'iwlinks' ) {
 341                         if ( $table == 'iwlinks' ) {
 342                                 $baseKey = 'iwl_prefix';
 343                         } else {
 344                                 $baseKey = "{$prefix}_namespace";
 345                         }
 346                         $clause = $this->mDb->makeWhereFrom2d( $deletions, $baseKey, "{$prefix}_title" );
 347                         if ( $clause ) {
 348                                 $where[] = $clause;
 349                         } else {
 350                                 $where = false;
 351                         }
 352                 } else {
 353                         if ( $table == 'langlinks' ) {
 354                                 $toField = 'll_lang';
 355                         } elseif ( $table == 'page_props' ) {
 356                                 $toField = 'pp_propname';
 357                         } else {
 358                                 $toField = $prefix . '_to';
 359                         }
 360                         if ( count( $deletions ) ) {
 361                                 $where[] = "$toField IN (" . $this->mDb->makeList( array_keys( $deletions ) ) . ')';
 362                         } else {
 363                                 $where = false;
 364                         }
 365                 }
 366                 if ( $where ) {
 367                         $this->mDb->delete( $table, $where, __METHOD__ );
 368                 }
 369                 if ( count( $insertions ) ) {
 370                         $this->mDb->insert( $table, $insertions, __METHOD__, 'IGNORE' );
 371                 }
 372         }
 373
 374
 375         /**
 376          * Get an array of pagelinks insertions for passing to the DB
 377          * Skips the titles specified by the 2-D array $existing
 378          * @private
 379          */
 380         function getLinkInsertions( $existing = array() ) {
 381                 $arr = array();
 382                 foreach( $this->mLinks as $ns => $dbkeys ) {
 383                         $diffs = isset( $existing[$ns] )
 384                                 ? array_diff_key( $dbkeys, $existing[$ns] )
 385                                 : $dbkeys;
 386                         foreach ( $diffs as $dbk => $id ) {
 387                                 $arr[] = array(
 388                                         'pl_from'      => $this->mId,
 389                                         'pl_namespace' => $ns,
 390                                         'pl_title'     => $dbk
 391                                 );
 392                         }
 393                 }
 394                 return $arr;
 395         }
 396
 397         /**
 398          * Get an array of template insertions. Like getLinkInsertions()
 399          * @private
 400          */
 401         function getTemplateInsertions( $existing = array() ) {
 402                 $arr = array();
 403                 foreach( $this->mTemplates as $ns => $dbkeys ) {
 404                         $diffs = isset( $existing[$ns] ) ? array_diff_key( $dbkeys, $existing[$ns] ) : $dbkeys;
 405                         foreach ( $diffs as $dbk => $id ) {
 406                                 $arr[] = array(
 407                                         'tl_from'      => $this->mId,
 408                                         'tl_namespace' => $ns,
 409                                         'tl_title'     => $dbk
 410                                 );
 411                         }
 412                 }
 413                 return $arr;
 414         }
 415
 416         /**
 417          * Get an array of image insertions
 418          * Skips the names specified in $existing
 419          * @private
 420          */
 421         function getImageInsertions( $existing = array() ) {
 422                 $arr = array();
 423                 $diffs = array_diff_key( $this->mImages, $existing );
 424                 foreach( $diffs as $iname => $dummy ) {
 425                         $arr[] = array(
 426                                 'il_from' => $this->mId,
 427                                 'il_to'   => $iname
 428                         );
 429                 }
 430                 return $arr;
 431         }
 432
 433         /**
 434          * Get an array of externallinks insertions. Skips the names specified in $existing
 435          * @private
 436          */
 437         function getExternalInsertions( $existing = array() ) {
 438                 $arr = array();
 439                 $diffs = array_diff_key( $this->mExternals, $existing );
 440                 foreach( $diffs as $url => $dummy ) {
 441                         $arr[] = array(
 442                                 'el_from'   => $this->mId,
 443                                 'el_to'     => $url,
 444                                 'el_index'  => wfMakeUrlIndex( $url ),
 445                         );
 446                 }
 447                 return $arr;
 448         }
 449
 450         /**
 451          * Get an array of category insertions
 452          *
 453          * @param $existing Array mapping existing category names to sort keys. If both
 454          * match a link in $this, the link will be omitted from the output
 455          * @private
 456          */
 457         function getCategoryInsertions( $existing = array() ) {
 458                 global $wgContLang, $wgCategoryCollation;
 459                 $diffs = array_diff_assoc( $this->mCategories, $existing );
 460                 $arr = array();
 461                 foreach ( $diffs as $name => $prefix ) {
 462                         $nt = Title::makeTitleSafe( NS_CATEGORY, $name );
 463                         $wgContLang->findVariantLink( $name, $nt, true );
 464
 465                         if ( $this->mTitle->getNamespace() == NS_CATEGORY ) {
 466                                 $type = 'subcat';
 467                         } elseif ( $this->mTitle->getNamespace() == NS_FILE ) {
 468                                 $type = 'file';
 469                         } else {
 470                                 $type = 'page';
 471                         }
 472
 473                         # Treat custom sortkeys as a prefix, so that if multiple
 474                         # things are forced to sort as '*' or something, they'll
 475                         # sort properly in the category rather than in page_id
 476                         # order or such.
 477                         $sortkey = Collation::singleton()->getSortKey(
 478                                 $this->mTitle->getCategorySortkey( $prefix ) );
 479
 480                         $arr[] = array(
 481                                 'cl_from'    => $this->mId,
 482                                 'cl_to'      => $name,
 483                                 'cl_sortkey' => $sortkey,
 484                                 'cl_timestamp' => $this->mDb->timestamp(),
 485                                 'cl_sortkey_prefix' => $prefix,
 486                                 'cl_collation' => $wgCategoryCollation,
 487                                 'cl_type' => $type,
 488                         );
 489                 }
 490                 return $arr;
 491         }
 492
 493         /**
 494          * Get an array of interlanguage link insertions
 495          *
 496          * @param $existing Array mapping existing language codes to titles
 497          * @private
 498          */
 499         function getInterlangInsertions( $existing = array() ) {
 500             $diffs = array_diff_assoc( $this->mInterlangs, $existing );
 501             $arr = array();
 502             foreach( $diffs as $lang => $title ) {
 503                 $arr[] = array(
 504                     'll_from'  => $this->mId,
 505                     'll_lang'  => $lang,
 506                     'll_title' => $title
 507                 );
 508             }
 509             return $arr;
 510         }
 511
 512         /**
 513          * Get an array of page property insertions
 514          */
 515         function getPropertyInsertions( $existing = array() ) {
 516                 $diffs = array_diff_assoc( $this->mProperties, $existing );
 517                 $arr = array();
 518                 foreach ( $diffs as $name => $value ) {
 519                         $arr[] = array(
 520                                 'pp_page'      => $this->mId,
 521                                 'pp_propname'  => $name,
 522                                 'pp_value'     => $value,
 523                         );
 524                 }
 525                 return $arr;
 526         }
 527
 528         /**
 529          * Get an array of interwiki insertions for passing to the DB
 530          * Skips the titles specified by the 2-D array $existing
 531          * @private
 532          */
 533         function getInterwikiInsertions( $existing = array() ) {
 534                 $arr = array();
 535                 foreach( $this->mInterwikis as $prefix => $dbkeys ) {
 536                         $diffs = isset( $existing[$prefix] ) ? array_diff_key( $dbkeys, $existing[$prefix] ) : $dbkeys;
 537                         foreach ( $diffs as $dbk => $id ) {
 538                                 $arr[] = array(
 539                                         'iwl_from'   => $this->mId,
 540                                         'iwl_prefix' => $prefix,
 541                                         'iwl_title'  => $dbk
 542                                 );
 543                         }
 544                 }
 545                 return $arr;
 546         }
 547
 548         /**
 549          * Given an array of existing links, returns those links which are not in $this
 550          * and thus should be deleted.
 551          * @private
 552          */
 553         function getLinkDeletions( $existing ) {
 554                 $del = array();
 555                 foreach ( $existing as $ns => $dbkeys ) {
 556                         if ( isset( $this->mLinks[$ns] ) ) {
 557                                 $del[$ns] = array_diff_key( $existing[$ns], $this->mLinks[$ns] );
 558                         } else {
 559                                 $del[$ns] = $existing[$ns];
 560                         }
 561                 }
 562                 return $del;
 563         }
 564
 565         /**
 566          * Given an array of existing templates, returns those templates which are not in $this
 567          * and thus should be deleted.
 568          * @private
 569          */
 570         function getTemplateDeletions( $existing ) {
 571                 $del = array();
 572                 foreach ( $existing as $ns => $dbkeys ) {
 573                         if ( isset( $this->mTemplates[$ns] ) ) {
 574                                 $del[$ns] = array_diff_key( $existing[$ns], $this->mTemplates[$ns] );
 575                         } else {
 576                                 $del[$ns] = $existing[$ns];
 577                         }
 578                 }
 579                 return $del;
 580         }
 581
 582         /**
 583          * Given an array of existing images, returns those images which are not in $this
 584          * and thus should be deleted.
 585          * @private
 586          */
 587         function getImageDeletions( $existing ) {
 588                 return array_diff_key( $existing, $this->mImages );
 589         }
 590
 591         /**
 592          * Given an array of existing external links, returns those links which are not
 593          * in $this and thus should be deleted.
 594          * @private
 595          */
 596         function getExternalDeletions( $existing ) {
 597                 return array_diff_key( $existing, $this->mExternals );
 598         }
 599
 600         /**
 601          * Given an array of existing categories, returns those categories which are not in $this
 602          * and thus should be deleted.
 603          * @private
 604          */
 605         function getCategoryDeletions( $existing ) {
 606                 return array_diff_assoc( $existing, $this->mCategories );
 607         }
 608
 609         /**
 610          * Given an array of existing interlanguage links, returns those links which are not
 611          * in $this and thus should be deleted.
 612          * @private
 613          */
 614         function getInterlangDeletions( $existing ) {
 615             return array_diff_assoc( $existing, $this->mInterlangs );
 616         }
 617
 618         /**
 619          * Get array of properties which should be deleted.
 620          * @private
 621          */
 622         function getPropertyDeletions( $existing ) {
 623                 return array_diff_assoc( $existing, $this->mProperties );
 624         }
 625
 626         /**
 627          * Given an array of existing interwiki links, returns those links which are not in $this
 628          * and thus should be deleted.
 629          * @private
 630          */
 631         function getInterwikiDeletions( $existing ) {
 632                 $del = array();
 633                 foreach ( $existing as $prefix => $dbkeys ) {
 634                         if ( isset( $this->mInterwikis[$prefix] ) ) {
 635                                 $del[$prefix] = array_diff_key( $existing[$prefix], $this->mInterwikis[$prefix] );
 636                         } else {
 637                                 $del[$prefix] = $existing[$prefix];
 638                         }
 639                 }
 640                 return $del;
 641         }
 642
 643         /**
 644          * Get an array of existing links, as a 2-D array
 645          * @private
 646          */
 647         function getExistingLinks() {
 648                 $res = $this->mDb->select( 'pagelinks', array( 'pl_namespace', 'pl_title' ),
 649                         array( 'pl_from' => $this->mId ), __METHOD__, $this->mOptions );
 650                 $arr = array();
 651                 foreach ( $res as $row ) {
 652                         if ( !isset( $arr[$row->pl_namespace] ) ) {
 653                                 $arr[$row->pl_namespace] = array();
 654                         }
 655                         $arr[$row->pl_namespace][$row->pl_title] = 1;
 656                 }
 657                 return $arr;
 658         }
 659
 660         /**
 661          * Get an array of existing templates, as a 2-D array
 662          * @private
 663          */
 664         function getExistingTemplates() {
 665                 $res = $this->mDb->select( 'templatelinks', array( 'tl_namespace', 'tl_title' ),
 666                         array( 'tl_from' => $this->mId ), __METHOD__, $this->mOptions );
 667                 $arr = array();
 668                 foreach ( $res as $row ) {
 669                         if ( !isset( $arr[$row->tl_namespace] ) ) {
 670                                 $arr[$row->tl_namespace] = array();
 671                         }
 672                         $arr[$row->tl_namespace][$row->tl_title] = 1;
 673                 }
 674                 return $arr;
 675         }
 676
 677         /**
 678          * Get an array of existing images, image names in the keys
 679          * @private
 680          */
 681         function getExistingImages() {
 682                 $res = $this->mDb->select( 'imagelinks', array( 'il_to' ),
 683                         array( 'il_from' => $this->mId ), __METHOD__, $this->mOptions );
 684                 $arr = array();
 685                 foreach ( $res as $row ) {
 686                         $arr[$row->il_to] = 1;
 687                 }
 688                 return $arr;
 689         }
 690
 691         /**
 692          * Get an array of existing external links, URLs in the keys
 693          * @private
 694          */
 695         function getExistingExternals() {
 696                 $res = $this->mDb->select( 'externallinks', array( 'el_to' ),
 697                         array( 'el_from' => $this->mId ), __METHOD__, $this->mOptions );
 698                 $arr = array();
 699                 foreach ( $res as $row ) {
 700                         $arr[$row->el_to] = 1;
 701                 }
 702                 return $arr;
 703         }
 704
 705         /**
 706          * Get an array of existing categories, with the name in the key and sort key in the value.
 707          * @private
 708          */
 709         function getExistingCategories() {
 710                 $res = $this->mDb->select( 'categorylinks', array( 'cl_to', 'cl_sortkey_prefix' ),
 711                         array( 'cl_from' => $this->mId ), __METHOD__, $this->mOptions );
 712                 $arr = array();
 713                 foreach ( $res as $row ) {
 714                         $arr[$row->cl_to] = $row->cl_sortkey_prefix;
 715                 }
 716                 return $arr;
 717         }
 718
 719         /**
 720          * Get an array of existing interlanguage links, with the language code in the key and the
 721          * title in the value.
 722          * @private
 723          */
 724         function getExistingInterlangs() {
 725                 $res = $this->mDb->select( 'langlinks', array( 'll_lang', 'll_title' ),
 726                         array( 'll_from' => $this->mId ), __METHOD__, $this->mOptions );
 727                 $arr = array();
 728                 foreach ( $res as $row ) {
 729                         $arr[$row->ll_lang] = $row->ll_title;
 730                 }
 731                 return $arr;
 732         }
 733
 734         /**
 735          * Get an array of existing inline interwiki links, as a 2-D array
 736          * @return array (prefix => array(dbkey => 1))
 737          */
 738         protected function getExistingInterwikis() {
 739                 $res = $this->mDb->select( 'iwlinks', array( 'iwl_prefix', 'iwl_title' ),
 740                         array( 'iwl_from' => $this->mId ), __METHOD__, $this->mOptions );
 741                 $arr = array();
 742                 foreach ( $res as $row ) {
 743                         if ( !isset( $arr[$row->iwl_prefix] ) ) {
 744                                 $arr[$row->iwl_prefix] = array();
 745                         }
 746                         $arr[$row->iwl_prefix][$row->iwl_title] = 1;
 747                 }
 748                 return $arr;
 749         }
 750
 751         /**
 752          * Get an array of existing categories, with the name in the key and sort key in the value.
 753          * @private
 754          */
 755         function getExistingProperties() {
 756                 $res = $this->mDb->select( 'page_props', array( 'pp_propname', 'pp_value' ),
 757                         array( 'pp_page' => $this->mId ), __METHOD__, $this->mOptions );
 758                 $arr = array();
 759                 foreach ( $res as $row ) {
 760                         $arr[$row->pp_propname] = $row->pp_value;
 761                 }
 762                 return $arr;
 763         }
 764
 765
 766         /**
 767          * Return the title object of the page being updated
 768          */
 769         function getTitle() {
 770                 return $this->mTitle;
 771         }
 772
 773         /**
 774          * Return the list of images used as generated by the parser
 775          */
 776         public function getImages() {
 777                 return $this->mImages;
 778         }
 779
 780         /**
 781          * Invalidate any necessary link lists related to page property changes
 782          */
 783         function invalidateProperties( $changed ) {
 784                 global $wgPagePropLinkInvalidations;
 785
 786                 foreach ( $changed as $name => $value ) {
 787                         if ( isset( $wgPagePropLinkInvalidations[$name] ) ) {
 788                                 $inv = $wgPagePropLinkInvalidations[$name];
 789                                 if ( !is_array( $inv ) ) {
 790                                         $inv = array( $inv );
 791                                 }
 792                                 foreach ( $inv as $table ) {
 793                                         $update = new HTMLCacheUpdate( $this->mTitle, $table );
 794                                         $update->doUpdate();
 795                                 }
 796                         }
 797                 }
 798         }
 799 }