Fixed some doxygen warnings
[lhc/web/wiklou.git] / includes / CategoryPage.php
index 16e6ed2..d9ef507 100644 (file)
@@ -1,16 +1,22 @@
 <?php
 /**
- * Special handling for category description pages
- * Modelled after ImagePage.php
+ * Special handling for category description pages.
+ * Modelled after ImagePage.php.
  *
+ * @file
  */
 
 if ( !defined( 'MEDIAWIKI' ) )
        die( 1 );
 
 /**
+ * Special handling for category description pages, showing pages,
+ * subcategories and file that belong to the category
  */
 class CategoryPage extends Article {
+       # Subclasses can change this to override the viewer class.
+       protected $mCategoryViewerClass = 'CategoryViewer';
+
        function view() {
                global $wgRequest, $wgUser;
 
@@ -18,7 +24,7 @@ class CategoryPage extends Article {
                $diffOnly = $wgRequest->getBool( 'diffonly', $wgUser->getOption( 'diffonly' ) );
 
                if ( isset( $diff ) && $diffOnly )
-                       return Article::view();
+                       return parent::view();
 
                if ( !wfRunHooks( 'CategoryPageView', array( &$this ) ) )
                        return;
@@ -27,7 +33,7 @@ class CategoryPage extends Article {
                        $this->openShowCategory();
                }
 
-               Article::view();
+               parent::view();
 
                if ( NS_CATEGORY == $this->mTitle->getNamespace() ) {
                        $this->closeShowCategory();
@@ -51,11 +57,18 @@ class CategoryPage extends Article {
        }
 
        function closeShowCategory() {
-               global $wgOut, $wgRequest;
-               $from = $wgRequest->getVal( 'from' );
-               $until = $wgRequest->getVal( 'until' );
+               global $wgOut;
+
+               $from = $until = array();
+               foreach ( array( 'page', 'subcat', 'file' ) as $type ) {
+                       # Use $_GET instead of $wgRequest, because the latter helpfully
+                       # normalizes Unicode, which removes nulls.  TODO: do something
+                       # smarter than passing nulls in URLs.  :/
+                       $from[$type] = isset( $_GET["{$type}from"] ) ? $_GET["{$type}from"] : null;
+                       $until[$type] = isset( $_GET["{$type}until"] ) ? $_GET["{$type}until"] : null;
+               }
 
-               $viewer = new CategoryViewer( $this->mTitle, $from, $until );
+               $viewer = new $this->mCategoryViewerClass( $this->mTitle, $from, $until, $_GET );
                $wgOut->addHTML( $viewer->getHTML() );
        }
 }
@@ -66,16 +79,20 @@ class CategoryViewer {
                $children, $children_start_char,
                $showGallery, $gallery,
                $skin;
-       /** Category object for this page */
+       # Category object for this page
        private $cat;
+       # The original query array, to be used in generating paging links.
+       private $query;
 
-       function __construct( $title, $from = '', $until = '' ) {
+       function __construct( $title, $from = '', $until = '', $query = array() ) {
                global $wgCategoryPagingLimit;
                $this->title = $title;
                $this->from = $from;
                $this->until = $until;
                $this->limit = $wgCategoryPagingLimit;
                $this->cat = Category::newFromTitle( $title );
+               $this->query = $query;
+               unset( $this->query['title'] );
        }
 
        /**
@@ -85,7 +102,7 @@ class CategoryViewer {
         * @private
         */
        function getHTML() {
-               global $wgOut, $wgCategoryMagicGallery, $wgCategoryPagingLimit, $wgContLang;
+               global $wgOut, $wgCategoryMagicGallery, $wgContLang;
                wfProfileIn( __METHOD__ );
 
                $this->showGallery = $wgCategoryMagicGallery && !$wgOut->mNoGallery;
@@ -175,11 +192,13 @@ class CategoryViewer {
                global $wgContLang;
 
                if ( $title->getPrefixedText() == $sortkey ) {
-                       $firstChar = $wgContLang->firstChar( $title->getDBkey() );
+                       $word = $title->getDBkey();
                } else {
-                       $firstChar = $wgContLang->firstChar( $sortkey );
+                       $word = $sortkey;
                }
 
+               $firstChar = $wgContLang->firstLetterForLists( $word );
+
                return $wgContLang->convert( $firstChar );
        }
 
@@ -188,7 +207,8 @@ class CategoryViewer {
         */
        function addImage( Title $title, $sortkey, $pageLength, $isRedirect = false ) {
                if ( $this->showGallery ) {
-                       if ( $this->flip ) {
+                       $flip = $this->flip['file'];
+                       if ( $flip ) {
                                $this->gallery->insert( $title );
                        } else {
                                $this->gallery->add( $title );
@@ -212,111 +232,85 @@ class CategoryViewer {
                                        array(),
                                        array( 'known', 'noclasses' )
                                ) . '</span>'
-                       : $this->getSkin()->makeSizeLinkObj( $pageLength, $title );
-               $this->articles_start_char[] = $wgContLang->convert( $wgContLang->firstChar( $sortkey ) );
+                       : $this->getSkin()->link( $title );
+
+               $this->articles_start_char[] = $wgContLang->convert( $wgContLang->firstLetterForLists( $sortkey ) );
        }
 
        function finaliseCategoryState() {
-               if ( $this->flip ) {
+               if ( $this->flip['subcat'] ) {
                        $this->children            = array_reverse( $this->children );
                        $this->children_start_char = array_reverse( $this->children_start_char );
+               }
+               if ( $this->flip['page'] ) {
                        $this->articles            = array_reverse( $this->articles );
                        $this->articles_start_char = array_reverse( $this->articles_start_char );
                }
        }
 
        function doCategoryQuery() {
-               global $wgExperimentalCategorySort;
+               global $wgContLang;
 
                $dbr = wfGetDB( DB_SLAVE, 'category' );
-               if ( $this->from != '' ) {
-                       $pageCondition = 'cl_sortkey >= ' . $dbr->addQuotes( $this->from );
-                       $this->flip = false;
-               } elseif ( $this->until != '' ) {
-                       $pageCondition = 'cl_sortkey < ' . $dbr->addQuotes( $this->until );
-                       $this->flip = true;
-               } else {
-                       $pageCondition = '1 = 1';
-                       $this->flip = false;
-               }
 
-               $tables = array( 'page', 'categorylinks', 'category' );
-               $fields = array( 'page_title', 'page_namespace', 'page_len',
-                       'page_is_redirect', 'cl_sortkey', 'cat_id', 'cat_title',
-                       'cat_subcats', 'cat_pages', 'cat_files' );
-               $conds = array( $pageCondition, 'cl_to' => $this->title->getDBkey() );
-               $opts = array( 'ORDER BY' => $this->flip ? 'cl_sortkey DESC' :
-                       'cl_sortkey', 'USE INDEX' => array( 'categorylinks' => 'cl_sortkey' ) );
-               $joins = array( 'categorylinks'  => array( 'INNER JOIN', 'cl_from = page_id' ),
-                       'category' => array( 'LEFT JOIN', 'cat_title = page_title AND page_namespace = ' . NS_CATEGORY ) );
-
-               $res = $dbr->select(
-                       $tables,
-                       $fields,
-                       $conds + ( $wgExperimentalCategorySort ? array( 'cl_type' => 'page' ) : array() ),
-                       __METHOD__,
-                       $opts + array( 'LIMIT' => $this->limit + 1 ),
-                       $joins
+               $this->nextPage = array(
+                       'page' => null,
+                       'subcat' => null,
+                       'file' => null,
                );
-
-               $count = 0;
-               $this->nextPage = null;
-
-               foreach ( $res as $row ) {
-                       if ( ++$count > $this->limit ) {
-                               // We've reached the one extra which shows that there are
-                               // additional pages to be had. Stop here...
-                               $this->nextPage = $row->cl_sortkey;
-                               break;
+               $this->flip = array( 'page' => false, 'subcat' => false, 'file' => false );
+
+               foreach ( array( 'page', 'subcat', 'file' ) as $type ) {
+                       # Get the sortkeys for start/end, if applicable.  Note that if
+                       # the collation in the database differs from the one
+                       # $wgContLang is using, pagination might go totally haywire.
+                       $extraConds = array( 'cl_type' => $type );
+                       if ( $this->from[$type] !== null ) {
+                               $extraConds[] = 'cl_sortkey >= '
+                                       . $dbr->addQuotes( $wgContLang->convertToSortkey( $this->from[$type] ) );
+                       } elseif ( $this->until[$type] !== null ) {
+                               $extraConds[] = 'cl_sortkey < '
+                                       . $dbr->addQuotes( $wgContLang->convertToSortkey( $this->until[$type] ) );
+                               $this->flip[$type] = true;
                        }
 
-                       $title = Title::newFromRow( $row );
-
-                       if ( $title->getNamespace() == NS_CATEGORY ) {
-                               $cat = Category::newFromRow( $row, $title );
-                               $this->addSubcategoryObject( $cat, $row->cl_sortkey, $row->page_len );
-                       } elseif ( $this->showGallery && $title->getNamespace() == NS_FILE ) {
-                               $this->addImage( $title, $row->cl_sortkey, $row->page_len, $row->page_is_redirect );
-                       } else {
-                               $this->addPage( $title, $row->cl_sortkey, $row->page_len, $row->page_is_redirect );
-                       }
-               }
-
-               if ( $wgExperimentalCategorySort ) {
-                       # Now add all subcategories and files.  TODO: rewrite to be sane
-                       # (this is basically a proof-of-concept, e.g., no pagination here).
-                       $subcatsRes = $dbr->select(
-                               $tables, $fields,
-                               $conds + array( 'cl_type' => 'subcat' ),
-                               __METHOD__, $opts, $joins
+                       $res = $dbr->select(
+                               array( 'page', 'categorylinks', 'category' ),
+                               array( 'page_id', 'page_title', 'page_namespace', 'page_len',
+                                       'page_is_redirect', 'cl_sortkey', 'cat_id', 'cat_title',
+                                       'cat_subcats', 'cat_pages', 'cat_files', 'cl_sortkey_prefix' ),
+                               array( 'cl_to' => $this->title->getDBkey() ) + $extraConds,
+                               __METHOD__,
+                               array(
+                                       'USE INDEX' => array( 'categorylinks' => 'cl_sortkey' ),
+                                       'LIMIT' => $this->limit + 1,
+                                       'ORDER BY' => $this->flip[$type] ? 'cl_sortkey DESC' : 'cl_sortkey',
+                               ),
+                               array(
+                                       'categorylinks'  => array( 'INNER JOIN', 'cl_from = page_id' ),
+                                       'category' => array( 'LEFT JOIN', 'cat_title = page_title AND page_namespace = ' . NS_CATEGORY )
+                               )
                        );
 
-                       foreach ( $subcatsRes as $row ) {
+                       $count = 0;
+                       foreach ( $res as $row ) {
                                $title = Title::newFromRow( $row );
+                               $rawSortkey = $title->getCategorySortkey( $row->cl_sortkey_prefix );
 
-                               if ( $title->getNamespace() == NS_CATEGORY ) {
-                                       $cat = Category::newFromRow( $row, $title );
-                                       $this->addSubcategoryObject( $cat, $row->cl_sortkey, $row->page_len );
-                               } else {
-                                       # Will handle this sanely in final code
-                                       throw new MWException( 'Debug: cl_type = subcat but not category' );
+                               if ( ++$count > $this->limit ) {
+                                       # We've reached the one extra which shows that there
+                                       # are additional pages to be had. Stop here...
+                                       $this->nextPage[$type] = $rawSortkey;
+                                       break;
                                }
-                       }
-
-                       $filesRes = $dbr->select(
-                               $tables, $fields,
-                               $conds + array( 'cl_type' => 'file' ),
-                               __METHOD__, $opts, $joins
-                       );
 
-                       foreach ( $filesRes as $row ) {
-                               $title = Title::newFromRow( $row );
-
-                               if ( $this->showGallery && $title->getNamespace() == NS_FILE ) {
-                                       $this->addImage( $title, $row->cl_sortkey, $row->page_len, $row->page_is_redirect );
+                               if ( $title->getNamespace() == NS_CATEGORY ) {
+                                       $cat = Category::newFromRow( $row, $title );
+                                       $this->addSubcategoryObject( $cat, $rawSortkey, $row->page_len );
+                               } elseif ( $this->showGallery && $title->getNamespace() == NS_FILE ) {
+                                       $this->addImage( $title, $rawSortkey, $row->page_len, $row->page_is_redirect );
                                } else {
-                                       # More temporary debugging
-                                       throw new MWException( 'Debug: cl_type = file but not file' );
+                                       $this->addPage( $title, $rawSortkey, $row->page_len, $row->page_is_redirect );
                                }
                        }
                }
@@ -341,7 +335,9 @@ class CategoryViewer {
                        $r .= "<div id=\"mw-subcategories\">\n";
                        $r .= '<h2>' . wfMsg( 'subcategories' ) . "</h2>\n";
                        $r .= $countmsg;
+                       $r .= $this->getSectionPagingLinks( 'subcat' );
                        $r .= $this->formatList( $this->children, $this->children_start_char );
+                       $r .= $this->getSectionPagingLinks( 'subcat' );
                        $r .= "\n</div>";
                }
                return $r;
@@ -365,36 +361,53 @@ class CategoryViewer {
                        $r = "<div id=\"mw-pages\">\n";
                        $r .= '<h2>' . wfMsg( 'category_header', $ti ) . "</h2>\n";
                        $r .= $countmsg;
+                       $r .= $this->getSectionPagingLinks( 'page' );
                        $r .= $this->formatList( $this->articles, $this->articles_start_char );
+                       $r .= $this->getSectionPagingLinks( 'page' );
                        $r .= "\n</div>";
                }
                return $r;
        }
 
        function getImageSection() {
+               $r = '';
                if ( $this->showGallery && ! $this->gallery->isEmpty() ) {
                        $dbcnt = $this->cat->getFileCount();
                        $rescnt = $this->gallery->count();
                        $countmsg = $this->getCountMessage( $rescnt, $dbcnt, 'file' );
 
-                       return "<div id=\"mw-category-media\">\n" .
-                       '<h2>' . wfMsg( 'category-media-header', htmlspecialchars( $this->title->getText() ) ) . "</h2>\n" .
-                       $countmsg . $this->gallery->toHTML() . "\n</div>";
-               } else {
-                       return '';
+                       $r .= "<div id=\"mw-category-media\">\n";
+                       $r .= '<h2>' . wfMsg( 'category-media-header', htmlspecialchars( $this->title->getText() ) ) . "</h2>\n";
+                       $r .= $countmsg;
+                       $r .= $this->getSectionPagingLinks( 'file' );
+                       $r .= $this->gallery->toHTML();
+                       $r .= $this->getSectionPagingLinks( 'file' );
+                       $r .= "\n</div>";
                }
+               return $r;
        }
 
-       function getCategoryBottom() {
-               if ( $this->until != '' ) {
-                       return $this->pagingLinks( $this->title, $this->nextPage, $this->until, $this->limit );
-               } elseif ( $this->nextPage != '' || $this->from != '' ) {
-                       return $this->pagingLinks( $this->title, $this->from, $this->nextPage, $this->limit );
+       /**
+        * Get the paging links for a section (subcats/pages/files), to go at the top and bottom
+        * of the output.
+        *
+        * @param $type String: 'page', 'subcat', or 'file'
+        * @return String: HTML output, possibly empty if there are no other pages
+        */
+       private function getSectionPagingLinks( $type ) {
+               if ( $this->until[$type] !== null ) {
+                       return $this->pagingLinks( $this->nextPage[$type], $this->until[$type], $type );
+               } elseif ( $this->nextPage[$type] !== null || $this->from[$type] !== null ) {
+                       return $this->pagingLinks( $this->from[$type], $this->nextPage[$type], $type );
                } else {
                        return '';
                }
        }
 
+       function getCategoryBottom() {
+               return '';
+       }
+
        /**
         * Format a list of articles chunked by letter, either as a
         * bullet list or a columnar format, depending on the length.
@@ -499,26 +512,27 @@ class CategoryViewer {
        }
 
        /**
-        * @param $title Title object
-        * @param $first String
-        * @param $last String
-        * @param $limit Int
-        * @param $query Array: additional query options to pass
-        * @return String
-        * @private
+        * Create paging links, as a helper method to getSectionPagingLinks().
+        *
+        * @param $first String The 'until' parameter for the generated URL
+        * @param $last String The 'from' parameter for the genererated URL
+        * @param $type String A prefix for parameters, 'page' or 'subcat' or
+        *     'file'
+        * @return String HTML
         */
-       function pagingLinks( $title, $first, $last, $limit, $query = array() ) {
+       private function pagingLinks( $first, $last, $type = '' ) {
                global $wgLang;
                $sk = $this->getSkin();
-               $limitText = $wgLang->formatNum( $limit );
+               $limitText = $wgLang->formatNum( $this->limit );
 
                $prevLink = wfMsgExt( 'prevn', array( 'escape', 'parsemag' ), $limitText );
 
                if ( $first != '' ) {
-                       $prevQuery = $query;
-                       $prevQuery['until'] = $first;
+                       $prevQuery = $this->query;
+                       $prevQuery["{$type}until"] = $first;
+                       unset( $prevQuery["{$type}from"] );
                        $prevLink = $sk->linkKnown(
-                               $title,
+                               $this->title,
                                $prevLink,
                                array(),
                                $prevQuery
@@ -528,10 +542,11 @@ class CategoryViewer {
                $nextLink = wfMsgExt( 'nextn', array( 'escape', 'parsemag' ), $limitText );
 
                if ( $last != '' ) {
-                       $lastQuery = $query;
-                       $lastQuery['from'] = $last;
+                       $lastQuery = $this->query;
+                       $lastQuery["{$type}from"] = $last;
+                       unset( $lastQuery["{$type}until"] );
                        $nextLink = $sk->linkKnown(
-                               $title,
+                               $this->title,
                                $nextLink,
                                array(),
                                $lastQuery