ApiQueryExternalLinks.php

Go to the documentation of this file.

<?php
use MediaWiki\ExternalLinks\LinkFilter;
use MediaWiki\Title\Title;
use Wikimedia\ParamValidator\ParamValidator;
use Wikimedia\ParamValidator\TypeDef\IntegerDef;
 
class ApiQueryExternalLinks extends ApiQueryBase {
 
    public function __construct( ApiQuery $query, $moduleName ) {
        parent::__construct( $query, $moduleName, 'el' );
    }
 
    public function execute() {
        $pages = $this->getPageSet()->getGoodPages();
        if ( $pages === [] ) {
            return;
        }
 
        $params = $this->extractRequestParams();
        $db = $this->getDB();
 
        $query = $params['query'];
        $protocol = LinkFilter::getProtocolPrefix( $params['protocol'] );
 
        $this->addFields( [
            'el_from',
            'el_to'
        ] );
 
        $this->addTables( 'externallinks' );
        $this->addWhereFld( 'el_from', array_keys( $pages ) );
 
        $orderBy = [];
 
        // Don't order by el_from if it's constant in the WHERE clause
        if ( count( $pages ) !== 1 ) {
            $orderBy[] = 'el_from';
        }
 
        if ( $query !== null && $query !== '' ) {
            $protocol ??= 'http://';
 
            // Normalize query to match the normalization applied for the externallinks table
            $query = Parser::normalizeLinkUrl( $protocol . $query );
 
            $conds = LinkFilter::getQueryConditions( $query, [
                'protocol' => '',
                'oneWildcard' => true,
                'db' => $db
            ] );
            if ( !$conds ) {
                $this->dieWithError( 'apierror-badquery' );
            }
            $this->addWhere( $conds );
            if ( !isset( $conds['el_index_60'] ) ) {
                $orderBy[] = 'el_index_60';
            }
        } else {
            $orderBy[] = 'el_index_60';
 
            if ( $protocol !== null ) {
                $this->addWhere( 'el_index_60' . $db->buildLike( "$protocol", $db->anyString() ) );
            } else {
                // We're querying all protocols, filter out duplicate protocol-relative links
                $this->addWhere( $db->makeList( [
                    'el_to NOT' . $db->buildLike( '//', $db->anyString() ),
                    'el_index_60 ' . $db->buildLike( 'http://', $db->anyString() ),
                ], LIST_OR ) );
            }
        }
 
        $orderBy[] = 'el_id';
 
        $this->addOption( 'ORDER BY', $orderBy );
        $this->addFields( $orderBy ); // Make sure
 
        $this->addOption( 'LIMIT', $params['limit'] + 1 );
 
        if ( $params['continue'] !== null ) {
            $cont = $this->parseContinueParamOrDie( $params['continue'],
                array_fill( 0, count( $orderBy ), 'string' ) );
            $conds = array_combine( $orderBy, array_map( 'rawurldecode', $cont ) );
            $this->addWhere( $db->buildComparison( '>=', $conds ) );
        }
 
        $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->setContinue( $orderBy, $row );
                break;
            }
            $entry = [];
            $to = $row->el_to;
            // expand protocol-relative urls
            if ( $params['expandurl'] ) {
                $to = wfExpandUrl( $to, PROTO_CANONICAL );
            }
            ApiResult::setContentValue( $entry, 'url', $to );
            $fit = $this->addPageSubItem( $row->el_from, $entry );
            if ( !$fit ) {
                $this->setContinue( $orderBy, $row );
                break;
            }
        }
    }
 
    private function setContinue( $orderBy, $row ) {
        $fields = [];
        foreach ( $orderBy as $field ) {
            $fields[] = strtr( $row->$field, [ '%' => '%25', '|' => '%7C' ] );
        }
        $this->setContinueEnumParameter( 'continue', implode( '|', $fields ) );
    }
 
    public function getCacheMode( $params ) {
        return 'public';
    }
 
    public function getAllowedParams() {
        return [
            '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',
            ],
            'protocol' => [
                ParamValidator::PARAM_TYPE => LinkFilter::prepareProtocols(),
                ParamValidator::PARAM_DEFAULT => '',
            ],
            'query' => null,
            'expandurl' => false,
        ];
    }
 
    protected function getExamplesMessages() {
        $title = Title::newMainPage()->getPrefixedText();
        $mp = rawurlencode( $title );
 
        return [
            "action=query&prop=extlinks&titles={$mp}"
                => 'apihelp-query+extlinks-example-simple',
        ];
    }
 
    public function getHelpUrls() {
        return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Extlinks';
    }
}