* Added a versionRequired() function to OutputPage, useful for extension
[lhc/web/wiklou.git] / includes / SpecialAllpages.php
index 177df31..4c704e3 100644 (file)
 <?php
+/**
+ * @package MediaWiki
+ * @subpackage SpecialPage
+ */
 
-function wfSpecialAllpages( $par=NULL )
-{
-       global $indexMaxperpage, $wgRequest;
+/**
+ * Entry point : initialise variables and call subfunctions.
+ * @param string $par Becomes "FOO" when called like Special:Allpages/FOO (default NULL)
+ */
+function wfSpecialAllpages( $par=NULL, $specialPage ) {
+       global $indexMaxperpage, $toplevelMaxperpage, $wgRequest, $wgOut, $wgContLang;
+       # Config
        $indexMaxperpage = 480;
+       $toplevelMaxperpage = 50;
+       # GET values
        $from = $wgRequest->getVal( 'from' );
-       $namespace = $wgRequest->getVal( 'namespace' );
-       if ( is_null($namespace) ) { $namespace = 0; }
+       $namespace = $wgRequest->getInt( 'namespace' );
+       $invert = $wgRequest->getBool( 'invert' );
+       
+       $namespaces = $wgContLang->getNamespaces();
 
-       if( $par ) {
-               indexShowChunk( $par, $namespace );
-       } elseif( !is_null( $from ) ) {
-               indexShowChunk( $from, $namespace );
+       if( !in_array($namespace, array_keys($namespaces)) )
+               $namespace = 0;
+
+       if ($invert) {
+               $wgOut->setPagetitle( $namespace > 0 ?
+                       wfMsg( 'allnotinnamespace', $namespaces[$namespace] ) :
+                       wfMsg( 'allnonarticles' )
+                       );
+       } else {
+               $wgOut->setPagetitle( $namespace > 0 ?
+                       wfMsg( 'allinnamespace', $namespaces[$namespace] ) :
+                       wfMsg( 'allarticles' )
+                       );
+       }
+       
+       if ( isset($par) ) {
+               indexShowChunk( $namespace, $par, $invert, $specialPage->including() );
+       } elseif ( isset($from) ) {
+               indexShowChunk( $namespace, $from, $invert, $specialPage->including() );
        } else {
-               indexShowToplevel();
+               indexShowToplevel ( $namespace, $invert, $specialPage->including() );
        }
 }
 
-function indexShowToplevel()
-{
-       global $wgOut, $indexMaxperpage, $wgLang;
-       $fname = "indexShowToplevel";
-
-       # Cache
-       $vsp = $wgLang->getValidSpecialPages();
-       $log = new LogPage( $vsp["Allpages"] );
-       $log->mUpdateRecentChanges = false;
+/**
+ * HTML for the top form
+ * @param integer $namespace A namespace constant (default NS_MAIN).
+ * @param string $from Article name we are starting listing at.
+ * @param bool $invert true if we want the namespaces inverted (default false)
+ */
+function indexNamespaceForm ( $namespace = NS_MAIN, $from = '', $invert = false ) {
+       global $wgContLang, $wgScript;
+       $t = Title::makeTitle( NS_SPECIAL, "Allpages" );
 
-       global $wgMiserMode;
-       if ( $wgMiserMode ) {
-               $log->showAsDisabledPage();
-               return;
+       $namespaceselect = "<select name='namespace' id='nsselectbox'>";
+       $arr = $wgContLang->getFormattedNamespaces();
+       foreach ( $arr as $ns => $name ) {
+               if ($ns < NS_MAIN)
+                       continue;
+               $n = $ns == 0 ? wfMsg ( 'blanknamespace' ) : $name;
+               $sel = $ns == $namespace ? ' selected="selected"' : '';
+               $namespaceselect .= "<option value='$ns'$sel>$n</option>";      
        }
+       $namespaceselect .= '</select>';
+
+       $frombox = "<input type='text' size='20' name='from' id='nsfrom' value=\""
+                   . htmlspecialchars ( $from ) . '"/>';
+       $submitbutton = '<input type="submit" value="' . wfMsg( 'allpagessubmit' ) . '" />';
+       
+       $invertbox = "<input type='checkbox' name='invert' value='1' id='nsinvert'" . ( $invert ? ' checked="checked"' : '' ) . ' />';
+
+       $out = "<div class='namespaceselector'><form method='get' action='{$wgScript}'>";
+       $out .= '<input type="hidden" name="title" value="'.$t->getPrefixedText().'" />';
+       $out .= "
+<table id='nsselect' class='allpages'>
+       <tr>
+               <td align='right'>" . wfMsg('allpagesfrom') . "</td>
+               <td align='left'><label for='nsfrom'>$frombox</label></td>
+       </tr>
+       <tr>    
+               <td align='right'><label for='nsselectbox'>" . wfMsg('namespace') . "</label></td>
+               <td align='left'>
+                       $namespaceselect $submitbutton $invertbox
+                       <label for='nsinvert'>" . wfMsg('invert') . "</label>
+               </td>
+       </tr>
+</table>
+";
+       $out .= '</form></div>';
+               return $out;
+}
+
+/**
+ * @param integer $namespace (default NS_MAIN)
+ * @param bool $invert true if we want the namespaces inverted (default false)
+ */
+function indexShowToplevel ( $namespace = NS_MAIN, $invert = false,  $including = false ) {
+       global $wgOut, $indexMaxperpage, $toplevelMaxperpage, $wgContLang, $wgRequest, $wgUser;
+       $sk = $wgUser->getSkin();
+       $fname = "indexShowToplevel";
+
+       # TODO: Either make this *much* faster or cache the title index points
+       # in the querycache table.
 
        $dbr =& wfGetDB( DB_SLAVE );
-       $cur = $dbr->tableName( 'cur' );
-       $fromwhere = "FROM $cur WHERE cur_namespace=0";
-       $order = 'ORDER BY cur_title';
+       $page = $dbr->tableName( 'page' );
+       $fromwhere = "FROM $page WHERE page_namespace" .
+       ($invert ? '!' : '') . "=$namespace";
+       $order_arr = array ( 'ORDER BY' => 'page_title' );
+       $order_str = 'ORDER BY page_title';
        $out = "";
-       $where = array( 'cur_namespace' => 0 );
+       $where = array( 'page_namespace' => $namespace );
 
-       $count = $dbr->selectField( 'cur', 'COUNT(*)', $where, $fname );
+       $count = $dbr->selectField( 'page', 'COUNT(*)', $where, $fname );
        $sections = ceil( $count / $indexMaxperpage );
-       $inpoint = $dbr->selectField( 'cur', 'cur_title', $where, $fname, $order );
+       
+       if ( $sections < 3 ) {
+               # If there are only two or less sections, don't even display them.
+               # Instead, display the first section directly.
+               indexShowChunk( $namespace, '', $invert, $including );
+               return;
+       }
 
-       $out .= "<table>\n";
-       # There's got to be a cleaner way to do this!
-       for( $i = 1; $i < $sections; $i++ ) {
-               $from = $i * $indexMaxperpage;
-               $sql = "SELECT cur_title $fromwhere $order ".$dbr->limitResult(2,$from);
-               $res = $dbr->query( $sql, $fname );
+       # We want to display $toplevelMaxperpage lines starting at $offset.
+       # NOTICE: $offset starts at 0
+       $offset = intval ( $wgRequest->getVal( 'offset' ) );
+       if ( $offset < 0 ) { $offset = 0; }
+       if ( $offset >= $sections ) { $offset = $sections - 1; }
 
-               $s = $dbr->fetchObject( $res );
-               $outpoint = $s->cur_title;
-               $out .= indexShowline( $inpoint, $outpoint );
+       # Where to stop? Notice that this can take the value of $sections, but $offset can't, because if
+       # we're displaying only the very last section, we still need two DB queries to find the titles
+       $stopat = ( $offset + $toplevelMaxperpage < $sections )
+                 ? $offset + $toplevelMaxperpage : $sections ;
 
-               $s = $dbr->fetchObject( $res );
-               $inpoint = $s->cur_title;
+       # This array is going to hold the page_titles in order.
+       $lines = array();
 
+       # If we are going to show n rows, we need n+1 queries to find the relevant titles.
+       for ( $i = $offset; $i <= $stopat; ++$i ) {
+               if ( $i == $sections )                  # if we're displaying the last section, we need to
+                       $from = $count-1;                       # find the last page_title in the DB
+               else if ( $i > $offset )
+                       $from = $i * $indexMaxperpage - 1;
+               else
+                       $from = $i * $indexMaxperpage;
+               $limit = ( $i == $offset || $i == $stopat ) ? 1 : 2;
+               $sql = "SELECT page_title $fromwhere $order_str " . $dbr->limitResult ( $limit, $from );
+               $res = $dbr->query( $sql, $fname );
+               if ( $s = $dbr->fetchObject( $res ) ) {
+                       array_push ( $lines, $s->page_title );
+                       if ( $s = $dbr->fetchObject( $res ) ) {
+                               array_push ( $lines, $s->page_title );
+                       }
+               }
                $dbr->freeResult( $res );
        }
 
-       $from = $i * $indexMaxperpage;
-       $sql = "SELECT cur_title $fromwhere $order ".wfLimitResult(1,$count-1);
-       $res = $dbr->query( $sql, $fname );
-       $s = $dbr->fetchObject( $res );
-       $outpoint = $s->cur_title;
-       $out .= indexShowline( $inpoint, $outpoint );
-       $out .= "</table>\n";
+       # At this point, $lines should contain an even number of elements.
+       $out .= "<table style='background: inherit;'>";
+       while ( count ( $lines ) > 0 ) {
+               $inpoint = array_shift ( $lines );
+               $outpoint = array_shift ( $lines );
+               $out .= indexShowline ( $inpoint, $outpoint, $namespace, $invert );
+       }
+       $out .= '</table>';
+       
+       $nsForm = indexNamespaceForm ( $namespace, '', $invert );
+       
+       # Is there more?
+       if ( $including ) {
+               $out2 = '';
+       } else {
+               $morelinks = '';
+               if ( $offset > 0 ) {
+                       $morelinks = $sk->makeKnownLink (
+                               $wgContLang->specialPage ( 'Allpages' ),
+                               wfMsg ( 'allpagesprev' ),
+                               ( $offset > $toplevelMaxperpage ) ? 'offset='.($offset-$toplevelMaxperpage) : ''
+                       );
+               }
+               if ( $stopat < $sections-1 ) {
+                       if ( $morelinks != '' ) { $morelinks .= " | "; }
+                       $morelinks .= $sk->makeKnownLink (
+                               $wgContLang->specialPage ( 'Allpages' ),
+                               wfMsg ( 'allpagesnext' ),
+                               'offset=' . ($offset + $toplevelMaxperpage)
+                       );
+               }
 
-       # Saving cache
-       $log->replaceContent( $out );
+               if ( $morelinks != '' ) {
+                       $out2 = '<table style="background: inherit;" width="100%" cellpadding="0" cellspacing="0" border="0">';
+                       $out2 .= '<tr valign="top"><td align="left">' . $nsForm;
+                       $out2 .= '</td><td align="right" style="font-size: smaller; margin-bottom: 1em;">';
+                       $out2 .= $morelinks . '</td></tr></table><hr />';
+               } else {
+                       $out2 = $nsForm . '<hr />';
+               }
+       }
 
-       $wgOut->addHtml( $out );
+       $wgOut->addHtml( $out2 . $out );
 }
 
-function indexShowline( $inpoint, $outpoint )
-{
+/**
+ * @todo Document
+ * @param string $from 
+ * @param integer $namespace (Default NS_MAIN)
+ * @param bool $invert true if we want the namespaces inverted (default false)
+ */
+function indexShowline( $inpoint, $outpoint, $namespace = NS_MAIN, $invert ) {
        global $wgOut, $wgLang, $wgUser;
        $sk = $wgUser->getSkin();
        $dbr =& wfGetDB( DB_SLAVE );
 
-       # Fixme: this is ugly
+       $inpointf = htmlspecialchars( str_replace( '_', ' ', $inpoint ) );
+       $outpointf = htmlspecialchars( str_replace( '_', ' ', $outpoint ) );
+       $queryparams = ($namespace ? "namespace=$namespace" : '') . ($invert ? "&invert=$invert" : '');
+       $special = Title::makeTitle( NS_SPECIAL, 'Allpages/' . $inpoint );
+       $link = $special->escapeLocalUrl( $queryparams );
+       
        $out = wfMsg(
-               "alphaindexline",
-               $sk->makeKnownLink( $wgLang->specialPage( "Allpages" ),
-                       str_replace( "_", " ", $inpoint ),
-                       "from=" . $dbr->strencode( $inpoint ) ) . "</td><td>",
-               "</td><td align=\"left\">" .
-               str_replace( "_", " ", $outpoint )
-               );
-       return "<tr><td align=\"right\">{$out}</td></tr>\n";
+               'alphaindexline',
+               "<a href=\"$link\">$inpointf</a></td><td><a href=\"$link\">",
+               "</a></td><td align=\"left\"><a href=\"$link\">$outpointf</a>"
+       );
+       return '<tr><td align="right">'.$out.'</td></tr>';
 }
 
-function indexShowChunk( $from, $namespace = 0 )
-{
-       global $wgOut, $wgUser, $indexMaxperpage, $wgLang;
+/**
+ * @param integer $namespace (Default NS_MAIN)
+ * @param string $from list all pages from this name (default FALSE)
+ * @param bool $invert true if we want the namespaces inverted (default false)
+ */
+function indexShowChunk( $namespace = NS_MAIN, $from, $invert = false, $including = false ) {
+       global $wgOut, $wgUser, $indexMaxperpage, $wgContLang;
        $sk = $wgUser->getSkin();
        $maxPlusOne = $indexMaxperpage + 1;
-       $namespacee = intval($namespace);
 
-       $out = "";
+       $out = '';
        $dbr =& wfGetDB( DB_SLAVE );
-       $cur = $dbr->tableName( 'cur' );
-       $sql = "SELECT cur_title FROM $cur WHERE cur_namespace=$namespacee AND cur_title >= '"
-               . $dbr->strencode( $from ) . "' ORDER BY cur_title LIMIT " . $maxPlusOne;
-       $res = $dbr->query( $sql, "indexShowChunk" );
+       $page = $dbr->tableName( 'page' );
+       
+       $fromTitle = Title::newFromURL( $from );
+       $fromKey = is_null( $fromTitle ) ? '' : $fromTitle->getDBkey();
+       
+       $sql = "SELECT page_namespace,page_title FROM $page WHERE page_namespace" .
+               ($invert ? '!' : '') . "=$namespace" .
+               " AND page_title >= ".  $dbr->addQuotes( $fromKey ) .
+               " ORDER BY page_title LIMIT " . $maxPlusOne;
+       $res = $dbr->query( $sql, 'indexShowChunk' );
 
        ### FIXME: side link to previous
 
        $n = 0;
-       $out = "<table border=\"0\" width=\"100%\">\n";
+       $out = '<table style="background: inherit;" border="0" width="100%">';
+       
+       $namespaces = $wgContLang->getFormattedNamespaces();
        while( ($n < $indexMaxperpage) && ($s = $dbr->fetchObject( $res )) ) {
-               $t = Title::makeTitle( $namespacee, $s->cur_title );
+               $t = Title::makeTitle( $s->page_namespace, $s->page_title );
                if( $t ) {
-                       $link = $sk->makeKnownLinkObj( $t );
+                       $ns = $s->page_namespace;
+                       $prefix = $invert ? $namespaces[$ns] : '';
+                       $prefix .= $invert && $namespaces[$ns] != $wgContLang->getNsText(NS_MAIN) ? ':' : '';
+                       $link = $sk->makeKnownLinkObj( $t, $t->getText(), false, false, $prefix ); 
                } else {
-                       $link = "[[" . htmlspecialchars( $s->cur_title ) . "]]";
+                       $link = '[[' . htmlspecialchars( $s->page_title ) . ']]';
                }
                if( $n % 3 == 0 ) {
-                       $out .= "<tr>\n";
+                       $out .= '<tr>';
                }
                $out .= "<td>$link</td>";
                $n++;
                if( $n % 3 == 0 ) {
-                       $out .= "</tr>\n";
+                       $out .= '</tr>';
                }
        }
        if( ($n % 3) != 0 ) {
-               $out .= "</tr>\n";
+               $out .= '</tr>';
        }
-       $out .= "</table>";
-
-       $out2 = "<div style='text-align: right; font-size: smaller; margin-bottom: 1em;'>" .
-                       $sk->makeKnownLink( $wgLang->specialPage( "Allpages" ),
-                               wfMsg ( 'allpages' ) );
-       if ( ($n == $indexMaxperpage) && ($s = $dbr->fetchObject( $res )) ) {
-               $out2 .= " | " . $sk->makeKnownLink(
-                       $wgLang->specialPage( "Allpages" ),
-                       wfMsg ( 'nextpage', $s->cur_title ),
-                       "from=" . $dbr->strencode( $s->cur_title ) );
+       $out .= '</table>';
+       
+       if ( $including ) {
+               $out2 = '';
+       } else {
+               $nsForm = indexNamespaceForm ( $namespace, $from, $invert );
+               $out2 = '<table style="background: inherit;" width="100%" cellpadding="0" cellspacing="0" border="0">';
+               $out2 .= '<tr valign="top"><td align="left">' . $nsForm;
+               $out2 .= '</td><td align="right" style="font-size: smaller; margin-bottom: 1em;">' .
+                               $sk->makeKnownLink( $wgContLang->specialPage( "Allpages" ),
+                                       wfMsg ( 'allpages' ) );
+               if ( ($n == $indexMaxperpage) && ($s = $dbr->fetchObject( $res )) ) {
+                       $namespaceparam = $namespace ? "&namespace=$namespace" : "";
+                       $invertparam = $invert ? "&invert=$invert" : '';
+                       $out2 .= " | " . $sk->makeKnownLink(
+                               $wgContLang->specialPage( "Allpages" ),
+                               wfMsg ( 'nextpage', $s->page_title ),
+                               "from=" . wfUrlEncode ( $s->page_title ) . $namespaceparam . $invertparam );
+               }
+               $out2 .= "</td></tr></table><hr />";
        }
-       $out2 .= "</div>";
 
        $wgOut->addHtml( $out2 . $out );
 }