diff options
Diffstat (limited to 'includes/CategoryPage.php')
| -rw-r--r-- | includes/CategoryPage.php | 358 |
1 files changed, 237 insertions, 121 deletions
diff --git a/includes/CategoryPage.php b/includes/CategoryPage.php index 56f85faa..f990b79b 100644 --- a/includes/CategoryPage.php +++ b/includes/CategoryPage.php @@ -1,33 +1,41 @@ <?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; $diff = $wgRequest->getVal( 'diff' ); $diffOnly = $wgRequest->getBool( 'diffonly', $wgUser->getOption( 'diffonly' ) ); - if ( isset( $diff ) && $diffOnly ) - return Article::view(); + if ( isset( $diff ) && $diffOnly ) { + return parent::view(); + } - if ( !wfRunHooks( 'CategoryPageView', array( &$this ) ) ) + if ( !wfRunHooks( 'CategoryPageView', array( &$this ) ) ) { return; + } if ( NS_CATEGORY == $this->mTitle->getNamespace() ) { $this->openShowCategory(); } - Article::view(); + parent::view(); if ( NS_CATEGORY == $this->mTitle->getNamespace() ) { $this->closeShowCategory(); @@ -36,14 +44,23 @@ class CategoryPage extends Article { /** * Don't return a 404 for categories in use. + * In use defined as: either the actual page exists + * or the category currently has members. */ function hasViewableContent() { if ( parent::hasViewableContent() ) { return true; } else { $cat = Category::newFromTitle( $this->mTitle ); - return $cat->getId() != 0; + // If any of these are not 0, then has members + if ( $cat->getPageCount() + || $cat->getSubcatCount() + || $cat->getFileCount() + ) { + return true; + } } + return false; } function openShowCategory() { @@ -52,10 +69,14 @@ class CategoryPage extends Article { function closeShowCategory() { global $wgOut, $wgRequest; - $from = $wgRequest->getVal( 'from' ); - $until = $wgRequest->getVal( 'until' ); - $viewer = new CategoryViewer( $this->mTitle, $from, $until ); + $from = $until = array(); + foreach ( array( 'page', 'subcat', 'file' ) as $type ) { + $from[$type] = $wgRequest->getVal( "{$type}from" ); + $until[$type] = $wgRequest->getVal( "{$type}until" ); + } + + $viewer = new $this->mCategoryViewerClass( $this->mTitle, $from, $until, $wgRequest->getValues() ); $wgOut->addHTML( $viewer->getHTML() ); } } @@ -65,27 +86,32 @@ class CategoryViewer { $articles, $articles_start_char, $children, $children_start_char, $showGallery, $gallery, - $skin; - /** Category object for this page */ + $imgsNoGalley, $imgsNoGallery_start_char, + $skin, $collation; + # 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; + $this->collation = Collation::singleton(); + unset( $this->query['title'] ); } /** * Format the category data list. * * @return string HTML output - * @private */ - function getHTML() { - global $wgOut, $wgCategoryMagicGallery, $wgCategoryPagingLimit, $wgContLang; + public function getHTML() { + global $wgOut, $wgCategoryMagicGallery, $wgContLang; wfProfileIn( __METHOD__ ); $this->showGallery = $wgCategoryMagicGallery && !$wgOut->mNoGallery; @@ -128,6 +154,9 @@ class CategoryViewer { if ( $this->showGallery ) { $this->gallery = new ImageGallery(); $this->gallery->setHideBadImages(); + } else { + $this->imgsNoGallery = array(); + $this->imgsNoGallery_start_char = array(); } } @@ -142,26 +171,29 @@ class CategoryViewer { /** * Add a subcategory to the internal lists, using a Category object */ - function addSubcategoryObject( $cat, $sortkey, $pageLength ) { + function addSubcategoryObject( Category $cat, $sortkey, $pageLength ) { + // Subcategory; strip the 'Category' namespace from the link text. $title = $cat->getTitle(); - $this->addSubcategory( $title, $sortkey, $pageLength ); + + $link = $this->getSkin()->link( $title, $title->getText() ); + if ( $title->isRedirect() ) { + // This didn't used to add redirect-in-category, but might + // as well be consistent with the rest of the sections + // on a category page. + $link = '<span class="redirect-in-category">' . $link . '</span>'; + } + $this->children[] = $link; + + $this->children_start_char[] = + $this->getSubcategorySortChar( $cat->getTitle(), $sortkey ); } /** * Add a subcategory to the internal lists, using a title object * @deprecated kept for compatibility, please use addSubcategoryObject instead */ - function addSubcategory( $title, $sortkey, $pageLength ) { - // Subcategory; strip the 'Category' namespace from the link text. - $this->children[] = $this->getSkin()->link( - $title, - null, - array(), - array(), - array( 'known', 'noclasses' ) - ); - - $this->children_start_char[] = $this->getSubcategorySortChar( $title, $sortkey ); + function addSubcategory( Title $title, $sortkey, $pageLength ) { + $this->addSubcategoryObject( Category::newFromTitle( $title ), $sortkey, $pageLength ); } /** @@ -170,16 +202,21 @@ class CategoryViewer { * entry in the categorylinks table is Category:A, not A, which it SHOULD be. * Workaround: If sortkey == "Category:".$title, than use $title for sorting, * else use sortkey... + * + * @param Title $title + * @param string $sortkey The human-readable sortkey (before transforming to icu or whatever). */ function getSubcategorySortChar( $title, $sortkey ) { global $wgContLang; if ( $title->getPrefixedText() == $sortkey ) { - $firstChar = $wgContLang->firstChar( $title->getDBkey() ); + $word = $title->getDBkey(); } else { - $firstChar = $wgContLang->firstChar( $sortkey ); + $word = $sortkey; } + $firstChar = $this->collation->getFirstLetter( $word ); + return $wgContLang->convert( $firstChar ); } @@ -187,14 +224,25 @@ class CategoryViewer { * Add a page in the image namespace */ function addImage( Title $title, $sortkey, $pageLength, $isRedirect = false ) { + global $wgContLang; if ( $this->showGallery ) { - if ( $this->flip ) { + $flip = $this->flip['file']; + if ( $flip ) { $this->gallery->insert( $title ); } else { $this->gallery->add( $title ); } } else { - $this->addPage( $title, $sortkey, $pageLength, $isRedirect ); + $link = $this->getSkin()->link( $title ); + if ( $isRedirect ) { + // This seems kind of pointless given 'mw-redirect' class, + // but keeping for back-compatibility with user css. + $link = '<span class="redirect-in-category">' . $link . '</span>'; + } + $this->imgsNoGallery[] = $link; + + $this->imgsNoGallery_start_char[] = $wgContLang->convert( + $this->collation->getFirstLetter( $sortkey ) ); } } @@ -203,74 +251,104 @@ class CategoryViewer { */ function addPage( $title, $sortkey, $pageLength, $isRedirect = false ) { global $wgContLang; - $this->articles[] = $isRedirect - ? '<span class="redirect-in-category">' . - $this->getSkin()->link( - $title, - null, - array(), - array(), - array( 'known', 'noclasses' ) - ) . '</span>' - : $this->getSkin()->makeSizeLinkObj( $pageLength, $title ); - $this->articles_start_char[] = $wgContLang->convert( $wgContLang->firstChar( $sortkey ) ); + + $link = $this->getSkin()->link( $title ); + if ( $isRedirect ) { + // This seems kind of pointless given 'mw-redirect' class, + // but keeping for back-compatiability with user css. + $link = '<span class="redirect-in-category">' . $link . '</span>'; + } + $this->articles[] = $link; + + $this->articles_start_char[] = $wgContLang->convert( + $this->collation->getFirstLetter( $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 ); } + if ( !$this->showGallery && $this->flip['file'] ) { + $this->imgsNoGallery = array_reverse( $this->imgsNoGallery ); + $this->imgsNoGallery_start_char = array_reverse( $this->imgsNoGallery_start_char ); + } } function doCategoryQuery() { $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; - } - $res = $dbr->select( - array( 'page', 'categorylinks', 'category' ), - array( 'page_title', 'page_namespace', 'page_len', 'page_is_redirect', 'cl_sortkey', - 'cat_id', 'cat_title', 'cat_subcats', 'cat_pages', 'cat_files' ), - array( $pageCondition, 'cl_to' => $this->title->getDBkey() ), - __METHOD__, - array( 'ORDER BY' => $this->flip ? 'cl_sortkey DESC' : 'cl_sortkey', - 'USE INDEX' => array( 'categorylinks' => 'cl_sortkey' ), - 'LIMIT' => $this->limit + 1 ), - array( 'categorylinks' => array( 'INNER JOIN', 'cl_from = page_id' ), - 'category' => array( 'LEFT JOIN', 'cat_title = page_title AND page_namespace = ' . NS_CATEGORY ) ) + $this->nextPage = array( + 'page' => null, + 'subcat' => null, + 'file' => null, ); + $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 + # set in $wgCategoryCollation, pagination might go totally haywire. + $extraConds = array( 'cl_type' => $type ); + if ( $this->from[$type] !== null ) { + $extraConds[] = 'cl_sortkey >= ' + . $dbr->addQuotes( $this->collation->getSortKey( $this->from[$type] ) ); + } elseif ( $this->until[$type] !== null ) { + $extraConds[] = 'cl_sortkey < ' + . $dbr->addQuotes( $this->collation->getSortKey( $this->until[$type] ) ); + $this->flip[$type] = true; + } - $count = 0; - $this->nextPage = null; + $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', 'cl_collation' ), + 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 ) + ) + ); - while ( $x = $dbr->fetchObject ( $res ) ) { - if ( ++$count > $this->limit ) { - // We've reached the one extra which shows that there are - // additional pages to be had. Stop here... - $this->nextPage = $x->cl_sortkey; - break; - } + $count = 0; + foreach ( $res as $row ) { + $title = Title::newFromRow( $row ); + if ( $row->cl_collation === '' ) { + // Hack to make sure that while updating from 1.16 schema + // and db is inconsistent, that the sky doesn't fall. + // See r83544. Could perhaps be removed in a couple decades... + $humanSortkey = $row->cl_sortkey; + } else { + $humanSortkey = $title->getCategorySortkey( $row->cl_sortkey_prefix ); + } - $title = Title::makeTitle( $x->page_namespace, $x->page_title ); + 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] = $humanSortkey; + break; + } - if ( $title->getNamespace() == NS_CATEGORY ) { - $cat = Category::newFromRow( $x, $title ); - $this->addSubcategoryObject( $cat, $x->cl_sortkey, $x->page_len ); - } elseif ( $this->showGallery && $title->getNamespace() == NS_FILE ) { - $this->addImage( $title, $x->cl_sortkey, $x->page_len, $x->page_is_redirect ); - } else { - $this->addPage( $title, $x->cl_sortkey, $x->page_len, $x->page_is_redirect ); + if ( $title->getNamespace() == NS_CATEGORY ) { + $cat = Category::newFromRow( $row, $title ); + $this->addSubcategoryObject( $cat, $humanSortkey, $row->page_len ); + } elseif ( $title->getNamespace() == NS_FILE ) { + $this->addImage( $title, $humanSortkey, $row->page_len, $row->page_is_redirect ); + } else { + $this->addPage( $title, $humanSortkey, $row->page_len, $row->page_is_redirect ); + } } } } @@ -294,7 +372,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; @@ -318,36 +398,57 @@ 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() { - if ( $this->showGallery && ! $this->gallery->isEmpty() ) { + $r = ''; + $rescnt = $this->showGallery ? $this->gallery->count() : count( $this->imgsNoGallery ); + if ( $rescnt > 0 ) { $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' ); + if ( $this->showGallery ) { + $r .= $this->gallery->toHTML(); + } else { + $r .= $this->formatList( $this->imgsNoGallery, $this->imgsNoGallery_start_char ); + } + $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. @@ -360,10 +461,10 @@ class CategoryViewer { */ function formatList( $articles, $articles_start_char, $cutoff = 6 ) { if ( count ( $articles ) > $cutoff ) { - return $this->columnList( $articles, $articles_start_char ); + return self::columnList( $articles, $articles_start_char ); } elseif ( count( $articles ) > 0 ) { // for short lists of articles in categories. - return $this->shortList( $articles, $articles_start_char ); + return self::shortList( $articles, $articles_start_char ); } return ''; } @@ -383,7 +484,7 @@ class CategoryViewer { * @return String * @private */ - function columnList( $articles, $articles_start_char ) { + static function columnList( $articles, $articles_start_char ) { $columns = array_combine( $articles, $articles_start_char ); # Split into three columns $columns = array_chunk( $columns, ceil( count( $columns ) / 3 ), true /* preserve keys */ ); @@ -435,7 +536,7 @@ class CategoryViewer { * @return String * @private */ - function shortList( $articles, $articles_start_char ) { + static function shortList( $articles, $articles_start_char ) { $r = '<h3>' . htmlspecialchars( $articles_start_char[0] ) . "</h3>\n"; $r .= '<ul><li>' . $articles[0] . '</li>'; for ( $index = 1; $index < count( $articles ); $index++ ) @@ -452,26 +553,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 @@ -481,10 +583,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 @@ -496,8 +599,8 @@ class CategoryViewer { /** * What to do if the category table conflicts with the number of results - * returned? This function says what. It works the same whether the - * things being counted are articles, subcategories, or files. + * returned? This function says what. Each type is considered independantly + * of the other types. * * Note for grepping: uses the messages category-article-count, * category-article-count-limited, category-subcat-count, @@ -520,15 +623,28 @@ class CategoryViewer { # than $this->limit and there's no offset. In this case we still # know the right figure. # 3) We have no idea. - $totalrescnt = count( $this->articles ) + count( $this->children ) + - ( $this->showGallery ? $this->gallery->count() : 0 ); - if ( $dbcnt == $rescnt || ( ( $totalrescnt == $this->limit || $this->from - || $this->until ) && $dbcnt > $rescnt ) ) + # Check if there's a "from" or "until" for anything + + // This is a little ugly, but we seem to use different names + // for the paging types then for the messages. + if ( $type === 'article' ) { + $pagingType = 'page'; + } else { + $pagingType = $type; + } + + $fromOrUntil = false; + if ( $this->from[$pagingType] !== null || $this->until[$pagingType] !== null ) { + $fromOrUntil = true; + } + + if ( $dbcnt == $rescnt || ( ( $rescnt == $this->limit || $fromOrUntil ) + && $dbcnt > $rescnt ) ) { # Case 1: seems sane. $totalcnt = $dbcnt; - } elseif ( $totalrescnt < $this->limit && !$this->from && !$this->until ) { + } elseif ( $rescnt < $this->limit && !$fromOrUntil ) { # Case 2: not sane, but salvageable. Use the number of results. # Since there are fewer than 200, we can also take this opportunity # to refresh the incorrect category table entry -- which should be |