includes/api/ApiQueryIWLinks.php

   1 <?php
   2
   3 /**
   4  * Created on May 14, 2010
   5  *
   6  * API for MediaWiki 1.17+
   7  *
   8  * Copyright © 2010 Sam Reed
   9  * Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License along
  22  * with this program; if not, write to the Free Software Foundation, Inc.,
  23  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  24  * http://www.gnu.org/copyleft/gpl.html
  25  */
  26
  27 if ( !defined( 'MEDIAWIKI' ) ) {
  28         // Eclipse helper - will be ignored in production
  29         require_once( "ApiQueryBase.php" );
  30 }
  31
  32 /**
  33  * A query module to list all interwiki links on a page
  34  *
  35  * @ingroup API
  36  */
  37 class ApiQueryIWLinks extends ApiQueryBase {
  38
  39         public function __construct( $query, $moduleName ) {
  40                 parent::__construct( $query, $moduleName, 'iw' );
  41         }
  42
  43         public function execute() {
  44                 if ( $this->getPageSet()->getGoodTitleCount() == 0 ) {
  45                         return;
  46                 }
  47
  48                 $params = $this->extractRequestParams();
  49                 $this->addFields( array(
  50                         'iwl_from',
  51                         'iwl_prefix',
  52                         'iwl_title'
  53                 ) );
  54
  55                 $this->addTables( 'iwlinks' );
  56                 $this->addWhereFld( 'iwl_from', array_keys( $this->getPageSet()->getGoodTitles() ) );
  57                 if ( !is_null( $params['continue'] ) ) {
  58                         $cont = explode( '|', $params['continue'] );
  59                         if ( count( $cont ) != 3 ) {
  60                                 $this->dieUsage( 'Invalid continue param. You should pass the ' .
  61                                         'original value returned by the previous query', '_badcontinue' );
  62                         }
  63                         $iwlfrom = intval( $cont[0] );
  64                         $iwlprefix = $this->getDB()->strencode( $cont[1] );
  65                         $iwltitle = $this->getDB()->strencode( $this->titleToKey( $cont[2] ) );
  66                         $this->addWhere(
  67                                 "iwl_from > $iwlfrom OR " .
  68                                 "(iwl_from = $iwlfrom AND " .
  69                                 "(iwl_prefix > '$iwlprefix' OR " .
  70                                 "(iwl_prefix = '$iwlprefix' AND " .
  71                                 "iwl_title >= '$iwltitle')))"
  72                         );
  73                 }
  74
  75                 // Don't order by iwl_from if it's constant in the WHERE clause
  76                 if ( count( $this->getPageSet()->getGoodTitles() ) == 1 ) {
  77                         $this->addOption( 'ORDER BY', 'iwl_prefix' );
  78                 } else {
  79                         $this->addOption( 'ORDER BY', 'iwl_from, iwl_prefix' );
  80                 }
  81                 $this->addOption( 'LIMIT', $params['limit'] + 1 );
  82                 $res = $this->select( __METHOD__ );
  83
  84                 $count = 0;
  85                 $db = $this->getDB();
  86                 while ( $row = $db->fetchObject( $res ) ) {
  87                         if ( ++$count > $params['limit'] ) {
  88                                 // We've reached the one extra which shows that
  89                                 // there are additional pages to be had. Stop here...
  90                                 $this->setContinueEnumParameter( 'continue', "{$row->iwl_from}|{$row->iwl_prefix}|{$row->iwl_title}" );
  91                                 break;
  92                         }
  93                         $entry = array( 'prefix' => $row->iwl_prefix );
  94                         ApiResult::setContent( $entry, $row->iwl_title );
  95                         $fit = $this->addPageSubItem( $row->iwl_from, $entry );
  96                         if ( !$fit ) {
  97                                 $this->setContinueEnumParameter( 'continue', "{$row->iwl_from}|{$row->iwl_prefix}|{$row->iwl_title}" );
  98                                 break;
  99                         }
 100                 }
 101                 $db->freeResult( $res );
 102         }
 103
 104         public function getAllowedParams() {
 105                 return array(
 106                         'limit' => array(
 107                                 ApiBase::PARAM_DFLT => 10,
 108                                 ApiBase::PARAM_TYPE => 'limit',
 109                                 ApiBase::PARAM_MIN => 1,
 110                                 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
 111                                 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
 112                         ),
 113                         'continue' => null,
 114                 );
 115         }
 116
 117         public function getParamDescription() {
 118                 return array(
 119                         'limit' => 'How many interwiki links to return',
 120                         'continue' => 'When more results are available, use this to continue',
 121                 );
 122         }
 123
 124         public function getDescription() {
 125                 return 'Returns all interwiki links from the given page(s)';
 126         }
 127
 128         public function getPossibleErrors() {
 129                 return array_merge( parent::getPossibleErrors(), array(
 130                         array( 'code' => '_badcontinue', 'info' => 'Invalid continue param. You should pass the original value returned by the previous query' ),
 131                 ) );
 132         }
 133
 134         protected function getExamples() {
 135                 return array(
 136                         'Get interwiki links from the [[Main Page]]:',
 137                         '  api.php?action=query&prop=iwlinks&titles=Main%20Page',
 138                 );
 139         }
 140
 141         public function getVersion() {
 142                 return __CLASS__ . ': $Id$';
 143         }
 144 }