X-Git-Url: https://git.cyclocoop.org/%27.WWW_URL.%27admin/?a=blobdiff_plain;f=includes%2Fapi%2FApiQueryAllimages.php;h=3a5c4278626b30b1c09892c09580253eda250624;hb=b874469e86a2b5e1335cd3a70c46ab95a0fe64c4;hp=363a65c36222fcc2f9edefe4c679414e48e86d6c;hpb=1f9a7d791c93f9581b46c5ab299a496cf8ba84a5;p=lhc%2Fweb%2Fwiklou.git

diff --git a/includes/api/ApiQueryAllimages.php b/includes/api/ApiQueryAllimages.php
index 363a65c362..3a5c427862 100644
--- a/includes/api/ApiQueryAllimages.php
+++ b/includes/api/ApiQueryAllimages.php
@@ -1,11 +1,11 @@
 <?php
 
-/*
+/**
  * Created on Mar 16, 2008
  *
  * API for MediaWiki 1.12+
  *
- * Copyright (C) 2008 Vasiliev Victor vasilvv@gmail.com,
+ * Copyright © 2008 Vasiliev Victor vasilvv@gmail.com,
  * based on ApiQueryAllpages.php
  *
  * This program is free software; you can redistribute it and/or modify
@@ -20,13 +20,13 @@
  *
  * You should have received a copy of the GNU General Public License along
  * with this program; if not, write to the Free Software Foundation, Inc.,
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  */
 
 if ( !defined( 'MEDIAWIKI' ) ) {
 	// Eclipse helper - will be ignored in production
-	require_once ( 'ApiQueryBase.php' );
+	require_once( 'ApiQueryBase.php' );
 }
 
 /**
@@ -37,14 +37,14 @@ if ( !defined( 'MEDIAWIKI' ) ) {
 class ApiQueryAllimages extends ApiQueryGeneratorBase {
 
 	public function __construct( $query, $moduleName ) {
-		parent :: __construct( $query, $moduleName, 'ai' );
+		parent::__construct( $query, $moduleName, 'ai' );
 		$this->mRepo = RepoGroup::singleton()->getLocalRepo();
 	}
-	
+
 	/**
 	 * Overide parent method to make sure to make sure the repo's DB is used
 	 * which may not necesarilly be the same as the local DB.
-	 * 
+	 *
 	 * TODO: allow querying non-local repos.
 	 */
 	protected function getDB() {
@@ -56,16 +56,18 @@ class ApiQueryAllimages extends ApiQueryGeneratorBase {
 	}
 
 	public function executeGenerator( $resultPageSet ) {
-		if ( $resultPageSet->isResolvingRedirects() )
+		if ( $resultPageSet->isResolvingRedirects() ) {
 			$this->dieUsage( 'Use "gaifilterredir=nonredirects" option instead of "redirects" when using allimages as a generator', 'params' );
+		}
 
 		$this->run( $resultPageSet );
 	}
 
 	private function run( $resultPageSet = null ) {
 		$repo = $this->mRepo;
-		if ( !$repo instanceof LocalRepo )
+		if ( !$repo instanceof LocalRepo ) {
 			$this->dieUsage( 'Local file repository does not support querying all images', 'unsupportedrepo' );
+		}
 
 		$db = $this->getDB();
 
@@ -75,14 +77,14 @@ class ApiQueryAllimages extends ApiQueryGeneratorBase {
 		$dir = ( $params['dir'] == 'descending' ? 'older' : 'newer' );
 		$from = ( is_null( $params['from'] ) ? null : $this->titlePartToKey( $params['from'] ) );
 		$this->addWhereRange( 'img_name', $dir, $from, null );
-		if ( isset ( $params['prefix'] ) )
+		if ( isset( $params['prefix'] ) )
 			$this->addWhere( 'img_name' . $db->buildLike( $this->titlePartToKey( $params['prefix'] ), $db->anyString() ) );
 
-		if ( isset ( $params['minsize'] ) ) {
+		if ( isset( $params['minsize'] ) ) {
 			$this->addWhere( 'img_size>=' . intval( $params['minsize'] ) );
 		}
 
-		if ( isset ( $params['maxsize'] ) ) {
+		if ( isset( $params['maxsize'] ) ) {
 			$this->addWhere( 'img_size<=' . intval( $params['maxsize'] ) );
 		}
 
@@ -111,7 +113,7 @@ class ApiQueryAllimages extends ApiQueryGeneratorBase {
 		$titles = array();
 		$count = 0;
 		$result = $this->getResult();
-		while ( $row = $db->fetchObject( $res ) ) {
+		foreach ( $res as $row ) {
 			if ( ++ $count > $limit ) {
 				// We've reached the one extra which shows that there are additional pages to be had. Stop here...
 				// TODO: Security issue - if the user has no right to view next title, it will still be shown
@@ -132,7 +134,6 @@ class ApiQueryAllimages extends ApiQueryGeneratorBase {
 				$titles[] = Title::makeTitle( NS_IMAGE, $row->img_name );
 			}
 		}
-		$db->freeResult( $res );
 
 		if ( is_null( $resultPageSet ) ) {
 			$result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'img' );
@@ -145,54 +146,67 @@ class ApiQueryAllimages extends ApiQueryGeneratorBase {
 		return array (
 			'from' => null,
 			'prefix' => null,
-			'minsize' => array (
-				ApiBase :: PARAM_TYPE => 'integer',
+			'minsize' => array(
+				ApiBase::PARAM_TYPE => 'integer',
 			),
-			'maxsize' => array (
-				ApiBase :: PARAM_TYPE => 'integer',
+			'maxsize' => array(
+				ApiBase::PARAM_TYPE => 'integer',
 			),
-			'limit' => array (
-				ApiBase :: PARAM_DFLT => 10,
-				ApiBase :: PARAM_TYPE => 'limit',
-				ApiBase :: PARAM_MIN => 1,
-				ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
-				ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
+			'limit' => array(
+				ApiBase::PARAM_DFLT => 10,
+				ApiBase::PARAM_TYPE => 'limit',
+				ApiBase::PARAM_MIN => 1,
+				ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
+				ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
 			),
-			'dir' => array (
-				ApiBase :: PARAM_DFLT => 'ascending',
-				ApiBase :: PARAM_TYPE => array (
+			'dir' => array(
+				ApiBase::PARAM_DFLT => 'ascending',
+				ApiBase::PARAM_TYPE => array(
 					'ascending',
 					'descending'
 				)
 			),
 			'sha1' => null,
 			'sha1base36' => null,
-			'prop' => array (
-				ApiBase :: PARAM_TYPE => ApiQueryImageInfo::getPropertyNames(),
-				ApiBase :: PARAM_DFLT => 'timestamp|url',
-				ApiBase :: PARAM_ISMULTI => true
+			'prop' => array(
+				ApiBase::PARAM_TYPE => ApiQueryImageInfo::getPropertyNames(),
+				ApiBase::PARAM_DFLT => 'timestamp|url',
+				ApiBase::PARAM_ISMULTI => true
 			)
 		);
 	}
 
 	public function getParamDescription() {
-		return array (
-			'from' => 'The image title to start enumerating from.',
-			'prefix' => 'Search for all image titles that begin with this value.',
+		return array(
+			'from' => 'The image title to start enumerating from',
+			'prefix' => 'Search for all image titles that begin with this value',
 			'dir' => 'The direction in which to list',
 			'minsize' => 'Limit to images with at least this many bytes',
 			'maxsize' => 'Limit to images with at most this many bytes',
-			'limit' => 'How many total images to return.',
-			'sha1' => 'SHA1 hash of image',
+			'limit' => 'How many images in total to return',
+			'sha1' => "SHA1 hash of image. Overrides {$this->getModulePrefix()}sha1base36",
 			'sha1base36' => 'SHA1 hash of image in base 36 (used in MediaWiki)',
-			'prop' => 'Which properties to get',
+			'prop' => array(
+				'Which properties to get',
+				' timestamp    - Adds the timestamp when the image was upload',
+				' user         - Adds the username of the last uploader',
+				' comment      - Adds the comment of the last upload',
+				' url          - Adds the URL of the image and its description page',
+				' size         - Adds the size of the image in bytes and its height and width',
+				' dimensions   - Alias of size',
+				' sha1         - Adds the sha1 of the image',
+				' mime         - Adds the MIME of the image',
+				' thumbmime    - Adds the MIME of the tumbnail for the image',
+				' archivename  - Adds the file name of the archive version for non-latest versions',
+				' bitdepth     - Adds the bit depth of the version',
+			),
 		);
 	}
 
 	public function getDescription() {
 		return 'Enumerate all images sequentially';
 	}
-	
+
 	public function getPossibleErrors() {
 		return array_merge( parent::getPossibleErrors(), array(
 			array( 'code' => 'params', 'info' => 'Use "gaifilterredir=nonredirects" option instead of "redirects" when using allimages as a generator' ),
@@ -201,7 +215,7 @@ class ApiQueryAllimages extends ApiQueryGeneratorBase {
 	}
 
 	protected function getExamples() {
-		return array (
+		return array(
 			'Simple Use',
 			' Show a list of images starting at the letter "B"',
 			'  api.php?action=query&list=allimages&aifrom=B',