5 * Created on May 13, 2007
7 * Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
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.
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.
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
27 if ( !defined( 'MEDIAWIKI' ) ) {
28 // Eclipse helper - will be ignored in production
29 require_once( "ApiQueryBase.php" );
33 * This query adds an <images> subelement to all pages with the list of images embedded into those pages.
37 class ApiQueryImages
extends ApiQueryGeneratorBase
{
39 public function __construct( $query, $moduleName ) {
40 parent
::__construct( $query, $moduleName, 'im' );
43 public function execute() {
47 public function executeGenerator( $resultPageSet ) {
48 $this->run( $resultPageSet );
52 * @param $resultPageSet ApiPageSet
54 private function run( $resultPageSet = null ) {
55 if ( $this->getPageSet()->getGoodTitleCount() == 0 ) {
56 return; // nothing to do
59 $params = $this->extractRequestParams();
60 $this->addFields( array(
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' );
73 $ilfrom = intval( $cont[0] );
74 $ilto = $this->getDB()->strencode( $this->titleToKey( $cont[1] ) );
76 "il_from > $ilfrom OR " .
77 "(il_from = $ilfrom AND " .
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' );
86 $this->addOption( 'ORDER BY', 'il_from, il_to' );
88 $this->addOption( 'LIMIT', $params['limit'] +
1 );
90 if ( !is_null( $params['images'] ) ) {
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" );
97 $images[] = $title->getDBkey();
100 $this->addWhereFld( 'il_to', $images );
103 $res = $this->select( __METHOD__
);
105 if ( is_null( $resultPageSet ) ) {
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
) );
116 ApiQueryBase
::addTitleInfo( $vals, Title
::makeTitle( NS_FILE
, $row->il_to
) );
117 $fit = $this->addPageSubItem( $row->il_from
, $vals );
119 $this->setContinueEnumParameter( 'continue', $row->il_from
.
120 '|' . $this->keyToTitle( $row->il_to
) );
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
) );
135 $titles[] = Title
::makeTitle( NS_FILE
, $row->il_to
);
137 $resultPageSet->populateFromTitles( $titles );
141 public function getCacheMode( $params ) {
145 public function getAllowedParams() {
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
156 ApiBase
::PARAM_ISMULTI
=> true,
161 public function getParamDescription() {
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.',
169 public function getDescription() {
170 return 'Returns all images contained on the given page(s)';
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' ),
179 protected function getExamples() {
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'
188 public function getVersion() {
189 return __CLASS__
. ': $Id$';