MediaWiki  1.28.0
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();
99  $params = $this->extractRequestParams();
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  // Determine our fields to query on
108  $p = $settings['prefix'];
109  $hasNS = !isset( $settings['to_namespace'] );
110  if ( $hasNS ) {
111  $bl_namespace = "{$p}_namespace";
112  $bl_title = "{$p}_title";
113  } else {
114  $bl_namespace = $settings['to_namespace'];
115  $bl_title = "{$p}_to";
116 
117  $titles = array_filter( $titles, function ( $t ) use ( $bl_namespace ) {
118  return $t->getNamespace() === $bl_namespace;
119  } );
120  $map = array_intersect_key( $map, [ $bl_namespace => true ] );
121  }
122  $bl_from = "{$p}_from";
123 
124  if ( !$titles ) {
125  return; // nothing to do
126  }
127 
128  // Figure out what we're sorting by, and add associated WHERE clauses.
129  // MySQL's query planner screws up if we include a field in ORDER BY
130  // when it's constant in WHERE, so we have to test that for each field.
131  $sortby = [];
132  if ( $hasNS && count( $map ) > 1 ) {
133  $sortby[$bl_namespace] = 'ns';
134  }
135  $theTitle = null;
136  foreach ( $map as $nsTitles ) {
137  reset( $nsTitles );
138  $key = key( $nsTitles );
139  if ( $theTitle === null ) {
140  $theTitle = $key;
141  }
142  if ( count( $nsTitles ) > 1 || $key !== $theTitle ) {
143  $sortby[$bl_title] = 'title';
144  break;
145  }
146  }
147  $miser_ns = null;
148  if ( $params['namespace'] !== null ) {
149  if ( empty( $settings['from_namespace'] ) ) {
150  if ( $this->getConfig()->get( 'MiserMode' ) ) {
151  $miser_ns = $params['namespace'];
152  } else {
153  $this->addWhereFld( 'page_namespace', $params['namespace'] );
154  }
155  } else {
156  $this->addWhereFld( "{$p}_from_namespace", $params['namespace'] );
157  if ( !empty( $settings['from_namespace'] ) && count( $params['namespace'] ) > 1 ) {
158  $sortby["{$p}_from_namespace"] = 'int';
159  }
160  }
161  }
162  $sortby[$bl_from] = 'int';
163 
164  // Now use the $sortby to figure out the continuation
165  if ( !is_null( $params['continue'] ) ) {
166  $cont = explode( '|', $params['continue'] );
167  $this->dieContinueUsageIf( count( $cont ) != count( $sortby ) );
168  $where = '';
169  $i = count( $sortby ) - 1;
170  foreach ( array_reverse( $sortby, true ) as $field => $type ) {
171  $v = $cont[$i];
172  switch ( $type ) {
173  case 'ns':
174  case 'int':
175  $v = (int)$v;
176  $this->dieContinueUsageIf( $v != $cont[$i] );
177  break;
178  default:
179  $v = $db->addQuotes( $v );
180  break;
181  }
182 
183  if ( $where === '' ) {
184  $where = "$field >= $v";
185  } else {
186  $where = "$field > $v OR ($field = $v AND ($where))";
187  }
188 
189  $i--;
190  }
191  $this->addWhere( $where );
192  }
193 
194  // Populate the rest of the query
195  $this->addTables( [ $settings['linktable'], 'page' ] );
196  $this->addWhere( "$bl_from = page_id" );
197 
198  if ( $this->getModuleName() === 'redirects' ) {
199  $this->addWhere( "rd_interwiki = $emptyString OR rd_interwiki IS NULL" );
200  }
201 
202  $this->addFields( array_keys( $sortby ) );
203  $this->addFields( [ 'bl_namespace' => $bl_namespace, 'bl_title' => $bl_title ] );
204  if ( is_null( $resultPageSet ) ) {
205  $fld_pageid = isset( $prop['pageid'] );
206  $fld_title = isset( $prop['title'] );
207  $fld_redirect = isset( $prop['redirect'] );
208 
209  $this->addFieldsIf( 'page_id', $fld_pageid );
210  $this->addFieldsIf( [ 'page_title', 'page_namespace' ], $fld_title );
211  $this->addFieldsIf( 'page_is_redirect', $fld_redirect );
212 
213  // prop=redirects
214  $fld_fragment = isset( $prop['fragment'] );
215  $this->addFieldsIf( 'rd_fragment', $fld_fragment );
216  } else {
217  $this->addFields( $resultPageSet->getPageTableFields() );
218  }
219 
220  $this->addFieldsIf( 'page_namespace', $miser_ns !== null );
221 
222  if ( $hasNS ) {
223  $lb = new LinkBatch( $titles );
224  $this->addWhere( $lb->constructSet( $p, $db ) );
225  } else {
226  $where = [];
227  foreach ( $titles as $t ) {
228  if ( $t->getNamespace() == $bl_namespace ) {
229  $where[] = "$bl_title = " . $db->addQuotes( $t->getDBkey() );
230  }
231  }
232  $this->addWhere( $db->makeList( $where, LIST_OR ) );
233  }
234 
235  if ( $params['show'] !== null ) {
236  // prop=redirects only
237  $show = array_flip( $params['show'] );
238  if ( isset( $show['fragment'] ) && isset( $show['!fragment'] ) ||
239  isset( $show['redirect'] ) && isset( $show['!redirect'] )
240  ) {
241  $this->dieUsageMsg( 'show' );
242  }
243  $this->addWhereIf( "rd_fragment != $emptyString", isset( $show['fragment'] ) );
244  $this->addWhereIf(
245  "rd_fragment = $emptyString OR rd_fragment IS NULL",
246  isset( $show['!fragment'] )
247  );
248  $this->addWhereIf( [ 'page_is_redirect' => 1 ], isset( $show['redirect'] ) );
249  $this->addWhereIf( [ 'page_is_redirect' => 0 ], isset( $show['!redirect'] ) );
250  }
251 
252  // Override any ORDER BY from above with what we calculated earlier.
253  $this->addOption( 'ORDER BY', array_keys( $sortby ) );
254 
255  // MySQL's optimizer chokes if we have too many values in "$bl_title IN
256  // (...)" and chooses the wrong index, so specify the correct index to
257  // use for the query. See T139056 for details.
258  if ( !empty( $settings['indexes'] ) ) {
259  list( $idxNoFromNS, $idxWithFromNS ) = $settings['indexes'];
260  if ( $params['namespace'] !== null && !empty( $settings['from_namespace'] ) ) {
261  $this->addOption( 'USE INDEX', [ $settings['linktable'] => $idxWithFromNS ] );
262  } else {
263  $this->addOption( 'USE INDEX', [ $settings['linktable'] => $idxNoFromNS ] );
264  }
265  }
266 
267  // MySQL (or at least 5.5.5-10.0.23-MariaDB) chooses a really bad query
268  // plan if it thinks there will be more matching rows in the linktable
269  // than are in page. Use STRAIGHT_JOIN here to force it to use the
270  // intended, fast plan. See T145079 for details.
271  $this->addOption( 'STRAIGHT_JOIN' );
272 
273  $this->addOption( 'LIMIT', $params['limit'] + 1 );
274 
275  $res = $this->select( __METHOD__ );
276 
277  if ( is_null( $resultPageSet ) ) {
278  $count = 0;
279  foreach ( $res as $row ) {
280  if ( ++$count > $params['limit'] ) {
281  // We've reached the one extra which shows that
282  // there are additional pages to be had. Stop here...
283  $this->setContinue( $row, $sortby );
284  break;
285  }
286 
287  if ( $miser_ns !== null && !in_array( $row->page_namespace, $miser_ns ) ) {
288  // Miser mode namespace check
289  continue;
290  }
291 
292  // Get the ID of the current page
293  $id = $map[$row->bl_namespace][$row->bl_title];
294 
295  $vals = [];
296  if ( $fld_pageid ) {
297  $vals['pageid'] = (int)$row->page_id;
298  }
299  if ( $fld_title ) {
301  Title::makeTitle( $row->page_namespace, $row->page_title )
302  );
303  }
304  if ( $fld_fragment && $row->rd_fragment !== null && $row->rd_fragment !== '' ) {
305  $vals['fragment'] = $row->rd_fragment;
306  }
307  if ( $fld_redirect ) {
308  $vals['redirect'] = (bool)$row->page_is_redirect;
309  }
310  $fit = $this->addPageSubItem( $id, $vals );
311  if ( !$fit ) {
312  $this->setContinue( $row, $sortby );
313  break;
314  }
315  }
316  } else {
317  $titles = [];
318  $count = 0;
319  foreach ( $res as $row ) {
320  if ( ++$count > $params['limit'] ) {
321  // We've reached the one extra which shows that
322  // there are additional pages to be had. Stop here...
323  $this->setContinue( $row, $sortby );
324  break;
325  }
326  $titles[] = Title::makeTitle( $row->page_namespace, $row->page_title );
327  }
328  $resultPageSet->populateFromTitles( $titles );
329  }
330  }
331 
332  private function setContinue( $row, $sortby ) {
333  $cont = [];
334  foreach ( $sortby as $field => $v ) {
335  $cont[] = $row->$field;
336  }
337  $this->setContinueEnumParameter( 'continue', implode( '|', $cont ) );
338  }
339 
340  public function getCacheMode( $params ) {
341  return 'public';
342  }
343 
344  public function getAllowedParams() {
345  $settings = self::$settings[$this->getModuleName()];
346 
347  $ret = [
348  'prop' => [
350  'pageid',
351  'title',
352  ],
353  ApiBase::PARAM_ISMULTI => true,
354  ApiBase::PARAM_DFLT => 'pageid|title',
356  ],
357  'namespace' => [
358  ApiBase::PARAM_ISMULTI => true,
359  ApiBase::PARAM_TYPE => 'namespace',
360  ],
361  'show' => null, // Will be filled/removed below
362  'limit' => [
363  ApiBase::PARAM_DFLT => 10,
364  ApiBase::PARAM_TYPE => 'limit',
365  ApiBase::PARAM_MIN => 1,
368  ],
369  'continue' => [
370  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
371  ],
372  ];
373 
374  if ( empty( $settings['from_namespace'] ) && $this->getConfig()->get( 'MiserMode' ) ) {
375  $ret['namespace'][ApiBase::PARAM_HELP_MSG_APPEND] = [
376  'api-help-param-limited-in-miser-mode',
377  ];
378  }
379 
380  if ( !empty( $settings['showredirects'] ) ) {
381  $ret['prop'][ApiBase::PARAM_TYPE][] = 'redirect';
382  $ret['prop'][ApiBase::PARAM_DFLT] .= '|redirect';
383  }
384  if ( isset( $settings['props'] ) ) {
385  $ret['prop'][ApiBase::PARAM_TYPE] = array_merge(
386  $ret['prop'][ApiBase::PARAM_TYPE], $settings['props']
387  );
388  }
389 
390  $show = [];
391  if ( !empty( $settings['showredirects'] ) ) {
392  $show[] = 'redirect';
393  $show[] = '!redirect';
394  }
395  if ( isset( $settings['show'] ) ) {
396  $show = array_merge( $show, $settings['show'] );
397  }
398  if ( $show ) {
399  $ret['show'] = [
400  ApiBase::PARAM_TYPE => $show,
401  ApiBase::PARAM_ISMULTI => true,
402  ];
403  } else {
404  unset( $ret['show'] );
405  }
406 
407  return $ret;
408  }
409 
410  protected function getExamplesMessages() {
411  $settings = self::$settings[$this->getModuleName()];
412  $name = $this->getModuleName();
413  $path = $this->getModulePath();
414  $title = isset( $settings['exampletitle'] ) ? $settings['exampletitle'] : 'Main Page';
415  $etitle = rawurlencode( $title );
416 
417  return [
418  "action=query&prop={$name}&titles={$etitle}"
419  => "apihelp-$path-example-simple",
420  "action=query&generator={$name}&titles={$etitle}&prop=info"
421  => "apihelp-$path-example-generator",
422  ];
423  }
424 
425  public function getHelpUrls() {
426  $name = ucfirst( $this->getModuleName() );
427  return "https://www.mediawiki.org/wiki/API:{$name}";
428  }
429 }
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:88
getDB()
Get the Query database connection (read-only)
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition: ApiBase.php:179
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
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:1555
addWhereFld($field, $value)
Equivalent to addWhere(array($field => $value))
This class contains a list of pages that the client has requested.
Definition: ApiPageSet.php:41
addPageSubItem($pageId, $item, $elemname=null)
Same as addPageSubItems(), but one element of $data at a time.
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:1936
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
run(ApiPageSet $resultPageSet=null)
static __construct(ApiQuery $query, $moduleName)
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:50
const LIMIT_BIG1
Fast query, standard limit.
Definition: ApiBase.php:177
const PARAM_MAX
(integer) Max value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:91
extractRequestParams($parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:678
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:157
select($method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
setContinueEnumParameter($paramName, $paramValue)
Overridden to set the generator param if in generator mode.
addWhere($value)
Add a set of WHERE clauses to the internal array.
Class representing a list of titles The execute() method checks them all for existence and adds them ...
Definition: LinkBatch.php:32
const PARAM_HELP_MSG_APPEND
((string|array|Message)[]) Specify additional i18n messages to append to the normal message for this ...
Definition: ApiBase.php:132
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:25
addWhereIf($value, $condition)
Same as addWhere(), but add the WHERE clauses only if a condition is met.
$res
Definition: database.txt:21
getModulePath()
Get the path to this module.
Definition: ApiBase.php:521
getConfig()
Get the Config object.
addOption($name, $value=null)
Add an option such as LIMIT or USE INDEX.
$params
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:953
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:457
const NS_FILE
Definition: Defines.php:62
const PARAM_MAX2
(integer) Max value allowed for the parameter for users with the apihighlimits right, for PARAM_TYPE 'limit'.
Definition: ApiBase.php:97
This is the main query class.
Definition: ApiQuery.php:38
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
dieContinueUsageIf($condition)
Die with the $prefix.
Definition: ApiBase.php:2229
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter...
Definition: ApiBase.php:125
const LIST_OR
Definition: Defines.php:38
addFieldsIf($value, $condition)
Same as addFields(), but add the fields only if a condition is met.
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:35
executeGenerator($resultPageSet)
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
addFields($value)
Add a set of fields to select to the internal array.
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:53
$count
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:100
static addTitleInfo(&$arr, $title, $prefix= '')
Add information (title and namespace) about a Title object to a result array.
getPageSet()
Get the PageSet object to work on.
addTables($tables, $alias=null)
Add a set of tables to the internal array.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
Definition: hooks.txt:2491
static makeTitle($ns, $title, $fragment= '', $interwiki= '')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:511
dieUsageMsg($error)
Output the error message related to a certain array.
Definition: ApiBase.php:2192
This implements prop=redirects, prop=linkshere, prop=catmembers, prop=transcludedin, and prop=fileusage.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:300