WatchAction.php

Go to the documentation of this file.

<?php
use MediaWiki\MediaWikiServices;
use Wikimedia\ParamValidator\TypeDef\ExpiryDef;
 
class WatchAction extends FormAction {
 
    protected $watchlistExpiry;
 
    protected $expiryFormFieldName = 'expiry';
 
    protected $watchedItem = false;
 
    public function __construct( Page $page, IContextSource $context = null ) {
        parent::__construct( $page, $context );
        $this->watchlistExpiry = $this->getContext()->getConfig()->get( 'WatchlistExpiry' );
        if ( $this->watchlistExpiry ) {
            // The watchedItem is only used in this action's form if $wgWatchlistExpiry is enabled.
            $this->watchedItem = MediaWikiServices::getInstance()
                ->getWatchedItemStore()
                ->getWatchedItem( $this->getUser(), $this->getTitle() );
        }
    }
 
    public function getName() {
        return 'watch';
    }
 
    public function requiresUnblock() {
        return false;
    }
 
    protected function getDescription() {
        return '';
    }
 
    public function onSubmit( $data ) {
        $expiry = $this->getRequest()->getVal( 'wp' . $this->expiryFormFieldName );
 
        // Even though we're never unwatching here, use doWatchOrUnwatch() because it also checks for changed expiry.
        return self::doWatchOrUnwatch( true, $this->getTitle(), $this->getUser(), $expiry );
    }
 
    protected function checkCanExecute( User $user ) {
        // Must be logged in
        if ( $user->isAnon() ) {
            throw new UserNotLoggedIn( 'watchlistanontext', 'watchnologin' );
        }
 
        parent::checkCanExecute( $user );
    }
 
    protected function usesOOUI() {
        return true;
    }
 
    protected function getFormFields() {
        // If watchlist expiry is not enabled, return a simple confirmation message.
        if ( !$this->watchlistExpiry ) {
            return [
                'intro' => [
                    'type' => 'info',
                    'vertical-label' => true,
                    'raw' => true,
                    'default' => $this->msg( 'confirm-watch-top' )->parse(),
                ],
            ];
        }
 
        // Otherwise, use a select-list of expiries.
        $expiryOptions = static::getExpiryOptions( $this->getContext(), $this->watchedItem );
        return [
            $this->expiryFormFieldName => [
                'type' => 'select',
                'label-message' => 'confirm-watch-label',
                'options' => $expiryOptions['options'],
                'default' => $expiryOptions['default'],
            ]
        ];
    }
 
    public static function getExpiryOptions( MessageLocalizer $msgLocalizer, $watchedItem ) {
        $expiryOptionsMsg = $msgLocalizer->msg( 'watchlist-expiry-options' );
        $expiryOptionsMsgText = $expiryOptionsMsg->text();
        $expiryOptions = XmlSelect::parseOptionsMessage( $expiryOptionsMsgText );
        $default = 'infinite';
        if ( $watchedItem instanceof WatchedItem && $watchedItem->getExpiry() ) {
            // If it's already being temporarily watched,
            // add the existing expiry as the default option in the dropdown.
            $default = $watchedItem->getExpiry( TS_ISO_8601 );
            $daysLeft = $watchedItem->getExpiryInDaysText( $msgLocalizer, true );
            $expiryOptions = array_merge( [ $daysLeft => $default ], $expiryOptions );
        }
        return [
            'options' => $expiryOptions,
            'default' => $default,
        ];
    }
 
    protected function alterForm( HTMLForm $form ) {
        $msg = $this->watchlistExpiry && $this->watchedItem ? 'updatewatchlist' : 'addwatch';
        $form->setWrapperLegendMsg( $msg );
        $submitMsg = $this->watchlistExpiry ? 'confirm-watch-button-expiry' : 'confirm-watch-button';
        $form->setSubmitTextMsg( $submitMsg );
        $form->setTokenSalt( 'watch' );
    }
 
    public function onSuccess() {
        $msgKey = $this->getTitle()->isTalkPage() ? 'addedwatchtext-talk' : 'addedwatchtext';
        $expiryLabel = null;
        $submittedExpiry = $this->getContext()->getRequest()->getText( 'wp' . $this->expiryFormFieldName );
        if ( $submittedExpiry ) {
            // We can't use $this->watcheditem to get the expiry because it's not been saved at this
            // point in the request and so its values are those from before saving.
            $expiry = ExpiryDef::normalizeExpiry( $submittedExpiry, TS_ISO_8601 );
 
            // If the expiry label isn't one of the predefined ones in the dropdown, calculate 'x days'.
            $expiryDays = WatchedItem::calculateExpiryInDays( $expiry );
            $defaultLabels = static::getExpiryOptions( $this->getContext(), null )['options'];
            $localizedExpiry = array_search( $submittedExpiry, $defaultLabels );
            $expiryLabel = $expiryDays && $localizedExpiry === false
                ? $this->getContext()->msg( 'days', $expiryDays )->text()
                : $localizedExpiry;
 
            // Determine which message to use, depending on whether this is a talk page or not
            // and whether an expiry was selected.
            $isTalk = $this->getTitle()->isTalkPage();
            if ( wfIsInfinity( $expiry ) ) {
                $msgKey = $isTalk ? 'addedwatchindefinitelytext-talk' : 'addedwatchindefinitelytext';
            } elseif ( $expiryDays > 0 ) {
                $msgKey = $isTalk ? 'addedwatchexpirytext-talk' : 'addedwatchexpirytext';
            } elseif ( $expiryDays < 1 ) {
                $msgKey = $isTalk ? 'addedwatchexpiryhours-talk' : 'addedwatchexpiryhours';
            }
        }
        $this->getOutput()->addWikiMsg( $msgKey, $this->getTitle()->getPrefixedText(), $expiryLabel );
    }
 
    public static function doWatchOrUnwatch(
        $watch,
        Title $title,
        User $user,
        string $expiry = null
    ) {
        // User must be logged in, and either changing the watch state or at least the expiry.
        if ( !$user->isLoggedIn() ) {
            return Status::newGood();
        }
 
        // Only run doWatch() or doUnwatch() if there's been a change in the watched status.
        $oldWatchedItem = MediaWikiServices::getInstance()->getWatchedItemStore()
            ->getWatchedItem( $user, $title );
        $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() === null
                ? 'infinity'
                : $oldWatchedItem->getExpiry();
            $changingWatchStatus = $changingWatchStatus ||
                $oldWatchPeriod !== ExpiryDef::normalizeExpiry( $expiry, TS_MW );
        }
 
        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 ) {
                return self::doWatch( $title, $user, User::IGNORE_USER_RIGHTS, $expiry );
            } else {
                return self::doUnwatch( $title, $user );
            }
        }
 
        return Status::newGood();
    }
 
    public static function doWatch(
        Title $title,
        User $user,
        $checkRights = User::CHECK_USER_RIGHTS,
        ?string $expiry = null
    ) {
        $permissionManager = MediaWikiServices::getInstance()->getPermissionManager();
        if ( $checkRights && !$permissionManager->userHasRight( $user, 'editmywatchlist' ) ) {
            return User::newFatalPermissionDeniedStatus( 'editmywatchlist' );
        }
 
        $page = WikiPage::factory( $title );
 
        $status = Status::newFatal( 'hookaborted' );
        if ( Hooks::runner()->onWatchArticle( $user, $page, $status, $expiry ) ) {
            $status = Status::newGood();
            $user->addWatch( $title, $checkRights, $expiry );
            Hooks::runner()->onWatchArticleComplete( $user, $page );
        }
 
        return $status;
    }
 
    public static function doUnwatch( Title $title, User $user ) {
        if ( !MediaWikiServices::getInstance()
            ->getPermissionManager()
            ->userHasRight( $user, 'editmywatchlist' ) ) {
            return User::newFatalPermissionDeniedStatus( 'editmywatchlist' );
        }
 
        $page = WikiPage::factory( $title );
 
        $status = Status::newFatal( 'hookaborted' );
        if ( Hooks::runner()->onUnwatchArticle( $user, $page, $status ) ) {
            $status = Status::newGood();
            $user->removeWatch( $title );
            Hooks::runner()->onUnwatchArticleComplete( $user, $page );
        }
 
        return $status;
    }
 
    public static function getWatchToken( Title $title, User $user, $action = 'watch' ) {
        if ( $action != 'unwatch' ) {
            $action = 'watch';
        }
        // This must match ApiWatch and ResourceLoaderUserOptionsModule
        return $user->getEditToken( $action );
    }
 
    public function doesWrites() {
        return true;
    }
}