ApiQueryIWLinks.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Api;
 
use MediaWiki\Deferred\LinksUpdate\InterwikiLinksTable;
use MediaWiki\Title\Title;
use MediaWiki\Utils\UrlUtils;
use Wikimedia\ParamValidator\ParamValidator;
use Wikimedia\ParamValidator\TypeDef\IntegerDef;
 
class ApiQueryIWLinks extends ApiQueryBase {
 
    public function __construct(
        ApiQuery $query,
        string $moduleName,
        private readonly UrlUtils $urlUtils,
    ) {
        parent::__construct( $query, $moduleName, 'iw' );
    }
 
    public function execute() {
        $pages = $this->getPageSet()->getGoodPages();
        if ( $pages === [] ) {
            return;
        }
 
        $params = $this->extractRequestParams();
        $prop = array_fill_keys( (array)$params['prop'], true );
 
        if ( isset( $params['title'] ) && !isset( $params['prefix'] ) ) {
            $this->dieWithError(
                [
                    'apierror-invalidparammix-mustusewith',
                    $this->encodeParamName( 'title' ),
                    $this->encodeParamName( 'prefix' ),
                ],
                'invalidparammix'
            );
        }
 
        // Handle deprecated param
        $this->requireMaxOneParameter( $params, 'url', 'prop' );
        if ( $params['url'] ) {
            $prop = [ 'url' => 1 ];
        }
 
        $this->setVirtualDomain( InterwikiLinksTable::VIRTUAL_DOMAIN );
 
        $this->addFields( [
            'iwl_from',
            'iwl_prefix',
            'iwl_title'
        ] );
        $this->addTables( 'iwlinks' );
        $this->addWhereFld( 'iwl_from', array_keys( $pages ) );
 
        if ( $params['continue'] !== null ) {
            $cont = $this->parseContinueParamOrDie( $params['continue'], [ 'int', 'string', 'string' ] );
            $op = $params['dir'] == 'descending' ? '<=' : '>=';
            $this->addWhere( $this->getDB()->buildComparison( $op, [
                'iwl_from' => $cont[0],
                'iwl_prefix' => $cont[1],
                'iwl_title' => $cont[2],
            ] ) );
        }
 
        $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', [
                    'iwl_from' . $sort,
                    'iwl_title' . $sort
                ] );
            }
        } else {
            // Don't order by iwl_from if it's constant in the WHERE clause
            if ( count( $pages ) === 1 ) {
                $this->addOption( 'ORDER BY', 'iwl_prefix' . $sort );
            } else {
                $this->addOption( 'ORDER BY', [
                    'iwl_from' . $sort,
                    'iwl_prefix' . $sort,
                    'iwl_title' . $sort
                ] );
            }
        }
 
        $this->addOption( 'LIMIT', $params['limit'] + 1 );
        $res = $this->select( __METHOD__ );
 
        $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->iwl_from}|{$row->iwl_prefix}|{$row->iwl_title}"
                );
                break;
            }
            $entry = [ 'prefix' => $row->iwl_prefix ];
 
            if ( isset( $prop['url'] ) ) {
                $title = Title::newFromText( "{$row->iwl_prefix}:{$row->iwl_title}" );
                if ( $title ) {
                    $entry['url'] = (string)$this->urlUtils->expand( $title->getFullURL(), PROTO_CURRENT );
                }
            }
 
            ApiResult::setContentValue( $entry, 'title', $row->iwl_title );
            $fit = $this->addPageSubItem( $row->iwl_from, $entry );
            if ( !$fit ) {
                $this->setContinueEnumParameter(
                    'continue',
                    "{$row->iwl_from}|{$row->iwl_prefix}|{$row->iwl_title}"
                );
                break;
            }
        }
    }
 
    public function getCacheMode( $params ) {
        return 'public';
    }
 
    public function getAllowedParams() {
        return [
            'prop' => [
                ParamValidator::PARAM_ISMULTI => true,
                ParamValidator::PARAM_TYPE => [
                    'url',
                ],
                ApiBase::PARAM_HELP_MSG_PER_VALUE => [],
            ],
            'prefix' => null,
            'title' => null,
            'dir' => [
                ParamValidator::PARAM_DEFAULT => 'ascending',
                ParamValidator::PARAM_TYPE => [
                    'ascending',
                    'descending'
                ]
            ],
            'limit' => [
                ParamValidator::PARAM_DEFAULT => 10,
                ParamValidator::PARAM_TYPE => 'limit',
                IntegerDef::PARAM_MIN => 1,
                IntegerDef::PARAM_MAX => ApiBase::LIMIT_BIG1,
                IntegerDef::PARAM_MAX2 => ApiBase::LIMIT_BIG2
            ],
            'continue' => [
                ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
            ],
            'url' => [
                ParamValidator::PARAM_DEFAULT => false,
                ParamValidator::PARAM_DEPRECATED => true,
            ],
        ];
    }
 
    protected function getExamplesMessages() {
        $title = Title::newMainPage()->getPrefixedText();
        $mp = rawurlencode( $title );
 
        return [
            "action=query&prop=iwlinks&titles={$mp}"
                => 'apihelp-query+iwlinks-example-simple',
        ];
    }
 
    public function getHelpUrls() {
        return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Iwlinks';
    }
}
 
class_alias( ApiQueryIWLinks::class, 'ApiQueryIWLinks' );