MediaWiki  master
ApiQueryAllLinks.php
Go to the documentation of this file.
1 <?php
29 
31  private $fieldTitle = 'title';
33  private $hasNamespace = true;
34  private $useIndex = null;
35  private $props = [];
36 
37  public function __construct( ApiQuery $query, $moduleName ) {
38  switch ( $moduleName ) {
39  case 'alllinks':
40  $prefix = 'al';
41  $this->table = 'pagelinks';
42  $this->tablePrefix = 'pl_';
43  $this->useIndex = 'pl_namespace';
44  $this->indexTag = 'l';
45  break;
46  case 'alltransclusions':
47  $prefix = 'at';
48  $this->table = 'templatelinks';
49  $this->tablePrefix = 'tl_';
50  $this->dfltNamespace = NS_TEMPLATE;
51  $this->useIndex = 'tl_namespace';
52  $this->indexTag = 't';
53  break;
54  case 'allfileusages':
55  $prefix = 'af';
56  $this->table = 'imagelinks';
57  $this->tablePrefix = 'il_';
58  $this->fieldTitle = 'to';
59  $this->dfltNamespace = NS_FILE;
60  $this->hasNamespace = false;
61  $this->indexTag = 'f';
62  break;
63  case 'allredirects':
64  $prefix = 'ar';
65  $this->table = 'redirect';
66  $this->tablePrefix = 'rd_';
67  $this->indexTag = 'r';
68  $this->props = [
69  'fragment' => 'rd_fragment',
70  'interwiki' => 'rd_interwiki',
71  ];
72  break;
73  default:
74  ApiBase::dieDebug( __METHOD__, 'Unknown module name' );
75  }
76 
77  parent::__construct( $query, $moduleName, $prefix );
78  }
79 
80  public function execute() {
81  $this->run();
82  }
83 
84  public function getCacheMode( $params ) {
85  return 'public';
86  }
87 
88  public function executeGenerator( $resultPageSet ) {
89  $this->run( $resultPageSet );
90  }
91 
96  private function run( $resultPageSet = null ) {
97  $db = $this->getDB();
98  $params = $this->extractRequestParams();
99 
100  $pfx = $this->tablePrefix;
102  $prop = array_flip( $params['prop'] );
103  $fld_ids = isset( $prop['ids'] );
104  $fld_title = isset( $prop['title'] );
105  if ( $this->hasNamespace ) {
106  $namespace = $params['namespace'];
107  } else {
108  $namespace = $this->dfltNamespace;
109  }
110 
111  if ( $params['unique'] ) {
112  $matches = array_intersect_key( $prop, $this->props + [ 'ids' => 1 ] );
113  if ( $matches ) {
114  $p = $this->getModulePrefix();
115  $this->dieWithError(
116  [
117  'apierror-invalidparammix-cannotusewith',
118  "{$p}prop=" . implode( '|', array_keys( $matches ) ),
119  "{$p}unique"
120  ],
121  'invalidparammix'
122  );
123  }
124  $this->addOption( 'DISTINCT' );
125  }
126 
127  $this->addTables( $this->table );
128  if ( $this->hasNamespace ) {
129  $this->addWhereFld( $pfx . 'namespace', $namespace );
130  }
131 
132  $continue = !is_null( $params['continue'] );
133  if ( $continue ) {
134  $continueArr = explode( '|', $params['continue'] );
135  $op = $params['dir'] == 'descending' ? '<' : '>';
136  if ( $params['unique'] ) {
137  $this->dieContinueUsageIf( count( $continueArr ) != 1 );
138  $continueTitle = $db->addQuotes( $continueArr[0] );
139  $this->addWhere( "{$pfx}{$fieldTitle} $op= $continueTitle" );
140  } else {
141  $this->dieContinueUsageIf( count( $continueArr ) != 2 );
142  $continueTitle = $db->addQuotes( $continueArr[0] );
143  $continueFrom = (int)$continueArr[1];
144  $this->addWhere(
145  "{$pfx}{$fieldTitle} $op $continueTitle OR " .
146  "({$pfx}{$fieldTitle} = $continueTitle AND " .
147  "{$pfx}from $op= $continueFrom)"
148  );
149  }
150  }
151 
152  // 'continue' always overrides 'from'
153  $from = $continue || $params['from'] === null ? null :
154  $this->titlePartToKey( $params['from'], $namespace );
155  $to = $params['to'] === null ? null :
156  $this->titlePartToKey( $params['to'], $namespace );
157  $this->addWhereRange( $pfx . $fieldTitle, 'newer', $from, $to );
158 
159  if ( isset( $params['prefix'] ) ) {
160  $this->addWhere( $pfx . $fieldTitle . $db->buildLike( $this->titlePartToKey(
161  $params['prefix'], $namespace ), $db->anyString() ) );
162  }
163 
164  $this->addFields( [ 'pl_title' => $pfx . $fieldTitle ] );
165  $this->addFieldsIf( [ 'pl_from' => $pfx . 'from' ], !$params['unique'] );
166  foreach ( $this->props as $name => $field ) {
167  $this->addFieldsIf( $field, isset( $prop[$name] ) );
168  }
169 
170  if ( $this->useIndex ) {
171  $this->addOption( 'USE INDEX', $this->useIndex );
172  }
173  $limit = $params['limit'];
174  $this->addOption( 'LIMIT', $limit + 1 );
175 
176  $sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
177  $orderBy = [];
178  $orderBy[] = $pfx . $fieldTitle . $sort;
179  if ( !$params['unique'] ) {
180  $orderBy[] = $pfx . 'from' . $sort;
181  }
182  $this->addOption( 'ORDER BY', $orderBy );
183 
184  $res = $this->select( __METHOD__ );
185 
186  $pageids = [];
187  $titles = [];
188  $count = 0;
189  $result = $this->getResult();
190  foreach ( $res as $row ) {
191  if ( ++$count > $limit ) {
192  // We've reached the one extra which shows that there are
193  // additional pages to be had. Stop here...
194  if ( $params['unique'] ) {
195  $this->setContinueEnumParameter( 'continue', $row->pl_title );
196  } else {
197  $this->setContinueEnumParameter( 'continue', $row->pl_title . '|' . $row->pl_from );
198  }
199  break;
200  }
201 
202  if ( is_null( $resultPageSet ) ) {
203  $vals = [
204  ApiResult::META_TYPE => 'assoc',
205  ];
206  if ( $fld_ids ) {
207  $vals['fromid'] = (int)$row->pl_from;
208  }
209  if ( $fld_title ) {
210  $title = Title::makeTitle( $namespace, $row->pl_title );
212  }
213  foreach ( $this->props as $name => $field ) {
214  if ( isset( $prop[$name] ) && $row->$field !== null && $row->$field !== '' ) {
215  $vals[$name] = $row->$field;
216  }
217  }
218  $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $vals );
219  if ( !$fit ) {
220  if ( $params['unique'] ) {
221  $this->setContinueEnumParameter( 'continue', $row->pl_title );
222  } else {
223  $this->setContinueEnumParameter( 'continue', $row->pl_title . '|' . $row->pl_from );
224  }
225  break;
226  }
227  } elseif ( $params['unique'] ) {
228  $titles[] = Title::makeTitle( $namespace, $row->pl_title );
229  } else {
230  $pageids[] = $row->pl_from;
231  }
232  }
233 
234  if ( is_null( $resultPageSet ) ) {
235  $result->addIndexedTagName( [ 'query', $this->getModuleName() ], $this->indexTag );
236  } elseif ( $params['unique'] ) {
237  $resultPageSet->populateFromTitles( $titles );
238  } else {
239  $resultPageSet->populateFromPageIDs( $pageids );
240  }
241  }
242 
243  public function getAllowedParams() {
244  $allowedParams = [
245  'continue' => [
246  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
247  ],
248  'from' => null,
249  'to' => null,
250  'prefix' => null,
251  'unique' => false,
252  'prop' => [
253  ApiBase::PARAM_ISMULTI => true,
254  ApiBase::PARAM_DFLT => 'title',
255  ApiBase::PARAM_TYPE => array_merge(
256  [ 'ids', 'title' ], array_keys( $this->props )
257  ),
259  ],
260  'namespace' => [
262  ApiBase::PARAM_TYPE => 'namespace',
264  ],
265  'limit' => [
266  ApiBase::PARAM_DFLT => 10,
267  ApiBase::PARAM_TYPE => 'limit',
268  ApiBase::PARAM_MIN => 1,
271  ],
272  'dir' => [
273  ApiBase::PARAM_DFLT => 'ascending',
274  ApiBase::PARAM_TYPE => [
275  'ascending',
276  'descending'
277  ]
278  ],
279  ];
280  if ( !$this->hasNamespace ) {
281  unset( $allowedParams['namespace'] );
282  }
283 
284  return $allowedParams;
285  }
286 
287  protected function getExamplesMessages() {
288  $p = $this->getModulePrefix();
289  $name = $this->getModuleName();
290  $path = $this->getModulePath();
291 
292  return [
293  "action=query&list={$name}&{$p}from=B&{$p}prop=ids|title"
294  => "apihelp-$path-example-b",
295  "action=query&list={$name}&{$p}unique=&{$p}from=B"
296  => "apihelp-$path-example-unique",
297  "action=query&generator={$name}&g{$p}unique=&g{$p}from=B"
298  => "apihelp-$path-example-unique-generator",
299  "action=query&generator={$name}&g{$p}from=B"
300  => "apihelp-$path-example-generator",
301  ];
302  }
303 
304  public function getHelpUrls() {
305  $name = ucfirst( $this->getModuleName() );
306 
307  return "https://www.mediawiki.org/wiki/Special:MyLanguage/API:{$name}";
308  }
309 }
select( $method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:94
getDB()
Get the Query database connection (read-only)
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition: ApiBase.php:261
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
getResult()
Get the result object.
Definition: ApiBase.php:640
const NS_MAIN
Definition: Defines.php:60
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:55
const LIMIT_BIG1
Fast query, standard limit.
Definition: ApiBase.php:259
const PARAM_MAX
(integer) Max value allowed for the parameter, for PARAM_TYPE &#39;integer&#39; and &#39;limit&#39;.
Definition: ApiBase.php:97
$sort
const NS_SPECIAL
Definition: Defines.php:49
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:2005
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:761
const META_TYPE
Key for the &#39;type&#39; metadata item.
Definition: ApiResult.php:110
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:164
setContinueEnumParameter( $paramName, $paramValue)
Overridden to set the generator param if in generator mode.
const NS_TEMPLATE
Definition: Defines.php:70
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
titlePartToKey( $titlePart, $namespace=NS_MAIN)
Convert an input title or title prefix into a dbkey.
const NS_MEDIA
Definition: Defines.php:48
dieContinueUsageIf( $condition)
Die with the &#39;badcontinue&#39; error.
Definition: ApiBase.php:2199
getModulePath()
Get the path to this module.
Definition: ApiBase.php:584
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:520
addFields( $value)
Add a set of fields to select to the internal array.
const NS_FILE
Definition: Defines.php:66
const PARAM_MAX2
(integer) Max value allowed for the parameter for users with the apihighlimits right, for PARAM_TYPE &#39;limit&#39;.
Definition: ApiBase.php:103
This is the main query class.
Definition: ApiQuery.php:37
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter...
Definition: ApiBase.php:131
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:586
getModulePrefix()
Get parameter prefix (usually two letters or an empty string).
Definition: ApiBase.php:528
addWhere( $value)
Add a set of WHERE clauses to the internal array.
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:58
static dieDebug( $method, $message)
Internal code errors should be reported with this method.
Definition: ApiBase.php:2211
addWhereFld( $field, $value)
Equivalent to addWhere( [ $field => $value ] )
addFieldsIf( $value, $condition)
Same as addFields(), but add the fields only if a condition is met.
const PARAM_EXTRA_NAMESPACES
(int[]) When PARAM_TYPE is &#39;namespace&#39;, include these as additional possible values.
Definition: ApiBase.php:193
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE &#39;integer&#39; and &#39;limit&#39;.
Definition: ApiBase.php:106
$matches
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...