ApiQueryWatchlistRaw.php

Go to the documentation of this file.

<?php
class ApiQueryWatchlistRaw extends ApiQueryGeneratorBase {

    public function __construct( $query, $moduleName ) {
        parent::__construct( $query, $moduleName, 'wr' );
    }

    public function execute() {
        $this->run();
    }

    public function executeGenerator( $resultPageSet ) {
        $this->run( $resultPageSet );
    }

    private function run( $resultPageSet = null ) {
        $this->selectNamedDB( 'watchlist', DB_SLAVE, 'watchlist' );

        $params = $this->extractRequestParams();

        $user = $this->getWatchlistUser( $params );

        $prop = array_flip( (array)$params['prop'] );
        $show = array_flip( (array)$params['show'] );
        if ( isset( $show['changed'] ) && isset( $show['!changed'] ) ) {
            $this->dieUsageMsg( 'show' );
        }

        $this->addTables( 'watchlist' );
        $this->addFields( array( 'wl_namespace', 'wl_title' ) );
        $this->addFieldsIf( 'wl_notificationtimestamp', isset( $prop['changed'] ) );
        $this->addWhereFld( 'wl_user', $user->getId() );
        $this->addWhereFld( 'wl_namespace', $params['namespace'] );
        $this->addWhereIf( 'wl_notificationtimestamp IS NOT NULL', isset( $show['changed'] ) );
        $this->addWhereIf( 'wl_notificationtimestamp IS NULL', isset( $show['!changed'] ) );

        if ( isset( $params['continue'] ) ) {
            $cont = explode( '|', $params['continue'] );
            $this->dieContinueUsageIf( count( $cont ) != 2 );
            $ns = intval( $cont[0] );
            $this->dieContinueUsageIf( strval( $ns ) !== $cont[0] );
            $title = $this->getDB()->addQuotes( $cont[1] );
            $op = $params['dir'] == 'ascending' ? '>' : '<';
            $this->addWhere(
                "wl_namespace $op $ns OR " .
                "(wl_namespace = $ns AND " .
                "wl_title $op= $title)"
            );
        }

        $sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
        // Don't ORDER BY wl_namespace if it's constant in the WHERE clause
        if ( count( $params['namespace'] ) == 1 ) {
            $this->addOption( 'ORDER BY', 'wl_title' . $sort );
        } else {
            $this->addOption( 'ORDER BY', array(
                'wl_namespace' . $sort,
                'wl_title' . $sort
            ));
        }
        $this->addOption( 'LIMIT', $params['limit'] + 1 );
        $res = $this->select( __METHOD__ );

        $titles = array();
        $count = 0;
        foreach ( $res as $row ) {
            if ( ++$count > $params['limit'] ) {
                // We've reached the one extra which shows that there are additional pages to be had. Stop here...
                $this->setContinueEnumParameter( 'continue', $row->wl_namespace . '|' . $row->wl_title );
                break;
            }
            $t = Title::makeTitle( $row->wl_namespace, $row->wl_title );

            if ( is_null( $resultPageSet ) ) {
                $vals = array();
                ApiQueryBase::addTitleInfo( $vals, $t );
                if ( isset( $prop['changed'] ) && !is_null( $row->wl_notificationtimestamp ) )
                {
                    $vals['changed'] = wfTimestamp( TS_ISO_8601, $row->wl_notificationtimestamp );
                }
                $fit = $this->getResult()->addValue( $this->getModuleName(), null, $vals );
                if ( !$fit ) {
                    $this->setContinueEnumParameter( 'continue', $row->wl_namespace . '|' . $row->wl_title );
                    break;
                }
            } else {
                $titles[] = $t;
            }
        }
        if ( is_null( $resultPageSet ) ) {
            $this->getResult()->setIndexedTagName_internal( $this->getModuleName(), 'wr' );
        } else {
            $resultPageSet->populateFromTitles( $titles );
        }
    }

    public function getAllowedParams() {
        return array(
            'continue' => null,
            'namespace' => array(
                ApiBase::PARAM_ISMULTI => true,
                ApiBase::PARAM_TYPE => 'namespace'
            ),
            'limit' => array(
                ApiBase::PARAM_DFLT => 10,
                ApiBase::PARAM_TYPE => 'limit',
                ApiBase::PARAM_MIN => 1,
                ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
                ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
            ),
            'prop' => array(
                ApiBase::PARAM_ISMULTI => true,
                ApiBase::PARAM_TYPE => array(
                    'changed',
                )
            ),
            'show' => array(
                ApiBase::PARAM_ISMULTI => true,
                ApiBase::PARAM_TYPE => array(
                    'changed',
                    '!changed',
                )
            ),
            'owner' => array(
                ApiBase::PARAM_TYPE => 'user'
            ),
            'token' => array(
                ApiBase::PARAM_TYPE => 'string'
            ),
            'dir' => array(
                ApiBase::PARAM_DFLT => 'ascending',
                ApiBase::PARAM_TYPE => array(
                    'ascending',
                    'descending'
                ),
            ),
        );
    }

    public function getParamDescription() {
        return array(
            'continue' => 'When more results are available, use this to continue',
            'namespace' => 'Only list pages in the given namespace(s)',
            'limit' => 'How many total results to return per request',
            'prop' => array(
                'Which additional properties to get (non-generator mode only)',
                ' changed  - Adds timestamp of when the user was last notified about the edit',
            ),
            'show' => 'Only list items that meet these criteria',
            'owner' => 'The name of the user whose watchlist you\'d like to access',
            'token' => 'Give a security token (settable in preferences) to allow access to another user\'s watchlist',
            'dir' => 'Direction to sort the titles and namespaces in',
        );
    }

    public function getResultProperties() {
        return array(
            '' => array(
                'ns' => 'namespace',
                'title' => 'string'
            ),
            'changed' => array(
                'changed' => array(
                    ApiBase::PROP_TYPE => 'timestamp',
                    ApiBase::PROP_NULLABLE => true
                )
            )
        );
    }

    public function getDescription() {
        return "Get all pages on the logged in 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( 'show' ),
            array( 'code' => 'bad_wlowner', 'info' => 'Specified user does not exist' ),
            array( 'code' => 'bad_wltoken', 'info' => 'Incorrect watchlist token provided -- please set a correct token in Special:Preferences' ),
        ) );
    }

    public function getExamples() {
        return array(
            'api.php?action=query&list=watchlistraw',
            'api.php?action=query&generator=watchlistraw&gwrshow=changed&prop=revisions',
        );
    }

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