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

        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 ErrorPageError( 'watchnologin', 'watchnologintext' );
                }

                return parent::checkCanExecute( $user );
        }

        public static function doWatch( Title $title, User $user  ) {
                $page = WikiPage::factory( $title );

                if ( wfRunHooks( 'WatchArticle', array( &$user, &$page ) ) ) {
                        $user->addWatch( $title );
                        wfRunHooks( 'WatchArticleComplete', array( &$user, &$page ) );
                }
                return true;
        }

        public static function doUnwatch( Title $title, User $user  ) {
                $page = WikiPage::factory( $title );

                if ( wfRunHooks( 'UnwatchArticle', array( &$user, &$page ) ) ) {
                        $user->removeWatch( $title );
                        wfRunHooks( 'UnwatchArticleComplete', array( &$user, &$page ) );
                }
                return true;
        }

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

                // 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->setSubmitText( wfMsg( 'confirm-watch-button' ) );
        }

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

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

class UnwatchAction extends WatchAction {

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

        protected function getDescription() {
                return wfMsg( 'removewatch' );
        }

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

        protected function alterForm( HTMLForm $form ) {
                $form->setSubmitText( wfMsg( 'confirm-unwatch-button' ) );
        }

        protected function preText() {
                return wfMessage( 'confirm-unwatch-top' )->parse();
        }

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