MediaWiki  1.27.2
LinksUpdate.php
Go to the documentation of this file.
1 <?php
29  // @todo make members protected, but make sure extensions don't break
30 
32  public $mId;
33 
35  public $mTitle;
36 
39 
41  public $mLinks;
42 
44  public $mImages;
45 
47  public $mTemplates;
48 
50  public $mExternals;
51 
53  public $mCategories;
54 
56  public $mInterlangs;
57 
59  public $mInterwikis;
60 
62  public $mProperties;
63 
65  public $mRecursive;
66 
68  private $mRevision;
69 
73  private $linkInsertions = null;
74 
78  private $linkDeletions = null;
79 
83  private $user;
84 
93  function __construct( Title $title, ParserOutput $parserOutput, $recursive = true ) {
94  parent::__construct( false ); // no implicit transaction
95 
96  $this->mTitle = $title;
97  $this->mId = $title->getArticleID( Title::GAID_FOR_UPDATE );
98 
99  if ( !$this->mId ) {
100  throw new InvalidArgumentException(
101  "The Title object yields no ID. Perhaps the page doesn't exist?"
102  );
103  }
104 
105  $this->mParserOutput = $parserOutput;
106 
107  $this->mLinks = $parserOutput->getLinks();
108  $this->mImages = $parserOutput->getImages();
109  $this->mTemplates = $parserOutput->getTemplates();
110  $this->mExternals = $parserOutput->getExternalLinks();
111  $this->mCategories = $parserOutput->getCategories();
112  $this->mProperties = $parserOutput->getProperties();
113  $this->mInterwikis = $parserOutput->getInterwikiLinks();
114 
115  # Convert the format of the interlanguage links
116  # I didn't want to change it in the ParserOutput, because that array is passed all
117  # the way back to the skin, so either a skin API break would be required, or an
118  # inefficient back-conversion.
119  $ill = $parserOutput->getLanguageLinks();
120  $this->mInterlangs = [];
121  foreach ( $ill as $link ) {
122  list( $key, $title ) = explode( ':', $link, 2 );
123  $this->mInterlangs[$key] = $title;
124  }
125 
126  foreach ( $this->mCategories as &$sortkey ) {
127  # If the sortkey is longer then 255 bytes,
128  # it truncated by DB, and then doesn't get
129  # matched when comparing existing vs current
130  # categories, causing bug 25254.
131  # Also. substr behaves weird when given "".
132  if ( $sortkey !== '' ) {
133  $sortkey = substr( $sortkey, 0, 255 );
134  }
135  }
136 
137  $this->mRecursive = $recursive;
138 
139  Hooks::run( 'LinksUpdateConstructed', [ &$this ] );
140  }
141 
145  public function doUpdate() {
146  Hooks::run( 'LinksUpdate', [ &$this ] );
147  $this->doIncrementalUpdate();
148 
149  $this->mDb->onTransactionIdle( function() {
150  Hooks::run( 'LinksUpdateComplete', [ &$this ] );
151  } );
152  }
153 
154  protected function doIncrementalUpdate() {
155  # Page links
156  $existing = $this->getExistingLinks();
157  $this->linkDeletions = $this->getLinkDeletions( $existing );
158  $this->linkInsertions = $this->getLinkInsertions( $existing );
159  $this->incrTableUpdate( 'pagelinks', 'pl', $this->linkDeletions, $this->linkInsertions );
160 
161  # Image links
162  $existing = $this->getExistingImages();
163 
164  $imageDeletes = $this->getImageDeletions( $existing );
165  $this->incrTableUpdate( 'imagelinks', 'il', $imageDeletes,
166  $this->getImageInsertions( $existing ) );
167 
168  # Invalidate all image description pages which had links added or removed
169  $imageUpdates = $imageDeletes + array_diff_key( $this->mImages, $existing );
170  $this->invalidateImageDescriptions( $imageUpdates );
171 
172  # External links
173  $existing = $this->getExistingExternals();
174  $this->incrTableUpdate( 'externallinks', 'el', $this->getExternalDeletions( $existing ),
175  $this->getExternalInsertions( $existing ) );
176 
177  # Language links
178  $existing = $this->getExistingInterlangs();
179  $this->incrTableUpdate( 'langlinks', 'll', $this->getInterlangDeletions( $existing ),
180  $this->getInterlangInsertions( $existing ) );
181 
182  # Inline interwiki links
183  $existing = $this->getExistingInterwikis();
184  $this->incrTableUpdate( 'iwlinks', 'iwl', $this->getInterwikiDeletions( $existing ),
185  $this->getInterwikiInsertions( $existing ) );
186 
187  # Template links
188  $existing = $this->getExistingTemplates();
189  $this->incrTableUpdate( 'templatelinks', 'tl', $this->getTemplateDeletions( $existing ),
190  $this->getTemplateInsertions( $existing ) );
191 
192  # Category links
193  $existing = $this->getExistingCategories();
194 
195  $categoryDeletes = $this->getCategoryDeletions( $existing );
196 
197  $this->incrTableUpdate( 'categorylinks', 'cl', $categoryDeletes,
198  $this->getCategoryInsertions( $existing ) );
199 
200  # Invalidate all categories which were added, deleted or changed (set symmetric difference)
201  $categoryInserts = array_diff_assoc( $this->mCategories, $existing );
202  $categoryUpdates = $categoryInserts + $categoryDeletes;
203  $this->invalidateCategories( $categoryUpdates );
204  $this->updateCategoryCounts( $categoryInserts, $categoryDeletes );
205 
206  # Page properties
207  $existing = $this->getExistingProperties();
208 
209  $propertiesDeletes = $this->getPropertyDeletions( $existing );
210 
211  $this->incrTableUpdate( 'page_props', 'pp', $propertiesDeletes,
212  $this->getPropertyInsertions( $existing ) );
213 
214  # Invalidate the necessary pages
215  $changed = $propertiesDeletes + array_diff_assoc( $this->mProperties, $existing );
216  $this->invalidateProperties( $changed );
217 
218  # Update the links table freshness for this title
219  $this->updateLinksTimestamp();
220 
221  # Refresh links of all pages including this page
222  # This will be in a separate transaction
223  if ( $this->mRecursive ) {
224  $this->queueRecursiveJobs();
225  }
226 
227  }
228 
235  protected function queueRecursiveJobs() {
236  self::queueRecursiveJobsForTable( $this->mTitle, 'templatelinks' );
237  if ( $this->mTitle->getNamespace() == NS_FILE ) {
238  // Process imagelinks in case the title is or was a redirect
239  self::queueRecursiveJobsForTable( $this->mTitle, 'imagelinks' );
240  }
241 
242  $bc = $this->mTitle->getBacklinkCache();
243  // Get jobs for cascade-protected backlinks for a high priority queue.
244  // If meta-templates change to using a new template, the new template
245  // should be implicitly protected as soon as possible, if applicable.
246  // These jobs duplicate a subset of the above ones, but can run sooner.
247  // Which ever runs first generally no-ops the other one.
248  $jobs = [];
249  foreach ( $bc->getCascadeProtectedLinks() as $title ) {
250  $jobs[] = RefreshLinksJob::newPrioritized( $title, [] );
251  }
252  JobQueueGroup::singleton()->push( $jobs );
253  }
254 
261  public static function queueRecursiveJobsForTable( Title $title, $table ) {
262  if ( $title->getBacklinkCache()->hasLinks( $table ) ) {
263  $job = new RefreshLinksJob(
264  $title,
265  [
266  'table' => $table,
267  'recursive' => true,
268  ] + Job::newRootJobParams( // "overall" refresh links job info
269  "refreshlinks:{$table}:{$title->getPrefixedText()}"
270  )
271  );
272 
273  JobQueueGroup::singleton()->push( $job );
274  }
275  }
276 
280  function invalidateCategories( $cats ) {
281  $this->invalidatePages( NS_CATEGORY, array_keys( $cats ) );
282  }
283 
289  function updateCategoryCounts( $added, $deleted ) {
290  $a = WikiPage::factory( $this->mTitle );
291  $a->updateCategoryCounts(
292  array_keys( $added ), array_keys( $deleted )
293  );
294  }
295 
299  function invalidateImageDescriptions( $images ) {
300  $this->invalidatePages( NS_FILE, array_keys( $images ) );
301  }
302 
310  function incrTableUpdate( $table, $prefix, $deletions, $insertions ) {
311  if ( $table == 'page_props' ) {
312  $fromField = 'pp_page';
313  } else {
314  $fromField = "{$prefix}_from";
315  }
316  $where = [ $fromField => $this->mId ];
317  if ( $table == 'pagelinks' || $table == 'templatelinks' || $table == 'iwlinks' ) {
318  if ( $table == 'iwlinks' ) {
319  $baseKey = 'iwl_prefix';
320  } else {
321  $baseKey = "{$prefix}_namespace";
322  }
323  $clause = $this->mDb->makeWhereFrom2d( $deletions, $baseKey, "{$prefix}_title" );
324  if ( $clause ) {
325  $where[] = $clause;
326  } else {
327  $where = false;
328  }
329  } else {
330  if ( $table == 'langlinks' ) {
331  $toField = 'll_lang';
332  } elseif ( $table == 'page_props' ) {
333  $toField = 'pp_propname';
334  } else {
335  $toField = $prefix . '_to';
336  }
337  if ( count( $deletions ) ) {
338  $where[$toField] = array_keys( $deletions );
339  } else {
340  $where = false;
341  }
342  }
343  if ( $where ) {
344  $this->mDb->delete( $table, $where, __METHOD__ );
345  }
346  if ( count( $insertions ) ) {
347  $this->mDb->insert( $table, $insertions, __METHOD__, 'IGNORE' );
348  Hooks::run( 'LinksUpdateAfterInsert', [ $this, $table, $insertions ] );
349  }
350  }
351 
358  private function getLinkInsertions( $existing = [] ) {
359  $arr = [];
360  foreach ( $this->mLinks as $ns => $dbkeys ) {
361  $diffs = isset( $existing[$ns] )
362  ? array_diff_key( $dbkeys, $existing[$ns] )
363  : $dbkeys;
364  foreach ( $diffs as $dbk => $id ) {
365  $arr[] = [
366  'pl_from' => $this->mId,
367  'pl_from_namespace' => $this->mTitle->getNamespace(),
368  'pl_namespace' => $ns,
369  'pl_title' => $dbk
370  ];
371  }
372  }
373 
374  return $arr;
375  }
376 
382  private function getTemplateInsertions( $existing = [] ) {
383  $arr = [];
384  foreach ( $this->mTemplates as $ns => $dbkeys ) {
385  $diffs = isset( $existing[$ns] ) ? array_diff_key( $dbkeys, $existing[$ns] ) : $dbkeys;
386  foreach ( $diffs as $dbk => $id ) {
387  $arr[] = [
388  'tl_from' => $this->mId,
389  'tl_from_namespace' => $this->mTitle->getNamespace(),
390  'tl_namespace' => $ns,
391  'tl_title' => $dbk
392  ];
393  }
394  }
395 
396  return $arr;
397  }
398 
405  private function getImageInsertions( $existing = [] ) {
406  $arr = [];
407  $diffs = array_diff_key( $this->mImages, $existing );
408  foreach ( $diffs as $iname => $dummy ) {
409  $arr[] = [
410  'il_from' => $this->mId,
411  'il_from_namespace' => $this->mTitle->getNamespace(),
412  'il_to' => $iname
413  ];
414  }
415 
416  return $arr;
417  }
418 
424  private function getExternalInsertions( $existing = [] ) {
425  $arr = [];
426  $diffs = array_diff_key( $this->mExternals, $existing );
427  foreach ( $diffs as $url => $dummy ) {
428  foreach ( wfMakeUrlIndexes( $url ) as $index ) {
429  $arr[] = [
430  'el_id' => $this->mDb->nextSequenceValue( 'externallinks_el_id_seq' ),
431  'el_from' => $this->mId,
432  'el_to' => $url,
433  'el_index' => $index,
434  ];
435  }
436  }
437 
438  return $arr;
439  }
440 
449  private function getCategoryInsertions( $existing = [] ) {
450  global $wgContLang, $wgCategoryCollation;
451  $diffs = array_diff_assoc( $this->mCategories, $existing );
452  $arr = [];
453  foreach ( $diffs as $name => $prefix ) {
455  $wgContLang->findVariantLink( $name, $nt, true );
456 
457  if ( $this->mTitle->getNamespace() == NS_CATEGORY ) {
458  $type = 'subcat';
459  } elseif ( $this->mTitle->getNamespace() == NS_FILE ) {
460  $type = 'file';
461  } else {
462  $type = 'page';
463  }
464 
465  # Treat custom sortkeys as a prefix, so that if multiple
466  # things are forced to sort as '*' or something, they'll
467  # sort properly in the category rather than in page_id
468  # order or such.
469  $sortkey = Collation::singleton()->getSortKey(
470  $this->mTitle->getCategorySortkey( $prefix ) );
471 
472  $arr[] = [
473  'cl_from' => $this->mId,
474  'cl_to' => $name,
475  'cl_sortkey' => $sortkey,
476  'cl_timestamp' => $this->mDb->timestamp(),
477  'cl_sortkey_prefix' => $prefix,
478  'cl_collation' => $wgCategoryCollation,
479  'cl_type' => $type,
480  ];
481  }
482 
483  return $arr;
484  }
485 
493  private function getInterlangInsertions( $existing = [] ) {
494  $diffs = array_diff_assoc( $this->mInterlangs, $existing );
495  $arr = [];
496  foreach ( $diffs as $lang => $title ) {
497  $arr[] = [
498  'll_from' => $this->mId,
499  'll_lang' => $lang,
500  'll_title' => $title
501  ];
502  }
503 
504  return $arr;
505  }
506 
512  function getPropertyInsertions( $existing = [] ) {
513  $diffs = array_diff_assoc( $this->mProperties, $existing );
514 
515  $arr = [];
516  foreach ( array_keys( $diffs ) as $name ) {
517  $arr[] = $this->getPagePropRowData( $name );
518  }
519 
520  return $arr;
521  }
522 
539  private function getPagePropRowData( $prop ) {
540  global $wgPagePropsHaveSortkey;
541 
542  $value = $this->mProperties[$prop];
543 
544  $row = [
545  'pp_page' => $this->mId,
546  'pp_propname' => $prop,
547  'pp_value' => $value,
548  ];
549 
550  if ( $wgPagePropsHaveSortkey ) {
551  $row['pp_sortkey'] = $this->getPropertySortKeyValue( $value );
552  }
553 
554  return $row;
555  }
556 
569  private function getPropertySortKeyValue( $value ) {
570  if ( is_int( $value ) || is_float( $value ) || is_bool( $value ) ) {
571  return floatval( $value );
572  }
573 
574  return null;
575  }
576 
583  private function getInterwikiInsertions( $existing = [] ) {
584  $arr = [];
585  foreach ( $this->mInterwikis as $prefix => $dbkeys ) {
586  $diffs = isset( $existing[$prefix] )
587  ? array_diff_key( $dbkeys, $existing[$prefix] )
588  : $dbkeys;
589 
590  foreach ( $diffs as $dbk => $id ) {
591  $arr[] = [
592  'iwl_from' => $this->mId,
593  'iwl_prefix' => $prefix,
594  'iwl_title' => $dbk
595  ];
596  }
597  }
598 
599  return $arr;
600  }
601 
608  private function getLinkDeletions( $existing ) {
609  $del = [];
610  foreach ( $existing as $ns => $dbkeys ) {
611  if ( isset( $this->mLinks[$ns] ) ) {
612  $del[$ns] = array_diff_key( $existing[$ns], $this->mLinks[$ns] );
613  } else {
614  $del[$ns] = $existing[$ns];
615  }
616  }
617 
618  return $del;
619  }
620 
627  private function getTemplateDeletions( $existing ) {
628  $del = [];
629  foreach ( $existing as $ns => $dbkeys ) {
630  if ( isset( $this->mTemplates[$ns] ) ) {
631  $del[$ns] = array_diff_key( $existing[$ns], $this->mTemplates[$ns] );
632  } else {
633  $del[$ns] = $existing[$ns];
634  }
635  }
636 
637  return $del;
638  }
639 
646  private function getImageDeletions( $existing ) {
647  return array_diff_key( $existing, $this->mImages );
648  }
649 
656  private function getExternalDeletions( $existing ) {
657  return array_diff_key( $existing, $this->mExternals );
658  }
659 
666  private function getCategoryDeletions( $existing ) {
667  return array_diff_assoc( $existing, $this->mCategories );
668  }
669 
676  private function getInterlangDeletions( $existing ) {
677  return array_diff_assoc( $existing, $this->mInterlangs );
678  }
679 
685  function getPropertyDeletions( $existing ) {
686  return array_diff_assoc( $existing, $this->mProperties );
687  }
688 
695  private function getInterwikiDeletions( $existing ) {
696  $del = [];
697  foreach ( $existing as $prefix => $dbkeys ) {
698  if ( isset( $this->mInterwikis[$prefix] ) ) {
699  $del[$prefix] = array_diff_key( $existing[$prefix], $this->mInterwikis[$prefix] );
700  } else {
701  $del[$prefix] = $existing[$prefix];
702  }
703  }
704 
705  return $del;
706  }
707 
713  private function getExistingLinks() {
714  $res = $this->mDb->select( 'pagelinks', [ 'pl_namespace', 'pl_title' ],
715  [ 'pl_from' => $this->mId ], __METHOD__, $this->mOptions );
716  $arr = [];
717  foreach ( $res as $row ) {
718  if ( !isset( $arr[$row->pl_namespace] ) ) {
719  $arr[$row->pl_namespace] = [];
720  }
721  $arr[$row->pl_namespace][$row->pl_title] = 1;
722  }
723 
724  return $arr;
725  }
726 
732  private function getExistingTemplates() {
733  $res = $this->mDb->select( 'templatelinks', [ 'tl_namespace', 'tl_title' ],
734  [ 'tl_from' => $this->mId ], __METHOD__, $this->mOptions );
735  $arr = [];
736  foreach ( $res as $row ) {
737  if ( !isset( $arr[$row->tl_namespace] ) ) {
738  $arr[$row->tl_namespace] = [];
739  }
740  $arr[$row->tl_namespace][$row->tl_title] = 1;
741  }
742 
743  return $arr;
744  }
745 
751  private function getExistingImages() {
752  $res = $this->mDb->select( 'imagelinks', [ 'il_to' ],
753  [ 'il_from' => $this->mId ], __METHOD__, $this->mOptions );
754  $arr = [];
755  foreach ( $res as $row ) {
756  $arr[$row->il_to] = 1;
757  }
758 
759  return $arr;
760  }
761 
767  private function getExistingExternals() {
768  $res = $this->mDb->select( 'externallinks', [ 'el_to' ],
769  [ 'el_from' => $this->mId ], __METHOD__, $this->mOptions );
770  $arr = [];
771  foreach ( $res as $row ) {
772  $arr[$row->el_to] = 1;
773  }
774 
775  return $arr;
776  }
777 
783  private function getExistingCategories() {
784  $res = $this->mDb->select( 'categorylinks', [ 'cl_to', 'cl_sortkey_prefix' ],
785  [ 'cl_from' => $this->mId ], __METHOD__, $this->mOptions );
786  $arr = [];
787  foreach ( $res as $row ) {
788  $arr[$row->cl_to] = $row->cl_sortkey_prefix;
789  }
790 
791  return $arr;
792  }
793 
800  private function getExistingInterlangs() {
801  $res = $this->mDb->select( 'langlinks', [ 'll_lang', 'll_title' ],
802  [ 'll_from' => $this->mId ], __METHOD__, $this->mOptions );
803  $arr = [];
804  foreach ( $res as $row ) {
805  $arr[$row->ll_lang] = $row->ll_title;
806  }
807 
808  return $arr;
809  }
810 
815  protected function getExistingInterwikis() {
816  $res = $this->mDb->select( 'iwlinks', [ 'iwl_prefix', 'iwl_title' ],
817  [ 'iwl_from' => $this->mId ], __METHOD__, $this->mOptions );
818  $arr = [];
819  foreach ( $res as $row ) {
820  if ( !isset( $arr[$row->iwl_prefix] ) ) {
821  $arr[$row->iwl_prefix] = [];
822  }
823  $arr[$row->iwl_prefix][$row->iwl_title] = 1;
824  }
825 
826  return $arr;
827  }
828 
834  private function getExistingProperties() {
835  $res = $this->mDb->select( 'page_props', [ 'pp_propname', 'pp_value' ],
836  [ 'pp_page' => $this->mId ], __METHOD__, $this->mOptions );
837  $arr = [];
838  foreach ( $res as $row ) {
839  $arr[$row->pp_propname] = $row->pp_value;
840  }
841 
842  return $arr;
843  }
844 
849  public function getTitle() {
850  return $this->mTitle;
851  }
852 
858  public function getParserOutput() {
859  return $this->mParserOutput;
860  }
861 
866  public function getImages() {
867  return $this->mImages;
868  }
869 
877  public function setRevision( Revision $revision ) {
878  $this->mRevision = $revision;
879  }
880 
887  public function setTriggeringUser( User $user ) {
888  $this->user = $user;
889  }
890 
895  public function getTriggeringUser() {
896  return $this->user;
897  }
898 
903  private function invalidateProperties( $changed ) {
904  global $wgPagePropLinkInvalidations;
905 
906  foreach ( $changed as $name => $value ) {
907  if ( isset( $wgPagePropLinkInvalidations[$name] ) ) {
908  $inv = $wgPagePropLinkInvalidations[$name];
909  if ( !is_array( $inv ) ) {
910  $inv = [ $inv ];
911  }
912  foreach ( $inv as $table ) {
913  DeferredUpdates::addUpdate( new HTMLCacheUpdate( $this->mTitle, $table ) );
914  }
915  }
916  }
917  }
918 
924  public function getAddedLinks() {
925  if ( $this->linkInsertions === null ) {
926  return null;
927  }
928  $result = [];
929  foreach ( $this->linkInsertions as $insertion ) {
930  $result[] = Title::makeTitle( $insertion['pl_namespace'], $insertion['pl_title'] );
931  }
932 
933  return $result;
934  }
935 
941  public function getRemovedLinks() {
942  if ( $this->linkDeletions === null ) {
943  return null;
944  }
945  $result = [];
946  foreach ( $this->linkDeletions as $ns => $titles ) {
947  foreach ( $titles as $title => $unused ) {
948  $result[] = Title::makeTitle( $ns, $title );
949  }
950  }
951 
952  return $result;
953  }
954 
958  protected function updateLinksTimestamp() {
959  if ( $this->mId ) {
960  // The link updates made here only reflect the freshness of the parser output
961  $timestamp = $this->mParserOutput->getCacheTime();
962  $this->mDb->update( 'page',
963  [ 'page_links_updated' => $this->mDb->timestamp( $timestamp ) ],
964  [ 'page_id' => $this->mId ],
965  __METHOD__
966  );
967  }
968  }
969 
970  public function getAsJobSpecification() {
971  if ( $this->user ) {
972  $userInfo = [
973  'userId' => $this->user->getId(),
974  'userName' => $this->user->getName(),
975  ];
976  } else {
977  $userInfo = false;
978  }
979 
980  if ( $this->mRevision ) {
981  $triggeringRevisionId = $this->mRevision->getId();
982  } else {
983  $triggeringRevisionId = false;
984  }
985 
986  return [
987  'wiki' => $this->mDb->getWikiID(),
988  'job' => new JobSpecification(
989  'refreshLinksPrioritized',
990  [
991  // Reuse the parser cache if it was saved
992  'rootJobTimestamp' => $this->mParserOutput->getCacheTime(),
993  'useRecursiveLinksUpdate' => $this->mRecursive,
994  'triggeringUser' => $userInfo,
995  'triggeringRevisionId' => $triggeringRevisionId,
996  ],
997  [ 'removeDuplicates' => true ],
998  $this->getTitle()
999  )
1000  ];
1001  }
1002 }
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:99
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
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...
magic word the default is to use $key to get the and $key value or $key value text $key value html to format the value $key
Definition: hooks.txt:2321
bool $mRecursive
Whether to queue jobs for recursive updates.
Definition: LinksUpdate.php:65
getArticleID($flags=0)
Get the article ID for this Title from the link cache, adding it if necessary.
Definition: Title.php:3187
getPropertySortKeyValue($value)
Determines the sort key for the given property value.
See docs/deferred.txt.
Definition: LinksUpdate.php:28
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:62
static singleton()
Definition: Collation.php:34
if(!isset($args[0])) $lang
Interface that marks a DataUpdate as enqueuable via the JobQueue.
Definition: DataUpdate.php:156
$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.
Revision $mRevision
Revision for which this update has been triggered.
Definition: LinksUpdate.php:68
null array $linkInsertions
Added links if calculated.
Definition: LinksUpdate.php:73
Represents a title within MediaWiki.
Definition: Title.php:34
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:35
getBacklinkCache()
Get a backlink cache object.
Definition: Title.php:4591
__construct(Title $title, ParserOutput $parserOutput, $recursive=true)
Constructor.
Definition: LinksUpdate.php:93
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':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:1796
ParserOutput $mParserOutput
Definition: LinksUpdate.php:38
the value to return A Title object or null for latest to be modified or replaced by the hook handler or if authentication is not possible after cache objects are set for highlighting & $link
Definition: hooks.txt:2581
getTemplateDeletions($existing)
Given an array of existing templates, returns those templates which are not in $this and thus should ...
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:1798
getPropertyInsertions($existing=[])
Get an array of page property insertions.
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:44
invalidatePages($namespace, array $dbkeys)
Invalidate the cache of a list of pages from a single namespace.
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:1004
$res
Definition: database.txt:21
const GAID_FOR_UPDATE
Used to be GAID_FOR_UPDATE define.
Definition: Title.php:49
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:83
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:50
static makeTitleSafe($ns, $title, $fragment= '', $interwiki= '')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:548
array $mTemplates
Map of title strings to IDs for the template references, including broken ones.
Definition: LinksUpdate.php:47
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:912
static addUpdate(DeferrableUpdate $update, $type=self::POSTSEND)
Add an update to the deferred list.
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:75
getInterlangInsertions($existing=[])
Get an array of interlanguage link insertions.
getTemplateInsertions($existing=[])
Get an array of template insertions.
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
Abstract base class for update jobs that put some secondary data extracted from article content into ...
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:83
array $mLinks
Map of title strings to IDs for the links in the document.
Definition: LinksUpdate.php:41
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...
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
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:78
getImages()
Return the list of images used as generated by the parser.
array $mInterlangs
Map of language codes to titles.
Definition: LinksUpdate.php:56
getAsJobSpecification()
int $mId
Page ID of the article linked from.
Definition: LinksUpdate.php:32
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:53
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:2338
static & makeTitle($ns, $title, $fragment= '', $interwiki= '')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:524
array $mInterwikis
2-D map of (prefix => DBK => 1)
Definition: LinksUpdate.php:59
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:310