MediaWiki  1.28.1
LinksUpdate.php
Go to the documentation of this file.
1 <?php
25 
33 class LinksUpdate extends DataUpdate implements EnqueueableDataUpdate {
34  // @todo make members protected, but make sure extensions don't break
35 
37  public $mId;
38 
40  public $mTitle;
41 
44 
46  public $mLinks;
47 
49  public $mImages;
50 
52  public $mTemplates;
53 
55  public $mExternals;
56 
58  public $mCategories;
59 
61  public $mInterlangs;
62 
64  public $mInterwikis;
65 
67  public $mProperties;
68 
70  public $mRecursive;
71 
73  private $mRevision;
74 
78  private $linkInsertions = null;
79 
83  private $linkDeletions = null;
84 
88  private $propertyInsertions = null;
89 
93  private $propertyDeletions = null;
94 
98  private $user;
99 
101  private $db;
102 
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,
146  # it truncated by DB, and then doesn't get
147  # matched when comparing existing vs current
148  # categories, causing bug 25254.
149  # Also. substr behaves weird when given "".
150  if ( $sortkey !== '' ) {
151  $sortkey = substr( $sortkey, 0, 255 );
152  }
153  }
154 
155  $this->mRecursive = $recursive;
156 
157  Hooks::run( 'LinksUpdateConstructed', [ &$this ] );
158  }
159 
165  public function doUpdate() {
166  if ( $this->ticket ) {
167  // Make sure all links update threads see the changes of each other.
168  // This handles the case when updates have to batched into several COMMITs.
169  $scopedLock = self::acquirePageLock( $this->getDB(), $this->mId );
170  }
171 
172  Hooks::run( 'LinksUpdate', [ &$this ] );
173  $this->doIncrementalUpdate();
174 
175  // Commit and release the lock (if set)
176  ScopedCallback::consume( $scopedLock );
177  // Run post-commit hooks without DBO_TRX
178  $this->getDB()->onTransactionIdle(
179  function () {
180  Hooks::run( 'LinksUpdateComplete', [ &$this, $this->ticket ] );
181  },
182  __METHOD__
183  );
184  }
185 
196  public static function acquirePageLock( IDatabase $dbw, $pageId, $why = 'atomicity' ) {
197  $key = "LinksUpdate:$why:pageid:$pageId";
198  $scopedLock = $dbw->getScopedLockAndFlush( $key, __METHOD__, 15 );
199  if ( !$scopedLock ) {
200  throw new RuntimeException( "Could not acquire lock '$key'." );
201  }
202 
203  return $scopedLock;
204  }
205 
206  protected function doIncrementalUpdate() {
207  # Page links
208  $existing = $this->getExistingLinks();
209  $this->linkDeletions = $this->getLinkDeletions( $existing );
210  $this->linkInsertions = $this->getLinkInsertions( $existing );
211  $this->incrTableUpdate( 'pagelinks', 'pl', $this->linkDeletions, $this->linkInsertions );
212 
213  # Image links
214  $existing = $this->getExistingImages();
215  $imageDeletes = $this->getImageDeletions( $existing );
216  $this->incrTableUpdate( 'imagelinks', 'il', $imageDeletes,
217  $this->getImageInsertions( $existing ) );
218 
219  # Invalidate all image description pages which had links added or removed
220  $imageUpdates = $imageDeletes + array_diff_key( $this->mImages, $existing );
221  $this->invalidateImageDescriptions( $imageUpdates );
222 
223  # External links
224  $existing = $this->getExistingExternals();
225  $this->incrTableUpdate( 'externallinks', 'el', $this->getExternalDeletions( $existing ),
226  $this->getExternalInsertions( $existing ) );
227 
228  # Language links
229  $existing = $this->getExistingInterlangs();
230  $this->incrTableUpdate( 'langlinks', 'll', $this->getInterlangDeletions( $existing ),
231  $this->getInterlangInsertions( $existing ) );
232 
233  # Inline interwiki links
234  $existing = $this->getExistingInterwikis();
235  $this->incrTableUpdate( 'iwlinks', 'iwl', $this->getInterwikiDeletions( $existing ),
236  $this->getInterwikiInsertions( $existing ) );
237 
238  # Template links
239  $existing = $this->getExistingTemplates();
240  $this->incrTableUpdate( 'templatelinks', 'tl', $this->getTemplateDeletions( $existing ),
241  $this->getTemplateInsertions( $existing ) );
242 
243  # Category links
244  $existing = $this->getExistingCategories();
245  $categoryDeletes = $this->getCategoryDeletions( $existing );
246  $this->incrTableUpdate( 'categorylinks', 'cl', $categoryDeletes,
247  $this->getCategoryInsertions( $existing ) );
248 
249  # Invalidate all categories which were added, deleted or changed (set symmetric difference)
250  $categoryInserts = array_diff_assoc( $this->mCategories, $existing );
251  $categoryUpdates = $categoryInserts + $categoryDeletes;
252  $this->invalidateCategories( $categoryUpdates );
253  $this->updateCategoryCounts( $categoryInserts, $categoryDeletes );
254 
255  # Page properties
256  $existing = $this->getExistingProperties();
257  $this->propertyDeletions = $this->getPropertyDeletions( $existing );
258  $this->incrTableUpdate( 'page_props', 'pp', $this->propertyDeletions,
259  $this->getPropertyInsertions( $existing ) );
260 
261  # Invalidate the necessary pages
262  $this->propertyInsertions = array_diff_assoc( $this->mProperties, $existing );
263  $changed = $this->propertyDeletions + $this->propertyInsertions;
264  $this->invalidateProperties( $changed );
265 
266  # Refresh links of all pages including this page
267  # This will be in a separate transaction
268  if ( $this->mRecursive ) {
269  $this->queueRecursiveJobs();
270  }
271 
272  # Update the links table freshness for this title
273  $this->updateLinksTimestamp();
274  }
275 
282  protected function queueRecursiveJobs() {
283  self::queueRecursiveJobsForTable( $this->mTitle, 'templatelinks' );
284  if ( $this->mTitle->getNamespace() == NS_FILE ) {
285  // Process imagelinks in case the title is or was a redirect
286  self::queueRecursiveJobsForTable( $this->mTitle, 'imagelinks' );
287  }
288 
289  $bc = $this->mTitle->getBacklinkCache();
290  // Get jobs for cascade-protected backlinks for a high priority queue.
291  // If meta-templates change to using a new template, the new template
292  // should be implicitly protected as soon as possible, if applicable.
293  // These jobs duplicate a subset of the above ones, but can run sooner.
294  // Which ever runs first generally no-ops the other one.
295  $jobs = [];
296  foreach ( $bc->getCascadeProtectedLinks() as $title ) {
297  $jobs[] = RefreshLinksJob::newPrioritized( $title, [] );
298  }
299  JobQueueGroup::singleton()->push( $jobs );
300  }
301 
308  public static function queueRecursiveJobsForTable( Title $title, $table ) {
309  if ( $title->getBacklinkCache()->hasLinks( $table ) ) {
310  $job = new RefreshLinksJob(
311  $title,
312  [
313  'table' => $table,
314  'recursive' => true,
315  ] + Job::newRootJobParams( // "overall" refresh links job info
316  "refreshlinks:{$table}:{$title->getPrefixedText()}"
317  )
318  );
319 
320  JobQueueGroup::singleton()->push( $job );
321  }
322  }
323 
327  function invalidateCategories( $cats ) {
328  PurgeJobUtils::invalidatePages( $this->getDB(), NS_CATEGORY, array_keys( $cats ) );
329  }
330 
336  function updateCategoryCounts( $added, $deleted ) {
337  $a = WikiPage::factory( $this->mTitle );
338  $a->updateCategoryCounts(
339  array_keys( $added ), array_keys( $deleted )
340  );
341  }
342 
346  function invalidateImageDescriptions( $images ) {
347  PurgeJobUtils::invalidatePages( $this->getDB(), NS_FILE, array_keys( $images ) );
348  }
349 
357  private function incrTableUpdate( $table, $prefix, $deletions, $insertions ) {
358  $services = MediaWikiServices::getInstance();
359  $bSize = $services->getMainConfig()->get( 'UpdateRowsPerQuery' );
360  $factory = $services->getDBLoadBalancerFactory();
361 
362  if ( $table === 'page_props' ) {
363  $fromField = 'pp_page';
364  } else {
365  $fromField = "{$prefix}_from";
366  }
367 
368  $deleteWheres = []; // list of WHERE clause arrays for each DB delete() call
369  if ( $table === 'pagelinks' || $table === 'templatelinks' || $table === 'iwlinks' ) {
370  $baseKey = ( $table === 'iwlinks' ) ? 'iwl_prefix' : "{$prefix}_namespace";
371 
372  $curBatchSize = 0;
373  $curDeletionBatch = [];
374  $deletionBatches = [];
375  foreach ( $deletions as $ns => $dbKeys ) {
376  foreach ( $dbKeys as $dbKey => $unused ) {
377  $curDeletionBatch[$ns][$dbKey] = 1;
378  if ( ++$curBatchSize >= $bSize ) {
379  $deletionBatches[] = $curDeletionBatch;
380  $curDeletionBatch = [];
381  $curBatchSize = 0;
382  }
383  }
384  }
385  if ( $curDeletionBatch ) {
386  $deletionBatches[] = $curDeletionBatch;
387  }
388 
389  foreach ( $deletionBatches as $deletionBatch ) {
390  $deleteWheres[] = [
391  $fromField => $this->mId,
392  $this->getDB()->makeWhereFrom2d( $deletionBatch, $baseKey, "{$prefix}_title" )
393  ];
394  }
395  } else {
396  if ( $table === 'langlinks' ) {
397  $toField = 'll_lang';
398  } elseif ( $table === 'page_props' ) {
399  $toField = 'pp_propname';
400  } else {
401  $toField = $prefix . '_to';
402  }
403 
404  $deletionBatches = array_chunk( array_keys( $deletions ), $bSize );
405  foreach ( $deletionBatches as $deletionBatch ) {
406  $deleteWheres[] = [ $fromField => $this->mId, $toField => $deletionBatch ];
407  }
408  }
409 
410  foreach ( $deleteWheres as $deleteWhere ) {
411  $this->getDB()->delete( $table, $deleteWhere, __METHOD__ );
412  $factory->commitAndWaitForReplication(
413  __METHOD__, $this->ticket, [ 'wiki' => $this->getDB()->getWikiID() ]
414  );
415  }
416 
417  $insertBatches = array_chunk( $insertions, $bSize );
418  foreach ( $insertBatches as $insertBatch ) {
419  $this->getDB()->insert( $table, $insertBatch, __METHOD__, 'IGNORE' );
420  $factory->commitAndWaitForReplication(
421  __METHOD__, $this->ticket, [ 'wiki' => $this->getDB()->getWikiID() ]
422  );
423  }
424 
425  if ( count( $insertions ) ) {
426  Hooks::run( 'LinksUpdateAfterInsert', [ $this, $table, $insertions ] );
427  }
428  }
429 
436  private function getLinkInsertions( $existing = [] ) {
437  $arr = [];
438  foreach ( $this->mLinks as $ns => $dbkeys ) {
439  $diffs = isset( $existing[$ns] )
440  ? array_diff_key( $dbkeys, $existing[$ns] )
441  : $dbkeys;
442  foreach ( $diffs as $dbk => $id ) {
443  $arr[] = [
444  'pl_from' => $this->mId,
445  'pl_from_namespace' => $this->mTitle->getNamespace(),
446  'pl_namespace' => $ns,
447  'pl_title' => $dbk
448  ];
449  }
450  }
451 
452  return $arr;
453  }
454 
460  private function getTemplateInsertions( $existing = [] ) {
461  $arr = [];
462  foreach ( $this->mTemplates as $ns => $dbkeys ) {
463  $diffs = isset( $existing[$ns] ) ? array_diff_key( $dbkeys, $existing[$ns] ) : $dbkeys;
464  foreach ( $diffs as $dbk => $id ) {
465  $arr[] = [
466  'tl_from' => $this->mId,
467  'tl_from_namespace' => $this->mTitle->getNamespace(),
468  'tl_namespace' => $ns,
469  'tl_title' => $dbk
470  ];
471  }
472  }
473 
474  return $arr;
475  }
476 
483  private function getImageInsertions( $existing = [] ) {
484  $arr = [];
485  $diffs = array_diff_key( $this->mImages, $existing );
486  foreach ( $diffs as $iname => $dummy ) {
487  $arr[] = [
488  'il_from' => $this->mId,
489  'il_from_namespace' => $this->mTitle->getNamespace(),
490  'il_to' => $iname
491  ];
492  }
493 
494  return $arr;
495  }
496 
502  private function getExternalInsertions( $existing = [] ) {
503  $arr = [];
504  $diffs = array_diff_key( $this->mExternals, $existing );
505  foreach ( $diffs as $url => $dummy ) {
506  foreach ( wfMakeUrlIndexes( $url ) as $index ) {
507  $arr[] = [
508  'el_id' => $this->getDB()->nextSequenceValue( 'externallinks_el_id_seq' ),
509  'el_from' => $this->mId,
510  'el_to' => $url,
511  'el_index' => $index,
512  ];
513  }
514  }
515 
516  return $arr;
517  }
518 
527  private function getCategoryInsertions( $existing = [] ) {
528  global $wgContLang, $wgCategoryCollation;
529  $diffs = array_diff_assoc( $this->mCategories, $existing );
530  $arr = [];
531  foreach ( $diffs as $name => $prefix ) {
533  $wgContLang->findVariantLink( $name, $nt, true );
534 
535  if ( $this->mTitle->getNamespace() == NS_CATEGORY ) {
536  $type = 'subcat';
537  } elseif ( $this->mTitle->getNamespace() == NS_FILE ) {
538  $type = 'file';
539  } else {
540  $type = 'page';
541  }
542 
543  # Treat custom sortkeys as a prefix, so that if multiple
544  # things are forced to sort as '*' or something, they'll
545  # sort properly in the category rather than in page_id
546  # order or such.
547  $sortkey = Collation::singleton()->getSortKey(
548  $this->mTitle->getCategorySortkey( $prefix ) );
549 
550  $arr[] = [
551  'cl_from' => $this->mId,
552  'cl_to' => $name,
553  'cl_sortkey' => $sortkey,
554  'cl_timestamp' => $this->getDB()->timestamp(),
555  'cl_sortkey_prefix' => $prefix,
556  'cl_collation' => $wgCategoryCollation,
557  'cl_type' => $type,
558  ];
559  }
560 
561  return $arr;
562  }
563 
571  private function getInterlangInsertions( $existing = [] ) {
572  $diffs = array_diff_assoc( $this->mInterlangs, $existing );
573  $arr = [];
574  foreach ( $diffs as $lang => $title ) {
575  $arr[] = [
576  'll_from' => $this->mId,
577  'll_lang' => $lang,
578  'll_title' => $title
579  ];
580  }
581 
582  return $arr;
583  }
584 
590  function getPropertyInsertions( $existing = [] ) {
591  $diffs = array_diff_assoc( $this->mProperties, $existing );
592 
593  $arr = [];
594  foreach ( array_keys( $diffs ) as $name ) {
595  $arr[] = $this->getPagePropRowData( $name );
596  }
597 
598  return $arr;
599  }
600 
617  private function getPagePropRowData( $prop ) {
618  global $wgPagePropsHaveSortkey;
619 
620  $value = $this->mProperties[$prop];
621 
622  $row = [
623  'pp_page' => $this->mId,
624  'pp_propname' => $prop,
625  'pp_value' => $value,
626  ];
627 
628  if ( $wgPagePropsHaveSortkey ) {
629  $row['pp_sortkey'] = $this->getPropertySortKeyValue( $value );
630  }
631 
632  return $row;
633  }
634 
647  private function getPropertySortKeyValue( $value ) {
648  if ( is_int( $value ) || is_float( $value ) || is_bool( $value ) ) {
649  return floatval( $value );
650  }
651 
652  return null;
653  }
654 
661  private function getInterwikiInsertions( $existing = [] ) {
662  $arr = [];
663  foreach ( $this->mInterwikis as $prefix => $dbkeys ) {
664  $diffs = isset( $existing[$prefix] )
665  ? array_diff_key( $dbkeys, $existing[$prefix] )
666  : $dbkeys;
667 
668  foreach ( $diffs as $dbk => $id ) {
669  $arr[] = [
670  'iwl_from' => $this->mId,
671  'iwl_prefix' => $prefix,
672  'iwl_title' => $dbk
673  ];
674  }
675  }
676 
677  return $arr;
678  }
679 
686  private function getLinkDeletions( $existing ) {
687  $del = [];
688  foreach ( $existing as $ns => $dbkeys ) {
689  if ( isset( $this->mLinks[$ns] ) ) {
690  $del[$ns] = array_diff_key( $existing[$ns], $this->mLinks[$ns] );
691  } else {
692  $del[$ns] = $existing[$ns];
693  }
694  }
695 
696  return $del;
697  }
698 
705  private function getTemplateDeletions( $existing ) {
706  $del = [];
707  foreach ( $existing as $ns => $dbkeys ) {
708  if ( isset( $this->mTemplates[$ns] ) ) {
709  $del[$ns] = array_diff_key( $existing[$ns], $this->mTemplates[$ns] );
710  } else {
711  $del[$ns] = $existing[$ns];
712  }
713  }
714 
715  return $del;
716  }
717 
724  private function getImageDeletions( $existing ) {
725  return array_diff_key( $existing, $this->mImages );
726  }
727 
734  private function getExternalDeletions( $existing ) {
735  return array_diff_key( $existing, $this->mExternals );
736  }
737 
744  private function getCategoryDeletions( $existing ) {
745  return array_diff_assoc( $existing, $this->mCategories );
746  }
747 
754  private function getInterlangDeletions( $existing ) {
755  return array_diff_assoc( $existing, $this->mInterlangs );
756  }
757 
763  function getPropertyDeletions( $existing ) {
764  return array_diff_assoc( $existing, $this->mProperties );
765  }
766 
773  private function getInterwikiDeletions( $existing ) {
774  $del = [];
775  foreach ( $existing as $prefix => $dbkeys ) {
776  if ( isset( $this->mInterwikis[$prefix] ) ) {
777  $del[$prefix] = array_diff_key( $existing[$prefix], $this->mInterwikis[$prefix] );
778  } else {
779  $del[$prefix] = $existing[$prefix];
780  }
781  }
782 
783  return $del;
784  }
785 
791  private function getExistingLinks() {
792  $res = $this->getDB()->select( 'pagelinks', [ 'pl_namespace', 'pl_title' ],
793  [ 'pl_from' => $this->mId ], __METHOD__ );
794  $arr = [];
795  foreach ( $res as $row ) {
796  if ( !isset( $arr[$row->pl_namespace] ) ) {
797  $arr[$row->pl_namespace] = [];
798  }
799  $arr[$row->pl_namespace][$row->pl_title] = 1;
800  }
801 
802  return $arr;
803  }
804 
810  private function getExistingTemplates() {
811  $res = $this->getDB()->select( 'templatelinks', [ 'tl_namespace', 'tl_title' ],
812  [ 'tl_from' => $this->mId ], __METHOD__ );
813  $arr = [];
814  foreach ( $res as $row ) {
815  if ( !isset( $arr[$row->tl_namespace] ) ) {
816  $arr[$row->tl_namespace] = [];
817  }
818  $arr[$row->tl_namespace][$row->tl_title] = 1;
819  }
820 
821  return $arr;
822  }
823 
829  private function getExistingImages() {
830  $res = $this->getDB()->select( 'imagelinks', [ 'il_to' ],
831  [ 'il_from' => $this->mId ], __METHOD__ );
832  $arr = [];
833  foreach ( $res as $row ) {
834  $arr[$row->il_to] = 1;
835  }
836 
837  return $arr;
838  }
839 
845  private function getExistingExternals() {
846  $res = $this->getDB()->select( 'externallinks', [ 'el_to' ],
847  [ 'el_from' => $this->mId ], __METHOD__ );
848  $arr = [];
849  foreach ( $res as $row ) {
850  $arr[$row->el_to] = 1;
851  }
852 
853  return $arr;
854  }
855 
861  private function getExistingCategories() {
862  $res = $this->getDB()->select( 'categorylinks', [ 'cl_to', 'cl_sortkey_prefix' ],
863  [ 'cl_from' => $this->mId ], __METHOD__ );
864  $arr = [];
865  foreach ( $res as $row ) {
866  $arr[$row->cl_to] = $row->cl_sortkey_prefix;
867  }
868 
869  return $arr;
870  }
871 
878  private function getExistingInterlangs() {
879  $res = $this->getDB()->select( 'langlinks', [ 'll_lang', 'll_title' ],
880  [ 'll_from' => $this->mId ], __METHOD__ );
881  $arr = [];
882  foreach ( $res as $row ) {
883  $arr[$row->ll_lang] = $row->ll_title;
884  }
885 
886  return $arr;
887  }
888 
893  private function getExistingInterwikis() {
894  $res = $this->getDB()->select( 'iwlinks', [ 'iwl_prefix', 'iwl_title' ],
895  [ 'iwl_from' => $this->mId ], __METHOD__ );
896  $arr = [];
897  foreach ( $res as $row ) {
898  if ( !isset( $arr[$row->iwl_prefix] ) ) {
899  $arr[$row->iwl_prefix] = [];
900  }
901  $arr[$row->iwl_prefix][$row->iwl_title] = 1;
902  }
903 
904  return $arr;
905  }
906 
912  private function getExistingProperties() {
913  $res = $this->getDB()->select( 'page_props', [ 'pp_propname', 'pp_value' ],
914  [ 'pp_page' => $this->mId ], __METHOD__ );
915  $arr = [];
916  foreach ( $res as $row ) {
917  $arr[$row->pp_propname] = $row->pp_value;
918  }
919 
920  return $arr;
921  }
922 
927  public function getTitle() {
928  return $this->mTitle;
929  }
930 
936  public function getParserOutput() {
937  return $this->mParserOutput;
938  }
939 
944  public function getImages() {
945  return $this->mImages;
946  }
947 
955  public function setRevision( Revision $revision ) {
956  $this->mRevision = $revision;
957  }
958 
963  public function getRevision() {
964  return $this->mRevision;
965  }
966 
973  public function setTriggeringUser( User $user ) {
974  $this->user = $user;
975  }
976 
981  public function getTriggeringUser() {
982  return $this->user;
983  }
984 
989  private function invalidateProperties( $changed ) {
990  global $wgPagePropLinkInvalidations;
991 
992  foreach ( $changed as $name => $value ) {
993  if ( isset( $wgPagePropLinkInvalidations[$name] ) ) {
994  $inv = $wgPagePropLinkInvalidations[$name];
995  if ( !is_array( $inv ) ) {
996  $inv = [ $inv ];
997  }
998  foreach ( $inv as $table ) {
999  DeferredUpdates::addUpdate( new HTMLCacheUpdate( $this->mTitle, $table ) );
1000  }
1001  }
1002  }
1003  }
1004 
1010  public function getAddedLinks() {
1011  if ( $this->linkInsertions === null ) {
1012  return null;
1013  }
1014  $result = [];
1015  foreach ( $this->linkInsertions as $insertion ) {
1016  $result[] = Title::makeTitle( $insertion['pl_namespace'], $insertion['pl_title'] );
1017  }
1018 
1019  return $result;
1020  }
1021 
1027  public function getRemovedLinks() {
1028  if ( $this->linkDeletions === null ) {
1029  return null;
1030  }
1031  $result = [];
1032  foreach ( $this->linkDeletions as $ns => $titles ) {
1033  foreach ( $titles as $title => $unused ) {
1034  $result[] = Title::makeTitle( $ns, $title );
1035  }
1036  }
1037 
1038  return $result;
1039  }
1040 
1047  public function getAddedProperties() {
1049  }
1050 
1057  public function getRemovedProperties() {
1058  return $this->propertyDeletions;
1059  }
1060 
1064  private function updateLinksTimestamp() {
1065  if ( $this->mId ) {
1066  // The link updates made here only reflect the freshness of the parser output
1067  $timestamp = $this->mParserOutput->getCacheTime();
1068  $this->getDB()->update( 'page',
1069  [ 'page_links_updated' => $this->getDB()->timestamp( $timestamp ) ],
1070  [ 'page_id' => $this->mId ],
1071  __METHOD__
1072  );
1073  }
1074  }
1075 
1079  private function getDB() {
1080  if ( !$this->db ) {
1081  $this->db = wfGetDB( DB_MASTER );
1082  }
1083 
1084  return $this->db;
1085  }
1086 
1087  public function getAsJobSpecification() {
1088  if ( $this->user ) {
1089  $userInfo = [
1090  'userId' => $this->user->getId(),
1091  'userName' => $this->user->getName(),
1092  ];
1093  } else {
1094  $userInfo = false;
1095  }
1096 
1097  if ( $this->mRevision ) {
1098  $triggeringRevisionId = $this->mRevision->getId();
1099  } else {
1100  $triggeringRevisionId = false;
1101  }
1102 
1103  return [
1104  'wiki' => $this->getDB()->getWikiID(),
1105  'job' => new JobSpecification(
1106  'refreshLinksPrioritized',
1107  [
1108  // Reuse the parser cache if it was saved
1109  'rootJobTimestamp' => $this->mParserOutput->getCacheTime(),
1110  'useRecursiveLinksUpdate' => $this->mRecursive,
1111  'triggeringUser' => $userInfo,
1112  'triggeringRevisionId' => $triggeringRevisionId,
1113  ],
1114  [ 'removeDuplicates' => true ],
1115  $this->getTitle()
1116  )
1117  ];
1118  }
1119 }
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:115
setRevision(Revision $revision)
Set the revision corresponding to this LinksUpdate.
invalidateProperties($changed)
Invalidate any necessary link lists related to page property changes.
updateLinksTimestamp()
Update links table freshness.
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
wfGetDB($db, $groups=[], $wiki=false)
Get a Database object.
queueRecursiveJobs()
Queue recursive jobs for this page.
getImageDeletions($existing)
Given an array of existing images, returns those images which are not in $this and thus should be del...
bool $mRecursive
Whether to queue jobs for recursive updates.
Definition: LinksUpdate.php:70
getArticleID($flags=0)
Get the article ID for this Title from the link cache, adding it if necessary.
Definition: Title.php:3209
static invalidatePages(IDatabase $dbw, $namespace, array $dbkeys)
Invalidate the cache of a list of pages from a single namespace.
getPropertySortKeyValue($value)
Determines the sort key for the given property value.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Class the manages updates of *_link tables as well as similar extension-managed tables.
Definition: LinksUpdate.php:33
getCategoryInsertions($existing=[])
Get an array of category insertions.
getExistingInterwikis()
Get an array of existing inline interwiki links, as a 2-D array.
array $mProperties
Map of arbitrary name to value.
Definition: LinksUpdate.php:67
static singleton()
Definition: Collation.php:34
if(!isset($args[0])) $lang
Interface that marks a DataUpdate as enqueuable via the JobQueue.
$value
static newRootJobParams($key)
Get "root job" parameters for a task.
Definition: Job.php:261
wfMakeUrlIndexes($url)
Make URL indexes, appropriate for the el_index field of externallinks.
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 MediaWikiServices
Definition: injection.txt:23
Revision $mRevision
Revision for which this update has been triggered.
Definition: LinksUpdate.php:73
null array $linkInsertions
Added links if calculated.
Definition: LinksUpdate.php:78
updateCategoryCounts($added, $deleted)
Update all the appropriate counts in the category table.
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
getExistingProperties()
Get an array of existing categories, with the name in the key and sort key in the value...
Title $mTitle
Title object of the article linked from.
Definition: LinksUpdate.php:40
getBacklinkCache()
Get a backlink cache object.
Definition: Title.php:4624
const DB_MASTER
Definition: defines.php:23
__construct(Title $title, ParserOutput $parserOutput, $recursive=true)
Constructor.
getPagePropRowData($prop)
Returns an associative array to be used for inserting a row into the page_props table.
getExistingInterlangs()
Get an array of existing interlanguage links, with the language code in the key and the title in the ...
static queueRecursiveJobsForTable(Title $title, $table)
Queue a RefreshLinks job for any table.
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:Associative array mapping language codes to prefixed links of the form"language:title".&$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:1934
ParserOutput $mParserOutput
Definition: LinksUpdate.php:43
getTemplateDeletions($existing)
Given an array of existing templates, returns those templates which are not in $this and thus should ...
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition: hooks.txt:2889
getLinkInsertions($existing=[])
Get an array of pagelinks insertions for passing to the DB Skips the titles specified by the 2-D arra...
getInterlangDeletions($existing)
Given an array of existing interlanguage links, returns those links which are not in $this and thus s...
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return true
Definition: hooks.txt:1936
getPropertyInsertions($existing=[])
Get an array of page property insertions.
getRemovedProperties()
Fetch page properties removed by this LinksUpdate.
getTitle()
Return the title object of the page being updated.
getExistingCategories()
Get an array of existing categories, with the name in the key and sort key in the value...
array $mImages
DB keys of the images used, in the array key only.
Definition: LinksUpdate.php:49
getExistingExternals()
Get an array of existing external links, URLs in the keys.
getParserOutput()
Returns parser output.
getCategoryDeletions($existing)
Given an array of existing categories, returns those categories which are not in $this and thus shoul...
Class to invalidate the HTML cache of all the pages linking to a given title.
getAddedLinks()
Fetch page links added by this LinksUpdate.
if($limit) $timestamp
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context $parserOutput
Definition: hooks.txt:1046
null array $propertyInsertions
Added properties if calculated.
Definition: LinksUpdate.php:88
$res
Definition: database.txt:21
const GAID_FOR_UPDATE
Used to be GAID_FOR_UPDATE define.
Definition: Title.php:51
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.
Definition: distributors.txt:9
setTriggeringUser(User $user)
Set the User who triggered this LinksUpdate.
getRemovedLinks()
Fetch page links removed by this LinksUpdate.
const NS_CATEGORY
Definition: Defines.php:70
incrTableUpdate($table, $prefix, $deletions, $insertions)
Update a table by doing a delete query then an insert query.
array $mExternals
URLs of external links, array key only.
Definition: LinksUpdate.php:55
static makeTitleSafe($ns, $title, $fragment= '', $interwiki= '')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:535
array $mTemplates
Map of title strings to IDs for the template references, including broken ones.
Definition: LinksUpdate.php:52
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:953
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
invalidateCategories($cats)
getExistingImages()
Get an array of existing images, image names in the keys.
const NS_FILE
Definition: Defines.php:62
getInterlangInsertions($existing=[])
Get an array of interlanguage link insertions.
getTemplateInsertions($existing=[])
Get an array of template insertions.
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:2159
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
Definition: distributors.txt:9
getExistingTemplates()
Get an array of existing templates, as a 2-D array.
getExternalInsertions($existing=[])
Get an array of externallinks insertions.
getExistingLinks()
Get an array of existing links, as a 2-D array.
invalidateImageDescriptions($images)
static singleton($wiki=false)
Job to update link tables for pages.
User null $user
Definition: LinksUpdate.php:98
null array $propertyDeletions
Deleted properties if calculated.
Definition: LinksUpdate.php:93
array $mLinks
Map of title strings to IDs for the links in the document.
Definition: LinksUpdate.php:46
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:35
getExternalDeletions($existing)
Given an array of existing external links, returns those links which are not in $this and thus should...
getInterwikiDeletions($existing)
Given an array of existing interwiki links, returns those links which are not in $this and thus shoul...
static addUpdate(DeferrableUpdate $update, $stage=self::POSTSEND)
Add an update to the deferred list to be run later by execute()
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
Abstract base class for update jobs that do something with some secondary data extracted from article...
Definition: DataUpdate.php:28
getAddedProperties()
Fetch page properties added by this LinksUpdate.
if(count($args)< 1) $job
static newPrioritized(Title $title, array $params)
getPropertyDeletions($existing)
Get array of properties which should be deleted.
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:56
getInterwikiInsertions($existing=[])
Get an array of interwiki insertions for passing to the DB Skips the titles specified by the 2-D arra...
getLinkDeletions($existing)
Given an array of existing links, returns those links which are not in $this and thus should be delet...
doUpdate()
Update link tables with outgoing links from an updated article.
null array $linkDeletions
Deleted links if calculated.
Definition: LinksUpdate.php:83
getImages()
Return the list of images used as generated by the parser.
array $mInterlangs
Map of language codes to titles.
Definition: LinksUpdate.php:61
static acquirePageLock(IDatabase $dbw, $pageId, $why= 'atomicity')
Acquire a lock for performing link table updates for a page on a DB.
int $mId
Page ID of the article linked from.
Definition: LinksUpdate.php:37
getImageInsertions($existing=[])
Get an array of image insertions Skips the names specified in $existing.
array $mCategories
Map of category names to sort keys.
Definition: LinksUpdate.php:58
Job queue task description base code.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
Definition: hooks.txt:2491
static makeTitle($ns, $title, $fragment= '', $interwiki= '')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:511
getScopedLockAndFlush($lockKey, $fname, $timeout)
Acquire a named lock, flush any transaction, and return an RAII style unlocker object.
Basic database interface for live and lazy-loaded relation database handles.
Definition: IDatabase.php:34
array $mInterwikis
2-D map of (prefix => DBK => 1)
Definition: LinksUpdate.php:64
IDatabase $db
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:300