3 * Implements Special:Allpages
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
25 * Implements Special:Allpages
27 * @ingroup SpecialPage
28 * @todo Rewrite using IndexPager
30 class SpecialAllPages
extends IncludableSpecialPage
{
33 * Maximum number of pages to show on single subpage.
35 * @var int $maxPerPage
37 protected $maxPerPage = 345;
40 * Determines, which message describes the input field 'nsfrom'.
42 * @var string $nsfromMsg
44 protected $nsfromMsg = 'allpagesfrom';
47 * @param string $name Name of the special page, as seen in links and URLs (default: 'Allpages')
49 function __construct( $name = 'Allpages' ) {
50 parent
::__construct( $name );
54 * Entry point : initialise variables and call subfunctions.
56 * @param string $par Becomes "FOO" when called like Special:Allpages/FOO (default null)
58 function execute( $par ) {
59 $request = $this->getRequest();
60 $out = $this->getOutput();
63 $this->outputHeader();
64 $out->allowClickjacking();
67 $from = $request->getVal( 'from', null );
68 $to = $request->getVal( 'to', null );
69 $namespace = $request->getInt( 'namespace' );
71 $miserMode = (bool)$this->getConfig()->get( 'MiserMode' );
73 // Redirects filter is disabled in MiserMode
74 $hideredirects = $request->getBool( 'hideredirects', false ) && !$miserMode;
76 $namespaces = $this->getLanguage()->getNamespaces();
79 ( $namespace > 0 && array_key_exists( $namespace, $namespaces ) ) ?
80 $this->msg( 'allinnamespace', str_replace( '_', ' ', $namespaces[$namespace] ) ) :
81 $this->msg( 'allarticles' )
83 $out->addModuleStyles( 'mediawiki.special' );
85 if ( $par !== null ) {
86 $this->showChunk( $namespace, $par, $to, $hideredirects );
87 } elseif ( $from !== null && $to === null ) {
88 $this->showChunk( $namespace, $from, $to, $hideredirects );
90 $this->showToplevel( $namespace, $from, $to, $hideredirects );
95 * Outputs the HTMLForm used on this page
97 * @param int $namespace A namespace constant (default NS_MAIN).
98 * @param string $from DbKey we are starting listing at.
99 * @param string $to DbKey we are ending listing at.
100 * @param bool $hideRedirects Don't show redirects (default false)
102 protected function outputHTMLForm( $namespace = NS_MAIN
,
103 $from = '', $to = '', $hideRedirects = false
105 $miserMode = (bool)$this->getConfig()->get( 'MiserMode' );
112 'label-message' => 'allpagesfrom',
113 'default' => str_replace( '_', ' ', $from ),
120 'label-message' => 'allpagesto',
121 'default' => str_replace( '_', ' ', $to ),
124 'type' => 'namespaceselect',
125 'name' => 'namespace',
127 'label-message' => 'namespace',
129 'default' => $namespace,
133 'name' => 'hideredirects',
134 'id' => 'hidredirects',
135 'label-message' => 'allpages-hide-redirects',
136 'value' => $hideRedirects,
141 unset( $formDescriptor['hideredirects'] );
144 $context = new DerivativeContext( $this->getContext() );
145 $context->setTitle( $this->getPageTitle() ); // Remove subpage
146 $htmlForm = HTMLForm
::factory( 'ooui', $formDescriptor, $context );
149 ->setWrapperLegendMsg( 'allpages' )
150 ->setSubmitTextMsg( 'allpagessubmit' )
152 ->displayForm( false );
156 * @param int $namespace (default NS_MAIN)
157 * @param string $from List all pages from this name
158 * @param string $to List all pages to this name
159 * @param bool $hideredirects Don't show redirects (default false)
161 function showToplevel( $namespace = NS_MAIN
, $from = '', $to = '', $hideredirects = false ) {
162 $from = Title
::makeTitleSafe( $namespace, $from );
163 $to = Title
::makeTitleSafe( $namespace, $to );
164 $from = ( $from && $from->isLocal() ) ?
$from->getDBkey() : null;
165 $to = ( $to && $to->isLocal() ) ?
$to->getDBkey() : null;
167 $this->showChunk( $namespace, $from, $to, $hideredirects );
171 * @param int $namespace Namespace (Default NS_MAIN)
172 * @param string|false $from List all pages from this name (default false)
173 * @param string|false $to List all pages to this name (default false)
174 * @param bool $hideredirects Don't show redirects (default false)
176 function showChunk( $namespace = NS_MAIN
, $from = false, $to = false, $hideredirects = false ) {
177 $output = $this->getOutput();
179 $fromList = $this->getNamespaceKeyAndText( $namespace, $from );
180 $toList = $this->getNamespaceKeyAndText( $namespace, $to );
181 $namespaces = $this->getContext()->getLanguage()->getNamespaces();
185 if ( !$fromList ||
!$toList ) {
186 $out = $this->msg( 'allpagesbadtitle' )->parseAsBlock();
187 } elseif ( !array_key_exists( $namespace, $namespaces ) ) {
188 // Show errormessage and reset to NS_MAIN
189 $out = $this->msg( 'allpages-bad-ns', $namespace )->parse();
190 $namespace = NS_MAIN
;
192 list( $namespace, $fromKey, $from ) = $fromList;
193 list( , $toKey, $to ) = $toList;
195 $dbr = wfGetDB( DB_REPLICA
);
196 $filterConds = [ 'page_namespace' => $namespace ];
197 if ( $hideredirects ) {
198 $filterConds['page_is_redirect'] = 0;
201 $conds = $filterConds;
202 $conds[] = 'page_title >= ' . $dbr->addQuotes( $fromKey );
203 if ( $toKey !== "" ) {
204 $conds[] = 'page_title <= ' . $dbr->addQuotes( $toKey );
207 $res = $dbr->select( 'page',
208 [ 'page_namespace', 'page_title', 'page_is_redirect', 'page_id' ],
212 'ORDER BY' => 'page_title',
213 'LIMIT' => $this->maxPerPage +
1,
214 'USE INDEX' => 'name_title',
218 $linkRenderer = $this->getLinkRenderer();
219 if ( $res->numRows() > 0 ) {
220 $out = Html
::openElement( 'ul', [ 'class' => 'mw-allpages-chunk' ] );
222 while ( ( $n < $this->maxPerPage
) && ( $s = $res->fetchObject() ) ) {
223 $t = Title
::newFromRow( $s );
226 ( $s->page_is_redirect ?
' class="allpagesredirect"' : '' ) .
228 $linkRenderer->makeLink( $t ) .
231 $out .= '<li>[[' . htmlspecialchars( $s->page_title
) . "]]</li>\n";
235 $out .= Html
::closeElement( 'ul' );
237 if ( $res->numRows() > 2 ) {
238 // Only apply CSS column styles if there's more than 2 entries.
239 // Otherwise, rendering is broken as "mw-allpages-body"'s CSS column count is 3.
240 $out = Html
::rawElement( 'div', [ 'class' => 'mw-allpages-body' ], $out );
246 if ( $fromKey !== '' && !$this->including() ) {
247 # Get the first title from previous chunk
248 $prevConds = $filterConds;
249 $prevConds[] = 'page_title < ' . $dbr->addQuotes( $fromKey );
250 $prevKey = $dbr->selectField(
255 [ 'ORDER BY' => 'page_title DESC', 'OFFSET' => $this->maxPerPage
- 1 ]
258 if ( $prevKey === false ) {
259 # The previous chunk is not complete, need to link to the very first title
260 # available in the database
261 $prevKey = $dbr->selectField(
266 [ 'ORDER BY' => 'page_title' ]
270 if ( $prevKey !== false ) {
271 $prevTitle = Title
::makeTitle( $namespace, $prevKey );
276 if ( $this->including() ) {
277 $output->addHTML( $out );
282 $self = $this->getPageTitle();
284 $linkRenderer = $this->getLinkRenderer();
285 // Generate a "previous page" link if needed
287 $query = [ 'from' => $prevTitle->getText() ];
290 $query['namespace'] = $namespace;
293 if ( $hideredirects ) {
294 $query['hideredirects'] = $hideredirects;
297 $navLinks[] = $linkRenderer->makeKnownLink(
299 $this->msg( 'prevpage', $prevTitle->getText() )->text(),
306 // Generate a "next page" link if needed
307 if ( $n == $this->maxPerPage
&& $s = $res->fetchObject() ) {
308 # $s is the first link of the next chunk
309 $t = Title
::makeTitle( $namespace, $s->page_title
);
310 $query = [ 'from' => $t->getText() ];
313 $query['namespace'] = $namespace;
316 if ( $hideredirects ) {
317 $query['hideredirects'] = $hideredirects;
320 $navLinks[] = $linkRenderer->makeKnownLink(
322 $this->msg( 'nextpage', $t->getText() )->text(),
328 $this->outputHTMLForm( $namespace, $from, $to, $hideredirects );
330 if ( count( $navLinks ) ) {
331 // Add pagination links
332 $pagination = Html
::rawElement( 'div',
333 [ 'class' => 'mw-allpages-nav' ],
334 $this->getLanguage()->pipeList( $navLinks )
337 $output->addHTML( $pagination );
338 $out .= Html
::element( 'hr' ) . $pagination; // Footer
341 $output->addHTML( $out );
345 * @param int $ns The namespace of the article
346 * @param string $text The name of the article
347 * @return array|null [ int namespace, string dbkey, string pagename ] or null on error
349 protected function getNamespaceKeyAndText( $ns, $text ) {
351 # shortcut for common case
352 return [ $ns, '', '' ];
355 $t = Title
::makeTitleSafe( $ns, $text );
356 if ( $t && $t->isLocal() ) {
357 return [ $t->getNamespace(), $t->getDBkey(), $t->getText() ];
362 # try again, in case the problem was an empty pagename
363 $text = preg_replace( '/(#|$)/', 'X$1', $text );
364 $t = Title
::makeTitleSafe( $ns, $text );
365 if ( $t && $t->isLocal() ) {
366 return [ $t->getNamespace(), '', '' ];
373 * Return an array of subpages beginning with $search that this special page will accept.
375 * @param string $search Prefix to search for
376 * @param int $limit Maximum number of results to return (usually 10)
377 * @param int $offset Number of results to skip (usually 0)
378 * @return string[] Matching subpages
380 public function prefixSearchSubpages( $search, $limit, $offset ) {
381 return $this->prefixSearchString( $search, $limit, $offset );
384 protected function getGroupName() {