30b83d70f4a8efb240bca4bd6eb93974d7eebed0
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();
45 public function onSubmit( $data ) {
46 self
::doWatch( $this->getTitle(), $this->getUser() );
51 protected function checkCanExecute( User
$user ) {
53 if ( $user->isAnon() ) {
54 throw new UserNotLoggedIn( 'watchlistanontext', 'watchnologin' );
57 parent
::checkCanExecute( $user );
60 protected function alterForm( HTMLForm
$form ) {
61 $form->setSubmitTextMsg( 'confirm-watch-button' );
62 $form->setTokenSalt( 'watch' );
65 protected function preText() {
66 return $this->msg( 'confirm-watch-top' )->parse();
69 public function onSuccess() {
70 $this->getOutput()->addWikiMsg( 'addedwatchtext', $this->getTitle()->getPrefixedText() );
73 /* Static utility methods */
76 * Watch or unwatch a page
78 * @param bool $watch Whether to watch or unwatch the page
79 * @param Title $title Page to watch/unwatch
80 * @param User $user User who is watching/unwatching
83 public static function doWatchOrUnwatch( $watch, Title
$title, User
$user ) {
84 if ( $user->isLoggedIn() &&
85 $user->isWatched( $title, WatchedItem
::IGNORE_USER_RIGHTS
) != $watch
87 // If the user doesn't have 'editmywatchlist', we still want to
88 // allow them to add but not remove items via edits and such.
90 return self
::doWatch( $title, $user, WatchedItem
::IGNORE_USER_RIGHTS
);
92 return self
::doUnwatch( $title, $user );
96 return Status
::newGood();
101 * @since 1.22 Returns Status, $checkRights parameter added
102 * @param Title $title Page to watch/unwatch
103 * @param User $user User who is watching/unwatching
104 * @param int $checkRights Passed through to $user->addWatch()
107 public static function doWatch( Title
$title, User
$user,
108 $checkRights = WatchedItem
::CHECK_USER_RIGHTS
110 if ( $checkRights !== WatchedItem
::IGNORE_USER_RIGHTS
&&
111 !$user->isAllowed( 'editmywatchlist' )
113 return User
::newFatalPermissionDeniedStatus( 'editmywatchlist' );
116 $page = WikiPage
::factory( $title );
118 $status = Status
::newFatal( 'hookaborted' );
119 if ( Hooks
::run( 'WatchArticle', array( &$user, &$page, &$status ) ) ) {
120 $status = Status
::newGood();
121 $user->addWatch( $title, $checkRights );
122 Hooks
::run( 'WatchArticleComplete', array( &$user, &$page ) );
130 * @since 1.22 Returns Status
131 * @param Title $title Page to watch/unwatch
132 * @param User $user User who is watching/unwatching
135 public static function doUnwatch( Title
$title, User
$user ) {
136 if ( !$user->isAllowed( 'editmywatchlist' ) ) {
137 return User
::newFatalPermissionDeniedStatus( 'editmywatchlist' );
140 $page = WikiPage
::factory( $title );
142 $status = Status
::newFatal( 'hookaborted' );
143 if ( Hooks
::run( 'UnwatchArticle', array( &$user, &$page, &$status ) ) ) {
144 $status = Status
::newGood();
145 $user->removeWatch( $title );
146 Hooks
::run( 'UnwatchArticleComplete', array( &$user, &$page ) );
153 * Get token to watch (or unwatch) a page for a user
155 * @param Title $title Title object of page to watch
156 * @param User $user User for whom the action is going to be performed
157 * @param string $action Optionally override the action to 'unwatch'
158 * @return string Token
161 public static function getWatchToken( Title
$title, User
$user, $action = 'watch' ) {
162 if ( $action != 'unwatch' ) {
165 // Match ApiWatch and ResourceLoaderUserTokensModule
166 return $user->getEditToken( $action );
170 * Get token to unwatch (or watch) a page for a user
172 * @param Title $title Title object of page to unwatch
173 * @param User $user User for whom the action is going to be performed
174 * @param string $action Optionally override the action to 'watch'
175 * @return string Token
178 public static function getUnwatchToken( Title
$title, User
$user, $action = 'unwatch' ) {
179 return self
::getWatchToken( $title, $user, $action );