1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
<?php
/*
* Created on Jan 4, 2008
*
* API for MediaWiki 1.8+
*
* Copyright (C) 2008 Yuri Astrakhan <Firstname><Lastname>@gmail.com,
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
* http://www.gnu.org/copyleft/gpl.html
*/
if (!defined('MEDIAWIKI')) {
// Eclipse helper - will be ignored in production
require_once ('ApiBase.php');
}
/**
* API module to allow users to log out of the wiki. API equivalent of
* Special:Userlogout.
*
* @ingroup API
*/
class ApiWatch extends ApiBase {
public function __construct($main, $action) {
parent :: __construct($main, $action);
}
public function execute() {
global $wgUser;
$this->getMain()->requestWriteMode();
if(!$wgUser->isLoggedIn())
$this->dieUsage('You must be logged-in to have a watchlist', 'notloggedin');
$params = $this->extractRequestParams();
$title = Title::newFromText($params['title']);
if(!$title)
$this->dieUsageMsg(array('invalidtitle', $params['title']));
$article = new Article($title);
$res = array('title' => $title->getPrefixedText());
if($params['unwatch'])
{
$res['unwatched'] = '';
$success = $article->doUnwatch();
}
else
{
$res['watched'] = '';
$success = $article->doWatch();
}
if(!$success)
$this->dieUsageMsg(array('hookaborted'));
$this->getResult()->addValue(null, $this->getModuleName(), $res);
}
public function getAllowedParams() {
return array (
'title' => null,
'unwatch' => false,
);
}
public function getParamDescription() {
return array (
'title' => 'The page to (un)watch',
'unwatch' => 'If set the page will be unwatched rather than watched',
);
}
public function getDescription() {
return array (
'Add or remove a page from/to the current user\'s watchlist'
);
}
protected function getExamples() {
return array(
'api.php?action=watch&title=Main_Page',
'api.php?action=watch&title=Main_Page&unwatch',
);
}
public function getVersion() {
return __CLASS__ . ': $Id: ApiWatch.php 40460 2008-09-04 22:20:32Z ialex $';
}
}
|
