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 * Get an item (may be cached)
346 * @param LinkTarget $target
348 * @return WatchedItem|false
350 public function getWatchedItem( User
$user, LinkTarget
$target ) {
351 if ( $user->isAnon() ) {
355 $cached = $this->getCached( $user, $target );
359 return $this->loadWatchedItem( $user, $target );
363 * Loads an item from the db
366 * @param LinkTarget $target
368 * @return WatchedItem|false
370 public function loadWatchedItem( User
$user, LinkTarget
$target ) {
371 // Only loggedin user can have a watchlist
372 if ( $user->isAnon() ) {
376 $dbr = $this->getConnection( DB_SLAVE
);
377 $row = $dbr->selectRow(
379 'wl_notificationtimestamp',
380 $this->dbCond( $user, $target ),
383 $this->reuseConnection( $dbr );
389 $item = new WatchedItem(
392 $row->wl_notificationtimestamp
394 $this->cache( $item );
401 * @param array $options Allowed keys:
402 * 'forWrite' => bool defaults to false
404 * @return WatchedItem[]
406 public function getWatchedItemsForUser( User
$user, array $options = [] ) {
407 $options +
= [ 'forWrite' => false ];
409 $db = $this->getConnection( $options['forWrite'] ? DB_MASTER
: DB_SLAVE
);
412 [ 'wl_namespace', 'wl_title', 'wl_notificationtimestamp' ],
413 [ 'wl_user' => $user->getId() ],
416 $this->reuseConnection( $db );
419 foreach ( $res as $row ) {
420 // todo these could all be cached at some point?
421 $watchedItems[] = new WatchedItem(
423 new TitleValue( (int)$row->wl_namespace
, $row->wl_title
),
424 $row->wl_notificationtimestamp
428 return $watchedItems;
432 * Must be called separately for Subject & Talk namespaces
435 * @param LinkTarget $target
439 public function isWatched( User
$user, LinkTarget
$target ) {
440 return (bool)$this->getWatchedItem( $user, $target );
444 * Must be called separately for Subject & Talk namespaces
447 * @param LinkTarget $target
449 public function addWatch( User
$user, LinkTarget
$target ) {
450 $this->addWatchBatch( [ [ $user, $target ] ] );
454 * @param array[] $userTargetCombinations array of arrays containing [0] => User [1] => LinkTarget
456 * @return bool success
458 public function addWatchBatch( array $userTargetCombinations ) {
459 if ( $this->loadBalancer
->getReadOnlyReason() !== false ) {
464 foreach ( $userTargetCombinations as list( $user, $target ) ) {
467 * @var LinkTarget $target
470 // Only loggedin user can have a watchlist
471 if ( $user->isAnon() ) {
475 'wl_user' => $user->getId(),
476 'wl_namespace' => $target->getNamespace(),
477 'wl_title' => $target->getDBkey(),
478 'wl_notificationtimestamp' => null,
480 $this->uncache( $user, $target );
487 $dbw = $this->getConnection( DB_MASTER
);
488 foreach ( array_chunk( $rows, 100 ) as $toInsert ) {
489 // Use INSERT IGNORE to avoid overwriting the notification timestamp
490 // if there's already an entry for this page
491 $dbw->insert( 'watchlist', $toInsert, __METHOD__
, 'IGNORE' );
493 $this->reuseConnection( $dbw );
499 * Removes the an entry for the User watching the LinkTarget
500 * Must be called separately for Subject & Talk namespaces
503 * @param LinkTarget $target
505 * @return bool success
506 * @throws DBUnexpectedError
507 * @throws MWException
509 public function removeWatch( User
$user, LinkTarget
$target ) {
510 // Only logged in user can have a watchlist
511 if ( $this->loadBalancer
->getReadOnlyReason() !== false ||
$user->isAnon() ) {
515 $this->uncache( $user, $target );
517 $dbw = $this->getConnection( DB_MASTER
);
518 $dbw->delete( 'watchlist',
520 'wl_user' => $user->getId(),
521 'wl_namespace' => $target->getNamespace(),
522 'wl_title' => $target->getDBkey(),
525 $success = (bool)$dbw->affectedRows();
526 $this->reuseConnection( $dbw );
532 * @param User $editor The editor that triggered the update. Their notification
533 * timestamp will not be updated(they have already seen it)
534 * @param LinkTarget $target The target to update timestamps for
535 * @param string $timestamp Set the update timestamp to this value
537 * @return int[] Array of user IDs the timestamp has been updated for
539 public function updateNotificationTimestamp( User
$editor, LinkTarget
$target, $timestamp ) {
540 $dbw = $this->getConnection( DB_MASTER
);
541 $res = $dbw->select( [ 'watchlist' ],
544 'wl_user != ' . intval( $editor->getId() ),
545 'wl_namespace' => $target->getNamespace(),
546 'wl_title' => $target->getDBkey(),
547 'wl_notificationtimestamp IS NULL',
552 foreach ( $res as $row ) {
553 $watchers[] = intval( $row->wl_user
);
557 // Update wl_notificationtimestamp for all watching users except the editor
559 $dbw->onTransactionIdle(
560 function () use ( $dbw, $timestamp, $watchers, $target, $fname ) {
561 $dbw->update( 'watchlist',
563 'wl_notificationtimestamp' => $dbw->timestamp( $timestamp )
565 'wl_user' => $watchers,
566 'wl_namespace' => $target->getNamespace(),
567 'wl_title' => $target->getDBkey(),
570 $this->uncacheLinkTarget( $target );
575 $this->reuseConnection( $dbw );
581 * Reset the notification timestamp of this entry
584 * @param Title $title
585 * @param string $force Whether to force the write query to be executed even if the
586 * page is not watched or the notification timestamp is already NULL.
587 * 'force' in order to force
588 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
590 * @return bool success
592 public function resetNotificationTimestamp( User
$user, Title
$title, $force = '', $oldid = 0 ) {
593 // Only loggedin user can have a watchlist
594 if ( $this->loadBalancer
->getReadOnlyReason() !== false ||
$user->isAnon() ) {
599 if ( $force != 'force' ) {
600 $item = $this->loadWatchedItem( $user, $title );
601 if ( !$item ||
$item->getNotificationTimestamp() === null ) {
606 // If the page is watched by the user (or may be watched), update the timestamp
607 $job = new ActivityUpdateJob(
610 'type' => 'updateWatchlistNotification',
611 'userid' => $user->getId(),
612 'notifTime' => $this->getNotificationTimestamp( $user, $title, $item, $force, $oldid ),
617 // Try to run this post-send
618 // Calls DeferredUpdates::addCallableUpdate in normal operation
620 $this->deferredUpdatesAddCallableUpdateCallback
,
621 function() use ( $job ) {
626 $this->uncache( $user, $title );
631 private function getNotificationTimestamp( User
$user, Title
$title, $item, $force, $oldid ) {
633 // No oldid given, assuming latest revision; clear the timestamp.
637 if ( !$title->getNextRevisionID( $oldid ) ) {
638 // Oldid given and is the latest revision for this title; clear the timestamp.
642 if ( $item === null ) {
643 $item = $this->loadWatchedItem( $user, $title );
647 // This can only happen if $force is enabled.
651 // Oldid given and isn't the latest; update the timestamp.
652 // This will result in no further notification emails being sent!
653 // Calls Revision::getTimestampFromId in normal operation
654 $notificationTimestamp = call_user_func(
655 $this->revisionGetTimestampFromIdCallback
,
660 // We need to go one second to the future because of various strict comparisons
661 // throughout the codebase
662 $ts = new MWTimestamp( $notificationTimestamp );
663 $ts->timestamp
->add( new DateInterval( 'PT1S' ) );
664 $notificationTimestamp = $ts->getTimestamp( TS_MW
);
666 if ( $notificationTimestamp < $item->getNotificationTimestamp() ) {
667 if ( $force != 'force' ) {
670 // This is a little silly…
671 return $item->getNotificationTimestamp();
675 return $notificationTimestamp;
680 * @param int $unreadLimit
682 * @return int|bool The number of unread notifications
683 * true if greater than or equal to $unreadLimit
685 public function countUnreadNotifications( User
$user, $unreadLimit = null ) {
687 if ( $unreadLimit !== null ) {
688 $unreadLimit = (int)$unreadLimit;
689 $queryOptions['LIMIT'] = $unreadLimit;
692 $dbr = $this->getConnection( DB_SLAVE
);
693 $rowCount = $dbr->selectRowCount(
697 'wl_user' => $user->getId(),
698 'wl_notificationtimestamp IS NOT NULL',
703 $this->reuseConnection( $dbr );
705 if ( !isset( $unreadLimit ) ) {
709 if ( $rowCount >= $unreadLimit ) {
717 * Check if the given title already is watched by the user, and if so
718 * add a watch for the new title.
720 * To be used for page renames and such.
722 * @param LinkTarget $oldTarget
723 * @param LinkTarget $newTarget
725 public function duplicateAllAssociatedEntries( LinkTarget
$oldTarget, LinkTarget
$newTarget ) {
726 if ( !$oldTarget instanceof Title
) {
727 $oldTarget = Title
::newFromLinkTarget( $oldTarget );
729 if ( !$newTarget instanceof Title
) {
730 $newTarget = Title
::newFromLinkTarget( $newTarget );
733 $this->duplicateEntry( $oldTarget->getSubjectPage(), $newTarget->getSubjectPage() );
734 $this->duplicateEntry( $oldTarget->getTalkPage(), $newTarget->getTalkPage() );
738 * Check if the given title already is watched by the user, and if so
739 * add a watch for the new title.
741 * To be used for page renames and such.
742 * This must be called separately for Subject and Talk pages
744 * @param LinkTarget $oldTarget
745 * @param LinkTarget $newTarget
747 public function duplicateEntry( LinkTarget
$oldTarget, LinkTarget
$newTarget ) {
748 $dbw = $this->getConnection( DB_MASTER
);
750 $result = $dbw->select(
752 [ 'wl_user', 'wl_notificationtimestamp' ],
754 'wl_namespace' => $oldTarget->getNamespace(),
755 'wl_title' => $oldTarget->getDBkey(),
761 $newNamespace = $newTarget->getNamespace();
762 $newDBkey = $newTarget->getDBkey();
764 # Construct array to replace into the watchlist
766 foreach ( $result as $row ) {
768 'wl_user' => $row->wl_user
,
769 'wl_namespace' => $newNamespace,
770 'wl_title' => $newDBkey,
771 'wl_notificationtimestamp' => $row->wl_notificationtimestamp
,
775 if ( !empty( $values ) ) {
777 # Note that multi-row replace is very efficient for MySQL but may be inefficient for
778 # some other DBMSes, mostly due to poor simulation by us
781 [ [ 'wl_user', 'wl_namespace', 'wl_title' ] ],
787 $this->reuseConnection( $dbw );