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
29 * This gives links pointing to the given interwiki
32 class ApiQueryLangBacklinks
extends ApiQueryGeneratorBase
{
34 public function __construct( $query, $moduleName ) {
35 parent
::__construct( $query, $moduleName, 'lbl' );
38 public function execute() {
42 public function executeGenerator( $resultPageSet ) {
43 $this->run( $resultPageSet );
47 * @param $resultPageSet ApiPageSet
50 public function run( $resultPageSet = null ) {
51 $params = $this->extractRequestParams();
53 if ( isset( $params['title'] ) && !isset( $params['lang'] ) ) {
54 $this->dieUsageMsg( array( 'missingparam', 'lang' ) );
57 if ( !is_null( $params['continue'] ) ) {
58 $cont = explode( '|', $params['continue'] );
59 if ( count( $cont ) != 3 ) {
60 $this->dieUsage( 'Invalid continue param. You should pass the ' .
61 'original value returned by the previous query', '_badcontinue' );
65 $prefix = $db->addQuotes( $cont[0] );
66 $title = $db->addQuotes( $this->titleToKey( $cont[1] ) );
67 $from = intval( $cont[2] );
69 "ll_lang > $prefix OR " .
70 "(ll_lang = $prefix AND " .
71 "(ll_title > $title OR " .
72 "(ll_title = $title AND " .
77 $prop = array_flip( $params['prop'] );
78 $lllang = isset( $prop['lllang'] );
79 $lltitle = isset( $prop['lltitle'] );
81 $this->addTables( array( 'langlinks', 'page' ) );
82 $this->addWhere( 'll_from = page_id' );
84 $this->addFields( array( 'page_id', 'page_title', 'page_namespace', 'page_is_redirect',
85 'll_from', 'll_lang', 'll_title' ) );
87 if ( isset( $params['lang'] ) ) {
88 $this->addWhereFld( 'll_lang', $params['lang'] );
89 if ( isset( $params['title'] ) ) {
90 $this->addWhereFld( 'll_title', $params['title'] );
91 $this->addOption( 'ORDER BY', 'll_from' );
93 $this->addOption( 'ORDER BY', array(
99 $this->addOption( 'ORDER BY', array(
106 $this->addOption( 'LIMIT', $params['limit'] +
1 );
108 $res = $this->select( __METHOD__
);
113 $result = $this->getResult();
114 foreach ( $res as $row ) {
115 if ( ++
$count > $params['limit'] ) {
116 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
117 // Continue string preserved in case the redirect query doesn't pass the limit
118 $this->setContinueEnumParameter( 'continue', "{$row->ll_lang}|{$row->ll_title}|{$row->ll_from}" );
122 if ( !is_null( $resultPageSet ) ) {
123 $pages[] = Title
::newFromRow( $row );
125 $entry = array( 'pageid' => $row->page_id
);
127 $title = Title
::makeTitle( $row->page_namespace
, $row->page_title
);
128 ApiQueryBase
::addTitleInfo( $entry, $title );
130 if ( $row->page_is_redirect
) {
131 $entry['redirect'] = '';
135 $entry['lllang'] = $row->ll_lang
;
139 $entry['lltitle'] = $row->ll_title
;
142 $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $entry );
144 $this->setContinueEnumParameter( 'continue', "{$row->ll_lang}|{$row->ll_title}|{$row->ll_from}" );
150 if ( is_null( $resultPageSet ) ) {
151 $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'll' );
153 $resultPageSet->populateFromTitles( $pages );
157 public function getCacheMode( $params ) {
161 public function getAllowedParams() {
167 ApiBase
::PARAM_DFLT
=> 10,
168 ApiBase
::PARAM_TYPE
=> 'limit',
169 ApiBase
::PARAM_MIN
=> 1,
170 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
171 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
174 ApiBase
::PARAM_ISMULTI
=> true,
175 ApiBase
::PARAM_DFLT
=> '',
176 ApiBase
::PARAM_TYPE
=> array(
184 public function getParamDescription() {
186 'lang' => 'Language for the language link',
187 'title' => "Language link to search for. Must be used with {$this->getModulePrefix()}lang",
188 'continue' => 'When more results are available, use this to continue',
190 'Which properties to get',
191 ' lllang - Adds the language code of the language link',
192 ' lltitle - Adds the title of the language ink',
194 'limit' => 'How many total pages to return',
198 public function getResultProperties() {
201 'pageid' => 'integer',
204 'redirect' => 'boolean'
210 'lltitle' => 'string'
215 public function getDescription() {
216 return array( 'Find all pages that link to the given language link.',
217 'Can be used to find all links with a language code, or',
218 'all links to a title (with a given language).',
219 'Using neither parameter is effectively "All Language Links"',
223 public function getPossibleErrors() {
224 return array_merge( parent
::getPossibleErrors(), array(
225 array( 'missingparam', 'lang' ),
226 array( 'code' => '_badcontinue', 'info' => 'Invalid continue param. You should pass the original value returned by the previous query' ),
230 public function getExamples() {
232 'api.php?action=query&list=langbacklinks&lbltitle=Test&lbllang=fr',
233 'api.php?action=query&generator=langbacklinks&glbltitle=Test&glbllang=fr&prop=info'
237 public function getVersion() {
238 return __CLASS__
. ': $Id$';