includes/api/ApiQueryImages.php

   1 <?php
   2 /**
   3  *
   4  *
   5  * Created on May 13, 2007
   6  *
   7  * Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, write to the Free Software Foundation, Inc.,
  21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  22  * http://www.gnu.org/copyleft/gpl.html
  23  *
  24  * @file
  25  */
  26
  27 if ( !defined( 'MEDIAWIKI' ) ) {
  28         // Eclipse helper - will be ignored in production
  29         require_once( "ApiQueryBase.php" );
  30 }
  31
  32 /**
  33  * This query adds an <images> subelement to all pages with the list of images embedded into those pages.
  34  *
  35  * @ingroup API
  36  */
  37 class ApiQueryImages extends ApiQueryGeneratorBase {
  38
  39         public function __construct( $query, $moduleName ) {
  40                 parent::__construct( $query, $moduleName, 'im' );
  41         }
  42
  43         public function execute() {
  44                 $this->run();
  45         }
  46
  47         public function executeGenerator( $resultPageSet ) {
  48                 $this->run( $resultPageSet );
  49         }
  50
  51         /**
  52          * @param $resultPageSet ApiPageSet
  53          */
  54         private function run( $resultPageSet = null ) {
  55                 if ( $this->getPageSet()->getGoodTitleCount() == 0 ) {
  56                         return; // nothing to do
  57                 }
  58
  59                 $params = $this->extractRequestParams();
  60                 $this->addFields( array(
  61                         'il_from',
  62                         'il_to'
  63                 ) );
  64
  65                 $this->addTables( 'imagelinks' );
  66                 $this->addWhereFld( 'il_from', array_keys( $this->getPageSet()->getGoodTitles() ) );
  67                 if ( !is_null( $params['continue'] ) ) {
  68                         $cont = explode( '|', $params['continue'] );
  69                         if ( count( $cont ) != 2 ) {
  70                                 $this->dieUsage( 'Invalid continue param. You should pass the ' .
  71                                         'original value returned by the previous query', '_badcontinue' );
  72                         }
  73                         $ilfrom = intval( $cont[0] );
  74                         $ilto = $this->getDB()->strencode( $this->titleToKey( $cont[1] ) );
  75                         $this->addWhere(
  76                                 "il_from > $ilfrom OR " .
  77                                 "(il_from = $ilfrom AND " .
  78                                 "il_to >= '$ilto')"
  79                         );
  80                 }
  81
  82                 // Don't order by il_from if it's constant in the WHERE clause
  83                 if ( count( $this->getPageSet()->getGoodTitles() ) == 1 ) {
  84                         $this->addOption( 'ORDER BY', 'il_to' );
  85                 } else {
  86                         $this->addOption( 'ORDER BY', 'il_from, il_to' );
  87                 }
  88                 $this->addOption( 'LIMIT', $params['limit'] + 1 );
  89
  90                 if ( !is_null( $params['images'] ) ) {
  91                         $images = array();
  92                         foreach ( $params['images'] as $img ) {
  93                                 $title = Title::newFromText( $img );
  94                                 if ( !$title || $title->getNamespace() != NS_FILE ) {
  95                                         $this->setWarning( "``$img'' is not a file" );
  96                                 } else {
  97                                         $images[] = $title->getDBkey();
  98                                 }
  99                         }
 100                         $this->addWhereFld( 'il_to', $images );
 101                 }
 102
 103                 $res = $this->select( __METHOD__ );
 104
 105                 if ( is_null( $resultPageSet ) ) {
 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->il_from .
 112                                                         '|' . $this->keyToTitle( $row->il_to ) );
 113                                         break;
 114                                 }
 115                                 $vals = array();
 116                                 ApiQueryBase::addTitleInfo( $vals, Title::makeTitle( NS_FILE, $row->il_to ) );
 117                                 $fit = $this->addPageSubItem( $row->il_from, $vals );
 118                                 if ( !$fit ) {
 119                                         $this->setContinueEnumParameter( 'continue', $row->il_from .
 120                                                         '|' . $this->keyToTitle( $row->il_to ) );
 121                                         break;
 122                                 }
 123                         }
 124                 } else {
 125                         $titles = array();
 126                         $count = 0;
 127                         foreach ( $res as $row ) {
 128                                 if ( ++$count > $params['limit'] ) {
 129                                         // We've reached the one extra which shows that
 130                                         // there are additional pages to be had. Stop here...
 131                                         $this->setContinueEnumParameter( 'continue', $row->il_from .
 132                                                         '|' . $this->keyToTitle( $row->il_to ) );
 133                                         break;
 134                                 }
 135                                 $titles[] = Title::makeTitle( NS_FILE, $row->il_to );
 136                         }
 137                         $resultPageSet->populateFromTitles( $titles );
 138                 }
 139         }
 140
 141         public function getCacheMode( $params ) {
 142                 return 'public';
 143         }
 144
 145         public function getAllowedParams() {
 146                 return array(
 147                         'limit' => array(
 148                                 ApiBase::PARAM_DFLT => 10,
 149                                 ApiBase::PARAM_TYPE => 'limit',
 150                                 ApiBase::PARAM_MIN => 1,
 151                                 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
 152                                 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
 153                         ),
 154                         'continue' => null,
 155                         'images' => array(
 156                                 ApiBase::PARAM_ISMULTI => true,
 157                         )
 158                 );
 159         }
 160
 161         public function getParamDescription() {
 162                 return array(
 163                         'limit' => 'How many images to return',
 164                         'continue' => 'When more results are available, use this to continue',
 165                         'images' => 'Only list these images. Useful for checking whether a certain page has a certain Image.',
 166                 );
 167         }
 168
 169         public function getDescription() {
 170                 return 'Returns all images contained on the given page(s)';
 171         }
 172
 173         public function getPossibleErrors() {
 174                 return array_merge( parent::getPossibleErrors(), array(
 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 a list of images used in the [[Main Page]]:',
 182                         '  api.php?action=query&prop=images&titles=Main%20Page',
 183                         'Get information about all images used in the [[Main Page]]:',
 184                         '  api.php?action=query&generator=images&titles=Main%20Page&prop=info'
 185                 );
 186         }
 187
 188         public function getHelpUrls() {
 189                 return 'http://www.mediawiki.org/wiki/API:Properties#images_.2F_im';
 190         }
 191
 192         public function getVersion() {
 193                 return __CLASS__ . ': $Id$';
 194         }
 195 }