3 * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
24 * This query adds an "<images>" subelement to all pages with the list of
25 * images embedded into those pages.
29 class ApiQueryImages
extends ApiQueryGeneratorBase
{
31 public function __construct( ApiQuery
$query, $moduleName ) {
32 parent
::__construct( $query, $moduleName, 'im' );
35 public function execute() {
39 public function executeGenerator( $resultPageSet ) {
40 $this->run( $resultPageSet );
44 * @param ApiPageSet $resultPageSet
46 private function run( $resultPageSet = null ) {
47 if ( $this->getPageSet()->getGoodTitleCount() == 0 ) {
48 return; // nothing to do
51 $params = $this->extractRequestParams();
57 $this->addTables( 'imagelinks' );
58 $this->addWhereFld( 'il_from', array_keys( $this->getPageSet()->getGoodTitles() ) );
59 if ( !is_null( $params['continue'] ) ) {
60 $cont = explode( '|', $params['continue'] );
61 $this->dieContinueUsageIf( count( $cont ) != 2 );
62 $op = $params['dir'] == 'descending' ?
'<' : '>';
63 $ilfrom = intval( $cont[0] );
64 $ilto = $this->getDB()->addQuotes( $cont[1] );
66 "il_from $op $ilfrom OR " .
67 "(il_from = $ilfrom AND " .
72 $sort = ( $params['dir'] == 'descending' ?
' DESC' : '' );
73 // Don't order by il_from if it's constant in the WHERE clause
74 if ( count( $this->getPageSet()->getGoodTitles() ) == 1 ) {
75 $this->addOption( 'ORDER BY', 'il_to' . $sort );
77 $this->addOption( 'ORDER BY', [
82 $this->addOption( 'LIMIT', $params['limit'] +
1 );
84 if ( $params['images'] ) {
86 foreach ( $params['images'] as $img ) {
87 $title = Title
::newFromText( $img );
88 if ( !$title ||
$title->getNamespace() != NS_FILE
) {
89 $this->addWarning( [ 'apiwarn-notfile', wfEscapeWikiText( $img ) ] );
91 $images[] = $title->getDBkey();
95 // No titles so no results
98 $this->addWhereFld( 'il_to', $images );
101 $res = $this->select( __METHOD__
);
103 if ( is_null( $resultPageSet ) ) {
105 foreach ( $res as $row ) {
106 if ( ++
$count > $params['limit'] ) {
107 // We've reached the one extra which shows that
108 // there are additional pages to be had. Stop here...
109 $this->setContinueEnumParameter( 'continue', $row->il_from
. '|' . $row->il_to
);
113 ApiQueryBase
::addTitleInfo( $vals, Title
::makeTitle( NS_FILE
, $row->il_to
) );
114 $fit = $this->addPageSubItem( $row->il_from
, $vals );
116 $this->setContinueEnumParameter( 'continue', $row->il_from
. '|' . $row->il_to
);
123 foreach ( $res as $row ) {
124 if ( ++
$count > $params['limit'] ) {
125 // We've reached the one extra which shows that
126 // there are additional pages to be had. Stop here...
127 $this->setContinueEnumParameter( 'continue', $row->il_from
. '|' . $row->il_to
);
130 $titles[] = Title
::makeTitle( NS_FILE
, $row->il_to
);
132 $resultPageSet->populateFromTitles( $titles );
136 public function getCacheMode( $params ) {
140 public function getAllowedParams() {
143 ApiBase
::PARAM_DFLT
=> 10,
144 ApiBase
::PARAM_TYPE
=> 'limit',
145 ApiBase
::PARAM_MIN
=> 1,
146 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
147 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
150 ApiBase
::PARAM_HELP_MSG
=> 'api-help-param-continue',
153 ApiBase
::PARAM_ISMULTI
=> true,
156 ApiBase
::PARAM_DFLT
=> 'ascending',
157 ApiBase
::PARAM_TYPE
=> [
165 protected function getExamplesMessages() {
167 'action=query&prop=images&titles=Main%20Page'
168 => 'apihelp-query+images-example-simple',
169 'action=query&generator=images&titles=Main%20Page&prop=info'
170 => 'apihelp-query+images-example-generator',
174 public function getHelpUrls() {
175 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Images';