4 * @addtogroup SpecialPage
9 * @param string $par An article name ??
11 function wfSpecialWhatlinkshere($par = NULL) {
13 $page = new WhatLinksHerePage( $wgRequest, $par );
18 * implements Special:Whatlinkshere
19 * @addtogroup SpecialPage
21 class WhatLinksHerePage
{
23 var $limit, $from, $back, $target;
24 var $selfTitle, $skin;
28 function WhatLinksHerePage( &$request, $par = null ) {
30 $this->request
=& $request;
31 $this->skin
= $wgUser->getSkin();
38 $this->limit
= min( $this->request
->getInt( 'limit', 50 ), 5000 );
39 if ( $this->limit
<= 0 ) {
42 $this->from
= $this->request
->getInt( 'from' );
43 $this->back
= $this->request
->getInt( 'back' );
45 $targetString = isset($this->par
) ?
$this->par
: $this->request
->getVal( 'target' );
47 if (is_null($targetString)) {
48 $wgOut->showErrorPage( 'notargettitle', 'notargettext' );
52 $this->target
= Title
::newFromURL( $targetString );
53 if( !$this->target
) {
54 $wgOut->showErrorPage( 'notargettitle', 'notargettext' );
57 $this->selfTitle
= Title
::makeTitleSafe( NS_SPECIAL
,
58 'Whatlinkshere/' . $this->target
->getPrefixedDBkey() );
60 $wgOut->setPageTitle( wfMsg( 'whatlinkshere-title', $this->target
->getPrefixedText() ) );
61 $wgOut->setSubtitle( wfMsg( 'linklistsub' ) );
63 $wgOut->addHTML( wfMsg( 'whatlinkshere-barrow' ) . ' ' .$this->skin
->makeLinkObj($this->target
, '', 'redirect=no' )."<br />\n");
65 $this->showIndirectLinks( 0, $this->target
, $this->limit
, $this->from
, $this->back
);
69 * @param int $level Recursion level
70 * @param Title $target Target title
71 * @param int $limit Number of entries to display
72 * @param Title $from Display from this article ID
73 * @param Title $back Display from this article ID at backwards scrolling
76 function showIndirectLinks( $level, $target, $limit, $from = 0, $back = 0 ) {
78 $fname = 'WhatLinksHerePage::showIndirectLinks';
79 $dbr = wfGetDB( DB_READ
);
82 $ns = $this->request
->getIntOrNull( 'namespace' );
84 $options['namespace'] = $ns;
85 $this->setNamespace( $options['namespace'] );
87 $options['namespace'] = '';
93 'pl_namespace' => $target->getNamespace(),
94 'pl_title' => $target->getDBkey(),
99 'tl_namespace' => $target->getNamespace(),
100 'tl_title' => $target->getDBkey(),
103 if ( $this->namespace !== null ){
104 $plConds['page_namespace'] = (int)$this->namespace;
105 $tlConds['page_namespace'] = (int)$this->namespace;
109 $from = (int)$from; // just in case
110 $tlConds[] = "tl_from >= $from";
111 $plConds[] = "pl_from >= $from";
114 // Read an extra row as an at-end check
115 $queryLimit = $limit +
1;
117 // enforce join order, sometimes namespace selector may
118 // trigger filesorts which are far less efficient than scanning many entries
119 $options[] = 'STRAIGHT_JOIN';
121 $options['LIMIT'] = $queryLimit;
122 $fields = array( 'page_id', 'page_namespace', 'page_title', 'page_is_redirect' );
124 $options['ORDER BY'] = 'pl_from';
125 $plRes = $dbr->select( array( 'pagelinks', 'page' ), $fields,
126 $plConds, $fname, $options );
128 $options['ORDER BY'] = 'tl_from';
129 $tlRes = $dbr->select( array( 'templatelinks', 'page' ), $fields,
130 $tlConds, $fname, $options );
132 if ( !$dbr->numRows( $plRes ) && !$dbr->numRows( $tlRes ) ) {
133 if ( 0 == $level && !isset( $this->namespace ) ) {
134 // really no links to here
135 $wgOut->addWikiText( wfMsg( 'nolinkshere', $this->target
->getPrefixedText() ) );
136 } elseif ( 0 == $level && isset( $this->namespace ) ) {
137 // no links from requested namespace to here
138 $options = array(); // reinitialize for a further namespace search
139 $options['namespace'] = $this->namespace;
140 $options['target'] = $this->target
->getPrefixedText();
141 list( $options['limit'], $options['offset']) = wfCheckLimits();
142 $wgOut->addHTML( $this->whatlinkshereForm( $options ) );
143 $wgOut->addWikiText( wfMsg( 'nolinkshere-ns', $this->target
->getPrefixedText() ) );
149 list( $options['limit'], $options['offset']) = wfCheckLimits();
150 if ( ( $ns = $this->request
->getVal( 'namespace', null ) ) !== null && $ns !== '' && ctype_digit($ns) ) {
151 $options['namespace'] = intval( $ns );
152 $this->setNamespace( $options['namespace'] );
154 $options['namespace'] = '';
155 $this->setNamespace( null );
157 $options['offset'] = $this->request
->getVal( 'offset' );
158 /* Offset must be an integral. */
159 if ( !strlen( $options['offset'] ) ||
!preg_match( '/^[0-9]+$/', $options['offset'] ) )
160 $options['offset'] = '';
161 $options['target'] = $this->target
->getPrefixedDBkey();
163 // Read the rows into an array and remove duplicates
164 // templatelinks comes second so that the templatelinks row overwrites the
165 // pagelinks row, so we get (inclusion) rather than nothing
166 while ( $row = $dbr->fetchObject( $plRes ) ) {
167 $row->is_template
= 0;
168 $rows[$row->page_id
] = $row;
170 $dbr->freeResult( $plRes );
171 while ( $row = $dbr->fetchObject( $tlRes ) ) {
172 $row->is_template
= 1;
173 $rows[$row->page_id
] = $row;
175 $dbr->freeResult( $tlRes );
177 // Sort by key and then change the keys to 0-based indices
179 $rows = array_values( $rows );
181 $numRows = count( $rows );
183 // Work out the start and end IDs, for prev/next links
184 if ( $numRows > $limit ) {
185 // More rows available after these ones
186 // Get the ID from the last row in the result set
187 $nextId = $rows[$limit]->page_id
;
188 // Remove undisplayed rows
189 $rows = array_slice( $rows, 0, $limit );
191 // No more rows after
197 $wgOut->addHTML( $this->whatlinkshereForm( $options ) );
198 $wgOut->addWikiText( wfMsg( 'linkshere', $this->target
->getPrefixedText() ) );
200 $isredir = wfMsg( 'isredirect' );
201 $istemplate = wfMsg( 'istemplate' );
204 $prevnext = $this->getPrevNext( $limit, $prevId, $nextId, $options['namespace'] );
205 $wgOut->addHTML( $prevnext );
208 $wgOut->addHTML( '<ul>' );
209 foreach ( $rows as $row ) {
210 $nt = Title
::makeTitle( $row->page_namespace
, $row->page_title
);
212 if ( $row->page_is_redirect
) {
213 $extra = 'redirect=no';
218 $link = $this->skin
->makeKnownLinkObj( $nt, '', $extra );
219 $wgOut->addHTML( '<li>'.$link );
221 // Display properties (redirect or template)
223 if ( $row->page_is_redirect
) {
226 if ( $row->is_template
) {
227 $props[] = $istemplate;
229 if ( count( $props ) ) {
230 // FIXME? Cultural assumption, hard-coded punctuation
231 $wgOut->addHTML( ' (' . implode( ', ', $props ) . ') ' );
234 # Space for utilities links, with a what-links-here link provided
235 $wlh = $this->skin
->makeKnownLinkObj(
236 SpecialPage
::getTitleFor( 'Whatlinkshere' ),
237 wfMsgHtml( 'whatlinkshere-links' ),
238 'target=' . $nt->getPrefixedUrl()
240 $wgOut->addHtml( ' <span class="mw-whatlinkshere-tools">(' . $wlh . ')</span>' );
242 if ( $row->page_is_redirect
) {
244 $this->showIndirectLinks( $level +
1, $nt, 500 );
247 $wgOut->addHTML( "</li>\n" );
249 $wgOut->addHTML( "</ul>\n" );
252 $wgOut->addHTML( $prevnext );
256 function makeSelfLink( $text, $query ) {
257 return $this->skin
->makeKnownLinkObj( $this->selfTitle
, $text, $query );
260 function getPrevNext( $limit, $prevId, $nextId ) {
262 $fmtLimit = $wgLang->formatNum( $limit );
263 $prev = wfMsgExt( 'whatlinkshere-prev', array( 'parsemag', 'escape' ), $fmtLimit );
264 $next = wfMsgExt( 'whatlinkshere-next', array( 'parsemag', 'escape' ), $fmtLimit );
267 if( is_int($this->namespace) ) {
268 $nsText = "&namespace={$this->namespace}";
271 if ( 0 != $prevId ) {
272 $prevLink = $this->makeSelfLink( $prev, "limit={$limit}&from={$this->back}{$nsText}" );
276 if ( 0 != $nextId ) {
277 $nextLink = $this->makeSelfLink( $next, "limit={$limit}&from={$nextId}&back={$prevId}{$nsText}" );
281 $nums = $this->numLink( 20, $prevId ) . ' | ' .
282 $this->numLink( 50, $prevId ) . ' | ' .
283 $this->numLink( 100, $prevId ) . ' | ' .
284 $this->numLink( 250, $prevId ) . ' | ' .
285 $this->numLink( 500, $prevId );
287 return wfMsg( 'viewprevnext', $prevLink, $nextLink, $nums );
290 function numLink( $limit, $from, $ns = null ) {
292 $query = "limit={$limit}&from={$from}";
293 if( is_int($this->namespace) ) { $query .= "&namespace={$this->namespace}";}
294 $fmtLimit = $wgLang->formatNum( $limit );
295 return $this->makeSelfLink( $fmtLimit, $query );
298 function whatlinkshereForm( $options ) {
299 global $wgScript, $wgTitle;
301 $options['title'] = $wgTitle->getPrefixedText();
303 $f = Xml
::openElement( 'form', array( 'method' => 'get', 'action' => "$wgScript" ) ) .
305 Xml
::element( 'legend', array(), wfMsg( 'whatlinkshere' ) );
307 foreach ( $options as $name => $value ) {
308 if( $name === 'namespace') continue;
309 $f .= "\t" . Xml
::hidden( $name, $value ). "\n";
312 $f .= Xml
::label( wfMsg( 'namespace' ), 'namespace' ) . ' ' .
313 Xml
::namespaceSelector( $options['namespace'], '' ) .
314 Xml
::submitButton( wfMsg( 'allpagessubmit' ) ) .
316 Xml
::closeElement( 'form' ) . "\n";
321 /** Set the namespace we are filtering on */
322 private function setNamespace( $ns ) {
323 $this->namespace = $ns;