5ce92221c421c0f5e3336b97cc855116d06a9d7b
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 $this->dieUsage('Missing required query parameter', 'params');
57 // Find the right prefix
58 global $wgUrlProtocols;
59 foreach ($wgUrlProtocols as $p) {
60 if( substr( $p, 0, strlen( $protocol ) ) === $protocol ) {
66 $likeQuery = LinkFilter
::makeLike($query , $protocol);
68 $this->dieUsage('Invalid query', 'bad_query');
69 $likeQuery = substr($likeQuery, 0, strpos($likeQuery,'%')+
1);
71 $this->addTables(array('page','externallinks')); // must be in this order for 'USE INDEX'
72 $this->addOption('USE INDEX', 'el_index');
75 $this->addWhere('page_id=el_from');
76 $this->addWhere('el_index LIKE ' . $db->addQuotes( $likeQuery ));
77 $this->addWhereFld('page_namespace', $params['namespace']);
79 $prop = array_flip($params['prop']);
80 $fld_ids = isset($prop['ids']);
81 $fld_title = isset($prop['title']);
82 $fld_url = isset($prop['url']);
84 if (is_null($resultPageSet)) {
85 $this->addFields(array (
90 $this->addFieldsIf('el_to', $fld_url);
92 $this->addFields($resultPageSet->getPageTableFields());
95 $limit = $params['limit'];
96 $offset = $params['offset'];
97 $this->addOption('LIMIT', $limit +
1);
99 $this->addOption('OFFSET', $offset);
101 $res = $this->select(__METHOD__
);
105 while ($row = $db->fetchObject($res)) {
106 if (++
$count > $limit) {
107 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
108 $this->setContinueEnumParameter('offset', $offset+
$limit+
1);
112 if (is_null($resultPageSet)) {
113 $title = Title
:: makeTitle($row->page_namespace
, $row->page_title
);
114 if ($title->userCanRead()) {
117 $vals['pageid'] = intval($row->page_id
);
119 $vals['ns'] = intval($title->getNamespace());
120 $vals['title'] = $title->getPrefixedText();
123 $vals['url'] = $row->el_to
;
127 $resultPageSet->processDbRow($row);
130 $db->freeResult($res);
132 if (is_null($resultPageSet)) {
133 $result = $this->getResult();
134 $result->setIndexedTagName($data, 'p');
135 $result->addValue('query', $this->getModuleName(), $data);
139 protected function getAllowedParams() {
140 global $wgUrlProtocols;
141 $protocols = array();
142 foreach ($wgUrlProtocols as $p) {
143 $protocols[] = substr($p, 0, strpos($p,':'));
148 ApiBase
:: PARAM_ISMULTI
=> true,
149 ApiBase
:: PARAM_DFLT
=> 'ids|title|url',
150 ApiBase
:: PARAM_TYPE
=> array (
157 ApiBase
:: PARAM_TYPE
=> 'integer'
159 'protocol' => array (
160 ApiBase
:: PARAM_TYPE
=> $protocols,
161 ApiBase
:: PARAM_DFLT
=> 'http',
164 'namespace' => array (
165 ApiBase
:: PARAM_ISMULTI
=> true,
166 ApiBase
:: PARAM_TYPE
=> 'namespace'
169 ApiBase
:: PARAM_DFLT
=> 10,
170 ApiBase
:: PARAM_TYPE
=> 'limit',
171 ApiBase
:: PARAM_MIN
=> 1,
172 ApiBase
:: PARAM_MAX
=> ApiBase
:: LIMIT_BIG1
,
173 ApiBase
:: PARAM_MAX2
=> ApiBase
:: LIMIT_BIG2
178 protected function getParamDescription() {
180 'prop' => 'What pieces of information to include',
181 'offset' => 'Used for paging. Use the value returned for "continue"',
182 'protocol' => 'Protocol of the url',
183 'query' => 'Search string without protocol. See [[Special:LinkSearch]]',
184 'namespace' => 'The page namespace(s) to enumerate.',
185 'limit' => 'How many entries to return.'
189 protected function getDescription() {
190 return 'Enumerate pages that contain a given URL';
193 protected function getExamples() {
195 'api.php?action=query&list=exturlusage&euquery=www.mediawiki.org'
199 public function getVersion() {
200 return __CLASS__
. ': $Id:$';