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 langlinks (links to correspanding foreign language pages).
37 class ApiQueryLangLinks
extends ApiQueryBase
{
39 public function __construct( $query, $moduleName ) {
40 parent
::__construct( $query, $moduleName, 'll' );
43 public function execute() {
44 if ( $this->getPageSet()->getGoodTitleCount() == 0 ) {
48 $params = $this->extractRequestParams();
50 if ( isset( $params['title'] ) && !isset( $params['lang'] ) ) {
51 $this->dieUsageMsg( array( 'missingparam', 'lang' ) );
54 $this->addFields( array(
60 $this->addTables( 'langlinks' );
61 $this->addWhereFld( 'll_from', array_keys( $this->getPageSet()->getGoodTitles() ) );
62 if ( !is_null( $params['continue'] ) ) {
63 $cont = explode( '|', $params['continue'] );
64 if ( count( $cont ) != 2 ) {
65 $this->dieUsage( 'Invalid continue param. You should pass the ' .
66 'original value returned by the previous query', '_badcontinue' );
68 $llfrom = intval( $cont[0] );
69 $lllang = $this->getDB()->strencode( $cont[1] );
71 "ll_from > $llfrom OR " .
72 "(ll_from = $llfrom AND " .
73 "ll_lang >= '$lllang')"
77 if ( isset( $params['lang'] ) ) {
78 $this->addWhereFld( 'll_lang', $params['lang'] );
79 if ( isset( $params['title'] ) ) {
80 $this->addWhereFld( 'll_title', $params['title'] );
81 $this->addOption( 'ORDER BY', 'll_from' );
83 $this->addOption( 'ORDER BY', 'll_title, ll_from' );
86 // Don't order by ll_from if it's constant in the WHERE clause
87 if ( count( $this->getPageSet()->getGoodTitles() ) == 1 ) {
88 $this->addOption( 'ORDER BY', 'll_lang' );
90 $this->addOption( 'ORDER BY', 'll_from, ll_lang' );
94 $this->addOption( 'LIMIT', $params['limit'] +
1 );
95 $res = $this->select( __METHOD__
);
98 foreach ( $res as $row ) {
99 if ( ++
$count > $params['limit'] ) {
100 // We've reached the one extra which shows that
101 // there are additional pages to be had. Stop here...
102 $this->setContinueEnumParameter( 'continue', "{$row->ll_from}|{$row->ll_lang}" );
105 $entry = array( 'lang' => $row->ll_lang
);
106 if ( $params['url'] ) {
107 $title = Title
::newFromText( "{$row->ll_lang}:{$row->ll_title}" );
109 $entry['url'] = $title->getFullURL();
112 ApiResult
::setContent( $entry, $row->ll_title
);
113 $fit = $this->addPageSubItem( $row->ll_from
, $entry );
115 $this->setContinueEnumParameter( 'continue', "{$row->ll_from}|{$row->ll_lang}" );
121 public function getCacheMode( $params ) {
125 public function getAllowedParams() {
128 ApiBase
::PARAM_DFLT
=> 10,
129 ApiBase
::PARAM_TYPE
=> 'limit',
130 ApiBase
::PARAM_MIN
=> 1,
131 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
132 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
141 public function getParamDescription() {
143 'limit' => 'How many langlinks to return',
144 'continue' => 'When more results are available, use this to continue',
145 'url' => 'Whether to get the full URL',
146 'lang' => 'Language code',
147 'title' => "Link to search for. Must be used with {$this->getModulePrefix()}lang",
151 public function getDescription() {
152 return 'Returns all interlanguage links from the given page(s)';
155 public function getPossibleErrors() {
156 return array_merge( parent
::getPossibleErrors(), array(
157 array( 'missingparam', 'lang' ),
158 array( 'code' => '_badcontinue', 'info' => 'Invalid continue param. You should pass the original value returned by the previous query' ),
162 protected function getExamples() {
164 'Get interlanguage links from the [[Main Page]]:',
165 ' api.php?action=query&prop=langlinks&titles=Main%20Page&redirects=',
169 public function getVersion() {
170 return __CLASS__
. ': $Id$';