Adding action=watch to the API

diff --git a/RELEASE-NOTES b/RELEASE-NOTES
index 118c38e..ddf5835 100644 (file)
--- a/RELEASE-NOTES
+++ b/RELEASE-NOTES
@@ -167,6 +167,7 @@ it from source control: http://www.mediawiki.org/wiki/Download_from_SVN
 * list={backlinks,embeddedin,imageusage} now return arrays with keys 0, 1, 2,
   etc. (AKA lists) instead of arrays with pageIDs as keys (AKA hash tables)
   for consistency with other list modules.
+* Added action=watch
 
 === Languages updated in 1.14 ===
 

diff --git a/includes/AutoLoader.php b/includes/AutoLoader.php
index fafa258..d781f3f 100644 (file)
--- a/includes/AutoLoader.php
+++ b/includes/AutoLoader.php
@@ -292,6 +292,7 @@ $wgAutoloadLocalClasses = array(
        'ApiRollback' => 'includes/api/ApiRollback.php',
        'ApiUnblock' => 'includes/api/ApiUnblock.php',
        'ApiUndelete' => 'includes/api/ApiUndelete.php',
+       'ApiWatch' => 'includes/api/ApiWatch.php',
        'Services_JSON' => 'includes/api/ApiFormatJson_json.php',
        'Services_JSON_Error' => 'includes/api/ApiFormatJson_json.php',
        'Spyc' => 'includes/api/ApiFormatYaml_spyc.php',

diff --git a/includes/api/ApiMain.php b/includes/api/ApiMain.php
index 298fd79..c3946e5 100644 (file)
--- a/includes/api/ApiMain.php
+++ b/includes/api/ApiMain.php
@@ -77,6 +77,7 @@ class ApiMain extends ApiBase {
                'move' => 'ApiMove',
                'edit' => 'ApiEditPage',
                'emailuser' => 'ApiEmailUser',
+               'watch' => 'ApiWatch',
        );
 
        /**

diff --git a/includes/api/ApiWatch.php b/includes/api/ApiWatch.php
new file mode 100644 (file)
index 0000000..2faecd9
--- /dev/null
+++ b/includes/api/ApiWatch.php
@@ -0,0 +1,99 @@
+<?php\r
+\r
+/*\r
+ * Created on Jan 4, 2008\r
+ *\r
+ * API for MediaWiki 1.8+\r
+ *\r
+ * Copyright (C) 2008 Yuri Astrakhan <Firstname><Lastname>@gmail.com,\r
+ *\r
+ * This program is free software; you can redistribute it and/or modify\r
+ * it under the terms of the GNU General Public License as published by\r
+ * the Free Software Foundation; either version 2 of the License, or\r
+ * (at your option) any later version.\r
+ *\r
+ * This program is distributed in the hope that it will be useful,\r
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r
+ * GNU General Public License for more details.\r
+ *\r
+ * You should have received a copy of the GNU General Public License along\r
+ * with this program; if not, write to the Free Software Foundation, Inc.,\r
+ * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.\r
+ * http://www.gnu.org/copyleft/gpl.html\r
+ */\r
+\r
+if (!defined('MEDIAWIKI')) {\r
+       // Eclipse helper - will be ignored in production\r
+       require_once ('ApiBase.php');\r
+}\r
+\r
+/**\r
+ * API module to allow users to log out of the wiki. API equivalent of\r
+ * Special:Userlogout.\r
+ *\r
+ * @ingroup API\r
+ */\r
+class ApiWatch extends ApiBase {\r
+\r
+       public function __construct($main, $action) {\r
+               parent :: __construct($main, $action);\r
+       }\r
+\r
+       public function execute() {\r
+               global $wgUser;\r
+               $this->getMain()->requestWriteMode();\r
+               if(!$wgUser->isLoggedIn())\r
+                       $this->dieUsage('You must be logged-in to have a watchlist', 'notloggedin');\r
+               $params = $this->extractRequestParams();\r
+               $title = Title::newFromText($params['title']);\r
+               if(!$title)\r
+                       $this->dieUsageMsg(array('invalidtitle', $params['title']));\r
+               $article = new Article($title);\r
+               $res = array('title' => $title->getPrefixedText());\r
+               if($params['unwatch'])\r
+               {\r
+                       $res['unwatched'] = '';\r
+                       $success = $article->doUnwatch();\r
+               }\r
+               else\r
+               {\r
+                       $res['watched'] = '';\r
+                       $success = $article->doWatch();\r
+               }\r
+               if(!$success)\r
+                       $this->dieUsageMsg(array('hookaborted'));\r
+               $this->getResult()->addValue(null, $this->getModuleName(), $res);\r
+       }\r
+\r
+       public function getAllowedParams() {\r
+               return array (\r
+                       'title' => null,\r
+                       'unwatch' => false,\r
+               );\r
+       }\r
+\r
+       public function getParamDescription() {\r
+               return array (\r
+                       'title' => 'The page to (un)watch',\r
+                       'unwatch' => 'If set the page will be unwatched rather than watched',\r
+               );\r
+       }\r
+\r
+       public function getDescription() {\r
+               return array (\r
+                       'Add or remove a page from/to the current user\'s watchlist'\r
+               );\r
+       }\r
+\r
+       protected function getExamples() {\r
+               return array(\r
+                       'api.php?action=watch&title=Main_Page',\r
+                       'api.php?action=watch&title=Main_Page&unwatch',\r
+               );\r
+       }\r
+\r
+       public function getVersion() {\r
+               return __CLASS__ . ': $Id: ApiLogout.php 35294 2008-05-24 20:44:49Z btongminh $';\r
+       }\r
+}\r