3 * API for MediaWiki 1.17+
5 * Created on May 14, 2011
7 * Copyright © 2011 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 * This gives links pointing to the given interwiki
37 class ApiQueryLangBacklinks
extends ApiQueryGeneratorBase
{
39 public function __construct( $query, $moduleName ) {
40 parent
::__construct( $query, $moduleName, 'lbl' );
43 public function execute() {
47 public function executeGenerator( $resultPageSet ) {
48 $this->run( $resultPageSet );
52 * @param $resultPageSet ApiPageSet
55 public function run( $resultPageSet = null ) {
56 $params = $this->extractRequestParams();
58 if ( isset( $params['title'] ) && !isset( $params['lang'] ) ) {
59 $this->dieUsageMsg( array( 'missingparam', 'lang' ) );
62 if ( !is_null( $params['continue'] ) ) {
63 $cont = explode( '|', $params['continue'] );
64 if ( count( $cont ) != 3 ) {
65 $this->dieUsage( 'Invalid continue param. You should pass the ' .
66 'original value returned by the previous query', '_badcontinue' );
69 $prefix = $this->getDB()->strencode( $cont[0] );
70 $title = $this->getDB()->strencode( $this->titleToKey( $cont[1] ) );
71 $from = intval( $cont[2] );
73 "ll_lang > '$prefix' OR " .
74 "(ll_lang = '$prefix' AND " .
75 "(ll_title > '$title' OR " .
76 "(ll_title = '$title' AND " .
81 $prop = array_flip( $params['prop'] );
82 $lllang = isset( $prop['llang'] );
83 $lltitle = isset( $prop['lltitle'] );
85 $this->addTables( array( 'langlinks', 'page' ) );
86 $this->addWhere( 'll_from = page_id' );
88 $this->addFields( array( 'page_id', 'page_title', 'page_namespace', 'page_is_redirect',
89 'll_from', 'iwl_lang', 'll_title' ) );
91 if ( isset( $params['lang'] ) ) {
92 $this->addWhereFld( 'll_lang', $params['lang'] );
93 if ( isset( $params['title'] ) ) {
94 $this->addWhereFld( 'll_title', $params['title'] );
95 $this->addOption( 'ORDER BY', 'll_from' );
97 $this->addOption( 'ORDER BY', 'll_title, ll_from' );
100 $this->addOption( 'ORDER BY', 'll_lang, ll_title, ll_from' );
103 $this->addOption( 'LIMIT', $params['limit'] +
1 );
105 $res = $this->select( __METHOD__
);
110 $result = $this->getResult();
111 foreach ( $res as $row ) {
112 if ( ++
$count > $params['limit'] ) {
113 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
114 // Continue string preserved in case the redirect query doesn't pass the limit
115 $this->setContinueEnumParameter( 'continue', "{$row->ll_lang}|{$row->ll_title}|{$row->ll_from}" );
119 if ( !is_null( $resultPageSet ) ) {
120 $pages[] = Title
::newFromRow( $row );
122 $entry = array( 'pageid' => $row->page_id
);
124 $title = Title
::makeTitle( $row->page_namespace
, $row->page_title
);
125 ApiQueryBase
::addTitleInfo( $entry, $title );
127 if ( $row->page_is_redirect
) {
128 $entry['redirect'] = '';
132 $entry['iwprefix'] = $row->ll_lang
;
136 $entry['iwtitle'] = $row->ll_title
;
139 $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $entry );
141 $this->setContinueEnumParameter( 'continue', "{$row->ll_lang}|{$row->ll_title}|{$row->ll_from}" );
147 if ( is_null( $resultPageSet ) ) {
148 $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'll' );
150 $resultPageSet->populateFromTitles( $pages );
154 public function getCacheMode( $params ) {
158 public function getAllowedParams() {
164 ApiBase
::PARAM_DFLT
=> 10,
165 ApiBase
::PARAM_TYPE
=> 'limit',
166 ApiBase
::PARAM_MIN
=> 1,
167 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
168 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
171 ApiBase
::PARAM_ISMULTI
=> true,
172 ApiBase
::PARAM_DFLT
=> '',
173 ApiBase
::PARAM_TYPE
=> array(
181 public function getParamDescription() {
183 'lang' => 'Language for the language link',
184 'title' => "Language link to search for. Must be used with {$this->getModulePrefix()}prefix",
185 'continue' => 'When more results are available, use this to continue',
187 'Which properties to get',
188 ' lllang - Adds the language code of the language link',
189 ' lltitle - Adds the title of the language ink',
191 'limit' => 'How many total pages to return',
195 public function getDescription() {
196 return array( 'Find all pages that link to the given language link.',
197 'Can be used to find all links with a language code, or',
198 'all links to a title (with a given language).',
199 'Using neither parameter is effectively "All Language Links"',
203 public function getPossibleErrors() {
204 return array_merge( parent
::getPossibleErrors(), array(
205 array( 'missingparam', 'lang' ),
206 array( 'code' => '_badcontinue', 'info' => 'Invalid continue param. You should pass the original value returned by the previous query' ),
210 protected function getExamples() {
212 'api.php?action=query&list=llbacklinks&lbltitle=Test&lbllang=fr',
213 'api.php?action=query&generator=llbacklinks&glbltitle=Test&lbllang=fr&prop=info'
217 public function getVersion() {
218 return __CLASS__
. ': $Id$';