SpecialLinkSearch.php

Go to the documentation of this file.

<?php
use Wikimedia\Rdbms\IResultWrapper;
use Wikimedia\Rdbms\IDatabase;
 
class SpecialLinkSearch extends QueryPage {
    private $mungedQuery = false;
    private $mQuery;
    private $mNs;
    private $mProt;
 
    function setParams( $params ) {
        $this->mQuery = $params['query'];
        $this->mNs = $params['namespace'];
        $this->mProt = $params['protocol'];
    }
 
    function __construct( $name = 'LinkSearch' ) {
        parent::__construct( $name );
 
        // Since we don't control the constructor parameters, we can't inject services that way.
        // Instead, we initialize services in the execute() method, and allow them to be overridden
        // using the setServices() method.
    }
 
    function isCacheable() {
        return false;
    }
 
    public function execute( $par ) {
        $this->setHeaders();
        $this->outputHeader();
 
        $out = $this->getOutput();
        $out->allowClickjacking();
 
        $request = $this->getRequest();
        $target = $request->getVal( 'target', $par );
        $namespace = $request->getIntOrNull( 'namespace' );
 
        $protocols_list = [];
        foreach ( $this->getConfig()->get( 'UrlProtocols' ) as $prot ) {
            if ( $prot !== '//' ) {
                $protocols_list[] = $prot;
            }
        }
 
        $target2 = Parser::normalizeLinkUrl( $target );
        // Get protocol, default is http://
        $protocol = 'http://';
        $bits = wfParseUrl( $target );
        if ( isset( $bits['scheme'] ) && isset( $bits['delimiter'] ) ) {
            $protocol = $bits['scheme'] . $bits['delimiter'];
            // Make sure wfParseUrl() didn't make some well-intended correction in the
            // protocol
            if ( strcasecmp( $protocol, substr( $target, 0, strlen( $protocol ) ) ) === 0 ) {
                $target2 = substr( $target, strlen( $protocol ) );
            } else {
                // If it did, let LinkFilter::makeLikeArray() handle this
                $protocol = '';
            }
        }
 
        $out->addWikiMsg(
            'linksearch-text',
            '<nowiki>' . $this->getLanguage()->commaList( $protocols_list ) . '</nowiki>',
            count( $protocols_list )
        );
        $fields = [
            'target' => [
                'type' => 'text',
                'name' => 'target',
                'id' => 'target',
                'size' => 50,
                'label-message' => 'linksearch-pat',
                'default' => $target,
                'dir' => 'ltr',
            ]
        ];
        if ( !$this->getConfig()->get( 'MiserMode' ) ) {
            $fields += [
                'namespace' => [
                    'type' => 'namespaceselect',
                    'name' => 'namespace',
                    'label-message' => 'linksearch-ns',
                    'default' => $namespace,
                    'id' => 'namespace',
                    'all' => '',
                    'cssclass' => 'namespaceselector',
                ],
            ];
        }
        $hiddenFields = [
            'title' => $this->getPageTitle()->getPrefixedDBkey(),
        ];
        $htmlForm = HTMLForm::factory( 'ooui', $fields, $this->getContext() );
        $htmlForm->addHiddenFields( $hiddenFields );
        $htmlForm->setSubmitTextMsg( 'linksearch-ok' );
        $htmlForm->setWrapperLegendMsg( 'linksearch' );
        $htmlForm->setAction( wfScript() );
        $htmlForm->setMethod( 'get' );
        $htmlForm->prepareForm()->displayForm( false );
        $this->addHelpLink( 'Help:Linksearch' );
 
        if ( $target != '' ) {
            $this->setParams( [
                'query' => $target2,
                'namespace' => $namespace,
                'protocol' => $protocol ] );
            parent::execute( $par );
            if ( $this->mungedQuery === false ) {
                $out->addWikiMsg( 'linksearch-error' );
            }
        }
    }
 
    function isSyndicated() {
        return false;
    }
 
    function linkParameters() {
        $params = [];
        $params['target'] = $this->mProt . $this->mQuery;
        if ( $this->mNs !== null && !$this->getConfig()->get( 'MiserMode' ) ) {
            $params['namespace'] = $this->mNs;
        }
 
        return $params;
    }
 
    public function getQueryInfo() {
        $dbr = wfGetDB( DB_REPLICA );
 
        if ( $this->mQuery === '*' && $this->mProt !== '' ) {
            $this->mungedQuery = [
                'el_index_60' . $dbr->buildLike( $this->mProt, $dbr->anyString() ),
            ];
        } else {
            $this->mungedQuery = LinkFilter::getQueryConditions( $this->mQuery, [
                'protocol' => $this->mProt,
                'oneWildcard' => true,
                'db' => $dbr
            ] );
        }
        if ( $this->mungedQuery === false ) {
            // Invalid query; return no results
            return [ 'tables' => 'page', 'fields' => 'page_id', 'conds' => '0=1' ];
        }
 
        $orderBy = [];
        if ( !isset( $this->mungedQuery['el_index_60'] ) ) {
            $orderBy[] = 'el_index_60';
        }
        $orderBy[] = 'el_id';
 
        $retval = [
            'tables' => [ 'page', 'externallinks' ],
            'fields' => [
                'namespace' => 'page_namespace',
                'title' => 'page_title',
                'value' => 'el_index',
                'url' => 'el_to'
            ],
            'conds' => array_merge(
                [
                    'page_id = el_from',
                ],
                $this->mungedQuery
            ),
            'options' => [ 'ORDER BY' => $orderBy ]
        ];
 
        if ( $this->mNs !== null && !$this->getConfig()->get( 'MiserMode' ) ) {
            $retval['conds']['page_namespace'] = $this->mNs;
        }
 
        return $retval;
    }
 
    function preprocessResults( $db, $res ) {
        $this->executeLBFromResultWrapper( $res );
    }
 
    function formatResult( $skin, $result ) {
        $title = new TitleValue( (int)$result->namespace, $result->title );
        $pageLink = $this->getLinkRenderer()->makeLink( $title );
 
        $url = $result->url;
        $urlLink = Linker::makeExternalLink( $url, $url );
 
        return $this->msg( 'linksearch-line' )->rawParams( $urlLink, $pageLink )->escaped();
    }
 
    function getOrderFields() {
        return [];
    }
 
    protected function getGroupName() {
        return 'redirects';
    }
 
    protected function getMaxResults() {
        return max( parent::getMaxResults(), 60000 );
    }
}