3 * See docs/deferred.txt
5 * @todo document (e.g. one-sentence top-level class description).
12 var $mId, //!< Page ID of the article linked from
13 $mTitle, //!< Title object of the article linked from
14 $mLinks, //!< Map of title strings to IDs for the links in the document
15 $mImages, //!< DB keys of the images used, in the array key only
16 $mTemplates, //!< Map of title strings to IDs for the template references, including broken ones
17 $mExternals, //!< URLs of external links, array key only
18 $mCategories, //!< Map of category names to sort keys
19 $mInterlangs, //!< Map of language codes to titles
20 $mProperties, //!< Map of arbitrary name to value
21 $mDb, //!< Database connection reference
22 $mOptions, //!< SELECT options to be used (array)
23 $mRecursive; //!< Whether to queue jobs for recursive updates
29 * @param Title $title Title of the page we're updating
30 * @param ParserOutput $parserOutput Output from a full parse of this page
31 * @param bool $recursive Queue jobs for recursive updates?
33 function LinksUpdate( $title, $parserOutput, $recursive = true ) {
34 global $wgAntiLockFlags;
36 if ( $wgAntiLockFlags & ALF_NO_LINK_LOCK
) {
37 $this->mOptions
= array();
39 $this->mOptions
= array( 'FOR UPDATE' );
41 $this->mDb
= wfGetDB( DB_MASTER
);
43 if ( !is_object( $title ) ) {
44 throw new MWException( "The calling convention to LinksUpdate::LinksUpdate() has changed. " .
45 "Please see Article::editUpdates() for an invocation example.\n" );
47 $this->mTitle
= $title;
48 $this->mId
= $title->getArticleID();
50 $this->mLinks
= $parserOutput->getLinks();
51 $this->mImages
= $parserOutput->getImages();
52 $this->mTemplates
= $parserOutput->getTemplates();
53 $this->mExternals
= $parserOutput->getExternalLinks();
54 $this->mCategories
= $parserOutput->getCategories();
55 $this->mProperties
= $parserOutput->getProperties();
57 # Convert the format of the interlanguage links
58 # I didn't want to change it in the ParserOutput, because that array is passed all
59 # the way back to the skin, so either a skin API break would be required, or an
60 # inefficient back-conversion.
61 $ill = $parserOutput->getLanguageLinks();
62 $this->mInterlangs
= array();
63 foreach ( $ill as $link ) {
64 list( $key, $title ) = explode( ':', $link, 2 );
65 $this->mInterlangs
[$key] = $title;
68 $this->mRecursive
= $recursive;
70 wfRunHooks( 'LinksUpdateConstructed', array( &$this ) );
74 * Update link tables with outgoing links from an updated article
77 global $wgUseDumbLinkUpdate;
79 wfRunHooks( 'LinksUpdate', array( &$this ) );
80 if ( $wgUseDumbLinkUpdate ) {
81 $this->doDumbUpdate();
83 $this->doIncrementalUpdate();
85 wfRunHooks( 'LinksUpdateComplete', array( &$this ) );
89 function doIncrementalUpdate() {
90 wfProfileIn( __METHOD__
);
93 $existing = $this->getExistingLinks();
94 $this->incrTableUpdate( 'pagelinks', 'pl', $this->getLinkDeletions( $existing ),
95 $this->getLinkInsertions( $existing ) );
98 $existing = $this->getExistingImages();
99 $this->incrTableUpdate( 'imagelinks', 'il', $this->getImageDeletions( $existing ),
100 $this->getImageInsertions( $existing ) );
102 # Invalidate all image description pages which had links added or removed
103 $imageUpdates = array_diff_key( $existing, $this->mImages
) +
array_diff_key( $this->mImages
, $existing );
104 $this->invalidateImageDescriptions( $imageUpdates );
107 $existing = $this->getExistingExternals();
108 $this->incrTableUpdate( 'externallinks', 'el', $this->getExternalDeletions( $existing ),
109 $this->getExternalInsertions( $existing ) );
112 $existing = $this->getExistingInterlangs();
113 $this->incrTableUpdate( 'langlinks', 'll', $this->getInterlangDeletions( $existing ),
114 $this->getInterlangInsertions( $existing ) );
117 $existing = $this->getExistingTemplates();
118 $this->incrTableUpdate( 'templatelinks', 'tl', $this->getTemplateDeletions( $existing ),
119 $this->getTemplateInsertions( $existing ) );
122 $existing = $this->getExistingCategories();
123 $this->incrTableUpdate( 'categorylinks', 'cl', $this->getCategoryDeletions( $existing ),
124 $this->getCategoryInsertions( $existing ) );
126 # Invalidate all categories which were added, deleted or changed (set symmetric difference)
127 $categoryUpdates = array_diff_assoc( $existing, $this->mCategories
) +
array_diff_assoc( $this->mCategories
, $existing );
128 $this->invalidateCategories( $categoryUpdates );
131 $existing = $this->getExistingProperties();
132 $this->incrTableUpdate( 'page_props', 'pp', $this->getPropertyDeletions( $existing ),
133 $this->getPropertyInsertions( $existing ) );
135 # Invalidate the necessary pages
136 $changed = array_diff_assoc( $existing, $this->mProperties
) +
array_diff_assoc( $this->mProperties
, $existing );
137 $this->invalidateProperties( $changed );
139 # Refresh links of all pages including this page
140 # This will be in a separate transaction
141 if ( $this->mRecursive
) {
142 $this->queueRecursiveJobs();
145 wfProfileOut( __METHOD__
);
149 * Link update which clears the previous entries and inserts new ones
150 * May be slower or faster depending on level of lock contention and write speed of DB
151 * Also useful where link table corruption needs to be repaired, e.g. in refreshLinks.php
153 function doDumbUpdate() {
154 wfProfileIn( __METHOD__
);
156 # Refresh category pages and image description pages
157 $existing = $this->getExistingCategories();
158 $categoryUpdates = array_diff_assoc( $existing, $this->mCategories
) +
array_diff_assoc( $this->mCategories
, $existing );
159 $existing = $this->getExistingImages();
160 $imageUpdates = array_diff_key( $existing, $this->mImages
) +
array_diff_key( $this->mImages
, $existing );
162 $this->dumbTableUpdate( 'pagelinks', $this->getLinkInsertions(), 'pl_from' );
163 $this->dumbTableUpdate( 'imagelinks', $this->getImageInsertions(), 'il_from' );
164 $this->dumbTableUpdate( 'categorylinks', $this->getCategoryInsertions(), 'cl_from' );
165 $this->dumbTableUpdate( 'templatelinks', $this->getTemplateInsertions(), 'tl_from' );
166 $this->dumbTableUpdate( 'externallinks', $this->getExternalInsertions(), 'el_from' );
167 $this->dumbTableUpdate( 'langlinks', $this->getInterlangInsertions(),'ll_from' );
168 $this->dumbTableUpdate( 'page_props', $this->getPropertyInsertions(), 'pp_page' );
170 # Update the cache of all the category pages and image description pages which were changed
171 $this->invalidateCategories( $categoryUpdates );
172 $this->invalidateImageDescriptions( $imageUpdates );
174 # Refresh links of all pages including this page
175 # This will be in a separate transaction
176 if ( $this->mRecursive
) {
177 $this->queueRecursiveJobs();
180 wfProfileOut( __METHOD__
);
183 function queueRecursiveJobs() {
184 wfProfileIn( __METHOD__
);
187 $dbr = wfGetDB( DB_SLAVE
);
188 $res = $dbr->select( array( 'templatelinks', 'page' ),
189 array( 'page_namespace', 'page_title' ),
192 'tl_namespace' => $this->mTitle
->getNamespace(),
193 'tl_title' => $this->mTitle
->getDBkey()
200 for ( $i = 0; $i < $batchSize; $i++
) {
201 $row = $dbr->fetchObject( $res );
206 $title = Title
::makeTitle( $row->page_namespace
, $row->page_title
);
207 $jobs[] = new RefreshLinksJob( $title, '' );
209 Job
::batchInsert( $jobs );
211 $dbr->freeResult( $res );
212 wfProfileOut( __METHOD__
);
216 * Invalidate the cache of a list of pages from a single namespace
218 * @param integer $namespace
219 * @param array $dbkeys
221 function invalidatePages( $namespace, $dbkeys ) {
222 if ( !count( $dbkeys ) ) {
227 * Determine which pages need to be updated
228 * This is necessary to prevent the job queue from smashing the DB with
229 * large numbers of concurrent invalidations of the same page
231 $now = $this->mDb
->timestamp();
233 $res = $this->mDb
->select( 'page', array( 'page_id' ),
235 'page_namespace' => $namespace,
236 'page_title IN (' . $this->mDb
->makeList( $dbkeys ) . ')',
237 'page_touched < ' . $this->mDb
->addQuotes( $now )
240 while ( $row = $this->mDb
->fetchObject( $res ) ) {
241 $ids[] = $row->page_id
;
243 if ( !count( $ids ) ) {
249 * We still need the page_touched condition, in case the row has changed since
250 * the non-locking select above.
252 $this->mDb
->update( 'page', array( 'page_touched' => $now ),
254 'page_id IN (' . $this->mDb
->makeList( $ids ) . ')',
255 'page_touched < ' . $this->mDb
->addQuotes( $now )
260 function invalidateCategories( $cats ) {
261 $this->invalidatePages( NS_CATEGORY
, array_keys( $cats ) );
264 function invalidateImageDescriptions( $images ) {
265 $this->invalidatePages( NS_IMAGE
, array_keys( $images ) );
268 function dumbTableUpdate( $table, $insertions, $fromField ) {
269 $this->mDb
->delete( $table, array( $fromField => $this->mId
), __METHOD__
);
270 if ( count( $insertions ) ) {
271 # The link array was constructed without FOR UPDATE, so there may be collisions
272 # This may cause minor link table inconsistencies, which is better than
273 # crippling the site with lock contention.
274 $this->mDb
->insert( $table, $insertions, __METHOD__
, array( 'IGNORE' ) );
279 * Make a WHERE clause from a 2-d NS/dbkey array
281 * @param array $arr 2-d array indexed by namespace and DB key
282 * @param string $prefix Field name prefix, without the underscore
284 function makeWhereFrom2d( &$arr, $prefix ) {
286 $lb->setArray( $arr );
287 return $lb->constructSet( $prefix, $this->mDb
);
291 * Update a table by doing a delete query then an insert query
294 function incrTableUpdate( $table, $prefix, $deletions, $insertions ) {
295 if ( $table == 'page_props' ) {
296 $fromField = 'pp_page';
298 $fromField = "{$prefix}_from";
300 $where = array( $fromField => $this->mId
);
301 if ( $table == 'pagelinks' ||
$table == 'templatelinks' ) {
302 $clause = $this->makeWhereFrom2d( $deletions, $prefix );
309 if ( $table == 'langlinks' ) {
310 $toField = 'll_lang';
311 } elseif ( $table == 'page_props' ) {
312 $toField = 'pp_propname';
314 $toField = $prefix . '_to';
316 if ( count( $deletions ) ) {
317 $where[] = "$toField IN (" . $this->mDb
->makeList( array_keys( $deletions ) ) . ')';
323 $this->mDb
->delete( $table, $where, __METHOD__
);
325 if ( count( $insertions ) ) {
326 $this->mDb
->insert( $table, $insertions, __METHOD__
, 'IGNORE' );
332 * Get an array of pagelinks insertions for passing to the DB
333 * Skips the titles specified by the 2-D array $existing
336 function getLinkInsertions( $existing = array() ) {
338 foreach( $this->mLinks
as $ns => $dbkeys ) {
339 # array_diff_key() was introduced in PHP 5.1, there is a compatibility function
340 # in GlobalFunctions.php
341 $diffs = isset( $existing[$ns] ) ?
array_diff_key( $dbkeys, $existing[$ns] ) : $dbkeys;
342 foreach ( $diffs as $dbk => $id ) {
344 'pl_from' => $this->mId
,
345 'pl_namespace' => $ns,
354 * Get an array of template insertions. Like getLinkInsertions()
357 function getTemplateInsertions( $existing = array() ) {
359 foreach( $this->mTemplates
as $ns => $dbkeys ) {
360 $diffs = isset( $existing[$ns] ) ?
array_diff_key( $dbkeys, $existing[$ns] ) : $dbkeys;
361 foreach ( $diffs as $dbk => $id ) {
363 'tl_from' => $this->mId
,
364 'tl_namespace' => $ns,
373 * Get an array of image insertions
374 * Skips the names specified in $existing
377 function getImageInsertions( $existing = array() ) {
379 $diffs = array_diff_key( $this->mImages
, $existing );
380 foreach( $diffs as $iname => $dummy ) {
382 'il_from' => $this->mId
,
390 * Get an array of externallinks insertions. Skips the names specified in $existing
393 function getExternalInsertions( $existing = array() ) {
395 $diffs = array_diff_key( $this->mExternals
, $existing );
396 foreach( $diffs as $url => $dummy ) {
398 'el_from' => $this->mId
,
400 'el_index' => wfMakeUrlIndex( $url ),
407 * Get an array of category insertions
408 * @param array $existing Array mapping existing category names to sort keys. If both
409 * match a link in $this, the link will be omitted from the output
412 function getCategoryInsertions( $existing = array() ) {
413 $diffs = array_diff_assoc( $this->mCategories
, $existing );
415 foreach ( $diffs as $name => $sortkey ) {
417 'cl_from' => $this->mId
,
419 'cl_sortkey' => $sortkey,
420 'cl_timestamp' => $this->mDb
->timestamp()
427 * Get an array of interlanguage link insertions
428 * @param array $existing Array mapping existing language codes to titles
431 function getInterlangInsertions( $existing = array() ) {
432 $diffs = array_diff_assoc( $this->mInterlangs
, $existing );
434 foreach( $diffs as $lang => $title ) {
436 'll_from' => $this->mId
,
445 * Get an array of page property insertions
447 function getPropertyInsertions( $existing = array() ) {
448 $diffs = array_diff_assoc( $this->mProperties
, $existing );
450 foreach ( $diffs as $name => $value ) {
452 'pp_page' => $this->mId
,
453 'pp_propname' => $name,
454 'pp_value' => $value,
462 * Given an array of existing links, returns those links which are not in $this
463 * and thus should be deleted.
466 function getLinkDeletions( $existing ) {
468 foreach ( $existing as $ns => $dbkeys ) {
469 if ( isset( $this->mLinks
[$ns] ) ) {
470 $del[$ns] = array_diff_key( $existing[$ns], $this->mLinks
[$ns] );
472 $del[$ns] = $existing[$ns];
479 * Given an array of existing templates, returns those templates which are not in $this
480 * and thus should be deleted.
483 function getTemplateDeletions( $existing ) {
485 foreach ( $existing as $ns => $dbkeys ) {
486 if ( isset( $this->mTemplates
[$ns] ) ) {
487 $del[$ns] = array_diff_key( $existing[$ns], $this->mTemplates
[$ns] );
489 $del[$ns] = $existing[$ns];
496 * Given an array of existing images, returns those images which are not in $this
497 * and thus should be deleted.
500 function getImageDeletions( $existing ) {
501 return array_diff_key( $existing, $this->mImages
);
505 * Given an array of existing external links, returns those links which are not
506 * in $this and thus should be deleted.
509 function getExternalDeletions( $existing ) {
510 return array_diff_key( $existing, $this->mExternals
);
514 * Given an array of existing categories, returns those categories which are not in $this
515 * and thus should be deleted.
518 function getCategoryDeletions( $existing ) {
519 return array_diff_assoc( $existing, $this->mCategories
);
523 * Given an array of existing interlanguage links, returns those links which are not
524 * in $this and thus should be deleted.
527 function getInterlangDeletions( $existing ) {
528 return array_diff_assoc( $existing, $this->mInterlangs
);
532 * Get array of properties which should be deleted.
535 function getPropertyDeletions( $existing ) {
536 return array_diff_assoc( $existing, $this->mProperties
);
540 * Get an array of existing links, as a 2-D array
543 function getExistingLinks() {
544 $res = $this->mDb
->select( 'pagelinks', array( 'pl_namespace', 'pl_title' ),
545 array( 'pl_from' => $this->mId
), __METHOD__
, $this->mOptions
);
547 while ( $row = $this->mDb
->fetchObject( $res ) ) {
548 if ( !isset( $arr[$row->pl_namespace
] ) ) {
549 $arr[$row->pl_namespace
] = array();
551 $arr[$row->pl_namespace
][$row->pl_title
] = 1;
553 $this->mDb
->freeResult( $res );
558 * Get an array of existing templates, as a 2-D array
561 function getExistingTemplates() {
562 $res = $this->mDb
->select( 'templatelinks', array( 'tl_namespace', 'tl_title' ),
563 array( 'tl_from' => $this->mId
), __METHOD__
, $this->mOptions
);
565 while ( $row = $this->mDb
->fetchObject( $res ) ) {
566 if ( !isset( $arr[$row->tl_namespace
] ) ) {
567 $arr[$row->tl_namespace
] = array();
569 $arr[$row->tl_namespace
][$row->tl_title
] = 1;
571 $this->mDb
->freeResult( $res );
576 * Get an array of existing images, image names in the keys
579 function getExistingImages() {
580 $res = $this->mDb
->select( 'imagelinks', array( 'il_to' ),
581 array( 'il_from' => $this->mId
), __METHOD__
, $this->mOptions
);
583 while ( $row = $this->mDb
->fetchObject( $res ) ) {
584 $arr[$row->il_to
] = 1;
586 $this->mDb
->freeResult( $res );
591 * Get an array of existing external links, URLs in the keys
594 function getExistingExternals() {
595 $res = $this->mDb
->select( 'externallinks', array( 'el_to' ),
596 array( 'el_from' => $this->mId
), __METHOD__
, $this->mOptions
);
598 while ( $row = $this->mDb
->fetchObject( $res ) ) {
599 $arr[$row->el_to
] = 1;
601 $this->mDb
->freeResult( $res );
606 * Get an array of existing categories, with the name in the key and sort key in the value.
609 function getExistingCategories() {
610 $res = $this->mDb
->select( 'categorylinks', array( 'cl_to', 'cl_sortkey' ),
611 array( 'cl_from' => $this->mId
), __METHOD__
, $this->mOptions
);
613 while ( $row = $this->mDb
->fetchObject( $res ) ) {
614 $arr[$row->cl_to
] = $row->cl_sortkey
;
616 $this->mDb
->freeResult( $res );
621 * Get an array of existing interlanguage links, with the language code in the key and the
622 * title in the value.
625 function getExistingInterlangs() {
626 $res = $this->mDb
->select( 'langlinks', array( 'll_lang', 'll_title' ),
627 array( 'll_from' => $this->mId
), __METHOD__
, $this->mOptions
);
629 while ( $row = $this->mDb
->fetchObject( $res ) ) {
630 $arr[$row->ll_lang
] = $row->ll_title
;
636 * Get an array of existing categories, with the name in the key and sort key in the value.
639 function getExistingProperties() {
640 $res = $this->mDb
->select( 'page_props', array( 'pp_propname', 'pp_value' ),
641 array( 'pp_page' => $this->mId
), __METHOD__
, $this->mOptions
);
643 while ( $row = $this->mDb
->fetchObject( $res ) ) {
644 $arr[$row->pp_propname
] = $row->pp_value
;
646 $this->mDb
->freeResult( $res );
652 * Return the title object of the page being updated
654 function getTitle() {
655 return $this->mTitle
;
659 * Invalidate any necessary link lists related to page property changes
661 function invalidateProperties( $changed ) {
662 global $wgPagePropLinkInvalidations;
664 foreach ( $changed as $name => $value ) {
665 if ( isset( $wgPagePropLinkInvalidations[$name] ) ) {
666 $inv = $wgPagePropLinkInvalidations[$name];
667 if ( !is_array( $inv ) ) {
668 $inv = array( $inv );
670 foreach ( $inv as $table ) {
671 $update = new HTMLCacheUpdate( $this->mTitle
, $table );