includes/api/ApiQueryLangLinks.php

   1 <?php
   2
   3 /*
   4  * Created on May 13, 2007
   5  *
   6  * API for MediaWiki 1.8+
   7  *
   8  * Copyright (C) 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  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  23  * http://www.gnu.org/copyleft/gpl.html
  24  */
  25
  26 if ( !defined( 'MEDIAWIKI' ) ) {
  27         // Eclipse helper - will be ignored in production
  28         require_once ( "ApiQueryBase.php" );
  29 }
  30
  31 /**
  32  * A query module to list all langlinks (links to correspanding foreign language pages).
  33  *
  34  * @ingroup API
  35  */
  36 class ApiQueryLangLinks extends ApiQueryBase {
  37
  38         public function __construct( $query, $moduleName ) {
  39                 parent :: __construct( $query, $moduleName, 'll' );
  40         }
  41
  42         public function execute() {
  43                 if ( $this->getPageSet()->getGoodTitleCount() == 0 )
  44                         return;
  45
  46                 $params = $this->extractRequestParams();
  47                 $this->addFields( array (
  48                         'll_from',
  49                         'll_lang',
  50                         'll_title'
  51                 ) );
  52
  53                 $this->addTables( 'langlinks' );
  54                 $this->addWhereFld( 'll_from', array_keys( $this->getPageSet()->getGoodTitles() ) );
  55                 if ( !is_null( $params['continue'] ) ) {
  56                         $cont = explode( '|', $params['continue'] );
  57                         if ( count( $cont ) != 2 )
  58                                 $this->dieUsage( "Invalid continue param. You should pass the " .
  59                                         "original value returned by the previous query", "_badcontinue" );
  60                         $llfrom = intval( $cont[0] );
  61                         $lllang = $this->getDB()->strencode( $cont[1] );
  62                         $this->addWhere( "ll_from > $llfrom OR " .
  63                                         "(ll_from = $llfrom AND " .
  64                                         "ll_lang >= '$lllang')" );
  65                 }
  66
  67                 // Don't order by ll_from if it's constant in the WHERE clause
  68                 if ( count( $this->getPageSet()->getGoodTitles() ) == 1 )
  69                         $this->addOption( 'ORDER BY', 'll_lang' );
  70                 else
  71                         $this->addOption( 'ORDER BY', 'll_from, ll_lang' );
  72                 $this->addOption( 'LIMIT', $params['limit'] + 1 );
  73                 $res = $this->select( __METHOD__ );
  74
  75                 $count = 0;
  76                 $db = $this->getDB();
  77                 while ( $row = $db->fetchObject( $res ) ) {
  78                         if ( ++$count > $params['limit'] ) {
  79                                 // We've reached the one extra which shows that
  80                                 // there are additional pages to be had. Stop here...
  81                                 $this->setContinueEnumParameter( 'continue', "{$row->ll_from}|{$row->ll_lang}" );
  82                                 break;
  83                         }
  84                         $entry = array( 'lang' => $row->ll_lang );
  85                         ApiResult :: setContent( $entry, $row->ll_title );
  86                         $fit = $this->addPageSubItem( $row->ll_from, $entry );
  87                         if ( !$fit )
  88                         {
  89                                 $this->setContinueEnumParameter( 'continue', "{$row->ll_from}|{$row->ll_lang}" );
  90                                 break;
  91                         }
  92                 }
  93                 $db->freeResult( $res );
  94         }
  95
  96         public function getCacheMode( $params ) {
  97                 return 'public';
  98         }
  99
 100         public function getAllowedParams() {
 101                 return array(
 102                                 'limit' => array(
 103                                         ApiBase :: PARAM_DFLT => 10,
 104                                         ApiBase :: PARAM_TYPE => 'limit',
 105                                         ApiBase :: PARAM_MIN => 1,
 106                                         ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
 107                                         ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
 108                                 ),
 109                                 'continue' => null,
 110                 );
 111         }
 112
 113         public function getParamDescription () {
 114                 return array(
 115                         'limit' => 'How many langlinks to return',
 116                         'continue' => 'When more results are available, use this to continue',
 117                 );
 118         }
 119
 120         public function getDescription() {
 121                 return 'Returns all interlanguage links from the given page(s)';
 122         }
 123
 124         public function getPossibleErrors() {
 125                 return array_merge( parent::getPossibleErrors(), array(
 126                         array( 'code' => '_badcontinue', 'info' => 'Invalid continue param. You should pass the original value returned by the previous query' ),
 127                 ) );
 128         }
 129
 130         protected function getExamples() {
 131                 return array (
 132                                 "Get interlanguage links from the [[Main Page]]:",
 133                                 "  api.php?action=query&prop=langlinks&titles=Main%20Page&redirects",
 134                         );
 135         }
 136
 137         public function getVersion() {
 138                 return __CLASS__ . ': $Id: ApiQueryLangLinks.php 69932 2010-07-26 08:03:21Z tstarling $';
 139         }
 140 }