MediaWiki  master
ApiQueryIWBacklinks.php
Go to the documentation of this file.
1 <?php
28 
34 
39  public function __construct( ApiQuery $query, $moduleName ) {
40  parent::__construct( $query, $moduleName, 'iwbl' );
41  }
42 
43  public function execute() {
44  $this->run();
45  }
46 
47  public function executeGenerator( $resultPageSet ) {
48  $this->run( $resultPageSet );
49  }
50 
55  public function run( $resultPageSet = null ) {
56  $params = $this->extractRequestParams();
57 
58  if ( isset( $params['title'] ) && !isset( $params['prefix'] ) ) {
59  $this->dieWithError(
60  [
61  'apierror-invalidparammix-mustusewith',
62  $this->encodeParamName( 'title' ),
63  $this->encodeParamName( 'prefix' ),
64  ],
65  'invalidparammix'
66  );
67  }
68 
69  if ( $params['continue'] !== null ) {
70  $cont = $this->parseContinueParamOrDie( $params['continue'], [ 'string', 'string', 'int' ] );
71  $db = $this->getDB();
72  $op = $params['dir'] == 'descending' ? '<=' : '>=';
73  $this->addWhere( $db->buildComparison( $op, [
74  'iwl_prefix' => $cont[0],
75  'iwl_title' => $cont[1],
76  'iwl_from' => $cont[2],
77  ] ) );
78  }
79 
80  $prop = array_fill_keys( $params['prop'], true );
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  ParamValidator::PARAM_DEFAULT => 10,
187  ParamValidator::PARAM_TYPE => 'limit',
188  IntegerDef::PARAM_MIN => 1,
189  IntegerDef::PARAM_MAX => ApiBase::LIMIT_BIG1,
190  IntegerDef::PARAM_MAX2 => ApiBase::LIMIT_BIG2
191  ],
192  'prop' => [
193  ParamValidator::PARAM_ISMULTI => true,
194  ParamValidator::PARAM_DEFAULT => '',
195  ParamValidator::PARAM_TYPE => [
196  'iwprefix',
197  'iwtitle',
198  ],
200  ],
201  'dir' => [
202  ParamValidator::PARAM_DEFAULT => 'ascending',
203  ParamValidator::PARAM_TYPE => [
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 }
dieWithError( $msg, $code=null, $data=null, $httpCode=0)
Abort execution with an error.
Definition: ApiBase.php:1455
parseContinueParamOrDie(string $continue, array $types)
Parse the 'continue' parameter in the usual format and validate the types of each part,...
Definition: ApiBase.php:1644
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:197
const LIMIT_BIG1
Fast query, standard limit.
Definition: ApiBase.php:222
getResult()
Get the result object.
Definition: ApiBase.php:630
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:766
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition: ApiBase.php:164
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition: ApiBase.php:224
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:499
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
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)
executeGenderCacheFromResultWrapper(IResultWrapper $res, $fname=__METHOD__, $fieldPrefix='page')
Preprocess the result set to fill the GenderCache with the necessary information before using self::a...
select( $method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
addWhereFld( $field, $value)
Equivalent to addWhere( [ $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.
encodeParamName( $paramName)
Overrides ApiBase to prepend 'g' to every generator parameter.
This is the main query class.
Definition: ApiQuery.php:41
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:641
static newFromRow( $row)
Make a Title object from a DB row.
Definition: Title.php:576
Service for formatting and validating API parameters.
Type definition for integer types.
Definition: IntegerDef.php:23