4 * Created on May 13, 2007
6 * API for MediaWiki 1.8+
8 * Copyright © 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 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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" );
32 * A query module to list all external URLs found on a given set of pages.
36 class ApiQueryExternalLinks
extends ApiQueryBase
{
38 public function __construct( $query, $moduleName ) {
39 parent
::__construct( $query, $moduleName, 'el' );
42 public function execute() {
43 if ( $this->getPageSet()->getGoodTitleCount() == 0 ) {
47 $params = $this->extractRequestParams();
48 $this->addFields( array(
53 $this->addTables( 'externallinks' );
54 $this->addWhereFld( 'el_from', array_keys( $this->getPageSet()->getGoodTitles() ) );
56 // Don't order by el_from if it's constant in the WHERE clause
57 if ( count( $this->getPageSet()->getGoodTitles() ) != 1 ) {
58 $this->addOption( 'ORDER BY', 'el_from' );
61 $this->addOption( 'LIMIT', $params['limit'] +
1 );
62 if ( !is_null( $params['offset'] ) ) {
63 $this->addOption( 'OFFSET', $params['offset'] );
67 $res = $this->select( __METHOD__
);
70 foreach ( $res as $row ) {
71 if ( ++
$count > $params['limit'] ) {
72 // We've reached the one extra which shows that
73 // there are additional pages to be had. Stop here...
74 $this->setContinueEnumParameter( 'offset', @$params['offset'] +
$params['limit'] );
78 ApiResult
::setContent( $entry, $row->el_to
);
79 $fit = $this->addPageSubItem( $row->el_from
, $entry );
81 $this->setContinueEnumParameter( 'offset', @$params['offset'] +
$count - 1 );
87 public function getAllowedParams() {
90 ApiBase
::PARAM_DFLT
=> 10,
91 ApiBase
::PARAM_TYPE
=> 'limit',
92 ApiBase
::PARAM_MIN
=> 1,
93 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
94 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
100 public function getParamDescription() {
102 'limit' => 'How many links to return',
103 'offset' => 'When more results are available, use this to continue',
107 public function getDescription() {
108 return 'Returns all external urls (not interwikies) from the given page(s)';
111 protected function getExamples() {
113 'Get a list of external links on the [[Main Page]]:',
114 ' api.php?action=query&prop=extlinks&titles=Main%20Page',
118 public function getVersion() {
119 return __CLASS__
. ': $Id$';