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
  46                 if ( isset( $params['title'] ) && !isset( $params['prefix'] ) ) {
  47                         $this->dieUsageMsg( array( 'missingparam', 'prefix' ) );
  48                 }
  49
  50                 $this->addFields( array(
  51                         'iwl_from',
  52                         'iwl_prefix',
  53                         'iwl_title'
  54                 ) );
  55
  56                 $this->addTables( 'iwlinks' );
  57                 $this->addWhereFld( 'iwl_from', array_keys( $this->getPageSet()->getGoodTitles() ) );
  58
  59                 if ( !is_null( $params['continue'] ) ) {
  60                         $cont = explode( '|', $params['continue'] );
  61                         $this->dieContinueUsageIf( count( $cont ) != 3 );
  62                         $op = $params['dir'] == 'descending' ? '<' : '>';
  63                         $db = $this->getDB();
  64                         $iwlfrom = intval( $cont[0] );
  65                         $iwlprefix = $db->addQuotes( $cont[1] );
  66                         $iwltitle = $db->addQuotes( $cont[2] );
  67                         $this->addWhere(
  68                                 "iwl_from $op $iwlfrom OR " .
  69                                 "(iwl_from = $iwlfrom AND " .
  70                                 "(iwl_prefix $op $iwlprefix OR " .
  71                                 "(iwl_prefix = $iwlprefix AND " .
  72                                 "iwl_title $op= $iwltitle)))"
  73                         );
  74                 }
  75
  76                 $sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
  77                 if ( isset( $params['prefix'] ) ) {
  78                         $this->addWhereFld( 'iwl_prefix', $params['prefix'] );
  79                         if ( isset( $params['title'] ) ) {
  80                                 $this->addWhereFld( 'iwl_title', $params['title'] );
  81                                 $this->addOption( 'ORDER BY', 'iwl_from' . $sort );
  82                         } else {
  83                                 $this->addOption( 'ORDER BY', array(
  84                                         'iwl_from' . $sort,
  85                                         'iwl_title' . $sort
  86                                 ) );
  87                         }
  88                 } else {
  89                         // Don't order by iwl_from if it's constant in the WHERE clause
  90                         if ( count( $this->getPageSet()->getGoodTitles() ) == 1 ) {
  91                                 $this->addOption( 'ORDER BY', 'iwl_prefix' . $sort );
  92                         } else {
  93                                 $this->addOption( 'ORDER BY', array(
  94                                         'iwl_from' . $sort,
  95                                         'iwl_prefix' . $sort,
  96                                         'iwl_title' . $sort
  97                                 ) );
  98                         }
  99                 }
 100
 101                 $this->addOption( 'LIMIT', $params['limit'] + 1 );
 102                 $res = $this->select( __METHOD__ );
 103
 104                 $count = 0;
 105                 foreach ( $res as $row ) {
 106                         if ( ++$count > $params['limit'] ) {
 107                                 // We've reached the one extra which shows that
 108                                 // there are additional pages to be had. Stop here...
 109                                 $this->setContinueEnumParameter(
 110                                         'continue',
 111                                         "{$row->iwl_from}|{$row->iwl_prefix}|{$row->iwl_title}"
 112                                 );
 113                                 break;
 114                         }
 115                         $entry = array( 'prefix' => $row->iwl_prefix );
 116
 117                         if ( $params['url'] ) {
 118                                 $title = Title::newFromText( "{$row->iwl_prefix}:{$row->iwl_title}" );
 119                                 if ( $title ) {
 120                                         $entry['url'] = wfExpandUrl( $title->getFullURL(), PROTO_CURRENT );
 121                                 }
 122                         }
 123
 124                         ApiResult::setContent( $entry, $row->iwl_title );
 125                         $fit = $this->addPageSubItem( $row->iwl_from, $entry );
 126                         if ( !$fit ) {
 127                                 $this->setContinueEnumParameter(
 128                                         'continue',
 129                                         "{$row->iwl_from}|{$row->iwl_prefix}|{$row->iwl_title}"
 130                                 );
 131                                 break;
 132                         }
 133                 }
 134         }
 135
 136         public function getCacheMode( $params ) {
 137                 return 'public';
 138         }
 139
 140         public function getAllowedParams() {
 141                 return array(
 142                         'url' => false,
 143                         'limit' => array(
 144                                 ApiBase::PARAM_DFLT => 10,
 145                                 ApiBase::PARAM_TYPE => 'limit',
 146                                 ApiBase::PARAM_MIN => 1,
 147                                 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
 148                                 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
 149                         ),
 150                         'continue' => null,
 151                         'prefix' => null,
 152                         'title' => null,
 153                         'dir' => array(
 154                                 ApiBase::PARAM_DFLT => 'ascending',
 155                                 ApiBase::PARAM_TYPE => array(
 156                                         'ascending',
 157                                         'descending'
 158                                 )
 159                         ),
 160                 );
 161         }
 162
 163         public function getParamDescription() {
 164                 return array(
 165                         'url' => 'Whether to get the full URL',
 166                         'limit' => 'How many interwiki links to return',
 167                         'continue' => 'When more results are available, use this to continue',
 168                         'prefix' => 'Prefix for the interwiki',
 169                         'title' => "Interwiki link to search for. Must be used with {$this->getModulePrefix()}prefix",
 170                         'dir' => 'The direction in which to list',
 171                 );
 172         }
 173
 174         public function getResultProperties() {
 175                 return array(
 176                         '' => array(
 177                                 'prefix' => 'string',
 178                                 'url' => array(
 179                                         ApiBase::PROP_TYPE => 'string',
 180                                         ApiBase::PROP_NULLABLE => true
 181                                 ),
 182                                 '*' => 'string'
 183                         )
 184                 );
 185         }
 186
 187         public function getDescription() {
 188                 return 'Returns all interwiki links from the given page(s).';
 189         }
 190
 191         public function getPossibleErrors() {
 192                 return array_merge( parent::getPossibleErrors(), array(
 193                         array( 'missingparam', 'prefix' ),
 194                 ) );
 195         }
 196
 197         public function getExamples() {
 198                 return array(
 199                         'api.php?action=query&prop=iwlinks&titles=Main%20Page'
 200                                 => 'Get interwiki links from the [[Main Page]]',
 201                 );
 202         }
 203
 204         public function getHelpUrls() {
 205                 return 'https://www.mediawiki.org/wiki/API:Iwlinks';
 206         }
 207 }