includes/widget/search/InterwikiSearchResultSetWidget.php

   1 <?php
   2
   3 namespace MediaWiki\Widget\Search;
   4
   5 use MediaWiki\Interwiki\InterwikiLookup;
   6 use MediaWiki\Linker\LinkRenderer;
   7 use SearchResultSet;
   8 use SpecialSearch;
   9 use Title;
  10 use Html;
  11 use OOUI;
  12
  13 /**
  14  * Renders one or more SearchResultSets into a sidebar grouped by
  15  * interwiki prefix. Includes a per-wiki header indicating where
  16  * the results are from.
  17  */
  18 class InterwikiSearchResultSetWidget implements SearchResultSetWidget {
  19         /** @var SpecialSearch */
  20         protected $specialSearch;
  21         /** @var SearchResultWidget */
  22         protected $resultWidget;
  23         /** @var string[]|null */
  24         protected $customCaptions;
  25         /** @var LinkRenderer */
  26         protected $linkRenderer;
  27         /** @var InterwikiLookup */
  28         protected $iwLookup;
  29         /** @var $output */
  30         protected $output;
  31         /** @var bool $showMultimedia */
  32         protected $showMultimedia;
  33
  34         public function __construct(
  35                 SpecialSearch $specialSearch,
  36                 SearchResultWidget $resultWidget,
  37                 LinkRenderer $linkRenderer,
  38                 InterwikiLookup $iwLookup,
  39                 $showMultimedia = false
  40         ) {
  41                 $this->specialSearch = $specialSearch;
  42                 $this->resultWidget = $resultWidget;
  43                 $this->linkRenderer = $linkRenderer;
  44                 $this->iwLookup = $iwLookup;
  45                 $this->output = $specialSearch->getOutput();
  46                 $this->showMultimedia = $showMultimedia;
  47         }
  48         /**
  49          * @param string $term User provided search term
  50          * @param SearchResultSet|SearchResultSet[] $resultSets List of interwiki
  51          *  results to render.
  52          * @return string HTML
  53          */
  54         public function render( $term, $resultSets ) {
  55                 if ( !is_array( $resultSets ) ) {
  56                         $resultSets = [ $resultSets ];
  57                 }
  58
  59                 $this->loadCustomCaptions();
  60
  61                 if ( $this->showMultimedia ) {
  62                         $this->output->addModules( 'mediawiki.special.search.commonsInterwikiWidget' );
  63                 }
  64                 $this->output->addModuleStyles( 'mediawiki.special.search.interwikiwidget.styles' );
  65
  66                 $iwResults = [];
  67                 foreach ( $resultSets as $resultSet ) {
  68                         foreach ( $resultSet as $result ) {
  69                                 if ( !$result->isBrokenTitle() ) {
  70                                         $iwResults[$result->getTitle()->getInterwiki()][] = $result;
  71                                 }
  72                         }
  73                 }
  74
  75                 $iwResultSetPos = 1;
  76                 $iwResultListOutput = '';
  77
  78                 foreach ( $iwResults as $iwPrefix => $results ) {
  79                         // TODO: Assumes interwiki results are never paginated
  80                         $position = 0;
  81                         $iwResultItemOutput = '';
  82
  83                         foreach ( $results as $result ) {
  84                                 $iwResultItemOutput .= $this->resultWidget->render( $result, $term, $position++ );
  85                         }
  86
  87                         $footerHtml = $this->footerHtml( $term, $iwPrefix );
  88                         $iwResultListOutput .= Html::rawElement( 'li',
  89                                 [
  90                                         'class' => 'iw-resultset',
  91                                         'data-iw-resultset-pos' => $iwResultSetPos,
  92                                         'data-iw-resultset-source' => $iwPrefix
  93                                 ],
  94
  95                                 $iwResultItemOutput .
  96                                 $footerHtml
  97                         );
  98
  99                         $iwResultSetPos++;
 100                 }
 101
 102                 return Html::rawElement(
 103                         'div',
 104                         [ 'id' => 'mw-interwiki-results' ],
 105                         Html::rawElement(
 106                                 'p',
 107                                 [ 'class' => 'iw-headline' ],
 108                                 $this->specialSearch->msg( 'search-interwiki-caption' )->parse()
 109                         ) .
 110                         Html::rawElement(
 111                                 'ul', [ 'class' => 'iw-results', ], $iwResultListOutput
 112                         )
 113                 );
 114         }
 115
 116         /**
 117          * Generates an HTML footer for the given interwiki prefix
 118          *
 119          * @param string $term User provided search term
 120          * @param string $iwPrefix Interwiki prefix of wiki to show footer for
 121          * @return string HTML
 122          */
 123         protected function footerHtml( $term, $iwPrefix ) {
 124                 $href = Title::makeTitle( NS_SPECIAL, 'Search', null, $iwPrefix )->getLocalURL(
 125                         [ 'search' => $term, 'fulltext' => 1 ]
 126                 );
 127
 128                 $interwiki = $this->iwLookup->fetch( $iwPrefix );
 129                 $parsed = wfParseUrl( wfExpandUrl( $interwiki ? $interwiki->getURL() : '/' ) );
 130
 131                 if ( isset( $this->customCaptions[$iwPrefix] ) ) {
 132                         $caption = $this->customCaptions[$iwPrefix];
 133                 } else {
 134                         $caption = $this->specialSearch->msg( 'search-interwiki-default', $parsed['host'] )->escaped();
 135                 }
 136
 137                 $searchLink = Html::rawElement( 'em', null,
 138                         Html::rawElement( 'a', [ 'href' => $href, 'target' => '_blank' ], $caption )
 139                 );
 140
 141                 return Html::rawElement( 'div',
 142                         [ 'class' => 'iw-result__footer' ],
 143                         $this->iwIcon( $iwPrefix ) . $searchLink );
 144         }
 145
 146         protected function loadCustomCaptions() {
 147                 if ( $this->customCaptions !== null ) {
 148                         return;
 149                 }
 150
 151                 $this->customCaptions = [];
 152                 $customLines = explode( "\n", $this->specialSearch->msg( 'search-interwiki-custom' )->escaped() );
 153                 foreach ( $customLines as $line ) {
 154                         $parts = explode( ':', $line, 2 );
 155                         if ( count( $parts ) === 2 ) {
 156                                 $this->customCaptions[$parts[0]] = $parts[1];
 157                         }
 158                 }
 159         }
 160
 161         /**
 162          * Generates a custom OOUI icon element with a favicon as the image.
 163          * The favicon image URL is generated by parsing the interwiki URL
 164          * and returning the default location of the favicon for that domain,
 165          * which is assumed to be '/favicon.ico'.
 166          *
 167          * @param string $iwPrefix Interwiki prefix
 168          * @return OOUI\IconWidget
 169          */
 170         protected function iwIcon( $iwPrefix ) {
 171                 $interwiki = $this->iwLookup->fetch( $iwPrefix );
 172                 $parsed = wfParseUrl( wfExpandUrl( $interwiki ? $interwiki->getURL() : '/' ) );
 173
 174                 $iwIconUrl = $parsed['scheme'] .
 175                         $parsed['delimiter'] .
 176                         $parsed['host'] .
 177                         ( isset( $parsed['port'] ) ? ':' . $parsed['port'] : '' ) .
 178                         '/favicon.ico';
 179
 180                 $iwIcon = new OOUI\IconWidget( [
 181                         'icon' => 'favicon'
 182                  ] );
 183
 184                  $iwIcon->setAttributes( [ 'style' => "background-image:url($iwIconUrl);" ] );
 185
 186                 return $iwIcon;
 187         }
 188 }