MediaWiki REL1_30
ApiQueryBacklinksprop.php
Go to the documentation of this file.
1<?php
36
37 // Data for the various modules implemented by this class
38 private static $settings = [
39 'redirects' => [
40 'code' => 'rd',
41 'prefix' => 'rd',
42 'linktable' => 'redirect',
43 'props' => [
44 'fragment',
45 ],
46 'showredirects' => false,
47 'show' => [
48 'fragment',
49 '!fragment',
50 ],
51 ],
52 'linkshere' => [
53 'code' => 'lh',
54 'prefix' => 'pl',
55 'linktable' => 'pagelinks',
56 'indexes' => [ 'pl_namespace', 'pl_backlinks_namespace' ],
57 'from_namespace' => true,
58 'showredirects' => true,
59 ],
60 'transcludedin' => [
61 'code' => 'ti',
62 'prefix' => 'tl',
63 'linktable' => 'templatelinks',
64 'indexes' => [ 'tl_namespace', 'tl_backlinks_namespace' ],
65 'from_namespace' => true,
66 'showredirects' => true,
67 ],
68 'fileusage' => [
69 'code' => 'fu',
70 'prefix' => 'il',
71 'linktable' => 'imagelinks',
72 'indexes' => [ 'il_to', 'il_backlinks_namespace' ],
73 'from_namespace' => true,
74 'to_namespace' => NS_FILE,
75 'exampletitle' => 'File:Example.jpg',
76 'showredirects' => true,
77 ],
78 ];
79
80 public function __construct( ApiQuery $query, $moduleName ) {
81 parent::__construct( $query, $moduleName, self::$settings[$moduleName]['code'] );
82 }
83
84 public function execute() {
85 $this->run();
86 }
87
88 public function executeGenerator( $resultPageSet ) {
89 $this->run( $resultPageSet );
90 }
91
95 private function run( ApiPageSet $resultPageSet = null ) {
96 $settings = self::$settings[$this->getModuleName()];
97
98 $db = $this->getDB();
100 $prop = array_flip( $params['prop'] );
101 $emptyString = $db->addQuotes( '' );
102
103 $pageSet = $this->getPageSet();
104 $titles = $pageSet->getGoodAndMissingTitles();
105 $map = $pageSet->getGoodAndMissingTitlesByNamespace();
106
107 // Add in special pages, they can theoretically have backlinks too.
108 // (although currently they only do for prop=redirects)
109 foreach ( $pageSet->getSpecialTitles() as $id => $title ) {
110 $titles[] = $title;
111 $map[$title->getNamespace()][$title->getDBkey()] = $id;
112 }
113
114 // Determine our fields to query on
115 $p = $settings['prefix'];
116 $hasNS = !isset( $settings['to_namespace'] );
117 if ( $hasNS ) {
118 $bl_namespace = "{$p}_namespace";
119 $bl_title = "{$p}_title";
120 } else {
121 $bl_namespace = $settings['to_namespace'];
122 $bl_title = "{$p}_to";
123
124 $titles = array_filter( $titles, function ( $t ) use ( $bl_namespace ) {
125 return $t->getNamespace() === $bl_namespace;
126 } );
127 $map = array_intersect_key( $map, [ $bl_namespace => true ] );
128 }
129 $bl_from = "{$p}_from";
130
131 if ( !$titles ) {
132 return; // nothing to do
133 }
134
135 // Figure out what we're sorting by, and add associated WHERE clauses.
136 // MySQL's query planner screws up if we include a field in ORDER BY
137 // when it's constant in WHERE, so we have to test that for each field.
138 $sortby = [];
139 if ( $hasNS && count( $map ) > 1 ) {
140 $sortby[$bl_namespace] = 'ns';
141 }
142 $theTitle = null;
143 foreach ( $map as $nsTitles ) {
144 reset( $nsTitles );
145 $key = key( $nsTitles );
146 if ( $theTitle === null ) {
147 $theTitle = $key;
148 }
149 if ( count( $nsTitles ) > 1 || $key !== $theTitle ) {
150 $sortby[$bl_title] = 'title';
151 break;
152 }
153 }
154 $miser_ns = null;
155 if ( $params['namespace'] !== null ) {
156 if ( empty( $settings['from_namespace'] ) ) {
157 if ( $this->getConfig()->get( 'MiserMode' ) ) {
158 $miser_ns = $params['namespace'];
159 } else {
160 $this->addWhereFld( 'page_namespace', $params['namespace'] );
161 }
162 } else {
163 $this->addWhereFld( "{$p}_from_namespace", $params['namespace'] );
164 if ( !empty( $settings['from_namespace'] ) && count( $params['namespace'] ) > 1 ) {
165 $sortby["{$p}_from_namespace"] = 'int';
166 }
167 }
168 }
169 $sortby[$bl_from] = 'int';
170
171 // Now use the $sortby to figure out the continuation
172 if ( !is_null( $params['continue'] ) ) {
173 $cont = explode( '|', $params['continue'] );
174 $this->dieContinueUsageIf( count( $cont ) != count( $sortby ) );
175 $where = '';
176 $i = count( $sortby ) - 1;
177 foreach ( array_reverse( $sortby, true ) as $field => $type ) {
178 $v = $cont[$i];
179 switch ( $type ) {
180 case 'ns':
181 case 'int':
182 $v = (int)$v;
183 $this->dieContinueUsageIf( $v != $cont[$i] );
184 break;
185 default:
186 $v = $db->addQuotes( $v );
187 break;
188 }
189
190 if ( $where === '' ) {
191 $where = "$field >= $v";
192 } else {
193 $where = "$field > $v OR ($field = $v AND ($where))";
194 }
195
196 $i--;
197 }
198 $this->addWhere( $where );
199 }
200
201 // Populate the rest of the query
202 $this->addTables( [ $settings['linktable'], 'page' ] );
203 $this->addWhere( "$bl_from = page_id" );
204
205 if ( $this->getModuleName() === 'redirects' ) {
206 $this->addWhere( "rd_interwiki = $emptyString OR rd_interwiki IS NULL" );
207 }
208
209 $this->addFields( array_keys( $sortby ) );
210 $this->addFields( [ 'bl_namespace' => $bl_namespace, 'bl_title' => $bl_title ] );
211 if ( is_null( $resultPageSet ) ) {
212 $fld_pageid = isset( $prop['pageid'] );
213 $fld_title = isset( $prop['title'] );
214 $fld_redirect = isset( $prop['redirect'] );
215
216 $this->addFieldsIf( 'page_id', $fld_pageid );
217 $this->addFieldsIf( [ 'page_title', 'page_namespace' ], $fld_title );
218 $this->addFieldsIf( 'page_is_redirect', $fld_redirect );
219
220 // prop=redirects
221 $fld_fragment = isset( $prop['fragment'] );
222 $this->addFieldsIf( 'rd_fragment', $fld_fragment );
223 } else {
224 $this->addFields( $resultPageSet->getPageTableFields() );
225 }
226
227 $this->addFieldsIf( 'page_namespace', $miser_ns !== null );
228
229 if ( $hasNS ) {
230 // Can't use LinkBatch because it throws away Special titles.
231 // And we already have the needed data structure anyway.
232 $this->addWhere( $db->makeWhereFrom2d( $map, $bl_namespace, $bl_title ) );
233 } else {
234 $where = [];
235 foreach ( $titles as $t ) {
236 if ( $t->getNamespace() == $bl_namespace ) {
237 $where[] = "$bl_title = " . $db->addQuotes( $t->getDBkey() );
238 }
239 }
240 $this->addWhere( $db->makeList( $where, LIST_OR ) );
241 }
242
243 if ( $params['show'] !== null ) {
244 // prop=redirects only
245 $show = array_flip( $params['show'] );
246 if ( isset( $show['fragment'] ) && isset( $show['!fragment'] ) ||
247 isset( $show['redirect'] ) && isset( $show['!redirect'] )
248 ) {
249 $this->dieWithError( 'apierror-show' );
250 }
251 $this->addWhereIf( "rd_fragment != $emptyString", isset( $show['fragment'] ) );
252 $this->addWhereIf(
253 "rd_fragment = $emptyString OR rd_fragment IS NULL",
254 isset( $show['!fragment'] )
255 );
256 $this->addWhereIf( [ 'page_is_redirect' => 1 ], isset( $show['redirect'] ) );
257 $this->addWhereIf( [ 'page_is_redirect' => 0 ], isset( $show['!redirect'] ) );
258 }
259
260 // Override any ORDER BY from above with what we calculated earlier.
261 $this->addOption( 'ORDER BY', array_keys( $sortby ) );
262
263 // MySQL's optimizer chokes if we have too many values in "$bl_title IN
264 // (...)" and chooses the wrong index, so specify the correct index to
265 // use for the query. See T139056 for details.
266 if ( !empty( $settings['indexes'] ) ) {
267 list( $idxNoFromNS, $idxWithFromNS ) = $settings['indexes'];
268 if ( $params['namespace'] !== null && !empty( $settings['from_namespace'] ) ) {
269 $this->addOption( 'USE INDEX', [ $settings['linktable'] => $idxWithFromNS ] );
270 } else {
271 $this->addOption( 'USE INDEX', [ $settings['linktable'] => $idxNoFromNS ] );
272 }
273 }
274
275 // MySQL (or at least 5.5.5-10.0.23-MariaDB) chooses a really bad query
276 // plan if it thinks there will be more matching rows in the linktable
277 // than are in page. Use STRAIGHT_JOIN here to force it to use the
278 // intended, fast plan. See T145079 for details.
279 $this->addOption( 'STRAIGHT_JOIN' );
280
281 $this->addOption( 'LIMIT', $params['limit'] + 1 );
282
283 $res = $this->select( __METHOD__ );
284
285 if ( is_null( $resultPageSet ) ) {
286 $count = 0;
287 foreach ( $res as $row ) {
288 if ( ++$count > $params['limit'] ) {
289 // We've reached the one extra which shows that
290 // there are additional pages to be had. Stop here...
291 $this->setContinue( $row, $sortby );
292 break;
293 }
294
295 if ( $miser_ns !== null && !in_array( $row->page_namespace, $miser_ns ) ) {
296 // Miser mode namespace check
297 continue;
298 }
299
300 // Get the ID of the current page
301 $id = $map[$row->bl_namespace][$row->bl_title];
302
303 $vals = [];
304 if ( $fld_pageid ) {
305 $vals['pageid'] = (int)$row->page_id;
306 }
307 if ( $fld_title ) {
309 Title::makeTitle( $row->page_namespace, $row->page_title )
310 );
311 }
312 if ( $fld_fragment && $row->rd_fragment !== null && $row->rd_fragment !== '' ) {
313 $vals['fragment'] = $row->rd_fragment;
314 }
315 if ( $fld_redirect ) {
316 $vals['redirect'] = (bool)$row->page_is_redirect;
317 }
318 $fit = $this->addPageSubItem( $id, $vals );
319 if ( !$fit ) {
320 $this->setContinue( $row, $sortby );
321 break;
322 }
323 }
324 } else {
325 $titles = [];
326 $count = 0;
327 foreach ( $res as $row ) {
328 if ( ++$count > $params['limit'] ) {
329 // We've reached the one extra which shows that
330 // there are additional pages to be had. Stop here...
331 $this->setContinue( $row, $sortby );
332 break;
333 }
334 $titles[] = Title::makeTitle( $row->page_namespace, $row->page_title );
335 }
336 $resultPageSet->populateFromTitles( $titles );
337 }
338 }
339
340 private function setContinue( $row, $sortby ) {
341 $cont = [];
342 foreach ( $sortby as $field => $v ) {
343 $cont[] = $row->$field;
344 }
345 $this->setContinueEnumParameter( 'continue', implode( '|', $cont ) );
346 }
347
348 public function getCacheMode( $params ) {
349 return 'public';
350 }
351
352 public function getAllowedParams() {
353 $settings = self::$settings[$this->getModuleName()];
354
355 $ret = [
356 'prop' => [
358 'pageid',
359 'title',
360 ],
362 ApiBase::PARAM_DFLT => 'pageid|title',
364 ],
365 'namespace' => [
367 ApiBase::PARAM_TYPE => 'namespace',
368 ],
369 'show' => null, // Will be filled/removed below
370 'limit' => [
372 ApiBase::PARAM_TYPE => 'limit',
376 ],
377 'continue' => [
378 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
379 ],
380 ];
381
382 if ( empty( $settings['from_namespace'] ) && $this->getConfig()->get( 'MiserMode' ) ) {
383 $ret['namespace'][ApiBase::PARAM_HELP_MSG_APPEND] = [
384 'api-help-param-limited-in-miser-mode',
385 ];
386 }
387
388 if ( !empty( $settings['showredirects'] ) ) {
389 $ret['prop'][ApiBase::PARAM_TYPE][] = 'redirect';
390 $ret['prop'][ApiBase::PARAM_DFLT] .= '|redirect';
391 }
392 if ( isset( $settings['props'] ) ) {
393 $ret['prop'][ApiBase::PARAM_TYPE] = array_merge(
394 $ret['prop'][ApiBase::PARAM_TYPE], $settings['props']
395 );
396 }
397
398 $show = [];
399 if ( !empty( $settings['showredirects'] ) ) {
400 $show[] = 'redirect';
401 $show[] = '!redirect';
402 }
403 if ( isset( $settings['show'] ) ) {
404 $show = array_merge( $show, $settings['show'] );
405 }
406 if ( $show ) {
407 $ret['show'] = [
408 ApiBase::PARAM_TYPE => $show,
410 ];
411 } else {
412 unset( $ret['show'] );
413 }
414
415 return $ret;
416 }
417
418 protected function getExamplesMessages() {
419 $settings = self::$settings[$this->getModuleName()];
420 $name = $this->getModuleName();
421 $path = $this->getModulePath();
422 $title = isset( $settings['exampletitle'] ) ? $settings['exampletitle'] : 'Main Page';
423 $etitle = rawurlencode( $title );
424
425 return [
426 "action=query&prop={$name}&titles={$etitle}"
427 => "apihelp-$path-example-simple",
428 "action=query&generator={$name}&titles={$etitle}&prop=info"
429 => "apihelp-$path-example-generator",
430 ];
431 }
432
433 public function getHelpUrls() {
434 $name = ucfirst( $this->getModuleName() );
435 return "https://www.mediawiki.org/wiki/Special:MyLanguage/API:{$name}";
436 }
437}
and give any other recipients of the Program a copy of this License along with the Program You may charge a fee for the physical act of transferring a and you may at your option offer warranty protection in exchange for a fee You may modify your copy or copies of the Program or any portion of thus forming a work based on the and copy and distribute such modifications or work under the terms of Section provided that you also meet all of these that in whole or in part contains or is derived from the Program or any part to be licensed as a whole at no charge to all third parties under the terms of this License c If the modified program normally reads commands interactively when run
Definition COPYING.txt:104
const PARAM_MAX2
(integer) Max value allowed for the parameter for users with the apihighlimits right,...
Definition ApiBase.php:100
const PARAM_MAX
(integer) Max value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition ApiBase.php:94
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition ApiBase.php:1855
dieContinueUsageIf( $condition)
Die with the 'badcontinue' error.
Definition ApiBase.php:2026
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition ApiBase.php:91
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition ApiBase.php:52
const PARAM_HELP_MSG_APPEND
((string|array|Message)[]) Specify additional i18n messages to append to the normal message for this ...
Definition ApiBase.php:135
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition ApiBase.php:740
const PARAM_HELP_MSG_PER_VALUE
((string|array|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg...
Definition ApiBase.php:160
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition ApiBase.php:103
const LIMIT_BIG1
Fast query, standard limit.
Definition ApiBase.php:225
getModulePath()
Get the path to this module.
Definition ApiBase.php:576
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition ApiBase.php:128
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition ApiBase.php:227
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:55
This class contains a list of pages that the client has requested.
This implements prop=redirects, prop=linkshere, prop=catmembers, prop=transcludedin,...
executeGenerator( $resultPageSet)
Execute this module as a generator.
getHelpUrls()
Return links to more detailed help pages about the module.
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
run(ApiPageSet $resultPageSet=null)
getExamplesMessages()
Returns usage examples for this module.
getCacheMode( $params)
Get the cache mode for the data generated by this module.
__construct(ApiQuery $query, $moduleName)
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
addWhereIf( $value, $condition)
Same as addWhere(), but add the WHERE clauses only if a condition is met.
addFields( $value)
Add a set of fields to select to the internal array.
addPageSubItem( $pageId, $item, $elemname=null)
Same as addPageSubItems(), but one element of $data at a time.
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)
addFieldsIf( $value, $condition)
Same as addFields(), but add the fields only if a condition is met.
addWhereFld( $field, $value)
Equivalent to addWhere(array($field => $value))
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.
getPageSet()
Get the PageSet object to work on.
This is the main query class.
Definition ApiQuery.php:40
getConfig()
Get the Config object.
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
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
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add in any and then calling but I prefer the flexibility This should also do the output encoding The system allocates a global one in $wgOut Title Represents the title of an and does all the work of translating among various forms such as plain database key
Definition design.txt:26
namespace and then decline to actually register it file or subcat img or subcat $title
Definition hooks.txt:962
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:1975
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:1610
const NS_FILE
Definition Defines.php:71
const LIST_OR
Definition Defines.php:47
linkcache txt The LinkCache class maintains a list of article titles and the information about whether or not the article exists in the database This is used to mark up links when displaying a page If the same link appears more than once on any page then it only has to be looked up once In most cases link lookups are done in batches with the LinkBatch class or the equivalent in so the link cache is mostly useful for short snippets of parsed and for links in the navigation areas of the skin The link cache was formerly used to track links used in a document for the purposes of updating the link tables This application is now deprecated To create a you can use the following $titles
Definition linkcache.txt:17
$params