Move this till after ID set
[lhc/web/wiklou.git] / includes / SpecialWhatlinkshere.php
index 711290b..e72f55a 100644 (file)
@@ -1,12 +1,14 @@
 <?php
 /**
+ * @todo Use some variant of Pager or something; the pagination here is lousy.
  *
- * @addtogroup SpecialPage
+ * @file
+ * @ingroup SpecialPage
  */
 
 /**
  * Entry point
- * @param string $par An article name ??
+ * @param $par String: An article name ??
  */
 function wfSpecialWhatlinkshere($par = NULL) {
        global $wgRequest;
@@ -16,15 +18,19 @@ function wfSpecialWhatlinkshere($par = NULL) {
 
 /**
  * implements Special:Whatlinkshere
- * @addtogroup SpecialPage
+ * @ingroup SpecialPage
  */
 class WhatLinksHerePage {
-       var $request, $par;
-       var $limit, $from, $back, $target;
-       var $selfTitle, $skin;
-       var $hideredirs, $hidetrans, $hidelinks, $fetchlinks;
+       // Stored data
+       protected $par;
 
-       private $namespace;
+       // 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;
@@ -36,39 +42,44 @@ class WhatLinksHerePage {
        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->back = $this->request->getInt( 'back' );
+               $opts = new FormOptions();
 
-               $this->hideredirs = $this->request->getInt( 'hideredirs' );
-               $this->hidetrans = $this->request->getInt( 'hidetrans' );
-               $this->hidelinks = $this->request->getInt( 'hidelinks' );
-               $this->fetchlinks = !$this->hidelinks || !$this->hideredirs;
+               $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 );
 
-               $targetString = isset($this->par) ? $this->par : $this->request->getVal( 'target' );
+               $opts->fetchValuesFromRequest( $this->request );
+               $opts->validateIntBounds( 'limit', 0, 5000 );
 
-               if ( is_null( $targetString ) ) {
-                       $wgOut->addHTML( $this->whatlinkshereForm() );
-                       return;
+               // 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->addHTML( $this->whatlinkshereForm() );
                        return;
                }
-               $this->selfTitle = Title::makeTitleSafe( NS_SPECIAL,
-                       'Whatlinkshere/' . $this->target->getPrefixedDBkey() );
 
-               $wgOut->setPageTitle( wfMsg( 'whatlinkshere-title', $this->target->getPrefixedText() ) );
-               $wgOut->setSubtitle( wfMsg( 'linklistsub' ) );
+               $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, $this->limit, $this->from, $this->back );
+               $this->showIndirectLinks( 0, $this->target, $opts->getValue( 'limit' ),
+                       $opts->getValue( 'from' ), $opts->getValue( 'back' ) );
        }
 
        /**
@@ -81,17 +92,15 @@ class WhatLinksHerePage {
         */
        function showIndirectLinks( $level, $target, $limit, $from = 0, $back = 0 ) {
                global $wgOut, $wgMaxRedirectLinksRetrieved;
-               $fname = 'WhatLinksHerePage::showIndirectLinks';
                $dbr = wfGetDB( DB_SLAVE );
                $options = array();
 
-               $ns = $this->request->getIntOrNull( 'namespace' );
-               if ( isset( $ns ) ) {
-                       $options['namespace'] = $ns;
-                       $this->setNamespace( $options['namespace'] );
-               } else {
-                       $options['namespace'] = '';
-               }
+               $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(
@@ -99,6 +108,11 @@ class WhatLinksHerePage {
                        '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',
@@ -106,89 +120,91 @@ class WhatLinksHerePage {
                        'tl_title' => $target->getDBkey(),
                );
 
-               if ( $this->namespace !== null ){
-                       $plConds['page_namespace'] = (int)$this->namespace;
-                       $tlConds['page_namespace'] = (int)$this->namespace;
+               $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 ) {
-                       $from = (int)$from; // just in case
                        $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 
+               // 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( $this->fetchlinks ) {
+               if( $fetchlinks ) {
                        $options['ORDER BY'] = 'pl_from';
                        $plRes = $dbr->select( array( 'pagelinks', 'page' ), $fields,
-                               $plConds, $fname, $options );
+                               $plConds, __METHOD__, $options );
                }
 
-               if( !$this->hidetrans ) {
+               if( !$hidetrans ) {
                        $options['ORDER BY'] = 'tl_from';
                        $tlRes = $dbr->select( array( 'templatelinks', 'page' ), $fields,
-                               $tlConds, $fname, $options );
+                               $tlConds, __METHOD__, $options );
+               }
+
+               if( !$hideimages ) {
+                       $options['ORDER BY'] = 'il_from';
+                       $ilRes = $dbr->select( array( 'imagelinks', 'page' ), $fields,
+                               $ilConds, __METHOD__, $options );
                }
 
-               if( ( !$this->fetchlinks || !$dbr->numRows( $plRes ) ) && ( $this->hidetrans || !$dbr->numRows( $tlRes ) ) ) {
+               if( ( !$fetchlinks || !$dbr->numRows($plRes) ) && ( $hidetrans || !$dbr->numRows($tlRes) ) && ( $hideimages || !$dbr->numRows($ilRes) ) ) {
                        if ( 0 == $level ) {
-                               $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->addHTML( $this->whatlinkshereForm() );
+                               $errMsg = is_int($namespace) ? 'nolinkshere-ns' : 'nolinkshere';
                                $wgOut->addWikiMsg( $errMsg, $this->target->getPrefixedText() );
                                // Show filters only if there are links
-                               if( $this->hidelinks || $this->hidetrans || $this->hideredirs )
+                               if( $hidelinks || $hidetrans || $hideredirs || $hideimages )
                                        $wgOut->addHTML( $this->getFilterPanel() );
                        }
                        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
                // pagelinks row, so we get (inclusion) rather than nothing
-               if( $this->fetchlinks ) {
+               if( $fetchlinks ) {
                        while ( $row = $dbr->fetchObject( $plRes ) ) {
                                $row->is_template = 0;
+                               $row->is_image = 0;
                                $rows[$row->page_id] = $row;
                        }
                        $dbr->freeResult( $plRes );
-                       
+
                }
-               if( !$this->hidetrans ) {
+               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 );
+               }
 
                // Sort by key and then change the keys to 0-based indices
                ksort( $rows );
@@ -210,150 +226,182 @@ class WhatLinksHerePage {
                $prevId = $from;
 
                if ( $level == 0 ) {
-                       $wgOut->addHTML( $this->whatlinkshereForm( $options ) );
+                       $wgOut->addHTML( $this->whatlinkshereForm() );
                        $wgOut->addHTML( $this->getFilterPanel() );
                        $wgOut->addWikiMsg( 'linkshere', $this->target->getPrefixedText() );
 
-                       $prevnext = $this->getPrevNext( $limit, $prevId, $nextId, $options['namespace'] );
+                       $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( $this->hideredirs && $row->page_is_redirect )
-                               continue;
-                       if( $this->hidelinks && ( !$row->page_is_redirect && !$row->is_template ) )
-                               continue;
-
-                       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[] = wfMsgHtml( 'isredirect' );
-                       }
-                       if ( $row->is_template ) {
-                               $props[] = wfMsgHtml( 'istemplate' );
-                       }
-                       if ( count( $props ) ) {
-                               $list = implode( wfMsgHtml( 'semicolon-separator' ), $props );
-                               $wgOut->addHTML( " ($list) " );
-                       }
+               if( $level == 0 ) {
+                       $wgOut->addHTML( $prevnext );
+               }
+       }
+
+       protected function listStart() {
+               return Xml::openElement( 'ul' );
+       }
 
-                       # 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 ) {
-                                       $this->showIndirectLinks( $level + 1, $nt, $wgMaxRedirectLinksRetrieved );
-                               }
+       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 );
+               $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 );
 
-               $nsText = '';
-               if( is_int($this->namespace) ) {
-                       $nsText = "&namespace={$this->namespace}";
-               }
+               $changed = $this->opts->getChangedValues();
+               unset($changed['target']); // Already in the request title
 
                if ( 0 != $prevId ) {
-                       $prevLink = $this->makeSelfLink( $prev, "limit={$limit}&from={$this->back}{$nsText}" );
-               } 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}&back={$prevId}{$nsText}" );
-               } else {
-                       $nextLink = $next;
+                       $overrides = array( 'from' => $nextId, 'back' => $prevId );
+                       $next = $this->makeSelfLink( $next, 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 wfMsgHtml( 'viewprevnext', $prevLink, $nextLink, $nums );
-       }
+               $limitLinks = array();
+               foreach ( $this->limits as $limit ) {
+                       $prettyLimit = $wgLang->formatNum( $limit );
+                       $overrides = array( 'limit' => $limit );
+                       $limitLinks[] = $this->makeSelfLink( $prettyLimit, wfArrayToCGI( $overrides, $changed ) );
+               }
 
-       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 );
+               $nums = implode ( ' | ', $limitLinks );
+
+               return wfMsgHtml( 'viewprevnext', $prev, $next, $nums );
        }
 
-       function whatlinkshereForm( $options = array( 'target' => '', 'namespace' => '' ) ) {
+       function whatlinkshereForm() {
                global $wgScript, $wgTitle;
 
-               $options['title'] = $wgTitle->getPrefixedText();
+               // 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::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'] ) . ' ';
+               $f .= Xml::fieldset( wfMsg( 'whatlinkshere' ) );
 
-               foreach ( $options as $name => $value ) {
-                       if( $name === 'namespace' || $name === 'target' )
-                               continue;
-                       $f .= "\t" . Xml::hidden( $name, $value ). "\n";
-               }
+               # Target input
+               $f .= Xml::inputLabel( wfMsg( 'whatlinkshere-page' ), 'target',
+                               'mw-whatlinkshere-target', 40, $target );
 
-               $f .= Xml::label( wfMsg( 'namespace' ), 'namespace' ) . ' ' .
-                       Xml::namespaceSelector( $options['namespace'], '' ) .
-                       Xml::submitButton( wfMsg( 'allpagessubmit' ) ) .
-                       Xml::closeElement( 'fieldset' ) .
-                       Xml::closeElement( 'form' ) . "\n";
+               $f .= ' ';
 
-               return $f;
-       }
+               # Namespace selector
+               $f .= Xml::label( wfMsg( 'namespace' ), 'namespace' ) . '&nbsp;' .
+                       Xml::namespaceSelector( $namespace, '' );
+
+               # Submit
+               $f .= Xml::submitButton( wfMsg( 'allpagessubmit' ) );
 
-       /** Set the namespace we are filtering on */
-       private function setNamespace( $ns ) {
-               $this->namespace = $ns;
+               # 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();
-               foreach( array( 'hidetrans', 'hidelinks', 'hideredirs' ) as $type ) {
-                       $chosen = $this->$type;
+               $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 );
-                       $url = $this->request->appendQueryValue( $type, intval( !$chosen ), true );
-                       $links[] = $this->makeSelfLink( $msg, $url );
+                       $overrides = array( $type => !$chosen );
+                       $links[] = $this->makeSelfLink( $msg, wfArrayToCGI( $overrides, $changed ) );
                }
-               return '<p>' . implode( '&nbsp;|&nbsp;', $links ) . '</p>';
+               return Xml::fieldset( wfMsg( 'whatlinkshere-filters' ), implode( '&nbsp;|&nbsp;', $links ) );
        }
-
 }