MediaWiki  1.23.13
ApiQueryAllPages.php
Go to the documentation of this file.
1 <?php
33 
34  public function __construct( $query, $moduleName ) {
35  parent::__construct( $query, $moduleName, 'ap' );
36  }
37 
38  public function execute() {
39  $this->run();
40  }
41 
42  public function getCacheMode( $params ) {
43  return 'public';
44  }
45 
50  public function executeGenerator( $resultPageSet ) {
51  if ( $resultPageSet->isResolvingRedirects() ) {
52  $this->dieUsage(
53  'Use "gapfilterredir=nonredirects" option instead of "redirects" ' .
54  'when using allpages as a generator',
55  'params'
56  );
57  }
58 
59  $this->run( $resultPageSet );
60  }
61 
66  private function run( $resultPageSet = null ) {
67  $db = $this->getDB();
68 
69  $params = $this->extractRequestParams();
70 
71  // Page filters
72  $this->addTables( 'page' );
73 
74  if ( !is_null( $params['continue'] ) ) {
75  $cont = explode( '|', $params['continue'] );
76  $this->dieContinueUsageIf( count( $cont ) != 1 );
77  $op = $params['dir'] == 'descending' ? '<' : '>';
78  $cont_from = $db->addQuotes( $cont[0] );
79  $this->addWhere( "page_title $op= $cont_from" );
80  }
81 
82  if ( $params['filterredir'] == 'redirects' ) {
83  $this->addWhereFld( 'page_is_redirect', 1 );
84  } elseif ( $params['filterredir'] == 'nonredirects' ) {
85  $this->addWhereFld( 'page_is_redirect', 0 );
86  }
87 
88  $this->addWhereFld( 'page_namespace', $params['namespace'] );
89  $dir = ( $params['dir'] == 'descending' ? 'older' : 'newer' );
90  $from = ( $params['from'] === null
91  ? null
92  : $this->titlePartToKey( $params['from'], $params['namespace'] ) );
93  $to = ( $params['to'] === null
94  ? null
95  : $this->titlePartToKey( $params['to'], $params['namespace'] ) );
96  $this->addWhereRange( 'page_title', $dir, $from, $to );
97 
98  if ( isset( $params['prefix'] ) ) {
99  $this->addWhere( 'page_title' . $db->buildLike(
100  $this->titlePartToKey( $params['prefix'], $params['namespace'] ),
101  $db->anyString() ) );
102  }
103 
104  if ( is_null( $resultPageSet ) ) {
105  $selectFields = array(
106  'page_namespace',
107  'page_title',
108  'page_id'
109  );
110  } else {
111  $selectFields = $resultPageSet->getPageTableFields();
112  }
113 
114  $this->addFields( $selectFields );
115  $forceNameTitleIndex = true;
116  if ( isset( $params['minsize'] ) ) {
117  $this->addWhere( 'page_len>=' . intval( $params['minsize'] ) );
118  $forceNameTitleIndex = false;
119  }
120 
121  if ( isset( $params['maxsize'] ) ) {
122  $this->addWhere( 'page_len<=' . intval( $params['maxsize'] ) );
123  $forceNameTitleIndex = false;
124  }
125 
126  // Page protection filtering
127  if ( count( $params['prtype'] ) || $params['prexpiry'] != 'all' ) {
128  $this->addTables( 'page_restrictions' );
129  $this->addWhere( 'page_id=pr_page' );
130  $this->addWhere( "pr_expiry > {$db->addQuotes( $db->timestamp() )} OR pr_expiry IS NULL" );
131 
132  if ( count( $params['prtype'] ) ) {
133  $this->addWhereFld( 'pr_type', $params['prtype'] );
134 
135  if ( isset( $params['prlevel'] ) ) {
136  // Remove the empty string and '*' from the prlevel array
137  $prlevel = array_diff( $params['prlevel'], array( '', '*' ) );
138 
139  if ( count( $prlevel ) ) {
140  $this->addWhereFld( 'pr_level', $prlevel );
141  }
142  }
143  if ( $params['prfiltercascade'] == 'cascading' ) {
144  $this->addWhereFld( 'pr_cascade', 1 );
145  } elseif ( $params['prfiltercascade'] == 'noncascading' ) {
146  $this->addWhereFld( 'pr_cascade', 0 );
147  }
148  }
149  $forceNameTitleIndex = false;
150 
151  if ( $params['prexpiry'] == 'indefinite' ) {
152  $this->addWhere( "pr_expiry = {$db->addQuotes( $db->getInfinity() )} OR pr_expiry IS NULL" );
153  } elseif ( $params['prexpiry'] == 'definite' ) {
154  $this->addWhere( "pr_expiry != {$db->addQuotes( $db->getInfinity() )}" );
155  }
156 
157  $this->addOption( 'DISTINCT' );
158  } elseif ( isset( $params['prlevel'] ) ) {
159  $this->dieUsage( 'prlevel may not be used without prtype', 'params' );
160  }
161 
162  if ( $params['filterlanglinks'] == 'withoutlanglinks' ) {
163  $this->addTables( 'langlinks' );
164  $this->addJoinConds( array( 'langlinks' => array( 'LEFT JOIN', 'page_id=ll_from' ) ) );
165  $this->addWhere( 'll_from IS NULL' );
166  $forceNameTitleIndex = false;
167  } elseif ( $params['filterlanglinks'] == 'withlanglinks' ) {
168  $this->addTables( 'langlinks' );
169  $this->addWhere( 'page_id=ll_from' );
170  $this->addOption( 'STRAIGHT_JOIN' );
171  // We have to GROUP BY all selected fields to stop
172  // PostgreSQL from whining
173  $this->addOption( 'GROUP BY', $selectFields );
174  $forceNameTitleIndex = false;
175  }
176 
177  if ( $forceNameTitleIndex ) {
178  $this->addOption( 'USE INDEX', 'name_title' );
179  }
180 
181  $limit = $params['limit'];
182  $this->addOption( 'LIMIT', $limit + 1 );
183  $res = $this->select( __METHOD__ );
184 
185  //Get gender information
186  if ( MWNamespace::hasGenderDistinction( $params['namespace'] ) ) {
187  $users = array();
188  foreach ( $res as $row ) {
189  $users[] = $row->page_title;
190  }
191  GenderCache::singleton()->doQuery( $users, __METHOD__ );
192  $res->rewind(); //reset
193  }
194 
195  $count = 0;
196  $result = $this->getResult();
197  foreach ( $res as $row ) {
198  if ( ++$count > $limit ) {
199  // We've reached the one extra which shows that there are
200  // additional pages to be had. Stop here...
201  $this->setContinueEnumParameter( 'continue', $row->page_title );
202  break;
203  }
204 
205  if ( is_null( $resultPageSet ) ) {
206  $title = Title::makeTitle( $row->page_namespace, $row->page_title );
207  $vals = array(
208  'pageid' => intval( $row->page_id ),
209  'ns' => intval( $title->getNamespace() ),
210  'title' => $title->getPrefixedText()
211  );
212  $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $vals );
213  if ( !$fit ) {
214  $this->setContinueEnumParameter( 'continue', $row->page_title );
215  break;
216  }
217  } else {
218  $resultPageSet->processDbRow( $row );
219  }
220  }
221 
222  if ( is_null( $resultPageSet ) ) {
223  $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'p' );
224  }
225  }
226 
227  public function getAllowedParams() {
228  global $wgRestrictionLevels;
229 
230  return array(
231  'from' => null,
232  'continue' => null,
233  'to' => null,
234  'prefix' => null,
235  'namespace' => array(
237  ApiBase::PARAM_TYPE => 'namespace',
238  ),
239  'filterredir' => array(
240  ApiBase::PARAM_DFLT => 'all',
242  'all',
243  'redirects',
244  'nonredirects'
245  )
246  ),
247  'minsize' => array(
248  ApiBase::PARAM_TYPE => 'integer',
249  ),
250  'maxsize' => array(
251  ApiBase::PARAM_TYPE => 'integer',
252  ),
253  'prtype' => array(
255  ApiBase::PARAM_ISMULTI => true
256  ),
257  'prlevel' => array(
258  ApiBase::PARAM_TYPE => $wgRestrictionLevels,
259  ApiBase::PARAM_ISMULTI => true
260  ),
261  'prfiltercascade' => array(
262  ApiBase::PARAM_DFLT => 'all',
264  'cascading',
265  'noncascading',
266  'all'
267  ),
268  ),
269  'limit' => array(
270  ApiBase::PARAM_DFLT => 10,
271  ApiBase::PARAM_TYPE => 'limit',
272  ApiBase::PARAM_MIN => 1,
275  ),
276  'dir' => array(
277  ApiBase::PARAM_DFLT => 'ascending',
279  'ascending',
280  'descending'
281  )
282  ),
283  'filterlanglinks' => array(
285  'withlanglinks',
286  'withoutlanglinks',
287  'all'
288  ),
289  ApiBase::PARAM_DFLT => 'all'
290  ),
291  'prexpiry' => array(
293  'indefinite',
294  'definite',
295  'all'
296  ),
297  ApiBase::PARAM_DFLT => 'all'
298  ),
299  );
300  }
301 
302  public function getParamDescription() {
303  $p = $this->getModulePrefix();
304 
305  return array(
306  'from' => 'The page title to start enumerating from',
307  'continue' => 'When more results are available, use this to continue',
308  'to' => 'The page title to stop enumerating at',
309  'prefix' => 'Search for all page titles that begin with this value',
310  'namespace' => 'The namespace to enumerate',
311  'filterredir' => 'Which pages to list',
312  'dir' => 'The direction in which to list',
313  'minsize' => 'Limit to pages with at least this many bytes',
314  'maxsize' => 'Limit to pages with at most this many bytes',
315  'prtype' => 'Limit to protected pages only',
316  'prlevel' => "The protection level (must be used with {$p}prtype= parameter)",
317  'prfiltercascade'
318  => "Filter protections based on cascadingness (ignored when {$p}prtype isn't set)",
319  'filterlanglinks' => array(
320  'Filter based on whether a page has langlinks',
321  'Note that this may not consider langlinks added by extensions.',
322  ),
323  'limit' => 'How many total pages to return.',
324  'prexpiry' => array(
325  'Which protection expiry to filter the page on',
326  ' indefinite - Get only pages with indefinite protection expiry',
327  ' definite - Get only pages with a definite (specific) protection expiry',
328  ' all - Get pages with any protections expiry'
329  ),
330  );
331  }
332 
333  public function getResultProperties() {
334  return array(
335  '' => array(
336  'pageid' => 'integer',
337  'ns' => 'namespace',
338  'title' => 'string'
339  )
340  );
341  }
342 
343  public function getDescription() {
344  return 'Enumerate all pages sequentially in a given namespace.';
345  }
346 
347  public function getPossibleErrors() {
348  return array_merge( parent::getPossibleErrors(), array(
349  array(
350  'code' => 'params',
351  'info' => 'Use "gapfilterredir=nonredirects" option instead of ' .
352  '"redirects" when using allpages as a generator'
353  ),
354  array( 'code' => 'params', 'info' => 'prlevel may not be used without prtype' ),
355  ) );
356  }
357 
358  public function getExamples() {
359  return array(
360  'api.php?action=query&list=allpages&apfrom=B' => array(
361  'Simple Use',
362  'Show a list of pages starting at the letter "B"',
363  ),
364  'api.php?action=query&generator=allpages&gaplimit=4&gapfrom=T&prop=info' => array(
365  'Using as Generator',
366  'Show info about 4 pages starting at the letter "T"',
367  ),
368  'api.php?action=query&generator=allpages&gaplimit=2&' .
369  'gapfilterredir=nonredirects&gapfrom=Re&prop=revisions&rvprop=content'
370  => array( 'Show content of first 2 non-redirect pages beginning at "Re"' )
371  );
372  }
373 
374  public function getHelpUrls() {
375  return 'https://www.mediawiki.org/wiki/API:Allpages';
376  }
377 }
GenderCache\singleton
static singleton()
Definition: GenderCache.php:39
Title\makeTitle
static & makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:398
$result
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. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. $reader:XMLReader object $logInfo:Array of information Return false to stop further processing of the tag 'ImportHandlePageXMLTag':When parsing a XML tag in a page. $reader:XMLReader object $pageInfo:Array of information Return false to stop further processing of the tag 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information Return false to stop further processing of the tag 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. $reader:XMLReader object Return false to stop further processing of the tag 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. $reader:XMLReader object $revisionInfo:Array of information Return false to stop further processing of the tag '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 '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. '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 '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 '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 wfIsTrustedProxy() $ip:IP being check $result:Change this value to override the result of wfIsTrustedProxy() '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 User::isValidEmailAddr(), 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 'LanguageGetMagic':DEPRECATED, use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetSpecialPageAliases':DEPRECATED, use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language $specialPageAliases:associative array of magic words synonyms $lang:language code(string) '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:Associative array mapping language codes to prefixed links of the form "language:title". & $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. 'LinkBegin':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:1528
ApiQueryBase\addFields
addFields( $value)
Add a set of fields to select to the internal array.
Definition: ApiQueryBase.php:117
Title\getFilteredRestrictionTypes
static getFilteredRestrictionTypes( $exists=true)
Get a filtered list of all restriction types supported by this wiki.
Definition: Title.php:2450
php
skin txt MediaWiki includes four core it has been set as the default in MediaWiki since the replacing Monobook it had been been the default skin since before being replaced by Vector largely rewritten in while keeping its appearance Several legacy skins were removed in the as the burden of supporting them became too heavy to bear Those in etc for skin dependent CSS etc for skin dependent JavaScript These can also be customised on a per user by etc This feature has led to a wide variety of user styles becoming that gallery is a good place to ending in php
Definition: skin.txt:62
ApiQueryAllPages\getHelpUrls
getHelpUrls()
Definition: ApiQueryAllPages.php:374
MWNamespace\hasGenderDistinction
static hasGenderDistinction( $index)
Does the namespace (potentially) have different aliases for different genders.
Definition: Namespace.php:406
ApiQueryAllPages
Query module to enumerate all available pages.
Definition: ApiQueryAllPages.php:32
ApiBase\PARAM_TYPE
const PARAM_TYPE
Definition: ApiBase.php:50
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:205
ApiQueryBase\select
select( $method, $extraQuery=array())
Execute a SELECT query based on the values in the internal arrays.
Definition: ApiQueryBase.php:274
$from
$from
Definition: importImages.php:90
$params
$params
Definition: styleTest.css.php:40
$limit
if( $sleep) $limit
Definition: importImages.php:99
ApiQueryAllPages\__construct
__construct( $query, $moduleName)
Definition: ApiQueryAllPages.php:34
ApiQueryBase\addOption
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
Definition: ApiQueryBase.php:252
ApiQueryAllPages\getDescription
getDescription()
Returns the description string for this module.
Definition: ApiQueryAllPages.php:343
ApiQueryAllPages\getParamDescription
getParamDescription()
Returns an array of parameter descriptions.
Definition: ApiQueryAllPages.php:302
NS_MAIN
const NS_MAIN
Definition: Defines.php:79
ApiQueryGeneratorBase\setContinueEnumParameter
setContinueEnumParameter( $paramName, $paramValue)
Overrides base in case of generator & smart continue to notify ApiQueryMain instead of adding them to...
Definition: ApiQueryBase.php:676
ApiBase\PARAM_MIN
const PARAM_MIN
Definition: ApiBase.php:56
ApiQueryAllPages\getExamples
getExamples()
Returns usage examples for this module.
Definition: ApiQueryAllPages.php:358
ApiQueryAllPages\getPossibleErrors
getPossibleErrors()
Definition: ApiQueryAllPages.php:347
ApiBase\LIMIT_BIG1
const LIMIT_BIG1
Definition: ApiBase.php:78
ApiQueryBase\getDB
getDB()
Get the Query database connection (read-only)
Definition: ApiQueryBase.php:417
ApiBase\PARAM_MAX
const PARAM_MAX
Definition: ApiBase.php:52
ApiQueryBase\addTables
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
Definition: ApiQueryBase.php:82
array
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:93
ApiBase\getModulePrefix
getModulePrefix()
Get parameter prefix (usually two letters or an empty string).
Definition: ApiBase.php:165
ApiQueryBase\addWhereRange
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.
Definition: ApiQueryBase.php:205
ApiBase\extractRequestParams
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:687
$title
presenting them properly to the user as errors is done by the caller $title
Definition: hooks.txt:1324
ApiBase\dieContinueUsageIf
dieContinueUsageIf( $condition)
Die with the $prefix.
Definition: ApiBase.php:1969
ApiBase\dieUsage
dieUsage( $description, $errorCode, $httpRespCode=0, $extradata=null)
Throw a UsageException, which will (if uncaught) call the main module's error handler and die with an...
Definition: ApiBase.php:1363
ApiQueryBase\addJoinConds
addJoinConds( $join_conds)
Add a set of JOIN conditions to the internal array.
Definition: ApiQueryBase.php:106
ApiQueryAllPages\run
run( $resultPageSet=null)
Definition: ApiQueryAllPages.php:66
ApiQueryAllPages\getAllowedParams
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiQueryAllPages.php:227
ApiQueryBase\titlePartToKey
titlePartToKey( $titlePart, $defaultNamespace=NS_MAIN)
An alternative to titleToKey() that doesn't trim trailing spaces, and does not mangle the input if st...
Definition: ApiQueryBase.php:491
ApiQueryBase\addWhereFld
addWhereFld( $field, $value)
Equivalent to addWhere(array($field => $value))
Definition: ApiQueryBase.php:185
ApiQueryAllPages\executeGenerator
executeGenerator( $resultPageSet)
Definition: ApiQueryAllPages.php:50
ApiQueryAllPages\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiQueryAllPages.php:38
$count
$count
Definition: UtfNormalTest2.php:96
ApiQueryGeneratorBase
Definition: ApiQueryBase.php:626
ApiBase\LIMIT_BIG2
const LIMIT_BIG2
Definition: ApiBase.php:79
$dir
if(count( $args)==0) $dir
Definition: importImages.php:49
ApiBase\PARAM_DFLT
const PARAM_DFLT
Definition: ApiBase.php:46
ApiQueryAllPages\getResultProperties
getResultProperties()
Returns possible properties in the result, grouped by the value of the prop parameter that shows them...
Definition: ApiQueryAllPages.php:333
as
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
Definition: distributors.txt:9
ApiBase\getModuleName
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:148
ApiBase\PARAM_ISMULTI
const PARAM_ISMULTI
Definition: ApiBase.php:48
ApiBase\PARAM_MAX2
const PARAM_MAX2
Definition: ApiBase.php:54
ApiQueryBase\addWhere
addWhere( $value)
Add a set of WHERE clauses to the internal array.
Definition: ApiQueryBase.php:152
$query
return true to allow those checks to and false if checking is done use this to change the tables headers temp or archived zone change it to an object instance and return false override the list derivative used the name of the old file when set the default code will be skipped add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1105
ApiQueryAllPages\getCacheMode
getCacheMode( $params)
Get the cache mode for the data generated by this module.
Definition: ApiQueryAllPages.php:42
$res
$res
Definition: database.txt:21