wikimedia/mediawiki-core

<?php
/**
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
 */

namespace MediaWiki\Specials;

use MediaWiki\Cache\LinkBatchFactory;
use MediaWiki\ExternalLinks\LinkFilter;
use MediaWiki\HTMLForm\HTMLForm;
use MediaWiki\Linker\Linker;
use MediaWiki\MainConfigNames;
use MediaWiki\Parser\Parser;
use MediaWiki\SpecialPage\QueryPage;
use MediaWiki\Title\TitleValue;
use MediaWiki\Utils\UrlUtils;
use Skin;
use stdClass;
use Wikimedia\Rdbms\IConnectionProvider;
use Wikimedia\Rdbms\IDatabase;
use Wikimedia\Rdbms\IExpression;
use Wikimedia\Rdbms\IResultWrapper;
use Wikimedia\Rdbms\LikeValue;

/**
 * Special:LinkSearch to search the external-links table.
 *
 * @ingroup SpecialPage
 * @author Brooke Vibber
 */
class SpecialLinkSearch extends QueryPage {
    /** @var array|bool */
    private $mungedQuery = false;
    /** @var string|null */
    private $mQuery;
    /** @var int|null */
    private $mNs;
    /** @var string|null */
    private $mProt;

    private UrlUtils $urlUtils;

    private function setParams( $params ) {
        $this->mQuery = $params['query'];
        $this->mNs = $params['namespace'];
        $this->mProt = $params['protocol'];
    }

    /**
     * @param IConnectionProvider $dbProvider
     * @param LinkBatchFactory $linkBatchFactory
     * @param UrlUtils $urlUtils
     */
    public function __construct(
        IConnectionProvider $dbProvider,
        LinkBatchFactory $linkBatchFactory,
        UrlUtils $urlUtils
    ) {
        parent::__construct( 'LinkSearch' );
        $this->setDatabaseProvider( $dbProvider );
        $this->setLinkBatchFactory( $linkBatchFactory );
        $this->urlUtils = $urlUtils;
    }

    public function isCacheable() {
        return false;
    }

    public function execute( $par ) {
        $this->setHeaders();
        $this->outputHeader();

        $out = $this->getOutput();
        $out->setPreventClickjacking( false );

        $request = $this->getRequest();
        $target = $request->getVal( 'target', $par ?? '' );
        $namespace = $request->getIntOrNull( 'namespace' );

        $protocols_list = [];
        foreach ( $this->getConfig()->get( MainConfigNames::UrlProtocols ) as $prot ) {
            if ( $prot !== '//' ) {
                $protocols_list[] = $prot;
            }
        }

        $target2 = Parser::normalizeLinkUrl( $target );
        $protocol = null;
        $bits = $this->urlUtils->parse( $target );
        if ( isset( $bits['scheme'] ) && isset( $bits['delimiter'] ) ) {
            $protocol = $bits['scheme'] . $bits['delimiter'];
            // Make sure UrlUtils::parse() didn't make some well-intended correction in the protocol
            if ( str_starts_with( strtolower( $target ), strtolower( $protocol ) ) ) {
                $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( MainConfigNames::MiserMode ) ) {
            $fields += [
                'namespace' => [
                    'type' => 'namespaceselect',
                    'name' => 'namespace',
                    'label-message' => 'linksearch-ns',
                    'default' => $namespace,
                    'id' => 'namespace',
                    'all' => '',
                    'cssclass' => 'namespaceselector',
                ],
            ];
        }
        $htmlForm = HTMLForm::factory( 'ooui', $fields, $this->getContext() );
        $htmlForm->setSubmitTextMsg( 'linksearch-ok' );
        $htmlForm->setWrapperLegendMsg( 'linksearch' );
        $htmlForm->setTitle( $this->getPageTitle() );
        $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' );
            }
        }
    }

    /**
     * Disable RSS/Atom feeds
     * @return bool
     */
    public function isSyndicated() {
        return false;
    }

    protected function linkParameters() {
        $params = [];
        $params['target'] = $this->mProt . $this->mQuery;
        if ( $this->mNs !== null && !$this->getConfig()->get( MainConfigNames::MiserMode ) ) {
            $params['namespace'] = $this->mNs;
        }

        return $params;
    }

    public function getQueryInfo() {
        $dbr = $this->getDatabaseProvider()->getReplicaDatabase();

        $field = 'el_to_domain_index';
        $extraFields = [
            'urldomain' => 'el_to_domain_index',
            'urlpath' => 'el_to_path'
        ];
        if ( $this->mQuery === '*' && $this->mProt !== '' ) {
            $this->mungedQuery = [
                $dbr->expr( $field, IExpression::LIKE, new LikeValue( $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 = [ 'el_id' ];

        $retval = [
            'tables' => [ 'page', 'externallinks' ],
            'fields' => array_merge( [
                'namespace' => 'page_namespace',
                'title' => 'page_title',
            ], $extraFields ),
            'conds' => array_merge(
                [
                    'page_id = el_from',
                ],
                $this->mungedQuery
            ),
            'options' => [ 'ORDER BY' => $orderBy ]
        ];

        if ( $this->mNs !== null && !$this->getConfig()->get( MainConfigNames::MiserMode ) ) {
            $retval['conds']['page_namespace'] = $this->mNs;
        }

        return $retval;
    }

    /**
     * Pre-fill the link cache
     *
     * @param IDatabase $db
     * @param IResultWrapper $res
     */
    public function preprocessResults( $db, $res ) {
        $this->executeLBFromResultWrapper( $res );
    }

    /**
     * @param Skin $skin
     * @param stdClass $result Result row
     * @return string
     */
    public function formatResult( $skin, $result ) {
        $title = new TitleValue( (int)$result->namespace, $result->title );
        $pageLink = $this->getLinkRenderer()->makeLink( $title );
        $url = LinkFilter::reverseIndexes( $result->urldomain ) . $result->urlpath;

        $urlLink = Linker::makeExternalLink( $url, $url );

        return $this->msg( 'linksearch-line' )->rawParams( $urlLink, $pageLink )->escaped();
    }

    /**
     * Override to squash the ORDER BY.
     * Not much point in descending order here.
     * @return array
     */
    protected function getOrderFields() {
        return [];
    }

    protected function getGroupName() {
        return 'pages';
    }

    /**
     * enwiki complained about low limits on this special page
     *
     * @see T130058
     * @todo FIXME This special page should not use LIMIT for paging
     * @return int
     */
    protected function getMaxResults() {
        return max( parent::getMaxResults(), 60000 );
    }
}

/** @deprecated class alias since 1.41 */
class_alias( SpecialLinkSearch::class, 'SpecialLinkSearch' );