3 * API for MediaWiki 1.17+
5 * Copyright © 2010 Sam Reed
6 * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21 * http://www.gnu.org/copyleft/gpl.html
27 * This gives links pointing to the given interwiki
30 class ApiQueryIWBacklinks
extends ApiQueryGeneratorBase
{
32 public function __construct( ApiQuery
$query, $moduleName ) {
33 parent
::__construct( $query, $moduleName, 'iwbl' );
36 public function execute() {
40 public function executeGenerator( $resultPageSet ) {
41 $this->run( $resultPageSet );
45 * @param ApiPageSet $resultPageSet
48 public function run( $resultPageSet = null ) {
49 $params = $this->extractRequestParams();
51 if ( isset( $params['title'] ) && !isset( $params['prefix'] ) ) {
54 'apierror-invalidparammix-mustusewith',
55 $this->encodeParamName( 'title' ),
56 $this->encodeParamName( 'prefix' ),
62 if ( !is_null( $params['continue'] ) ) {
63 $cont = explode( '|', $params['continue'] );
64 $this->dieContinueUsageIf( count( $cont ) != 3 );
67 $op = $params['dir'] == 'descending' ?
'<' : '>';
68 $prefix = $db->addQuotes( $cont[0] );
69 $title = $db->addQuotes( $cont[1] );
70 $from = intval( $cont[2] );
72 "iwl_prefix $op $prefix OR " .
73 "(iwl_prefix = $prefix AND " .
74 "(iwl_title $op $title OR " .
75 "(iwl_title = $title AND " .
76 "iwl_from $op= $from)))"
80 $prop = array_flip( $params['prop'] );
81 $iwprefix = isset( $prop['iwprefix'] );
82 $iwtitle = isset( $prop['iwtitle'] );
84 $this->addTables( [ 'iwlinks', 'page' ] );
85 $this->addWhere( 'iwl_from = page_id' );
87 $this->addFields( [ 'page_id', 'page_title', 'page_namespace', 'page_is_redirect',
88 'iwl_from', 'iwl_prefix', 'iwl_title' ] );
90 $sort = ( $params['dir'] == 'descending' ?
' DESC' : '' );
91 if ( isset( $params['prefix'] ) ) {
92 $this->addWhereFld( 'iwl_prefix', $params['prefix'] );
93 if ( isset( $params['title'] ) ) {
94 $this->addWhereFld( 'iwl_title', $params['title'] );
95 $this->addOption( 'ORDER BY', 'iwl_from' . $sort );
97 $this->addOption( 'ORDER BY', [
103 $this->addOption( 'ORDER BY', [
104 'iwl_prefix' . $sort,
110 $this->addOption( 'LIMIT', $params['limit'] +
1 );
112 $res = $this->select( __METHOD__
);
117 $result = $this->getResult();
118 foreach ( $res as $row ) {
119 if ( ++
$count > $params['limit'] ) {
120 // We've reached the one extra which shows that there are
121 // additional pages to be had. Stop here...
122 // Continue string preserved in case the redirect query doesn't
124 $this->setContinueEnumParameter(
126 "{$row->iwl_prefix}|{$row->iwl_title}|{$row->iwl_from}"
131 if ( !is_null( $resultPageSet ) ) {
132 $pages[] = Title
::newFromRow( $row );
134 $entry = [ 'pageid' => $row->page_id
];
136 $title = Title
::makeTitle( $row->page_namespace
, $row->page_title
);
137 ApiQueryBase
::addTitleInfo( $entry, $title );
139 if ( $row->page_is_redirect
) {
140 $entry['redirect'] = true;
144 $entry['iwprefix'] = $row->iwl_prefix
;
148 $entry['iwtitle'] = $row->iwl_title
;
151 $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $entry );
153 $this->setContinueEnumParameter(
155 "{$row->iwl_prefix}|{$row->iwl_title}|{$row->iwl_from}"
162 if ( is_null( $resultPageSet ) ) {
163 $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'iw' );
165 $resultPageSet->populateFromTitles( $pages );
169 public function getCacheMode( $params ) {
173 public function getAllowedParams() {
178 ApiBase
::PARAM_HELP_MSG
=> 'api-help-param-continue',
181 ApiBase
::PARAM_DFLT
=> 10,
182 ApiBase
::PARAM_TYPE
=> 'limit',
183 ApiBase
::PARAM_MIN
=> 1,
184 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
185 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
188 ApiBase
::PARAM_ISMULTI
=> true,
189 ApiBase
::PARAM_DFLT
=> '',
190 ApiBase
::PARAM_TYPE
=> [
194 ApiBase
::PARAM_HELP_MSG_PER_VALUE
=> [],
197 ApiBase
::PARAM_DFLT
=> 'ascending',
198 ApiBase
::PARAM_TYPE
=> [
206 protected function getExamplesMessages() {
208 'action=query&list=iwbacklinks&iwbltitle=Test&iwblprefix=wikibooks'
209 => 'apihelp-query+iwbacklinks-example-simple',
210 'action=query&generator=iwbacklinks&giwbltitle=Test&giwblprefix=wikibooks&prop=info'
211 => 'apihelp-query+iwbacklinks-example-generator',
215 public function getHelpUrls() {
216 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Iwbacklinks';