* Don't put _ into the title in the form
[lhc/web/wiklou.git] / includes / SpecialWhatlinkshere.php
index bbdd74b..881510c 100644 (file)
@@ -1,8 +1,7 @@
 <?php
 /**
  *
- * @package MediaWiki
- * @subpackage SpecialPage
+ * @addtogroup SpecialPage
  */
 
 /**
@@ -15,53 +14,55 @@ function wfSpecialWhatlinkshere($par = NULL) {
        $page->execute();
 }
 
+/**
+ * implements Special:Whatlinkshere
+ * @addtogroup SpecialPage
+ */
 class WhatLinksHerePage {
        var $request, $par;
-       var $limit, $from, $dir, $target;
+       var $limit, $from, $back, $target;
        var $selfTitle, $skin;
-       
+
+       private $namespace;
+
        function WhatLinksHerePage( &$request, $par = null ) {
                global $wgUser;
                $this->request =& $request;
-               $this->skin =& $wgUser->getSkin();
+               $this->skin = $wgUser->getSkin();
                $this->par = $par;
        }
 
        function execute() {
-               global $wgUser, $wgOut;
-               
+               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';
-               }
-               
+               $this->back = $this->request->getInt( 'back' );
+
                $targetString = isset($this->par) ? $this->par : $this->request->getVal( 'target' );
 
-               if (is_null($targetString)) {
-                       $wgOut->errorpage( 'notargettitle', 'notargettext' );
+               if ( is_null( $targetString ) ) {
+                       $wgOut->addHTML( $this->whatlinkshereForm() );
                        return;
                }
 
                $this->target = Title::newFromURL( $targetString );
                if( !$this->target ) {
-                       $wgOut->errorpage( 'notargettitle', 'notargettext' );
+                       $wgOut->addHTML( $this->whatlinkshereForm() );
                        return;
                }
-               $this->selfTitle = Title::makeTitleSafe( NS_SPECIAL, 
+               $this->selfTitle = Title::makeTitleSafe( NS_SPECIAL,
                        'Whatlinkshere/' . $this->target->getPrefixedDBkey() );
-               $wgOut->setPagetitle( $this->target->getPrefixedText() );
-               $wgOut->setSubtitle( wfMsg( 'linklistsub' ) );
 
-               $isredir = ' (' . wfMsg( 'isredirect' ) . ")\n";
+               $wgOut->setPageTitle( wfMsg( 'whatlinkshere-title', $this->target->getPrefixedText() ) );
+               $wgOut->setSubtitle( wfMsg( 'linklistsub' ) );
 
-               $wgOut->addHTML('&lt; '.$this->skin->makeLinkObj($this->target, '', 'redirect=no' )."<br />\n");
+               $wgOut->addHTML( wfMsg( 'whatlinkshere-barrow' ) . ' '  .$this->skin->makeLinkObj($this->target, '', 'redirect=no' )."<br />\n");
 
-               $this->showIndirectLinks( 0, $this->target, $this->limit, $this->from, $this->dir );
+               $this->showIndirectLinks( 0, $this->target, $this->limit, $this->from, $this->back );
        }
 
        /**
@@ -69,72 +70,96 @@ class WhatLinksHerePage {
         * @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
-        * @access private
+        * @param Title     $back       Display from this article ID at backwards scrolling
+        * @private
         */
-       function showIndirectLinks( $level, $target, $limit, $from = 0, $dir = 'next' ) {
-               global $wgOut, $wgUser;
+       function showIndirectLinks( $level, $target, $limit, $from = 0, $back = 0 ) {
+               global $wgOut;
                $fname = 'WhatLinksHerePage::showIndirectLinks';
+               $dbr = wfGetDB( DB_READ );
+               $options = array();
 
-               $dbr =& wfGetDB( DB_READ );
-               
-               extract( $dbr->tableNames( 'pagelinks', 'templatelinks', 'page' ) );
-
-               // Some extra validation
-               $from = intval( $from );
-               if ( !$from && $dir == 'prev' ) {
-                       // Before start? No make sense
-                       $dir = 'next';
+               $ns = $this->request->getIntOrNull( 'namespace' );
+               if ( isset( $ns ) ) {
+                       $options['namespace'] = $ns;
+                       $this->setNamespace( $options['namespace'] );
+               } else {
+                       $options['namespace'] = '';
                }
-               
+
                // Make the query
-               $plConds = array( 
+               $plConds = array(
                        'page_id=pl_from',
                        'pl_namespace' => $target->getNamespace(),
                        'pl_title' => $target->getDBkey(),
                );
-               
-               $tlConds = array( 
+
+               $tlConds = array(
                        'page_id=tl_from',
                        'tl_namespace' => $target->getNamespace(),
                        'tl_title' => $target->getDBkey(),
                );
-                       
-               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' );
+
+               if ( $this->namespace !== null ){
+                       $plConds['page_namespace'] = (int)$this->namespace;
+                       $tlConds['page_namespace'] = (int)$this->namespace;
                }
+
+               if ( $from ) {
+                       $from = (int)$from; // just in case
+                       $tlConds[] = "tl_from >= $from";
+                       $plConds[] = "pl_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, 
+
+               $options['ORDER BY'] = 'pl_from';
+               $plRes = $dbr->select( array( 'pagelinks', 'page' ), $fields,
                        $plConds, $fname, $options );
-               $tlRes = $dbr->select( array( 'templatelinks', 'page' ), $fields, 
+
+               $options['ORDER BY'] = 'tl_from';
+               $tlRes = $dbr->select( array( 'templatelinks', 'page' ), $fields,
                        $tlConds, $fname, $options );
-               
+
                if ( !$dbr->numRows( $plRes ) && !$dbr->numRows( $tlRes ) ) {
                        if ( 0 == $level ) {
-                               $wgOut->addWikiText( wfMsg( 'nolinkshere' ) );
+                               $options = array(); // reinitialize for a further namespace search
+                               // really no links to here
+                               $options['namespace'] = $this->namespace;
+                               $options['target'] = $this->target->getPrefixedText();
+                               list( $options['limit'], $options['offset']) = wfCheckLimits();
+                               $wgOut->addHTML( $this->whatlinkshereForm( $options ) );
+                               $errMsg = isset( $this->namespace ) ? 'nolinkshere-ns' : 'nolinkshere';
+                               $wgOut->addWikiText( wfMsg( $errMsg, $this->target->getPrefixedText() ) );
                        }
                        return;
-               }               
+               }
+
+               $options = array();
+               list( $options['limit'], $options['offset']) = wfCheckLimits();
+               if ( ( $ns = $this->request->getVal( 'namespace', null ) ) !== null && $ns !== '' && ctype_digit($ns) ) {
+                       $options['namespace'] = intval( $ns );
+                       $this->setNamespace( $options['namespace'] );
+               } else {
+                       $options['namespace'] = '';
+                       $this->setNamespace( null );
+               }
+               $options['offset'] = $this->request->getVal( 'offset' );
+               /* Offset must be an integral. */
+               if ( !strlen( $options['offset'] ) || !preg_match( '/^[0-9]+$/', $options['offset'] ) )
+               $options['offset'] = '';
+               $options['target'] = $this->target->getPrefixedText();
 
                // Read the rows into an array and remove duplicates
-               // templatelinks comes second so that the templatelinks row overwrites the 
+               // 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;
@@ -150,53 +175,34 @@ class WhatLinksHerePage {
                // Sort by key and then change the keys to 0-based indices
                ksort( $rows );
                $rows = array_values( $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;
                }
-               
-               if ( 0 == $level ) {
-                       $wgOut->addWikiText( wfMsg( 'linkshere' ) );
+               $prevId = $from;
+
+               if ( $level == 0 ) {
+                       $wgOut->addHTML( $this->whatlinkshereForm( $options ) );
+                       $wgOut->addWikiText( wfMsg( 'linkshere', $this->target->getPrefixedText() ) );
                }
                $isredir = wfMsg( 'isredirect' );
                $istemplate = wfMsg( 'istemplate' );
-               
+
                if( $level == 0 ) {
-                       $prevnext = $this->getPrevNext( $limit, $prevId, $nextId );
+                       $prevnext = $this->getPrevNext( $limit, $prevId, $nextId, $options['namespace'] );
                        $wgOut->addHTML( $prevnext );
                }
-               
+
                $wgOut->addHTML( '<ul>' );
                foreach ( $rows as $row ) {
                        $nt = Title::makeTitle( $row->page_namespace, $row->page_title );
@@ -222,6 +228,14 @@ class WhatLinksHerePage {
                                // FIXME? Cultural assumption, hard-coded punctuation
                                $wgOut->addHTML( ' (' . implode( ', ', $props ) . ') ' );
                        }
+
+                       # Space for utilities links, with a what-links-here link provided
+                       $wlh = $this->skin->makeKnownLinkObj(
+                               SpecialPage::getTitleFor( 'Whatlinkshere' ),
+                               wfMsgHtml( 'whatlinkshere-links' ),
+                               'target=' . $nt->getPrefixedUrl()
+                       );
+                       $wgOut->addHtml( ' <span class="mw-whatlinkshere-tools">(' . $wlh . ')</span>' );                       
                        
                        if ( $row->page_is_redirect ) {
                                if ( $level < 2 ) {
@@ -231,7 +245,7 @@ class WhatLinksHerePage {
                        $wgOut->addHTML( "</li>\n" );
                }
                $wgOut->addHTML( "</ul>\n" );
-               
+
                if( $level == 0 ) {
                        $wgOut->addHTML( $prevnext );
                }
@@ -244,16 +258,21 @@ class WhatLinksHerePage {
        function getPrevNext( $limit, $prevId, $nextId ) {
                global $wgLang;
                $fmtLimit = $wgLang->formatNum( $limit );
-               $prev = wfMsg( 'prevn', $fmtLimit );
-               $next = wfMsg( 'nextn', $fmtLimit );
+               $prev = wfMsgExt( 'whatlinkshere-prev', array( 'parsemag', 'escape' ), $fmtLimit );
+               $next = wfMsgExt( 'whatlinkshere-next', array( 'parsemag', 'escape' ), $fmtLimit );
+
+               $nsText = '';
+               if( is_int($this->namespace) ) {
+                       $nsText = "&namespace={$this->namespace}";
+               }
 
                if ( 0 != $prevId ) {
-                       $prevLink = $this->makeSelfLink( $prev, "limit={$limit}&from={$prevId}&dir=prev" );
-               } else { 
-                       $prevLink = $prev; 
+                       $prevLink = $this->makeSelfLink( $prev, "limit={$limit}&from={$this->back}{$nsText}" );
+               } else {
+                       $prevLink = $prev;
                }
                if ( 0 != $nextId ) {
-                       $nextLink = $this->makeSelfLink( $next, "limit={$limit}&from={$nextId}" );
+                       $nextLink = $this->makeSelfLink( $next, "limit={$limit}&from={$nextId}&back={$prevId}{$nsText}" );
                } else {
                        $nextLink = $next;
                }
@@ -266,12 +285,42 @@ class WhatLinksHerePage {
                return wfMsg( 'viewprevnext', $prevLink, $nextLink, $nums );
        }
 
-       function numLink( $limit, $from ) {
+       function numLink( $limit, $from, $ns = null ) {
                global $wgLang;
                $query = "limit={$limit}&from={$from}";
+               if( is_int($this->namespace) ) { $query .= "&namespace={$this->namespace}";}
                $fmtLimit = $wgLang->formatNum( $limit );
                return $this->makeSelfLink( $fmtLimit, $query );
        }
-}
 
-?>
+       function whatlinkshereForm( $options = array( 'target' => '', 'namespace' => '' ) ) {
+               global $wgScript, $wgTitle;
+
+               $options['title'] = $wgTitle->getPrefixedText();
+
+               $f = Xml::openElement( 'form', array( 'method' => 'get', 'action' => $wgScript ) ) .
+                       Xml::openElement( 'fieldset' ) .
+                       Xml::element( 'legend', array(), wfMsg( 'whatlinkshere' ) ) .
+                       Xml::inputLabel( wfMsg( 'whatlinkshere-page' ), 'target', 'mw-whatlinkshere-target', 40, $options['target'] ) . ' ';
+
+               foreach ( $options as $name => $value ) {
+                       if( $name === 'namespace' || $name === 'target' )
+                               continue;
+                       $f .= "\t" . Xml::hidden( $name, $value ). "\n";
+               }
+
+               $f .= Xml::label( wfMsg( 'namespace' ), 'namespace' ) . ' ' .
+                       Xml::namespaceSelector( $options['namespace'], '' ) .
+                       Xml::submitButton( wfMsg( 'allpagessubmit' ) ) .
+                       Xml::closeElement( 'fieldset' ) .
+                       Xml::closeElement( 'form' ) . "\n";
+
+               return $f;
+       }
+
+       /** Set the namespace we are filtering on */
+       private function setNamespace( $ns ) {
+               $this->namespace = $ns;
+       }
+
+}