includes/api/ApiQueryImages.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  * This query adds an <images> subelement to all pages with the list of images embedded into those pages.
  33  *
  34  * @ingroup API
  35  */
  36 class ApiQueryImages extends ApiQueryGeneratorBase {
  37
  38         public function __construct( $query, $moduleName ) {
  39                 parent :: __construct( $query, $moduleName, 'im' );
  40         }
  41
  42         public function execute() {
  43                 $this->run();
  44         }
  45
  46         public function executeGenerator( $resultPageSet ) {
  47                 $this->run( $resultPageSet );
  48         }
  49
  50         private function run( $resultPageSet = null ) {
  51
  52                 if ( $this->getPageSet()->getGoodTitleCount() == 0 )
  53                         return; // nothing to do
  54
  55                 $params = $this->extractRequestParams();
  56                 $this->addFields( array (
  57                         'il_from',
  58                         'il_to'
  59                 ) );
  60
  61                 $this->addTables( 'imagelinks' );
  62                 $this->addWhereFld( 'il_from', array_keys( $this->getPageSet()->getGoodTitles() ) );
  63                 if ( !is_null( $params['continue'] ) ) {
  64                         $cont = explode( '|', $params['continue'] );
  65                         if ( count( $cont ) != 2 )
  66                                 $this->dieUsage( "Invalid continue param. You should pass the " .
  67                                         "original value returned by the previous query", "_badcontinue" );
  68                         $ilfrom = intval( $cont[0] );
  69                         $ilto = $this->getDB()->strencode( $this->titleToKey( $cont[1] ) );
  70                         $this->addWhere( "il_from > $ilfrom OR " .
  71                                         "(il_from = $ilfrom AND " .
  72                                         "il_to >= '$ilto')" );
  73                 }
  74
  75                 // Don't order by il_from if it's constant in the WHERE clause
  76                 if ( count( $this->getPageSet()->getGoodTitles() ) == 1 )
  77                         $this->addOption( 'ORDER BY', 'il_to' );
  78                 else
  79                         $this->addOption( 'ORDER BY', 'il_from, il_to' );
  80                 $this->addOption( 'LIMIT', $params['limit'] + 1 );
  81
  82                 $db = $this->getDB();
  83                 $res = $this->select( __METHOD__ );
  84
  85                 if ( is_null( $resultPageSet ) ) {
  86                         $count = 0;
  87                         while ( $row = $db->fetchObject( $res ) ) {
  88                                 if ( ++$count > $params['limit'] ) {
  89                                         // We've reached the one extra which shows that
  90                                         // there are additional pages to be had. Stop here...
  91                                         $this->setContinueEnumParameter( 'continue', $row->il_from .
  92                                                         '|' . $this->keyToTitle( $row->il_to ) );
  93                                         break;
  94                                 }
  95                                 $vals = array();
  96                                 ApiQueryBase :: addTitleInfo( $vals, Title :: makeTitle( NS_FILE, $row->il_to ) );
  97                                 $fit = $this->addPageSubItem( $row->il_from, $vals );
  98                                 if ( !$fit )
  99                                 {
 100                                         $this->setContinueEnumParameter( 'continue', $row->il_from .
 101                                                         '|' . $this->keyToTitle( $row->il_to ) );
 102                                         break;
 103                                 }
 104                         }
 105                 } else {
 106
 107                         $titles = array();
 108                         $count = 0;
 109                         while ( $row = $db->fetchObject( $res ) ) {
 110                                 if ( ++$count > $params['limit'] ) {
 111                                         // We've reached the one extra which shows that
 112                                         // there are additional pages to be had. Stop here...
 113                                         $this->setContinueEnumParameter( 'continue', $row->il_from .
 114                                                         '|' . $this->keyToTitle( $row->il_to ) );
 115                                         break;
 116                                 }
 117                                 $titles[] = Title :: makeTitle( NS_FILE, $row->il_to );
 118                         }
 119                         $resultPageSet->populateFromTitles( $titles );
 120                 }
 121
 122                 $db->freeResult( $res );
 123         }
 124
 125         public function getAllowedParams() {
 126                 return array(
 127                                 'limit' => array(
 128                                         ApiBase :: PARAM_DFLT => 10,
 129                                         ApiBase :: PARAM_TYPE => 'limit',
 130                                         ApiBase :: PARAM_MIN => 1,
 131                                         ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
 132                                         ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
 133                                 ),
 134                                 'continue' => null,
 135                 );
 136         }
 137
 138         public function getParamDescription () {
 139                 return array(
 140                         'limit' => 'How many images to return',
 141                         'continue' => 'When more results are available, use this to continue',
 142                 );
 143         }
 144
 145         public function getDescription() {
 146                 return 'Returns all images contained on the given page(s)';
 147         }
 148
 149         public function getPossibleErrors() {
 150                 return array_merge( parent::getPossibleErrors(), array(
 151                         array( 'code' => '_badcontinue', 'info' => 'Invalid continue param. You should pass the original value returned by the previous query' ),
 152                 ) );
 153         }
 154
 155         protected function getExamples() {
 156                 return array (
 157                                 "Get a list of images used in the [[Main Page]]:",
 158                                 "  api.php?action=query&prop=images&titles=Main%20Page",
 159                                 "Get information about all images used in the [[Main Page]]:",
 160                                 "  api.php?action=query&generator=images&titles=Main%20Page&prop=info"
 161                         );
 162         }
 163
 164         public function getVersion() {
 165                 return __CLASS__ . ': $Id$';
 166         }
 167 }