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
27 if ( !defined( 'MEDIAWIKI' ) ) {
28 // Eclipse helper - will be ignored in production
29 require_once( 'ApiQueryBase.php' );
35 class ApiQueryExtLinksUsage
extends ApiQueryGeneratorBase
{
37 public function __construct( $query, $moduleName ) {
38 parent
::__construct( $query, $moduleName, 'eu' );
41 public function execute() {
45 public function getCacheMode( $params ) {
49 public function executeGenerator( $resultPageSet ) {
50 $this->run( $resultPageSet );
54 * @param $resultPageSet ApiPageSet
57 private function run( $resultPageSet = null ) {
58 $params = $this->extractRequestParams();
60 $query = $params['query'];
61 $protocol = self
::getProtocolPrefix( $params['protocol'] );
63 $this->addTables( array( 'page', 'externallinks' ) ); // must be in this order for 'USE INDEX'
64 $this->addOption( 'USE INDEX', 'el_index' );
65 $this->addWhere( 'page_id=el_from' );
70 $miser_ns = $params['namespace'];
72 $this->addWhereFld( 'page_namespace', $params['namespace'] );
75 $whereQuery = $this->prepareUrlQuerySearchString( $query, $protocol );
77 if ( $whereQuery !== null ) {
78 $this->addWhere( $whereQuery );
81 $prop = array_flip( $params['prop'] );
82 $fld_ids = isset( $prop['ids'] );
83 $fld_title = isset( $prop['title'] );
84 $fld_url = isset( $prop['url'] );
86 if ( is_null( $resultPageSet ) ) {
87 $this->addFields( array(
92 $this->addFieldsIf( 'el_to', $fld_url );
94 $this->addFields( $resultPageSet->getPageTableFields() );
97 $limit = $params['limit'];
98 $offset = $params['offset'];
99 $this->addOption( 'LIMIT', $limit +
1 );
100 if ( isset( $offset ) ) {
101 $this->addOption( 'OFFSET', $offset );
104 $res = $this->select( __METHOD__
);
106 $result = $this->getResult();
108 foreach ( $res as $row ) {
109 if ( ++
$count > $limit ) {
110 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
111 $this->setContinueEnumParameter( 'offset', $offset +
$limit );
115 if ( count( $miser_ns ) && !in_array( $row->page_namespace
, $miser_ns ) ) {
119 if ( is_null( $resultPageSet ) ) {
122 $vals['pageid'] = intval( $row->page_id
);
125 $title = Title
::makeTitle( $row->page_namespace
, $row->page_title
);
126 ApiQueryBase
::addTitleInfo( $vals, $title );
129 $vals['url'] = $row->el_to
;
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'
162 ApiBase
::PARAM_TYPE
=> self
::prepareProtocols(),
163 ApiBase
::PARAM_DFLT
=> '',
166 'namespace' => array(
167 ApiBase
::PARAM_ISMULTI
=> true,
168 ApiBase
::PARAM_TYPE
=> 'namespace'
171 ApiBase
::PARAM_DFLT
=> 10,
172 ApiBase
::PARAM_TYPE
=> 'limit',
173 ApiBase
::PARAM_MIN
=> 1,
174 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
175 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
180 public static function prepareProtocols() {
181 global $wgUrlProtocols;
182 $protocols = array( '' );
183 foreach ( $wgUrlProtocols as $p ) {
184 $protocols[] = substr( $p, 0, strpos( $p, ':' ) );
189 public static function getProtocolPrefix( $protocol ) {
190 // Find the right prefix
191 global $wgUrlProtocols;
192 if ( $protocol && !in_array( $protocol, $wgUrlProtocols ) ) {
193 foreach ( $wgUrlProtocols as $p ) {
194 if ( substr( $p, 0, strlen( $protocol ) ) === $protocol ) {
206 public function getParamDescription() {
208 $p = $this->getModulePrefix();
211 'What pieces of information to include',
212 ' ids - Adds the ID of page',
213 ' title - Adds the title and namespace ID of the page',
214 ' url - Adds the URL used in the page',
216 'offset' => 'Used for paging. Use the value returned for "continue"',
218 "Protocol of the url. If empty and {$p}query set, the protocol is http.",
219 "Leave both this and {$p}query empty to list all external links"
221 'query' => 'Search string without protocol. See [[Special:LinkSearch]]. Leave empty to list all external links',
222 'namespace' => 'The page namespace(s) to enumerate.',
223 'limit' => 'How many pages to return.'
226 if ( $wgMiserMode ) {
227 $desc['namespace'] = array(
229 "NOTE: Due to \$wgMiserMode, using this may result in fewer than \"{$p}limit\" results",
230 'returned before continuing; in extreme cases, zero results may be returned',
237 public function getDescription() {
238 return 'Enumerate pages that contain a given URL';
241 public function getPossibleErrors() {
242 return array_merge( parent
::getPossibleErrors(), array(
243 array( 'code' => 'bad_query', 'info' => 'Invalid query' ),
247 protected function getExamples() {
249 'api.php?action=query&list=exturlusage&euquery=www.mediawiki.org'
253 public function getVersion() {
254 return __CLASS__
. ': $Id$';