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
24 * Query module to enumerate links from all pages together.
28 class ApiQueryAllLinks
extends ApiQueryGeneratorBase
{
30 private $table, $tablePrefix, $indexTag;
31 private $fieldTitle = 'title';
32 private $dfltNamespace = NS_MAIN
;
33 private $hasNamespace = true;
34 private $useIndex = null;
37 public function __construct( ApiQuery
$query, $moduleName ) {
38 switch ( $moduleName ) {
41 $this->table
= 'pagelinks';
42 $this->tablePrefix
= 'pl_';
43 $this->useIndex
= 'pl_namespace';
44 $this->indexTag
= 'l';
46 case 'alltransclusions':
48 $this->table
= 'templatelinks';
49 $this->tablePrefix
= 'tl_';
50 $this->dfltNamespace
= NS_TEMPLATE
;
51 $this->useIndex
= 'tl_namespace';
52 $this->indexTag
= 't';
56 $this->table
= 'imagelinks';
57 $this->tablePrefix
= 'il_';
58 $this->fieldTitle
= 'to';
59 $this->dfltNamespace
= NS_FILE
;
60 $this->hasNamespace
= false;
61 $this->indexTag
= 'f';
65 $this->table
= 'redirect';
66 $this->tablePrefix
= 'rd_';
67 $this->indexTag
= 'r';
69 'fragment' => 'rd_fragment',
70 'interwiki' => 'rd_interwiki',
74 ApiBase
::dieDebug( __METHOD__
, 'Unknown module name' );
77 parent
::__construct( $query, $moduleName, $prefix );
80 public function execute() {
84 public function getCacheMode( $params ) {
88 public function executeGenerator( $resultPageSet ) {
89 $this->run( $resultPageSet );
93 * @param ApiPageSet $resultPageSet
96 private function run( $resultPageSet = null ) {
98 $params = $this->extractRequestParams();
100 $pfx = $this->tablePrefix
;
101 $fieldTitle = $this->fieldTitle
;
102 $prop = array_flip( $params['prop'] );
103 $fld_ids = isset( $prop['ids'] );
104 $fld_title = isset( $prop['title'] );
105 if ( $this->hasNamespace
) {
106 $namespace = $params['namespace'];
108 $namespace = $this->dfltNamespace
;
111 if ( $params['unique'] ) {
112 $matches = array_intersect_key( $prop, $this->props +
[ 'ids' => 1 ] );
114 $p = $this->getModulePrefix();
117 'apierror-invalidparammix-cannotusewith',
118 "{$p}prop=" . implode( '|', array_keys( $matches ) ),
124 $this->addOption( 'DISTINCT' );
127 $this->addTables( $this->table
);
128 if ( $this->hasNamespace
) {
129 $this->addWhereFld( $pfx . 'namespace', $namespace );
132 $continue = !is_null( $params['continue'] );
134 $continueArr = explode( '|', $params['continue'] );
135 $op = $params['dir'] == 'descending' ?
'<' : '>';
136 if ( $params['unique'] ) {
137 $this->dieContinueUsageIf( count( $continueArr ) != 1 );
138 $continueTitle = $db->addQuotes( $continueArr[0] );
139 $this->addWhere( "{$pfx}{$fieldTitle} $op= $continueTitle" );
141 $this->dieContinueUsageIf( count( $continueArr ) != 2 );
142 $continueTitle = $db->addQuotes( $continueArr[0] );
143 $continueFrom = (int)$continueArr[1];
145 "{$pfx}{$fieldTitle} $op $continueTitle OR " .
146 "({$pfx}{$fieldTitle} = $continueTitle AND " .
147 "{$pfx}from $op= $continueFrom)"
152 // 'continue' always overrides 'from'
153 $from = $continue ||
$params['from'] === null ?
null :
154 $this->titlePartToKey( $params['from'], $namespace );
155 $to = $params['to'] === null ?
null :
156 $this->titlePartToKey( $params['to'], $namespace );
157 $this->addWhereRange( $pfx . $fieldTitle, 'newer', $from, $to );
159 if ( isset( $params['prefix'] ) ) {
160 $this->addWhere( $pfx . $fieldTitle . $db->buildLike( $this->titlePartToKey(
161 $params['prefix'], $namespace ), $db->anyString() ) );
164 $this->addFields( [ 'pl_title' => $pfx . $fieldTitle ] );
165 $this->addFieldsIf( [ 'pl_from' => $pfx . 'from' ], !$params['unique'] );
166 foreach ( $this->props
as $name => $field ) {
167 $this->addFieldsIf( $field, isset( $prop[$name] ) );
170 if ( $this->useIndex
) {
171 $this->addOption( 'USE INDEX', $this->useIndex
);
173 $limit = $params['limit'];
174 $this->addOption( 'LIMIT', $limit +
1 );
176 $sort = ( $params['dir'] == 'descending' ?
' DESC' : '' );
178 $orderBy[] = $pfx . $fieldTitle . $sort;
179 if ( !$params['unique'] ) {
180 $orderBy[] = $pfx . 'from' . $sort;
182 $this->addOption( 'ORDER BY', $orderBy );
184 $res = $this->select( __METHOD__
);
189 $result = $this->getResult();
190 foreach ( $res as $row ) {
191 if ( ++
$count > $limit ) {
192 // We've reached the one extra which shows that there are
193 // additional pages to be had. Stop here...
194 if ( $params['unique'] ) {
195 $this->setContinueEnumParameter( 'continue', $row->pl_title
);
197 $this->setContinueEnumParameter( 'continue', $row->pl_title
. '|' . $row->pl_from
);
202 if ( is_null( $resultPageSet ) ) {
204 ApiResult
::META_TYPE
=> 'assoc',
207 $vals['fromid'] = (int)$row->pl_from
;
210 $title = Title
::makeTitle( $namespace, $row->pl_title
);
211 ApiQueryBase
::addTitleInfo( $vals, $title );
213 foreach ( $this->props
as $name => $field ) {
214 if ( isset( $prop[$name] ) && $row->$field !== null && $row->$field !== '' ) {
215 $vals[$name] = $row->$field;
218 $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $vals );
220 if ( $params['unique'] ) {
221 $this->setContinueEnumParameter( 'continue', $row->pl_title
);
223 $this->setContinueEnumParameter( 'continue', $row->pl_title
. '|' . $row->pl_from
);
227 } elseif ( $params['unique'] ) {
228 $titles[] = Title
::makeTitle( $namespace, $row->pl_title
);
230 $pageids[] = $row->pl_from
;
234 if ( is_null( $resultPageSet ) ) {
235 $result->addIndexedTagName( [ 'query', $this->getModuleName() ], $this->indexTag
);
236 } elseif ( $params['unique'] ) {
237 $resultPageSet->populateFromTitles( $titles );
239 $resultPageSet->populateFromPageIDs( $pageids );
243 public function getAllowedParams() {
246 ApiBase
::PARAM_HELP_MSG
=> 'api-help-param-continue',
253 ApiBase
::PARAM_ISMULTI
=> true,
254 ApiBase
::PARAM_DFLT
=> 'title',
255 ApiBase
::PARAM_TYPE
=> array_merge(
256 [ 'ids', 'title' ], array_keys( $this->props
)
258 ApiBase
::PARAM_HELP_MSG_PER_VALUE
=> [],
261 ApiBase
::PARAM_DFLT
=> $this->dfltNamespace
,
262 ApiBase
::PARAM_TYPE
=> 'namespace',
263 ApiBase
::PARAM_EXTRA_NAMESPACES
=> [ NS_MEDIA
, NS_SPECIAL
],
266 ApiBase
::PARAM_DFLT
=> 10,
267 ApiBase
::PARAM_TYPE
=> 'limit',
268 ApiBase
::PARAM_MIN
=> 1,
269 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
270 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
273 ApiBase
::PARAM_DFLT
=> 'ascending',
274 ApiBase
::PARAM_TYPE
=> [
280 if ( !$this->hasNamespace
) {
281 unset( $allowedParams['namespace'] );
284 return $allowedParams;
287 protected function getExamplesMessages() {
288 $p = $this->getModulePrefix();
289 $name = $this->getModuleName();
290 $path = $this->getModulePath();
293 "action=query&list={$name}&{$p}from=B&{$p}prop=ids|title"
294 => "apihelp-$path-example-b",
295 "action=query&list={$name}&{$p}unique=&{$p}from=B"
296 => "apihelp-$path-example-unique",
297 "action=query&generator={$name}&g{$p}unique=&g{$p}from=B"
298 => "apihelp-$path-example-unique-generator",
299 "action=query&generator={$name}&g{$p}from=B"
300 => "apihelp-$path-example-generator",
304 public function getHelpUrls() {
305 $name = ucfirst( $this->getModuleName() );
307 return "https://www.mediawiki.org/wiki/Special:MyLanguage/API:{$name}";