3 * Implements Special:Prefixindex
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @ingroup SpecialPage
23 use MediaWiki\MediaWikiServices
;
26 * Implements Special:Prefixindex
28 * @ingroup SpecialPage
30 class SpecialPrefixindex
extends SpecialAllPages
{
33 * Whether to remove the searched prefix from the displayed link. Useful
34 * for inclusion of a set of sub pages in a root page.
36 protected $stripPrefix = false;
38 protected $hideRedirects = false;
40 // Inherit $maxPerPage
42 function __construct() {
43 parent
::__construct( 'Prefixindex' );
47 * Entry point : initialise variables and call subfunctions.
48 * @param string $par Becomes "FOO" when called like Special:Prefixindex/FOO (default null)
50 function execute( $par ) {
54 $this->outputHeader();
56 $out = $this->getOutput();
57 $out->addModuleStyles( 'mediawiki.special' );
60 $request = $this->getRequest();
61 $from = $request->getVal( 'from', '' );
62 $prefix = $request->getVal( 'prefix', '' );
63 $ns = $request->getIntOrNull( 'namespace' );
64 $namespace = (int)$ns; // if no namespace given, use 0 (NS_MAIN).
65 $this->hideRedirects
= $request->getBool( 'hideredirects', $this->hideRedirects
);
66 $this->stripPrefix
= $request->getBool( 'stripprefix', $this->stripPrefix
);
68 $namespaces = $wgContLang->getNamespaces();
70 ( $namespace > 0 && array_key_exists( $namespace, $namespaces ) )
71 ?
$this->msg( 'prefixindex-namespace', str_replace( '_', ' ', $namespaces[$namespace] ) )
72 : $this->msg( 'prefixindex' )
76 if ( $par !== null ) {
78 } elseif ( $prefix != '' ) {
80 } elseif ( $from != '' && $ns === null ) {
81 // For back-compat with Special:Allpages
82 // Don't do this if namespace is passed, so paging works when doing NS views.
86 // T29864: if transcluded, show all pages instead of the form.
87 if ( $this->including() ||
$showme != '' ||
$ns !== null ) {
88 $this->showPrefixChunk( $namespace, $showme, $from );
90 $out->addHTML( $this->namespacePrefixForm( $namespace, null ) );
95 * HTML for the top form
96 * @param int $namespace A namespace constant (default NS_MAIN).
97 * @param string $from DbKey we are starting listing at.
100 protected function namespacePrefixForm( $namespace = NS_MAIN
, $from = '' ) {
103 'label-message' => 'allpagesprefix',
108 'default' => str_replace( '_', ' ', $from ),
111 'type' => 'namespaceselect',
112 'name' => 'namespace',
114 'label-message' => 'namespace',
116 'default' => $namespace,
119 'class' => 'HTMLCheckField',
120 'name' => 'hideredirects',
121 'label-message' => 'allpages-hide-redirects',
124 'class' => 'HTMLCheckField',
125 'name' => 'stripprefix',
126 'label-message' => 'prefixindex-strip',
129 $context = new DerivativeContext( $this->getContext() );
130 $context->setTitle( $this->getPageTitle() ); // Remove subpage
131 $htmlForm = HTMLForm
::factory( 'ooui', $formDescriptor, $context );
134 ->setWrapperLegendMsg( 'prefixindex' )
135 ->setSubmitTextMsg( 'prefixindex-submit' );
137 return $htmlForm->prepareForm()->getHTML( false );
141 * @param int $namespace
142 * @param string $prefix
143 * @param string $from List all pages from this name (default false)
145 protected function showPrefixChunk( $namespace, $prefix, $from = null ) {
148 if ( $from === null ) {
152 $fromList = $this->getNamespaceKeyAndText( $namespace, $from );
153 $prefixList = $this->getNamespaceKeyAndText( $namespace, $prefix );
154 $namespaces = $wgContLang->getNamespaces();
159 if ( !$prefixList ||
!$fromList ) {
160 $out = $this->msg( 'allpagesbadtitle' )->parseAsBlock();
161 } elseif ( !array_key_exists( $namespace, $namespaces ) ) {
162 // Show errormessage and reset to NS_MAIN
163 $out = $this->msg( 'allpages-bad-ns', $namespace )->parse();
164 $namespace = NS_MAIN
;
166 list( $namespace, $prefixKey, $prefix ) = $prefixList;
167 list( /* $fromNS */, $fromKey, ) = $fromList;
169 # ## @todo FIXME: Should complain if $fromNs != $namespace
171 $dbr = wfGetDB( DB_REPLICA
);
174 'page_namespace' => $namespace,
175 'page_title' . $dbr->buildLike( $prefixKey, $dbr->anyString() ),
176 'page_title >= ' . $dbr->addQuotes( $fromKey ),
179 if ( $this->hideRedirects
) {
180 $conds['page_is_redirect'] = 0;
183 $res = $dbr->select( 'page',
185 [ 'page_namespace', 'page_title' ],
186 LinkCache
::getSelectFields()
191 'ORDER BY' => 'page_title',
192 'LIMIT' => $this->maxPerPage +
1,
193 'USE INDEX' => 'name_title',
197 // @todo FIXME: Side link to previous
199 if ( $res->numRows() > 0 ) {
200 $out = Html
::openElement( 'ul', [ 'class' => 'mw-prefixindex-list' ] );
201 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
203 $prefixLength = strlen( $prefix );
204 foreach ( $res as $row ) {
205 if ( $n >= $this->maxPerPage
) {
209 $title = Title
::newFromRow( $row );
210 // Make sure it gets into LinkCache
211 $linkCache->addGoodLinkObjFromRow( $title, $row );
212 $displayed = $title->getText();
213 // Try not to generate unclickable links
214 if ( $this->stripPrefix
&& $prefixLength !== strlen( $displayed ) ) {
215 $displayed = substr( $displayed, $prefixLength );
217 $link = ( $title->isRedirect() ?
'<div class="allpagesredirect">' : '' ) .
218 $this->getLinkRenderer()->makeKnownLink(
222 ( $title->isRedirect() ?
'</div>' : '' );
224 $out .= "<li>$link</li>\n";
228 $out .= Html
::closeElement( 'ul' );
230 if ( $res->numRows() > 2 ) {
231 // Only apply CSS column styles if there's more than 2 entries.
232 // Otherwise rendering is broken as "mw-prefixindex-body"'s CSS column count is 3.
233 $out = Html
::rawElement( 'div', [ 'class' => 'mw-prefixindex-body' ], $out );
240 $output = $this->getOutput();
242 if ( $this->including() ) {
243 // We don't show the nav-links and the form when included into other
244 // pages so let's just finish here.
245 $output->addHTML( $out );
249 $topOut = $this->namespacePrefixForm( $namespace, $prefix );
251 if ( $res && ( $n == $this->maxPerPage
) && $nextRow ) {
253 'from' => $nextRow->page_title
,
255 'hideredirects' => $this->hideRedirects
,
256 'stripprefix' => $this->stripPrefix
,
259 if ( $namespace ||
$prefix == '' ) {
260 // Keep the namespace even if it's 0 for empty prefixes.
261 // This tells us we're not just a holdover from old links.
262 $query['namespace'] = $namespace;
265 $nextLink = $this->getLinkRenderer()->makeKnownLink(
266 $this->getPageTitle(),
267 $this->msg( 'nextpage', str_replace( '_', ' ', $nextRow->page_title
) )->text(),
272 // Link shown at the top of the page below the form
273 $topOut .= Html
::rawElement( 'div',
274 [ 'class' => 'mw-prefixindex-nav' ],
278 // Link shown at the footer
279 $out .= "\n" . Html
::element( 'hr' ) .
282 [ 'class' => 'mw-prefixindex-nav' ],
288 $output->addHTML( $topOut . $out );
292 * Return an array of subpages beginning with $search that this special page will accept.
294 * @param string $search Prefix to search for
295 * @param int $limit Maximum number of results to return (usually 10)
296 * @param int $offset Number of results to skip (usually 0)
297 * @return string[] Matching subpages
299 public function prefixSearchSubpages( $search, $limit, $offset ) {
300 return $this->prefixSearchString( $search, $limit, $offset );
303 protected function getGroupName() {