includes/api/ApiQueryIWLinks.php

   1 <?php
   2 /**
   3  * API for MediaWiki 1.17+
   4  *
   5  * Created on May 14, 2010
   6  *
   7  * Copyright © 2010 Sam Reed
   8  * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
   9  *
  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.
  14  *
  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.
  19  *
  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
  24  *
  25  * @file
  26  */
  27
  28 /**
  29  * A query module to list all interwiki links on a page
  30  *
  31  * @ingroup API
  32  */
  33 class ApiQueryIWLinks extends ApiQueryBase {
  34
  35         public function __construct( ApiQuery $query, $moduleName ) {
  36                 parent::__construct( $query, $moduleName, 'iw' );
  37         }
  38
  39         public function execute() {
  40                 if ( $this->getPageSet()->getGoodTitleCount() == 0 ) {
  41                         return;
  42                 }
  43
  44                 $params = $this->extractRequestParams();
  45                 $prop = array_flip( (array)$params['prop'] );
  46
  47                 if ( isset( $params['title'] ) && !isset( $params['prefix'] ) ) {
  48                         $this->dieUsageMsg( [ 'missingparam', 'prefix' ] );
  49                 }
  50
  51                 // Handle deprecated param
  52                 $this->requireMaxOneParameter( $params, 'url', 'prop' );
  53                 if ( $params['url'] ) {
  54                         $prop = [ 'url' => 1 ];
  55                 }
  56
  57                 $this->addFields( [
  58                         'iwl_from',
  59                         'iwl_prefix',
  60                         'iwl_title'
  61                 ] );
  62
  63                 $this->addTables( 'iwlinks' );
  64                 $this->addWhereFld( 'iwl_from', array_keys( $this->getPageSet()->getGoodTitles() ) );
  65
  66                 if ( !is_null( $params['continue'] ) ) {
  67                         $cont = explode( '|', $params['continue'] );
  68                         $this->dieContinueUsageIf( count( $cont ) != 3 );
  69                         $op = $params['dir'] == 'descending' ? '<' : '>';
  70                         $db = $this->getDB();
  71                         $iwlfrom = intval( $cont[0] );
  72                         $iwlprefix = $db->addQuotes( $cont[1] );
  73                         $iwltitle = $db->addQuotes( $cont[2] );
  74                         $this->addWhere(
  75                                 "iwl_from $op $iwlfrom OR " .
  76                                 "(iwl_from = $iwlfrom AND " .
  77                                 "(iwl_prefix $op $iwlprefix OR " .
  78                                 "(iwl_prefix = $iwlprefix AND " .
  79                                 "iwl_title $op= $iwltitle)))"
  80                         );
  81                 }
  82
  83                 $sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
  84                 if ( isset( $params['prefix'] ) ) {
  85                         $this->addWhereFld( 'iwl_prefix', $params['prefix'] );
  86                         if ( isset( $params['title'] ) ) {
  87                                 $this->addWhereFld( 'iwl_title', $params['title'] );
  88                                 $this->addOption( 'ORDER BY', 'iwl_from' . $sort );
  89                         } else {
  90                                 $this->addOption( 'ORDER BY', [
  91                                         'iwl_from' . $sort,
  92                                         'iwl_title' . $sort
  93                                 ] );
  94                         }
  95                 } else {
  96                         // Don't order by iwl_from if it's constant in the WHERE clause
  97                         if ( count( $this->getPageSet()->getGoodTitles() ) == 1 ) {
  98                                 $this->addOption( 'ORDER BY', 'iwl_prefix' . $sort );
  99                         } else {
 100                                 $this->addOption( 'ORDER BY', [
 101                                         'iwl_from' . $sort,
 102                                         'iwl_prefix' . $sort,
 103                                         'iwl_title' . $sort
 104                                 ] );
 105                         }
 106                 }
 107
 108                 $this->addOption( 'LIMIT', $params['limit'] + 1 );
 109                 $res = $this->select( __METHOD__ );
 110
 111                 $count = 0;
 112                 foreach ( $res as $row ) {
 113                         if ( ++$count > $params['limit'] ) {
 114                                 // We've reached the one extra which shows that
 115                                 // there are additional pages to be had. Stop here...
 116                                 $this->setContinueEnumParameter(
 117                                         'continue',
 118                                         "{$row->iwl_from}|{$row->iwl_prefix}|{$row->iwl_title}"
 119                                 );
 120                                 break;
 121                         }
 122                         $entry = [ 'prefix' => $row->iwl_prefix ];
 123
 124                         if ( isset( $prop['url'] ) ) {
 125                                 $title = Title::newFromText( "{$row->iwl_prefix}:{$row->iwl_title}" );
 126                                 if ( $title ) {
 127                                         $entry['url'] = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT );
 128                                 }
 129                         }
 130
 131                         ApiResult::setContentValue( $entry, 'title', $row->iwl_title );
 132                         $fit = $this->addPageSubItem( $row->iwl_from, $entry );
 133                         if ( !$fit ) {
 134                                 $this->setContinueEnumParameter(
 135                                         'continue',
 136                                         "{$row->iwl_from}|{$row->iwl_prefix}|{$row->iwl_title}"
 137                                 );
 138                                 break;
 139                         }
 140                 }
 141         }
 142
 143         public function getCacheMode( $params ) {
 144                 return 'public';
 145         }
 146
 147         public function getAllowedParams() {
 148                 return [
 149                         'prop' => [
 150                                 ApiBase::PARAM_ISMULTI => true,
 151                                 ApiBase::PARAM_TYPE => [
 152                                         'url',
 153                                 ],
 154                                 ApiBase::PARAM_HELP_MSG_PER_VALUE => [],
 155                         ],
 156                         'prefix' => null,
 157                         'title' => null,
 158                         'dir' => [
 159                                 ApiBase::PARAM_DFLT => 'ascending',
 160                                 ApiBase::PARAM_TYPE => [
 161                                         'ascending',
 162                                         'descending'
 163                                 ]
 164                         ],
 165                         'limit' => [
 166                                 ApiBase::PARAM_DFLT => 10,
 167                                 ApiBase::PARAM_TYPE => 'limit',
 168                                 ApiBase::PARAM_MIN => 1,
 169                                 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
 170                                 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
 171                         ],
 172                         'continue' => [
 173                                 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
 174                         ],
 175                         'url' => [
 176                                 ApiBase::PARAM_DFLT => false,
 177                                 ApiBase::PARAM_DEPRECATED => true,
 178                         ],
 179                 ];
 180         }
 181
 182         protected function getExamplesMessages() {
 183                 return [
 184                         'action=query&prop=iwlinks&titles=Main%20Page'
 185                                 => 'apihelp-query+iwlinks-example-simple',
 186                 ];
 187         }
 188
 189         public function getHelpUrls() {
 190                 return 'https://www.mediawiki.org/wiki/API:Iwlinks';
 191         }
 192 }