MediaWiki REL1_33
ApiQueryAllPages.php
Go to the documentation of this file.
1<?php
23
30
31 public function __construct( ApiQuery $query, $moduleName ) {
32 parent::__construct( $query, $moduleName, 'ap' );
33 }
34
35 public function execute() {
36 $this->run();
37 }
38
39 public function getCacheMode( $params ) {
40 return 'public';
41 }
42
47 public function executeGenerator( $resultPageSet ) {
48 if ( $resultPageSet->isResolvingRedirects() ) {
49 $this->dieWithError( 'apierror-allpages-generator-redirects', 'params' );
50 }
51
52 $this->run( $resultPageSet );
53 }
54
59 private function run( $resultPageSet = null ) {
60 $db = $this->getDB();
61
63
64 // Page filters
65 $this->addTables( 'page' );
66
67 if ( !is_null( $params['continue'] ) ) {
68 $cont = explode( '|', $params['continue'] );
69 $this->dieContinueUsageIf( count( $cont ) != 1 );
70 $op = $params['dir'] == 'descending' ? '<' : '>';
71 $cont_from = $db->addQuotes( $cont[0] );
72 $this->addWhere( "page_title $op= $cont_from" );
73 }
74
75 $miserMode = $this->getConfig()->get( 'MiserMode' );
76 if ( !$miserMode ) {
77 if ( $params['filterredir'] == 'redirects' ) {
78 $this->addWhereFld( 'page_is_redirect', 1 );
79 } elseif ( $params['filterredir'] == 'nonredirects' ) {
80 $this->addWhereFld( 'page_is_redirect', 0 );
81 }
82 }
83
84 $this->addWhereFld( 'page_namespace', $params['namespace'] );
85 $dir = ( $params['dir'] == 'descending' ? 'older' : 'newer' );
86 $from = ( $params['from'] === null
87 ? null
88 : $this->titlePartToKey( $params['from'], $params['namespace'] ) );
89 $to = ( $params['to'] === null
90 ? null
91 : $this->titlePartToKey( $params['to'], $params['namespace'] ) );
92 $this->addWhereRange( 'page_title', $dir, $from, $to );
93
94 if ( isset( $params['prefix'] ) ) {
95 $this->addWhere( 'page_title' . $db->buildLike(
96 $this->titlePartToKey( $params['prefix'], $params['namespace'] ),
97 $db->anyString() ) );
98 }
99
100 if ( is_null( $resultPageSet ) ) {
101 $selectFields = [
102 'page_namespace',
103 'page_title',
104 'page_id'
105 ];
106 } else {
107 $selectFields = $resultPageSet->getPageTableFields();
108 }
109
110 $miserModeFilterRedirValue = null;
111 $miserModeFilterRedir = $miserMode && $params['filterredir'] !== 'all';
112 if ( $miserModeFilterRedir ) {
113 $selectFields[] = 'page_is_redirect';
114
115 if ( $params['filterredir'] == 'redirects' ) {
116 $miserModeFilterRedirValue = 1;
117 } elseif ( $params['filterredir'] == 'nonredirects' ) {
118 $miserModeFilterRedirValue = 0;
119 }
120 }
121
122 $this->addFields( $selectFields );
123 $forceNameTitleIndex = true;
124 if ( isset( $params['minsize'] ) ) {
125 $this->addWhere( 'page_len>=' . (int)$params['minsize'] );
126 $forceNameTitleIndex = false;
127 }
128
129 if ( isset( $params['maxsize'] ) ) {
130 $this->addWhere( 'page_len<=' . (int)$params['maxsize'] );
131 $forceNameTitleIndex = false;
132 }
133
134 // Page protection filtering
135 if ( $params['prtype'] || $params['prexpiry'] != 'all' ) {
136 $this->addTables( 'page_restrictions' );
137 $this->addWhere( 'page_id=pr_page' );
138 $this->addWhere( "pr_expiry > {$db->addQuotes( $db->timestamp() )} OR pr_expiry IS NULL" );
139
140 if ( $params['prtype'] ) {
141 $this->addWhereFld( 'pr_type', $params['prtype'] );
142
143 if ( isset( $params['prlevel'] ) ) {
144 // Remove the empty string and '*' from the prlevel array
145 $prlevel = array_diff( $params['prlevel'], [ '', '*' ] );
146
147 if ( count( $prlevel ) ) {
148 $this->addWhereFld( 'pr_level', $prlevel );
149 }
150 }
151 if ( $params['prfiltercascade'] == 'cascading' ) {
152 $this->addWhereFld( 'pr_cascade', 1 );
153 } elseif ( $params['prfiltercascade'] == 'noncascading' ) {
154 $this->addWhereFld( 'pr_cascade', 0 );
155 }
156 }
157 $forceNameTitleIndex = false;
158
159 if ( $params['prexpiry'] == 'indefinite' ) {
160 $this->addWhere( "pr_expiry = {$db->addQuotes( $db->getInfinity() )} OR pr_expiry IS NULL" );
161 } elseif ( $params['prexpiry'] == 'definite' ) {
162 $this->addWhere( "pr_expiry != {$db->addQuotes( $db->getInfinity() )}" );
163 }
164
165 $this->addOption( 'DISTINCT' );
166 } elseif ( isset( $params['prlevel'] ) ) {
167 $this->dieWithError(
168 [ 'apierror-invalidparammix-mustusewith', 'prlevel', 'prtype' ], 'invalidparammix'
169 );
170 }
171
172 if ( $params['filterlanglinks'] == 'withoutlanglinks' ) {
173 $this->addTables( 'langlinks' );
174 $this->addJoinConds( [ 'langlinks' => [ 'LEFT JOIN', 'page_id=ll_from' ] ] );
175 $this->addWhere( 'll_from IS NULL' );
176 $forceNameTitleIndex = false;
177 } elseif ( $params['filterlanglinks'] == 'withlanglinks' ) {
178 $this->addTables( 'langlinks' );
179 $this->addWhere( 'page_id=ll_from' );
180 $this->addOption( 'STRAIGHT_JOIN' );
181
182 // MySQL filesorts if we use a GROUP BY that works with the rules
183 // in the 1992 SQL standard (it doesn't like having the
184 // constant-in-WHERE page_namespace column in there). Using the
185 // 1999 rules works fine, but that breaks other DBs. Sigh.
187 $dbType = $db->getType();
188 if ( $dbType === 'mysql' || $dbType === 'sqlite' ) {
189 // Ignore the rules, or 1999 rules if you count unique keys
190 // over non-NULL columns as satisfying the requirement for
191 // "functional dependency" and don't require including
192 // constant-in-WHERE columns in the GROUP BY.
193 $this->addOption( 'GROUP BY', [ 'page_title' ] );
194 } elseif ( $dbType === 'postgres' && $db->getServerVersion() >= 9.1 ) {
195 // 1999 rules only counting primary keys
196 $this->addOption( 'GROUP BY', [ 'page_title', 'page_id' ] );
197 } else {
198 // 1992 rules
199 $this->addOption( 'GROUP BY', $selectFields );
200 }
201
202 $forceNameTitleIndex = false;
203 }
204
205 if ( $forceNameTitleIndex ) {
206 $this->addOption( 'USE INDEX', 'name_title' );
207 }
208
209 $limit = $params['limit'];
210 $this->addOption( 'LIMIT', $limit + 1 );
211 $res = $this->select( __METHOD__ );
212
213 // Get gender information
214 if ( MWNamespace::hasGenderDistinction( $params['namespace'] ) ) {
215 $users = [];
216 foreach ( $res as $row ) {
217 $users[] = $row->page_title;
218 }
219 MediaWikiServices::getInstance()->getGenderCache()->doQuery( $users, __METHOD__ );
220 $res->rewind(); // reset
221 }
222
223 $count = 0;
224 $result = $this->getResult();
225 foreach ( $res as $row ) {
226 if ( ++$count > $limit ) {
227 // We've reached the one extra which shows that there are
228 // additional pages to be had. Stop here...
229 $this->setContinueEnumParameter( 'continue', $row->page_title );
230 break;
231 }
232
233 if ( $miserModeFilterRedir && (int)$row->page_is_redirect !== $miserModeFilterRedirValue ) {
234 // Filter implemented in PHP due to being in Miser Mode
235 continue;
236 }
237
238 if ( is_null( $resultPageSet ) ) {
239 $title = Title::makeTitle( $row->page_namespace, $row->page_title );
240 $vals = [
241 'pageid' => (int)$row->page_id,
242 'ns' => (int)$title->getNamespace(),
243 'title' => $title->getPrefixedText()
244 ];
245 $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $vals );
246 if ( !$fit ) {
247 $this->setContinueEnumParameter( 'continue', $row->page_title );
248 break;
249 }
250 } else {
251 $resultPageSet->processDbRow( $row );
252 }
253 }
254
255 if ( is_null( $resultPageSet ) ) {
256 $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'p' );
257 }
258 }
259
260 public function getAllowedParams() {
261 $ret = [
262 'from' => null,
263 'continue' => [
264 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
265 ],
266 'to' => null,
267 'prefix' => null,
268 'namespace' => [
270 ApiBase::PARAM_TYPE => 'namespace',
271 ],
272 'filterredir' => [
273 ApiBase::PARAM_DFLT => 'all',
274 ApiBase::PARAM_TYPE => [
275 'all',
276 'redirects',
277 'nonredirects'
278 ]
279 ],
280 'minsize' => [
281 ApiBase::PARAM_TYPE => 'integer',
282 ],
283 'maxsize' => [
284 ApiBase::PARAM_TYPE => 'integer',
285 ],
286 'prtype' => [
287 ApiBase::PARAM_TYPE => Title::getFilteredRestrictionTypes( true ),
289 ],
290 'prlevel' => [
291 ApiBase::PARAM_TYPE => $this->getConfig()->get( 'RestrictionLevels' ),
293 ],
294 'prfiltercascade' => [
295 ApiBase::PARAM_DFLT => 'all',
296 ApiBase::PARAM_TYPE => [
297 'cascading',
298 'noncascading',
299 'all'
300 ],
301 ],
302 'limit' => [
304 ApiBase::PARAM_TYPE => 'limit',
308 ],
309 'dir' => [
310 ApiBase::PARAM_DFLT => 'ascending',
312 'ascending',
313 'descending'
314 ]
315 ],
316 'filterlanglinks' => [
318 'withlanglinks',
319 'withoutlanglinks',
320 'all'
321 ],
322 ApiBase::PARAM_DFLT => 'all'
323 ],
324 'prexpiry' => [
326 'indefinite',
327 'definite',
328 'all'
329 ],
330 ApiBase::PARAM_DFLT => 'all'
331 ],
332 ];
333
334 if ( $this->getConfig()->get( 'MiserMode' ) ) {
335 $ret['filterredir'][ApiBase::PARAM_HELP_MSG_APPEND] = [ 'api-help-param-limited-in-miser-mode' ];
336 }
337
338 return $ret;
339 }
340
341 protected function getExamplesMessages() {
342 return [
343 'action=query&list=allpages&apfrom=B'
344 => 'apihelp-query+allpages-example-B',
345 'action=query&generator=allpages&gaplimit=4&gapfrom=T&prop=info'
346 => 'apihelp-query+allpages-example-generator',
347 'action=query&generator=allpages&gaplimit=2&' .
348 'gapfilterredir=nonredirects&gapfrom=Re&prop=revisions&rvprop=content'
349 => 'apihelp-query+allpages-example-generator-revisions',
350 ];
351 }
352
353 public function getHelpUrls() {
354 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Allpages';
355 }
356}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
const PARAM_MAX2
(integer) Max value allowed for the parameter for users with the apihighlimits right,...
Definition ApiBase.php:96
const PARAM_MAX
(integer) Max value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition ApiBase.php:90
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition ApiBase.php:1990
dieContinueUsageIf( $condition)
Die with the 'badcontinue' error.
Definition ApiBase.php:2176
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition ApiBase.php:87
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition ApiBase.php:48
const PARAM_HELP_MSG_APPEND
((string|array|Message)[]) Specify additional i18n messages to append to the normal message for this ...
Definition ApiBase.php:131
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition ApiBase.php:99
const LIMIT_BIG1
Fast query, standard limit.
Definition ApiBase.php:252
getResult()
Get the result object.
Definition ApiBase.php:632
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition ApiBase.php:743
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition ApiBase.php:124
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition ApiBase.php:254
getModuleName()
Get the name of the module being executed by this instance.
Definition ApiBase.php:512
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition ApiBase.php:51
Query module to enumerate all available pages.
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
getCacheMode( $params)
Get the cache mode for the data generated by this module.
executeGenerator( $resultPageSet)
run( $resultPageSet=null)
__construct(ApiQuery $query, $moduleName)
getHelpUrls()
Return links to more detailed help pages about the module.
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
getExamplesMessages()
Returns usage examples for this module.
addWhereRange( $field, $dir, $start, $end, $sort=true)
Add a WHERE clause corresponding to a range, and an ORDER BY clause to sort in the right direction.
addFields( $value)
Add a set of fields to select to the internal array.
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
getDB()
Get the Query database connection (read-only)
addJoinConds( $join_conds)
Add a set of JOIN conditions to the internal array.
addWhereFld( $field, $value)
Equivalent to addWhere(array($field => $value))
titlePartToKey( $titlePart, $namespace=NS_MAIN)
Convert an input title or title prefix into a dbkey.
addWhere( $value)
Add a set of WHERE clauses to the internal array.
setContinueEnumParameter( $paramName, $paramValue)
Overridden to set the generator param if in generator mode.
This is the main query class.
Definition ApiQuery.php:36
MediaWikiServices is the service locator for the application scope of MediaWiki.
We use the convention $dbr for read and $dbw for write to help you keep track of whether the database object is a the world will explode Or to be a subsequent write query which succeeded on the master may fail when replicated to the slave due to a unique key collision Replication on the slave will stop and it may take hours to repair the database and get it back online Setting read_only in my cnf on the slave will avoid this but given the dire we prefer to have as many checks as possible We provide a but the wrapper functions like select() and insert() are usually more convenient. They take care of things like table prefixes and escaping for you. If you really need to make your own SQL
$res
Definition database.txt:21
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
const NS_MAIN
Definition Defines.php:73
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition hooks.txt:1991
namespace and then decline to actually register it file or subcat img or subcat $title
Definition hooks.txt:955
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition hooks.txt:783
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return true
Definition hooks.txt:2004
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
Definition hooks.txt:2003
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:1617
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
$params