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                                 'table' => 'templatelinks',
 245                                 'start' => $start,
 246                                 'end' => $end,
 247                         );
 248                         $jobs[] = new RefreshLinksJob2( $this->mTitle, $params );
 249                 }
 250                 Job::batchInsert( $jobs );
 251
 252                 wfProfileOut( __METHOD__ );
 253         }
 254
 255         /**
 256          * Invalidate the cache of a list of pages from a single namespace
 257          *
 258          * @param $namespace Integer
 259          * @param $dbkeys Array
 260          */
 261         function invalidatePages( $namespace, $dbkeys ) {
 262                 if ( !count( $dbkeys ) ) {
 263                         return;
 264                 }
 265
 266                 /**
 267                  * Determine which pages need to be updated
 268                  * This is necessary to prevent the job queue from smashing the DB with
 269                  * large numbers of concurrent invalidations of the same page
 270                  */
 271                 $now = $this->mDb->timestamp();
 272                 $ids = array();
 273                 $res = $this->mDb->select( 'page', array( 'page_id' ),
 274                         array(
 275                                 'page_namespace' => $namespace,
 276                                 'page_title IN (' . $this->mDb->makeList( $dbkeys ) . ')',
 277                                 'page_touched < ' . $this->mDb->addQuotes( $now )
 278                         ), __METHOD__
 279                 );
 280                 foreach ( $res as $row ) {
 281                         $ids[] = $row->page_id;
 282                 }
 283                 if ( !count( $ids ) ) {
 284                         return;
 285                 }
 286
 287                 /**
 288                  * Do the update
 289                  * We still need the page_touched condition, in case the row has changed since
 290                  * the non-locking select above.
 291                  */
 292                 $this->mDb->update( 'page', array( 'page_touched' => $now ),
 293                         array(
 294                                 'page_id IN (' . $this->mDb->makeList( $ids ) . ')',
 295                                 'page_touched < ' . $this->mDb->addQuotes( $now )
 296                         ), __METHOD__
 297                 );
 298         }
 299
 300         function invalidateCategories( $cats ) {
 301                 $this->invalidatePages( NS_CATEGORY, array_keys( $cats ) );
 302         }
 303
 304         /**
 305          * Update all the appropriate counts in the category table.
 306          * @param $added associative array of category name => sort key
 307          * @param $deleted associative array of category name => sort key
 308          */
 309         function updateCategoryCounts( $added, $deleted ) {
 310                 $a = new Article($this->mTitle);
 311                 $a->updateCategoryCounts(
 312                         array_keys( $added ), array_keys( $deleted )
 313                 );
 314         }
 315
 316         function invalidateImageDescriptions( $images ) {
 317                 $this->invalidatePages( NS_FILE, array_keys( $images ) );
 318         }
 319
 320         function dumbTableUpdate( $table, $insertions, $fromField ) {
 321                 $this->mDb->delete( $table, array( $fromField => $this->mId ), __METHOD__ );
 322                 if ( count( $insertions ) ) {
 323                         # The link array was constructed without FOR UPDATE, so there may
 324                         # be collisions.  This may cause minor link table inconsistencies,
 325                         # which is better than crippling the site with lock contention.
 326                         $this->mDb->insert( $table, $insertions, __METHOD__, array( 'IGNORE' ) );
 327                 }
 328         }
 329
 330         /**
 331          * Update a table by doing a delete query then an insert query
 332          *
 333          */
 334         function incrTableUpdate( $table, $prefix, $deletions, $insertions ) {
 335                 if ( $table == 'page_props' ) {
 336                         $fromField = 'pp_page';
 337                 } else {
 338                         $fromField = "{$prefix}_from";
 339                 }
 340                 $where = array( $fromField => $this->mId );
 341                 if ( $table == 'pagelinks' || $table == 'templatelinks' || $table == 'iwlinks' ) {
 342                         if ( $table == 'iwlinks' ) {
 343                                 $baseKey = 'iwl_prefix';
 344                         } else {
 345                                 $baseKey = "{$prefix}_namespace";
 346                         }
 347                         $clause = $this->mDb->makeWhereFrom2d( $deletions, $baseKey, "{$prefix}_title" );
 348                         if ( $clause ) {
 349                                 $where[] = $clause;
 350                         } else {
 351                                 $where = false;
 352                         }
 353                 } else {
 354                         if ( $table == 'langlinks' ) {
 355                                 $toField = 'll_lang';
 356                         } elseif ( $table == 'page_props' ) {
 357                                 $toField = 'pp_propname';
 358                         } else {
 359                                 $toField = $prefix . '_to';
 360                         }
 361                         if ( count( $deletions ) ) {
 362                                 $where[] = "$toField IN (" . $this->mDb->makeList( array_keys( $deletions ) ) . ')';
 363                         } else {
 364                                 $where = false;
 365                         }
 366                 }
 367                 if ( $where ) {
 368                         $this->mDb->delete( $table, $where, __METHOD__ );
 369                 }
 370                 if ( count( $insertions ) ) {
 371                         $this->mDb->insert( $table, $insertions, __METHOD__, 'IGNORE' );
 372                 }
 373         }
 374
 375
 376         /**
 377          * Get an array of pagelinks insertions for passing to the DB
 378          * Skips the titles specified by the 2-D array $existing
 379          *
 380          */
 381         function getLinkInsertions( $existing = array() ) {
 382                 $arr = array();
 383                 foreach( $this->mLinks as $ns => $dbkeys ) {
 384                         $diffs = isset( $existing[$ns] )
 385                                 ? array_diff_key( $dbkeys, $existing[$ns] )
 386                                 : $dbkeys;
 387                         foreach ( $diffs as $dbk => $id ) {
 388                                 $arr[] = array(
 389                                         'pl_from'      => $this->mId,
 390                                         'pl_namespace' => $ns,
 391                                         'pl_title'     => $dbk
 392                                 );
 393                         }
 394                 }
 395                 return $arr;
 396         }
 397
 398         /**
 399          * Get an array of template insertions. Like getLinkInsertions()
 400          *
 401          */
 402         function getTemplateInsertions( $existing = array() ) {
 403                 $arr = array();
 404                 foreach( $this->mTemplates as $ns => $dbkeys ) {
 405                         $diffs = isset( $existing[$ns] ) ? array_diff_key( $dbkeys, $existing[$ns] ) : $dbkeys;
 406                         foreach ( $diffs as $dbk => $id ) {
 407                                 $arr[] = array(
 408                                         'tl_from'      => $this->mId,
 409                                         'tl_namespace' => $ns,
 410                                         'tl_title'     => $dbk
 411                                 );
 412                         }
 413                 }
 414                 return $arr;
 415         }
 416
 417         /**
 418          * Get an array of image insertions
 419          * Skips the names specified in $existing
 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          */
 436         function getExternalInsertions( $existing = array() ) {
 437                 $arr = array();
 438                 $diffs = array_diff_key( $this->mExternals, $existing );
 439                 foreach( $diffs as $url => $dummy ) {
 440                         $arr[] = array(
 441                                 'el_from'   => $this->mId,
 442                                 'el_to'     => $url,
 443                                 'el_index'  => wfMakeUrlIndex( $url ),
 444                         );
 445                 }
 446                 return $arr;
 447         }
 448
 449         /**
 450          * Get an array of category insertions
 451          *
 452          * @param $existing Array mapping existing category names to sort keys. If both
 453          * match a link in $this, the link will be omitted from the output
 454          */
 455         function getCategoryInsertions( $existing = array() ) {
 456                 global $wgContLang, $wgCategoryCollation;
 457                 $diffs = array_diff_assoc( $this->mCategories, $existing );
 458                 $arr = array();
 459                 foreach ( $diffs as $name => $prefix ) {
 460                         $nt = Title::makeTitleSafe( NS_CATEGORY, $name );
 461                         $wgContLang->findVariantLink( $name, $nt, true );
 462
 463                         if ( $this->mTitle->getNamespace() == NS_CATEGORY ) {
 464                                 $type = 'subcat';
 465                         } elseif ( $this->mTitle->getNamespace() == NS_FILE ) {
 466                                 $type = 'file';
 467                         } else {
 468                                 $type = 'page';
 469                         }
 470
 471                         # Treat custom sortkeys as a prefix, so that if multiple
 472                         # things are forced to sort as '*' or something, they'll
 473                         # sort properly in the category rather than in page_id
 474                         # order or such.
 475                         $sortkey = Collation::singleton()->getSortKey(
 476                                 $this->mTitle->getCategorySortkey( $prefix ) );
 477
 478                         $arr[] = array(
 479                                 'cl_from'    => $this->mId,
 480                                 'cl_to'      => $name,
 481                                 'cl_sortkey' => $sortkey,
 482                                 'cl_timestamp' => $this->mDb->timestamp(),
 483                                 'cl_sortkey_prefix' => $prefix,
 484                                 'cl_collation' => $wgCategoryCollation,
 485                                 'cl_type' => $type,
 486                         );
 487                 }
 488                 return $arr;
 489         }
 490
 491         /**
 492          * Get an array of interlanguage link insertions
 493          *
 494          * @param $existing Array mapping existing language codes to titles
 495          *
 496          */
 497         function getInterlangInsertions( $existing = array() ) {
 498                 $diffs = array_diff_assoc( $this->mInterlangs, $existing );
 499                 $arr = array();
 500                 foreach( $diffs as $lang => $title ) {
 501                         $arr[] = array(
 502                                 'll_from'  => $this->mId,
 503                                 'll_lang'  => $lang,
 504                                 'll_title' => $title
 505                         );
 506                 }
 507                 return $arr;
 508         }
 509
 510         /**
 511          * Get an array of page property insertions
 512          */
 513         function getPropertyInsertions( $existing = array() ) {
 514                 $diffs = array_diff_assoc( $this->mProperties, $existing );
 515                 $arr = array();
 516                 foreach ( $diffs as $name => $value ) {
 517                         $arr[] = array(
 518                                 'pp_page'      => $this->mId,
 519                                 'pp_propname'  => $name,
 520                                 'pp_value'     => $value,
 521                         );
 522                 }
 523                 return $arr;
 524         }
 525
 526         /**
 527          * Get an array of interwiki insertions for passing to the DB
 528          * Skips the titles specified by the 2-D array $existing
 529          *
 530          */
 531         function getInterwikiInsertions( $existing = array() ) {
 532                 $arr = array();
 533                 foreach( $this->mInterwikis as $prefix => $dbkeys ) {
 534                         $diffs = isset( $existing[$prefix] ) ? array_diff_key( $dbkeys, $existing[$prefix] ) : $dbkeys;
 535                         foreach ( $diffs as $dbk => $id ) {
 536                                 $arr[] = array(
 537                                         'iwl_from'   => $this->mId,
 538                                         'iwl_prefix' => $prefix,
 539                                         'iwl_title'  => $dbk
 540                                 );
 541                         }
 542                 }
 543                 return $arr;
 544         }
 545
 546         /**
 547          * Given an array of existing links, returns those links which are not in $this
 548          * and thus should be deleted.
 549          *
 550          */
 551         function getLinkDeletions( $existing ) {
 552                 $del = array();
 553                 foreach ( $existing as $ns => $dbkeys ) {
 554                         if ( isset( $this->mLinks[$ns] ) ) {
 555                                 $del[$ns] = array_diff_key( $existing[$ns], $this->mLinks[$ns] );
 556                         } else {
 557                                 $del[$ns] = $existing[$ns];
 558                         }
 559                 }
 560                 return $del;
 561         }
 562
 563         /**
 564          * Given an array of existing templates, returns those templates which are not in $this
 565          * and thus should be deleted.
 566          *
 567          */
 568         function getTemplateDeletions( $existing ) {
 569                 $del = array();
 570                 foreach ( $existing as $ns => $dbkeys ) {
 571                         if ( isset( $this->mTemplates[$ns] ) ) {
 572                                 $del[$ns] = array_diff_key( $existing[$ns], $this->mTemplates[$ns] );
 573                         } else {
 574                                 $del[$ns] = $existing[$ns];
 575                         }
 576                 }
 577                 return $del;
 578         }
 579
 580         /**
 581          * Given an array of existing images, returns those images which are not in $this
 582          * and thus should be deleted.
 583          *
 584          */
 585         function getImageDeletions( $existing ) {
 586                 return array_diff_key( $existing, $this->mImages );
 587         }
 588
 589         /**
 590          * Given an array of existing external links, returns those links which are not
 591          * in $this and thus should be deleted.
 592          *
 593          */
 594         function getExternalDeletions( $existing ) {
 595                 return array_diff_key( $existing, $this->mExternals );
 596         }
 597
 598         /**
 599          * Given an array of existing categories, returns those categories which are not in $this
 600          * and thus should be deleted.
 601          *
 602          */
 603         function getCategoryDeletions( $existing ) {
 604                 return array_diff_assoc( $existing, $this->mCategories );
 605         }
 606
 607         /**
 608          * Given an array of existing interlanguage links, returns those links which are not
 609          * in $this and thus should be deleted.
 610          *
 611          */
 612         function getInterlangDeletions( $existing ) {
 613                 return array_diff_assoc( $existing, $this->mInterlangs );
 614         }
 615
 616         /**
 617          * Get array of properties which should be deleted.
 618          *
 619          */
 620         function getPropertyDeletions( $existing ) {
 621                 return array_diff_assoc( $existing, $this->mProperties );
 622         }
 623
 624         /**
 625          * Given an array of existing interwiki links, returns those links which are not in $this
 626          * and thus should be deleted.
 627          *
 628          */
 629         function getInterwikiDeletions( $existing ) {
 630                 $del = array();
 631                 foreach ( $existing as $prefix => $dbkeys ) {
 632                         if ( isset( $this->mInterwikis[$prefix] ) ) {
 633                                 $del[$prefix] = array_diff_key( $existing[$prefix], $this->mInterwikis[$prefix] );
 634                         } else {
 635                                 $del[$prefix] = $existing[$prefix];
 636                         }
 637                 }
 638                 return $del;
 639         }
 640
 641         /**
 642          * Get an array of existing links, as a 2-D array
 643          *
 644          */
 645         function getExistingLinks() {
 646                 $res = $this->mDb->select( 'pagelinks', array( 'pl_namespace', 'pl_title' ),
 647                         array( 'pl_from' => $this->mId ), __METHOD__, $this->mOptions );
 648                 $arr = array();
 649                 foreach ( $res as $row ) {
 650                         if ( !isset( $arr[$row->pl_namespace] ) ) {
 651                                 $arr[$row->pl_namespace] = array();
 652                         }
 653                         $arr[$row->pl_namespace][$row->pl_title] = 1;
 654                 }
 655                 return $arr;
 656         }
 657
 658         /**
 659          * Get an array of existing templates, as a 2-D array
 660          *
 661          */
 662         function getExistingTemplates() {
 663                 $res = $this->mDb->select( 'templatelinks', array( 'tl_namespace', 'tl_title' ),
 664                         array( 'tl_from' => $this->mId ), __METHOD__, $this->mOptions );
 665                 $arr = array();
 666                 foreach ( $res as $row ) {
 667                         if ( !isset( $arr[$row->tl_namespace] ) ) {
 668                                 $arr[$row->tl_namespace] = array();
 669                         }
 670                         $arr[$row->tl_namespace][$row->tl_title] = 1;
 671                 }
 672                 return $arr;
 673         }
 674
 675         /**
 676          * Get an array of existing images, image names in the keys
 677          *
 678          */
 679         function getExistingImages() {
 680                 $res = $this->mDb->select( 'imagelinks', array( 'il_to' ),
 681                         array( 'il_from' => $this->mId ), __METHOD__, $this->mOptions );
 682                 $arr = array();
 683                 foreach ( $res as $row ) {
 684                         $arr[$row->il_to] = 1;
 685                 }
 686                 return $arr;
 687         }
 688
 689         /**
 690          * Get an array of existing external links, URLs in the keys
 691          *
 692          */
 693         function getExistingExternals() {
 694                 $res = $this->mDb->select( 'externallinks', array( 'el_to' ),
 695                         array( 'el_from' => $this->mId ), __METHOD__, $this->mOptions );
 696                 $arr = array();
 697                 foreach ( $res as $row ) {
 698                         $arr[$row->el_to] = 1;
 699                 }
 700                 return $arr;
 701         }
 702
 703         /**
 704          * Get an array of existing categories, with the name in the key and sort key in the value.
 705          *
 706          */
 707         function getExistingCategories() {
 708                 $res = $this->mDb->select( 'categorylinks', array( 'cl_to', 'cl_sortkey_prefix' ),
 709                         array( 'cl_from' => $this->mId ), __METHOD__, $this->mOptions );
 710                 $arr = array();
 711                 foreach ( $res as $row ) {
 712                         $arr[$row->cl_to] = $row->cl_sortkey_prefix;
 713                 }
 714                 return $arr;
 715         }
 716
 717         /**
 718          * Get an array of existing interlanguage links, with the language code in the key and the
 719          * title in the value.
 720          *
 721          */
 722         function getExistingInterlangs() {
 723                 $res = $this->mDb->select( 'langlinks', array( 'll_lang', 'll_title' ),
 724                         array( 'll_from' => $this->mId ), __METHOD__, $this->mOptions );
 725                 $arr = array();
 726                 foreach ( $res as $row ) {
 727                         $arr[$row->ll_lang] = $row->ll_title;
 728                 }
 729                 return $arr;
 730         }
 731
 732         /**
 733          * Get an array of existing inline interwiki links, as a 2-D array
 734          * @return array (prefix => array(dbkey => 1))
 735          */
 736         protected function getExistingInterwikis() {
 737                 $res = $this->mDb->select( 'iwlinks', array( 'iwl_prefix', 'iwl_title' ),
 738                         array( 'iwl_from' => $this->mId ), __METHOD__, $this->mOptions );
 739                 $arr = array();
 740                 foreach ( $res as $row ) {
 741                         if ( !isset( $arr[$row->iwl_prefix] ) ) {
 742                                 $arr[$row->iwl_prefix] = array();
 743                         }
 744                         $arr[$row->iwl_prefix][$row->iwl_title] = 1;
 745                 }
 746                 return $arr;
 747         }
 748
 749         /**
 750          * Get an array of existing categories, with the name in the key and sort key in the value.
 751          *
 752          */
 753         function getExistingProperties() {
 754                 $res = $this->mDb->select( 'page_props', array( 'pp_propname', 'pp_value' ),
 755                         array( 'pp_page' => $this->mId ), __METHOD__, $this->mOptions );
 756                 $arr = array();
 757                 foreach ( $res as $row ) {
 758                         $arr[$row->pp_propname] = $row->pp_value;
 759                 }
 760                 return $arr;
 761         }
 762
 763
 764         /**
 765          * Return the title object of the page being updated
 766          */
 767         function getTitle() {
 768                 return $this->mTitle;
 769         }
 770
 771         /**
 772          * Return the list of images used as generated by the parser
 773          */
 774         public function getImages() {
 775                 return $this->mImages;
 776         }
 777
 778         /**
 779          * Invalidate any necessary link lists related to page property changes
 780          */
 781         function invalidateProperties( $changed ) {
 782                 global $wgPagePropLinkInvalidations;
 783
 784                 foreach ( $changed as $name => $value ) {
 785                         if ( isset( $wgPagePropLinkInvalidations[$name] ) ) {
 786                                 $inv = $wgPagePropLinkInvalidations[$name];
 787                                 if ( !is_array( $inv ) ) {
 788                                         $inv = array( $inv );
 789                                 }
 790                                 foreach ( $inv as $table ) {
 791                                         $update = new HTMLCacheUpdate( $this->mTitle, $table );
 792                                         $update->doUpdate();
 793                                 }
 794                         }
 795                 }
 796         }
 797 }