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