MediaWiki  master
ApiQueryIWBacklinks.php
Go to the documentation of this file.
1 <?php
31 
32  public function __construct( ApiQuery $query, $moduleName ) {
33  parent::__construct( $query, $moduleName, 'iwbl' );
34  }
35 
36  public function execute() {
37  $this->run();
38  }
39 
40  public function executeGenerator( $resultPageSet ) {
41  $this->run( $resultPageSet );
42  }
43 
48  public function run( $resultPageSet = null ) {
49  $params = $this->extractRequestParams();
50 
51  if ( isset( $params['title'] ) && !isset( $params['prefix'] ) ) {
52  $this->dieWithError(
53  [
54  'apierror-invalidparammix-mustusewith',
55  $this->encodeParamName( 'title' ),
56  $this->encodeParamName( 'prefix' ),
57  ],
58  'invalidparammix'
59  );
60  }
61 
62  if ( $params['continue'] !== null ) {
63  $cont = explode( '|', $params['continue'] );
64  $this->dieContinueUsageIf( count( $cont ) != 3 );
65 
66  $db = $this->getDB();
67  $op = $params['dir'] == 'descending' ? '<' : '>';
68  $prefix = $db->addQuotes( $cont[0] );
69  $title = $db->addQuotes( $cont[1] );
70  $from = (int)$cont[2];
71  $this->addWhere(
72  "iwl_prefix $op $prefix OR " .
73  "(iwl_prefix = $prefix AND " .
74  "(iwl_title $op $title OR " .
75  "(iwl_title = $title AND " .
76  "iwl_from $op= $from)))"
77  );
78  }
79 
80  $prop = array_flip( $params['prop'] );
81  $iwprefix = isset( $prop['iwprefix'] );
82  $iwtitle = isset( $prop['iwtitle'] );
83 
84  $this->addTables( [ 'iwlinks', 'page' ] );
85  $this->addWhere( 'iwl_from = page_id' );
86 
87  $this->addFields( [ 'page_id', 'page_title', 'page_namespace', 'page_is_redirect',
88  'iwl_from', 'iwl_prefix', 'iwl_title' ] );
89 
90  $sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
91  if ( isset( $params['prefix'] ) ) {
92  $this->addWhereFld( 'iwl_prefix', $params['prefix'] );
93  if ( isset( $params['title'] ) ) {
94  $this->addWhereFld( 'iwl_title', $params['title'] );
95  $this->addOption( 'ORDER BY', 'iwl_from' . $sort );
96  } else {
97  $this->addOption( 'ORDER BY', [
98  'iwl_title' . $sort,
99  'iwl_from' . $sort
100  ] );
101  }
102  } else {
103  $this->addOption( 'ORDER BY', [
104  'iwl_prefix' . $sort,
105  'iwl_title' . $sort,
106  'iwl_from' . $sort
107  ] );
108  }
109 
110  $this->addOption( 'LIMIT', $params['limit'] + 1 );
111 
112  $res = $this->select( __METHOD__ );
113 
114  $pages = [];
115 
116  $count = 0;
117  $result = $this->getResult();
118 
119  if ( $resultPageSet === null ) {
120  $this->executeGenderCacheFromResultWrapper( $res, __METHOD__ );
121  }
122 
123  foreach ( $res as $row ) {
124  if ( ++$count > $params['limit'] ) {
125  // We've reached the one extra which shows that there are
126  // additional pages to be had. Stop here...
127  // Continue string preserved in case the redirect query doesn't
128  // pass the limit
130  'continue',
131  "{$row->iwl_prefix}|{$row->iwl_title}|{$row->iwl_from}"
132  );
133  break;
134  }
135 
136  if ( $resultPageSet !== null ) {
137  $pages[] = Title::newFromRow( $row );
138  } else {
139  $entry = [ 'pageid' => (int)$row->page_id ];
140 
141  $title = Title::makeTitle( $row->page_namespace, $row->page_title );
143 
144  if ( $row->page_is_redirect ) {
145  $entry['redirect'] = true;
146  }
147 
148  if ( $iwprefix ) {
149  $entry['iwprefix'] = $row->iwl_prefix;
150  }
151 
152  if ( $iwtitle ) {
153  $entry['iwtitle'] = $row->iwl_title;
154  }
155 
156  $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $entry );
157  if ( !$fit ) {
159  'continue',
160  "{$row->iwl_prefix}|{$row->iwl_title}|{$row->iwl_from}"
161  );
162  break;
163  }
164  }
165  }
166 
167  if ( $resultPageSet === null ) {
168  $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'iw' );
169  } else {
170  $resultPageSet->populateFromTitles( $pages );
171  }
172  }
173 
174  public function getCacheMode( $params ) {
175  return 'public';
176  }
177 
178  public function getAllowedParams() {
179  return [
180  'prefix' => null,
181  'title' => null,
182  'continue' => [
183  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
184  ],
185  'limit' => [
186  ApiBase::PARAM_DFLT => 10,
187  ApiBase::PARAM_TYPE => 'limit',
188  ApiBase::PARAM_MIN => 1,
191  ],
192  'prop' => [
193  ApiBase::PARAM_ISMULTI => true,
194  ApiBase::PARAM_DFLT => '',
196  'iwprefix',
197  'iwtitle',
198  ],
200  ],
201  'dir' => [
202  ApiBase::PARAM_DFLT => 'ascending',
204  'ascending',
205  'descending'
206  ]
207  ],
208  ];
209  }
210 
211  protected function getExamplesMessages() {
212  return [
213  'action=query&list=iwbacklinks&iwbltitle=Test&iwblprefix=wikibooks'
214  => 'apihelp-query+iwbacklinks-example-simple',
215  'action=query&generator=iwbacklinks&giwbltitle=Test&giwblprefix=wikibooks&prop=info'
216  => 'apihelp-query+iwbacklinks-example-generator',
217  ];
218  }
219 
220  public function getHelpUrls() {
221  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Iwbacklinks';
222  }
223 }
ApiQueryBase\addFields
addFields( $value)
Add a set of fields to select to the internal array.
Definition: ApiQueryBase.php:208
ApiQuery
This is the main query class.
Definition: ApiQuery.php:37
ApiQueryGeneratorBase\encodeParamName
encodeParamName( $paramName)
Overrides ApiBase to prepend 'g' to every generator parameter.
Definition: ApiQueryGeneratorBase.php:71
ApiBase\dieWithError
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:1415
ApiBase\PARAM_HELP_MSG
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition: ApiBase.php:104
ApiBase\PARAM_TYPE
const PARAM_TYPE
(boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE
Definition: ApiBase.php:68
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:546
ApiQueryBase\addOption
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
Definition: ApiQueryBase.php:374
$res
$res
Definition: testCompression.php:57
ApiQueryGeneratorBase\setContinueEnumParameter
setContinueEnumParameter( $paramName, $paramValue)
Overridden to set the generator param if in generator mode.
Definition: ApiQueryGeneratorBase.php:84
ApiBase\PARAM_MIN
const PARAM_MIN
(boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE
Definition: ApiBase.php:71
ApiQueryBase\executeGenderCacheFromResultWrapper
executeGenderCacheFromResultWrapper(IResultWrapper $res, $fname=__METHOD__, $fieldPrefix='page')
Preprocess the result set to fill the GenderCache with the necessary information before using self::a...
Definition: ApiQueryBase.php:623
Title\newFromRow
static newFromRow( $row)
Make a Title object from a DB row.
Definition: Title.php:527
ApiBase\LIMIT_BIG1
const LIMIT_BIG1
Fast query, standard limit.
Definition: ApiBase.php:162
ApiQueryBase\getDB
getDB()
Get the Query database connection (read-only)
Definition: ApiQueryBase.php:113
ApiBase\PARAM_MAX
const PARAM_MAX
(boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE
Definition: ApiBase.php:69
ApiQueryBase\addTables
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
Definition: ApiQueryBase.php:178
ApiQueryBase\select
select( $method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
Definition: ApiQueryBase.php:395
ApiBase\extractRequestParams
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:695
$title
$title
Definition: testCompression.php:38
Title\makeTitle
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:595
ApiBase\dieContinueUsageIf
dieContinueUsageIf( $condition)
Die with the 'badcontinue' error.
Definition: ApiBase.php:1595
ApiQueryBase\addWhereFld
addWhereFld( $field, $value)
Equivalent to addWhere( [ $field => $value ] )
Definition: ApiQueryBase.php:278
ApiQueryGeneratorBase
Definition: ApiQueryGeneratorBase.php:26
ApiBase\LIMIT_BIG2
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition: ApiBase.php:164
ApiBase\PARAM_DFLT
const PARAM_DFLT
(boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE
Definition: ApiBase.php:66
ApiBase\getModuleName
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:426
ApiBase\PARAM_ISMULTI
const PARAM_ISMULTI
(boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE
Definition: ApiBase.php:67
ApiBase\PARAM_MAX2
const PARAM_MAX2
(boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE
Definition: ApiBase.php:70
ApiQueryBase\addWhere
addWhere( $value)
Add a set of WHERE clauses to the internal array.
Definition: ApiQueryBase.php:241
ApiBase\PARAM_HELP_MSG_PER_VALUE
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:137
ApiQueryBase\addTitleInfo
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
Definition: ApiQueryBase.php:463