7d13f07494b8b2d4f4b359db4c0d5941dacf0265
4 * Created on May 14, 2010
6 * API for MediaWiki 1.17+
8 * Copyright © 2010 Sam Reed
9 * Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License along
22 * with this program; if not, write to the Free Software Foundation, Inc.,
23 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
24 * 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 interwiki links on a page
37 class ApiQueryIWLinks
extends ApiQueryBase
{
39 public function __construct( $query, $moduleName ) {
40 parent
::__construct( $query, $moduleName, 'iw' );
43 public function execute() {
44 if ( $this->getPageSet()->getGoodTitleCount() == 0 ) {
48 $params = $this->extractRequestParams();
49 $this->addFields( array(
55 $this->addTables( 'iwlinks' );
56 $this->addWhereFld( 'iwl_from', array_keys( $this->getPageSet()->getGoodTitles() ) );
58 if ( !is_null( $params['continue'] ) ) {
59 $cont = explode( '|', $params['continue'] );
60 if ( count( $cont ) != 3 ) {
61 $this->dieUsage( 'Invalid continue param. You should pass the ' .
62 'original value returned by the previous query', '_badcontinue' );
64 $iwlfrom = intval( $cont[0] );
65 $iwlprefix = $this->getDB()->strencode( $cont[1] );
66 $iwltitle = $this->getDB()->strencode( $this->titleToKey( $cont[2] ) );
68 "iwl_from > $iwlfrom OR " .
69 "(iwl_from = $iwlfrom AND " .
70 "(iwl_prefix > '$iwlprefix' OR " .
71 "(iwl_prefix = '$iwlprefix' AND " .
72 "iwl_title >= '$iwltitle')))"
76 // Don't order by iwl_from if it's constant in the WHERE clause
77 if ( count( $this->getPageSet()->getGoodTitles() ) == 1 ) {
78 $this->addOption( 'ORDER BY', 'iwl_prefix' );
80 $this->addOption( 'ORDER BY', 'iwl_from, iwl_prefix' );
82 $this->addOption( 'LIMIT', $params['limit'] +
1 );
83 $res = $this->select( __METHOD__
);
87 while ( $row = $db->fetchObject( $res ) ) {
88 if ( ++
$count > $params['limit'] ) {
89 // We've reached the one extra which shows that
90 // there are additional pages to be had. Stop here...
91 $this->setContinueEnumParameter( 'continue', "{$row->iwl_from}|{$row->iwl_prefix}|{$row->iwl_title}" );
94 $entry = array( 'prefix' => $row->iwl_prefix
);
96 if ( !is_null( $params['url'] ) ) {
97 $title = Title
::newFromText( "{$row->iwl_prefix}:{$row->iwl_title}" );
99 $entry = array_merge( $entry, array( 'url' => $title->getFullURL() ) );
103 ApiResult
::setContent( $entry, $row->iwl_title
);
104 $fit = $this->addPageSubItem( $row->iwl_from
, $entry );
106 $this->setContinueEnumParameter( 'continue', "{$row->iwl_from}|{$row->iwl_prefix}|{$row->iwl_title}" );
110 $db->freeResult( $res );
113 public function getAllowedParams() {
117 ApiBase
::PARAM_DFLT
=> 10,
118 ApiBase
::PARAM_TYPE
=> 'limit',
119 ApiBase
::PARAM_MIN
=> 1,
120 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
121 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
127 public function getParamDescription() {
129 'url' => 'Whether to get the full URL',
130 'limit' => 'How many interwiki links to return',
131 'continue' => 'When more results are available, use this to continue',
135 public function getDescription() {
136 return 'Returns all interwiki links from the given page(s)';
139 public function getPossibleErrors() {
140 return array_merge( parent
::getPossibleErrors(), array(
141 array( 'code' => '_badcontinue', 'info' => 'Invalid continue param. You should pass the original value returned by the previous query' ),
145 protected function getExamples() {
147 'Get interwiki links from the [[Main Page]]:',
148 ' api.php?action=query&prop=iwlinks&titles=Main%20Page',
152 public function getVersion() {
153 return __CLASS__
. ': $Id$';