InterwikiSearchResultSetWidget.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Search\SearchWidgets;
 
use MediaWiki\Html\Html;
use MediaWiki\Interwiki\InterwikiLookup;
use MediaWiki\Linker\LinkRenderer;
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use MediaWiki\Output\OutputPage;
use MediaWiki\Search\ISearchResultSet;
use MediaWiki\Specials\SpecialSearch;
use MediaWiki\Title\Title;
use OOUI;
 
class InterwikiSearchResultSetWidget implements SearchResultSetWidget {
    protected SpecialSearch $specialSearch;
    protected SearchResultWidget $resultWidget;
    protected LinkRenderer $linkRenderer;
    protected InterwikiLookup $iwLookup;
    protected OutputPage $output;
    protected bool $showMultimedia;
    protected array $iwLogoOverrides;
    protected ?array $customCaptions = null;
 
    public function __construct(
        SpecialSearch $specialSearch,
        SearchResultWidget $resultWidget,
        LinkRenderer $linkRenderer,
        InterwikiLookup $iwLookup,
        bool $showMultimedia = false
    ) {
        $this->specialSearch = $specialSearch;
        $this->resultWidget = $resultWidget;
        $this->linkRenderer = $linkRenderer;
        $this->iwLookup = $iwLookup;
        $this->output = $specialSearch->getOutput();
        $this->showMultimedia = $showMultimedia;
        $this->iwLogoOverrides = $this->specialSearch->getConfig()->get( MainConfigNames::InterwikiLogoOverride );
    }
 
    public function render( $term, $resultSets ) {
        if ( !is_array( $resultSets ) ) {
            $resultSets = [ $resultSets ];
        }
 
        $this->loadCustomCaptions();
 
        if ( $this->showMultimedia ) {
            $this->output->addModules( 'mediawiki.special.search.commonsInterwikiWidget' );
        }
        $this->output->addModuleStyles( 'mediawiki.special.search.interwikiwidget.styles' );
        $this->output->addModuleStyles( 'oojs-ui.styles.icons-wikimedia' );
 
        $iwResults = [];
        foreach ( $resultSets as $resultSet ) {
            foreach ( $resultSet as $result ) {
                if ( !$result->isBrokenTitle() ) {
                    $iwResults[$result->getTitle()->getInterwiki()][] = $result;
                }
            }
        }
 
        $iwResultSetPos = 1;
        $iwResultListOutput = '';
 
        foreach ( $iwResults as $iwPrefix => $results ) {
            // TODO: Assumes interwiki results are never paginated
            $position = 0;
            $iwResultItemOutput = '';
 
            foreach ( $results as $result ) {
                $iwResultItemOutput .= $this->resultWidget->render( $result, $position++ );
            }
 
            $headerHtml = $this->headerHtml( $term, $iwPrefix );
            $footerHtml = $this->footerHtml( $term, $iwPrefix );
            $iwResultListOutput .= Html::rawElement( 'li',
                [
                    'class' => 'iw-resultset',
                    'data-iw-resultset-pos' => $iwResultSetPos,
                    'data-iw-resultset-source' => $iwPrefix
                ],
 
                $headerHtml .
                $iwResultItemOutput .
                $footerHtml
            );
            $iwResultSetPos++;
        }
 
        return Html::rawElement(
            'div',
            [ 'id' => 'mw-interwiki-results' ],
            Html::rawElement(
                'ul', [ 'class' => 'iw-results', ], $iwResultListOutput
            )
        );
    }
 
    protected function headerHtml( $term, $iwPrefix ) {
        $href = Title::makeTitle( NS_SPECIAL, 'Search', '', $iwPrefix )->getLocalURL(
            [ 'search' => $term, 'fulltext' => 1 ]
        );
 
        $interwiki = $this->iwLookup->fetch( $iwPrefix );
        // This is false if the lookup fails, or if the other wiki is on the same
        // domain name (i.e. /en-wiki/ and /de-wiki/)
        $iwHost = $interwiki ? parse_url( $interwiki->getURL(), PHP_URL_HOST ) : false;
 
        $captionText = $this->customCaptions[$iwPrefix] ?? $iwHost ?: $iwPrefix;
        $searchLink = Html::element( 'a', [ 'href' => $href, 'target' => '_blank' ], $captionText );
 
        return Html::rawElement( 'div',
            [ 'class' => 'iw-result__header' ],
            $this->iwIcon( $iwPrefix ) . $searchLink );
    }
 
    protected function footerHtml( $term, $iwPrefix ) {
        $href = Title::makeTitle( NS_SPECIAL, 'Search', '', $iwPrefix )->getLocalURL(
            [ 'search' => $term, 'fulltext' => 1 ]
        );
 
        $captionText = $this->specialSearch->msg( 'search-interwiki-resultset-link' )->text();
        $searchLink = Html::element( 'a', [ 'href' => $href, 'target' => '_blank' ], $captionText );
 
        return Html::rawElement( 'div',
            [ 'class' => 'iw-result__footer' ],
            $searchLink );
    }
 
    protected function loadCustomCaptions() {
        if ( $this->customCaptions !== null ) {
            return;
        }
 
        $this->customCaptions = [];
        $customLines = explode( "\n", $this->specialSearch->msg( 'search-interwiki-custom' )->text() );
        foreach ( $customLines as $line ) {
            $parts = explode( ':', $line, 2 );
            if ( count( $parts ) === 2 ) {
                $this->customCaptions[$parts[0]] = $parts[1];
            }
        }
    }
 
    protected function iwIcon( $iwPrefix ) {
        $logoName = $this->generateLogoName( $iwPrefix );
        // If the value is an URL we use the favicon
        if ( filter_var( $logoName, FILTER_VALIDATE_URL ) || $logoName === "/" ) {
            return $this->generateIconFromFavicon( $logoName );
        }
 
        $iwIcon = new OOUI\IconWidget( [
            'icon' => $logoName
        ] );
 
        return $iwIcon;
    }
 
    protected function generateLogoName( $prefix ) {
        if ( isset( $this->iwLogoOverrides[ $prefix ] ) ) {
            return $this->iwLogoOverrides[ $prefix ];
        }
 
        $interwiki = $this->iwLookup->fetch( $prefix );
        return $interwiki ? $interwiki->getURL() : '/';
    }
 
    protected function generateIconFromFavicon( $logoUrl ) {
        $urlUtils = MediaWikiServices::getInstance()->getUrlUtils();
        $parsed = $urlUtils->parse( (string)$urlUtils->expand( $logoUrl, PROTO_CURRENT ) );
        '@phan-var array $parsed'; // Valid URL
        $iwIconUrl = $parsed['scheme'] .
            $parsed['delimiter'] .
            $parsed['host'] .
            ( isset( $parsed['port'] ) ? ':' . $parsed['port'] : '' ) .
            '/favicon.ico';
 
        $iwIcon = new OOUI\IconWidget( [
            'icon' => 'favicon'
        ] );
 
        return $iwIcon->setAttributes( [ 'style' => "background-image:url($iwIconUrl);" ] );
    }
}