Add the other existing $skin.css/.js to the message files too to be consistent
[lhc/web/wiklou.git] / includes / SpecialWhatlinkshere.php
index b0c925a..a57df5e 100644 (file)
 <?php
 /**
+ * @todo Use some variant of Pager or something; the pagination here is lousy.
  *
+ * @file
+ * @ingroup SpecialPage
  */
 
 /**
- *
+ * Entry point
+ * @param $par String: An article name ??
  */
 function wfSpecialWhatlinkshere($par = NULL) {
-       global $wgUser, $wgOut, $wgRequest;
-       $fname = "wfSpecialWhatlinkshere";
-
-       $target = $wgRequest->getVal( 'target' );
-       $limit = $wgRequest->getInt( 'limit', 500 );
-       
-       if(!empty($par)) {
-               $target = $par;
-       } else if ( is_null( $target ) ) {
-               $wgOut->errorpage( "notargettitle", "notargettext" );
-               return;
+       global $wgRequest;
+       $page = new WhatLinksHerePage( $wgRequest, $par );
+       $page->execute();
+}
+
+/**
+ * implements Special:Whatlinkshere
+ * @ingroup SpecialPage
+ */
+class WhatLinksHerePage {
+       // Stored data
+       protected $par;
+
+       // Stored objects
+       protected $opts, $target, $selfTitle;
+
+       // 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->par = $par;
        }
 
-       $nt = Title::newFromURL( $target );
-       if( !$nt ) {
-               $wgOut->errorpage( "notargettitle", "notargettext" );
-               return;
+       function execute() {
+               global $wgOut;
+
+               $opts = new FormOptions();
+
+               $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 );
+
+               $opts->fetchValuesFromRequest( $this->request );
+               $opts->validateIntBounds( 'limit', 0, 5000 );
+
+               // Give precedence to subpage syntax
+               if ( isset($this->par) ) {
+                       $opts->setValue( 'target', $this->par );
+               }
+
+               // Bind to member variable
+               $this->opts = $opts;
+
+               $this->target = Title::newFromURL( $opts->getValue( 'target' ) );
+               if( !$this->target ) {
+                       $wgOut->addHTML( $this->whatlinkshereForm() );
+                       return;
+               }
+
+               $this->selfTitle = SpecialPage::getTitleFor( 'Whatlinkshere', $this->target->getPrefixedDBkey() );
+
+               $wgOut->setPageTitle( wfMsgExt( 'whatlinkshere-title', 'escape', $this->target->getPrefixedText() ) );
+               $wgOut->setSubtitle( wfMsgHtml( 'linklistsub' ) );
+
+               $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' ) );
        }
-       $wgOut->setPagetitle( $nt->getPrefixedText() );
-       $wgOut->setSubtitle( wfMsg( "linklistsub" ) );
 
-       $id = $nt->getArticleID();
-       $sk = $wgUser->getSkin();
-       $isredir = " (" . wfMsg( "isredirect" ) . ")\n";
+       /**
+        * @param $level  int     Recursion level
+        * @param $target Title   Target title
+        * @param $limit  int     Number of entries to display
+        * @param $from   Title   Display from this article ID
+        * @param $back   Title   Display from this article ID at backwards scrolling
+        * @private
+        */
+       function showIndirectLinks( $level, $target, $limit, $from = 0, $back = 0 ) {
+               global $wgOut, $wgMaxRedirectLinksRetrieved;
+               $dbr = wfGetDB( DB_SLAVE );
+               $options = array();
+
+               $hidelinks = $this->opts->getValue( 'hidelinks' );
+               $hideredirs = $this->opts->getValue( 'hideredirs' );
+               $hidetrans = $this->opts->getValue( 'hidetrans' );
+               $hideimages = $target->getNamespace() != NS_IMAGE || $this->opts->getValue( 'hideimages' );
+
+               $fetchlinks = (!$hidelinks || !$hideredirs);
+
+               // Make the query
+               $plConds = array(
+                       'page_id=pl_from',
+                       '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_namespace' => $target->getNamespace(),
+                       '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;
+                       $ilConds['page_namespace'] = $namespace;
+               }
+
+               if ( $from ) {
+                       $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;
+               $fields = array( 'page_id', 'page_namespace', 'page_title', 'page_is_redirect' );
+
+               if( $fetchlinks ) {
+                       $options['ORDER BY'] = 'pl_from';
+                       $plRes = $dbr->select( array( 'pagelinks', 'page' ), $fields,
+                               $plConds, __METHOD__, $options );
+               }
+
+               if( !$hidetrans ) {
+                       $options['ORDER BY'] = 'tl_from';
+                       $tlRes = $dbr->select( array( 'templatelinks', 'page' ), $fields,
+                               $tlConds, __METHOD__, $options );
+               }
 
-       $wgOut->addHTML("&lt; ".$sk->makeKnownLinkObj($nt, "", "redirect=no" )."<br />\n");
-       $dbr =& wfGetDB( DB_SLAVE );
-       extract( $dbr->tableNames( 'cur', 'brokenlinks', 'links' ) );
+               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->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
+               if( $fetchlinks ) {
+                       while ( $row = $dbr->fetchObject( $plRes ) ) {
+                               $row->is_template = 0;
+                               $row->is_image = 0;
+                               $rows[$row->page_id] = $row;
+                       }
+                       $dbr->freeResult( $plRes );
+
+               }
+               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 );
+               }
 
-       if ( 0 == $id ) {
-               $sql = "SELECT cur_id,cur_namespace,cur_title,cur_is_redirect FROM $brokenlinks,$cur WHERE bl_to='" .
-                 $dbr->strencode( $nt->getPrefixedDBkey() ) . "' AND bl_from=cur_id LIMIT $limit";
-               $res = $dbr->query( $sql, $fname );
+               // Sort by key and then change the keys to 0-based indices
+               ksort( $rows );
+               $rows = array_values( $rows );
 
-               if ( 0 == $dbr->numRows( $res ) ) {
-                       $wgOut->addHTML( wfMsg( "nolinkshere" ) );
+               $numRows = count( $rows );
+
+               // Work out the start and end IDs, for prev/next links
+               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 {
-                       $wgOut->addHTML( wfMsg( "linkshere" ) );
-                       $wgOut->addHTML( "\n<ul>" );
-
-                       while ( $row = $dbr->fetchObject( $res ) ) {
-                               $nt = Title::makeTitle( $row->cur_namespace, $row->cur_title );
-                               if( !$nt ) {
-                                       continue;
-                               }
-                               $link = $sk->makeKnownLinkObj( $nt, "", "redirect=no" );
-                               $wgOut->addHTML( "<li>{$link}" );
-
-                               if ( $row->cur_is_redirect ) {
-                                       $wgOut->addHTML( $isredir );
-                                       wfShowIndirectLinks( 1, $row->cur_id, $limit );
-                               }
-                               $wgOut->addHTML( "</li>\n" );
+                       // No more rows after
+                       $nextId = false;
+               }
+               $prevId = $from;
+
+               if ( $level == 0 ) {
+                       $wgOut->addHTML( $this->whatlinkshereForm() );
+                       $wgOut->addHTML( $this->getFilterPanel() );
+                       $wgOut->addWikiMsg( 'linkshere', $this->target->getPrefixedText() );
+
+                       $prevnext = $this->getPrevNext( $prevId, $nextId );
+                       $wgOut->addHTML( $prevnext );
+               }
+
+               $wgOut->addHTML( $this->listStart() );
+               foreach ( $rows as $row ) {
+                       $nt = Title::makeTitle( $row->page_namespace, $row->page_title );
+
+                       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 {
+                               $wgOut->addHTML( $this->listItem( $row, $nt ) );
                        }
-                       $wgOut->addHTML( "</ul>\n" );
-                       $dbr->freeResult( $res );
                }
-       } else {
-               wfShowIndirectLinks( 0, $id, $limit );
+
+               $wgOut->addHTML( $this->listEnd() );
+
+               if( $level == 0 ) {
+                       $wgOut->addHTML( $prevnext );
+               }
        }
-}
 
-/**
- *
- */
-function wfShowIndirectLinks( $level, $lid, $limit ) {
-       global $wgOut, $wgUser;
-       $fname = "wfShowIndirectLinks";
+       protected function listStart() {
+               return Xml::openElement( 'ul' );
+       }
+
+       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 );
+                       }
+               }
 
-       $dbr =& wfGetDB( DB_READ );
-       extract( $dbr->tableNames( 'links','cur' ) );
+               $suppressRedirect = $row->page_is_redirect ? 'redirect=no' : '';
+               $link = $this->skin->makeKnownLinkObj( $nt, '', $suppressRedirect );
 
-       $sql = "SELECT cur_id,cur_namespace,cur_title,cur_is_redirect FROM $links,$cur WHERE l_to={$lid} AND l_from=cur_id LIMIT $limit";
-       $res = $dbr->query( $sql, $fname );
+               // 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 ( 0 == $dbr->numRows( $res ) ) {
-               if ( 0 == $level ) {
-                       $wgOut->addHTML( wfMsg( "nolinkshere" ) );
+               if ( count( $props ) ) {
+                       $propsText = '(' . implode( $msgcache['semicolon-separator'], $props ) . ')';
                }
-               return;
+
+               # 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' );
        }
-       if ( 0 == $level ) {
-               $wgOut->addHTML( wfMsg( "linkshere" ) );
+
+       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 );
        }
-       $sk = $wgUser->getSkin();
-       $isredir = " (" . wfMsg( "isredirect" ) . ")\n";
 
-       $wgOut->addHTML( "<ul>" );
-       while ( $row = $dbr->fetchObject( $res ) ) {
-               $nt = Title::makeTitle( $row->cur_namespace, $row->cur_title );
-               if( !$nt ) {
-                       $wgOut->addHTML( "<!-- bad backlink: " . htmlspecialchars( $row->l_from ) . " -->\n" );
-                       continue;
+       function makeSelfLink( $text, $query ) {
+               return $this->skin->makeKnownLinkObj( $this->selfTitle, $text, $query );
+       }
+
+       function getPrevNext( $prevId, $nextId ) {
+               global $wgLang;
+               $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 ) {
+                       $overrides = array( 'from' => $this->opts->getValue( 'back' ) );
+                       $prev = $this->makeSelfLink( $prev, wfArrayToCGI( $overrides, $changed ) );
+               }
+               if ( 0 != $nextId ) {
+                       $overrides = array( 'from' => $nextId, 'back' => $prevId );
+                       $next = $this->makeSelfLink( $next, wfArrayToCGI( $overrides, $changed ) );
                }
 
-               if ( $row->cur_is_redirect ) {
-                       $extra = "redirect=no";
-               } else {
-                       $extra = "";
+               $limitLinks = array();
+               foreach ( $this->limits as $limit ) {
+                       $prettyLimit = $wgLang->formatNum( $limit );
+                       $overrides = array( 'limit' => $limit );
+                       $limitLinks[] = $this->makeSelfLink( $prettyLimit, wfArrayToCGI( $overrides, $changed ) );
                }
 
-               $link = $sk->makeKnownLinkObj( $nt, "", $extra );
-               $wgOut->addHTML( "<li>{$link}" );
+               $nums = implode ( ' | ', $limitLinks );
 
-               if ( $row->cur_is_redirect ) {
-                       $wgOut->addHTML( $isredir );
-                       if ( $level < 2 ) {
-                               wfShowIndirectLinks( $level + 1, $row->cur_id, $limit );
-                       }
+               return wfMsgHtml( 'viewprevnext', $prev, $next, $nums );
+       }
+
+       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' ) . '&nbsp;' .
+                       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 ) );
                }
-               $wgOut->addHTML( "</li>\n" );
+               return Xml::fieldset( wfMsg( 'whatlinkshere-filters' ), implode( '&nbsp;|&nbsp;', $links ) );
        }
-       $wgOut->addHTML( "</ul>\n" );
 }
-
-?>