MediaWiki REL1_30
LinksUpdate.php
Go to the documentation of this file.
1<?php
25use Wikimedia\ScopedCallback;
26
35 // @todo make members protected, but make sure extensions don't break
36
38 public $mId;
39
41 public $mTitle;
42
45
47 public $mLinks;
48
50 public $mImages;
51
54
57
60
63
66
69
72
74 private $mRevision;
75
79 private $linkInsertions = null;
80
84 private $linkDeletions = null;
85
89 private $propertyInsertions = null;
90
94 private $propertyDeletions = null;
95
99 private $user;
100
102 private $db;
103
110 function __construct( Title $title, ParserOutput $parserOutput, $recursive = true ) {
111 parent::__construct();
112
113 $this->mTitle = $title;
114 $this->mId = $title->getArticleID( Title::GAID_FOR_UPDATE );
115
116 if ( !$this->mId ) {
117 throw new InvalidArgumentException(
118 "The Title object yields no ID. Perhaps the page doesn't exist?"
119 );
120 }
121
122 $this->mParserOutput = $parserOutput;
123
124 $this->mLinks = $parserOutput->getLinks();
125 $this->mImages = $parserOutput->getImages();
126 $this->mTemplates = $parserOutput->getTemplates();
127 $this->mExternals = $parserOutput->getExternalLinks();
128 $this->mCategories = $parserOutput->getCategories();
129 $this->mProperties = $parserOutput->getProperties();
130 $this->mInterwikis = $parserOutput->getInterwikiLinks();
131
132 # Convert the format of the interlanguage links
133 # I didn't want to change it in the ParserOutput, because that array is passed all
134 # the way back to the skin, so either a skin API break would be required, or an
135 # inefficient back-conversion.
136 $ill = $parserOutput->getLanguageLinks();
137 $this->mInterlangs = [];
138 foreach ( $ill as $link ) {
139 list( $key, $title ) = explode( ':', $link, 2 );
140 $this->mInterlangs[$key] = $title;
141 }
142
143 foreach ( $this->mCategories as &$sortkey ) {
144 # If the sortkey is longer then 255 bytes,
145 # it truncated by DB, and then doesn't get
146 # matched when comparing existing vs current
147 # categories, causing T27254.
148 # Also. substr behaves weird when given "".
149 if ( $sortkey !== '' ) {
150 $sortkey = substr( $sortkey, 0, 255 );
151 }
152 }
153
154 $this->mRecursive = $recursive;
155
156 // Avoid PHP 7.1 warning from passing $this by reference
157 $linksUpdate = $this;
158 Hooks::run( 'LinksUpdateConstructed', [ &$linksUpdate ] );
159 }
160
166 public function doUpdate() {
167 if ( $this->ticket ) {
168 // Make sure all links update threads see the changes of each other.
169 // This handles the case when updates have to batched into several COMMITs.
170 $scopedLock = self::acquirePageLock( $this->getDB(), $this->mId );
171 }
172
173 // Avoid PHP 7.1 warning from passing $this by reference
174 $linksUpdate = $this;
175 Hooks::run( 'LinksUpdate', [ &$linksUpdate ] );
176 $this->doIncrementalUpdate();
177
178 // Commit and release the lock (if set)
179 ScopedCallback::consume( $scopedLock );
180 // Run post-commit hooks without DBO_TRX
181 $this->getDB()->onTransactionIdle(
182 function () {
183 // Avoid PHP 7.1 warning from passing $this by reference
184 $linksUpdate = $this;
185 Hooks::run( 'LinksUpdateComplete', [ &$linksUpdate, $this->ticket ] );
186 },
187 __METHOD__
188 );
189 }
190
201 public static function acquirePageLock( IDatabase $dbw, $pageId, $why = 'atomicity' ) {
202 $key = "LinksUpdate:$why:pageid:$pageId";
203 $scopedLock = $dbw->getScopedLockAndFlush( $key, __METHOD__, 15 );
204 if ( !$scopedLock ) {
205 throw new RuntimeException( "Could not acquire lock '$key'." );
206 }
207
208 return $scopedLock;
209 }
210
211 protected function doIncrementalUpdate() {
212 # Page links
213 $existingPL = $this->getExistingLinks();
214 $this->linkDeletions = $this->getLinkDeletions( $existingPL );
215 $this->linkInsertions = $this->getLinkInsertions( $existingPL );
216 $this->incrTableUpdate( 'pagelinks', 'pl', $this->linkDeletions, $this->linkInsertions );
217
218 # Image links
219 $existingIL = $this->getExistingImages();
220 $imageDeletes = $this->getImageDeletions( $existingIL );
221 $this->incrTableUpdate(
222 'imagelinks',
223 'il',
224 $imageDeletes,
225 $this->getImageInsertions( $existingIL ) );
226
227 # Invalidate all image description pages which had links added or removed
228 $imageUpdates = $imageDeletes + array_diff_key( $this->mImages, $existingIL );
229 $this->invalidateImageDescriptions( $imageUpdates );
230
231 # External links
232 $existingEL = $this->getExistingExternals();
233 $this->incrTableUpdate(
234 'externallinks',
235 'el',
236 $this->getExternalDeletions( $existingEL ),
237 $this->getExternalInsertions( $existingEL ) );
238
239 # Language links
240 $existingLL = $this->getExistingInterlangs();
241 $this->incrTableUpdate(
242 'langlinks',
243 'll',
244 $this->getInterlangDeletions( $existingLL ),
245 $this->getInterlangInsertions( $existingLL ) );
246
247 # Inline interwiki links
248 $existingIW = $this->getExistingInterwikis();
249 $this->incrTableUpdate(
250 'iwlinks',
251 'iwl',
252 $this->getInterwikiDeletions( $existingIW ),
253 $this->getInterwikiInsertions( $existingIW ) );
254
255 # Template links
256 $existingTL = $this->getExistingTemplates();
257 $this->incrTableUpdate(
258 'templatelinks',
259 'tl',
260 $this->getTemplateDeletions( $existingTL ),
261 $this->getTemplateInsertions( $existingTL ) );
262
263 # Category links
264 $existingCL = $this->getExistingCategories();
265 $categoryDeletes = $this->getCategoryDeletions( $existingCL );
266 $this->incrTableUpdate(
267 'categorylinks',
268 'cl',
269 $categoryDeletes,
270 $this->getCategoryInsertions( $existingCL ) );
271 $categoryInserts = array_diff_assoc( $this->mCategories, $existingCL );
272 $categoryUpdates = $categoryInserts + $categoryDeletes;
273
274 # Page properties
275 $existingPP = $this->getExistingProperties();
276 $this->propertyDeletions = $this->getPropertyDeletions( $existingPP );
277 $this->incrTableUpdate(
278 'page_props',
279 'pp',
280 $this->propertyDeletions,
281 $this->getPropertyInsertions( $existingPP ) );
282
283 # Invalidate the necessary pages
284 $this->propertyInsertions = array_diff_assoc( $this->mProperties, $existingPP );
285 $changed = $this->propertyDeletions + $this->propertyInsertions;
286 $this->invalidateProperties( $changed );
287
288 # Invalidate all categories which were added, deleted or changed (set symmetric difference)
289 $this->invalidateCategories( $categoryUpdates );
290 $this->updateCategoryCounts( $categoryInserts, $categoryDeletes );
291
292 # Refresh links of all pages including this page
293 # This will be in a separate transaction
294 if ( $this->mRecursive ) {
295 $this->queueRecursiveJobs();
296 }
297
298 # Update the links table freshness for this title
299 $this->updateLinksTimestamp();
300 }
301
308 protected function queueRecursiveJobs() {
309 self::queueRecursiveJobsForTable( $this->mTitle, 'templatelinks' );
310 if ( $this->mTitle->getNamespace() == NS_FILE ) {
311 // Process imagelinks in case the title is or was a redirect
312 self::queueRecursiveJobsForTable( $this->mTitle, 'imagelinks' );
313 }
314
315 $bc = $this->mTitle->getBacklinkCache();
316 // Get jobs for cascade-protected backlinks for a high priority queue.
317 // If meta-templates change to using a new template, the new template
318 // should be implicitly protected as soon as possible, if applicable.
319 // These jobs duplicate a subset of the above ones, but can run sooner.
320 // Which ever runs first generally no-ops the other one.
321 $jobs = [];
322 foreach ( $bc->getCascadeProtectedLinks() as $title ) {
324 }
325 JobQueueGroup::singleton()->push( $jobs );
326 }
327
334 public static function queueRecursiveJobsForTable( Title $title, $table ) {
335 if ( $title->getBacklinkCache()->hasLinks( $table ) ) {
336 $job = new RefreshLinksJob(
337 $title,
338 [
339 'table' => $table,
340 'recursive' => true,
341 ] + Job::newRootJobParams( // "overall" refresh links job info
342 "refreshlinks:{$table}:{$title->getPrefixedText()}"
343 )
344 );
345
347 }
348 }
349
353 private function invalidateCategories( $cats ) {
354 PurgeJobUtils::invalidatePages( $this->getDB(), NS_CATEGORY, array_keys( $cats ) );
355 }
356
362 private function updateCategoryCounts( array $added, array $deleted ) {
364
365 if ( !$added && !$deleted ) {
366 return;
367 }
368
369 $domainId = $this->getDB()->getDomainID();
370 $wp = WikiPage::factory( $this->mTitle );
371 $lbf = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
372 // T163801: try to release any row locks to reduce contention
373 $lbf->commitAndWaitForReplication( __METHOD__, $this->ticket, [ 'domain' => $domainId ] );
374
375 foreach ( array_chunk( array_keys( $added ), $wgUpdateRowsPerQuery ) as $addBatch ) {
376 $wp->updateCategoryCounts( $addBatch, [], $this->mId );
377 $lbf->commitAndWaitForReplication(
378 __METHOD__, $this->ticket, [ 'domain' => $domainId ] );
379 }
380
381 foreach ( array_chunk( array_keys( $deleted ), $wgUpdateRowsPerQuery ) as $deleteBatch ) {
382 $wp->updateCategoryCounts( [], $deleteBatch, $this->mId );
383 $lbf->commitAndWaitForReplication(
384 __METHOD__, $this->ticket, [ 'domain' => $domainId ] );
385 }
386 }
387
391 private function invalidateImageDescriptions( $images ) {
392 PurgeJobUtils::invalidatePages( $this->getDB(), NS_FILE, array_keys( $images ) );
393 }
394
402 private function incrTableUpdate( $table, $prefix, $deletions, $insertions ) {
403 $services = MediaWikiServices::getInstance();
404 $bSize = $services->getMainConfig()->get( 'UpdateRowsPerQuery' );
405 $lbf = $services->getDBLoadBalancerFactory();
406
407 if ( $table === 'page_props' ) {
408 $fromField = 'pp_page';
409 } else {
410 $fromField = "{$prefix}_from";
411 }
412
413 $deleteWheres = []; // list of WHERE clause arrays for each DB delete() call
414 if ( $table === 'pagelinks' || $table === 'templatelinks' || $table === 'iwlinks' ) {
415 $baseKey = ( $table === 'iwlinks' ) ? 'iwl_prefix' : "{$prefix}_namespace";
416
417 $curBatchSize = 0;
418 $curDeletionBatch = [];
419 $deletionBatches = [];
420 foreach ( $deletions as $ns => $dbKeys ) {
421 foreach ( $dbKeys as $dbKey => $unused ) {
422 $curDeletionBatch[$ns][$dbKey] = 1;
423 if ( ++$curBatchSize >= $bSize ) {
424 $deletionBatches[] = $curDeletionBatch;
425 $curDeletionBatch = [];
426 $curBatchSize = 0;
427 }
428 }
429 }
430 if ( $curDeletionBatch ) {
431 $deletionBatches[] = $curDeletionBatch;
432 }
433
434 foreach ( $deletionBatches as $deletionBatch ) {
435 $deleteWheres[] = [
436 $fromField => $this->mId,
437 $this->getDB()->makeWhereFrom2d( $deletionBatch, $baseKey, "{$prefix}_title" )
438 ];
439 }
440 } else {
441 if ( $table === 'langlinks' ) {
442 $toField = 'll_lang';
443 } elseif ( $table === 'page_props' ) {
444 $toField = 'pp_propname';
445 } else {
446 $toField = $prefix . '_to';
447 }
448
449 $deletionBatches = array_chunk( array_keys( $deletions ), $bSize );
450 foreach ( $deletionBatches as $deletionBatch ) {
451 $deleteWheres[] = [ $fromField => $this->mId, $toField => $deletionBatch ];
452 }
453 }
454
455 $domainId = $this->getDB()->getDomainID();
456
457 foreach ( $deleteWheres as $deleteWhere ) {
458 $this->getDB()->delete( $table, $deleteWhere, __METHOD__ );
459 $lbf->commitAndWaitForReplication(
460 __METHOD__, $this->ticket, [ 'domain' => $domainId ]
461 );
462 }
463
464 $insertBatches = array_chunk( $insertions, $bSize );
465 foreach ( $insertBatches as $insertBatch ) {
466 $this->getDB()->insert( $table, $insertBatch, __METHOD__, 'IGNORE' );
467 $lbf->commitAndWaitForReplication(
468 __METHOD__, $this->ticket, [ 'domain' => $domainId ]
469 );
470 }
471
472 if ( count( $insertions ) ) {
473 Hooks::run( 'LinksUpdateAfterInsert', [ $this, $table, $insertions ] );
474 }
475 }
476
483 private function getLinkInsertions( $existing = [] ) {
484 $arr = [];
485 foreach ( $this->mLinks as $ns => $dbkeys ) {
486 $diffs = isset( $existing[$ns] )
487 ? array_diff_key( $dbkeys, $existing[$ns] )
488 : $dbkeys;
489 foreach ( $diffs as $dbk => $id ) {
490 $arr[] = [
491 'pl_from' => $this->mId,
492 'pl_from_namespace' => $this->mTitle->getNamespace(),
493 'pl_namespace' => $ns,
494 'pl_title' => $dbk
495 ];
496 }
497 }
498
499 return $arr;
500 }
501
507 private function getTemplateInsertions( $existing = [] ) {
508 $arr = [];
509 foreach ( $this->mTemplates as $ns => $dbkeys ) {
510 $diffs = isset( $existing[$ns] ) ? array_diff_key( $dbkeys, $existing[$ns] ) : $dbkeys;
511 foreach ( $diffs as $dbk => $id ) {
512 $arr[] = [
513 'tl_from' => $this->mId,
514 'tl_from_namespace' => $this->mTitle->getNamespace(),
515 'tl_namespace' => $ns,
516 'tl_title' => $dbk
517 ];
518 }
519 }
520
521 return $arr;
522 }
523
530 private function getImageInsertions( $existing = [] ) {
531 $arr = [];
532 $diffs = array_diff_key( $this->mImages, $existing );
533 foreach ( $diffs as $iname => $dummy ) {
534 $arr[] = [
535 'il_from' => $this->mId,
536 'il_from_namespace' => $this->mTitle->getNamespace(),
537 'il_to' => $iname
538 ];
539 }
540
541 return $arr;
542 }
543
549 private function getExternalInsertions( $existing = [] ) {
550 $arr = [];
551 $diffs = array_diff_key( $this->mExternals, $existing );
552 foreach ( $diffs as $url => $dummy ) {
553 foreach ( wfMakeUrlIndexes( $url ) as $index ) {
554 $arr[] = [
555 'el_from' => $this->mId,
556 'el_to' => $url,
557 'el_index' => $index,
558 ];
559 }
560 }
561
562 return $arr;
563 }
564
573 private function getCategoryInsertions( $existing = [] ) {
575 $diffs = array_diff_assoc( $this->mCategories, $existing );
576 $arr = [];
577 foreach ( $diffs as $name => $prefix ) {
578 $nt = Title::makeTitleSafe( NS_CATEGORY, $name );
579 $wgContLang->findVariantLink( $name, $nt, true );
580
581 if ( $this->mTitle->getNamespace() == NS_CATEGORY ) {
582 $type = 'subcat';
583 } elseif ( $this->mTitle->getNamespace() == NS_FILE ) {
584 $type = 'file';
585 } else {
586 $type = 'page';
587 }
588
589 # Treat custom sortkeys as a prefix, so that if multiple
590 # things are forced to sort as '*' or something, they'll
591 # sort properly in the category rather than in page_id
592 # order or such.
593 $sortkey = Collation::singleton()->getSortKey(
594 $this->mTitle->getCategorySortkey( $prefix ) );
595
596 $arr[] = [
597 'cl_from' => $this->mId,
598 'cl_to' => $name,
599 'cl_sortkey' => $sortkey,
600 'cl_timestamp' => $this->getDB()->timestamp(),
601 'cl_sortkey_prefix' => $prefix,
602 'cl_collation' => $wgCategoryCollation,
603 'cl_type' => $type,
604 ];
605 }
606
607 return $arr;
608 }
609
617 private function getInterlangInsertions( $existing = [] ) {
618 $diffs = array_diff_assoc( $this->mInterlangs, $existing );
619 $arr = [];
620 foreach ( $diffs as $lang => $title ) {
621 $arr[] = [
622 'll_from' => $this->mId,
623 'll_lang' => $lang,
624 'll_title' => $title
625 ];
626 }
627
628 return $arr;
629 }
630
636 function getPropertyInsertions( $existing = [] ) {
637 $diffs = array_diff_assoc( $this->mProperties, $existing );
638
639 $arr = [];
640 foreach ( array_keys( $diffs ) as $name ) {
641 $arr[] = $this->getPagePropRowData( $name );
642 }
643
644 return $arr;
645 }
646
663 private function getPagePropRowData( $prop ) {
665
666 $value = $this->mProperties[$prop];
667
668 $row = [
669 'pp_page' => $this->mId,
670 'pp_propname' => $prop,
671 'pp_value' => $value,
672 ];
673
675 $row['pp_sortkey'] = $this->getPropertySortKeyValue( $value );
676 }
677
678 return $row;
679 }
680
693 private function getPropertySortKeyValue( $value ) {
694 if ( is_int( $value ) || is_float( $value ) || is_bool( $value ) ) {
695 return floatval( $value );
696 }
697
698 return null;
699 }
700
707 private function getInterwikiInsertions( $existing = [] ) {
708 $arr = [];
709 foreach ( $this->mInterwikis as $prefix => $dbkeys ) {
710 $diffs = isset( $existing[$prefix] )
711 ? array_diff_key( $dbkeys, $existing[$prefix] )
712 : $dbkeys;
713
714 foreach ( $diffs as $dbk => $id ) {
715 $arr[] = [
716 'iwl_from' => $this->mId,
717 'iwl_prefix' => $prefix,
718 'iwl_title' => $dbk
719 ];
720 }
721 }
722
723 return $arr;
724 }
725
732 private function getLinkDeletions( $existing ) {
733 $del = [];
734 foreach ( $existing as $ns => $dbkeys ) {
735 if ( isset( $this->mLinks[$ns] ) ) {
736 $del[$ns] = array_diff_key( $existing[$ns], $this->mLinks[$ns] );
737 } else {
738 $del[$ns] = $existing[$ns];
739 }
740 }
741
742 return $del;
743 }
744
751 private function getTemplateDeletions( $existing ) {
752 $del = [];
753 foreach ( $existing as $ns => $dbkeys ) {
754 if ( isset( $this->mTemplates[$ns] ) ) {
755 $del[$ns] = array_diff_key( $existing[$ns], $this->mTemplates[$ns] );
756 } else {
757 $del[$ns] = $existing[$ns];
758 }
759 }
760
761 return $del;
762 }
763
770 private function getImageDeletions( $existing ) {
771 return array_diff_key( $existing, $this->mImages );
772 }
773
780 private function getExternalDeletions( $existing ) {
781 return array_diff_key( $existing, $this->mExternals );
782 }
783
790 private function getCategoryDeletions( $existing ) {
791 return array_diff_assoc( $existing, $this->mCategories );
792 }
793
800 private function getInterlangDeletions( $existing ) {
801 return array_diff_assoc( $existing, $this->mInterlangs );
802 }
803
809 function getPropertyDeletions( $existing ) {
810 return array_diff_assoc( $existing, $this->mProperties );
811 }
812
819 private function getInterwikiDeletions( $existing ) {
820 $del = [];
821 foreach ( $existing as $prefix => $dbkeys ) {
822 if ( isset( $this->mInterwikis[$prefix] ) ) {
823 $del[$prefix] = array_diff_key( $existing[$prefix], $this->mInterwikis[$prefix] );
824 } else {
825 $del[$prefix] = $existing[$prefix];
826 }
827 }
828
829 return $del;
830 }
831
837 private function getExistingLinks() {
838 $res = $this->getDB()->select( 'pagelinks', [ 'pl_namespace', 'pl_title' ],
839 [ 'pl_from' => $this->mId ], __METHOD__ );
840 $arr = [];
841 foreach ( $res as $row ) {
842 if ( !isset( $arr[$row->pl_namespace] ) ) {
843 $arr[$row->pl_namespace] = [];
844 }
845 $arr[$row->pl_namespace][$row->pl_title] = 1;
846 }
847
848 return $arr;
849 }
850
856 private function getExistingTemplates() {
857 $res = $this->getDB()->select( 'templatelinks', [ 'tl_namespace', 'tl_title' ],
858 [ 'tl_from' => $this->mId ], __METHOD__ );
859 $arr = [];
860 foreach ( $res as $row ) {
861 if ( !isset( $arr[$row->tl_namespace] ) ) {
862 $arr[$row->tl_namespace] = [];
863 }
864 $arr[$row->tl_namespace][$row->tl_title] = 1;
865 }
866
867 return $arr;
868 }
869
875 private function getExistingImages() {
876 $res = $this->getDB()->select( 'imagelinks', [ 'il_to' ],
877 [ 'il_from' => $this->mId ], __METHOD__ );
878 $arr = [];
879 foreach ( $res as $row ) {
880 $arr[$row->il_to] = 1;
881 }
882
883 return $arr;
884 }
885
891 private function getExistingExternals() {
892 $res = $this->getDB()->select( 'externallinks', [ 'el_to' ],
893 [ 'el_from' => $this->mId ], __METHOD__ );
894 $arr = [];
895 foreach ( $res as $row ) {
896 $arr[$row->el_to] = 1;
897 }
898
899 return $arr;
900 }
901
907 private function getExistingCategories() {
908 $res = $this->getDB()->select( 'categorylinks', [ 'cl_to', 'cl_sortkey_prefix' ],
909 [ 'cl_from' => $this->mId ], __METHOD__ );
910 $arr = [];
911 foreach ( $res as $row ) {
912 $arr[$row->cl_to] = $row->cl_sortkey_prefix;
913 }
914
915 return $arr;
916 }
917
924 private function getExistingInterlangs() {
925 $res = $this->getDB()->select( 'langlinks', [ 'll_lang', 'll_title' ],
926 [ 'll_from' => $this->mId ], __METHOD__ );
927 $arr = [];
928 foreach ( $res as $row ) {
929 $arr[$row->ll_lang] = $row->ll_title;
930 }
931
932 return $arr;
933 }
934
939 private function getExistingInterwikis() {
940 $res = $this->getDB()->select( 'iwlinks', [ 'iwl_prefix', 'iwl_title' ],
941 [ 'iwl_from' => $this->mId ], __METHOD__ );
942 $arr = [];
943 foreach ( $res as $row ) {
944 if ( !isset( $arr[$row->iwl_prefix] ) ) {
945 $arr[$row->iwl_prefix] = [];
946 }
947 $arr[$row->iwl_prefix][$row->iwl_title] = 1;
948 }
949
950 return $arr;
951 }
952
958 private function getExistingProperties() {
959 $res = $this->getDB()->select( 'page_props', [ 'pp_propname', 'pp_value' ],
960 [ 'pp_page' => $this->mId ], __METHOD__ );
961 $arr = [];
962 foreach ( $res as $row ) {
963 $arr[$row->pp_propname] = $row->pp_value;
964 }
965
966 return $arr;
967 }
968
973 public function getTitle() {
974 return $this->mTitle;
975 }
976
982 public function getParserOutput() {
984 }
985
990 public function getImages() {
991 return $this->mImages;
992 }
993
1001 public function setRevision( Revision $revision ) {
1002 $this->mRevision = $revision;
1003 }
1004
1009 public function getRevision() {
1010 return $this->mRevision;
1011 }
1012
1019 public function setTriggeringUser( User $user ) {
1020 $this->user = $user;
1021 }
1022
1027 public function getTriggeringUser() {
1028 return $this->user;
1029 }
1030
1035 private function invalidateProperties( $changed ) {
1037
1038 foreach ( $changed as $name => $value ) {
1039 if ( isset( $wgPagePropLinkInvalidations[$name] ) ) {
1041 if ( !is_array( $inv ) ) {
1042 $inv = [ $inv ];
1043 }
1044 foreach ( $inv as $table ) {
1045 DeferredUpdates::addUpdate( new HTMLCacheUpdate( $this->mTitle, $table ) );
1046 }
1047 }
1048 }
1049 }
1050
1056 public function getAddedLinks() {
1057 if ( $this->linkInsertions === null ) {
1058 return null;
1059 }
1060 $result = [];
1061 foreach ( $this->linkInsertions as $insertion ) {
1062 $result[] = Title::makeTitle( $insertion['pl_namespace'], $insertion['pl_title'] );
1063 }
1064
1065 return $result;
1066 }
1067
1073 public function getRemovedLinks() {
1074 if ( $this->linkDeletions === null ) {
1075 return null;
1076 }
1077 $result = [];
1078 foreach ( $this->linkDeletions as $ns => $titles ) {
1079 foreach ( $titles as $title => $unused ) {
1080 $result[] = Title::makeTitle( $ns, $title );
1081 }
1082 }
1083
1084 return $result;
1085 }
1086
1093 public function getAddedProperties() {
1095 }
1096
1103 public function getRemovedProperties() {
1105 }
1106
1110 private function updateLinksTimestamp() {
1111 if ( $this->mId ) {
1112 // The link updates made here only reflect the freshness of the parser output
1113 $timestamp = $this->mParserOutput->getCacheTime();
1114 $this->getDB()->update( 'page',
1115 [ 'page_links_updated' => $this->getDB()->timestamp( $timestamp ) ],
1116 [ 'page_id' => $this->mId ],
1117 __METHOD__
1118 );
1119 }
1120 }
1121
1125 private function getDB() {
1126 if ( !$this->db ) {
1127 $this->db = wfGetDB( DB_MASTER );
1128 }
1129
1130 return $this->db;
1131 }
1132
1133 public function getAsJobSpecification() {
1134 if ( $this->user ) {
1135 $userInfo = [
1136 'userId' => $this->user->getId(),
1137 'userName' => $this->user->getName(),
1138 ];
1139 } else {
1140 $userInfo = false;
1141 }
1142
1143 if ( $this->mRevision ) {
1144 $triggeringRevisionId = $this->mRevision->getId();
1145 } else {
1146 $triggeringRevisionId = false;
1147 }
1148
1149 return [
1150 'wiki' => WikiMap::getWikiIdFromDomain( $this->getDB()->getDomainID() ),
1151 'job' => new JobSpecification(
1152 'refreshLinksPrioritized',
1153 [
1154 // Reuse the parser cache if it was saved
1155 'rootJobTimestamp' => $this->mParserOutput->getCacheTime(),
1156 'useRecursiveLinksUpdate' => $this->mRecursive,
1157 'triggeringUser' => $userInfo,
1158 'triggeringRevisionId' => $triggeringRevisionId,
1159 ],
1160 [ 'removeDuplicates' => true ],
1161 $this->getTitle()
1162 )
1163 ];
1164 }
1165}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
$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.
static singleton()
Definition Collation.php:34
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.
static singleton( $wiki=false)
Job queue task description base code.
static newRootJobParams( $key)
Get "root job" parameters for a task.
Definition Job.php:271
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.
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.
static queueRecursiveJobsForTable(Title $title, $table)
Queue a RefreshLinks job for any table.
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.
invalidateImageDescriptions( $images)
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.
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:51
static getWikiIdFromDomain( $domain)
Get the wiki ID of a database domain.
Definition WikiMap.php:252
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition WikiPage.php:121
$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
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the local content language as $wgContLang
Definition design.txt:57
when a variable name is used in a it is silently declared as a new local masking the global
Definition design.txt:95
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such and we might be restricted by PHP settings such as safe mode or open_basedir We cannot assume that the software even has read access anywhere useful Many shared hosts run all users web applications under the same user
Wikitext formatted, in the key only.
const NS_FILE
Definition Defines.php:71
const NS_CATEGORY
Definition Defines.php:79
the array() calling protocol came about after MediaWiki 1.4rc1.
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition hooks.txt:1963
namespace and then decline to actually register it file or subcat img or subcat $title
Definition hooks.txt:962
either a unescaped string or a HtmlArmor object after in associative array form externallinks $linksUpdate
Definition hooks.txt:2060
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title 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:2243
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition hooks.txt:2989
Allows to change the fields on the form that will be generated $name
Definition hooks.txt:302
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37
Interface that marks a DataUpdate as enqueuable via the JobQueue.
Basic database interface for live and lazy-loaded relation database handles.
Definition IDatabase.php:40
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
const DB_MASTER
Definition defines.php:26
if(count( $args)< 1) $job
if(!isset( $args[0])) $lang