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