includes/api/ApiQueryImages.php

   1 <?php
   2
   3 /**
   4  * Created on May 13, 2007
   5  *
   6  * API for MediaWiki 1.8+
   7  *
   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
  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                 if ( $this->getPageSet()->getGoodTitleCount() == 0 ) {
  52                         return; // nothing to do
  53                 }
  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                         }
  69                         $ilfrom = intval( $cont[0] );
  70                         $ilto = $this->getDB()->strencode( $this->titleToKey( $cont[1] ) );
  71                         $this->addWhere(
  72                                 "il_from > $ilfrom OR " .
  73                                 "(il_from = $ilfrom AND " .
  74                                 "il_to >= '$ilto')"
  75                         );
  76                 }
  77
  78                 // Don't order by il_from if it's constant in the WHERE clause
  79                 if ( count( $this->getPageSet()->getGoodTitles() ) == 1 ) {
  80                         $this->addOption( 'ORDER BY', 'il_to' );
  81                 } else {
  82                         $this->addOption( 'ORDER BY', 'il_from, il_to' );
  83                 }
  84                 $this->addOption( 'LIMIT', $params['limit'] + 1 );
  85
  86                 $res = $this->select( __METHOD__ );
  87
  88                 if ( is_null( $resultPageSet ) ) {
  89                         $count = 0;
  90                         foreach ( $res as $row ) {
  91                                 if ( ++$count > $params['limit'] ) {
  92                                         // We've reached the one extra which shows that
  93                                         // there are additional pages to be had. Stop here...
  94                                         $this->setContinueEnumParameter( 'continue', $row->il_from .
  95                                                         '|' . $this->keyToTitle( $row->il_to ) );
  96                                         break;
  97                                 }
  98                                 $vals = array();
  99                                 ApiQueryBase::addTitleInfo( $vals, Title::makeTitle( NS_FILE, $row->il_to ) );
 100                                 $fit = $this->addPageSubItem( $row->il_from, $vals );
 101                                 if ( !$fit ) {
 102                                         $this->setContinueEnumParameter( 'continue', $row->il_from .
 103                                                         '|' . $this->keyToTitle( $row->il_to ) );
 104                                         break;
 105                                 }
 106                         }
 107                 } else {
 108                         $titles = array();
 109                         $count = 0;
 110                         foreach ( $result as $row ) {
 111                                 if ( ++$count > $params['limit'] ) {
 112                                         // We've reached the one extra which shows that
 113                                         // there are additional pages to be had. Stop here...
 114                                         $this->setContinueEnumParameter( 'continue', $row->il_from .
 115                                                         '|' . $this->keyToTitle( $row->il_to ) );
 116                                         break;
 117                                 }
 118                                 $titles[] = Title::makeTitle( NS_FILE, $row->il_to );
 119                         }
 120                         $resultPageSet->populateFromTitles( $titles );
 121                 }
 122         }
 123
 124         public function getCacheMode( $params ) {
 125                 return 'public';
 126         }
 127
 128         public function getAllowedParams() {
 129                 return array(
 130                         'limit' => array(
 131                                 ApiBase::PARAM_DFLT => 10,
 132                                 ApiBase::PARAM_TYPE => 'limit',
 133                                 ApiBase::PARAM_MIN => 1,
 134                                 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
 135                                 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
 136                         ),
 137                         'continue' => null,
 138                 );
 139         }
 140
 141         public function getParamDescription() {
 142                 return array(
 143                         'limit' => 'How many images to return',
 144                         'continue' => 'When more results are available, use this to continue',
 145                 );
 146         }
 147
 148         public function getDescription() {
 149                 return 'Returns all images contained on the given page(s)';
 150         }
 151
 152         public function getPossibleErrors() {
 153                 return array_merge( parent::getPossibleErrors(), array(
 154                         array( 'code' => '_badcontinue', 'info' => 'Invalid continue param. You should pass the original value returned by the previous query' ),
 155                 ) );
 156         }
 157
 158         protected function getExamples() {
 159                 return array(
 160                         'Get a list of images used in the [[Main Page]]:',
 161                         '  api.php?action=query&prop=images&titles=Main%20Page',
 162                         'Get information about all images used in the [[Main Page]]:',
 163                         '  api.php?action=query&generator=images&titles=Main%20Page&prop=info'
 164                 );
 165         }
 166
 167         public function getVersion() {
 168                 return __CLASS__ . ': $Id$';
 169         }
 170 }