5 * Created on Jan 4, 2008
7 * Copyright © 2008 Yuri Astrakhan "<Firstname><Lastname>@gmail.com",
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 * http://www.gnu.org/copyleft/gpl.html
28 * API module to allow users to watch a page
32 class ApiWatch
extends ApiBase
{
34 public function __construct( $main, $action ) {
35 parent
::__construct( $main, $action );
38 public function execute() {
39 $user = $this->getUser();
40 if ( !$user->isLoggedIn() ) {
41 $this->dieUsage( 'You must be logged-in to have a watchlist', 'notloggedin' );
43 $params = $this->extractRequestParams();
44 // titles can handle basic request of 1 title,
45 // but title is still supported for backward compatability
46 if ( isset( $params['title'] ) ) {
47 $title = Title
::newFromText( $params['title'] );
48 if ( !$title ||
$title->getNamespace() < 0 ) {
49 $this->dieUsageMsg( array( 'invalidtitle', $params['title'] ) );
51 $res = $this->watchTitle( $title, $user, $params);
53 $pageSet = new ApiPageSet( $this );
56 foreach ( $pageSet->getTitles() as $title ) {
57 $r = $this->watchTitle( $title, $user, $params);
61 $this->getResult()->addValue( null, $this->getModuleName(), $res );
63 private function watchTitle( $title, $user, $params ) {
64 $res = array( 'title' => $title->getPrefixedText() );
66 if ( $params['unwatch'] ) {
67 $res['unwatched'] = '';
68 $res['message'] = $this->msg( 'removedwatchtext', $title->getPrefixedText() )->title( $title )->parseAsBlock();
69 $success = UnwatchAction
::doUnwatch( $title, $user );
72 $res['message'] = $this->msg( 'addedwatchtext', $title->getPrefixedText() )->title( $title )->parseAsBlock();
73 $success = WatchAction
::doWatch( $title, $user );
76 $this->dieUsageMsg( 'hookaborted' );
81 public function mustBePosted() {
85 public function isWriteMode() {
89 public function needsToken() {
93 public function getTokenSalt() {
97 public function getAllowedParams() {
100 ApiBase
::PARAM_TYPE
=> 'string',
103 ApiBase
::PARAM_TYPE
=> 'string',
104 ApiBase
::PARAM_ISMULTI
=> true
108 ApiBase
::PARAM_TYPE
=> 'string',
109 ApiBase
::PARAM_REQUIRED
=> true
114 public function getParamDescription() {
116 'title' => 'The page to (un)watch',
117 'unwatch' => 'If set the page will be unwatched rather than watched',
118 'token' => 'A token previously acquired via prop=info',
122 public function getResultProperties() {
126 'unwatched' => 'boolean',
127 'watched' => 'boolean',
128 'message' => 'string'
133 public function getDescription() {
134 return 'Add or remove a page from/to the current user\'s watchlist';
137 public function getPossibleErrors() {
138 return array_merge( parent
::getPossibleErrors(), array(
139 array( 'code' => 'notloggedin', 'info' => 'You must be logged-in to have a watchlist' ),
140 array( 'invalidtitle', 'title' ),
141 array( 'hookaborted' ),
145 public function getExamples() {
147 'api.php?action=watch&title=Main_Page' => 'Watch the page "Main Page"',
148 'api.php?action=watch&title=Main_Page&unwatch=' => 'Unwatch the page "Main Page"',
152 public function getHelpUrls() {
153 return 'https://www.mediawiki.org/wiki/API:Watch';
156 public function getVersion() {
157 return __CLASS__
. ': $Id$';