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