WatchAction.php

Go to the documentation of this file.

<?php
class WatchAction extends FormAction {

    public function getName() {
        return 'watch';
    }

    public function requiresUnblock() {
        return false;
    }

    protected function getDescription() {
        return $this->msg( 'addwatch' )->escaped();
    }

    public function onSubmit( $data ) {
        self::doWatch( $this->getTitle(), $this->getUser() );

        return true;
    }

    protected function checkCanExecute( User $user ) {
        // Must be logged in
        if ( $user->isAnon() ) {
            throw new UserNotLoggedIn( 'watchlistanontext', 'watchnologin' );
        }

        parent::checkCanExecute( $user );
    }

    protected function alterForm( HTMLForm $form ) {
        $form->setSubmitTextMsg( 'confirm-watch-button' );
        $form->setTokenSalt( 'watch' );
    }

    protected function preText() {
        return $this->msg( 'confirm-watch-top' )->parse();
    }

    public function onSuccess() {
        $this->getOutput()->addWikiMsg( 'addedwatchtext', $this->getTitle()->getPrefixedText() );
    }

    /* Static utility methods */

    public static function doWatchOrUnwatch( $watch, Title $title, User $user ) {
        if ( $user->isLoggedIn() &&
            $user->isWatched( $title, User::IGNORE_USER_RIGHTS ) != $watch
        ) {
            // 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 );
            } else {
                return self::doUnwatch( $title, $user );
            }
        }

        return Status::newGood();
    }

    public static function doWatch(
        Title $title,
        User $user,
        $checkRights = User::CHECK_USER_RIGHTS
    ) {
        if ( $checkRights && !$user->isAllowed( 'editmywatchlist' ) ) {
            return User::newFatalPermissionDeniedStatus( 'editmywatchlist' );
        }

        $page = WikiPage::factory( $title );

        $status = Status::newFatal( 'hookaborted' );
        if ( Hooks::run( 'WatchArticle', [ &$user, &$page, &$status ] ) ) {
            $status = Status::newGood();
            $user->addWatch( $title, $checkRights );
            Hooks::run( 'WatchArticleComplete', [ &$user, &$page ] );
        }

        return $status;
    }

    public static function doUnwatch( Title $title, User $user ) {
        if ( !$user->isAllowed( 'editmywatchlist' ) ) {
            return User::newFatalPermissionDeniedStatus( 'editmywatchlist' );
        }

        $page = WikiPage::factory( $title );

        $status = Status::newFatal( 'hookaborted' );
        if ( Hooks::run( 'UnwatchArticle', [ &$user, &$page, &$status ] ) ) {
            $status = Status::newGood();
            $user->removeWatch( $title );
            Hooks::run( 'UnwatchArticleComplete', [ &$user, &$page ] );
        }

        return $status;
    }

    public static function getWatchToken( Title $title, User $user, $action = 'watch' ) {
        if ( $action != 'unwatch' ) {
            $action = 'watch';
        }
        // Match ApiWatch and ResourceLoaderUserTokensModule
        return $user->getEditToken( $action );
    }

    public static function getUnwatchToken( Title $title, User $user, $action = 'unwatch' ) {
        return self::getWatchToken( $title, $user, $action );
    }

    public function doesWrites() {
        return true;
    }
}