3 * Implements Special:Whatlinkshere
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @todo Use some variant of Pager or something; the pagination here is lousy.
24 use Wikimedia\Rdbms\IDatabase
;
27 * Implements Special:Whatlinkshere
29 * @ingroup SpecialPage
31 class SpecialWhatLinksHere
extends IncludableSpecialPage
{
32 /** @var FormOptions */
40 protected $limits = [ 20, 50, 100, 250, 500 ];
42 public function __construct() {
43 parent
::__construct( 'Whatlinkshere' );
46 function execute( $par ) {
47 $out = $this->getOutput();
50 $this->outputHeader();
51 $this->addHelpLink( 'Help:What links here' );
53 $opts = new FormOptions();
55 $opts->add( 'target', '' );
56 $opts->add( 'namespace', '', FormOptions
::INTNULL
);
57 $opts->add( 'limit', $this->getConfig()->get( 'QueryPageDefaultLimit' ) );
58 $opts->add( 'from', 0 );
59 $opts->add( 'back', 0 );
60 $opts->add( 'hideredirs', false );
61 $opts->add( 'hidetrans', false );
62 $opts->add( 'hidelinks', false );
63 $opts->add( 'hideimages', false );
64 $opts->add( 'invert', false );
66 $opts->fetchValuesFromRequest( $this->getRequest() );
67 $opts->validateIntBounds( 'limit', 0, 5000 );
69 // Give precedence to subpage syntax
70 if ( $par !== null ) {
71 $opts->setValue( 'target', $par );
74 // Bind to member variable
77 $this->target
= Title
::newFromText( $opts->getValue( 'target' ) );
78 if ( !$this->target
) {
79 if ( !$this->including() ) {
80 $out->addHTML( $this->whatlinkshereForm() );
86 $this->getSkin()->setRelevantTitle( $this->target
);
88 $this->selfTitle
= $this->getPageTitle( $this->target
->getPrefixedDBkey() );
90 $out->setPageTitle( $this->msg( 'whatlinkshere-title', $this->target
->getPrefixedText() ) );
91 $out->addBacklinkSubtitle( $this->target
);
92 $this->showIndirectLinks(
95 $opts->getValue( 'limit' ),
96 $opts->getValue( 'from' ),
97 $opts->getValue( 'back' )
102 * @param int $level Recursion level
103 * @param Title $target Target title
104 * @param int $limit Number of entries to display
105 * @param int $from Display from this article ID (default: 0)
106 * @param int $back Display from this article ID at backwards scrolling (default: 0)
108 function showIndirectLinks( $level, $target, $limit, $from = 0, $back = 0 ) {
109 $out = $this->getOutput();
110 $dbr = wfGetDB( DB_REPLICA
);
112 $hidelinks = $this->opts
->getValue( 'hidelinks' );
113 $hideredirs = $this->opts
->getValue( 'hideredirs' );
114 $hidetrans = $this->opts
->getValue( 'hidetrans' );
115 $hideimages = $target->getNamespace() != NS_FILE ||
$this->opts
->getValue( 'hideimages' );
117 $fetchlinks = ( !$hidelinks ||
!$hideredirs );
119 // Build query conds in concert for all three tables...
121 $conds['pagelinks'] = [
122 'pl_namespace' => $target->getNamespace(),
123 'pl_title' => $target->getDBkey(),
125 $conds['templatelinks'] = [
126 'tl_namespace' => $target->getNamespace(),
127 'tl_title' => $target->getDBkey(),
129 $conds['imagelinks'] = [
130 'il_to' => $target->getDBkey(),
133 $namespace = $this->opts
->getValue( 'namespace' );
134 $invert = $this->opts
->getValue( 'invert' );
135 $nsComparison = ( $invert ?
'!= ' : '= ' ) . $dbr->addQuotes( $namespace );
136 if ( is_int( $namespace ) ) {
137 $conds['pagelinks'][] = "pl_from_namespace $nsComparison";
138 $conds['templatelinks'][] = "tl_from_namespace $nsComparison";
139 $conds['imagelinks'][] = "il_from_namespace $nsComparison";
143 $conds['templatelinks'][] = "tl_from >= $from";
144 $conds['pagelinks'][] = "pl_from >= $from";
145 $conds['imagelinks'][] = "il_from >= $from";
149 $conds['pagelinks']['rd_from'] = null;
150 } elseif ( $hidelinks ) {
151 $conds['pagelinks'][] = 'rd_from is NOT NULL';
154 $queryFunc = function ( IDatabase
$dbr, $table, $fromCol ) use (
155 $conds, $target, $limit
157 // Read an extra row as an at-end check
158 $queryLimit = $limit +
1;
160 "rd_from = $fromCol",
161 'rd_title' => $target->getDBkey(),
162 'rd_interwiki = ' . $dbr->addQuotes( '' ) . ' OR rd_interwiki IS NULL'
164 $on['rd_namespace'] = $target->getNamespace();
165 // Inner LIMIT is 2X in case of stale backlinks with wrong namespaces
166 $subQuery = $dbr->buildSelectSubquery(
167 [ $table, 'redirect', 'page' ],
168 [ $fromCol, 'rd_from' ],
170 __CLASS__
. '::showIndirectLinks',
171 // Force JOIN order per T106682 to avoid large filesorts
172 [ 'ORDER BY' => $fromCol, 'LIMIT' => 2 * $queryLimit, 'STRAIGHT_JOIN' ],
174 'page' => [ 'JOIN', "$fromCol = page_id" ],
175 'redirect' => [ 'LEFT JOIN', $on ]
179 [ 'page', 'temp_backlink_range' => $subQuery ],
180 [ 'page_id', 'page_namespace', 'page_title', 'rd_from', 'page_is_redirect' ],
182 __CLASS__
. '::showIndirectLinks',
183 [ 'ORDER BY' => 'page_id', 'LIMIT' => $queryLimit ],
184 [ 'page' => [ 'JOIN', "$fromCol = page_id" ] ]
189 $plRes = $queryFunc( $dbr, 'pagelinks', 'pl_from' );
193 $tlRes = $queryFunc( $dbr, 'templatelinks', 'tl_from' );
196 if ( !$hideimages ) {
197 $ilRes = $queryFunc( $dbr, 'imagelinks', 'il_from' );
200 if ( ( !$fetchlinks ||
!$plRes->numRows() )
201 && ( $hidetrans ||
!$tlRes->numRows() )
202 && ( $hideimages ||
!$ilRes->numRows() )
204 if ( $level == 0 && !$this->including() ) {
205 $out->addHTML( $this->whatlinkshereForm() );
207 // Show filters only if there are links
208 if ( $hidelinks ||
$hidetrans ||
$hideredirs ||
$hideimages ) {
209 $out->addHTML( $this->getFilterPanel() );
211 $msgKey = is_int( $namespace ) ?
'nolinkshere-ns' : 'nolinkshere';
212 $link = $this->getLinkRenderer()->makeLink(
216 $this->target
->isRedirect() ?
[ 'redirect' => 'no' ] : []
219 $errMsg = $this->msg( $msgKey )
220 ->params( $this->target
->getPrefixedText() )
223 $out->addHTML( $errMsg );
224 $out->setStatusCode( 404 );
230 // Read the rows into an array and remove duplicates
231 // templatelinks comes second so that the templatelinks row overwrites the
232 // pagelinks row, so we get (inclusion) rather than nothing
235 foreach ( $plRes as $row ) {
236 $row->is_template
= 0;
238 $rows[$row->page_id
] = $row;
242 foreach ( $tlRes as $row ) {
243 $row->is_template
= 1;
245 $rows[$row->page_id
] = $row;
248 if ( !$hideimages ) {
249 foreach ( $ilRes as $row ) {
250 $row->is_template
= 0;
252 $rows[$row->page_id
] = $row;
256 // Sort by key and then change the keys to 0-based indices
258 $rows = array_values( $rows );
260 $numRows = count( $rows );
262 // Work out the start and end IDs, for prev/next links
263 if ( $numRows > $limit ) {
264 // More rows available after these ones
265 // Get the ID from the last row in the result set
266 $nextId = $rows[$limit]->page_id
;
267 // Remove undisplayed rows
268 $rows = array_slice( $rows, 0, $limit );
270 // No more rows after
275 // use LinkBatch to make sure, that all required data (associated with Titles)
276 // is loaded in one query
277 $lb = new LinkBatch();
278 foreach ( $rows as $row ) {
279 $lb->add( $row->page_namespace
, $row->page_title
);
283 if ( $level == 0 && !$this->including() ) {
284 $out->addHTML( $this->whatlinkshereForm() );
285 $out->addHTML( $this->getFilterPanel() );
287 $link = $this->getLinkRenderer()->makeLink(
291 $this->target
->isRedirect() ?
[ 'redirect' => 'no' ] : []
294 $msg = $this->msg( 'linkshere' )
295 ->params( $this->target
->getPrefixedText() )
298 $out->addHTML( $msg );
300 $prevnext = $this->getPrevNext( $prevId, $nextId );
301 $out->addHTML( $prevnext );
303 $out->addHTML( $this->listStart( $level ) );
304 foreach ( $rows as $row ) {
305 $nt = Title
::makeTitle( $row->page_namespace
, $row->page_title
);
307 if ( $row->rd_from
&& $level < 2 ) {
308 $out->addHTML( $this->listItem( $row, $nt, $target, true ) );
309 $this->showIndirectLinks(
312 $this->getConfig()->get( 'MaxRedirectLinksRetrieved' )
314 $out->addHTML( Xml
::closeElement( 'li' ) );
316 $out->addHTML( $this->listItem( $row, $nt, $target ) );
320 $out->addHTML( $this->listEnd() );
322 if ( $level == 0 && !$this->including() ) {
323 $out->addHTML( $prevnext );
327 protected function listStart( $level ) {
328 return Xml
::openElement( 'ul', ( $level ?
[] : [ 'id' => 'mw-whatlinkshere-list' ] ) );
331 protected function listItem( $row, $nt, $target, $notClose = false ) {
332 $dirmark = $this->getLanguage()->getDirMark();
334 # local message cache
335 static $msgcache = null;
336 if ( $msgcache === null ) {
337 static $msgs = [ 'isredirect', 'istemplate', 'semicolon-separator',
338 'whatlinkshere-links', 'isimage', 'editlink' ];
340 foreach ( $msgs as $msg ) {
341 $msgcache[$msg] = $this->msg( $msg )->escaped();
345 if ( $row->rd_from
) {
346 $query = [ 'redirect' => 'no' ];
351 $link = $this->getLinkRenderer()->makeKnownLink(
354 $row->page_is_redirect ?
[ 'class' => 'mw-redirect' ] : [],
358 // Display properties (redirect or template)
361 if ( $row->rd_from
) {
362 $props[] = $msgcache['isredirect'];
364 if ( $row->is_template
) {
365 $props[] = $msgcache['istemplate'];
367 if ( $row->is_image
) {
368 $props[] = $msgcache['isimage'];
371 Hooks
::run( 'WhatLinksHereProps', [ $row, $nt, $target, &$props ] );
373 if ( count( $props ) ) {
374 $propsText = $this->msg( 'parentheses' )
375 ->rawParams( implode( $msgcache['semicolon-separator'], $props ) )->escaped();
378 # Space for utilities links, with a what-links-here link provided
379 $wlhLink = $this->wlhLink( $nt, $msgcache['whatlinkshere-links'], $msgcache['editlink'] );
380 $wlh = Xml
::wrapClass(
381 $this->msg( 'parentheses' )->rawParams( $wlhLink )->escaped(),
382 'mw-whatlinkshere-tools'
386 Xml
::openElement( 'li' ) . "$link $propsText $dirmark $wlh\n" :
387 Xml
::tags( 'li', null, "$link $propsText $dirmark $wlh" ) . "\n";
390 protected function listEnd() {
391 return Xml
::closeElement( 'ul' );
394 protected function wlhLink( Title
$target, $text, $editText ) {
395 static $title = null;
396 if ( $title === null ) {
397 $title = $this->getPageTitle();
400 $linkRenderer = $this->getLinkRenderer();
402 if ( $text !== null ) {
403 $text = new HtmlArmor( $text );
406 // always show a "<- Links" link
408 'links' => $linkRenderer->makeKnownLink(
412 [ 'target' => $target->getPrefixedText() ]
416 // if the page is editable, add an edit link
418 // check user permissions
419 $this->getUser()->isAllowed( 'edit' ) &&
420 // check, if the content model is editable through action=edit
421 ContentHandler
::getForTitle( $target )->supportsDirectEditing()
423 if ( $editText !== null ) {
424 $editText = new HtmlArmor( $editText );
427 $links['edit'] = $linkRenderer->makeKnownLink(
431 [ 'action' => 'edit' ]
435 // build the links html
436 return $this->getLanguage()->pipeList( $links );
439 function makeSelfLink( $text, $query ) {
440 if ( $text !== null ) {
441 $text = new HtmlArmor( $text );
444 return $this->getLinkRenderer()->makeKnownLink(
452 function getPrevNext( $prevId, $nextId ) {
453 $currentLimit = $this->opts
->getValue( 'limit' );
454 $prev = $this->msg( 'whatlinkshere-prev' )->numParams( $currentLimit )->escaped();
455 $next = $this->msg( 'whatlinkshere-next' )->numParams( $currentLimit )->escaped();
457 $changed = $this->opts
->getChangedValues();
458 unset( $changed['target'] ); // Already in the request title
460 if ( $prevId != 0 ) {
461 $overrides = [ 'from' => $this->opts
->getValue( 'back' ) ];
462 $prev = $this->makeSelfLink( $prev, array_merge( $changed, $overrides ) );
464 if ( $nextId != 0 ) {
465 $overrides = [ 'from' => $nextId, 'back' => $prevId ];
466 $next = $this->makeSelfLink( $next, array_merge( $changed, $overrides ) );
470 $lang = $this->getLanguage();
471 foreach ( $this->limits
as $limit ) {
472 $prettyLimit = htmlspecialchars( $lang->formatNum( $limit ) );
473 $overrides = [ 'limit' => $limit ];
474 $limitLinks[] = $this->makeSelfLink( $prettyLimit, array_merge( $changed, $overrides ) );
477 $nums = $lang->pipeList( $limitLinks );
479 return $this->msg( 'viewprevnext' )->rawParams( $prev, $next, $nums )->escaped();
482 function whatlinkshereForm() {
483 // We get nicer value from the title object
484 $this->opts
->consumeValue( 'target' );
485 // Reset these for new requests
486 $this->opts
->consumeValues( [ 'back', 'from' ] );
488 $target = $this->target ?
$this->target
->getPrefixedText() : '';
489 $namespace = $this->opts
->consumeValue( 'namespace' );
490 $nsinvert = $this->opts
->consumeValue( 'invert' );
493 $f = Xml
::openElement( 'form', [ 'action' => wfScript() ] );
495 # Values that should not be forgotten
496 $f .= Html
::hidden( 'title', $this->getPageTitle()->getPrefixedText() );
497 foreach ( $this->opts
->getUnconsumedValues() as $name => $value ) {
498 $f .= Html
::hidden( $name, $value );
501 $f .= Xml
::fieldset( $this->msg( 'whatlinkshere' )->text() );
503 # Target input (.mw-searchInput enables suggestions)
504 $f .= Xml
::inputLabel( $this->msg( 'whatlinkshere-page' )->text(), 'target',
505 'mw-whatlinkshere-target', 40, $target, [ 'class' => 'mw-searchInput' ] );
510 $f .= Html
::namespaceSelector(
512 'selected' => $namespace,
514 'label' => $this->msg( 'namespace' )->text(),
515 'in-user-lang' => true,
517 'name' => 'namespace',
519 'class' => 'namespaceselector',
525 $this->msg( 'invert' )->text(),
529 [ 'title' => $this->msg( 'tooltip-whatlinkshere-invert' )->text() ]
535 $f .= Xml
::submitButton( $this->msg( 'whatlinkshere-submit' )->text() );
538 $f .= Xml
::closeElement( 'fieldset' ) . Xml
::closeElement( 'form' ) . "\n";
544 * Create filter panel
546 * @return string HTML fieldset and filter panel with the show/hide links
548 function getFilterPanel() {
549 $show = $this->msg( 'show' )->escaped();
550 $hide = $this->msg( 'hide' )->escaped();
552 $changed = $this->opts
->getChangedValues();
553 unset( $changed['target'] ); // Already in the request title
556 $types = [ 'hidetrans', 'hidelinks', 'hideredirs' ];
557 if ( $this->target
->getNamespace() == NS_FILE
) {
558 $types[] = 'hideimages';
561 // Combined message keys: 'whatlinkshere-hideredirs', 'whatlinkshere-hidetrans',
562 // 'whatlinkshere-hidelinks', 'whatlinkshere-hideimages'
563 // To be sure they will be found by grep
564 foreach ( $types as $type ) {
565 $chosen = $this->opts
->getValue( $type );
566 $msg = $chosen ?
$show : $hide;
567 $overrides = [ $type => !$chosen ];
568 $links[] = $this->msg( "whatlinkshere-{$type}" )->rawParams(
569 $this->makeSelfLink( $msg, array_merge( $changed, $overrides ) ) )->escaped();
572 return Xml
::fieldset(
573 $this->msg( 'whatlinkshere-filters' )->text(),
574 $this->getLanguage()->pipeList( $links )
579 * Return an array of subpages beginning with $search that this special page will accept.
581 * @param string $search Prefix to search for
582 * @param int $limit Maximum number of results to return (usually 10)
583 * @param int $offset Number of results to skip (usually 0)
584 * @return string[] Matching subpages
586 public function prefixSearchSubpages( $search, $limit, $offset ) {
587 return $this->prefixSearchString( $search, $limit, $offset );
590 protected function getGroupName() {