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 ( !is_null( $params['continue'] ) ) {
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  foreach ( $res as $row ) {
119  if ( ++$count > $params['limit'] ) {
120  // We've reached the one extra which shows that there are
121  // additional pages to be had. Stop here...
122  // Continue string preserved in case the redirect query doesn't
123  // pass the limit
125  'continue',
126  "{$row->iwl_prefix}|{$row->iwl_title}|{$row->iwl_from}"
127  );
128  break;
129  }
130 
131  if ( !is_null( $resultPageSet ) ) {
132  $pages[] = Title::newFromRow( $row );
133  } else {
134  $entry = [ 'pageid' => (int)$row->page_id ];
135 
136  $title = Title::makeTitle( $row->page_namespace, $row->page_title );
138 
139  if ( $row->page_is_redirect ) {
140  $entry['redirect'] = true;
141  }
142 
143  if ( $iwprefix ) {
144  $entry['iwprefix'] = $row->iwl_prefix;
145  }
146 
147  if ( $iwtitle ) {
148  $entry['iwtitle'] = $row->iwl_title;
149  }
150 
151  $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $entry );
152  if ( !$fit ) {
154  'continue',
155  "{$row->iwl_prefix}|{$row->iwl_title}|{$row->iwl_from}"
156  );
157  break;
158  }
159  }
160  }
161 
162  if ( is_null( $resultPageSet ) ) {
163  $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'iw' );
164  } else {
165  $resultPageSet->populateFromTitles( $pages );
166  }
167  }
168 
169  public function getCacheMode( $params ) {
170  return 'public';
171  }
172 
173  public function getAllowedParams() {
174  return [
175  'prefix' => null,
176  'title' => null,
177  'continue' => [
178  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
179  ],
180  'limit' => [
181  ApiBase::PARAM_DFLT => 10,
182  ApiBase::PARAM_TYPE => 'limit',
183  ApiBase::PARAM_MIN => 1,
186  ],
187  'prop' => [
188  ApiBase::PARAM_ISMULTI => true,
189  ApiBase::PARAM_DFLT => '',
191  'iwprefix',
192  'iwtitle',
193  ],
195  ],
196  'dir' => [
197  ApiBase::PARAM_DFLT => 'ascending',
199  'ascending',
200  'descending'
201  ]
202  ],
203  ];
204  }
205 
206  protected function getExamplesMessages() {
207  return [
208  'action=query&list=iwbacklinks&iwbltitle=Test&iwblprefix=wikibooks'
209  => 'apihelp-query+iwbacklinks-example-simple',
210  'action=query&generator=iwbacklinks&giwbltitle=Test&giwblprefix=wikibooks&prop=info'
211  => 'apihelp-query+iwbacklinks-example-generator',
212  ];
213  }
214 
215  public function getHelpUrls() {
216  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Iwbacklinks';
217  }
218 }
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 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
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 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.
static newFromRow( $row)
Make a Title object from a DB row.
Definition: Title.php:518
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
dieContinueUsageIf( $condition)
Die with the &#39;badcontinue&#39; error.
Definition: ApiBase.php:2199
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 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
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
addWhereFld( $field, $value)
Equivalent to addWhere( [ $field => $value ] )
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
encodeParamName( $paramName)
Overrides ApiBase to prepend &#39;g&#39; to every generator parameter.