3 * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
26 class ApiQueryExtLinksUsage
extends ApiQueryGeneratorBase
{
28 public function __construct( ApiQuery
$query, $moduleName ) {
29 parent
::__construct( $query, $moduleName, 'eu' );
32 public function execute() {
36 public function getCacheMode( $params ) {
40 public function executeGenerator( $resultPageSet ) {
41 $this->run( $resultPageSet );
45 * @param ApiPageSet $resultPageSet
48 private function run( $resultPageSet = null ) {
49 $params = $this->extractRequestParams();
52 $query = $params['query'];
53 $protocol = self
::getProtocolPrefix( $params['protocol'] );
55 $this->addTables( [ 'page', 'externallinks' ] );
56 $this->addWhere( 'page_id=el_from' );
59 if ( $this->getConfig()->get( 'MiserMode' ) ) {
60 $miser_ns = $params['namespace'] ?
: [];
62 $this->addWhereFld( 'page_namespace', $params['namespace'] );
67 if ( $query !== null && $query !== '' ) {
68 if ( $protocol === null ) {
69 $protocol = 'http://';
72 // Normalize query to match the normalization applied for the externallinks table
73 $query = Parser
::normalizeLinkUrl( $protocol . $query );
75 $conds = LinkFilter
::getQueryConditions( $query, [
77 'oneWildcard' => true,
81 $this->dieWithError( 'apierror-badquery' );
83 $this->addWhere( $conds );
84 if ( !isset( $conds['el_index_60'] ) ) {
85 $orderBy[] = 'el_index_60';
88 $orderBy[] = 'el_index_60';
90 if ( $protocol !== null ) {
91 $this->addWhere( 'el_index_60' . $db->buildLike( "$protocol", $db->anyString() ) );
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() ),
101 $orderBy[] = 'el_id';
102 $this->addOption( 'ORDER BY', $orderBy );
103 $this->addFields( $orderBy ); // Make sure
105 $prop = array_flip( $params['prop'] );
106 $fld_ids = isset( $prop['ids'] );
107 $fld_title = isset( $prop['title'] );
108 $fld_url = isset( $prop['url'] );
110 if ( is_null( $resultPageSet ) ) {
116 $this->addFieldsIf( 'el_to', $fld_url );
118 $this->addFields( $resultPageSet->getPageTableFields() );
121 $limit = $params['limit'];
122 $this->addOption( 'LIMIT', $limit +
1 );
124 if ( $params['continue'] !== null ) {
125 $cont = explode( '|', $params['continue'] );
126 $this->dieContinueUsageIf( count( $cont ) !== count( $orderBy ) );
127 $i = count( $cont ) - 1;
128 $cond = $orderBy[$i] . ' >= ' . $db->addQuotes( rawurldecode( $cont[$i] ) );
130 $field = $orderBy[$i];
131 $v = $db->addQuotes( rawurldecode( $cont[$i] ) );
132 $cond = "($field > $v OR ($field = $v AND $cond))";
134 $this->addWhere( $cond );
137 $res = $this->select( __METHOD__
);
139 $result = $this->getResult();
141 foreach ( $res as $row ) {
142 if ( ++
$count > $limit ) {
143 // We've reached the one extra which shows that there are
144 // additional pages to be had. Stop here...
145 $this->setContinue( $orderBy, $row );
149 if ( count( $miser_ns ) && !in_array( $row->page_namespace
, $miser_ns ) ) {
153 if ( is_null( $resultPageSet ) ) {
155 ApiResult
::META_TYPE
=> 'assoc',
158 $vals['pageid'] = (int)$row->page_id
;
161 $title = Title
::makeTitle( $row->page_namespace
, $row->page_title
);
162 ApiQueryBase
::addTitleInfo( $vals, $title );
166 // expand protocol-relative urls
167 if ( $params['expandurl'] ) {
168 $to = wfExpandUrl( $to, PROTO_CANONICAL
);
172 $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $vals );
174 $this->setContinue( $orderBy, $row );
178 $resultPageSet->processDbRow( $row );
182 if ( is_null( $resultPageSet ) ) {
183 $result->addIndexedTagName( [ 'query', $this->getModuleName() ],
184 $this->getModulePrefix() );
188 private function setContinue( $orderBy, $row ) {
190 foreach ( $orderBy as $field ) {
191 $fields[] = strtr( $row->$field, [ '%' => '%25', '|' => '%7C' ] );
193 $this->setContinueEnumParameter( 'continue', implode( '|', $fields ) );
196 public function getAllowedParams() {
199 ApiBase
::PARAM_ISMULTI
=> true,
200 ApiBase
::PARAM_DFLT
=> 'ids|title|url',
201 ApiBase
::PARAM_TYPE
=> [
206 ApiBase
::PARAM_HELP_MSG_PER_VALUE
=> [],
209 ApiBase
::PARAM_HELP_MSG
=> 'api-help-param-continue',
212 ApiBase
::PARAM_TYPE
=> self
::prepareProtocols(),
213 ApiBase
::PARAM_DFLT
=> '',
217 ApiBase
::PARAM_ISMULTI
=> true,
218 ApiBase
::PARAM_TYPE
=> 'namespace'
221 ApiBase
::PARAM_DFLT
=> 10,
222 ApiBase
::PARAM_TYPE
=> 'limit',
223 ApiBase
::PARAM_MIN
=> 1,
224 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
225 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
227 'expandurl' => false,
230 if ( $this->getConfig()->get( 'MiserMode' ) ) {
231 $ret['namespace'][ApiBase
::PARAM_HELP_MSG_APPEND
] = [
232 'api-help-param-limited-in-miser-mode',
239 public static function prepareProtocols() {
240 global $wgUrlProtocols;
242 foreach ( $wgUrlProtocols as $p ) {
244 $protocols[] = substr( $p, 0, strpos( $p, ':' ) );
251 public static function getProtocolPrefix( $protocol ) {
252 // Find the right prefix
253 global $wgUrlProtocols;
254 if ( $protocol && !in_array( $protocol, $wgUrlProtocols ) ) {
255 foreach ( $wgUrlProtocols as $p ) {
256 if ( substr( $p, 0, strlen( $protocol ) ) === $protocol ) {
268 protected function getExamplesMessages() {
270 'action=query&list=exturlusage&euquery=www.mediawiki.org'
271 => 'apihelp-query+exturlusage-example-simple',
275 public function getHelpUrls() {
276 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Exturlusage';