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