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
27 if ( !defined( 'MEDIAWIKI' ) ) {
28 // Eclipse helper - will be ignored in production
29 require_once( 'ApiBase.php' );
33 * API module to allow users to watch a page
37 class ApiWatch
extends ApiBase
{
39 public function __construct( $main, $action ) {
40 parent
::__construct( $main, $action );
43 public function execute() {
44 $user = $this->getUser();
45 if ( !$user->isLoggedIn() ) {
46 $this->dieUsage( 'You must be logged-in to have a watchlist', 'notloggedin' );
49 $params = $this->extractRequestParams();
50 $title = Title
::newFromText( $params['title'] );
52 if ( !$title ||
$title->getNamespace() < 0 ) {
53 $this->dieUsageMsg( array( 'invalidtitle', $params['title'] ) );
56 $res = array( 'title' => $title->getPrefixedText() );
58 if ( $params['unwatch'] ) {
59 $res['unwatched'] = '';
60 $res['message'] = wfMsgExt( 'removedwatchtext', array( 'parse' ), $title->getPrefixedText() );
61 $success = UnwatchAction
::doUnwatch( $title, $user );
64 $res['message'] = wfMsgExt( 'addedwatchtext', array( 'parse' ), $title->getPrefixedText() );
65 $success = WatchAction
::doWatch( $title, $user );
68 $this->dieUsageMsg( 'hookaborted' );
70 $this->getResult()->addValue( null, $this->getModuleName(), $res );
73 public function mustBePosted() {
77 public function isWriteMode() {
81 public function needsToken() {
85 public function getTokenSalt() {
89 public function getAllowedParams() {
92 ApiBase
::PARAM_TYPE
=> 'string',
93 ApiBase
::PARAM_REQUIRED
=> true
100 public function getParamDescription() {
102 'title' => 'The page to (un)watch',
103 'unwatch' => 'If set the page will be unwatched rather than watched',
104 'token' => 'A token previously acquired via prop=info',
108 public function getDescription() {
109 return 'Add or remove a page from/to the current user\'s watchlist';
112 public function getPossibleErrors() {
113 return array_merge( parent
::getPossibleErrors(), array(
114 array( 'code' => 'notloggedin', 'info' => 'You must be logged-in to have a watchlist' ),
115 array( 'invalidtitle', 'title' ),
116 array( 'hookaborted' ),
120 public function getExamples() {
122 'api.php?action=watch&title=Main_Page',
123 'api.php?action=watch&title=Main_Page&unwatch=',
127 public function getHelpUrls() {
128 return 'http://www.mediawiki.org/wiki/API:Watch';
131 public function getVersion() {
132 return __CLASS__
. ': $Id$';