3 use Wikimedia\Assert\Assert
;
6 * Storage layer class for WatchedItems.
7 * Database interaction.
13 class WatchedItemStore
{
18 private $loadBalancer;
26 * @var array[] Looks like $cacheIndex[Namespace ID][Target DB Key][User Id] => 'key'
27 * The index is needed so that on mass changes all relevant items can be un-cached.
28 * For example: Clearing a users watchlist of all items or updating notification timestamps
29 * for all users watching a single target.
31 private $cacheIndex = [];
36 private $deferredUpdatesAddCallableUpdateCallback;
41 private $revisionGetTimestampFromIdCallback;
46 private static $instance;
49 * @param LoadBalancer $loadBalancer
50 * @param HashBagOStuff $cache
52 public function __construct(
53 LoadBalancer
$loadBalancer,
56 $this->loadBalancer
= $loadBalancer;
57 $this->cache
= $cache;
58 $this->deferredUpdatesAddCallableUpdateCallback
= [ 'DeferredUpdates', 'addCallableUpdate' ];
59 $this->revisionGetTimestampFromIdCallback
= [ 'Revision', 'getTimestampFromId' ];
63 * Overrides the DeferredUpdates::addCallableUpdate callback
64 * This is intended for use while testing and will fail if MW_PHPUNIT_TEST is not defined.
66 * @param callable $callback
68 * @see DeferredUpdates::addCallableUpdate for callback signiture
70 * @return ScopedCallback to reset the overridden value
73 public function overrideDeferredUpdatesAddCallableUpdateCallback( $callback ) {
74 if ( !defined( 'MW_PHPUNIT_TEST' ) ) {
75 throw new MWException(
76 'Cannot override DeferredUpdates::addCallableUpdate callback in operation.'
79 Assert
::parameterType( 'callable', $callback, '$callback' );
81 $previousValue = $this->deferredUpdatesAddCallableUpdateCallback
;
82 $this->deferredUpdatesAddCallableUpdateCallback
= $callback;
83 return new ScopedCallback( function() use ( $previousValue ) {
84 $this->deferredUpdatesAddCallableUpdateCallback
= $previousValue;
89 * Overrides the Revision::getTimestampFromId callback
90 * This is intended for use while testing and will fail if MW_PHPUNIT_TEST is not defined.
92 * @param callable $callback
93 * @see Revision::getTimestampFromId for callback signiture
95 * @return ScopedCallback to reset the overridden value
98 public function overrideRevisionGetTimestampFromIdCallback( $callback ) {
99 if ( !defined( 'MW_PHPUNIT_TEST' ) ) {
100 throw new MWException(
101 'Cannot override Revision::getTimestampFromId callback in operation.'
104 Assert
::parameterType( 'callable', $callback, '$callback' );
106 $previousValue = $this->revisionGetTimestampFromIdCallback
;
107 $this->revisionGetTimestampFromIdCallback
= $callback;
108 return new ScopedCallback( function() use ( $previousValue ) {
109 $this->revisionGetTimestampFromIdCallback
= $previousValue;
114 * Overrides the default instance of this class
115 * This is intended for use while testing and will fail if MW_PHPUNIT_TEST is not defined.
117 * If this method is used it MUST also be called with null after a test to ensure a new
118 * default instance is created next time getDefaultInstance is called.
120 * @param WatchedItemStore|null $store
122 * @return ScopedCallback to reset the overridden value
123 * @throws MWException
125 public static function overrideDefaultInstance( WatchedItemStore
$store = null ) {
126 if ( !defined( 'MW_PHPUNIT_TEST' ) ) {
127 throw new MWException(
128 'Cannot override ' . __CLASS__
. 'default instance in operation.'
132 $previousValue = self
::$instance;
133 self
::$instance = $store;
134 return new ScopedCallback( function() use ( $previousValue ) {
135 self
::$instance = $previousValue;
142 public static function getDefaultInstance() {
143 if ( !self
::$instance ) {
144 self
::$instance = new self(
146 new HashBagOStuff( [ 'maxKeys' => 100 ] )
149 return self
::$instance;
152 private function getCacheKey( User
$user, LinkTarget
$target ) {
153 return $this->cache
->makeKey(
154 (string)$target->getNamespace(),
156 (string)$user->getId()
160 private function cache( WatchedItem
$item ) {
161 $user = $item->getUser();
162 $target = $item->getLinkTarget();
163 $key = $this->getCacheKey( $user, $target );
164 $this->cache
->set( $key, $item );
165 $this->cacheIndex
[$target->getNamespace()][$target->getDBkey()][$user->getId()] = $key;
168 private function uncache( User
$user, LinkTarget
$target ) {
169 $this->cache
->delete( $this->getCacheKey( $user, $target ) );
170 unset( $this->cacheIndex
[$target->getNamespace()][$target->getDBkey()][$user->getId()] );
173 private function uncacheLinkTarget( LinkTarget
$target ) {
174 if ( !isset( $this->cacheIndex
[$target->getNamespace()][$target->getDBkey()] ) ) {
177 foreach ( $this->cacheIndex
[$target->getNamespace()][$target->getDBkey()] as $key ) {
178 $this->cache
->delete( $key );
184 * @param LinkTarget $target
186 * @return WatchedItem|null
188 private function getCached( User
$user, LinkTarget
$target ) {
189 return $this->cache
->get( $this->getCacheKey( $user, $target ) );
193 * Return an array of conditions to select or update the appropriate database
197 * @param LinkTarget $target
201 private function dbCond( User
$user, LinkTarget
$target ) {
203 'wl_user' => $user->getId(),
204 'wl_namespace' => $target->getNamespace(),
205 'wl_title' => $target->getDBkey(),
210 * @param int $slaveOrMaster DB_MASTER or DB_SLAVE
212 * @return DatabaseBase
213 * @throws MWException
215 private function getConnection( $slaveOrMaster ) {
216 return $this->loadBalancer
->getConnection( $slaveOrMaster, [ 'watchlist' ] );
220 * @param DatabaseBase $connection
222 * @throws MWException
224 private function reuseConnection( $connection ) {
225 $this->loadBalancer
->reuseConnection( $connection );
229 * Count the number of individual items that are watched by the user.
230 * If a subject and corresponding talk page are watched this will return 2.
236 public function countWatchedItems( User
$user ) {
237 $dbr = $this->getConnection( DB_SLAVE
);
238 $return = (int)$dbr->selectField(
242 'wl_user' => $user->getId()
246 $this->reuseConnection( $dbr );
252 * @param LinkTarget $target
256 public function countWatchers( LinkTarget
$target ) {
257 $dbr = $this->getConnection( DB_SLAVE
);
258 $return = (int)$dbr->selectField(
262 'wl_namespace' => $target->getNamespace(),
263 'wl_title' => $target->getDBkey(),
267 $this->reuseConnection( $dbr );
273 * Number of page watchers who also visited a "recent" edit
275 * @param LinkTarget $target
276 * @param mixed $threshold timestamp accepted by wfTimestamp
279 * @throws DBUnexpectedError
280 * @throws MWException
282 public function countVisitingWatchers( LinkTarget
$target, $threshold ) {
283 $dbr = $this->getConnection( DB_SLAVE
);
284 $visitingWatchers = (int)$dbr->selectField(
288 'wl_namespace' => $target->getNamespace(),
289 'wl_title' => $target->getDBkey(),
290 'wl_notificationtimestamp >= ' .
291 $dbr->addQuotes( $dbr->timestamp( $threshold ) ) .
292 ' OR wl_notificationtimestamp IS NULL'
296 $this->reuseConnection( $dbr );
298 return $visitingWatchers;
302 * @param LinkTarget[] $targets
303 * @param array $options Allowed keys:
304 * 'minimumWatchers' => int
306 * @return array multi dimensional like $return[$namespaceId][$titleString] = int $watchers
307 * All targets will be present in the result. 0 either means no watchers or the number
308 * of watchers was below the minimumWatchers option if passed.
310 public function countWatchersMultiple( array $targets, array $options = [] ) {
311 $dbOptions = [ 'GROUP BY' => [ 'wl_namespace', 'wl_title' ] ];
313 $dbr = $this->getConnection( DB_SLAVE
);
315 if ( array_key_exists( 'minimumWatchers', $options ) ) {
316 $dbOptions['HAVING'] = 'COUNT(*) >= ' . (int)$options['minimumWatchers'];
319 $lb = new LinkBatch( $targets );
322 [ 'wl_title', 'wl_namespace', 'watchers' => 'COUNT(*)' ],
323 [ $lb->constructSet( 'wl', $dbr ) ],
328 $this->reuseConnection( $dbr );
331 foreach ( $targets as $linkTarget ) {
332 $watchCounts[$linkTarget->getNamespace()][$linkTarget->getDBkey()] = 0;
335 foreach ( $res as $row ) {
336 $watchCounts[$row->wl_namespace
][$row->wl_title
] = (int)$row->watchers
;
343 * Number of watchers of each page who have visited recent edits to that page
345 * @param array $targetsWithVisitThresholds array of pairs (LinkTarget $target, mixed $threshold),
347 * - a timestamp of the recent edit if $target exists (format accepted by wfTimestamp)
348 * - null if $target doesn't exist
349 * @param int|null $minimumWatchers
350 * @return array multi-dimensional like $return[$namespaceId][$titleString] = $watchers,
351 * where $watchers is an int:
352 * - if the page exists, number of users watching who have visited the page recently
353 * - if the page doesn't exist, number of users that have the page on their watchlist
354 * - 0 means there are no visiting watchers or their number is below the minimumWatchers
355 * option (if passed).
357 public function countVisitingWatchersMultiple(
358 array $targetsWithVisitThresholds,
359 $minimumWatchers = null
361 $dbr = $this->getConnection( DB_SLAVE
);
363 $conds = $this->getVisitingWatchersCondition( $dbr, $targetsWithVisitThresholds );
365 $dbOptions = [ 'GROUP BY' => [ 'wl_namespace', 'wl_title' ] ];
366 if ( $minimumWatchers !== null ) {
367 $dbOptions['HAVING'] = 'COUNT(*) >= ' . (int)$minimumWatchers;
371 [ 'wl_namespace', 'wl_title', 'watchers' => 'COUNT(*)' ],
377 $this->reuseConnection( $dbr );
380 foreach ( $targetsWithVisitThresholds as list( $target ) ) {
381 /* @var LinkTarget $target */
382 $watcherCounts[$target->getNamespace()][$target->getDBkey()] = 0;
385 foreach ( $res as $row ) {
386 $watcherCounts[$row->wl_namespace
][$row->wl_title
] = (int)$row->watchers
;
389 return $watcherCounts;
393 * Generates condition for the query used in a batch count visiting watchers.
395 * @param IDatabase $db
396 * @param array $targetsWithVisitThresholds array of pairs (LinkTarget, last visit threshold)
399 private function getVisitingWatchersCondition(
401 array $targetsWithVisitThresholds
403 $missingTargets = [];
404 $namespaceConds = [];
405 foreach ( $targetsWithVisitThresholds as list( $target, $threshold ) ) {
406 if ( $threshold === null ) {
407 $missingTargets[] = $target;
410 /* @var LinkTarget $target */
411 $namespaceConds[$target->getNamespace()][] = $db->makeList( [
412 'wl_title = ' . $db->addQuotes( $target->getDBkey() ),
414 'wl_notificationtimestamp >= ' . $db->addQuotes( $db->timestamp( $threshold ) ),
415 'wl_notificationtimestamp IS NULL'
421 foreach ( $namespaceConds as $namespace => $pageConds ) {
422 $conds[] = $db->makeList( [
423 'wl_namespace = ' . $namespace,
424 '(' . $db->makeList( $pageConds, LIST_OR
) . ')'
428 if ( $missingTargets ) {
429 $lb = new LinkBatch( $missingTargets );
430 $conds[] = $lb->constructSet( 'wl', $db );
433 return $db->makeList( $conds, LIST_OR
);
437 * Get an item (may be cached)
440 * @param LinkTarget $target
442 * @return WatchedItem|false
444 public function getWatchedItem( User
$user, LinkTarget
$target ) {
445 if ( $user->isAnon() ) {
449 $cached = $this->getCached( $user, $target );
453 return $this->loadWatchedItem( $user, $target );
457 * Loads an item from the db
460 * @param LinkTarget $target
462 * @return WatchedItem|false
464 public function loadWatchedItem( User
$user, LinkTarget
$target ) {
465 // Only loggedin user can have a watchlist
466 if ( $user->isAnon() ) {
470 $dbr = $this->getConnection( DB_SLAVE
);
471 $row = $dbr->selectRow(
473 'wl_notificationtimestamp',
474 $this->dbCond( $user, $target ),
477 $this->reuseConnection( $dbr );
483 $item = new WatchedItem(
486 $row->wl_notificationtimestamp
488 $this->cache( $item );
495 * @param array $options Allowed keys:
496 * 'forWrite' => bool defaults to false
498 * @return WatchedItem[]
500 public function getWatchedItemsForUser( User
$user, array $options = [] ) {
501 $options +
= [ 'forWrite' => false ];
503 $db = $this->getConnection( $options['forWrite'] ? DB_MASTER
: DB_SLAVE
);
506 [ 'wl_namespace', 'wl_title', 'wl_notificationtimestamp' ],
507 [ 'wl_user' => $user->getId() ],
510 $this->reuseConnection( $db );
513 foreach ( $res as $row ) {
514 // todo these could all be cached at some point?
515 $watchedItems[] = new WatchedItem(
517 new TitleValue( (int)$row->wl_namespace
, $row->wl_title
),
518 $row->wl_notificationtimestamp
522 return $watchedItems;
526 * Must be called separately for Subject & Talk namespaces
529 * @param LinkTarget $target
533 public function isWatched( User
$user, LinkTarget
$target ) {
534 return (bool)$this->getWatchedItem( $user, $target );
539 * @param LinkTarget[] $targets
541 * @return array multi-dimensional like $return[$namespaceId][$titleString] = $timestamp,
542 * where $timestamp is:
543 * - string|null value of wl_notificationtimestamp,
544 * - false if $target is not watched by $user.
546 public function getNotificationTimestampsBatch( User
$user, array $targets ) {
548 foreach ( $targets as $target ) {
549 $timestamps[$target->getNamespace()][$target->getDBkey()] = false;
552 if ( $user->isAnon() ) {
557 foreach ( $targets as $target ) {
558 $cachedItem = $this->getCached( $user, $target );
560 $timestamps[$target->getNamespace()][$target->getDBkey()] =
561 $cachedItem->getNotificationTimestamp();
563 $targetsToLoad[] = $target;
567 if ( !$targetsToLoad ) {
571 $dbr = $this->getConnection( DB_SLAVE
);
573 $lb = new LinkBatch( $targetsToLoad );
576 [ 'wl_namespace', 'wl_title', 'wl_notificationtimestamp' ],
578 $lb->constructSet( 'wl', $dbr ),
579 'wl_user' => $user->getId(),
583 $this->reuseConnection( $dbr );
585 foreach ( $res as $row ) {
586 $timestamps[(int)$row->wl_namespace
][$row->wl_title
] = $row->wl_notificationtimestamp
;
593 * Must be called separately for Subject & Talk namespaces
596 * @param LinkTarget $target
598 public function addWatch( User
$user, LinkTarget
$target ) {
599 $this->addWatchBatch( [ [ $user, $target ] ] );
603 * @param array[] $userTargetCombinations array of arrays containing [0] => User [1] => LinkTarget
605 * @return bool success
607 public function addWatchBatch( array $userTargetCombinations ) {
608 if ( $this->loadBalancer
->getReadOnlyReason() !== false ) {
613 foreach ( $userTargetCombinations as list( $user, $target ) ) {
616 * @var LinkTarget $target
619 // Only loggedin user can have a watchlist
620 if ( $user->isAnon() ) {
624 'wl_user' => $user->getId(),
625 'wl_namespace' => $target->getNamespace(),
626 'wl_title' => $target->getDBkey(),
627 'wl_notificationtimestamp' => null,
629 $this->uncache( $user, $target );
636 $dbw = $this->getConnection( DB_MASTER
);
637 foreach ( array_chunk( $rows, 100 ) as $toInsert ) {
638 // Use INSERT IGNORE to avoid overwriting the notification timestamp
639 // if there's already an entry for this page
640 $dbw->insert( 'watchlist', $toInsert, __METHOD__
, 'IGNORE' );
642 $this->reuseConnection( $dbw );
648 * Removes the an entry for the User watching the LinkTarget
649 * Must be called separately for Subject & Talk namespaces
652 * @param LinkTarget $target
654 * @return bool success
655 * @throws DBUnexpectedError
656 * @throws MWException
658 public function removeWatch( User
$user, LinkTarget
$target ) {
659 // Only logged in user can have a watchlist
660 if ( $this->loadBalancer
->getReadOnlyReason() !== false ||
$user->isAnon() ) {
664 $this->uncache( $user, $target );
666 $dbw = $this->getConnection( DB_MASTER
);
667 $dbw->delete( 'watchlist',
669 'wl_user' => $user->getId(),
670 'wl_namespace' => $target->getNamespace(),
671 'wl_title' => $target->getDBkey(),
674 $success = (bool)$dbw->affectedRows();
675 $this->reuseConnection( $dbw );
681 * @param User $editor The editor that triggered the update. Their notification
682 * timestamp will not be updated(they have already seen it)
683 * @param LinkTarget $target The target to update timestamps for
684 * @param string $timestamp Set the update timestamp to this value
686 * @return int[] Array of user IDs the timestamp has been updated for
688 public function updateNotificationTimestamp( User
$editor, LinkTarget
$target, $timestamp ) {
689 $dbw = $this->getConnection( DB_MASTER
);
690 $res = $dbw->select( [ 'watchlist' ],
693 'wl_user != ' . intval( $editor->getId() ),
694 'wl_namespace' => $target->getNamespace(),
695 'wl_title' => $target->getDBkey(),
696 'wl_notificationtimestamp IS NULL',
701 foreach ( $res as $row ) {
702 $watchers[] = intval( $row->wl_user
);
706 // Update wl_notificationtimestamp for all watching users except the editor
708 $dbw->onTransactionIdle(
709 function () use ( $dbw, $timestamp, $watchers, $target, $fname ) {
710 $dbw->update( 'watchlist',
712 'wl_notificationtimestamp' => $dbw->timestamp( $timestamp )
714 'wl_user' => $watchers,
715 'wl_namespace' => $target->getNamespace(),
716 'wl_title' => $target->getDBkey(),
719 $this->uncacheLinkTarget( $target );
724 $this->reuseConnection( $dbw );
730 * Reset the notification timestamp of this entry
733 * @param Title $title
734 * @param string $force Whether to force the write query to be executed even if the
735 * page is not watched or the notification timestamp is already NULL.
736 * 'force' in order to force
737 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
739 * @return bool success
741 public function resetNotificationTimestamp( User
$user, Title
$title, $force = '', $oldid = 0 ) {
742 // Only loggedin user can have a watchlist
743 if ( $this->loadBalancer
->getReadOnlyReason() !== false ||
$user->isAnon() ) {
748 if ( $force != 'force' ) {
749 $item = $this->loadWatchedItem( $user, $title );
750 if ( !$item ||
$item->getNotificationTimestamp() === null ) {
755 // If the page is watched by the user (or may be watched), update the timestamp
756 $job = new ActivityUpdateJob(
759 'type' => 'updateWatchlistNotification',
760 'userid' => $user->getId(),
761 'notifTime' => $this->getNotificationTimestamp( $user, $title, $item, $force, $oldid ),
766 // Try to run this post-send
767 // Calls DeferredUpdates::addCallableUpdate in normal operation
769 $this->deferredUpdatesAddCallableUpdateCallback
,
770 function() use ( $job ) {
775 $this->uncache( $user, $title );
780 private function getNotificationTimestamp( User
$user, Title
$title, $item, $force, $oldid ) {
782 // No oldid given, assuming latest revision; clear the timestamp.
786 if ( !$title->getNextRevisionID( $oldid ) ) {
787 // Oldid given and is the latest revision for this title; clear the timestamp.
791 if ( $item === null ) {
792 $item = $this->loadWatchedItem( $user, $title );
796 // This can only happen if $force is enabled.
800 // Oldid given and isn't the latest; update the timestamp.
801 // This will result in no further notification emails being sent!
802 // Calls Revision::getTimestampFromId in normal operation
803 $notificationTimestamp = call_user_func(
804 $this->revisionGetTimestampFromIdCallback
,
809 // We need to go one second to the future because of various strict comparisons
810 // throughout the codebase
811 $ts = new MWTimestamp( $notificationTimestamp );
812 $ts->timestamp
->add( new DateInterval( 'PT1S' ) );
813 $notificationTimestamp = $ts->getTimestamp( TS_MW
);
815 if ( $notificationTimestamp < $item->getNotificationTimestamp() ) {
816 if ( $force != 'force' ) {
819 // This is a little silly…
820 return $item->getNotificationTimestamp();
824 return $notificationTimestamp;
829 * @param int $unreadLimit
831 * @return int|bool The number of unread notifications
832 * true if greater than or equal to $unreadLimit
834 public function countUnreadNotifications( User
$user, $unreadLimit = null ) {
836 if ( $unreadLimit !== null ) {
837 $unreadLimit = (int)$unreadLimit;
838 $queryOptions['LIMIT'] = $unreadLimit;
841 $dbr = $this->getConnection( DB_SLAVE
);
842 $rowCount = $dbr->selectRowCount(
846 'wl_user' => $user->getId(),
847 'wl_notificationtimestamp IS NOT NULL',
852 $this->reuseConnection( $dbr );
854 if ( !isset( $unreadLimit ) ) {
858 if ( $rowCount >= $unreadLimit ) {
866 * Check if the given title already is watched by the user, and if so
867 * add a watch for the new title.
869 * To be used for page renames and such.
871 * @param LinkTarget $oldTarget
872 * @param LinkTarget $newTarget
874 public function duplicateAllAssociatedEntries( LinkTarget
$oldTarget, LinkTarget
$newTarget ) {
875 if ( !$oldTarget instanceof Title
) {
876 $oldTarget = Title
::newFromLinkTarget( $oldTarget );
878 if ( !$newTarget instanceof Title
) {
879 $newTarget = Title
::newFromLinkTarget( $newTarget );
882 $this->duplicateEntry( $oldTarget->getSubjectPage(), $newTarget->getSubjectPage() );
883 $this->duplicateEntry( $oldTarget->getTalkPage(), $newTarget->getTalkPage() );
887 * Check if the given title already is watched by the user, and if so
888 * add a watch for the new title.
890 * To be used for page renames and such.
891 * This must be called separately for Subject and Talk pages
893 * @param LinkTarget $oldTarget
894 * @param LinkTarget $newTarget
896 public function duplicateEntry( LinkTarget
$oldTarget, LinkTarget
$newTarget ) {
897 $dbw = $this->getConnection( DB_MASTER
);
899 $result = $dbw->select(
901 [ 'wl_user', 'wl_notificationtimestamp' ],
903 'wl_namespace' => $oldTarget->getNamespace(),
904 'wl_title' => $oldTarget->getDBkey(),
910 $newNamespace = $newTarget->getNamespace();
911 $newDBkey = $newTarget->getDBkey();
913 # Construct array to replace into the watchlist
915 foreach ( $result as $row ) {
917 'wl_user' => $row->wl_user
,
918 'wl_namespace' => $newNamespace,
919 'wl_title' => $newDBkey,
920 'wl_notificationtimestamp' => $row->wl_notificationtimestamp
,
924 if ( !empty( $values ) ) {
926 # Note that multi-row replace is very efficient for MySQL but may be inefficient for
927 # some other DBMSes, mostly due to poor simulation by us
930 [ [ 'wl_user', 'wl_namespace', 'wl_title' ] ],
936 $this->reuseConnection( $dbw );