forked from wikimedia/mediawiki-extensions-GlobalUsage
-
Notifications
You must be signed in to change notification settings - Fork 0
/
SpecialGlobalUsage.php
235 lines (200 loc) · 6.81 KB
/
SpecialGlobalUsage.php
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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
<?php
/**
* Special page to show global file usage. Also contains hook functions for
* showing usage on an image page.
*/
class SpecialGlobalUsage extends SpecialPage {
/**
* @var Title
*/
protected $target;
/**
* @var bool
*/
protected $filterLocal;
public function __construct() {
parent::__construct( 'GlobalUsage' );
}
/**
* Entry point
* @param $par String
*/
public function execute( $par ) {
$target = $par ? $par : $this->getRequest()->getVal( 'target' );
$this->target = Title::makeTitleSafe( NS_FILE, $target );
$this->filterLocal = $this->getRequest()->getCheck( 'filterlocal' );
$this->setHeaders();
$this->getOutput()->addWikiMsg( 'globalusage-header' );
$this->showForm();
if ( is_null( $this->target ) ) {
$this->getOutput()->setPageTitle( $this->msg( 'globalusage' ) );
return;
}
$this->getOutput()->setPageTitle( $this->msg( 'globalusage-for', $this->target->getPrefixedText() ) );
$this->showResult();
}
/**
* Shows the search form
*/
private function showForm() {
global $wgScript;
/* Build form */
$html = Xml::openElement( 'form', array( 'action' => $wgScript ) ) . "\n";
// Name of SpecialPage
$html .= Html::hidden( 'title', $this->getPageTitle()->getPrefixedText() ) . "\n";
// Limit
$html .= Html::hidden( 'limit', $this->getRequest()->getInt( 'limit', 50 ) );
// Input box with target prefilled if available
$formContent = "\t" . Xml::input( 'target', 40, is_null( $this->target ) ? ''
: $this->target->getText() )
// Submit button
. "\n\t" . Xml::element( 'input', array(
'type' => 'submit',
'value' => $this->msg( 'globalusage-ok' )->text()
) )
// Filter local checkbox
. "\n\t<p>" . Xml::checkLabel( $this->msg( 'globalusage-filterlocal' )->text(),
'filterlocal', 'mw-filterlocal', $this->filterLocal ) . '</p>';
if ( !is_null( $this->target ) && wfFindFile( $this->target ) ) {
// Show the image if it exists
$html .= Linker::makeThumbLinkObj(
$this->target,
wfFindFile( $this->target ),
/* $label */ $this->target->getPrefixedText(),
/* $alt */ '', /* $align */ $this->getLanguage()->alignEnd(),
/* $handlerParams */ array(), /* $framed */ false,
/* $manualThumb */ false
);
}
// Wrap the entire form in a nice fieldset
$html .= Xml::fieldSet( $this->msg( 'globalusage-text' )->text(), $formContent ) . "\n</form>";
$this->getOutput()->addHtml( $html );
}
/**
* Creates as queryer and executes it based on $this->getRequest()
*/
private function showResult() {
$query = new GlobalUsageQuery( $this->target );
$request = $this->getRequest();
foreach(Interwiki::getAllPrefixes(1) as $k) { $interWikis[$k[iw_wikiid]] = $k[iw_prefix];};
// Extract params from $request.
if ( $request->getText( 'from' ) ) {
$query->setOffset( $request->getText( 'from' ) );
} elseif ( $request->getText( 'to' ) ) {
$query->setOffset( $request->getText( 'to' ), true );
}
$query->setLimit( $request->getInt( 'limit', 50 ) );
$query->filterLocal( $this->filterLocal );
// Perform query
$query->execute();
// Don't show form element if there is no data
if ( $query->count() == 0 ) {
$this->getOutput()->addWikiMsg( 'globalusage-no-results', $this->target->getPrefixedText() );
return;
}
$navbar = $this->getNavBar( $query );
$targetName = $this->target->getText();
$out = $this->getOutput();
// Top navbar
$out->addHtml( $navbar );
$out->addHtml( '<div id="mw-globalusage-result">' );
foreach ( $query->getSingleImageResult() as $wiki => $result ) {
$interwiki = Interwiki::fetch($interWikis[$wiki]);
$out->addHtml(
'<h2>' . $this->msg(
'globalusage-on-wiki',
$targetName, parse_url($interwiki->getURL(), PHP_URL_HOST) )->parse()
. "</h2><ul>\n" );
foreach ( $result as $item ) {
$out->addHtml( "\t<li>" . self::formatItem( $item, $interwiki ) . "</li>\n" );
}
$out->addHtml( "</ul>\n" );
}
$out->addHtml( '</div>' );
// Bottom navbar
$out->addHtml( $navbar );
}
/**
* Helper to format a specific item
* @param $item array
* @return String
*/
public static function formatItem( $item, $interwiki ) {
if ( !$item['namespace'] ) {
$page = $item['title'];
} else {
$page = "{$item['namespace']}:{$item['title']}";
}
$link = Linker::makeExternalLink( $interwiki->getURL($page) , str_replace( '_', ' ', $page ));
// Return only the title if no link can be constructed
return $link === false ? $page : $link;
}
/**
* Helper function to create the navbar, stolen from wfViewPrevNext
*
* @param $query GlobalUsageQuery An executed GlobalUsageQuery object
* @return string Navbar HTML
*/
protected function getNavBar( $query ) {
$target = $this->target->getText();
$limit = $query->getLimit();
# Find out which strings are for the prev and which for the next links
$offset = $query->getOffsetString();
$continue = $query->getContinueString();
if ( $query->isReversed() ) {
$from = $offset;
$to = $continue;
} else {
$from = $continue;
$to = $offset;
}
# Get prev/next link display text
$prev = $this->msg( 'prevn' )->numParams( $limit )->escaped();
$next = $this->msg( 'nextn' )->numParams( $limit )->escaped();
# Get prev/next link title text
$pTitle = $this->msg( 'prevn-title' )->numParams( $limit )->escaped();
$nTitle = $this->msg( 'nextn-title' )->numParams( $limit )->escaped();
# Fetch the title object
$title = $this->getPageTitle();
# Make 'previous' link
if ( $to ) {
$attr = array( 'title' => $pTitle, 'class' => 'mw-prevlink' );
$q = array( 'limit' => $limit, 'to' => $to, 'target' => $target );
if ( $this->filterLocal ) {
$q['filterlocal'] = '1';
}
$plink = Linker::link( $title, $prev, $attr, $q );
} else {
$plink = $prev;
}
# Make 'next' link
if ( $from ) {
$attr = array( 'title' => $nTitle, 'class' => 'mw-nextlink' );
$q = array( 'limit' => $limit, 'from' => $from, 'target' => $target );
if ( $this->filterLocal ) {
$q['filterlocal'] = '1';
}
$nlink = Linker::link( $title, $next, $attr, $q );
} else {
$nlink = $next;
}
# Make links to set number of items per page
$numLinks = array();
$lang = $this->getLanguage();
foreach ( array( 20, 50, 100, 250, 500 ) as $num ) {
$fmtLimit = $lang->formatNum( $num );
$q = array( 'offset' => $offset, 'limit' => $num, 'target' => $target );
if ( $this->filterLocal ) {
$q['filterlocal'] = '1';
}
$lTitle = $this->msg( 'shown-title' )->numParams( $num )->escaped();
$attr = array( 'title' => $lTitle, 'class' => 'mw-numlink' );
$numLinks[] = Linker::link( $title, $fmtLimit, $attr, $q );
}
$nums = $lang->pipeList( $numLinks );
return $this->msg( 'viewprevnext' )->rawParams( $plink, $nlink, $nums )->escaped();
}
protected function getGroupName() {
return 'media';
}
}