<?php
/**
+ * @todo Use some variant of Pager or something; the pagination here is lousy.
*
- * @package MediaWiki
- * @subpackage SpecialPage
+ * @file
+ * @ingroup SpecialPage
*/
/**
* Entry point
- * @param string $par An article name ??
+ * @param $par String: An article name ??
*/
function wfSpecialWhatlinkshere($par = NULL) {
global $wgRequest;
$page->execute();
}
+/**
+ * implements Special:Whatlinkshere
+ * @ingroup SpecialPage
+ */
class WhatLinksHerePage {
- var $request, $par;
- var $limit, $from, $dir, $target;
- var $selfTitle, $skin;
+ // Stored data
+ protected $par;
+
+ // Stored objects
+ protected $opts, $target, $selfTitle;
- function WhatLinksHerePage( &$request, $par = null ) {
+ // Stored globals
+ protected $skin, $request;
+
+ protected $limits = array( 20, 50, 100, 250, 500 );
+
+ function WhatLinksHerePage( $request, $par = null ) {
global $wgUser;
- $this->request =& $request;
- $this->skin =& $wgUser->getSkin();
+ $this->request = $request;
+ $this->skin = $wgUser->getSkin();
$this->par = $par;
}
function execute() {
global $wgOut;
- $this->limit = min( $this->request->getInt( 'limit', 50 ), 5000 );
- if ( $this->limit <= 0 ) {
- $this->limit = 50;
- }
- $this->from = $this->request->getInt( 'from' );
- $this->dir = $this->request->getText( 'dir', 'next' );
- if ( $this->dir != 'prev' ) {
- $this->dir = 'next';
- }
+ $opts = new FormOptions();
- $targetString = isset($this->par) ? $this->par : $this->request->getVal( 'target' );
+ $opts->add( 'target', '' );
+ $opts->add( 'namespace', '', FormOptions::INTNULL );
+ $opts->add( 'limit', 50 );
+ $opts->add( 'from', 0 );
+ $opts->add( 'back', 0 );
+ $opts->add( 'hideredirs', false );
+ $opts->add( 'hidetrans', false );
+ $opts->add( 'hidelinks', false );
+ $opts->add( 'hideimages', false );
- if (is_null($targetString)) {
- $wgOut->showErrorPage( 'notargettitle', 'notargettext' );
- return;
+ $opts->fetchValuesFromRequest( $this->request );
+ $opts->validateIntBounds( 'limit', 0, 5000 );
+
+ // Give precedence to subpage syntax
+ if ( isset($this->par) ) {
+ $opts->setValue( 'target', $this->par );
}
- $this->target = Title::newFromURL( $targetString );
+ // Bind to member variable
+ $this->opts = $opts;
+
+ $this->target = Title::newFromURL( $opts->getValue( 'target' ) );
if( !$this->target ) {
- $wgOut->showErrorPage( 'notargettitle', 'notargettext' );
+ $wgOut->addHTML( $this->whatlinkshereForm() );
return;
}
- $this->selfTitle = Title::makeTitleSafe( NS_SPECIAL,
- 'Whatlinkshere/' . $this->target->getPrefixedDBkey() );
- $wgOut->setPagetitle( $this->target->getPrefixedText() );
- $wgOut->setSubtitle( wfMsg( 'linklistsub' ) );
- $wgOut->addHTML( wfMsg( 'whatlinkshere-barrow' ) . ' ' .$this->skin->makeLinkObj($this->target, '', 'redirect=no' )."<br />\n");
+ $this->selfTitle = SpecialPage::getTitleFor( 'Whatlinkshere', $this->target->getPrefixedDBkey() );
+
+ $wgOut->setPageTitle( wfMsgExt( 'whatlinkshere-title', 'escape', $this->target->getPrefixedText() ) );
+ $wgOut->setSubtitle( wfMsgHtml( 'linklistsub' ) );
- $this->showIndirectLinks( 0, $this->target, $this->limit, $this->from, $this->dir );
+ $wgOut->addHTML( wfMsgExt( 'whatlinkshere-barrow', array( 'escapenoentities') ) . ' ' .$this->skin->makeLinkObj($this->target, '', 'redirect=no' )."<br />\n");
+
+ $this->showIndirectLinks( 0, $this->target, $opts->getValue( 'limit' ),
+ $opts->getValue( 'from' ), $opts->getValue( 'back' ) );
}
/**
* @param Title $target Target title
* @param int $limit Number of entries to display
* @param Title $from Display from this article ID
- * @param string $dir 'next' or 'prev', whether $fromTitle is the start or end of the list
+ * @param Title $back Display from this article ID at backwards scrolling
* @private
*/
- function showIndirectLinks( $level, $target, $limit, $from = 0, $dir = 'next' ) {
- global $wgOut;
- $fname = 'WhatLinksHerePage::showIndirectLinks';
+ function showIndirectLinks( $level, $target, $limit, $from = 0, $back = 0 ) {
+ global $wgOut, $wgMaxRedirectLinksRetrieved;
+ $dbr = wfGetDB( DB_SLAVE );
+ $options = array();
- $dbr =& wfGetDB( DB_READ );
+ $hidelinks = $this->opts->getValue( 'hidelinks' );
+ $hideredirs = $this->opts->getValue( 'hideredirs' );
+ $hidetrans = $this->opts->getValue( 'hidetrans' );
+ $hideimages = $target->getNamespace() != NS_IMAGE || $this->opts->getValue( 'hideimages' );
- // Some extra validation
- $from = intval( $from );
- if ( !$from && $dir == 'prev' ) {
- // Before start? No make sense
- $dir = 'next';
- }
+ $fetchlinks = (!$hidelinks || !$hideredirs);
// Make the query
$plConds = array(
'pl_namespace' => $target->getNamespace(),
'pl_title' => $target->getDBkey(),
);
+ if( $hideredirs ) {
+ $plConds['page_is_redirect'] = 0;
+ } elseif( $hidelinks ) {
+ $plConds['page_is_redirect'] = 1;
+ }
$tlConds = array(
'page_id=tl_from',
'tl_title' => $target->getDBkey(),
);
+ $ilConds = array(
+ 'page_id=il_from',
+ 'il_to' => $target->getDBkey(),
+ );
+
+ $namespace = $this->opts->getValue( 'namespace' );
+ if ( is_int($namespace) ) {
+ $plConds['page_namespace'] = $namespace;
+ $tlConds['page_namespace'] = $namespace;
+ }
+
if ( $from ) {
- if ( 'prev' == $dir ) {
- $offsetCond = "page_id < $from";
- $options = array( 'ORDER BY page_id DESC' );
- } else {
- $offsetCond = "page_id >= $from";
- $options = array( 'ORDER BY page_id' );
- }
- } else {
- $offsetCond = false;
- $options = array( 'ORDER BY page_id,is_template DESC' );
+ $tlConds[] = "tl_from >= $from";
+ $plConds[] = "pl_from >= $from";
+ $ilConds[] = "il_from >= $from";
}
+
// Read an extra row as an at-end check
$queryLimit = $limit + 1;
+
+ // Enforce join order, sometimes namespace selector may
+ // trigger filesorts which are far less efficient than scanning many entries
+ $options[] = 'STRAIGHT_JOIN';
+
$options['LIMIT'] = $queryLimit;
- if ( $offsetCond ) {
- $tlConds[] = $offsetCond;
- $plConds[] = $offsetCond;
- }
$fields = array( 'page_id', 'page_namespace', 'page_title', 'page_is_redirect' );
- $plRes = $dbr->select( array( 'pagelinks', 'page' ), $fields,
- $plConds, $fname, $options );
- $tlRes = $dbr->select( array( 'templatelinks', 'page' ), $fields,
- $tlConds, $fname, $options );
+ if( $fetchlinks ) {
+ $options['ORDER BY'] = 'pl_from';
+ $plRes = $dbr->select( array( 'pagelinks', 'page' ), $fields,
+ $plConds, __METHOD__, $options );
+ }
- if ( !$dbr->numRows( $plRes ) && !$dbr->numRows( $tlRes ) ) {
+ if( !$hidetrans ) {
+ $options['ORDER BY'] = 'tl_from';
+ $tlRes = $dbr->select( array( 'templatelinks', 'page' ), $fields,
+ $tlConds, __METHOD__, $options );
+ }
+
+ if( !$hideimages ) {
+ $options['ORDER BY'] = 'il_from';
+ $ilRes = $dbr->select( array( 'imagelinks', 'page' ), $fields,
+ $ilConds, __METHOD__, $options );
+ }
+
+ if( ( !$fetchlinks || !$dbr->numRows($plRes) ) && ( $hidetrans || !$dbr->numRows($tlRes) ) && ( $hideimages || !$dbr->numRows($ilRes) ) ) {
if ( 0 == $level ) {
- $wgOut->addWikiText( wfMsg( 'nolinkshere', $this->target->getPrefixedText() ) );
+ $wgOut->addHTML( $this->whatlinkshereForm() );
+ $errMsg = is_int($namespace) ? 'nolinkshere-ns' : 'nolinkshere';
+ $wgOut->addWikiMsg( $errMsg, $this->target->getPrefixedText() );
+ // Show filters only if there are links
+ if( $hidelinks || $hidetrans || $hideredirs || $hideimages )
+ $wgOut->addHTML( $this->getFilterPanel() );
}
return;
}
// Read the rows into an array and remove duplicates
// templatelinks comes second so that the templatelinks row overwrites the
// pagelinks row, so we get (inclusion) rather than nothing
- while ( $row = $dbr->fetchObject( $plRes ) ) {
- $row->is_template = 0;
- $rows[$row->page_id] = $row;
+ if( $fetchlinks ) {
+ while ( $row = $dbr->fetchObject( $plRes ) ) {
+ $row->is_template = 0;
+ $row->is_image = 0;
+ $rows[$row->page_id] = $row;
+ }
+ $dbr->freeResult( $plRes );
+
}
- $dbr->freeResult( $plRes );
- while ( $row = $dbr->fetchObject( $tlRes ) ) {
- $row->is_template = 1;
- $rows[$row->page_id] = $row;
+ if( !$hidetrans ) {
+ while ( $row = $dbr->fetchObject( $tlRes ) ) {
+ $row->is_template = 1;
+ $row->is_image = 0;
+ $rows[$row->page_id] = $row;
+ }
+ $dbr->freeResult( $tlRes );
+ }
+ if( !$hideimages ) {
+ while ( $row = $dbr->fetchObject( $ilRes ) ) {
+ $row->is_template = 0;
+ $row->is_image = 1;
+ $rows[$row->page_id] = $row;
+ }
+ $dbr->freeResult( $ilRes );
}
- $dbr->freeResult( $tlRes );
// Sort by key and then change the keys to 0-based indices
ksort( $rows );
$numRows = count( $rows );
// Work out the start and end IDs, for prev/next links
- if ( $dir == 'prev' ) {
- // Descending order
- if ( $numRows > $limit ) {
- // More rows available before these ones
- // Get the ID from the next row past the end of the displayed set
- $prevId = $rows[$limit]->page_id;
- // Remove undisplayed rows
- $rows = array_slice( $rows, 0, $limit );
- } else {
- // No more rows available before
- $prevId = 0;
- }
- // Assume that the ID specified in $from exists, so there must be another page
- $nextId = $from;
-
- // Reverse order ready for display
- $rows = array_reverse( $rows );
+ if ( $numRows > $limit ) {
+ // More rows available after these ones
+ // Get the ID from the last row in the result set
+ $nextId = $rows[$limit]->page_id;
+ // Remove undisplayed rows
+ $rows = array_slice( $rows, 0, $limit );
} else {
- // Ascending
- if ( $numRows > $limit ) {
- // More rows available after these ones
- // Get the ID from the last row in the result set
- $nextId = $rows[$limit]->page_id;
- // Remove undisplayed rows
- $rows = array_slice( $rows, 0, $limit );
- } else {
- // No more rows after
- $nextId = false;
- }
- $prevId = $from;
+ // No more rows after
+ $nextId = false;
}
+ $prevId = $from;
- if ( 0 == $level ) {
- $wgOut->addWikiText( wfMsg( 'linkshere', $this->target->getPrefixedText() ) );
- }
- $isredir = wfMsg( 'isredirect' );
- $istemplate = wfMsg( 'istemplate' );
+ if ( $level == 0 ) {
+ $wgOut->addHTML( $this->whatlinkshereForm() );
+ $wgOut->addHTML( $this->getFilterPanel() );
+ $wgOut->addWikiMsg( 'linkshere', $this->target->getPrefixedText() );
- if( $level == 0 ) {
- $prevnext = $this->getPrevNext( $limit, $prevId, $nextId );
+ $prevnext = $this->getPrevNext( $prevId, $nextId );
$wgOut->addHTML( $prevnext );
}
- $wgOut->addHTML( '<ul>' );
+ $wgOut->addHTML( $this->listStart() );
foreach ( $rows as $row ) {
$nt = Title::makeTitle( $row->page_namespace, $row->page_title );
- if ( $row->page_is_redirect ) {
- $extra = 'redirect=no';
+ if ( $row->page_is_redirect && $level < 2 ) {
+ $wgOut->addHTML( $this->listItem( $row, $nt, true ) );
+ $this->showIndirectLinks( $level + 1, $nt, $wgMaxRedirectLinksRetrieved );
+ $wgOut->addHTML( Xml::closeElement( 'li' ) );
} else {
- $extra = '';
+ $wgOut->addHTML( $this->listItem( $row, $nt ) );
}
+ }
- $link = $this->skin->makeKnownLinkObj( $nt, '', $extra );
- $wgOut->addHTML( '<li>'.$link );
+ $wgOut->addHTML( $this->listEnd() );
- // Display properties (redirect or template)
- $props = array();
- if ( $row->page_is_redirect ) {
- $props[] = $isredir;
- }
- if ( $row->is_template ) {
- $props[] = $istemplate;
- }
- if ( count( $props ) ) {
- // FIXME? Cultural assumption, hard-coded punctuation
- $wgOut->addHTML( ' (' . implode( ', ', $props ) . ') ' );
- }
+ if( $level == 0 ) {
+ $wgOut->addHTML( $prevnext );
+ }
+ }
+
+ protected function listStart() {
+ return Xml::openElement( 'ul' );
+ }
- if ( $row->page_is_redirect ) {
- if ( $level < 2 ) {
- $this->showIndirectLinks( $level + 1, $nt, 500 );
- }
+ protected function listItem( $row, $nt, $notClose = false ) {
+ # local message cache
+ static $msgcache = null;
+ if ( $msgcache === null ) {
+ static $msgs = array( 'isredirect', 'istemplate', 'semicolon-separator',
+ 'whatlinkshere-links', 'isimage' );
+ $msgcache = array();
+ foreach ( $msgs as $msg ) {
+ $msgcache[$msg] = wfMsgHtml( $msg );
}
- $wgOut->addHTML( "</li>\n" );
}
- $wgOut->addHTML( "</ul>\n" );
- if( $level == 0 ) {
- $wgOut->addHTML( $prevnext );
+ $suppressRedirect = $row->page_is_redirect ? 'redirect=no' : '';
+ $link = $this->skin->makeKnownLinkObj( $nt, '', $suppressRedirect );
+
+ // Display properties (redirect or template)
+ $propsText = '';
+ $props = array();
+ if ( $row->page_is_redirect )
+ $props[] = $msgcache['isredirect'];
+ if ( $row->is_template )
+ $props[] = $msgcache['istemplate'];
+ if( $row->is_image )
+ $props[] = $msgcache['isimage'];
+
+ if ( count( $props ) ) {
+ $propsText = '(' . implode( $msgcache['semicolon-separator'], $props ) . ')';
}
+
+ # Space for utilities links, with a what-links-here link provided
+ $wlhLink = $this->wlhLink( $nt, $msgcache['whatlinkshere-links'] );
+ $wlh = Xml::wrapClass( "($wlhLink)", 'mw-whatlinkshere-tools' );
+
+ return $notClose ?
+ Xml::openElement( 'li' ) . "$link $propsText $wlh\n" :
+ Xml::tags( 'li', null, "$link $propsText $wlh" ) . "\n";
+ }
+
+ protected function listEnd() {
+ return Xml::closeElement( 'ul' );
+ }
+
+ protected function wlhLink( Title $target, $text ) {
+ static $title = null;
+ if ( $title === null )
+ $title = SpecialPage::getTitleFor( 'Whatlinkshere' );
+
+ $targetText = $target->getPrefixedUrl();
+ return $this->skin->makeKnownLinkObj( $title, $text, 'target=' . $targetText );
}
function makeSelfLink( $text, $query ) {
return $this->skin->makeKnownLinkObj( $this->selfTitle, $text, $query );
}
- function getPrevNext( $limit, $prevId, $nextId ) {
+ function getPrevNext( $prevId, $nextId ) {
global $wgLang;
- $fmtLimit = $wgLang->formatNum( $limit );
- $prev = wfMsg( 'prevn', $fmtLimit );
- $next = wfMsg( 'nextn', $fmtLimit );
+ $currentLimit = $this->opts->getValue( 'limit' );
+ $fmtLimit = $wgLang->formatNum( $currentLimit );
+ $prev = wfMsgExt( 'whatlinkshere-prev', array( 'parsemag', 'escape' ), $fmtLimit );
+ $next = wfMsgExt( 'whatlinkshere-next', array( 'parsemag', 'escape' ), $fmtLimit );
+
+ $changed = $this->opts->getChangedValues();
+ unset($changed['target']); // Already in the request title
if ( 0 != $prevId ) {
- $prevLink = $this->makeSelfLink( $prev, "limit={$limit}&from={$prevId}&dir=prev" );
- } else {
- $prevLink = $prev;
+ $overrides = array( 'from' => $this->opts->getValue( 'back' ) );
+ $prev = $this->makeSelfLink( $prev, wfArrayToCGI( $overrides, $changed ) );
}
if ( 0 != $nextId ) {
- $nextLink = $this->makeSelfLink( $next, "limit={$limit}&from={$nextId}" );
- } else {
- $nextLink = $next;
+ $overrides = array( 'from' => $nextId, 'back' => $prevId );
+ $next = $this->makeSelfLink( $next, wfArrayToCGI( $overrides, $changed ) );
+ }
+
+ $limitLinks = array();
+ foreach ( $this->limits as $limit ) {
+ $prettyLimit = $wgLang->formatNum( $limit );
+ $overrides = array( 'limit' => $limit );
+ $limitLinks[] = $this->makeSelfLink( $prettyLimit, wfArrayToCGI( $overrides, $changed ) );
}
- $nums = $this->numLink( 20, $prevId ) . ' | ' .
- $this->numLink( 50, $prevId ) . ' | ' .
- $this->numLink( 100, $prevId ) . ' | ' .
- $this->numLink( 250, $prevId ) . ' | ' .
- $this->numLink( 500, $prevId );
- return wfMsg( 'viewprevnext', $prevLink, $nextLink, $nums );
+ $nums = implode ( ' | ', $limitLinks );
+
+ return wfMsgHtml( 'viewprevnext', $prev, $next, $nums );
}
- function numLink( $limit, $from ) {
- global $wgLang;
- $query = "limit={$limit}&from={$from}";
- $fmtLimit = $wgLang->formatNum( $limit );
- return $this->makeSelfLink( $fmtLimit, $query );
+ function whatlinkshereForm() {
+ global $wgScript, $wgTitle;
+
+ // We get nicer value from the title object
+ $this->opts->consumeValue( 'target' );
+ // Reset these for new requests
+ $this->opts->consumeValues( array( 'back', 'from' ) );
+
+ $target = $this->target ? $this->target->getPrefixedText() : '';
+ $namespace = $this->opts->consumeValue( 'namespace' );
+
+ # Build up the form
+ $f = Xml::openElement( 'form', array( 'action' => $wgScript ) );
+
+ # Values that should not be forgotten
+ $f .= Xml::hidden( 'title', $wgTitle->getPrefixedText() );
+ foreach ( $this->opts->getUnconsumedValues() as $name => $value ) {
+ $f .= Xml::hidden( $name, $value );
+ }
+
+ $f .= Xml::fieldset( wfMsg( 'whatlinkshere' ) );
+
+ # Target input
+ $f .= Xml::inputLabel( wfMsg( 'whatlinkshere-page' ), 'target',
+ 'mw-whatlinkshere-target', 40, $target );
+
+ $f .= ' ';
+
+ # Namespace selector
+ $f .= Xml::label( wfMsg( 'namespace' ), 'namespace' ) . ' ' .
+ Xml::namespaceSelector( $namespace, '' );
+
+ # Submit
+ $f .= Xml::submitButton( wfMsg( 'allpagessubmit' ) );
+
+ # Close
+ $f .= Xml::closeElement( 'fieldset' ) . Xml::closeElement( 'form' ) . "\n";
+
+ return $f;
}
-}
-?>
+ function getFilterPanel() {
+ $show = wfMsgHtml( 'show' );
+ $hide = wfMsgHtml( 'hide' );
+
+ $changed = $this->opts->getChangedValues();
+ unset($changed['target']); // Already in the request title
+
+ $links = array();
+ $types = array( 'hidetrans', 'hidelinks', 'hideredirs' );
+ if( $this->target->getNamespace() == NS_IMAGE )
+ $types[] = 'hideimages';
+ foreach( $types as $type ) {
+ $chosen = $this->opts->getValue( $type );
+ $msg = wfMsgHtml( "whatlinkshere-{$type}", $chosen ? $show : $hide );
+ $overrides = array( $type => !$chosen );
+ $links[] = $this->makeSelfLink( $msg, wfArrayToCGI( $overrides, $changed ) );
+ }
+ return Xml::fieldset( wfMsg( 'whatlinkshere-filters' ), implode( ' | ', $links ) );
+ }
+}