From 44475e0314b985c6f0c825f0af74c43a533b9743 Mon Sep 17 00:00:00 2001
From: Roan Kattouw <catrope@users.mediawiki.org>
Date: Thu, 21 Aug 2008 15:44:13 +0000
Subject: [PATCH] Adding action=watch to the API

---
 RELEASE-NOTES             |  1 +
 includes/AutoLoader.php   |  1 +
 includes/api/ApiMain.php  |  1 +
 includes/api/ApiWatch.php | 99 +++++++++++++++++++++++++++++++++++++++
 4 files changed, 102 insertions(+)
 create mode 100644 includes/api/ApiWatch.php

diff --git a/RELEASE-NOTES b/RELEASE-NOTES
index 118c38ea75..ddf583598c 100644
--- 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 fafa258e61..d781f3f468 100644
--- 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 298fd79682..c3946e5c34 100644
--- 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
index 0000000000..2faecd9ffe
--- /dev/null
+++ b/includes/api/ApiWatch.php
@@ -0,0 +1,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: ApiLogout.php 35294 2008-05-24 20:44:49Z btongminh $';
+	}
+}
-- 
2.20.1