Re-instate most of the revisions for bug 33147 "API examples should explain what...

[lhc/web/wiklou.git] / includes / api / ApiWatch.php

diff --git a/includes/api/ApiWatch.php b/includes/api/ApiWatch.php
index fe52328..4b448d6 100644 (file)
--- a/includes/api/ApiWatch.php
+++ b/includes/api/ApiWatch.php
@@ -24,11 +24,6 @@
  * @file
  */
 
-if ( !defined( 'MEDIAWIKI' ) ) {
-       // Eclipse helper - will be ignored in production
-       require_once( 'ApiBase.php' );
-}
-
 /**
  * API module to allow users to watch a page
  *
@@ -41,48 +36,59 @@ class ApiWatch extends ApiBase {
        }
 
        public function execute() {
-               global $wgUser;
-               if ( !$wgUser->isLoggedIn() ) {
+               $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 ) {
+               if ( !$title || $title->getNamespace() < 0 ) {
                        $this->dieUsageMsg( array( 'invalidtitle', $params['title'] ) );
                }
 
-               $article = new Article( $title );
                $res = array( 'title' => $title->getPrefixedText() );
 
                if ( $params['unwatch'] ) {
                        $res['unwatched'] = '';
                        $res['message'] = wfMsgExt( 'removedwatchtext', array( 'parse' ), $title->getPrefixedText() );
-                       $success = $article->doUnwatch();
+                       $success = UnwatchAction::doUnwatch( $title, $user );
                } else {
                        $res['watched'] = '';
                        $res['message'] = wfMsgExt( 'addedwatchtext', array( 'parse' ), $title->getPrefixedText() );
-                       $success = $article->doWatch();
+                       $success = WatchAction::doWatch( $title, $user );
                }
                if ( !$success ) {
-                       $this->dieUsageMsg( array( 'hookaborted' ) );
+                       $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,
                );
        }
 
@@ -90,6 +96,7 @@ class ApiWatch extends ApiBase {
                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',
                );
        }
 
@@ -105,13 +112,17 @@ class ApiWatch extends ApiBase {
                ) );
        }
 
-       protected function getExamples() {
+       public function getExamples() {
                return array(
-                       'api.php?action=watch&title=Main_Page',
-                       'api.php?action=watch&title=Main_Page&unwatch=',
+                       '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$';
        }