3 * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 use MediaWiki\MediaWikiServices
;
26 * A query module to list all langlinks (links to corresponding foreign language pages).
30 class ApiQueryLangLinks
extends ApiQueryBase
{
32 public function __construct( ApiQuery
$query, $moduleName ) {
33 parent
::__construct( $query, $moduleName, 'll' );
36 public function execute() {
37 if ( $this->getPageSet()->getGoodTitleCount() == 0 ) {
41 $params = $this->extractRequestParams();
42 $prop = array_flip( (array)$params['prop'] );
44 if ( isset( $params['title'] ) && !isset( $params['lang'] ) ) {
47 'apierror-invalidparammix-mustusewith',
48 $this->encodeParamName( 'title' ),
49 $this->encodeParamName( 'lang' ),
55 // Handle deprecated param
56 $this->requireMaxOneParameter( $params, 'url', 'prop' );
57 if ( $params['url'] ) {
58 $prop = [ 'url' => 1 ];
67 $this->addTables( 'langlinks' );
68 $this->addWhereFld( 'll_from', array_keys( $this->getPageSet()->getGoodTitles() ) );
69 if ( !is_null( $params['continue'] ) ) {
70 $cont = explode( '|', $params['continue'] );
71 $this->dieContinueUsageIf( count( $cont ) != 2 );
72 $op = $params['dir'] == 'descending' ?
'<' : '>';
73 $llfrom = (int)$cont[0];
74 $lllang = $this->getDB()->addQuotes( $cont[1] );
76 "ll_from $op $llfrom OR " .
77 "(ll_from = $llfrom AND " .
78 "ll_lang $op= $lllang)"
82 // FIXME: (follow-up) To allow extensions to add to the language links, we need
83 // to load them all, add the extra links, then apply paging.
84 // Should not be terrible, it's not going to be more than a few hundred links.
86 // Note that, since (ll_from, ll_lang) is a unique key, we don't need
87 // to sort by ll_title to ensure deterministic ordering.
88 $sort = ( $params['dir'] == 'descending' ?
' DESC' : '' );
89 if ( isset( $params['lang'] ) ) {
90 $this->addWhereFld( 'll_lang', $params['lang'] );
91 if ( isset( $params['title'] ) ) {
92 $this->addWhereFld( 'll_title', $params['title'] );
94 $this->addOption( 'ORDER BY', 'll_from' . $sort );
96 // Don't order by ll_from if it's constant in the WHERE clause
97 if ( count( $this->getPageSet()->getGoodTitles() ) == 1 ) {
98 $this->addOption( 'ORDER BY', 'll_lang' . $sort );
100 $this->addOption( 'ORDER BY', [
107 $this->addOption( 'LIMIT', $params['limit'] +
1 );
108 $res = $this->select( __METHOD__
);
111 foreach ( $res as $row ) {
112 if ( ++
$count > $params['limit'] ) {
113 // We've reached the one extra which shows that
114 // there are additional pages to be had. Stop here...
115 $this->setContinueEnumParameter( 'continue', "{$row->ll_from}|{$row->ll_lang}" );
118 $entry = [ 'lang' => $row->ll_lang
];
119 if ( isset( $prop['url'] ) ) {
120 $title = Title
::newFromText( "{$row->ll_lang}:{$row->ll_title}" );
122 $entry['url'] = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT
);
125 if ( isset( $prop['langname'] ) ) {
126 $entry['langname'] = Language
::fetchLanguageName( $row->ll_lang
, $params['inlanguagecode'] );
128 if ( isset( $prop['autonym'] ) ) {
129 $entry['autonym'] = Language
::fetchLanguageName( $row->ll_lang
);
131 ApiResult
::setContentValue( $entry, 'title', $row->ll_title
);
132 $fit = $this->addPageSubItem( $row->ll_from
, $entry );
134 $this->setContinueEnumParameter( 'continue', "{$row->ll_from}|{$row->ll_lang}" );
140 public function getCacheMode( $params ) {
144 public function getAllowedParams() {
147 ApiBase
::PARAM_ISMULTI
=> true,
148 ApiBase
::PARAM_TYPE
=> [
153 ApiBase
::PARAM_HELP_MSG_PER_VALUE
=> [],
158 ApiBase
::PARAM_DFLT
=> 'ascending',
159 ApiBase
::PARAM_TYPE
=> [
164 'inlanguagecode' => MediaWikiServices
::getInstance()->getContentLanguage()->getCode(),
166 ApiBase
::PARAM_DFLT
=> 10,
167 ApiBase
::PARAM_TYPE
=> 'limit',
168 ApiBase
::PARAM_MIN
=> 1,
169 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
170 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
173 ApiBase
::PARAM_HELP_MSG
=> 'api-help-param-continue',
176 ApiBase
::PARAM_DFLT
=> false,
177 ApiBase
::PARAM_DEPRECATED
=> true,
182 protected function getExamplesMessages() {
184 'action=query&prop=langlinks&titles=Main%20Page&redirects='
185 => 'apihelp-query+langlinks-example-simple',
189 public function getHelpUrls() {
190 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Langlinks';