Merge "Special:Upload should not crash on failing previews"
[mediawiki.git] / includes / WatchedItemStore.php
blob3cdc59cda0ebbf5e3ae9e0abf046276279631ed0
1 <?php
3 use Liuggio\StatsdClient\Factory\StatsdDataFactoryInterface;
4 use MediaWiki\Linker\LinkTarget;
5 use Wikimedia\Assert\Assert;
6 use Wikimedia\ScopedCallback;
8 /**
9 * Storage layer class for WatchedItems.
10 * Database interaction.
12 * @author Addshore
14 * @since 1.27
16 class WatchedItemStore implements StatsdAwareInterface {
18 const SORT_DESC = 'DESC';
19 const SORT_ASC = 'ASC';
21 /**
22 * @var LoadBalancer
24 private $loadBalancer;
26 /**
27 * @var HashBagOStuff
29 private $cache;
31 /**
32 * @var array[] Looks like $cacheIndex[Namespace ID][Target DB Key][User Id] => 'key'
33 * The index is needed so that on mass changes all relevant items can be un-cached.
34 * For example: Clearing a users watchlist of all items or updating notification timestamps
35 * for all users watching a single target.
37 private $cacheIndex = [];
39 /**
40 * @var callable|null
42 private $deferredUpdatesAddCallableUpdateCallback;
44 /**
45 * @var callable|null
47 private $revisionGetTimestampFromIdCallback;
49 /**
50 * @var StatsdDataFactoryInterface
52 private $stats;
54 /**
55 * @param LoadBalancer $loadBalancer
56 * @param HashBagOStuff $cache
58 public function __construct(
59 LoadBalancer $loadBalancer,
60 HashBagOStuff $cache
61 ) {
62 $this->loadBalancer = $loadBalancer;
63 $this->cache = $cache;
64 $this->stats = new NullStatsdDataFactory();
65 $this->deferredUpdatesAddCallableUpdateCallback = [ 'DeferredUpdates', 'addCallableUpdate' ];
66 $this->revisionGetTimestampFromIdCallback = [ 'Revision', 'getTimestampFromId' ];
69 public function setStatsdDataFactory( StatsdDataFactoryInterface $stats ) {
70 $this->stats = $stats;
73 /**
74 * Overrides the DeferredUpdates::addCallableUpdate callback
75 * This is intended for use while testing and will fail if MW_PHPUNIT_TEST is not defined.
77 * @param callable $callback
79 * @see DeferredUpdates::addCallableUpdate for callback signiture
81 * @return ScopedCallback to reset the overridden value
82 * @throws MWException
84 public function overrideDeferredUpdatesAddCallableUpdateCallback( callable $callback ) {
85 if ( !defined( 'MW_PHPUNIT_TEST' ) ) {
86 throw new MWException(
87 'Cannot override DeferredUpdates::addCallableUpdate callback in operation.'
90 $previousValue = $this->deferredUpdatesAddCallableUpdateCallback;
91 $this->deferredUpdatesAddCallableUpdateCallback = $callback;
92 return new ScopedCallback( function() use ( $previousValue ) {
93 $this->deferredUpdatesAddCallableUpdateCallback = $previousValue;
94 } );
97 /**
98 * Overrides the Revision::getTimestampFromId callback
99 * This is intended for use while testing and will fail if MW_PHPUNIT_TEST is not defined.
101 * @param callable $callback
102 * @see Revision::getTimestampFromId for callback signiture
104 * @return ScopedCallback to reset the overridden value
105 * @throws MWException
107 public function overrideRevisionGetTimestampFromIdCallback( callable $callback ) {
108 if ( !defined( 'MW_PHPUNIT_TEST' ) ) {
109 throw new MWException(
110 'Cannot override Revision::getTimestampFromId callback in operation.'
113 $previousValue = $this->revisionGetTimestampFromIdCallback;
114 $this->revisionGetTimestampFromIdCallback = $callback;
115 return new ScopedCallback( function() use ( $previousValue ) {
116 $this->revisionGetTimestampFromIdCallback = $previousValue;
117 } );
120 private function getCacheKey( User $user, LinkTarget $target ) {
121 return $this->cache->makeKey(
122 (string)$target->getNamespace(),
123 $target->getDBkey(),
124 (string)$user->getId()
128 private function cache( WatchedItem $item ) {
129 $user = $item->getUser();
130 $target = $item->getLinkTarget();
131 $key = $this->getCacheKey( $user, $target );
132 $this->cache->set( $key, $item );
133 $this->cacheIndex[$target->getNamespace()][$target->getDBkey()][$user->getId()] = $key;
134 $this->stats->increment( 'WatchedItemStore.cache' );
137 private function uncache( User $user, LinkTarget $target ) {
138 $this->cache->delete( $this->getCacheKey( $user, $target ) );
139 unset( $this->cacheIndex[$target->getNamespace()][$target->getDBkey()][$user->getId()] );
140 $this->stats->increment( 'WatchedItemStore.uncache' );
143 private function uncacheLinkTarget( LinkTarget $target ) {
144 $this->stats->increment( 'WatchedItemStore.uncacheLinkTarget' );
145 if ( !isset( $this->cacheIndex[$target->getNamespace()][$target->getDBkey()] ) ) {
146 return;
148 foreach ( $this->cacheIndex[$target->getNamespace()][$target->getDBkey()] as $key ) {
149 $this->stats->increment( 'WatchedItemStore.uncacheLinkTarget.items' );
150 $this->cache->delete( $key );
154 private function uncacheUser( User $user ) {
155 $this->stats->increment( 'WatchedItemStore.uncacheUser' );
156 foreach ( $this->cacheIndex as $ns => $dbKeyArray ) {
157 foreach ( $dbKeyArray as $dbKey => $userArray ) {
158 if ( isset( $userArray[$user->getId()] ) ) {
159 $this->stats->increment( 'WatchedItemStore.uncacheUser.items' );
160 $this->cache->delete( $userArray[$user->getId()] );
167 * @param User $user
168 * @param LinkTarget $target
170 * @return WatchedItem|false
172 private function getCached( User $user, LinkTarget $target ) {
173 return $this->cache->get( $this->getCacheKey( $user, $target ) );
177 * Return an array of conditions to select or update the appropriate database
178 * row.
180 * @param User $user
181 * @param LinkTarget $target
183 * @return array
185 private function dbCond( User $user, LinkTarget $target ) {
186 return [
187 'wl_user' => $user->getId(),
188 'wl_namespace' => $target->getNamespace(),
189 'wl_title' => $target->getDBkey(),
194 * @param int $dbIndex DB_MASTER or DB_REPLICA
196 * @return IDatabase
197 * @throws MWException
199 private function getConnectionRef( $dbIndex ) {
200 return $this->loadBalancer->getConnectionRef( $dbIndex, [ 'watchlist' ] );
204 * Count the number of individual items that are watched by the user.
205 * If a subject and corresponding talk page are watched this will return 2.
207 * @param User $user
209 * @return int
211 public function countWatchedItems( User $user ) {
212 $dbr = $this->getConnectionRef( DB_REPLICA );
213 $return = (int)$dbr->selectField(
214 'watchlist',
215 'COUNT(*)',
217 'wl_user' => $user->getId()
219 __METHOD__
222 return $return;
226 * @param LinkTarget $target
228 * @return int
230 public function countWatchers( LinkTarget $target ) {
231 $dbr = $this->getConnectionRef( DB_REPLICA );
232 $return = (int)$dbr->selectField(
233 'watchlist',
234 'COUNT(*)',
236 'wl_namespace' => $target->getNamespace(),
237 'wl_title' => $target->getDBkey(),
239 __METHOD__
242 return $return;
246 * Number of page watchers who also visited a "recent" edit
248 * @param LinkTarget $target
249 * @param mixed $threshold timestamp accepted by wfTimestamp
251 * @return int
252 * @throws DBUnexpectedError
253 * @throws MWException
255 public function countVisitingWatchers( LinkTarget $target, $threshold ) {
256 $dbr = $this->getConnectionRef( DB_REPLICA );
257 $visitingWatchers = (int)$dbr->selectField(
258 'watchlist',
259 'COUNT(*)',
261 'wl_namespace' => $target->getNamespace(),
262 'wl_title' => $target->getDBkey(),
263 'wl_notificationtimestamp >= ' .
264 $dbr->addQuotes( $dbr->timestamp( $threshold ) ) .
265 ' OR wl_notificationtimestamp IS NULL'
267 __METHOD__
270 return $visitingWatchers;
274 * @param LinkTarget[] $targets
275 * @param array $options Allowed keys:
276 * 'minimumWatchers' => int
278 * @return array multi dimensional like $return[$namespaceId][$titleString] = int $watchers
279 * All targets will be present in the result. 0 either means no watchers or the number
280 * of watchers was below the minimumWatchers option if passed.
282 public function countWatchersMultiple( array $targets, array $options = [] ) {
283 $dbOptions = [ 'GROUP BY' => [ 'wl_namespace', 'wl_title' ] ];
285 $dbr = $this->getConnectionRef( DB_REPLICA );
287 if ( array_key_exists( 'minimumWatchers', $options ) ) {
288 $dbOptions['HAVING'] = 'COUNT(*) >= ' . (int)$options['minimumWatchers'];
291 $lb = new LinkBatch( $targets );
292 $res = $dbr->select(
293 'watchlist',
294 [ 'wl_title', 'wl_namespace', 'watchers' => 'COUNT(*)' ],
295 [ $lb->constructSet( 'wl', $dbr ) ],
296 __METHOD__,
297 $dbOptions
300 $watchCounts = [];
301 foreach ( $targets as $linkTarget ) {
302 $watchCounts[$linkTarget->getNamespace()][$linkTarget->getDBkey()] = 0;
305 foreach ( $res as $row ) {
306 $watchCounts[$row->wl_namespace][$row->wl_title] = (int)$row->watchers;
309 return $watchCounts;
313 * Number of watchers of each page who have visited recent edits to that page
315 * @param array $targetsWithVisitThresholds array of pairs (LinkTarget $target, mixed $threshold),
316 * $threshold is:
317 * - a timestamp of the recent edit if $target exists (format accepted by wfTimestamp)
318 * - null if $target doesn't exist
319 * @param int|null $minimumWatchers
320 * @return array multi-dimensional like $return[$namespaceId][$titleString] = $watchers,
321 * where $watchers is an int:
322 * - if the page exists, number of users watching who have visited the page recently
323 * - if the page doesn't exist, number of users that have the page on their watchlist
324 * - 0 means there are no visiting watchers or their number is below the minimumWatchers
325 * option (if passed).
327 public function countVisitingWatchersMultiple(
328 array $targetsWithVisitThresholds,
329 $minimumWatchers = null
331 $dbr = $this->getConnectionRef( DB_REPLICA );
333 $conds = $this->getVisitingWatchersCondition( $dbr, $targetsWithVisitThresholds );
335 $dbOptions = [ 'GROUP BY' => [ 'wl_namespace', 'wl_title' ] ];
336 if ( $minimumWatchers !== null ) {
337 $dbOptions['HAVING'] = 'COUNT(*) >= ' . (int)$minimumWatchers;
339 $res = $dbr->select(
340 'watchlist',
341 [ 'wl_namespace', 'wl_title', 'watchers' => 'COUNT(*)' ],
342 $conds,
343 __METHOD__,
344 $dbOptions
347 $watcherCounts = [];
348 foreach ( $targetsWithVisitThresholds as list( $target ) ) {
349 /* @var LinkTarget $target */
350 $watcherCounts[$target->getNamespace()][$target->getDBkey()] = 0;
353 foreach ( $res as $row ) {
354 $watcherCounts[$row->wl_namespace][$row->wl_title] = (int)$row->watchers;
357 return $watcherCounts;
361 * Generates condition for the query used in a batch count visiting watchers.
363 * @param IDatabase $db
364 * @param array $targetsWithVisitThresholds array of pairs (LinkTarget, last visit threshold)
365 * @return string
367 private function getVisitingWatchersCondition(
368 IDatabase $db,
369 array $targetsWithVisitThresholds
371 $missingTargets = [];
372 $namespaceConds = [];
373 foreach ( $targetsWithVisitThresholds as list( $target, $threshold ) ) {
374 if ( $threshold === null ) {
375 $missingTargets[] = $target;
376 continue;
378 /* @var LinkTarget $target */
379 $namespaceConds[$target->getNamespace()][] = $db->makeList( [
380 'wl_title = ' . $db->addQuotes( $target->getDBkey() ),
381 $db->makeList( [
382 'wl_notificationtimestamp >= ' . $db->addQuotes( $db->timestamp( $threshold ) ),
383 'wl_notificationtimestamp IS NULL'
384 ], LIST_OR )
385 ], LIST_AND );
388 $conds = [];
389 foreach ( $namespaceConds as $namespace => $pageConds ) {
390 $conds[] = $db->makeList( [
391 'wl_namespace = ' . $namespace,
392 '(' . $db->makeList( $pageConds, LIST_OR ) . ')'
393 ], LIST_AND );
396 if ( $missingTargets ) {
397 $lb = new LinkBatch( $missingTargets );
398 $conds[] = $lb->constructSet( 'wl', $db );
401 return $db->makeList( $conds, LIST_OR );
405 * Get an item (may be cached)
407 * @param User $user
408 * @param LinkTarget $target
410 * @return WatchedItem|false
412 public function getWatchedItem( User $user, LinkTarget $target ) {
413 if ( $user->isAnon() ) {
414 return false;
417 $cached = $this->getCached( $user, $target );
418 if ( $cached ) {
419 $this->stats->increment( 'WatchedItemStore.getWatchedItem.cached' );
420 return $cached;
422 $this->stats->increment( 'WatchedItemStore.getWatchedItem.load' );
423 return $this->loadWatchedItem( $user, $target );
427 * Loads an item from the db
429 * @param User $user
430 * @param LinkTarget $target
432 * @return WatchedItem|false
434 public function loadWatchedItem( User $user, LinkTarget $target ) {
435 // Only loggedin user can have a watchlist
436 if ( $user->isAnon() ) {
437 return false;
440 $dbr = $this->getConnectionRef( DB_REPLICA );
441 $row = $dbr->selectRow(
442 'watchlist',
443 'wl_notificationtimestamp',
444 $this->dbCond( $user, $target ),
445 __METHOD__
448 if ( !$row ) {
449 return false;
452 $item = new WatchedItem(
453 $user,
454 $target,
455 $row->wl_notificationtimestamp
457 $this->cache( $item );
459 return $item;
463 * @param User $user
464 * @param array $options Allowed keys:
465 * 'forWrite' => bool defaults to false
466 * 'sort' => string optional sorting by namespace ID and title
467 * one of the self::SORT_* constants
469 * @return WatchedItem[]
471 public function getWatchedItemsForUser( User $user, array $options = [] ) {
472 $options += [ 'forWrite' => false ];
474 $dbOptions = [];
475 if ( array_key_exists( 'sort', $options ) ) {
476 Assert::parameter(
477 ( in_array( $options['sort'], [ self::SORT_ASC, self::SORT_DESC ] ) ),
478 '$options[\'sort\']',
479 'must be SORT_ASC or SORT_DESC'
481 $dbOptions['ORDER BY'] = [
482 "wl_namespace {$options['sort']}",
483 "wl_title {$options['sort']}"
486 $db = $this->getConnectionRef( $options['forWrite'] ? DB_MASTER : DB_REPLICA );
488 $res = $db->select(
489 'watchlist',
490 [ 'wl_namespace', 'wl_title', 'wl_notificationtimestamp' ],
491 [ 'wl_user' => $user->getId() ],
492 __METHOD__,
493 $dbOptions
496 $watchedItems = [];
497 foreach ( $res as $row ) {
498 // @todo: Should we add these to the process cache?
499 $watchedItems[] = new WatchedItem(
500 $user,
501 new TitleValue( (int)$row->wl_namespace, $row->wl_title ),
502 $row->wl_notificationtimestamp
506 return $watchedItems;
510 * Must be called separately for Subject & Talk namespaces
512 * @param User $user
513 * @param LinkTarget $target
515 * @return bool
517 public function isWatched( User $user, LinkTarget $target ) {
518 return (bool)$this->getWatchedItem( $user, $target );
522 * @param User $user
523 * @param LinkTarget[] $targets
525 * @return array multi-dimensional like $return[$namespaceId][$titleString] = $timestamp,
526 * where $timestamp is:
527 * - string|null value of wl_notificationtimestamp,
528 * - false if $target is not watched by $user.
530 public function getNotificationTimestampsBatch( User $user, array $targets ) {
531 $timestamps = [];
532 foreach ( $targets as $target ) {
533 $timestamps[$target->getNamespace()][$target->getDBkey()] = false;
536 if ( $user->isAnon() ) {
537 return $timestamps;
540 $targetsToLoad = [];
541 foreach ( $targets as $target ) {
542 $cachedItem = $this->getCached( $user, $target );
543 if ( $cachedItem ) {
544 $timestamps[$target->getNamespace()][$target->getDBkey()] =
545 $cachedItem->getNotificationTimestamp();
546 } else {
547 $targetsToLoad[] = $target;
551 if ( !$targetsToLoad ) {
552 return $timestamps;
555 $dbr = $this->getConnectionRef( DB_REPLICA );
557 $lb = new LinkBatch( $targetsToLoad );
558 $res = $dbr->select(
559 'watchlist',
560 [ 'wl_namespace', 'wl_title', 'wl_notificationtimestamp' ],
562 $lb->constructSet( 'wl', $dbr ),
563 'wl_user' => $user->getId(),
565 __METHOD__
568 foreach ( $res as $row ) {
569 $timestamps[$row->wl_namespace][$row->wl_title] = $row->wl_notificationtimestamp;
572 return $timestamps;
576 * Must be called separately for Subject & Talk namespaces
578 * @param User $user
579 * @param LinkTarget $target
581 public function addWatch( User $user, LinkTarget $target ) {
582 $this->addWatchBatchForUser( $user, [ $target ] );
586 * @param User $user
587 * @param LinkTarget[] $targets
589 * @return bool success
591 public function addWatchBatchForUser( User $user, array $targets ) {
592 if ( $this->loadBalancer->getReadOnlyReason() !== false ) {
593 return false;
595 // Only loggedin user can have a watchlist
596 if ( $user->isAnon() ) {
597 return false;
600 if ( !$targets ) {
601 return true;
604 $rows = [];
605 $items = [];
606 foreach ( $targets as $target ) {
607 $rows[] = [
608 'wl_user' => $user->getId(),
609 'wl_namespace' => $target->getNamespace(),
610 'wl_title' => $target->getDBkey(),
611 'wl_notificationtimestamp' => null,
613 $items[] = new WatchedItem(
614 $user,
615 $target,
616 null
618 $this->uncache( $user, $target );
621 $dbw = $this->getConnectionRef( DB_MASTER );
622 foreach ( array_chunk( $rows, 100 ) as $toInsert ) {
623 // Use INSERT IGNORE to avoid overwriting the notification timestamp
624 // if there's already an entry for this page
625 $dbw->insert( 'watchlist', $toInsert, __METHOD__, 'IGNORE' );
627 // Update process cache to ensure skin doesn't claim that the current
628 // page is unwatched in the response of action=watch itself (T28292).
629 // This would otherwise be re-queried from a slave by isWatched().
630 foreach ( $items as $item ) {
631 $this->cache( $item );
634 return true;
638 * Removes the an entry for the User watching the LinkTarget
639 * Must be called separately for Subject & Talk namespaces
641 * @param User $user
642 * @param LinkTarget $target
644 * @return bool success
645 * @throws DBUnexpectedError
646 * @throws MWException
648 public function removeWatch( User $user, LinkTarget $target ) {
649 // Only logged in user can have a watchlist
650 if ( $this->loadBalancer->getReadOnlyReason() !== false || $user->isAnon() ) {
651 return false;
654 $this->uncache( $user, $target );
656 $dbw = $this->getConnectionRef( DB_MASTER );
657 $dbw->delete( 'watchlist',
659 'wl_user' => $user->getId(),
660 'wl_namespace' => $target->getNamespace(),
661 'wl_title' => $target->getDBkey(),
662 ], __METHOD__
664 $success = (bool)$dbw->affectedRows();
666 return $success;
670 * @param User $user The user to set the timestamp for
671 * @param string|null $timestamp Set the update timestamp to this value
672 * @param LinkTarget[] $targets List of targets to update. Default to all targets
674 * @return bool success
676 public function setNotificationTimestampsForUser( User $user, $timestamp, array $targets = [] ) {
677 // Only loggedin user can have a watchlist
678 if ( $user->isAnon() ) {
679 return false;
682 $dbw = $this->getConnectionRef( DB_MASTER );
684 $conds = [ 'wl_user' => $user->getId() ];
685 if ( $targets ) {
686 $batch = new LinkBatch( $targets );
687 $conds[] = $batch->constructSet( 'wl', $dbw );
690 if ( $timestamp !== null ) {
691 $timestamp = $dbw->timestamp( $timestamp );
694 $success = $dbw->update(
695 'watchlist',
696 [ 'wl_notificationtimestamp' => $timestamp ],
697 $conds,
698 __METHOD__
701 $this->uncacheUser( $user );
703 return $success;
707 * @param User $editor The editor that triggered the update. Their notification
708 * timestamp will not be updated(they have already seen it)
709 * @param LinkTarget $target The target to update timestamps for
710 * @param string $timestamp Set the update timestamp to this value
712 * @return int[] Array of user IDs the timestamp has been updated for
714 public function updateNotificationTimestamp( User $editor, LinkTarget $target, $timestamp ) {
715 $dbw = $this->getConnectionRef( DB_MASTER );
716 $uids = $dbw->selectFieldValues(
717 'watchlist',
718 'wl_user',
720 'wl_user != ' . intval( $editor->getId() ),
721 'wl_namespace' => $target->getNamespace(),
722 'wl_title' => $target->getDBkey(),
723 'wl_notificationtimestamp IS NULL',
725 __METHOD__
728 $watchers = array_map( 'intval', $uids );
729 if ( $watchers ) {
730 // Update wl_notificationtimestamp for all watching users except the editor
731 $fname = __METHOD__;
732 DeferredUpdates::addCallableUpdate(
733 function () use ( $timestamp, $watchers, $target, $fname ) {
734 global $wgUpdateRowsPerQuery;
736 $dbw = $this->getConnectionRef( DB_MASTER );
737 $factory = wfGetLBFactory();
738 $ticket = $factory->getEmptyTransactionTicket( __METHOD__ );
740 $watchersChunks = array_chunk( $watchers, $wgUpdateRowsPerQuery );
741 foreach ( $watchersChunks as $watchersChunk ) {
742 $dbw->update( 'watchlist',
743 [ /* SET */
744 'wl_notificationtimestamp' => $dbw->timestamp( $timestamp )
745 ], [ /* WHERE - TODO Use wl_id T130067 */
746 'wl_user' => $watchersChunk,
747 'wl_namespace' => $target->getNamespace(),
748 'wl_title' => $target->getDBkey(),
749 ], $fname
751 if ( count( $watchersChunks ) > 1 ) {
752 $factory->commitAndWaitForReplication(
753 __METHOD__, $ticket, [ 'wiki' => $dbw->getWikiID() ]
757 $this->uncacheLinkTarget( $target );
759 DeferredUpdates::POSTSEND,
760 $dbw
764 return $watchers;
768 * Reset the notification timestamp of this entry
770 * @param User $user
771 * @param Title $title
772 * @param string $force Whether to force the write query to be executed even if the
773 * page is not watched or the notification timestamp is already NULL.
774 * 'force' in order to force
775 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
777 * @return bool success
779 public function resetNotificationTimestamp( User $user, Title $title, $force = '', $oldid = 0 ) {
780 // Only loggedin user can have a watchlist
781 if ( $this->loadBalancer->getReadOnlyReason() !== false || $user->isAnon() ) {
782 return false;
785 $item = null;
786 if ( $force != 'force' ) {
787 $item = $this->loadWatchedItem( $user, $title );
788 if ( !$item || $item->getNotificationTimestamp() === null ) {
789 return false;
793 // If the page is watched by the user (or may be watched), update the timestamp
794 $job = new ActivityUpdateJob(
795 $title,
797 'type' => 'updateWatchlistNotification',
798 'userid' => $user->getId(),
799 'notifTime' => $this->getNotificationTimestamp( $user, $title, $item, $force, $oldid ),
800 'curTime' => time()
804 // Try to run this post-send
805 // Calls DeferredUpdates::addCallableUpdate in normal operation
806 call_user_func(
807 $this->deferredUpdatesAddCallableUpdateCallback,
808 function() use ( $job ) {
809 $job->run();
813 $this->uncache( $user, $title );
815 return true;
818 private function getNotificationTimestamp( User $user, Title $title, $item, $force, $oldid ) {
819 if ( !$oldid ) {
820 // No oldid given, assuming latest revision; clear the timestamp.
821 return null;
824 if ( !$title->getNextRevisionID( $oldid ) ) {
825 // Oldid given and is the latest revision for this title; clear the timestamp.
826 return null;
829 if ( $item === null ) {
830 $item = $this->loadWatchedItem( $user, $title );
833 if ( !$item ) {
834 // This can only happen if $force is enabled.
835 return null;
838 // Oldid given and isn't the latest; update the timestamp.
839 // This will result in no further notification emails being sent!
840 // Calls Revision::getTimestampFromId in normal operation
841 $notificationTimestamp = call_user_func(
842 $this->revisionGetTimestampFromIdCallback,
843 $title,
844 $oldid
847 // We need to go one second to the future because of various strict comparisons
848 // throughout the codebase
849 $ts = new MWTimestamp( $notificationTimestamp );
850 $ts->timestamp->add( new DateInterval( 'PT1S' ) );
851 $notificationTimestamp = $ts->getTimestamp( TS_MW );
853 if ( $notificationTimestamp < $item->getNotificationTimestamp() ) {
854 if ( $force != 'force' ) {
855 return false;
856 } else {
857 // This is a little silly…
858 return $item->getNotificationTimestamp();
862 return $notificationTimestamp;
866 * @param User $user
867 * @param int $unreadLimit
869 * @return int|bool The number of unread notifications
870 * true if greater than or equal to $unreadLimit
872 public function countUnreadNotifications( User $user, $unreadLimit = null ) {
873 $queryOptions = [];
874 if ( $unreadLimit !== null ) {
875 $unreadLimit = (int)$unreadLimit;
876 $queryOptions['LIMIT'] = $unreadLimit;
879 $dbr = $this->getConnectionRef( DB_REPLICA );
880 $rowCount = $dbr->selectRowCount(
881 'watchlist',
882 '1',
884 'wl_user' => $user->getId(),
885 'wl_notificationtimestamp IS NOT NULL',
887 __METHOD__,
888 $queryOptions
891 if ( !isset( $unreadLimit ) ) {
892 return $rowCount;
895 if ( $rowCount >= $unreadLimit ) {
896 return true;
899 return $rowCount;
903 * Check if the given title already is watched by the user, and if so
904 * add a watch for the new title.
906 * To be used for page renames and such.
908 * @param LinkTarget $oldTarget
909 * @param LinkTarget $newTarget
911 public function duplicateAllAssociatedEntries( LinkTarget $oldTarget, LinkTarget $newTarget ) {
912 $oldTarget = Title::newFromLinkTarget( $oldTarget );
913 $newTarget = Title::newFromLinkTarget( $newTarget );
915 $this->duplicateEntry( $oldTarget->getSubjectPage(), $newTarget->getSubjectPage() );
916 $this->duplicateEntry( $oldTarget->getTalkPage(), $newTarget->getTalkPage() );
920 * Check if the given title already is watched by the user, and if so
921 * add a watch for the new title.
923 * To be used for page renames and such.
924 * This must be called separately for Subject and Talk pages
926 * @param LinkTarget $oldTarget
927 * @param LinkTarget $newTarget
929 public function duplicateEntry( LinkTarget $oldTarget, LinkTarget $newTarget ) {
930 $dbw = $this->getConnectionRef( DB_MASTER );
932 $result = $dbw->select(
933 'watchlist',
934 [ 'wl_user', 'wl_notificationtimestamp' ],
936 'wl_namespace' => $oldTarget->getNamespace(),
937 'wl_title' => $oldTarget->getDBkey(),
939 __METHOD__,
940 [ 'FOR UPDATE' ]
943 $newNamespace = $newTarget->getNamespace();
944 $newDBkey = $newTarget->getDBkey();
946 # Construct array to replace into the watchlist
947 $values = [];
948 foreach ( $result as $row ) {
949 $values[] = [
950 'wl_user' => $row->wl_user,
951 'wl_namespace' => $newNamespace,
952 'wl_title' => $newDBkey,
953 'wl_notificationtimestamp' => $row->wl_notificationtimestamp,
957 if ( !empty( $values ) ) {
958 # Perform replace
959 # Note that multi-row replace is very efficient for MySQL but may be inefficient for
960 # some other DBMSes, mostly due to poor simulation by us
961 $dbw->replace(
962 'watchlist',
963 [ [ 'wl_user', 'wl_namespace', 'wl_title' ] ],
964 $values,
965 __METHOD__