FullSearchResultWidget.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Search\SearchWidgets;
 
use Category;
use Html;
use HtmlArmor;
use MediaWiki\HookContainer\HookContainer;
use MediaWiki\HookContainer\HookRunner;
use MediaWiki\Linker\LinkRenderer;
use MediaWiki\MediaWikiServices;
use SearchResult;
use SpecialSearch;
use Title;
 
class FullSearchResultWidget implements SearchResultWidget {
    protected $specialPage;
    protected $linkRenderer;
    private $hookRunner;
 
    public function __construct( SpecialSearch $specialPage, LinkRenderer $linkRenderer,
        HookContainer $hookContainer
    ) {
        $this->specialPage = $specialPage;
        $this->linkRenderer = $linkRenderer;
        $this->hookRunner = new HookRunner( $hookContainer );
    }
 
    public function render( SearchResult $result, $position ) {
        // If the page doesn't *exist*... our search index is out of date.
        // The least confusing at this point is to drop the result.
        // You may get less results, but... on well. :P
        if ( $result->isBrokenTitle() || $result->isMissingRevision() ) {
            return '';
        }
 
        $link = $this->generateMainLinkHtml( $result, $position );
        // If page content is not readable, just return ths title.
        // This is not quite safe, but better than showing excerpts from
        // non-readable pages. Note that hiding the entry entirely would
        // screw up paging (really?).
        if ( !$this->specialPage->getAuthority()->definitelyCan( 'read', $result->getTitle() ) ) {
            return Html::rawElement( 'li', [], $link );
        }
 
        $redirect = $this->generateRedirectHtml( $result );
        $section = $this->generateSectionHtml( $result );
        $category = $this->generateCategoryHtml( $result );
        $date = htmlspecialchars(
            $this->specialPage->getLanguage()->userTimeAndDate(
                $result->getTimestamp(),
                $this->specialPage->getUser()
            )
        );
        list( $file, $desc, $thumb ) = $this->generateFileHtml( $result );
        $snippet = $result->getTextSnippet();
        if ( $snippet ) {
            $extract = Html::rawElement( 'div', [ 'class' => 'searchresult' ], $snippet );
        } else {
            $extract = '';
        }
 
        if ( $thumb === null ) {
            // If no thumb, then the description is about size
            $desc = $this->generateSizeHtml( $result );
 
            // Let hooks do their own final construction if desired.
            // FIXME: Not sure why this is only for results without thumbnails,
            // but keeping it as-is for now to prevent breaking hook consumers.
            $html = null;
            $score = '';
            $related = '';
            // TODO: remove this instanceof and always pass [], let implementors do the cast if
            // they want to be SearchDatabase specific
            $terms = $result instanceof \SqlSearchResult ? $result->getTermMatches() : [];
            if ( !$this->hookRunner->onShowSearchHit( $this->specialPage, $result,
                $terms, $link, $redirect, $section, $extract, $score,
                // @phan-suppress-next-line PhanTypeMismatchArgument Type mismatch on pass-by-ref args
                $desc, $date, $related, $html )
            ) {
                return $html;
            }
        }
 
        // All the pieces have been collected. Now generate the final HTML
        $joined = "{$link} {$redirect} {$category} {$section} {$file}";
        $meta = $this->buildMeta( $desc, $date );
 
        if ( $thumb === null ) {
            $html = Html::rawElement(
                'div',
                [ 'class' => 'mw-search-result-heading' ],
                $joined
            );
            $html .= $extract . ' ' . $meta;
        } else {
            $tableCells = Html::rawElement(
                'td',
                [ 'style' => 'width: 120px; text-align: center; vertical-align: top' ],
                $thumb
            ) . Html::rawElement(
                'td',
                [ 'style' => 'vertical-align: top' ],
                "$joined $extract $meta"
            );
            $html = Html::rawElement(
                'table',
                [ 'class' => 'searchResultImage' ],
                Html::rawElement(
                    'tr',
                    [],
                    $tableCells
                )
            );
        }
 
        return Html::rawElement( 'li', [ 'class' => 'mw-search-result' ], $html );
    }
 
    protected function generateMainLinkHtml( SearchResult $result, $position ) {
        $snippet = $result->getTitleSnippet();
        if ( $snippet === '' ) {
            $snippet = null;
        } else {
            $snippet = new HtmlArmor( $snippet );
        }
 
        // clone to prevent hook from changing the title stored inside $result
        $title = clone $result->getTitle();
        $query = [];
 
        $attributes = [ 'data-serp-pos' => $position ];
        $this->hookRunner->onShowSearchHitTitle( $title, $snippet, $result,
            $result instanceof \SqlSearchResult ? $result->getTermMatches() : [],
            // @phan-suppress-next-line PhanTypeMismatchArgument Type mismatch on pass-by-ref args
            $this->specialPage, $query, $attributes );
 
        $link = $this->linkRenderer->makeLink(
            $title,
            $snippet,
            $attributes,
            $query
        );
 
        return $link;
    }
 
    protected function generateAltTitleHtml( $msgKey, ?Title $title, $text ) {
        $inner = $title === null
            ? $text
            : $this->linkRenderer->makeLink( $title, $text ? new HtmlArmor( $text ) : null );
 
        return "<span class='searchalttitle'>" .
                $this->specialPage->msg( $msgKey )->rawParams( $inner )->parse()
            . "</span>";
    }
 
    protected function generateRedirectHtml( SearchResult $result ) {
        $title = $result->getRedirectTitle();
        return $title === null
            ? ''
            : $this->generateAltTitleHtml( 'search-redirect', $title, $result->getRedirectSnippet() );
    }
 
    protected function generateSectionHtml( SearchResult $result ) {
        $title = $result->getSectionTitle();
        return $title === null
            ? ''
            : $this->generateAltTitleHtml( 'search-section', $title, $result->getSectionSnippet() );
    }
 
    protected function generateCategoryHtml( SearchResult $result ) {
        $snippet = $result->getCategorySnippet();
        return $snippet
            ? $this->generateAltTitleHtml( 'search-category', null, $snippet )
            : '';
    }
 
    protected function generateSizeHtml( SearchResult $result ) {
        $title = $result->getTitle();
        if ( $title->getNamespace() === NS_CATEGORY ) {
            $cat = Category::newFromTitle( $title );
            return $this->specialPage->msg( 'search-result-category-size' )
                ->numParams( $cat->getMemberCount(), $cat->getSubcatCount(), $cat->getFileCount() )
                ->escaped();
        // TODO: This is a bit odd...but requires changing the i18n message to fix
        } elseif ( $result->getByteSize() !== null || $result->getWordCount() > 0 ) {
            return $this->specialPage->msg( 'search-result-size' )
                ->sizeParams( $result->getByteSize() )
                ->numParams( $result->getWordCount() )
                ->escaped();
        }
 
        return '';
    }
 
    protected function generateFileHtml( SearchResult $result ) {
        $title = $result->getTitle();
        if ( $title->getNamespace() !== NS_FILE ) {
            return [ '', null, null ];
        }
 
        if ( $result->isFileMatch() ) {
            $html = Html::rawElement(
                'span',
                [ 'class' => 'searchalttitle' ],
                $this->specialPage->msg( 'search-file-match' )->escaped()
            );
        } else {
            $html = '';
        }
 
        $descHtml = null;
        $thumbHtml = null;
 
        $img = $result->getFile() ?: MediaWikiServices::getInstance()->getRepoGroup()
            ->findFile( $title );
        if ( $img ) {
            $thumb = $img->transform( [ 'width' => 120, 'height' => 120 ] );
            if ( $thumb ) {
                $descHtml = $this->specialPage->msg( 'parentheses' )
                    ->rawParams( $img->getShortDesc() )
                    ->escaped();
                $thumbHtml = $thumb->toHtml( [ 'desc-link' => true ] );
            }
        }
 
        return [ $html, $descHtml, $thumbHtml ];
    }
 
    protected function buildMeta( $desc, $date ) {
        if ( $desc && $date ) {
            $meta = "{$desc} - {$date}";
        } elseif ( $desc ) {
            $meta = $desc;
        } elseif ( $date ) {
            $meta = $date;
        } else {
            return '';
        }
 
        return "<div class='mw-search-result-data'>{$meta}</div>";
    }
}