MediaWiki  master
ApiQueryExtLinksUsage.php
Go to the documentation of this file.
1 <?php
27 
28  public function __construct( ApiQuery $query, $moduleName ) {
29  parent::__construct( $query, $moduleName, 'eu' );
30  }
31 
32  public function execute() {
33  $this->run();
34  }
35 
36  public function getCacheMode( $params ) {
37  return 'public';
38  }
39 
40  public function executeGenerator( $resultPageSet ) {
41  $this->run( $resultPageSet );
42  }
43 
48  private function run( $resultPageSet = null ) {
49  $params = $this->extractRequestParams();
50  $db = $this->getDB();
51 
52  $query = $params['query'];
53  $protocol = self::getProtocolPrefix( $params['protocol'] );
54 
55  $this->addTables( [ 'externallinks', 'page' ] );
56  $this->addJoinConds( [ 'page' => [ 'JOIN', 'page_id=el_from' ] ] );
57 
58  $miser_ns = [];
59  if ( $this->getConfig()->get( 'MiserMode' ) ) {
60  $miser_ns = $params['namespace'] ?: [];
61  } else {
62  $this->addWhereFld( 'page_namespace', $params['namespace'] );
63  }
64 
65  $orderBy = [];
66 
67  if ( $query !== null && $query !== '' ) {
68  if ( $protocol === null ) {
69  $protocol = 'http://';
70  }
71 
72  // Normalize query to match the normalization applied for the externallinks table
73  $query = Parser::normalizeLinkUrl( $protocol . $query );
74 
75  $conds = LinkFilter::getQueryConditions( $query, [
76  'protocol' => '',
77  'oneWildcard' => true,
78  'db' => $db
79  ] );
80  if ( !$conds ) {
81  $this->dieWithError( 'apierror-badquery' );
82  }
83  $this->addWhere( $conds );
84  if ( !isset( $conds['el_index_60'] ) ) {
85  $orderBy[] = 'el_index_60';
86  }
87  } else {
88  $orderBy[] = 'el_index_60';
89 
90  if ( $protocol !== null ) {
91  $this->addWhere( 'el_index_60' . $db->buildLike( "$protocol", $db->anyString() ) );
92  } else {
93  // We're querying all protocols, filter out duplicate protocol-relative links
94  $this->addWhere( $db->makeList( [
95  'el_to NOT' . $db->buildLike( '//', $db->anyString() ),
96  'el_index_60 ' . $db->buildLike( 'http://', $db->anyString() ),
97  ], LIST_OR ) );
98  }
99  }
100 
101  $orderBy[] = 'el_id';
102  $this->addOption( 'ORDER BY', $orderBy );
103  $this->addFields( $orderBy ); // Make sure
104 
105  $prop = array_flip( $params['prop'] );
106  $fld_ids = isset( $prop['ids'] );
107  $fld_title = isset( $prop['title'] );
108  $fld_url = isset( $prop['url'] );
109 
110  if ( $resultPageSet === null ) {
111  $this->addFields( [
112  'page_id',
113  'page_namespace',
114  'page_title'
115  ] );
116  $this->addFieldsIf( 'el_to', $fld_url );
117  } else {
118  $this->addFields( $resultPageSet->getPageTableFields() );
119  }
120 
121  $limit = $params['limit'];
122  $this->addOption( 'LIMIT', $limit + 1 );
123 
124  // T244254: Avoid MariaDB deciding to scan all of `page`.
125  $this->addOption( 'STRAIGHT_JOIN' );
126 
127  if ( $params['continue'] !== null ) {
128  $cont = explode( '|', $params['continue'] );
129  $this->dieContinueUsageIf( count( $cont ) !== count( $orderBy ) );
130  $i = count( $cont ) - 1;
131  $cond = $orderBy[$i] . ' >= ' . $db->addQuotes( rawurldecode( $cont[$i] ) );
132  while ( $i-- > 0 ) {
133  $field = $orderBy[$i];
134  $v = $db->addQuotes( rawurldecode( $cont[$i] ) );
135  $cond = "($field > $v OR ($field = $v AND $cond))";
136  }
137  $this->addWhere( $cond );
138  }
139 
140  $res = $this->select( __METHOD__ );
141 
142  $result = $this->getResult();
143 
144  if ( $resultPageSet === null ) {
145  $this->executeGenderCacheFromResultWrapper( $res, __METHOD__ );
146  }
147 
148  $count = 0;
149  foreach ( $res as $row ) {
150  if ( ++$count > $limit ) {
151  // We've reached the one extra which shows that there are
152  // additional pages to be had. Stop here...
153  $this->setContinue( $orderBy, $row );
154  break;
155  }
156 
157  if ( count( $miser_ns ) && !in_array( $row->page_namespace, $miser_ns ) ) {
158  continue;
159  }
160 
161  if ( $resultPageSet === null ) {
162  $vals = [
163  ApiResult::META_TYPE => 'assoc',
164  ];
165  if ( $fld_ids ) {
166  $vals['pageid'] = (int)$row->page_id;
167  }
168  if ( $fld_title ) {
169  $title = Title::makeTitle( $row->page_namespace, $row->page_title );
171  }
172  if ( $fld_url ) {
173  $to = $row->el_to;
174  // expand protocol-relative urls
175  if ( $params['expandurl'] ) {
176  $to = wfExpandUrl( $to, PROTO_CANONICAL );
177  }
178  $vals['url'] = $to;
179  }
180  $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $vals );
181  if ( !$fit ) {
182  $this->setContinue( $orderBy, $row );
183  break;
184  }
185  } else {
186  $resultPageSet->processDbRow( $row );
187  }
188  }
189 
190  if ( $resultPageSet === null ) {
191  $result->addIndexedTagName( [ 'query', $this->getModuleName() ],
192  $this->getModulePrefix() );
193  }
194  }
195 
196  private function setContinue( $orderBy, $row ) {
197  $fields = [];
198  foreach ( $orderBy as $field ) {
199  $fields[] = strtr( $row->$field, [ '%' => '%25', '|' => '%7C' ] );
200  }
201  $this->setContinueEnumParameter( 'continue', implode( '|', $fields ) );
202  }
203 
204  public function getAllowedParams() {
205  $ret = [
206  'prop' => [
207  ApiBase::PARAM_ISMULTI => true,
208  ApiBase::PARAM_DFLT => 'ids|title|url',
210  'ids',
211  'title',
212  'url'
213  ],
215  ],
216  'continue' => [
217  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
218  ],
219  'protocol' => [
221  ApiBase::PARAM_DFLT => '',
222  ],
223  'query' => null,
224  'namespace' => [
225  ApiBase::PARAM_ISMULTI => true,
226  ApiBase::PARAM_TYPE => 'namespace'
227  ],
228  'limit' => [
229  ApiBase::PARAM_DFLT => 10,
230  ApiBase::PARAM_TYPE => 'limit',
231  ApiBase::PARAM_MIN => 1,
234  ],
235  'expandurl' => false,
236  ];
237 
238  if ( $this->getConfig()->get( 'MiserMode' ) ) {
239  $ret['namespace'][ApiBase::PARAM_HELP_MSG_APPEND] = [
240  'api-help-param-limited-in-miser-mode',
241  ];
242  }
243 
244  return $ret;
245  }
246 
247  public static function prepareProtocols() {
248  global $wgUrlProtocols;
249  $protocols = [ '' ];
250  foreach ( $wgUrlProtocols as $p ) {
251  if ( $p !== '//' ) {
252  $protocols[] = substr( $p, 0, strpos( $p, ':' ) );
253  }
254  }
255 
256  return $protocols;
257  }
258 
259  public static function getProtocolPrefix( $protocol ) {
260  // Find the right prefix
261  global $wgUrlProtocols;
262  if ( $protocol && !in_array( $protocol, $wgUrlProtocols ) ) {
263  foreach ( $wgUrlProtocols as $p ) {
264  if ( substr( $p, 0, strlen( $protocol ) ) === $protocol ) {
265  $protocol = $p;
266  break;
267  }
268  }
269 
270  return $protocol;
271  } else {
272  return null;
273  }
274  }
275 
276  protected function getExamplesMessages() {
277  return [
278  'action=query&list=exturlusage&euquery=www.mediawiki.org'
279  => 'apihelp-query+exturlusage-example-simple',
280  ];
281  }
282 
283  public function getHelpUrls() {
284  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Exturlusage';
285  }
286 }
ContextSource\getConfig
getConfig()
Definition: ContextSource.php:63
ApiQueryExtLinksUsage\getCacheMode
getCacheMode( $params)
Get the cache mode for the data generated by this module.
Definition: ApiQueryExtLinksUsage.php:36
ApiQueryBase\addFields
addFields( $value)
Add a set of fields to select to the internal array.
Definition: ApiQueryBase.php:193
ApiQuery
This is the main query class.
Definition: ApiQuery.php:37
PROTO_CANONICAL
const PROTO_CANONICAL
Definition: Defines.php:212
LinkFilter\getQueryConditions
static getQueryConditions( $filterEntry, array $options=[])
Return query conditions which will match the specified string.
Definition: LinkFilter.php:256
ApiResult\META_TYPE
const META_TYPE
Key for the 'type' metadata item.
Definition: ApiResult.php:110
ApiBase\dieWithError
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:1379
ApiBase\PARAM_HELP_MSG
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition: ApiBase.php:96
ApiQueryExtLinksUsage\getHelpUrls
getHelpUrls()
Return links to more detailed help pages about the module.
Definition: ApiQueryExtLinksUsage.php:283
ApiBase\PARAM_TYPE
const PARAM_TYPE
(boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE
Definition: ApiBase.php:60
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:538
ApiQueryBase\$fields
$fields
Definition: ApiQueryBase.php:37
ApiQueryExtLinksUsage
Definition: ApiQueryExtLinksUsage.php:26
ApiQueryBase\addOption
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
Definition: ApiQueryBase.php:369
ApiQueryExtLinksUsage\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiQueryExtLinksUsage.php:32
$res
$res
Definition: testCompression.php:57
ApiBase\PARAM_HELP_MSG_APPEND
const PARAM_HELP_MSG_APPEND
((string|array|Message)[]) Specify additional i18n messages to append to the normal message for this ...
Definition: ApiBase.php:103
ApiQueryBase\addFieldsIf
addFieldsIf( $value, $condition)
Same as addFields(), but add the fields only if a condition is met.
Definition: ApiQueryBase.php:207
ApiQueryGeneratorBase\setContinueEnumParameter
setContinueEnumParameter( $paramName, $paramValue)
Overridden to set the generator param if in generator mode.
Definition: ApiQueryGeneratorBase.php:84
ApiQueryExtLinksUsage\prepareProtocols
static prepareProtocols()
Definition: ApiQueryExtLinksUsage.php:247
ApiBase\PARAM_MIN
const PARAM_MIN
(boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE
Definition: ApiBase.php:63
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:622
LIST_OR
const LIST_OR
Definition: Defines.php:51
ApiBase\LIMIT_BIG1
const LIMIT_BIG1
Fast query, standard limit.
Definition: ApiBase.php:154
ApiQueryBase\getDB
getDB()
Get the Query database connection (read-only)
Definition: ApiQueryBase.php:107
ApiBase\PARAM_MAX
const PARAM_MAX
(boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE
Definition: ApiBase.php:61
ApiQueryExtLinksUsage\setContinue
setContinue( $orderBy, $row)
Definition: ApiQueryExtLinksUsage.php:196
ApiQueryBase\addTables
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
Definition: ApiQueryBase.php:161
ApiQueryBase\select
select( $method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
Definition: ApiQueryBase.php:394
ApiBase\extractRequestParams
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:659
ApiQueryExtLinksUsage\run
run( $resultPageSet=null)
Definition: ApiQueryExtLinksUsage.php:48
$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
ApiQueryExtLinksUsage\__construct
__construct(ApiQuery $query, $moduleName)
Definition: ApiQueryExtLinksUsage.php:28
ApiBase\getModulePrefix
getModulePrefix()
Get parameter prefix (usually two letters or an empty string).
Definition: ApiBase.php:426
$wgUrlProtocols
$wgUrlProtocols
URL schemes that should be recognized as valid by wfParseUrl().
Definition: DefaultSettings.php:4473
ApiBase\dieContinueUsageIf
dieContinueUsageIf( $condition)
Die with the 'badcontinue' error.
Definition: ApiBase.php:1559
ApiQueryBase\addJoinConds
addJoinConds( $join_conds)
Add a set of JOIN conditions to the internal array.
Definition: ApiQueryBase.php:182
ApiQueryBase\addWhereFld
addWhereFld( $field, $value)
Equivalent to addWhere( [ $field => $value ] )
Definition: ApiQueryBase.php:267
ApiQueryExtLinksUsage\getAllowedParams
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiQueryExtLinksUsage.php:204
ApiQueryGeneratorBase
Definition: ApiQueryGeneratorBase.php:26
ApiQueryExtLinksUsage\getExamplesMessages
getExamplesMessages()
Returns usage examples for this module.
Definition: ApiQueryExtLinksUsage.php:276
ApiBase\LIMIT_BIG2
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition: ApiBase.php:156
ApiBase\PARAM_DFLT
const PARAM_DFLT
(boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE
Definition: ApiBase.php:58
ApiBase\getModuleName
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:418
ApiBase\PARAM_ISMULTI
const PARAM_ISMULTI
(boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE
Definition: ApiBase.php:59
ApiBase\PARAM_MAX2
const PARAM_MAX2
(boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE
Definition: ApiBase.php:62
ApiQueryBase\addWhere
addWhere( $value)
Add a set of WHERE clauses to the internal array.
Definition: ApiQueryBase.php:230
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:129
ApiQueryExtLinksUsage\executeGenerator
executeGenerator( $resultPageSet)
Execute this module as a generator.
Definition: ApiQueryExtLinksUsage.php:40
ApiQueryBase\addTitleInfo
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
Definition: ApiQueryBase.php:462
wfExpandUrl
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
Definition: GlobalFunctions.php:491
ApiQueryExtLinksUsage\getProtocolPrefix
static getProtocolPrefix( $protocol)
Definition: ApiQueryExtLinksUsage.php:259