4 * Created on July 7, 2007
6 * API for MediaWiki 1.8+
8 * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 * http://www.gnu.org/copyleft/gpl.html
26 if (!defined('MEDIAWIKI')) {
27 // Eclipse helper - will be ignored in production
28 require_once ('ApiQueryBase.php');
34 class ApiQueryExtLinksUsage
extends ApiQueryGeneratorBase
{
36 public function __construct($query, $moduleName) {
37 parent
:: __construct($query, $moduleName, 'eu');
40 public function execute() {
44 public function executeGenerator($resultPageSet) {
45 $this->run($resultPageSet);
48 private function run($resultPageSet = null) {
50 $params = $this->extractRequestParams();
52 $protocol = $params['protocol'];
53 $query = $params['query'];
55 // Find the right prefix
56 global $wgUrlProtocols;
57 if($protocol && !in_array($protocol, $wgUrlProtocols))
59 foreach ($wgUrlProtocols as $p) {
60 if( substr( $p, 0, strlen( $protocol ) ) === $protocol ) {
70 $this->addTables(array('page','externallinks')); // must be in this order for 'USE INDEX'
71 $this->addOption('USE INDEX', 'el_index');
72 $this->addWhere('page_id=el_from');
73 $this->addWhereFld('page_namespace', $params['namespace']);
75 if(!is_null($query) ||
$query != '')
77 if(is_null($protocol))
78 $protocol = 'http://';
80 $likeQuery = LinkFilter
::makeLikeArray($query, $protocol);
82 $this->dieUsage('Invalid query', 'bad_query');
84 $likeQuery = LinkFilter
::keepOneWildcard($likeQuery);
85 $this->addWhere('el_index ' . $db->buildLike( $likeQuery ));
87 else if(!is_null($protocol))
88 $this->addWhere('el_index ' . $db->buildLike( "$protocol", $db->anyString() ));
90 $prop = array_flip($params['prop']);
91 $fld_ids = isset($prop['ids']);
92 $fld_title = isset($prop['title']);
93 $fld_url = isset($prop['url']);
95 if (is_null($resultPageSet)) {
96 $this->addFields(array (
101 $this->addFieldsIf('el_to', $fld_url);
103 $this->addFields($resultPageSet->getPageTableFields());
106 $limit = $params['limit'];
107 $offset = $params['offset'];
108 $this->addOption('LIMIT', $limit +
1);
110 $this->addOption('OFFSET', $offset);
112 $res = $this->select(__METHOD__
);
114 $result = $this->getResult();
116 while ($row = $db->fetchObject($res)) {
117 if (++
$count > $limit) {
118 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
119 $this->setContinueEnumParameter('offset', $offset+
$limit);
123 if (is_null($resultPageSet)) {
126 $vals['pageid'] = intval($row->page_id
);
128 $title = Title
:: makeTitle($row->page_namespace
, $row->page_title
);
129 ApiQueryBase
::addTitleInfo($vals, $title);
132 $vals['url'] = $row->el_to
;
133 $fit = $result->addValue(array('query', $this->getModuleName()), null, $vals);
136 $this->setContinueEnumParameter('offset', $offset +
$count - 1);
140 $resultPageSet->processDbRow($row);
143 $db->freeResult($res);
145 if (is_null($resultPageSet)) {
146 $result->setIndexedTagName_internal(array('query', $this->getModuleName()),
147 $this->getModulePrefix());
151 public function getAllowedParams() {
152 global $wgUrlProtocols;
153 $protocols = array('');
154 foreach ($wgUrlProtocols as $p) {
155 $protocols[] = substr($p, 0, strpos($p,':'));
160 ApiBase
:: PARAM_ISMULTI
=> true,
161 ApiBase
:: PARAM_DFLT
=> 'ids|title|url',
162 ApiBase
:: PARAM_TYPE
=> array (
169 ApiBase
:: PARAM_TYPE
=> 'integer'
171 'protocol' => array (
172 ApiBase
:: PARAM_TYPE
=> $protocols,
173 ApiBase
:: PARAM_DFLT
=> '',
176 'namespace' => array (
177 ApiBase
:: PARAM_ISMULTI
=> true,
178 ApiBase
:: PARAM_TYPE
=> 'namespace'
181 ApiBase
:: PARAM_DFLT
=> 10,
182 ApiBase
:: PARAM_TYPE
=> 'limit',
183 ApiBase
:: PARAM_MIN
=> 1,
184 ApiBase
:: PARAM_MAX
=> ApiBase
:: LIMIT_BIG1
,
185 ApiBase
:: PARAM_MAX2
=> ApiBase
:: LIMIT_BIG2
190 public function getParamDescription() {
192 'prop' => 'What pieces of information to include',
193 'offset' => 'Used for paging. Use the value returned for "continue"',
194 'protocol' => array( 'Protocol of the url. If empty and euquery set, the protocol is http.',
195 'Leave both this and euquery empty to list all external links'),
196 'query' => 'Search string without protocol. See [[Special:LinkSearch]]. Leave empty to list all external links',
197 'namespace' => 'The page namespace(s) to enumerate.',
198 'limit' => 'How many pages to return.'
202 public function getDescription() {
203 return 'Enumerate pages that contain a given URL';
206 protected function getExamples() {
208 'api.php?action=query&list=exturlusage&euquery=www.mediawiki.org'
212 public function getVersion() {
213 return __CLASS__
. ': $Id$';