wiki.techinc.nl/includes/CategoryViewer.php

775 lines
24 KiB
PHP
Raw Normal View History

2011-10-15 17:37:05 +00:00
<?php
/**
* List and paging of category members.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
Hooks::run() call site migration Migrate all callers of Hooks::run() to use the new HookContainer/HookRunner system. General principles: * Use DI if it is already used. We're not changing the way state is managed in this patch. * HookContainer is always injected, not HookRunner. HookContainer is a service, it's a more generic interface, it is the only thing that provides isRegistered() which is needed in some cases, and a HookRunner can be efficiently constructed from it (confirmed by benchmark). Because HookContainer is needed for object construction, it is also needed by all factories. * "Ask your friendly local base class". Big hierarchies like SpecialPage and ApiBase have getHookContainer() and getHookRunner() methods in the base class, and classes that extend that base class are not expected to know or care where the base class gets its HookContainer from. * ProtectedHookAccessorTrait provides protected getHookContainer() and getHookRunner() methods, getting them from the global service container. The point of this is to ease migration to DI by ensuring that call sites ask their local friendly base class rather than getting a HookRunner from the service container directly. * Private $this->hookRunner. In some smaller classes where accessor methods did not seem warranted, there is a private HookRunner property which is accessed directly. Very rarely (two cases), there is a protected property, for consistency with code that conventionally assumes protected=private, but in cases where the class might actually be overridden, a protected accessor is preferred over a protected property. * The last resort: Hooks::runner(). Mostly for static, file-scope and global code. In a few cases it was used for objects with broken construction schemes, out of horror or laziness. Constructors with new required arguments: * AuthManager * BadFileLookup * BlockManager * ClassicInterwikiLookup * ContentHandlerFactory * ContentSecurityPolicy * DefaultOptionsManager * DerivedPageDataUpdater * FullSearchResultWidget * HtmlCacheUpdater * LanguageFactory * LanguageNameUtils * LinkRenderer * LinkRendererFactory * LocalisationCache * MagicWordFactory * MessageCache * NamespaceInfo * PageEditStash * PageHandlerFactory * PageUpdater * ParserFactory * PermissionManager * RevisionStore * RevisionStoreFactory * SearchEngineConfig * SearchEngineFactory * SearchFormWidget * SearchNearMatcher * SessionBackend * SpecialPageFactory * UserNameUtils * UserOptionsManager * WatchedItemQueryService * WatchedItemStore Constructors with new optional arguments: * DefaultPreferencesFactory * Language * LinkHolderArray * MovePage * Parser * ParserCache * PasswordReset * Router setHookContainer() now required after construction: * AuthenticationProvider * ResourceLoaderModule * SearchEngine Change-Id: Id442b0dbe43aba84bd5cf801d86dedc768b082c7
2020-03-19 02:42:09 +00:00
use MediaWiki\HookContainer\ProtectedHookAccessorTrait;
use MediaWiki\MediaWikiServices;
2011-10-15 17:37:05 +00:00
class CategoryViewer extends ContextSource {
Hooks::run() call site migration Migrate all callers of Hooks::run() to use the new HookContainer/HookRunner system. General principles: * Use DI if it is already used. We're not changing the way state is managed in this patch. * HookContainer is always injected, not HookRunner. HookContainer is a service, it's a more generic interface, it is the only thing that provides isRegistered() which is needed in some cases, and a HookRunner can be efficiently constructed from it (confirmed by benchmark). Because HookContainer is needed for object construction, it is also needed by all factories. * "Ask your friendly local base class". Big hierarchies like SpecialPage and ApiBase have getHookContainer() and getHookRunner() methods in the base class, and classes that extend that base class are not expected to know or care where the base class gets its HookContainer from. * ProtectedHookAccessorTrait provides protected getHookContainer() and getHookRunner() methods, getting them from the global service container. The point of this is to ease migration to DI by ensuring that call sites ask their local friendly base class rather than getting a HookRunner from the service container directly. * Private $this->hookRunner. In some smaller classes where accessor methods did not seem warranted, there is a private HookRunner property which is accessed directly. Very rarely (two cases), there is a protected property, for consistency with code that conventionally assumes protected=private, but in cases where the class might actually be overridden, a protected accessor is preferred over a protected property. * The last resort: Hooks::runner(). Mostly for static, file-scope and global code. In a few cases it was used for objects with broken construction schemes, out of horror or laziness. Constructors with new required arguments: * AuthManager * BadFileLookup * BlockManager * ClassicInterwikiLookup * ContentHandlerFactory * ContentSecurityPolicy * DefaultOptionsManager * DerivedPageDataUpdater * FullSearchResultWidget * HtmlCacheUpdater * LanguageFactory * LanguageNameUtils * LinkRenderer * LinkRendererFactory * LocalisationCache * MagicWordFactory * MessageCache * NamespaceInfo * PageEditStash * PageHandlerFactory * PageUpdater * ParserFactory * PermissionManager * RevisionStore * RevisionStoreFactory * SearchEngineConfig * SearchEngineFactory * SearchFormWidget * SearchNearMatcher * SessionBackend * SpecialPageFactory * UserNameUtils * UserOptionsManager * WatchedItemQueryService * WatchedItemStore Constructors with new optional arguments: * DefaultPreferencesFactory * Language * LinkHolderArray * MovePage * Parser * ParserCache * PasswordReset * Router setHookContainer() now required after construction: * AuthenticationProvider * ResourceLoaderModule * SearchEngine Change-Id: Id442b0dbe43aba84bd5cf801d86dedc768b082c7
2020-03-19 02:42:09 +00:00
use ProtectedHookAccessorTrait;
/** @var int */
public $limit;
2011-10-15 17:37:05 +00:00
/** @var array */
public $from;
2011-10-15 17:37:05 +00:00
/** @var array */
public $until;
2011-10-15 17:37:05 +00:00
/** @var string[] */
public $articles;
2011-10-15 17:37:05 +00:00
/** @var array */
public $articles_start_char;
2011-10-15 17:37:05 +00:00
/** @var array */
public $children;
2011-10-15 17:37:05 +00:00
/** @var array */
public $children_start_char;
/** @var bool */
public $showGallery;
/** @var array */
public $imgsNoGallery_start_char;
/** @var array */
public $imgsNoGallery;
/** @var array */
public $nextPage;
/** @var array */
protected $prevPage;
/** @var array */
public $flip;
/** @var Title */
public $title;
/** @var Collation */
public $collation;
/** @var ImageGalleryBase */
public $gallery;
/** @var Category Category object for this page. */
2011-10-15 17:37:05 +00:00
private $cat;
/** @var array The original query array, to be used in generating paging links. */
2011-10-15 17:37:05 +00:00
private $query;
/** @var ILanguageConverter */
private $languageConverter;
2011-10-15 17:37:05 +00:00
/**
* @since 1.19 $context is a second, required parameter
* @param Title $title
* @param IContextSource $context
* @param array $from An array with keys page, subcat,
* and file for offset of results of each section (since 1.17)
* @param array $until An array with 3 keys for until of each section (since 1.17)
* @param array $query
2011-10-15 17:37:05 +00:00
*/
public function __construct( $title, IContextSource $context, $from = [],
$until = [], $query = []
) {
2011-10-15 17:37:05 +00:00
$this->title = $title;
$this->setContext( $context );
$this->getOutput()->addModuleStyles( [
'mediawiki.action.view.categoryPage.styles'
] );
2011-10-15 17:37:05 +00:00
$this->from = $from;
$this->until = $until;
$this->limit = $context->getConfig()->get( 'CategoryPagingLimit' );
2011-10-15 17:37:05 +00:00
$this->cat = Category::newFromTitle( $title );
$this->query = $query;
$this->collation = MediaWikiServices::getInstance()->getCollationFactory()->getCategoryCollation();
$this->languageConverter = MediaWikiServices::getInstance()
->getLanguageConverterFactory()->getLanguageConverter();
2011-10-15 17:37:05 +00:00
unset( $this->query['title'] );
}
/**
* Format the category data list.
*
* @return string HTML output
*/
public function getHTML() {
$this->showGallery = $this->getConfig()->get( 'CategoryMagicGallery' )
&& !$this->getOutput()->mNoGallery;
2011-10-15 17:37:05 +00:00
$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 = $this->getCategoryTop();
2011-10-15 17:37:05 +00:00
} else {
$r = $this->getCategoryTop() .
$r .
$this->getCategoryBottom();
}
// Give a proper message if category is empty
if ( $r == '' ) {
$r = $this->msg( 'category-empty' )->parseAsBlock();
2011-10-15 17:37:05 +00:00
}
$lang = $this->getLanguage();
$attribs = [
'class' => 'mw-category-generated',
'lang' => $lang->getHtmlCode(),
'dir' => $lang->getDir()
];
2011-10-15 17:37:05 +00:00
# put a div around the headings which are in the user language
$r = Html::rawElement( 'div', $attribs, $r );
2011-10-15 17:37:05 +00:00
return $r;
}
protected function clearCategoryState() {
$this->articles = [];
$this->articles_start_char = [];
$this->children = [];
$this->children_start_char = [];
2011-10-15 17:37:05 +00:00
if ( $this->showGallery ) {
// Note that null for mode is taken to mean use default.
$mode = $this->getRequest()->getVal( 'gallerymode', null );
try {
$this->gallery = ImageGalleryBase::factory( $mode, $this->getContext() );
} catch ( Exception $e ) {
// User specified something invalid, fallback to default.
$this->gallery = ImageGalleryBase::factory( false, $this->getContext() );
}
2011-10-15 17:37:05 +00:00
$this->gallery->setHideBadImages();
} else {
$this->imgsNoGallery = [];
$this->imgsNoGallery_start_char = [];
2011-10-15 17:37:05 +00:00
}
}
/**
* Add a subcategory to the internal lists, using a Category object
* @param Category $cat
* @param string $sortkey
* @param int $pageLength
2011-10-15 17:37:05 +00:00
*/
public function addSubcategoryObject( Category $cat, $sortkey, $pageLength ) {
2011-10-15 17:37:05 +00:00
// Subcategory; strip the 'Category' namespace from the link text.
$title = $cat->getTitle();
$this->children[] = $this->generateLink(
'subcat',
$title,
$title->isRedirect(),
htmlspecialchars( $title->getText() )
);
2011-10-15 17:37:05 +00:00
$this->children_start_char[] =
$this->getSubcategorySortChar( $cat->getTitle(), $sortkey );
}
/**
* @param string $type
* @param Title $title
* @param bool $isRedirect
* @param string|null $html
* @return string
* Annotations needed to tell taint about HtmlArmor,
* due to the use of the hook it is not possible to avoid raw html handling here
* @param-taint $html tainted
* @return-taint escaped
*/
private function generateLink( $type, Title $title, $isRedirect, $html = null ) {
$link = null;
Hooks::run() call site migration Migrate all callers of Hooks::run() to use the new HookContainer/HookRunner system. General principles: * Use DI if it is already used. We're not changing the way state is managed in this patch. * HookContainer is always injected, not HookRunner. HookContainer is a service, it's a more generic interface, it is the only thing that provides isRegistered() which is needed in some cases, and a HookRunner can be efficiently constructed from it (confirmed by benchmark). Because HookContainer is needed for object construction, it is also needed by all factories. * "Ask your friendly local base class". Big hierarchies like SpecialPage and ApiBase have getHookContainer() and getHookRunner() methods in the base class, and classes that extend that base class are not expected to know or care where the base class gets its HookContainer from. * ProtectedHookAccessorTrait provides protected getHookContainer() and getHookRunner() methods, getting them from the global service container. The point of this is to ease migration to DI by ensuring that call sites ask their local friendly base class rather than getting a HookRunner from the service container directly. * Private $this->hookRunner. In some smaller classes where accessor methods did not seem warranted, there is a private HookRunner property which is accessed directly. Very rarely (two cases), there is a protected property, for consistency with code that conventionally assumes protected=private, but in cases where the class might actually be overridden, a protected accessor is preferred over a protected property. * The last resort: Hooks::runner(). Mostly for static, file-scope and global code. In a few cases it was used for objects with broken construction schemes, out of horror or laziness. Constructors with new required arguments: * AuthManager * BadFileLookup * BlockManager * ClassicInterwikiLookup * ContentHandlerFactory * ContentSecurityPolicy * DefaultOptionsManager * DerivedPageDataUpdater * FullSearchResultWidget * HtmlCacheUpdater * LanguageFactory * LanguageNameUtils * LinkRenderer * LinkRendererFactory * LocalisationCache * MagicWordFactory * MessageCache * NamespaceInfo * PageEditStash * PageHandlerFactory * PageUpdater * ParserFactory * PermissionManager * RevisionStore * RevisionStoreFactory * SearchEngineConfig * SearchEngineFactory * SearchFormWidget * SearchNearMatcher * SessionBackend * SpecialPageFactory * UserNameUtils * UserOptionsManager * WatchedItemQueryService * WatchedItemStore Constructors with new optional arguments: * DefaultPreferencesFactory * Language * LinkHolderArray * MovePage * Parser * ParserCache * PasswordReset * Router setHookContainer() now required after construction: * AuthenticationProvider * ResourceLoaderModule * SearchEngine Change-Id: Id442b0dbe43aba84bd5cf801d86dedc768b082c7
2020-03-19 02:42:09 +00:00
$this->getHookRunner()->onCategoryViewer__generateLink( $type, $title, $html, $link );
if ( $link === null ) {
$linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
if ( $html !== null ) {
$html = new HtmlArmor( $html );
}
$link = $linkRenderer->makeLink( $title, $html );
}
if ( $isRedirect ) {
$link = Html::rawElement(
'span',
[ 'class' => 'redirect-in-category' ],
$link
);
}
return $link;
}
2011-10-15 17:37:05 +00:00
/**
* 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).
2012-02-09 21:33:27 +00:00
* @return string
*/
public function getSubcategorySortChar( $title, $sortkey ) {
2011-10-15 17:37:05 +00:00
if ( $title->getPrefixedText() == $sortkey ) {
$word = $title->getDBkey();
} else {
$word = $sortkey;
}
$firstChar = $this->collation->getFirstLetter( $word );
return $this->languageConverter->convert( $firstChar );
2011-10-15 17:37:05 +00:00
}
/**
* Add a page in the image namespace
* @param Title $title
* @param string $sortkey
* @param int $pageLength
* @param bool $isRedirect
2011-10-15 17:37:05 +00:00
*/
public function addImage( Title $title, $sortkey, $pageLength, $isRedirect = false ) {
2011-10-15 17:37:05 +00:00
if ( $this->showGallery ) {
$flip = $this->flip['file'];
if ( $flip ) {
$this->gallery->insert( $title );
} else {
$this->gallery->add( $title );
}
} else {
$this->imgsNoGallery[] = $this->generateLink( 'image', $title, $isRedirect );
2011-10-15 17:37:05 +00:00
$this->imgsNoGallery_start_char[] =
$this->languageConverter->convert( $this->collation->getFirstLetter( $sortkey ) );
2011-10-15 17:37:05 +00:00
}
}
/**
* Add a miscellaneous page
* @param Title $title
* @param string $sortkey
* @param int $pageLength
* @param bool $isRedirect
2011-10-15 17:37:05 +00:00
*/
public function addPage( $title, $sortkey, $pageLength, $isRedirect = false ) {
$this->articles[] = $this->generateLink( 'page', $title, $isRedirect );
2011-10-15 17:37:05 +00:00
$this->articles_start_char[] =
$this->languageConverter->convert( $this->collation->getFirstLetter( $sortkey ) );
2011-10-15 17:37:05 +00:00
}
protected function finaliseCategoryState() {
2011-10-15 17:37:05 +00:00
if ( $this->flip['subcat'] ) {
$this->children = array_reverse( $this->children );
2011-10-15 17:37:05 +00:00
$this->children_start_char = array_reverse( $this->children_start_char );
}
if ( $this->flip['page'] ) {
$this->articles = array_reverse( $this->articles );
2011-10-15 17:37:05 +00:00
$this->articles_start_char = array_reverse( $this->articles_start_char );
}
if ( !$this->showGallery && $this->flip['file'] ) {
$this->imgsNoGallery = array_reverse( $this->imgsNoGallery );
2011-10-15 17:37:05 +00:00
$this->imgsNoGallery_start_char = array_reverse( $this->imgsNoGallery_start_char );
}
}
protected function doCategoryQuery() {
$dbr = wfGetDB( DB_REPLICA, 'category' );
2011-10-15 17:37:05 +00:00
$this->nextPage = [
2011-10-15 17:37:05 +00:00
'page' => null,
'subcat' => null,
'file' => null,
];
$this->prevPage = [
'page' => null,
'subcat' => null,
'file' => null,
];
$this->flip = [ 'page' => false, 'subcat' => false, 'file' => false ];
2011-10-15 17:37:05 +00:00
foreach ( [ 'page', 'subcat', 'file' ] as $type ) {
2011-10-15 17:37:05 +00:00
# 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 = [ 'cl_type' => $type ];
if ( isset( $this->from[$type] ) ) {
2011-10-15 17:37:05 +00:00
$extraConds[] = 'cl_sortkey >= '
. $dbr->addQuotes( $this->collation->getSortKey( $this->from[$type] ) );
} elseif ( isset( $this->until[$type] ) ) {
2011-10-15 17:37:05 +00:00
$extraConds[] = 'cl_sortkey < '
. $dbr->addQuotes( $this->collation->getSortKey( $this->until[$type] ) );
$this->flip[$type] = true;
}
$res = $dbr->select(
[ 'page', 'categorylinks', 'category' ],
array_merge(
LinkCache::getSelectFields(),
[
'page_namespace',
'page_title',
'cl_sortkey',
'cat_id',
'cat_title',
'cat_subcats',
'cat_pages',
'cat_files',
'cl_sortkey_prefix',
'cl_collation'
]
),
array_merge( [ 'cl_to' => $this->title->getDBkey() ], $extraConds ),
2011-10-15 17:37:05 +00:00
__METHOD__,
[
'USE INDEX' => [ 'categorylinks' => 'cl_sortkey' ],
2011-10-15 17:37:05 +00:00
'LIMIT' => $this->limit + 1,
'ORDER BY' => $this->flip[$type] ? 'cl_sortkey DESC' : 'cl_sortkey',
],
[
'categorylinks' => [ 'JOIN', 'cl_from = page_id' ],
'category' => [ 'LEFT JOIN', [
'cat_title = page_title',
'page_namespace' => NS_CATEGORY
] ]
]
2011-10-15 17:37:05 +00:00
);
Hooks::run() call site migration Migrate all callers of Hooks::run() to use the new HookContainer/HookRunner system. General principles: * Use DI if it is already used. We're not changing the way state is managed in this patch. * HookContainer is always injected, not HookRunner. HookContainer is a service, it's a more generic interface, it is the only thing that provides isRegistered() which is needed in some cases, and a HookRunner can be efficiently constructed from it (confirmed by benchmark). Because HookContainer is needed for object construction, it is also needed by all factories. * "Ask your friendly local base class". Big hierarchies like SpecialPage and ApiBase have getHookContainer() and getHookRunner() methods in the base class, and classes that extend that base class are not expected to know or care where the base class gets its HookContainer from. * ProtectedHookAccessorTrait provides protected getHookContainer() and getHookRunner() methods, getting them from the global service container. The point of this is to ease migration to DI by ensuring that call sites ask their local friendly base class rather than getting a HookRunner from the service container directly. * Private $this->hookRunner. In some smaller classes where accessor methods did not seem warranted, there is a private HookRunner property which is accessed directly. Very rarely (two cases), there is a protected property, for consistency with code that conventionally assumes protected=private, but in cases where the class might actually be overridden, a protected accessor is preferred over a protected property. * The last resort: Hooks::runner(). Mostly for static, file-scope and global code. In a few cases it was used for objects with broken construction schemes, out of horror or laziness. Constructors with new required arguments: * AuthManager * BadFileLookup * BlockManager * ClassicInterwikiLookup * ContentHandlerFactory * ContentSecurityPolicy * DefaultOptionsManager * DerivedPageDataUpdater * FullSearchResultWidget * HtmlCacheUpdater * LanguageFactory * LanguageNameUtils * LinkRenderer * LinkRendererFactory * LocalisationCache * MagicWordFactory * MessageCache * NamespaceInfo * PageEditStash * PageHandlerFactory * PageUpdater * ParserFactory * PermissionManager * RevisionStore * RevisionStoreFactory * SearchEngineConfig * SearchEngineFactory * SearchFormWidget * SearchNearMatcher * SessionBackend * SpecialPageFactory * UserNameUtils * UserOptionsManager * WatchedItemQueryService * WatchedItemStore Constructors with new optional arguments: * DefaultPreferencesFactory * Language * LinkHolderArray * MovePage * Parser * ParserCache * PasswordReset * Router setHookContainer() now required after construction: * AuthenticationProvider * ResourceLoaderModule * SearchEngine Change-Id: Id442b0dbe43aba84bd5cf801d86dedc768b082c7
2020-03-19 02:42:09 +00:00
$this->getHookRunner()->onCategoryViewer__doCategoryQuery( $type, $res );
$linkCache = MediaWikiServices::getInstance()->getLinkCache();
2011-10-15 17:37:05 +00:00
$count = 0;
foreach ( $res as $row ) {
$title = Title::newFromRow( $row );
$linkCache->addGoodLinkObjFromRow( $title, $row );
2011-10-15 17:37:05 +00:00
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 ( $count == $this->limit ) {
$this->prevPage[$type] = $humanSortkey;
}
2011-10-15 17:37:05 +00:00
if ( $title->getNamespace() === NS_CATEGORY ) {
2011-10-15 17:37:05 +00:00
$cat = Category::newFromRow( $row, $title );
$this->addSubcategoryObject( $cat, $humanSortkey, $row->page_len );
} elseif ( $title->getNamespace() === NS_FILE ) {
2011-10-15 17:37:05 +00:00
$this->addImage( $title, $humanSortkey, $row->page_len, $row->page_is_redirect );
} else {
$this->addPage( $title, $humanSortkey, $row->page_len, $row->page_is_redirect );
}
}
}
}
2011-10-29 01:53:28 +00:00
/**
* @return string
*/
protected function getCategoryTop() {
2011-10-15 17:37:05 +00:00
$r = $this->getCategoryBottom();
return $r === ''
? $r
: "<br style=\"clear:both;\"/>\n" . $r;
}
2011-10-29 01:53:28 +00:00
/**
* @return string
*/
protected function getSubcategorySection() {
2011-10-15 17:37:05 +00:00
# Don't show subcategories section if there are none.
$r = '';
$rescnt = count( $this->children );
$dbcnt = $this->cat->getSubcatCount();
// This function should be called even if the result isn't used, it has side-effects
2011-10-15 17:37:05 +00:00
$countmsg = $this->getCountMessage( $rescnt, $dbcnt, 'subcat' );
if ( $rescnt > 0 ) {
# Showing subcategories
$r .= Html::openElement( 'div', [ 'id' => 'mw-subcategories' ] ) . "\n";
$r .= Html::rawElement( 'h2', [], $this->msg( 'subcategories' )->parse() ) . "\n";
2011-10-15 17:37:05 +00:00
$r .= $countmsg;
$r .= $this->getSectionPagingLinks( 'subcat' );
$r .= $this->formatList( $this->children, $this->children_start_char );
$r .= $this->getSectionPagingLinks( 'subcat' );
$r .= "\n" . Html::closeElement( 'div' );
2011-10-15 17:37:05 +00:00
}
return $r;
}
2011-10-29 01:53:28 +00:00
/**
* @return string
*/
protected function getPagesSection() {
$name = $this->getOutput()->getUnprefixedDisplayTitle();
2011-10-15 17:37:05 +00:00
# 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 rigmarole if the entire category contents fit on one page
2011-10-15 17:37:05 +00:00
# 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 );
// This function should be called even if the result isn't used, it has side-effects
2011-10-15 17:37:05 +00:00
$countmsg = $this->getCountMessage( $rescnt, $dbcnt, 'article' );
if ( $rescnt > 0 ) {
$r .= Html::openElement( 'div', [ 'id' => 'mw-pages' ] ) . "\n";
$r .= Html::rawElement(
'h2',
[],
$this->msg( 'category_header' )->rawParams( $name )->parse()
) . "\n";
2011-10-15 17:37:05 +00:00
$r .= $countmsg;
$r .= $this->getSectionPagingLinks( 'page' );
$r .= $this->formatList( $this->articles, $this->articles_start_char );
$r .= $this->getSectionPagingLinks( 'page' );
$r .= "\n" . Html::closeElement( 'div' );
2011-10-15 17:37:05 +00:00
}
return $r;
}
2011-10-29 01:53:28 +00:00
/**
* @return string
*/
protected function getImageSection() {
$name = $this->getOutput()->getUnprefixedDisplayTitle();
2011-10-15 17:37:05 +00:00
$r = '';
$rescnt = $this->showGallery ? $this->gallery->count() : count( $this->imgsNoGallery );
$dbcnt = $this->cat->getFileCount();
// This function should be called even if the result isn't used, it has side-effects
$countmsg = $this->getCountMessage( $rescnt, $dbcnt, 'file' );
2011-10-15 17:37:05 +00:00
if ( $rescnt > 0 ) {
$r .= Html::openElement( 'div', [ 'id' => 'mw-category-media' ] ) . "\n";
$r .= Html::rawElement(
'h2',
[],
$this->msg( 'category-media-header' )->rawParams( $name )->parse()
) . "\n";
2011-10-15 17:37:05 +00:00
$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" . Html::closeElement( 'div' );
2011-10-15 17:37:05 +00:00
}
return $r;
}
/**
* Get the paging links for a section (subcats/pages/files), to go at the top and bottom
* of the output.
*
* @param string $type 'page', 'subcat', or 'file'
* @return string HTML output, possibly empty if there are no other pages
2011-10-15 17:37:05 +00:00
*/
private function getSectionPagingLinks( $type ) {
if ( isset( $this->until[$type] ) ) {
// The new value for the until parameter should be pointing to the first
// result displayed on the page which is the second last result retrieved
// from the database.The next link should have a from parameter pointing
// to the until parameter of the current page.
if ( $this->nextPage[$type] !== null ) {
return $this->pagingLinks( $this->prevPage[$type], $this->until[$type], $type );
} else {
// If the nextPage variable is null, it means that we have reached the first page
// and therefore the previous link should be disabled.
return $this->pagingLinks( null, $this->until[$type], $type );
}
} elseif ( $this->nextPage[$type] !== null || isset( $this->from[$type] ) ) {
2011-10-15 17:37:05 +00:00
return $this->pagingLinks( $this->from[$type], $this->nextPage[$type], $type );
} else {
return '';
}
}
2011-10-29 01:53:28 +00:00
/**
* @return string
*/
protected function getCategoryBottom() {
2011-10-15 17:37:05 +00:00
return '';
}
/**
* Format a list of articles chunked by letter, either as a
* bullet list or a columnar format, depending on the length.
*
* @param array $articles
* @param array $articles_start_char
* @param int $cutoff
* @return string
* @internal
2011-10-15 17:37:05 +00:00
*/
private function formatList( $articles, $articles_start_char, $cutoff = 6 ) {
2011-10-15 17:37:05 +00:00
$list = '';
if ( count( $articles ) > $cutoff ) {
2011-10-15 17:37:05 +00:00
$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 = [ 'lang' => $pageLang->getHtmlCode(), 'dir' => $pageLang->getDir(),
'class' => 'mw-content-' . $pageLang->getDir() ];
2011-10-15 17:37:05 +00:00
$list = Html::rawElement( 'div', $attribs, $list );
return $list;
}
/**
* Format a list of articles chunked by letter in a three-column list, ordered
* vertically. This is used for categories with a significant number of pages.
2011-10-15 17:37:05 +00:00
*
* TODO: Take the headers into account when creating columns, so they're
* more visually equal.
*
* TODO: shortList and columnList are similar, need merging
2011-10-15 17:37:05 +00:00
*
* @param string[] $articles HTML links to each article
* @param string[] $articles_start_char The header characters for each article
* @return string HTML to output
* @internal
2011-10-15 17:37:05 +00:00
*/
public static function columnList( $articles, $articles_start_char ) {
2011-10-15 17:37:05 +00:00
$columns = array_combine( $articles, $articles_start_char );
$ret = Html::openElement( 'div', [ 'class' => 'mw-category' ] );
2011-10-15 17:37:05 +00:00
$colContents = [];
2011-10-15 17:37:05 +00:00
# Kind of like array_flip() here, but we keep duplicates in an
# array instead of dropping them.
foreach ( $columns as $article => $char ) {
if ( !isset( $colContents[$char] ) ) {
$colContents[$char] = [];
2011-10-15 17:37:05 +00:00
}
$colContents[$char][] = $article;
}
2011-10-15 17:37:05 +00:00
foreach ( $colContents as $char => $articles ) {
# Change space to non-breaking space to keep headers aligned
$h3char = $char === ' ' ? "\u{00A0}" : htmlspecialchars( $char );
$ret .= Html::openELement( 'div', [ 'class' => 'mw-category-group' ] );
$ret .= Html::rawElement( 'h3', [], $h3char ) . "\n";
$ret .= Html::openElement( 'ul' );
$ret .= implode(
"\n",
array_map(
static function ( $article ) {
return Html::rawElement( 'li', [], $article );
},
$articles
)
);
$ret .= Html::closeElement( 'ul' ) . Html::closeElement( 'div' );
2011-10-15 17:37:05 +00:00
}
$ret .= Html::closeElement( 'div' );
2011-10-15 17:37:05 +00:00
return $ret;
}
/**
* Format a list of articles chunked by letter in a bullet list. This is used
* for categories with a small number of pages (when columns aren't needed).
* @param string[] $articles HTML links to each article
* @param string[] $articles_start_char The header characters for each article
* @return string HTML to output
* @internal
2011-10-15 17:37:05 +00:00
*/
public static function shortList( $articles, $articles_start_char ) {
2011-10-15 17:37:05 +00:00
$r = '<h3>' . htmlspecialchars( $articles_start_char[0] ) . "</h3>\n";
$r .= '<ul><li>' . $articles[0] . '</li>';
$articleCount = count( $articles );
for ( $index = 1; $index < $articleCount; $index++ ) {
2011-10-15 17:37:05 +00:00
if ( $articles_start_char[$index] != $articles_start_char[$index - 1] ) {
$r .= "</ul><h3>" . htmlspecialchars( $articles_start_char[$index] ) . "</h3>\n<ul>";
}
$r .= "<li>{$articles[$index]}</li>";
}
$r .= '</ul>';
return $r;
}
/**
* Create paging links, as a helper method to getSectionPagingLinks().
*
* @param string $first The 'until' parameter for the generated URL
* @param string $last The 'from' parameter for the generated URL
* @param string $type A prefix for parameters, 'page' or 'subcat' or
2011-10-15 17:37:05 +00:00
* 'file'
* @return string HTML
2011-10-15 17:37:05 +00:00
*/
private function pagingLinks( $first, $last, $type = '' ) {
$prevLink = $this->msg( 'prev-page' )->escaped();
2011-10-15 17:37:05 +00:00
$linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
2011-10-15 17:37:05 +00:00
if ( $first != '' ) {
$prevQuery = $this->query;
$prevQuery["{$type}until"] = $first;
unset( $prevQuery["{$type}from"] );
$prevLink = $linkRenderer->makeKnownLink(
2011-10-15 17:37:05 +00:00
$this->addFragmentToTitle( $this->title, $type ),
new HtmlArmor( $prevLink ),
[],
2011-10-15 17:37:05 +00:00
$prevQuery
);
}
$nextLink = $this->msg( 'next-page' )->escaped();
2011-10-15 17:37:05 +00:00
if ( $last != '' ) {
$lastQuery = $this->query;
$lastQuery["{$type}from"] = $last;
unset( $lastQuery["{$type}until"] );
$nextLink = $linkRenderer->makeKnownLink(
2011-10-15 17:37:05 +00:00
$this->addFragmentToTitle( $this->title, $type ),
new HtmlArmor( $nextLink ),
[],
2011-10-15 17:37:05 +00:00
$lastQuery
);
}
return $this->msg( 'categoryviewer-pagedlinks' )->rawParams( $prevLink, $nextLink )->escaped();
2011-10-15 17:37:05 +00:00
}
/**
* 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
* @throws MWException
2011-10-29 01:53:28 +00:00
* @return Title
2011-10-15 17:37:05 +00:00
*/
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 );
}
2011-10-15 17:37:05 +00:00
/**
* 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.
*
* @param int $rescnt The number of items returned by our database query.
* @param int $dbcnt The number of items according to the category table.
* @param string $type 'subcat', 'article', or 'file'
* @return string A message giving the number of items, to output to HTML.
2011-10-15 17:37:05 +00:00
*/
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
2011-10-15 17:37:05 +00:00
// 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 ( isset( $this->from[$pagingType] ) || isset( $this->until[$pagingType] ) ) {
2011-10-15 17:37:05 +00:00
$fromOrUntil = true;
}
if ( $dbcnt == $rescnt ||
( ( $rescnt == $this->limit || $fromOrUntil ) && $dbcnt > $rescnt )
) {
// Case 1: seems sane.
2011-10-15 17:37:05 +00:00
$totalcnt = $dbcnt;
} elseif ( $rescnt < $this->limit && !$fromOrUntil ) {
// Case 2: not sane, but salvageable. Use the number of results.
2011-10-15 17:37:05 +00:00
$totalcnt = $rescnt;
} else {
// Case 3: hopeless. Don't give a total count at all.
// Messages: category-subcat-count-limited, category-article-count-limited,
// category-file-count-limited
return $this->msg( "category-$type-count-limited" )->numParams( $rescnt )->parseAsBlock();
2011-10-15 17:37:05 +00:00
}
// Messages: category-subcat-count, category-article-count, category-file-count
return $this->msg( "category-$type-count" )->numParams( $rescnt, $totalcnt )->parseAsBlock();
2011-10-15 17:37:05 +00:00
}
}