4 * Created on May 13, 2007
6 * API for MediaWiki 1.8+
8 * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
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.
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.
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
26 if ( !defined( 'MEDIAWIKI' ) ) {
27 // Eclipse helper - will be ignored in production
28 require_once ( "ApiQueryBase.php" );
32 * This query adds an <images> subelement to all pages with the list of images embedded into those pages.
36 class ApiQueryImages extends ApiQueryGeneratorBase {
38 public function __construct( $query, $moduleName ) {
39 parent :: __construct( $query, $moduleName, 'im' );
42 public function execute() {
46 public function executeGenerator( $resultPageSet ) {
47 $this->run( $resultPageSet );
50 private function run( $resultPageSet = null ) {
52 if ( $this->getPageSet()->getGoodTitleCount() == 0 )
53 return; // nothing to do
55 $params = $this->extractRequestParams();
56 $this->addFields( array (
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')" );
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' );
79 $this->addOption( 'ORDER BY', 'il_from, il_to' );
80 $this->addOption( 'LIMIT', $params['limit'] + 1 );
83 $res = $this->select( __METHOD__ );
85 if ( is_null( $resultPageSet ) ) {
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 ) );
96 ApiQueryBase :: addTitleInfo( $vals, Title :: makeTitle( NS_FILE, $row->il_to ) );
97 $fit = $this->addPageSubItem( $row->il_from, $vals );
100 $this->setContinueEnumParameter( 'continue', $row->il_from .
101 '|' . $this->keyToTitle( $row->il_to ) );
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 ) );
117 $titles[] = Title :: makeTitle( NS_FILE, $row->il_to );
119 $resultPageSet->populateFromTitles( $titles );
122 $db->freeResult( $res );
125 public function getCacheMode( $params ) {
129 public function getAllowedParams() {
132 ApiBase :: PARAM_DFLT => 10,
133 ApiBase :: PARAM_TYPE => 'limit',
134 ApiBase :: PARAM_MIN => 1,
135 ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
136 ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
142 public function getParamDescription () {
144 'limit' => 'How many images to return',
145 'continue' => 'When more results are available, use this to continue',
149 public function getDescription() {
150 return 'Returns all images contained on the given page(s)';
153 public function getPossibleErrors() {
154 return array_merge( parent::getPossibleErrors(), array(
155 array( 'code' => '_badcontinue', 'info' => 'Invalid continue param. You should pass the original value returned by the previous query' ),
159 protected function getExamples() {
161 "Get a list of images used in the [[Main Page]]:",
162 " api.php?action=query&prop=images&titles=Main%20Page",
163 "Get information about all images used in the [[Main Page]]:",
164 " api.php?action=query&generator=images&titles=Main%20Page&prop=info"
168 public function getVersion() {
169 return __CLASS__ . ': $Id: ApiQueryImages.php 69932 2010-07-26 08:03:21Z tstarling $';