5 * Created on May 13, 2007
7 * Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 * http://www.gnu.org/copyleft/gpl.html
27 if ( !defined( 'MEDIAWIKI' ) ) {
28 // Eclipse helper - will be ignored in production
29 require_once( "ApiQueryBase.php" );
33 * A query module to list all external URLs found on a given set of pages.
37 class ApiQueryExternalLinks
extends ApiQueryBase
{
39 public function __construct( $query, $moduleName ) {
40 parent
::__construct( $query, $moduleName, 'el' );
43 public function execute() {
44 if ( $this->getPageSet()->getGoodTitleCount() == 0 ) {
48 $params = $this->extractRequestParams();
50 $query = $params['query'];
51 $protocol = ApiQueryExtLinksUsage
::getProtocolPrefix( $params['protocol'] );
53 $this->addFields( array(
58 $this->addTables( 'externallinks' );
59 $this->addWhereFld( 'el_from', array_keys( $this->getPageSet()->getGoodTitles() ) );
61 $whereQuery = $this->prepareUrlQuerySearchString( $query, $protocol );
63 if ( $whereQuery !== null ) {
64 $this->addWhere( $whereQuery );
67 // Don't order by el_from if it's constant in the WHERE clause
68 if ( count( $this->getPageSet()->getGoodTitles() ) != 1 ) {
69 $this->addOption( 'ORDER BY', 'el_from' );
72 $this->addOption( 'LIMIT', $params['limit'] +
1 );
73 if ( !is_null( $params['offset'] ) ) {
74 $this->addOption( 'OFFSET', $params['offset'] );
77 $res = $this->select( __METHOD__
);
80 foreach ( $res as $row ) {
81 if ( ++
$count > $params['limit'] ) {
82 // We've reached the one extra which shows that
83 // there are additional pages to be had. Stop here...
84 $this->setContinueEnumParameter( 'offset', @$params['offset'] +
$params['limit'] );
88 ApiResult
::setContent( $entry, $row->el_to
);
89 $fit = $this->addPageSubItem( $row->el_from
, $entry );
91 $this->setContinueEnumParameter( 'offset', @$params['offset'] +
$count - 1 );
97 public function getCacheMode( $params ) {
101 public function getAllowedParams() {
104 ApiBase
::PARAM_DFLT
=> 10,
105 ApiBase
::PARAM_TYPE
=> 'limit',
106 ApiBase
::PARAM_MIN
=> 1,
107 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
108 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
111 ApiBase
::PARAM_TYPE
=> 'integer'
114 ApiBase
::PARAM_TYPE
=> ApiQueryExtLinksUsage
::prepareProtocols(),
115 ApiBase
::PARAM_DFLT
=> '',
121 public function getParamDescription() {
122 $p = $this->getModulePrefix();
124 'limit' => 'How many links to return',
125 'offset' => 'When more results are available, use this to continue',
127 "Protocol of the url. If empty and {$p}query set, the protocol is http.",
128 "Leave both this and {$p}query empty to list all external links"
130 'query' => 'Search string without protocol. Useful for checking whether a certain page contains a certain external url',
134 public function getDescription() {
135 return 'Returns all external urls (not interwikies) from the given page(s)';
138 public function getPossibleErrors() {
139 return array_merge( parent
::getPossibleErrors(), array(
140 array( 'code' => 'bad_query', 'info' => 'Invalid query' ),
144 protected function getExamples() {
146 'Get a list of external links on the [[Main Page]]:',
147 ' api.php?action=query&prop=extlinks&titles=Main%20Page',
151 public function getVersion() {
152 return __CLASS__
. ': $Id$';