4 * Created on May 14, 2010
6 * API for MediaWiki 1.17+
8 * Copyright (C) 2010 Sam Reed
9 * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License along
22 * with this program; if not, write to the Free Software Foundation, Inc.,
23 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
24 * 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 * This gives links pointing to the given interwiki
36 class ApiQueryIWBacklinks
extends ApiQueryGeneratorBase
{
38 public function __construct( $query, $moduleName ) {
39 parent
::__construct( $query, $moduleName, 'iwbl' );
42 public function execute() {
46 public function executeGenerator( $resultPageSet ) {
47 $this->run( $resultPageSet );
50 public function run( $resultPageSet = null ) {
51 $params = $this->extractRequestParams();
53 if ( isset( $params['title'] ) && !isset( $params['prefix'] ) ) {
54 $this->dieUsageMsg( array( 'missingparam', 'prefix' ) );
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' );
64 $prefix = $this->getDB()->strencode( $cont[0] );
65 $title = $this->getDB()->strencode( $this->titleToKey( $cont[1] ) );
66 $from = intval( $cont[2] );
68 "iwl_prefix > '$prefix' OR " .
69 "(iwl_prefix = '$prefix' AND " .
70 "(iwl_title > '$title' OR " .
71 "(iwl_title = '$title' AND " .
72 "iwl_from >= $from)))"
76 $prop = array_flip( $params['prop'] );
77 $iwprefix = isset( $prop['iwprefix'] );
78 $iwtitle = isset( $prop['iwtitle'] );
80 $this->addTables( array( 'iwlinks', 'page' ) );
81 $this->addWhere( 'iwl_from = page_id' );
83 $this->addFields( array( 'page_id', 'page_title', 'page_namespace', 'page_is_redirect',
84 'iwl_from', 'iwl_prefix', 'iwl_title' ) );
86 if ( isset( $params['prefix'] ) ) {
87 $this->addWhereFld( 'iwl_prefix', $params['prefix'] );
88 if ( isset( $params['title'] ) ) {
89 $this->addWhereFld( 'iwl_title', $params['title'] );
90 $this->addOption( 'ORDER BY', 'iwl_from' );
92 $this->addOption( 'ORDER BY', 'iwl_title, iwl_from' );
95 $this->addOption( 'ORDER BY', 'iwl_prefix, iwl_title, iwl_from' );
98 $this->addOption( 'LIMIT', $params['limit'] +
1 );
100 $res = $this->select( __METHOD__
);
105 $result = $this->getResult();
106 foreach ( $res as $row ) {
107 if ( ++
$count > $params['limit'] ) {
108 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
109 // Continue string preserved in case the redirect query doesn't pass the limit
110 $this->setContinueEnumParameter( 'continue', "{$row->iwl_prefix}|{$row->iwl_title}|{$row->iwl_from}" );
114 if ( !is_null( $resultPageSet ) ) {
115 $pages[] = Title
::newFromRow( $row );
119 $entry['pageid'] = intval( $row->page_id
);
120 $entry['ns'] = intval( $row->page_namespace
);
121 $entry['title'] = $row->page_title
;
123 if ( $row->page_is_redirect
) {
124 $entry['redirect'] = '';
128 $entry['iwprefix'] = $row->iwl_prefix
;
132 $entry['iwtitle'] = $row->iwl_title
;
135 $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $entry );
137 $this->setContinueEnumParameter( 'continue', "{$row->iwl_prefix}|{$row->iwl_title}|{$row->iwl_from}" );
143 if ( is_null( $resultPageSet ) ) {
144 $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'iw' );
146 $resultPageSet->populateFromTitles( $pages );
150 public function getCacheMode( $params ) {
154 public function getAllowedParams() {
160 ApiBase
::PARAM_DFLT
=> 10,
161 ApiBase
::PARAM_TYPE
=> 'limit',
162 ApiBase
::PARAM_MIN
=> 1,
163 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
164 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
167 ApiBase
::PARAM_ISMULTI
=> true,
168 ApiBase
::PARAM_DFLT
=> '',
169 ApiBase
::PARAM_TYPE
=> array(
177 public function getParamDescription() {
179 'prefix' => 'Prefix for the interwiki',
180 'title' => "Interwiki link to search for. Must be used with {$this->getModulePrefix()}prefix",
181 'continue' => 'When more results are available, use this to continue',
183 'Which properties to get',
184 ' iwprefix - Adds the prefix of the interwiki',
185 ' iwtitle - Adds the title of the interwiki',
187 'limit' => 'How many total pages to return',
191 public function getDescription() {
192 return array( 'Find all pages that link to the given interwiki link.',
193 'Can be used to find all links with a prefix, or',
194 'all links to a title (with a given prefix).',
195 'Using neither parameter is effectively "All IW Links"',
199 public function getPossibleErrors() {
200 return array_merge( parent
::getPossibleErrors(), array(
201 array( 'missingparam', 'prefix' ),
202 array( 'code' => '_badcontinue', 'info' => 'Invalid continue param. You should pass the original value returned by the previous query' ),
206 protected function getExamples() {
208 'api.php?action=query&list=iwbacklinks&iwbltitle=Test&iwblprefix=wikibooks',
209 'api.php?action=query&generator=iwbacklinks&giwbltitle=Test&iwblprefix=wikibooks&prop=info'
213 public function getVersion() {
214 return __CLASS__
. ': $Id$';