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