includes/api/ApiQueryIWBacklinks.php

   1 <?php
   2 /**
   3  * API for MediaWiki 1.17+
   4  *
   5  * Copyright © 2010 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 ApiQueryIWBacklinks extends ApiQueryGeneratorBase {
  31
  32         public function __construct( ApiQuery $query, $moduleName ) {
  33                 parent::__construct( $query, $moduleName, 'iwbl' );
  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['prefix'] ) ) {
  52                         $this->dieWithError(
  53                                 [
  54                                         'apierror-invalidparammix-mustusewith',
  55                                         $this->encodeParamName( 'title' ),
  56                                         $this->encodeParamName( 'prefix' ),
  57                                 ],
  58                                 'invalidparammix'
  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                                 "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)))"
  77                         );
  78                 }
  79
  80                 $prop = array_flip( $params['prop'] );
  81                 $iwprefix = isset( $prop['iwprefix'] );
  82                 $iwtitle = isset( $prop['iwtitle'] );
  83
  84                 $this->addTables( [ 'iwlinks', 'page' ] );
  85                 $this->addWhere( 'iwl_from = page_id' );
  86
  87                 $this->addFields( [ 'page_id', 'page_title', 'page_namespace', 'page_is_redirect',
  88                         'iwl_from', 'iwl_prefix', 'iwl_title' ] );
  89
  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 );
  96                         } else {
  97                                 $this->addOption( 'ORDER BY', [
  98                                         'iwl_title' . $sort,
  99                                         'iwl_from' . $sort
 100                                 ] );
 101                         }
 102                 } else {
 103                         $this->addOption( 'ORDER BY', [
 104                                 'iwl_prefix' . $sort,
 105                                 'iwl_title' . $sort,
 106                                 'iwl_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...
 122                                 // Continue string preserved in case the redirect query doesn't
 123                                 // pass the limit
 124                                 $this->setContinueEnumParameter(
 125                                         'continue',
 126                                         "{$row->iwl_prefix}|{$row->iwl_title}|{$row->iwl_from}"
 127                                 );
 128                                 break;
 129                         }
 130
 131                         if ( !is_null( $resultPageSet ) ) {
 132                                 $pages[] = Title::newFromRow( $row );
 133                         } else {
 134                                 $entry = [ 'pageid' => (int)$row->page_id ];
 135
 136                                 $title = Title::makeTitle( $row->page_namespace, $row->page_title );
 137                                 ApiQueryBase::addTitleInfo( $entry, $title );
 138
 139                                 if ( $row->page_is_redirect ) {
 140                                         $entry['redirect'] = true;
 141                                 }
 142
 143                                 if ( $iwprefix ) {
 144                                         $entry['iwprefix'] = $row->iwl_prefix;
 145                                 }
 146
 147                                 if ( $iwtitle ) {
 148                                         $entry['iwtitle'] = $row->iwl_title;
 149                                 }
 150
 151                                 $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $entry );
 152                                 if ( !$fit ) {
 153                                         $this->setContinueEnumParameter(
 154                                                 'continue',
 155                                                 "{$row->iwl_prefix}|{$row->iwl_title}|{$row->iwl_from}"
 156                                         );
 157                                         break;
 158                                 }
 159                         }
 160                 }
 161
 162                 if ( is_null( $resultPageSet ) ) {
 163                         $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'iw' );
 164                 } else {
 165                         $resultPageSet->populateFromTitles( $pages );
 166                 }
 167         }
 168
 169         public function getCacheMode( $params ) {
 170                 return 'public';
 171         }
 172
 173         public function getAllowedParams() {
 174                 return [
 175                         'prefix' => null,
 176                         'title' => null,
 177                         'continue' => [
 178                                 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
 179                         ],
 180                         'limit' => [
 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
 186                         ],
 187                         'prop' => [
 188                                 ApiBase::PARAM_ISMULTI => true,
 189                                 ApiBase::PARAM_DFLT => '',
 190                                 ApiBase::PARAM_TYPE => [
 191                                         'iwprefix',
 192                                         'iwtitle',
 193                                 ],
 194                                 ApiBase::PARAM_HELP_MSG_PER_VALUE => [],
 195                         ],
 196                         'dir' => [
 197                                 ApiBase::PARAM_DFLT => 'ascending',
 198                                 ApiBase::PARAM_TYPE => [
 199                                         'ascending',
 200                                         'descending'
 201                                 ]
 202                         ],
 203                 ];
 204         }
 205
 206         protected function getExamplesMessages() {
 207                 return [
 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',
 212                 ];
 213         }
 214
 215         public function getHelpUrls() {
 216                 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Iwbacklinks';
 217         }
 218 }