MediaWiki  1.32.5
WatchedItemStore.php
Go to the documentation of this file.
1 <?php
2 
4 use Liuggio\StatsdClient\Factory\StatsdDataFactoryInterface;
6 use Wikimedia\Assert\Assert;
7 use Wikimedia\ScopedCallback;
10 
20 
24  private $lbFactory;
25 
29  private $loadBalancer;
30 
34  private $readOnlyMode;
35 
39  private $cache;
40 
47  private $cacheIndex = [];
48 
53 
58 
63 
67  private $stats;
68 
75  public function __construct(
80  ) {
81  $this->lbFactory = $lbFactory;
82  $this->loadBalancer = $lbFactory->getMainLB();
83  $this->cache = $cache;
84  $this->readOnlyMode = $readOnlyMode;
85  $this->stats = new NullStatsdDataFactory();
86  $this->deferredUpdatesAddCallableUpdateCallback =
87  [ DeferredUpdates::class, 'addCallableUpdate' ];
88  $this->revisionGetTimestampFromIdCallback =
89  [ Revision::class, 'getTimestampFromId' ];
90  $this->updateRowsPerQuery = $updateRowsPerQuery;
91  }
92 
96  public function setStatsdDataFactory( StatsdDataFactoryInterface $stats ) {
97  $this->stats = $stats;
98  }
99 
111  public function overrideDeferredUpdatesAddCallableUpdateCallback( callable $callback ) {
112  if ( !defined( 'MW_PHPUNIT_TEST' ) ) {
113  throw new MWException(
114  'Cannot override DeferredUpdates::addCallableUpdate callback in operation.'
115  );
116  }
118  $this->deferredUpdatesAddCallableUpdateCallback = $callback;
119  return new ScopedCallback( function () use ( $previousValue ) {
120  $this->deferredUpdatesAddCallableUpdateCallback = $previousValue;
121  } );
122  }
123 
134  public function overrideRevisionGetTimestampFromIdCallback( callable $callback ) {
135  if ( !defined( 'MW_PHPUNIT_TEST' ) ) {
136  throw new MWException(
137  'Cannot override Revision::getTimestampFromId callback in operation.'
138  );
139  }
141  $this->revisionGetTimestampFromIdCallback = $callback;
142  return new ScopedCallback( function () use ( $previousValue ) {
143  $this->revisionGetTimestampFromIdCallback = $previousValue;
144  } );
145  }
146 
147  private function getCacheKey( User $user, LinkTarget $target ) {
148  return $this->cache->makeKey(
149  (string)$target->getNamespace(),
150  $target->getDBkey(),
151  (string)$user->getId()
152  );
153  }
154 
155  private function cache( WatchedItem $item ) {
156  $user = $item->getUser();
157  $target = $item->getLinkTarget();
158  $key = $this->getCacheKey( $user, $target );
159  $this->cache->set( $key, $item );
160  $this->cacheIndex[$target->getNamespace()][$target->getDBkey()][$user->getId()] = $key;
161  $this->stats->increment( 'WatchedItemStore.cache' );
162  }
163 
164  private function uncache( User $user, LinkTarget $target ) {
165  $this->cache->delete( $this->getCacheKey( $user, $target ) );
166  unset( $this->cacheIndex[$target->getNamespace()][$target->getDBkey()][$user->getId()] );
167  $this->stats->increment( 'WatchedItemStore.uncache' );
168  }
169 
170  private function uncacheLinkTarget( LinkTarget $target ) {
171  $this->stats->increment( 'WatchedItemStore.uncacheLinkTarget' );
172  if ( !isset( $this->cacheIndex[$target->getNamespace()][$target->getDBkey()] ) ) {
173  return;
174  }
175  foreach ( $this->cacheIndex[$target->getNamespace()][$target->getDBkey()] as $key ) {
176  $this->stats->increment( 'WatchedItemStore.uncacheLinkTarget.items' );
177  $this->cache->delete( $key );
178  }
179  }
180 
181  private function uncacheUser( User $user ) {
182  $this->stats->increment( 'WatchedItemStore.uncacheUser' );
183  foreach ( $this->cacheIndex as $ns => $dbKeyArray ) {
184  foreach ( $dbKeyArray as $dbKey => $userArray ) {
185  if ( isset( $userArray[$user->getId()] ) ) {
186  $this->stats->increment( 'WatchedItemStore.uncacheUser.items' );
187  $this->cache->delete( $userArray[$user->getId()] );
188  }
189  }
190  }
191  }
192 
199  private function getCached( User $user, LinkTarget $target ) {
200  return $this->cache->get( $this->getCacheKey( $user, $target ) );
201  }
202 
212  private function dbCond( User $user, LinkTarget $target ) {
213  return [
214  'wl_user' => $user->getId(),
215  'wl_namespace' => $target->getNamespace(),
216  'wl_title' => $target->getDBkey(),
217  ];
218  }
219 
226  private function getConnectionRef( $dbIndex ) {
227  return $this->loadBalancer->getConnectionRef( $dbIndex, [ 'watchlist' ] );
228  }
229 
240  public function clearUserWatchedItems( User $user ) {
241  if ( $this->countWatchedItems( $user ) > $this->updateRowsPerQuery ) {
242  return false;
243  }
244 
245  $dbw = $this->loadBalancer->getConnectionRef( DB_MASTER );
246  $dbw->delete(
247  'watchlist',
248  [ 'wl_user' => $user->getId() ],
249  __METHOD__
250  );
251  $this->uncacheAllItemsForUser( $user );
252 
253  return true;
254  }
255 
256  private function uncacheAllItemsForUser( User $user ) {
257  $userId = $user->getId();
258  foreach ( $this->cacheIndex as $ns => $dbKeyIndex ) {
259  foreach ( $dbKeyIndex as $dbKey => $userIndex ) {
260  if ( array_key_exists( $userId, $userIndex ) ) {
261  $this->cache->delete( $userIndex[$userId] );
262  unset( $this->cacheIndex[$ns][$dbKey][$userId] );
263  }
264  }
265  }
266 
267  // Cleanup empty cache keys
268  foreach ( $this->cacheIndex as $ns => $dbKeyIndex ) {
269  foreach ( $dbKeyIndex as $dbKey => $userIndex ) {
270  if ( empty( $this->cacheIndex[$ns][$dbKey] ) ) {
271  unset( $this->cacheIndex[$ns][$dbKey] );
272  }
273  }
274  if ( empty( $this->cacheIndex[$ns] ) ) {
275  unset( $this->cacheIndex[$ns] );
276  }
277  }
278  }
279 
289  // TODO inject me.
290  JobQueueGroup::singleton()->push( $job );
291  }
292 
297  public function getMaxId() {
298  $dbr = $this->getConnectionRef( DB_REPLICA );
299  return (int)$dbr->selectField(
300  'watchlist',
301  'MAX(wl_id)',
302  '',
303  __METHOD__
304  );
305  }
306 
312  public function countWatchedItems( User $user ) {
313  $dbr = $this->getConnectionRef( DB_REPLICA );
314  $return = (int)$dbr->selectField(
315  'watchlist',
316  'COUNT(*)',
317  [
318  'wl_user' => $user->getId()
319  ],
320  __METHOD__
321  );
322 
323  return $return;
324  }
325 
331  public function countWatchers( LinkTarget $target ) {
332  $dbr = $this->getConnectionRef( DB_REPLICA );
333  $return = (int)$dbr->selectField(
334  'watchlist',
335  'COUNT(*)',
336  [
337  'wl_namespace' => $target->getNamespace(),
338  'wl_title' => $target->getDBkey(),
339  ],
340  __METHOD__
341  );
342 
343  return $return;
344  }
345 
352  public function countVisitingWatchers( LinkTarget $target, $threshold ) {
353  $dbr = $this->getConnectionRef( DB_REPLICA );
354  $visitingWatchers = (int)$dbr->selectField(
355  'watchlist',
356  'COUNT(*)',
357  [
358  'wl_namespace' => $target->getNamespace(),
359  'wl_title' => $target->getDBkey(),
360  'wl_notificationtimestamp >= ' .
361  $dbr->addQuotes( $dbr->timestamp( $threshold ) ) .
362  ' OR wl_notificationtimestamp IS NULL'
363  ],
364  __METHOD__
365  );
366 
367  return $visitingWatchers;
368  }
369 
376  public function countWatchersMultiple( array $targets, array $options = [] ) {
377  $dbOptions = [ 'GROUP BY' => [ 'wl_namespace', 'wl_title' ] ];
378 
379  $dbr = $this->getConnectionRef( DB_REPLICA );
380 
381  if ( array_key_exists( 'minimumWatchers', $options ) ) {
382  $dbOptions['HAVING'] = 'COUNT(*) >= ' . (int)$options['minimumWatchers'];
383  }
384 
385  $lb = new LinkBatch( $targets );
386  $res = $dbr->select(
387  'watchlist',
388  [ 'wl_title', 'wl_namespace', 'watchers' => 'COUNT(*)' ],
389  [ $lb->constructSet( 'wl', $dbr ) ],
390  __METHOD__,
391  $dbOptions
392  );
393 
394  $watchCounts = [];
395  foreach ( $targets as $linkTarget ) {
396  $watchCounts[$linkTarget->getNamespace()][$linkTarget->getDBkey()] = 0;
397  }
398 
399  foreach ( $res as $row ) {
400  $watchCounts[$row->wl_namespace][$row->wl_title] = (int)$row->watchers;
401  }
402 
403  return $watchCounts;
404  }
405 
413  array $targetsWithVisitThresholds,
414  $minimumWatchers = null
415  ) {
416  if ( $targetsWithVisitThresholds === [] ) {
417  // No titles requested => no results returned
418  return [];
419  }
420 
421  $dbr = $this->getConnectionRef( DB_REPLICA );
422 
423  $conds = $this->getVisitingWatchersCondition( $dbr, $targetsWithVisitThresholds );
424 
425  $dbOptions = [ 'GROUP BY' => [ 'wl_namespace', 'wl_title' ] ];
426  if ( $minimumWatchers !== null ) {
427  $dbOptions['HAVING'] = 'COUNT(*) >= ' . (int)$minimumWatchers;
428  }
429  $res = $dbr->select(
430  'watchlist',
431  [ 'wl_namespace', 'wl_title', 'watchers' => 'COUNT(*)' ],
432  $conds,
433  __METHOD__,
434  $dbOptions
435  );
436 
437  $watcherCounts = [];
438  foreach ( $targetsWithVisitThresholds as list( $target ) ) {
439  /* @var LinkTarget $target */
440  $watcherCounts[$target->getNamespace()][$target->getDBkey()] = 0;
441  }
442 
443  foreach ( $res as $row ) {
444  $watcherCounts[$row->wl_namespace][$row->wl_title] = (int)$row->watchers;
445  }
446 
447  return $watcherCounts;
448  }
449 
458  IDatabase $db,
459  array $targetsWithVisitThresholds
460  ) {
461  $missingTargets = [];
462  $namespaceConds = [];
463  foreach ( $targetsWithVisitThresholds as list( $target, $threshold ) ) {
464  if ( $threshold === null ) {
465  $missingTargets[] = $target;
466  continue;
467  }
468  /* @var LinkTarget $target */
469  $namespaceConds[$target->getNamespace()][] = $db->makeList( [
470  'wl_title = ' . $db->addQuotes( $target->getDBkey() ),
471  $db->makeList( [
472  'wl_notificationtimestamp >= ' . $db->addQuotes( $db->timestamp( $threshold ) ),
473  'wl_notificationtimestamp IS NULL'
474  ], LIST_OR )
475  ], LIST_AND );
476  }
477 
478  $conds = [];
479  foreach ( $namespaceConds as $namespace => $pageConds ) {
480  $conds[] = $db->makeList( [
481  'wl_namespace = ' . $namespace,
482  '(' . $db->makeList( $pageConds, LIST_OR ) . ')'
483  ], LIST_AND );
484  }
485 
486  if ( $missingTargets ) {
487  $lb = new LinkBatch( $missingTargets );
488  $conds[] = $lb->constructSet( 'wl', $db );
489  }
490 
491  return $db->makeList( $conds, LIST_OR );
492  }
493 
500  public function getWatchedItem( User $user, LinkTarget $target ) {
501  if ( $user->isAnon() ) {
502  return false;
503  }
504 
505  $cached = $this->getCached( $user, $target );
506  if ( $cached ) {
507  $this->stats->increment( 'WatchedItemStore.getWatchedItem.cached' );
508  return $cached;
509  }
510  $this->stats->increment( 'WatchedItemStore.getWatchedItem.load' );
511  return $this->loadWatchedItem( $user, $target );
512  }
513 
520  public function loadWatchedItem( User $user, LinkTarget $target ) {
521  // Only loggedin user can have a watchlist
522  if ( $user->isAnon() ) {
523  return false;
524  }
525 
526  $dbr = $this->getConnectionRef( DB_REPLICA );
527  $row = $dbr->selectRow(
528  'watchlist',
529  'wl_notificationtimestamp',
530  $this->dbCond( $user, $target ),
531  __METHOD__
532  );
533 
534  if ( !$row ) {
535  return false;
536  }
537 
538  $item = new WatchedItem(
539  $user,
540  $target,
541  wfTimestampOrNull( TS_MW, $row->wl_notificationtimestamp )
542  );
543  $this->cache( $item );
544 
545  return $item;
546  }
547 
554  public function getWatchedItemsForUser( User $user, array $options = [] ) {
555  $options += [ 'forWrite' => false ];
556 
557  $dbOptions = [];
558  if ( array_key_exists( 'sort', $options ) ) {
559  Assert::parameter(
560  ( in_array( $options['sort'], [ self::SORT_ASC, self::SORT_DESC ] ) ),
561  '$options[\'sort\']',
562  'must be SORT_ASC or SORT_DESC'
563  );
564  $dbOptions['ORDER BY'] = [
565  "wl_namespace {$options['sort']}",
566  "wl_title {$options['sort']}"
567  ];
568  }
569  $db = $this->getConnectionRef( $options['forWrite'] ? DB_MASTER : DB_REPLICA );
570 
571  $res = $db->select(
572  'watchlist',
573  [ 'wl_namespace', 'wl_title', 'wl_notificationtimestamp' ],
574  [ 'wl_user' => $user->getId() ],
575  __METHOD__,
576  $dbOptions
577  );
578 
579  $watchedItems = [];
580  foreach ( $res as $row ) {
581  // @todo: Should we add these to the process cache?
582  $watchedItems[] = new WatchedItem(
583  $user,
584  new TitleValue( (int)$row->wl_namespace, $row->wl_title ),
585  $row->wl_notificationtimestamp
586  );
587  }
588 
589  return $watchedItems;
590  }
591 
598  public function isWatched( User $user, LinkTarget $target ) {
599  return (bool)$this->getWatchedItem( $user, $target );
600  }
601 
608  public function getNotificationTimestampsBatch( User $user, array $targets ) {
609  $timestamps = [];
610  foreach ( $targets as $target ) {
611  $timestamps[$target->getNamespace()][$target->getDBkey()] = false;
612  }
613 
614  if ( $user->isAnon() ) {
615  return $timestamps;
616  }
617 
618  $targetsToLoad = [];
619  foreach ( $targets as $target ) {
620  $cachedItem = $this->getCached( $user, $target );
621  if ( $cachedItem ) {
622  $timestamps[$target->getNamespace()][$target->getDBkey()] =
623  $cachedItem->getNotificationTimestamp();
624  } else {
625  $targetsToLoad[] = $target;
626  }
627  }
628 
629  if ( !$targetsToLoad ) {
630  return $timestamps;
631  }
632 
633  $dbr = $this->getConnectionRef( DB_REPLICA );
634 
635  $lb = new LinkBatch( $targetsToLoad );
636  $res = $dbr->select(
637  'watchlist',
638  [ 'wl_namespace', 'wl_title', 'wl_notificationtimestamp' ],
639  [
640  $lb->constructSet( 'wl', $dbr ),
641  'wl_user' => $user->getId(),
642  ],
643  __METHOD__
644  );
645 
646  foreach ( $res as $row ) {
647  $timestamps[$row->wl_namespace][$row->wl_title] =
648  wfTimestampOrNull( TS_MW, $row->wl_notificationtimestamp );
649  }
650 
651  return $timestamps;
652  }
653 
659  public function addWatch( User $user, LinkTarget $target ) {
660  $this->addWatchBatchForUser( $user, [ $target ] );
661  }
662 
669  public function addWatchBatchForUser( User $user, array $targets ) {
670  if ( $this->readOnlyMode->isReadOnly() ) {
671  return false;
672  }
673  // Only loggedin user can have a watchlist
674  if ( $user->isAnon() ) {
675  return false;
676  }
677 
678  if ( !$targets ) {
679  return true;
680  }
681 
682  $rows = [];
683  $items = [];
684  foreach ( $targets as $target ) {
685  $rows[] = [
686  'wl_user' => $user->getId(),
687  'wl_namespace' => $target->getNamespace(),
688  'wl_title' => $target->getDBkey(),
689  'wl_notificationtimestamp' => null,
690  ];
691  $items[] = new WatchedItem(
692  $user,
693  $target,
694  null
695  );
696  $this->uncache( $user, $target );
697  }
698 
699  $dbw = $this->getConnectionRef( DB_MASTER );
700  foreach ( array_chunk( $rows, 100 ) as $toInsert ) {
701  // Use INSERT IGNORE to avoid overwriting the notification timestamp
702  // if there's already an entry for this page
703  $dbw->insert( 'watchlist', $toInsert, __METHOD__, 'IGNORE' );
704  }
705  // Update process cache to ensure skin doesn't claim that the current
706  // page is unwatched in the response of action=watch itself (T28292).
707  // This would otherwise be re-queried from a replica by isWatched().
708  foreach ( $items as $item ) {
709  $this->cache( $item );
710  }
711 
712  return true;
713  }
714 
721  public function removeWatch( User $user, LinkTarget $target ) {
722  // Only logged in user can have a watchlist
723  if ( $this->readOnlyMode->isReadOnly() || $user->isAnon() ) {
724  return false;
725  }
726 
727  $this->uncache( $user, $target );
728 
729  $dbw = $this->getConnectionRef( DB_MASTER );
730  $dbw->delete( 'watchlist',
731  [
732  'wl_user' => $user->getId(),
733  'wl_namespace' => $target->getNamespace(),
734  'wl_title' => $target->getDBkey(),
735  ], __METHOD__
736  );
737  $success = (bool)$dbw->affectedRows();
738 
739  return $success;
740  }
741 
749  public function setNotificationTimestampsForUser( User $user, $timestamp, array $targets = [] ) {
750  // Only loggedin user can have a watchlist
751  if ( $user->isAnon() ) {
752  return false;
753  }
754 
755  $dbw = $this->getConnectionRef( DB_MASTER );
756 
757  $conds = [ 'wl_user' => $user->getId() ];
758  if ( $targets ) {
759  $batch = new LinkBatch( $targets );
760  $conds[] = $batch->constructSet( 'wl', $dbw );
761  }
762 
763  if ( $timestamp !== null ) {
764  $timestamp = $dbw->timestamp( $timestamp );
765  }
766 
767  $success = $dbw->update(
768  'watchlist',
769  [ 'wl_notificationtimestamp' => $timestamp ],
770  $conds,
771  __METHOD__
772  );
773 
774  $this->uncacheUser( $user );
775 
776  return $success;
777  }
778 
780  // Only loggedin user can have a watchlist
781  if ( $user->isAnon() ) {
782  return;
783  }
784 
785  // If the page is watched by the user (or may be watched), update the timestamp
787  $user->getUserPage(),
788  [ 'userId' => $user->getId(), 'casTime' => time() ]
789  );
790 
791  // Try to run this post-send
792  // Calls DeferredUpdates::addCallableUpdate in normal operation
793  call_user_func(
794  $this->deferredUpdatesAddCallableUpdateCallback,
795  function () use ( $job ) {
796  $job->run();
797  }
798  );
799  }
800 
808  public function updateNotificationTimestamp( User $editor, LinkTarget $target, $timestamp ) {
809  $dbw = $this->getConnectionRef( DB_MASTER );
810  $uids = $dbw->selectFieldValues(
811  'watchlist',
812  'wl_user',
813  [
814  'wl_user != ' . intval( $editor->getId() ),
815  'wl_namespace' => $target->getNamespace(),
816  'wl_title' => $target->getDBkey(),
817  'wl_notificationtimestamp IS NULL',
818  ],
819  __METHOD__
820  );
821 
822  $watchers = array_map( 'intval', $uids );
823  if ( $watchers ) {
824  // Update wl_notificationtimestamp for all watching users except the editor
825  $fname = __METHOD__;
827  function () use ( $timestamp, $watchers, $target, $fname ) {
828  $dbw = $this->getConnectionRef( DB_MASTER );
829  $ticket = $this->lbFactory->getEmptyTransactionTicket( $fname );
830 
831  $watchersChunks = array_chunk( $watchers, $this->updateRowsPerQuery );
832  foreach ( $watchersChunks as $watchersChunk ) {
833  $dbw->update( 'watchlist',
834  [ /* SET */
835  'wl_notificationtimestamp' => $dbw->timestamp( $timestamp )
836  ], [ /* WHERE - TODO Use wl_id T130067 */
837  'wl_user' => $watchersChunk,
838  'wl_namespace' => $target->getNamespace(),
839  'wl_title' => $target->getDBkey(),
840  ], $fname
841  );
842  if ( count( $watchersChunks ) > 1 ) {
843  $this->lbFactory->commitAndWaitForReplication(
844  $fname, $ticket, [ 'domain' => $dbw->getDomainID() ]
845  );
846  }
847  }
848  $this->uncacheLinkTarget( $target );
849  },
851  $dbw
852  );
853  }
854 
855  return $watchers;
856  }
857 
866  public function resetNotificationTimestamp( User $user, Title $title, $force = '', $oldid = 0 ) {
867  // Only loggedin user can have a watchlist
868  if ( $this->readOnlyMode->isReadOnly() || $user->isAnon() ) {
869  return false;
870  }
871 
872  $item = null;
873  if ( $force != 'force' ) {
874  $item = $this->loadWatchedItem( $user, $title );
875  if ( !$item || $item->getNotificationTimestamp() === null ) {
876  return false;
877  }
878  }
879 
880  // If the page is watched by the user (or may be watched), update the timestamp
881  $job = new ActivityUpdateJob(
882  $title,
883  [
884  'type' => 'updateWatchlistNotification',
885  'userid' => $user->getId(),
886  'notifTime' => $this->getNotificationTimestamp( $user, $title, $item, $force, $oldid ),
887  'curTime' => time()
888  ]
889  );
890 
891  // Try to run this post-send
892  // Calls DeferredUpdates::addCallableUpdate in normal operation
893  call_user_func(
894  $this->deferredUpdatesAddCallableUpdateCallback,
895  function () use ( $job ) {
896  $job->run();
897  }
898  );
899 
900  $this->uncache( $user, $title );
901 
902  return true;
903  }
904 
905  private function getNotificationTimestamp( User $user, Title $title, $item, $force, $oldid ) {
906  if ( !$oldid ) {
907  // No oldid given, assuming latest revision; clear the timestamp.
908  return null;
909  }
910 
911  if ( !$title->getNextRevisionID( $oldid ) ) {
912  // Oldid given and is the latest revision for this title; clear the timestamp.
913  return null;
914  }
915 
916  if ( $item === null ) {
917  $item = $this->loadWatchedItem( $user, $title );
918  }
919 
920  if ( !$item ) {
921  // This can only happen if $force is enabled.
922  return null;
923  }
924 
925  // Oldid given and isn't the latest; update the timestamp.
926  // This will result in no further notification emails being sent!
927  // Calls Revision::getTimestampFromId in normal operation
928  $notificationTimestamp = call_user_func(
929  $this->revisionGetTimestampFromIdCallback,
930  $title,
931  $oldid
932  );
933 
934  // We need to go one second to the future because of various strict comparisons
935  // throughout the codebase
936  $ts = new MWTimestamp( $notificationTimestamp );
937  $ts->timestamp->add( new DateInterval( 'PT1S' ) );
938  $notificationTimestamp = $ts->getTimestamp( TS_MW );
939 
940  if ( $notificationTimestamp < $item->getNotificationTimestamp() ) {
941  if ( $force != 'force' ) {
942  return false;
943  } else {
944  // This is a little silly…
945  return $item->getNotificationTimestamp();
946  }
947  }
948 
949  return $notificationTimestamp;
950  }
951 
958  public function countUnreadNotifications( User $user, $unreadLimit = null ) {
959  $queryOptions = [];
960  if ( $unreadLimit !== null ) {
961  $unreadLimit = (int)$unreadLimit;
962  $queryOptions['LIMIT'] = $unreadLimit;
963  }
964 
965  $dbr = $this->getConnectionRef( DB_REPLICA );
966  $rowCount = $dbr->selectRowCount(
967  'watchlist',
968  '1',
969  [
970  'wl_user' => $user->getId(),
971  'wl_notificationtimestamp IS NOT NULL',
972  ],
973  __METHOD__,
974  $queryOptions
975  );
976 
977  if ( !isset( $unreadLimit ) ) {
978  return $rowCount;
979  }
980 
981  if ( $rowCount >= $unreadLimit ) {
982  return true;
983  }
984 
985  return $rowCount;
986  }
987 
993  public function duplicateAllAssociatedEntries( LinkTarget $oldTarget, LinkTarget $newTarget ) {
994  $oldTarget = Title::newFromLinkTarget( $oldTarget );
995  $newTarget = Title::newFromLinkTarget( $newTarget );
996 
997  $this->duplicateEntry( $oldTarget->getSubjectPage(), $newTarget->getSubjectPage() );
998  $this->duplicateEntry( $oldTarget->getTalkPage(), $newTarget->getTalkPage() );
999  }
1000 
1006  public function duplicateEntry( LinkTarget $oldTarget, LinkTarget $newTarget ) {
1007  $dbw = $this->getConnectionRef( DB_MASTER );
1008 
1009  $result = $dbw->select(
1010  'watchlist',
1011  [ 'wl_user', 'wl_notificationtimestamp' ],
1012  [
1013  'wl_namespace' => $oldTarget->getNamespace(),
1014  'wl_title' => $oldTarget->getDBkey(),
1015  ],
1016  __METHOD__,
1017  [ 'FOR UPDATE' ]
1018  );
1019 
1020  $newNamespace = $newTarget->getNamespace();
1021  $newDBkey = $newTarget->getDBkey();
1022 
1023  # Construct array to replace into the watchlist
1024  $values = [];
1025  foreach ( $result as $row ) {
1026  $values[] = [
1027  'wl_user' => $row->wl_user,
1028  'wl_namespace' => $newNamespace,
1029  'wl_title' => $newDBkey,
1030  'wl_notificationtimestamp' => $row->wl_notificationtimestamp,
1031  ];
1032  }
1033 
1034  if ( !empty( $values ) ) {
1035  # Perform replace
1036  # Note that multi-row replace is very efficient for MySQL but may be inefficient for
1037  # some other DBMSes, mostly due to poor simulation by us
1038  $dbw->replace(
1039  'watchlist',
1040  [ [ 'wl_user', 'wl_namespace', 'wl_title' ] ],
1041  $values,
1042  __METHOD__
1043  );
1044  }
1045  }
1046 
1047 }
WatchedItemStore\getNotificationTimestampsBatch
getNotificationTimestampsBatch(User $user, array $targets)
Definition: WatchedItemStore.php:608
MWTimestamp
Library for creating and parsing MW-style timestamps.
Definition: MWTimestamp.php:32
WatchedItemStore\countUnreadNotifications
countUnreadNotifications(User $user, $unreadLimit=null)
Definition: WatchedItemStore.php:958
$user
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
Definition: hooks.txt:244
WatchedItemStore\overrideRevisionGetTimestampFromIdCallback
overrideRevisionGetTimestampFromIdCallback(callable $callback)
Overrides the Revision::getTimestampFromId callback This is intended for use while testing and will f...
Definition: WatchedItemStore.php:134
ActivityUpdateJob
Job for updating user activity like "last viewed" timestamps.
Definition: ActivityUpdateJob.php:34
WatchedItemStore\addWatch
addWatch(User $user, LinkTarget $target)
Definition: WatchedItemStore.php:659
false
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187
HashBagOStuff
Simple store for keeping values in an associative array for the current process.
Definition: HashBagOStuff.php:31
LinkBatch
Class representing a list of titles The execute() method checks them all for existence and adds them ...
Definition: LinkBatch.php:34
Wikimedia\Rdbms\IDatabase\makeList
makeList( $a, $mode=self::LIST_COMMA)
Makes an encoded list of strings from an array.
captcha-old.count
count
Definition: captcha-old.py:249
WatchedItemStore\getVisitingWatchersCondition
getVisitingWatchersCondition(IDatabase $db, array $targetsWithVisitThresholds)
Generates condition for the query used in a batch count visiting watchers.
Definition: WatchedItemStore.php:457
WatchedItemStore\removeWatch
removeWatch(User $user, LinkTarget $target)
Definition: WatchedItemStore.php:721
WatchedItemStore\getWatchedItem
getWatchedItem(User $user, LinkTarget $target)
Definition: WatchedItemStore.php:500
$result
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. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. '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. 'LanguageGetMagic':DEPRECATED since 1.16! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED 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:2042
ReadOnlyMode
A service class for fetching the wiki's current read-only mode.
Definition: ReadOnlyMode.php:11
WatchedItemStore\countVisitingWatchers
countVisitingWatchers(LinkTarget $target, $threshold)
Definition: WatchedItemStore.php:352
NullStatsdDataFactory
Definition: NullStatsdDataFactory.php:10
ClearWatchlistNotificationsJob
Job for clearing all of the "last viewed" timestamps for a user's watchlist.
Definition: ClearWatchlistNotificationsJob.php:34
WatchedItemStore\duplicateAllAssociatedEntries
duplicateAllAssociatedEntries(LinkTarget $oldTarget, LinkTarget $newTarget)
Definition: WatchedItemStore.php:993
WatchedItemStore\uncacheUser
uncacheUser(User $user)
Definition: WatchedItemStore.php:181
WatchedItemStore\resetAllNotificationTimestampsForUser
resetAllNotificationTimestampsForUser(User $user)
Reset all watchlist notificaton timestamps for a user using the job queue.
Definition: WatchedItemStore.php:779
$res
$res
Definition: database.txt:21
WatchedItemStore\$loadBalancer
LoadBalancer $loadBalancer
Definition: WatchedItemStore.php:29
Wikimedia\Rdbms\ILBFactory\getMainLB
getMainLB( $domain=false)
Get a cached (tracked) load balancer object.
$success
$success
Definition: NoLocalSettings.php:42
WatchedItemStore\$cache
HashBagOStuff $cache
Definition: WatchedItemStore.php:39
php
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
LIST_AND
const LIST_AND
Definition: Defines.php:43
Wikimedia\Rdbms\IDatabase
Basic database interface for live and lazy-loaded relation database handles.
Definition: IDatabase.php:38
$dbr
$dbr
Definition: testCompression.php:50
WatchedItemStore\$lbFactory
ILBFactory $lbFactory
Definition: WatchedItemStore.php:24
WatchedItemStore\updateNotificationTimestamp
updateNotificationTimestamp(User $editor, LinkTarget $target, $timestamp)
Definition: WatchedItemStore.php:808
WatchedItemStore\resetNotificationTimestamp
resetNotificationTimestamp(User $user, Title $title, $force='', $oldid=0)
Definition: WatchedItemStore.php:866
MediaWiki\Linker\LinkTarget\getNamespace
getNamespace()
Get the namespace index.
WatchedItemStore\$readOnlyMode
ReadOnlyMode $readOnlyMode
Definition: WatchedItemStore.php:34
Wikimedia\Rdbms\IDatabase\timestamp
timestamp( $ts=0)
Convert a timestamp in one of the formats accepted by wfTimestamp() to the format used for inserting ...
LIST_OR
const LIST_OR
Definition: Defines.php:46
WatchedItemStore\overrideDeferredUpdatesAddCallableUpdateCallback
overrideDeferredUpdatesAddCallableUpdateCallback(callable $callback)
Overrides the DeferredUpdates::addCallableUpdate callback This is intended for use while testing and ...
Definition: WatchedItemStore.php:111
MWException
MediaWiki exception.
Definition: MWException.php:26
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:964
Title\newFromLinkTarget
static newFromLinkTarget(LinkTarget $linkTarget)
Create a new Title from a LinkTarget.
Definition: Title.php:251
WatchedItemStore\clearUserWatchedItems
clearUserWatchedItems(User $user)
Deletes ALL watched items for the given user when under $updateRowsPerQuery entries exist.
Definition: WatchedItemStore.php:240
wfTimestampOrNull
wfTimestampOrNull( $outputtype=TS_UNIX, $ts=null)
Return a formatted timestamp, or null if input is null.
Definition: GlobalFunctions.php:1970
WatchedItemStore\duplicateEntry
duplicateEntry(LinkTarget $oldTarget, LinkTarget $newTarget)
Definition: WatchedItemStore.php:1006
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
DeferredUpdates\POSTSEND
const POSTSEND
Definition: DeferredUpdates.php:64
DB_REPLICA
const DB_REPLICA
Definition: defines.php:25
WatchedItemStore\addWatchBatchForUser
addWatchBatchForUser(User $user, array $targets)
Definition: WatchedItemStore.php:669
WatchedItemStore\getMaxId
getMaxId()
Definition: WatchedItemStore.php:297
DB_MASTER
const DB_MASTER
Definition: defines.php:26
array
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
$editor
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:1329
WatchedItemStore\uncacheLinkTarget
uncacheLinkTarget(LinkTarget $target)
Definition: WatchedItemStore.php:170
string
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
list
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
WatchedItem\getUser
getUser()
Definition: WatchedItem.php:66
WatchedItemStore\getConnectionRef
getConnectionRef( $dbIndex)
Definition: WatchedItemStore.php:226
WatchedItemStore\$deferredUpdatesAddCallableUpdateCallback
callable null $deferredUpdatesAddCallableUpdateCallback
Definition: WatchedItemStore.php:52
Wikimedia\Rdbms\LoadBalancer
Database connection, tracking, load balancing, and transaction manager for a cluster.
Definition: LoadBalancer.php:41
$fname
if(defined( 'MW_SETUP_CALLBACK')) $fname
Customization point after all loading (constants, functions, classes, DefaultSettings,...
Definition: Setup.php:121
WatchedItemStore\uncache
uncache(User $user, LinkTarget $target)
Definition: WatchedItemStore.php:164
WatchedItemStore\dbCond
dbCond(User $user, LinkTarget $target)
Return an array of conditions to select or update the appropriate database row.
Definition: WatchedItemStore.php:212
WatchedItemStore\__construct
__construct(ILBFactory $lbFactory, HashBagOStuff $cache, ReadOnlyMode $readOnlyMode, $updateRowsPerQuery)
Definition: WatchedItemStore.php:75
StatsdAwareInterface
Describes a Statsd aware interface.
Definition: StatsdAwareInterface.php:11
WatchedItemStore\uncacheAllItemsForUser
uncacheAllItemsForUser(User $user)
Definition: WatchedItemStore.php:256
WatchedItemStore\$cacheIndex
array[] $cacheIndex
Looks like $cacheIndex[Namespace ID][Target DB Key][User Id] => 'key' The index is needed so that on ...
Definition: WatchedItemStore.php:47
WatchedItem
Representation of a pair of user and title for watchlist entries.
Definition: WatchedItem.php:32
MediaWiki\Linker\LinkTarget\getDBkey
getDBkey()
Get the main part with underscores.
WatchedItemStore\setNotificationTimestampsForUser
setNotificationTimestampsForUser(User $user, $timestamp, array $targets=[])
Definition: WatchedItemStore.php:749
WatchedItemStore
Storage layer class for WatchedItems.
Definition: WatchedItemStore.php:19
WatchedItemStore\countWatchedItems
countWatchedItems(User $user)
Definition: WatchedItemStore.php:312
Title
Represents a title within MediaWiki.
Definition: Title.php:39
JobQueueGroup\singleton
static singleton( $domain=false)
Definition: JobQueueGroup.php:69
WatchedItemStore\getWatchedItemsForUser
getWatchedItemsForUser(User $user, array $options=[])
Definition: WatchedItemStore.php:554
$rows
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:2683
$options
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:2044
Wikimedia\Rdbms\IDatabase\addQuotes
addQuotes( $s)
Adds quotes and backslashes.
WatchedItemStore\$stats
StatsdDataFactoryInterface $stats
Definition: WatchedItemStore.php:67
WatchedItemStore\countWatchers
countWatchers(LinkTarget $target)
Definition: WatchedItemStore.php:331
WatchedItemStore\loadWatchedItem
loadWatchedItem(User $user, LinkTarget $target)
Definition: WatchedItemStore.php:520
$job
if(count( $args)< 1) $job
Definition: recompressTracked.php:48
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
WatchedItemStore\getCached
getCached(User $user, LinkTarget $target)
Definition: WatchedItemStore.php:199
WatchedItem\getLinkTarget
getLinkTarget()
Definition: WatchedItem.php:73
WatchedItemStore\countVisitingWatchersMultiple
countVisitingWatchersMultiple(array $targetsWithVisitThresholds, $minimumWatchers=null)
Definition: WatchedItemStore.php:412
WatchedItemStore\setStatsdDataFactory
setStatsdDataFactory(StatsdDataFactoryInterface $stats)
Definition: WatchedItemStore.php:96
ClearUserWatchlistJob\newForUser
static newForUser(User $user, $maxWatchlistId)
Definition: ClearUserWatchlistJob.php:21
$batch
$batch
Definition: linkcache.txt:23
WatchedItemStore\clearUserWatchedItemsUsingJobQueue
clearUserWatchedItemsUsingJobQueue(User $user)
Queues a job that will clear the users watchlist using the Job Queue.
Definition: WatchedItemStore.php:287
class
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
MediaWiki\Linker\LinkTarget
Definition: LinkTarget.php:26
WatchedItemStore\isWatched
isWatched(User $user, LinkTarget $target)
Definition: WatchedItemStore.php:598
WatchedItemStore\$revisionGetTimestampFromIdCallback
callable null $revisionGetTimestampFromIdCallback
Definition: WatchedItemStore.php:57
WatchedItemStore\getNotificationTimestamp
getNotificationTimestamp(User $user, Title $title, $item, $force, $oldid)
Definition: WatchedItemStore.php:905
WatchedItemStoreInterface
Definition: WatchedItemStoreInterface.php:28
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition: User.php:47
DeferredUpdates\addCallableUpdate
static addCallableUpdate( $callable, $stage=self::POSTSEND, $dbw=null)
Add a callable update.
Definition: DeferredUpdates.php:118
WatchedItemStore\getCacheKey
getCacheKey(User $user, LinkTarget $target)
Definition: WatchedItemStore.php:147
WatchedItemStore\$updateRowsPerQuery
int $updateRowsPerQuery
Definition: WatchedItemStore.php:62
WatchedItemStore\countWatchersMultiple
countWatchersMultiple(array $targets, array $options=[])
Definition: WatchedItemStore.php:376
Wikimedia\Rdbms\ILBFactory
An interface for generating database load balancers.
Definition: ILBFactory.php:33
WatchedItemStore\cache
cache(WatchedItem $item)
Definition: WatchedItemStore.php:155
TitleValue
Represents a page (or page fragment) title within MediaWiki.
Definition: TitleValue.php:36