includes/api/ApiQueryLangBacklinks.php

   1 <?php
   2 /**
   3  * API for MediaWiki 1.17+
   4  *
   5  * Copyright © 2011 Sam Reed
   6  * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
   7  *
   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.
  12  *
  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.
  17  *
  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
  22  *
  23  * @file
  24  */
  25
  26 /**
  27  * This gives links pointing to the given interwiki
  28  * @ingroup API
  29  */
  30 class ApiQueryLangBacklinks extends ApiQueryGeneratorBase {
  31
  32         public function __construct( ApiQuery $query, $moduleName ) {
  33                 parent::__construct( $query, $moduleName, 'lbl' );
  34         }
  35
  36         public function execute() {
  37                 $this->run();
  38         }
  39
  40         public function executeGenerator( $resultPageSet ) {
  41                 $this->run( $resultPageSet );
  42         }
  43
  44         /**
  45          * @param ApiPageSet $resultPageSet
  46          * @return void
  47          */
  48         public function run( $resultPageSet = null ) {
  49                 $params = $this->extractRequestParams();
  50
  51                 if ( isset( $params['title'] ) && !isset( $params['lang'] ) ) {
  52                         $this->dieWithError(
  53                                 [
  54                                         'apierror-invalidparammix-mustusewith',
  55                                         $this->encodeParamName( 'title' ),
  56                                         $this->encodeParamName( 'lang' )
  57                                 ],
  58                                 'nolang'
  59                         );
  60                 }
  61
  62                 if ( !is_null( $params['continue'] ) ) {
  63                         $cont = explode( '|', $params['continue'] );
  64                         $this->dieContinueUsageIf( count( $cont ) != 3 );
  65
  66                         $db = $this->getDB();
  67                         $op = $params['dir'] == 'descending' ? '<' : '>';
  68                         $prefix = $db->addQuotes( $cont[0] );
  69                         $title = $db->addQuotes( $cont[1] );
  70                         $from = intval( $cont[2] );
  71                         $this->addWhere(
  72                                 "ll_lang $op $prefix OR " .
  73                                 "(ll_lang = $prefix AND " .
  74                                 "(ll_title $op $title OR " .
  75                                 "(ll_title = $title AND " .
  76                                 "ll_from $op= $from)))"
  77                         );
  78                 }
  79
  80                 $prop = array_flip( $params['prop'] );
  81                 $lllang = isset( $prop['lllang'] );
  82                 $lltitle = isset( $prop['lltitle'] );
  83
  84                 $this->addTables( [ 'langlinks', 'page' ] );
  85                 $this->addWhere( 'll_from = page_id' );
  86
  87                 $this->addFields( [ 'page_id', 'page_title', 'page_namespace', 'page_is_redirect',
  88                         'll_from', 'll_lang', 'll_title' ] );
  89
  90                 $sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
  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' . $sort );
  96                         } else {
  97                                 $this->addOption( 'ORDER BY', [
  98                                         'll_title' . $sort,
  99                                         'll_from' . $sort
 100                                 ] );
 101                         }
 102                 } else {
 103                         $this->addOption( 'ORDER BY', [
 104                                 'll_lang' . $sort,
 105                                 'll_title' . $sort,
 106                                 'll_from' . $sort
 107                         ] );
 108                 }
 109
 110                 $this->addOption( 'LIMIT', $params['limit'] + 1 );
 111
 112                 $res = $this->select( __METHOD__ );
 113
 114                 $pages = [];
 115
 116                 $count = 0;
 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... Continue string
 122                                 // preserved in case the redirect query doesn't pass the limit.
 123                                 $this->setContinueEnumParameter(
 124                                         'continue',
 125                                         "{$row->ll_lang}|{$row->ll_title}|{$row->ll_from}"
 126                                 );
 127                                 break;
 128                         }
 129
 130                         if ( !is_null( $resultPageSet ) ) {
 131                                 $pages[] = Title::newFromRow( $row );
 132                         } else {
 133                                 $entry = [ 'pageid' => $row->page_id ];
 134
 135                                 $title = Title::makeTitle( $row->page_namespace, $row->page_title );
 136                                 ApiQueryBase::addTitleInfo( $entry, $title );
 137
 138                                 if ( $row->page_is_redirect ) {
 139                                         $entry['redirect'] = true;
 140                                 }
 141
 142                                 if ( $lllang ) {
 143                                         $entry['lllang'] = $row->ll_lang;
 144                                 }
 145
 146                                 if ( $lltitle ) {
 147                                         $entry['lltitle'] = $row->ll_title;
 148                                 }
 149
 150                                 $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $entry );
 151                                 if ( !$fit ) {
 152                                         $this->setContinueEnumParameter(
 153                                                 'continue',
 154                                                 "{$row->ll_lang}|{$row->ll_title}|{$row->ll_from}"
 155                                         );
 156                                         break;
 157                                 }
 158                         }
 159                 }
 160
 161                 if ( is_null( $resultPageSet ) ) {
 162                         $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'll' );
 163                 } else {
 164                         $resultPageSet->populateFromTitles( $pages );
 165                 }
 166         }
 167
 168         public function getCacheMode( $params ) {
 169                 return 'public';
 170         }
 171
 172         public function getAllowedParams() {
 173                 return [
 174                         'lang' => null,
 175                         'title' => null,
 176                         'continue' => [
 177                                 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
 178                         ],
 179                         'limit' => [
 180                                 ApiBase::PARAM_DFLT => 10,
 181                                 ApiBase::PARAM_TYPE => 'limit',
 182                                 ApiBase::PARAM_MIN => 1,
 183                                 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
 184                                 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
 185                         ],
 186                         'prop' => [
 187                                 ApiBase::PARAM_ISMULTI => true,
 188                                 ApiBase::PARAM_DFLT => '',
 189                                 ApiBase::PARAM_TYPE => [
 190                                         'lllang',
 191                                         'lltitle',
 192                                 ],
 193                                 ApiBase::PARAM_HELP_MSG_PER_VALUE => [],
 194                         ],
 195                         'dir' => [
 196                                 ApiBase::PARAM_DFLT => 'ascending',
 197                                 ApiBase::PARAM_TYPE => [
 198                                         'ascending',
 199                                         'descending'
 200                                 ]
 201                         ],
 202                 ];
 203         }
 204
 205         protected function getExamplesMessages() {
 206                 return [
 207                         'action=query&list=langbacklinks&lbltitle=Test&lbllang=fr'
 208                                 => 'apihelp-query+langbacklinks-example-simple',
 209                         'action=query&generator=langbacklinks&glbltitle=Test&glbllang=fr&prop=info'
 210                                 => 'apihelp-query+langbacklinks-example-generator',
 211                 ];
 212         }
 213
 214         public function getHelpUrls() {
 215                 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Langbacklinks';
 216         }
 217 }