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