Swap and for &&
[mediawiki.git] / includes / api / ApiQueryExternalLinks.php
blobb9a4263d6411ccdec66e7bec7ad75d0070cb437e
1 <?php
2 /**
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
24 * @file
27 /**
28 * A query module to list all external URLs found on a given set of pages.
30 * @ingroup API
32 class ApiQueryExternalLinks extends ApiQueryBase {
34 public function __construct( ApiQuery $query, $moduleName ) {
35 parent::__construct( $query, $moduleName, 'el' );
38 public function execute() {
39 if ( $this->getPageSet()->getGoodTitleCount() == 0 ) {
40 return;
43 $params = $this->extractRequestParams();
45 $query = $params['query'];
46 $protocol = ApiQueryExtLinksUsage::getProtocolPrefix( $params['protocol'] );
48 $this->addFields( array(
49 'el_from',
50 'el_to'
51 ) );
53 $this->addTables( 'externallinks' );
54 $this->addWhereFld( 'el_from', array_keys( $this->getPageSet()->getGoodTitles() ) );
56 $whereQuery = $this->prepareUrlQuerySearchString( $query, $protocol );
58 if ( $whereQuery !== null ) {
59 $this->addWhere( $whereQuery );
62 // Don't order by el_from if it's constant in the WHERE clause
63 if ( count( $this->getPageSet()->getGoodTitles() ) != 1 ) {
64 $this->addOption( 'ORDER BY', 'el_from' );
67 // If we're querying all protocols, use DISTINCT to avoid repeating protocol-relative links twice
68 if ( $protocol === null ) {
69 $this->addOption( 'DISTINCT' );
72 $this->addOption( 'LIMIT', $params['limit'] + 1 );
73 $offset = isset( $params['offset'] ) ? $params['offset'] : 0;
74 if ( $offset ) {
75 $this->addOption( 'OFFSET', $params['offset'] );
78 $res = $this->select( __METHOD__ );
80 $count = 0;
81 foreach ( $res as $row ) {
82 if ( ++$count > $params['limit'] ) {
83 // We've reached the one extra which shows that
84 // there are additional pages to be had. Stop here...
85 $this->setContinueEnumParameter( 'offset', $offset + $params['limit'] );
86 break;
88 $entry = array();
89 $to = $row->el_to;
90 // expand protocol-relative urls
91 if ( $params['expandurl'] ) {
92 $to = wfExpandUrl( $to, PROTO_CANONICAL );
94 ApiResult::setContent( $entry, $to );
95 $fit = $this->addPageSubItem( $row->el_from, $entry );
96 if ( !$fit ) {
97 $this->setContinueEnumParameter( 'offset', $offset + $count - 1 );
98 break;
103 public function getCacheMode( $params ) {
104 return 'public';
107 public function getAllowedParams() {
108 return array(
109 'limit' => array(
110 ApiBase::PARAM_DFLT => 10,
111 ApiBase::PARAM_TYPE => 'limit',
112 ApiBase::PARAM_MIN => 1,
113 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
114 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
116 'offset' => array(
117 ApiBase::PARAM_TYPE => 'integer',
118 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
120 'protocol' => array(
121 ApiBase::PARAM_TYPE => ApiQueryExtLinksUsage::prepareProtocols(),
122 ApiBase::PARAM_DFLT => '',
124 'query' => null,
125 'expandurl' => false,
129 public function getExamplesMessages() {
130 return array(
131 'action=query&prop=extlinks&titles=Main%20Page'
132 => 'apihelp-query+extlinks-example-simple',
136 public function getHelpUrls() {
137 return 'https://www.mediawiki.org/wiki/API:Properties#extlinks_.2F_el';