includes/specials/SpecialWhatlinkshere.php

   1 <?php
   2 /**
   3  * Implements Special:Whatlinkshere
   4  *
   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.
   9  *
  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.
  14  *
  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
  19  *
  20  * @file
  21  * @todo Use some variant of Pager or something; the pagination here is lousy.
  22  */
  23
  24 use Wikimedia\Rdbms\IDatabase;
  25
  26 /**
  27  * Implements Special:Whatlinkshere
  28  *
  29  * @ingroup SpecialPage
  30  */
  31 class SpecialWhatLinksHere extends IncludableSpecialPage {
  32         /** @var FormOptions */
  33         protected $opts;
  34
  35         protected $selfTitle;
  36
  37         /** @var Title */
  38         protected $target;
  39
  40         protected $limits = [ 20, 50, 100, 250, 500 ];
  41
  42         public function __construct() {
  43                 parent::__construct( 'Whatlinkshere' );
  44         }
  45
  46         function execute( $par ) {
  47                 $out = $this->getOutput();
  48
  49                 $this->setHeaders();
  50                 $this->outputHeader();
  51                 $this->addHelpLink( 'Help:What links here' );
  52
  53                 $opts = new FormOptions();
  54
  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 );
  65
  66                 $opts->fetchValuesFromRequest( $this->getRequest() );
  67                 $opts->validateIntBounds( 'limit', 0, 5000 );
  68
  69                 // Give precedence to subpage syntax
  70                 if ( $par !== null ) {
  71                         $opts->setValue( 'target', $par );
  72                 }
  73
  74                 // Bind to member variable
  75                 $this->opts = $opts;
  76
  77                 $this->target = Title::newFromText( $opts->getValue( 'target' ) );
  78                 if ( !$this->target ) {
  79                         if ( !$this->including() ) {
  80                                 $out->addHTML( $this->whatlinkshereForm() );
  81                         }
  82
  83                         return;
  84                 }
  85
  86                 $this->getSkin()->setRelevantTitle( $this->target );
  87
  88                 $this->selfTitle = $this->getPageTitle( $this->target->getPrefixedDBkey() );
  89
  90                 $out->setPageTitle( $this->msg( 'whatlinkshere-title', $this->target->getPrefixedText() ) );
  91                 $out->addBacklinkSubtitle( $this->target );
  92                 $this->showIndirectLinks(
  93                         0,
  94                         $this->target,
  95                         $opts->getValue( 'limit' ),
  96                         $opts->getValue( 'from' ),
  97                         $opts->getValue( 'back' )
  98                 );
  99         }
 100
 101         /**
 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)
 107          */
 108         function showIndirectLinks( $level, $target, $limit, $from = 0, $back = 0 ) {
 109                 $out = $this->getOutput();
 110                 $dbr = wfGetDB( DB_REPLICA );
 111
 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' );
 116
 117                 $fetchlinks = ( !$hidelinks || !$hideredirs );
 118
 119                 // Build query conds in concert for all three tables...
 120                 $conds['pagelinks'] = [
 121                         'pl_namespace' => $target->getNamespace(),
 122                         'pl_title' => $target->getDBkey(),
 123                 ];
 124                 $conds['templatelinks'] = [
 125                         'tl_namespace' => $target->getNamespace(),
 126                         'tl_title' => $target->getDBkey(),
 127                 ];
 128                 $conds['imagelinks'] = [
 129                         'il_to' => $target->getDBkey(),
 130                 ];
 131
 132                 $namespace = $this->opts->getValue( 'namespace' );
 133                 $invert = $this->opts->getValue( 'invert' );
 134                 $nsComparison = ( $invert ? '!= ' : '= ' ) . $dbr->addQuotes( $namespace );
 135                 if ( is_int( $namespace ) ) {
 136                         $conds['pagelinks'][] = "pl_from_namespace $nsComparison";
 137                         $conds['templatelinks'][] = "tl_from_namespace $nsComparison";
 138                         $conds['imagelinks'][] = "il_from_namespace $nsComparison";
 139                 }
 140
 141                 if ( $from ) {
 142                         $conds['templatelinks'][] = "tl_from >= $from";
 143                         $conds['pagelinks'][] = "pl_from >= $from";
 144                         $conds['imagelinks'][] = "il_from >= $from";
 145                 }
 146
 147                 if ( $hideredirs ) {
 148                         $conds['pagelinks']['rd_from'] = null;
 149                 } elseif ( $hidelinks ) {
 150                         $conds['pagelinks'][] = 'rd_from is NOT NULL';
 151                 }
 152
 153                 $queryFunc = function ( IDatabase $dbr, $table, $fromCol ) use (
 154                         $conds, $target, $limit
 155                 ) {
 156                         // Read an extra row as an at-end check
 157                         $queryLimit = $limit + 1;
 158                         $on = [
 159                                 "rd_from = $fromCol",
 160                                 'rd_title' => $target->getDBkey(),
 161                                 'rd_interwiki = ' . $dbr->addQuotes( '' ) . ' OR rd_interwiki IS NULL'
 162                         ];
 163                         $on['rd_namespace'] = $target->getNamespace();
 164                         // Inner LIMIT is 2X in case of stale backlinks with wrong namespaces
 165                         $subQuery = $dbr->buildSelectSubquery(
 166                                 [ $table, 'redirect', 'page' ],
 167                                 [ $fromCol, 'rd_from' ],
 168                                 $conds[$table],
 169                                 __CLASS__ . '::showIndirectLinks',
 170                                 // Force JOIN order per T106682 to avoid large filesorts
 171                                 [ 'ORDER BY' => $fromCol, 'LIMIT' => 2 * $queryLimit, 'STRAIGHT_JOIN' ],
 172                                 [
 173                                         'page' => [ 'INNER JOIN', "$fromCol = page_id" ],
 174                                         'redirect' => [ 'LEFT JOIN', $on ]
 175                                 ]
 176                         );
 177                         return $dbr->select(
 178                                 [ 'page', 'temp_backlink_range' => $subQuery ],
 179                                 [ 'page_id', 'page_namespace', 'page_title', 'rd_from', 'page_is_redirect' ],
 180                                 [],
 181                                 __CLASS__ . '::showIndirectLinks',
 182                                 [ 'ORDER BY' => 'page_id', 'LIMIT' => $queryLimit ],
 183                                 [ 'page' => [ 'INNER JOIN', "$fromCol = page_id" ] ]
 184                         );
 185                 };
 186
 187                 if ( $fetchlinks ) {
 188                         $plRes = $queryFunc( $dbr, 'pagelinks', 'pl_from' );
 189                 }
 190
 191                 if ( !$hidetrans ) {
 192                         $tlRes = $queryFunc( $dbr, 'templatelinks', 'tl_from' );
 193                 }
 194
 195                 if ( !$hideimages ) {
 196                         $ilRes = $queryFunc( $dbr, 'imagelinks', 'il_from' );
 197                 }
 198
 199                 if ( ( !$fetchlinks || !$plRes->numRows() )
 200                         && ( $hidetrans || !$tlRes->numRows() )
 201                         && ( $hideimages || !$ilRes->numRows() )
 202                 ) {
 203                         if ( $level == 0 ) {
 204                                 if ( !$this->including() ) {
 205                                         $out->addHTML( $this->whatlinkshereForm() );
 206
 207                                         // Show filters only if there are links
 208                                         if ( $hidelinks || $hidetrans || $hideredirs || $hideimages ) {
 209                                                 $out->addHTML( $this->getFilterPanel() );
 210                                         }
 211                                         $msgKey = is_int( $namespace ) ? 'nolinkshere-ns' : 'nolinkshere';
 212                                         $link = $this->getLinkRenderer()->makeLink(
 213                                                 $this->target,
 214                                                 null,
 215                                                 [],
 216                                                 $this->target->isRedirect() ? [ 'redirect' => 'no' ] : []
 217                                         );
 218
 219                                         $errMsg = $this->msg( $msgKey )
 220                                                 ->params( $this->target->getPrefixedText() )
 221                                                 ->rawParams( $link )
 222                                                 ->parseAsBlock();
 223                                         $out->addHTML( $errMsg );
 224                                         $out->setStatusCode( 404 );
 225                                 }
 226                         }
 227
 228                         return;
 229                 }
 230
 231                 // Read the rows into an array and remove duplicates
 232                 // templatelinks comes second so that the templatelinks row overwrites the
 233                 // pagelinks row, so we get (inclusion) rather than nothing
 234                 if ( $fetchlinks ) {
 235                         foreach ( $plRes as $row ) {
 236                                 $row->is_template = 0;
 237                                 $row->is_image = 0;
 238                                 $rows[$row->page_id] = $row;
 239                         }
 240                 }
 241                 if ( !$hidetrans ) {
 242                         foreach ( $tlRes as $row ) {
 243                                 $row->is_template = 1;
 244                                 $row->is_image = 0;
 245                                 $rows[$row->page_id] = $row;
 246                         }
 247                 }
 248                 if ( !$hideimages ) {
 249                         foreach ( $ilRes as $row ) {
 250                                 $row->is_template = 0;
 251                                 $row->is_image = 1;
 252                                 $rows[$row->page_id] = $row;
 253                         }
 254                 }
 255
 256                 // Sort by key and then change the keys to 0-based indices
 257                 ksort( $rows );
 258                 $rows = array_values( $rows );
 259
 260                 $numRows = count( $rows );
 261
 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 );
 269                 } else {
 270                         // No more rows after
 271                         $nextId = false;
 272                 }
 273                 $prevId = $from;
 274
 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 );
 280                 }
 281                 $lb->execute();
 282
 283                 if ( $level == 0 ) {
 284                         if ( !$this->including() ) {
 285                                 $out->addHTML( $this->whatlinkshereForm() );
 286                                 $out->addHTML( $this->getFilterPanel() );
 287
 288                                 $link = $this->getLinkRenderer()->makeLink(
 289                                         $this->target,
 290                                         null,
 291                                         [],
 292                                         $this->target->isRedirect() ? [ 'redirect' => 'no' ] : []
 293                                 );
 294
 295                                 $msg = $this->msg( 'linkshere' )
 296                                         ->params( $this->target->getPrefixedText() )
 297                                         ->rawParams( $link )
 298                                         ->parseAsBlock();
 299                                 $out->addHTML( $msg );
 300
 301                                 $prevnext = $this->getPrevNext( $prevId, $nextId );
 302                                 $out->addHTML( $prevnext );
 303                         }
 304                 }
 305                 $out->addHTML( $this->listStart( $level ) );
 306                 foreach ( $rows as $row ) {
 307                         $nt = Title::makeTitle( $row->page_namespace, $row->page_title );
 308
 309                         if ( $row->rd_from && $level < 2 ) {
 310                                 $out->addHTML( $this->listItem( $row, $nt, $target, true ) );
 311                                 $this->showIndirectLinks(
 312                                         $level + 1,
 313                                         $nt,
 314                                         $this->getConfig()->get( 'MaxRedirectLinksRetrieved' )
 315                                 );
 316                                 $out->addHTML( Xml::closeElement( 'li' ) );
 317                         } else {
 318                                 $out->addHTML( $this->listItem( $row, $nt, $target ) );
 319                         }
 320                 }
 321
 322                 $out->addHTML( $this->listEnd() );
 323
 324                 if ( $level == 0 ) {
 325                         if ( !$this->including() ) {
 326                                 $out->addHTML( $prevnext );
 327                         }
 328                 }
 329         }
 330
 331         protected function listStart( $level ) {
 332                 return Xml::openElement( 'ul', ( $level ? [] : [ 'id' => 'mw-whatlinkshere-list' ] ) );
 333         }
 334
 335         protected function listItem( $row, $nt, $target, $notClose = false ) {
 336                 $dirmark = $this->getLanguage()->getDirMark();
 337
 338                 # local message cache
 339                 static $msgcache = null;
 340                 if ( $msgcache === null ) {
 341                         static $msgs = [ 'isredirect', 'istemplate', 'semicolon-separator',
 342                                 'whatlinkshere-links', 'isimage', 'editlink' ];
 343                         $msgcache = [];
 344                         foreach ( $msgs as $msg ) {
 345                                 $msgcache[$msg] = $this->msg( $msg )->escaped();
 346                         }
 347                 }
 348
 349                 if ( $row->rd_from ) {
 350                         $query = [ 'redirect' => 'no' ];
 351                 } else {
 352                         $query = [];
 353                 }
 354
 355                 $link = $this->getLinkRenderer()->makeKnownLink(
 356                         $nt,
 357                         null,
 358                         $row->page_is_redirect ? [ 'class' => 'mw-redirect' ] : [],
 359                         $query
 360                 );
 361
 362                 // Display properties (redirect or template)
 363                 $propsText = '';
 364                 $props = [];
 365                 if ( $row->rd_from ) {
 366                         $props[] = $msgcache['isredirect'];
 367                 }
 368                 if ( $row->is_template ) {
 369                         $props[] = $msgcache['istemplate'];
 370                 }
 371                 if ( $row->is_image ) {
 372                         $props[] = $msgcache['isimage'];
 373                 }
 374
 375                 Hooks::run( 'WhatLinksHereProps', [ $row, $nt, $target, &$props ] );
 376
 377                 if ( count( $props ) ) {
 378                         $propsText = $this->msg( 'parentheses' )
 379                                 ->rawParams( implode( $msgcache['semicolon-separator'], $props ) )->escaped();
 380                 }
 381
 382                 # Space for utilities links, with a what-links-here link provided
 383                 $wlhLink = $this->wlhLink( $nt, $msgcache['whatlinkshere-links'], $msgcache['editlink'] );
 384                 $wlh = Xml::wrapClass(
 385                         $this->msg( 'parentheses' )->rawParams( $wlhLink )->escaped(),
 386                         'mw-whatlinkshere-tools'
 387                 );
 388
 389                 return $notClose ?
 390                         Xml::openElement( 'li' ) . "$link $propsText $dirmark $wlh\n" :
 391                         Xml::tags( 'li', null, "$link $propsText $dirmark $wlh" ) . "\n";
 392         }
 393
 394         protected function listEnd() {
 395                 return Xml::closeElement( 'ul' );
 396         }
 397
 398         protected function wlhLink( Title $target, $text, $editText ) {
 399                 static $title = null;
 400                 if ( $title === null ) {
 401                         $title = $this->getPageTitle();
 402                 }
 403
 404                 $linkRenderer = $this->getLinkRenderer();
 405
 406                 if ( $text !== null ) {
 407                         $text = new HtmlArmor( $text );
 408                 }
 409
 410                 // always show a "<- Links" link
 411                 $links = [
 412                         'links' => $linkRenderer->makeKnownLink(
 413                                 $title,
 414                                 $text,
 415                                 [],
 416                                 [ 'target' => $target->getPrefixedText() ]
 417                         ),
 418                 ];
 419
 420                 // if the page is editable, add an edit link
 421                 if (
 422                         // check user permissions
 423                         $this->getUser()->isAllowed( 'edit' ) &&
 424                         // check, if the content model is editable through action=edit
 425                         ContentHandler::getForTitle( $target )->supportsDirectEditing()
 426                 ) {
 427                         if ( $editText !== null ) {
 428                                 $editText = new HtmlArmor( $editText );
 429                         }
 430
 431                         $links['edit'] = $linkRenderer->makeKnownLink(
 432                                 $target,
 433                                 $editText,
 434                                 [],
 435                                 [ 'action' => 'edit' ]
 436                         );
 437                 }
 438
 439                 // build the links html
 440                 return $this->getLanguage()->pipeList( $links );
 441         }
 442
 443         function makeSelfLink( $text, $query ) {
 444                 if ( $text !== null ) {
 445                         $text = new HtmlArmor( $text );
 446                 }
 447
 448                 return $this->getLinkRenderer()->makeKnownLink(
 449                         $this->selfTitle,
 450                         $text,
 451                         [],
 452                         $query
 453                 );
 454         }
 455
 456         function getPrevNext( $prevId, $nextId ) {
 457                 $currentLimit = $this->opts->getValue( 'limit' );
 458                 $prev = $this->msg( 'whatlinkshere-prev' )->numParams( $currentLimit )->escaped();
 459                 $next = $this->msg( 'whatlinkshere-next' )->numParams( $currentLimit )->escaped();
 460
 461                 $changed = $this->opts->getChangedValues();
 462                 unset( $changed['target'] ); // Already in the request title
 463
 464                 if ( $prevId != 0 ) {
 465                         $overrides = [ 'from' => $this->opts->getValue( 'back' ) ];
 466                         $prev = $this->makeSelfLink( $prev, array_merge( $changed, $overrides ) );
 467                 }
 468                 if ( $nextId != 0 ) {
 469                         $overrides = [ 'from' => $nextId, 'back' => $prevId ];
 470                         $next = $this->makeSelfLink( $next, array_merge( $changed, $overrides ) );
 471                 }
 472
 473                 $limitLinks = [];
 474                 $lang = $this->getLanguage();
 475                 foreach ( $this->limits as $limit ) {
 476                         $prettyLimit = htmlspecialchars( $lang->formatNum( $limit ) );
 477                         $overrides = [ 'limit' => $limit ];
 478                         $limitLinks[] = $this->makeSelfLink( $prettyLimit, array_merge( $changed, $overrides ) );
 479                 }
 480
 481                 $nums = $lang->pipeList( $limitLinks );
 482
 483                 return $this->msg( 'viewprevnext' )->rawParams( $prev, $next, $nums )->escaped();
 484         }
 485
 486         function whatlinkshereForm() {
 487                 // We get nicer value from the title object
 488                 $this->opts->consumeValue( 'target' );
 489                 // Reset these for new requests
 490                 $this->opts->consumeValues( [ 'back', 'from' ] );
 491
 492                 $target = $this->target ? $this->target->getPrefixedText() : '';
 493                 $namespace = $this->opts->consumeValue( 'namespace' );
 494                 $nsinvert = $this->opts->consumeValue( 'invert' );
 495
 496                 # Build up the form
 497                 $f = Xml::openElement( 'form', [ 'action' => wfScript() ] );
 498
 499                 # Values that should not be forgotten
 500                 $f .= Html::hidden( 'title', $this->getPageTitle()->getPrefixedText() );
 501                 foreach ( $this->opts->getUnconsumedValues() as $name => $value ) {
 502                         $f .= Html::hidden( $name, $value );
 503                 }
 504
 505                 $f .= Xml::fieldset( $this->msg( 'whatlinkshere' )->text() );
 506
 507                 # Target input (.mw-searchInput enables suggestions)
 508                 $f .= Xml::inputLabel( $this->msg( 'whatlinkshere-page' )->text(), 'target',
 509                         'mw-whatlinkshere-target', 40, $target, [ 'class' => 'mw-searchInput' ] );
 510
 511                 $f .= ' ';
 512
 513                 # Namespace selector
 514                 $f .= Html::namespaceSelector(
 515                         [
 516                                 'selected' => $namespace,
 517                                 'all' => '',
 518                                 'label' => $this->msg( 'namespace' )->text(),
 519                                 'in-user-lang' => true,
 520                         ], [
 521                                 'name' => 'namespace',
 522                                 'id' => 'namespace',
 523                                 'class' => 'namespaceselector',
 524                         ]
 525                 );
 526
 527                 $f .= "\u{00A0}" .
 528                         Xml::checkLabel(
 529                                 $this->msg( 'invert' )->text(),
 530                                 'invert',
 531                                 'nsinvert',
 532                                 $nsinvert,
 533                                 [ 'title' => $this->msg( 'tooltip-whatlinkshere-invert' )->text() ]
 534                         );
 535
 536                 $f .= ' ';
 537
 538                 # Submit
 539                 $f .= Xml::submitButton( $this->msg( 'whatlinkshere-submit' )->text() );
 540
 541                 # Close
 542                 $f .= Xml::closeElement( 'fieldset' ) . Xml::closeElement( 'form' ) . "\n";
 543
 544                 return $f;
 545         }
 546
 547         /**
 548          * Create filter panel
 549          *
 550          * @return string HTML fieldset and filter panel with the show/hide links
 551          */
 552         function getFilterPanel() {
 553                 $show = $this->msg( 'show' )->escaped();
 554                 $hide = $this->msg( 'hide' )->escaped();
 555
 556                 $changed = $this->opts->getChangedValues();
 557                 unset( $changed['target'] ); // Already in the request title
 558
 559                 $links = [];
 560                 $types = [ 'hidetrans', 'hidelinks', 'hideredirs' ];
 561                 if ( $this->target->getNamespace() == NS_FILE ) {
 562                         $types[] = 'hideimages';
 563                 }
 564
 565                 // Combined message keys: 'whatlinkshere-hideredirs', 'whatlinkshere-hidetrans',
 566                 // 'whatlinkshere-hidelinks', 'whatlinkshere-hideimages'
 567                 // To be sure they will be found by grep
 568                 foreach ( $types as $type ) {
 569                         $chosen = $this->opts->getValue( $type );
 570                         $msg = $chosen ? $show : $hide;
 571                         $overrides = [ $type => !$chosen ];
 572                         $links[] = $this->msg( "whatlinkshere-{$type}" )->rawParams(
 573                                 $this->makeSelfLink( $msg, array_merge( $changed, $overrides ) ) )->escaped();
 574                 }
 575
 576                 return Xml::fieldset(
 577                         $this->msg( 'whatlinkshere-filters' )->text(),
 578                         $this->getLanguage()->pipeList( $links )
 579                 );
 580         }
 581
 582         /**
 583          * Return an array of subpages beginning with $search that this special page will accept.
 584          *
 585          * @param string $search Prefix to search for
 586          * @param int $limit Maximum number of results to return (usually 10)
 587          * @param int $offset Number of results to skip (usually 0)
 588          * @return string[] Matching subpages
 589          */
 590         public function prefixSearchSubpages( $search, $limit, $offset ) {
 591                 return $this->prefixSearchString( $search, $limit, $offset );
 592         }
 593
 594         protected function getGroupName() {
 595                 return 'pagetools';
 596         }
 597 }