ApiSetNotificationTimestamp.php

Go to the documentation of this file.

<?php

use MediaWiki\MediaWikiServices;

class ApiSetNotificationTimestamp extends ApiBase {

    private $mPageSet;

    public function execute() {
        $user = $this->getUser();

        if ( $user->isAnon() ) {
            $this->dieUsage( 'Anonymous users cannot use watchlist change notifications', 'notloggedin' );
        }
        if ( !$user->isAllowed( 'editmywatchlist' ) ) {
            $this->dieUsage( 'You don\'t have permission to edit your watchlist', 'permissiondenied' );
        }

        $params = $this->extractRequestParams();
        $this->requireMaxOneParameter( $params, 'timestamp', 'torevid', 'newerthanrevid' );

        $continuationManager = new ApiContinuationManager( $this, [], [] );
        $this->setContinuationManager( $continuationManager );

        $pageSet = $this->getPageSet();
        if ( $params['entirewatchlist'] && $pageSet->getDataSource() !== null ) {
            $this->dieUsage(
                "Cannot use 'entirewatchlist' at the same time as '{$pageSet->getDataSource()}'",
                'multisource'
            );
        }

        $dbw = wfGetDB( DB_MASTER, 'api' );

        $timestamp = null;
        if ( isset( $params['timestamp'] ) ) {
            $timestamp = $dbw->timestamp( $params['timestamp'] );
        }

        if ( !$params['entirewatchlist'] ) {
            $pageSet->execute();
        }

        if ( isset( $params['torevid'] ) ) {
            if ( $params['entirewatchlist'] || $pageSet->getGoodTitleCount() > 1 ) {
                $this->dieUsage( 'torevid may only be used with a single page', 'multpages' );
            }
            $title = reset( $pageSet->getGoodTitles() );
            if ( $title ) {
                $timestamp = Revision::getTimestampFromId(
                    $title, $params['torevid'], Revision::READ_LATEST );
                if ( $timestamp ) {
                    $timestamp = $dbw->timestamp( $timestamp );
                } else {
                    $timestamp = null;
                }
            }
        } elseif ( isset( $params['newerthanrevid'] ) ) {
            if ( $params['entirewatchlist'] || $pageSet->getGoodTitleCount() > 1 ) {
                $this->dieUsage( 'newerthanrevid may only be used with a single page', 'multpages' );
            }
            $title = reset( $pageSet->getGoodTitles() );
            if ( $title ) {
                $revid = $title->getNextRevisionID(
                    $params['newerthanrevid'], Title::GAID_FOR_UPDATE );
                if ( $revid ) {
                    $timestamp = $dbw->timestamp( Revision::getTimestampFromId( $title, $revid ) );
                } else {
                    $timestamp = null;
                }
            }
        }

        $watchedItemStore = MediaWikiServices::getInstance()->getWatchedItemStore();
        $apiResult = $this->getResult();
        $result = [];
        if ( $params['entirewatchlist'] ) {
            // Entire watchlist mode: Just update the thing and return a success indicator
            $watchedItemStore->setNotificationTimestampsForUser(
                $user,
                $timestamp
            );

            $result['notificationtimestamp'] = is_null( $timestamp )
                ? ''
                : wfTimestamp( TS_ISO_8601, $timestamp );
        } else {
            // First, log the invalid titles
            foreach ( $pageSet->getInvalidTitlesAndReasons() as $r ) {
                $r['invalid'] = true;
                $result[] = $r;
            }
            foreach ( $pageSet->getMissingPageIDs() as $p ) {
                $page = [];
                $page['pageid'] = $p;
                $page['missing'] = true;
                $page['notwatched'] = true;
                $result[] = $page;
            }
            foreach ( $pageSet->getMissingRevisionIDs() as $r ) {
                $rev = [];
                $rev['revid'] = $r;
                $rev['missing'] = true;
                $rev['notwatched'] = true;
                $result[] = $rev;
            }

            if ( $pageSet->getTitles() ) {
                // Now process the valid titles
                $watchedItemStore->setNotificationTimestampsForUser(
                    $user,
                    $timestamp,
                    $pageSet->getTitles()
                );

                // Query the results of our update
                $timestamps = $watchedItemStore->getNotificationTimestampsBatch(
                    $user,
                    $pageSet->getTitles()
                );

                // Now, put the valid titles into the result
                foreach ( $pageSet->getTitles() as $title ) {
                    $ns = $title->getNamespace();
                    $dbkey = $title->getDBkey();
                    $r = [
                        'ns' => intval( $ns ),
                        'title' => $title->getPrefixedText(),
                    ];
                    if ( !$title->exists() ) {
                        $r['missing'] = true;
                        if ( $title->isKnown() ) {
                            $r['known'] = true;
                        }
                    }
                    if ( isset( $timestamps[$ns] ) && array_key_exists( $dbkey, $timestamps[$ns] ) ) {
                        $r['notificationtimestamp'] = '';
                        if ( $timestamps[$ns][$dbkey] !== null ) {
                            $r['notificationtimestamp'] = wfTimestamp( TS_ISO_8601, $timestamps[$ns][$dbkey] );
                        }
                    } else {
                        $r['notwatched'] = true;
                    }
                    $result[] = $r;
                }
            }

            ApiResult::setIndexedTagName( $result, 'page' );
        }
        $apiResult->addValue( null, $this->getModuleName(), $result );

        $this->setContinuationManager( null );
        $continuationManager->setContinuationIntoResult( $apiResult );
    }

    private function getPageSet() {
        if ( !isset( $this->mPageSet ) ) {
            $this->mPageSet = new ApiPageSet( $this );
        }

        return $this->mPageSet;
    }

    public function mustBePosted() {
        return true;
    }

    public function isWriteMode() {
        return true;
    }

    public function needsToken() {
        return 'csrf';
    }

    public function getAllowedParams( $flags = 0 ) {
        $result = [
            'entirewatchlist' => [
                ApiBase::PARAM_TYPE => 'boolean'
            ],
            'timestamp' => [
                ApiBase::PARAM_TYPE => 'timestamp'
            ],
            'torevid' => [
                ApiBase::PARAM_TYPE => 'integer'
            ],
            'newerthanrevid' => [
                ApiBase::PARAM_TYPE => 'integer'
            ],
            'continue' => [
                ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
            ],
        ];
        if ( $flags ) {
            $result += $this->getPageSet()->getFinalParams( $flags );
        }

        return $result;
    }

    protected function getExamplesMessages() {
        return [
            'action=setnotificationtimestamp&entirewatchlist=&token=123ABC'
                => 'apihelp-setnotificationtimestamp-example-all',
            'action=setnotificationtimestamp&titles=Main_page&token=123ABC'
                => 'apihelp-setnotificationtimestamp-example-page',
            'action=setnotificationtimestamp&titles=Main_page&' .
                'timestamp=2012-01-01T00:00:00Z&token=123ABC'
                => 'apihelp-setnotificationtimestamp-example-pagetimestamp',
            'action=setnotificationtimestamp&generator=allpages&gapnamespace=2&token=123ABC'
                => 'apihelp-setnotificationtimestamp-example-allpages',
        ];
    }

    public function getHelpUrls() {
        return 'https://www.mediawiki.org/wiki/API:SetNotificationTimestamp';
    }
}