MediaWiki  master
WatchedItemStore.php
Go to the documentation of this file.
1 <?php
2 
12 
22 
26  private $lbFactory;
27 
31  private $loadBalancer;
32 
36  private $queueGroup;
37 
41  private $stash;
42 
46  private $readOnlyMode;
47 
51  private $cache;
52 
57 
64  private $cacheIndex = [];
65 
70 
75 
79  private $nsInfo;
80 
84  private $revisionLookup;
85 
89  private $stats;
90 
101  public function __construct(
110  ) {
111  $this->lbFactory = $lbFactory;
112  $this->loadBalancer = $lbFactory->getMainLB();
113  $this->queueGroup = $queueGroup;
114  $this->stash = $stash;
115  $this->cache = $cache;
116  $this->readOnlyMode = $readOnlyMode;
117  $this->stats = new NullStatsdDataFactory();
118  $this->deferredUpdatesAddCallableUpdateCallback =
119  [ DeferredUpdates::class, 'addCallableUpdate' ];
120  $this->updateRowsPerQuery = $updateRowsPerQuery;
121  $this->nsInfo = $nsInfo;
122  $this->revisionLookup = $revisionLookup;
123 
124  $this->latestUpdateCache = new HashBagOStuff( [ 'maxKeys' => 3 ] );
125  }
126 
130  public function setStatsdDataFactory( StatsdDataFactoryInterface $stats ) {
131  $this->stats = $stats;
132  }
133 
145  public function overrideDeferredUpdatesAddCallableUpdateCallback( callable $callback ) {
146  if ( !defined( 'MW_PHPUNIT_TEST' ) ) {
147  throw new MWException(
148  'Cannot override DeferredUpdates::addCallableUpdate callback in operation.'
149  );
150  }
152  $this->deferredUpdatesAddCallableUpdateCallback = $callback;
153  return new ScopedCallback( function () use ( $previousValue ) {
154  $this->deferredUpdatesAddCallableUpdateCallback = $previousValue;
155  } );
156  }
157 
158  private function getCacheKey( UserIdentity $user, LinkTarget $target ) {
159  return $this->cache->makeKey(
160  (string)$target->getNamespace(),
161  $target->getDBkey(),
162  (string)$user->getId()
163  );
164  }
165 
166  private function cache( WatchedItem $item ) {
167  $user = $item->getUserIdentity();
168  $target = $item->getLinkTarget();
169  $key = $this->getCacheKey( $user, $target );
170  $this->cache->set( $key, $item );
171  $this->cacheIndex[$target->getNamespace()][$target->getDBkey()][$user->getId()] = $key;
172  $this->stats->increment( 'WatchedItemStore.cache' );
173  }
174 
175  private function uncache( UserIdentity $user, LinkTarget $target ) {
176  $this->cache->delete( $this->getCacheKey( $user, $target ) );
177  unset( $this->cacheIndex[$target->getNamespace()][$target->getDBkey()][$user->getId()] );
178  $this->stats->increment( 'WatchedItemStore.uncache' );
179  }
180 
181  private function uncacheLinkTarget( LinkTarget $target ) {
182  $this->stats->increment( 'WatchedItemStore.uncacheLinkTarget' );
183  if ( !isset( $this->cacheIndex[$target->getNamespace()][$target->getDBkey()] ) ) {
184  return;
185  }
186  foreach ( $this->cacheIndex[$target->getNamespace()][$target->getDBkey()] as $key ) {
187  $this->stats->increment( 'WatchedItemStore.uncacheLinkTarget.items' );
188  $this->cache->delete( $key );
189  }
190  }
191 
192  private function uncacheUser( UserIdentity $user ) {
193  $this->stats->increment( 'WatchedItemStore.uncacheUser' );
194  foreach ( $this->cacheIndex as $ns => $dbKeyArray ) {
195  foreach ( $dbKeyArray as $dbKey => $userArray ) {
196  if ( isset( $userArray[$user->getId()] ) ) {
197  $this->stats->increment( 'WatchedItemStore.uncacheUser.items' );
198  $this->cache->delete( $userArray[$user->getId()] );
199  }
200  }
201  }
202 
203  $pageSeenKey = $this->getPageSeenTimestampsKey( $user );
204  $this->latestUpdateCache->delete( $pageSeenKey );
205  $this->stash->delete( $pageSeenKey );
206  }
207 
214  private function getCached( UserIdentity $user, LinkTarget $target ) {
215  return $this->cache->get( $this->getCacheKey( $user, $target ) );
216  }
217 
227  private function dbCond( UserIdentity $user, LinkTarget $target ) {
228  return [
229  'wl_user' => $user->getId(),
230  'wl_namespace' => $target->getNamespace(),
231  'wl_title' => $target->getDBkey(),
232  ];
233  }
234 
241  private function getConnectionRef( $dbIndex ) {
242  return $this->loadBalancer->getConnectionRef( $dbIndex, [ 'watchlist' ] );
243  }
244 
256  if ( $this->countWatchedItems( $user ) > $this->updateRowsPerQuery ) {
257  return false;
258  }
259 
260  $dbw = $this->loadBalancer->getConnectionRef( DB_MASTER );
261  $dbw->delete(
262  'watchlist',
263  [ 'wl_user' => $user->getId() ],
264  __METHOD__
265  );
266  $this->uncacheAllItemsForUser( $user );
267 
268  return true;
269  }
270 
272  $userId = $user->getId();
273  foreach ( $this->cacheIndex as $ns => $dbKeyIndex ) {
274  foreach ( $dbKeyIndex as $dbKey => $userIndex ) {
275  if ( array_key_exists( $userId, $userIndex ) ) {
276  $this->cache->delete( $userIndex[$userId] );
277  unset( $this->cacheIndex[$ns][$dbKey][$userId] );
278  }
279  }
280  }
281 
282  // Cleanup empty cache keys
283  foreach ( $this->cacheIndex as $ns => $dbKeyIndex ) {
284  foreach ( $dbKeyIndex as $dbKey => $userIndex ) {
285  if ( empty( $this->cacheIndex[$ns][$dbKey] ) ) {
286  unset( $this->cacheIndex[$ns][$dbKey] );
287  }
288  }
289  if ( empty( $this->cacheIndex[$ns] ) ) {
290  unset( $this->cacheIndex[$ns] );
291  }
292  }
293  }
294 
303  $job = ClearUserWatchlistJob::newForUser( $user, $this->getMaxId() );
304  $this->queueGroup->push( $job );
305  }
306 
311  public function getMaxId() {
312  $dbr = $this->getConnectionRef( DB_REPLICA );
313  return (int)$dbr->selectField(
314  'watchlist',
315  'MAX(wl_id)',
316  '',
317  __METHOD__
318  );
319  }
320 
326  public function countWatchedItems( UserIdentity $user ) {
327  $dbr = $this->getConnectionRef( DB_REPLICA );
328  $return = (int)$dbr->selectField(
329  'watchlist',
330  'COUNT(*)',
331  [
332  'wl_user' => $user->getId()
333  ],
334  __METHOD__
335  );
336 
337  return $return;
338  }
339 
345  public function countWatchers( LinkTarget $target ) {
346  $dbr = $this->getConnectionRef( DB_REPLICA );
347  $return = (int)$dbr->selectField(
348  'watchlist',
349  'COUNT(*)',
350  [
351  'wl_namespace' => $target->getNamespace(),
352  'wl_title' => $target->getDBkey(),
353  ],
354  __METHOD__
355  );
356 
357  return $return;
358  }
359 
366  public function countVisitingWatchers( LinkTarget $target, $threshold ) {
367  $dbr = $this->getConnectionRef( DB_REPLICA );
368  $visitingWatchers = (int)$dbr->selectField(
369  'watchlist',
370  'COUNT(*)',
371  [
372  'wl_namespace' => $target->getNamespace(),
373  'wl_title' => $target->getDBkey(),
374  'wl_notificationtimestamp >= ' .
375  $dbr->addQuotes( $dbr->timestamp( $threshold ) ) .
376  ' OR wl_notificationtimestamp IS NULL'
377  ],
378  __METHOD__
379  );
380 
381  return $visitingWatchers;
382  }
383 
390  public function removeWatchBatchForUser( UserIdentity $user, array $titles ) {
391  if ( $this->readOnlyMode->isReadOnly() ) {
392  return false;
393  }
394  if ( !$user->isRegistered() ) {
395  return false;
396  }
397  if ( !$titles ) {
398  return true;
399  }
400 
401  $rows = $this->getTitleDbKeysGroupedByNamespace( $titles );
402  $this->uncacheTitlesForUser( $user, $titles );
403 
404  $dbw = $this->getConnectionRef( DB_MASTER );
405  $ticket = count( $titles ) > $this->updateRowsPerQuery ?
406  $this->lbFactory->getEmptyTransactionTicket( __METHOD__ ) : null;
407  $affectedRows = 0;
408 
409  // Batch delete items per namespace.
410  foreach ( $rows as $namespace => $namespaceTitles ) {
411  $rowBatches = array_chunk( $namespaceTitles, $this->updateRowsPerQuery );
412  foreach ( $rowBatches as $toDelete ) {
413  $dbw->delete( 'watchlist', [
414  'wl_user' => $user->getId(),
415  'wl_namespace' => $namespace,
416  'wl_title' => $toDelete
417  ], __METHOD__ );
418  $affectedRows += $dbw->affectedRows();
419  if ( $ticket ) {
420  $this->lbFactory->commitAndWaitForReplication( __METHOD__, $ticket );
421  }
422  }
423  }
424 
425  return (bool)$affectedRows;
426  }
427 
434  public function countWatchersMultiple( array $targets, array $options = [] ) {
435  $dbOptions = [ 'GROUP BY' => [ 'wl_namespace', 'wl_title' ] ];
436 
437  $dbr = $this->getConnectionRef( DB_REPLICA );
438 
439  if ( array_key_exists( 'minimumWatchers', $options ) ) {
440  $dbOptions['HAVING'] = 'COUNT(*) >= ' . (int)$options['minimumWatchers'];
441  }
442 
443  $lb = new LinkBatch( $targets );
444  $res = $dbr->select(
445  'watchlist',
446  [ 'wl_title', 'wl_namespace', 'watchers' => 'COUNT(*)' ],
447  [ $lb->constructSet( 'wl', $dbr ) ],
448  __METHOD__,
449  $dbOptions
450  );
451 
452  $watchCounts = [];
453  foreach ( $targets as $linkTarget ) {
454  $watchCounts[$linkTarget->getNamespace()][$linkTarget->getDBkey()] = 0;
455  }
456 
457  foreach ( $res as $row ) {
458  $watchCounts[$row->wl_namespace][$row->wl_title] = (int)$row->watchers;
459  }
460 
461  return $watchCounts;
462  }
463 
471  array $targetsWithVisitThresholds,
472  $minimumWatchers = null
473  ) {
474  if ( $targetsWithVisitThresholds === [] ) {
475  // No titles requested => no results returned
476  return [];
477  }
478 
479  $dbr = $this->getConnectionRef( DB_REPLICA );
480 
481  $conds = $this->getVisitingWatchersCondition( $dbr, $targetsWithVisitThresholds );
482 
483  $dbOptions = [ 'GROUP BY' => [ 'wl_namespace', 'wl_title' ] ];
484  if ( $minimumWatchers !== null ) {
485  $dbOptions['HAVING'] = 'COUNT(*) >= ' . (int)$minimumWatchers;
486  }
487  $res = $dbr->select(
488  'watchlist',
489  [ 'wl_namespace', 'wl_title', 'watchers' => 'COUNT(*)' ],
490  $conds,
491  __METHOD__,
492  $dbOptions
493  );
494 
495  $watcherCounts = [];
496  foreach ( $targetsWithVisitThresholds as list( $target ) ) {
497  /* @var LinkTarget $target */
498  $watcherCounts[$target->getNamespace()][$target->getDBkey()] = 0;
499  }
500 
501  foreach ( $res as $row ) {
502  $watcherCounts[$row->wl_namespace][$row->wl_title] = (int)$row->watchers;
503  }
504 
505  return $watcherCounts;
506  }
507 
516  IDatabase $db,
517  array $targetsWithVisitThresholds
518  ) {
519  $missingTargets = [];
520  $namespaceConds = [];
521  foreach ( $targetsWithVisitThresholds as list( $target, $threshold ) ) {
522  if ( $threshold === null ) {
523  $missingTargets[] = $target;
524  continue;
525  }
526  /* @var LinkTarget $target */
527  $namespaceConds[$target->getNamespace()][] = $db->makeList( [
528  'wl_title = ' . $db->addQuotes( $target->getDBkey() ),
529  $db->makeList( [
530  'wl_notificationtimestamp >= ' . $db->addQuotes( $db->timestamp( $threshold ) ),
531  'wl_notificationtimestamp IS NULL'
532  ], LIST_OR )
533  ], LIST_AND );
534  }
535 
536  $conds = [];
537  foreach ( $namespaceConds as $namespace => $pageConds ) {
538  $conds[] = $db->makeList( [
539  'wl_namespace = ' . $namespace,
540  '(' . $db->makeList( $pageConds, LIST_OR ) . ')'
541  ], LIST_AND );
542  }
543 
544  if ( $missingTargets ) {
545  $lb = new LinkBatch( $missingTargets );
546  $conds[] = $lb->constructSet( 'wl', $db );
547  }
548 
549  return $db->makeList( $conds, LIST_OR );
550  }
551 
558  public function getWatchedItem( UserIdentity $user, LinkTarget $target ) {
559  if ( !$user->isRegistered() ) {
560  return false;
561  }
562 
563  $cached = $this->getCached( $user, $target );
564  if ( $cached ) {
565  $this->stats->increment( 'WatchedItemStore.getWatchedItem.cached' );
566  return $cached;
567  }
568  $this->stats->increment( 'WatchedItemStore.getWatchedItem.load' );
569  return $this->loadWatchedItem( $user, $target );
570  }
571 
578  public function loadWatchedItem( UserIdentity $user, LinkTarget $target ) {
579  // Only registered user can have a watchlist
580  if ( !$user->isRegistered() ) {
581  return false;
582  }
583 
584  $dbr = $this->getConnectionRef( DB_REPLICA );
585 
586  $row = $dbr->selectRow(
587  'watchlist',
588  'wl_notificationtimestamp',
589  $this->dbCond( $user, $target ),
590  __METHOD__
591  );
592 
593  if ( !$row ) {
594  return false;
595  }
596 
597  $item = new WatchedItem(
598  $user,
599  $target,
600  $this->getLatestNotificationTimestamp( $row->wl_notificationtimestamp, $user, $target )
601  );
602  $this->cache( $item );
603 
604  return $item;
605  }
606 
613  public function getWatchedItemsForUser( UserIdentity $user, array $options = [] ) {
614  $options += [ 'forWrite' => false ];
615 
616  $dbOptions = [];
617  if ( array_key_exists( 'sort', $options ) ) {
618  Assert::parameter(
619  ( in_array( $options['sort'], [ self::SORT_ASC, self::SORT_DESC ] ) ),
620  '$options[\'sort\']',
621  'must be SORT_ASC or SORT_DESC'
622  );
623  $dbOptions['ORDER BY'] = [
624  "wl_namespace {$options['sort']}",
625  "wl_title {$options['sort']}"
626  ];
627  }
628  $db = $this->getConnectionRef( $options['forWrite'] ? DB_MASTER : DB_REPLICA );
629 
630  $res = $db->select(
631  'watchlist',
632  [ 'wl_namespace', 'wl_title', 'wl_notificationtimestamp' ],
633  [ 'wl_user' => $user->getId() ],
634  __METHOD__,
635  $dbOptions
636  );
637 
638  $watchedItems = [];
639  foreach ( $res as $row ) {
640  $target = new TitleValue( (int)$row->wl_namespace, $row->wl_title );
641  // @todo: Should we add these to the process cache?
642  $watchedItems[] = new WatchedItem(
643  $user,
644  $target,
646  $row->wl_notificationtimestamp, $user, $target )
647  );
648  }
649 
650  return $watchedItems;
651  }
652 
659  public function isWatched( UserIdentity $user, LinkTarget $target ) {
660  return (bool)$this->getWatchedItem( $user, $target );
661  }
662 
669  public function getNotificationTimestampsBatch( UserIdentity $user, array $targets ) {
670  $timestamps = [];
671  foreach ( $targets as $target ) {
672  $timestamps[$target->getNamespace()][$target->getDBkey()] = false;
673  }
674 
675  if ( !$user->isRegistered() ) {
676  return $timestamps;
677  }
678 
679  $targetsToLoad = [];
680  foreach ( $targets as $target ) {
681  $cachedItem = $this->getCached( $user, $target );
682  if ( $cachedItem ) {
683  $timestamps[$target->getNamespace()][$target->getDBkey()] =
684  $cachedItem->getNotificationTimestamp();
685  } else {
686  $targetsToLoad[] = $target;
687  }
688  }
689 
690  if ( !$targetsToLoad ) {
691  return $timestamps;
692  }
693 
694  $dbr = $this->getConnectionRef( DB_REPLICA );
695 
696  $lb = new LinkBatch( $targetsToLoad );
697  $res = $dbr->select(
698  'watchlist',
699  [ 'wl_namespace', 'wl_title', 'wl_notificationtimestamp' ],
700  [
701  $lb->constructSet( 'wl', $dbr ),
702  'wl_user' => $user->getId(),
703  ],
704  __METHOD__
705  );
706 
707  foreach ( $res as $row ) {
708  $target = new TitleValue( (int)$row->wl_namespace, $row->wl_title );
709  $timestamps[$row->wl_namespace][$row->wl_title] =
711  $row->wl_notificationtimestamp, $user, $target );
712  }
713 
714  return $timestamps;
715  }
716 
723  public function addWatch( UserIdentity $user, LinkTarget $target ) {
724  $this->addWatchBatchForUser( $user, [ $target ] );
725  }
726 
734  public function addWatchBatchForUser( UserIdentity $user, array $targets ) {
735  if ( $this->readOnlyMode->isReadOnly() ) {
736  return false;
737  }
738  // Only registered user can have a watchlist
739  if ( !$user->isRegistered() ) {
740  return false;
741  }
742 
743  if ( !$targets ) {
744  return true;
745  }
746 
747  $rows = [];
748  $items = [];
749  foreach ( $targets as $target ) {
750  $rows[] = [
751  'wl_user' => $user->getId(),
752  'wl_namespace' => $target->getNamespace(),
753  'wl_title' => $target->getDBkey(),
754  'wl_notificationtimestamp' => null,
755  ];
756  $items[] = new WatchedItem(
757  $user,
758  $target,
759  null
760  );
761  $this->uncache( $user, $target );
762  }
763 
764  $dbw = $this->getConnectionRef( DB_MASTER );
765  $ticket = count( $targets ) > $this->updateRowsPerQuery ?
766  $this->lbFactory->getEmptyTransactionTicket( __METHOD__ ) : null;
767  $affectedRows = 0;
768  $rowBatches = array_chunk( $rows, $this->updateRowsPerQuery );
769  foreach ( $rowBatches as $toInsert ) {
770  // Use INSERT IGNORE to avoid overwriting the notification timestamp
771  // if there's already an entry for this page
772  $dbw->insert( 'watchlist', $toInsert, __METHOD__, [ 'IGNORE' ] );
773  $affectedRows += $dbw->affectedRows();
774  if ( $ticket ) {
775  $this->lbFactory->commitAndWaitForReplication( __METHOD__, $ticket );
776  }
777  }
778  // Update process cache to ensure skin doesn't claim that the current
779  // page is unwatched in the response of action=watch itself (T28292).
780  // This would otherwise be re-queried from a replica by isWatched().
781  foreach ( $items as $item ) {
782  $this->cache( $item );
783  }
784 
785  return (bool)$affectedRows;
786  }
787 
795  public function removeWatch( UserIdentity $user, LinkTarget $target ) {
796  return $this->removeWatchBatchForUser( $user, [ $target ] );
797  }
798 
817  UserIdentity $user, $timestamp, array $targets = []
818  ) {
819  // Only registered user can have a watchlist
820  if ( !$user->isRegistered() || $this->readOnlyMode->isReadOnly() ) {
821  return false;
822  }
823 
824  if ( !$targets ) {
825  // Backwards compatibility
826  $this->resetAllNotificationTimestampsForUser( $user, $timestamp );
827  return true;
828  }
829 
830  $rows = $this->getTitleDbKeysGroupedByNamespace( $targets );
831 
832  $dbw = $this->getConnectionRef( DB_MASTER );
833  if ( $timestamp !== null ) {
834  $timestamp = $dbw->timestamp( $timestamp );
835  }
836  $ticket = $this->lbFactory->getEmptyTransactionTicket( __METHOD__ );
837  $affectedSinceWait = 0;
838 
839  // Batch update items per namespace
840  foreach ( $rows as $namespace => $namespaceTitles ) {
841  $rowBatches = array_chunk( $namespaceTitles, $this->updateRowsPerQuery );
842  foreach ( $rowBatches as $toUpdate ) {
843  $dbw->update(
844  'watchlist',
845  [ 'wl_notificationtimestamp' => $timestamp ],
846  [
847  'wl_user' => $user->getId(),
848  'wl_namespace' => $namespace,
849  'wl_title' => $toUpdate
850  ]
851  );
852  $affectedSinceWait += $dbw->affectedRows();
853  // Wait for replication every time we've touched updateRowsPerQuery rows
854  if ( $affectedSinceWait >= $this->updateRowsPerQuery ) {
855  $this->lbFactory->commitAndWaitForReplication( __METHOD__, $ticket );
856  $affectedSinceWait = 0;
857  }
858  }
859  }
860 
861  $this->uncacheUser( $user );
862 
863  return true;
864  }
865 
867  $timestamp, UserIdentity $user, LinkTarget $target
868  ) {
869  $timestamp = wfTimestampOrNull( TS_MW, $timestamp );
870  if ( $timestamp === null ) {
871  return null; // no notification
872  }
873 
874  $seenTimestamps = $this->getPageSeenTimestamps( $user );
875  if (
876  $seenTimestamps &&
877  $seenTimestamps->get( $this->getPageSeenKey( $target ) ) >= $timestamp
878  ) {
879  // If a reset job did not yet run, then the "seen" timestamp will be higher
880  return null;
881  }
882 
883  return $timestamp;
884  }
885 
893  // Only registered user can have a watchlist
894  if ( !$user->isRegistered() ) {
895  return;
896  }
897 
898  // If the page is watched by the user (or may be watched), update the timestamp
900  'userId' => $user->getId(), 'timestamp' => $timestamp, 'casTime' => time()
901  ] );
902 
903  // Try to run this post-send
904  // Calls DeferredUpdates::addCallableUpdate in normal operation
905  call_user_func(
906  $this->deferredUpdatesAddCallableUpdateCallback,
907  function () use ( $job ) {
908  $job->run();
909  }
910  );
911  }
912 
921  UserIdentity $editor, LinkTarget $target, $timestamp
922  ) {
923  $dbw = $this->getConnectionRef( DB_MASTER );
924  $uids = $dbw->selectFieldValues(
925  'watchlist',
926  'wl_user',
927  [
928  'wl_user != ' . intval( $editor->getId() ),
929  'wl_namespace' => $target->getNamespace(),
930  'wl_title' => $target->getDBkey(),
931  'wl_notificationtimestamp IS NULL',
932  ],
933  __METHOD__
934  );
935 
936  $watchers = array_map( 'intval', $uids );
937  if ( $watchers ) {
938  // Update wl_notificationtimestamp for all watching users except the editor
939  $fname = __METHOD__;
941  function () use ( $timestamp, $watchers, $target, $fname ) {
942  $dbw = $this->getConnectionRef( DB_MASTER );
943  $ticket = $this->lbFactory->getEmptyTransactionTicket( $fname );
944 
945  $watchersChunks = array_chunk( $watchers, $this->updateRowsPerQuery );
946  foreach ( $watchersChunks as $watchersChunk ) {
947  $dbw->update( 'watchlist',
948  [ /* SET */
949  'wl_notificationtimestamp' => $dbw->timestamp( $timestamp )
950  ], [ /* WHERE - TODO Use wl_id T130067 */
951  'wl_user' => $watchersChunk,
952  'wl_namespace' => $target->getNamespace(),
953  'wl_title' => $target->getDBkey(),
954  ], $fname
955  );
956  if ( count( $watchersChunks ) > 1 ) {
957  $this->lbFactory->commitAndWaitForReplication(
958  $fname, $ticket, [ 'domain' => $dbw->getDomainID() ]
959  );
960  }
961  }
962  $this->uncacheLinkTarget( $target );
963  },
965  $dbw
966  );
967  }
968 
969  return $watchers;
970  }
971 
980  public function resetNotificationTimestamp(
981  UserIdentity $user, LinkTarget $title, $force = '', $oldid = 0
982  ) {
983  $time = time();
984 
985  // Only registered user can have a watchlist
986  if ( $this->readOnlyMode->isReadOnly() || !$user->isRegistered() ) {
987  return false;
988  }
989 
990  // Hook expects User and Title, not UserIdentity and LinkTarget
991  $userObj = User::newFromId( $user->getId() );
992  $titleObj = Title::castFromLinkTarget( $title );
993  if ( !Hooks::run( 'BeforeResetNotificationTimestamp',
994  [ &$userObj, &$titleObj, $force, &$oldid ] )
995  ) {
996  return false;
997  }
998  if ( !$userObj->equals( $user ) ) {
999  $user = $userObj;
1000  }
1001  if ( !$titleObj->equals( $title ) ) {
1002  $title = $titleObj;
1003  }
1004 
1005  $item = null;
1006  if ( $force != 'force' ) {
1007  $item = $this->loadWatchedItem( $user, $title );
1008  if ( !$item || $item->getNotificationTimestamp() === null ) {
1009  return false;
1010  }
1011  }
1012 
1013  // Get the timestamp (TS_MW) of this revision to track the latest one seen
1014  $id = $oldid;
1015  $seenTime = null;
1016  if ( !$id ) {
1017  $latestRev = $this->revisionLookup->getRevisionByTitle( $title );
1018  if ( $latestRev ) {
1019  $id = $latestRev->getId();
1020  // Save a DB query
1021  $seenTime = $latestRev->getTimestamp();
1022  }
1023  }
1024  if ( $seenTime === null ) {
1025  $seenTime = $this->revisionLookup->getTimestampFromId( $id );
1026  }
1027 
1028  // Mark the item as read immediately in lightweight storage
1029  $this->stash->merge(
1030  $this->getPageSeenTimestampsKey( $user ),
1031  function ( $cache, $key, $current ) use ( $title, $seenTime ) {
1032  $value = $current ?: new MapCacheLRU( 300 );
1033  $subKey = $this->getPageSeenKey( $title );
1034 
1035  if ( $seenTime > $value->get( $subKey ) ) {
1036  // Revision is newer than the last one seen
1037  $value->set( $subKey, $seenTime );
1038  $this->latestUpdateCache->set( $key, $value, IExpiringStore::TTL_PROC_LONG );
1039  } elseif ( $seenTime === false ) {
1040  // Revision does not exist
1041  $value->set( $subKey, wfTimestamp( TS_MW ) );
1042  $this->latestUpdateCache->set( $key, $value, IExpiringStore::TTL_PROC_LONG );
1043  } else {
1044  return false; // nothing to update
1045  }
1046 
1047  return $value;
1048  },
1050  );
1051 
1052  // If the page is watched by the user (or may be watched), update the timestamp
1053  $job = new ActivityUpdateJob(
1054  $title,
1055  [
1056  'type' => 'updateWatchlistNotification',
1057  'userid' => $user->getId(),
1058  'notifTime' => $this->getNotificationTimestamp( $user, $title, $item, $force, $oldid ),
1059  'curTime' => $time
1060  ]
1061  );
1062  // Try to enqueue this post-send
1063  $this->queueGroup->lazyPush( $job );
1064 
1065  $this->uncache( $user, $title );
1066 
1067  return true;
1068  }
1069 
1075  $key = $this->getPageSeenTimestampsKey( $user );
1076 
1077  return $this->latestUpdateCache->getWithSetCallback(
1078  $key,
1080  function () use ( $key ) {
1081  return $this->stash->get( $key ) ?: null;
1082  }
1083  );
1084  }
1085 
1091  return $this->stash->makeGlobalKey(
1092  'watchlist-recent-updates',
1093  $this->lbFactory->getLocalDomainID(),
1094  $user->getId()
1095  );
1096  }
1097 
1102  private function getPageSeenKey( LinkTarget $target ) {
1103  return "{$target->getNamespace()}:{$target->getDBkey()}";
1104  }
1105 
1114  private function getNotificationTimestamp(
1115  UserIdentity $user, LinkTarget $title, $item, $force, $oldid
1116  ) {
1117  if ( !$oldid ) {
1118  // No oldid given, assuming latest revision; clear the timestamp.
1119  return null;
1120  }
1121 
1122  $oldRev = $this->revisionLookup->getRevisionById( $oldid );
1123  $nextRev = $this->revisionLookup->getNextRevision( $oldRev );
1124  if ( !$nextRev ) {
1125  // Oldid given and is the latest revision for this title; clear the timestamp.
1126  return null;
1127  }
1128 
1129  if ( $item === null ) {
1130  $item = $this->loadWatchedItem( $user, $title );
1131  }
1132 
1133  if ( !$item ) {
1134  // This can only happen if $force is enabled.
1135  return null;
1136  }
1137 
1138  // Oldid given and isn't the latest; update the timestamp.
1139  // This will result in no further notification emails being sent!
1140  $notificationTimestamp = $this->revisionLookup->getTimestampFromId( $oldid );
1141  // @FIXME: this should use getTimestamp() for consistency with updates on new edits
1142  // $notificationTimestamp = $nextRev->getTimestamp(); // first unseen revision timestamp
1143 
1144  // We need to go one second to the future because of various strict comparisons
1145  // throughout the codebase
1146  $ts = new MWTimestamp( $notificationTimestamp );
1147  $ts->timestamp->add( new DateInterval( 'PT1S' ) );
1148  $notificationTimestamp = $ts->getTimestamp( TS_MW );
1149 
1150  if ( $notificationTimestamp < $item->getNotificationTimestamp() ) {
1151  if ( $force != 'force' ) {
1152  return false;
1153  } else {
1154  // This is a little silly‚Ķ
1155  return $item->getNotificationTimestamp();
1156  }
1157  }
1158 
1159  return $notificationTimestamp;
1160  }
1161 
1168  public function countUnreadNotifications( UserIdentity $user, $unreadLimit = null ) {
1169  $dbr = $this->getConnectionRef( DB_REPLICA );
1170 
1171  $queryOptions = [];
1172  if ( $unreadLimit !== null ) {
1173  $unreadLimit = (int)$unreadLimit;
1174  $queryOptions['LIMIT'] = $unreadLimit;
1175  }
1176 
1177  $conds = [
1178  'wl_user' => $user->getId(),
1179  'wl_notificationtimestamp IS NOT NULL'
1180  ];
1181 
1182  $rowCount = $dbr->selectRowCount( 'watchlist', '1', $conds, __METHOD__, $queryOptions );
1183 
1184  if ( $unreadLimit === null ) {
1185  return $rowCount;
1186  }
1187 
1188  if ( $rowCount >= $unreadLimit ) {
1189  return true;
1190  }
1191 
1192  return $rowCount;
1193  }
1194 
1200  public function duplicateAllAssociatedEntries( LinkTarget $oldTarget, LinkTarget $newTarget ) {
1201  // Duplicate first the subject page, then the talk page
1202  $this->duplicateEntry(
1203  $this->nsInfo->getSubjectPage( $oldTarget ),
1204  $this->nsInfo->getSubjectPage( $newTarget )
1205  );
1206  $this->duplicateEntry(
1207  $this->nsInfo->getTalkPage( $oldTarget ),
1208  $this->nsInfo->getTalkPage( $newTarget )
1209  );
1210  }
1211 
1217  public function duplicateEntry( LinkTarget $oldTarget, LinkTarget $newTarget ) {
1218  $dbw = $this->getConnectionRef( DB_MASTER );
1219 
1220  $result = $dbw->select(
1221  'watchlist',
1222  [ 'wl_user', 'wl_notificationtimestamp' ],
1223  [
1224  'wl_namespace' => $oldTarget->getNamespace(),
1225  'wl_title' => $oldTarget->getDBkey(),
1226  ],
1227  __METHOD__,
1228  [ 'FOR UPDATE' ]
1229  );
1230 
1231  $newNamespace = $newTarget->getNamespace();
1232  $newDBkey = $newTarget->getDBkey();
1233 
1234  # Construct array to replace into the watchlist
1235  $values = [];
1236  foreach ( $result as $row ) {
1237  $values[] = [
1238  'wl_user' => $row->wl_user,
1239  'wl_namespace' => $newNamespace,
1240  'wl_title' => $newDBkey,
1241  'wl_notificationtimestamp' => $row->wl_notificationtimestamp,
1242  ];
1243  }
1244 
1245  if ( !empty( $values ) ) {
1246  # Perform replace
1247  # Note that multi-row replace is very efficient for MySQL but may be inefficient for
1248  # some other DBMSes, mostly due to poor simulation by us
1249  $dbw->replace(
1250  'watchlist',
1251  [ [ 'wl_user', 'wl_namespace', 'wl_title' ] ],
1252  $values,
1253  __METHOD__
1254  );
1255  }
1256  }
1257 
1262  private function getTitleDbKeysGroupedByNamespace( array $titles ) {
1263  $rows = [];
1264  foreach ( $titles as $title ) {
1265  // Group titles by namespace.
1266  $rows[ $title->getNamespace() ][] = $title->getDBkey();
1267  }
1268  return $rows;
1269  }
1270 
1275  private function uncacheTitlesForUser( UserIdentity $user, array $titles ) {
1276  foreach ( $titles as $title ) {
1277  $this->uncache( $user, $title );
1278  }
1279  }
1280 
1281 }
getCacheKey(UserIdentity $user, LinkTarget $target)
static castFromLinkTarget( $linkTarget)
Same as newFromLinkTarget, but if passed null, returns null.
Definition: Title.php:295
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction $rows
Definition: hooks.txt:2633
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
removeWatch(UserIdentity $user, LinkTarget $target)
countUnreadNotifications(UserIdentity $user, $unreadLimit=null)
getTitleDbKeysGroupedByNamespace(array $titles)
Job for clearing all of the "last viewed" timestamps for a user&#39;s watchlist, or setting them all to t...
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187
uncacheUser(UserIdentity $user)
ReadOnlyMode $readOnlyMode
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
getLatestNotificationTimestamp( $timestamp, UserIdentity $user, LinkTarget $target)
Convert $timestamp to TS_MW or return null if the page was visited since then by $user.
addWatch(UserIdentity $user, LinkTarget $target)
resetAllNotificationTimestampsForUser(UserIdentity $user, $timestamp=null)
Schedule a DeferredUpdate that sets all of the "last viewed" timestamps for a given user to the same ...
This code would result in ircNotify being run twice when an article is and once for brion Hooks can return three possible true was required This is the default since MediaWiki *some string
Definition: hooks.txt:175
$value
overrideDeferredUpdatesAddCallableUpdateCallback(callable $callback)
Overrides the DeferredUpdates::addCallableUpdate callback This is intended for use while testing and ...
getPageSeenTimestampsKey(UserIdentity $user)
updateNotificationTimestamp(UserIdentity $editor, LinkTarget $target, $timestamp)
getWatchedItem(UserIdentity $user, LinkTarget $target)
wfTimestampOrNull( $outputtype=TS_UNIX, $ts=null)
Return a formatted timestamp, or null if input is null.
Describes a Statsd aware interface.
see documentation in includes Linker php for Linker::makeImageLink & $time
Definition: hooks.txt:1799
const DB_MASTER
Definition: defines.php:26
getCached(UserIdentity $user, LinkTarget $target)
getNamespace()
Get the namespace index.
uncache(UserIdentity $user, LinkTarget $target)
getConnectionRef( $dbIndex)
timestamp( $ts=0)
Convert a timestamp in one of the formats accepted by wfTimestamp() to the format used for inserting ...
Storage layer class for WatchedItems.
RevisionLookup $revisionLookup
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 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name '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. '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 '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 since 1.28! 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:1980
A service class for fetching the wiki&#39;s current read-only mode.
Interface for objects representing user identity.
clearUserWatchedItemsUsingJobQueue(UserIdentity $user)
Queues a job that will clear the users watchlist using the Job Queue.
Class representing a list of titles The execute() method checks them all for existence and adds them ...
Definition: LinkBatch.php:34
Job for updating user activity like "last viewed" timestamps.
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
static addCallableUpdate( $callable, $stage=self::POSTSEND, $dbw=null)
Add a callable update.
duplicateAllAssociatedEntries(LinkTarget $oldTarget, LinkTarget $newTarget)
countWatchers(LinkTarget $target)
const LIST_AND
Definition: Defines.php:39
uncacheAllItemsForUser(UserIdentity $user)
setNotificationTimestampsForUser(UserIdentity $user, $timestamp, array $targets=[])
Set the "last viewed" timestamps for certain titles on a user&#39;s watchlist.
StatsdDataFactoryInterface $stats
getWatchedItemsForUser(UserIdentity $user, array $options=[])
array [] $cacheIndex
Looks like $cacheIndex[Namespace ID][Target DB Key][User Id] => &#39;key&#39; The index is needed so that on ...
$res
Definition: database.txt:21
countWatchedItems(UserIdentity $user)
dbCond(UserIdentity $user, LinkTarget $target)
Return an array of conditions to select or update the appropriate database row.
getDBkey()
Get the main part with underscores.
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 & $options
Definition: hooks.txt:1982
removeWatchBatchForUser(UserIdentity $user, array $titles)
Representation of a pair of user and title for watchlist entries.
Definition: WatchedItem.php:33
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
NamespaceInfo $nsInfo
Service for looking up page revisions.
LoadBalancer $loadBalancer
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
loadWatchedItem(UserIdentity $user, LinkTarget $target)
if(defined( 'MW_SETUP_CALLBACK')) $fname
Customization point after all loading (constants, functions, classes, DefaultSettings, LocalSettings).
Definition: Setup.php:123
__construct(ILBFactory $lbFactory, JobQueueGroup $queueGroup, BagOStuff $stash, HashBagOStuff $cache, ReadOnlyMode $readOnlyMode, $updateRowsPerQuery, NamespaceInfo $nsInfo, RevisionLookup $revisionLookup)
getMainLB( $domain=false)
Get a cached (tracked) load balancer object.
const LIST_OR
Definition: Defines.php:42
getNotificationTimestamp(UserIdentity $user, LinkTarget $title, $item, $force, $oldid)
getPageSeenTimestamps(UserIdentity $user)
setStatsdDataFactory(StatsdDataFactoryInterface $stats)
countVisitingWatchersMultiple(array $targetsWithVisitThresholds, $minimumWatchers=null)
resetNotificationTimestamp(UserIdentity $user, LinkTarget $title, $force='', $oldid=0)
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
static newFromId( $id)
Static factory method for creation from a given user ID.
Definition: User.php:618
JobQueueGroup $queueGroup
countWatchersMultiple(array $targets, array $options=[])
An interface for generating database load balancers.
Definition: ILBFactory.php:33
Basic database interface for live and lazy-loaded relation database handles.
Definition: IDatabase.php:38
getPageSeenKey(LinkTarget $target)
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
callable null $deferredUpdatesAddCallableUpdateCallback
getNotificationTimestampsBatch(UserIdentity $user, array $targets)
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
cache(WatchedItem $item)
makeList( $a, $mode=self::LIST_COMMA)
Makes an encoded list of strings from an array.
if(count( $args)< 1) $job
HashBagOStuff $cache
uncacheLinkTarget(LinkTarget $target)
duplicateEntry(LinkTarget $oldTarget, LinkTarget $newTarget)
const DB_REPLICA
Definition: defines.php:25
uncacheTitlesForUser(UserIdentity $user, array $titles)
HashBagOStuff $latestUpdateCache
getVisitingWatchersCondition(IDatabase $db, array $targetsWithVisitThresholds)
Generates condition for the query used in a batch count visiting watchers.
static newForUser(UserIdentity $user, $maxWatchlistId)
addQuotes( $s)
Adds quotes and backslashes.
countVisitingWatchers(LinkTarget $target, $threshold)
passed in as a query string parameter to the various URLs constructed here(i.e. $prevlink) $ldel you ll need to handle error etc yourself modifying $error and returning true will cause the contents of $error to be echoed at the top of the edit form as wikitext Return true without altering $error to allow the edit to proceed & $editor
Definition: hooks.txt:1287
clearUserWatchedItems(UserIdentity $user)
Deletes ALL watched items for the given user when under $updateRowsPerQuery entries exist...
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1473
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200
addWatchBatchForUser(UserIdentity $user, array $targets)
isWatched(UserIdentity $user, LinkTarget $target)