5 * Created on July 7, 2007
7 * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 * http://www.gnu.org/copyleft/gpl.html
30 class ApiQueryExtLinksUsage
extends ApiQueryGeneratorBase
{
32 public function __construct( ApiQuery
$query, $moduleName ) {
33 parent
::__construct( $query, $moduleName, 'eu' );
36 public function execute() {
40 public function getCacheMode( $params ) {
44 public function executeGenerator( $resultPageSet ) {
45 $this->run( $resultPageSet );
49 * @param ApiPageSet $resultPageSet
52 private function run( $resultPageSet = null ) {
53 $params = $this->extractRequestParams();
55 $query = $params['query'];
56 $protocol = self
::getProtocolPrefix( $params['protocol'] );
58 $this->addTables( array( 'page', 'externallinks' ) ); // must be in this order for 'USE INDEX'
59 $this->addOption( 'USE INDEX', 'el_index' );
60 $this->addWhere( 'page_id=el_from' );
63 if ( $this->getConfig()->get( 'MiserMode' ) ) {
64 $miser_ns = $params['namespace'];
66 $this->addWhereFld( 'page_namespace', $params['namespace'] );
69 $whereQuery = $this->prepareUrlQuerySearchString( $query, $protocol );
71 if ( $whereQuery !== null ) {
72 $this->addWhere( $whereQuery );
75 $prop = array_flip( $params['prop'] );
76 $fld_ids = isset( $prop['ids'] );
77 $fld_title = isset( $prop['title'] );
78 $fld_url = isset( $prop['url'] );
80 if ( is_null( $resultPageSet ) ) {
81 $this->addFields( array(
86 $this->addFieldsIf( 'el_to', $fld_url );
88 $this->addFields( $resultPageSet->getPageTableFields() );
91 $limit = $params['limit'];
92 $offset = $params['offset'];
93 $this->addOption( 'LIMIT', $limit +
1 );
94 if ( isset( $offset ) ) {
95 $this->addOption( 'OFFSET', $offset );
98 $res = $this->select( __METHOD__
);
100 $result = $this->getResult();
102 foreach ( $res as $row ) {
103 if ( ++
$count > $limit ) {
104 // We've reached the one extra which shows that there are
105 // additional pages to be had. Stop here...
106 $this->setContinueEnumParameter( 'offset', $offset +
$limit );
110 if ( count( $miser_ns ) && !in_array( $row->page_namespace
, $miser_ns ) ) {
114 if ( is_null( $resultPageSet ) ) {
117 $vals['pageid'] = intval( $row->page_id
);
120 $title = Title
::makeTitle( $row->page_namespace
, $row->page_title
);
121 ApiQueryBase
::addTitleInfo( $vals, $title );
125 // expand protocol-relative urls
126 if ( $params['expandurl'] ) {
127 $to = wfExpandUrl( $to, PROTO_CANONICAL
);
131 $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $vals );
133 $this->setContinueEnumParameter( 'offset', $offset +
$count - 1 );
137 $resultPageSet->processDbRow( $row );
141 if ( is_null( $resultPageSet ) ) {
142 $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ),
143 $this->getModulePrefix() );
147 public function getAllowedParams() {
150 ApiBase
::PARAM_ISMULTI
=> true,
151 ApiBase
::PARAM_DFLT
=> 'ids|title|url',
152 ApiBase
::PARAM_TYPE
=> array(
159 ApiBase
::PARAM_TYPE
=> 'integer',
160 ApiBase
::PARAM_HELP_MSG
=> 'api-help-param-continue',
163 ApiBase
::PARAM_TYPE
=> self
::prepareProtocols(),
164 ApiBase
::PARAM_DFLT
=> '',
167 'namespace' => array(
168 ApiBase
::PARAM_ISMULTI
=> true,
169 ApiBase
::PARAM_TYPE
=> 'namespace'
172 ApiBase
::PARAM_DFLT
=> 10,
173 ApiBase
::PARAM_TYPE
=> 'limit',
174 ApiBase
::PARAM_MIN
=> 1,
175 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
176 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
178 'expandurl' => false,
181 if ( $this->getConfig()->get( 'MiserMode' ) ) {
182 $ret['namespace'][ApiBase
::PARAM_HELP_MSG_APPEND
] = array(
183 'api-help-param-limited-in-miser-mode',
190 public static function prepareProtocols() {
191 global $wgUrlProtocols;
192 $protocols = array( '' );
193 foreach ( $wgUrlProtocols as $p ) {
195 $protocols[] = substr( $p, 0, strpos( $p, ':' ) );
202 public static function getProtocolPrefix( $protocol ) {
203 // Find the right prefix
204 global $wgUrlProtocols;
205 if ( $protocol && !in_array( $protocol, $wgUrlProtocols ) ) {
206 foreach ( $wgUrlProtocols as $p ) {
207 if ( substr( $p, 0, strlen( $protocol ) ) === $protocol ) {
219 public function getExamplesMessages() {
221 'action=query&list=exturlusage&euquery=www.mediawiki.org'
222 => 'apihelp-query+exturlusage-example-simple',
226 public function getHelpUrls() {
227 return 'https://www.mediawiki.org/wiki/API:Exturlusage';