includes/widget/search/FullSearchResultWidget.php

   1 <?php
   2
   3 namespace MediaWiki\Widget\Search;
   4
   5 use Category;
   6 use Hooks;
   7 use HtmlArmor;
   8 use MediaWiki\Linker\LinkRenderer;
   9 use SearchResult;
  10 use SpecialSearch;
  11 use Title;
  12
  13 /**
  14  * Renders a 'full' multi-line search result with metadata.
  15  *
  16  *  The Title
  17  *  some *highlighted* *text* about the search result
  18  *  5KB (651 words) - 12:40, 6 Aug 2016
  19  */
  20 class FullSearchResultWidget implements SearchResultWidget {
  21         /** @var SpecialSearch */
  22         protected $specialPage;
  23         /** @var LinkRenderer */
  24         protected $linkRenderer;
  25
  26         public function __construct( SpecialSearch $specialPage, LinkRenderer $linkRenderer ) {
  27                 $this->specialPage = $specialPage;
  28                 $this->linkRenderer = $linkRenderer;
  29         }
  30
  31         /**
  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
  35          * @return string HTML
  36          */
  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() ) {
  42                         return '';
  43                 }
  44
  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>";
  52                 }
  53
  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()
  60                 );
  61                 list( $file, $desc, $thumb ) = $this->generateFileHtml( $result );
  62                 $snippet = $result->getTextSnippet( $terms );
  63                 if ( $snippet ) {
  64                         $extract = "<div class='searchresult'>$snippet</div>";
  65                 } else {
  66                         $extract = '';
  67                 }
  68
  69                 if ( $thumb === null ) {
  70                         // If no thumb, then the description is about size
  71                         $desc = $this->generateSizeHtml( $result );
  72
  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.
  76                         $html = null;
  77                         $score = '';
  78                         $related = '';
  79                         if ( !Hooks::run( 'ShowSearchHit', [
  80                                 $this->specialPage, $result, $terms,
  81                                 &$link, &$redirect, &$section, &$extract,
  82                                 &$score, &$size, &$date, &$related, &$html
  83                         ] ) ) {
  84                                 return $html;
  85                         }
  86                 }
  87
  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 );
  91
  92                 if ( $thumb === null ) {
  93                         $html =
  94                                 "<div class='mw-search-result-heading'>{$joined}</div>" .
  95                                 "{$extract} {$meta}";
  96                 } else {
  97                         $html =
  98                                 "<table class='searchResultImage'>" .
  99                                         "<tr>" .
 100                                                 "<td style='width: 120px; text-align: center; vertical-align: top'>" .
 101                                                         $thumb .
 102                                                 "</td>" .
 103                                                 "<td style='vertical-align: top'>" .
 104                                                         "{$joined} {$extract} {$meta}" .
 105                                                 "</td>" .
 106                                         "</tr>" .
 107                                 "</table>";
 108                 }
 109
 110                 return "<li>{$html}</li>";
 111         }
 112
 113         /**
 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).
 118          *
 119          * @param SearchResult $result
 120          * @param string $terms
 121          * @param int $position
 122          * @return string HTML
 123          */
 124         protected function generateMainLinkHtml( SearchResult $result, $terms, $position ) {
 125                 $snippet = $result->getTitleSnippet();
 126                 if ( $snippet === '' ) {
 127                         $snippet = null;
 128                 } else {
 129                         $snippet = new HtmlArmor( $snippet );
 130                 }
 131
 132                 // clone to prevent hook from changing the title stored inside $result
 133                 $title = clone $result->getTitle();
 134                 $query = [];
 135
 136                 Hooks::run( 'ShowSearchHitTitle',
 137                         [ &$title, &$snippet, $result, $terms, $this->specialPage, &$query ] );
 138
 139                 $link = $this->linkRenderer->makeLink(
 140                         $title,
 141                         $snippet,
 142                         [ 'data-serp-pos' => $position ],
 143                         $query
 144                 );
 145
 146                 return $link;
 147         }
 148
 149         /**
 150          * Generates an alternate title link, such as (redirect from <a>Foo</a>).
 151          *
 152          * @param string $msgKey i18n message  used to wrap title
 153          * @param Title|null $title The title to link to, or null to generate
 154          *  the message without a link. In that case $text must be non-null.
 155          * @param string|null $text The text snippet to display, or null
 156          *  to use the title
 157          * @return string HTML
 158          */
 159         protected function generateAltTitleHtml( $msgKey, Title $title = null, $text ) {
 160                 $inner = $title === null
 161                         ? $text
 162                         : $this->linkRenderer->makeLink( $title, $text ? new HtmlArmor( $text ) : null );
 163
 164                 return "<span class='searchalttitle'>" .
 165                                 $this->specialPage->msg( $msgKey )->rawParams( $inner )->text()
 166                         . "</span>";
 167         }
 168
 169         /**
 170          * @param SearchResult $result
 171          * @return string HTML
 172          */
 173         protected function generateRedirectHtml( SearchResult $result ) {
 174                 $title = $result->getRedirectTitle();
 175                 return $title === null
 176                         ? ''
 177                         : $this->generateAltTitleHtml( 'search-redirect', $title, $result->getRedirectSnippet() );
 178         }
 179
 180         /**
 181          * @param SearchResult $result
 182          * @return string HTML
 183          */
 184         protected function generateSectionHtml( SearchResult $result ) {
 185                 $title = $result->getSectionTitle();
 186                 return $title === null
 187                         ? ''
 188                         : $this->generateAltTitleHtml( 'search-section', $title, $result->getSectionSnippet() );
 189         }
 190
 191         /**
 192          * @param SearchResult $result
 193          * @return string HTML
 194          */
 195         protected function generateCategoryHtml( SearchResult $result ) {
 196                 $snippet = $result->getCategorySnippet();
 197                 return $snippet
 198                         ? $this->generateAltTitleHtml( 'search-category', null, $snippet )
 199                         : '';
 200         }
 201
 202         /**
 203          * @param SearchResult $result
 204          * @return string HTML
 205          */
 206         protected function generateSizeHtml( SearchResult $result ) {
 207                 $title = $result->getTitle();
 208                 if ( $title->getNamespace() === NS_CATEGORY ) {
 209                         $cat = Category::newFromTitle( $title );
 210                         return $this->specialPage->msg( 'search-result-category-size' )
 211                                 ->numParams( $cat->getPageCount(), $cat->getSubcatCount(), $cat->getFileCount() )
 212                                 ->escaped();
 213                 // TODO: This is a bit odd...but requires changing the i18n message to fix
 214                 } elseif ( $result->getByteSize() !== null || $result->getWordCount() > 0 ) {
 215                         $lang = $this->specialPage->getLanguage();
 216                         $bytes = $lang->formatSize( $result->getByteSize() );
 217                         $words = $result->getWordCount();
 218
 219                         return $this->specialPage->msg( 'search-result-size', $bytes )
 220                                 ->numParams( $words )
 221                                 ->escaped();
 222                 }
 223
 224                 return '';
 225         }
 226
 227         /**
 228          * @param SearchResult $result
 229          * @return array Three element array containing the main file html,
 230          *  a text description of the file, and finally the thumbnail html.
 231          *  If no thumbnail is available the second and third will be null.
 232          */
 233         protected function generateFileHtml( SearchResult $result ) {
 234                 $title = $result->getTitle();
 235                 if ( $title->getNamespace() !== NS_FILE ) {
 236                         return [ '', null, null ];
 237                 }
 238
 239                 if ( $result->isFileMatch() ) {
 240                         $html = "<span class='searchalttitle'>" .
 241                                         $this->specialPage->msg( 'search-file-match' )->escaped() .
 242                                 "</span>";
 243                 } else {
 244                         $html = '';
 245                 }
 246
 247                 $descHtml = null;
 248                 $thumbHtml = null;
 249
 250                 $img = $result->getFile() ?: wfFindFile( $title );
 251                 if ( $img ) {
 252                         $thumb = $img->transform( [ 'width' => 120, 'height' => 120 ] );
 253                         if ( $thumb ) {
 254                                 $descHtml = $this->specialPage->msg( 'parentheses' )
 255                                         ->rawParams( $img->getShortDesc() )
 256                                         ->escaped();
 257                                 $thumbHtml = $thumb->toHtml( [ 'desc-link' => true ] );
 258                         }
 259                 }
 260
 261                 return [ $html, $descHtml, $thumbHtml ];
 262         }
 263
 264         /**
 265          * @param string $desc HTML description of result, ex: size in bytes, or empty string
 266          * @param string $date HTML representation of last edit date, or empty string
 267          * @return string HTML A div combining $desc and $date with a separator in a <div>.
 268          *  If either is missing only one will be represented. If both are missing an empty
 269          *  string will be returned.
 270          */
 271         protected function buildMeta( $desc, $date ) {
 272                 if ( $desc && $date ) {
 273                         $meta = "{$desc} - {$date}";
 274                 } elseif ( $desc ) {
 275                         $meta = $desc;
 276                 } elseif ( $date ) {
 277                         $meta = $date;
 278                 } else {
 279                         return '';
 280                 }
 281
 282                 return "<div class='mw-search-result-data'>{$meta}</div>";
 283         }
 284 }