35 private $table, $tablePrefix, $indexTag;
36 private $fieldTitle =
'title';
37 private $dfltNamespace =
NS_MAIN;
38 private $hasNamespace =
true;
39 private $useIndex =
null;
43 private $namespaceInfo;
49 private $linksMigration;
65 switch ( $moduleName ) {
68 $this->table =
'pagelinks';
69 $this->tablePrefix =
'pl_';
70 $this->useIndex =
'pl_namespace';
71 $this->indexTag =
'l';
73 case 'alltransclusions':
75 $this->table =
'templatelinks';
76 $this->tablePrefix =
'tl_';
78 $this->useIndex =
'tl_namespace';
79 $this->indexTag =
't';
83 $this->table =
'imagelinks';
84 $this->tablePrefix =
'il_';
85 $this->fieldTitle =
'to';
87 $this->hasNamespace =
false;
88 $this->indexTag =
'f';
92 $this->table =
'redirect';
93 $this->tablePrefix =
'rd_';
94 $this->indexTag =
'r';
96 'fragment' =>
'rd_fragment',
97 'interwiki' =>
'rd_interwiki',
104 parent::__construct( $query, $moduleName, $prefix );
105 $this->namespaceInfo = $namespaceInfo;
106 $this->genderCache = $genderCache;
107 $this->linksMigration = $linksMigration;
119 $this->run( $resultPageSet );
126 private function run( $resultPageSet =
null ) {
127 $db = $this->
getDB();
130 $pfx = $this->tablePrefix;
132 $nsField = $pfx .
'namespace';
133 $titleField = $pfx . $this->fieldTitle;
134 if ( isset( $this->linksMigration::$mapping[$this->table] ) ) {
135 list( $nsField, $titleField ) = $this->linksMigration->getTitleFields( $this->table );
136 $queryInfo = $this->linksMigration->getQueryInfo( $this->table );
137 $this->
addTables( $queryInfo[
'tables'] );
140 if ( $this->useIndex ) {
141 $this->
addOption(
'USE INDEX', $this->useIndex );
146 $prop = array_fill_keys( $params[
'prop'],
true );
147 $fld_ids = isset( $prop[
'ids'] );
148 $fld_title = isset( $prop[
'title'] );
149 if ( $this->hasNamespace ) {
150 $namespace = $params[
'namespace'];
152 $namespace = $this->dfltNamespace;
155 if ( $params[
'unique'] ) {
156 $matches = array_intersect_key( $prop, $this->props + [
'ids' => 1 ] );
161 'apierror-invalidparammix-cannotusewith',
162 "{$p}prop=" . implode(
'|', array_keys(
$matches ) ),
171 if ( $this->hasNamespace ) {
175 $continue = $params[
'continue'] !==
null;
177 $continueArr = explode(
'|', $params[
'continue'] );
178 $op = $params[
'dir'] ==
'descending' ?
'<' :
'>';
179 if ( $params[
'unique'] ) {
181 $continueTitle = $db->addQuotes( $continueArr[0] );
182 $this->
addWhere(
"{$titleField} $op= $continueTitle" );
185 $continueTitle = $db->addQuotes( $continueArr[0] );
186 $continueFrom = (int)$continueArr[1];
188 "{$titleField} $op $continueTitle OR " .
189 "({$titleField} = $continueTitle AND " .
190 "{$pfx}from $op= $continueFrom)"
196 $from = $continue || $params[
'from'] ===
null ? null :
198 $to = $params[
'to'] ===
null ? null :
202 if ( isset( $params[
'prefix'] ) ) {
203 $this->
addWhere( $titleField . $db->buildLike( $this->titlePartToKey(
204 $params[
'prefix'], $namespace ), $db->anyString() ) );
207 $this->
addFields( [
'pl_title' => $titleField ] );
208 $this->
addFieldsIf( [
'pl_from' => $pfx .
'from' ], !$params[
'unique'] );
209 foreach ( $this->props as $name => $field ) {
210 $this->
addFieldsIf( $field, isset( $prop[$name] ) );
213 $limit = $params[
'limit'];
216 $sort = ( $params[
'dir'] ==
'descending' ?
' DESC' :
'' );
218 $orderBy[] = $titleField . $sort;
219 if ( !$params[
'unique'] ) {
220 $orderBy[] = $pfx .
'from' . $sort;
222 $this->
addOption(
'ORDER BY', $orderBy );
227 if ( $resultPageSet ===
null &&
$res->numRows() && $this->namespaceInfo->hasGenderDistinction( $namespace ) ) {
229 foreach (
$res as $row ) {
230 $users[] = $row->pl_title;
232 if ( $users !== [] ) {
233 $this->genderCache->doQuery( $users, __METHOD__ );
241 foreach (
$res as $row ) {
242 if ( ++$count > $limit ) {
245 if ( $params[
'unique'] ) {
253 if ( $resultPageSet ===
null ) {
258 $vals[
'fromid'] = (int)$row->pl_from;
264 foreach ( $this->props as $name => $field ) {
265 if ( isset( $prop[$name] ) && $row->$field !==
null && $row->$field !==
'' ) {
266 $vals[$name] = $row->$field;
269 $fit = $result->addValue( [
'query', $this->
getModuleName() ],
null, $vals );
271 if ( $params[
'unique'] ) {
278 } elseif ( $params[
'unique'] ) {
281 $pageids[] = $row->pl_from;
285 if ( $resultPageSet ===
null ) {
286 $result->addIndexedTagName( [
'query', $this->
getModuleName() ], $this->indexTag );
287 } elseif ( $params[
'unique'] ) {
288 $resultPageSet->populateFromTitles( $titles );
290 $resultPageSet->populateFromPageIDs( $pageids );
304 ParamValidator::PARAM_ISMULTI =>
true,
305 ParamValidator::PARAM_DEFAULT =>
'title',
306 ParamValidator::PARAM_TYPE => array_merge(
307 [
'ids',
'title' ], array_keys( $this->props )
312 ParamValidator::PARAM_DEFAULT => $this->dfltNamespace,
313 ParamValidator::PARAM_TYPE =>
'namespace',
317 ParamValidator::PARAM_DEFAULT => 10,
318 ParamValidator::PARAM_TYPE =>
'limit',
319 IntegerDef::PARAM_MIN => 1,
324 ParamValidator::PARAM_DEFAULT =>
'ascending',
325 ParamValidator::PARAM_TYPE => [
331 if ( !$this->hasNamespace ) {
332 unset( $allowedParams[
'namespace'] );
335 return $allowedParams;
344 "action=query&list={$name}&{$p}from=B&{$p}prop=ids|title"
345 =>
"apihelp-$path-example-b",
346 "action=query&list={$name}&{$p}unique=&{$p}from=B"
347 =>
"apihelp-$path-example-unique",
348 "action=query&generator={$name}&g{$p}unique=&g{$p}from=B"
349 =>
"apihelp-$path-example-unique-generator",
350 "action=query&generator={$name}&g{$p}from=B"
351 =>
"apihelp-$path-example-generator",
358 return "https://www.mediawiki.org/wiki/Special:MyLanguage/API:{$name}";
dieWithError( $msg, $code=null, $data=null, $httpCode=0)
Abort execution with an error.
getModulePrefix()
Get parameter prefix (usually two letters or an empty string).
dieContinueUsageIf( $condition)
Die with the 'badcontinue' error.
static dieDebug( $method, $message)
Internal code errors should be reported with this method.
const PARAM_HELP_MSG_PER_VALUE
((string|array|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg...
const LIMIT_BIG1
Fast query, standard limit.
getResult()
Get the result object.
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user,...
getModulePath()
Get the path to this module.
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
const LIMIT_BIG2
Fast query, apihighlimits limit.
getModuleName()
Get the name of the module being executed by this instance.
Query module to enumerate links from all pages together.
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
getHelpUrls()
Return links to more detailed help pages about the module.
executeGenerator( $resultPageSet)
Execute this module as a generator.
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
__construct(ApiQuery $query, $moduleName, NamespaceInfo $namespaceInfo, GenderCache $genderCache, LinksMigration $linksMigration)
getExamplesMessages()
Returns usage examples for this module.
getCacheMode( $params)
Get the cache mode for the data generated by this module.
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
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)
select( $method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
addFieldsIf( $value, $condition)
Same as addFields(), but add the fields only if a condition is met.
addJoinConds( $join_conds)
Add a set of JOIN conditions to the internal array.
addWhereFld( $field, $value)
Equivalent to addWhere( [ $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.
const META_TYPE
Key for the 'type' metadata item.
Caches user genders when needed to use correct namespace aliases.
This is a utility class for dealing with namespaces that encodes all the "magic" behaviors of them ba...
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.