From: Sam Reed Date: Sat, 15 Oct 2011 17:37:05 +0000 (+0000) Subject: Move CategoryViewer to it's own file X-Git-Tag: 1.31.0-rc.0~27101 X-Git-Url: http://git.cyclocoop.org//%27%40script%40/%27?a=commitdiff_plain;h=445a8a008c2f1d06968f52956f64da972f8fff5d;p=lhc%2Fweb%2Fwiklou.git Move CategoryViewer to it's own file --- diff --git a/includes/AutoLoader.php b/includes/AutoLoader.php index 3c25190b1d..640f6205fc 100644 --- a/includes/AutoLoader.php +++ b/includes/AutoLoader.php @@ -29,7 +29,7 @@ $wgAutoloadLocalClasses = array( 'Category' => 'includes/Category.php', 'Categoryfinder' => 'includes/Categoryfinder.php', 'CategoryPage' => 'includes/CategoryPage.php', - 'CategoryViewer' => 'includes/CategoryPage.php', + 'CategoryViewer' => 'includes/CategoryViewer.php', 'CdbFunctions' => 'includes/Cdb_PHP.php', 'CdbReader' => 'includes/Cdb.php', 'CdbReader_DBA' => 'includes/Cdb.php', diff --git a/includes/CategoryPage.php b/includes/CategoryPage.php index 38cf01df7a..92646af027 100644 --- a/includes/CategoryPage.php +++ b/includes/CategoryPage.php @@ -100,647 +100,3 @@ class CategoryPage extends Article { $this->getContext()->getOutput()->addHTML( $viewer->getHTML() ); } } - -class CategoryViewer extends ContextSource { - var $limit, $from, $until, - $articles, $articles_start_char, - $children, $children_start_char, - $showGallery, $imgsNoGalley, - $imgsNoGallery_start_char, - $imgsNoGallery; - - /** - * @var - */ - var $nextPage; - - /** - * @var Array - */ - var $flip; - - /** - * @var Title - */ - var $title; - - /** - * @var Collation - */ - var $collation; - - /** - * @var ImageGallery - */ - var $gallery; - - /** - * Category object for this page - * @var Category - */ - private $cat; - - /** - * The original query array, to be used in generating paging links. - * @var array - */ - private $query; - - /** - * Constructor - * - * @since 1.19 $context is a second, required parameter - * @param $title Title - * @param $context IContextSource - * @param $from String - * @param $until String - * @param $query Array - */ - function __construct( $title, IContextSource $context, $from = '', $until = '', $query = array() ) { - global $wgCategoryPagingLimit; - $this->title = $title; - $this->setContext( $context ); - $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 - */ - public function getHTML() { - global $wgCategoryMagicGallery; - wfProfileIn( __METHOD__ ); - - $this->showGallery = $wgCategoryMagicGallery && !$this->getOutput()->mNoGallery; - - $this->clearCategoryState(); - $this->doCategoryQuery(); - $this->finaliseCategoryState(); - - $r = $this->getSubcategorySection() . - $this->getPagesSection() . - $this->getImageSection(); - - if ( $r == '' ) { - // If there is no category content to display, only - // show the top part of the navigation links. - // @todo FIXME: Cannot be completely suppressed because it - // is unknown if 'until' or 'from' makes this - // give 0 results. - $r = $r . $this->getCategoryTop(); - } else { - $r = $this->getCategoryTop() . - $r . - $this->getCategoryBottom(); - } - - // Give a proper message if category is empty - if ( $r == '' ) { - $r = wfMsgExt( 'category-empty', array( 'parse' ) ); - } - - $lang = $this->getLang(); - $langAttribs = array( 'lang' => $lang->getCode(), 'dir' => $lang->getDir() ); - # put a div around the headings which are in the user language - $r = Html::openElement( 'div', $langAttribs ) . $r . ''; - - wfProfileOut( __METHOD__ ); - return $r; - } - - function clearCategoryState() { - $this->articles = array(); - $this->articles_start_char = array(); - $this->children = array(); - $this->children_start_char = array(); - if ( $this->showGallery ) { - $this->gallery = new ImageGallery(); - $this->gallery->setHideBadImages(); - } else { - $this->imgsNoGallery = array(); - $this->imgsNoGallery_start_char = array(); - } - } - - /** - * Add a subcategory to the internal lists, using a Category object - */ - function addSubcategoryObject( Category $cat, $sortkey, $pageLength ) { - // Subcategory; strip the 'Category' namespace from the link text. - $title = $cat->getTitle(); - - $link = Linker::link( $title, htmlspecialchars( $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 = '' . $link . ''; - } - $this->children[] = $link; - - $this->children_start_char[] = - $this->getSubcategorySortChar( $cat->getTitle(), $sortkey ); - } - - /** - * Add a subcategory to the internal lists, using a title object - * @deprecated since 1.17 kept for compatibility, please use addSubcategoryObject instead - */ - function addSubcategory( Title $title, $sortkey, $pageLength ) { - $this->addSubcategoryObject( Category::newFromTitle( $title ), $sortkey, $pageLength ); - } - - /** - * Get the character to be used for sorting subcategories. - * If there's a link from Category:A to Category:B, the sortkey of the resulting - * 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 ) { - $word = $title->getDBkey(); - } else { - $word = $sortkey; - } - - $firstChar = $this->collation->getFirstLetter( $word ); - - return $wgContLang->convert( $firstChar ); - } - - /** - * Add a page in the image namespace - */ - function addImage( Title $title, $sortkey, $pageLength, $isRedirect = false ) { - global $wgContLang; - if ( $this->showGallery ) { - $flip = $this->flip['file']; - if ( $flip ) { - $this->gallery->insert( $title ); - } else { - $this->gallery->add( $title ); - } - } else { - $link = Linker::link( $title ); - if ( $isRedirect ) { - // This seems kind of pointless given 'mw-redirect' class, - // but keeping for back-compatibility with user css. - $link = '' . $link . ''; - } - $this->imgsNoGallery[] = $link; - - $this->imgsNoGallery_start_char[] = $wgContLang->convert( - $this->collation->getFirstLetter( $sortkey ) ); - } - } - - /** - * Add a miscellaneous page - */ - function addPage( $title, $sortkey, $pageLength, $isRedirect = false ) { - global $wgContLang; - - $link = Linker::link( $title ); - if ( $isRedirect ) { - // This seems kind of pointless given 'mw-redirect' class, - // but keeping for back-compatiability with user css. - $link = '' . $link . ''; - } - $this->articles[] = $link; - - $this->articles_start_char[] = $wgContLang->convert( - $this->collation->getFirstLetter( $sortkey ) ); - } - - function finaliseCategoryState() { - 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' ); - - $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; - } - - $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_merge( 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 ) - ) - ); - - $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 ); - } - - 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( $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 ); - } - } - } - } - - function getCategoryTop() { - $r = $this->getCategoryBottom(); - return $r === '' - ? $r - : "
\n" . $r; - } - - function getSubcategorySection() { - # Don't show subcategories section if there are none. - $r = ''; - $rescnt = count( $this->children ); - $dbcnt = $this->cat->getSubcatCount(); - $countmsg = $this->getCountMessage( $rescnt, $dbcnt, 'subcat' ); - - if ( $rescnt > 0 ) { - # Showing subcategories - $r .= "
\n"; - $r .= '

' . wfMsg( 'subcategories' ) . "

\n"; - $r .= $countmsg; - $r .= $this->getSectionPagingLinks( 'subcat' ); - $r .= $this->formatList( $this->children, $this->children_start_char ); - $r .= $this->getSectionPagingLinks( 'subcat' ); - $r .= "\n
"; - } - return $r; - } - - function getPagesSection() { - $ti = htmlspecialchars( $this->title->getText() ); - # Don't show articles section if there are none. - $r = ''; - - # @todo FIXME: Here and in the other two sections: we don't need to bother - # with this rigamarole if the entire category contents fit on one page - # and have already been retrieved. We can just use $rescnt in that - # case and save a query and some logic. - $dbcnt = $this->cat->getPageCount() - $this->cat->getSubcatCount() - - $this->cat->getFileCount(); - $rescnt = count( $this->articles ); - $countmsg = $this->getCountMessage( $rescnt, $dbcnt, 'article' ); - - if ( $rescnt > 0 ) { - $r = "
\n"; - $r .= '

' . wfMsg( 'category_header', $ti ) . "

\n"; - $r .= $countmsg; - $r .= $this->getSectionPagingLinks( 'page' ); - $r .= $this->formatList( $this->articles, $this->articles_start_char ); - $r .= $this->getSectionPagingLinks( 'page' ); - $r .= "\n
"; - } - return $r; - } - - function getImageSection() { - $r = ''; - $rescnt = $this->showGallery ? $this->gallery->count() : count( $this->imgsNoGallery ); - if ( $rescnt > 0 ) { - $dbcnt = $this->cat->getFileCount(); - $countmsg = $this->getCountMessage( $rescnt, $dbcnt, 'file' ); - - $r .= "
\n"; - $r .= '

' . wfMsg( 'category-media-header', htmlspecialchars( $this->title->getText() ) ) . "

\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
"; - } - return $r; - } - - /** - * 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. - * - * @param $articles Array - * @param $articles_start_char Array - * @param $cutoff Int - * @return String - * @private - */ - function formatList( $articles, $articles_start_char, $cutoff = 6 ) { - $list = ''; - if ( count ( $articles ) > $cutoff ) { - $list = self::columnList( $articles, $articles_start_char ); - } elseif ( count( $articles ) > 0 ) { - // for short lists of articles in categories. - $list = self::shortList( $articles, $articles_start_char ); - } - - $pageLang = $this->title->getPageLanguage(); - $attribs = array( 'lang' => $pageLang->getCode(), 'dir' => $pageLang->getDir(), - 'class' => 'mw-content-'.$pageLang->getDir() ); - $list = Html::rawElement( 'div', $attribs, $list ); - - return $list; - } - - /** - * Format a list of articles chunked by letter in a three-column - * list, ordered vertically. - * - * TODO: Take the headers into account when creating columns, so they're - * more visually equal. - * - * More distant TODO: Scrap this and use CSS columns, whenever IE finally - * supports those. - * - * @param $articles Array - * @param $articles_start_char Array - * @return String - * @private - */ - 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 */ ); - - $ret = '\n
'; - $prevchar = null; - - foreach ( $columns as $column ) { - $colContents = array(); - - # Kind of like array_flip() here, but we keep duplicates in an - # array instead of dropping them. - foreach ( $column as $article => $char ) { - if ( !isset( $colContents[$char] ) ) { - $colContents[$char] = array(); - } - $colContents[$char][] = $article; - } - - $first = true; - foreach ( $colContents as $char => $articles ) { - $ret .= '

' . htmlspecialchars( $char ); - if ( $first && $char === $prevchar ) { - # We're continuing a previous chunk at the top of a new - # column, so add " cont." after the letter. - $ret .= ' ' . wfMsgHtml( 'listingcontinuesabbrev' ); - } - $ret .= "

\n"; - - $ret .= '
  • '; - $ret .= implode( "
    • \n
  • ", $articles ); - $ret .= '
'; - - $first = false; - $prevchar = $char; - } - - $ret .= "		"; - } - - $ret .= '
'; - return $ret; - } - - /** - * Format a list of articles chunked by letter in a bullet list. - * @param $articles Array - * @param $articles_start_char Array - * @return String - * @private - */ - static function shortList( $articles, $articles_start_char ) { - $r = '

' . htmlspecialchars( $articles_start_char[0] ) . "

\n"; - $r .= '

" . htmlspecialchars( $articles_start_char[$index] ) . "

\n'; - return $r; - } - - /** - * 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 - */ - private function pagingLinks( $first, $last, $type = '' ) { - $prevLink = wfMessage( 'prevn' )->numParams( $this->limit )->escaped(); - - if ( $first != '' ) { - $prevQuery = $this->query; - $prevQuery["{$type}until"] = $first; - unset( $prevQuery["{$type}from"] ); - $prevLink = Linker::linkKnown( - $this->addFragmentToTitle( $this->title, $type ), - $prevLink, - array(), - $prevQuery - ); - } - - $nextLink = wfMessage( 'nextn' )->numParams( $this->limit )->escaped(); - - if ( $last != '' ) { - $lastQuery = $this->query; - $lastQuery["{$type}from"] = $last; - unset( $lastQuery["{$type}until"] ); - $nextLink = Linker::linkKnown( - $this->addFragmentToTitle( $this->title, $type ), - $nextLink, - array(), - $lastQuery - ); - } - - return "($prevLink) ($nextLink)"; - } - - /** - * Takes a title, and adds the fragment identifier that - * corresponds to the correct segment of the category. - * - * @param Title $title: The title (usually $this->title) - * @param String $section: Which section - */ - private function addFragmentToTitle( $title, $section ) { - switch ( $section ) { - case 'page': - $fragment = 'mw-pages'; - break; - case 'subcat': - $fragment = 'mw-subcategories'; - break; - case 'file': - $fragment = 'mw-category-media'; - break; - default: - throw new MWException( __METHOD__ . - " Invalid section $section." ); - } - - return Title::makeTitle( $title->getNamespace(), - $title->getDBkey(), $fragment ); - } - /** - * What to do if the category table conflicts with the number of results - * returned? This function says what. Each type is considered independently - * of the other types. - * - * Note for grepping: uses the messages category-article-count, - * category-article-count-limited, category-subcat-count, - * category-subcat-count-limited, category-file-count, - * category-file-count-limited. - * - * @param $rescnt Int: The number of items returned by our database query. - * @param $dbcnt Int: The number of items according to the category table. - * @param $type String: 'subcat', 'article', or 'file' - * @return String: A message giving the number of items, to output to HTML. - */ - private function getCountMessage( $rescnt, $dbcnt, $type ) { - # There are three cases: - # 1) The category table figure seems sane. It might be wrong, but - # we can't do anything about it if we don't recalculate it on ev- - # ery category view. - # 2) The category table figure isn't sane, like it's smaller than the - # number of actual results, *but* the number of results is less - # than $this->limit and there's no offset. In this case we still - # know the right figure. - # 3) We have no idea. - - # 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 ( $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 - # quick due to the small number of entries. - $totalcnt = $rescnt; - $this->cat->refreshCounts(); - } else { - # Case 3: hopeless. Don't give a total count at all. - return wfMessage( "category-$type-count-limited" )->numParams( $rescnt )->parseAsBlock(); - } - return wfMessage( "category-$type-count" )->numParams( $rescnt, $totalcnt )->parseAsBlock(); - } -} diff --git a/includes/CategoryViewer.php b/includes/CategoryViewer.php new file mode 100644 index 0000000000..b66beaed67 --- /dev/null +++ b/includes/CategoryViewer.php @@ -0,0 +1,648 @@ +title = $title; + $this->setContext( $context ); + $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 + */ + public function getHTML() { + global $wgCategoryMagicGallery; + wfProfileIn( __METHOD__ ); + + $this->showGallery = $wgCategoryMagicGallery && !$this->getOutput()->mNoGallery; + + $this->clearCategoryState(); + $this->doCategoryQuery(); + $this->finaliseCategoryState(); + + $r = $this->getSubcategorySection() . + $this->getPagesSection() . + $this->getImageSection(); + + if ( $r == '' ) { + // If there is no category content to display, only + // show the top part of the navigation links. + // @todo FIXME: Cannot be completely suppressed because it + // is unknown if 'until' or 'from' makes this + // give 0 results. + $r = $r . $this->getCategoryTop(); + } else { + $r = $this->getCategoryTop() . + $r . + $this->getCategoryBottom(); + } + + // Give a proper message if category is empty + if ( $r == '' ) { + $r = wfMsgExt( 'category-empty', array( 'parse' ) ); + } + + $lang = $this->getLang(); + $langAttribs = array( 'lang' => $lang->getCode(), 'dir' => $lang->getDir() ); + # put a div around the headings which are in the user language + $r = Html::openElement( 'div', $langAttribs ) . $r . ''; + + wfProfileOut( __METHOD__ ); + return $r; + } + + function clearCategoryState() { + $this->articles = array(); + $this->articles_start_char = array(); + $this->children = array(); + $this->children_start_char = array(); + if ( $this->showGallery ) { + $this->gallery = new ImageGallery(); + $this->gallery->setHideBadImages(); + } else { + $this->imgsNoGallery = array(); + $this->imgsNoGallery_start_char = array(); + } + } + + /** + * Add a subcategory to the internal lists, using a Category object + */ + function addSubcategoryObject( Category $cat, $sortkey, $pageLength ) { + // Subcategory; strip the 'Category' namespace from the link text. + $title = $cat->getTitle(); + + $link = Linker::link( $title, htmlspecialchars( $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 = '' . $link . ''; + } + $this->children[] = $link; + + $this->children_start_char[] = + $this->getSubcategorySortChar( $cat->getTitle(), $sortkey ); + } + + /** + * Add a subcategory to the internal lists, using a title object + * @deprecated since 1.17 kept for compatibility, please use addSubcategoryObject instead + */ + function addSubcategory( Title $title, $sortkey, $pageLength ) { + $this->addSubcategoryObject( Category::newFromTitle( $title ), $sortkey, $pageLength ); + } + + /** + * Get the character to be used for sorting subcategories. + * If there's a link from Category:A to Category:B, the sortkey of the resulting + * 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 ) { + $word = $title->getDBkey(); + } else { + $word = $sortkey; + } + + $firstChar = $this->collation->getFirstLetter( $word ); + + return $wgContLang->convert( $firstChar ); + } + + /** + * Add a page in the image namespace + */ + function addImage( Title $title, $sortkey, $pageLength, $isRedirect = false ) { + global $wgContLang; + if ( $this->showGallery ) { + $flip = $this->flip['file']; + if ( $flip ) { + $this->gallery->insert( $title ); + } else { + $this->gallery->add( $title ); + } + } else { + $link = Linker::link( $title ); + if ( $isRedirect ) { + // This seems kind of pointless given 'mw-redirect' class, + // but keeping for back-compatibility with user css. + $link = '' . $link . ''; + } + $this->imgsNoGallery[] = $link; + + $this->imgsNoGallery_start_char[] = $wgContLang->convert( + $this->collation->getFirstLetter( $sortkey ) ); + } + } + + /** + * Add a miscellaneous page + */ + function addPage( $title, $sortkey, $pageLength, $isRedirect = false ) { + global $wgContLang; + + $link = Linker::link( $title ); + if ( $isRedirect ) { + // This seems kind of pointless given 'mw-redirect' class, + // but keeping for back-compatiability with user css. + $link = '' . $link . ''; + } + $this->articles[] = $link; + + $this->articles_start_char[] = $wgContLang->convert( + $this->collation->getFirstLetter( $sortkey ) ); + } + + function finaliseCategoryState() { + 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' ); + + $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; + } + + $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_merge( 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 ) + ) + ); + + $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 ); + } + + 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( $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 ); + } + } + } + } + + function getCategoryTop() { + $r = $this->getCategoryBottom(); + return $r === '' + ? $r + : "
\n" . $r; + } + + function getSubcategorySection() { + # Don't show subcategories section if there are none. + $r = ''; + $rescnt = count( $this->children ); + $dbcnt = $this->cat->getSubcatCount(); + $countmsg = $this->getCountMessage( $rescnt, $dbcnt, 'subcat' ); + + if ( $rescnt > 0 ) { + # Showing subcategories + $r .= "
\n"; + $r .= '

' . wfMsg( 'subcategories' ) . "

\n"; + $r .= $countmsg; + $r .= $this->getSectionPagingLinks( 'subcat' ); + $r .= $this->formatList( $this->children, $this->children_start_char ); + $r .= $this->getSectionPagingLinks( 'subcat' ); + $r .= "\n
"; + } + return $r; + } + + function getPagesSection() { + $ti = htmlspecialchars( $this->title->getText() ); + # Don't show articles section if there are none. + $r = ''; + + # @todo FIXME: Here and in the other two sections: we don't need to bother + # with this rigamarole if the entire category contents fit on one page + # and have already been retrieved. We can just use $rescnt in that + # case and save a query and some logic. + $dbcnt = $this->cat->getPageCount() - $this->cat->getSubcatCount() + - $this->cat->getFileCount(); + $rescnt = count( $this->articles ); + $countmsg = $this->getCountMessage( $rescnt, $dbcnt, 'article' ); + + if ( $rescnt > 0 ) { + $r = "
\n"; + $r .= '

' . wfMsg( 'category_header', $ti ) . "

\n"; + $r .= $countmsg; + $r .= $this->getSectionPagingLinks( 'page' ); + $r .= $this->formatList( $this->articles, $this->articles_start_char ); + $r .= $this->getSectionPagingLinks( 'page' ); + $r .= "\n
"; + } + return $r; + } + + function getImageSection() { + $r = ''; + $rescnt = $this->showGallery ? $this->gallery->count() : count( $this->imgsNoGallery ); + if ( $rescnt > 0 ) { + $dbcnt = $this->cat->getFileCount(); + $countmsg = $this->getCountMessage( $rescnt, $dbcnt, 'file' ); + + $r .= "
\n"; + $r .= '

' . wfMsg( 'category-media-header', htmlspecialchars( $this->title->getText() ) ) . "

\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
"; + } + return $r; + } + + /** + * 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. + * + * @param $articles Array + * @param $articles_start_char Array + * @param $cutoff Int + * @return String + * @private + */ + function formatList( $articles, $articles_start_char, $cutoff = 6 ) { + $list = ''; + if ( count ( $articles ) > $cutoff ) { + $list = self::columnList( $articles, $articles_start_char ); + } elseif ( count( $articles ) > 0 ) { + // for short lists of articles in categories. + $list = self::shortList( $articles, $articles_start_char ); + } + + $pageLang = $this->title->getPageLanguage(); + $attribs = array( 'lang' => $pageLang->getCode(), 'dir' => $pageLang->getDir(), + 'class' => 'mw-content-'.$pageLang->getDir() ); + $list = Html::rawElement( 'div', $attribs, $list ); + + return $list; + } + + /** + * Format a list of articles chunked by letter in a three-column + * list, ordered vertically. + * + * TODO: Take the headers into account when creating columns, so they're + * more visually equal. + * + * More distant TODO: Scrap this and use CSS columns, whenever IE finally + * supports those. + * + * @param $articles Array + * @param $articles_start_char Array + * @return String + * @private + */ + 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 */ ); + + $ret = '\n
'; + $prevchar = null; + + foreach ( $columns as $column ) { + $colContents = array(); + + # Kind of like array_flip() here, but we keep duplicates in an + # array instead of dropping them. + foreach ( $column as $article => $char ) { + if ( !isset( $colContents[$char] ) ) { + $colContents[$char] = array(); + } + $colContents[$char][] = $article; + } + + $first = true; + foreach ( $colContents as $char => $articles ) { + $ret .= '

' . htmlspecialchars( $char ); + if ( $first && $char === $prevchar ) { + # We're continuing a previous chunk at the top of a new + # column, so add " cont." after the letter. + $ret .= ' ' . wfMsgHtml( 'listingcontinuesabbrev' ); + } + $ret .= "

\n"; + + $ret .= '
  • '; + $ret .= implode( "
    • \n
  • ", $articles ); + $ret .= '
'; + + $first = false; + $prevchar = $char; + } + + $ret .= "		"; + } + + $ret .= '
'; + return $ret; + } + + /** + * Format a list of articles chunked by letter in a bullet list. + * @param $articles Array + * @param $articles_start_char Array + * @return String + * @private + */ + static function shortList( $articles, $articles_start_char ) { + $r = '

' . htmlspecialchars( $articles_start_char[0] ) . "

\n"; + $r .= '

" . htmlspecialchars( $articles_start_char[$index] ) . "

\n'; + return $r; + } + + /** + * 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 + */ + private function pagingLinks( $first, $last, $type = '' ) { + $prevLink = wfMessage( 'prevn' )->numParams( $this->limit )->escaped(); + + if ( $first != '' ) { + $prevQuery = $this->query; + $prevQuery["{$type}until"] = $first; + unset( $prevQuery["{$type}from"] ); + $prevLink = Linker::linkKnown( + $this->addFragmentToTitle( $this->title, $type ), + $prevLink, + array(), + $prevQuery + ); + } + + $nextLink = wfMessage( 'nextn' )->numParams( $this->limit )->escaped(); + + if ( $last != '' ) { + $lastQuery = $this->query; + $lastQuery["{$type}from"] = $last; + unset( $lastQuery["{$type}until"] ); + $nextLink = Linker::linkKnown( + $this->addFragmentToTitle( $this->title, $type ), + $nextLink, + array(), + $lastQuery + ); + } + + return "($prevLink) ($nextLink)"; + } + + /** + * Takes a title, and adds the fragment identifier that + * corresponds to the correct segment of the category. + * + * @param Title $title: The title (usually $this->title) + * @param String $section: Which section + */ + private function addFragmentToTitle( $title, $section ) { + switch ( $section ) { + case 'page': + $fragment = 'mw-pages'; + break; + case 'subcat': + $fragment = 'mw-subcategories'; + break; + case 'file': + $fragment = 'mw-category-media'; + break; + default: + throw new MWException( __METHOD__ . + " Invalid section $section." ); + } + + return Title::makeTitle( $title->getNamespace(), + $title->getDBkey(), $fragment ); + } + /** + * What to do if the category table conflicts with the number of results + * returned? This function says what. Each type is considered independently + * of the other types. + * + * Note for grepping: uses the messages category-article-count, + * category-article-count-limited, category-subcat-count, + * category-subcat-count-limited, category-file-count, + * category-file-count-limited. + * + * @param $rescnt Int: The number of items returned by our database query. + * @param $dbcnt Int: The number of items according to the category table. + * @param $type String: 'subcat', 'article', or 'file' + * @return String: A message giving the number of items, to output to HTML. + */ + private function getCountMessage( $rescnt, $dbcnt, $type ) { + # There are three cases: + # 1) The category table figure seems sane. It might be wrong, but + # we can't do anything about it if we don't recalculate it on ev- + # ery category view. + # 2) The category table figure isn't sane, like it's smaller than the + # number of actual results, *but* the number of results is less + # than $this->limit and there's no offset. In this case we still + # know the right figure. + # 3) We have no idea. + + # 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 ( $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 + # quick due to the small number of entries. + $totalcnt = $rescnt; + $this->cat->refreshCounts(); + } else { + # Case 3: hopeless. Don't give a total count at all. + return wfMessage( "category-$type-count-limited" )->numParams( $rescnt )->parseAsBlock(); + } + return wfMessage( "category-$type-count" )->numParams( $rescnt, $totalcnt )->parseAsBlock(); + } +}