ApiQueryAllImages.php

Go to the documentation of this file.

<?php

class ApiQueryAllImages extends ApiQueryGeneratorBase {

        protected $mRepo;

        public function __construct( $query, $moduleName ) {
                parent::__construct( $query, $moduleName, 'ai' );
                $this->mRepo = RepoGroup::singleton()->getLocalRepo();
        }

        protected function getDB() {
                return $this->mRepo->getSlaveDB();
        }

        public function execute() {
                $this->run();
        }

        public function getCacheMode( $params ) {
                return 'public';
        }

        public function executeGenerator( $resultPageSet ) {
                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 ) {
                        $this->dieUsage( 'Local file repository does not support querying all images', 'unsupportedrepo' );
                }

                $db = $this->getDB();

                $params = $this->extractRequestParams();

                if ( !is_null( $params['continue'] ) ) {
                        $cont = explode( '|', $params['continue'] );
                        if ( count( $cont ) != 1 ) {
                                $this->dieUsage( "Invalid continue param. You should pass the " .
                                        "original value returned by the previous query", "_badcontinue" );
                        }
                        $op = $params['dir'] == 'descending' ? '<' : '>';
                        $cont_from = $db->addQuotes( $cont[0] );
                        $this->addWhere( "img_name $op= $cont_from" );
                }

                // Image filters
                $dir = ( $params['dir'] == 'descending' ? 'older' : 'newer' );
                $from = ( is_null( $params['from'] ) ? null : $this->titlePartToKey( $params['from'] ) );
                $to = ( is_null( $params['to'] ) ? null : $this->titlePartToKey( $params['to'] ) );
                $this->addWhereRange( 'img_name', $dir, $from, $to );

                if ( isset( $params['prefix'] ) )
                        $this->addWhere( 'img_name' . $db->buildLike( $this->titlePartToKey( $params['prefix'] ), $db->anyString() ) );

                if ( isset( $params['minsize'] ) ) {
                        $this->addWhere( 'img_size>=' . intval( $params['minsize'] ) );
                }

                if ( isset( $params['maxsize'] ) ) {
                        $this->addWhere( 'img_size<=' . intval( $params['maxsize'] ) );
                }

                $sha1 = false;
                if ( isset( $params['sha1'] ) ) {
                        if ( !$this->validateSha1Hash( $params['sha1'] ) ) {
                                $this->dieUsage( 'The SHA1 hash provided is not valid', 'invalidsha1hash' );
                        }
                        $sha1 = wfBaseConvert( $params['sha1'], 16, 36, 31 );
                } elseif ( isset( $params['sha1base36'] ) ) {
                        $sha1 = $params['sha1base36'];
                        if ( !$this->validateSha1Base36Hash( $sha1 ) ) {
                                $this->dieUsage( 'The SHA1Base36 hash provided is not valid', 'invalidsha1base36hash' );
                        }
                }
                if ( $sha1 ) {
                        $this->addWhereFld( 'img_sha1', $sha1 );
                }

                if ( !is_null( $params['mime'] ) ) {
                        global $wgMiserMode;
                        if ( $wgMiserMode  ) {
                                $this->dieUsage( 'MIME search disabled in Miser Mode', 'mimesearchdisabled' );
                        }

                        list( $major, $minor ) = File::splitMime( $params['mime'] );

                        $this->addWhereFld( 'img_major_mime', $major );
                        $this->addWhereFld( 'img_minor_mime', $minor );
                }

                $this->addTables( 'image' );

                $prop = array_flip( $params['prop'] );
                $this->addFields( LocalFile::selectFields() );

                $limit = $params['limit'];
                $this->addOption( 'LIMIT', $limit + 1 );
                $sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
                $this->addOption( 'ORDER BY', 'img_name' . $sort );

                $res = $this->select( __METHOD__ );

                $titles = array();
                $count = 0;
                $result = $this->getResult();
                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...
                                $this->setContinueEnumParameter( 'continue', $row->img_name );
                                break;
                        }

                        if ( is_null( $resultPageSet ) ) {
                                $file = $repo->newFileFromRow( $row );
                                $info = array_merge( array( 'name' => $row->img_name ),
                                        ApiQueryImageInfo::getInfo( $file, $prop, $result ) );
                                self::addTitleInfo( $info, $file->getTitle() );

                                $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $info );
                                if ( !$fit ) {
                                        $this->setContinueEnumParameter( 'continue', $row->img_name );
                                        break;
                                }
                        } else {
                                $titles[] = Title::makeTitle( NS_FILE, $row->img_name );
                        }
                }

                if ( is_null( $resultPageSet ) ) {
                        $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'img' );
                } else {
                        $resultPageSet->populateFromTitles( $titles );
                }
        }

        public function getAllowedParams() {
                return array (
                        'from' => null,
                        'continue' => null,
                        'to' => null,
                        'prefix' => null,
                        'minsize' => 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
                        ),
                        'dir' => array(
                                ApiBase::PARAM_DFLT => 'ascending',
                                ApiBase::PARAM_TYPE => array(
                                        'ascending',
                                        'descending'
                                )
                        ),
                        'sha1' => null,
                        'sha1base36' => null,
                        'prop' => array(
                                ApiBase::PARAM_TYPE => ApiQueryImageInfo::getPropertyNames( $this->propertyFilter ),
                                ApiBase::PARAM_DFLT => 'timestamp|url',
                                ApiBase::PARAM_ISMULTI => true
                        ),
                        'mime' => null,
                );
        }

        public function getParamDescription() {
                return array(
                        'from' => 'The image title to start enumerating from',
                        'continue' => 'When more results are available, use this to continue',
                        'to' => 'The image title to stop enumerating at',
                        '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 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' => ApiQueryImageInfo::getPropertyDescriptions( $this->propertyFilter ),
                        'mime' => 'What MIME type to search for. e.g. image/jpeg. Disabled in Miser Mode',
                );
        }

        private $propertyFilter = array( 'archivename', 'thumbmime' );

        public function getResultProperties() {
                return array_merge(
                        array(
                                '' => array(
                                        'name' => 'string',
                                        'ns' => 'namespace',
                                        'title' => 'string'
                                )
                        ),
                        ApiQueryImageInfo::getResultPropertiesFiltered( $this->propertyFilter )
                );
        }

        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' ),
                        array( 'code' => 'unsupportedrepo', 'info' => 'Local file repository does not support querying all images' ),
                        array( 'code' => 'mimesearchdisabled', 'info' => 'MIME search disabled in Miser Mode' ),
                        array( 'code' => 'invalidsha1hash', 'info' => 'The SHA1 hash provided is not valid' ),
                        array( 'code' => 'invalidsha1base36hash', 'info' => 'The SHA1Base36 hash provided is not valid' ),
                        array( 'code' => '_badcontinue', 'info' => 'Invalid continue param. You should pass the original value returned by the previous query' ),
                ) );
        }

        public function getExamples() {
                return array(
                        'api.php?action=query&list=allimages&aifrom=B' => array(
                                'Simple Use',
                                'Show a list of images starting at the letter "B"',
                        ),
                        'api.php?action=query&generator=allimages&gailimit=4&gaifrom=T&prop=imageinfo' => array(
                                'Using as Generator',
                                'Show info about 4 images starting at the letter "T"',
                        ),
                );
        }

        public function getHelpUrls() {
                return 'https://www.mediawiki.org/wiki/API:Allimages';
        }

        public function getVersion() {
                return __CLASS__ . ': $Id$';
        }
}