3 namespace MediaWiki\Widget\Search
;
8 use MediaWiki\Linker\LinkRenderer
;
14 * Renders a 'full' multi-line search result with metadata.
17 * some *highlighted* *text* about the search result
18 * 5KB (651 words) - 12:40, 6 Aug 2016
20 class FullSearchResultWidget
implements SearchResultWidget
{
21 /** @var SpecialSearch */
22 protected $specialPage;
23 /** @var LinkRenderer */
24 protected $linkRenderer;
26 public function __construct( SpecialSearch
$specialPage, LinkRenderer
$linkRenderer ) {
27 $this->specialPage
= $specialPage;
28 $this->linkRenderer
= $linkRenderer;
32 * @param SearchResult $result The result to render
33 * @param string $terms Terms to be highlighted (@see SearchResult::getTextSnippet)
34 * @param int $position The result position, including offset
37 public function render( SearchResult
$result, $terms, $position ) {
38 // If the page doesn't *exist*... our search index is out of date.
39 // The least confusing at this point is to drop the result.
40 // You may get less results, but... on well. :P
41 if ( $result->isBrokenTitle() ||
$result->isMissingRevision() ) {
45 $link = $this->generateMainLinkHtml( $result, $terms, $position );
46 // If page content is not readable, just return ths title.
47 // This is not quite safe, but better than showing excerpts from
48 // non-readable pages. Note that hiding the entry entirely would
49 // screw up paging (really?).
50 if ( !$result->getTitle()->userCan( 'read', $this->specialPage
->getUser() ) ) {
51 return "<li>{$link}</li>";
54 $redirect = $this->generateRedirectHtml( $result );
55 $section = $this->generateSectionHtml( $result );
56 $category = $this->generateCategoryHtml( $result );
57 $date = $this->specialPage
->getLanguage()->userTimeAndDate(
58 $result->getTimestamp(),
59 $this->specialPage
->getUser()
61 list( $file, $desc, $thumb ) = $this->generateFileHtml( $result );
62 $snippet = $result->getTextSnippet( $terms );
64 $extract = "<div class='searchresult'>$snippet</div>";
69 if ( $thumb === null ) {
70 // If no thumb, then the description is about size
71 $desc = $this->generateSizeHtml( $result );
73 // Let hooks do their own final construction if desired.
74 // FIXME: Not sure why this is only for results without thumbnails,
75 // but keeping it as-is for now to prevent breaking hook consumers.
79 if ( !Hooks
::run( 'ShowSearchHit', [
80 $this->specialPage
, $result, $terms,
81 &$link, &$redirect, &$section, &$extract,
82 &$score, &$size, &$date, &$related, &$html
88 // All the pieces have been collected. Now generate the final HTML
89 $joined = "{$link} {$redirect} {$category} {$section} {$file}";
90 $meta = $this->buildMeta( $desc, $date );
92 if ( $thumb === null ) {
94 "<div class='mw-search-result-heading'>{$joined}</div>" .
98 "<table class='searchResultImage'>" .
100 "<td style='width: 120px; text-align: center; vertical-align: top'>" .
103 "<td style='vertical-align: top'>" .
104 "{$joined} {$extract} {$meta}" .
110 return "<li>{$html}</li>";
114 * Generates HTML for the primary call to action. It is
115 * typically the article title, but the search engine can
116 * return an exact snippet to use (typically the article
117 * title with highlighted words).
119 * @param SearchResult $result
120 * @param string $terms
121 * @param int $position
122 * @return string HTML
124 protected function generateMainLinkHtml( SearchResult
$result, $terms, $position ) {
125 $snippet = $result->getTitleSnippet();
126 if ( $snippet === '' ) {
129 $snippet = new HtmlArmor( $snippet );
132 // clone to prevent hook from changing the title stored inside $result
133 $title = clone $result->getTitle();
136 $attributes = [ 'data-serp-pos' => $position ];
137 Hooks
::run( 'ShowSearchHitTitle',
138 [ &$title, &$snippet, $result, $terms, $this->specialPage
, &$query, &$attributes ] );
140 $link = $this->linkRenderer
->makeLink(
151 * Generates an alternate title link, such as (redirect from <a>Foo</a>).
153 * @param string $msgKey i18n message used to wrap title
154 * @param Title|null $title The title to link to, or null to generate
155 * the message without a link. In that case $text must be non-null.
156 * @param string|null $text The text snippet to display, or null
158 * @return string HTML
160 protected function generateAltTitleHtml( $msgKey, Title
$title = null, $text ) {
161 $inner = $title === null
163 : $this->linkRenderer
->makeLink( $title, $text ?
new HtmlArmor( $text ) : null );
165 return "<span class='searchalttitle'>" .
166 $this->specialPage
->msg( $msgKey )->rawParams( $inner )->text()
171 * @param SearchResult $result
172 * @return string HTML
174 protected function generateRedirectHtml( SearchResult
$result ) {
175 $title = $result->getRedirectTitle();
176 return $title === null
178 : $this->generateAltTitleHtml( 'search-redirect', $title, $result->getRedirectSnippet() );
182 * @param SearchResult $result
183 * @return string HTML
185 protected function generateSectionHtml( SearchResult
$result ) {
186 $title = $result->getSectionTitle();
187 return $title === null
189 : $this->generateAltTitleHtml( 'search-section', $title, $result->getSectionSnippet() );
193 * @param SearchResult $result
194 * @return string HTML
196 protected function generateCategoryHtml( SearchResult
$result ) {
197 $snippet = $result->getCategorySnippet();
199 ?
$this->generateAltTitleHtml( 'search-category', null, $snippet )
204 * @param SearchResult $result
205 * @return string HTML
207 protected function generateSizeHtml( SearchResult
$result ) {
208 $title = $result->getTitle();
209 if ( $title->getNamespace() === NS_CATEGORY
) {
210 $cat = Category
::newFromTitle( $title );
211 return $this->specialPage
->msg( 'search-result-category-size' )
212 ->numParams( $cat->getPageCount(), $cat->getSubcatCount(), $cat->getFileCount() )
214 // TODO: This is a bit odd...but requires changing the i18n message to fix
215 } elseif ( $result->getByteSize() !== null ||
$result->getWordCount() > 0 ) {
216 $lang = $this->specialPage
->getLanguage();
217 $bytes = $lang->formatSize( $result->getByteSize() );
218 $words = $result->getWordCount();
220 return $this->specialPage
->msg( 'search-result-size', $bytes )
221 ->numParams( $words )
229 * @param SearchResult $result
230 * @return array Three element array containing the main file html,
231 * a text description of the file, and finally the thumbnail html.
232 * If no thumbnail is available the second and third will be null.
234 protected function generateFileHtml( SearchResult
$result ) {
235 $title = $result->getTitle();
236 if ( $title->getNamespace() !== NS_FILE
) {
237 return [ '', null, null ];
240 if ( $result->isFileMatch() ) {
241 $html = "<span class='searchalttitle'>" .
242 $this->specialPage
->msg( 'search-file-match' )->escaped() .
251 $img = $result->getFile() ?
: wfFindFile( $title );
253 $thumb = $img->transform( [ 'width' => 120, 'height' => 120 ] );
255 $descHtml = $this->specialPage
->msg( 'parentheses' )
256 ->rawParams( $img->getShortDesc() )
258 $thumbHtml = $thumb->toHtml( [ 'desc-link' => true ] );
262 return [ $html, $descHtml, $thumbHtml ];
266 * @param string $desc HTML description of result, ex: size in bytes, or empty string
267 * @param string $date HTML representation of last edit date, or empty string
268 * @return string HTML A div combining $desc and $date with a separator in a <div>.
269 * If either is missing only one will be represented. If both are missing an empty
270 * string will be returned.
272 protected function buildMeta( $desc, $date ) {
273 if ( $desc && $date ) {
274 $meta = "{$desc} - {$date}";
283 return "<div class='mw-search-result-data'>{$meta}</div>";