X-Git-Url: https://scripts.mit.edu/gitweb/autoinstallsdev/mediawiki.git/blobdiff_plain/19e297c21b10b1b8a3acad5e73fc71dcb35db44a..6932310fd58ebef145fa01eb76edf7150284d8ea:/includes/api/ApiQueryLangLinks.php diff --git a/includes/api/ApiQueryLangLinks.php b/includes/api/ApiQueryLangLinks.php index 60e33709..df33d027 100644 --- a/includes/api/ApiQueryLangLinks.php +++ b/includes/api/ApiQueryLangLinks.php @@ -1,10 +1,10 @@ @gmail.com + * Copyright © 2006 Yuri Astrakhan "@gmail.com" * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -24,19 +24,14 @@ * @file */ -if ( !defined( 'MEDIAWIKI' ) ) { - // Eclipse helper - will be ignored in production - require_once( "ApiQueryBase.php" ); -} - /** - * A query module to list all langlinks (links to correspanding foreign language pages). + * A query module to list all langlinks (links to corresponding foreign language pages). * * @ingroup API */ class ApiQueryLangLinks extends ApiQueryBase { - public function __construct( $query, $moduleName ) { + public function __construct( ApiQuery $query, $moduleName ) { parent::__construct( $query, $moduleName, 'll' ); } @@ -46,35 +41,71 @@ class ApiQueryLangLinks extends ApiQueryBase { } $params = $this->extractRequestParams(); - $this->addFields( array( + $prop = array_flip( (array)$params['prop'] ); + + if ( isset( $params['title'] ) && !isset( $params['lang'] ) ) { + $this->dieWithError( + [ + 'apierror-invalidparammix-mustusewith', + $this->encodeParamName( 'title' ), + $this->encodeParamName( 'lang' ), + ], + 'invalidparammix' + ); + } + + // Handle deprecated param + $this->requireMaxOneParameter( $params, 'url', 'prop' ); + if ( $params['url'] ) { + $prop = [ 'url' => 1 ]; + } + + $this->addFields( [ 'll_from', 'll_lang', 'll_title' - ) ); + ] ); $this->addTables( 'langlinks' ); $this->addWhereFld( 'll_from', array_keys( $this->getPageSet()->getGoodTitles() ) ); if ( !is_null( $params['continue'] ) ) { $cont = explode( '|', $params['continue'] ); - if ( count( $cont ) != 2 ) { - $this->dieUsage( 'Invalid continue param. You should pass the ' . - 'original value returned by the previous query', '_badcontinue' ); - } + $this->dieContinueUsageIf( count( $cont ) != 2 ); + $op = $params['dir'] == 'descending' ? '<' : '>'; $llfrom = intval( $cont[0] ); - $lllang = $this->getDB()->strencode( $cont[1] ); + $lllang = $this->getDB()->addQuotes( $cont[1] ); $this->addWhere( - "ll_from > $llfrom OR " . + "ll_from $op $llfrom OR " . "(ll_from = $llfrom AND " . - "ll_lang >= '$lllang')" + "ll_lang $op= $lllang)" ); } - // Don't order by ll_from if it's constant in the WHERE clause - if ( count( $this->getPageSet()->getGoodTitles() ) == 1 ) { - $this->addOption( 'ORDER BY', 'll_lang' ); + // FIXME: (follow-up) To allow extensions to add to the language links, we need + // to load them all, add the extra links, then apply paging. + // Should not be terrible, it's not going to be more than a few hundred links. + + // Note that, since (ll_from, ll_lang) is a unique key, we don't need + // to sort by ll_title to ensure deterministic ordering. + $sort = ( $params['dir'] == 'descending' ? ' DESC' : '' ); + if ( isset( $params['lang'] ) ) { + $this->addWhereFld( 'll_lang', $params['lang'] ); + if ( isset( $params['title'] ) ) { + $this->addWhereFld( 'll_title', $params['title'] ); + } + $this->addOption( 'ORDER BY', 'll_from' . $sort ); } else { - $this->addOption( 'ORDER BY', 'll_from, ll_lang' ); + // Don't order by ll_from if it's constant in the WHERE clause + if ( count( $this->getPageSet()->getGoodTitles() ) == 1 ) { + $this->addOption( 'ORDER BY', 'll_lang' . $sort ); + } else { + $this->addOption( 'ORDER BY', [ + 'll_from' . $sort, + 'll_lang' . $sort + ] ); + } } + $this->addOption( 'LIMIT', $params['limit'] + 1 ); $res = $this->select( __METHOD__ ); @@ -86,14 +117,20 @@ class ApiQueryLangLinks extends ApiQueryBase { $this->setContinueEnumParameter( 'continue', "{$row->ll_from}|{$row->ll_lang}" ); break; } - $entry = array( 'lang' => $row->ll_lang ); - if ( $params['url'] ) { + $entry = [ 'lang' => $row->ll_lang ]; + if ( isset( $prop['url'] ) ) { $title = Title::newFromText( "{$row->ll_lang}:{$row->ll_title}" ); if ( $title ) { - $entry['url'] = $title->getFullURL(); + $entry['url'] = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT ); } } - ApiResult::setContent( $entry, $row->ll_title ); + if ( isset( $prop['langname'] ) ) { + $entry['langname'] = Language::fetchLanguageName( $row->ll_lang, $params['inlanguagecode'] ); + } + if ( isset( $prop['autonym'] ) ) { + $entry['autonym'] = Language::fetchLanguageName( $row->ll_lang ); + } + ApiResult::setContentValue( $entry, 'title', $row->ll_title ); $fit = $this->addPageSubItem( $row->ll_from, $entry ); if ( !$fit ) { $this->setContinueEnumParameter( 'continue', "{$row->ll_from}|{$row->ll_lang}" ); @@ -107,45 +144,52 @@ class ApiQueryLangLinks extends ApiQueryBase { } public function getAllowedParams() { - return array( - 'limit' => array( + global $wgContLang; + return [ + 'prop' => [ + ApiBase::PARAM_ISMULTI => true, + ApiBase::PARAM_TYPE => [ + 'url', + 'langname', + 'autonym', + ], + ApiBase::PARAM_HELP_MSG_PER_VALUE => [], + ], + 'lang' => null, + 'title' => null, + 'dir' => [ + ApiBase::PARAM_DFLT => 'ascending', + ApiBase::PARAM_TYPE => [ + 'ascending', + 'descending' + ] + ], + 'inlanguagecode' => $wgContLang->getCode(), + 'limit' => [ ApiBase::PARAM_DFLT => 10, ApiBase::PARAM_TYPE => 'limit', ApiBase::PARAM_MIN => 1, ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1, ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2 - ), - 'continue' => null, - 'url' => false, - ); - } - - public function getParamDescription() { - return array( - 'limit' => 'How many langlinks to return', - 'continue' => 'When more results are available, use this to continue', - 'url' => 'Whether to get the full URL', - ); - } - - public function getDescription() { - return 'Returns all interlanguage links from the given page(s)'; - } - - public function getPossibleErrors() { - return array_merge( parent::getPossibleErrors(), array( - array( 'code' => '_badcontinue', 'info' => 'Invalid continue param. You should pass the original value returned by the previous query' ), - ) ); + ], + 'continue' => [ + ApiBase::PARAM_HELP_MSG => 'api-help-param-continue', + ], + 'url' => [ + ApiBase::PARAM_DFLT => false, + ApiBase::PARAM_DEPRECATED => true, + ], + ]; } - protected function getExamples() { - return array( - 'Get interlanguage links from the [[Main Page]]:', - ' api.php?action=query&prop=langlinks&titles=Main%20Page&redirects=', - ); + protected function getExamplesMessages() { + return [ + 'action=query&prop=langlinks&titles=Main%20Page&redirects=' + => 'apihelp-query+langlinks-example-simple', + ]; } - public function getVersion() { - return __CLASS__ . ': $Id$'; + public function getHelpUrls() { + return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Langlinks'; } }