3 * Performs the watch actions on a page
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24 * Page addition to a user's watchlist
28 class WatchAction
extends FormAction
{
30 public function getName() {
34 public function requiresUnblock() {
41 protected function getDescription() {
42 return $this->msg( 'addwatch' )->escaped();
46 * Just get an empty form with a single submit button
49 protected function getFormFields() {
53 public function onSubmit( $data ) {
54 self
::doWatch( $this->getTitle(), $this->getUser() );
60 * This can be either formed or formless depending on the session token given
62 public function show() {
65 $user = $this->getUser();
66 // This will throw exceptions if there's a problem
67 $this->checkCanExecute( $user );
69 $form = $this->getForm();
70 if ( $form->show() ) {
75 protected function checkCanExecute( User
$user ) {
77 if ( $user->isAnon() ) {
78 throw new UserNotLoggedIn( 'watchlistanontext', 'watchnologin' );
81 parent
::checkCanExecute( $user );
84 protected function alterForm( HTMLForm
$form ) {
85 $form->setSubmitTextMsg( 'confirm-watch-button' );
86 $form->setTokenSalt( 'watch' );
89 protected function preText() {
90 return $this->msg( 'confirm-watch-top' )->parse();
93 public function onSuccess() {
94 $this->getOutput()->addWikiMsg( 'addedwatchtext', $this->getTitle()->getPrefixedText() );
97 /* Static utility methods */
100 * Watch or unwatch a page
102 * @param bool $watch Whether to watch or unwatch the page
103 * @param Title $title Page to watch/unwatch
104 * @param User $user User who is watching/unwatching
107 public static function doWatchOrUnwatch( $watch, Title
$title, User
$user ) {
108 if ( $user->isLoggedIn() &&
109 $user->isWatched( $title, WatchedItem
::IGNORE_USER_RIGHTS
) != $watch
111 // If the user doesn't have 'editmywatchlist', we still want to
112 // allow them to add but not remove items via edits and such.
114 return self
::doWatch( $title, $user, WatchedItem
::IGNORE_USER_RIGHTS
);
116 return self
::doUnwatch( $title, $user );
120 return Status
::newGood();
125 * @since 1.22 Returns Status, $checkRights parameter added
126 * @param Title $title Page to watch/unwatch
127 * @param User $user User who is watching/unwatching
128 * @param int $checkRights Passed through to $user->addWatch()
131 public static function doWatch( Title
$title, User
$user,
132 $checkRights = WatchedItem
::CHECK_USER_RIGHTS
134 if ( $checkRights !== WatchedItem
::IGNORE_USER_RIGHTS
&&
135 !$user->isAllowed( 'editmywatchlist' )
137 return User
::newFatalPermissionDeniedStatus( 'editmywatchlist' );
140 $page = WikiPage
::factory( $title );
142 $status = Status
::newFatal( 'hookaborted' );
143 if ( Hooks
::run( 'WatchArticle', array( &$user, &$page, &$status ) ) ) {
144 $status = Status
::newGood();
145 $user->addWatch( $title, $checkRights );
146 Hooks
::run( 'WatchArticleComplete', array( &$user, &$page ) );
154 * @since 1.22 Returns Status
155 * @param Title $title Page to watch/unwatch
156 * @param User $user User who is watching/unwatching
159 public static function doUnwatch( Title
$title, User
$user ) {
160 if ( !$user->isAllowed( 'editmywatchlist' ) ) {
161 return User
::newFatalPermissionDeniedStatus( 'editmywatchlist' );
164 $page = WikiPage
::factory( $title );
166 $status = Status
::newFatal( 'hookaborted' );
167 if ( Hooks
::run( 'UnwatchArticle', array( &$user, &$page, &$status ) ) ) {
168 $status = Status
::newGood();
169 $user->removeWatch( $title );
170 Hooks
::run( 'UnwatchArticleComplete', array( &$user, &$page ) );
177 * Get token to watch (or unwatch) a page for a user
179 * @param Title $title Title object of page to watch
180 * @param User $user User for whom the action is going to be performed
181 * @param string $action Optionally override the action to 'unwatch'
182 * @return string Token
185 public static function getWatchToken( Title
$title, User
$user, $action = 'watch' ) {
186 if ( $action != 'unwatch' ) {
189 // Match ApiWatch and ResourceLoaderUserTokensModule
190 return $user->getEditToken( $action );
194 * Get token to unwatch (or watch) a page for a user
196 * @param Title $title Title object of page to unwatch
197 * @param User $user User for whom the action is going to be performed
198 * @param string $action Optionally override the action to 'watch'
199 * @return string Token
202 public static function getUnwatchToken( Title
$title, User
$user, $action = 'unwatch' ) {
203 return self
::getWatchToken( $title, $user, $action );