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();
    }

    protected function getFormFields() {
        return array();
    }

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

        return true;
    }

    public function show() {
        $this->setHeaders();

        $user = $this->getUser();
        // This will throw exceptions if there's a problem
        $this->checkCanExecute( $user );

        // Must have valid token for this action/title
        $salt = array( $this->getName(), $this->getTitle()->getDBkey() );

        if ( $user->matchEditToken( $this->getRequest()->getVal( 'token' ), $salt ) ) {
            $this->onSubmit( array() );
            $this->onSuccess();
        } else {
            $form = $this->getForm();
            if ( $form->show() ) {
                $this->onSuccess();
            }
        }
    }

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

        parent::checkCanExecute( $user );
    }

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

        return Status::newGood();
    }

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

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

        $status = Status::newFatal( 'hookaborted' );
        if ( wfRunHooks( 'WatchArticle', array( &$user, &$page, &$status ) ) ) {
            $status = Status::newGood();
            $user->addWatch( $title, $checkRights );
            wfRunHooks( 'WatchArticleComplete', array( &$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 ( wfRunHooks( 'UnwatchArticle', array( &$user, &$page, &$status ) ) ) {
            $status = Status::newGood();
            $user->removeWatch( $title );
            wfRunHooks( 'UnwatchArticleComplete', array( &$user, &$page ) );
        }

        return $status;
    }

    public static function getWatchToken( Title $title, User $user, $action = 'watch' ) {
        if ( $action != 'unwatch' ) {
            $action = 'watch';
        }
        $salt = array( $action, $title->getPrefixedDBkey() );

        // This token stronger salted and not compatible with ApiWatch
        // It's title/action specific because index.php is GET and API is POST
        return $user->getEditToken( $salt );
    }

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

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

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

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