-<?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
+<?php
+/**
+ *
+ *
+ * Created on Jan 4, 2008
+ *
+ * Copyright © 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.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
+
+/**
+ * API module to allow users to watch a page
+ *
+ * @ingroup API
+ */
+class ApiWatch extends ApiBase {
+
+ public function __construct( $main, $action ) {
+ parent::__construct( $main, $action );
+ }
+
+ public function execute() {
+ $user = $this->getUser();
+ if ( !$user->isLoggedIn() ) {
+ $this->dieUsage( 'You must be logged-in to have a watchlist', 'notloggedin' );
+ }
+
+ $params = $this->extractRequestParams();
+ $title = Title::newFromText( $params['title'] );
+
+ if ( !$title || $title->getNamespace() < 0 ) {
+ $this->dieUsageMsg( array( 'invalidtitle', $params['title'] ) );
+ }
+
+ $res = array( 'title' => $title->getPrefixedText() );
+
+ if ( $params['unwatch'] ) {
+ $res['unwatched'] = '';
+ $res['message'] = wfMsgExt( 'removedwatchtext', array( 'parse' ), $title->getPrefixedText() );
+ $success = UnwatchAction::doUnwatch( $title, $user );
+ } else {
+ $res['watched'] = '';
+ $res['message'] = wfMsgExt( 'addedwatchtext', array( 'parse' ), $title->getPrefixedText() );
+ $success = WatchAction::doWatch( $title, $user );
+ }
+ if ( !$success ) {
+ $this->dieUsageMsg( 'hookaborted' );
+ }
+ $this->getResult()->addValue( null, $this->getModuleName(), $res );
+ }
+
+ public function mustBePosted() {
+ return true;
+ }
+
+ public function isWriteMode() {
+ return true;
+ }
+
+ public function needsToken() {
+ return true;
+ }
+
+ public function getTokenSalt() {
+ return 'watch';
+ }
+
+ public function getAllowedParams() {
+ return array(
+ 'title' => array(
+ ApiBase::PARAM_TYPE => 'string',
+ ApiBase::PARAM_REQUIRED => true
+ ),
+ 'unwatch' => false,
+ 'token' => null,
+ );
+ }
+
+ public function getParamDescription() {
+ return array(
+ 'title' => 'The page to (un)watch',
+ 'unwatch' => 'If set the page will be unwatched rather than watched',
+ 'token' => 'A token previously acquired via prop=info',
+ );
+ }
+
+ public function getDescription() {
+ return 'Add or remove a page from/to the current user\'s watchlist';
+ }
+
+ public function getPossibleErrors() {
+ return array_merge( parent::getPossibleErrors(), array(
+ array( 'code' => 'notloggedin', 'info' => 'You must be logged-in to have a watchlist' ),
+ array( 'invalidtitle', 'title' ),
+ array( 'hookaborted' ),
+ ) );
+ }
+
+ public function getExamples() {
+ return array(
+ 'api.php?action=watch&title=Main_Page' => 'Watch the page "Main Page"',
+ 'api.php?action=watch&title=Main_Page&unwatch=' => 'Unwatch the page "Main Page"',
+ );
+ }
+
+ public function getHelpUrls() {
+ return 'https://www.mediawiki.org/wiki/API:Watch';
+ }
+
+ public function getVersion() {
+ return __CLASS__ . ': $Id$';
+ }
+}
dépôts / lhc / web / wiklou.git / blobdiff