WatchlistManager.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Watchlist;
 
use MediaWiki\HookContainer\HookContainer;
use MediaWiki\HookContainer\HookRunner;
use MediaWiki\Page\PageIdentity;
use MediaWiki\Page\PageReference;
use MediaWiki\Page\PageReferenceValue;
use MediaWiki\Page\WikiPageFactory;
use MediaWiki\Permissions\Authority;
use MediaWiki\Permissions\PermissionStatus;
use MediaWiki\Revision\RevisionLookup;
use MediaWiki\Revision\RevisionRecord;
use MediaWiki\Status\Status;
use MediaWiki\Title\NamespaceInfo;
use MediaWiki\Title\TitleValue;
use MediaWiki\User\TalkPageNotificationManager;
use MediaWiki\User\UserFactory;
use MediaWiki\User\UserIdentity;
use StatusValue;
use Wikimedia\ParamValidator\TypeDef\ExpiryDef;
use Wikimedia\Rdbms\ReadOnlyMode;
use Wikimedia\Timestamp\TimestampFormat as TS;
 
class WatchlistManager {
 
    public const OPTION_ENOTIF = 'isEnotifEnabled';
 
    private $isEnotifEnabled;
 
    private $hookRunner;
 
    private $readOnlyMode;
 
    private $revisionLookup;
 
    private $talkPageNotificationManager;
 
    private $watchedItemStore;
 
    private $userFactory;
 
    private $nsInfo;
 
    private $wikiPageFactory;
 
    private array $watchlistLabels = [];
 
    private $notificationTimestampCache = [];
 
    public function __construct(
        array $options,
        HookContainer $hookContainer,
        ReadOnlyMode $readOnlyMode,
        RevisionLookup $revisionLookup,
        TalkPageNotificationManager $talkPageNotificationManager,
        WatchedItemStoreInterface $watchedItemStore,
        private readonly WatchlistLabelStore $watchlistLabelStore,
        UserFactory $userFactory,
        NamespaceInfo $nsInfo,
        WikiPageFactory $wikiPageFactory
    ) {
        $this->isEnotifEnabled = $options[ self::OPTION_ENOTIF ];
        $this->hookRunner = new HookRunner( $hookContainer );
        $this->readOnlyMode = $readOnlyMode;
        $this->revisionLookup = $revisionLookup;
        $this->talkPageNotificationManager = $talkPageNotificationManager;
        $this->watchedItemStore = $watchedItemStore;
        $this->userFactory = $userFactory;
        $this->nsInfo = $nsInfo;
        $this->wikiPageFactory = $wikiPageFactory;
    }
 
    public function clearAllUserNotifications( Authority $performer ) {
        if ( $this->readOnlyMode->isReadOnly() ) {
            // Cannot change anything in read only
            return;
        }
 
        $user = $performer->getUser();
 
        // NOTE: Has to be before `editmywatchlist` user right check, to ensure
        // anonymous / temporary users have their talk page notifications cleared (T345031).
        if ( !$this->isEnotifEnabled ) {
            $this->talkPageNotificationManager->removeUserHasNewMessages( $user );
            return;
        }
 
        if ( !$performer->isAllowed( 'editmywatchlist' ) ) {
            // User isn't allowed to edit the watchlist
            return;
        }
 
        if ( !$user->isRegistered() ) {
            return;
        }
 
        $this->watchedItemStore->resetAllNotificationTimestampsForUser( $user );
 
        // We also need to clear here the "you have new message" notification for the own
        // user_talk page; it's cleared one page view later in WikiPage::doViewUpdates().
    }
 
    public function clearTitleUserNotifications(
        Authority $performer,
        PageReference $title,
        $oldRev = null,
        $oldRevDeprecated = null
    ) {
        if ( func_num_args() > 3 ) {
            wfDeprecatedMsg( 'Passing $oldid to ' . __METHOD__ . ' is deprecated since 1.46.' );
            $oldid = $oldRev ?? 0;
            $oldRev = $oldRevDeprecated;
        } else {
            $oldid = $oldRev?->getId() ?? 0;
        }
 
        if ( $this->readOnlyMode->isReadOnly() ) {
            // Cannot change anything in read only
            return;
        }
 
        $userIdentity = $performer->getUser();
        $userTalkPage = (
            $title->getNamespace() === NS_USER_TALK &&
            $title->getDBkey() === strtr( $userIdentity->getName(), ' ', '_' )
        );
 
        if ( $userTalkPage ) {
            if ( !$oldid ) {
                $oldRev = null;
            } elseif ( !$oldRev ) {
                $oldRev = $this->revisionLookup->getRevisionById( $oldid );
            }
            // NOTE: Has to be called before isAllowed() check, to ensure users with no watchlist
            // access (by default, temporary and anonymous users) can clear their talk page
            // notification (T345031).
            $this->talkPageNotificationManager->clearForPageView( $userIdentity, $oldRev );
        }
 
        if ( !$this->isEnotifEnabled ) {
            return;
        }
 
        if ( !$userIdentity->isRegistered() ) {
            // Nothing else to do
            return;
        }
 
        // NOTE: Has to be checked after the TalkPageNotificationManager::clearForPageView call, to
        // ensure users with no watchlist access (by default, temporary and anonymous users) can
        // clear their talk page notification (T345031).
        if ( !$performer->isAllowed( 'editmywatchlist' ) ) {
            // User isn't allowed to edit the watchlist
            return;
        }
 
        // Only update the timestamp if the page is being watched.
        // The query to find out if it is watched is cached both in memcached and per-invocation,
        // and when it does have to be executed, it can be on a replica DB
        // If this is the user's newtalk page, we always update the timestamp
        $force = $userTalkPage ? 'force' : '';
        $this->watchedItemStore->resetNotificationTimestamp( $userIdentity, $title, $force, $oldid );
    }
 
    public function getTitleNotificationTimestamp( UserIdentity $user, PageReference $title ) {
        if ( !$user->isRegistered() ) {
            return false;
        }
 
        $cacheKey = 'u' . $user->getId() . '-' .
            $title->getNamespace() . ':' . $title->getDBkey();
 
        // avoid isset here, as it'll return false for null entries
        if ( array_key_exists( $cacheKey, $this->notificationTimestampCache ) ) {
            return $this->notificationTimestampCache[ $cacheKey ];
        }
 
        $watchedItem = $this->watchedItemStore->getWatchedItem( $user, $title );
        if ( $watchedItem ) {
            $timestamp = $watchedItem->getNotificationTimestamp();
        } else {
            $timestamp = false;
        }
 
        $this->notificationTimestampCache[ $cacheKey ] = $timestamp;
        return $timestamp;
    }
 
    public function isWatchable( PageReference $target ): bool {
        if ( !$this->nsInfo->isWatchable( $target->getNamespace() ) ) {
            return false;
        }
 
        if ( $target instanceof PageIdentity && !$target->canExist() ) {
            // Catch "improper" Title instances
            return false;
        }
 
        return true;
    }
 
    public function isWatchedIgnoringRights( UserIdentity $userIdentity, PageReference $target ): bool {
        if ( $this->isWatchable( $target ) ) {
            return $this->watchedItemStore->isWatched( $userIdentity, $target );
        }
        return false;
    }
 
    public function isWatched( Authority $performer, PageReference $target ): bool {
        if ( $performer->isAllowed( 'viewmywatchlist' ) ) {
            return $this->isWatchedIgnoringRights( $performer->getUser(), $target );
        }
        return false;
    }
 
    public function isTempWatchedIgnoringRights( UserIdentity $userIdentity, PageReference $target ): bool {
        if ( $this->isWatchable( $target ) ) {
            return $this->watchedItemStore->isTempWatched( $userIdentity, $target );
        }
        return false;
    }
 
    public function isTempWatched( Authority $performer, PageReference $target ): bool {
        if ( $performer->isAllowed( 'viewmywatchlist' ) ) {
            return $this->isTempWatchedIgnoringRights( $performer->getUser(), $target );
        }
        return false;
    }
 
    public function addWatchIgnoringRights(
        UserIdentity $userIdentity,
        PageReference $target,
        ?string $expiry = null
    ): StatusValue {
        if ( !$this->isWatchable( $target ) ) {
            return StatusValue::newFatal( 'watchlistnotwatchable' );
        }
 
        $wikiPage = $this->wikiPageFactory->newFromTitle( $target );
        $title = $wikiPage->getTitle();
 
        $status = Status::newFatal( 'hookaborted' );
        // TODO: broaden the interface on these hooks to accept PageReference
        if ( $this->hookRunner->onWatchArticle( $userIdentity, $wikiPage, $status, $expiry ) ) {
            $status = StatusValue::newGood();
            $this->watchedItemStore->addWatch( $userIdentity, $this->getSubjectPage( $title ), $expiry );
            if ( $this->nsInfo->canHaveTalkPage( $title ) ) {
                $this->watchedItemStore->addWatch( $userIdentity, $this->getTalkPage( $title ), $expiry );
            }
            $this->hookRunner->onWatchArticleComplete( $userIdentity, $wikiPage );
        }
 
        // eventually user_touched should be factored out of User and this should be replaced
        $user = $this->userFactory->newFromUserIdentity( $userIdentity );
        $user->invalidateCache();
 
        return $status;
    }
 
    public function addWatch(
        Authority $performer,
        PageReference $target,
        ?string $expiry = null
    ): StatusValue {
        $status = PermissionStatus::newEmpty();
        if ( !$performer->isAllowed( 'editmywatchlist', $status ) ) {
            return $status;
        }
 
        return $this->addWatchIgnoringRights( $performer->getUser(), $target, $expiry );
    }
 
    public function removeWatchIgnoringRights(
        UserIdentity $userIdentity,
        PageReference $target
    ): StatusValue {
        if ( !$this->isWatchable( $target ) ) {
            return StatusValue::newFatal( 'watchlistnotwatchable' );
        }
 
        $wikiPage = $this->wikiPageFactory->newFromTitle( $target );
        $title = $wikiPage->getTitle();
 
        $status = Status::newFatal( 'hookaborted' );
        // TODO broaden the interface on these hooks from WikiPage to PageReference
        if ( $this->hookRunner->onUnwatchArticle( $userIdentity, $wikiPage, $status ) ) {
            $status = StatusValue::newGood();
            $this->watchedItemStore->removeWatch( $userIdentity, $this->getSubjectPage( $title ) );
            if ( $this->nsInfo->canHaveTalkPage( $title ) ) {
                $this->watchedItemStore->removeWatch( $userIdentity, $this->getTalkPage( $title ) );
            }
            $this->hookRunner->onUnwatchArticleComplete( $userIdentity, $wikiPage );
        }
 
        // eventually user_touched should be factored out of User and this should be replaced
        $user = $this->userFactory->newFromUserIdentity( $userIdentity );
        $user->invalidateCache();
 
        return $status;
    }
 
    private function getSubjectPage( PageReference $title ): PageReference {
        if ( $this->nsInfo->isSubject( $title->getNamespace() ) ) {
            return $title;
        }
        return PageReferenceValue::localReference(
            $this->nsInfo->getSubject( $title->getNamespace() ),
            $title->getDBkey()
        );
    }
 
    private function getTalkPage( PageReference $title ): PageReference {
        if ( $this->nsInfo->isTalk( $title->getNamespace() ) ) {
            return $title;
        }
        return PageReferenceValue::localReference(
            $this->nsInfo->getTalk( $title->getNamespace() ),
            $title->getDBkey()
        );
    }
 
    public function removeWatch(
        Authority $performer,
        PageReference $target
    ): StatusValue {
        $status = PermissionStatus::newEmpty();
        if ( !$performer->isAllowed( 'editmywatchlist', $status ) ) {
            return $status;
        }
 
        return $this->removeWatchIgnoringRights( $performer->getUser(), $target );
    }
 
    public function setWatch(
        bool $watch,
        Authority $performer,
        PageReference $target,
        ?string $expiry = null,
        ?array $labels = null
    ): StatusValue {
        // User must be registered, and (T371091) not a temp user
        if ( !$performer->getUser()->isRegistered() || $performer->isTemp() ) {
            return StatusValue::newGood();
        }
 
        // User must be either changing the watch state or at least the expiry.
 
        // Only call addWatchIgnoringRights() or removeWatch() if there's been a change in the watched status.
        $oldWatchedItem = $this->watchedItemStore->getWatchedItem( $performer->getUser(), $target );
        $changingWatchStatus = (bool)$oldWatchedItem !== $watch;
        if ( $oldWatchedItem && $expiry !== null ) {
            // If there's an old watched item, a non-null change to the expiry requires an UPDATE.
            $oldWatchPeriod = $oldWatchedItem->getExpiry() ?? 'infinity';
            $changingWatchStatus = $changingWatchStatus ||
                $oldWatchPeriod !== ExpiryDef::normalizeExpiry( $expiry, TS::MW );
        }
 
        $out = StatusValue::newGood();
        if ( $changingWatchStatus ) {
            // If the user doesn't have 'editmywatchlist', we still want to
            // allow them to add but not remove items via edits and such.
            if ( $watch ) {
                $out = $this->addWatchIgnoringRights( $performer->getUser(), $target, $expiry );
            } else {
                $out = $this->removeWatch( $performer, $target );
            }
        }
 
        if ( $watch && $labels !== null ) {
            // Add labels to both the subject and talk pages.
            $assocPage = $this->nsInfo->getAssociatedPage( TitleValue::newFromPage( $target ) );
            $targets = [
                $target,
                PageReferenceValue::localReference( $assocPage->getNamespace(), $assocPage->getDBkey() ),
            ];
            $this->addOrRemoveLabels( $performer->getUser(), $targets, $labels );
        }
 
        return $out;
    }
 
    private function addOrRemoveLabels( UserIdentity $user, array $targets, array $newLabelIds ): void {
        foreach ( $targets as $target ) {
            $currentLabelIds = [];
            $watchedItem = $this->watchedItemStore->getWatchedItem( $user, $target );
            if ( $watchedItem ) {
                foreach ( $watchedItem->getLabels() as $label ) {
                    $labelId = $label->getId();
                    if ( $labelId !== null ) {
                        $currentLabelIds[] = $labelId;
                    }
                }
            }
            $userLabelIds = array_keys( $this->loadWatchlistLabelsForUser( $user ) );
            $submittedLabelIds = array_values( array_intersect( $newLabelIds, $userLabelIds ) );
            $toAdd = array_values( array_diff( $submittedLabelIds, $currentLabelIds ) );
            $toRemove = array_values( array_diff( $currentLabelIds, $submittedLabelIds ) );
            if ( $toAdd ) {
                $this->watchedItemStore->addLabels( $user, $targets, $toAdd );
            }
            if ( $toRemove ) {
                $this->watchedItemStore->removeLabels( $user, $targets, $toRemove );
            }
        }
    }
 
    private function loadWatchlistLabelsForUser( UserIdentity $user ): array {
        if ( !isset( $this->watchlistLabels[$user->getId()] ) ) {
            $this->watchlistLabels[$user->getId()] = $this->watchlistLabelStore->loadAllForUser( $user );
        }
 
        return $this->watchlistLabels[$user->getId()];
    }
}