3namespace MediaWiki\Search\SearchWidgets;
5use MediaWiki\Category\Category;
6use MediaWiki\FileRepo\File\File;
7use MediaWiki\FileRepo\RepoGroup;
8use MediaWiki\HookContainer\HookContainer;
9use MediaWiki\HookContainer\HookRunner;
10use MediaWiki\Html\Html;
11use MediaWiki\Linker\LinkRenderer;
12use MediaWiki\MainConfigNames;
13use MediaWiki\Media\MediaTransformOutput;
14use MediaWiki\Media\ThumbnailImage;
15use MediaWiki\Message\Message;
16use MediaWiki\Parser\Sanitizer;
17use MediaWiki\Search\Entity\SearchResultThumbnail;
18use MediaWiki\Search\SearchResult;
19use MediaWiki\Search\SearchResultThumbnailProvider;
20use MediaWiki\Specials\SpecialSearch;
21use MediaWiki\Title\Title;
22use MediaWiki\User\Options\UserOptionsManager;
23use Wikimedia\HtmlArmor\HtmlArmor;
44 private $thumbnailPlaceholderHtml;
56 $this->hookRunner =
new HookRunner( $hookContainer );
57 $this->repoGroup = $repoGroup;
58 $this->thumbnailProvider = $thumbnailProvider;
59 $this->userOptionsManager = $userOptionsManager;
80 if ( !$this->specialPage->getAuthority()->definitelyCan(
'read', $result->
getTitle() ) ) {
81 return Html::rawElement(
'li', [], $link );
87 $date = htmlspecialchars(
88 $this->specialPage->getLanguage()->userTimeAndDate(
90 $this->specialPage->getUser()
96 $snippetWithEllipsis = $snippet . $this->specialPage->msg(
'ellipsis' );
97 $extract = Html::rawElement(
'div', [
'class' =>
'searchresult' ], $snippetWithEllipsis );
114 $terms = $result instanceof \MediaWiki\Search\SqlSearchResult ? $result->getTermMatches() : [];
115 if ( !$this->hookRunner->onShowSearchHit( $this->specialPage, $result,
116 $terms, $link, $redirect, $section, $extract, $score,
118 $desc, $date, $related, $html )
125 $joined =
"{$link} {$redirect} {$category} {$section} {$file}";
126 $meta = $this->
buildMeta( $desc, $date );
129 $html = Html::rawElement(
131 [
'class' =>
'mw-search-result-heading' ],
134 $html .= $extract .
' ' . $meta;
138 $gridCells = Html::rawElement(
140 [
'class' =>
'searchResultImage-thumbnail' ],
142 ) . Html::rawElement(
144 [
'class' =>
'searchResultImage-text' ],
147 $html = Html::rawElement(
149 [
'class' =>
'searchResultImage' ],
154 return Html::rawElement(
156 [
'class' => [
'mw-search-result',
'mw-search-result-ns-' . $result->
getTitle()->getNamespace() ] ],
173 if ( $snippet ===
'' ) {
182 if ( $title->isRedirect() ) {
187 $query[
'redirect'] =
'no';
190 $attributes = [
'data-serp-pos' => $position ];
191 $this->hookRunner->onShowSearchHitTitle( $title, $snippet, $result,
194 $this->specialPage, $query, $attributes );
196 $link = $this->linkRenderer->makeLink(
217 $inner = $title ===
null
219 : $this->linkRenderer->makeLink( $title, $text ?
new HtmlArmor( $text ) :
null );
221 return "<span class='searchalttitle'>" .
222 $this->specialPage->msg( $msgKey )->rawParams( $inner )->parse()
232 return $title ===
null
243 return $title ===
null
266 $cat = Category::newFromTitle( $title );
267 return $this->specialPage->msg(
'search-result-category-size' )
268 ->numParams( $cat->getMemberCount(), $cat->getSubcatCount(), $cat->getFileCount() )
272 return $this->specialPage->msg(
'search-result-size' )
290 if ( $title ===
null || !$title->canExist() ) {
291 return [
'',
null, null ];
297 [
'class' =>
'searchalttitle' ],
298 $this->specialPage->msg(
'search-file-match' )->text()
302 $allowExtraThumbsFromRequest = $this->specialPage->getRequest()->getVal(
'search-thumbnail-extra-namespaces' );
303 $allowExtraThumbsFromPreference = $this->userOptionsManager->getOption(
304 $this->specialPage->getUser(),
305 'search-thumbnail-extra-namespaces'
307 $allowExtraThumbs = (bool)( $allowExtraThumbsFromRequest ?? $allowExtraThumbsFromPreference );
308 if ( !$allowExtraThumbs && $title->getNamespace() !==
NS_FILE ) {
309 return [ $html,
null, null ];
312 $thumbnail = $this->getThumbnail( $result, self::THUMBNAIL_SIZE );
313 $thumbnailName = $thumbnail ? $thumbnail->getName() :
null;
314 if ( !$thumbnailName ) {
315 return [ $html,
null, $this->generateThumbnailHtml( $result ) ];
318 $img = $this->repoGroup->findFile( $thumbnailName );
320 return [ $html,
null, $this->generateThumbnailHtml( $result ) ];
325 $unsafeShortDesc = $img->getShortDesc( $this->specialPage->getLanguage() );
326 $shortDesc = Sanitizer::removeSomeTags( $unsafeShortDesc );
330 $this->specialPage->msg(
'parentheses' )->rawParams( $shortDesc )->escaped(),
331 $this->generateThumbnailHtml( $result, $thumbnail )
341 $title = $result->getTitle();
343 if ( $title ===
null || !$title->canExist() ) {
347 $thumbnails = $this->thumbnailProvider->getThumbnails( [ $title->getArticleID() => $title ], $size );
349 return $thumbnails[ $title->getArticleID() ] ??
null;
358 $title = $result->getTitle();
360 if ( $title ===
null || !$title->canExist() ) {
365 if ( !$title->inNamespaces( $thumbnailNamespaces ) ) {
369 $thumbnailName = $thumbnail?->getName();
370 if ( $thumbnailName ===
null ) {
371 return $this->generateThumbnailPlaceholderHtml();
374 $img = $this->repoGroup->findFile( $thumbnailName );
376 return $this->generateThumbnailPlaceholderHtml();
379 $thumb = $this->transformThumbnail( $img, $thumbnail );
381 if ( $title->getNamespace() ===
NS_FILE ) {
383 return $thumb->toHtml( [
386 'alt' => $this->specialPage->msg(
'search-thumbnail-alt', $title->getPrefixedText() ),
391 return $thumb->toHtml( [
393 'custom-title-link' =>
$title,
395 'alt' => $this->specialPage->msg(
'search-thumbnail-alt',
$title->getPrefixedText() ),
399 return $this->generateThumbnailPlaceholderHtml();
407 private function transformThumbnail( File $img, SearchResultThumbnail $thumbnail ) {
408 $optimalThumbnailWidth = $thumbnail->getWidth();
415 $thumbnailMaxDimension = max( $thumbnail->getWidth(), $thumbnail->getHeight() );
416 $thumbnailMinDimension = min( $thumbnail->getWidth(), $thumbnail->getHeight() );
417 $rescaleCoefficient = $thumbnailMinDimension
418 ? $thumbnailMaxDimension / $thumbnailMinDimension : 1;
423 $rescaledWidth = (int)round( $rescaleCoefficient * $thumbnail->getWidth() );
432 if ( $rescaledWidth !== $thumbnail->getWidth() ) {
433 $thumbLimits = $this->specialPage->getConfig()->get( MainConfigNames::ThumbLimits );
434 $largerThumbLimits = array_filter(
436 static function ( $limit ) use ( $rescaledWidth ) {
437 return $limit >= $rescaledWidth;
440 $optimalThumbnailWidth = $largerThumbLimits ? min( $largerThumbLimits ) : max( $thumbLimits );
443 return $img->transform( [
'width' => $optimalThumbnailWidth ] );
446 private function generateThumbnailPlaceholderHtml(): string {
447 if ( $this->thumbnailPlaceholderHtml ) {
448 return $this->thumbnailPlaceholderHtml;
451 $path = MW_INSTALL_PATH .
'/resources/lib/ooui/themes/wikimediaui/images/icons/imageLayoutFrameless.svg';
452 $this->thumbnailPlaceholderHtml = Html::rawElement(
455 'class' =>
'searchResultImage-thumbnail-placeholder',
456 'aria-hidden' =>
'true',
458 file_get_contents(
$path )
460 return $this->thumbnailPlaceholderHtml;
471 if ( $desc && $date ) {
472 $meta = $this->specialPage->msg(
'search-result-meta-separator',
484 return "<div class='mw-search-result-data'>{$meta}</div>";
if(!defined('MW_SETUP_CALLBACK'))
const ThumbnailNamespaces
Name constant for the ThumbnailNamespaces setting, for use with Config\get().