MediaWiki REL1_32
SpecialAllPages.php
Go to the documentation of this file.
1<?php
31
37 protected $maxPerPage = 345;
38
44 protected $nsfromMsg = 'allpagesfrom';
45
49 function __construct( $name = 'Allpages' ) {
50 parent::__construct( $name );
51 }
52
58 function execute( $par ) {
59 $request = $this->getRequest();
60 $out = $this->getOutput();
61
62 $this->setHeaders();
63 $this->outputHeader();
64 $out->allowClickjacking();
65
66 # GET values
67 $from = $request->getVal( 'from', null );
68 $to = $request->getVal( 'to', null );
69 $namespace = $request->getInt( 'namespace' );
70
71 $miserMode = (bool)$this->getConfig()->get( 'MiserMode' );
72
73 // Redirects filter is disabled in MiserMode
74 $hideredirects = $request->getBool( 'hideredirects', false ) && !$miserMode;
75
76 $namespaces = $this->getLanguage()->getNamespaces();
77
78 $out->setPageTitle(
79 ( $namespace > 0 && array_key_exists( $namespace, $namespaces ) ) ?
80 $this->msg( 'allinnamespace', str_replace( '_', ' ', $namespaces[$namespace] ) ) :
81 $this->msg( 'allarticles' )
82 );
83 $out->addModuleStyles( 'mediawiki.special' );
84
85 if ( $par !== null ) {
86 $this->showChunk( $namespace, $par, $to, $hideredirects );
87 } elseif ( $from !== null && $to === null ) {
88 $this->showChunk( $namespace, $from, $to, $hideredirects );
89 } else {
90 $this->showToplevel( $namespace, $from, $to, $hideredirects );
91 }
92 }
93
102 protected function outputHTMLForm( $namespace = NS_MAIN,
103 $from = '', $to = '', $hideRedirects = false
104 ) {
105 $miserMode = (bool)$this->getConfig()->get( 'MiserMode' );
107 'from' => [
108 'type' => 'text',
109 'name' => 'from',
110 'id' => 'nsfrom',
111 'size' => 30,
112 'label-message' => 'allpagesfrom',
113 'default' => str_replace( '_', ' ', $from ),
114 ],
115 'to' => [
116 'type' => 'text',
117 'name' => 'to',
118 'id' => 'nsto',
119 'size' => 30,
120 'label-message' => 'allpagesto',
121 'default' => str_replace( '_', ' ', $to ),
122 ],
123 'namespace' => [
124 'type' => 'namespaceselect',
125 'name' => 'namespace',
126 'id' => 'namespace',
127 'label-message' => 'namespace',
128 'all' => null,
129 'default' => $namespace,
130 ],
131 'hideredirects' => [
132 'type' => 'check',
133 'name' => 'hideredirects',
134 'id' => 'hidredirects',
135 'label-message' => 'allpages-hide-redirects',
136 'value' => $hideRedirects,
137 ],
138 ];
139
140 if ( $miserMode ) {
141 unset( $formDescriptor['hideredirects'] );
142 }
143
144 $context = new DerivativeContext( $this->getContext() );
145 $context->setTitle( $this->getPageTitle() ); // Remove subpage
146 $htmlForm = HTMLForm::factory( 'ooui', $formDescriptor, $context );
147 $htmlForm
148 ->setMethod( 'get' )
149 ->setWrapperLegendMsg( 'allpages' )
150 ->setSubmitTextMsg( 'allpagessubmit' )
151 ->prepareForm()
152 ->displayForm( false );
153 }
154
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;
166
167 $this->showChunk( $namespace, $from, $to, $hideredirects );
168 }
169
176 function showChunk( $namespace = NS_MAIN, $from = false, $to = false, $hideredirects = false ) {
177 $output = $this->getOutput();
178
179 $fromList = $this->getNamespaceKeyAndText( $namespace, $from );
180 $toList = $this->getNamespaceKeyAndText( $namespace, $to );
181 $namespaces = $this->getContext()->getLanguage()->getNamespaces();
182 $n = 0;
183 $prevTitle = null;
184
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;
191 } else {
192 list( $namespace, $fromKey, $from ) = $fromList;
193 list( , $toKey, $to ) = $toList;
194
196 $filterConds = [ 'page_namespace' => $namespace ];
197 if ( $hideredirects ) {
198 $filterConds['page_is_redirect'] = 0;
199 }
200
201 $conds = $filterConds;
202 $conds[] = 'page_title >= ' . $dbr->addQuotes( $fromKey );
203 if ( $toKey !== "" ) {
204 $conds[] = 'page_title <= ' . $dbr->addQuotes( $toKey );
205 }
206
207 $res = $dbr->select( 'page',
208 [ 'page_namespace', 'page_title', 'page_is_redirect', 'page_id' ],
209 $conds,
210 __METHOD__,
211 [
212 'ORDER BY' => 'page_title',
213 'LIMIT' => $this->maxPerPage + 1,
214 'USE INDEX' => 'name_title',
215 ]
216 );
217
219 if ( $res->numRows() > 0 ) {
220 $out = Html::openElement( 'ul', [ 'class' => 'mw-allpages-chunk' ] );
221
222 while ( ( $n < $this->maxPerPage ) && ( $s = $res->fetchObject() ) ) {
223 $t = Title::newFromRow( $s );
224 if ( $t ) {
225 $out .= '<li' .
226 ( $s->page_is_redirect ? ' class="allpagesredirect"' : '' ) .
227 '>' .
228 $linkRenderer->makeLink( $t ) .
229 "</li>\n";
230 } else {
231 $out .= '<li>[[' . htmlspecialchars( $s->page_title ) . "]]</li>\n";
232 }
233 $n++;
234 }
235 $out .= Html::closeElement( 'ul' );
236
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 );
241 }
242 } else {
243 $out = '';
244 }
245
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(
251 'page',
252 'page_title',
253 $prevConds,
254 __METHOD__,
255 [ 'ORDER BY' => 'page_title DESC', 'OFFSET' => $this->maxPerPage - 1 ]
256 );
257
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(
262 'page',
263 'page_title',
264 $prevConds,
265 __METHOD__,
266 [ 'ORDER BY' => 'page_title' ]
267 );
268 }
269
270 if ( $prevKey !== false ) {
271 $prevTitle = Title::makeTitle( $namespace, $prevKey );
272 }
273 }
274 }
275
276 if ( $this->including() ) {
277 $output->addHTML( $out );
278 return;
279 }
280
281 $navLinks = [];
282 $self = $this->getPageTitle();
283
285 // Generate a "previous page" link if needed
286 if ( $prevTitle ) {
287 $query = [ 'from' => $prevTitle->getText() ];
288
289 if ( $namespace ) {
290 $query['namespace'] = $namespace;
291 }
292
293 if ( $hideredirects ) {
294 $query['hideredirects'] = $hideredirects;
295 }
296
297 $navLinks[] = $linkRenderer->makeKnownLink(
298 $self,
299 $this->msg( 'prevpage', $prevTitle->getText() )->text(),
300 [],
301 $query
302 );
303
304 }
305
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() ];
311
312 if ( $namespace ) {
313 $query['namespace'] = $namespace;
314 }
315
316 if ( $hideredirects ) {
317 $query['hideredirects'] = $hideredirects;
318 }
319
320 $navLinks[] = $linkRenderer->makeKnownLink(
321 $self,
322 $this->msg( 'nextpage', $t->getText() )->text(),
323 [],
324 $query
325 );
326 }
327
328 $this->outputHTMLForm( $namespace, $from, $to, $hideredirects );
329
330 if ( count( $navLinks ) ) {
331 // Add pagination links
332 $pagination = Html::rawElement( 'div',
333 [ 'class' => 'mw-allpages-nav' ],
334 $this->getLanguage()->pipeList( $navLinks )
335 );
336
337 $output->addHTML( $pagination );
338 $out .= Html::element( 'hr' ) . $pagination; // Footer
339 }
340
341 $output->addHTML( $out );
342 }
343
349 protected function getNamespaceKeyAndText( $ns, $text ) {
350 if ( $text == '' ) {
351 # shortcut for common case
352 return [ $ns, '', '' ];
353 }
354
355 $t = Title::makeTitleSafe( $ns, $text );
356 if ( $t && $t->isLocal() ) {
357 return [ $t->getNamespace(), $t->getDBkey(), $t->getText() ];
358 } elseif ( $t ) {
359 return null;
360 }
361
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(), '', '' ];
367 } else {
368 return null;
369 }
370 }
371
380 public function prefixSearchSubpages( $search, $limit, $offset ) {
381 return $this->prefixSearchString( $search, $limit, $offset );
382 }
383
384 protected function getGroupName() {
385 return 'pages';
386 }
387}
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
An IContextSource implementation which will inherit context from another source but allow individual ...
Shortcut to construct an includable special page.
Implements Special:Allpages.
$maxPerPage
Maximum number of pages to show on single subpage.
__construct( $name='Allpages')
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
showToplevel( $namespace=NS_MAIN, $from='', $to='', $hideredirects=false)
execute( $par)
Entry point : initialise variables and call subfunctions.
prefixSearchSubpages( $search, $limit, $offset)
Return an array of subpages beginning with $search that this special page will accept.
showChunk( $namespace=NS_MAIN, $from=false, $to=false, $hideredirects=false)
$nsfromMsg
Determines, which message describes the input field 'nsfrom'.
outputHTMLForm( $namespace=NS_MAIN, $from='', $to='', $hideRedirects=false)
Outputs the HTMLForm used on this page.
getNamespaceKeyAndText( $ns, $text)
outputHeader( $summaryMessageKey='')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes!
getOutput()
Get the OutputPage being used for this instance.
getContext()
Gets the context this SpecialPage is executed in.
msg( $key)
Wrapper around wfMessage that sets the current context.
getConfig()
Shortcut to get main config object.
getRequest()
Get the WebRequest being used for this instance.
getPageTitle( $subpage=false)
Get a self-referential title object.
getLanguage()
Shortcut to get user's language.
including( $x=null)
Whether the special page is being evaluated via transclusion.
prefixSearchString( $search, $limit, $offset)
Perform a regular substring search for prefixSearchSubpages.
MediaWiki Linker LinkRenderer null $linkRenderer
$res
Definition database.txt:21
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition deferred.txt:11
const NS_MAIN
Definition Defines.php:64
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request
Definition hooks.txt:2880
namespace and then decline to actually register it & $namespaces
Definition hooks.txt:964
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead & $formDescriptor
Definition hooks.txt:2208
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
Definition hooks.txt:2885
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition hooks.txt:894
Allows to change the fields on the form that will be generated $name
Definition hooks.txt:302
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition hooks.txt:1656
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set but before ordinary actions take place $output
Definition hooks.txt:2317
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37
const DB_REPLICA
Definition defines.php:25