MediaWiki REL1_32
LinksUpdate.php
Go to the documentation of this file.
1<?php
26use Wikimedia\ScopedCallback;
27
36 // @todo make members protected, but make sure extensions don't break
37
39 public $mId;
40
42 public $mTitle;
43
46
48 public $mLinks;
49
51 public $mImages;
52
55
58
61
64
67
70
73
75 private $mRevision;
76
80 private $linkInsertions = null;
81
85 private $linkDeletions = null;
86
90 private $propertyInsertions = null;
91
95 private $propertyDeletions = null;
96
100 private $user;
101
103 private $db;
104
111 function __construct( Title $title, ParserOutput $parserOutput, $recursive = true ) {
112 parent::__construct();
113
114 $this->mTitle = $title;
115 $this->mId = $title->getArticleID( Title::GAID_FOR_UPDATE );
116
117 if ( !$this->mId ) {
118 throw new InvalidArgumentException(
119 "The Title object yields no ID. Perhaps the page doesn't exist?"
120 );
121 }
122
123 $this->mParserOutput = $parserOutput;
124
125 $this->mLinks = $parserOutput->getLinks();
126 $this->mImages = $parserOutput->getImages();
127 $this->mTemplates = $parserOutput->getTemplates();
128 $this->mExternals = $parserOutput->getExternalLinks();
129 $this->mCategories = $parserOutput->getCategories();
130 $this->mProperties = $parserOutput->getProperties();
131 $this->mInterwikis = $parserOutput->getInterwikiLinks();
132
133 # Convert the format of the interlanguage links
134 # I didn't want to change it in the ParserOutput, because that array is passed all
135 # the way back to the skin, so either a skin API break would be required, or an
136 # inefficient back-conversion.
137 $ill = $parserOutput->getLanguageLinks();
138 $this->mInterlangs = [];
139 foreach ( $ill as $link ) {
140 list( $key, $title ) = explode( ':', $link, 2 );
141 $this->mInterlangs[$key] = $title;
142 }
143
144 foreach ( $this->mCategories as &$sortkey ) {
145 # If the sortkey is longer then 255 bytes, it is truncated by DB, and then doesn't match
146 # when comparing existing vs current categories, causing T27254.
147 $sortkey = mb_strcut( $sortkey, 0, 255 );
148 }
149
150 $this->mRecursive = $recursive;
151
152 // Avoid PHP 7.1 warning from passing $this by reference
153 $linksUpdate = $this;
154 Hooks::run( 'LinksUpdateConstructed', [ &$linksUpdate ] );
155 }
156
162 public function doUpdate() {
163 if ( $this->ticket ) {
164 // Make sure all links update threads see the changes of each other.
165 // This handles the case when updates have to batched into several COMMITs.
166 $scopedLock = self::acquirePageLock( $this->getDB(), $this->mId );
167 if ( !$scopedLock ) {
168 throw new RuntimeException( "Could not acquire lock for page ID '{$this->mId}'." );
169 }
170 }
171
172 // Avoid PHP 7.1 warning from passing $this by reference
173 $linksUpdate = $this;
174 Hooks::run( 'LinksUpdate', [ &$linksUpdate ] );
175 $this->doIncrementalUpdate();
176
177 // Commit and release the lock (if set)
178 ScopedCallback::consume( $scopedLock );
179 // Run post-commit hook handlers without DBO_TRX
180 DeferredUpdates::addUpdate( new AutoCommitUpdate(
181 $this->getDB(),
182 __METHOD__,
183 function () {
184 // Avoid PHP 7.1 warning from passing $this by reference
185 $linksUpdate = $this;
186 Hooks::run( 'LinksUpdateComplete', [ &$linksUpdate, $this->ticket ] );
187 }
188 ) );
189 }
190
200 public static function acquirePageLock( IDatabase $dbw, $pageId, $why = 'atomicity' ) {
201 $key = "LinksUpdate:$why:pageid:$pageId";
202 $scopedLock = $dbw->getScopedLockAndFlush( $key, __METHOD__, 15 );
203 if ( !$scopedLock ) {
204 $logger = LoggerFactory::getInstance( 'SecondaryDataUpdate' );
205 $logger->info( "Could not acquire lock '{key}' for page ID '{page_id}'.", [
206 'key' => $key,
207 'page_id' => $pageId,
208 ] );
209 return null;
210 }
211
212 return $scopedLock;
213 }
214
215 protected function doIncrementalUpdate() {
216 # Page links
217 $existingPL = $this->getExistingLinks();
218 $this->linkDeletions = $this->getLinkDeletions( $existingPL );
219 $this->linkInsertions = $this->getLinkInsertions( $existingPL );
220 $this->incrTableUpdate( 'pagelinks', 'pl', $this->linkDeletions, $this->linkInsertions );
221
222 # Image links
223 $existingIL = $this->getExistingImages();
224 $imageDeletes = $this->getImageDeletions( $existingIL );
225 $this->incrTableUpdate(
226 'imagelinks',
227 'il',
228 $imageDeletes,
229 $this->getImageInsertions( $existingIL ) );
230
231 # Invalidate all image description pages which had links added or removed
232 $imageUpdates = $imageDeletes + array_diff_key( $this->mImages, $existingIL );
233 $this->invalidateImageDescriptions( $imageUpdates );
234
235 # External links
236 $existingEL = $this->getExistingExternals();
237 $this->incrTableUpdate(
238 'externallinks',
239 'el',
240 $this->getExternalDeletions( $existingEL ),
241 $this->getExternalInsertions( $existingEL ) );
242
243 # Language links
244 $existingLL = $this->getExistingInterlangs();
245 $this->incrTableUpdate(
246 'langlinks',
247 'll',
248 $this->getInterlangDeletions( $existingLL ),
249 $this->getInterlangInsertions( $existingLL ) );
250
251 # Inline interwiki links
252 $existingIW = $this->getExistingInterwikis();
253 $this->incrTableUpdate(
254 'iwlinks',
255 'iwl',
256 $this->getInterwikiDeletions( $existingIW ),
257 $this->getInterwikiInsertions( $existingIW ) );
258
259 # Template links
260 $existingTL = $this->getExistingTemplates();
261 $this->incrTableUpdate(
262 'templatelinks',
263 'tl',
264 $this->getTemplateDeletions( $existingTL ),
265 $this->getTemplateInsertions( $existingTL ) );
266
267 # Category links
268 $existingCL = $this->getExistingCategories();
269 $categoryDeletes = $this->getCategoryDeletions( $existingCL );
270 $this->incrTableUpdate(
271 'categorylinks',
272 'cl',
273 $categoryDeletes,
274 $this->getCategoryInsertions( $existingCL ) );
275 $categoryInserts = array_diff_assoc( $this->mCategories, $existingCL );
276 $categoryUpdates = $categoryInserts + $categoryDeletes;
277
278 # Page properties
279 $existingPP = $this->getExistingProperties();
280 $this->propertyDeletions = $this->getPropertyDeletions( $existingPP );
281 $this->incrTableUpdate(
282 'page_props',
283 'pp',
284 $this->propertyDeletions,
285 $this->getPropertyInsertions( $existingPP ) );
286
287 # Invalidate the necessary pages
288 $this->propertyInsertions = array_diff_assoc( $this->mProperties, $existingPP );
289 $changed = $this->propertyDeletions + $this->propertyInsertions;
290 $this->invalidateProperties( $changed );
291
292 # Invalidate all categories which were added, deleted or changed (set symmetric difference)
293 $this->invalidateCategories( $categoryUpdates );
294 $this->updateCategoryCounts( $categoryInserts, $categoryDeletes );
295
296 # Refresh links of all pages including this page
297 # This will be in a separate transaction
298 if ( $this->mRecursive ) {
299 $this->queueRecursiveJobs();
300 }
301
302 # Update the links table freshness for this title
303 $this->updateLinksTimestamp();
304 }
305
312 protected function queueRecursiveJobs() {
313 $action = $this->getCauseAction();
314 $agent = $this->getCauseAgent();
315
316 self::queueRecursiveJobsForTable( $this->mTitle, 'templatelinks', $action, $agent );
317 if ( $this->mTitle->getNamespace() == NS_FILE ) {
318 // Process imagelinks in case the title is or was a redirect
319 self::queueRecursiveJobsForTable( $this->mTitle, 'imagelinks', $action, $agent );
320 }
321
322 $bc = $this->mTitle->getBacklinkCache();
323 // Get jobs for cascade-protected backlinks for a high priority queue.
324 // If meta-templates change to using a new template, the new template
325 // should be implicitly protected as soon as possible, if applicable.
326 // These jobs duplicate a subset of the above ones, but can run sooner.
327 // Which ever runs first generally no-ops the other one.
328 $jobs = [];
329 foreach ( $bc->getCascadeProtectedLinks() as $title ) {
331 $title,
332 [
333 'causeAction' => $action,
334 'causeAgent' => $agent
335 ]
336 );
337 }
338 JobQueueGroup::singleton()->push( $jobs );
339 }
340
349 public static function queueRecursiveJobsForTable(
350 Title $title, $table, $action = 'unknown', $userName = 'unknown'
351 ) {
352 if ( $title->getBacklinkCache()->hasLinks( $table ) ) {
353 $job = new RefreshLinksJob(
354 $title,
355 [
356 'table' => $table,
357 'recursive' => true,
358 ] + Job::newRootJobParams( // "overall" refresh links job info
359 "refreshlinks:{$table}:{$title->getPrefixedText()}"
360 ) + [ 'causeAction' => $action, 'causeAgent' => $userName ]
361 );
362
363 JobQueueGroup::singleton()->push( $job );
364 }
365 }
366
370 private function invalidateCategories( $cats ) {
371 PurgeJobUtils::invalidatePages( $this->getDB(), NS_CATEGORY, array_keys( $cats ) );
372 }
373
379 private function updateCategoryCounts( array $added, array $deleted ) {
381
382 if ( !$added && !$deleted ) {
383 return;
384 }
385
386 $domainId = $this->getDB()->getDomainID();
387 $wp = WikiPage::factory( $this->mTitle );
388 $lbf = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
389 // T163801: try to release any row locks to reduce contention
390 $lbf->commitAndWaitForReplication( __METHOD__, $this->ticket, [ 'domain' => $domainId ] );
391
392 foreach ( array_chunk( array_keys( $added ), $wgUpdateRowsPerQuery ) as $addBatch ) {
393 $wp->updateCategoryCounts( $addBatch, [], $this->mId );
394 $lbf->commitAndWaitForReplication(
395 __METHOD__, $this->ticket, [ 'domain' => $domainId ] );
396 }
397
398 foreach ( array_chunk( array_keys( $deleted ), $wgUpdateRowsPerQuery ) as $deleteBatch ) {
399 $wp->updateCategoryCounts( [], $deleteBatch, $this->mId );
400 $lbf->commitAndWaitForReplication(
401 __METHOD__, $this->ticket, [ 'domain' => $domainId ] );
402 }
403 }
404
408 private function invalidateImageDescriptions( array $images ) {
409 PurgeJobUtils::invalidatePages( $this->getDB(), NS_FILE, array_keys( $images ) );
410 }
411
419 private function incrTableUpdate( $table, $prefix, $deletions, $insertions ) {
420 $services = MediaWikiServices::getInstance();
421 $bSize = $services->getMainConfig()->get( 'UpdateRowsPerQuery' );
422 $lbf = $services->getDBLoadBalancerFactory();
423
424 if ( $table === 'page_props' ) {
425 $fromField = 'pp_page';
426 } else {
427 $fromField = "{$prefix}_from";
428 }
429
430 $deleteWheres = []; // list of WHERE clause arrays for each DB delete() call
431 if ( $table === 'pagelinks' || $table === 'templatelinks' || $table === 'iwlinks' ) {
432 $baseKey = ( $table === 'iwlinks' ) ? 'iwl_prefix' : "{$prefix}_namespace";
433
434 $curBatchSize = 0;
435 $curDeletionBatch = [];
436 $deletionBatches = [];
437 foreach ( $deletions as $ns => $dbKeys ) {
438 foreach ( $dbKeys as $dbKey => $unused ) {
439 $curDeletionBatch[$ns][$dbKey] = 1;
440 if ( ++$curBatchSize >= $bSize ) {
441 $deletionBatches[] = $curDeletionBatch;
442 $curDeletionBatch = [];
443 $curBatchSize = 0;
444 }
445 }
446 }
447 if ( $curDeletionBatch ) {
448 $deletionBatches[] = $curDeletionBatch;
449 }
450
451 foreach ( $deletionBatches as $deletionBatch ) {
452 $deleteWheres[] = [
453 $fromField => $this->mId,
454 $this->getDB()->makeWhereFrom2d( $deletionBatch, $baseKey, "{$prefix}_title" )
455 ];
456 }
457 } else {
458 if ( $table === 'langlinks' ) {
459 $toField = 'll_lang';
460 } elseif ( $table === 'page_props' ) {
461 $toField = 'pp_propname';
462 } else {
463 $toField = $prefix . '_to';
464 }
465
466 $deletionBatches = array_chunk( array_keys( $deletions ), $bSize );
467 foreach ( $deletionBatches as $deletionBatch ) {
468 $deleteWheres[] = [ $fromField => $this->mId, $toField => $deletionBatch ];
469 }
470 }
471
472 $domainId = $this->getDB()->getDomainID();
473
474 foreach ( $deleteWheres as $deleteWhere ) {
475 $this->getDB()->delete( $table, $deleteWhere, __METHOD__ );
476 $lbf->commitAndWaitForReplication(
477 __METHOD__, $this->ticket, [ 'domain' => $domainId ]
478 );
479 }
480
481 $insertBatches = array_chunk( $insertions, $bSize );
482 foreach ( $insertBatches as $insertBatch ) {
483 $this->getDB()->insert( $table, $insertBatch, __METHOD__, 'IGNORE' );
484 $lbf->commitAndWaitForReplication(
485 __METHOD__, $this->ticket, [ 'domain' => $domainId ]
486 );
487 }
488
489 if ( count( $insertions ) ) {
490 Hooks::run( 'LinksUpdateAfterInsert', [ $this, $table, $insertions ] );
491 }
492 }
493
500 private function getLinkInsertions( $existing = [] ) {
501 $arr = [];
502 foreach ( $this->mLinks as $ns => $dbkeys ) {
503 $diffs = isset( $existing[$ns] )
504 ? array_diff_key( $dbkeys, $existing[$ns] )
505 : $dbkeys;
506 foreach ( $diffs as $dbk => $id ) {
507 $arr[] = [
508 'pl_from' => $this->mId,
509 'pl_from_namespace' => $this->mTitle->getNamespace(),
510 'pl_namespace' => $ns,
511 'pl_title' => $dbk
512 ];
513 }
514 }
515
516 return $arr;
517 }
518
524 private function getTemplateInsertions( $existing = [] ) {
525 $arr = [];
526 foreach ( $this->mTemplates as $ns => $dbkeys ) {
527 $diffs = isset( $existing[$ns] ) ? array_diff_key( $dbkeys, $existing[$ns] ) : $dbkeys;
528 foreach ( $diffs as $dbk => $id ) {
529 $arr[] = [
530 'tl_from' => $this->mId,
531 'tl_from_namespace' => $this->mTitle->getNamespace(),
532 'tl_namespace' => $ns,
533 'tl_title' => $dbk
534 ];
535 }
536 }
537
538 return $arr;
539 }
540
547 private function getImageInsertions( $existing = [] ) {
548 $arr = [];
549 $diffs = array_diff_key( $this->mImages, $existing );
550 foreach ( $diffs as $iname => $dummy ) {
551 $arr[] = [
552 'il_from' => $this->mId,
553 'il_from_namespace' => $this->mTitle->getNamespace(),
554 'il_to' => $iname
555 ];
556 }
557
558 return $arr;
559 }
560
566 private function getExternalInsertions( $existing = [] ) {
567 $arr = [];
568 $diffs = array_diff_key( $this->mExternals, $existing );
569 foreach ( $diffs as $url => $dummy ) {
570 foreach ( wfMakeUrlIndexes( $url ) as $index ) {
571 $arr[] = [
572 'el_from' => $this->mId,
573 'el_to' => $url,
574 'el_index' => $index,
575 'el_index_60' => substr( $index, 0, 60 ),
576 ];
577 }
578 }
579
580 return $arr;
581 }
582
591 private function getCategoryInsertions( $existing = [] ) {
593 $diffs = array_diff_assoc( $this->mCategories, $existing );
594 $arr = [];
595 $contLang = MediaWikiServices::getInstance()->getContentLanguage();
596 $collation = Collation::singleton();
597 foreach ( $diffs as $name => $prefix ) {
598 $nt = Title::makeTitleSafe( NS_CATEGORY, $name );
599 $contLang->findVariantLink( $name, $nt, true );
600
601 $type = MWNamespace::getCategoryLinkType( $this->mTitle->getNamespace() );
602
603 # Treat custom sortkeys as a prefix, so that if multiple
604 # things are forced to sort as '*' or something, they'll
605 # sort properly in the category rather than in page_id
606 # order or such.
607 $sortkey = $collation->getSortKey( $this->mTitle->getCategorySortkey( $prefix ) );
608
609 $arr[] = [
610 'cl_from' => $this->mId,
611 'cl_to' => $name,
612 'cl_sortkey' => $sortkey,
613 'cl_timestamp' => $this->getDB()->timestamp(),
614 'cl_sortkey_prefix' => $prefix,
615 'cl_collation' => $wgCategoryCollation,
616 'cl_type' => $type,
617 ];
618 }
619
620 return $arr;
621 }
622
630 private function getInterlangInsertions( $existing = [] ) {
631 $diffs = array_diff_assoc( $this->mInterlangs, $existing );
632 $arr = [];
633 foreach ( $diffs as $lang => $title ) {
634 $arr[] = [
635 'll_from' => $this->mId,
636 'll_lang' => $lang,
637 'll_title' => $title
638 ];
639 }
640
641 return $arr;
642 }
643
649 function getPropertyInsertions( $existing = [] ) {
650 $diffs = array_diff_assoc( $this->mProperties, $existing );
651
652 $arr = [];
653 foreach ( array_keys( $diffs ) as $name ) {
654 $arr[] = $this->getPagePropRowData( $name );
655 }
656
657 return $arr;
658 }
659
676 private function getPagePropRowData( $prop ) {
678
679 $value = $this->mProperties[$prop];
680
681 $row = [
682 'pp_page' => $this->mId,
683 'pp_propname' => $prop,
684 'pp_value' => $value,
685 ];
686
688 $row['pp_sortkey'] = $this->getPropertySortKeyValue( $value );
689 }
690
691 return $row;
692 }
693
706 private function getPropertySortKeyValue( $value ) {
707 if ( is_int( $value ) || is_float( $value ) || is_bool( $value ) ) {
708 return floatval( $value );
709 }
710
711 return null;
712 }
713
720 private function getInterwikiInsertions( $existing = [] ) {
721 $arr = [];
722 foreach ( $this->mInterwikis as $prefix => $dbkeys ) {
723 $diffs = isset( $existing[$prefix] )
724 ? array_diff_key( $dbkeys, $existing[$prefix] )
725 : $dbkeys;
726
727 foreach ( $diffs as $dbk => $id ) {
728 $arr[] = [
729 'iwl_from' => $this->mId,
730 'iwl_prefix' => $prefix,
731 'iwl_title' => $dbk
732 ];
733 }
734 }
735
736 return $arr;
737 }
738
745 private function getLinkDeletions( $existing ) {
746 $del = [];
747 foreach ( $existing as $ns => $dbkeys ) {
748 if ( isset( $this->mLinks[$ns] ) ) {
749 $del[$ns] = array_diff_key( $existing[$ns], $this->mLinks[$ns] );
750 } else {
751 $del[$ns] = $existing[$ns];
752 }
753 }
754
755 return $del;
756 }
757
764 private function getTemplateDeletions( $existing ) {
765 $del = [];
766 foreach ( $existing as $ns => $dbkeys ) {
767 if ( isset( $this->mTemplates[$ns] ) ) {
768 $del[$ns] = array_diff_key( $existing[$ns], $this->mTemplates[$ns] );
769 } else {
770 $del[$ns] = $existing[$ns];
771 }
772 }
773
774 return $del;
775 }
776
783 private function getImageDeletions( $existing ) {
784 return array_diff_key( $existing, $this->mImages );
785 }
786
793 private function getExternalDeletions( $existing ) {
794 return array_diff_key( $existing, $this->mExternals );
795 }
796
803 private function getCategoryDeletions( $existing ) {
804 return array_diff_assoc( $existing, $this->mCategories );
805 }
806
813 private function getInterlangDeletions( $existing ) {
814 return array_diff_assoc( $existing, $this->mInterlangs );
815 }
816
822 function getPropertyDeletions( $existing ) {
823 return array_diff_assoc( $existing, $this->mProperties );
824 }
825
832 private function getInterwikiDeletions( $existing ) {
833 $del = [];
834 foreach ( $existing as $prefix => $dbkeys ) {
835 if ( isset( $this->mInterwikis[$prefix] ) ) {
836 $del[$prefix] = array_diff_key( $existing[$prefix], $this->mInterwikis[$prefix] );
837 } else {
838 $del[$prefix] = $existing[$prefix];
839 }
840 }
841
842 return $del;
843 }
844
850 private function getExistingLinks() {
851 $res = $this->getDB()->select( 'pagelinks', [ 'pl_namespace', 'pl_title' ],
852 [ 'pl_from' => $this->mId ], __METHOD__ );
853 $arr = [];
854 foreach ( $res as $row ) {
855 if ( !isset( $arr[$row->pl_namespace] ) ) {
856 $arr[$row->pl_namespace] = [];
857 }
858 $arr[$row->pl_namespace][$row->pl_title] = 1;
859 }
860
861 return $arr;
862 }
863
869 private function getExistingTemplates() {
870 $res = $this->getDB()->select( 'templatelinks', [ 'tl_namespace', 'tl_title' ],
871 [ 'tl_from' => $this->mId ], __METHOD__ );
872 $arr = [];
873 foreach ( $res as $row ) {
874 if ( !isset( $arr[$row->tl_namespace] ) ) {
875 $arr[$row->tl_namespace] = [];
876 }
877 $arr[$row->tl_namespace][$row->tl_title] = 1;
878 }
879
880 return $arr;
881 }
882
888 private function getExistingImages() {
889 $res = $this->getDB()->select( 'imagelinks', [ 'il_to' ],
890 [ 'il_from' => $this->mId ], __METHOD__ );
891 $arr = [];
892 foreach ( $res as $row ) {
893 $arr[$row->il_to] = 1;
894 }
895
896 return $arr;
897 }
898
904 private function getExistingExternals() {
905 $res = $this->getDB()->select( 'externallinks', [ 'el_to' ],
906 [ 'el_from' => $this->mId ], __METHOD__ );
907 $arr = [];
908 foreach ( $res as $row ) {
909 $arr[$row->el_to] = 1;
910 }
911
912 return $arr;
913 }
914
920 private function getExistingCategories() {
921 $res = $this->getDB()->select( 'categorylinks', [ 'cl_to', 'cl_sortkey_prefix' ],
922 [ 'cl_from' => $this->mId ], __METHOD__ );
923 $arr = [];
924 foreach ( $res as $row ) {
925 $arr[$row->cl_to] = $row->cl_sortkey_prefix;
926 }
927
928 return $arr;
929 }
930
937 private function getExistingInterlangs() {
938 $res = $this->getDB()->select( 'langlinks', [ 'll_lang', 'll_title' ],
939 [ 'll_from' => $this->mId ], __METHOD__ );
940 $arr = [];
941 foreach ( $res as $row ) {
942 $arr[$row->ll_lang] = $row->ll_title;
943 }
944
945 return $arr;
946 }
947
952 private function getExistingInterwikis() {
953 $res = $this->getDB()->select( 'iwlinks', [ 'iwl_prefix', 'iwl_title' ],
954 [ 'iwl_from' => $this->mId ], __METHOD__ );
955 $arr = [];
956 foreach ( $res as $row ) {
957 if ( !isset( $arr[$row->iwl_prefix] ) ) {
958 $arr[$row->iwl_prefix] = [];
959 }
960 $arr[$row->iwl_prefix][$row->iwl_title] = 1;
961 }
962
963 return $arr;
964 }
965
971 private function getExistingProperties() {
972 $res = $this->getDB()->select( 'page_props', [ 'pp_propname', 'pp_value' ],
973 [ 'pp_page' => $this->mId ], __METHOD__ );
974 $arr = [];
975 foreach ( $res as $row ) {
976 $arr[$row->pp_propname] = $row->pp_value;
977 }
978
979 return $arr;
980 }
981
986 public function getTitle() {
987 return $this->mTitle;
988 }
989
995 public function getParserOutput() {
996 return $this->mParserOutput;
997 }
998
1003 public function getImages() {
1004 return $this->mImages;
1005 }
1006
1014 public function setRevision( Revision $revision ) {
1015 $this->mRevision = $revision;
1016 }
1017
1022 public function getRevision() {
1023 return $this->mRevision;
1024 }
1025
1032 public function setTriggeringUser( User $user ) {
1033 $this->user = $user;
1034 }
1035
1040 public function getTriggeringUser() {
1041 return $this->user;
1042 }
1043
1048 private function invalidateProperties( $changed ) {
1050
1051 foreach ( $changed as $name => $value ) {
1052 if ( isset( $wgPagePropLinkInvalidations[$name] ) ) {
1054 if ( !is_array( $inv ) ) {
1055 $inv = [ $inv ];
1056 }
1057 foreach ( $inv as $table ) {
1058 DeferredUpdates::addUpdate(
1059 new HTMLCacheUpdate( $this->mTitle, $table, 'page-props' )
1060 );
1061 }
1062 }
1063 }
1064 }
1065
1071 public function getAddedLinks() {
1072 if ( $this->linkInsertions === null ) {
1073 return null;
1074 }
1075 $result = [];
1076 foreach ( $this->linkInsertions as $insertion ) {
1077 $result[] = Title::makeTitle( $insertion['pl_namespace'], $insertion['pl_title'] );
1078 }
1079
1080 return $result;
1081 }
1082
1088 public function getRemovedLinks() {
1089 if ( $this->linkDeletions === null ) {
1090 return null;
1091 }
1092 $result = [];
1093 foreach ( $this->linkDeletions as $ns => $titles ) {
1094 foreach ( $titles as $title => $unused ) {
1095 $result[] = Title::makeTitle( $ns, $title );
1096 }
1097 }
1098
1099 return $result;
1100 }
1101
1108 public function getAddedProperties() {
1109 return $this->propertyInsertions;
1110 }
1111
1118 public function getRemovedProperties() {
1119 return $this->propertyDeletions;
1120 }
1121
1125 private function updateLinksTimestamp() {
1126 if ( $this->mId ) {
1127 // The link updates made here only reflect the freshness of the parser output
1128 $timestamp = $this->mParserOutput->getCacheTime();
1129 $this->getDB()->update( 'page',
1130 [ 'page_links_updated' => $this->getDB()->timestamp( $timestamp ) ],
1131 [ 'page_id' => $this->mId ],
1132 __METHOD__
1133 );
1134 }
1135 }
1136
1140 private function getDB() {
1141 if ( !$this->db ) {
1142 $this->db = wfGetDB( DB_MASTER );
1143 }
1144
1145 return $this->db;
1146 }
1147
1148 public function getAsJobSpecification() {
1149 if ( $this->user ) {
1150 $userInfo = [
1151 'userId' => $this->user->getId(),
1152 'userName' => $this->user->getName(),
1153 ];
1154 } else {
1155 $userInfo = false;
1156 }
1157
1158 if ( $this->mRevision ) {
1159 $triggeringRevisionId = $this->mRevision->getId();
1160 } else {
1161 $triggeringRevisionId = false;
1162 }
1163
1164 return [
1165 'wiki' => WikiMap::getWikiIdFromDomain( $this->getDB()->getDomainID() ),
1166 'job' => new JobSpecification(
1167 'refreshLinksPrioritized',
1168 [
1169 // Reuse the parser cache if it was saved
1170 'rootJobTimestamp' => $this->mParserOutput->getCacheTime(),
1171 'useRecursiveLinksUpdate' => $this->mRecursive,
1172 'triggeringUser' => $userInfo,
1173 'triggeringRevisionId' => $triggeringRevisionId,
1174 'causeAction' => $this->getCauseAction(),
1175 'causeAgent' => $this->getCauseAgent()
1176 ],
1177 [ 'removeDuplicates' => true ],
1178 $this->getTitle()
1179 )
1180 ];
1181 }
1182}
$wgPagePropLinkInvalidations
Page property link table invalidation lists.
$wgCategoryCollation
Specify how category names should be sorted, when listed on a category page.
$wgUpdateRowsPerQuery
Number of rows to update per query.
$wgPagePropsHaveSortkey
Whether the page_props table has a pp_sortkey column.
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
wfMakeUrlIndexes( $url)
Make URL indexes, appropriate for the el_index field of externallinks.
Deferrable Update for closure/callback updates that should use auto-commit mode.
static singleton()
Definition Collation.php:36
Abstract base class for update jobs that do something with some secondary data extracted from article...
Class to invalidate the HTML cache of all the pages linking to a given title.
Job queue task description base code.
static newRootJobParams( $key)
Get "root job" parameters for a task.
Definition Job.php:266
Class the manages updates of *_link tables as well as similar extension-managed tables.
updateCategoryCounts(array $added, array $deleted)
Update all the appropriate counts in the category table.
array $mTemplates
Map of title strings to IDs for the template references, including broken ones.
updateLinksTimestamp()
Update links table freshness.
getTitle()
Return the title object of the page being updated.
User null $user
getExistingLinks()
Get an array of existing links, as a 2-D array.
getExistingProperties()
Get an array of existing categories, with the name in the key and sort key in the value.
getImageInsertions( $existing=[])
Get an array of image insertions Skips the names specified in $existing.
getInterlangInsertions( $existing=[])
Get an array of interlanguage link insertions.
getExternalInsertions( $existing=[])
Get an array of externallinks insertions.
__construct(Title $title, ParserOutput $parserOutput, $recursive=true)
getPropertyInsertions( $existing=[])
Get an array of page property insertions.
array $mLinks
Map of title strings to IDs for the links in the document.
array $mInterwikis
2-D map of (prefix => DBK => 1)
setTriggeringUser(User $user)
Set the User who triggered this LinksUpdate.
getTemplateDeletions( $existing)
Given an array of existing templates, returns those templates which are not in $this and thus should ...
invalidateCategories( $cats)
null array $propertyInsertions
Added properties if calculated.
doUpdate()
Update link tables with outgoing links from an updated article.
Title $mTitle
Title object of the article linked from.
getPropertySortKeyValue( $value)
Determines the sort key for the given property value.
int $mId
Page ID of the article linked from.
getAddedProperties()
Fetch page properties added by this LinksUpdate.
static queueRecursiveJobsForTable(Title $title, $table, $action='unknown', $userName='unknown')
Queue a RefreshLinks job for any table.
getLinkInsertions( $existing=[])
Get an array of pagelinks insertions for passing to the DB Skips the titles specified by the 2-D arra...
getExistingImages()
Get an array of existing images, image names in the keys.
getRemovedLinks()
Fetch page links removed by this LinksUpdate.
Revision $mRevision
Revision for which this update has been triggered.
setRevision(Revision $revision)
Set the revision corresponding to this LinksUpdate.
getTemplateInsertions( $existing=[])
Get an array of template insertions.
invalidateImageDescriptions(array $images)
getCategoryDeletions( $existing)
Given an array of existing categories, returns those categories which are not in $this and thus shoul...
getInterwikiInsertions( $existing=[])
Get an array of interwiki insertions for passing to the DB Skips the titles specified by the 2-D arra...
ParserOutput $mParserOutput
null array $linkInsertions
Added links if calculated.
getImages()
Return the list of images used as generated by the parser.
array $mProperties
Map of arbitrary name to value.
getExistingInterlangs()
Get an array of existing interlanguage links, with the language code in the key and the title in the ...
getExistingExternals()
Get an array of existing external links, URLs in the keys.
getParserOutput()
Returns parser output.
getPropertyDeletions( $existing)
Get array of properties which should be deleted.
invalidateProperties( $changed)
Invalidate any necessary link lists related to page property changes.
null array $linkDeletions
Deleted links if calculated.
null array $propertyDeletions
Deleted properties if calculated.
getInterlangDeletions( $existing)
Given an array of existing interlanguage links, returns those links which are not in $this and thus s...
getPagePropRowData( $prop)
Returns an associative array to be used for inserting a row into the page_props table.
getExistingCategories()
Get an array of existing categories, with the name in the key and sort key in the value.
getAddedLinks()
Fetch page links added by this LinksUpdate.
queueRecursiveJobs()
Queue recursive jobs for this page.
array $mImages
DB keys of the images used, in the array key only.
getImageDeletions( $existing)
Given an array of existing images, returns those images which are not in $this and thus should be del...
array $mInterlangs
Map of language codes to titles.
getLinkDeletions( $existing)
Given an array of existing links, returns those links which are not in $this and thus should be delet...
array $mCategories
Map of category names to sort keys.
bool $mRecursive
Whether to queue jobs for recursive updates.
getCategoryInsertions( $existing=[])
Get an array of category insertions.
getRemovedProperties()
Fetch page properties removed by this LinksUpdate.
getExistingTemplates()
Get an array of existing templates, as a 2-D array.
getExternalDeletions( $existing)
Given an array of existing external links, returns those links which are not in $this and thus should...
static acquirePageLock(IDatabase $dbw, $pageId, $why='atomicity')
Acquire a lock for performing link table updates for a page on a DB.
getInterwikiDeletions( $existing)
Given an array of existing interwiki links, returns those links which are not in $this and thus shoul...
array $mExternals
URLs of external links, array key only.
incrTableUpdate( $table, $prefix, $deletions, $insertions)
Update a table by doing a delete query then an insert query.
IDatabase $db
getExistingInterwikis()
Get an array of existing inline interwiki links, as a 2-D array.
PSR-3 logger instance factory.
MediaWikiServices is the service locator for the application scope of MediaWiki.
static invalidatePages(IDatabase $dbw, $namespace, array $dbkeys)
Invalidate the cache of a list of pages from a single namespace.
Job to update link tables for pages.
static newPrioritized(Title $title, array $params)
Represents a title within MediaWiki.
Definition Title.php:39
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition User.php:47
static getWikiIdFromDomain( $domain)
Get the wiki ID of a database domain.
Definition WikiMap.php:252
$res
Definition database.txt:21
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition deferred.txt:11
namespace being checked & $result
Definition hooks.txt:2385
namespace and then decline to actually register it file or subcat img or subcat $title
Definition hooks.txt:994
either a unescaped string or a HtmlArmor object after in associative array form externallinks $linksUpdate
Definition hooks.txt:2139
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set but before ordinary actions take place or wrap services the preferred way to define a new service is the $wgServiceWiringFiles array $services
Definition hooks.txt:2335
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition hooks.txt:3106
Allows to change the fields on the form that will be generated $name
Definition hooks.txt:302
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition hooks.txt:247
const NS_FILE
Definition Defines.php:70
const NS_CATEGORY
Definition Defines.php:78
Interface that marks a DataUpdate as enqueuable via the JobQueue.
Basic database interface for live and lazy-loaded relation database handles.
Definition IDatabase.php:38
getScopedLockAndFlush( $lockKey, $fname, $timeout)
Acquire a named lock, flush any transaction, and return an RAII style unlocker object.
linkcache txt The LinkCache class maintains a list of article titles and the information about whether or not the article exists in the database This is used to mark up links when displaying a page If the same link appears more than once on any page then it only has to be looked up once In most cases link lookups are done in batches with the LinkBatch class or the equivalent in so the link cache is mostly useful for short snippets of parsed and for links in the navigation areas of the skin The link cache was formerly used to track links used in a document for the purposes of updating the link tables This application is now deprecated To create a you can use the following $titles
Definition linkcache.txt:17
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
const DB_MASTER
Definition defines.php:26
if(count( $args)< 1) $job
if(!isset( $args[0])) $lang