1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
|
<?php
/*
* Created on May 13, 2007
*
* API for MediaWiki 1.8+
*
* Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
* http://www.gnu.org/copyleft/gpl.html
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once ( "ApiQueryBase.php" );
}
/**
* A query module to list all external URLs found on a given set of pages.
*
* @ingroup API
*/
class ApiQueryExternalLinks extends ApiQueryBase {
public function __construct( $query, $moduleName ) {
parent :: __construct( $query, $moduleName, 'el' );
}
public function execute() {
if ( $this->getPageSet()->getGoodTitleCount() == 0 )
return;
$params = $this->extractRequestParams();
$this->addFields( array (
'el_from',
'el_to'
) );
$this->addTables( 'externallinks' );
$this->addWhereFld( 'el_from', array_keys( $this->getPageSet()->getGoodTitles() ) );
// Don't order by el_from if it's constant in the WHERE clause
if ( count( $this->getPageSet()->getGoodTitles() ) != 1 )
$this->addOption( 'ORDER BY', 'el_from' );
$this->addOption( 'LIMIT', $params['limit'] + 1 );
if ( !is_null( $params['offset'] ) )
$this->addOption( 'OFFSET', $params['offset'] );
$db = $this->getDB();
$res = $this->select( __METHOD__ );
$count = 0;
while ( $row = $db->fetchObject( $res ) ) {
if ( ++$count > $params['limit'] ) {
// We've reached the one extra which shows that
// there are additional pages to be had. Stop here...
$this->setContinueEnumParameter( 'offset', @$params['offset'] + $params['limit'] );
break;
}
$entry = array();
ApiResult :: setContent( $entry, $row->el_to );
$fit = $this->addPageSubItem( $row->el_from, $entry );
if ( !$fit )
{
$this->setContinueEnumParameter( 'offset', @$params['offset'] + $count - 1 );
break;
}
}
$db->freeResult( $res );
}
public function getCacheMode( $params ) {
return 'public';
}
public function getAllowedParams() {
return array(
'limit' => array(
ApiBase :: PARAM_DFLT => 10,
ApiBase :: PARAM_TYPE => 'limit',
ApiBase :: PARAM_MIN => 1,
ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
),
'offset' => null,
);
}
public function getParamDescription () {
return array(
'limit' => 'How many links to return',
'offset' => 'When more results are available, use this to continue',
);
}
public function getDescription() {
return 'Returns all external urls (not interwikies) from the given page(s)';
}
protected function getExamples() {
return array (
"Get a list of external links on the [[Main Page]]:",
" api.php?action=query&prop=extlinks&titles=Main%20Page",
);
}
public function getVersion() {
return __CLASS__ . ': $Id: ApiQueryExternalLinks.php 69932 2010-07-26 08:03:21Z tstarling $';
}
}
|
