mediawiki-extensions-Multim.../resources/mmv/provider/mmv.provider.ThumbnailInfo.js

87 lines
3 KiB
JavaScript
Raw Normal View History

/*
* This file is part of the MediaWiki extension MultimediaViewer.
*
* MultimediaViewer is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* MultimediaViewer is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with MultimediaViewer. If not, see <http://www.gnu.org/licenses/>.
*/
( function ( mw, oo, $ ) {
/**
* @class mw.mmv.provider.ThumbnailInfo
* Gets thumbnail information.
* See https://www.mediawiki.org/wiki/API:Properties#imageinfo_.2F_ii
* @extends mw.mmv.provider.Api
* @inheritdoc
* @param {mw.Api} api
*/
function ThumbnailInfo( api ) {
mw.mmv.provider.Api.call( this, api );
}
oo.inheritClass( ThumbnailInfo, mw.mmv.provider.Api );
/**
* @method
* Runs an API GET request to get the thumbnail info for the specified size.
* The thumbnail always has the same aspect ratio as the full image.
* One of width or height can be null; if both are set, the API will return the largest
* thumbnail which fits into a width x height bounding box (or the full-sized image - whichever
* is smaller).
* @param {mw.Title} file
* @param {number} width thumbnail width in pixels
* @param {number} height thumbnail height in pixels
* @return {jQuery.Promise.<mw.mmv.model.Thumbnail>}
*/
ThumbnailInfo.prototype.get = function( file, width, height ) {
var provider = this,
cacheKey = file.getPrefixedDb() + '|' + ( width || '' ) + '|' + ( height || '' );
if ( !this.cache[cacheKey] ) {
this.cache[cacheKey] = this.api.get( {
action: 'query',
prop: 'imageinfo',
titles: file.getPrefixedDb(),
iiprop: 'url',
iiurlwidth: width, // mw.Api will omit null/undefined parameters
iiurlheight: height,
format: 'json'
} ).then( function( data ) {
return provider.getQueryPage( file, data );
} ).then( function( page ) {
if ( page.imageinfo && page.imageinfo[0] ) {
var imageInfo = page.imageinfo[0];
if ( imageInfo.thumburl && imageInfo.thumbwidth && imageInfo.thumbheight ) {
return $.Deferred().resolve(
new mw.mmv.model.Thumbnail(
imageInfo.thumburl,
imageInfo.thumbwidth,
imageInfo.thumbheight
)
);
} else {
return $.Deferred().reject( 'error in provider, thumb info not found' );
}
} else if ( page.missing === '' && page.imagerepository === '' ) {
return $.Deferred().reject( 'file does not exist: ' + file.getPrefixedDb() );
} else {
return $.Deferred().reject( 'unknown error' );
}
} );
}
return this.cache[cacheKey];
};
mw.mmv.provider.ThumbnailInfo = ThumbnailInfo;
}( mediaWiki, OO, jQuery ) );