ApiQueryQueryPage.php

Go to the documentation of this file.

<?php
class ApiQueryQueryPage extends ApiQueryGeneratorBase {
    private $qpMap;

    public function __construct( $query, $moduleName ) {
        parent::__construct( $query, $moduleName, 'qp' );
        // Build mapping from special page names to QueryPage classes
        global $wgAPIUselessQueryPages;
        $this->qpMap = array();
        foreach ( QueryPage::getPages() as $page ) {
            if ( !in_array( $page[1], $wgAPIUselessQueryPages ) ) {
                $this->qpMap[$page[1]] = $page[0];
            }
        }
    }

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

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

    public function run( $resultPageSet = null ) {
        global $wgQueryCacheLimit;

        $params = $this->extractRequestParams();
        $result = $this->getResult();

        $qp = new $this->qpMap[$params['page']]();
        if ( !$qp->userCanExecute( $this->getUser() ) ) {
            $this->dieUsageMsg( 'specialpage-cantexecute' );
        }

        $r = array( 'name' => $params['page'] );
        if ( $qp->isCached() ) {
            if ( !$qp->isCacheable() ) {
                $r['disabled'] = '';
            } else {
                $r['cached'] = '';
                $ts = $qp->getCachedTimestamp();
                if ( $ts ) {
                    $r['cachedtimestamp'] = wfTimestamp( TS_ISO_8601, $ts );
                }
                $r['maxresults'] = $wgQueryCacheLimit;
            }
        }
        $result->addValue( array( 'query' ), $this->getModuleName(), $r );

        if ( $qp->isCached() && !$qp->isCacheable() ) {
            // Disabled query page, don't run the query
            return;
        }

        $res = $qp->doQuery( $params['offset'], $params['limit'] + 1 );
        $count = 0;
        $titles = array();
        foreach ( $res as $row ) {
            if ( ++$count > $params['limit'] ) {
                // We've had enough
                $this->setContinueEnumParameter( 'offset', $params['offset'] + $params['limit'] );
                break;
            }

            $title = Title::makeTitle( $row->namespace, $row->title );
            if ( is_null( $resultPageSet ) ) {
                $data = array( 'value' => $row->value );
                if ( $qp->usesTimestamps() ) {
                    $data['timestamp'] = wfTimestamp( TS_ISO_8601, $row->value );
                }
                self::addTitleInfo( $data, $title );

                foreach ( $row as $field => $value ) {
                    if ( !in_array( $field, array( 'namespace', 'title', 'value', 'qc_type' ) ) ) {
                        $data['databaseResult'][$field] = $value;
                    }
                }

                $fit = $result->addValue( array( 'query', $this->getModuleName(), 'results' ), null, $data );
                if ( !$fit ) {
                    $this->setContinueEnumParameter( 'offset', $params['offset'] + $count - 1 );
                    break;
                }
            } else {
                $titles[] = $title;
            }
        }
        if ( is_null( $resultPageSet ) ) {
            $result->setIndexedTagName_internal(
                array( 'query', $this->getModuleName(), 'results' ),
                'page'
            );
        } else {
            $resultPageSet->populateFromTitles( $titles );
        }
    }

    public function getCacheMode( $params ) {
        $qp = new $this->qpMap[$params['page']]();
        if ( $qp->getRestriction() != '' ) {
            return 'private';
        }

        return 'public';
    }

    public function getAllowedParams() {
        return array(
            'page' => array(
                ApiBase::PARAM_TYPE => array_keys( $this->qpMap ),
                ApiBase::PARAM_REQUIRED => true
            ),
            'offset' => 0,
            '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
            ),
        );
    }

    public function getParamDescription() {
        return array(
            'page' => 'The name of the special page. Note, this is case sensitive',
            'offset' => 'When more results are available, use this to continue',
            'limit' => 'Number of results to return',
        );
    }

    public function getResultProperties() {
        return array(
            ApiBase::PROP_ROOT => array(
                'name' => array(
                    ApiBase::PROP_TYPE => 'string',
                    ApiBase::PROP_NULLABLE => false
                ),
                'disabled' => array(
                    ApiBase::PROP_TYPE => 'boolean',
                    ApiBase::PROP_NULLABLE => false
                ),
                'cached' => array(
                    ApiBase::PROP_TYPE => 'boolean',
                    ApiBase::PROP_NULLABLE => false
                ),
                'cachedtimestamp' => array(
                    ApiBase::PROP_TYPE => 'timestamp',
                    ApiBase::PROP_NULLABLE => true
                )
            ),
            '' => array(
                'value' => 'string',
                'timestamp' => array(
                    ApiBase::PROP_TYPE => 'timestamp',
                    ApiBase::PROP_NULLABLE => true
                ),
                'ns' => 'namespace',
                'title' => 'string'
            )
        );
    }

    public function getDescription() {
        return 'Get a list provided by a QueryPage-based special page.';
    }

    public function getPossibleErrors() {
        return array_merge( parent::getPossibleErrors(), array(
            array( 'specialpage-cantexecute' )
        ) );
    }

    public function getExamples() {
        return array(
            'api.php?action=query&list=querypage&qppage=Ancientpages'
        );
    }

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