3 * API for MediaWiki 1.17+
5 * Created on May 14, 2010
7 * Copyright © 2010 Sam Reed
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
28 if ( !defined( 'MEDIAWIKI' ) ) {
29 // Eclipse helper - will be ignored in production
30 require_once( "ApiQueryBase.php" );
34 * A query module to list all interwiki links on a page
38 class ApiQueryIWLinks
extends ApiQueryBase
{
40 public function __construct( $query, $moduleName ) {
41 parent
::__construct( $query, $moduleName, 'iw' );
44 public function execute() {
45 if ( $this->getPageSet()->getGoodTitleCount() == 0 ) {
49 $params = $this->extractRequestParams();
51 if ( isset( $params['title'] ) && !isset( $params['prefix'] ) ) {
52 $this->dieUsageMsg( array( 'missingparam', 'prefix' ) );
55 $this->addFields( array(
61 $this->addTables( 'iwlinks' );
62 $this->addWhereFld( 'iwl_from', array_keys( $this->getPageSet()->getGoodTitles() ) );
64 if ( !is_null( $params['continue'] ) ) {
65 $cont = explode( '|', $params['continue'] );
66 if ( count( $cont ) != 3 ) {
67 $this->dieUsage( 'Invalid continue param. You should pass the ' .
68 'original value returned by the previous query', '_badcontinue' );
70 $iwlfrom = intval( $cont[0] );
71 $iwlprefix = $this->getDB()->strencode( $cont[1] );
72 $iwltitle = $this->getDB()->strencode( $this->titleToKey( $cont[2] ) );
74 "iwl_from > $iwlfrom OR " .
75 "(iwl_from = $iwlfrom AND " .
76 "(iwl_prefix > '$iwlprefix' OR " .
77 "(iwl_prefix = '$iwlprefix' AND " .
78 "iwl_title >= '$iwltitle')))"
82 if ( isset( $params['prefix'] ) ) {
83 $this->addWhereFld( 'iwl_prefix', $params['prefix'] );
84 if ( isset( $params['title'] ) ) {
85 $this->addWhereFld( 'iwl_title', $params['title'] );
86 $this->addOption( 'ORDER BY', 'iwl_from' );
88 $this->addOption( 'ORDER BY', 'iwl_title, iwl_from' );
91 // Don't order by iwl_from if it's constant in the WHERE clause
92 if ( count( $this->getPageSet()->getGoodTitles() ) == 1 ) {
93 $this->addOption( 'ORDER BY', 'iwl_prefix' );
95 $this->addOption( 'ORDER BY', 'iwl_from, iwl_prefix' );
99 $this->addOption( 'LIMIT', $params['limit'] +
1 );
100 $res = $this->select( __METHOD__
);
103 foreach ( $res as $row ) {
104 if ( ++
$count > $params['limit'] ) {
105 // We've reached the one extra which shows that
106 // there are additional pages to be had. Stop here...
107 $this->setContinueEnumParameter( 'continue', "{$row->iwl_from}|{$row->iwl_prefix}|{$row->iwl_title}" );
110 $entry = array( 'prefix' => $row->iwl_prefix
);
112 if ( !is_null( $params['url'] ) ) {
113 $title = Title
::newFromText( "{$row->iwl_prefix}:{$row->iwl_title}" );
115 $entry['url'] = $title->getFullURL();
119 ApiResult
::setContent( $entry, $row->iwl_title
);
120 $fit = $this->addPageSubItem( $row->iwl_from
, $entry );
122 $this->setContinueEnumParameter( 'continue', "{$row->iwl_from}|{$row->iwl_prefix}|{$row->iwl_title}" );
128 public function getCacheMode( $params ) {
132 public function getAllowedParams() {
136 ApiBase
::PARAM_DFLT
=> 10,
137 ApiBase
::PARAM_TYPE
=> 'limit',
138 ApiBase
::PARAM_MIN
=> 1,
139 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
140 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
148 public function getParamDescription() {
150 'url' => 'Whether to get the full URL',
151 'limit' => 'How many interwiki links to return',
152 'continue' => 'When more results are available, use this to continue',
153 'prefix' => 'Prefix for the interwiki',
154 'title' => "Interwiki link to search for. Must be used with {$this->getModulePrefix()}prefix",
158 public function getDescription() {
159 return 'Returns all interwiki links from the given page(s)';
162 public function getPossibleErrors() {
163 return array_merge( parent
::getPossibleErrors(), array(
164 array( 'missingparam', 'prefix' ),
165 array( 'code' => '_badcontinue', 'info' => 'Invalid continue param. You should pass the original value returned by the previous query' ),
169 protected function getExamples() {
171 'Get interwiki links from the [[Main Page]]:',
172 ' api.php?action=query&prop=iwlinks&titles=Main%20Page',
176 public function getVersion() {
177 return __CLASS__
. ': $Id$';