ApiQueryIWBacklinks.php

Go to the documentation of this file.

<?php
class ApiQueryIWBacklinks extends ApiQueryGeneratorBase {

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

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

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

    public function run( $resultPageSet = null ) {
        $params = $this->extractRequestParams();

        if ( isset( $params['title'] ) && !isset( $params['prefix'] ) ) {
            $this->dieUsageMsg( array( 'missingparam', 'prefix' ) );
        }

        if ( !is_null( $params['continue'] ) ) {
            $cont = explode( '|', $params['continue'] );
            $this->dieContinueUsageIf( count( $cont ) != 3 );

            $db = $this->getDB();
            $op = $params['dir'] == 'descending' ? '<' : '>';
            $prefix = $db->addQuotes( $cont[0] );
            $title = $db->addQuotes( $cont[1] );
            $from = intval( $cont[2] );
            $this->addWhere(
                "iwl_prefix $op $prefix OR " .
                "(iwl_prefix = $prefix AND " .
                "(iwl_title $op $title OR " .
                "(iwl_title = $title AND " .
                "iwl_from $op= $from)))"
            );
        }

        $prop = array_flip( $params['prop'] );
        $iwprefix = isset( $prop['iwprefix'] );
        $iwtitle = isset( $prop['iwtitle'] );

        $this->addTables( array( 'iwlinks', 'page' ) );
        $this->addWhere( 'iwl_from = page_id' );

        $this->addFields( array( 'page_id', 'page_title', 'page_namespace', 'page_is_redirect',
            'iwl_from', 'iwl_prefix', 'iwl_title' ) );

        $sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
        if ( isset( $params['prefix'] ) ) {
            $this->addWhereFld( 'iwl_prefix', $params['prefix'] );
            if ( isset( $params['title'] ) ) {
                $this->addWhereFld( 'iwl_title', $params['title'] );
                $this->addOption( 'ORDER BY', 'iwl_from' . $sort );
            } else {
                $this->addOption( 'ORDER BY', array(
                    'iwl_title' . $sort,
                    'iwl_from' . $sort
                ));
            }
        } else {
            $this->addOption( 'ORDER BY', array(
                'iwl_prefix' . $sort,
                'iwl_title' . $sort,
                'iwl_from' . $sort
            ));
        }

        $this->addOption( 'LIMIT', $params['limit'] + 1 );

        $res = $this->select( __METHOD__ );

        $pages = array();

        $count = 0;
        $result = $this->getResult();
        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...
                // Continue string preserved in case the redirect query doesn't pass the limit
                $this->setContinueEnumParameter( 'continue', "{$row->iwl_prefix}|{$row->iwl_title}|{$row->iwl_from}" );
                break;
            }

            if ( !is_null( $resultPageSet ) ) {
                $pages[] = Title::newFromRow( $row );
            } else {
                $entry = array( 'pageid' => $row->page_id );

                $title = Title::makeTitle( $row->page_namespace, $row->page_title );
                ApiQueryBase::addTitleInfo( $entry, $title );

                if ( $row->page_is_redirect ) {
                    $entry['redirect'] = '';
                }

                if ( $iwprefix ) {
                    $entry['iwprefix'] = $row->iwl_prefix;
                }

                if ( $iwtitle ) {
                    $entry['iwtitle'] = $row->iwl_title;
                }

                $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $entry );
                if ( !$fit ) {
                    $this->setContinueEnumParameter( 'continue', "{$row->iwl_prefix}|{$row->iwl_title}|{$row->iwl_from}" );
                    break;
                }
            }
        }

        if ( is_null( $resultPageSet ) ) {
            $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'iw' );
        } else {
            $resultPageSet->populateFromTitles( $pages );
        }
    }

    public function getCacheMode( $params ) {
        return 'public';
    }

    public function getAllowedParams() {
        return array(
            'prefix' => null,
            'title' => null,
            'continue' => null,
            '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_DFLT => '',
                ApiBase::PARAM_TYPE => array(
                    'iwprefix',
                    'iwtitle',
                ),
            ),
            'dir' => array(
                ApiBase::PARAM_DFLT => 'ascending',
                ApiBase::PARAM_TYPE => array(
                    'ascending',
                    'descending'
                )
            ),
        );
    }

    public function getParamDescription() {
        return array(
            'prefix' => 'Prefix for the interwiki',
            'title' => "Interwiki link to search for. Must be used with {$this->getModulePrefix()}prefix",
            'continue' => 'When more results are available, use this to continue',
            'prop' => array(
                'Which properties to get',
                ' iwprefix       - Adds the prefix of the interwiki',
                ' iwtitle        - Adds the title of the interwiki',
            ),
            'limit' => 'How many total pages to return',
            'dir' => 'The direction in which to list',
        );
    }

    public function getResultProperties() {
        return array(
            '' => array(
                'pageid' => 'integer',
                'ns' => 'namespace',
                'title' => 'string',
                'redirect' => 'boolean'
            ),
            'iwprefix' => array(
                'iwprefix' => 'string'
            ),
            'iwtitle' => array(
                'iwtitle' => 'string'
            )
        );
    }

    public function getDescription() {
        return array( 'Find all pages that link to the given interwiki link.',
            'Can be used to find all links with a prefix, or',
            'all links to a title (with a given prefix).',
            'Using neither parameter is effectively "All IW Links"',
        );
    }

    public function getPossibleErrors() {
        return array_merge( parent::getPossibleErrors(), array(
            array( 'missingparam', 'prefix' ),
        ) );
    }

    public function getExamples() {
        return array(
            'api.php?action=query&list=iwbacklinks&iwbltitle=Test&iwblprefix=wikibooks',
            'api.php?action=query&generator=iwbacklinks&giwbltitle=Test&giwblprefix=wikibooks&prop=info'
        );
    }

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