ApiWatch.php

Go to the documentation of this file.

<?php
class ApiWatch extends ApiBase {
    private $mPageSet = null;
 
    public function execute() {
        $user = $this->getUser();
        if ( !$user->isLoggedIn() ) {
            $this->dieUsage( 'You must be logged-in to have a watchlist', 'notloggedin' );
        }
 
        if ( !$user->isAllowed( 'editmywatchlist' ) ) {
            $this->dieUsage( 'You don\'t have permission to edit your watchlist', 'permissiondenied' );
        }
 
        $params = $this->extractRequestParams();
        $pageSet = $this->getPageSet();
        // by default we use pageset to extract the page to work on.
        // title is still supported for backward compatibility
        if ( !isset( $params['title'] ) ) {
            $pageSet->execute();
            $res = $pageSet->getInvalidTitlesAndRevisions( array(
                'invalidTitles',
                'special',
                'missingIds',
                'missingRevIds',
                'interwikiTitles'
            ) );
 
            foreach ( $pageSet->getMissingTitles() as $title ) {
                $r = $this->watchTitle( $title, $user, $params );
                $r['missing'] = 1;
                $res[] = $r;
            }
 
            foreach ( $pageSet->getGoodTitles() as $title ) {
                $r = $this->watchTitle( $title, $user, $params );
                $res[] = $r;
            }
            $this->getResult()->setIndexedTagName( $res, 'w' );
        } else {
            // dont allow use of old title parameter with new pageset parameters.
            $extraParams = array_keys( array_filter( $pageSet->extractRequestParams(), function ( $x ) {
                return $x !== null && $x !== false;
            } ) );
 
            if ( $extraParams ) {
                $p = $this->getModulePrefix();
                $this->dieUsage(
                    "The parameter {$p}title can not be used with " . implode( ", ", $extraParams ),
                    'invalidparammix'
                );
            }
 
            $title = Title::newFromText( $params['title'] );
            if ( !$title || !$title->isWatchable() ) {
                $this->dieUsageMsg( array( 'invalidtitle', $params['title'] ) );
            }
            $res = $this->watchTitle( $title, $user, $params, true );
        }
        $this->getResult()->addValue( null, $this->getModuleName(), $res );
    }
 
    private function watchTitle( Title $title, User $user, array $params,
        $compatibilityMode = false
    ) {
        if ( !$title->isWatchable() ) {
            return array( 'title' => $title->getPrefixedText(), 'watchable' => 0 );
        }
 
        $res = array( 'title' => $title->getPrefixedText() );
 
        // Currently unnecessary, code to act as a safeguard against any change
        // in current behavior of uselang.
        // Copy from ApiParse
        $oldLang = null;
        if ( isset( $params['uselang'] ) &&
            $params['uselang'] != $this->getContext()->getLanguage()->getCode()
        ) {
            $oldLang = $this->getContext()->getLanguage(); // Backup language
            $this->getContext()->setLanguage( Language::factory( $params['uselang'] ) );
        }
 
        if ( $params['unwatch'] ) {
            $status = UnwatchAction::doUnwatch( $title, $user );
            if ( $status->isOK() ) {
                $res['unwatched'] = '';
                $res['message'] = $this->msg( 'removedwatchtext', $title->getPrefixedText() )
                    ->title( $title )->parseAsBlock();
            }
        } else {
            $status = WatchAction::doWatch( $title, $user );
            if ( $status->isOK() ) {
                $res['watched'] = '';
                $res['message'] = $this->msg( 'addedwatchtext', $title->getPrefixedText() )
                    ->title( $title )->parseAsBlock();
            }
        }
 
        if ( !is_null( $oldLang ) ) {
            $this->getContext()->setLanguage( $oldLang ); // Reset language to $oldLang
        }
 
        if ( !$status->isOK() ) {
            if ( $compatibilityMode ) {
                $this->dieStatus( $status );
            }
            $res['error'] = $this->getErrorFromStatus( $status );
        }
 
        return $res;
    }
 
    private function getPageSet() {
        if ( $this->mPageSet === null ) {
            $this->mPageSet = new ApiPageSet( $this );
        }
 
        return $this->mPageSet;
    }
 
    public function mustBePosted() {
        return true;
    }
 
    public function isWriteMode() {
        return true;
    }
 
    public function needsToken() {
        return true;
    }
 
    public function getTokenSalt() {
        return 'watch';
    }
 
    public function getAllowedParams( $flags = 0 ) {
        $result = array(
            'title' => array(
                ApiBase::PARAM_TYPE => 'string',
                ApiBase::PARAM_DEPRECATED => true
            ),
            'unwatch' => false,
            'uselang' => null,
            'token' => array(
                ApiBase::PARAM_TYPE => 'string',
                ApiBase::PARAM_REQUIRED => true
            ),
        );
        if ( $flags ) {
            $result += $this->getPageSet()->getFinalParams( $flags );
        }
 
        return $result;
    }
 
    public function getParamDescription() {
        $psModule = $this->getPageSet();
 
        return $psModule->getParamDescription() + array(
            'title' => 'The page to (un)watch. use titles instead',
            'unwatch' => 'If set the page will be unwatched rather than watched',
            'uselang' => 'Language to show the message in',
            'token' => 'A token previously acquired via prop=info',
        );
    }
 
    public function getResultProperties() {
        return array(
            '' => array(
                'title' => 'string',
                'unwatched' => 'boolean',
                'watched' => 'boolean',
                'message' => 'string'
            )
        );
    }
 
    public function getDescription() {
        return 'Add or remove pages 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&titles=Main_Page' => 'Watch the page "Main Page"',
            'api.php?action=watch&titles=Main_Page&unwatch=' => 'Unwatch the page "Main Page"',
        );
    }
 
    public function getHelpUrls() {
        return 'https://www.mediawiki.org/wiki/API:Watch';
    }
}